nRF5 SDK for Thread and Zigbee v3.2.0
Data Structures | Macros | Typedefs | Enumerations | Functions
DRLC commands
ZCL Demand Response and Load Control (DRLC) cluster

Data Structures

struct  zb_zcl_drlc_lce_payload_s
 
struct  zb_zcl_drlc_cancel_lce_payload_s
 
struct  zb_zcl_drlc_report_event_status_payload_s
 
struct  zb_zcl_drlc_get_scheduled_events_payload_s
 

Macros

#define ZB_ZCL_DRLC_LCE_PAYLOAD_INIT
 
#define ZB_ZCL_DRLC_CANCEL_LCE_PAYLOAD_INIT   (zb_zcl_drlc_cancel_lce_payload_t) {0}
 
#define ZB_ZCL_DRLC_REPORT_EVENT_STATUS_PAYLOAD_INIT
 
#define ZB_ZCL_DRLC_CMD_GET_SCHEDULED_EVENTS_PAYLOAD_INIT
 
#define ZB_ZCL_DRLC_SEND_CMD_LOAD_CONTROL_EVENT(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_DRLC_SEND_CMD_CANCEL_LCE(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_DRLC_SEND_CMD_CANCEL_ALL_LCE(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_DRLC_SEND_CMD_GET_SCHEDULED_EVENTS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_DRLC_SEND_CMD_REPORT_EVENT_STATUS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 

Typedefs

typedef enum zb_zcl_drlc_srv_cmd_e zb_zcl_drlc_srv_cmd_t
 
typedef enum zb_zcl_drlc_cli_cmd_e zb_zcl_drlc_cli_cmd_t
 
typedef struct
zb_zcl_drlc_lce_payload_s 		zb_zcl_drlc_lce_payload_t
 
typedef struct
zb_zcl_drlc_cancel_lce_payload_s 		zb_zcl_drlc_cancel_lce_payload_t
 
typedef struct
zb_zcl_drlc_report_event_status_payload_s 		zb_zcl_drlc_report_event_status_payload_t
 
typedef struct
zb_zcl_drlc_get_scheduled_events_payload_s 		zb_zcl_drlc_get_scheduled_events_payload_t
 

Enumerations

enum  zb_zcl_drlc_srv_cmd_e { ZB_ZCL_DRLC_SRV_CMD_LOAD_CONTROL_EVENT = 0x00, ZB_ZCL_DRLC_SRV_CMD_CANCEL_LOAD_CONTROL_EVENT = 0x01, ZB_ZCL_DRLC_SRV_CMD_CANCEL_ALL_LOAD_CONTROL_EVENTS = 0x02 }
 
enum  zb_zcl_drlc_cli_cmd_e { ZB_ZCL_DRLC_CLI_CMD_REPORT_EVENT_STATUS = 0x00, ZB_ZCL_DRLC_CLI_CMD_GET_SCHEDULED_EVENTS = 0x01 }
 

Functions

zb_void_t zb_drlc_server_send_load_control_event (zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_lce_payload_t *payload, zb_callback_t cb)
 
zb_void_t zb_drlc_server_send_cancel_load_control_event (zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_cancel_lce_payload_t *payload, zb_callback_t cb)
 
zb_void_t zb_drlc_server_send_cancel_all_load_control_events (zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_uint8_t *payload, zb_callback_t cb)
 
zb_void_t zb_drlc_client_send_report_event_status (zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_report_event_status_payload_t *payload, zb_callback_t cb)
 
zb_void_t zb_drlc_client_send_get_scheduled_events (zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_get_scheduled_events_payload_t *payload, zb_callback_t cb)
 

Detailed Description

This section describes all commands structures and data payloads.

Macro Definition Documentation

#define ZB_ZCL_DRLC_CANCEL_LCE_PAYLOAD_INIT   (zb_zcl_drlc_cancel_lce_payload_t) {0}

Initialize CancelLoadControlEvent command zb_zcl_drlc_cancel_lce_payload_t payload

#define ZB_ZCL_DRLC_CMD_GET_SCHEDULED_EVENTS_PAYLOAD_INIT
Value:
(zb_zcl_drlc_get_scheduled_events_payload_t) \
{ \
.issuer_event_id = 0xFFFFFFFF, \
}
zb_zcl_drlc_get_scheduled_events_payload_t
struct zb_zcl_drlc_get_scheduled_events_payload_s zb_zcl_drlc_get_scheduled_events_payload_t

Initialize GetScheduledEvents command zb_zcl_drlc_get_scheduled_events_payload_t payload

