Logo
Developing with ZBOSS for Zigbee
zb_zcl_on_off.h File Reference

Data Structures

struct  zb_zcl_on_off_off_with_effect_req_s
 Structured representation of Off with effect command payload. More...
 
struct  zb_zcl_on_off_on_with_timed_off_req_s
 Structured representation of On with timed off command payload. More...
 

Macros

#define ZB_ZCL_CLUSTER_ID_ON_OFF_SERVER_ROLE_INIT   zb_zcl_on_off_init_server
 
#define ZB_ZCL_CLUSTER_ID_ON_OFF_CLIENT_ROLE_INIT   zb_zcl_on_off_init_client
 

Functions

void zb_zcl_on_off_init_server (void)
 
void zb_zcl_on_off_init_client (void)
 

On/Off cluster attributes

#define ZB_ZCL_ON_OFF_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)
 Default value for OnOff cluster revision global attribute. More...
 
#define ZB_ZCL_ON_OFF_ON_OFF_DEFAULT_VALUE   (ZB_ZCL_ON_OFF_IS_OFF)
 Default value for OnOff attribute. More...
 
#define ZB_ZCL_ON_OFF_GLOBAL_SCENE_CONTROL_DEFAULT_VALUE   ((zb_bool_t)0x01)
 Default value for GlobalSceneControl attribute. More...
 
#define ZB_ZCL_ON_OFF_ON_TIME_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for OnTime attribute. More...
 
#define ZB_ZCL_ON_OFF_OFF_WAIT_TIME_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for OffWaitTime attribute. More...
 
#define ZB_ZCL_DECLARE_ON_OFF_ATTRIB_LIST(attr_list, on_off)
 Declare attribute list for On/Off cluster. More...
 
#define ZB_ZCL_DECLARE_ON_OFF_ATTRIB_LIST_EXT( attr_list, on_off, global_scene_ctrl, on_time, off_wait_time)
 Declare attribute list for On/Off cluster (extended attribute set). More...
 
enum  zb_zcl_on_off_attr_e {
  ZB_ZCL_ATTR_ON_OFF_ON_OFF_ID = 0, ZB_ZCL_ATTR_ON_OFF_GLOBAL_SCENE_CONTROL = 0x4000, ZB_ZCL_ATTR_ON_OFF_ON_TIME = 0x4001, ZB_ZCL_ATTR_ON_OFF_OFF_WAIT_TIME = 0x4002,
  ZB_ZCL_ATTR_ON_OFF_START_UP_ON_OFF = 0x4003
}
 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...
 
enum  zb_zcl_on_off_start_up_on_off_e { ZB_ZCL_ON_OFF_START_UP_ON_OFF_IS_OFF = 0, ZB_ZCL_ON_OFF_START_UP_ON_OFF_IS_ON = 1, ZB_ZCL_ON_OFF_START_UP_ON_OFF_IS_TOGGLE = 2, ZB_ZCL_ON_OFF_START_UP_ON_OFF_IS_PREVIOUS = 0xFF }
 

On/Off cluster commands

#define ZB_ZCL_ON_OFF_SEND_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, command_id, cb)
 General macro for sending On/Off cluster command. 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)
 
#define ZB_ZCL_ON_OFF_SEND_OFF_WITH_EFFECT_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, effect_id, effect_var, cb)
 
#define ZB_ZCL_ON_OFF_SEND_ON_WITH_RECALL_GLOBAL_SCENE_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cb)
 
#define ZB_ZCL_ON_OFF_SEND_ON_WITH_TIMED_OFF_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, on_off, on_time, off_wait_time, cb)
 
#define ZB_ZCL_ON_OFF_ACCEPT_ONLY_WHEN_ON   1
 
#define ZB_ZCL_ON_OFF_GET_OFF_WITH_EFFECT_REQ(data_ptr, buffer, status)
 Parses Off with Effect command. More...
 
#define ZB_ZCL_ON_OFF_GET_ON_WITH_TIMED_OFF_REQ(data_ptr, buffer, status)
 Parses On with timed off command. More...
 
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, ZB_ZCL_CMD_ON_OFF_OFF_WITH_EFFECT_ID = 0x40,
  ZB_ZCL_CMD_ON_OFF_ON_WITH_RECALL_GLOBAL_SCENE_ID = 0x41, ZB_ZCL_CMD_ON_OFF_ON_WITH_TIMED_OFF_ID = 0x42
}
 On/Off cluster command identifiers. More...
 
enum  zb_zcl_on_off_effect_e { ZB_ZCL_ON_OFF_EFFECT_ID_DELAYED_ALL_OFF = 0x00, ZB_ZCL_ON_OFF_EFFECT_ID_DYING_LIGHT = 0x01 }
 
enum  zb_zcl_on_off_effect_variant_delayed_e { ZB_ZCL_ON_OFF_EFFECT_VARIANT_FADE = 0x00, ZB_ZCL_ON_OFF_EFFECT_VARIANT_NO_FADE = 0x01, ZB_ZCL_ON_OFF_EFFECT_VARIANT_50PART_FADE = 0x02 }
 
enum  zb_zcl_on_off_effect_variant_dying_e { ZB_ZCL_ON_OFF_EFFECT_VARIANT_20PART_FADE = 0x00 }
 
typedef struct zb_zcl_on_off_off_with_effect_req_s zb_zcl_on_off_off_with_effect_req_t
 Structured representation of Off with effect command payload. More...
 
typedef struct zb_zcl_on_off_on_with_timed_off_req_s zb_zcl_on_off_on_with_timed_off_req_t
 Structured representation of On with timed off command payload. More...
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_ON_OFF_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_ON_OFF_CLIENT_ROLE_INIT   zb_zcl_on_off_init_client

§ ZB_ZCL_CLUSTER_ID_ON_OFF_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_ON_OFF_SERVER_ROLE_INIT   zb_zcl_on_off_init_server

Function Documentation

§ zb_zcl_on_off_init_client()

void zb_zcl_on_off_init_client ( void  )

§ zb_zcl_on_off_init_server()

void zb_zcl_on_off_init_server ( void  )