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#
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.
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
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
| sl_802154_long_addr_t | N/A | returnEui64 | Ver.: always |
Returns
bool true is success
sl_zigbee_af_meter_mirror_is_mirror_used#
bool sl_zigbee_af_meter_mirror_is_mirror_used (uint8_t endpoint)
Mirror used status.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
Returns
bool Mirror used state
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
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_long_addr_t | N/A | eui64 | Ver.: always |
| uint8_t * | N/A | returnEndpoint | Ver.: always |
Returns
bool true is success
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
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_long_addr_t | N/A | requestingDeviceIeeeAddress | Ver.: always |
Returns
uint16_t Endpoint if valid
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
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_long_addr_t | N/A | requestingDeviceIeeeAddress |
Returns
uint16_t endpoint if success