Logo
Developing with ZBOSS for Zigbee
Modules | Macros | Enumerations
Multistate Input cluster attributes
Zigbee stack API » ZCL API » ZCL clusters » ZCL Multistate Input

Modules

 Multistate Input cluster application types
 

Macros

#define ZB_ZCL_MULTI_INPUT_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)
 Default value for Multistate Input cluster revision global attribute. More...
 
#define ZB_ZCL_MULTI_INPUT_DESCRIPTION_DEFAULT_VALUE   {0}
 Default value for Description attribute. More...
 
#define ZB_ZCL_MULTI_INPUT_NUM_OF_STATES_DEFAULT_VALUE   ((zb_uint16_t)0x0000u)
 Default value for NumberOfStates attribute. More...
 
#define ZB_ZCL_MULTI_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE   ZB_FALSE
 Default value for OutOfService attribute. More...
 
#define ZB_ZCL_MULTI_INPUT_RELIABILITY_DEFAULT_VALUE   ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_FAULT_DETECTED
 Default value for Reliability attribute. More...
 
#define ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_DEFAULT_VALUE   ZB_ZCL_MULTI_INPUT_STATUS_FLAG_NORMAL
 Default value for StatusFlags attribute. More...
 
#define ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MIN_VALUE   0
 StatusFlags attribute minimum value. More...
 
#define ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MAX_VALUE   0x0f
 StatusFlags attribute maximum value. More...
 
#define ZB_ZCL_DECLARE_MULTI_INPUT_ATTRIB_LIST( attr_list, description, num_of_states, out_of_service, present_value, reliability, status_flags, app_type)
 Declare attribute list for Multistate Input cluster. More...
 

Enumerations

enum  zb_zcl_multi_input_attr_e {
  ZB_ZCL_ATTR_MULTI_INPUT_STATE_TEXT_ID = 0x000e, ZB_ZCL_ATTR_MULTI_INPUT_DESCRIPTION_ID = 0x001c, ZB_ZCL_ATTR_MULTI_INPUT_NUM_OF_STATES_ID = 0x004a, ZB_ZCL_ATTR_MULTI_INPUT_OUT_OF_SERVICE_ID = 0x0051,
  ZB_ZCL_ATTR_MULTI_INPUT_PRESENT_VALUE_ID = 0x0055, ZB_ZCL_ATTR_MULTI_INPUT_RELIABILITY_ID = 0x0067, ZB_ZCL_ATTR_MULTI_INPUT_STATUS_FLAGS_ID = 0x006f, ZB_ZCL_ATTR_MULTI_INPUT_APPLICATION_TYPE_ID = 0x0100
}
 Multistate Input cluster attribute identifiers. More...
 
enum  zb_zcl_multi_input_status_flags_value_e {
  ZB_ZCL_MULTI_INPUT_STATUS_FLAG_NORMAL = 0x00, ZB_ZCL_MULTI_INPUT_STATUS_FLAG_IN_ALARM = 0x01, ZB_ZCL_MULTI_INPUT_STATUS_FLAG_FAULT = 0x02, ZB_ZCL_MULTI_INPUT_STATUS_FLAG_OVERRIDDEN = 0x04,
  ZB_ZCL_MULTI_INPUT_STATUS_FLAG_OUT_OF_SERVICE = 0x08
}
 StatusFlags attribute values. More...
 
enum  zb_zcl_multi_input_reliability_value_e {
  ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_FAULT_DETECTED = 0x00, ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_SENSOR = 0x01, ZB_ZCL_MULTI_INPUT_RELIABILITY_OVER_RANGE = 0x02, ZB_ZCL_MULTI_INPUT_RELIABILITY_UNDER_RANGE = 0x03,
  ZB_ZCL_MULTI_INPUT_RELIABILITY_OPEN_LOOP = 0x04, ZB_ZCL_MULTI_INPUT_RELIABILITY_SHORTED_LOOP = 0x05, ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_OUTPUT = 0x06, ZB_ZCL_MULTI_INPUT_RELIABILITY_UNRELIABLE_OTHER = 0x07,
  ZB_ZCL_MULTI_INPUT_RELIABILITY_PROCESS_ERROR = 0x08, ZB_ZCL_MULTI_INPUT_RELIABILITY_MULTI_STATE_FAULT = 0x09, ZB_ZCL_MULTI_INPUT_RELIABILITY_CONFIGURATION_ERROR = 0x0a
}
 Reliability attribute values. More...
 

