ZCL Multistate Value

Zigbee Cluster Library (ZCL) multistate value cluster usage definition for ESP Zigbee SDK.

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_multistate_value.h

Functions

void esp_zb_zcl_multi_value_init_server(void)

void esp_zb_zcl_multi_value_init_client(void)

Macros

ESP_ZB_ZCL_MV_GROUP_ID

Multistate Value cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Multistate Value clusters have Group = 0x0d.

Type = Bits 16 to 23 The application usage domain.

Index = Bits 0 to 15 The specific application usage of the cluster.

ESP_ZB_ZCL_MV_SET_APP_TYPE_WITH_ID(_type, _id)

ESP_ZB_ZCL_MULTI_VALUE_DESCRIPTION_DEFAULT_VALUE: Default value for Description attribute.

ESP_ZB_ZCL_MULTI_VALUE_OUT_OF_SERVICE_DEFAULT_VALUE: Default value for OutOfService attribute.

ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_DEFAULT_VALUE: Default value for Reliability attribute.

ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_DEFAULT_VALUE: Default value for StatusFlags attribute.

ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_MIN_VALUE: StatusFlags attribute minimum value.

ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_MAX_VALUE: StatusFlags attribute maximum value.

ESP_ZB_ZCL_MULTI_VALUE_DESCRIPTION_MAX_LEN: Maximum length of Description string field

ESP_ZB_ZCL_CLUSTER_ID_MULTI_VALUE_SERVER_ROLE_INIT

ESP_ZB_ZCL_CLUSTER_ID_MULTI_VALUE_CLIENT_ROLE_INIT

Enumerations

enum esp_zb_zcl_multi_value_attr_t

Multistate Value cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_STATE_TEXT_ID: Text attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_DESCRIPTION_ID: Description attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_NUMBER_OF_STATES_ID: NumberOfStates attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_OUT_OF_SERVICE_ID: OutOfService attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_PRESENT_VALUE_ID: PresentValue attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_RELIABILITY_ID: Reliability attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_RELINQUISH_DEFAULT_ID: Reliability attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_STATUS_FLAGS_ID: StatusFlags attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_VALUE_APPLICATION_TYPE_ID: ApplicationType attribute

enum esp_zb_zcl_multi_value_status_flags_value_t

Values for StatusFlags attribute.

Values:

enumerator ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_NORMAL: Normal (default) .

enumerator ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_IN_ALARM: In alarm bit.

enumerator ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_FAULT: Fault bit.

enumerator ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_OVERRIDDEN: Overridden bit.

enumerator ESP_ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_OUT_OF_SERVICE: Out of service bit.

enum esp_zb_zcl_multi_value_reliability_value_t

Values for Reliability attribute.

Values:

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_FAULT_DETECTED: No fault detected

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_SENSOR: No sensor

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_OVER_RANGE: Over range

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_UNDER_RANGE: Under range

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_OPEN_LOOP: Open loop

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_SHORTED_LOOP: Shorted loop

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_OUTPUT: No output

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_UNRELIABLE_OTHER: Unreliable other

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_PROCESS_ERROR: Process error

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_MULTI_STATE_FAULT: Mutlistate fault

enumerator ESP_ZB_ZCL_MULTI_VALUE_RELIABILITY_CONFIGURATION_ERROR: Configuration error

enum esp_zb_zcl_mv_application_types_t

Values for Multistate Value cluster applications type.

Values:

enumerator ESP_ZB_ZCL_MV_APP_TYPE_APP_DOMAIN_HVAC: Application Domain HVAC

enum esp_zb_zcl_mv_app_domain_hvac_t

Values:

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_0: On, Off, Auto state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_1: Off, Low, Medium, High state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_2: Auto, Heat, Cool, Off, Emergency Heat, Fan Only, Max Heat state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_3: Occupied, Unoccupied, Standby, Bypass state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_4: Inactive, Active, Hold state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_5: Auto, Warm-up, Water Flush, Autocalibration, Shutdown Open, Shutdown Closed, Low Limit, Test and Balance state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_6: Off, Auto, Heat Control, Heat Only, Cool Only, Fan Only state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_7: High, Normal, Low state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_8: Occupied, Unoccupied, Startup, Shutdown state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_9: Night, Day, Hold state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_10: Off, Cool, Heat, Auto, Emergency Heat state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_11: Shutdown Closed, Shutdown Open, Satisfied, Mixing, Cooling, Heating, Supplemental Heat state

enumerator ESP_ZB_ZCL_MV_APP_DOMAIN_HVAC_OTHER: Other