Z-Stack API Reference  8.31.00.00
Macros
ZCL Basic IO Cluster
ZCL General

Macros

#define ATTRID_IOV_BASIC_ACTIVE_TEXT   0x0004
 
#define ATTRID_IOV_BASIC_STATE_TEXT   0x000E
 
#define ATTRID_IOV_BASIC_DESCRIPTION   0x001C
 
#define ATTRID_IOV_BASIC_INACTIVE_TEXT   0x002E
 
#define ATTRID_IOV_BASIC_MAX_PRESENT_VALUE   0x0041
 
#define ATTRID_IOV_BASIC_MIN_OFF_TIME   0x0042
 
#define ATTRID_IOV_BASIC_MIM_ON_TIME   0x0043
 
#define ATTRID_IOV_BASIC_MIN_PRESENT_VALUE   0x0045
 
#define ATTRID_IOV_BASIC_NUM_OF_STATES   0x004A
 
#define ATTRID_IOV_BASIC_OUT_OF_SERVICE   0x0051
 
#define ATTRID_IOV_BASIC_POLARITY   0x0054
 
#define ATTRID_IOV_BASIC_PRESENT_VALUE   0x0055
 
#define ATTRID_IOV_BASIC_PRIORITY_ARRAY   0x0057
 
#define ATTRID_IOV_BASIC_RELIABILITY   0x0067
 
#define ATTRID_IOV_BASIC_RELINQUISH_DEFAULT   0x0068
 
#define ATTRID_IOV_BASIC_RESOLUTION   0x006A
 
#define ATTRID_IOV_BASIC_STATUS_FLAG   0x006F
 
#define ATTRID_IOV_BASIC_ENGINEERING_UNITS   0x0075
 
#define ATTRID_IOV_BASIC_APP_TYPE   0x0100
 
#define ATTRID_APPLIANCE_CONTROL_START_TIME   0x0000
 
#define ATTRID_APPLIANCE_CONTROL_FINISH_TIME   0x0001
 
#define ATTRID_APPLIANCE_CONTROL_REMAINING_TIME   0x0002
 
#define STATUS_FLAGS_IN_ALARM   0x01
 
#define STATUS_FLAGS_FAULT   0x02
 
#define STATUS_FLAGS_OVERRIDDEN   0x04
 
#define STATUS_FLAGS_OUT_OF_SERVICE   0x08
 
#define RELIABILITY_NO_FAULT_DETECTED   0x00
 
#define RELIABILITY_NO_SENSOR   0x01
 
#define RELIABILITY_OVER_RANGE   0x02
 
#define RELIABILITY_UNDER_RANGE   0x03
 
#define RELIABILITY_OPEN_LOOP   0x04
 
#define RELIABILITY_SHORTED_LOOP   0x05
 
#define RELIABILITY_NO_OUTPUT   0x06
 
#define RELIABILITY_UNRELIABLE_OTHER   0x07
 
#define RELIABILITY_PROCESS_ERROR   0x08
 
#define RELIABILITY_MULTI_STATE_FAULT   0x09
 
#define RELIABILITY_CONFIG_ERROR   0x0A
 
#define ENGINEERING_UNITS_OTHER   0x00FF
 
#define POLARITY_NORMAL   0x00
 
#define POLARITY_REVERSE   0x01
 
#define APP_GROUP   0xFF000000
 
#define APP_TYPE   0x00FF0000
 
#define APP_INDEX   0x0000FFFF
 
#define APP_GROUP_AI   0x00
 
#define APP_GROUP_AO   0x01
 
#define APP_GROUP_AV   0x02
 
#define APP_GROUP_BI   0x03
 
#define APP_GROUP_BO   0x04
 
#define APP_GROUP_BV   0x05
 
#define APP_GROUP_MI   0x0D
 
#define APP_GROUP_MO   0x0E
 
#define APP_GROUP_MV   0x13
 
#define APP_TYPE_AI_TEMP_C   0x00
 
#define APP_TYPE_AI_HUMIDITY_PERCENT   0x01
 
#define APP_TYPE_AI_PRESSURE_PASCAL   0x02
 
#define APP_TYPE_AI_FLOW_LIT_SEC   0x03
 
