Z-Stack API Reference  3.60.00.10
ZCL

This module implements the Zigbee Cluster Library. More...

Modules

 ZCL Cluster IDs
 
 ZCL Functions
 
 ZCL Typedefs
 

Files

file  zcl.h
 Top level ZCL header.
 

Macros

#define zcl_ProfileCmd(a)   ( (a) == ZCL_FRAME_TYPE_PROFILE_CMD )
 
#define zcl_ClusterCmd(a)   ( (a) == ZCL_FRAME_TYPE_SPECIFIC_CMD )
 
#define zcl_ServerCmd(a)   ( (a) == ZCL_FRAME_CLIENT_SERVER_DIR )
 
#define zcl_ClientCmd(a)   ( (a) == ZCL_FRAME_SERVER_CLIENT_DIR )
 
#define UNICAST_MSG(msg)   ( (msg)->wasBroadcast == false && (msg)->groupId == 0 )
 
#define PADDING_NEEDED(bufLen)   ( (bufLen) % 2 )
 
#define ZCL_CLUSTER_ID_GEN(id)
 
#define ZCL_CLUSTER_ID_CLOSURES(id)
 
#define ZCL_CLUSTER_ID_HVAC(id)
 
#define ZCL_CLUSTER_ID_LIGHTING(id)
 
#define ZCL_CLUSTER_ID_MS(id)
 
#define ZCL_CLUSTER_ID_SS(id)
 
#define ZCL_CLUSTER_ID_KEY(id)   ( (id) == ZCL_CLUSTER_ID_GEN_KEY_ESTABLISHMENT )
 
#define ZCL_CLUSTER_ID_SE(id)
 
#define ZCL_CLUSTER_ID_PI(id)
 
#define ZCL_CLUSTER_ID_PI_RETAIL_T(id)   ( (id) == ZCL_CLUSTER_ID_PI_RETAIL_TUNNEL )
 
#define ZCL_CLUSTER_ID_PI_RETAIL(id)
 
#define ZCL_CLUSTER_ID_LL(id)   ( (id) == ZCL_CLUSTER_ID_TOUCHLINK )
 
#define ZCL_CLUSTER_ID_PART(id)   ( (id) == ZCL_CLUSTER_ID_GEN_PARTITION )
 
#define ZCL_CLUSTER_ID_PC(id)   ( (id) == ZCL_CLUSTER_ID_GEN_POLL_CONTROL )
 
#define ZCL_CLUSTER_ID_EM(id)   ( (id) == ZCL_CLUSTER_ID_MS_ELECTRICAL_MEASUREMENT )
 
#define ZCL_CLUSTER_ID_DIAG(id)   ( (id) == ZCL_CLUSTER_ID_HA_DIAGNOSTIC )
 
#define ZCL_CLUSTER_ID_MI(id)   ( (id) == ZCL_CLUSTER_ID_HA_METER_IDENTIFICATION )
 
#define ZCL_CLUSTER_ID_APPL_C(id)   ( (id) == ZCL_CLUSTER_ID_GEN_APPLIANCE_CONTROL )
 
#define ZCL_CLUSTER_ID_APPL_I(id)   ( (id) == ZCL_CLUSTER_ID_HA_APPLIANCE_IDENTIFICATION )
 
#define ZCL_CLUSTER_ID_APPL_STAT(id)   ( (id) == ZCL_CLUSTER_ID_HA_APPLIANCE_STATISTICS )
 
#define ZCL_CLUSTER_ID_APPL_E_A(id)   ( (id) == ZCL_CLUSTER_ID_HA_APPLIANCE_EVENTS_ALERTS )
 
#define ZCL_CLUSTER_ID_APPL_S(id)   ( (id) == ZCL_CLUSTER_ID_HA_APPLIANCE_STATISTICS )
 
#define ZCL_CLUSTER_ID_PP(id)   ( (id) == ZCL_CLUSTER_ID_GEN_POWER_PROFILE )
 
