5.2.6.3.5. ZCL Closures Clusters

This section provides the closures clusters implementations in ZCL of ESP Zigbee Core.

5.2.6.3.5.1. Shade Config

5.2.6.3.5.1.1. Header File

5.2.6.3.5.1.2. Functions

ezb_err_t ezb_zcl_shade_config_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an shade_config cluster descriptor.

Parameters:

  • cluster_desc -- [in] The shade_config cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_shade_config_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an shade_config cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the shade_config cluster configuration structure. Use ezb_zcl_shade_config_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_shade_config_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_shade_config_cluster_client_init(uint8_t ep_id)

Initialize the ShadeConfig cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_shade_config_cluster_server_init(uint8_t ep_id)

Initialize the ShadeConfig cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.5.1.3. Structures

struct ezb_zcl_shade_config_cluster_server_config_s

Configuration mandatory attributes for the ShadeConfig server cluster.

Public Members

uint8_t status

Configurable mandatory Status attribute

uint16_t closed_limit

Configurable mandatory ClosedLimit attribute

uint8_t mode

Configurable mandatory Mode attribute

5.2.6.3.5.1.4. Macros

EZB_ZCL_SHADE_CONFIG_CLUSTER_REVISION

Cluster Revision of the shade_config cluster implementation.

EZB_ZCL_SHADE_CONFIG_PHYSICAL_CLOSED_LIMIT_MIN_VALUE

Minimum value of PhysicalClosedLimit in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_PHYSICAL_CLOSED_LIMIT_MAX_VALUE

Maximum value of PhysicalClosedLimit in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_MOTOR_STEP_SIZE_MIN_VALUE

Minimum value of MotorStepSize in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_MOTOR_STEP_SIZE_MAX_VALUE

Maximum value of MotorStepSize in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_STATUS_DEFAULT_VALUE

Default value of Status in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_CLOSED_LIMIT_DEFAULT_VALUE

Default value of ClosedLimit in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_CLOSED_LIMIT_MIN_VALUE

Minimum value of ClosedLimit in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_CLOSED_LIMIT_MAX_VALUE

Maximum value of ClosedLimit in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_MODE_DEFAULT_VALUE

Default value of Mode in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_MODE_MIN_VALUE

Minimum value of Mode in ShadeConfig cluster.

EZB_ZCL_SHADE_CONFIG_MODE_MAX_VALUE

Maximum value of Mode in ShadeConfig cluster.

EZB_ZCL_CLUSTER_ID_SHADE_CONFIG_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_SHADE_CONFIG_SERVER_ROLE_INIT

5.2.6.3.5.1.5. Type Definitions

typedef struct ezb_zcl_shade_config_cluster_server_config_s ezb_zcl_shade_config_cluster_server_config_t

Configuration mandatory attributes for the ShadeConfig server cluster.

typedef ezb_zcl_shade_config_cluster_server_config_t ezb_zcl_shade_config_cluster_config_t

5.2.6.3.5.1.6. Enumerations

enum ezb_zcl_shade_config_server_attr_t

Attribute identifiers for the shade_config server cluster.

Values:

enumerator EZB_ZCL_ATTR_SHADE_CONFIG_PHYSICAL_CLOSED_LIMIT_ID

PhysicalClosedLimit attribute.

enumerator EZB_ZCL_ATTR_SHADE_CONFIG_MOTOR_STEP_SIZE_ID

MotorStepSize attribute.

enumerator EZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID

Status attribute.

enumerator EZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID

ClosedLimit attribute.

enumerator EZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID

Mode attribute.

enum ezb_zcl_shade_config_server_mode_t

Enumeration for ZCL Mode attribute of ShadeConfig.

Values:

enumerator EZB_ZCL_SHADE_CONFIG_MODE_NORMAL

Normal

enumerator EZB_ZCL_SHADE_CONFIG_MODE_CONFIGURE

Configure

enum ezb_zcl_shade_config_server_status_t

Bitmap for ZCL Status attribute of ShadeConfig.

Values:

enumerator EZB_ZCL_SHADE_CONFIG_STATUS_SHADE_OPERATIONAL

ShadeOperational

enumerator EZB_ZCL_SHADE_CONFIG_STATUS_SHADE_ADJUSTING

ShadeAdjusting

enumerator EZB_ZCL_SHADE_CONFIG_STATUS_SHADE_DIRECTION

ShadeDirection

enumerator EZB_ZCL_SHADE_CONFIG_STATUS_FORWARD_DIRECTION_OF_MOTOR

ForwardDirectionOfMotor

5.2.6.3.5.1.7. Header File

5.2.6.3.5.2. Door Lock

5.2.6.3.5.2.1. Header File

5.2.6.3.5.2.2. Functions

ezb_err_t ezb_zcl_door_lock_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an door_lock cluster descriptor.

Parameters:

  • cluster_desc -- [in] The door_lock cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_door_lock_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an door_lock cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the door_lock cluster configuration structure. Use ezb_zcl_door_lock_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_door_lock_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_door_lock_cluster_client_init(uint8_t ep_id)

Initialize the DoorLock cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_door_lock_cluster_server_init(uint8_t ep_id)

