Energy Management cluster attributes

Data Structures
struct	zb_zcl_energy_management_attr_s
	Energy Management cluster attributes. More...

Macros
#define	ZB_ZCL_ENERGY_MANAGEMENT_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)
	Default value for Energy Management cluster revision global attribute (not defined anywhere) More...
#define	ZB_ZCL_DECLARE_ENERGY_MANAGEMENT_ATTR_LIST(attr_list, attrs)
	Declare attribute list for Energy Management cluster. More...

Typedefs
typedef enum zb_zcl_energy_management_srv_attr_e	zb_zcl_energy_management_srv_attr_t
typedef struct zb_zcl_energy_management_attr_s	zb_zcl_energy_management_attr_t
	Energy Management cluster attributes. More...
typedef enum zb_zcl_energy_management_load_control_state_encoding_e	zb_zcl_energy_management_load_control_state_encoding_t
typedef enum zb_zcl_energy_management_current_event_status_encoding_e	zb_zcl_energy_management_current_event_status_encoding_t

Enumerations
enum	zb_zcl_energy_management_srv_attr_e {   ZB_ZCL_ATTR_ENERGY_MANAGEMENT_LOAD_CONTROL_STATE = 0x0000, ZB_ZCL_ATTR_ENERGY_MANAGEMENT_CURRENT_EVENT_ID, ZB_ZCL_ATTR_ENERGY_MANAGEMENT_CURRENT_EVENT_STATUS, ZB_ZCL_ATTR_ENERGY_MANAGEMENT_CONFORMANCE_LEVEL,   ZB_ZCL_ATTR_ENERGY_MANAGEMENT_MINIMUM_OFF_TIME, ZB_ZCL_ATTR_ENERGY_MANAGEMENT_MINIMUM_ON_TIME, ZB_ZCL_ATTR_ENERGY_MANAGEMENT_MINIMUM_CYCLE_PERIOD }
enum	zb_zcl_energy_management_load_control_state_encoding_e {   ZB_ZCL_ENERGY_MANAGEMENT_STATE_RELAY_OPEN = 1 << 0, ZB_ZCL_ENERGY_MANAGEMENT_STATE_EVENT_IN_PROGRESS = 1 << 1, ZB_ZCL_ENERGY_MANAGEMENT_STATE_POWER_STABILIZING = 1 << 2, ZB_ZCL_ENERGY_MANAGEMENT_STATE_OTHER_LOAD_REDUCTION = 1 << 3,   ZB_ZCL_ENERGY_MANAGEMENT_STATE_CURRENT_FLOW = 1 << 4, ZB_ZCL_ENERGY_MANAGEMENT_STATE_LOAD_CALL = 1 << 5 }
enum	zb_zcl_energy_management_current_event_status_encoding_e {   ZB_ZCL_ENERGY_MANAGEMENT_STATUS_RANDOMIZED_START_TIME = 1 << 0, ZB_ZCL_ENERGY_MANAGEMENT_STATUS_RANDOMIZED_DURATION = 1 << 1, ZB_ZCL_ENERGY_MANAGEMENT_STATUS_EXTENDED_BITS_PRESENT = 1 << 2, ZB_ZCL_ENERGY_MANAGEMENT_STATUS_EVENT_ACTIVE = 1 << 3,   ZB_ZCL_ENERGY_MANAGEMENT_STATUS_DEVICE_PARTICIPATING_IN_EVENT = 1 << 4, ZB_ZCL_ENERGY_MANAGEMENT_STATUS_REDUCING_LOAD = 1 << 5, ZB_ZCL_ENERGY_MANAGEMENT_STATUS_ON_AT_END_OF_EVENT = 1 << 6 }

Detailed Description

Macro Definition Documentation

ZB_ZCL_DECLARE_ENERGY_MANAGEMENT_ATTR_LIST

#define ZB_ZCL_DECLARE_ENERGY_MANAGEMENT_ATTR_LIST	(		attr_list,
			attrs
	)

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

Value:

ZB_ZCL_DECLARE_ENERGY_MANAGEMENT_ATTRIB_LIST(attr_list, &attrs.load_control_state,          \
      &attrs.current_event_id, &attrs.current_event_status, &attrs.conformance_level,           \
      &attrs.minimum_off_time, &attrs.minimum_on_time, &attrs.minimum_cycle_period)

Declare attribute list for Energy Management cluster.

Parameters

[in]	attr_list	- attribute list variable name
[in]	attrs	- variable of zb_zcl_energy_management_attr_t type (containing Energy Management cluster attributes)

ZB_ZCL_ENERGY_MANAGEMENT_CLUSTER_REVISION_DEFAULT

#define ZB_ZCL_ENERGY_MANAGEMENT_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_energy_mgmt.h>

Default value for Energy Management cluster revision global attribute (not defined anywhere)

Typedef Documentation

zb_zcl_energy_management_attr_t

typedef struct zb_zcl_energy_management_attr_s zb_zcl_energy_management_attr_t

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

Energy Management cluster attributes.

