Z-Stack API Reference  8.31.00.00
ZCL General Functions

Macros

#define zclGeneral_SendBasicResetFactoryDefaults(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_BASIC, COMMAND_BASIC_RESET_TO_FACTORY_DEFAULTS, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendIdentifyQuery(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_IDENTIFY, COMMAND_IDENTIFY_IDENTIFY_QUERY, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_StackSendIdentifyQuery(a, b, c, d)   zcl_StackSendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_IDENTIFY, COMMAND_IDENTIFY_IDENTIFY_QUERY, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendGroupAdd(a, b, c, d, e, f)   zclGeneral_SendAddGroupRequestEx( (a), (b), COMMAND_GROUPS_ADD_GROUP, (c), (d), (e), (f), TRUE )
 
#define zclGeneral_StackSendGroupAdd(a, b, c, d, e, f)   zclGeneral_SendAddGroupRequestEx( (a), (b), COMMAND_GROUPS_ADD_GROUP, (c), (d), (e), (f), FALSE )
 
#define zclGeneral_SendGroupView(a, b, c, d, e)   zclGeneral_SendGroupRequest( (a), (b), COMMAND_GROUPS_VIEW_GROUP, (c), (d), (e) )
 
#define zclGeneral_SendGroupGetMembership(a, b, c, d, e, f)   zclGeneral_SendGroupGetMembershipRequest( (a), (b), COMMAND_GROUPS_GET_GROUP_MEMBERSHIP, FALSE, ZCL_FRAME_CLIENT_SERVER_DIR, 0, (c), (d), (e), (f) )
 
#define zclGeneral_SendGroupRemove(a, b, c, d, e)   zclGeneral_SendGroupRequest( (a), (b), COMMAND_GROUPS_REMOVE_GROUP, (c), (d), (e) )
 
#define zclGeneral_SendGroupRemoveAll(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_GROUPS, COMMAND_GROUPS_REMOVE_ALL_GROUPS, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendGroupAddIfIdentifying(a, b, c, d, e, f)   zclGeneral_SendAddGroupRequestEx( (a), (b), COMMAND_GROUPS_ADD_GROUP_IF_IDENTIFYING, (c), (d), (e), (f), TRUE )
 
#define zclGeneral_SendGroupAddResponse(a, b, c, d, e, f)   zclGeneral_SendGroupResponse( (a), (b), COMMAND_GROUPS_ADD_GROUP_RESPONSE, (c), (d), (e), (f) )
 
#define zclGeneral_SendGroupGetMembershipResponse(a, b, c, d, e, f, g)   zclGeneral_SendGroupGetMembershipRequest( (a), (b), COMMAND_GROUPS_GET_GROUP_MEMBERSHIP_RESPONSE, TRUE, ZCL_FRAME_SERVER_CLIENT_DIR, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendGroupRemoveResponse(a, b, c, d, e, f)   zclGeneral_SendGroupResponse( (a), (b), COMMAND_GROUPS_REMOVE_GROUP_RESPONSE, (c), (d), (e), (f) )
 
#define zclGeneral_SendAddScene(a, b, c, d, e)   zclGeneral_SendAddSceneRequest( (a), (b), COMMAND_SCENES_ADD_SCENE, (c), (d), (e) )
 
#define zclGeneral_SendSceneView(a, b, c, d, e, f)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_VIEW_SCENE, (c), (d), (e), (f) )
 
#define zclGeneral_SendSceneRemove(a, b, c, d, e, f)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_REMOVE_SCENE, (c), (d), (e), (f) )
 
#define zclGeneral_SendSceneStore(a, b, c, d, e, f)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_STORE_SCENE, (c), (d), (e), (f) )
 
#define zclGeneral_SendSceneRecall(a, b, c, d, e, f)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_RECALL_SCENE, (c), (d), (e), (f) )
 
#define zclGeneral_SendSceneRemoveAll(a, b, c, d, e)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_REMOVE_ALL_SCENES, (c), 0, (d), (e) )
 
#define zclGeneral_SendSceneGetMembership(a, b, c, d, e)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_GET_SCENE_MEMBERSHIP, (c), 0, (d), (e) )
 
#define zclGeneral_SendSceneAddResponse(a, b, c, d, e, f, g)   zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_ADD_SCENE_RESPONSE, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendSceneViewResponse(a, b, c, d, e, f)   zclGeneral_SendSceneViewRsp( (a), (b), COMMAND_SCENES_VIEW_SCENE_RESPONSE, (c), (d), (e), (f) )
 
#define zclGeneral_SendSceneRemoveResponse(a, b, c, d, e, f, g)   zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_REMOVE_SCENE_RESPONSE, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendSceneRemoveAllResponse(a, b, c, d, e, f)   zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_REMOVE_ALL_SCENES_RESPONSE, (c), (d), 0, (e), (f) )
 
#define zclGeneral_SendSceneStoreResponse(a, b, c, d, e, f, g)   zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_STORE_SCENE_RESPONSE, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendEnhancedAddScene(a, b, c, d, e)   zclGeneral_SendAddSceneRequest( (a), (b), COMMAND_SCENES_ENHANCED_ADD_SCENE, (c), (d), (e) )
 