Initialize the DoorLock cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.5.2.3. Structures

struct ezb_zcl_door_lock_cluster_server_config_s

Configuration mandatory attributes for the DoorLock server cluster.

Public Members

uint8_t lock_state

Configurable mandatory LockState attribute

uint8_t lock_type

Configurable mandatory LockType attribute

bool actuator_enabled

Configurable mandatory ActuatorEnabled attribute

5.2.6.3.5.2.4. Macros

EZB_ZCL_DOOR_LOCK_CLUSTER_REVISION

Cluster Revision of the door_lock cluster implementation.

EZB_ZCL_DOOR_LOCK_ACTUATOR_ENABLED_MIN_VALUE

Minimum value of ActuatorEnabled in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ACTUATOR_ENABLED_MAX_VALUE

Maximum value of ActuatorEnabled in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED_DEFAULT_VALUE

Default value of NumberOfLogRecordsSupported in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_TOTAL_USERS_SUPPORTED_DEFAULT_VALUE

Default value of NumberOfTotalUsersSupported in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_PIN_USERS_SUPPORTED_DEFAULT_VALUE

Default value of NumberOfPINUsersSupported in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED_DEFAULT_VALUE

Default value of NumberOfRFIDUsersSupported in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER_DEFAULT_VALUE

Default value of NumberOfWeekDaySchedulesSupportedPerUser in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER_DEFAULT_VALUE

Default value of NumberOfYearDaySchedulesSupportedPerUser in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED_DEFAULT_VALUE

Default value of NumberOfHolidaySchedulesSupported in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_MAX_PIN_CODE_LENGTH_DEFAULT_VALUE

Default value of MaxPINCodeLength in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_MIN_PIN_CODE_LENGTH_DEFAULT_VALUE

Default value of MinPINCodeLength in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_MAX_RFID_CODE_LENGTH_DEFAULT_VALUE

Default value of MaxRFIDCodeLength in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_MIN_RFID_CODE_LENGTH_DEFAULT_VALUE

Default value of MinRFIDCodeLength in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ENABLE_LOGGING_DEFAULT_VALUE

Default value of EnableLogging in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_LANGUAGE_DEFAULT_VALUE

Default value of Language in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_LED_SETTINGS_DEFAULT_VALUE

Default value of LEDSettings in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_AUTO_RELOCK_TIME_DEFAULT_VALUE

Default value of AutoRelockTime in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_SOUND_VOLUME_DEFAULT_VALUE

Default value of SoundVolume in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_OPERATING_MODE_DEFAULT_VALUE

Default value of OperatingMode in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_SUPPORTED_OPERATING_MODES_DEFAULT_VALUE

Default value of SupportedOperatingModes in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_VALUE

Default value of DefaultConfigurationRegister in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING_DEFAULT_VALUE

Default value of EnableLocalProgramming in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ENABLE_ONE_TOUCH_LOCKING_DEFAULT_VALUE

Default value of EnableOneTouchLocking in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ENABLE_INSIDE_STATUS_LED_DEFAULT_VALUE

Default value of EnableInsideStatusLED in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON_DEFAULT_VALUE

Default value of EnablePrivacyModeButton in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT_DEFAULT_VALUE

Default value of WrongCodeEntryLimit in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME_DEFAULT_VALUE

Default value of UserCodeTemporaryDisableTime in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_SEND_PIN_OVER_THE_AIR_DEFAULT_VALUE

Default value of SendPINOverTheAir in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_REQUIRE_PI_NFOR_RF_OPERATION_DEFAULT_VALUE

Default value of RequirePINforRFOperation in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_SECURITY_LEVEL_DEFAULT_VALUE

Default value of SecurityLevel in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_ALARM_MASK_DEFAULT_VALUE

Default value of AlarmMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_DEFAULT_VALUE

Default value of KeypadOperationEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_DEFAULT_VALUE

Default value of RFOperationEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_MIN_VALUE

Minimum value of RFOperationEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_MAX_VALUE

Maximum value of RFOperationEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_DEFAULT_VALUE

Default value of ManualOperationEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_DEFAULT_VALUE

Default value of RFIDOperationEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_DEFAULT_VALUE

Default value of KeypadProgrammingEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_DEFAULT_VALUE

Default value of RFProgrammingEventMask in DoorLock cluster.

EZB_ZCL_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_DEFAULT_VALUE

Default value of RFIDProgrammingEventMask in DoorLock cluster.

EZB_ZCL_CLUSTER_ID_DOOR_LOCK_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_DOOR_LOCK_SERVER_ROLE_INIT

5.2.6.3.5.2.5. Type Definitions

typedef struct ezb_zcl_door_lock_cluster_server_config_s ezb_zcl_door_lock_cluster_server_config_t

Configuration mandatory attributes for the DoorLock server cluster.

typedef ezb_zcl_door_lock_cluster_server_config_t ezb_zcl_door_lock_cluster_config_t

5.2.6.3.5.2.6. Enumerations

enum ezb_zcl_door_lock_server_attr_t

Attribute identifiers for the door_lock server cluster.

Values:

