Z-Stack API Reference  6.10.00.04
ZCL Closure Typedefs

This group defines the typedefs used for closure devices. More...

Data Structures

struct  zclClosuresWcInfoConfigStatus_t
 Window Covering Cluster - Bits in Config/Status Attribute. More...
 
struct  zclClosuresWcSetMode_t
 Window Covering Cluster - Bits in Mode Attribute. More...
 
struct  zclDoorLock_t
 Server Commands Received: Lock Door, Unlock Door, Toggle Door. More...
 
struct  zclDoorLockUnlockTimeout_t
 Server Commands Received: Unlock with Timeout. More...
 
struct  zclDoorLockGetLogRecord_t
 Server Commands Received: Get Log Record. More...
 
struct  zclDoorLockSetPINCode_t
 Server Commands Received: Set PIN Code. More...
 
struct  zclDoorLockUserID_t
 Server Commands Received: Get PIN Code, Clear PIN Code, Get User Status, Get User Type, Get RFID Code, Clear RFID Code. More...
 
struct  zclDoorLockSetUserStatus_t
 Server Commands Received: Set User Status. More...
 
struct  zclDoorLockSetWeekDaySchedule_t
 Server Commands Received: Set Week Day Schedule. More...
 
struct  zclDoorLockSchedule_t
 Server Commands Received: Get Week Day Schedule, Clear Week Day Schedule, Get Year Day Schedule, Clear Year Day Schedule. More...
 
struct  zclDoorLockSetYearDaySchedule_t
 Server Commands Received: Set Year Day Schedule. More...
 
struct  zclDoorLockSetHolidaySchedule_t
 Server Commands Received: Set Holiday Schedule. More...
 
struct  zclDoorLockHolidayScheduleID_t
 Server Commands Received: Get Holiday Schedule, Clear Holiday Schedule. More...
 
struct  zclDoorLockSetUserType_t
 Server Commands Received: Set User Type. More...
 
struct  zclDoorLockSetRFIDCode_t
 Server Commands Received: Set RFID Code. More...
 
struct  zclDoorLockGetLogRecordRsp_t
 Client Commands Received: Get Log Record Response. More...
 
struct  zclDoorLockGetPINCodeRsp_t
 Client Commands Received: Get PIN Code Response. More...
 
struct  zclDoorLockGetUserStatusRsp_t
 Client Commands Received: Get User Status Response. More...
 
struct  zclDoorLockGetUserTypeRsp_t
 Client Commands Received: Get User Type Response. More...
 
struct  zclDoorLockGetWeekDayScheduleRsp_t
 Client Commands Received: Get Week Day Schedule Response. More...
 
struct  zclDoorLockGetYearDayScheduleRsp_t
 Client Commands Received: Get Year Day Schedule Response. More...
 
struct  zclDoorLockGetHolidayScheduleRsp_t
 Client Commands Received: Get Holiday Schedule Response. More...
 
struct  zclDoorLockGetRFIDCodeRsp_t
 Client Commands Received: Get RFID Code Response. More...
 
struct  zclDoorLockOperationEventNotification_t
 Client Commands Received: Operation Event Notification. More...
 
struct  zclDoorLockProgrammingEventNotification_t
 Client Commands Received: Programming Event Notification. More...
 
struct  zclClosures_DoorLockAppCallbacks_t
 Register Callbacks DoorLock Cluster table entry - enter function pointers for callbacks that the application would like to receive. More...
 
struct  zclClosures_WindowCoveringAppCallbacks_t
 Register Callbacks Window Covering Cluster table entry - enter function pointers for callbacks that the application would like to receive. More...
 

Typedefs

typedef ZStatus_t(* zclClosures_DoorLock_t) (zclIncoming_t *pInMsg, zclDoorLock_t *pInCmd)
 This callback is called to process an incoming Door Lock command.
 