#define zclGeneral_SendSceneEnhancedView(a, b, c, d, e, f)   zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_ENHANCED_VIEW_SCENE, (c), (d), (e), (f) )
 
#define zclGeneral_SendSceneEnhancedAddResponse(a, b, c, d, e, f, g)   zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_ENHANCED_ADD_SCENE_RESPONSE, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendSceneEnhancedViewResponse(a, b, c, d, e, f)   zclGeneral_SendSceneViewRsp( (a), (b), COMMAND_SCENES_ENHANCED_VIEW_SCENE_RESPONSE, (c), (d), (e), (f) )
 
#define zclGeneral_SendOnOff_CmdOff(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_OFF, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendOnOff_CmdOn(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_ON, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendOnOff_CmdToggle(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_TOGGLE, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendOnOff_CmdOnWithRecallGlobalScene(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_ON_WITH_RECALL_GLOBAL_SCENE, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendLevelControlMoveToLevel(a, b, c, d, e, f)   zclGeneral_SendLevelControlMoveToLevelRequest( (a), (b), COMMAND_LEVEL_MOVE_TO_LEVEL, (c), (d), (e) ,(f) )
 
#define zclGeneral_SendLevelControlMove(a, b, c, d, e, f)   zclGeneral_SendLevelControlMoveRequest( (a), (b), COMMAND_LEVEL_MOVE, (c), (d), (e), (f) )
 
#define zclGeneral_SendLevelControlStep(a, b, c, d, e, f, g)   zclGeneral_SendLevelControlStepRequest( (a), (b), COMMAND_LEVEL_STEP, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendLevelControlStop(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_LEVEL_CONTROL, COMMAND_LEVEL_STOP, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendLevelControlMoveToLevelWithOnOff(a, b, c, d, e, f)   zclGeneral_SendLevelControlMoveToLevelRequest( (a), (b), COMMAND_LEVEL_MOVE_TO_LEVEL_WITH_ON_OFF, (c), (d), (e) ,(f) )
 
#define zclGeneral_SendLevelControlMoveWithOnOff(a, b, c, d, e, f)   zclGeneral_SendLevelControlMoveRequest( (a), (b), COMMAND_LEVEL_MOVE_WITH_ON_OFF, (c), (d), (e), (f) )
 
#define zclGeneral_SendLevelControlStepWithOnOff(a, b, c, d, e, f, g)   zclGeneral_SendLevelControlStepRequest( (a), (b), COMMAND_LEVEL_STEP_WITH_ON_OFF, (c), (d), (e), (f), (g) )
 
#define zclGeneral_SendLevelControlStopWithOnOff(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_LEVEL_CONTROL, COMMAND_LEVEL_STOP_WITH_ON_OFF, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendAlarmResetAll(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ALARMS, COMMAND_ALARMS_RESET_ALL_ALARMS, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendAlarmGet(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ALARMS, COMMAND_ALARMS_GET_ALARM, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendAlarmResetLog(a, b, c, d)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ALARMS, COMMAND_ALARMS_RESET_ALARM_LOG, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )
 
#define zclGeneral_SendLocationDataResponse(a, b, c, d, e)   zclGeneral_SendLocationData( (a), (b), COMMAND_LOCATION_DATA_RSP, ((c)->status), (&((c)->data)), (d), (e) )
 
#define zclGeneral_SendLocationDataNotif(a, b, c, d)   zclGeneral_SendLocationData( (a), (b), COMMAND_LOCATION_DATA_NOTIF, 0, (c), (d) )
 
#define zclGeneral_SendLocationDataCompactNotif(a, b, c, d)   zclGeneral_SendLocationData( (a), (b), COMMAND_LOCATION_DATA_COMPACT_NOTIF, 0, (c), (d) )
 
#define zclGeneral_SendRSSIPing(a, b, c, d, e)   zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_LOCATION, COMMAND_LOCATION_RSSI_PING, TRUE, ZCL_FRAME_SERVER_CLIENT_DIR, (d), 0, (e), 1, (c) )
 

Functions

ZStatus_t zclGeneral_RegisterCmdCallbacks (uint8_t endpoint, zclGeneral_AppCallbacks_t *callbacks)
 