enumerator EZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_ID

LockState attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_ID

LockType attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ID

ActuatorEnabled attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ID

DoorState attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_DOOR_OPEN_EVENTS_ID

DoorOpenEvents attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_DOOR_CLOSED_EVENTS_ID

DoorClosedEvents attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_OPEN_PERIOD_ID

OpenPeriod attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED_ID

NumberOfLogRecordsSupported attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_TOTAL_USERS_SUPPORTED_ID

NumberOfTotalUsersSupported attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_PIN_USERS_SUPPORTED_ID

NumberOfPINUsersSupported attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED_ID

NumberOfRFIDUsersSupported attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER_ID

NumberOfWeekDaySchedulesSupportedPerUser attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER_ID

NumberOfYearDaySchedulesSupportedPerUser attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED_ID

NumberOfHolidaySchedulesSupported attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_MAX_PIN_CODE_LENGTH_ID

MaxPINCodeLength attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_MIN_PIN_CODE_LENGTH_ID

MinPINCodeLength attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_MAX_RFID_CODE_LENGTH_ID

MaxRFIDCodeLength attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_MIN_RFID_CODE_LENGTH_ID

MinRFIDCodeLength attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOGGING_ID

EnableLogging attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_LANGUAGE_ID

Language attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_LED_SETTINGS_ID

LEDSettings attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_AUTO_RELOCK_TIME_ID

AutoRelockTime attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_SOUND_VOLUME_ID

SoundVolume attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_OPERATING_MODE_ID

OperatingMode attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_SUPPORTED_OPERATING_MODES_ID

SupportedOperatingModes attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_ID

DefaultConfigurationRegister attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING_ID

EnableLocalProgramming attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ENABLE_ONE_TOUCH_LOCKING_ID

EnableOneTouchLocking attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ENABLE_INSIDE_STATUS_LED_ID

EnableInsideStatusLED attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON_ID

EnablePrivacyModeButton attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT_ID

WrongCodeEntryLimit attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME_ID

UserCodeTemporaryDisableTime attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_SEND_PIN_OVER_THE_AIR_ID

SendPINOverTheAir attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_REQUIRE_PI_NFOR_RF_OPERATION_ID

RequirePINforRFOperation attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_SECURITY_LEVEL_ID

SecurityLevel attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_ALARM_MASK_ID

AlarmMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_ID

KeypadOperationEventMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_RF_OPERATION_EVENT_MASK_ID

RFOperationEventMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_ID

ManualOperationEventMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_ID

RFIDOperationEventMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_ID

KeypadProgrammingEventMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_ID

RFProgrammingEventMask attribute.

enumerator EZB_ZCL_ATTR_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_ID

RFIDProgrammingEventMask attribute.

enum ezb_zcl_door_lock_server_lock_state_t

Enumeration for ZCL LockState attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_LOCK_STATE_NOT_FULLY_LOCKED

NotFullyLocked

enumerator EZB_ZCL_DOOR_LOCK_LOCK_STATE_LOCKED

Locked

enumerator EZB_ZCL_DOOR_LOCK_LOCK_STATE_UNLOCKED

Unlocked

enumerator EZB_ZCL_DOOR_LOCK_LOCK_STATE_UNDEFINED

Undefined

enum ezb_zcl_door_lock_server_lock_type_t

Enumeration for ZCL LockType attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_DEAD_BOLT

DeadBolt

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_MAGNETIC

Magnetic

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_OTHER

Other

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_MORTISE

Mortise

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_RIM

Rim

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_LATCH_BOLT

LatchBolt

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_CYLINDRICAL_LOCK

CylindricalLock

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_TUBULAR_LOCK

TubularLock

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_INTERCONNECTED_LOCK

InterconnectedLock

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_DEAD_LATCH

DeadLatch

enumerator EZB_ZCL_DOOR_LOCK_LOCK_TYPE_DOOR_FURNITURE

DoorFurniture

enum ezb_zcl_door_lock_server_door_state_t

Enumeration for ZCL DoorState attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_DOOR_STATE_OPEN

Open

enumerator EZB_ZCL_DOOR_LOCK_DOOR_STATE_CLOSED

Closed

enumerator EZB_ZCL_DOOR_LOCK_DOOR_STATE_ERROR_JAMMED

ErrorJammed

enumerator EZB_ZCL_DOOR_LOCK_DOOR_STATE_ERROR_FORCED_OPEN

ErrorForcedOpen

enumerator EZB_ZCL_DOOR_LOCK_DOOR_STATE_ERROR_UNSPECIFIED

ErrorUnspecified

enumerator EZB_ZCL_DOOR_LOCK_DOOR_STATE_UNDEFINED

Undefined

enum ezb_zcl_door_lock_server_led_settings_t

Enumeration for ZCL LEDSettings attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_LED_SETTINGS_NEVER_USE_LED

NeverUseLED

enumerator EZB_ZCL_DOOR_LOCK_LED_SETTINGS_USE_LED_EXCEPT_FOR_ACCESS_ALLOWED

UseLEDExceptForAccessAllowed

