Logo
DSR GreenBOSS  1.1.0
Macros
Color Control Сluster Сommands

Macros

#define GBOSS_CMD_MOVE_HUE_STOP(device_config, tx_cfg)   gboss_payloadless_cmd(GBOSS_APP_CMD_ID_MOVE_HUE_STOP, (device_config), (tx_cfg))
 Upon receipt of this command, any movement currently in process SHALL be terminated. More...
 
#define GBOSS_CMD_MOVE_HUE_UP(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_UP, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Hue Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_HUE_DOWN(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_DOWN, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Hue Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_HUE_UP_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_UP, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Hue Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_HUE_DOWN_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_DOWN, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Hue Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_HUE_UP(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_UP, (step_size),0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Hue Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_HUE_DOWN(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_DOWN, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Hue Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_HUE_UP_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_UP, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Hue Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_HUE_DOWN_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_DOWN, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Hue Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_SATURATION_STOP(device_config, tx_cfg)   gboss_payloadless_cmd(GBOSS_APP_CMD_ID_MOVE_SATURATION_STOP, (device_config), (tx_cfg))
 Upon receipt of this command, any movement currently in process SHALL be terminated. More...
 
#define GBOSS_CMD_MOVE_SATURATION_UP(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_UP, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Saturation Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_SATURATION_DOWN(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_DOWN, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Saturation Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_SATURATION_UP_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_UP, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Saturation Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_SATURATION_DOWN_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_DOWN, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Saturation Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_SATURATION_UP(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_UP, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Saturation Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_SATURATION_DOWN(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_DOWN, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Saturation Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_SATURATION_UP_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_UP, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Saturation Up from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_SATURATION_DOWN_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_DOWN, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Saturation Down from cluster ID Color Control. More...
 
#define GBOSS_CMD_MOVE_COLOR(device_config, tx_cfg, rate_x, rate_y)   gboss_cmd_move_color(GBOSS_APP_CMD_ID_MOVE_COLOR, (rate_x), (rate_y), (device_config), (tx_cfg))
 GPD command Move Color from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_COLOR(device_config, tx_cfg, step_x, step_y)   gboss_cmd_step_color(GBOSS_APP_CMD_ID_STEP_COLOR, (step_x), (step_y), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Color from cluster ID Color Control. More...
 
#define GBOSS_CMD_STEP_COLOR_W_TR_TIME(device_config, tx_cfg, step_x, step_y, tr_time)   gboss_cmd_step_color(GBOSS_APP_CMD_ID_STEP_COLOR, (step_x), (step_y), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Color from cluster ID Color Control. More...
 

Detailed Description

Macro Definition Documentation

§ GBOSS_CMD_MOVE_HUE_STOP

#define GBOSS_CMD_MOVE_HUE_STOP (   device_config,
  tx_cfg 
)    gboss_payloadless_cmd(GBOSS_APP_CMD_ID_MOVE_HUE_STOP, (device_config), (tx_cfg))

Upon receipt of this command, any movement currently in process SHALL be terminated.

Payloadless.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions

§ GBOSS_CMD_MOVE_HUE_UP

#define GBOSS_CMD_MOVE_HUE_UP (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_UP, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Hue Up from cluster ID Color Control.

This is the variant of the command without payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions

§ GBOSS_CMD_MOVE_HUE_DOWN

#define GBOSS_CMD_MOVE_HUE_DOWN (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_DOWN, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Hue Down from cluster ID Color Control.

This is the variant of the command without payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions

§ GBOSS_CMD_MOVE_HUE_UP_W_RATE

#define GBOSS_CMD_MOVE_HUE_UP_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_UP, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Hue Up from cluster ID Color Control.

This is the variant of the command with payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
rateSpecifies the rate of movement in steps per second. A step is a change in the device’s hue of one unit

§ GBOSS_CMD_MOVE_HUE_DOWN_W_RATE

#define GBOSS_CMD_MOVE_HUE_DOWN_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_HUE_DOWN, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Hue Down from cluster ID Color Control.

This is the variant of the command with payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
rateSpecifies the rate of movement in steps per second. A step is a change in the device’s hue of one unit

§ GBOSS_CMD_STEP_HUE_UP

#define GBOSS_CMD_STEP_HUE_UP (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_UP, (step_size),0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Hue Up from cluster ID Color Control.

It has payload. This is the variant of the command without transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s hue of "Step size" units.

§ GBOSS_CMD_STEP_HUE_DOWN

#define GBOSS_CMD_STEP_HUE_DOWN (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_DOWN, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Hue Down from cluster ID Color Control.

It has payload. This is the variant of the command without transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s hue of "Step size" units.

§ GBOSS_CMD_STEP_HUE_UP_W_TR_TIME

#define GBOSS_CMD_STEP_HUE_UP_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_UP, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Hue Up from cluster ID Color Control.

It has payload. This is the variant of the command with transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s hue of "Step size" units.
tr_timeSpecifies the time that SHALL be taken to perform a single step, in tenths of a second

§ GBOSS_CMD_STEP_HUE_DOWN_W_TR_TIME

