Logo
DSR GreenBOSS  1.1.0
Macros
Level Control Сluster Сommands

Macros

#define GBOSS_CMD_MOVE_UP(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Up from cluster ID Level Control. More...
 
#define GBOSS_CMD_MOVE_DOWN(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Down from cluster ID Level Control. More...
 
#define GBOSS_CMD_MOVE_UP_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Up from cluster ID Level Control. More...
 
#define GBOSS_CMD_MOVE_DOWN_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Down from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_UP(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Up from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_DOWN(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Down from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_UP_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Up from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_DOWN_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Down from cluster ID Level Control. More...
 
#define GBOSS_CMD_LEVEL_CONTROL_STOP(device_config, tx_cfg)   gboss_payloadless_cmd(GBOSS_APP_CMD_ID_LEVEL_CONTROL_STOP, (device_config), (tx_cfg))
 Upon receipt of this command, any Move to Level, Move or Step command (and their "with On/Off" variants) currently in process SHALL be terminated. More...
 
#define GBOSS_CMD_MOVE_UP_W_ON_OFF(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP_W_ON_OFF, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Up with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_MOVE_DOWN_W_ON_OFF(device_config, tx_cfg)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN_W_ON_OFF, 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Move Down with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_MOVE_UP_W_ON_OFF_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP_W_ON_OFF, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Up with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_MOVE_DOWN_W_ON_OFF_W_RATE(device_config, tx_cfg, rate)   gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN_W_ON_OFF, (rate), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Move Down with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_UP_W_ON_OFF(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP_W_ON_OFF, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Up with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_DOWN_W_ON_OFF(device_config, tx_cfg, step_size)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN_W_ON_OFF, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))
 GPD command Step Down with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_UP_W_ON_OFF_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP_W_ON_OFF, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Up with On/Off from cluster ID Level Control. More...
 
#define GBOSS_CMD_STEP_DOWN_W_ON_OFF_W_TR_TIME(device_config, tx_cfg, step_size, tr_time)   gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN_W_ON_OFF, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))
 GPD command Step Down with On/Off from cluster ID Level Control. More...
 

Detailed Description

Macro Definition Documentation

§ GBOSS_CMD_MOVE_UP

#define GBOSS_CMD_MOVE_UP (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Up from cluster ID Level 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_DOWN

#define GBOSS_CMD_MOVE_DOWN (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Down from cluster ID Level 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_UP_W_RATE

#define GBOSS_CMD_MOVE_UP_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Up from cluster ID Level 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 units per second

§ GBOSS_CMD_MOVE_DOWN_W_RATE

#define GBOSS_CMD_MOVE_DOWN_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Down from cluster ID Level 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 units per second

§ GBOSS_CMD_STEP_UP

#define GBOSS_CMD_STEP_UP (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Up from cluster ID Level 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 current level of "Step size" units

§ GBOSS_CMD_STEP_DOWN

#define GBOSS_CMD_STEP_DOWN (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Down from cluster ID Level 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 current level of "Step size" units

§ GBOSS_CMD_STEP_UP_W_TR_TIME

#define GBOSS_CMD_STEP_UP_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Up from cluster ID Level 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 current level of "Step size" units
tr_timeSpecifies the time that SHALL be taken to perform the step, in tenths of a second

§ GBOSS_CMD_STEP_DOWN_W_TR_TIME

#define GBOSS_CMD_STEP_DOWN_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Down from cluster ID Level 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 current level of "Step size" units
tr_timeSpecifies the time that SHALL be taken to perform the step, in tenths of a second

§ GBOSS_CMD_LEVEL_CONTROL_STOP

#define GBOSS_CMD_LEVEL_CONTROL_STOP (   device_config,
  tx_cfg 
)    gboss_payloadless_cmd(GBOSS_APP_CMD_ID_LEVEL_CONTROL_STOP, (device_config), (tx_cfg))

Upon receipt of this command, any Move to Level, Move or Step command (and their "with On/Off" variants) 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_UP_W_ON_OFF

#define GBOSS_CMD_MOVE_UP_W_ON_OFF (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP_W_ON_OFF, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Up with On/Off from cluster ID Level 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_DOWN_W_ON_OFF

#define GBOSS_CMD_MOVE_DOWN_W_ON_OFF (   device_config,
  tx_cfg 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN_W_ON_OFF, 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Move Down with On/Off from cluster ID Level 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_UP_W_ON_OFF_W_RATE

#define GBOSS_CMD_MOVE_UP_W_ON_OFF_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_UP_W_ON_OFF, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Up with On/Off from cluster ID Level 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 units per second

§ GBOSS_CMD_MOVE_DOWN_W_ON_OFF_W_RATE

#define GBOSS_CMD_MOVE_DOWN_W_ON_OFF_W_RATE (   device_config,
  tx_cfg,
  rate 
)    gboss_cmd_move(GBOSS_APP_CMD_ID_MOVE_DOWN_W_ON_OFF, (rate), ZB_TRUE, (device_config), (tx_cfg))

GPD command Move Down with On/Off from cluster ID Level 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 units per second

§ GBOSS_CMD_STEP_UP_W_ON_OFF

#define GBOSS_CMD_STEP_UP_W_ON_OFF (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP_W_ON_OFF, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Up with On/Off from cluster ID Level 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 current level of "Step size" units

§ GBOSS_CMD_STEP_DOWN_W_ON_OFF

#define GBOSS_CMD_STEP_DOWN_W_ON_OFF (   device_config,
  tx_cfg,
  step_size 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN_W_ON_OFF, (step_size), 0, ZB_FALSE, (device_config), (tx_cfg))

GPD command Step Down with On/Off from cluster ID Level 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 current level of "Step size" units

§ GBOSS_CMD_STEP_UP_W_ON_OFF_W_TR_TIME

#define GBOSS_CMD_STEP_UP_W_ON_OFF_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_UP_W_ON_OFF, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Up with On/Off from cluster ID Level 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 current level of "Step size" units
tr_timeSpecifies the time that SHALL be taken to perform the step, in tenths of a second

§ GBOSS_CMD_STEP_DOWN_W_ON_OFF_W_TR_TIME

#define GBOSS_CMD_STEP_DOWN_W_ON_OFF_W_TR_TIME (   device_config,
  tx_cfg,
  step_size,
  tr_time 
)    gboss_cmd_step(GBOSS_APP_CMD_ID_STEP_DOWN_W_ON_OFF, (step_size), (tr_time), ZB_TRUE, (device_config), (tx_cfg))

GPD command Step Down with On/Off from cluster ID Level 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 current level of "Step size" units
tr_timeSpecifies the time that SHALL be taken to perform the step, in tenths of a second