Metering cluster commands

Data Structures
struct	zb_zcl_metering_get_profile_payload_s
struct	zb_zcl_metering_get_profile_response_payload_s
struct	zb_zcl_metering_request_fast_poll_mode_payload_s
struct	zb_zcl_metering_request_fast_poll_mode_response_payload_s
struct	zb_zcl_metering_get_sampled_data_response_payload_s
struct	zb_zcl_metering_get_sampled_data_payload_s
struct	zb_zcl_metering_get_snapshot_payload_s
struct	zb_zcl_metering_tou_delivered_payload_s
struct	zb_zcl_metering_tou_received_payload_s
struct	zb_zcl_metering_block_delivered_payload_s
struct	zb_zcl_metering_block_received_payload_s
struct	zb_zcl_metering_tou_delivered_no_billing_payload_s
struct	zb_zcl_metering_tou_received_no_billing_payload_s
struct	zb_zcl_metering_block_tier_delivered_no_billing_payload_s
struct	zb_zcl_metering_block_tier_received_no_billing_payload_s
union	zb_zcl_metering_snapshot_sub_payload_s
struct	zb_zcl_metering_publish_snapshot_payload_s

Macros
#define	ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_GENERATED_CMD_LIST
#define	ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_GENERATED_CMD_LIST
#define	ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_GENERATED_CMD_LIST
#define	ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_GENERATED_CMD_LIST
#define	ZB_ZCL_METERING_GET_PROFILE_PAYLOAD_SIZE_IS_VALID(current_size)   ((current_size == sizeof(zb_zcl_metering_get_profile_payload_t) ? ZB_TRUE : ZB_FALSE))
#define	ZB_ZCL_METERING_SEND_CMD_GET_SNAPSHOT(_param, _dst_addr, _addr_mode,_dst_ep, _src_ep, _payload)
#define	ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA(_param, _dst_addr, _addr_mode,_dst_ep, _src_ep, _payload)
#define	ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE(_param, _dst_addr, _addr_mode,_dst_ep, _src_ep, _payload)
#define	ZB_ZCL_METERING_SEND_CMD_GET_PROFILE(_param, _dst_addr, _addr_mode,_dst_ep, _src_ep, _payload)
#define	ZB_ZCL_METERING_SEND_CMD_PUBLISH_SNAPSHOT(_param, _dst_addr, _addr_mode,_dst_ep, _src_ep, _payload)
#define	ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE_RESPONSE(_param, _dst_addr, _addr_mode,_dst_ep, _src_ep, _payload)
#define	ZB_ZCL_METERING_SEND_CMD_GET_PROFILE_RESPONSE(_param, _dst_addr, _addr_mode, _dst_ep,_src_ep, _payload, _pl_size)
#define	ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA_RESPONSE(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, _pl_size)

Typedefs
typedef enum zb_zcl_metering_cli_cmd_e	zb_zcl_metering_cli_cmd_t
typedef enum zb_zcl_metering_srv_cmd_e	zb_zcl_metering_srv_cmd_t
typedef struct zb_zcl_metering_get_profile_payload_s	zb_zcl_metering_get_profile_payload_t
typedef struct zb_zcl_metering_get_profile_response_payload_s	zb_zcl_metering_get_profile_response_payload_t
typedef struct zb_zcl_metering_request_fast_poll_mode_payload_s	zb_zcl_metering_request_fast_poll_mode_payload_t
typedef struct zb_zcl_metering_request_fast_poll_mode_response_payload_s	zb_zcl_metering_request_fast_poll_mode_response_payload_t
typedef struct zb_zcl_metering_get_sampled_data_response_payload_s	zb_zcl_metering_get_sampled_data_response_payload_t
typedef struct zb_zcl_metering_get_sampled_data_payload_s	zb_zcl_metering_get_sampled_data_payload_t
typedef struct zb_zcl_metering_get_snapshot_payload_s	zb_zcl_metering_get_snapshot_payload_t
typedef struct zb_zcl_metering_tou_delivered_payload_s	zb_zcl_metering_tou_delivered_payload_t
typedef struct zb_zcl_metering_tou_received_payload_s	zb_zcl_metering_tou_received_payload_t
typedef struct zb_zcl_metering_block_delivered_payload_s	zb_zcl_metering_block_delivered_payload_t
typedef struct zb_zcl_metering_block_received_payload_s	zb_zcl_metering_block_received_payload_t
typedef struct zb_zcl_metering_tou_delivered_no_billing_payload_s	zb_zcl_metering_tou_delivered_no_billing_payload_t
typedef struct zb_zcl_metering_tou_received_no_billing_payload_s	zb_zcl_metering_tou_received_no_billing_payload_t
typedef struct zb_zcl_metering_block_tier_delivered_no_billing_payload_s	zb_zcl_metering_block_tier_delivered_no_billing_payload_t
typedef struct zb_zcl_metering_block_tier_received_no_billing_payload_s	zb_zcl_metering_block_tier_received_no_billing_payload_t
typedef union zb_zcl_metering_snapshot_sub_payload_s	zb_zcl_metering_snapshot_sub_payload_t
typedef struct zb_zcl_metering_publish_snapshot_payload_s	zb_zcl_metering_publish_snapshot_payload_t

