Plugin Callbacks#

emberAfPluginBasicResetToFactoryDefaultsCallback#

void emberAfPluginBasicResetToFactoryDefaultsCallback (uint8_t endpoint)

Reset To Factory Defaults.

This function is called by the Basic server plugin when a request to reset to factory defaults is received. The plugin will reset attributes managed by the framework to their default values. The application should perform any other necessary reset-related operations in this callback, including resetting any externally-stored attributes.

emberAfPluginBatteryMonitorDataReadyCallback#

void emberAfPluginBatteryMonitorDataReadyCallback (uint16_t batteryVoltageMilliV)

Data Ready.

This function is called whenever the battery monitor has generated a new valid battery level.

emberAfPluginBleGetConfigCallback#

void emberAfPluginBleGetConfigCallback (sl_bt_configuration_t * config)

This function is called at init time. The following fields will be overwritten by the framework:

• max_connections

• heap

• heap_size

emberAfPluginBleEventCallback#

void emberAfPluginBleEventCallback (sl_bt_msg_t * evt)

This function is called from the BLE stack to notify the application of a stack event.

halBulbPwmDriverFrequencyCallback#

uint16_t halBulbPwmDriverFrequencyCallback (void )

Configures the frequency of the PWM driver. Called by the bulb-pwm driver upon initialization to determine the frequency at which the PWM driver should be driven. It should return either the frequency, in Hz, or USE_DEFAULT_FREQUENCY to indicate that the plugin should use the default value. The default value is 1000 Hz, but can be overridden by a macro in the board header.

@appusage Should be implemented by an application layer configuration plugin.

halBulbPwmDriverInitCompleteCallback#

void halBulbPwmDriverInitCompleteCallback (void )

Indicates that the PWM driver has been initialized and the bulb should drive the initial LED PWM values at this time.

@appusage Should be implemented by an application layer configuration plugin.

halBulbPwmDriverBlinkOnCallback#

void halBulbPwmDriverBlinkOnCallback (void )

Generated during blinking behavior when it is time to turn the bulb on. While the plugin will determine when to blink the bulb on or off, it is up to this callback to determine how to turn the bulb on.

@appusage Should be implemented by an application layer configuration plugin.

halBulbPwmDriverBlinkOffCallback#

void halBulbPwmDriverBlinkOffCallback (void )

Generated during blinking behavior when it is time to turn the bulb off. While the plugin will determine when to blink the bulb on or off, it is up to this callback to determine how to turn the bulb off.

@appusage Should be implemented by an application layer configuration plugin.

halBulbPwmDriverBlinkStartCallback#

void halBulbPwmDriverBlinkStartCallback (void )

Generated when the application layer makes a call to initiate blinking behavior. It warns the application layer PWM code not to attempt to drive the LEDs directly and interfere with the blinking behavior.

@appusage Should be implemented by an application layer configuration plugin.

halBulbPwmDriverBlinkStopCallback#

void halBulbPwmDriverBlinkStopCallback (void )

Generated when the current blinking command finishes. The application layer PWM code must then determine what the bulb drive should be, based on the current application layer attributes (i.e., level, on/off, color XY, and so on.)

@appusage Should be implemented by an application layer configuration plugin.

emberAfPluginBulbUiFinishedCallback#

void emberAfPluginBulbUiFinishedCallback (EmberStatus status)

Finished.

This callback is fired when the bulb-ui plugin is finished with the forming or joining process. The result of the operation will be returned in the status parameter.

emberAfPluginButtonInterfaceButton0PressedShortCallback#

void emberAfPluginButtonInterfaceButton0PressedShortCallback (uint16_t timePressedMs)

Called when Button 0 is pressed short.

emberAfPluginButtonInterfaceButton1PressedShortCallback#

void emberAfPluginButtonInterfaceButton1PressedShortCallback (uint16_t timePressedMs)

Called when Button 1 is pressed short.

emberAfPluginButtonInterfaceButton0PressedLongCallback#

void emberAfPluginButtonInterfaceButton0PressedLongCallback (uint16_t timePressedMs, bool pressedAtReset)

Called when Button 0 is pressed long.

emberAfPluginButtonInterfaceButton1PressedLongCallback#

void emberAfPluginButtonInterfaceButton1PressedLongCallback (uint16_t timePressedMs, bool pressedAtReset)

Called when Button 1 is pressed long.

emberAfPluginButtonInterfaceButton0PressingCallback#

void emberAfPluginButtonInterfaceButton0PressingCallback (void )

Called while Button 0 is pressed.

This function is periodically called when button 0 is being pressed.

emberAfPluginButtonInterfaceButton1PressingCallback#

void emberAfPluginButtonInterfaceButton1PressingCallback (void )

Called while Button 1 is pressed.

This function is periodically called when button 1 is being pressed.

emberAfPluginButtonInterfaceButton0LowCallback#

void emberAfPluginButtonInterfaceButton0LowCallback (void )

Called when Button 0 goes low.

This function is called when the GPIO tied to button zero goes low

emberAfPluginButtonInterfaceButton0HighCallback#

void emberAfPluginButtonInterfaceButton0HighCallback (void )

Called when Button 0 goes high.

This function is called when the GPIO tied to button zero goes high

emberAfPluginButtonInterfaceButton1LowCallback#

void emberAfPluginButtonInterfaceButton1LowCallback (void )

Called when Button 1 goes low.

This function is called when the GPIO tied to button one goes low

emberAfPluginButtonInterfaceButton1HighCallback#

void emberAfPluginButtonInterfaceButton1HighCallback (void )

Called when Button 1 goes high.

This function is called when the GPIO tied to button one goes high

emberAfPluginButtonJoiningButtonEventCallback#

void emberAfPluginButtonJoiningButtonEventCallback (uint8_t buttonNumber, uint32_t buttonPressDurationMs)

Button Event.

This allows another module to get notification when a button is pressed and released but the button joining plugin did not handle it. This callback is NOT called in ISR context so there are no restrictions on what code can execute.

emberAfPluginCalendarServerPublishInfoCallback#

void emberAfPluginCalendarServerPublishInfoCallback (uint8_t publishCommandId, EmberNodeId clientNodeId, uint8_t clientEndpoint, uint8_t totalCommands)

Publish Info.

This function is called by the calendar-server plugin after receiving any of the following commands and just before it starts publishing the response: GetCalendar, GetDayProfiles, GetSeasons, GetSpecialDays, and GetWeekProfiles.

coexCoulombCounterEventCallback#

void coexCoulombCounterEventCallback (uint16_t ccState)

Reports a change in radio state.

This function is called by the RAIL library to report changes in the radio states (Idle/Rx/Tx) according to PTA events.

emberAfPluginCoulombCounterEventCallback#

void emberAfPluginCoulombCounterEventCallback (uint32_t mask, uint32_t options)

Set the Radio states and energy modes.

This function is called by the RAIL library to set the radio states for the purpose of coulomb counter, to indicate Idle/Rx/Tx. Also the Zigbee stack will call into this function to set the various energy modes.

emberAfPluginColorControlIsColorSupportedCallback#

bool emberAfPluginColorControlIsColorSupportedCallback (uint8_t hue, uint8_t saturation)

Is Color Supported.

This function will be called to determine whether a color is supported by a device. The color will be specified by hue and saturation.

emberAfPluginColorControlServerComputePwmFromHsvCallback#

void emberAfPluginColorControlServerComputePwmFromHsvCallback (uint8_t endpoint)

Compute Pwm from HSV.

This function is called from the color server when it is time for the PWMs to be driven with a new value from the HSV values.

emberAfPluginColorControlServerComputePwmFromXyCallback#

void emberAfPluginColorControlServerComputePwmFromXyCallback (uint8_t endpoint)

Compute Pwm from HSV.

This function is called from the color server when it is time for the PWMs to be driven with a new value from the color X and color Y values.