zb_zcl_energy_management_current_event_status_encoding_t

typedef enum zb_zcl_energy_management_current_event_status_encoding_e zb_zcl_energy_management_current_event_status_encoding_t

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

Current Event Status BitMap/Encoding

See also

SE spec, Table D-194

zb_zcl_energy_management_load_control_state_encoding_t

typedef enum zb_zcl_energy_management_load_control_state_encoding_e zb_zcl_energy_management_load_control_state_encoding_t

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

Load Control State BitMap/Encoding

See also

SE spec, Table D-193

zb_zcl_energy_management_srv_attr_t

typedef enum zb_zcl_energy_management_srv_attr_e zb_zcl_energy_management_srv_attr_t

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

Energy Management Server Cluster Attributes

See also

SE spec, subclause 12.2.2

Enumeration Type Documentation

zb_zcl_energy_management_current_event_status_encoding_e

enum zb_zcl_energy_management_current_event_status_encoding_e

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

Current Event Status BitMap/Encoding

See also

SE spec, Table D-194

Enumerator
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_RANDOMIZED_START_TIME	Set if the current event had a randomized start time.
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_RANDOMIZED_DURATION	Set if the duration of the current event is randomized.
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_EXTENDED_BITS_PRESENT	This bit will always return 1. This allows the field to be used in DRLC Event Status messages.
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_EVENT_ACTIVE	Set if the current time lies between the Effective Start Time and Effective End Time of the event identified by the CurrentEventID attribute
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_DEVICE_PARTICIPATING_IN_EVENT	Set if the device is (or will be when the event starts) participating in the event.
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_REDUCING_LOAD	Set if the device is currently shedding load in response to a DR event. Set if an active load control event is duty cycling and currently off, or if the new set points or offsets are lowering demand.
ZB_ZCL_ENERGY_MANAGEMENT_STATUS_ON_AT_END_OF_EVENT	Set if the device will return to using a normal load after the event has completed. For example, this would be False if the device supported the On/Off cluster and the On/Off attribute was set to OFF.

zb_zcl_energy_management_load_control_state_encoding_e

enum zb_zcl_energy_management_load_control_state_encoding_e

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

Load Control State BitMap/Encoding

See also

SE spec, Table D-193

Enumerator
ZB_ZCL_ENERGY_MANAGEMENT_STATE_RELAY_OPEN	The device being controlled has been turned off and prevented from consuming electric power or another commodity, either by opening a relay or some other means.
ZB_ZCL_ENERGY_MANAGEMENT_STATE_EVENT_IN_PROGRESS	There is an event in progress. The current time is between the Effective Start Time and Effective End Time of the event. When this bit is set, the CurrentEventStatus attribute is valid.
ZB_ZCL_ENERGY_MANAGEMENT_STATE_POWER_STABILIZING	The device has automatically reduced consumption of the commodity for an automatic reason, to aid in the stability of the system.
ZB_ZCL_ENERGY_MANAGEMENT_STATE_OTHER_LOAD_REDUCTION	This bit indicates the device has automatically reduced consumption of the commodity for some non-consumer-initiated reason.
ZB_ZCL_ENERGY_MANAGEMENT_STATE_CURRENT_FLOW	This bit indicates that the device is currently consuming the commodity. The bit not being set means either no commodity being consumption or the device does not have the ability to detect consumption. Support is optional.
ZB_ZCL_ENERGY_MANAGEMENT_STATE_LOAD_CALL	This bit is set if there is currently no consumption but the device under control would consume power if able to. Support is optional. The bit shall be cleared if not supported.

zb_zcl_energy_management_srv_attr_e

enum zb_zcl_energy_management_srv_attr_e

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

Energy Management Server Cluster Attributes

See also

SE spec, subclause 12.2.2

Enumerator
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_LOAD_CONTROL_STATE	This attribute shall be a BitMap showing the current state of the device. The attribute shall be read-only.
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_CURRENT_EVENT_ID	If an event is in progress (current time is between the Effective Start Time and Effective End Time of an event), this attribute SHALL indicate the Issuer Event ID of the active event.
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_CURRENT_EVENT_STATUS	This attribute represents the value returned in the Event Control field of the latest Report Event Status command (see D.2.3.3.1). This attribute provides a mechanism to allow a remote device to query whether this client device is currently participating in a load control event.
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_CONFORMANCE_LEVEL	This is the minimum criticality level of a DRLC event that the device will observe. Events with a criticality level lower than the Conformance Level will be opted out.
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_MINIMUM_OFF_TIME	This attribute is measured in seconds and used to determine the duty cycling times. It is the shortest times the device should be allowed off.
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_MINIMUM_ON_TIME	This attribute is measured in seconds and used to determine the duty cycling times. It is the shortest times the device should be allowed on.
ZB_ZCL_ATTR_ENERGY_MANAGEMENT_MINIMUM_CYCLE_PERIOD	This attribute is measured in seconds and used to determine the duty cycling times. It is the shortest cycling period allowed for duty cycling