#define ZB_ZCL_DRLC_LCE_PAYLOAD_INIT
Value:
(zb_zcl_drlc_lce_payload_t) \
{ \
.cooling_temperature_offset = 0xFF, \
.heating_temperature_offset = 0xFF, \
.cooling_temperature_set_point = (zb_int16_t) 0x8000, \
.heating_temperature_set_point = (zb_int16_t) 0x8000, \
.average_load_adjustment_percentage = (zb_int8_t) 0x80, \
.duty_cycle = 0xFF, \
}
zb_zcl_drlc_lce_payload_t
struct zb_zcl_drlc_lce_payload_s zb_zcl_drlc_lce_payload_t
zb_int16_t
signed short zb_int16_t
Project-local 2-byte signed int type.
Definition: zb_types.h:122
zb_int8_t
signed char zb_int8_t
Project-local 1-byte signed int type.
Definition: zb_types.h:118

Initialize LoadControlEvent command zb_zcl_drlc_lce_payload_t payload

#define ZB_ZCL_DRLC_REPORT_EVENT_STATUS_PAYLOAD_INIT
Value:
(zb_zcl_drlc_report_event_status_payload_t) \
{ \
.cooling_temperature_set_point_applied = (zb_uint16_t) 0x8000, \
.heating_temperature_set_point_applied = (zb_uint16_t) 0x8000, \
.average_load_adjustment_percentage_applied = (zb_int8_t) 0x80, \
.duty_cycle_applied = (zb_uint8_t) 0xFF, \
.signature = \
{ \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, \
}, \
}
zb_uint16_t
unsigned short zb_uint16_t
Project-local 2-byte unsigned int type.
Definition: zb_types.h:120
zb_zcl_drlc_report_event_status_payload_t
struct zb_zcl_drlc_report_event_status_payload_s zb_zcl_drlc_report_event_status_payload_t
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:116
zb_int8_t
signed char zb_int8_t
Project-local 1-byte signed int type.
Definition: zb_types.h:118

Initialize ReportEventStatus command zb_zcl_drlc_report_event_status_payload_t payload

#define ZB_ZCL_DRLC_SEND_CMD_CANCEL_ALL_LCE (   _param,
  _dst_addr,
  _dst_addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_drlc_server_send_cancel_all_load_control_events(_param, \
_dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload, NULL)
zb_drlc_server_send_cancel_all_load_control_events
zb_void_t zb_drlc_server_send_cancel_all_load_control_events(zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_uint8_t *payload, zb_callback_t cb)

Macro for call zb_drlc_server_send_cancel_all_load_control_events function

#define ZB_ZCL_DRLC_SEND_CMD_CANCEL_LCE (   _param,
  _dst_addr,
  _dst_addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_drlc_server_send_cancel_load_control_event(_param, \
_dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload, NULL)
zb_drlc_server_send_cancel_load_control_event
zb_void_t zb_drlc_server_send_cancel_load_control_event(zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_cancel_lce_payload_t *payload, zb_callback_t cb)

Macro for call zb_drlc_server_send_cancel_load_control_event function

#define ZB_ZCL_DRLC_SEND_CMD_GET_SCHEDULED_EVENTS (   _param,
  _dst_addr,
  _dst_addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_drlc_client_send_get_scheduled_events(_param, \
_dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload, NULL)
zb_drlc_client_send_get_scheduled_events
zb_void_t zb_drlc_client_send_get_scheduled_events(zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_get_scheduled_events_payload_t *payload, zb_callback_t cb)

Macro for call zb_drlc_client_send_get_scheduled_events function

#define ZB_ZCL_DRLC_SEND_CMD_LOAD_CONTROL_EVENT (   _param,
  _dst_addr,
  _dst_addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_drlc_server_send_load_control_event(_param, \
_dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload, NULL)
zb_drlc_server_send_load_control_event
zb_void_t zb_drlc_server_send_load_control_event(zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_lce_payload_t *payload, zb_callback_t cb)

Macro for call zb_drlc_server_send_load_control_event function

#define ZB_ZCL_DRLC_SEND_CMD_REPORT_EVENT_STATUS (   _param,
  _dst_addr,
  _dst_addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_drlc_client_send_report_event_status(_param, \
_dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload, NULL)
zb_drlc_client_send_report_event_status
zb_void_t zb_drlc_client_send_report_event_status(zb_uint8_t param, zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_zcl_drlc_report_event_status_payload_t *payload, zb_callback_t cb)

Macro for call zb_drlc_client_send_report_event_status function

Typedef Documentation

typedef struct zb_zcl_drlc_cancel_lce_payload_s zb_zcl_drlc_cancel_lce_payload_t

CancelLoadControlEvent command payload

See also
SE spec, Figure D-3
typedef enum zb_zcl_drlc_cli_cmd_e zb_zcl_drlc_cli_cmd_t

Commands are generated by DRLC Client.

See also
SE spec, Table D-8
typedef struct zb_zcl_drlc_get_scheduled_events_payload_s zb_zcl_drlc_get_scheduled_events_payload_t

