Z-Stack API Reference  8.31.00.00
ZCL General Typedefs

Data Structures

struct  zclGeneral_Scene_extField_t
 
struct  zclGeneral_Scene_t
 
struct  zclIdentifyUpdateCommState_t
 
struct  zclGeneral_Alarm_t
 
struct  zclGetEventLog_t
 
struct  zclEventLogPayload_t
 
struct  zclPublishEventLog_t
 
struct  zclLocationAbsolute_t
 
struct  zclLocationDevCfg_t
 
struct  locationbits_t
 
union  location_t
 
struct  zclLocationGetData_t
 
struct  zclLocationDevCfgRsp_t
 
struct  zclLocationCalculated_t
 
struct  zclLocationData_t
 
struct  zclLocationDataRsp_t
 
struct  zclIdentify_t
 
struct  zclIdentifyQuery_t
 
struct  zclIdentifyTriggerEffect_t
 
struct  zclIdentifyQueryRsp_t
 
struct  zclOffWithEffect_t
 
struct  zclOnOffCtrlBits_t
 
union  zclOnOffCtrl_t
 
struct  zclOnWithTimedOff_t
 
struct  zclLCMoveToLevel_t
 
struct  zclLCMove_t
 
struct  zclLCStep_t
 
struct  zclLCStop_t
 
struct  zclLCMoveFreq_t
 
struct  zclGroupRsp_t
 
struct  zclSceneReq_t
 
struct  zclSceneRsp_t
 
struct  zclAlarm_t
 
struct  zclLocation_t
 
struct  zclLocationRsp_t
 
struct  zclGeneral_AppCallbacks_t
 

Typedefs

typedef void(* zclGCB_BasicReset_t) (void)
 
typedef void(* zclGCB_Identify_t) (zclIdentify_t *pCmd)
 This callback is called to process an incoming Identify command.
 
typedef void(* zclGCB_IdentifyQuery_t) (zclIdentifyQuery_t *pCmd)
 This callback is called to process an incoming Identify Query command.
 
typedef void(* zclGCB_IdentifyTriggerEffect_t) (zclIdentifyTriggerEffect_t *pCmd)
 This callback is called to process an incoming Identify Trigger Effect command.
 
typedef ZStatus_t(* zclGCB_IdentifyUpdateCommState_t) (zclIdentifyUpdateCommState_t *pCmd)
 This callback is called to process an incoming Identify Update Commission State command.
 
typedef void(* zclGCB_IdentifyQueryRsp_t) (zclIdentifyQueryRsp_t *pRsp)
 This callback is called to process an incoming Identify Query Response command.
 
typedef void(* zclGCB_OnOff_t) (uint8_t cmd)
 This callback is called to process an incoming On, Off or Toggle command.
 
typedef void(* zclGCB_OnOff_OffWithEffect_t) (zclOffWithEffect_t *pCmd)
 This callback is called to process an incoming Off with Effect.
 
typedef void(* zclGCB_OnOff_OnWithRecallGlobalScene_t) (void)
 This callback is called to process an incoming On with Recall Global Scene command.
 
typedef void(* zclGCB_OnOff_OnWithTimedOff_t) (zclOnWithTimedOff_t *pCmd)
 This callback is called to process an incoming On with Timed Off.
 
typedef void(* zclGCB_LevelControlMoveToLevel_t) (zclLCMoveToLevel_t *pCmd)
 This callback is called to process a Level Control - Move to Level command.
 
typedef void(* zclGCB_LevelControlMove_t) (zclLCMove_t *pCmd)
 This callback is called to process a Level Control - Move command.
 
typedef void(* zclGCB_LevelControlStep_t) (zclLCStep_t *pCmd)
 This callback is called to process a Level Control - Step command.
 
typedef void(* zclGCB_LevelControlStop_t) (zclLCStop_t *pCmd)
 This callback is called to process a Level Control - Stop command.
 
typedef void(* zclGCB_LevelControlMoveFreq_t) (zclLCMoveFreq_t *pCmd)
 This callback is called to process a Level Control - Move to Closest Frequency command.
 
typedef void(* zclGCB_GroupRsp_t) (zclGroupRsp_t *pRsp)
 
typedef uint8_t(* zclGCB_SceneStoreReq_t) (zclSceneReq_t *pReq)
 
typedef void(* zclGCB_SceneRecallReq_t) (zclSceneReq_t *pReq)
 
typedef void(* zclGCB_SceneRsp_t) (zclSceneRsp_t *pRsp)
 
typedef void(* zclGCB_Alarm_t) (uint8_t direction, zclAlarm_t *pAlarm)
 This callback is called to process an incoming Alarm request or response command.
 
typedef void(* zclGCB_GetEventLog_t) (uint8_t srcEP, afAddrType_t *srcAddr, zclGetEventLog_t *pEventLog, uint8_t seqNum)
 This callback is called to process an incoming Alarm Get Event Log command.
 
typedef void(* zclGCB_PublishEventLog_t) (afAddrType_t *srcAddr, zclPublishEventLog_t *pEventLog)
 This callback is called to process an incoming Alarm Publish Event Log command.
 
typedef void(* zclGCB_Location_t) (zclLocation_t *pCmd)
 This callback is called to to process an incoming RSSI Location command.
 
typedef void(* zclGCB_LocationRsp_t) (zclLocationRsp_t *pRsp)
 

Detailed Description

Typedef Documentation

§ zclGCB_BasicReset_t

typedef void(* zclGCB_BasicReset_t) (void)

This callback is called to process an incoming Reset to Factory Defaults command. On receipt of this command, the device resets all the attributes of all its clusters to their factory defaults.

§ zclGCB_GroupRsp_t

typedef void(* zclGCB_GroupRsp_t) (zclGroupRsp_t *pRsp)

This callback is called to process an received Group Response message. This means that this app sent the request message.

§ zclGCB_LocationRsp_t

typedef void(* zclGCB_LocationRsp_t) (zclLocationRsp_t *pRsp)

This callback is called to process an incoming RSSI Location response command. This means that this app sent the request for this response.

§ zclGCB_SceneRecallReq_t

typedef void(* zclGCB_SceneRecallReq_t) (zclSceneReq_t *pReq)

This callback is called to process an incoming Scene Recall request The app will use what's in the "extField" to restore to these settings.

§ zclGCB_SceneRsp_t

typedef void(* zclGCB_SceneRsp_t) (zclSceneRsp_t *pRsp)

This callback is called to process an incoming Scene responses. This means that this app sent the request for this response.

§ zclGCB_SceneStoreReq_t

typedef uint8_t(* zclGCB_SceneStoreReq_t) (zclSceneReq_t *pReq)

This callback is called to process an incoming Scene Store request. The app will fill in the "extField" with what is needed to restore its current settings. Before overwriting the content of the scene, App needs to verify if there was a change with the previous configuration. App function returns TRUE if there was a change, otherwise returns FALSE.