emberAfPluginColorControlServerComputePwmFromTempCallback#

void emberAfPluginColorControlServerComputePwmFromTempCallback (uint8_t endpoint)

Compute Pwm from HSV.

This function is called from the color server when it is time for the PWMs to be driven with a new value from the color temperature.

emberAfPluginCommandRelayChangedCallback#

void emberAfPluginCommandRelayChangedCallback (void )

Changed.

Called when relays rules are added or removed.

emberAfPluginCommsHubFunctionSendCallback#

void emberAfPluginCommsHubFunctionSendCallback (uint8_t status, EmberEUI64 destinationDeviceId, uint16_t dataLen, uint8_t * data)

Send.

This callback is called by the Comms Hub Function (CHF) plugin to report the status of a message that was previously sent.

emberAfPluginCommsHubFunctionReceivedCallback#

void emberAfPluginCommsHubFunctionReceivedCallback (EmberEUI64 senderDeviceId, uint16_t dataLen, uint8_t * data)

Received.

This callback is called by the Comms Hub Function (CHF) plugin whenever a message is received.

emberAfPluginCommsHubFunctionAlertWANCallback#

void emberAfPluginCommsHubFunctionAlertWANCallback (uint16_t alertCode, uint8_t * gbzAlert, uint16_t gbzAlertLength)

Alert WAN.

Notify the application of an Alert that should be sent to the WAN. The second argument is a pointer to the gbz alert buffer. The application is responsible for freeing this buffer.

emberAfPluginCommsHubFunctionTunnelOpenedCallback#

void emberAfPluginCommsHubFunctionTunnelOpenedCallback (EmberEUI64 remoteDeviceId)

Tunnel Opened.

This function is called by the Comms Hub Function (CHF) plugin when a tunnel is opened.

emberAfPluginCommsHubFunctionSubGhzChannelChangeCallback#

void emberAfPluginCommsHubFunctionSubGhzChannelChangeCallback (EmberAfPluginCommsHubFunctionSubGhzChannelChangeOutcome outcome, EmberAfStatus status)

Sub-GHz channel change request outcome callback.

This callback is called by the Comms Hub Function (Sub-GHz) plugin to report the outcome of the channel change request.

emberAfPluginConcentratorBroadcastSentCallback#

void emberAfPluginConcentratorBroadcastSentCallback (void )

Broadcast Sent.

This function is called when a new MTORR broadcast has been successfully sent by the concentrator plugin.

emberAfPluginConfigurationServerFinishedCallback#

void emberAfPluginConfigurationServerFinishedCallback (EmberStatus status)

Finished.

This callback is fired when the bulb-ui plugin is finished with the forming or joining process. The result of the operation will be returned in the status parameter.

emberAfPluginConnectionManagerFinishedCallback#

void emberAfPluginConnectionManagerFinishedCallback (EmberStatus status)

Network join finished.

This callback is fired when the Connection Manager plugin is finished with the network search process. The result of the operation will be returned as the status parameter.

emberAfPluginConnectionManagerStartNetworkSearchCallback#

void emberAfPluginConnectionManagerStartNetworkSearchCallback (void )

Begin searching for network to join.

This function is called by the Connection Manager Plugin when it starts to search for a new network. It is normally used to trigger a UI event to notify the user that the device is currently searching for a network.

emberAfPluginConnectionManagerLeaveNetworkCallback#

void emberAfPluginConnectionManagerLeaveNetworkCallback (void )

Leave the currently joined network.

This function is called by the Connection Manager Plugin when the device is about to leave the network. It is normally used to trigger a UI event to notify the user of a network leave.

emberAfPluginCountersRolloverCallback#

void emberAfPluginCountersRolloverCallback (EmberCounterType type)

Rollover.

This function is called every time a counter exceeds its threshold.

emberAfPluginDelayedJoinCallback#

void emberAfPluginDelayedJoinCallback (EmberNodeId newNodeId, EmberEUI64 newNodeEui64, EmberNodeId parentOfNewNode, EmberDeviceUpdate status, EmberJoinDecision decision)

Consumer App can implement this callback to be notified when there is a new join attempt that is waiting on the network key.

emberAfPluginDeviceDatabaseDiscoveryCompleteCallback#

void emberAfPluginDeviceDatabaseDiscoveryCompleteCallback (const EmberAfDeviceInfo * device)

Discovery Complete.

This function is called when a device in the database has been set to EMBER_AF_DEVICE_DISCOVERY_STATUS_DONE.

emberAfPluginDeviceManagementClientEnactChangeOfTenancyCallback#

void emberAfPluginDeviceManagementClientEnactChangeOfTenancyCallback (uint8_t endpoint, EmberAfDeviceManagementTenancy * tenancy)

Enact Change Of Tenancy.

This callback will be implemented by a meter to enact a change of tenancy at the requested time of implementation.

emberAfPluginDeviceManagementClientEnactChangeOfSupplierCallback#

void emberAfPluginDeviceManagementClientEnactChangeOfSupplierCallback (uint8_t endpoint, EmberAfDeviceManagementSupplier * supplier)

Enact Change Of Supplier.

This callback will be implemented by a meter to enact a change of supplier at the requested time of implementation.

emberAfPluginDeviceManagementClientEnactChangeSupplyCallback#

EmberStatus emberAfPluginDeviceManagementClientEnactChangeSupplyCallback (uint8_t endpoint, EmberAfDeviceManagementSupply * supply)

Enact Change Supply.

This callback will be implemented by a meter to enact a supply change at the requested time of implementation.

emberAfPluginDeviceManagementClientSetSupplyStatusCallback#

void emberAfPluginDeviceManagementClientSetSupplyStatusCallback (uint8_t endpoint, EmberAfDeviceManagementSupplyStatusFlags * supplyStatus)

Set Supply Status.

This callback will be implemented by a meter to appropriately set the supply status.

emberAfPluginDeviceManagementClientEnactUpdateUncontrolledFlowThresholdCallback#

void emberAfPluginDeviceManagementClientEnactUpdateUncontrolledFlowThresholdCallback (uint8_t endpoint, EmberAfDeviceManagementUncontrolledFlowThreshold * supplier)

Enact Update Uncontrolled Flow Threshold.

This callback will be implemented by a meter to enact an update to the uncontrolled flow threshold as specified.

emberAfPluginDeviceManagementServerGetPasswordCallback#

void emberAfPluginDeviceManagementServerGetPasswordCallback (EmberNodeId senderNodeId, EmberAfDeviceManagementPasswordType passwordType, EmberAfDeviceManagementPassword passwordInfo)

Get Password.

This callback will be implemented by an esi to provide device specific password information.

emberAfPluginDeviceTableStateChangeCallback#

void emberAfPluginDeviceTableStateChangeCallback (EmberNodeId nodeId, uint8_t state)

StateChange.

This callback is called when a device's state changes.

emberAfPluginDeviceTableClearedCallback#

void emberAfPluginDeviceTableClearedCallback (void )

Cleared.

This callback is called when a device table has been cleared.

emberAfPluginDeviceTableNewDeviceCallback#

void emberAfPluginDeviceTableNewDeviceCallback (EmberEUI64 eui64)

NewDevice.

This callback is called when a new device joins the gateway.

emberAfPluginDeviceTableRejoinDeviceCallback#

void emberAfPluginDeviceTableRejoinDeviceCallback (EmberEUI64 newNodeEui64)

Rejoin device.

Called when a device rejoins.

emberAfPluginDeviceTableDeviceLeftCallback#

void emberAfPluginDeviceTableDeviceLeftCallback (EmberEUI64 newNodeEui64, state)

StateChange.

This callback is called when a device's state changes.

emberAfPluginDeviceTableInitialized#

void emberAfPluginDeviceTableInitialized (void , state)

StateChange.

This callback is called when a device's state changes.

emberAfPluginDeviceTableIndexRemovedCallback#

