Data Structures
struct	zb_zcl_multi_value_attrs_s
	Multistate Value cluster attributes. More...

Macros
#define	ZB_ZCL_MULTI_VALUE_CLUSTER_REVISION_DEFAULT ((zb_uint16_t)0x0001u)
	Default value for Multistate Value cluster revision global attribute.

#define	ZB_ZCL_MULTI_VALUE_DESCRIPTION_DEFAULT_VALUE {0}
	Default value for Description attribute.

#define	ZB_ZCL_MULTI_VALUE_OUT_OF_SERVICE_DEFAULT_VALUE ZB_FALSE
	Default value for OutOfService attribute.

#define	ZB_ZCL_MULTI_VALUE_RELIABILITY_DEFAULT_VALUE ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_FAULT_DETECTED
	Default value for Reliability attribute.

#define	ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_DEFAULT_VALUE ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_NORMAL
	Default value for StatusFlags attribute.

#define	ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_MIN_VALUE 0
	StatusFlags attribute minimum value.

#define	ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_MAX_VALUE 0x0f
	StatusFlags attribute maximum value.

#define	ZB_ZCL_DECLARE_MULTI_VALUE_ATTRIB_LIST(attr_list, description, out_of_service, present_value, reliability, relinquish_default, status_flags, app_type)
	Declare attribute list for Multistate Value cluster. More...

#define	ZB_ZCL_MULTI_VALUE_DESCRIPTION_MAX_LEN 16

#define	ZB_ZCL_DECLARE_MULTI_VALUE_ATTR_LIST(attr_list, attrs)
	Declare attribute list for Multistate Value cluster. More...

Typedefs
typedef struct zb_zcl_multi_value_attrs_s	zb_zcl_multi_value_attrs_t
	Multistate Value cluster attributes.

Multistate Value cluster attributes
enum	zb_zcl_multi_value_attr_e { ZB_ZCL_ATTR_MULTI_VALUE_DESCRIPTION_ID = 0x001c, ZB_ZCL_ATTR_MULTI_VALUE_OUT_OF_SERVICE_ID = 0x0051, ZB_ZCL_ATTR_MULTI_VALUE_PRESENT_VALUE_ID = 0x0055, ZB_ZCL_ATTR_MULTI_VALUE_RELIABILITY_ID = 0x0067, ZB_ZCL_ATTR_MULTI_VALUE_RELINQUISH_DEFAULT_ID = 0x0068, ZB_ZCL_ATTR_MULTI_VALUE_STATUS_FLAGS_ID = 0x006f, ZB_ZCL_ATTR_MULTI_VALUE_APPLICATION_TYPE_ID = 0x0100 }
	Multistate Value cluster attribute identifiers. More...

enum	zb_zcl_multi_value_status_flags_value_e { ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_NORMAL = 0x00, ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_IN_ALARM = 0x01, ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_FAULT = 0x02, ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_OVERRIDDEN = 0x04, ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_OUT_OF_SERVICE = 0x08 }
	StatusFlags attribute values. More...

enum	zb_zcl_multi_value_reliability_value_e { ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_FAULT_DETECTED = 0x00, ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_SENSOR = 0x01, ZB_ZCL_MULTI_VALUE_RELIABILITY_OVER_RANGE = 0x02, ZB_ZCL_MULTI_VALUE_RELIABILITY_UNDER_RANGE = 0x03, ZB_ZCL_MULTI_VALUE_RELIABILITY_OPEN_LOOP = 0x04, ZB_ZCL_MULTI_VALUE_RELIABILITY_SHORTED_LOOP = 0x05, ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_OUTPUT = 0x06, ZB_ZCL_MULTI_VALUE_RELIABILITY_UNRELIABLE_OTHER = 0x07, ZB_ZCL_MULTI_VALUE_RELIABILITY_PROCESS_ERROR = 0x08, ZB_ZCL_MULTI_VALUE_RELIABILITY_MULTI_STATE_FAULT = 0x09, ZB_ZCL_MULTI_VALUE_RELIABILITY_CONFIGURATION_ERROR = 0x0a }
	Reliability attribute values. More...

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 physical quantity that the PresentValue attribute of the cluster represents. Index = Bits 0 to 15 The specific application usage of the cluster.
enum	zb_zcl_mv_application_types_e { ZB_ZCL_MV_APP_TYPE_APP_DOMAIN_HVAC = 0x0000 }
	Type values for Multistate Value cluster applications. More...