enumerator EZB_ZCL_DOOR_LOCK_LED_SETTINGS_USE_LED_FOR_ALL_EVENTS

UseLEDForAllEvents

enum ezb_zcl_door_lock_server_sound_volume_t

Enumeration for ZCL SoundVolume attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_SOUND_VOLUME_SILENT_MODE

SilentMode

enumerator EZB_ZCL_DOOR_LOCK_SOUND_VOLUME_LOW_VOLUME

LowVolume

enumerator EZB_ZCL_DOOR_LOCK_SOUND_VOLUME_HIGH_VOLUME

HighVolume

enum ezb_zcl_door_lock_server_security_level_t

Enumeration for ZCL SecurityLevel attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_SECURITY_LEVEL_NETWORK

Network

enumerator EZB_ZCL_DOOR_LOCK_SECURITY_LEVEL_APS

APS

enum ezb_zcl_door_lock_server_supported_operating_modes_t

Bitmap for ZCL SupportedOperatingModes attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_SUPPORTED_OPERATING_MODES_NORMAL_MODE_SUPPORTED

NormalModeSupported

enumerator EZB_ZCL_DOOR_LOCK_SUPPORTED_OPERATING_MODES_VACATION_MODE_SUPPORTED

VacationModeSupported

enumerator EZB_ZCL_DOOR_LOCK_SUPPORTED_OPERATING_MODES_PRIVACY_MODE_SUPPORTED

PrivacyModeSupported

enumerator EZB_ZCL_DOOR_LOCK_SUPPORTED_OPERATING_MODES_NO_RF_LOCK_OR_UNLOCK_MODE_SUPPORTED

NoRFLockOrUnlockModeSupported

enumerator EZB_ZCL_DOOR_LOCK_SUPPORTED_OPERATING_MODES_PASSAGE_MODE_SUPPORTED

PassageModeSupported

enum ezb_zcl_door_lock_server_default_configuration_register_t

Bitmap for ZCL DefaultConfigurationRegister attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_ENABLE_LOCAL_PROGRAMMING_ATTRIBUTE_IS_ENABLED

DefaultEnableLocalProgrammingAttributeIsEnabled

enumerator EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_KEYPAD_INTERFACE_IS_ENABLED

DefaultKeypadInterfaceIsEnabled

enumerator EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_RF_INTERFACE_IS_ENABLED

DefaultRFInterfaceIsEnabled

enumerator EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_SOUND_VOLUME_IS_ENABLED

DefaultSoundVolumeIsEnabled

enumerator EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_AUTO_RELOCK_TIME_IS_ENABLED

DefaultAutoRelockTimeIsEnabled

enumerator EZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_LED_SETTINGS_IS_ENABLED

DefaultLEDSettingsIsEnabled

enum ezb_zcl_door_lock_server_alarm_mask_t

Bitmap for ZCL AlarmMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_ALARM_MASK_DEADBOLT_JAMMED

DeadboltJammed

enumerator EZB_ZCL_DOOR_LOCK_ALARM_MASK_LOCK_RESET_TO_FACTORY_DEFAULTS

LockResetToFactoryDefaults

enumerator EZB_ZCL_DOOR_LOCK_ALARM_MASK_RF_POWER_MODULE_CYCLED

RFPowerModuleCycled

enumerator EZB_ZCL_DOOR_LOCK_ALARM_MASK_TAMPER_ALARM_WRONG_CODE_ENTRY_LIMIT

TamperAlarmWrongCodeEntryLimit

enumerator EZB_ZCL_DOOR_LOCK_ALARM_MASK_TAMPER_ALARM_FRONT_ESCUTCHEON_REMOVED_FROM_MAIN

TamperAlarmFrontEscutcheonRemovedFromMain

enumerator EZB_ZCL_DOOR_LOCK_ALARM_MASK_FORCED_DOOR_OPEN_UNDER_DOOR_LOCKED_CONDITION

ForcedDoorOpenUnderDoorLockedCondition

enum ezb_zcl_door_lock_server_keypad_operation_event_mask_t

Bitmap for ZCL KeypadOperationEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_UNKNOWN_OR_MS

KeypadOpUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_LOCK

KeypadOpLock

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_UNLOCK

KeypadOpUnlock

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_LOCK_ERROR_INVALID_PIN

KeypadOpLockErrorInvalidPIN

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_LOCK_ERROR_INVALID_SCHEDULE

KeypadOpLockErrorInvalidSchedule

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_UNLOCK_INVALID_PIN

KeypadOpUnlockInvalidPIN

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_UNLOCK_INVALID_SCHEDULE

KeypadOpUnlockInvalidSchedule

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_KEYPAD_OP_NON_ACCESS_USER

KeypadOpNonAccessUser

enum ezb_zcl_door_lock_server_rf_operation_event_mask_t

Bitmap for ZCL RFOperationEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_UNKNOWN_OR_MS

RFOpUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_LOCK

RFOpLock

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_UNLOCK

RFOpUnlock

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_LOCK_ERROR_INVALID_CODE

RFOpLockErrorInvalidCode

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_LOCK_ERROR_INVALID_SCHEDULE

RFOpLockErrorInvalidSchedule

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_UNLOCK_INVALID_CODE

