DRLC attributes and enumerations

Typedefs
typedef enum zb_zcl_drlc_cli_attr_e	zb_zcl_drlc_cli_attr_t
typedef enum zb_zcl_drlc_criticality_levels_e	zb_zcl_drlc_criticality_levels_t
typedef enum zb_zcl_drlc_device_class_e	zb_zcl_drlc_device_class_t
typedef enum zb_zcl_drlc_event_status_e	zb_zcl_drlc_event_status_t
typedef enum zb_zcl_drlc_signature_type_e	zb_zcl_drlc_signature_type_t

Enumerations
enum	zb_zcl_drlc_cli_attr_e { ZB_ZCL_ATTR_DRLC_UTILITY_ENROLLMENT_GROUP = 0x0000, ZB_ZCL_ATTR_DRLC_START_RANDOMIZATION_MINUTES = 0x0001, ZB_ZCL_ATTR_DRLC_DURATION_RANDOMIZATION_MINUTES = 0x0002, ZB_ZCL_ATTR_DRLC_DEVICE_CLASS_VALUE = 0x0003 }
enum	zb_zcl_drlc_criticality_levels_e {   ZB_ZCL_DRLC_CRITICALITY_LEVEL_0 = 0x00, ZB_ZCL_DRLC_CRITICALITY_LEVEL_1, ZB_ZCL_DRLC_CRITICALITY_LEVEL_2, ZB_ZCL_DRLC_CRITICALITY_LEVEL_3,   ZB_ZCL_DRLC_CRITICALITY_LEVEL_4, ZB_ZCL_DRLC_CRITICALITY_LEVEL_5, ZB_ZCL_DRLC_CRITICALITY_LEVEL_6, ZB_ZCL_DRLC_CRITICALITY_LEVEL_7,   ZB_ZCL_DRLC_CRITICALITY_LEVEL_8, ZB_ZCL_DRLC_CRITICALITY_LEVEL_9 }
enum	zb_zcl_drlc_device_class_e {   ZB_ZCL_DRLC_DEVICE_CLASS_HVAC = 1 << 0, ZB_ZCL_DRLC_DEVICE_CLASS_STRIP_HEATER = 1 << 1, ZB_ZCL_DRLC_DEVICE_CLASS_WATER_HEATER = 1 << 2, ZB_ZCL_DRLC_DEVICE_CLASS_POOL_PUMP = 1 << 3,   ZB_ZCL_DRLC_DEVICE_CLASS_SMART_APPLIANCE = 1 << 4, ZB_ZCL_DRLC_DEVICE_CLASS_IRRIGATION_PUMP = 1 << 5, ZB_ZCL_DRLC_DEVICE_CLASS_MCI_LOADS = 1 << 6, ZB_ZCL_DRLC_DEVICE_CLASS_SIMPLE_LOADS = 1 << 7,   ZB_ZCL_DRLC_DEVICE_CLASS_EXTERIOR_LIGHTNING = 1 << 8, ZB_ZCL_DRLC_DEVICE_CLASS_INTERIOR_LIGHTNING = 1 << 9, ZB_ZCL_DRLC_DEVICE_CLASS_ELECTRIC_VEHICLE = 1 << 10, ZB_ZCL_DRLC_DEVICE_CLASS_GENERATION_SYSTEMS = 1 << 11 }
enum	zb_zcl_drlc_event_status_e {   ZB_ZCL_DRLC_EVENT_RESERVED_00 = 0x00, ZB_ZCL_DRLC_EVENT_LCE_RECEIVED, ZB_ZCL_DRLC_EVENT_EVENT_STARTED, ZB_ZCL_DRLC_EVENT_EVENT_COMPLETED,   ZB_ZCL_DRLC_EVENT_OPT_OUT, ZB_ZCL_DRLC_EVENT_OPT_IN, ZB_ZCL_DRLC_EVENT_EVENT_CANCELLED, ZB_ZCL_DRLC_EVENT_EVENT_SUPERSEDED,   ZB_ZCL_DRLC_EVENT_EVENT_PARTIALLY_OPT_OUT, ZB_ZCL_DRLC_EVENT_EVENT_PARTIALLY_OPT_IN, ZB_ZCL_DRLC_EVENT_EVENT_COMPLETED_NO_USER, ZB_ZCL_DRLC_EVENT_RESERVED_0B,   ZB_ZCL_DRLC_EVENT_RESERVED_F7 = 0xF7, ZB_ZCL_DRLC_EVENT_REJECTED_INVALID_CANCEL_CMD, ZB_ZCL_DRLC_EVENT_REJECTED_INVALID_EFFECTIVE_TIME, ZB_ZCL_DRLC_EVENT_RESERVED_FA,   ZB_ZCL_DRLC_EVENT_REJECTED_EXPIRED, ZB_ZCL_DRLC_EVENT_RESERVED_FC, ZB_ZCL_DRLC_EVENT_REJECTED_UNDEFINED_EVENT, ZB_ZCL_DRLC_EVENT_REJECTED,   ZB_ZCL_DRLC_EVENT_RESERVED_FF }
enum	zb_zcl_drlc_signature_type_e { ZB_ZCL_DRLC_LCE_NO_SIGNATURE = 0x00, ZB_ZCL_DRLC_LCE_SIGNATURE_ECDSA, ZB_ZCL_DRLC_LCE_SIGNATURE_RESERVED }