void emberAfPluginDeviceTableIndexRemovedCallback (uint16_t currentIndex, state)

StateChange.

This callback is called when a device's state changes.

emberAfPluginDeviceTableIndexAddedCallback#

void emberAfPluginDeviceTableIndexAddedCallback (uint16_t index, state)

StateChange.

This callback is called when a device's state changes.

emberAfPluginDoorLockServerActivateDoorLockCallback#

bool emberAfPluginDoorLockServerActivateDoorLockCallback (bool activate)

Activate Door Lock.

This function is provided by the door lock server plugin. It is

emberAfPluginDrlcEventActionCallback#

bool emberAfPluginDrlcEventActionCallback (EmberAfLoadControlEvent * loadControlEvent, EmberAfAmiEventStatus eventStatus, uint8_t sequenceNumber)

Event Action.

This function is called by the demand response and load control client plugin whenever an event status changes within the DRLC event table. The list of possible event status values is defined by the ZCL spec and is listed in the Application Framework's generated enums located in enums.h. For example, an event status may be: AMI_EVENT_STATUS_LOAD_CONTROL_EVENT_COMMAND_RX indicating that a properly formatted event was received; AMI_EVENT_STATUS_EVENT_STARTED indicating that an event has started; AMI_EVENT_STATUS_THE_EVENT_HAS_BEEN_CANCELED, indicating that the event was canceled. This callback is intended to give the device an opportunity to take action on the event in question. For instance if an event starts, the device should take the appropriate event action on the hardware. This callback returns a bool, if returned value is true, then a notification will be send over the air automatically to the originator of the event. If it is false, then nothing will be sent back to the originator of the event. Please note that in order for your application to be ZigBee compliant, a notification must be sent over the air to the originator of the event, so a value of false should only be returned if your application code takes care of sending this message or there is some other reason a message does not need to be sent by the framework.

emberAfPluginEepromStateChangeCallback#

void emberAfPluginEepromStateChangeCallback (HalEepromState oldEepromState, HalEepromState newEepromState)

Called whenever the EEPROM changes state.

emberAfPluginEm4EnterCallback#

bool emberAfPluginEm4EnterCallback (uint32_t * durationMs)

EM4 Enter.

This function is called from idle-sleep plugin before going into em4 sleep mode. This should be implemented by app to store restart sensitive app/stack variables in RTCC RAM, check/change the sleep duration.

emberAfPluginEm4ExitCallback#

void emberAfPluginEm4ExitCallback (void )

EM4 Exit.

This function is called from idle-sleep plugin after coming back from em4 sleep mode. This should be implemented by app, if it requires any additional variable restoration and network/app-initialization steps other than what is implemented in emberAfPostEm4ResetCallback()

emberAfPluginEndDeviceSupportPollCompletedCallback#

void emberAfPluginEndDeviceSupportPollCompletedCallback (EmberStatus status)

Poll Completed.

This function is called by the End Device Support plugin after a poll is completed.

emberAfPluginEndDeviceSupportLostParentConnectivityCallback#

bool emberAfPluginEndDeviceSupportLostParentConnectivityCallback (void )

Lost Parent Connectivity.

This function is called by the End Device Support plugin when the end device cannot connect to its parent. This callback is called under the following instances:

• When the network state of the device is EMBER_JOINED_NETWORK_NO_PARENT.

• If there are 3 or more data poll transaction failures for an end device.

If this callback returns false, the End Device Support plugin code will proceed with issuing a Trust Center rejoin. Otherwise, if this function returns true, the End Device Support plugin will not issue a Trust Center rejoin.

emberAfPluginEndDeviceSupportPreNetworkMoveCallback#

bool emberAfPluginEndDeviceSupportPreNetworkMoveCallback (void )

Pre Network Move.

This function is called by the End Device Support plugin just before it issues a Network Move, or a sequence of a secure rejoin followed by several trust center rejoins. Various plugins issue a Network Move when certain conditions are met, such as when the network state is EMBER_JOINED_NO_PARENT.

Users can consume this callback and return true to prevent the End Device Support plugin from issuing rejoin requests. Consuming the callback also gives the application a chance to implement its own rejoin logic. If this callback returns false, the End Device Support plugin will issue network rejoins as usual.

emberAfPluginEventsServerOkToClearLogCallback#

bool emberAfPluginEventsServerOkToClearLogCallback (EmberAfEventLogId logId)

Ok To Clear Log.

This function is called by the Events server plugin whenever a Clear Event Log Request command is received. The application should return true if it is Ok to clear the given log and false otherwise. If the request is to clear all logs (i.e. logId == EMBER_ZCL_EVENT_LOG_ID_ALL_LOGS) and the application allows all logs to be cleared then the application should return true. If the application does not allow all logs to be cleared it should return false in which case the plugin will subsequently call this callback for each event log allowing the application to selectively choose which event logs are Ok to be cleared.

emberAfPluginEventsServerLogDataUpdatedCallback#

void emberAfPluginEventsServerLogDataUpdatedCallback (const EmberAfClusterCommand * cmd)

Log Data Updated.

This function is called by the Events server plugin when any modification to the plugin's event logs has been made. The argument will hint the ZCL command that might be used to triggered the data change. If null, it means the logging data have been updated through other means, e.g. CLI.

emberAfPluginEzmodeCommissioningClientCompleteCallback#

void emberAfPluginEzmodeCommissioningClientCompleteCallback (uint8_t bindingIndex)

Client Complete.

This function is called by the EZ-Mode Commissioning plugin when client commissioning completes.

emberAfPluginFindAndBindInitiatorBindTargetCallback#

bool emberAfPluginFindAndBindInitiatorBindTargetCallback (EmberNodeId nodeId, EmberBindingTableEntry * bindingEntry, uint8_t * groupName)

Bind Target.

This callback with enable the user to programmatically decide if they want to bind with a potential target. The plugin will try to bind with this target if and only if the function returns true. By default, the callback tells the plugin to try to bind with the target. If the binding type is changed to EMBER_MULTICAST_BINDING, a multicast binding will be created.

emberAfPluginFindAndBindInitiatorCompleteCallback#

void emberAfPluginFindAndBindInitiatorCompleteCallback (EmberStatus status)

Complete.

This callback is fired by the initiator when the Find and Bind process is complete.

emberAfPluginFormAndJoinNetworkFoundCallback#

void emberAfPluginFormAndJoinNetworkFoundCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)

Network Found.

This is called by the form-and-join library to notify the application of the network found after a call to ::emberScanForJoinableNetwork() or ::emberScanForNextJoinableNetwork(). See form-and-join documentation for more information.

emberAfPluginFormAndJoinUnusedPanIdFoundCallback#

void emberAfPluginFormAndJoinUnusedPanIdFoundCallback (EmberPanId panId, uint8_t channel)

Unused Pan Id Found.

This function is called when the form-and-join library finds an unused PAN ID that can be used to form a new network on.

emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback#

void emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback (uint8_t * gbzCommandsResponse, uint16_t gbzCommandsResponseLength)

Non Tap Off Message Handler Completed.

Notify the application that the Non Tap Off Message (Non-TOM) have been handled by the mirror endpoint. This callback is invoked when the the Non Tap Off Message have been processed. The first argument is a pointer to the gbz commands response buffer. The application is responsible for freeing this buffer.

emberAfPluginGasProxyFunctionAlertWANCallback#

void emberAfPluginGasProxyFunctionAlertWANCallback (uint16_t alertCode, uint8_t * gbzAlert, uint16_t gbzAlertLength)

Alert WAN.

Notify the application of an Alert that should be sent to the WAN. The second argument is a pointer to the gbz alert buffer. The application is responsible for freeing this buffer.

emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback#

void emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback (const EmberAfGpfMessage * gpfMessage, const EmberAfClusterCommand * zclClusterCommand)

Tap Off Message Future Command Ignored.