#define ZCL_CLUSTER_ID_DL(id)   ( (id) == ZCL_CLUSTER_ID_CLOSURES_DOOR_LOCK )
 
#define ZCL_CLUSTER_ID_TEL(id)
 
#define ZCL_CLUSTER_ID_TL(id)   ( (id) == ZCL_CLUSTER_ID_TOUCHLINK )
 
#define zcl_SendWrite(a, b, c, d, e, f, g)   (zcl_SendWriteRequest( (a), (b), (c), (d), ZCL_CMD_WRITE, (e), (f), (g) ))
 
#define zcl_SendWriteUndivided(a, b, c, d, e, f, g)   (zcl_SendWriteRequest( (a), (b), (c), (d), ZCL_CMD_WRITE_UNDIVIDED, (e), (f), (g) ))
 
#define zcl_SendWriteNoRsp(a, b, c, d, e, f, g)   (zcl_SendWriteRequest( (a), (b), (c), (d), ZCL_CMD_WRITE_NO_RSP, (e), (f), (g) ))
 
#define zcl_SendCommand(a, b, c, d, e, f, g, h, i, j, k)   (zcl_SendCommandEx(a,b,c,d,e,f,g,h,i,j,k,TRUE))
 
#define zcl_StackSendCommand(a, b, c, d, e, f, g, h, i, j, k)   (zcl_SendCommandEx(a,b,c,d,e,f,g,h,i,j,k,FALSE))
 
#define zcl_SendConfigReportRspCmd(a, b, c, d, e, f, g)   (zcl_SendConfigReportRspCmdEx(a,b,c,d,e,f,g,TRUE))
 
#define zcl_StackSendConfigReportRspCmd(a, b, c, d, e, f, g)   (zcl_SendConfigReportRspCmdEx(a,b,c,d,e,f,g,FALSE))
 
#define zcl_SendReadReportCfgRspCmd(a, b, c, d, e, f, g)   (zcl_SendReadReportCfgRspCmdEx(a,b,c,d,e,f,g,TRUE))
 
#define zcl_StackSendReadReportCfgRspCmd(a, b, c, d, e, f, g)   (zcl_SendReadReportCfgRspCmdEx(a,b,c,d,e,f,g,FALSE))
 
#define zcl_SendReportCmd(a, b, c, d, e, f, g)   (zcl_SendReportCmdEx(a,b,c,d,e,f,g,TRUE))
 
#define zcl_StackSendReportCmd(a, b, c, d, e, f, g)   (zcl_SendReportCmdEx(a,b,c,d,e,f,g,FALSE))
 

Functions

void * zcl_mem_alloc (uint16_t size)
 
void * zcl_memset (void *dest, uint8_t value, int len)
 
void * zcl_memcpy (void *dst, void *src, unsigned int len)
 
uint8_t zcl_memcmp (const void *src1, const void *src2, unsigned int len)
 
void zcl_mem_free (void *ptr)
 
uint8_t * zcl_buffer_uint32 (uint8_t *buf, uint32_t val)
 
uint8_t zcl_nv_item_init (uint16_t id, uint16_t len, void *buf)
 
uint8_t zcl_nv_write (uint16_t id, uint16_t ndx, uint16_t len, void *buf)
 
uint8_t zcl_nv_read (uint16_t id, uint16_t ndx, uint16_t len, void *buf)
 
uint32_t zcl_build_uint32 (uint8_t *swapped, uint8_t len)
 
void * zcl_cpyExtAddr (uint8_t *pDest, const uint8_t *pSrc)
 

Variables

uint8_t zcl_InSeqNum
 
uint8_t zcl_radius
 

Detailed Description

This module implements the Zigbee Cluster Library.

Macro Definition Documentation

§ ZCL_CLUSTER_ID_CLOSURES