RFOpUnlockInvalidCode

enumerator EZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_RF_OP_UNLOCK_INVALID_SCHEDULE

RFOpUnlockInvalidSchedule

enum ezb_zcl_door_lock_server_manual_operation_event_mask_t

Bitmap for ZCL ManualOperationEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_UNKNOWN_OR_MS

ManualOpUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_THUMB_TURN_LOCK

ManualOpThumbTurnLock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_THUMB_TURN_UNLOCK

ManualOpThumbTurnUnlock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_ONE_TOUCH_LOCK

ManualOpOneTouchLock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_KEY_LOCK

ManualOpKeyLock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_KEY_UNLOCK

ManualOpKeyUnlock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_AUTO_LOCK

ManualOpAutoLock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_SCHEDULE_LOCK

ManualOpScheduleLock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_SCHEDULE_UNLOCK

ManualOpScheduleUnlock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_LOCK

ManualOpLock

enumerator EZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_OP_UNLOCK

ManualOpUnlock

enum ezb_zcl_door_lock_server_rfid_operation_event_mask_t

Bitmap for ZCL RFIDOperationEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_UNKNOWN_OR_MS

RFIDOpUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_LOCK

RFIDOpLock

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_UNLOCK

RFIDOpUnlock

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_LOCK_ERROR_INVALID_RFID

RFIDOpLockErrorInvalidRFID

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_LOCK_ERROR_INVALID_SCHEDULE

RFIDOpLockErrorInvalidSchedule

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_UNLOCK_ERROR_INVALID_RFID

RFIDOpUnlockErrorInvalidRFID

enumerator EZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_RFID_OP_UNLOCK_ERROR_INVALID_SCHEDULE

RFIDOpUnlockErrorInvalidSchedule

enum ezb_zcl_door_lock_server_keypad_programming_event_mask_t

Bitmap for ZCL KeypadProgrammingEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_KEYPAD_PROG_UNKNOWN_OR_MS

KeypadProgUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_KEYPAD_PROG_MASTER_CODE_CHANGED

KeypadProgMasterCodeChanged

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_KEYPAD_PROG_PIN_ADDED

KeypadProgPINAdded

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_KEYPAD_PROG_PIN_DELETED

KeypadProgPINDeleted

enumerator EZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_KEYPAD_PROG_PIN_CHANGED

KeypadProgPINChanged

enum ezb_zcl_door_lock_server_rf_programming_event_mask_t

Bitmap for ZCL RFProgrammingEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_RF_PROG_UNKNOWN_OR_MS

RFProgUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_RF_PROG_PIN_ADDED

RFProgPINAdded

enumerator EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_RF_PROG_PIN_DELETED

RFProgPINDeleted

enumerator EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_RF_PROG_PIN_CHANGED

RFProgPINChanged

enumerator EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_RF_PROG_RFID_ADDED

RFProgRFIDAdded

enumerator EZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_RF_PROG_RFID_DELETED

RFProgRFIDDeleted

enum ezb_zcl_door_lock_server_rfid_programming_event_mask_t

Bitmap for ZCL RFIDProgrammingEventMask attribute of DoorLock.

Values:

enumerator EZB_ZCL_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_RFID_PROG_UNKNOWN_OR_MS

RFIDProgUnknownOrMS

enumerator EZB_ZCL_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_RFID_PROG_RFID_ADDED

RFIDProgRFIDAdded

enumerator EZB_ZCL_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_RFID_PROG_RFID_DELETED

RFIDProgRFIDDeleted

enum ezb_zcl_door_lock_server_cmd_id_t

Received Command identifiers for the DoorLock cluster.

Values:

enumerator EZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_ID

LockDoor command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_ID

UnlockDoor command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_TOGGLE_ID

Toggle command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_ID

UnlockWithTimeout command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD_ID

GetLogRecord command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE_ID

SetPINCode command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE_ID

GetPINCode command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE_ID

ClearPINCode command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES_ID

ClearAllPINCodes command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS_ID

SetUserStatus command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS_ID

GetUserStatus command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE_ID

SetWeekdaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE_ID

GetWeekdaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE_ID

ClearWeekdaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE_ID

SetYearDaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE_ID

GetYearDaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE_ID

ClearYearDaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE_ID

SetHolidaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE_ID

GetHolidaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE_ID

ClearHolidaySchedule command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE_ID

SetUserType command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE_ID

GetUserType command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE_ID

SetRFIDCode command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE_ID

GetRFIDCode command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE_ID

ClearRFIDCode command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES_ID

ClearAllRFIDCodes command.

enum ezb_zcl_door_lock_client_cmd_id_t

Received Command identifiers for the DoorLock cluster.

Values:

enumerator EZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_RESPONSE_ID

LockDoorResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_RESPONSE_ID

UnlockDoorResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_TOGGLE_RESPONSE_ID

ToggleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE_ID

UnlockWithTimeoutResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD_RESPONSE_ID

GetLogRecordResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE_RESPONSE_ID

SetPINCodeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE_RESPONSE_ID

GetPINCodeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE_RESPONSE_ID

ClearPINCodeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES_RESPONSE_ID

ClearAllPINCodesResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS_RESPONSE_ID

SetUserStatusResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS_RESPONSE_ID

GetUserStatusResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE_RESPONSE_ID

SetWeekdayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE_RESPONSE_ID

GetWeekdayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE_RESPONSE_ID

ClearWeekdayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE_RESPONSE_ID

SetYearDayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE_RESPONSE_ID

GetYearDayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE_RESPONSE_ID

ClearYearDayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE_RESPONSE_ID

SetHolidayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE_RESPONSE_ID

GetHolidayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE_RESPONSE_ID

ClearHolidayScheduleResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE_RESPONSE_ID

SetUserTypeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE_RESPONSE_ID

GetUserTypeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE_RESPONSE_ID

SetRFIDCodeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE_RESPONSE_ID

GetRFIDCodeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE_RESPONSE_ID

ClearRFIDCodeResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES_RESPONSE_ID

ClearAllRFIDCodesResponse command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_OPERATING_EVENT_NOTIFICATION_ID

OperatingEventNotification command.

enumerator EZB_ZCL_CMD_DOOR_LOCK_PROGRAMMING_EVENT_NOTIFICATION_ID

ProgrammingEventNotification command.

5.2.6.3.5.2.7. Header File

5.2.6.3.5.2.8. Functions

ezb_err_t ezb_zcl_door_lock_lock_door_cmd_req(const ezb_zcl_door_lock_lock_door_cmd_t *cmd_req)

Send ZCL DoorLock LockDoor command request.

Parameters:

cmd_req -- Pointer to the LockDoor command request structure, ezb_zcl_door_lock_lock_door_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_door_lock_unlock_door_cmd_req(const ezb_zcl_door_lock_unlock_door_cmd_t *cmd_req)

Send ZCL DoorLock UnlockDoor command request.

Parameters:

cmd_req -- Pointer to the UnlockDoor command request structure, ezb_zcl_door_lock_unlock_door_cmd_t.

Returns:

Error code.

5.2.6.3.5.2.9. Structures

struct ezb_zcl_door_lock_lock_door_cmd_s

Structure for the ZCL DoorLock LockDoor command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

bool aps_secur_enabled

APS security enabled transmission.

struct ezb_zcl_door_lock_lock_door_message_s

Message for the ZCL DoorLock LockDoor.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

struct ezb_zcl_door_lock_lock_door_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_door_lock_lock_door_message_s out

Output: result to send back.

struct ezb_zcl_door_lock_lock_door_rsp_message_s

Message for the ZCL DoorLock LockDoor response.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_status_t req_status

Status of the request command (indicates if the message was received successfully).

struct ezb_zcl_door_lock_lock_door_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_door_lock_lock_door_rsp_message_s out

Output: result to send back.

5.2.6.3.5.2.10. Type Definitions

typedef struct ezb_zcl_door_lock_lock_door_cmd_s ezb_zcl_door_lock_lock_door_cmd_t

Structure for the ZCL DoorLock LockDoor command request.

typedef ezb_zcl_door_lock_lock_door_cmd_t ezb_zcl_door_lock_unlock_door_cmd_t

Structure for the ZCL DoorLock UnlockDoor command request. .

typedef struct ezb_zcl_door_lock_lock_door_message_s ezb_zcl_door_lock_lock_door_message_t

Message for the ZCL DoorLock LockDoor.

typedef ezb_zcl_door_lock_lock_door_message_t ezb_zcl_door_lock_unlock_door_message_t

Message for the ZCL DoorLock UnlockDoor. .

typedef struct ezb_zcl_door_lock_lock_door_rsp_message_s ezb_zcl_door_lock_lock_door_rsp_message_t

Message for the ZCL DoorLock LockDoor response.

typedef ezb_zcl_door_lock_lock_door_rsp_message_t ezb_zcl_door_lock_unlock_door_rsp_message_t

Message for the ZCL DoorLock UnlockDoor response. .

5.2.6.3.5.3. Window Covering

5.2.6.3.5.3.1. Header File

5.2.6.3.5.3.2. Functions

ezb_err_t ezb_zcl_window_covering_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an window_covering cluster descriptor.

Parameters:

  • cluster_desc -- [in] The window_covering cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_window_covering_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an window_covering cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the window_covering cluster configuration structure. Use ezb_zcl_window_covering_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_window_covering_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_window_covering_cluster_client_init(uint8_t ep_id)

Initialize the WindowCovering cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_window_covering_cluster_server_init(uint8_t ep_id)

Initialize the WindowCovering cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.5.3.3. Structures

struct ezb_zcl_window_covering_cluster_server_config_s

Configuration mandatory attributes for the WindowCovering server cluster.

Public Members

uint8_t window_covering_type

Configurable mandatory WindowCoveringType attribute

uint8_t config_status

Configurable mandatory ConfigStatus attribute

uint8_t mode

Configurable mandatory Mode attribute

5.2.6.3.5.3.4. Macros

EZB_ZCL_WINDOW_COVERING_CLUSTER_REVISION

Cluster Revision of the window_covering cluster implementation.

EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_DEFAULT_VALUE