#define APP_TYPE_AI_PERCENT   0x04
 
#define APP_TYPE_AI_PARTS_PER_MIL   0x05
 
#define APP_TYPE_AI_ROTATION_SPEED   0x06
 
#define APP_TYPE_AI_CURRENT_AMPS   0x07
 
#define APP_TYPE_AI_FREQUENCY_HZ   0x08
 
#define APP_TYPE_AI_PWR_WATTS   0x09
 
#define APP_TYPE_AI_PWR_KW   0x0A
 
#define APP_TYPE_AI_ENERGY_KWH   0x0B
 
#define APP_TYPE_AI_COUNT   0x0C
 
#define APP_TYPE_AI_ENTHALPY_KJ_KG   0x0D
 
#define APP_TYPE_AI_TIME_SEC   0x0E
 
#define APP_TYPE_AO_TEMP_C   0x00
 
#define APP_TYPE_AO_HUMIDITY_PERCENT   0x01
 
#define APP_TYPE_AO_PRESSURE_PASCAL   0x02
 
#define APP_TYPE_AO_FLOW_LIT_SEC   0x03
 
#define APP_TYPE_AO_PERCENT   0x04
 
#define APP_TYPE_AO_PARTS_PER_MIL   0x05
 
#define APP_TYPE_AO_ROTATION_SPEED   0x06
 
#define APP_TYPE_AO_CURRENT_AMPS   0x07
 
#define APP_TYPE_AO_FREQUENCY_HZ   0x08
 
#define APP_TYPE_AO_PWR_WATTS   0x09
 
#define APP_TYPE_AO_PWR_KW   0x0A
 
#define APP_TYPE_AO_ENERGY_KWH   0x0B
 
#define APP_TYPE_AO_COUNT   0x0C
 
#define APP_TYPE_AO_ENTHALPY_KJ_KG   0x0D
 
#define APP_TYPE_AO_TIME_SEC   0x0E
 
#define APP_TYPE_AV_TEMP_C   0x00
 
#define APP_TYPE_AV_AREA_SQ_METER   0x01
 
#define APP_TYPE_AV_MULTIPLIER_NUM   0x02
 
#define APP_TYPE_AV_FLOW_LIT_SEC   0x03
 
#define APP_TYPE_BI_DOMAIN_HVAC   0x00
 
#define APP_TYPE_BI_DOMAIN_SEC   0x01
 
#define APP_TYPE_BO_DOMAIN_HVAC   0x00
 
#define APP_TYPE_BO_DOMAIN_SEC   0x02
 
#define APP_TYPE_BV   0x00
 
#define APP_TYPE_MI_DOMAIN_HVAC   0x00
 
#define APP_TYPE_MO_DOMAIN_HVAC   0x00
 
#define APP_TYPE_MV_DOMAIN_HVAC   0x00
 
#define APP_INDEX_AI_TEMP_2_PIPE_ENTER_WATER   0x00
 
#define APP_INDEX_AI_HUMIDITY_DISCHARGE   0x00
 
#define APP_INDEX_AI_PRESSURE_BOIL_PUMP_DIFF   0x00
 
#define APP_INDEX_AI_FLOW_CHILLED_WATER   0x00
 
#define APP_INDEX_AI_PERCENT_CHILLER_FULL_LOAD_AMP   0x00
 
#define APP_INDEX_AI_PARTS_RETURN_CO2   0x00
 
#define APP_INDEX_AI_ROTATION_EXHAUST_FAN_REMOTE   0x00
 
#define APP_INDEX_AI_CURRENT_AMPS_CHILLER   0x00
 
#define APP_INDEX_AI_FREQUENCY_SPEED_DRIVE_OUTPUT   0x00
 
#define APP_INDEX_AI_PWR_WATTS_CONSUMPTION   0x00
 
#define APP_INDEX_AI_PWR_KW_ABSOLUTE   0x00
 
#define APP_INDEX_AI_ENERGY_KWH_SPEED_DRIVE   0x00
 
#define APP_INDEX_AI_COUNT   0x00
 
#define APP_INDEX_AI_ENTHALPY_OUTDOOR_AIR   0x00
 
#define APP_INDEX_AI_TIME_RELATIVE   0x00
 