#define ZCL_CLUSTER_ID_CLOSURES (   id)
Value:
#define ZCL_CLUSTER_ID_CLOSURES_WINDOW_COVERING
Definition: zcl.h:260
#define ZCL_CLUSTER_ID_CLOSURES_SHADE_CONFIG
Definition: zcl.h:255

§ ZCL_CLUSTER_ID_GEN

#define ZCL_CLUSTER_ID_GEN (   id)
Value:
( /* (id) >= ZCL_CLUSTER_ID_GEN_BASIC &&*/ \
#define ZCL_CLUSTER_ID_GEN_COMMISSIONING
Definition: zcl.h:432

§ ZCL_CLUSTER_ID_HVAC

#define ZCL_CLUSTER_ID_HVAC (   id)
Value:
#define ZCL_CLUSTER_ID_HVAC_PUMP_CONFIG_CONTROL
Definition: zcl.h:232
#define ZCL_CLUSTER_ID_HVAC_USER_INTERFACE_CONFIG
Definition: zcl.h:244

§ ZCL_CLUSTER_ID_LIGHTING

#define ZCL_CLUSTER_ID_LIGHTING (   id)
Value:
#define ZCL_CLUSTER_ID_LIGHTING_COLOR_CONTROL
Color Control Cluster. Attributes and commands for changing the color of a light. ...
Definition: zcl.h:219
#define ZCL_CLUSTER_ID_LIGHTING_BALLAST_CONFIG
Ballast Configuration Cluster. Attributes and commands for configuring a lighting ballast...
Definition: zcl.h:221

§ ZCL_CLUSTER_ID_MS

#define ZCL_CLUSTER_ID_MS (   id)
Value:
#define ZCL_CLUSTER_ID_MS_OCCUPANCY_SENSING
Definition: zcl.h:207
#define ZCL_CLUSTER_ID_MS_ILLUMINANCE_MEASUREMENT
Definition: zcl.h:188

§ ZCL_CLUSTER_ID_PI

#define ZCL_CLUSTER_ID_PI (   id)
Value:
#define ZCL_CLUSTER_ID_PI_GENERIC_TUNNEL
Definition: zcl.h:291
#define ZCL_CLUSTER_ID_PI_ISO7818_PROTOCOL_TUNNEL
Definition: zcl.h:360

§ ZCL_CLUSTER_ID_PI_RETAIL

#define ZCL_CLUSTER_ID_PI_RETAIL (   id)
Value:
#define ZCL_CLUSTER_ID_MOBILE_DEVICE_CONFIGURATION
Definition: zcl.h:449
#define ZCL_CLUSTER_ID_NEIGHBOR_CLEANING
Neighbor Cleaning Cluster.Interface to manage mobile devices in a network.
Definition: zcl.h:451

§ ZCL_CLUSTER_ID_SE

#define ZCL_CLUSTER_ID_SE (   id)
Value:
#define ZCL_CLUSTER_ID_SE_MDU_PAIRING
ISO7816 Tunnel Cluster. Commands and attributes for mobile office solutions using devices...
Definition: zcl.h:392
#define ZCL_CLUSTER_ID_SE_PRICE
Price Cluster. Commands and attributes for reporting price.
Definition: zcl.h:370

§ ZCL_CLUSTER_ID_SS

#define ZCL_CLUSTER_ID_SS (   id)
Value:
#define ZCL_CLUSTER_ID_SS_IAS_ZONE
Definition: zcl.h:271
#define ZCL_CLUSTER_ID_SS_IAS_WD
Definition: zcl.h:277

§ ZCL_CLUSTER_ID_TEL

#define ZCL_CLUSTER_ID_TEL (   id)
Value:
#define ZCL_CLUSTER_ID_TELECOMMUNICATIONS_INFORMATION
Information Cluster. Commands and attributes for information delivery.
Definition: zcl.h:416
#define ZCL_CLUSTER_ID_TELECOMMUNICATIONS_CHATTING
Chatting Cluster. Commands and attributes for sending chat messages.
Definition: zcl.h:421