Enumerations
enum	zb_zcl_metering_cli_cmd_e {   ZB_ZCL_METERING_CLI_CMD_GET_PROFILE = 0x00, ZB_ZCL_METERING_CLI_CMD_REQUEST_MIRROR_RESPONSE, ZB_ZCL_METERING_CLI_CMD_MIRROR_REMOVED, ZB_ZCL_METERING_CLI_CMD_REQUEST_FAST_POLL_MODE,   ZB_ZCL_METERING_CLI_CMD_SCHEDULE_SNAPSHOT, ZB_ZCL_METERING_CLI_CMD_TAKE_SNAPSHOT, ZB_ZCL_METERING_CLI_CMD_GET_SNAPSHOT, ZB_ZCL_METERING_CLI_CMD_START_SAMPLING,   ZB_ZCL_METERING_CLI_CMD_GET_SAMPLED_DATA, ZB_ZCL_METERING_CLI_CMD_MIRROR_REPORT_ATTRIBUTE_RESPONSE, ZB_ZCL_METERING_CLI_CMD_RESET_LOAD_LIMIT_COUNTER, ZB_ZCL_METERING_CLI_CMD_CHANGE_SUPPLY,   ZB_ZCL_METERING_CLI_CMD_LOCAL_CHANGE_SUPPLY, ZB_ZCL_METERING_CLI_CMD_SET_SUPPLY_STATUS, ZB_ZCL_METERING_CLI_CMD_SET_UNCONTROLLED_FLOW_THRESHOLD }
enum	zb_zcl_metering_srv_cmd_e {   ZB_ZCL_METERING_SRV_CMD_GET_PROFILE_RESPONSE = 0x00, ZB_ZCL_METERING_SRV_CMD_REQUEST_MIRROR, ZB_ZCL_METERING_SRV_CMD_REMOVE_MIRROR, ZB_ZCL_METERING_SRV_CMD_REQUEST_FAST_POLL_MODE_RESPONSE,   ZB_ZCL_METERING_SRV_CMD_SCHEDULE_SNAPSHOT_RESPONSE, ZB_ZCL_METERING_SRV_CMD_TAKE_SNAPSHOT_RESPONSE, ZB_ZCL_METERING_SRV_CMD_PUBLISH_SNAPSHOT, ZB_ZCL_METERING_SRV_CMD_GET_SAMPLED_DATA_RESPONSE,   ZB_ZCL_METERING_SRV_CMD_CONFIGURE_MIRROR, ZB_ZCL_METERING_SRV_CMD_CONFIGURE_NOTIFICATION_SCHEME, ZB_ZCL_METERING_SRV_CMD_CONFIGURE_NOTIFICATION_FLAG, ZB_ZCL_METERING_SRV_CMD_GET_NOTIFIED_MESSAGE,   ZB_ZCL_METERING_SRV_CMD_SUPPLY_STATUS_RESPONSE, ZB_ZCL_METERING_SRV_CMD_START_SAMPLING_RESPONSE }
enum	zb_zcl_metering_interval_channel_e { ZB_ZCL_METERING_CONSUMPTION_DELIVERED = 0, ZB_ZCL_METERING_CONSUMPTION_RECEIVED = 1, ZB_ZCL_METERING_REACTIVE_CONSUMPTION_DELIVERED = 2, ZB_ZCL_METERING_REACTIVE_CONSUMPTION_RECEIVED = 3 }
enum	zb_zcl_metering_status_field_e {   ZB_ZCL_METERING_SUCCESS = 0x00, ZB_ZCL_METERING_UNDEFINED_INTERVAL_CHANNEL_REQUESTED = 0x01, ZB_ZCL_METERING_INTERVAL_CHANNEL_NOT_SUPPORTED = 0x02, ZB_ZCL_METERING_INVALID_END_TIME = 0x03,   ZB_ZCL_METERING_MORE_PERIODS_REQUESTED_THAN_CAN_BE_RETURNED = 0x04, ZB_ZCL_METERING_NO_INTERVALS_AVAILABLE_FOR_THE_REQUESTED_TIME = 0x05 }
enum	zb_zcl_metering_profile_interval_period_e {   ZB_ZCl_METERING_INTERVAL_PERIOD_DAILY = 0, ZB_ZCl_METERING_INTERVAL_PERIOD_60_MINUTES = 1, ZB_ZCl_METERING_INTERVAL_PERIOD_30_MINUTES = 2, ZB_ZCl_METERING_INTERVAL_PERIOD_15_MINUTES = 3,   ZB_ZCl_METERING_INTERVAL_PERIOD_10_MINUTES = 4, ZB_ZCl_METERING_INTERVAL_PERIOD_7_5_MINUTES = 5, ZB_ZCl_METERING_INTERVAL_PERIOD_5_MINUTES = 6, ZB_ZCl_METERING_INTERVAL_PERIOD_2_5_MINUTES = 7,   ZB_ZCl_METERING_INTERVAL_PERIOD_1_MINUTE = 8 }
enum	zb_zcl_metering_sample_type_e {   ZB_ZCL_METERING_SAMPLE_TYPE_CONSUMPTION_DELIVERED = 0, ZB_ZCL_METERING_SAMPLE_TYPE_CONSUMPTION_RECEIVED = 1, ZB_ZCL_METERING_SAMPLE_TYPE_REACTIVE_CONSUMPTION_DELIVERED = 2, ZB_ZCL_METERING_SAMPLE_TYPE_REACTIVE_CONSUMPTION_RECEIVED = 3,   ZB_ZCL_METERING_SAMPLE_TYPE_INSTANTANEOUS_DEMAND = 4 }
enum	zb_zcl_metering_snapshot_cause_e {   ZB_ZCL_METERING_CAUSE_GENERAL = 0, ZB_ZCL_METERING_CAUSE_END_OF_BILLING_PERIOD = 1, ZB_ZCL_METERING_CAUSE_END_OF_BLOCK_PERIOD = 2, ZB_ZCL_METERING_CAUSE_CHANGE_OF_TARIFF_INFORMATION = 3,   ZB_ZCL_METERING_CAUSE_CHANGE_OF_PRICE_MATRIX = 4, ZB_ZCL_METERING_CAUSE_CHANGE_OF_BLOCK_THRESHOLDS = 5, ZB_ZCL_METERING_CAUSE_CHANGE_OF_CV = 6, ZB_ZCL_METERING_CAUSE_CHANGE_OF_CF = 7,   ZB_ZCL_METERING_CAUSE_CHANGE_OF_CALENDAR = 8, ZB_ZCL_METERING_CAUSE_CRITICAL_PEAK_PRICING = 9, ZB_ZCL_METERING_CAUSE_MANUALLY_TRIGGERED_FROM_CLIENT = 10, ZB_ZCL_METERING_CAUSE_END_OF_RESOLVE_PERIOD = 11,   ZB_ZCL_METERING_CAUSE_CHANGE_OF_TENANCY = 12, ZB_ZCL_METERING_CAUSE_CHANGE_OF_SUPPLIER = 13, ZB_ZCL_METERING_CAUSE_CHANGE_OF_METER_MODE = 14, ZB_ZCL_METERING_CAUSE_DEBT_PAYMENT = 15,   ZB_ZCL_METERING_CAUSE_SCHEDULED_SNAPSHOT = 16, ZB_ZCL_METERING_CAUSE_OTA_FIRMWARE_DOWNLOAD = 17 }
enum	zb_zcl_metering_snapshot_payload_type_e {   ZB_ZCL_METERING_TOU_DELIVERED_REGISTERS = 0, ZB_ZCL_METERING_TOU_RECEIVED_REGISTERS = 1, ZB_ZCL_METERING_BLOCK_TIER_DELIVERED = 2, ZB_ZCL_METERING_BLOCK_TIER_RECEIVED = 3,   ZB_ZCL_METERING_TOU_DELIVERED_NO_BILLING = 4, ZB_ZCL_METERING_TOU_RECEIVED_NO_BILLING = 5, ZB_ZCL_METERING_BLOCK_TIER_DELIVERED_NO_BILLING = 6, ZB_ZCL_METERING_BLOCK_TIER_RECEIVED_NO_BILLING = 7,   ZB_ZCL_METERING_DATA_UNAVAILABLE = 128 }

