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.

Variables#

EmberEUI64

nullEui64

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

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

Returns

bool true is success

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

emberAfPluginMeterMirrorIsMirrorUsed#

bool emberAfPluginMeterMirrorIsMirrorUsed (uint8_t endpoint)

Mirror used status.

Parameters

N/A

endpoint

Ver.: always

Returns

bool Mirror used state

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

emberAfPluginMeterMirrorGetEndpointByEui64#

bool emberAfPluginMeterMirrorGetEndpointByEui64 (EmberEUI64 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 84 of file app/framework/plugin/meter-mirror/meter-mirror.h

emberAfPluginMeterMirrorRequestMirror#

uint16_t emberAfPluginMeterMirrorRequestMirror (EmberEUI64 requestingDeviceIeeeAddress)

Request mirror.

Parameters

N/A

requestingDeviceIeeeAddress

Ver.: always

Returns

uint16_t Endpoint if valid

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

emberAfPluginMeterMirrorRemoveMirror#

uint16_t emberAfPluginMeterMirrorRemoveMirror (EmberEUI64 requestingDeviceIeeeAddress)

Remove mirror.

Parameters

N/A requestingDeviceIeeeAddress

Returns

uint16_t endpoint if success

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

Variable Documentation#

nullEui64#

EmberEUI64 nullEui64

Definition at line 45 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:

EMBER_AF_MANUFACTURER_CODE

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

EM_AF_MIRROR_ENDPOINT_END#

#define EM_AF_MIRROR_ENDPOINT_END

Value:

(EMBER_AF_PLUGIN_METER_MIRROR_ENDPOINT_START \

+ EMBER_AF_PLUGIN_METER_MIRROR_MAX_MIRRORS)

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