Green Power Server#

Callbacks for Green Power Server Component.

Callbacks#

void
emberAfGreenPowerServerCommissioningTimeoutCallback(uint8_t commissioningTimeoutType, uint8_t numberOfEndpoints, uint8_t *endpoint)

Green power server commissioning timeout callback.

void
emberAfGreenPowerServerPairingCompleteCallback(uint8_t numberOfEndpoints, uint8_t *endpoint)

Green power server pairing complete callback.

bool
emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback(void *data, EmberAfGpServerSinkTableAccessType accessType)

Sink table access notification callback.

bool
emberAfPluginGreenPowerServerGpdCommissioningCallback(EmberGpApplicationInfo *appInfo, bool *matchFound)

Green power server commissioning callback.

void

Green power server security failure callback.

bool

Green power server update involved TC callback.

bool
emberAfGreenPowerClusterGpNotificationForwardCallback(uint16_t options, EmberGpAddress *addr, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t *gpdCommandPayload, uint16_t gppShortAddress, uint8_t gppDistance)

Green power server notification forward callback.

bool
emberAfPluginGreenPowerServerGpdCommissioningNotificationCallback(uint8_t commandId, uint16_t commNotificationOptions, EmberGpAddress *gpdAddr, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t *gpdCommandPayload, uint16_t gppShortAddress, int8_t rssi, uint8_t linkQuality, uint8_t gppDistance, uint32_t commissioningNotificationMic)

Green power commissioning notification callback.

void
emberAfGreenPowerClusterCommissioningMessageStatusNotificationCallback(EmberAfGreenPowerServerCommissioningState *commissioningState, EmberApsFrame *apsFrame, EmberOutgoingMessageType messageType, uint16_t destination, EmberStatus status)

Sink commissioning enter call status notification callback.

bool
emberAfPluginGreenPowerServerUpdateAliasCallback(EmberGpAddress *gpdAddr, uint16_t *alias)

Update alias information callback.

void
emberAfGreenPowerServerPairingStatusCallback(EmberSinkPairingStatus status, EmberCommissioningGpd *commissioningGpd)

Green power server pairing complete callback.

void
emberAfPluginGreenPowerServerPreSinkPairingCallback(EmberCommissioningGpd *commissioningGpd)

Green power server update sink list callback.

Callbacks Documentation#

emberAfGreenPowerServerCommissioningTimeoutCallback#

void emberAfGreenPowerServerCommissioningTimeoutCallback (uint8_t commissioningTimeoutType, uint8_t numberOfEndpoints, uint8_t *endpoint)

Green power server commissioning timeout callback.

Parameters
N/AcommissioningTimeoutType

one of the types COMMISSIONING_TIMEOUT_TYPE_COMMISSIONING_WINDOW_TIMEOUT, COMMISSIONING_TIMEOUT_TYPE_GENERIC_SWITCH or COMMISSIONING_TIMEOUT_TYPE_MULTI_SENSOR Ver.: always

N/AnumberOfEndpoints

Number of sink endpoints participated in the commissioning Ver.: always

N/Aendpoint

list of sink endpoints Ver.: always

This function is called by the Green Power Server upon expiration of any of the commissioning timers, which can be server commissioning window, generic switch commissioning, or multi-sensor commissioning timer expiration.


Definition at line 332 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfGreenPowerServerPairingCompleteCallback#

void emberAfGreenPowerServerPairingCompleteCallback (uint8_t numberOfEndpoints, uint8_t *endpoint)

Green power server pairing complete callback.

Parameters
N/AnumberOfEndpoints

number of sink endpoints participated in the pairing Ver.: always

N/Aendpoint

list of sink endpoints Ver.: always

This function is called by the Green Power Server upon the completion of the pairing to indicate the closure of the pairing session.


Definition at line 344 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback#

bool emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback (void *data, EmberAfGpServerSinkTableAccessType accessType)

Sink table access notification callback.

Parameters
N/Adata

void pointer to the data Ver.: always

N/AaccessType

accessType Ver.: always

This function is called by the green power server plugin to notify the application about Green Power Device addition or removal by the green power server to the Sink Table. If returned false, the sink table remains un-accessed.

Returns

  • true if the access is granted.


Definition at line 358 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfPluginGreenPowerServerGpdCommissioningCallback#

bool emberAfPluginGreenPowerServerGpdCommissioningCallback (EmberGpApplicationInfo *appInfo, bool *matchFound)

Green power server commissioning callback.

Parameters
N/AappInfo

Application information of the commissioning GPD. Ver.: always

N/AmatchFound

Output flag to notify matching functionality. Ver.: always

This function is called by the green power server plugin to notify the application of a Green Power Device that has requested commissioning with this sink. Returns false if callback is not handled, true if callback is handled. When the callback is handled, it must set the matchFound argument appropriately to indicate if the matching functionality is found on the sink or not.

Returns

  • true if application handled it Ver.: always


Definition at line 373 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfPluginGreenPowerServerGpdSecurityFailureCallback#

void emberAfPluginGreenPowerServerGpdSecurityFailureCallback (EmberGpAddress *gpdAddr)

Green power server security failure callback.

Parameters
N/AgpdAddr

Ver.: always

This function is called by the green power server plugin to notify the application of a Green Power Security Processing failed for an incoming notification.


Definition at line 383 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfGreenPowerServerUpdateInvolveTCCallback#