#define APP_INDEX_AO_TEMP_BOILER   0x00
 
#define APP_INDEX_AO_HUMIDITY_HUMIDIFICATION   0x00
 
#define APP_INDEX_AO_PERCENT_FACE_BYPASS_DAMPER   0x00
 
#define APP_INDEX_AO_PARTS_SPACE_CO2_LIMIT   0x00
 
#define APP_INDEX_AO_ROTATION_EXHAUST_FAN_SPEED   0x00
 
#define APP_INDEX_AO_TIME_RELATIVE   0x00
 
#define APP_INDEX_AV_TEMP_SETPOINT_OFFSET   0x00
 
#define APP_INDEX_AV_AREA_DUCT   0x00
 
#define APP_INDEX_AV_MULTIPLIER_GAIN   0x00
 
#define APP_INDEX_AV_FLOW_MIN_AIR   0x00
 
#define APP_INDEX_BI_DOMAIN_HVAC_2_PIPE_PUMP_STAT   0x00
 
#define APP_INDEX_BI_DOMAIN_SEC_GLASS_BREAK_DETECT   0x00
 
#define APP_INDEX_BO_DOMAIN_HVAC_2_PIPE_CIR_PUMP   0x00
 
#define APP_INDEX_BO_DOMAIN_SEC_ARM_DISARM_CMD   0x00
 
#define APP_INDEX_MI_DOMAIN_HVAC_OFF_ON_AUTO   0x00
 
#define APP_INDEX_MO_DOMAIN_HVAC_OFF_ON_AUTO   0x00
 
#define APP_INDEX_MV_DOMAIN_HVAC_OFF_ON_AUTO   0x00
 

Detailed Description

Macro Definition Documentation

§ ATTRID_APPLIANCE_CONTROL_FINISH_TIME

#define ATTRID_APPLIANCE_CONTROL_FINISH_TIME   0x0001

FinishTime attribute determines the time (either relative or absolute) of the expected end of the machine activity.

§ ATTRID_APPLIANCE_CONTROL_REMAINING_TIME

#define ATTRID_APPLIANCE_CONTROL_REMAINING_TIME   0x0002

RemainingTime attribute determines the time, in relative format, of the remaining time of the machine cycle.

§ ATTRID_APPLIANCE_CONTROL_START_TIME

#define ATTRID_APPLIANCE_CONTROL_START_TIME   0x0000

StartTime attribute determines the time (either relative or absolute) of the start of the machine activity.

§ ATTRID_IOV_BASIC_ACTIVE_TEXT

#define ATTRID_IOV_BASIC_ACTIVE_TEXT   0x0004

This attribute, of type Character string, MAY be used to hold a human readable description of the ACTIVE state of a binary PresentValue.

§ ATTRID_IOV_BASIC_APP_TYPE

#define ATTRID_IOV_BASIC_APP_TYPE   0x0100

The ApplicationType attribute is an unsigned 32 bit integer that indicates the specific application usage for this cluster.

§ ATTRID_IOV_BASIC_DESCRIPTION

#define ATTRID_IOV_BASIC_DESCRIPTION   0x001C

The Description attribute, of type Character string, MAY be used to hold a description of the usage of the input, output or value, as appropriate to the cluster.

§ ATTRID_IOV_BASIC_ENGINEERING_UNITS

#define ATTRID_IOV_BASIC_ENGINEERING_UNITS   0x0075

The EngineeringUnits attribute indicates the physical units associated with the value of the PresentValue attribute of an Analog cluster.

§ ATTRID_IOV_BASIC_INACTIVE_TEXT

#define ATTRID_IOV_BASIC_INACTIVE_TEXT   0x002E

This attribute, of type Character string, MAY be used to hold a human readable description of the INACTIVE state of a binary PresentValue.

§ ATTRID_IOV_BASIC_MAX_PRESENT_VALUE

#define ATTRID_IOV_BASIC_MAX_PRESENT_VALUE   0x0041

The MaxPresentValue attribute, of type Single precision, indicates the highest value that can be reliably obtained for the PresentValue attribute of an Analog Input cluster, or which can reliably be used for the PresentValue attribute of an Analog Output or Analog Value cluster.

§ ATTRID_IOV_BASIC_MIM_ON_TIME