Notify the application that an elemental ZCL command, embedded within the Tap Off Message (TOM), has been ignored by the GPF as it is a future dated command. The application can utilize the callback to store the discarded command for later retrieval. When the future dated command becomes active on the GSME, it will inform the CommsHub about the activation via an Alert message. The CommsHub should be able to correlate the matching messages and pass the previously stored ZCL commands to the TOM message handler for processing.

emberAfPluginGasProxyFunctionDataLogAccessRequestCallback#

bool emberAfPluginGasProxyFunctionDataLogAccessRequestCallback (const EmberAfGpfMessage * gpfMessage, const EmberAfClusterCommand * zclClusterCommand)

Data Log Access Request.

Query the application regarding the processing of the current GBCS specific command. Depending on the vendor specific information, such as the Tenancy attribute in the Device Management Cluster, the callback's return value determines whether the current command gets processed or not. With a return value of true, the plugin will process the message. Otherwise, the plugin will reject the message.

emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback#

EmberAfGpfZclCommandPermission emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback (const EmberAfClusterCommand * cmd, uint16_t messageCode)

Validate Incoming Zcl Command.

Query the application to check if a specific ZCL command should be processed given the UseCase # and ZCL command payload information. This function should capture the behavior detailed by the GBCS Use Case documentation. Please refer to EmberAfGpfZclCommandPermission enum for specific return data types.

emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback#

void emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback (uint32_t issuerCalendarId, uint8_t * seasonEntries, uint8_t seasonEntriesLength, uint8_t unknownWeekIdSeasonsMask)

Unknown Season Week Id.

This callback is called when the GPF receives a PublishSeasons command with an unknown week ID in one of the seasons. The callback contains a mask, unknownWeekIdSeasonsMask, with bits set corresponding to season entries that were not published because of an unknown week ID reference.

emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback#

void emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback (uint32_t issuerCalendarId, uint8_t * specialDayEntries, uint8_t specialDayEntriesLength, uint8_t unknownDayIdMask)

Unknown Special Days Day Id.

This callback is called when the GPF receives a PublishSpecialDays command with an unknown day ID for one of the special days. The callback contains a mask, unknownDayIdMask, with bits set corresponding to special day entries that were not published because of an unknown day ID reference.

emberAfPluginGbcsDeviceLogDeviceRemovedCallback#

void emberAfPluginGbcsDeviceLogDeviceRemovedCallback (EmberEUI64 deviceId)

Device Removed.

This callback is called by the plugin when a device is removed from the device log.

emberAfPluginGbzMessageControllerDecryptDataCallback#

void emberAfPluginGbzMessageControllerDecryptDataCallback (EmberAfGbzMessageData * data)

Decrypt Data.

This function is called by the Gbz Message Controller plugin to decrypt a ZCL payload. If the decryption is successful, the application is responsible for allocating the memory for the new decrypted data and passing the pointer via the "plainPayload" field as well as the plainPayloadLength field for the length. The framework will be responsible for free-ing the allocated memory. If the decryption fails, the callback return false and should not modify any data.

emberAfPluginGbzMessageControllerEncryptDataCallback#

void emberAfPluginGbzMessageControllerEncryptDataCallback (EmberAfGbzMessageData * data)

Encrypt Data.

This function is called by the Gbz Message Controller plugin to encrypt a ZCL payload. If the encryption is successful, the application is responsible for allocating the memory for the new encrypted data and passing the pointer via the "encryptedPayload" field as well as the encryptedPayloadLength field for the length. The framework will be responsible for free-ing the allocated memory. If the encryption fails, the callback return false and should not modify any data.

emberAfPluginGpioSensorStateChangedCallback#

void emberAfPluginGpioSensorStateChangedCallback (uint8_t newSensorState)

Called whenever the GPIO sensor detects a change in state.

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, errorReturn)

Gpd Commissioning Notification.

This function is called by the Green Power Sink Plugin to notify the application about Green Power Device commissioning notification received by the sink. Return false if callback not handled, true if callback is handled.

emberAfPluginGreenPowerServerGpdCommissioningCallback#

bool emberAfPluginGreenPowerServerGpdCommissioningCallback (EmberGpApplicationInfo * appInfo, bool * matchFound)

Gpd Commissioning.

This function is called by the Green Power Sink 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 or not.

emberAfPluginGreenPowerServerGpdSecurityFailureCallback#

void emberAfPluginGreenPowerServerGpdSecurityFailureCallback (EmberGpAddress * gpdAddr)

Gpd Commissioning.

This function is called by the Green Power Sink Plugin to notify the application of a Green Power Security Processing failed for an incomming notification.

emberAfGreenPowerClusterGpNotificationForwardCallback#

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

Gp Notification.

This function is called by the Green Power Sink Plugin to notify the application of a Green Power Gp Notification of an incomming gpd command. Return true to handle in application.

emberAfGreenPowerServerPairingCompleteCallback#

void emberAfGreenPowerServerPairingCompleteCallback (uint8_t numberOfEndpoints, uint8_t * endpoints)

Gpd Commissioning.

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

emberAfGreenPowerServerCommissioningTimeoutCallback#

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

Gpd Commissioning.

This function is called by the Green Power Server upon expiry of either the switch commissioning or multisensor commissioning timer.

emberAfGreenPowerServerUpdateInvolveTCCallback#

bool emberAfGreenPowerServerUpdateInvolveTCCallback (EmberStatus status)

Gpd Commissioning.

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

emberAfGreenPowerClusterGpPairingSearchCallback#

bool emberAfGreenPowerClusterGpPairingSearchCallback (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t endpoint)

Green Power Cluster Gp Pairing Search Retruns true if this callback is handled.

emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback#

bool emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback (void * data, EmberAfGpServerSinkTableAccessType accessType)

Sink Table Access Notification.

This function is called by the Green Power Sink 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.

emberAfGreenPowerClusterCommissioningMessageStatusNotificationCallback#

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

Sink Commissioning Enter Call Status notification.

This function is called by the Green Power Sink Plugin from the sink commissioning enter command to notify the application of the status of the proxy commissioning enter message submission to network layer.

emberAfGreenPowerClusterPassFrameWithoutTranslationCallback#

void emberAfGreenPowerClusterPassFrameWithoutTranslationCallback (EmberGpAddress * addr, uint8_t gpdCommandId, uint8_t * gpdCommandPayload)

Gpd Commissioning.

This function is called by the Green Power Sink Plugin to notify the application of a Green Power Gp Notification without translation(endpoint is 0xFC).

emberAfGreenPowerClusterGpTransTableDeleteTranslationTableEntryCallback#

bool emberAfGreenPowerClusterGpTransTableDeleteTranslationTableEntryCallback (EmberGpAddress * gpdAddr)

Remove Gpd entries From Translation Table.

This function is called by the Green Power Sink Plugin to notify the application of a Green Power Device to remove translation table entries of this gpd. Return true on suceess, false on failure.

emberAfGreenPowerClusterGpRequestTranslationTableCallback#

bool emberAfGreenPowerClusterGpRequestTranslationTableCallback (uint8_t startIndex)

Request Translation Table.

This function is called by the Green Power Sink Plugin to request the application of a Green Power Device to send response with the GPD Command translation table. Return true on suceess, false on failure.

emberAfGreenPowerClusterGpUpdateTranslationTableCallback#

bool emberAfGreenPowerClusterGpUpdateTranslationTableCallback (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t * translations)

Update Translation Table.

This function is called by the Green Power Sink Plugin to request the application of a Green Power Device to add, remove or replace the requested translation table entries. Return true on suceess, false on failure.

emberAfPluginGroupsServerGetGroupNameCallback#

void emberAfPluginGroupsServerGetGroupNameCallback (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)

Get Group Name.

This function returns the name of a group with the provided group ID, should it exist.

emberAfPluginGroupsServerSetGroupNameCallback#

void emberAfPluginGroupsServerSetGroupNameCallback (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)