Detailed Description

This section describes DRLC client attributes and common cluster enumerations.

Typedef Documentation

typedef enum zb_zcl_drlc_cli_attr_e zb_zcl_drlc_cli_attr_t

DRLC Client attributes.

See also

SE spec, subclause D.2.3.2

typedef enum zb_zcl_drlc_criticality_levels_e zb_zcl_drlc_criticality_levels_t

Criticality Level value applied by the device.

See also

SE spe, Table D-3

typedef enum zb_zcl_drlc_device_class_e zb_zcl_drlc_device_class_t

DRLC device classes enumeration.

See also

SE spec, Table D-2.

typedef enum zb_zcl_drlc_event_status_e zb_zcl_drlc_event_status_t

DRLC Event Status enum

See also

SE spec, Table D-9

typedef enum zb_zcl_drlc_signature_type_e zb_zcl_drlc_signature_type_t

DRLC signature type enum

Enumeration Type Documentation

enum zb_zcl_drlc_cli_attr_e

DRLC Client attributes.

See also

SE spec, subclause D.2.3.2

Enumerator
ZB_ZCL_ATTR_DRLC_UTILITY_ENROLLMENT_GROUP	UtilityEnrollmentGroup attribute. Provides for utilites to assing devices to groups.
ZB_ZCL_ATTR_DRLC_START_RANDOMIZATION_MINUTES	StartRandomizationMinutes attribute. Represents the maximum number of minutes to be used when randomizing the start of an event.
ZB_ZCL_ATTR_DRLC_DURATION_RANDOMIZATION_MINUTES	DurationRandomizationMinutes attribute. Represents the maximum number of minutes to be used when randomizing the duration of an event.
ZB_ZCL_ATTR_DRLC_DEVICE_CLASS_VALUE	DeviceClassValue attribute. Identifies which bits the device will match in the Device Class fields.

enum zb_zcl_drlc_criticality_levels_e

Criticality Level value applied by the device.

See also

SE spe, Table D-3

Enumerator
ZB_ZCL_DRLC_CRITICALITY_LEVEL_0	Reserved
ZB_ZCL_DRLC_CRITICALITY_LEVEL_1	Green
ZB_ZCL_DRLC_CRITICALITY_LEVEL_2	Level 1
ZB_ZCL_DRLC_CRITICALITY_LEVEL_3	Level 2
ZB_ZCL_DRLC_CRITICALITY_LEVEL_4	Level 3
ZB_ZCL_DRLC_CRITICALITY_LEVEL_5	Level 4
ZB_ZCL_DRLC_CRITICALITY_LEVEL_6	Level 5
ZB_ZCL_DRLC_CRITICALITY_LEVEL_7	Emergency
ZB_ZCL_DRLC_CRITICALITY_LEVEL_8	Planned Outage
ZB_ZCL_DRLC_CRITICALITY_LEVEL_9	Service Disconnect

enum zb_zcl_drlc_device_class_e

DRLC device classes enumeration.

See also

SE spec, Table D-2.