#define GBOSS_CMD_STEP_HUE_DOWN_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_HUE_DOWN, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Hue Down from cluster ID Color Control.

It has payload. This is the variant of the command with transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s hue of "Step size" units.
tr_timeSpecifies the time that SHALL be taken to perform a single step, in tenths of a second

§ GBOSS_CMD_MOVE_SATURATION_STOP

#define GBOSS_CMD_MOVE_SATURATION_STOP (   device_config,
  tx_cfg 
)    gboss_payloadless_cmd(GBOSS_APP_CMD_ID_MOVE_SATURATION_STOP, (device_config), (tx_cfg))

Upon receipt of this command, any movement currently in process SHALL be terminated.

Payloadless.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions

§ GBOSS_CMD_MOVE_SATURATION_UP

#define GBOSS_CMD_MOVE_SATURATION_UP (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_UP, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Saturation Up from cluster ID Color Control.

This is the variant of the command without payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions

§ GBOSS_CMD_MOVE_SATURATION_DOWN

#define GBOSS_CMD_MOVE_SATURATION_DOWN (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_DOWN, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Saturation Down from cluster ID Color Control.

This is the variant of the command without payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions

§ GBOSS_CMD_MOVE_SATURATION_UP_W_RATE

#define GBOSS_CMD_MOVE_SATURATION_UP_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_UP, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Saturation Up from cluster ID Color Control.

This is the variant of the command with payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
rateSpecifies the rate of movement in steps per second. A step is a change in the device’s saturation of one unit

§ GBOSS_CMD_MOVE_SATURATION_DOWN_W_RATE

#define GBOSS_CMD_MOVE_SATURATION_DOWN_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_SATURATION_DOWN, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Saturation Down from cluster ID Color Control.

This is the variant of the command with payload (rate).

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
rateSpecifies the rate of movement in steps per second. A step is a change in the device’s saturation of one unit

§ GBOSS_CMD_STEP_SATURATION_UP

#define GBOSS_CMD_STEP_SATURATION_UP (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_UP, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Saturation Up from cluster ID Color Control.

It has payload. This is the variant of the command without transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s saturation of "Step size" units

§ GBOSS_CMD_STEP_SATURATION_DOWN

#define GBOSS_CMD_STEP_SATURATION_DOWN (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_DOWN, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Saturation Down from cluster ID Color Control.

It has payload. This is the variant of the command without transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s saturation of "Step size" units

§ GBOSS_CMD_STEP_SATURATION_UP_W_TR_TIME

#define GBOSS_CMD_STEP_SATURATION_UP_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_UP, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Saturation Up from cluster ID Color Control.

It has payload. This is the variant of the command with transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s saturation of "Step size" units
tr_timeSpecifies the time that SHALL be taken to perform a single step, in tenths of a second

§ GBOSS_CMD_STEP_SATURATION_DOWN_W_TR_TIME

#define GBOSS_CMD_STEP_SATURATION_DOWN_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_SATURATION_DOWN, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Saturation Down from cluster ID Color Control.

It has payload. This is the variant of the command with transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_sizeChange in the device’s saturation of "Step size" units
tr_timeSpecifies the time that SHALL be taken to perform a single step, in tenths of a second

§ GBOSS_CMD_MOVE_COLOR

#define GBOSS_CMD_MOVE_COLOR (   device_config,
  tx_cfg,
  rate_x,
  rate_y 
)    gboss_cmd_move_color(GBOSS_APP_CMD_ID_MOVE_COLOR, (rate_x), (rate_y), (device_config), (tx_cfg))

GPD command Move Color from cluster ID Color Control.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
rate_xSpecifies the rate of movement in steps per second. A step is a change in the device's CurrentX attribute of one unit
rate_ySpecifies the rate of movement in steps per second. A step is a change in the device's CurrentY attribute of one unit

§ GBOSS_CMD_STEP_COLOR

#define GBOSS_CMD_STEP_COLOR (   device_config,
  tx_cfg,
  step_x,
  step_y 
)    gboss_cmd_step_color(GBOSS_APP_CMD_ID_STEP_COLOR, (step_x), (step_y), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Color from cluster ID Color Control.

This is the variant of the command without transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_xSpecifies the change to be added to the device's CurrentX attribute
step_ySpecifies the change to be added to the device's CurrentX attribute

§ GBOSS_CMD_STEP_COLOR_W_TR_TIME

#define GBOSS_CMD_STEP_COLOR_W_TR_TIME (   device_config,
  tx_cfg,
  step_x,
  step_y,
  tr_time 
)    gboss_cmd_step_color(GBOSS_APP_CMD_ID_STEP_COLOR, (step_x), (step_y), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Color from cluster ID Color Control.

This is the variant of the command with transition time.

Parameters
device_configDescribes main configuration constants of a GP device
tx_cfgTX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions
step_xSpecifies the change to be added to the device's CurrentX attribute
step_ySpecifies the change to be added to the device's CurrentX attribute
tr_timeSpecifies the time that SHALL be taken to perform the color change, in tenths of a second