Set Group Name.

This function sets the name of a group with the provided group ID.

emberAfPluginGroupsServerGroupNamesSupportedCallback#

bool emberAfPluginGroupsServerGroupNamesSupportedCallback (uint8_t endpoint)

Group Names Supported.

This function returns whether or not group names are supported.

halRadioPowerUpHandler#

void halRadioPowerUpHandler (void )

Called whenever the radio is powered on.

halRadioPowerDownHandler#

void halRadioPowerDownHandler (void )

Called whenever the radio is powered off.

halSleepCallback#

void halSleepCallback (boolean enter, SleepModes sleepMode)

Called whenever the microcontroller enters/exits a idle/sleep mode.

emberAfPluginIdentifyStartFeedbackCallback#

void emberAfPluginIdentifyStartFeedbackCallback (uint8_t endpoint, uint16_t identifyTime)

Start Feedback.

This function is called by the Identify plugin when identification begins. It informs the Identify Feedback plugin that it should begin providing its implemented feedback functionality (e.g. LED blinking, buzzer sounding, etc.) until the Identify plugin tells it to stop. The identify time is purely a matter of informational convenience; this plugin does not need to know how long it will identify (the Identify plugin will perform the necessary timekeeping.)

emberAfPluginIdentifyStopFeedbackCallback#

void emberAfPluginIdentifyStopFeedbackCallback (uint8_t endpoint)

Stop Feedback.

This function is called by the Identify plugin when identification is finished. It tells the Identify Feedback plugin to stop providing its implemented feedback functionality.

emberAfPluginIdleSleepOkToSleepCallback#

bool emberAfPluginIdleSleepOkToSleepCallback (uint32_t durationMs)

Ok To Sleep.

This function is called by the Idle/Sleep plugin before sleeping. It is called with interrupts disabled. The application should return true if the device may sleep or false otherwise.

emberAfPluginIdleSleepWakeUpCallback#

void emberAfPluginIdleSleepWakeUpCallback (uint32_t durationMs)

Wake Up.

This function is called by the Idle/Sleep plugin after sleeping.

emberAfPluginIdleSleepOkToIdleCallback#

bool emberAfPluginIdleSleepOkToIdleCallback (void )

Ok To Idle.

This function is called by the Idle/Sleep plugin before idling. It is called with interrupts disabled. The application should return true if the device may idle or false otherwise.

emberAfPluginIdleSleepActiveCallback#

void emberAfPluginIdleSleepActiveCallback (void )

Active.

This function is called by the Idle/Sleep plugin after idling.

emberAfPluginIdleSleepRtosCallback#

bool emberAfPluginIdleSleepRtosCallback (uint32_t * durationMs, bool sleepOk)

RTOS idle/sleep.

This function is called by the Idle/Sleep plugin before idling or sleeping. If it returns true, the RTOS is handling the MCU idling/sleeping, if it returns false the idle/sleep shall manage the actual MCU idling/sleeping.

emberAfPluginIdleSleepPreEm4ResetCallback#

bool emberAfPluginIdleSleepPreEm4ResetCallback (uint32_t * sleepDurationMs)

Active.

This function is called by the Idle/Sleep plugin before em4 reset, and it is implemented by EM4 plugin.

emberAfPluginInterpanPreMessageReceivedCallback#

bool emberAfPluginInterpanPreMessageReceivedCallback (const EmberAfInterpanHeader * header, uint8_t msgLen, uint8_t * message)

Pre Message Received.

This function is called by the Interpan plugin when an interpan message is received but has not yet been handled by the plugin or the framework. The application should return true if the message was handled.

emberAfPluginInterpanMessageReceivedOverFragmentsCallback#

void emberAfPluginInterpanMessageReceivedOverFragmentsCallback (const EmberAfInterpanHeader * header, uint8_t msgLen, uint8_t * message)

Message Received Over Fragments.

This function is called by the Interpan plugin when a fully reconstructed message has been received over inter-PAN fragments, or IPMFs.

emberAfPluginInterpanFragmentTransmissionFailedCallback#

void emberAfPluginInterpanFragmentTransmissionFailedCallback (uint8_t interpanFragmentationStatus, uint8_t fragmentNum)

Fragment Transmission Failed.

This function is called by the Interpan plugin when a fragmented transmission has failed.

emberAfPluginLevelControlClusterServerPostInitCallback#

void emberAfPluginLevelControlClusterServerPostInitCallback (uint8_t endpoint)

Level Control Cluster Server Post Init.

Following resolution of the Current Level at startup for this endpoint, perform any additional initialization needed; e.g., synchronize hardware state.

emberAfPluginLevelControlCoupledColorTempChangeCallback#

void emberAfPluginLevelControlCoupledColorTempChangeCallback (uint8_t endpoint)

Level Control Coupled Color Temp Change.

Adjust Color Control cluster Color Temperature in response to a change in Level Control cluster CurrentLevel.

emberAfPluginMessagingClientPreDisplayMessageCallback#

bool emberAfPluginMessagingClientPreDisplayMessageCallback (uint32_t messageId, uint8_t messageControl, uint32_t startTime, uint16_t durationInMinutes, uint8_t * message, uint8_t optionalExtendedMessageControl)

Pre Display Message.

This function is called by the Messaging client plugin when a DisplayMessage command is received. If callback returns true, the plugin assumes the message have been handled and will not do anything with the message. Otherwise, the plugin will go through with its own implementation.

emberAfPluginMessagingClientDisplayMessageCallback#

void emberAfPluginMessagingClientDisplayMessageCallback (EmberAfPluginMessagingClientMessage * message)

Display Message.

This function is called by the Messaging client plugin whenever the application should display a message.

emberAfPluginMessagingClientCancelMessageCallback#

void emberAfPluginMessagingClientCancelMessageCallback (EmberAfPluginMessagingClientMessage * message)

Cancel Message.

This function is called by the Messaging client plugin whenever the application should stop displaying a message.

emberAfPluginMeterMirrorMirrorAddedCallback#

void emberAfPluginMeterMirrorMirrorAddedCallback (const EmberEUI64 requestingDeviceIeeeAddress, uint8_t endpoint)

Mirror Added.

This function is called by the Meter Mirror plugin whenever a RequestMirror command is successfully processed.

emberAfPluginMeterMirrorMirrorRemovedCallback#

void emberAfPluginMeterMirrorMirrorRemovedCallback (const EmberEUI64 requestingDeviceIeeeAddress, uint8_t endpoint)

Mirror Removed.

This function is called by the Meter Mirror plugin whenever a RemoveMirror command is successfully processed.

emberAfPluginMeterMirrorReportingCompleteCallback#

void emberAfPluginMeterMirrorReportingCompleteCallback (uint8_t endpoint)

Reporting Complete.

This function is called by the Meter Mirror plugin after processing an AttributeReportingStatus attribute set to ReportingComplete. If the application needs to do any post attribute reporting processing it can do it from within this callback.

emberAfPluginMeterSnapshotServerScheduleSnapshotCallback#

void emberAfPluginMeterSnapshotServerScheduleSnapshotCallback (uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t * snapshotPayload, uint8_t * responsePayload)

Schedule Snapshot.

This function is called by the Meter Snapshot server plugin whenever a ScheduleSnapshot command is received. A plugin implementing backhaul functionality for the snapshot mechanism should proceed to schedule the snapshot as required.

emberAfPluginMeterSnapshotServerTakeSnapshotCallback#

uint32_t emberAfPluginMeterSnapshotServerTakeSnapshotCallback (uint8_t endpoint, uint32_t snapshotCause, uint8_t * snapshotConfirmation)

Take Snapshot.

This function is called by the Meter Snapshot server plugin whenever a TakeSnapshot command is received. A plugin implementing backhaul functionality for the snapshot mechanism should proceed to manually take a snapshot as required. If for some reason the snapshot could not be taken, this should be reflected in the snapshotConfirmation argument.