Functions
zb_void_t	zb_zcl_metering_send_cmd_get_snapshot (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_metering_get_snapshot_payload_t *payload, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_get_sampled_data (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_metering_get_sampled_data_payload_t *payload, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_request_fast_poll_mode (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_metering_request_fast_poll_mode_payload_t *payload, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_get_profile (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_metering_get_profile_payload_t *payload, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_publish_snapshot (zb_uint8_t param, const zb_addr_u *dst_addr, enum zb_aps_addr_mode_e dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_metering_publish_snapshot_payload_t *pl, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_request_fast_poll_mode_response (zb_uint8_t param, const zb_addr_u *dst_addr, enum zb_aps_addr_mode_e dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_metering_request_fast_poll_mode_response_payload_t *pl, zb_uint8_t pl_size, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_get_profile_response (zb_uint8_t param, const zb_addr_u *dst_addr, enum zb_aps_addr_mode_e dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_metering_get_profile_response_payload_t *pl, zb_uint8_t pl_size, zb_callback_t cb)
zb_void_t	zb_zcl_metering_send_cmd_get_sampled_data_response (zb_uint8_t param, const zb_addr_u *dst_addr, enum zb_aps_addr_mode_e dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_metering_get_sampled_data_response_payload_t *pl, zb_uint8_t pl_size, zb_callback_t cb)

Detailed Description

Macro Definition Documentation

#define ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_GENERATED_CMD_LIST

Value:

ZB_ZCL_METERING_CLI_CMD_GET_PROFILE, \
 ZB_ZCL_METERING_CLI_CMD_REQUEST_FAST_POLL_MODE, \
 ZB_ZCL_METERING_CLI_CMD_GET_SNAPSHOT, \
 ZB_ZCL_METERING_CLI_CMD_GET_SAMPLED_DATA

#define ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_GENERATED_CMD_LIST

Value:

ZB_ZCL_METERING_SRV_CMD_GET_PROFILE_RESPONSE, \
 ZB_ZCL_METERING_SRV_CMD_REQUEST_FAST_POLL_MODE_RESPONSE, \
 ZB_ZCL_METERING_SRV_CMD_PUBLISH_SNAPSHOT, \
 ZB_ZCL_METERING_SRV_CMD_GET_SAMPLED_DATA_RESPONSE

#define ZB_ZCL_METERING_SEND_CMD_GET_PROFILE	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload
	)

Value:

zb_zcl_metering_send_cmd_get_profile(_param, _dst_addr, _addr_mode, \
 _dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_metering_send_cmd_get_profile function

#define ZB_ZCL_METERING_SEND_CMD_GET_PROFILE_RESPONSE	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload,
			_pl_size
	)

Value:

zb_zcl_metering_send_cmd_get_profile_response(_param, _dst_addr, _addr_mode, _dst_ep, \
 _src_ep, _payload, _pl_size, NULL)

Macro for call zb_zcl_metering_send_cmd_get_profile_response function

#define ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload
	)

Value:

zb_zcl_metering_send_cmd_get_sampled_data(_param, _dst_addr, _addr_mode, \
 _dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_metering_send_cmd_get_sampled_data function

#define ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA_RESPONSE	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload,
			_pl_size
	)

Value:

zb_zcl_metering_send_cmd_get_sampled_data_response(_param, _dst_addr, _addr_mode, _dst_ep, \
 _src_ep, _payload, _pl_size, NULL)

Macro for call zb_zcl_metering_send_cmd_get_sampled_data_response function

#define ZB_ZCL_METERING_SEND_CMD_GET_SNAPSHOT	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload
	)

Value:

zb_zcl_metering_send_cmd_get_snapshot(_param, _dst_addr, _addr_mode, \
 _dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_metering_send_cmd_get_snapshot function

#define ZB_ZCL_METERING_SEND_CMD_PUBLISH_SNAPSHOT	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload
	)

Value:

zb_zcl_metering_send_cmd_publish_snapshot(_param, _dst_addr, _addr_mode, \
 _dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_metering_send_cmd_publish_snapshot function

#define ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload
	)

Value:

zb_zcl_metering_send_cmd_request_fast_poll_mode(_param, _dst_addr, _addr_mode, \
 _dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_metering_send_cmd_request_fast_poll_mode function

#define ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE_RESPONSE	(		_param,
			_dst_addr,
			_addr_mode,
			_dst_ep,
			_src_ep,
			_payload
	)

Value:

zb_zcl_metering_send_cmd_request_fast_poll_mode_response(_param, _dst_addr, _addr_mode, \
 _dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_metering_send_cmd_request_fast_poll_mode_response function

Typedef Documentation

typedef struct zb_zcl_metering_block_delivered_payload_s zb_zcl_metering_block_delivered_payload_t

SnapshotPayloadType 2 = Block Information Delivered Set

See also

ZB_ZCL_METERING_BLOCK_TIER_DELIVERED

typedef struct zb_zcl_metering_block_received_payload_s zb_zcl_metering_block_received_payload_t

SnapshotPayloadType 3 = Block Information Received Set

See also

ZB_ZCL_METERING_BLOCK_TIER_RECEIVED

typedef struct zb_zcl_metering_block_tier_delivered_no_billing_payload_s zb_zcl_metering_block_tier_delivered_no_billing_payload_t

SnapshotPayloadType 6 = Block Tier Information Set Delivered (No Billing)

See also

ZB_ZCL_METERING_BLOCK_TIER_DELIVERED_NO_BILLING

typedef struct zb_zcl_metering_block_tier_received_no_billing_payload_s zb_zcl_metering_block_tier_received_no_billing_payload_t

SnapshotPayloadType 7 = Block Tier Information Set Received (No Billing)

See also

ZB_ZCL_METERING_BLOCK_TIER_RECEIVED_NO_BILLING

typedef enum zb_zcl_metering_cli_cmd_e zb_zcl_metering_cli_cmd_t

Metering cluster client command identifiers.

See also

SE spec, subclause D.3.3.3.1

typedef struct zb_zcl_metering_get_profile_payload_s zb_zcl_metering_get_profile_payload_t

GetProfile command payload

See also

SE spec, subclause D.3.3.3.1.1.1

typedef struct zb_zcl_metering_get_profile_response_payload_s zb_zcl_metering_get_profile_response_payload_t

GetProfileResponse command payload

See also

SE spec, subclause D.3.2.3.1.1.1

typedef struct zb_zcl_metering_get_sampled_data_payload_s zb_zcl_metering_get_sampled_data_payload_t

GetSampledData command payload

See also

SE spec, subclause D.3.2.3.1.8

typedef struct zb_zcl_metering_get_sampled_data_response_payload_s zb_zcl_metering_get_sampled_data_response_payload_t

GetSampledDataResponse command payload

See also

SE spec, subclause D.3.2.3.1.8

typedef struct zb_zcl_metering_get_snapshot_payload_s zb_zcl_metering_get_snapshot_payload_t

GetSnapshot command payload

See also

SE spec, subclause D.3.3.3.1.7

typedef struct zb_zcl_metering_publish_snapshot_payload_s zb_zcl_metering_publish_snapshot_payload_t

PublishSnapshot command payload

See also

SE spec, subclause D.3.2.3.1.7

typedef struct zb_zcl_metering_request_fast_poll_mode_payload_s zb_zcl_metering_request_fast_poll_mode_payload_t

RequestFastPollMode command payload

See also

SE spec, subclause D.3.3.3.1.4

typedef struct zb_zcl_metering_request_fast_poll_mode_response_payload_s zb_zcl_metering_request_fast_poll_mode_response_payload_t

RequestFastPollModeResponse command payload

See also

SE spec, subclause D.3.3.3.1.4

typedef union zb_zcl_metering_snapshot_sub_payload_s zb_zcl_metering_snapshot_sub_payload_t

The format of the Snapshot Sub-Payload differs depending on the SnapshotPayloadType

See also

SE spec, Table D-53 and D.3.2.3.1.7

typedef enum zb_zcl_metering_srv_cmd_e zb_zcl_metering_srv_cmd_t

Metering cluster server command identifiers.

See also

SE spec, D.3.2.3.1

typedef struct zb_zcl_metering_tou_delivered_no_billing_payload_s zb_zcl_metering_tou_delivered_no_billing_payload_t

SnapshotPayloadType 4 = TOU Information Set Delivered (No Billing)

See also

ZB_ZCL_METERING_TOU_DELIVERED_NO_BILLING

typedef struct zb_zcl_metering_tou_delivered_payload_s zb_zcl_metering_tou_delivered_payload_t

SnapshotPayloadType 0 = TOU Information Delivered Set

See also

ZB_ZCL_METERING_TOU_DELIVERED_REGISTERS

typedef struct zb_zcl_metering_tou_received_no_billing_payload_s zb_zcl_metering_tou_received_no_billing_payload_t

SnapshotPayloadType 5 = TOU Information Set Received (No Billing)

See also

ZB_ZCL_METERING_TOU_RECEIVED_NO_BILLING

typedef struct zb_zcl_metering_tou_received_payload_s zb_zcl_metering_tou_received_payload_t

SnapshotPayloadType 1 = TOU Information Received Set

See also

ZB_ZCL_METERING_TOU_RECEIVED_REGISTERS

Enumeration Type Documentation

enum zb_zcl_metering_cli_cmd_e

Metering cluster client command identifiers.

See also

SE spec, subclause D.3.3.3.1

Enumerator
ZB_ZCL_METERING_CLI_CMD_GET_PROFILE	GetProfile command
ZB_ZCL_METERING_CLI_CMD_REQUEST_MIRROR_RESPONSE	The RequestMirrorResponse command allows the ESI to inform a sleepy Metering Device it has the ability to store and mirror its data.
ZB_ZCL_METERING_CLI_CMD_MIRROR_REMOVED	The MirrorRemovedCommand allows the ESI to inform a sleepy Metering Device mirroring support has been removed or halted.
ZB_ZCL_METERING_CLI_CMD_REQUEST_FAST_POLL_MODE	RequestFastPollMode command
ZB_ZCL_METERING_CLI_CMD_SCHEDULE_SNAPSHOT	This command is used to set up a schedule of when the device shall create snapshot data.
ZB_ZCL_METERING_CLI_CMD_TAKE_SNAPSHOT	This command is used to instruct the cluster server to take a single snapshot.
ZB_ZCL_METERING_CLI_CMD_GET_SNAPSHOT	This command is used to request snapshot data from the cluster server.
ZB_ZCL_METERING_CLI_CMD_START_SAMPLING	The sampling mechanism allows a set of samples of the specified type of data to be taken, commencing at the stipulated start time.
ZB_ZCL_METERING_CLI_CMD_GET_SAMPLED_DATA	This command is used to request sampled data from the server.
ZB_ZCL_METERING_CLI_CMD_MIRROR_REPORT_ATTRIBUTE_RESPONSE	This command is sent in response to the ReportAttribute command when the MirrorReporting attribute is set.
ZB_ZCL_METERING_CLI_CMD_RESET_LOAD_LIMIT_COUNTER	The ResetLoadLimitCounter command shall cause the LoadLimitCounter attribute to be reset
ZB_ZCL_METERING_CLI_CMD_CHANGE_SUPPLY	This command is sent from the Head-end or ESI to the Metering Device to instruct it to change the status of the valve or load switch, i.e. the supply.
ZB_ZCL_METERING_CLI_CMD_LOCAL_CHANGE_SUPPLY	This command is a simplified version of the Change Supply command, intended to be sent from an IHD to a meter as the consequence of a user action on the IHD.
ZB_ZCL_METERING_CLI_CMD_SET_SUPPLY_STATUS	This command is used to specify the required status of the supply following the occurrence of certain events on the meter.
ZB_ZCL_METERING_CLI_CMD_SET_UNCONTROLLED_FLOW_THRESHOLD	This command is used to update the 'Uncontrolled Flow Rate' configuration data used by flow meters.

enum zb_zcl_metering_interval_channel_e

Interval Channel Values

See also

SE spec, subclause D.3.3.3.1.1.1

enum zb_zcl_metering_profile_interval_period_e

Profile Interval Period

See also

SE spec, Table D-49

Enumerator
ZB_ZCl_METERING_INTERVAL_PERIOD_DAILY	Daily
ZB_ZCl_METERING_INTERVAL_PERIOD_60_MINUTES	60 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_30_MINUTES	30 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_15_MINUTES	15 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_10_MINUTES	10 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_7_5_MINUTES	7.5 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_5_MINUTES	5 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_2_5_MINUTES	2.5 minutes
ZB_ZCl_METERING_INTERVAL_PERIOD_1_MINUTE	1 minute

enum zb_zcl_metering_sample_type_e

Sample Type Enumerations

See also

SE spec, Table D-54

Enumerator
ZB_ZCL_METERING_SAMPLE_TYPE_CONSUMPTION_DELIVERED	Consumption Delivered
ZB_ZCL_METERING_SAMPLE_TYPE_CONSUMPTION_RECEIVED	Consumption Received
ZB_ZCL_METERING_SAMPLE_TYPE_REACTIVE_CONSUMPTION_DELIVERED	Reactive Consumption Delivered
ZB_ZCL_METERING_SAMPLE_TYPE_REACTIVE_CONSUMPTION_RECEIVED	Reactive Consumption Received
ZB_ZCL_METERING_SAMPLE_TYPE_INSTANTANEOUS_DEMAND	InstantaneousDemand

enum zb_zcl_metering_snapshot_cause_e

Snapshot Cause BitMap

See also

SE spec, Table D-52

Enumerator
ZB_ZCL_METERING_CAUSE_GENERAL	General
ZB_ZCL_METERING_CAUSE_END_OF_BILLING_PERIOD	End of Billing Period
ZB_ZCL_METERING_CAUSE_END_OF_BLOCK_PERIOD	End of Block Period
ZB_ZCL_METERING_CAUSE_CHANGE_OF_TARIFF_INFORMATION	Change of Tariff Information
ZB_ZCL_METERING_CAUSE_CHANGE_OF_PRICE_MATRIX	Change of Price Matrix
ZB_ZCL_METERING_CAUSE_CHANGE_OF_BLOCK_THRESHOLDS	Change of Block Thresholds
ZB_ZCL_METERING_CAUSE_CHANGE_OF_CV	Change of CV
ZB_ZCL_METERING_CAUSE_CHANGE_OF_CF	Change of CF
ZB_ZCL_METERING_CAUSE_CHANGE_OF_CALENDAR	Change of Calendar
ZB_ZCL_METERING_CAUSE_CRITICAL_PEAK_PRICING	Critical Peak Pricing
ZB_ZCL_METERING_CAUSE_MANUALLY_TRIGGERED_FROM_CLIENT	Manually Triggered from Client
ZB_ZCL_METERING_CAUSE_END_OF_RESOLVE_PERIOD	End of Resolve Period
ZB_ZCL_METERING_CAUSE_CHANGE_OF_TENANCY	Change of Tenancy
ZB_ZCL_METERING_CAUSE_CHANGE_OF_SUPPLIER	Change of Supplier
ZB_ZCL_METERING_CAUSE_CHANGE_OF_METER_MODE	Change of (Meter) Mode
ZB_ZCL_METERING_CAUSE_DEBT_PAYMENT	Debt Payment
ZB_ZCL_METERING_CAUSE_SCHEDULED_SNAPSHOT	Scheduled Snapshot
ZB_ZCL_METERING_CAUSE_OTA_FIRMWARE_DOWNLOAD	OTA Firmware Download

enum zb_zcl_metering_snapshot_payload_type_e

Snapshot Payload Type

See also

SE spec, Table D-53

Enumerator
ZB_ZCL_METERING_TOU_DELIVERED_REGISTERS	TOU Information Set DeliveredRegisters
ZB_ZCL_METERING_TOU_RECEIVED_REGISTERS	TOU Information Set Received Registers
ZB_ZCL_METERING_BLOCK_TIER_DELIVERED	Block Tier Information Set Delivered
ZB_ZCL_METERING_BLOCK_TIER_RECEIVED	Block Tier Information Set Received
ZB_ZCL_METERING_TOU_DELIVERED_NO_BILLING	TOU Information Set Delivered (No Billing)
ZB_ZCL_METERING_TOU_RECEIVED_NO_BILLING	TOU Information Set Received (No Billing)
ZB_ZCL_METERING_BLOCK_TIER_DELIVERED_NO_BILLING	Block Tier Information Set Delivered (No Billing)
ZB_ZCL_METERING_BLOCK_TIER_RECEIVED_NO_BILLING	Block Tier Information Set Received (No Billing)
ZB_ZCL_METERING_DATA_UNAVAILABLE	Data Unavailable

enum zb_zcl_metering_srv_cmd_e

Metering cluster server command identifiers.

See also

SE spec, D.3.2.3.1

Enumerator
ZB_ZCL_METERING_SRV_CMD_GET_PROFILE_RESPONSE	Get Profile Response
ZB_ZCL_METERING_SRV_CMD_REQUEST_MIRROR	This command is used to request the ESI to mirror Metering Device data.
ZB_ZCL_METERING_SRV_CMD_REMOVE_MIRROR	This command is used to request the ESI to remove its mirror of Metering Device data.
ZB_ZCL_METERING_SRV_CMD_REQUEST_FAST_POLL_MODE_RESPONSE	RequestFastPollModeResponse command
ZB_ZCL_METERING_SRV_CMD_SCHEDULE_SNAPSHOT_RESPONSE	This command is generated in response to a ScheduleSnapshot command, and is sent to confirm whether the requested snapshot schedule has been set up.
ZB_ZCL_METERING_SRV_CMD_TAKE_SNAPSHOT_RESPONSE	This command is generated in response to a TakeSnapshot command, and is sent to confirm whether the requested snapshot has been accepted and successfully taken.
ZB_ZCL_METERING_SRV_CMD_PUBLISH_SNAPSHOT	This command is generated in response to a GetSnapshot command or when a new snapshot is created.
ZB_ZCL_METERING_SRV_CMD_GET_SAMPLED_DATA_RESPONSE	This command is used to send the requested sample data to the client. It is generated in response to a GetSampledData command
ZB_ZCL_METERING_SRV_CMD_CONFIGURE_MIRROR	Where 'Two Way Mirroring' is being implemented, this command shall be sent to the mirror once the mirror has been created. The command allows a BOMD to provide the operational configuration of the associated Mirror.
ZB_ZCL_METERING_SRV_CMD_CONFIGURE_NOTIFICATION_SCHEME	Where 'Two Way Mirroring' is being implemented, and a non-default Notification Scheme is to be used, this command shall be sent to the mirror once the mirror has been created.
ZB_ZCL_METERING_SRV_CMD_CONFIGURE_NOTIFICATION_FLAG	Where 'Two Way Mirroring' is being implemented, and a non-default Notification Scheme is to be used, the ConfigureNotificationFlags command allows a BOMD to set the commands relating to the bit value for each NotificationFlags::N attribute that the scheme is proposing to use.
ZB_ZCL_METERING_SRV_CMD_GET_NOTIFIED_MESSAGE	The GetNotifiedMessage command is used only when a BOMD is being mirrored. This command provides a method for the BOMD to notify the Mirror message queue that it wants to receive commands that the Mirror has queued.
ZB_ZCL_METERING_SRV_CMD_SUPPLY_STATUS_RESPONSE	This command is transmitted by a Metering Device in response to a Change Supply command.
ZB_ZCL_METERING_SRV_CMD_START_SAMPLING_RESPONSE	This command is transmitted by a Metering Device in response to a StartSampling command.

enum zb_zcl_metering_status_field_e

Status Field Values

See also

SE spec, Table D-48

Enumerator
ZB_ZCL_METERING_SUCCESS	Success
ZB_ZCL_METERING_UNDEFINED_INTERVAL_CHANNEL_REQUESTED	Undefined Interval Channel requested
ZB_ZCL_METERING_INTERVAL_CHANNEL_NOT_SUPPORTED	Interval Channel not supported
ZB_ZCL_METERING_INVALID_END_TIME	Invalid End Time
ZB_ZCL_METERING_MORE_PERIODS_REQUESTED_THAN_CAN_BE_RETURNED	More periods requested than can be returned
ZB_ZCL_METERING_NO_INTERVALS_AVAILABLE_FOR_THE_REQUESTED_TIME	No intervals available for the requested time

Function Documentation

zb_void_t zb_zcl_metering_send_cmd_get_profile	(	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_metering_get_profile_payload_t *	payload,
		zb_callback_t	cb
	)

Function for send GetProfile command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_PROFILE_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 (ref to zb_zcl_metering_get_profile_payload_t).
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_get_profile_response	(	zb_uint8_t	param,
		const zb_addr_u *	dst_addr,
		enum zb_aps_addr_mode_e	dst_addr_mode,
		zb_uint8_t	dst_ep,
		zb_uint8_t	src_ep,
		const zb_zcl_metering_get_profile_response_payload_t *	pl,
		zb_uint8_t	pl_size,
		zb_callback_t	cb
	)

Function for send GetProfileResponse command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_PROFILE_RESPONSE_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.
pl	- Packet payload (ref to zb_zcl_metering_get_profile_response_payload_t).
pl_size	- size in bytes of input payload. Stack can calculate actual payload size. Set pl_size to 0 for it.
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_get_sampled_data	(	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_metering_get_sampled_data_payload_t *	payload,
		zb_callback_t	cb
	)

Function for send GetSampledData command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_SAMPLED_DATA_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 (ref to zb_zcl_metering_get_sampled_data_payload_t).
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_get_sampled_data_response	(	zb_uint8_t	param,
		const zb_addr_u *	dst_addr,
		enum zb_aps_addr_mode_e	dst_addr_mode,
		zb_uint8_t	dst_ep,
		zb_uint8_t	src_ep,
		const zb_zcl_metering_get_sampled_data_response_payload_t *	pl,
		zb_uint8_t	pl_size,
		zb_callback_t	cb
	)

Function for send GetSampledDataResponse command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_SAMPLED_DATA_RESPONSE_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.
pl	- Packet payload (ref to zb_zcl_metering_get_sampled_data_response_payload_t).
pl_size	- size in bytes of input payload. Stack can calculate actual payload size. Set pl_size to 0 for it.
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_get_snapshot	(	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_metering_get_snapshot_payload_t *	payload,
		zb_callback_t	cb
	)

Function for send GetSnapshot command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_SNAPSHOT_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 (ref to zb_zcl_metering_get_snapshot_payload_t).
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_publish_snapshot	(	zb_uint8_t	param,
		const zb_addr_u *	dst_addr,
		enum zb_aps_addr_mode_e	dst_addr_mode,
		zb_uint8_t	dst_ep,
		zb_uint8_t	src_ep,
		const zb_zcl_metering_publish_snapshot_payload_t *	pl,
		zb_callback_t	cb
	)

Function for send PublishSnapshot command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_PUBLISH_SNAPSHOT_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.
pl	- Packet payload (ref to zb_zcl_metering_publish_snapshot_payload_t).
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_request_fast_poll_mode	(	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_metering_request_fast_poll_mode_payload_t *	payload,
		zb_callback_t	cb
	)

Function for send RequestFastPollMode command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_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 (ref to zb_zcl_metering_request_fast_poll_mode_payload_t).
cb	- Callback which should be called when the ZCL stack receives APS ack.

zb_void_t zb_zcl_metering_send_cmd_request_fast_poll_mode_response	(	zb_uint8_t	param,
		const zb_addr_u *	dst_addr,
		enum zb_aps_addr_mode_e	dst_addr_mode,
		zb_uint8_t	dst_ep,
		zb_uint8_t	src_ep,
		const zb_zcl_metering_request_fast_poll_mode_response_payload_t *	pl,
		zb_uint8_t	pl_size,
		zb_callback_t	cb
	)

Function for send RequestFastPollMode command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_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.
pl	- Packet payload (ref to zb_zcl_metering_request_fast_poll_mode_response_payload_t).
pl_size	- size in bytes of input payload. Stack can calculate actual payload size. Set pl_size to 0 for it.
cb	- Callback which should be called when the ZCL stack receives APS ack.