|
Z-Stack API Reference
3.3.1
|
This group defines the functions for IAS devices. More...
Functions | |
| ZStatus_t | zclSS_RegisterCmdCallbacks (uint8 endpoint, zclSS_AppCallbacks_t *callbacks) |
| ZStatus_t | zclSS_IAS_Send_ZoneStatusChangeNotificationCmd (uint8 srcEP, afAddrType_t *dstAddr, uint16 zoneStatus, uint8 extendedStatus, uint8 zoneID, uint16 delay, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_IAS_Send_ZoneStatusEnrollRequestCmd (uint8 srcEP, afAddrType_t *dstAddr, uint16 zoneType, uint16 manufacturerCode, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_IAS_Send_ZoneStatusEnrollResponseCmd (uint8 srcEP, afAddrType_t *dstAddr, uint8 responseCode, uint8 zoneID, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_IAS_Send_ZoneStatusInitTestModeCmd (uint8 srcEP, afAddrType_t *dstAddr, zclZoneInitTestMode_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| void | zclSS_UpdateZoneAddress (uint8 endpoint, uint8 zoneID, uint8 *ieeeAddr) |
| uint8 | zclSS_RemoveZone (uint8 endpoint, uint8 zoneID) |
| IAS_ACE_ZoneTable_t * | zclSS_FindZone (uint8 endpoint, uint8 zoneID) |
| ZStatus_t | zclSS_ParseInCmd_ACE_Arm (zclACEArm_t *pCmd, uint8 *pInBuf) |
| ZStatus_t | zclSS_ParseInCmd_ACE_Bypass (zclACEBypass_t *pCmd, uint8 *pInBuf) |
| ZStatus_t | zclSS_ParseInCmd_ACE_GetZoneInformationResponse (zclACEGetZoneInfoRsp_t *pCmd, uint8 *pInBuf) |
| ZStatus_t | zclSS_ParseInCmd_ACE_ZoneStatusChanged (zclACEZoneStatusChanged_t *pCmd, uint8 *pInBuf) |
| ZStatus_t | zclSS_Send_IAS_ACE_ArmCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEArm_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_BypassCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEBypass_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_GetZoneInformationCmd (uint8 srcEP, afAddrType_t *dstAddr, uint8 zoneID, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_GetZoneStatusCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEGetZoneStatus_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_ArmResponse (uint8 srcEP, afAddrType_t *dstAddr, uint8 armNotification, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_GetZoneIDMapResponseCmd (uint8 srcEP, afAddrType_t *dstAddr, uint16 *zoneIDMap, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_GetZoneInformationResponseCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEGetZoneInfoRsp_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_ZoneStatusChangedCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEZoneStatusChanged_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_PanelStatusChangedCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEPanelStatusChanged_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_GetPanelStatusResponseCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEGetPanelStatusRsp_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_SetBypassedZoneListCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACESetBypassedZoneList_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_BypassResponseCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEBypassRsp_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_ACE_GetZoneStatusResponseCmd (uint8 srcEP, afAddrType_t *dstAddr, zclACEGetZoneStatusRsp_t *pCmd, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_WD_StartWarningCmd (uint8 srcEP, afAddrType_t *dstAddr, zclWDStartWarning_t *warning, uint8 disableDefaultRsp, uint8 seqNum) |
| ZStatus_t | zclSS_Send_IAS_WD_SquawkCmd (uint8 srcEP, afAddrType_t *dstAddr, zclWDSquawk_t *squawk, uint8 disableDefaultRsp, uint8 seqNum) |
This group defines the functions for IAS devices.
| #define zclSS_IAS_Send_ZoneStatusInitNormalOperationModeCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send a InitNormalOperationMode Cmd ( IAS Zone Cluster ) Use like: zclSS_IAS_Send_ZoneStatusInitNormalOperationModeCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| #define zclSS_Send_IAS_ACE_EmergencyCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send an Emergency Cmd ( IAS ACE Cluster ) Use like: ZStatus_t zclSS_Send_IAS_ACE_EmergencyCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| #define zclSS_Send_IAS_ACE_FireCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send a Fire Cmd ( IAS ACE Cluster ) Use like: ZStatus_t zclSS_Send_IAS_ACE_FireCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| #define zclSS_Send_IAS_ACE_GetBypassedZoneListCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send a GetBypassedZoneList Cmd ( IAS ACE Cluster ) Use like: ZStatus_t zclSS_Send_IAS_ACE_GetBypassedZoneListCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| #define zclSS_Send_IAS_ACE_GetPanelStatusCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send a GetPanelStatus Cmd ( IAS ACE Cluster ) Use like: ZStatus_t zclSS_Send_IAS_ACE_GetPanelStatusCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| #define zclSS_Send_IAS_ACE_GetZoneIDMapCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send a GetZoneIDMap Cmd ( IAS ACE Cluster ) Use like: ZStatus_t zclSS_Send_IAS_ACE_GetZoneIDMapCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| #define zclSS_Send_IAS_ACE_PanicCmd | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
Send a Panic Cmd ( IAS ACE Cluster ) Use like: ZStatus_t zclSS_Send_IAS_ACE_PanicCmd( uint16 srcEP, afAddrType_t *dstAddr, uint8 disableDefaultRsp, uint8 seqNum );.
| IAS_ACE_ZoneTable_t* zclSS_FindZone | ( | uint8 | endpoint, |
| uint8 | zoneID | ||
| ) |
| endpoint | - endpoint of zone to be found |
| zoneID | - ID to look for zone |
| ZStatus_t zclSS_IAS_Send_ZoneStatusChangeNotificationCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| uint16 | zoneStatus, | ||
| uint8 | extendedStatus, | ||
| uint8 | zoneID, | ||
| uint16 | delay, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| zoneStatus | - current zone status - bit map |
| extendedStatus | - bit map, currently set to All zeros ( reserved) |
| zoneID | - allocated zone ID |
| delay | - delay from change in ZoneStatus attr to transmission of change notification cmd |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_IAS_Send_ZoneStatusEnrollRequestCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| uint16 | zoneType, | ||
| uint16 | manufacturerCode, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| zoneType | - current value of Zone Type attribute |
| manufacturerCode | - manuf. code from node descriptor for the device |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_IAS_Send_ZoneStatusEnrollResponseCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| uint8 | responseCode, | ||
| uint8 | zoneID, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| responseCode | - value of response Code |
| zoneID | - index to the zone table of the CIE |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_IAS_Send_ZoneStatusInitTestModeCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclZoneInitTestMode_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_ParseInCmd_ACE_Arm | ( | zclACEArm_t * | pCmd, |
| uint8 * | pInBuf | ||
| ) |
| pCmd | - pointer to the output data struct |
| pInBuf | - pointer to the input data buffer |
| ZStatus_t zclSS_ParseInCmd_ACE_Bypass | ( | zclACEBypass_t * | pCmd, |
| uint8 * | pInBuf | ||
| ) |
| pCmd | - pointer to the output data struct |
| pInBuf | - pointer to the input data buffer |
| ZStatus_t zclSS_ParseInCmd_ACE_GetZoneInformationResponse | ( | zclACEGetZoneInfoRsp_t * | pCmd, |
| uint8 * | pInBuf | ||
| ) |
| pCmd | - pointer to the output data struct |
| pInBuf | - pointer to the input data buffer |
| ZStatus_t zclSS_ParseInCmd_ACE_ZoneStatusChanged | ( | zclACEZoneStatusChanged_t * | pCmd, |
| uint8 * | pInBuf | ||
| ) |
| pCmd | - pointer to the output data struct |
| pInBuf | - pointer to the input data buffer |
| ZStatus_t zclSS_RegisterCmdCallbacks | ( | uint8 | endpoint, |
| zclSS_AppCallbacks_t * | callbacks | ||
| ) |
| endpoint | - application's endpoint |
| callbacks | - pointer to the callback record. |
| uint8 zclSS_RemoveZone | ( | uint8 | endpoint, |
| uint8 | zoneID | ||
| ) |
| endpoint | - endpoint of zone to be removed |
| zoneID | - ID to look for zone |
| ZStatus_t zclSS_Send_IAS_ACE_ArmCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEArm_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_ArmResponse | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| uint8 | armNotification, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| armNotification | - notification parameter |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_BypassCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEBypass_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_BypassResponseCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEBypassRsp_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_GetPanelStatusResponseCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEGetPanelStatusRsp_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_GetZoneIDMapResponseCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| uint16 * | zoneIDMap, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| zoneIDMap | - pointer to an array of 16 uint16 |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_GetZoneInformationCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| uint8 | zoneID, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| zoneID | - 8 bit value from 0 to 255 |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_GetZoneInformationResponseCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEGetZoneInfoRsp_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_GetZoneStatusCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEGetZoneStatus_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_GetZoneStatusResponseCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEGetZoneStatusRsp_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_PanelStatusChangedCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEPanelStatusChanged_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_SetBypassedZoneListCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACESetBypassedZoneList_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_ACE_ZoneStatusChangedCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclACEZoneStatusChanged_t * | pCmd, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| pCmd | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_WD_SquawkCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclWDSquawk_t * | squawk, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| squawk | - pointer to the command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| ZStatus_t zclSS_Send_IAS_WD_StartWarningCmd | ( | uint8 | srcEP, |
| afAddrType_t * | dstAddr, | ||
| zclWDStartWarning_t * | warning, | ||
| uint8 | disableDefaultRsp, | ||
| uint8 | seqNum | ||
| ) |
| srcEP | - Sending application's endpoint |
| dstAddr | - where you want the message to go |
| warning | - pointer to command structure |
| disableDefaultRsp | - toggle for enabling/disabling default response |
| seqNum | - command sequence number |
| void zclSS_UpdateZoneAddress | ( | uint8 | endpoint, |
| uint8 | zoneID, | ||
| uint8 * | ieeeAddr | ||
| ) |
| endpoint | - endpoint of zone |
| zoneID | - ID to look for zone |
| ieeeAddr | - Device IEEE Address |