enum	zb_zcl_mv_app_domain_hvac_e { ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_0 = ZB_ZCL_MV_SET_APP_TYPE_WITH_ID(ZB_ZCL_MV_APP_TYPE_APP_DOMAIN_HVAC, 0x0000), ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_1, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_2, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_3, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_4, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_5, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_6, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_7, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_8, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_9, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_10, ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_11, ZB_ZCL_MV_APP_DOMAIN_HVAC_OTHER = ZB_ZCL_MV_SET_APP_TYPE_WITH_ID(ZB_ZCL_MV_APP_TYPE_APP_DOMAIN_HVAC, 0xffff) }

#define	ZB_ZCL_MV_GROUP_ID 0x0d

#define	ZB_ZCL_MV_SET_APP_TYPE_WITH_ID(_type, _id) ((ZB_ZCL_MV_GROUP_ID << 24) \| ((_type & 0xff) << 16) \| (_id & 0xffff))

Detailed Description

The Multistate Value (Basic) cluster provides an interface for setting a multistate value, typically used as a control system parameter, and accessing characteristics of that value.

Macro Definition Documentation

§ ZB_ZCL_DECLARE_MULTI_VALUE_ATTR_LIST

#define ZB_ZCL_DECLARE_MULTI_VALUE_ATTR_LIST	(	attr_list,
		attrs
	)

Value:

ZB_ZCL_DECLARE_MULTI_VALUE_ATTRIB_LIST(attr_list,                        \
                                         &attrs.description,               \
                                         &attrs.out_of_service,            \
                                         &attrs.present_value,             \
                                         &attrs.reliability,               \
                                         &attrs.relinquish_default,        \
                                         &attrs.status_flags,              \
                                         &attrs.application_type)

Declare attribute list for Multistate Value cluster.

Parameters

[in]	attr_list	- attribute list variable name
[in]	attrs	- variable of zb_zcl_multi_value_attrs_t type (containing Multistate Value cluster attributes)

§ ZB_ZCL_DECLARE_MULTI_VALUE_ATTRIB_LIST

#define ZB_ZCL_DECLARE_MULTI_VALUE_ATTRIB_LIST	(	attr_list,
		description,
		out_of_service,
		present_value,
		reliability,
		relinquish_default,
		status_flags,
		app_type
	)

Value:

\
  ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_MULTI_VALUE)          \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_DESCRIPTION_ID, (description))               \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_OUT_OF_SERVICE_ID, (out_of_service))         \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_PRESENT_VALUE_ID, (present_value))           \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_RELIABILITY_ID, (reliability))               \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_RELINQUISH_DEFAULT_ID, (relinquish_default)) \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_STATUS_FLAGS_ID, (status_flags))             \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_VALUE_APPLICATION_TYPE_ID, (app_type))             \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Multistate Value cluster.

Parameters

attr_list	- attribute list name
description	- pointer to variable storing Description attribute value
out_of_service	- pointer to variable storing OutOfService attribute value
present_value	- pointer to variable storing PresentValue attribute value
reliability	- pointer to variable storing Reliability attribute value
relinquish_default	- pointer to variable storing RelinquishDefault attribute value
status_flags	- pointer to variable storing StatusFlags attribute value
app_type	- pointer to variable storing ApplicationType attribute value

§ ZB_ZCL_MULTI_VALUE_DESCRIPTION_MAX_LEN

#define ZB_ZCL_MULTI_VALUE_DESCRIPTION_MAX_LEN 16

Maximum length of Description string field

Enumeration Type Documentation

§ zb_zcl_multi_value_attr_e

enum zb_zcl_multi_value_attr_e

Multistate Value cluster attribute identifiers.

See also: ZCL spec, Multistate Value (Basic) Cluster 3.14.4.4.2

