Z-Stack API Reference  7.10.00.08
ZCL Green Power feature

This module implements the Zigbee Green Power feature. More...

Modules

 Attribute formats
 Attribute formats.
 
 Default Values for GP Sink
 These are default values used by GP Sinks.
 
 GP Proxy Defaults
 Bit masks showing which GP functions supported.
 
 GP callback structs
 Structs used for GP callbacks.
 
 GP commands
 GP commands.
 
 Green Power Cluster Attribute IDs
 This group defines the IDs used for each Green Power Cluster attribute.
 
 Green Power Cluster Commands
 Green Power Cluster Commands.
 
 Green Power Simple Descriptor
 This group defines the values for the simple descriptor of the internal Green Power endpoint.
 
 Green Power Stack Messages
 gp stack messages
 
 Options for commands
 Options for commands.
 
 Other GP Constants
 Other relevant GP constants.
 
 Zigbee PRO Green Power Proxy specification
 Bit masks showing which GPP functions supported.
 
 Zigbee PRO Green Power Sink specification
 Bit masks showing which GPS functions supported.
 

Files

file  zcl_green_power.h
 ZCL Green Power header.
 

Data Structures

struct  zclGp_AppCallbacks_t
 Register Callbacks table entry - enter function pointers for callbacks that the green power application would like to receive. More...
 
struct  GpSink_AppCallbacks_t
 Register Callbacks table entry - enter function pointers for callbacks that the application would like to receive when processing sink functionality. More...
 

Typedefs

typedef void(* zclGCB_GP_Pairing_t) (zclGpPairing_t *pCmd)
 From sink to proxies to (de)register for tunneling service or to remove GPD from the network.
 
typedef void(* zclGCB_GP_Response_t) (zclGpResponse_t *pCmd)
 From sink to selected proxies, to provide data to be transmitted to Rx-capable GPD.
 
typedef void(* zclGCB_GP_Proxy_Commissioning_Mode_t) (zclGpProxyCommissioningMode_t *pCmd)
 From sink to proxies in the whole network to indicate commissioning mode.
 
typedef void(* zclGCB_GP_Proxy_Table_Request_t) (zclGpTableRequest_t *pRsp)
 To request selected Proxy Table entries, by index or by GPD ID.
 
