ZCL Multistate Input

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

Header File

Functions

void esp_zb_zcl_multi_input_init_server(void)
void esp_zb_zcl_multi_input_init_client(void)

Macros

ESP_ZB_ZCL_MULTI_INPUT_STATE_TEXT_DEFAULT_VALUE

Default value for StateText attribute.

ESP_ZB_ZCL_MULTI_INPUT_DESCRIPTION_DEFAULT_VALUE

Default value for Description attribute.

ESP_ZB_ZCL_MULTI_INPUT_NUMBER_OF_STATES_DEFAULT_VALUE

Default value for Number of states attribute.

ESP_ZB_ZCL_MULTI_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value for OutOfService attribute.

ESP_ZB_ZCL_MULTI_INPUT_PRESENT_VALUE_DEFAULT_VALUE

Default value for PresentValue attribute.

ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_DEFAULT_VALUE

Default value for Reliability attribute.

ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value for StatusFlag attribute.

ESP_ZB_ZCL_MULTI_INPUT_APPLICATION_TYPE_DEFAULT_VALUE

Default value for Application type attribute.

ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MIN_VALUE

StatusFlag attribute minimum value.

ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MAX_VALUE

StatusFlag attribute maximum value.

ESP_ZB_ZCL_MI_GROUP_ID

Macros for ApplicationType attribute.

Multistate Input 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 Input clusters have Group = 0x00.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

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

Macros for ApplicationType attribute

ESP_ZB_ZCL_MI_SET_APP_TYPE_WITH_ID(_type, _id)
ESP_ZB_ZCL_CLUSTER_ID_MULTI_INPUT_SERVER_ROLE_INIT
ESP_ZB_ZCL_CLUSTER_ID_MULTI_INPUT_CLIENT_ROLE_INIT

Enumerations

enum esp_zb_zcl_multi_input_attr_t

MultiState Input cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_STATE_TEXT_ID

StateText attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_DESCRIPTION_ID

Description attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_NUMBER_OF_STATES_ID

Number of states attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_OUT_OF_SERVICE_ID

OutOfService attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_PRESENT_VALUE_ID

PresentValue attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_RELIABILITY_ID

Reliability attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_STATUS_FLAGS_ID

StatusFlag attribute

enumerator ESP_ZB_ZCL_ATTR_MULTI_INPUT_APPLICATION_TYPE_ID

Application type attribute

enum esp_zb_zcl_multi_input_status_flags_value_t

Values for StatusFlags attribute.

Values:

enumerator ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAG_NORMAL

Normal (default) state.

enumerator ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAG_IN_ALARM

In alarm bit.

enumerator ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAG_FAULT

Fault bit.

enumerator ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAG_OVERRIDDEN

Overridden bit.

enumerator ESP_ZB_ZCL_MULTI_INPUT_STATUS_FLAG_OUT_OF_SERVICE

Out of service bit.

enum esp_zb_zcl_multi_input_reliability_value_t

Values for Reliability attribute.

Values:

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_FAULT_DETECTED

No fault detected

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_SENSOR

No sensor

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_OVER_RANGE

Over range

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_UNDER_RANGE

Under range

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_OPEN_LOOP

Open loop

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_SHORTED_LOOP

Shorted loop

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_OUTPUT

No output

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_UNRELIABLE_OTHER

Unreliable other

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_PROCESS_ERROR

Process error

enumerator ESP_ZB_ZCL_MULTI_INPUT_RELIABILITY_CONFIGURATION_ERROR

Configuration error

enum esp_zb_zcl_mi_application_types_t

Values for Multistate Input cluster application types (Type field, bits 16-23)

Values:

enumerator ESP_ZB_ZCL_MI_APP_TYPE_DOMAIN_HVAC

Application Domain HVAC

enumerator ESP_ZB_ZCL_MI_APP_TYPE_OTHER

Other

enum esp_zb_zcl_mi_domain_hvac_t

Values for Multistate Input cluster HVAC application usages.

Values:

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OFF_ON_AUTO

Off, On, Auto

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OFF_LOW_MEDIUM_HIGH

Off, Low, Medium, High

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_AUTO_HEAT_COOL_OFF_EMERGENCY_FAN_MAX

Auto, Heat, Cool, Off, Emergency Heat, Fan Only, Max Heat

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STANDBY_BYPASS

Occupied, Unoccupied, Standby, Bypass

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_INACTIVE_ACTIVE_HOLD

Inactive, Active, Hold

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_AUTO_WARMUP_WATER_FLUSH_AUTOCAL_SHUTDOWNOPEN_SHUTDOWNCLOSED_LOWLIMIT_TEST_BALANCE

Auto, Warm-up, Water Flush, Autocalibration, Shutdown Open, Shutdown Closed, Low Limit, Test and Balance

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OFF_AUTO_HEAT_COOL_HEATONLY_COOLONLY_FAN_ONLY

Off, Auto, Heat Cool, Heat Only, Cool Only, Fan Only

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_HIGH_NORMAL_LOW

High, Normal, Low

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STARTUP_SHUTDOWN

Occupied, Unoccupied, Startup, Shutdown

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_NIGHT_DAY_HOLD

Night, Day, Hold

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OFF_COOL_HEAT_AUTO_EMERGENCY

Off, Cool, Heat, Auto, Emergency Heat

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_SHUTDOWNCLOSED_SHUTDOWNOPEN_SATISFIED_MIXING_COOLING_HEATING_SUPPLEMENTAL_HEAT

Shutdown Closed, Shutdown Open, Satisfied, Mixing, Cooling, Heating, Supplemental Heat

enumerator ESP_ZB_ZCL_MI_DOMAIN_HVAC_OTHER

Other