bool emberAfGreenPowerServerUpdateInvolveTCCallback (EmberStatus status)

Green power server update involved TC callback.

Parameters
N/Astatus

Ver.: always

This function is called by the Green Power Server to proceed with updating the InvolveTC bit of the security level attribute.

Returns

  • true if application handled it and plugin will not process it Ver.: always


Definition at line 394 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfGreenPowerClusterGpNotificationForwardCallback#

bool emberAfGreenPowerClusterGpNotificationForwardCallback (uint16_t options, EmberGpAddress *addr, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t *gpdCommandPayload, uint16_t gppShortAddress, uint8_t gppDistance)

Green power server notification forward callback.

Parameters
N/Aoptions

from the incoming Gp Notification Command Ver.: always

N/Aaddr

GPD address Ver.: always

N/AgpdSecurityFrameCounter

Ver.: always

N/AgpdCommandId

Ver.: always

N/AgpdCommandPayload

first byte is length of the payload Ver.: always

N/AgppShortAddress

Ver.: always

N/AgppDistance

Ver.: always

This function is called by the green power server plugin to notify the application of a Green Power Gp Notification of an incoming gpd command. Return true to handle in application.

Returns

  • true if application handled it and plugin will not process it anymore. else return false to process the notification by the plugin Ver.: always


Definition at line 413 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfPluginGreenPowerServerGpdCommissioningNotificationCallback#

bool emberAfPluginGreenPowerServerGpdCommissioningNotificationCallback (uint8_t commandId, uint16_t commNotificationOptions, EmberGpAddress *gpdAddr, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t *gpdCommandPayload, uint16_t gppShortAddress, int8_t rssi, uint8_t linkQuality, uint8_t gppDistance, uint32_t commissioningNotificationMic)

Green power commissioning notification callback.

Parameters
N/AcommandId

Ver.: always

N/AcommNotificationOptions

Ver.: always

N/AgpdAddr

Ver.: always

N/AgpdSecurityFrameCounter

Ver.: always

N/AgpdCommandId

Ver.: always

N/AgpdCommandPayload

Ver.: always

N/AgppShortAddress

Ver.: always

N/Arssi

Ver.: always

N/AlinkQuality

Ver.: always

N/AgppDistance

Ver.: always

N/AcommissioningNotificationMic

Ver.: always

This function is called by the green power server plugin to notify the application about gp commissioning notification received by the sink. If the this function returns false indicating application does not handle the notification, the plugin will handle. If this returns true, the plugin will skip processing of the commissioning notification.

Returns

  • true if application handles it and plugin will not process it anymore. else return false to process the notification by the plugin Ver.: always


Definition at line 444 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfGreenPowerClusterCommissioningMessageStatusNotificationCallback#

void emberAfGreenPowerClusterCommissioningMessageStatusNotificationCallback (EmberAfGreenPowerServerCommissioningState *commissioningState, EmberApsFrame *apsFrame, EmberOutgoingMessageType messageType, uint16_t destination, EmberStatus status)

Sink commissioning enter call status notification callback.

Parameters
N/AcommissioningState

Sink commissioning state Ver.: always

N/AapsFrame

aps frame header Ver.: always

N/AmessageType

unicast or broadcast Ver.: always

N/Adestination

destination node Ver.: always

N/Astatus

status of the network submission Ver.: always

This function is called by the green power server plugin from the sink commissioning enter command to notify the application of the status of the proxy commissioning enter message submission to network layer.


Definition at line 469 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfPluginGreenPowerServerUpdateAliasCallback#

bool emberAfPluginGreenPowerServerUpdateAliasCallback (EmberGpAddress *gpdAddr, uint16_t *alias)

Update alias information callback.

Parameters
N/AgpdAddr

GPD address Ver.: always

N/Aalias

Ver.: always

This function is called by the green power server plugin during commissioning to update alias information from user.

Returns

  • true if the alias is updated by the caller.


Definition at line 485 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfGreenPowerServerPairingStatusCallback#

void emberAfGreenPowerServerPairingStatusCallback (EmberSinkPairingStatus status, EmberCommissioningGpd *commissioningGpd)

Green power server pairing complete callback.

Parameters
N/Astatus

status of the pairing Ver.: always

N/AcommissioningGpd

context of the GPD that is currently commissioning Ver.: always

This function is called by the Green Power Server plugin during the pairing process to indicate the status. This may be called multiple times for a single pairing session. This provides the status as well as the current GPD context. This callback can be monitored to get information in case a GPD commissioning that has started ended up in success or failure. This callback does not give any information about a commissioning GPDF that gets filtered out ealier in the commissioning processing.


Definition at line 500 of file app/framework/plugin/green-power-server/green-power-server.h

emberAfPluginGreenPowerServerPreSinkPairingCallback#

void emberAfPluginGreenPowerServerPreSinkPairingCallback (EmberCommissioningGpd *commissioningGpd)

Green power server update sink list callback.

Parameters
N/AcommissioningGpd

context of the GPD that is currently commissioning Ver.: always

This callback is called by the green power server at a final stagee during pairing process. At this point the commissioning sink is ready to be saved or updated into the sink table and GpPairing announcement. This callback is helpful to supply or update the associated parameters to the sink entry. For example, a sink application can update a group list groupcast comminication.


Definition at line 514 of file app/framework/plugin/green-power-server/green-power-server.h