#define ATTRID_IOV_BASIC_MIM_ON_TIME   0x0043

This property, of type 32-bit unsigned integer, represents the minimum number of seconds that a binary PresentValue SHALL remain in the ACTIVE state after a write to PresentValue causes it to assume the ACTIVE state.

§ ATTRID_IOV_BASIC_MIN_OFF_TIME

#define ATTRID_IOV_BASIC_MIN_OFF_TIME   0x0042

This property, of type 32-bit unsigned integer, represents the minimum number of seconds that a binary PresentValue SHALL remain in the INACTIVE state after a write to PresentValue causes it to assume the INACTIVE state.

§ ATTRID_IOV_BASIC_MIN_PRESENT_VALUE

#define ATTRID_IOV_BASIC_MIN_PRESENT_VALUE   0x0045

The MinPresentValue attribute, of type Single precision, indicates the lowest value that can be reliably obtained for the PresentValue attribute of an Analog Input cluster, or which can reliably be used for the PresentValue attribute of an Analog Output or Analog Value cluster.

§ ATTRID_IOV_BASIC_NUM_OF_STATES

#define ATTRID_IOV_BASIC_NUM_OF_STATES   0x004A

This attribute, of type Unsigned 16-bit integer, defines the number of states that a multistate PresentValue MAY have.

§ ATTRID_IOV_BASIC_OUT_OF_SERVICE

#define ATTRID_IOV_BASIC_OUT_OF_SERVICE   0x0051

The OutOfService attribute, of type Boolean, indicates whether (TRUE) or not (FALSE) the physical input, output or value that the cluster represents is not in service.

§ ATTRID_IOV_BASIC_POLARITY

#define ATTRID_IOV_BASIC_POLARITY   0x0054

This attribute, of type enumeration, indicates the relationship between the physical state of the input (or output as appropriate for the cluster) and the logical state represented by a binary PresentValue attribute, when OutOfService is FALSE. If the Polarity attribute is NORMAL (0), then the ACTIVE (1) state of the PresentValue attribute is also the ACTIVE or ON state of the physical input (or output). If the Polarity attribute is REVERSE (1), then the ACTIVE (1) state of the PresentValue attribute is the INACTIVE or OFF state of the physical input (or output).

§ ATTRID_IOV_BASIC_PRESENT_VALUE

#define ATTRID_IOV_BASIC_PRESENT_VALUE   0x0055

The PresentValue attribute indicates the current value of the input, output or value, as appropriate for the cluster.

§ ATTRID_IOV_BASIC_PRIORITY_ARRAY

#define ATTRID_IOV_BASIC_PRIORITY_ARRAY   0x0057

The PriorityArray attribute is an array of 16 structures. The first element of each structure is a Boolean, and the second element is of the same type as the PresentValue attribute of the corresponding cluster.

§ ATTRID_IOV_BASIC_RELIABILITY

#define ATTRID_IOV_BASIC_RELIABILITY   0x0067

The Reliability attribute, of type 8-bit enumeration, provides an indication of whether the PresentValue or the operation of the physical input, output or value in question (as appropriate for the cluster) is "reliable" as far as can be 5590 determined and, if not, why not.

§ ATTRID_IOV_BASIC_RELINQUISH_DEFAULT

#define ATTRID_IOV_BASIC_RELINQUISH_DEFAULT   0x0068

The RelinquishDefault attribute is the default value to be used for the PresentValue attribute when all elements of the PriorityArray attribute are marked as invalid.

§ ATTRID_IOV_BASIC_RESOLUTION

#define ATTRID_IOV_BASIC_RESOLUTION   0x006A

This attribute, of type Single precision, indicates the smallest recognizable change to PresentValue.

§ ATTRID_IOV_BASIC_STATE_TEXT

#define ATTRID_IOV_BASIC_STATE_TEXT   0x000E

This attribute, of type Array of Character strings, holds descriptions of all possible states of a multistate PresentValue.

§ ATTRID_IOV_BASIC_STATUS_FLAG

#define ATTRID_IOV_BASIC_STATUS_FLAG   0x006F

This attribute, of type bitmap, represents four Boolean flags that indicate the general "health" of the analog sensor.