Modules#
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.
API#
bool
emberAfPluginMeterMirrorGetEui64ByEndpoint(uint8_t endpoint, EmberEUI64 returnEui64)
Get EUI64 by endpoint.
bool
emberAfPluginMeterMirrorIsMirrorUsed(uint8_t endpoint)
Mirror used status.
bool
emberAfPluginMeterMirrorGetEndpointByEui64(EmberEUI64 eui64, uint8_t *returnEndpoint)
Get endpoint by EUI64.
uint16_t
emberAfPluginMeterMirrorRequestMirror(EmberEUI64 requestingDeviceIeeeAddress)
Request Mirror.
uint16_t
emberAfPluginMeterMirrorRemoveMirror(EmberEUI64 requestingDeviceIeeeAddress)
Remove mirror.
Macros#
#define
EM_AF_APPLICATION_MANUFACTURER_CODE EMBER_AF_MANUFACTURER_CODE
#define
EM_AF_MIRROR_ENDPOINT_END undefined
API Documentation#
emberAfPluginMeterMirrorGetEui64ByEndpoint#
bool emberAfPluginMeterMirrorGetEui64ByEndpoint (uint8_t endpoint, EmberEUI64 returnEui64)
Get EUI64 by endpoint.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
| EmberEUI64 | N/A | returnEui64 | Ver.: always |
Returns
bool true is success
emberAfPluginMeterMirrorIsMirrorUsed#
bool emberAfPluginMeterMirrorIsMirrorUsed (uint8_t endpoint)
Mirror used status.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
Returns
bool Mirror used state
emberAfPluginMeterMirrorGetEndpointByEui64#
bool emberAfPluginMeterMirrorGetEndpointByEui64 (EmberEUI64 eui64, uint8_t * returnEndpoint)
Get endpoint by EUI64.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberEUI64 | N/A | eui64 | Ver.: always |
| uint8_t * | N/A | returnEndpoint | Ver.: always |
Returns
bool true is success
emberAfPluginMeterMirrorRequestMirror#
uint16_t emberAfPluginMeterMirrorRequestMirror (EmberEUI64 requestingDeviceIeeeAddress)
Request Mirror.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberEUI64 | N/A | requestingDeviceIeeeAddress | Ver.: always |
Returns
uint16_t Endpoint if valid
emberAfPluginMeterMirrorRemoveMirror#
uint16_t emberAfPluginMeterMirrorRemoveMirror (EmberEUI64 requestingDeviceIeeeAddress)
Remove mirror.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberEUI64 | N/A | requestingDeviceIeeeAddress |
Returns
uint16_t endpoint if success