Default value of WindowCoveringType in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_DEFAULT_VALUE

Default value of PhysicalClosedLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_MIN_VALUE

Minimum value of PhysicalClosedLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_MAX_VALUE

Maximum value of PhysicalClosedLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT_DEFAULT_VALUE

Default value of PhysicalClosedLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT_MIN_VALUE

Minimum value of PhysicalClosedLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT_MAX_VALUE

Maximum value of PhysicalClosedLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_DEFAULT_VALUE

Default value of CurrentPositionLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_MIN_VALUE

Minimum value of CurrentPositionLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_MAX_VALUE

Maximum value of CurrentPositionLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_DEFAULT_VALUE

Default value of CurrentPositionTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_MIN_VALUE

Minimum value of CurrentPositionTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_MAX_VALUE

Maximum value of CurrentPositionTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_DEFAULT_VALUE

Default value of NumberOfActuationsLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_MIN_VALUE

Minimum value of NumberOfActuationsLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_MAX_VALUE

Maximum value of NumberOfActuationsLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_DEFAULT_VALUE

Default value of NumberOfActuationsTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_MIN_VALUE

Minimum value of NumberOfActuationsTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_MAX_VALUE

Maximum value of NumberOfActuationsTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_MAX_VALUE

Maximum value of ConfigStatus in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_MIN_VALUE

Minimum value of CurrentPositionLiftPercentage in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_MAX_VALUE

Maximum value of CurrentPositionLiftPercentage in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_MIN_VALUE

Minimum value of CurrentPositionTiltPercentage in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_MAX_VALUE

Maximum value of CurrentPositionTiltPercentage in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_DEFAULT_VALUE

Default value of InstalledOpenLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_MIN_VALUE

Minimum value of InstalledOpenLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_MAX_VALUE

Maximum value of InstalledOpenLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_DEFAULT_VALUE

Default value of InstalledClosedLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_MIN_VALUE

Minimum value of InstalledClosedLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_MAX_VALUE

Maximum value of InstalledClosedLimitLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_DEFAULT_VALUE

Default value of InstalledOpenLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_MIN_VALUE

Minimum value of InstalledOpenLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_MAX_VALUE

Maximum value of InstalledOpenLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_DEFAULT_VALUE

Default value of InstalledClosedLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_MIN_VALUE

Minimum value of InstalledClosedLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_MAX_VALUE

Maximum value of InstalledClosedLimitTilt in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_VELOCITY_LIFT_DEFAULT_VALUE

Default value of VelocityLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_VELOCITY_LIFT_MIN_VALUE

Minimum value of VelocityLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_VELOCITY_LIFT_MAX_VALUE

Maximum value of VelocityLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_ACCELERATION_TIME_LIFT_DEFAULT_VALUE

Default value of AccelerationTimeLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_ACCELERATION_TIME_LIFT_MIN_VALUE

Minimum value of AccelerationTimeLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_ACCELERATION_TIME_LIFT_MAX_VALUE

Maximum value of AccelerationTimeLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_DECELERATION_TIME_LIFT_DEFAULT_VALUE

Default value of DecelerationTimeLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_DECELERATION_TIME_LIFT_MIN_VALUE

Minimum value of DecelerationTimeLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_DECELERATION_TIME_LIFT_MAX_VALUE

Maximum value of DecelerationTimeLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_MODE_DEFAULT_VALUE

Default value of Mode in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT_DEFAULT_VALUE

Default value of IntermediateSetpointsLift in WindowCovering cluster.

EZB_ZCL_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT_DEFAULT_VALUE

Default value of IntermediateSetpointsTilt in WindowCovering cluster.

EZB_ZCL_CLUSTER_ID_WINDOW_COVERING_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_WINDOW_COVERING_SERVER_ROLE_INIT

5.2.6.3.5.3.5. Type Definitions

typedef struct ezb_zcl_window_covering_cluster_server_config_s ezb_zcl_window_covering_cluster_server_config_t

Configuration mandatory attributes for the WindowCovering server cluster.

typedef ezb_zcl_window_covering_cluster_server_config_t ezb_zcl_window_covering_cluster_config_t

5.2.6.3.5.3.6. Enumerations

enum ezb_zcl_window_covering_server_attr_t

Attribute identifiers for the window_covering server cluster.

Values:

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_WINDOW_COVERING_TYPE_ID

WindowCoveringType attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_ID

PhysicalClosedLimitLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT_ID

PhysicalClosedLimitTilt attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_ID

CurrentPositionLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_ID

CurrentPositionTilt attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_ID

NumberOfActuationsLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_ID

NumberOfActuationsTilt attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_ID

ConfigStatus attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_ID

CurrentPositionLiftPercentage attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_ID

CurrentPositionTiltPercentage attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_ID

InstalledOpenLimitLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_ID

InstalledClosedLimitLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_ID

InstalledOpenLimitTilt attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_ID

InstalledClosedLimitTilt attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_VELOCITY_LIFT_ID

VelocityLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_ACCELERATION_TIME_LIFT_ID

AccelerationTimeLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_DECELERATION_TIME_LIFT_ID

DecelerationTimeLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_MODE_ID