typedef void(* GPDFCB_GP_identify_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process identify command.
 
typedef void(* GPDFCB_GP_RecallScene_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process recall scene command.
 
typedef void(* GPDFCB_GP_StoreScene_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Store scene command.
 
typedef void(* GPDFCB_GP_Off_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Off command.
 
typedef void(* GPDFCB_GP_On_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process On command.
 
typedef void(* GPDFCB_GP_Toggle_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Toggle command.
 
typedef void(* GPDFCB_GP_LevelControlStop_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level Control Stop command.
 
typedef void(* GPDFCB_GP_MoveUp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control move up command.
 
typedef void(* GPDFCB_GP_MoveDown_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control move down command.
 
typedef void(* GPDFCB_GP_StepUp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control step up command.
 
typedef void(* GPDFCB_GP_StepDown_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control move down command.
 
typedef void(* GPDFCB_GP_MoveUpWithOnOff_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control move up with on/off command.
 
typedef void(* GPDFCB_GP_MoveDownWithOnOff_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control move down with on/off command.
 
typedef void(* GPDFCB_GP_StepUpWithOnOff_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control step up with on/off command.
 
typedef void(* GPDFCB_GP_StepDownWithOnOff_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Level control step down with on/off command.
 
typedef void(* GPDFCB_GP_MoveHueStop_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Hue Stop command.
 
typedef void(* GPDFCB_GP_MoveHueUp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Move hue up command.
 
typedef void(* GPDFCB_GP_MoveHueDown_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Move hue down command.
 
typedef void(* GPDFCB_GP_StepHueUp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control step hue up command.
 
typedef void(* GPDFCB_GP_StepHueDown_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control step hue down command.
 
typedef void(* GPDFCB_GP_MoveSaturationStop_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Move Saturation stop command.
 
typedef void(* GPDFCB_GP_MoveSaturationUp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Move Saturation up command.
 
typedef void(* GPDFCB_GP_MoveSaturationDown_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Move Saturation down command.
 
typedef void(* GPDFCB_GP_StepSaturationUp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Step Saturation up command.
 
typedef void(* GPDFCB_GP_StepSaturationDown_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Step Saturation down command.
 
typedef void(* GPDFCB_GP_MoveColor_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Move Color command.
 
typedef void(* GPDFCB_GP_StepColor_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Color Control Step Color command.
 
typedef void(* GPDFCB_GP_LockDoor_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process DoorLock Lock command.
 
typedef void(* GPDFCB_GP_UnlockDoor_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process DoorLock Unlock command.
 
typedef void(* GPDFCB_GP_AttributeReporting_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Attribute Reporting command.
 
typedef void(* GPDFCB_GP_MfrSpecificReporting_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Manufacturer Specific Reporting command.
 
typedef void(* GPDFCB_GP_MultiClusterReporting_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process MultiCluster Reporting command.
 
typedef void(* GPDFCB_GP_MfrSpecificMultiReporting_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Manufacturer Specific MultiCluster Reporting command.
 
typedef void(* GPDFCB_GP_RequestAttributes_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Request Attributes command.
 
typedef void(* GPDFCB_GP_ReadAttributeRsp_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process Read Attribute Response command.
 
typedef void(* GPDFCB_GP_zclTunneling_t) (zclGpNotification_t *zclGpNotification)
 From GPD to sink to process ZCL Tunneling command.
 
typedef void(* zclGPCB_CommissioningMode_t) (bool isEntering, bool hasTime, uint16_t time)
 To process Commissioning Mode command.
 

Functions

ZStatus_t zclGp_RegisterCmdCallbacks (uint8_t endpoint, zclGp_AppCallbacks_t *callbacks)
 
ZStatus_t zclGp_SendGpProxyTableResponse (afAddrType_t *dstAddr, zclGpTableResponse_t *rsp, uint8_t seqNum)
 
ZStatus_t zclGp_SendGpNotificationCommand (gpNotificationCmd_t *cmd, uint8_t secNum)
 
ZStatus_t zclGp_SendGpCommissioningNotificationCommand (gpCommissioningNotificationCmd_t *pCmd, uint8_t secNumber, gpdID_t *pGpdID, uint8_t *entry)
 
void gp_CreateNotificationMsgList (gpNotificationMsg_t **pHead)
 
void gp_CreateCmdPayloadMsgList (gpCmdPayloadMsg_t **pHead)
 
gpNotificationMsg_tgp_AddNotificationMsgNode (gpNotificationMsg_t **pHead, gpCmdPayloadMsg_t *pMsg)
 
gpCmdPayloadMsg_tgp_AddCmdPayloadMsgNode (gpCmdPayloadMsg_t **pHead, uint8_t *pBuf, uint8_t len)
 
gpNotificationMsg_tgp_GetHeadNotificationMsg (void)
 
gpNotificationMsg_t ** gp_GetPHeadNotification (void)
 
gpCmdPayloadMsg_tgp_GetHeadCmdPayloadMsg (void)
 
gpCmdPayloadMsg_t ** gp_GetPHeadCmdPayload (void)
 
void gp_NotificationMsgClean (gpNotificationMsg_t **pHead)
 
void gp_CmdPayloadMsgClean (gpCmdPayloadMsg_t **pHead)
 
uint8_t gp_getProxyTableByIndex (uint16_t nvIndex, uint8_t *pEntry)
 
uint8_t gp_getSinkTableByIndex (uint16_t nvIndex, uint8_t *pEntry)
 
uint8_t gp_getProxyTableByGpId (gpdID_t *gpd_ID, uint8_t *pEntry, uint16_t *NvProxyTableIndex)
 
uint8_t gp_getSinkTableByGpId (gpdID_t *gpd_ID, uint8_t *pEntry, uint16_t *NvSinkTableIndex)
 
void gp_ResetProxyTblEntry (uint8_t *entry)
 
void gp_ResetSinkTblEntry (uint8_t *entry)
 

Detailed Description

This module implements the Zigbee Green Power feature.