nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
ZCL On/Off cluster

On/Off cluster attributes

enum  zb_zcl_on_off_attr_e { ZB_ZCL_ATTR_ON_OFF_ON_OFF_ID = 0 }
 On/Off cluster attribute identifiers. More...
 
enum  zb_zcl_on_off_on_off_e { ZB_ZCL_ON_OFF_IS_OFF = 0, ZB_ZCL_ON_OFF_IS_ON = 1 }
 Permissible values for OnOff attribute. More...
 
#define ZB_ZCL_ON_OFF_ON_OFF_DEFAULT_VALUE   (ZB_ZCL_ON_OFF_IS_OFF)
 Default value for OnOff attribute.
 

On/Off cluster commands

enum  zb_zcl_on_off_cmd_e { ZB_ZCL_CMD_ON_OFF_OFF_ID = 0x00, ZB_ZCL_CMD_ON_OFF_ON_ID = 0x01, ZB_ZCL_CMD_ON_OFF_TOGGLE_ID = 0x02 }
 On/Off cluster command identifiers. More...
 
#define ZB_ZCL_ON_OFF_SEND_OFF_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, dis_default_resp, cb)
 
#define ZB_ZCL_ON_OFF_SEND_ON_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, dis_default_resp, cb)
 
#define ZB_ZCL_ON_OFF_SEND_TOGGLE_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, dis_default_resp, cb)
 

Detailed Description

All commands in the cluster have only request form, and carry no payload.

Example
On command sending:
#define DST_ADDR 0
#define DST_ENDPOINT 5
#define DST_ADDR_MODE ZB_APS_ADDR_MODE_16_ENDP_PRESENT
buf,
DST_ADDR,
DST_ADDR_MODE,
DST_ENDPOINT,
HA_SWITCH_ENDPOINT,
ZB_FALSE, NULL);

Other two commands can be sent in the same way using appropriate macros.

For more information see 5.7.3_onoff_server sample

Macro Definition Documentation

#define ZB_ZCL_ON_OFF_SEND_OFF_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  dis_default_resp,
  cb 
)
Value:
ZB_ZCL_ON_OFF_SEND_REQ( \
buffer, \
addr, \
dst_addr_mode, \
dst_ep, \
ep, \
prfl_id, \
dis_default_resp, \
cb)
Definition: zb_zcl_on_off.h:111

Specific macro for sending Off command

#define ZB_ZCL_ON_OFF_SEND_ON_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  dis_default_resp,
  cb 
)
Value:
ZB_ZCL_ON_OFF_SEND_REQ( \
buffer, \
addr, \
dst_addr_mode, \
dst_ep, \
ep, \
prfl_id, \
dis_default_resp, \
cb)
Definition: zb_zcl_on_off.h:112

Specific macro for sending On command

#define ZB_ZCL_ON_OFF_SEND_TOGGLE_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  dis_default_resp,
  cb 
)
Value:
ZB_ZCL_ON_OFF_SEND_REQ( \
buffer, \
addr, \
dst_addr_mode, \
dst_ep, \
ep, \
prfl_id, \
dis_default_resp, \
cb)
Definition: zb_zcl_on_off.h:113

Specific macro for sending Toggle command

Enumeration Type Documentation

On/Off cluster attribute identifiers.

See also
ZCL spec, subclause 3.8.2.2
Enumerator
ZB_ZCL_ATTR_ON_OFF_ON_OFF_ID 

OnOff attribute.

On/Off cluster command identifiers.

See also
ZCL spec, subclause 3.8.2.3
Enumerator
ZB_ZCL_CMD_ON_OFF_OFF_ID 

"Turn off" command.

ZB_ZCL_CMD_ON_OFF_ON_ID 

"Turn on" command.

ZB_ZCL_CMD_ON_OFF_TOGGLE_ID 

"Toggle state" command.

Permissible values for OnOff attribute.

Enumerator
ZB_ZCL_ON_OFF_IS_OFF 

"Off" value

ZB_ZCL_ON_OFF_IS_ON 

"On" value