Meter Mirror Server#

API and Callbacks for the Meter Mirror Cluster Server Component.

A component for mirroring attributes of a sleepy meter in a Smart Energy network. The device is expected to be a configured as mirror server on as many endpoints as are allocated as meters. Those endpoints must be contiguous.

Modules#

Meter Mirror

API#

bool

sl_zigbee_af_meter_mirror_get_eui64_by_endpoint(uint8_t endpoint, sl_802154_long_addr_t returnEui64)

Get EUI64 by endpoint.

bool

sl_zigbee_af_meter_mirror_is_mirror_used(uint8_t endpoint)

Mirror used status.

bool

sl_zigbee_af_meter_mirror_get_endpoint_by_eui64(sl_802154_long_addr_t eui64, uint8_t *returnEndpoint)

Get endpoint by EUI64.

uint16_t

sl_zigbee_af_meter_mirror_request_mirror(sl_802154_long_addr_t requestingDeviceIeeeAddress)

Request mirror.

uint16_t

sl_zigbee_af_meter_mirror_remove_mirror(sl_802154_long_addr_t requestingDeviceIeeeAddress)

Remove mirror.

Variables#

sl_802154_long_addr_t

nullEui64

Macros#

#define

EM_AF_APPLICATION_MANUFACTURER_CODE SL_ZIGBEE_ZCL_MANUFACTURER_CODE

#define

EM_AF_MIRROR_ENDPOINT_END undefined

API Documentation#

sl_zigbee_af_meter_mirror_get_eui64_by_endpoint#

bool sl_zigbee_af_meter_mirror_get_eui64_by_endpoint (uint8_t endpoint, sl_802154_long_addr_t returnEui64)

Get EUI64 by endpoint.

Parameters

N/A	endpoint	Ver.: always
N/A	returnEui64	Ver.: always

Returns

bool true is success

Definition at line 62 of file app/framework/plugin/meter-mirror/meter-mirror.h

sl_zigbee_af_meter_mirror_is_mirror_used#

bool sl_zigbee_af_meter_mirror_is_mirror_used (uint8_t endpoint)

Mirror used status.

Parameters

N/A

endpoint

Ver.: always

Returns

bool Mirror used state

Definition at line 72 of file app/framework/plugin/meter-mirror/meter-mirror.h

sl_zigbee_af_meter_mirror_get_endpoint_by_eui64#

bool sl_zigbee_af_meter_mirror_get_endpoint_by_eui64 (sl_802154_long_addr_t eui64, uint8_t * returnEndpoint)

Get endpoint by EUI64.

Parameters

N/A	eui64	Ver.: always
N/A	returnEndpoint	Ver.: always

Returns

bool true is success

Definition at line 82 of file app/framework/plugin/meter-mirror/meter-mirror.h

sl_zigbee_af_meter_mirror_request_mirror#

uint16_t sl_zigbee_af_meter_mirror_request_mirror (sl_802154_long_addr_t requestingDeviceIeeeAddress)

Request mirror.

Parameters

N/A

requestingDeviceIeeeAddress

Ver.: always

Returns

uint16_t Endpoint if valid

Definition at line 92 of file app/framework/plugin/meter-mirror/meter-mirror.h

sl_zigbee_af_meter_mirror_remove_mirror#

uint16_t sl_zigbee_af_meter_mirror_remove_mirror (sl_802154_long_addr_t requestingDeviceIeeeAddress)

Remove mirror.

Parameters

N/A requestingDeviceIeeeAddress

Returns

uint16_t endpoint if success

Definition at line 101 of file app/framework/plugin/meter-mirror/meter-mirror.h

Variable Documentation#

nullEui64#

sl_802154_long_addr_t nullEui64

Definition at line 43 of file app/framework/plugin/meter-mirror/meter-mirror.h

Macro Definition Documentation#

EM_AF_APPLICATION_MANUFACTURER_CODE#

#define EM_AF_APPLICATION_MANUFACTURER_CODE

Value:

SL_ZIGBEE_ZCL_MANUFACTURER_CODE

Definition at line 41 of file app/framework/plugin/meter-mirror/meter-mirror.h

EM_AF_MIRROR_ENDPOINT_END#

#define EM_AF_MIRROR_ENDPOINT_END

Value:

(SL_ZIGBEE_AF_PLUGIN_METER_MIRROR_ENDPOINT_START \

+ SL_ZIGBEE_AF_PLUGIN_METER_MIRROR_MAX_MIRRORS)

Definition at line 45 of file app/framework/plugin/meter-mirror/meter-mirror.h