GetScheduledEvents command payload

See also
SE spec, Figure D-6
typedef struct zb_zcl_drlc_lce_payload_s zb_zcl_drlc_lce_payload_t

LoadControlEvent command payload.

See also
SE spec, Figure D-2
typedef struct zb_zcl_drlc_report_event_status_payload_s zb_zcl_drlc_report_event_status_payload_t

ReportEventStatus command payload

See also
SE spec, Figure D-5
typedef enum zb_zcl_drlc_srv_cmd_e zb_zcl_drlc_srv_cmd_t

Commands are generated by DRLC Server.

See also
SE spec, Table D-1

Enumeration Type Documentation

enum zb_zcl_drlc_cli_cmd_e

Commands are generated by DRLC Client.

See also
SE spec, Table D-8
Enumerator
ZB_ZCL_DRLC_CLI_CMD_REPORT_EVENT_STATUS 

ReportEventStatus is generated when the client device detects a change of state for an active LoadControl event.

See also
zb_zcl_drlc_report_event_status_payload_s
ZB_ZCL_DRLC_CLI_CMD_GET_SCHEDULED_EVENTS 

GetScheduledEvents is generated when the client device wishes to verify the available LoadControl events.

See also
zb_zcl_drlc_get_scheduled_events_payload_s
enum zb_zcl_drlc_srv_cmd_e

Commands are generated by DRLC Server.

See also
SE spec, Table D-1
Enumerator
ZB_ZCL_DRLC_SRV_CMD_LOAD_CONTROL_EVENT 

LoadControlEvent is generated when the ESI wants to control one or more load control devices usually as the result of an energy curtailment command from the Smart Energy Network.

See also
zb_zcl_drlc_lce_payload_s
ZB_ZCL_DRLC_SRV_CMD_CANCEL_LOAD_CONTROL_EVENT 

CancelLoadControlEvent is generated when the ESI wants to cancel previously scheduled control of one or more load control devices, usually as the result of an energy curtailment command from the Smart Energy Network

See also
zb_zcl_drlc_cancel_lce_payload_s
ZB_ZCL_DRLC_SRV_CMD_CANCEL_ALL_LOAD_CONTROL_EVENTS 

CancellAllLoadControlEvents is generated when the ESI wants to cancel all events for control device(s)

Function Documentation

zb_void_t zb_drlc_client_send_get_scheduled_events ( zb_uint8_t  param,
zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
zb_zcl_drlc_get_scheduled_events_payload_t *  payload,
zb_callback_t  cb 
)

Function for send GetScheduledEvents command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_drlc_get_scheduled_events_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.
zb_void_t zb_drlc_client_send_report_event_status ( zb_uint8_t  param,
zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
zb_zcl_drlc_report_event_status_payload_t *  payload,
zb_callback_t  cb 
)

Function for send ReportEventStatus command. On sender's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with one of ZB_ZCL_DRLC_LOAD_CONTROL_EVENT_CB_ID, ZB_ZCL_DRLC_CANCEL_LOAD_CONTROL_EVENT_CB_ID, ZB_ZCL_DRLC_CANCEL_ALL_LOAD_CONTROL_EVENTS_CB_ID callback ids on reception of LoadControlEvent, CancelLoadControlEvent, CancellAllLoadControlEvents commands respectively.
On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_REPORT_EVENT_STATUS_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_drlc_report_event_status_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.
zb_void_t zb_drlc_server_send_cancel_all_load_control_events ( zb_uint8_t  param,
zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
zb_uint8_t *  payload,
zb_callback_t  cb 
)

Function for send CancellAllLoadControlEvents command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_CANCEL_ALL_LOAD_CONTROL_EVENTS_CB_ID

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload: pointer to zb_uint8_t, where "Cancel Control" field value is placed (see SE spec, D.2.2.3.3.1).
cb- Callback which should be called when the ZCL stack receives APS ack.
zb_void_t zb_drlc_server_send_cancel_load_control_event ( zb_uint8_t  param,
zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
zb_zcl_drlc_cancel_lce_payload_t *  payload,
zb_callback_t  cb 
)

Function for send CancelLoadControlEvent command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_CANCEL_LOAD_CONTROL_EVENT_CB_ID

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_drlc_cancel_lce_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.
zb_void_t zb_drlc_server_send_load_control_event ( zb_uint8_t  param,
zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
zb_zcl_drlc_lce_payload_t *  payload,
zb_callback_t  cb 
)

Function for send LoadControlEvent command. On sender's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_CB_ID callback id on reception of GetScheduledEvents command.
On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_LOAD_CONTROL_EVENT_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_drlc_lce_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.
Documentation feedback | Developer Zone | Subscribe | Updated