Detailed Description

Macro Definition Documentation

§ ZB_ZCL_DECLARE_MULTI_INPUT_ATTRIB_LIST

#define ZB_ZCL_DECLARE_MULTI_INPUT_ATTRIB_LIST (   attr_list,
  description,
  num_of_states,
  out_of_service,
  present_value,
  reliability,
  status_flags,
  app_type 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_MULTI_INPUT) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_DESCRIPTION_ID, (description)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_NUM_OF_STATES_ID, (num_of_states)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_OUT_OF_SERVICE_ID, (out_of_service)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_PRESENT_VALUE_ID, (present_value)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_RELIABILITY_ID, (reliability)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_STATUS_FLAGS_ID, (status_flags)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_MULTI_INPUT_APPLICATION_TYPE_ID, (app_type)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZB_ZCL_ATTR_MULTI_INPUT_APPLICATION_TYPE_ID
ApplicationType attribute, ZCL spec 3.14.11.19.
Definition: zb_zcl_multistate_input.h:67
ZB_ZCL_ATTR_MULTI_INPUT_OUT_OF_SERVICE_ID
OutOfService attribute, ZCL spec 3.14.11.1.
Definition: zb_zcl_multistate_input.h:59
ZB_ZCL_ATTR_MULTI_INPUT_PRESENT_VALUE_ID
PresentValue attribute, ZCL spec 3.14.11.2.
Definition: zb_zcl_multistate_input.h:61
ZB_ZCL_ATTR_MULTI_INPUT_STATUS_FLAGS_ID
StatusFlags attribute, ZCL spec 3.14.11.3.
Definition: zb_zcl_multistate_input.h:65
ZB_ZCL_ATTR_MULTI_INPUT_NUM_OF_STATES_ID
NumberOfStates attribute, ZCL spec 3.14.11.17.
Definition: zb_zcl_multistate_input.h:57
ZB_ZCL_ATTR_MULTI_INPUT_DESCRIPTION_ID
Description attribute, ZCL spec 3.14.11.4.
Definition: zb_zcl_multistate_input.h:55
ZB_ZCL_ATTR_MULTI_INPUT_RELIABILITY_ID
Reliability attribute, ZCL spec 3.14.11.9.
Definition: zb_zcl_multistate_input.h:63

Declare attribute list for Multistate Input cluster.

Parameters
attr_list- attribute list name
description- pointer to variable storing Description attribute value
num_of_states- pointer to variable storing NumberOfStates 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
status_flags- pointer to variable storing StatusFlags attribute value
app_type- pointer to variable storing ApplicationType attribute value

§ ZB_ZCL_MULTI_INPUT_CLUSTER_REVISION_DEFAULT

#define ZB_ZCL_MULTI_INPUT_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Default value for Multistate Input cluster revision global attribute.

§ ZB_ZCL_MULTI_INPUT_DESCRIPTION_DEFAULT_VALUE

#define ZB_ZCL_MULTI_INPUT_DESCRIPTION_DEFAULT_VALUE   {0}

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Default value for Description attribute.

§ ZB_ZCL_MULTI_INPUT_NUM_OF_STATES_DEFAULT_VALUE

#define ZB_ZCL_MULTI_INPUT_NUM_OF_STATES_DEFAULT_VALUE   ((zb_uint16_t)0x0000u)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Default value for NumberOfStates attribute.

§ ZB_ZCL_MULTI_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE

#define ZB_ZCL_MULTI_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE   ZB_FALSE

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Default value for OutOfService attribute.

§ ZB_ZCL_MULTI_INPUT_RELIABILITY_DEFAULT_VALUE

#define ZB_ZCL_MULTI_INPUT_RELIABILITY_DEFAULT_VALUE   ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_FAULT_DETECTED

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Default value for Reliability attribute.

§ ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_DEFAULT_VALUE

#define ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_DEFAULT_VALUE   ZB_ZCL_MULTI_INPUT_STATUS_FLAG_NORMAL

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Default value for StatusFlags attribute.

§ ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MAX_VALUE

#define ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MAX_VALUE   0x0f

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

StatusFlags attribute maximum value.

§ ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MIN_VALUE

#define ZB_ZCL_MULTI_INPUT_STATUS_FLAGS_MIN_VALUE   0

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

StatusFlags attribute minimum value.

Enumeration Type Documentation

§ zb_zcl_multi_input_attr_e

enum zb_zcl_multi_input_attr_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Multistate Input cluster attribute identifiers.

See also
ZCL spec, Multistate Input (Basic) Cluster 3.14.8.4.2
Enumerator
ZB_ZCL_ATTR_MULTI_INPUT_STATE_TEXT_ID 

StateText attribute, ZCL spec 3.14.11.18.

ZB_ZCL_ATTR_MULTI_INPUT_DESCRIPTION_ID 

Description attribute, ZCL spec 3.14.11.4.

ZB_ZCL_ATTR_MULTI_INPUT_NUM_OF_STATES_ID 

NumberOfStates attribute, ZCL spec 3.14.11.17.

ZB_ZCL_ATTR_MULTI_INPUT_OUT_OF_SERVICE_ID 

OutOfService attribute, ZCL spec 3.14.11.1.

ZB_ZCL_ATTR_MULTI_INPUT_PRESENT_VALUE_ID 

PresentValue attribute, ZCL spec 3.14.11.2.

ZB_ZCL_ATTR_MULTI_INPUT_RELIABILITY_ID 

Reliability attribute, ZCL spec 3.14.11.9.

ZB_ZCL_ATTR_MULTI_INPUT_STATUS_FLAGS_ID 

StatusFlags attribute, ZCL spec 3.14.11.3.

ZB_ZCL_ATTR_MULTI_INPUT_APPLICATION_TYPE_ID 

ApplicationType attribute, ZCL spec 3.14.11.19.

§ zb_zcl_multi_input_reliability_value_e

enum zb_zcl_multi_input_reliability_value_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

Reliability attribute values.

See also
ZCL spec 3.14.11.9 for details.
Enumerator
ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_FAULT_DETECTED 
ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_SENSOR 
ZB_ZCL_MULTI_INPUT_RELIABILITY_OVER_RANGE 
ZB_ZCL_MULTI_INPUT_RELIABILITY_UNDER_RANGE 
ZB_ZCL_MULTI_INPUT_RELIABILITY_OPEN_LOOP 
ZB_ZCL_MULTI_INPUT_RELIABILITY_SHORTED_LOOP 
ZB_ZCL_MULTI_INPUT_RELIABILITY_NO_OUTPUT 
ZB_ZCL_MULTI_INPUT_RELIABILITY_UNRELIABLE_OTHER 
ZB_ZCL_MULTI_INPUT_RELIABILITY_PROCESS_ERROR 
ZB_ZCL_MULTI_INPUT_RELIABILITY_MULTI_STATE_FAULT 
ZB_ZCL_MULTI_INPUT_RELIABILITY_CONFIGURATION_ERROR 

§ zb_zcl_multi_input_status_flags_value_e

enum zb_zcl_multi_input_status_flags_value_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_multistate_input.h>

StatusFlags attribute values.

See also
ZCL spec 3.14.11.3 for details.
Enumerator
ZB_ZCL_MULTI_INPUT_STATUS_FLAG_NORMAL 

Normal (default) state.

ZB_ZCL_MULTI_INPUT_STATUS_FLAG_IN_ALARM 

In alarm bit.

ZB_ZCL_MULTI_INPUT_STATUS_FLAG_FAULT 

Fault bit.

ZB_ZCL_MULTI_INPUT_STATUS_FLAG_OVERRIDDEN 

Overridden bit.

ZB_ZCL_MULTI_INPUT_STATUS_FLAG_OUT_OF_SERVICE 

Out of service bit.

Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.