emberAfPluginMeterSnapshotServerGetSnapshotCallback#

void emberAfPluginMeterSnapshotServerGetSnapshotCallback (uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t * snapshotCriteria)

Get Snapshot.

This function is called by the Meter Snapshot server plugin whenever a GetSnapshot command is received. A plugin implementing backhaul functionality for the snapshot mechanism should proceed to retrieve the snapshot and send a PublishSnapshot command to the requesting client.

emberAfPluginMeteringServerProcessNotificationFlagsCallback#

void emberAfPluginMeteringServerProcessNotificationFlagsCallback (uint16_t attributeId, uint32_t attributeValue)

Server Process Notification.

This function is called by the metering server plugin when any of the Notification Attribute Set attributes are read or reported by the metering client.

emberAfPluginMultirailDemoRailEventCallback#

void emberAfPluginMultirailDemoRailEventCallback (RAIL_Handle_t handle, RAIL_Events_t events)

A callback called whenever a secondary instance RAIL event occurs.

emberAfPluginNetworkCreatorCompleteCallback#

void emberAfPluginNetworkCreatorCompleteCallback (const EmberNetworkParameters * network, bool usedSecondaryChannels)

Complete.

This callback notifies the user that the network creation process has completed successfully.

emberAfPluginNetworkCreatorGetPanIdCallback#

EmberPanId emberAfPluginNetworkCreatorGetPanIdCallback (void )

Get Pan Id.

This callback is called when the Network Creator plugin needs the PAN ID for the network it is about to create. By default, the callback will return a random 16-bit value.

emberAfPluginNetworkCreatorGetRadioPowerCallback#

int8_t emberAfPluginNetworkCreatorGetRadioPowerCallback (void )

Get Power For Radio Channel.

This callback is called when the Network Creator plugin needs the radio power for the network it is about to create. By default, the callback will use the radio power specified in the relevant plugin option.

emberAfPluginNetworkFindFinishedCallback#

void emberAfPluginNetworkFindFinishedCallback (EmberStatus status)

Finished.

This callback is fired when the network-find plugin is finished with the forming or joining process. The result of the operation will be returned in the status parameter.

emberAfPluginNetworkFindGetRadioPowerForChannelCallback#

int8_t emberAfPluginNetworkFindGetRadioPowerForChannelCallback (uint8_t pgChan)

Get Radio Power For Channel.

This callback is called by the framework when it is setting the radio power during the discovery process. The framework will set the radio power depending on what is returned by this callback.

emberAfPluginNetworkFindJoinCallback#

bool emberAfPluginNetworkFindJoinCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)

Join.

This callback is called by the plugin when a joinable network has been found. If the application returns true, the plugin will attempt to join the network. Otherwise, the plugin will ignore the network and continue searching. Applications can use this callback to implement a network blacklist.

emberAfPluginNetworkFindGetEnergyThresholdForChannelCallback#

int8_t emberAfPluginNetworkFindGetEnergyThresholdForChannelCallback (uint8_t pgChan)

Get Energy Threshold For Channel.

This callback is called during the energy scan when forming the network. Should the energy level exceed the value returned by this callback, the current channel will not be considered a suitable candidate for forming. Should none of the channels in the channel mask be considered suitable, the scan will fall back on all channels, including those not on the channel mask. The return value is RSSI, in dBm. This callback is called only when the fallback functionality is enabled.

emberAfPluginNetworkFindGetEnableScanningAllChannelsCallback#

bool emberAfPluginNetworkFindGetEnableScanningAllChannelsCallback (void )

Get Enable Scanning All Channels.

Returns true is the fallback on scanning all channels is enabled, false if not.

emberAfPluginNetworkSteeringCompleteCallback#

void emberAfPluginNetworkSteeringCompleteCallback (EmberStatus status, uint8_t totalBeacons, uint8_t joinAttempts, uint8_t finalState)

Complete.

This callback is fired when the Network Steering plugin is complete.

emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback#

int8_t emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback (uint8_t channel)

Get Power For Radio Channel.

This callback is fired when the Network Steering plugin needs to set the power level. The application has the ability to change the max power level used for this particular channel.

emberAfPluginNetworkSteeringGetDistributedKeyCallback#

bool emberAfPluginNetworkSteeringGetDistributedKeyCallback (EmberKeyData * key)

Get Distributed Key.

This callback is fired when the Network Steering plugin needs to set the distributed key. The application set the distributed key from Zigbee Alliance thru this callback or the network steering will use the default test key.

Returns

• true if the key is loaded successfully, otherwise false. level. Ver.: always

emberAfPluginNetworkSteeringGetNodeTypeCallback#

EmberNodeType emberAfPluginNetworkSteeringGetNodeTypeCallback (EmberAfPluginNetworkSteeringJoiningState state)

Get Node Type.

This callback allows the application to set the node type that the network steering process will use in joining a network.

Returns

• An EmberNodeType value that the network steering process will try to join a network as.

halOccupancyStateChangedCallback#

void halOccupancyStateChangedCallback (HalOccupancyState occupancyState)

Occupancy state has changed.

This callback is called when the occupancy sensor state changes.

emberAfPluginOccupancySensorServerOccupancyStateChangedCallback#

void emberAfPluginOccupancySensorServerOccupancyStateChangedCallback (HalOccupancyState occupancyState)

Occupancy state changed.

This callback is generated when the occupancy measurement server receives a new occupancy status.

emberAfPluginOnOffClusterServerPostInitCallback#

void emberAfPluginOnOffClusterServerPostInitCallback (uint8_t endpoint)

On/off Cluster Server Post Init.

Following resolution of the On/Off state at startup for this endpoint, perform any additional initialization needed; e.g., synchronize hardware state.

emberAfPluginOtaClientPreBootloadCallback#

void emberAfPluginOtaClientPreBootloadCallback (uint8_t srcEndpoint, uint8_t serverEndpoint, EmberNodeId serverNodeId)

Pre-Bootload Callback.

Called shortly before installing the downloaded image.

emberAfPluginOtaServerUpdateStartedCallback#

void emberAfPluginOtaServerUpdateStartedCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, uint8_t maxDataSize, uint32_t offset)

UpdateStarted.

Called when an OTA upgrade starts.

emberAfPluginOtaServerBlockSentCallback#

void emberAfPluginOtaServerBlockSentCallback (uint8_t actualLength, uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion)

OTA Server Block Sent Callback.

This function will be called when a block is sent to a device.

emberAfPluginOtaServerUpdateCompleteCallback#

void emberAfPluginOtaServerUpdateCompleteCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, EmberNodeId source, uint8_t status)

OTA Server Update Complete Callback.

This function will be called when an OTA update has finished.

emberAfOtaServerImageBlockRequestCallback#

uint8_t emberAfOtaServerImageBlockRequestCallback (EmberAfImageBlockRequestCallbackStruct * data)

Ota Server Image Block Request.

This function is called when the server application receives an image block request by a client.

emberAfPluginOtaServerPolicyGetClientDelayUnits#

uint8_t emberAfPluginOtaServerPolicyGetClientDelayUnits (EmberNodeId clientNodeId, EmberEUI64 clientEui64)

GetClientDelayUnits.

Called when the server receives an Image Block Request from a client that supports rate limiting using the Minimum Block Period feature. This callback gives the server a chance to decide which units the client uses for the Minimum Block Period, seconds or milliseconds. The server can also return OTA_SERVER_DISCOVER_CLIENT_DELAY_UNITS, which causes the plugin code to test the client by sending it a preset delay value. The length of time the client delays determines which units it uses. For more information on this feature, please read the plugin option descriptions under the OTA Server plugin.

For return values, see ota-server-policy.h. An unknown return value will result in the same behavior as if OTA_SERVER_CLIENT_USES_MILLISECONDS had been returned.

emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback#

void emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback (bool success)

Erase Complete.