Enumerator
ZB_ZCL_DRLC_DEVICE_CLASS_HVAC	HVAC Compressor or Furnace
ZB_ZCL_DRLC_DEVICE_CLASS_STRIP_HEATER	Strip Heaters/Baseboard Heaters
ZB_ZCL_DRLC_DEVICE_CLASS_WATER_HEATER	Water Heater
ZB_ZCL_DRLC_DEVICE_CLASS_POOL_PUMP	Pool Pump/Spa/Jacuzzi
ZB_ZCL_DRLC_DEVICE_CLASS_SMART_APPLIANCE	Smart Appliances
ZB_ZCL_DRLC_DEVICE_CLASS_IRRIGATION_PUMP	Irrigation Pump
ZB_ZCL_DRLC_DEVICE_CLASS_MCI_LOADS	Managed Commercial & Industrial (C&I) loads
ZB_ZCL_DRLC_DEVICE_CLASS_SIMPLE_LOADS	Simple misc. (Residential On/Off) loads
ZB_ZCL_DRLC_DEVICE_CLASS_EXTERIOR_LIGHTNING	Exterior Lighting
ZB_ZCL_DRLC_DEVICE_CLASS_INTERIOR_LIGHTNING	Interior Lighting
ZB_ZCL_DRLC_DEVICE_CLASS_ELECTRIC_VEHICLE	Electric Vehicle
ZB_ZCL_DRLC_DEVICE_CLASS_GENERATION_SYSTEMS	Generation Systems

enum zb_zcl_drlc_event_status_e

DRLC Event Status enum

See also

SE spec, Table D-9

Enumerator
ZB_ZCL_DRLC_EVENT_RESERVED_00	Reserved for future use.
ZB_ZCL_DRLC_EVENT_LCE_RECEIVED	Load Control Event command received
ZB_ZCL_DRLC_EVENT_EVENT_STARTED	Event started
ZB_ZCL_DRLC_EVENT_EVENT_COMPLETED	Event completed
ZB_ZCL_DRLC_EVENT_OPT_OUT	User has chosen to “Opt-Out”, user will not participate in this event
ZB_ZCL_DRLC_EVENT_OPT_IN	User has chosen to “Opt-In”, user will participate in this event
ZB_ZCL_DRLC_EVENT_EVENT_CANCELLED	The event has been cancelled
ZB_ZCL_DRLC_EVENT_EVENT_SUPERSEDED	The event has been superseded
ZB_ZCL_DRLC_EVENT_EVENT_PARTIALLY_OPT_OUT	Event partially completed with User “Opt-Out”.
ZB_ZCL_DRLC_EVENT_EVENT_PARTIALLY_OPT_IN	Event partially completed due to User “Opt-In”.
ZB_ZCL_DRLC_EVENT_EVENT_COMPLETED_NO_USER	Event completed, no User participation (Previous “Opt-Out”).
ZB_ZCL_DRLC_EVENT_RESERVED_0B	Reserved for future use.
ZB_ZCL_DRLC_EVENT_RESERVED_F7	Reserved for future use.
ZB_ZCL_DRLC_EVENT_REJECTED_INVALID_CANCEL_CMD	Rejected - Invalid Cancel Command (Default)
ZB_ZCL_DRLC_EVENT_REJECTED_INVALID_EFFECTIVE_TIME	Rejected - Invalid Cancel Command (Invalid Effective Time)
ZB_ZCL_DRLC_EVENT_RESERVED_FA	Reserved
ZB_ZCL_DRLC_EVENT_REJECTED_EXPIRED	Rejected - Event was received after it had expired (Current Time > Start Time + Duration)
ZB_ZCL_DRLC_EVENT_RESERVED_FC	Reserved for future use.
ZB_ZCL_DRLC_EVENT_REJECTED_UNDEFINED_EVENT	Rejected - Invalid Cancel Command (Undefined Event)
ZB_ZCL_DRLC_EVENT_REJECTED	Load Control Event command Rejected
ZB_ZCL_DRLC_EVENT_RESERVED_FF	Reserved for future use.

enum zb_zcl_drlc_signature_type_e

DRLC signature type enum

Enumerator
ZB_ZCL_DRLC_LCE_NO_SIGNATURE	No Signature
ZB_ZCL_DRLC_LCE_SIGNATURE_ECDSA	ECDSA
ZB_ZCL_DRLC_LCE_SIGNATURE_RESERVED	Reserved