ZStatus_t zclGeneral_SendOnOff_CmdOffWithEffect (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t effectId, uint8_t effectVariant, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendOnOff_CmdOnWithTimedOff (uint8_t srcEP, afAddrType_t *dstAddr, zclOnOffCtrl_t onOffCtrl, uint16_t onTime, uint16_t offWaitTime, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLevelControlMoveToLevelRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t level, uint16_t transTime, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLevelControlMoveRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t moveMode, uint8_t rate, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLevelControlStepRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t stepMode, uint8_t stepSize, uint16_t transTime, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLevelControlStopRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendGroupResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t status, uint16_t groupID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendGroupViewResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t status, aps_Group_t *grp, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendGroupGetMembershipRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t rspCmd, uint8_t direction, uint8_t capacity, uint8_t grpCnt, uint16_t *grpList, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_AddScene (uint8_t endpoint, zclGeneral_Scene_t *scene)
 
zclGeneral_Scene_tzclGeneral_FindScene (uint8_t endpoint, uint16_t groupID, uint8_t sceneID)
 
uint8_t zclGeneral_FindAllScenesForGroup (uint8_t endpoint, uint16_t groupID, uint8_t *sceneList)
 
uint8_t zclGeneral_RemoveScene (uint8_t endpoint, uint16_t groupID, uint8_t sceneID)
 
void zclGeneral_RemoveAllScenes (uint8_t endpoint, uint16_t groupID)
 
uint8_t zclGeneral_CountScenes (uint8_t endpoint)
 
uint8_t zclGeneral_CountAllScenes (void)
 
ZStatus_t zclGeneral_ReadSceneCountCB (uint16_t clusterId, uint16_t attrId, uint8_t oper, uint8_t *pValue, uint16_t *pLen)
 
ZStatus_t zclGeneral_SendAddSceneRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, zclGeneral_Scene_t *scene, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendSceneRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint16_t groupID, uint8_t sceneID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendSceneResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t status, uint16_t groupID, uint8_t sceneID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendSceneViewRsp (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t status, zclGeneral_Scene_t *scene, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendSceneGetMembershipResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t sceneStatus, uint8_t capacity, uint8_t sceneCnt, uint8_t *sceneList, uint16_t groupID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendSceneCopy (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t mode, uint16_t groupIDFrom, uint8_t sceneIDFrom, uint16_t groupIDTo, uint8_t sceneIDTo, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendSceneCopyResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t status, uint16_t groupIDFrom, uint8_t sceneIDFrom, uint8_t disableDefaultRsp, uint8_t seqNum)
 
void zclGeneral_ScenesInit (void)
 
void zclGeneral_ScenesSave (void)
 
ZStatus_t zclGeneral_SendGroupRequest (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint16_t groupID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendAddGroupRequestEx (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint16_t groupID, uint8_t *groupName, uint8_t disableDefaultRsp, uint8_t seqNum, uint8_t isReqFromApp)
 
ZStatus_t zclGeneral_SendIdentify (uint8_t srcEP, afAddrType_t *dstAddr, uint16_t identifyTime, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendIdentifyTriggerEffect (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t effectId, uint8_t effectVariant, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendIdentifyQueryResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint16_t timeout, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendAlarm (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t alarmCode, uint16_t clusterID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendAlarmReset (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t alarmCode, uint16_t clusterID, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendAlarmGetResponse (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t status, uint8_t alarmCode, uint16_t clusterID, uint32_t timeStamp, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendAlarmGetEventLog (uint8_t srcEP, afAddrType_t *dstAddr, zclGetEventLog_t *pEventLog, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendAlarmPublishEventLog (uint8_t srcEP, afAddrType_t *dstAddr, zclPublishEventLog_t *pEventLog, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLocationSetAbsolute (uint8_t srcEP, afAddrType_t *dstAddr, zclLocationAbsolute_t *absLoc, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLocationSetDevCfg (uint8_t srcEP, afAddrType_t *dstAddr, zclLocationDevCfg_t *devCfg, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLocationGetDevCfg (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t *targetAddr, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLocationGetData (uint8_t srcEP, afAddrType_t *dstAddr, zclLocationGetData_t *locData, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLocationDevCfgResponse (uint8_t srcEP, afAddrType_t *dstAddr, zclLocationDevCfgRsp_t *devCfg, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_SendLocationData (uint8_t srcEP, afAddrType_t *dstAddr, uint8_t cmd, uint8_t status, zclLocationData_t *locData, uint8_t disableDefaultRsp, uint8_t seqNum)
 
ZStatus_t zclGeneral_AddAlarm (uint8_t endpoint, zclGeneral_Alarm_t *alarm)
 
zclGeneral_Alarm_tzclGeneral_FindAlarm (uint8_t endpoint, uint8_t alarmCode, uint16_t clusterID)
 
zclGeneral_Alarm_tzclGeneral_FindEarliestAlarm (uint8_t endpoint)
 
void zclGeneral_ResetAlarm (uint8_t endpoint, uint8_t alarmCode, uint16_t clusterID)
 
void zclGeneral_ResetAllAlarms (uint8_t endpoint, uint8_t notifyApp)
 

Detailed Description

Macro Definition Documentation

§ zclGeneral_SendAddScene

#define zclGeneral_SendAddScene (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendAddSceneRequest( (a), (b), COMMAND_SCENES_ADD_SCENE, (c), (d), (e) )

§ zclGeneral_SendAlarmGet

#define zclGeneral_SendAlarmGet (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ALARMS, COMMAND_ALARMS_GET_ALARM, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send an Alarm Get Command - COMMAND_ALARMS_GET_ALARM Use like: ZStatus_t zclGeneral_SendAlarmGet uint16_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendAlarmResetAll

#define zclGeneral_SendAlarmResetAll (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ALARMS, COMMAND_ALARMS_RESET_ALL_ALARMS, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send an Alarm Reset ALL Command - COMMAND_ALARMS_RESET_ALL_ALARMS Use like: ZStatus_t zclGeneral_SendAlarmResetAll( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendAlarmResetLog

#define zclGeneral_SendAlarmResetLog (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ALARMS, COMMAND_ALARMS_RESET_ALARM_LOG, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send an Alarm Reset Log Command - COMMAND_ALARMS_RESET_ALARM_LOG Use like: ZStatus_t zclGeneral_SendAlarmResetLog( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendBasicResetFactoryDefaults

#define zclGeneral_SendBasicResetFactoryDefaults (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_BASIC, COMMAND_BASIC_RESET_TO_FACTORY_DEFAULTS, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send a Reset to Factory Defaults Command - COMMAND_BASIC_RESET_FACTORY_DEFAULTS Use like: ZStatus_t zclGeneral_SendBasicResetFactoryDefaults( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendEnhancedAddScene

#define zclGeneral_SendEnhancedAddScene (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendAddSceneRequest( (a), (b), COMMAND_SCENES_ENHANCED_ADD_SCENE, (c), (d), (e) )

§ zclGeneral_SendGroupAdd

#define zclGeneral_SendGroupAdd (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendAddGroupRequestEx( (a), (b), COMMAND_GROUPS_ADD_GROUP, (c), (d), (e), (f), TRUE )

§ zclGeneral_SendGroupAddIfIdentifying

#define zclGeneral_SendGroupAddIfIdentifying (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendAddGroupRequestEx( (a), (b), COMMAND_GROUPS_ADD_GROUP_IF_IDENTIFYING, (c), (d), (e), (f), TRUE )

§ zclGeneral_SendGroupAddResponse

#define zclGeneral_SendGroupAddResponse (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendGroupResponse( (a), (b), COMMAND_GROUPS_ADD_GROUP_RESPONSE, (c), (d), (e), (f) )

§ zclGeneral_SendGroupGetMembership

#define zclGeneral_SendGroupGetMembership (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendGroupGetMembershipRequest( (a), (b), COMMAND_GROUPS_GET_GROUP_MEMBERSHIP, FALSE, ZCL_FRAME_CLIENT_SERVER_DIR, 0, (c), (d), (e), (f) )

§ zclGeneral_SendGroupGetMembershipResponse

#define zclGeneral_SendGroupGetMembershipResponse (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendGroupGetMembershipRequest( (a), (b), COMMAND_GROUPS_GET_GROUP_MEMBERSHIP_RESPONSE, TRUE, ZCL_FRAME_SERVER_CLIENT_DIR, (c), (d), (e), (f), (g) )

§ zclGeneral_SendGroupRemove

#define zclGeneral_SendGroupRemove (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendGroupRequest( (a), (b), COMMAND_GROUPS_REMOVE_GROUP, (c), (d), (e) )

§ zclGeneral_SendGroupRemoveAll

#define zclGeneral_SendGroupRemoveAll (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_GROUPS, COMMAND_GROUPS_REMOVE_ALL_GROUPS, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send a Group Remove ALL Command - COMMAND_GROUPS_REMOVE_ALL_GROUPS Use like: ZStatus_t zclGeneral_SendGroupRemoveAll( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendGroupRemoveResponse

#define zclGeneral_SendGroupRemoveResponse (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendGroupResponse( (a), (b), COMMAND_GROUPS_REMOVE_GROUP_RESPONSE, (c), (d), (e), (f) )

§ zclGeneral_SendGroupView

#define zclGeneral_SendGroupView (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendGroupRequest( (a), (b), COMMAND_GROUPS_VIEW_GROUP, (c), (d), (e) )

§ zclGeneral_SendIdentifyQuery

#define zclGeneral_SendIdentifyQuery (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_IDENTIFY, COMMAND_IDENTIFY_IDENTIFY_QUERY, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send a Identify Query command from Application Thread Use like: ZStatus_t zclGeneral_SendIdentifyQuery( uint8_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendLevelControlMove

#define zclGeneral_SendLevelControlMove (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendLevelControlMoveRequest( (a), (b), COMMAND_LEVEL_MOVE, (c), (d), (e), (f) )

Send a Level Control Move Command - COMMAND_LEVEL_MOVE Use like: ZStatus_t zclGeneral_SendLevelControlMoveRequest( uint8_t srcEP, afAddrType_t *dstAddr, uint8_t moveMode, uint8_t rate, uint8_t disableDefaultRsp, uint8_t seqNum )

§ zclGeneral_SendLevelControlMoveToLevel

#define zclGeneral_SendLevelControlMoveToLevel (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendLevelControlMoveToLevelRequest( (a), (b), COMMAND_LEVEL_MOVE_TO_LEVEL, (c), (d), (e) ,(f) )

§ zclGeneral_SendLevelControlMoveToLevelWithOnOff

#define zclGeneral_SendLevelControlMoveToLevelWithOnOff (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendLevelControlMoveToLevelRequest( (a), (b), COMMAND_LEVEL_MOVE_TO_LEVEL_WITH_ON_OFF, (c), (d), (e) ,(f) )

Send a Level Control Move to Level with On/Off Command - COMMAND_LEVEL_MOVE_TO_LEVEL_WITH_ON_OFF Use like: ZStatus_t zclGeneral_SendLevelControlMoveToLevelWithOnOff( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t level, uint16_t transTime, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendLevelControlMoveWithOnOff

#define zclGeneral_SendLevelControlMoveWithOnOff (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendLevelControlMoveRequest( (a), (b), COMMAND_LEVEL_MOVE_WITH_ON_OFF, (c), (d), (e), (f) )

§ zclGeneral_SendLevelControlStep

#define zclGeneral_SendLevelControlStep (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendLevelControlStepRequest( (a), (b), COMMAND_LEVEL_STEP, (c), (d), (e), (f), (g) )

§ zclGeneral_SendLevelControlStepWithOnOff

#define zclGeneral_SendLevelControlStepWithOnOff (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendLevelControlStepRequest( (a), (b), COMMAND_LEVEL_STEP_WITH_ON_OFF, (c), (d), (e), (f), (g) )

§ zclGeneral_SendLevelControlStop

#define zclGeneral_SendLevelControlStop (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_LEVEL_CONTROL, COMMAND_LEVEL_STOP, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send out a Level Control Stop Command - COMMAND_LEVEL_STOP Use like: ZStatus_t zclGeneral_SendLevelControlStop( uint8_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendLevelControlStopWithOnOff

#define zclGeneral_SendLevelControlStopWithOnOff (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_LEVEL_CONTROL, COMMAND_LEVEL_STOP_WITH_ON_OFF, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send out a Level Control Stop with On/Off Command - COMMAND_LEVEL_STOP_WITH_ON_OFF Use like: ZStatus_t zclGeneral_SendLevelControlStopWithOnOff( uint8_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendLocationDataCompactNotif

#define zclGeneral_SendLocationDataCompactNotif (   a,
  b,
  c,
 
)    zclGeneral_SendLocationData( (a), (b), COMMAND_LOCATION_DATA_COMPACT_NOTIF, 0, (c), (d) )

Send a Location Data Compact Notification Command - COMMAND_LOCATION_COMPACT_DATA_NOTIFICATION Use like: ZStatus_t zclGeneral_SendLocationDataCompactNotif( uint16_t srcEP, afAddrType_t *dstAddr, zclLocationData_t *locData, uint8_t seqNum );

§ zclGeneral_SendLocationDataNotif

#define zclGeneral_SendLocationDataNotif (   a,
  b,
  c,
 
)    zclGeneral_SendLocationData( (a), (b), COMMAND_LOCATION_DATA_NOTIF, 0, (c), (d) )

Send a Location Data Notification Command - COMMAND_LOCATION_DATA_NOTIFICATION Use like: ZStatus_t zclGeneral_SendLocationDataNotif( uint16_t srcEP, afAddrType_t *dstAddr, zclLocationData_t *locData, uint8_t seqNum );

§ zclGeneral_SendLocationDataResponse

#define zclGeneral_SendLocationDataResponse (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendLocationData( (a), (b), COMMAND_LOCATION_DATA_RSP, ((c)->status), (&((c)->data)), (d), (e) )

§ zclGeneral_SendOnOff_CmdOff

#define zclGeneral_SendOnOff_CmdOff (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_OFF, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

§ zclGeneral_SendOnOff_CmdOn

#define zclGeneral_SendOnOff_CmdOn (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_ON, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

§ zclGeneral_SendOnOff_CmdOnWithRecallGlobalScene

#define zclGeneral_SendOnOff_CmdOnWithRecallGlobalScene (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_ON_WITH_RECALL_GLOBAL_SCENE, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Send an On With Recall Global Scene Command - COMMAND_ON_OFF_ON_WITH_RECALL_GLOBAL_SCENE Use like: ZStatus_t zclGeneral_SendOnOff_CmdOnWithRecallGlobalScene( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendOnOff_CmdToggle

#define zclGeneral_SendOnOff_CmdToggle (   a,
  b,
  c,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_ON_OFF, COMMAND_ON_OFF_TOGGLE, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

§ zclGeneral_SendRSSIPing

#define zclGeneral_SendRSSIPing (   a,
  b,
  c,
  d,
 
)    zcl_SendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_LOCATION, COMMAND_LOCATION_RSSI_PING, TRUE, ZCL_FRAME_SERVER_CLIENT_DIR, (d), 0, (e), 1, (c) )

§ zclGeneral_SendSceneAddResponse

#define zclGeneral_SendSceneAddResponse (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_ADD_SCENE_RESPONSE, (c), (d), (e), (f), (g) )

§ zclGeneral_SendSceneEnhancedAddResponse

#define zclGeneral_SendSceneEnhancedAddResponse (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_ENHANCED_ADD_SCENE_RESPONSE, (c), (d), (e), (f), (g) )

§ zclGeneral_SendSceneEnhancedView

#define zclGeneral_SendSceneEnhancedView (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_ENHANCED_VIEW_SCENE, (c), (d), (e), (f) )

§ zclGeneral_SendSceneEnhancedViewResponse

#define zclGeneral_SendSceneEnhancedViewResponse (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneViewRsp( (a), (b), COMMAND_SCENES_ENHANCED_VIEW_SCENE_RESPONSE, (c), (d), (e), (f) )

Send a Scene Enhanced View Response Command - COMMAND_SCENES_ENHANCED_VIEW_SCENE_RESPONSE Use like: ZStatus_t zclGeneral_SendSceneEnhancedViewResponse( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t status, zclGeneral_Scene_t *scene, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendSceneGetMembership

#define zclGeneral_SendSceneGetMembership (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_GET_SCENE_MEMBERSHIP, (c), 0, (d), (e) )

Send a Scene Get Membership Command - COMMAND_SCENES_GET_MEMBERSHIPSHIP Use like: ZStatus_t zclGeneral_SendSceneGetMembership( uint16_t srcEP, afAddrType_t *dstAddr, uint16_t groupID, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendSceneRecall

#define zclGeneral_SendSceneRecall (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_RECALL_SCENE, (c), (d), (e), (f) )

§ zclGeneral_SendSceneRemove

#define zclGeneral_SendSceneRemove (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_REMOVE_SCENE, (c), (d), (e), (f) )

§ zclGeneral_SendSceneRemoveAll

#define zclGeneral_SendSceneRemoveAll (   a,
  b,
  c,
  d,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_REMOVE_ALL_SCENES, (c), 0, (d), (e) )

Send a Scene Remove ALL Command - COMMAND_SCENES_REMOVE_ALL_SCENES Use like: ZStatus_t zclGeneral_SendSceneRemoveAll( uint16_t srcEP, afAddrType_t *dstAddr, uint16_t groupID, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendSceneRemoveAllResponse

#define zclGeneral_SendSceneRemoveAllResponse (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_REMOVE_ALL_SCENES_RESPONSE, (c), (d), 0, (e), (f) )

Send a Scene Remove All Response Command - COMMAND_SCENES_REMOVE_ALL_SCENES_RESPONSE Use like: ZStatus_t zclGeneral_SendSceneRemoveAllResponse( uint16_t srcEP, afAddrType_t *dstAddr, uint8_t status, uint16_t groupID, uint8_t disableDefaultRsp, uint8_t seqNum );

§ zclGeneral_SendSceneRemoveResponse

#define zclGeneral_SendSceneRemoveResponse (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_REMOVE_SCENE_RESPONSE, (c), (d), (e), (f), (g) )

§ zclGeneral_SendSceneStore

#define zclGeneral_SendSceneStore (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_STORE_SCENE, (c), (d), (e), (f) )

§ zclGeneral_SendSceneStoreResponse

#define zclGeneral_SendSceneStoreResponse (   a,
  b,
  c,
  d,
  e,
  f,
 
)    zclGeneral_SendSceneResponse( (a), (b), COMMAND_SCENES_STORE_SCENE_RESPONSE, (c), (d), (e), (f), (g) )

§ zclGeneral_SendSceneView

#define zclGeneral_SendSceneView (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneRequest( (a), (b), COMMAND_SCENES_VIEW_SCENE, (c), (d), (e), (f) )

§ zclGeneral_SendSceneViewResponse

#define zclGeneral_SendSceneViewResponse (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendSceneViewRsp( (a), (b), COMMAND_SCENES_VIEW_SCENE_RESPONSE, (c), (d), (e), (f) )

§ zclGeneral_StackSendGroupAdd

#define zclGeneral_StackSendGroupAdd (   a,
  b,
  c,
  d,
  e,
 
)    zclGeneral_SendAddGroupRequestEx( (a), (b), COMMAND_GROUPS_ADD_GROUP, (c), (d), (e), (f), FALSE )

§ zclGeneral_StackSendIdentifyQuery

#define zclGeneral_StackSendIdentifyQuery (   a,
  b,
  c,
 
)    zcl_StackSendCommand( (a), (b), ZCL_CLUSTER_ID_GENERAL_IDENTIFY, COMMAND_IDENTIFY_IDENTIFY_QUERY, TRUE, ZCL_FRAME_CLIENT_SERVER_DIR, (c), 0, (d), 0, NULL )

Function Documentation

§ zclGeneral_AddAlarm()

ZStatus_t zclGeneral_AddAlarm ( uint8_t  endpoint,
zclGeneral_Alarm_t alarm 
)

Add an alarm for a cluster

§ zclGeneral_AddScene()

ZStatus_t zclGeneral_AddScene ( uint8_t  endpoint,
zclGeneral_Scene_t scene 
)

Add a scene for an endpoint

§ zclGeneral_CountAllScenes()

uint8_t zclGeneral_CountAllScenes ( void  )

Count the number of scenes

§ zclGeneral_CountScenes()

uint8_t zclGeneral_CountScenes ( uint8_t  endpoint)

Count the number of scenes for an endpoint

§ zclGeneral_FindAlarm()

zclGeneral_Alarm_t* zclGeneral_FindAlarm ( uint8_t  endpoint,
uint8_t  alarmCode,
uint16_t  clusterID 
)

Find an alarm with alarmCode and clusterID

§ zclGeneral_FindAllScenesForGroup()

uint8_t zclGeneral_FindAllScenesForGroup ( uint8_t  endpoint,
uint16_t  groupID,
uint8_t *  sceneList 
)

Get all the scenes with groupID

§ zclGeneral_FindEarliestAlarm()

zclGeneral_Alarm_t* zclGeneral_FindEarliestAlarm ( uint8_t  endpoint)

Find an alarm with the earliest timestamp

§ zclGeneral_FindScene()

zclGeneral_Scene_t* zclGeneral_FindScene ( uint8_t  endpoint,
uint16_t  groupID,
uint8_t  sceneID 
)

Find a scene with endpoint and sceneID

§ zclGeneral_ReadSceneCountCB()

ZStatus_t zclGeneral_ReadSceneCountCB ( uint16_t  clusterId,
uint16_t  attrId,
uint8_t  oper,
uint8_t *  pValue,
uint16_t *  pLen 
)

Read callback function for the Scene Count attribute.

§ zclGeneral_RegisterCmdCallbacks()

ZStatus_t zclGeneral_RegisterCmdCallbacks ( uint8_t  endpoint,
zclGeneral_AppCallbacks_t callbacks 
)

Register for callbacks from this cluster library

§ zclGeneral_RemoveAllScenes()

void zclGeneral_RemoveAllScenes ( uint8_t  endpoint,
uint16_t  groupID 
)

Remove all scenes for an endpoint

§ zclGeneral_RemoveScene()

uint8_t zclGeneral_RemoveScene ( uint8_t  endpoint,
uint16_t  groupID,
uint8_t  sceneID 
)

Remove a scene with endpoint and sceneID

§ zclGeneral_ResetAlarm()

void zclGeneral_ResetAlarm ( uint8_t  endpoint,
uint8_t  alarmCode,
uint16_t  clusterID 
)

Remove a scene with endpoint and sceneID

§ zclGeneral_ResetAllAlarms()

void zclGeneral_ResetAllAlarms ( uint8_t  endpoint,
uint8_t  notifyApp 
)

Remove all scenes with endpoint

§ zclGeneral_ScenesInit()

void zclGeneral_ScenesInit ( void  )

Initialize the Scenes Table

§ zclGeneral_ScenesSave()

void zclGeneral_ScenesSave ( void  )

Save the Scenes Table - Something has changed

§ zclGeneral_SendAddGroupRequestEx()

ZStatus_t zclGeneral_SendAddGroupRequestEx ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint16_t  groupID,
uint8_t *  groupName,
uint8_t  disableDefaultRsp,
uint8_t  seqNum,
uint8_t  isReqFromApp 
)

Send a Group Add command (request) groupName - pointer to Group Name. This is a Zigbee string data type, so the first byte is the length of the name (in bytes), then the name.

§ zclGeneral_SendAddSceneRequest()

ZStatus_t zclGeneral_SendAddSceneRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
zclGeneral_Scene_t scene,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send an (Enhanced) Add Scene Request message

§ zclGeneral_SendAlarm()

ZStatus_t zclGeneral_SendAlarm ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  alarmCode,
uint16_t  clusterID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send out an Alarm Command

§ zclGeneral_SendAlarmGetEventLog()

ZStatus_t zclGeneral_SendAlarmGetEventLog ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclGetEventLog_t pEventLog,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send out an Alarm Get Event Log Command

§ zclGeneral_SendAlarmGetResponse()

ZStatus_t zclGeneral_SendAlarmGetResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  status,
uint8_t  alarmCode,
uint16_t  clusterID,
uint32_t  timeStamp,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send out an Alarm Get Response Command

§ zclGeneral_SendAlarmPublishEventLog()

ZStatus_t zclGeneral_SendAlarmPublishEventLog ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclPublishEventLog_t pEventLog,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send out an an Alarm Publish Event Log Command

§ zclGeneral_SendAlarmReset()

ZStatus_t zclGeneral_SendAlarmReset ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  alarmCode,
uint16_t  clusterID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send out an Alarm Reset Command

§ zclGeneral_SendGroupGetMembershipRequest()

ZStatus_t zclGeneral_SendGroupGetMembershipRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  rspCmd,
uint8_t  direction,
uint8_t  capacity,
uint8_t  grpCnt,
uint16_t *  grpList,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send Group Membership Command

§ zclGeneral_SendGroupRequest()

ZStatus_t zclGeneral_SendGroupRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint16_t  groupID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Group command (request) - not Group Add or Remove All

§ zclGeneral_SendGroupResponse()

ZStatus_t zclGeneral_SendGroupResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  status,
uint16_t  groupID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send Group Response (not Group View Response)

  • Use MACROS instead: zclGeneral_SendGroupAddResponse or zclGeneral_SendGroupRemoveResponse

§ zclGeneral_SendGroupViewResponse()

ZStatus_t zclGeneral_SendGroupViewResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  status,
aps_Group_t *  grp,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send Group Response Command

§ zclGeneral_SendIdentify()

ZStatus_t zclGeneral_SendIdentify ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint16_t  identifyTime,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Identify message

§ zclGeneral_SendIdentifyQueryResponse()

ZStatus_t zclGeneral_SendIdentifyQueryResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint16_t  timeout,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Identify Query Response message

§ zclGeneral_SendIdentifyTriggerEffect()

ZStatus_t zclGeneral_SendIdentifyTriggerEffect ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  effectId,
uint8_t  effectVariant,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Trigger Effect message

§ zclGeneral_SendLevelControlMoveRequest()

ZStatus_t zclGeneral_SendLevelControlMoveRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  moveMode,
uint8_t  rate,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send out a Level Control Move Request cmd - Step or Step with On/Off moveMode - LEVEL_MOVE_UP or LEVEL_MOVE_DOWN rate - number of steps to take per second

§ zclGeneral_SendLevelControlMoveToLevelRequest()

ZStatus_t zclGeneral_SendLevelControlMoveToLevelRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  level,
uint16_t  transTime,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send out a Level Control Move to Level Request cmd - Move or Move with On/Off level - what level to move to transitionTime - how long to take to get to the level (in seconds).

§ zclGeneral_SendLevelControlStepRequest()

ZStatus_t zclGeneral_SendLevelControlStepRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  stepMode,
uint8_t  stepSize,
uint16_t  transTime,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send out a Level Control Step Request cmd - Step or Step with On/Off stepMode - LEVEL_STEP_UP or LEVEL_STEP_DOWN amount - number of levels to step transitionTime - time to take to perform a single step

§ zclGeneral_SendLevelControlStopRequest()

ZStatus_t zclGeneral_SendLevelControlStopRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send out a Level Control Stop Command

 this command has no parameters

§ zclGeneral_SendLocationData()

ZStatus_t zclGeneral_SendLocationData ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  status,
zclLocationData_t locData,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Location Data Response, Location Data Notification or Compact Location Data Notification message.

§ zclGeneral_SendLocationDevCfgResponse()

ZStatus_t zclGeneral_SendLocationDevCfgResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclLocationDevCfgRsp_t devCfg,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Set Device Configuration Response message

§ zclGeneral_SendLocationGetData()

ZStatus_t zclGeneral_SendLocationGetData ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclLocationGetData_t locData,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Get Location Data message

§ zclGeneral_SendLocationGetDevCfg()

ZStatus_t zclGeneral_SendLocationGetDevCfg ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t *  targetAddr,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Get Device Configuration message

§ zclGeneral_SendLocationSetAbsolute()

ZStatus_t zclGeneral_SendLocationSetAbsolute ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclLocationAbsolute_t absLoc,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Set Absolute Location message

§ zclGeneral_SendLocationSetDevCfg()

ZStatus_t zclGeneral_SendLocationSetDevCfg ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclLocationDevCfg_t devCfg,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Set Device Configuration message

§ zclGeneral_SendOnOff_CmdOffWithEffect()

ZStatus_t zclGeneral_SendOnOff_CmdOffWithEffect ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  effectId,
uint8_t  effectVariant,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send out an Off with Effect Command effectId - fading effect to use when switching light off effectVariant - which variant of effect to be triggered

§ zclGeneral_SendOnOff_CmdOnWithTimedOff()

ZStatus_t zclGeneral_SendOnOff_CmdOnWithTimedOff ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
zclOnOffCtrl_t  onOffCtrl,
uint16_t  onTime,
uint16_t  offWaitTime,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Call to send out an On with Timed Off Command onOffCtrl - how the lamp is to be operated onTime - the length of time (in 1/10ths second) that the lamp is to remain on, before automatically turning off offWaitTime - the length of time (in 1/10ths second) that the lamp shall remain off, and guarded to prevent an on command turning the light back on.

§ zclGeneral_SendSceneCopy()

ZStatus_t zclGeneral_SendSceneCopy ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  mode,
uint16_t  groupIDFrom,
uint8_t  sceneIDFrom,
uint16_t  groupIDTo,
uint8_t  sceneIDTo,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Scene Copy Request

§ zclGeneral_SendSceneCopyResponse()

ZStatus_t zclGeneral_SendSceneCopyResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  status,
uint16_t  groupIDFrom,
uint8_t  sceneIDFrom,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send Scene Copy Response message

§ zclGeneral_SendSceneGetMembershipResponse()

ZStatus_t zclGeneral_SendSceneGetMembershipResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  sceneStatus,
uint8_t  capacity,
uint8_t  sceneCnt,
uint8_t *  sceneList,
uint16_t  groupID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send Scene Get Membership response message

§ zclGeneral_SendSceneRequest()

ZStatus_t zclGeneral_SendSceneRequest ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint16_t  groupID,
uint8_t  sceneID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send a Scene command (request) - not Scene Add

§ zclGeneral_SendSceneResponse()

ZStatus_t zclGeneral_SendSceneResponse ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  status,
uint16_t  groupID,
uint8_t  sceneID,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send Scene response messages for either COMMAND_SCENES_ADD_SCENE_RESPONSE, COMMAND_SCENES_REMOVE_SCENE_RESPONSE or COMMAND_SCENES_STORE_SCENE_RESPONSE

§ zclGeneral_SendSceneViewRsp()

ZStatus_t zclGeneral_SendSceneViewRsp ( uint8_t  srcEP,
afAddrType_t *  dstAddr,
uint8_t  cmd,
uint8_t  status,
zclGeneral_Scene_t scene,
uint8_t  disableDefaultRsp,
uint8_t  seqNum 
)

Send Scene (Enhanced) View response message