typedef ZStatus_t(* zclClosures_DoorLockRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Door Lock Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockUnlockWithTimeout_t) (zclIncoming_t *pInMsg, zclDoorLockUnlockTimeout_t *pCmd)
 This callback is called to process an incoming Unlock With Timeout command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetLogRecord_t) (zclIncoming_t *pInMsg, zclDoorLockGetLogRecord_t *pCmd)
 This callback is called to process an incoming Get Log Record command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetPINCode_t) (zclIncoming_t *pInMsg, zclDoorLockSetPINCode_t *pCmd)
 This callback is called to process an incoming Set PIN Code command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetPINCode_t) (zclIncoming_t *pInMsg, zclDoorLockUserID_t *pCmd)
 This callback is called to process an incoming Get PIN Code command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearPINCode_t) (zclIncoming_t *pInMsg, zclDoorLockUserID_t *pCmd)
 This callback is called to process an incoming Clear PIN Code command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearAllPINCodes_t) (zclIncoming_t *pInMsg)
 This callback is called to process an incoming Clear All PIN Codes command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetUserStatus_t) (zclIncoming_t *pInMsg, zclDoorLockSetUserStatus_t *pCmd)
 This callback is called to process an incoming Set User Status command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetUserStatus_t) (zclIncoming_t *pInMsg, zclDoorLockUserID_t *pCmd)
 This callback is called to process an incoming Get User Status command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetWeekDaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSetWeekDaySchedule_t *pCmd)
 This callback is called to process an incoming Set Week Day Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetWeekDaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSchedule_t *pCmd)
 This callback is called to process an incoming Get Week Day Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearWeekDaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSchedule_t *pCmd)
 This callback is called to process an incoming Clear Week Day Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetYearDaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSetYearDaySchedule_t *pCmd)
 This callback is called to process an incoming Set Year Day Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetYearDaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSchedule_t *pCmd)
 This callback is called to process an incoming Get Year Day Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearYearDaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSchedule_t *pCmd)
 This callback is called to process an incoming Clear Year Day Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetHolidaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockSetHolidaySchedule_t *pCmd)
 This callback is called to process an incoming Set Holiday Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetHolidaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockHolidayScheduleID_t *pCmd)
 This callback is called to process an incoming Get Holiday Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearHolidaySchedule_t) (zclIncoming_t *pInMsg, zclDoorLockHolidayScheduleID_t *pCmd)
 This callback is called to process an incoming Clear Holiday Schedule command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetUserType_t) (zclIncoming_t *pInMsg, zclDoorLockSetUserType_t *pCmd)
 This callback is called to process an incoming Set User Type command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetUserType_t) (zclIncoming_t *pInMsg, zclDoorLockUserID_t *pCmd)
 This callback is called to process an incoming Get User Type command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetRFIDCode_t) (zclIncoming_t *pInMsg, zclDoorLockSetRFIDCode_t *pCmd)
 This callback is called to process an incoming Set RFID Code command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetRFIDCode_t) (zclIncoming_t *pInMsg, zclDoorLockUserID_t *pCmd)
 This callback is called to process an incoming Get RFID Code command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearRFIDCode_t) (zclIncoming_t *pInMsg, zclDoorLockUserID_t *pCmd)
 This callback is called to process an incoming Clear RFID Code command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearAllRFIDCodes_t) (zclIncoming_t *pInMsg)
 This callback is called to process an incoming Clear All RFID Codes command.
 
typedef ZStatus_t(* zclClosures_DoorLockLockDoorRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Lock Door Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockUnlockDoorRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Unlock Door Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockToggleDoorRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Toggle Door Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockUnlockWithTimeoutRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Unlock With Timeout Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetLogRecordRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetLogRecordRsp_t *pCmd)
 This callback is called to process an incoming Get Log Record Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetPINCodeRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set PIN Code Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetPINCodeRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetPINCodeRsp_t *pCmd)
 This callback is called to process an incoming Get PIN Code Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearPINCodeRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear PIN Code Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearAllPINCodesRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear All PIN Codes Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetUserStatusRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set User Status Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetUserStatusRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetUserStatusRsp_t *pCmd)
 This callback is called to process an incoming Get User Status Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetWeekDayScheduleRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set Week Day Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetWeekDayScheduleRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetWeekDayScheduleRsp_t *pCmd)
 This callback is called to process an incoming Get Week Day Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearWeekDayScheduleRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear Week Day Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetYearDayScheduleRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set Year Day Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetYearDayScheduleRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetYearDayScheduleRsp_t *pCmd)
 This callback is called to process an incoming Get Year Day Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearYearDayScheduleRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear Year Day Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetHolidayScheduleRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set Holiday Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetHolidayScheduleRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetHolidayScheduleRsp_t *pCmd)
 This callback is called to process an incoming Get Holiday Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearHolidayScheduleRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear Holiday Schedule Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetUserTypeRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set User Type Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetUserTypeRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetUserTypeRsp_t *pCmd)
 This callback is called to process an incoming Get User Type Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockSetRFIDCodeRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Set RFID Code Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockGetRFIDCodeRsp_t) (zclIncoming_t *pInMsg, zclDoorLockGetRFIDCodeRsp_t *pCmd)
 This callback is called to process an incoming Get RFID Code Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearRFIDCodeRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear RFID Code Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockClearAllRFIDCodesRsp_t) (zclIncoming_t *pInMsg, uint8_t status)
 This callback is called to process an incoming Clear All RFID Codes Response command.
 
typedef ZStatus_t(* zclClosures_DoorLockOperationEventNotification_t) (zclIncoming_t *pInMsg, zclDoorLockOperationEventNotification_t *pCmd)
 This callback is called to process an incoming Operation Event Notification command.
 
typedef ZStatus_t(* zclClosures_DoorLockProgrammingEventNotification_t) (zclIncoming_t *pInMsg, zclDoorLockProgrammingEventNotification_t *pCmd)
 This callback is called to process an incoming Programming Event Notification command.
 
typedef void(* zclClosures_WindowCoveringSimple_t) (void)
 This callback is called to process an incoming Window Covering cluster basic commands.
 
typedef bool(* zclClosures_WindowCoveringGotoPercentage_t) (uint8_t percentage)
 This callback is called to process an incoming Window Covering cluster goto percentage commands.
 
typedef bool(* zclClosures_WindowCoveringGotoValue_t) (uint16_t value)
 This callback is called to process an incoming Window Covering cluster goto value commands.
 
typedef uint8_t(* zclClosures_WindowCoveringGotoSetpoint_t) (uint8_t index)
 This callback is called to process an incoming Window Covering cluster goto setpoint commands.
 

Enumerations

enum  setpointType_t { lift = 0, tilt = 1 }
 Window Covering Cluster - Setpoint type. More...
 

Detailed Description

This group defines the typedefs used for closure devices.

Enumeration Type Documentation

§ setpointType_t

Window Covering Cluster - Setpoint type.

Enumerator
lift 

Lift.

tilt 

Tilt.