Mode attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT_ID

IntermediateSetpointsLift attribute.

enumerator EZB_ZCL_ATTR_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT_ID

IntermediateSetpointsTilt attribute.

enum ezb_zcl_window_covering_server_window_covering_type_t

Enumeration for ZCL WindowCoveringType attribute of WindowCovering.

Values:

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_ROLLERSHADE

Rollershade

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_ROLLERSHADE2_MOTOR

Rollershade2Motor

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR

RollershadeExterior

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR2_MOTOR

RollershadeExterior2Motor

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_DRAPERY

Drapery

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_AWNING

Awning

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_SHUTTER

Shutter

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_TILT_BLIND_TILT_ONLY

TiltBlindTiltOnly

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_TILT_BLIND_LIFT_AND_TILT

TiltBlindLiftAndTilt

enumerator EZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_PROJECTOR_SCREEN

ProjectorScreen

enum ezb_zcl_window_covering_server_config_status_t

Bitmap for ZCL ConfigStatus attribute of WindowCovering.

Values:

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_OPERATIONAL

Operational

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_ONLINE

Online

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_OPEN_AND_UP_COMMANDS_REVERSED

OpenAndUpCommandsReversed

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_LIFT_CLOSED_LOOP

LiftClosedLoop

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_TILT_CLOSED_LOOP

TiltClosedLoop

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_LIFT_ENCODER_CONTROLLED

LiftEncoderControlled

enumerator EZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_TILT_ENCODER_CONTROLLED

TiltEncoderControlled

enum ezb_zcl_window_covering_server_mode_t

Bitmap for ZCL Mode attribute of WindowCovering.

Values:

enumerator EZB_ZCL_WINDOW_COVERING_MODE_MOTOR_DIRECTION_REVERSED

MotorDirectionReversed

enumerator EZB_ZCL_WINDOW_COVERING_MODE_CALIBRATION_MODE

CalibrationMode

enumerator EZB_ZCL_WINDOW_COVERING_MODE_MAINTENANCE_MODE

MaintenanceMode

enumerator EZB_ZCL_WINDOW_COVERING_MODE_LED_FEEDBACK

LEDFeedback

enum ezb_zcl_window_covering_server_cmd_id_t

Received Command identifiers for the WindowCovering cluster.

Values:

enumerator EZB_ZCL_CMD_WINDOW_COVERING_UP_OPEN_ID

UpOpen command.

enumerator EZB_ZCL_CMD_WINDOW_COVERING_DOWN_CLOSE_ID

DownClose command.

enumerator EZB_ZCL_CMD_WINDOW_COVERING_STOP_ID

Stop command.

enumerator EZB_ZCL_CMD_WINDOW_COVERING_GO_TO_LIFT_VALUE_ID

GoToLiftValue command.

enumerator EZB_ZCL_CMD_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE_ID

GoToLiftPercentage command.

enumerator EZB_ZCL_CMD_WINDOW_COVERING_GO_TO_TILT_VALUE_ID

GoToTiltValue command.

enumerator EZB_ZCL_CMD_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE_ID

GoToTiltPercentage command.

5.2.6.3.5.3.7. Header File

5.2.6.3.5.3.8. Functions

ezb_err_t ezb_zcl_window_covering_movement_cmd_req(const ezb_zcl_window_covering_movement_cmd_t *cmd_req)

Send ZCL WindowCovering movement command request.

Parameters:

cmd_req -- Pointer to the movement command request structure, ezb_zcl_window_covering_movement_cmd_s.

Returns:

Error code.

5.2.6.3.5.3.9. Unions

union ezb_zcl_window_covering_cmd_payload_u
#include <window_covering.h>

Payload for the ZCL WindowCovering movement command (lift/tilt value or percentage).

Public Members

uint8_t lift_percentage

Lift percentage (for GoToLiftPercentage).

uint8_t tilt_percentage

Tilt percentage (for GoToTiltPercentage).

uint16_t lift_value

Lift value (for GoToLiftValue).

uint16_t tilt_value

Tilt value (for GoToTiltValue).

5.2.6.3.5.3.10. Structures

struct ezb_zcl_window_covering_movement_cmd_s

Structure for the ZCL WindowCovering movement command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_window_covering_server_cmd_id_t cmd_id

Window covering command ID.

ezb_zcl_window_covering_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_window_covering_movement_message_s

Message for the ZCL WindowCovering movement.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_window_covering_cmd_payload_t payload

Payload from the command.

struct ezb_zcl_window_covering_movement_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_window_covering_movement_message_s out

Output: result to send back.

5.2.6.3.5.3.11. Type Definitions

typedef union ezb_zcl_window_covering_cmd_payload_u ezb_zcl_window_covering_cmd_payload_t

Payload for the ZCL WindowCovering movement command (lift/tilt value or percentage).

typedef struct ezb_zcl_window_covering_movement_cmd_s ezb_zcl_window_covering_movement_cmd_t

Structure for the ZCL WindowCovering movement command request.

typedef struct ezb_zcl_window_covering_movement_message_s ezb_zcl_window_covering_movement_message_t

Message for the ZCL WindowCovering movement.