This is called when an EEPROM erase operation has completed.

emberAfIncomingPacketFilterCallback#

EmberPacketAction emberAfIncomingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t * packetData, uint8_t * size_p, void * data)

A protocol layer packet has been received by the stack.

This is called when the stack receives a packet that is meant for one of the protocol layers specified in EmberZigbeePacketType.

The packetType argument is one of the values of the EmberZigbeePacketType enum. If the stack receives an 802.15.4 MAC beacon, it will call this function with the packetType argument set to EMBER_ZIGBEE_PACKET_TYPE_BEACON.

The implementation of this callback may alter the data contained in packetData, modify options and flags in the auxillary data, or consume the packet itself, either sending the message, or discarding it as it sees fit.

Returns

• a EmberPacketAction indicating what action should be taken for the packet, EMBER_ACCEPT_PACKET, EMBER_DROP_PACKET, or EMBER_MANGLE_PACKET

emberAfOutgoingPacketFilterCallback#

EmberPacketAction emberAfOutgoingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t * packetData, uint8_t * size_p, void * data)

The stack is preparing to send a protocol layer packet.

This is called when the stack is preparing to send a packet from one of the protocol layers specified in EmberZigbeePacketType.

The packetType argument is one of the values of the EmberZigbeePacketType enum. If the stack is preparing to send an 802.15.4 MAC beacon, it will call this function with the packetType argument set to EMBER_ZIGBEE_PACKET_TYPE_BEACON.

The implementation of this callback may alter the data contained in packetData, modify options and flags in the auxillary data, or consume the packet itself, either sending the message, or discarding it as it sees fit.

Returns

• a EmberPacketAction indicating what action should be taken for the packet, EMBER_ACCEPT_PACKET, EMBER_DROP_PACKET, or EMBER_MANGLE_PACKET

emberAfPluginPollControlServerCheckInTimeoutCallback#

void emberAfPluginPollControlServerCheckInTimeoutCallback (void )

CheckInTimeout.

This function is called by the Poll Control Server plugin after a threshold value of poll control check in messages are sent to a trust center and no responses are received. The existence of this callback provides an opportunity for the application to implement its own rejoin algorithm or logic.

emberAfPluginPrepaymentServerConsumerTopUpCallback#

bool emberAfPluginPrepaymentServerConsumerTopUpCallback (uint8_t originatingDevice, uint8_t * topUpCode)

Consumer Top Up.

This function is called when a Consumer Top Up command is received. This callback must evaluate the command data and determine if it is a valid Top Up command.

emberAfPluginPriceClientPriceStartedCallback#

void emberAfPluginPriceClientPriceStartedCallback (EmberAfPluginPriceClientPrice * price)

Price Started.

This function is called by the Price client plugin whenever a price starts.

emberAfPluginPriceClientPriceExpiredCallback#

void emberAfPluginPriceClientPriceExpiredCallback (EmberAfPluginPriceClientPrice * price)

Price Expired.

This function is called by the Price client plugin whenever a price expires.

emberAfPluginPriceClientPendingCppEventCallback#

uint8_t emberAfPluginPriceClientPendingCppEventCallback (uint8_t cppAuth)

Pending Cpp Event.

This function is called by the Price client plugin when a CPP event is received with pending status.

emberAfPluginPriceServerNewActivePriceMatrixCallback#

void emberAfPluginPriceServerNewActivePriceMatrixCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfScheduledPriceMatrix * priceMatrix)

New Active Price Matrix.

This callback is used to notify the application that a new PriceMatrix has become active. The application is responsible for updating proper ZCL attributes to reflect the necessary vendor specific behaviors. Argument, priceCommonInfo, would contain common informations such as startTime and etc. Argument, priceMatrix, would contain the PriceMatrix information itself.

emberAfPluginPriceServerNewActiveTariffInformationCallback#

void emberAfPluginPriceServerNewActiveTariffInformationCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfScheduledTariff * priceTariffInfo)

New Active Tariff Information.

This callback is used to notify the application that a new Tariff Information has become active. The application is responsible for updating proper ZCL attributes to reflect the necessary vendor specific behaviors. Argument, priceCommonInfo, would contain common informations such as startTime and etc. Argument, priceTariffInfo, would contain the PriceMatrix information itself.

emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback#

void emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfScheduledBlockThresholds * priceBlockThresholds)

New Active Block Thresholds Information.

This callback is used to notify the application that a new Block Thresholds Information has become active. The application is responsible for updating proper ZCL attributes to reflect the necessary vendor specific behaviors. Argument, priceCommonInfo, would contain common informations such as startTime and etc. Argument, priceTariffInfo, would contain the BlockThresholds information itself.

emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback#

void emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfPriceBlockPeriod * priceBlockPeriods)

New Active Block Period Information.

This callback is used to notify the application that a new Block Period Information has become active. The application is responsible for updating proper ZCL attributes to reflect the necessary vendor specific behaviors. Argument, priceCommonInfo, would contain common informations such as startTime and etc. Argument, priceBlockPeriod, would contain the BlockPeriod information itself.

emberAfPluginReportingConfiguredCallback#

EmberAfStatus emberAfPluginReportingConfiguredCallback (const EmberAfPluginReportingEntry * entry)

Configured.

This callback is called by the Reporting plugin whenever a reporting entry is configured, including when entries are deleted or updated. The application can use this callback for scheduling readings or measurements based on the minimum and maximum reporting interval for the entry. The application should return EMBER_ZCL_STATUS_SUCCESS if it can support the configuration or an error status otherwise. Note: attribute reporting is required for many clusters and attributes, so rejecting a reporting configuration may violate ZigBee specifications.

emberAfPluginReportingGetDefaultReportingConfigCallback#

bool emberAfPluginReportingGetDefaultReportingConfigCallback (EmberAfPluginReportingEntry * entry)

Configured.

This callback is called by the Reporting plugin to get the default reporting configuration values from user if there is no default value available within af generated default reporting configuration tabel. The application need to write to the minInterval, maxInterval and reportable change in the passed IO pointer in the arguement while handleing this callback, then application shall return true if it has provided the default values or else false for reporting plugin to further handleing.

emberAfPluginRtosAppTask1InitCallback#

void emberAfPluginRtosAppTask1InitCallback (void )

This function is called from the RTOS Common plugin before the Application (1) task is created.

emberAfPluginRtosAppTask1MainLoopCallback#

void emberAfPluginRtosAppTask1MainLoopCallback (void * p_arg)

This function implements the Application (1) task main loop.

emberAfPluginRtosAppTask2InitCallback#

void emberAfPluginRtosAppTask2InitCallback (void )

This function is called from the RTOS Common plugin before the Application (2) task is created.

emberAfPluginRtosAppTask2MainLoopCallback#

void emberAfPluginRtosAppTask2MainLoopCallback (void * p_arg)

This function implements the Application (2) task main loop.

emberAfPluginRtosAppTask3InitCallback#

void emberAfPluginRtosAppTask3InitCallback (void )

This function is called from the RTOS Common plugin before the Application (3) task is created.

emberAfPluginRtosAppTask3MainLoopCallback#

void emberAfPluginRtosAppTask3MainLoopCallback (void * p_arg)

This function implements the Application (3) task main loop.

emberAfPluginSb1GestureSensorGestureReceivedCallback#

void emberAfPluginSb1GestureSensorGestureReceivedCallback (uint8_t gestureReceived, uint8_t switchNumber)

Called whenever the SB1 receives a gesture.

emberAfPluginScenesServerCustomRecallSceneCallback#

bool emberAfPluginScenesServerCustomRecallSceneCallback (const EmberAfSceneTableEntry *const sceneEntry, uint16_t transitionTimeDs, EmberAfStatus *const status)

Scenes Server Custom Recall Scene.

Customize the implementation of the Scenes cluster RecallScene command for desired behavior when gradually transitioning to the specified scene over the specified transition time interval.