Enumerator
ZB_ZCL_ATTR_MULTI_VALUE_DESCRIPTION_ID	Description attribute, ZCL spec 3.14.11.4.
ZB_ZCL_ATTR_MULTI_VALUE_OUT_OF_SERVICE_ID	OutOfService attribute, ZCL spec 3.14.11.1.
ZB_ZCL_ATTR_MULTI_VALUE_PRESENT_VALUE_ID	PresentValue attribute, ZCL spec 3.14.11.2.
ZB_ZCL_ATTR_MULTI_VALUE_RELIABILITY_ID	PriorityArray attribute, ZCL spec 3.14.11.6. Reliability attribute, ZCL spec 3.14.11.9
ZB_ZCL_ATTR_MULTI_VALUE_RELINQUISH_DEFAULT_ID	Reliability attribute, ZCL spec 3.14.11.7.
ZB_ZCL_ATTR_MULTI_VALUE_STATUS_FLAGS_ID	StatusFlags attribute, ZCL spec 3.14.11.3.
ZB_ZCL_ATTR_MULTI_VALUE_APPLICATION_TYPE_ID	ApplicationType attribute, ZCL spec 3.14.11.19.

§ zb_zcl_multi_value_reliability_value_e

enum zb_zcl_multi_value_reliability_value_e

Reliability attribute values.

See also: ZCL spec 3.14.11.9 for details.

Enumerator
ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_FAULT_DETECTED	No fault detected
ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_SENSOR	No sensor
ZB_ZCL_MULTI_VALUE_RELIABILITY_OVER_RANGE	Over range
ZB_ZCL_MULTI_VALUE_RELIABILITY_UNDER_RANGE	Under range
ZB_ZCL_MULTI_VALUE_RELIABILITY_OPEN_LOOP	Open loop
ZB_ZCL_MULTI_VALUE_RELIABILITY_SHORTED_LOOP	Shorted loop
ZB_ZCL_MULTI_VALUE_RELIABILITY_NO_OUTPUT	No output
ZB_ZCL_MULTI_VALUE_RELIABILITY_UNRELIABLE_OTHER	Unreliable other
ZB_ZCL_MULTI_VALUE_RELIABILITY_PROCESS_ERROR	Process error
ZB_ZCL_MULTI_VALUE_RELIABILITY_MULTI_STATE_FAULT	Mutlistate fault
ZB_ZCL_MULTI_VALUE_RELIABILITY_CONFIGURATION_ERROR	Configuration error

§ zb_zcl_multi_value_status_flags_value_e

enum zb_zcl_multi_value_status_flags_value_e

StatusFlags attribute values.

See also: ZCL spec 3.14.11.3 for details.

Enumerator
ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_NORMAL	Normal (default) .
ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_IN_ALARM	In alarm bit.
ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_FAULT	Fault bit.
ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_OVERRIDDEN	Overridden bit.
ZB_ZCL_MULTI_VALUE_STATUS_FLAGS_OUT_OF_SERVICE	Out of service bit.

§ zb_zcl_mv_app_domain_hvac_e

enum zb_zcl_mv_app_domain_hvac_e

Enumerator
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_0	On, Off, Auto state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_1	Off, Low, Medium, High state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_2	Auto, Heat, Cool, Off, Emergency Heat, Fan Only, Max Heat state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_3	Occupied, Unoccupied, Standby, Bypass state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_4	Inactive, Active, Hold state
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
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_6	Off, Auto, Heat Control, Heat Only, Cool Only, Fan Only state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_7	High, Normal, Low state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_8	Occupied, Unoccupied, Startup, Shutdown state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_9	Night, Day, Hold state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_10	Off, Cool, Heat, Auto, Emergency Heat state
ZB_ZCL_MV_APP_DOMAIN_HVAC_STATES_GROUP_11	Shutdown Closed, Shutdown Open, Satisfied, Mixing, Cooling, Heating, Supplemental Heat state
ZB_ZCL_MV_APP_DOMAIN_HVAC_OTHER	Other

§ zb_zcl_mv_application_types_e

enum zb_zcl_mv_application_types_e

Type values for Multistate Value cluster applications.

See also: ZCL spec 3.16.11.19.9

Enumerator
ZB_ZCL_MV_APP_TYPE_APP_DOMAIN_HVAC	Application Domain HVAC

Data Structures

Macros

Typedefs

Multistate Value cluster attributes

Multistate Value cluster application types