Logo
Developing with ZBOSS for Zigbee
zb_zcl_energy_mgmt.h File Reference
#include "zboss_api_core.h"
#include "zcl/zb_zcl_drlc.h"

Data Structures

struct  zb_zcl_energy_management_attr_s
 Energy Management cluster attributes. More...
 
struct  zb_zcl_energy_management_manage_event_payload_s
 
struct  zb_zcl_energy_management_report_event_status_payload_s
 

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...
 
#define ZB_ZCL_ENERGY_MANAGEMENT_MANAGE_EVENT_PAYLOAD_SIZE_IS_VALID(size)   ((size) >= sizeof(zb_zcl_energy_management_manage_event_payload_t))
 
#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_SERVER_ROLE_GENERATED_CMD_LIST   ZB_ZCL_ENERGY_MANAGEMENT_SRV_CMD_REPORT_EVENT_STATUS
 
#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_SERVER_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_CLIENT_ROLE_GENERATED_CMD_LIST   ZB_ZCL_ENERGY_MANAGEMENT_CLI_CMD_MANAGE_EVENT
 
#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_CLIENT_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_ENERGY_MANAGEMENT_REPORT_EVENT_STATUS_PAYLOAD_SIZE_IS_VALID(size)   ((size) >= sizeof(zb_zcl_energy_management_report_event_status_payload_t))
 
#define ZB_ZCL_ENERGY_MANAGEMENT_REPORT_EVENT_STATUS_PAYLOAD_INIT
 
#define ZB_ZCL_ENERGY_MANAGEMENT_MANAGE_EVENT_PAYLOAD_INIT   (zb_zcl_energy_management_manage_event_payload_t) {0} \
 
#define ZB_ZCL_ENERGY_MANAGEMENT_SEND_CMD_REPORT_EVENT_STATUS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_ENERGY_MANAGEMENT_SEND_CMD_MANAGE_EVENT(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_SERVER_ROLE_INIT   zb_zcl_energy_management_init_server
 
#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_CLIENT_ROLE_INIT   zb_zcl_energy_management_init_client
 

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
 
typedef enum zb_zcl_energy_management_cli_cmd_e zb_zcl_energy_management_cli_cmd_t
 
typedef struct zb_zcl_energy_management_manage_event_payload_s zb_zcl_energy_management_manage_event_payload_t
 
typedef enum zb_zcl_energy_management_actions_required_encoding_e zb_zcl_energy_management_actions_required_encoding_t
 
typedef enum zb_zcl_energy_management_srv_cmd_e zb_zcl_energy_management_srv_cmd_t
 
typedef struct zb_zcl_energy_management_report_event_status_payload_s zb_zcl_energy_management_report_event_status_payload_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
}
 
enum  zb_zcl_energy_management_cli_cmd_e { ZB_ZCL_ENERGY_MANAGEMENT_CLI_CMD_MANAGE_EVENT = 0x00 }
 
enum  zb_zcl_energy_management_actions_required_encoding_e { ZB_ZCL_ENERGY_MANAGEMENT_ACTIONS_EVENT_OPT_OUT = 0, ZB_ZCL_ENERGY_MANAGEMENT_ACTIONS_OPT_INTO_EVENT = 1, ZB_ZCL_ENERGY_MANAGEMENT_ACTIONS_DISABLE_DUTY_CYCLING = 2, ZB_ZCL_ENERGY_MANAGEMENT_ACTIONS_ENABLE_DUTY_CYCLING = 3 }
 
enum  zb_zcl_energy_management_srv_cmd_e { ZB_ZCL_ENERGY_MANAGEMENT_SRV_CMD_REPORT_EVENT_STATUS = 0x00 }
 

Functions

void zb_zcl_energy_management_server_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_energy_management_report_event_status_payload_t *payload, zb_callback_t cb)
 
void zb_zcl_energy_management_client_send_manage_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_energy_management_manage_event_payload_t *payload, zb_callback_t cb)
 
void zb_zcl_energy_management_init_server (void)
 
void zb_zcl_energy_management_init_client (void)
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_CLIENT_ROLE_INIT   zb_zcl_energy_management_init_client

§ ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_ENERGY_MANAGEMENT_SERVER_ROLE_INIT   zb_zcl_energy_management_init_server

Function Documentation

§ zb_zcl_energy_management_init_client()

void zb_zcl_energy_management_init_client ( void  )

§ zb_zcl_energy_management_init_server()

void zb_zcl_energy_management_init_server ( void  )

Internal handler for Energy Management Cluster commands