Upon entry to this callback, the presented scene table entry has been verified to be valid for the endpoint, group ID, and scene ID referenced in the received ZCL Scenes cluster RecallScene command.

NOTE: If this callback is implemented, the expectation is that it will INITIATE the scene transition behavior and return promptly with prospective success or failure status, rather than execute through the full duration of the transition time before returning.

NOTE: The scene table entry pointer, and the information in the scene table entry, are available only during the execution of this callback function. The scene table entry information (NOT the pointer) must be copied and saved before returning from this callback function if it will need to be referenced at other times to perform the desired transition behavior (for example, by a timer-based periodic handler launched by this callback).

If the value of transitionTimeDs is 0xFFFF, the transition time information configured in the scene table entry should be used.

Upon arriving at the target scene configuration, the custom implementation should set the Scenes cluster attributes CurrentScene and CurrentGroup to the scene ID and group ID values contained in the sceneEntry, and set the SceneValid attribute to true.

Returns true if a customization of this callback HAS been IMPLEMENTED. This REQUIRES that a valid EmberAfStatus value has been written to the status argument. Status will be EMBER_ZCL_STATUS_SUCCESS if the scene transition has been initiated successfully, even though the transition time has not fully elapsed and the full effect of the scene transition over the transition time has not yet completed. Otherwise, a suitable error status value should be returned in the status argument.

Returns false if a customization of this callback HAS NOT been implemented. In this case, the Scenes plugin will perform default handling (apply target scene settings immediately without regard for the specified transition time).

Returns

• true if custom callback is implemented false if custom callback is not implemented (apply default handling)

emberAfPluginSecuritySensorStatusChangedCallback#

void emberAfPluginSecuritySensorStatusChangedCallback (uint16_t status)

Security sensor state changed.

This callback is generated when the status of security sensor is changed

bit0: 1 - opened or alarmed, 0 - closed or not alarmed bit2: 1 - tampered, 0 - not tampered other bits: reserved.

Ver.: always

emberAfPluginSimpleMeteringClientRequestMirrorCallback#

uint16_t emberAfPluginSimpleMeteringClientRequestMirrorCallback (EmberEUI64 requestingDeviceIeeeAddress)

Request Mirror.

This function is called by the Simple Metering client plugin whenever a Request Mirror command is received. The application should return the endpoint to which the mirror has been assigned. If no mirror could be assigned, the application should return 0xFFFF.

emberAfPluginSimpleMeteringClientRemoveMirrorCallback#

uint16_t emberAfPluginSimpleMeteringClientRemoveMirrorCallback (EmberEUI64 requestingDeviceIeeeAddress)

Remove Mirror.

This function is called by the Simple Metering client plugin whenever a Remove Mirror command is received. The application should return the endpoint on which the mirror has been removed. If the mirror could not be removed, the application should return 0xFFFF.

emberAfPluginSimpleMeteringServerProcessNotificationFlagsCallback#

void emberAfPluginSimpleMeteringServerProcessNotificationFlagsCallback (uint16_t attributeId, uint32_t attributeValue)

Process Notification Flags.

This function is called by the metering server plugin when any of the Notification Attribute Set attributes are read or reported by the metering client.

emberAfPluginSleepyMessageQueueMessageTimedOutCallback#

void emberAfPluginSleepyMessageQueueMessageTimedOutCallback (uint8_t sleepyMsgId)

Message Timed Out.

This function is called by the sleepy message queue when a message times out. The plugin will invalidate the entry in the queue after giving the application a chance to perform any actions on the timed-out message.

emberAfPluginStandaloneBootloaderClientAllowIncomingMessageCallback#

bool emberAfPluginStandaloneBootloaderClientAllowIncomingMessageCallback (EmberEUI64 sourceEui64, uint8_t command)

Allow Incoming Message.

Allows the application to control whether the plugin can respond to incoming bootload messages.

emberAfPluginStandaloneBootloaderClientAllowBootloadLaunchCallback#

bool emberAfPluginStandaloneBootloaderClientAllowBootloadLaunchCallback (EmberEUI64 sourceEui64)

Allow Bootload Launch.

This function is a callback when the client is being told to launch the standalone bootloader. This is done after authentication has completed successfully.

emberAfPluginStandaloneBootloaderCommonIncomingMessageCallback#

bool emberAfPluginStandaloneBootloaderCommonIncomingMessageCallback (EmberEUI64 longId, uint8_t length, uint8_t * message)

Incoming Message.

Indicates an Ember Bootload message has been received by the Standalone Bootloader Common plugin.

emberAfPluginStandaloneBootloaderServerQueryResponseCallback#

void emberAfPluginStandaloneBootloaderServerQueryResponseCallback (bool queryWasBroadcast, const EmberAfStandaloneBootloaderQueryResponseData * queryData)

Query Response.

Allows the application to control whether the plugin can respond to incoming bootload messages.

emberAfPluginStandaloneBootloaderServerFinishedCallback#

void emberAfPluginStandaloneBootloaderServerFinishedCallback (bool success)

Finished.

Notifies the application when the standalone bootload has completed, successfully or otherwise.

emberAfPluginSubGhzSuspendZclMessagesCallback#

bool emberAfPluginSubGhzSuspendZclMessagesCallback (uint8_t period)

Sub-GHz Cluster Suspend ZCL Messages.

'Suspend ZCL Messages' is a server command, sent to request the client to temporarily suspend sending any ZCL messages to reduce the duty cycle.

The clients's default action is to suspend ZCL messages for the requested period.

Returns

• true to indicate the callback has been handled by the application, false to keep the default behaviour

emberAfPluginSubGhzDutyCycleCallback#

boolean emberAfPluginSubGhzDutyCycleCallback (uint8_t channelPage, uint8_t channel, EmberDutyCycleState oldState, EmberDutyCycleState newState)

Duty cycle state change callback for the use with the Sub-GHz plugin.

The Sub-GHz plugin monitors the duty cycle and calls this callback every time the duty cycle state changes.

Returns

• true to handle in the application, false for default behaviour

The default response is sending the 'Suspend ZCL Messages' command, either by unicast to the most offending client of a broadcast to all clients, depending on the old and new duty cycle state.

emberAfPluginSubGhzUnsolicitedEnhancedUpdateNotifyCallback#

void emberAfPluginSubGhzUnsolicitedEnhancedUpdateNotifyCallback (uint8_t channelPage, uint8_t channel, uint16_t macTxUcastTotal, uint16_t macTxUcastFailures, uint16_t macTxUcastRetries, uint8_t period)

Callback to let the application handle the incoming Mgmt_NWK_Unsolicited_Enhanced_Update_notify command.

'Mgmt_NWK_Unsolicited_Enhanced_Update_notify' is a client command. The client sends it to notify the server about the poor link quality. The server should determine whether a channel change is necessary and change the channel if so. There is no default action performed by the application framework. If not handled by the application, no action is taken.

emberAfPluginSubGhzGetSuspendZclMessagesStatusCallback#

bool emberAfPluginSubGhzGetSuspendZclMessagesStatusCallback (void )

Sub-GHz Cluster Get Suspend ZCL Messages Status.

'Get Suspend ZCL Messages Status' is a client command. The client can send it to the server to query the status instead of waiting for the 'Suspend ZCL Messages' command.

The server's default action is sending the 'Suspend ZCL Messages' command with the parameter indicating the remaining suspend time in minutes.

Returns

• true to indicate the callback has been handled by the application, false to keep the default behaviour

emberAfPluginTamperSwitchTamperActiveCallback#

void emberAfPluginTamperSwitchTamperActiveCallback (void )

Tamper is active.

This function is called whenever the tamper switch detects that it has entered the enclosure, thereby activating tamper monitoring.

emberAfPluginTamperSwitchTamperAlarmCallback#

void emberAfPluginTamperSwitchTamperAlarmCallback (void )

Tamper alarm.