Plugin Callbacks#
Basic Server Cluster Plugin Callbacks#
Reset To Factory Defaults.
Battery Monitor Plugin Callbacks#
Data Ready.
BLE Plugin Callbacks#
This function is called at init time. The following fields will be overwritten by the framework:
This function is called from the BLE stack to notify the application of a stack event.
Bulb PWM Driver Plugin Callbacks#
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.
Indicates that the PWM driver has been initialized and the bulb should drive the initial LED PWM values at this time.
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.
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.
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.
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.)
Bulb user interface Plugin Callbacks#
Finished.
Button Interface Plugin Callbacks#
Called when Button 0 is pressed short.
Called when Button 1 is pressed short.
Called when Button 0 is pressed long.
Called when Button 1 is pressed long.
Called while Button 0 is pressed.
Called while Button 1 is pressed.
Called when Button 0 goes low.
Called when Button 0 goes high.
Called when Button 1 goes low.
Called when Button 1 goes high.
Button Form/Join Code Plugin Callbacks#
Button Event.
Calendar Server Plugin Callbacks#
Publish Info.
Radio Coexistence Plugin Callbacks#
Reports a change in radio state.
Radio Coexistence Stub Plugin Callbacks#
Set the Radio states and energy modes.
Color Control Cluster (deprecated) Plugin Callbacks#
Is Color Supported.
Color Control Cluster Server Plugin Callbacks#
Compute Pwm from HSV.
Compute Pwm from HSV.
Compute Pwm from HSV.
Command Relay Plugin Callbacks#
Changed.
Comms Hub Function (CHF) Plugin Callbacks#
Send.
Received.
Alert WAN.
Tunnel Opened.
Comms Hub Function (Sub-GHz) Plugin Callbacks#
Sub-GHz channel change request outcome callback.
Concentrator Support Plugin Callbacks#
Broadcast Sent.
Configuration server Plugin Callbacks#
Finished.
Connection Manager Plugin Callbacks#
Network join finished.
Begin searching for network to join.
Leave the currently joined network.
Counters Plugin Callbacks#
Rollover.
Delayed Join Plugin Callbacks#
Consumer App can implement this callback to be notified when there is a new join attempt that is waiting on the network key.
Device Database Plugin Callbacks#
Discovery Complete.
Device Management Client Plugin Callbacks#
Enact Change Of Tenancy.
Enact Change Of Supplier.
Enact Change Supply.
Set Supply Status.
Enact Update Uncontrolled Flow Threshold.
Device Management Server Plugin Callbacks#
Get Password.
Device Table Plugin Callbacks#
StateChange.
Cleared.
NewDevice.
Rejoin device.
StateChange.
StateChange.
StateChange.
StateChange.
Door Lock Server Cluster Plugin Callbacks#
Activate Door Lock.
Demand Response Load Control Cluster Client Plugin Callbacks#
Event Action.
EEPROM Plugin Callbacks#
Called whenever the EEPROM changes state.
Em4 Plugin Callbacks#
EM4 Enter.
EM4 Exit.
End Device Support Plugin Callbacks#
Poll Completed.
Lost Parent Connectivity.
Pre Network Move.
Events Server Plugin Callbacks#
Ok To Clear Log.
Log Data Updated.
EZ-Mode Commissioning Plugin Callbacks#
Client Complete.
Find and Bind Initiator Plugin Callbacks#
Bind Target.
Complete.
Form and Join Library Plugin Callbacks#
Network Found.
Unused Pan Id Found.
Gas Proxy Function (GPF) Plugin Callbacks#
Non Tap Off Message Handler Completed.
Alert WAN.
Tap Off Message Future Command Ignored.
Data Log Access Request.
Validate Incoming Zcl Command.
Unknown Season Week Id.
Unknown Special Days Day Id.
GBCS Device Log Plugin Callbacks#
Device Removed.
GBZ Message Controller Plugin Callbacks#
Decrypt Data.
Encrypt Data.
GPIO Sensor Interface Plugin Callbacks#
Called whenever the GPIO sensor detects a change in state.
Green Power Server Plugin Callbacks#
Gpd Commissioning Notification.
Gpd Commissioning.
Gpd Commissioning.
Gp Notification.
Gpd Commissioning.
Gpd Commissioning.
Gpd Commissioning.
Green Power Cluster Gp Pairing Search Retruns true if this callback is handled.
Sink Table Access Notification.
Sink Commissioning Enter Call Status notification.
Green Power Translation Table Plugin Callbacks#
Gpd Commissioning.
Remove Gpd entries From Translation Table.
Request Translation Table.
Update Translation Table.
Groups Server Cluster Plugin Callbacks#
Get Group Name.
Set Group Name.
Group Names Supported.
HAL Library Plugin Callbacks#
Called whenever the radio is powered on.
Called whenever the radio is powered off.
Called whenever the microcontroller enters/exits a idle/sleep mode.
Identify Cluster Plugin Callbacks#
Start Feedback.
Stop Feedback.
Idle/Sleep Plugin Callbacks#
Ok To Sleep.
Wake Up.
Ok To Idle.
Active.
RTOS idle/sleep.
Active.
Interpan Plugin Callbacks#
Pre Message Received.
Message Received Over Fragments.
Fragment Transmission Failed.
Level Control Server Cluster Plugin Callbacks#
Level Control Cluster Server Post Init.
Level Control Coupled Color Temp Change.
Messaging Client Cluster Plugin Callbacks#
Pre Display Message.
Display Message.
Cancel Message.
Meter Mirror Plugin Callbacks#
Mirror Added.
Mirror Removed.
Reporting Complete.
Meter Snapshot Server Plugin Callbacks#
Schedule Snapshot.
Take Snapshot.
Get Snapshot.
Metering Server Plugin Callbacks#
Server Process Notification.
Multiple RAIL Demo Code Plugin Callbacks#
A callback called whenever a secondary instance RAIL event occurs.
Network Creator Plugin Callbacks#
Complete.
Get Pan Id.
Get Power For Radio Channel.
Network Find Plugin Callbacks#
Finished.
Get Radio Power For Channel.
Join.
Get Energy Threshold For Channel.
Get Enable Scanning All Channels.
Network Steering Plugin Callbacks#
Complete.
Get Power For Radio Channel.
Get Distributed Key.
Get Node Type.
Occupancy PYD-1698 Plugin Callbacks#
Occupancy state has changed.
Occupancy Sensor Server Cluster Plugin Callbacks#
Occupancy state changed.
On/Off Server Cluster Plugin Callbacks#
On/off Cluster Server Post Init.
OTA Bootload Cluster Client Plugin Callbacks#
Pre-Bootload Callback.
OTA Bootload Cluster Server Plugin Callbacks#
UpdateStarted.
OTA Server Block Sent Callback.
OTA Server Update Complete Callback.
Ota Server Image Block Request.
OTA Bootload Cluster Server Policy Plugin Callbacks#
GetClientDelayUnits.
OTA Simple Storage EEPROM Driver Plugin Callbacks#
Erase Complete.
Packet Handoff Plugin Callbacks#
A protocol layer packet has been received by the stack.
The stack is preparing to send a protocol layer packet.
Poll Control Server Cluster Plugin Callbacks#
CheckInTimeout.
Prepayment Server Plugin Callbacks#
Consumer Top Up.
Price Client Plugin Callbacks#
Price Started.
Price Expired.
Pending Cpp Event.
Price Server Plugin Callbacks#
New Active Price Matrix.
New Active Tariff Information.
New Active Block Thresholds Information.
New Active Block Period Information.
Reporting Plugin Callbacks#
Configured.
Configured.
RTOS Common Plugin Callbacks#
This function is called from the RTOS Common plugin before the Application (1) task is created.
This function implements the Application (1) task main loop.
This function is called from the RTOS Common plugin before the Application (2) task is created.
This function implements the Application (2) task main loop.
This function is called from the RTOS Common plugin before the Application (3) task is created.
This function implements the Application (3) task main loop.
SB1 Gesture Sensor Plugin Callbacks#
Called whenever the SB1 receives a gesture.
Scenes Server Cluster Plugin Callbacks#
Scenes Server Custom Recall Scene.
Security Sensor Interface Plugin Callbacks#
Security sensor state changed.
Simple Metering Client Plugin Callbacks#
Request Mirror.
Remove Mirror.
Simple Metering Server Plugin Callbacks#
Process Notification Flags.
Sleepy Message Queue Plugin Callbacks#
Message Timed Out.
Standalone Bootloader Client Plugin Callbacks#
Allow Incoming Message.
Allow Bootload Launch.
Standalone Bootloader Common Plugin Callbacks#
Incoming Message.
Standalone Bootloader Server Plugin Callbacks#
Query Response.
Finished.
Sub-GHz Client Plugin Callbacks#
Sub-GHz Cluster Suspend ZCL Messages.
Sub-GHz Server Plugin Callbacks#
Duty cycle state change callback for the use with the Sub-GHz plugin.
Callback to let the application handle the incoming Mgmt_NWK_Unsolicited_Enhanced_Update_notify command.
Sub-GHz Cluster Get Suspend ZCL Messages Status.
Temperature Measurement Server Cluster Plugin Callbacks#
Over temperature state changed.
Gateway MQTT Transport Plugin Callbacks#
MQTT client state is changed.
MQTT message arrived.
Trust Center Keepalive Plugin Callbacks#
Timeout.
ConnectivityEstablished This function is called by the Trust Center Keepalive plugin when a read attribute response command from the trust center is received after trust center connectivity had previously been lost. This function is also called after a match descriptor response.
Serverless Keep Alive Supported This function is called by the Trust Center Keep Alive plugin when service discovery receives a response indicating that the server does not support the cluster. Applications may consume this callback and have it return true in order to have the Trust Center Keep Alive plugin code to still start the keep alive process even if the server cluster is not discovered. If this callback returns false, the Trust Center Keep Alive plugin code will only proceed to start the process in case the service discovery was succesful.
Overwrite Default Timing Parameters This function is called by the Trust Center Keep Alive plugin when the Trust Center Keep Alive process is started. Applications may consume this callback and have it return true in order to have the Trust Center Keep Alive plugin code to start the keep alive process with timing parameters other than the default values. If this callback returns false, the Trust Center Keep Alive plugin code will proceed to start with the default timing parameters.
Serverless Keep Alive Enabled This function is called by the Trust Center Keep Alive plugin when a service discovery is done, a response has arrived and emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback() returned true. Applications may consume this callback and have it return true in order to have the Trust Center Keep Alive plugin code to start the keep alive process right away. If this callback returns false, the Trust Center Keep Alive plugin code will return to the disabled state waiting to be enabled.
Tunneling Client Cluster Plugin Callbacks#
Tunnel Opened.
Data Received.
Data Error.
Tunnel Closed.
Transfer Data Failure.
Tunneling Server Cluster Plugin Callbacks#
Is Protocol Supported.
Tunnel Opened.
Data Received.
Data Error.
Tunnel Closed.
Update TC Link Key Plugin Callbacks#
Status.
ZCL Framework Core Plugin Callbacks#
EZSP Error Handler.
ZLL Commissioning Client Plugin Callbacks#
Touch Link Failed.
ZLL Commissioning Common Plugin Callbacks#
Initial Security State.
Touch Link Complete.
Reset To Factory New.
ZLL Commissioning Network Plugin Callbacks#
Join.
ZLL Commissioning Server Plugin Callbacks#
Group Identifier Count.
Group Identifier.
Endpoint Information Count.
Endpoint Information.
Identify.
ZLL On/Off Server Cluster Enhancements Plugin Callbacks#
Off With Effect.
Basic Server Cluster Plugin Callbacks Documentation#
emberAfPluginBasicResetToFactoryDefaultsCallback#
void emberAfPluginBasicResetToFactoryDefaultsCallback (uint8_t endpoint)
Reset To Factory Defaults.
N/A | endpoint | Ver.: always |
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.
32
of file ./app/framework/test/headers/plugin-callback.doc
Battery Monitor Plugin Callbacks Documentation#
emberAfPluginBatteryMonitorDataReadyCallback#
void emberAfPluginBatteryMonitorDataReadyCallback (uint16_t batteryVoltageMilliV)
Data Ready.
N/A | batteryVoltageMilliV | The battery voltage, in milli Volts Ver.: always |
This function is called whenever the battery monitor has generated a new valid battery level.
46
of file ./app/framework/test/headers/plugin-callback.doc
BLE Plugin Callbacks Documentation#
emberAfPluginBleGetConfigCallback#
void emberAfPluginBleGetConfigCallback (sl_bt_configuration_t * config)
This function is called at init time. The following fields will be overwritten by the framework:
N/A | config |
max_connections
heap
heap_size
61
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginBleEventCallback#
void emberAfPluginBleEventCallback (sl_bt_msg_t * evt)
This function is called from the BLE stack to notify the application of a stack event.
N/A | evt |
67
of file ./app/framework/test/headers/plugin-callback.doc
Bulb PWM Driver Plugin Callbacks Documentation#
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.
N/A |
@appusage Should be implemented by an application layer configuration plugin.
85
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A |
@appusage Should be implemented by an application layer configuration plugin.
93
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A |
@appusage Should be implemented by an application layer configuration plugin.
103
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A |
@appusage Should be implemented by an application layer configuration plugin.
113
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A |
@appusage Should be implemented by an application layer configuration plugin.
123
of file ./app/framework/test/headers/plugin-callback.doc
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.)
N/A |
@appusage Should be implemented by an application layer configuration plugin.
133
of file ./app/framework/test/headers/plugin-callback.doc
Bulb user interface Plugin Callbacks Documentation#
emberAfPluginBulbUiFinishedCallback#
void emberAfPluginBulbUiFinishedCallback (EmberStatus status)
Finished.
N/A | status | Ver.: always |
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.
148
of file ./app/framework/test/headers/plugin-callback.doc
Button Interface Plugin Callbacks Documentation#
emberAfPluginButtonInterfaceButton0PressedShortCallback
void emberAfPluginButtonInterfaceButton0PressedShortCallback (uint16_t timePressedMs)
Called when Button 0 is pressed short.
N/A | timePressedMs | Time (in ms) button 0 was pressed short |
159
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton1PressedShortCallback
void emberAfPluginButtonInterfaceButton1PressedShortCallback (uint16_t timePressedMs)
Called when Button 1 is pressed short.
N/A | timePressedMs | Time (in ms) button 1 was pressed short |
164
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton0PressedLongCallback
void emberAfPluginButtonInterfaceButton0PressedLongCallback (uint16_t timePressedMs, bool pressedAtReset)
Called when Button 0 is pressed long.
N/A | timePressedMs | Amount of time button 0 was pressed. |
N/A | pressedAtReset | Was the button pressed at startup. |
170
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton1PressedLongCallback
void emberAfPluginButtonInterfaceButton1PressedLongCallback (uint16_t timePressedMs, bool pressedAtReset)
Called when Button 1 is pressed long.
N/A | timePressedMs | Amount of time button 1 was pressed. |
N/A | pressedAtReset | Was the button pressed at startup. |
177
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton0PressingCallback
void emberAfPluginButtonInterfaceButton0PressingCallback (void )
Called while Button 0 is pressed.
N/A |
This function is periodically called when button 0 is being pressed.
184
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton1PressingCallback
void emberAfPluginButtonInterfaceButton1PressingCallback (void )
Called while Button 1 is pressed.
N/A |
This function is periodically called when button 1 is being pressed.
190
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton0LowCallback
void emberAfPluginButtonInterfaceButton0LowCallback (void )
Called when Button 0 goes low.
N/A |
This function is called when the GPIO tied to button zero goes low
196
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton0HighCallback
void emberAfPluginButtonInterfaceButton0HighCallback (void )
Called when Button 0 goes high.
N/A |
This function is called when the GPIO tied to button zero goes high
202
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton1LowCallback
void emberAfPluginButtonInterfaceButton1LowCallback (void )
Called when Button 1 goes low.
N/A |
This function is called when the GPIO tied to button one goes low
208
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginButtonInterfaceButton1HighCallback
void emberAfPluginButtonInterfaceButton1HighCallback (void )
Called when Button 1 goes high.
N/A |
This function is called when the GPIO tied to button one goes high
214
of file ./app/framework/test/headers/plugin-callback.doc
Button Form/Join Code Plugin Callbacks Documentation#
emberAfPluginButtonJoiningButtonEventCallback
void emberAfPluginButtonJoiningButtonEventCallback (uint8_t buttonNumber, uint32_t buttonPressDurationMs)
Button Event.
N/A | buttonNumber | The button number that was pressed. Ver.: always |
N/A | buttonPressDurationMs | The length of time button was held down before it was released. Ver.: always |
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.
232
of file ./app/framework/test/headers/plugin-callback.doc
Calendar Server Plugin Callbacks Documentation#
emberAfPluginCalendarServerPublishInfoCallback#
void emberAfPluginCalendarServerPublishInfoCallback (uint8_t publishCommandId, EmberNodeId clientNodeId, uint8_t clientEndpoint, uint8_t totalCommands)
Publish Info.
N/A | publishCommandId | ZCL command to be published Ver.: always |
N/A | clientNodeId | Destination nodeId Ver.: always |
N/A | clientEndpoint | Destination endpoint Ver.: always |
N/A | totalCommands | Total number of publish commands to be sent Ver.: always |
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.
253
of file ./app/framework/test/headers/plugin-callback.doc
Radio Coexistence Plugin Callbacks Documentation#
coexCoulombCounterEventCallback#
void coexCoulombCounterEventCallback (uint16_t ccState)
Reports a change in radio state.
N/A | ccState | bitmask of radio states |
This function is called by the RAIL library to report changes in the radio states (Idle/Rx/Tx) according to PTA events.
271
of file ./app/framework/test/headers/plugin-callback.doc
Radio Coexistence Stub Plugin Callbacks Documentation#
emberAfPluginCoulombCounterEventCallback#
void emberAfPluginCoulombCounterEventCallback (uint32_t mask, uint32_t options)
Set the Radio states and energy modes.
N/A | mask | |
N/A | options |
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.
285
of file ./app/framework/test/headers/plugin-callback.doc
Color Control Cluster (deprecated) Plugin Callbacks Documentation#
emberAfPluginColorControlIsColorSupportedCallback#
bool emberAfPluginColorControlIsColorSupportedCallback (uint8_t hue, uint8_t saturation)
Is Color Supported.
N/A | hue | Ver.: always |
N/A | saturation | Ver.: always |
This function will be called to determine whether a color is supported by a device. The color will be specified by hue and saturation.
300
of file ./app/framework/test/headers/plugin-callback.doc
Color Control Cluster Server Plugin Callbacks Documentation#
emberAfPluginColorControlServerComputePwmFromHsvCallback#
void emberAfPluginColorControlServerComputePwmFromHsvCallback (uint8_t endpoint)
Compute Pwm from HSV.
N/A | endpoint | The identifying endpoint Ver.: always |
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.
315
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginColorControlServerComputePwmFromXyCallback#
void emberAfPluginColorControlServerComputePwmFromXyCallback (uint8_t endpoint)
Compute Pwm from HSV.
N/A | endpoint | The identifying endpoint Ver.: always |
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.
323
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginColorControlServerComputePwmFromTempCallback#
void emberAfPluginColorControlServerComputePwmFromTempCallback (uint8_t endpoint)
Compute Pwm from HSV.
N/A | endpoint | The identifying endpoint Ver.: always |
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.
331
of file ./app/framework/test/headers/plugin-callback.doc
Command Relay Plugin Callbacks Documentation#
emberAfPluginCommandRelayChangedCallback#
void emberAfPluginCommandRelayChangedCallback (void )
Changed.
N/A |
Called when relays rules are added or removed.
343
of file ./app/framework/test/headers/plugin-callback.doc
Comms Hub Function (CHF) Plugin Callbacks Documentation#
emberAfPluginCommsHubFunctionSendCallback#
void emberAfPluginCommsHubFunctionSendCallback (uint8_t status, EmberEUI64 destinationDeviceId, uint16_t dataLen, uint8_t * data)
Send.
N/A | status | The status of the message that was sent Ver.: always |
N/A | destinationDeviceId | The EUI64 of the destination device to which the data was sent Ver.: always |
N/A | dataLen | The length in octets of the data that was sent Ver.: always |
N/A | data | Buffer containing the raw octets of the data that was sent Ver.: always |
This callback is called by the Comms Hub Function (CHF) plugin to report the status of a message that was previously sent.
362
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginCommsHubFunctionReceivedCallback#
void emberAfPluginCommsHubFunctionReceivedCallback (EmberEUI64 senderDeviceId, uint16_t dataLen, uint8_t * data)
Received.
N/A | senderDeviceId | The EUI64 of the sending device Ver.: always |
N/A | dataLen | The length in octets of the data Ver.: always |
N/A | data | Buffer containing the raw octets of the data Ver.: always |
This callback is called by the Comms Hub Function (CHF) plugin whenever a message is received.
375
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginCommsHubFunctionAlertWANCallback#
void emberAfPluginCommsHubFunctionAlertWANCallback (uint16_t alertCode, uint8_t * gbzAlert, uint16_t gbzAlertLength)
Alert WAN.
N/A | alertCode | The 16 bit allert code as defined by GBCS Ver.: always |
N/A | gbzAlert | Buffer continaing the GBZ formatted Alert Ver.: always |
N/A | gbzAlertLength | The length in octets of the GBZ formatted Alert Ver.: always |
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.
389
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginCommsHubFunctionTunnelOpenedCallback#
void emberAfPluginCommsHubFunctionTunnelOpenedCallback (EmberEUI64 remoteDeviceId)
Tunnel Opened.
N/A | remoteDeviceId | The EUI64 of the remote device for which a tunnel is opened Ver.: always |
This function is called by the Comms Hub Function (CHF) plugin when a tunnel is opened.
400
of file ./app/framework/test/headers/plugin-callback.doc
Comms Hub Function (Sub-GHz) Plugin Callbacks Documentation#
emberAfPluginCommsHubFunctionSubGhzChannelChangeCallback#
void emberAfPluginCommsHubFunctionSubGhzChannelChangeCallback (EmberAfPluginCommsHubFunctionSubGhzChannelChangeOutcome outcome, EmberAfStatus status)
Sub-GHz channel change request outcome callback.
N/A | outcome | Channel change request outcome |
N/A | status | Ember status code if the outcome is negative |
This callback is called by the Comms Hub Function (Sub-GHz) plugin to report the outcome of the channel change request.
415
of file ./app/framework/test/headers/plugin-callback.doc
Concentrator Support Plugin Callbacks Documentation#
emberAfPluginConcentratorBroadcastSentCallback#
void emberAfPluginConcentratorBroadcastSentCallback (void )
Broadcast Sent.
N/A |
This function is called when a new MTORR broadcast has been successfully sent by the concentrator plugin.
429
of file ./app/framework/test/headers/plugin-callback.doc
Configuration server Plugin Callbacks Documentation#
emberAfPluginConfigurationServerFinishedCallback#
void emberAfPluginConfigurationServerFinishedCallback (EmberStatus status)
Finished.
N/A | status | Ver.: always |
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.
444
of file ./app/framework/test/headers/plugin-callback.doc
Connection Manager Plugin Callbacks Documentation#
emberAfPluginConnectionManagerFinishedCallback#
void emberAfPluginConnectionManagerFinishedCallback (EmberStatus status)
Network join finished.
N/A | status | Ver.: always |
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.
459
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginConnectionManagerStartNetworkSearchCallback#
void emberAfPluginConnectionManagerStartNetworkSearchCallback (void )
Begin searching for network to join.
N/A |
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.
466
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginConnectionManagerLeaveNetworkCallback#
void emberAfPluginConnectionManagerLeaveNetworkCallback (void )
Leave the currently joined network.
N/A |
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.
473
of file ./app/framework/test/headers/plugin-callback.doc
Counters Plugin Callbacks Documentation#
emberAfPluginCountersRolloverCallback#
void emberAfPluginCountersRolloverCallback (EmberCounterType type)
Rollover.
N/A | type | The counter that rolled over Ver.: always |
This function is called every time a counter exceeds its threshold.
486
of file ./app/framework/test/headers/plugin-callback.doc
Delayed Join Plugin Callbacks Documentation#
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.
N/A | newNodeId | of the joining device |
N/A | newNodeEui64 | longId of the joing device |
N/A | parentOfNewNode | nodeId of the parent |
N/A | status | type of join attempt, if it is secure Join etc. |
N/A | decision | stacks decision on how to handle this join attempt |
503
of file ./app/framework/test/headers/plugin-callback.doc
Device Database Plugin Callbacks Documentation#
emberAfPluginDeviceDatabaseDiscoveryCompleteCallback#
void emberAfPluginDeviceDatabaseDiscoveryCompleteCallback (const EmberAfDeviceInfo * device)
Discovery Complete.
N/A | device | A pointer to the information struct about the device. Ver.: always |
This function is called when a device in the database has been set to EMBER_AF_DEVICE_DISCOVERY_STATUS_DONE.
522
of file ./app/framework/test/headers/plugin-callback.doc
Device Management Client Plugin Callbacks Documentation#
emberAfPluginDeviceManagementClientEnactChangeOfTenancyCallback#
void emberAfPluginDeviceManagementClientEnactChangeOfTenancyCallback (uint8_t endpoint, EmberAfDeviceManagementTenancy * tenancy)
Enact Change Of Tenancy.
N/A | endpoint | Ver.: always |
N/A | tenancy | Ver.: always |
This callback will be implemented by a meter to enact a change of tenancy at the requested time of implementation.
537
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceManagementClientEnactChangeOfSupplierCallback#
void emberAfPluginDeviceManagementClientEnactChangeOfSupplierCallback (uint8_t endpoint, EmberAfDeviceManagementSupplier * supplier)
Enact Change Of Supplier.
N/A | endpoint | Ver.: always |
N/A | supplier | Ver.: always |
This callback will be implemented by a meter to enact a change of supplier at the requested time of implementation.
547
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceManagementClientEnactChangeSupplyCallback#
EmberStatus emberAfPluginDeviceManagementClientEnactChangeSupplyCallback (uint8_t endpoint, EmberAfDeviceManagementSupply * supply)
Enact Change Supply.
N/A | endpoint | Ver.: always |
N/A | supply | Ver.: always |
This callback will be implemented by a meter to enact a supply change at the requested time of implementation.
557
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceManagementClientSetSupplyStatusCallback#
void emberAfPluginDeviceManagementClientSetSupplyStatusCallback (uint8_t endpoint, EmberAfDeviceManagementSupplyStatusFlags * supplyStatus)
Set Supply Status.
N/A | endpoint | Ver.: always |
N/A | supplyStatus | Ver.: always |
This callback will be implemented by a meter to appropriately set the supply status.
567
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceManagementClientEnactUpdateUncontrolledFlowThresholdCallback#
void emberAfPluginDeviceManagementClientEnactUpdateUncontrolledFlowThresholdCallback (uint8_t endpoint, EmberAfDeviceManagementUncontrolledFlowThreshold * supplier)
Enact Update Uncontrolled Flow Threshold.
N/A | endpoint | Ver.: always |
N/A | supplier | Ver.: always |
This callback will be implemented by a meter to enact an update to the uncontrolled flow threshold as specified.
577
of file ./app/framework/test/headers/plugin-callback.doc
Device Management Server Plugin Callbacks Documentation#
emberAfPluginDeviceManagementServerGetPasswordCallback#
void emberAfPluginDeviceManagementServerGetPasswordCallback (EmberNodeId senderNodeId, EmberAfDeviceManagementPasswordType passwordType, EmberAfDeviceManagementPassword passwordInfo)
Get Password.
N/A | senderNodeId | Ver.: always |
N/A | passwordType | Ver.: always |
N/A | passwordInfo | Ver.: always |
This callback will be implemented by an esi to provide device specific password information.
594
of file ./app/framework/test/headers/plugin-callback.doc
Device Table Plugin Callbacks Documentation#
emberAfPluginDeviceTableStateChangeCallback#
void emberAfPluginDeviceTableStateChangeCallback (EmberNodeId nodeId, uint8_t state)
StateChange.
N/A | nodeId | Ver.: always |
N/A | state | Ver.: always |
This callback is called when a device's state changes.
610
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableClearedCallback#
void emberAfPluginDeviceTableClearedCallback (void )
Cleared.
N/A |
This callback is called when a device table has been cleared.
617
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableNewDeviceCallback#
void emberAfPluginDeviceTableNewDeviceCallback (EmberEUI64 eui64)
NewDevice.
N/A | eui64 | Ver.: always |
This callback is called when a new device joins the gateway.
624
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableRejoinDeviceCallback#
void emberAfPluginDeviceTableRejoinDeviceCallback (EmberEUI64 newNodeEui64)
Rejoin device.
N/A | newNodeEui64 | EUI64 of the rejoined device. |
Called when a device rejoins.
631
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableDeviceLeftCallback#
void emberAfPluginDeviceTableDeviceLeftCallback (EmberEUI64 newNodeEui64, state)
StateChange.
N/A | newNodeEui64 | Ver.: always |
N/A | state | Ver.: always |
This callback is called when a device's state changes.
638
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableInitialized#
void emberAfPluginDeviceTableInitialized (void , state)
StateChange.
N/A | Ver.: always | |
N/A | state | Ver.: always |
This callback is called when a device's state changes.
644
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableIndexRemovedCallback#
void emberAfPluginDeviceTableIndexRemovedCallback (uint16_t currentIndex, state)
StateChange.
N/A | currentIndex | Ver.: always |
N/A | state | Ver.: always |
This callback is called when a device's state changes.
652
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginDeviceTableIndexAddedCallback#
void emberAfPluginDeviceTableIndexAddedCallback (uint16_t index, state)
StateChange.
N/A | index | Ver.: always |
N/A | state | Ver.: always |
This callback is called when a device's state changes.
660
of file ./app/framework/test/headers/plugin-callback.doc
Door Lock Server Cluster Plugin Callbacks Documentation#
emberAfPluginDoorLockServerActivateDoorLockCallback#
bool emberAfPluginDoorLockServerActivateDoorLockCallback (bool activate)
Activate Door Lock.
N/A | activate | True if the lock should move to the locked position, false if it should move to the unlocked position Ver.: always |
This function is provided by the door lock server plugin. It is
674
of file ./app/framework/test/headers/plugin-callback.doc
Demand Response Load Control Cluster Client Plugin Callbacks Documentation#
emberAfPluginDrlcEventActionCallback#
bool emberAfPluginDrlcEventActionCallback (EmberAfLoadControlEvent * loadControlEvent, EmberAfAmiEventStatus eventStatus, uint8_t sequenceNumber)
Event Action.
N/A | loadControlEvent | Actual event Ver.: always |
N/A | eventStatus | Status of event Ver.: always |
N/A | sequenceNumber | Sequence number Ver.: always |
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.
707
of file ./app/framework/test/headers/plugin-callback.doc
EEPROM Plugin Callbacks Documentation#
emberAfPluginEepromStateChangeCallback#
void emberAfPluginEepromStateChangeCallback (HalEepromState oldEepromState, HalEepromState newEepromState)
Called whenever the EEPROM changes state.
N/A | oldEepromState | The old state of the EEPROM |
N/A | newEepromState | The new state of the EEPROM |
722
of file ./app/framework/test/headers/plugin-callback.doc
Em4 Plugin Callbacks Documentation#
emberAfPluginEm4EnterCallback#
bool emberAfPluginEm4EnterCallback (uint32_t * durationMs)
EM4 Enter.
N/A | durationMs | The maximum duration in milliseconds that the device will sleep. Ver.: always |
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.
738
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginEm4ExitCallback#
void emberAfPluginEm4ExitCallback (void )
EM4 Exit.
N/A |
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()
746
of file ./app/framework/test/headers/plugin-callback.doc
End Device Support Plugin Callbacks Documentation#
emberAfPluginEndDeviceSupportPollCompletedCallback#
void emberAfPluginEndDeviceSupportPollCompletedCallback (EmberStatus status)
Poll Completed.
N/A | status | Return status of a completed poll operation Ver.: always |
This function is called by the End Device Support plugin after a poll is completed.
760
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginEndDeviceSupportLostParentConnectivityCallback#
bool emberAfPluginEndDeviceSupportLostParentConnectivityCallback (void )
Lost Parent Connectivity.
N/A |
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.
774
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginEndDeviceSupportPreNetworkMoveCallback#
bool emberAfPluginEndDeviceSupportPreNetworkMoveCallback (void )
Pre Network Move.
N/A |
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.
788
of file ./app/framework/test/headers/plugin-callback.doc
Events Server Plugin Callbacks Documentation#
emberAfPluginEventsServerOkToClearLogCallback#
bool emberAfPluginEventsServerOkToClearLogCallback (EmberAfEventLogId logId)
Ok To Clear Log.
N/A | logId | The identifier of the log requested to be cleared. Ver.: always |
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.
809
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginEventsServerLogDataUpdatedCallback#
void emberAfPluginEventsServerLogDataUpdatedCallback (const EmberAfClusterCommand * cmd)
Log Data Updated.
N/A | cmd | ZCL command Ver.: always |
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.
819
of file ./app/framework/test/headers/plugin-callback.doc
EZ-Mode Commissioning Plugin Callbacks Documentation#
emberAfPluginEzmodeCommissioningClientCompleteCallback#
void emberAfPluginEzmodeCommissioningClientCompleteCallback (uint8_t bindingIndex)
Client Complete.
N/A | bindingIndex | The binding index that was created or EMBER_NULL_BINDING if an error occurred. Ver.: always |
This function is called by the EZ-Mode Commissioning plugin when client commissioning completes.
834
of file ./app/framework/test/headers/plugin-callback.doc
Find and Bind Initiator Plugin Callbacks Documentation#
emberAfPluginFindAndBindInitiatorBindTargetCallback#
bool emberAfPluginFindAndBindInitiatorBindTargetCallback (EmberNodeId nodeId, EmberBindingTableEntry * bindingEntry, uint8_t * groupName)
Bind Target.
N/A | nodeId | short ID of the potential target Ver.: always |
N/A | bindingEntry | The binding entry for that target. Ver.: always |
N/A | groupName | The name of the group if a multicast binding is created. Ver.: always |
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.
854
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginFindAndBindInitiatorCompleteCallback#
void emberAfPluginFindAndBindInitiatorCompleteCallback (EmberStatus status)
Complete.
N/A | status | Status code describing the completion of the find and bind process Ver.: always |
This callback is fired by the initiator when the Find and Bind process is complete.
865
of file ./app/framework/test/headers/plugin-callback.doc
Form and Join Library Plugin Callbacks Documentation#
emberAfPluginFormAndJoinNetworkFoundCallback#
void emberAfPluginFormAndJoinNetworkFoundCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
Network Found.
N/A | networkFound | Ver.: always |
N/A | lqi | Ver.: always |
N/A | rssi | Ver.: always |
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.
883
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginFormAndJoinUnusedPanIdFoundCallback#
void emberAfPluginFormAndJoinUnusedPanIdFoundCallback (EmberPanId panId, uint8_t channel)
Unused Pan Id Found.
N/A | panId | A randomly generated PAN ID without other devices on it. Ver.: always |
N/A | channel | The channel where the PAN ID can be used to form a new network. Ver.: always |
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.
896
of file ./app/framework/test/headers/plugin-callback.doc
Gas Proxy Function (GPF) Plugin Callbacks Documentation#
emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback#
void emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback (uint8_t * gbzCommandsResponse, uint16_t gbzCommandsResponseLength)
Non Tap Off Message Handler Completed.
N/A | gbzCommandsResponse | Ver.: always |
N/A | gbzCommandsResponseLength | Ver.: always |
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.
915
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGasProxyFunctionAlertWANCallback#
void emberAfPluginGasProxyFunctionAlertWANCallback (uint16_t alertCode, uint8_t * gbzAlert, uint16_t gbzAlertLength)
Alert WAN.
N/A | alertCode | The 16 bit allert code as defined by GBCS Ver.: always |
N/A | gbzAlert | Buffer continaing the GBZ formatted Alert Ver.: always |
N/A | gbzAlertLength | The length in octets of the GBZ formatted Alert Ver.: always |
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.
928
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback#
void emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback (const EmberAfGpfMessage * gpfMessage, const EmberAfClusterCommand * zclClusterCommand)
Tap Off Message Future Command Ignored.
N/A | gpfMessage | Ver.: always |
N/A | zclClusterCommand | Ver.: always |
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.
945
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGasProxyFunctionDataLogAccessRequestCallback#
bool emberAfPluginGasProxyFunctionDataLogAccessRequestCallback (const EmberAfGpfMessage * gpfMessage, const EmberAfClusterCommand * zclClusterCommand)
Data Log Access Request.
N/A | gpfMessage | Ver.: always |
N/A | zclClusterCommand | Ver.: always |
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.
959
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback#
EmberAfGpfZclCommandPermission emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback (const EmberAfClusterCommand * cmd, uint16_t messageCode)
Validate Incoming Zcl Command.
N/A | cmd | Ver.: always |
N/A | messageCode | Ver.: always |
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.
972
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback#
void emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback (uint32_t issuerCalendarId, uint8_t * seasonEntries, uint8_t seasonEntriesLength, uint8_t unknownWeekIdSeasonsMask)
Unknown Season Week Id.
N/A | issuerCalendarId | The calendar ID associated with these seasons. Ver.: always |
N/A | seasonEntries | The season entries for this publish command. Ver.: always |
N/A | seasonEntriesLength | The length of the season entries. Ver.: always |
N/A | unknownWeekIdSeasonsMask | A mask where bit N indicates that the Nth season entry contains an unknown week ID reference. Ver.: always |
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.
989
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback#
void emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback (uint32_t issuerCalendarId, uint8_t * specialDayEntries, uint8_t specialDayEntriesLength, uint8_t unknownDayIdMask)
Unknown Special Days Day Id.
N/A | issuerCalendarId | The calendar ID associated with these special days. Ver.: always |
N/A | specialDayEntries | The special day entries for this publish command. Ver.: always |
N/A | specialDayEntriesLength | The length of the special day entries. Ver.: always |
N/A | unknownDayIdMask | A mask where bit N indicates that the Nth special day entry contains an unknown day ID reference. Ver.: always |
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.
1009
of file ./app/framework/test/headers/plugin-callback.doc
GBCS Device Log Plugin Callbacks Documentation#
emberAfPluginGbcsDeviceLogDeviceRemovedCallback#
void emberAfPluginGbcsDeviceLogDeviceRemovedCallback (EmberEUI64 deviceId)
Device Removed.
N/A | deviceId | Identifier of the device removed Ver.: always |
This callback is called by the plugin when a device is removed from the device log.
1026
of file ./app/framework/test/headers/plugin-callback.doc
GBZ Message Controller Plugin Callbacks Documentation#
emberAfPluginGbzMessageControllerDecryptDataCallback#
void emberAfPluginGbzMessageControllerDecryptDataCallback (EmberAfGbzMessageData * data)
Decrypt Data.
N/A | data | Ver.: always |
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.
1045
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGbzMessageControllerEncryptDataCallback#
void emberAfPluginGbzMessageControllerEncryptDataCallback (EmberAfGbzMessageData * data)
Encrypt Data.
N/A | data | Ver.: always |
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.
1058
of file ./app/framework/test/headers/plugin-callback.doc
GPIO Sensor Interface Plugin Callbacks Documentation#
emberAfPluginGpioSensorStateChangedCallback#
void emberAfPluginGpioSensorStateChangedCallback (uint8_t newSensorState)
Called whenever the GPIO sensor detects a change in state.
N/A | newSensorState | The new state of the sensor based alarm (EMBER_AF_PLUGIN_GPIO_SENSOR_ACTIVE or EMBER_AF_PLUGIN_GPIO_SENSOR_NOT_ACTIVE) Ver.: always |
1071
of file ./app/framework/test/headers/plugin-callback.doc
Green Power Server Plugin Callbacks Documentation#
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.
N/A | commandId | Ver.: always |
N/A | commNotificationOptions | Ver.: always |
N/A | gpdAddr | Ver.: always |
N/A | gpdSecurityFrameCounter | Ver.: always |
N/A | gpdCommandId | Ver.: always |
N/A | gpdCommandPayload | Ver.: always |
N/A | gppShortAddress | Ver.: always |
N/A | rssi | Ver.: always |
N/A | linkQuality | Ver.: always |
N/A | gppDistance | Ver.: always |
N/A | commissioningNotificationMic | Ver.: always |
N/A | errorReturn | Ver.: always |
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.
1098
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGreenPowerServerGpdCommissioningCallback#
bool emberAfPluginGreenPowerServerGpdCommissioningCallback (EmberGpApplicationInfo * appInfo, bool * matchFound)
Gpd Commissioning.
N/A | appInfo | Application information of the commissioning GPD. Ver.: always |
N/A | matchFound | Output flag to notify matching functionality. Ver.: always |
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.
1120
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGreenPowerServerGpdSecurityFailureCallback#
void emberAfPluginGreenPowerServerGpdSecurityFailureCallback (EmberGpAddress * gpdAddr)
Gpd Commissioning.
N/A | gpdAddr | Ver.: always |
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.
1129
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A | options | from the incoming Gp Notification Command Ver.: always |
N/A | addr | GPD address Ver.: always |
N/A | gpdSecurityFrameCounter | Ver.: always |
N/A | gpdCommandId | Ver.: always |
N/A | gpdCommandPayload | first byte is length of the payload Ver.: always |
N/A | gppShortAddress | Ver.: always |
N/A | gppDistance | Ver.: always |
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.
1144
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerServerPairingCompleteCallback#
void emberAfGreenPowerServerPairingCompleteCallback (uint8_t numberOfEndpoints, uint8_t * endpoints)
Gpd Commissioning.
N/A | numberOfEndpoints | Ver.: always |
N/A | endpoints |
This function is called by the Green Power Server upon the completion of the pairing and to indicate the closure of the pairing session.
1158
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerServerCommissioningTimeoutCallback#
void emberAfGreenPowerServerCommissioningTimeoutCallback (uint8_t commissioningTimeoutType, uint8_t numberOfEndpoints, uint8_t * endpoints)
Gpd Commissioning.
N/A | commissioningTimeoutType | Ver.: always |
N/A | numberOfEndpoints | |
N/A | endpoints |
This function is called by the Green Power Server upon expiry of either the switch commissioning or multisensor commissioning timer.
1167
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerServerUpdateInvolveTCCallback#
bool emberAfGreenPowerServerUpdateInvolveTCCallback (EmberStatus status)
Gpd Commissioning.
N/A | status | Ver.: always |
This function is called by the Green Power Server to proceed with updating the InvolveTC bit of the security level attribute.
1177
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A | options | Ver.: since gp-1.0-09-5499-24 |
N/A | gpdSrcId | Ver.: since gp-1.0-09-5499-24 |
N/A | gpdIeee | Ver.: since gp-1.0-09-5499-24 |
N/A | endpoint | Ver.: always |
1187
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback#
bool emberAfPluginGreenPowerServerSinkTableAccessNotificationCallback (void * data, EmberAfGpServerSinkTableAccessType accessType)
Sink Table Access Notification.
N/A | data | void pointer to the data Ver.: always |
N/A | accessType | accessType Ver.: always |
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.
1200
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerClusterCommissioningMessageStatusNotificationCallback#
void emberAfGreenPowerClusterCommissioningMessageStatusNotificationCallback (EmberAfGreenPowerServerCommissioningState * commissioningState, EmberApsFrame * apsFrame, EmberOutgoingMessageType messageType, uint16_t destination, EmberStatus status)
Sink Commissioning Enter Call Status notification.
N/A | commissioningState | Sink commissioning state Ver.: always |
N/A | apsFrame | aps frame header Ver.: always |
N/A | messageType | unicast or broadcast Ver.: always |
N/A | destination | destination node Ver.: always |
N/A | status | status of the network submission Ver.: always |
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.
1214
of file ./app/framework/test/headers/plugin-callback.doc
Green Power Translation Table Plugin Callbacks Documentation#
emberAfGreenPowerClusterPassFrameWithoutTranslationCallback#
void emberAfGreenPowerClusterPassFrameWithoutTranslationCallback (EmberGpAddress * addr, uint8_t gpdCommandId, uint8_t * gpdCommandPayload)
Gpd Commissioning.
N/A | addr | Ver.: always |
N/A | gpdCommandId | |
N/A | gpdCommandPayload |
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).
1232
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerClusterGpTransTableDeleteTranslationTableEntryCallback#
bool emberAfGreenPowerClusterGpTransTableDeleteTranslationTableEntryCallback (EmberGpAddress * gpdAddr)
Remove Gpd entries From Translation Table.
N/A | gpdAddr | Ver.: always |
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.
1243
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerClusterGpRequestTranslationTableCallback#
bool emberAfGreenPowerClusterGpRequestTranslationTableCallback (uint8_t startIndex)
Request Translation Table.
N/A | startIndex | Ver.: always |
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.
1252
of file ./app/framework/test/headers/plugin-callback.doc
emberAfGreenPowerClusterGpUpdateTranslationTableCallback#
bool emberAfGreenPowerClusterGpUpdateTranslationTableCallback (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t * translations)
Update Translation Table.
N/A | options | Ver.: always |
N/A | gpdSrcId | Ver.: always |
N/A | gpdIeee | Ver.: always |
N/A | gpdEndpoint | Ver.: always |
N/A | translations | Ver.: always |
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.
1265
of file ./app/framework/test/headers/plugin-callback.doc
Groups Server Cluster Plugin Callbacks Documentation#
emberAfPluginGroupsServerGetGroupNameCallback#
void emberAfPluginGroupsServerGetGroupNameCallback (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)
Get Group Name.
N/A | endpoint | Endpoint Ver.: always |
N/A | groupId | Group ID Ver.: always |
N/A | groupName | Group Name Ver.: always |
This function returns the name of a group with the provided group ID, should it exist.
1285
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGroupsServerSetGroupNameCallback#
void emberAfPluginGroupsServerSetGroupNameCallback (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)
Set Group Name.
N/A | endpoint | Endpoint Ver.: always |
N/A | groupId | Group ID Ver.: always |
N/A | groupName | Group Name Ver.: always |
This function sets the name of a group with the provided group ID.
1296
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginGroupsServerGroupNamesSupportedCallback#
bool emberAfPluginGroupsServerGroupNamesSupportedCallback (uint8_t endpoint)
Group Names Supported.
N/A | endpoint | Endpoint Ver.: always |
This function returns whether or not group names are supported.
1305
of file ./app/framework/test/headers/plugin-callback.doc
HAL Library Plugin Callbacks Documentation#
halRadioPowerUpHandler#
void halRadioPowerUpHandler (void )
Called whenever the radio is powered on.
N/A |
1315
of file ./app/framework/test/headers/plugin-callback.doc
halRadioPowerDownHandler#
void halRadioPowerDownHandler (void )
Called whenever the radio is powered off.
N/A |
1319
of file ./app/framework/test/headers/plugin-callback.doc
halSleepCallback#
void halSleepCallback (boolean enter, SleepModes sleepMode)
Called whenever the microcontroller enters/exits a idle/sleep mode.
N/A | enter | True if entering idle/sleep, False if exiting |
N/A | sleepMode | Idle/sleep mode |
1326
of file ./app/framework/test/headers/plugin-callback.doc
Identify Cluster Plugin Callbacks Documentation#
emberAfPluginIdentifyStartFeedbackCallback#
void emberAfPluginIdentifyStartFeedbackCallback (uint8_t endpoint, uint16_t identifyTime)
Start Feedback.
N/A | endpoint | The identifying endpoint Ver.: always |
N/A | identifyTime | The identify time Ver.: always |
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.)
1346
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginIdentifyStopFeedbackCallback#
void emberAfPluginIdentifyStopFeedbackCallback (uint8_t endpoint)
Stop Feedback.
N/A | endpoint | The identifying endpoint Ver.: always |
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.
1356
of file ./app/framework/test/headers/plugin-callback.doc
Idle/Sleep Plugin Callbacks Documentation#
emberAfPluginIdleSleepOkToSleepCallback#
bool emberAfPluginIdleSleepOkToSleepCallback (uint32_t durationMs)
Ok To Sleep.
N/A | durationMs | The maximum duration in milliseconds that the device will sleep. Ver.: always |
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.
1372
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginIdleSleepWakeUpCallback#
void emberAfPluginIdleSleepWakeUpCallback (uint32_t durationMs)
Wake Up.
N/A | durationMs | The duration in milliseconds that the device slept. Ver.: always |
This function is called by the Idle/Sleep plugin after sleeping.
1380
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginIdleSleepOkToIdleCallback#
bool emberAfPluginIdleSleepOkToIdleCallback (void )
Ok To Idle.
N/A |
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.
1388
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginIdleSleepActiveCallback#
void emberAfPluginIdleSleepActiveCallback (void )
Active.
N/A |
This function is called by the Idle/Sleep plugin after idling.
1394
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginIdleSleepRtosCallback#
bool emberAfPluginIdleSleepRtosCallback (uint32_t * durationMs, bool sleepOk)
RTOS idle/sleep.
N/A | durationMs | A pointer to the allowed idle/sleep duration in milliseconds. Ver.: always |
N/A | sleepOk | A boolean indicating whether sleep is allowed. |
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.
1406
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginIdleSleepPreEm4ResetCallback#
bool emberAfPluginIdleSleepPreEm4ResetCallback (uint32_t * sleepDurationMs)
Active.
N/A | sleepDurationMs |
This function is called by the Idle/Sleep plugin before em4 reset, and it is implemented by EM4 plugin.
1413
of file ./app/framework/test/headers/plugin-callback.doc
Interpan Plugin Callbacks Documentation#
emberAfPluginInterpanPreMessageReceivedCallback#
bool emberAfPluginInterpanPreMessageReceivedCallback (const EmberAfInterpanHeader * header, uint8_t msgLen, uint8_t * message)
Pre Message Received.
N/A | header | The inter-PAN header Ver.: always |
N/A | msgLen | The message payload length Ver.: always |
N/A | message | The message payload Ver.: always |
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.
1430
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginInterpanMessageReceivedOverFragmentsCallback#
void emberAfPluginInterpanMessageReceivedOverFragmentsCallback (const EmberAfInterpanHeader * header, uint8_t msgLen, uint8_t * message)
Message Received Over Fragments.
N/A | header | The inter-PAN header Ver.: always |
N/A | msgLen | The message payload length Ver.: always |
N/A | message | The message payload Ver.: always |
This function is called by the Interpan plugin when a fully reconstructed message has been received over inter-PAN fragments, or IPMFs.
1442
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginInterpanFragmentTransmissionFailedCallback#
void emberAfPluginInterpanFragmentTransmissionFailedCallback (uint8_t interpanFragmentationStatus, uint8_t fragmentNum)
Fragment Transmission Failed.
N/A | interpanFragmentationStatus | The status describing why transmission failed Ver.: always |
N/A | fragmentNum | The fragment number that encountered the failure Ver.: always |
This function is called by the Interpan plugin when a fragmented transmission has failed.
1455
of file ./app/framework/test/headers/plugin-callback.doc
Level Control Server Cluster Plugin Callbacks Documentation#
emberAfPluginLevelControlClusterServerPostInitCallback#
void emberAfPluginLevelControlClusterServerPostInitCallback (uint8_t endpoint)
Level Control Cluster Server Post Init.
N/A | endpoint | Endpoint that is being initialized Ver.: always |
Following resolution of the Current Level at startup for this endpoint, perform any additional initialization needed; e.g., synchronize hardware state.
1471
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginLevelControlCoupledColorTempChangeCallback#
void emberAfPluginLevelControlCoupledColorTempChangeCallback (uint8_t endpoint)
Level Control Coupled Color Temp Change.
N/A | endpoint | Endpoint that is being initialized Ver.: always |
Adjust Color Control cluster Color Temperature in response to a change in Level Control cluster CurrentLevel.
1479
of file ./app/framework/test/headers/plugin-callback.doc
Messaging Client Cluster Plugin Callbacks Documentation#
emberAfPluginMessagingClientPreDisplayMessageCallback#
bool emberAfPluginMessagingClientPreDisplayMessageCallback (uint32_t messageId, uint8_t messageControl, uint32_t startTime, uint16_t durationInMinutes, uint8_t * message, uint8_t optionalExtendedMessageControl)
Pre Display Message.
N/A | messageId | Ver.: always |
N/A | messageControl | Ver.: always |
N/A | startTime | Ver.: always |
N/A | durationInMinutes | Ver.: always |
N/A | message | Ver.: always |
N/A | optionalExtendedMessageControl | Ver.: always |
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.
1500
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginMessagingClientDisplayMessageCallback#
void emberAfPluginMessagingClientDisplayMessageCallback (EmberAfPluginMessagingClientMessage * message)
Display Message.
N/A | message | The message that should be displayed. Ver.: always |
This function is called by the Messaging client plugin whenever the application should display a message.
1513
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginMessagingClientCancelMessageCallback#
void emberAfPluginMessagingClientCancelMessageCallback (EmberAfPluginMessagingClientMessage * message)
Cancel Message.
N/A | message | The message that should no longer be displayed. Ver.: always |
This function is called by the Messaging client plugin whenever the application should stop displaying a message.
1521
of file ./app/framework/test/headers/plugin-callback.doc
Meter Mirror Plugin Callbacks Documentation#
emberAfPluginMeterMirrorMirrorAddedCallback#
void emberAfPluginMeterMirrorMirrorAddedCallback (const EmberEUI64 requestingDeviceIeeeAddress, uint8_t endpoint)
Mirror Added.
N/A | requestingDeviceIeeeAddress | Ver.: always |
N/A | endpoint | Ver.: always |
This function is called by the Meter Mirror plugin whenever a RequestMirror command is successfully processed.
1536
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginMeterMirrorMirrorRemovedCallback#
void emberAfPluginMeterMirrorMirrorRemovedCallback (const EmberEUI64 requestingDeviceIeeeAddress, uint8_t endpoint)
Mirror Removed.
N/A | requestingDeviceIeeeAddress | Ver.: always |
N/A | endpoint | Ver.: always |
This function is called by the Meter Mirror plugin whenever a RemoveMirror command is successfully processed.
1546
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginMeterMirrorReportingCompleteCallback#
void emberAfPluginMeterMirrorReportingCompleteCallback (uint8_t endpoint)
Reporting Complete.
N/A | endpoint | Ver.: always |
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.
1557
of file ./app/framework/test/headers/plugin-callback.doc
Meter Snapshot Server Plugin Callbacks Documentation#
emberAfPluginMeterSnapshotServerScheduleSnapshotCallback#
void emberAfPluginMeterSnapshotServerScheduleSnapshotCallback (uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t * snapshotPayload, uint8_t * responsePayload)
Schedule Snapshot.
N/A | srcEndpoint | Ver.: always |
N/A | dstEndpoint | Ver.: always |
N/A | dest | Ver.: always |
N/A | snapshotPayload | Ver.: always |
N/A | responsePayload | Ver.: always |
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.
1577
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginMeterSnapshotServerTakeSnapshotCallback#
uint32_t emberAfPluginMeterSnapshotServerTakeSnapshotCallback (uint8_t endpoint, uint32_t snapshotCause, uint8_t * snapshotConfirmation)
Take Snapshot.
N/A | endpoint | Ver.: always |
N/A | snapshotCause | Ver.: always |
N/A | snapshotConfirmation | Ver.: always |
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.
1594
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginMeterSnapshotServerGetSnapshotCallback#
void emberAfPluginMeterSnapshotServerGetSnapshotCallback (uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t * snapshotCriteria)
Get Snapshot.
N/A | srcEndpoint | Ver.: always |
N/A | dstEndpoint | Ver.: always |
N/A | dest | Ver.: always |
N/A | snapshotCriteria | Ver.: always |
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.
1609
of file ./app/framework/test/headers/plugin-callback.doc
Metering Server Plugin Callbacks Documentation#
emberAfPluginMeteringServerProcessNotificationFlagsCallback#
void emberAfPluginMeteringServerProcessNotificationFlagsCallback (uint16_t attributeId, uint32_t attributeValue)
Server Process Notification.
N/A | attributeId | ID of the attribute being proccessed Ver.: always |
N/A | attributeValue | value of the attribute being proccessed Ver.: always |
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.
1629
of file ./app/framework/test/headers/plugin-callback.doc
Multiple RAIL Demo Code Plugin Callbacks Documentation#
emberAfPluginMultirailDemoRailEventCallback#
void emberAfPluginMultirailDemoRailEventCallback (RAIL_Handle_t handle, RAIL_Events_t events)
A callback called whenever a secondary instance RAIL event occurs.
[in] | handle | A handle for a RAIL instance. |
[in] | events | A bit mask of RAIL events (full list in rail_types.h) |
1643
of file ./app/framework/test/headers/plugin-callback.doc
Network Creator Plugin Callbacks Documentation#
emberAfPluginNetworkCreatorCompleteCallback#
void emberAfPluginNetworkCreatorCompleteCallback (const EmberNetworkParameters * network, bool usedSecondaryChannels)
Complete.
N/A | network | The network that the network creator plugin successfully formed. Ver.: always |
N/A | usedSecondaryChannels | Whether or not the network creator wants to form a network on the secondary channels Ver.: always |
This callback notifies the user that the network creation process has completed successfully.
1661
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkCreatorGetPanIdCallback#
EmberPanId emberAfPluginNetworkCreatorGetPanIdCallback (void )
Get Pan Id.
N/A |
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.
1670
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkCreatorGetRadioPowerCallback#
int8_t emberAfPluginNetworkCreatorGetRadioPowerCallback (void )
Get Power For Radio Channel.
N/A |
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.
1678
of file ./app/framework/test/headers/plugin-callback.doc
Network Find Plugin Callbacks Documentation#
emberAfPluginNetworkFindFinishedCallback#
void emberAfPluginNetworkFindFinishedCallback (EmberStatus status)
Finished.
N/A | status | Ver.: always |
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.
1693
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkFindGetRadioPowerForChannelCallback#
int8_t emberAfPluginNetworkFindGetRadioPowerForChannelCallback (uint8_t pgChan)
Get Radio Power For Channel.
N/A | pgChan | Ver.: always |
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.
1702
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkFindJoinCallback#
bool emberAfPluginNetworkFindJoinCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
Join.
N/A | networkFound | Ver.: always |
N/A | lqi | Ver.: always |
N/A | rssi | Ver.: always |
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.
1715
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkFindGetEnergyThresholdForChannelCallback#
int8_t emberAfPluginNetworkFindGetEnergyThresholdForChannelCallback (uint8_t pgChan)
Get Energy Threshold For Channel.
N/A | pgChan | Ver.: always |
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.
1730
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkFindGetEnableScanningAllChannelsCallback#
bool emberAfPluginNetworkFindGetEnableScanningAllChannelsCallback (void )
Get Enable Scanning All Channels.
N/A |
Returns true is the fallback on scanning all channels is enabled, false if not.
1736
of file ./app/framework/test/headers/plugin-callback.doc
Network Steering Plugin Callbacks Documentation#
emberAfPluginNetworkSteeringCompleteCallback#
void emberAfPluginNetworkSteeringCompleteCallback (EmberStatus status, uint8_t totalBeacons, uint8_t joinAttempts, uint8_t finalState)
Complete.
N/A | status | On success this will be set to EMBER_SUCCESS to indicate a network was joined successfully. On failure this will be the status code of the last join or scan attempt. Ver.: always |
N/A | totalBeacons | The total number of 802.15.4 beacons that were heard, including beacons from different devices with the same PAN ID. Ver.: always |
N/A | joinAttempts | The number of join attempts that were made to get onto an open Zigbee network. Ver.: always |
N/A | finalState | The finishing state of the network steering process. From this, one is able to tell on which channel mask and with which key the process was complete. Ver.: always |
This callback is fired when the Network Steering plugin is complete.
1758
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback#
int8_t emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback (uint8_t channel)
Get Power For Radio Channel.
N/A | channel | The channel that the plugin is inquiring about the power level. Ver.: always |
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.
1771
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkSteeringGetDistributedKeyCallback#
bool emberAfPluginNetworkSteeringGetDistributedKeyCallback (EmberKeyData * key)
Get Distributed Key.
N/A | key | to the distributed key struct |
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
1782
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginNetworkSteeringGetNodeTypeCallback#
EmberNodeType emberAfPluginNetworkSteeringGetNodeTypeCallback (EmberAfPluginNetworkSteeringJoiningState state)
Get Node Type.
N/A | state | The current ::EmberAfPluginNetworkSteeringJoiningState. |
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.
1793
of file ./app/framework/test/headers/plugin-callback.doc
Occupancy PYD-1698 Plugin Callbacks Documentation#
halOccupancyStateChangedCallback#
void halOccupancyStateChangedCallback (HalOccupancyState occupancyState)
Occupancy state has changed.
N/A | occupancyState | The bitmap used to determine occupancy state. At present, only bit 0 is used and will be set to either HAL_OCCUPANCY_STATE_OCCUPIED or HAL_OCCUPANCY_STATE_UNOCCUPIED. |
This callback is called when the occupancy sensor state changes.
1808
of file ./app/framework/test/headers/plugin-callback.doc
Occupancy Sensor Server Cluster Plugin Callbacks Documentation#
emberAfPluginOccupancySensorServerOccupancyStateChangedCallback#
void emberAfPluginOccupancySensorServerOccupancyStateChangedCallback (HalOccupancyState occupancyState)
Occupancy state changed.
N/A | occupancyState | The bitmap used to determine occupancy state. At present, only bit 0 is used, and will be set to either HAL_OCCUPANCY_STATE_OCCUPIED or HAL_OCCUPANCY_STATE_UNOCCUPIED. Ver.: always |
This callback is generated when the occupancy measurement server receives a new occupancy status.
1824
of file ./app/framework/test/headers/plugin-callback.doc
On/Off Server Cluster Plugin Callbacks Documentation#
emberAfPluginOnOffClusterServerPostInitCallback#
void emberAfPluginOnOffClusterServerPostInitCallback (uint8_t endpoint)
On/off Cluster Server Post Init.
N/A | endpoint | Endpoint that is being initialized Ver.: always |
Following resolution of the On/Off state at startup for this endpoint, perform any additional initialization needed; e.g., synchronize hardware state.
1839
of file ./app/framework/test/headers/plugin-callback.doc
OTA Bootload Cluster Client Plugin Callbacks Documentation#
emberAfPluginOtaClientPreBootloadCallback#
void emberAfPluginOtaClientPreBootloadCallback (uint8_t srcEndpoint, uint8_t serverEndpoint, EmberNodeId serverNodeId)
Pre-Bootload Callback.
N/A | srcEndpoint | Ver.: always |
N/A | serverEndpoint | Ver.: always |
N/A | serverNodeId | Ver.: always |
Called shortly before installing the downloaded image.
1854
of file ./app/framework/test/headers/plugin-callback.doc
OTA Bootload Cluster Server Plugin Callbacks Documentation#
emberAfPluginOtaServerUpdateStartedCallback#
void emberAfPluginOtaServerUpdateStartedCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, uint8_t maxDataSize, uint32_t offset)
UpdateStarted.
N/A | manufacturerId | Ver.: always |
N/A | imageTypeId | Ver.: always |
N/A | firmwareVersion | Ver.: always |
N/A | maxDataSize | Ver.: always |
N/A | offset | Ver.: always |
Called when an OTA upgrade starts.
1873
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginOtaServerBlockSentCallback#
void emberAfPluginOtaServerBlockSentCallback (uint8_t actualLength, uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion)
OTA Server Block Sent Callback.
N/A | actualLength | Ver.: always |
N/A | manufacturerId | Ver.: always |
N/A | imageTypeId | Ver.: always |
N/A | firmwareVersion | Ver.: always |
This function will be called when a block is sent to a device.
1887
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginOtaServerUpdateCompleteCallback#
void emberAfPluginOtaServerUpdateCompleteCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, EmberNodeId source, uint8_t status)
OTA Server Update Complete Callback.
N/A | manufacturerId | ManufacturerId. |
N/A | imageTypeId | Image Type Id. |
N/A | firmwareVersion | Firmware Version. |
N/A | source | Source node id. |
N/A | status | Status of update. |
This function will be called when an OTA update has finished.
1901
of file ./app/framework/test/headers/plugin-callback.doc
emberAfOtaServerImageBlockRequestCallback#
uint8_t emberAfOtaServerImageBlockRequestCallback (EmberAfImageBlockRequestCallbackStruct * data)
Ota Server Image Block Request.
N/A | data | A struct containing the details of the image block response and values that can be returned by the application to effect the behavior of the server's response. |
This function is called when the server application receives an image block request by a client.
1915
of file ./app/framework/test/headers/plugin-callback.doc
OTA Bootload Cluster Server Policy Plugin Callbacks Documentation#
emberAfPluginOtaServerPolicyGetClientDelayUnits#
uint8_t emberAfPluginOtaServerPolicyGetClientDelayUnits (EmberNodeId clientNodeId, EmberEUI64 clientEui64)
GetClientDelayUnits.
N/A | clientNodeId | Ver.: always |
N/A | clientEui64 | Ver.: always |
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.
1940
of file ./app/framework/test/headers/plugin-callback.doc
OTA Simple Storage EEPROM Driver Plugin Callbacks Documentation#
emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback#
void emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback (bool success)
Erase Complete.
N/A | success | The result of the erase operation. Ver.: always |
This is called when an EEPROM erase operation has completed.
1954
of file ./app/framework/test/headers/plugin-callback.doc
Packet Handoff Plugin Callbacks Documentation#
emberAfIncomingPacketFilterCallback#
EmberPacketAction emberAfIncomingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t * packetData, uint8_t * size_p, void * data)
A protocol layer packet has been received by the stack.
N/A | packetType | The type of packet received. See EmberZigbeePacketType. |
N/A | packetData | A flat buffer containing the packet contents the buffer starts with the command id followed by the payload |
N/A | size_p | a pointer to the size of the packet data |
N/A | data | This is a pointer to auxiliary data for the command. |
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
1986
of file ./app/framework/test/headers/plugin-callback.doc
emberAfOutgoingPacketFilterCallback#
EmberPacketAction emberAfOutgoingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t * packetData, uint8_t * size_p, void * data)
The stack is preparing to send a protocol layer packet.
N/A | packetType | The type of packet received. See EmberZigbeePacketType. |
N/A | packetData | A flat buffer containing the packet contents the buffer starts with the command id followed by the payload |
N/A | size_p | a pointer to the size of the packet data |
N/A | data | This is a pointer to auxiliary data for the command. ZDO commands pass the EmberApsFrame associated with the packet here. Otherwise, this value is NULL. |
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
2017
of file ./app/framework/test/headers/plugin-callback.doc
Poll Control Server Cluster Plugin Callbacks Documentation#
emberAfPluginPollControlServerCheckInTimeoutCallback#
void emberAfPluginPollControlServerCheckInTimeoutCallback (void )
CheckInTimeout.
N/A |
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.
2033
of file ./app/framework/test/headers/plugin-callback.doc
Prepayment Server Plugin Callbacks Documentation#
emberAfPluginPrepaymentServerConsumerTopUpCallback#
bool emberAfPluginPrepaymentServerConsumerTopUpCallback (uint8_t originatingDevice, uint8_t * topUpCode)
Consumer Top Up.
N/A | originatingDevice | Ver.: always |
N/A | topUpCode | Ver.: always |
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.
2049
of file ./app/framework/test/headers/plugin-callback.doc
Price Client Plugin Callbacks Documentation#
emberAfPluginPriceClientPriceStartedCallback#
void emberAfPluginPriceClientPriceStartedCallback (EmberAfPluginPriceClientPrice * price)
Price Started.
N/A | price | The price that has started. Ver.: always |
This function is called by the Price client plugin whenever a price starts.
2063
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginPriceClientPriceExpiredCallback#
void emberAfPluginPriceClientPriceExpiredCallback (EmberAfPluginPriceClientPrice * price)
Price Expired.
N/A | price | The price that has expired. Ver.: always |
This function is called by the Price client plugin whenever a price expires.
2070
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginPriceClientPendingCppEventCallback#
uint8_t emberAfPluginPriceClientPendingCppEventCallback (uint8_t cppAuth)
Pending Cpp Event.
N/A | cppAuth | The CPP Auth status. Ver.: always |
This function is called by the Price client plugin when a CPP event is received with pending status.
2078
of file ./app/framework/test/headers/plugin-callback.doc
Price Server Plugin Callbacks Documentation#
emberAfPluginPriceServerNewActivePriceMatrixCallback#
void emberAfPluginPriceServerNewActivePriceMatrixCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfScheduledPriceMatrix * priceMatrix)
New Active Price Matrix.
N/A | priceCommonInfo | Ver.: always |
N/A | priceMatrix | Ver.: always |
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.
2097
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginPriceServerNewActiveTariffInformationCallback#
void emberAfPluginPriceServerNewActiveTariffInformationCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfScheduledTariff * priceTariffInfo)
New Active Tariff Information.
N/A | priceCommonInfo | Ver.: always |
N/A | priceTariffInfo | Ver.: always |
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.
2111
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback#
void emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfScheduledBlockThresholds * priceBlockThresholds)
New Active Block Thresholds Information.
N/A | priceCommonInfo | Ver.: always |
N/A | priceBlockThresholds | Ver.: always |
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.
2125
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback#
void emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback (const EmberAfPriceCommonInfo * priceCommonInfo, const EmberAfPriceBlockPeriod * priceBlockPeriods)
New Active Block Period Information.
N/A | priceCommonInfo | Ver.: always |
N/A | priceBlockPeriods | Ver.: always |
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.
2139
of file ./app/framework/test/headers/plugin-callback.doc
Reporting Plugin Callbacks Documentation#
emberAfPluginReportingConfiguredCallback#
EmberAfStatus emberAfPluginReportingConfiguredCallback (const EmberAfPluginReportingEntry * entry)
Configured.
N/A | entry | Ver.: always |
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.
2160
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginReportingGetDefaultReportingConfigCallback#
bool emberAfPluginReportingGetDefaultReportingConfigCallback (EmberAfPluginReportingEntry * entry)
Configured.
N/A | entry | Ver.: always |
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.
2173
of file ./app/framework/test/headers/plugin-callback.doc
RTOS Common Plugin Callbacks Documentation#
emberAfPluginRtosAppTask1InitCallback#
void emberAfPluginRtosAppTask1InitCallback (void )
This function is called from the RTOS Common plugin before the Application (1) task is created.
N/A |
2185
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginRtosAppTask1MainLoopCallback#
void emberAfPluginRtosAppTask1MainLoopCallback (void * p_arg)
This function implements the Application (1) task main loop.
N/A | p_arg | Ver.: always |
2192
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginRtosAppTask2InitCallback#
void emberAfPluginRtosAppTask2InitCallback (void )
This function is called from the RTOS Common plugin before the Application (2) task is created.
N/A |
2198
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginRtosAppTask2MainLoopCallback#
void emberAfPluginRtosAppTask2MainLoopCallback (void * p_arg)
This function implements the Application (2) task main loop.
N/A | p_arg | Ver.: always |
2205
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginRtosAppTask3InitCallback#
void emberAfPluginRtosAppTask3InitCallback (void )
This function is called from the RTOS Common plugin before the Application (3) task is created.
N/A |
2211
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginRtosAppTask3MainLoopCallback#
void emberAfPluginRtosAppTask3MainLoopCallback (void * p_arg)
This function implements the Application (3) task main loop.
N/A | p_arg | Ver.: always |
2218
of file ./app/framework/test/headers/plugin-callback.doc
SB1 Gesture Sensor Plugin Callbacks Documentation#
emberAfPluginSb1GestureSensorGestureReceivedCallback#
void emberAfPluginSb1GestureSensorGestureReceivedCallback (uint8_t gestureReceived, uint8_t switchNumber)
Called whenever the SB1 receives a gesture.
N/A | gestureReceived | The (enumerated) gesture received. |
N/A | switchNumber | The switch that received the gesture. |
2230
of file ./app/framework/test/headers/plugin-callback.doc
Scenes Server Cluster Plugin Callbacks Documentation#
emberAfPluginScenesServerCustomRecallSceneCallback#
bool emberAfPluginScenesServerCustomRecallSceneCallback (const EmberAfSceneTableEntry *const sceneEntry, uint16_t transitionTimeDs, EmberAfStatus *const status)
Scenes Server Custom Recall Scene.
N/A | sceneEntry | pointer to EmberAfSceneTableEntry for recalled scene Ver.: always |
N/A | transitionTimeDs | transition time in deci-seconds (1/10 sec) Ver.: always |
N/A | status | pointer to return EmberAfStatus Ver.: always |
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)
2287
of file ./app/framework/test/headers/plugin-callback.doc
Security Sensor Interface Plugin Callbacks Documentation#
emberAfPluginSecuritySensorStatusChangedCallback#
void emberAfPluginSecuritySensorStatusChangedCallback (uint16_t status)
Security sensor state changed.
N/A | status | bit new status |
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
2309
of file ./app/framework/test/headers/plugin-callback.doc
Simple Metering Client Plugin Callbacks Documentation#
emberAfPluginSimpleMeteringClientRequestMirrorCallback#
uint16_t emberAfPluginSimpleMeteringClientRequestMirrorCallback (EmberEUI64 requestingDeviceIeeeAddress)
Request Mirror.
N/A | requestingDeviceIeeeAddress | Ver.: always |
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.
2325
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginSimpleMeteringClientRemoveMirrorCallback#
uint16_t emberAfPluginSimpleMeteringClientRemoveMirrorCallback (EmberEUI64 requestingDeviceIeeeAddress)
Remove Mirror.
N/A | requestingDeviceIeeeAddress | Ver.: always |
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.
2335
of file ./app/framework/test/headers/plugin-callback.doc
Simple Metering Server Plugin Callbacks Documentation#
emberAfPluginSimpleMeteringServerProcessNotificationFlagsCallback#
void emberAfPluginSimpleMeteringServerProcessNotificationFlagsCallback (uint16_t attributeId, uint32_t attributeValue)
Process Notification Flags.
N/A | attributeId | Ver.: always |
N/A | attributeValue | Ver.: always |
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.
2351
of file ./app/framework/test/headers/plugin-callback.doc
Sleepy Message Queue Plugin Callbacks Documentation#
emberAfPluginSleepyMessageQueueMessageTimedOutCallback#
void emberAfPluginSleepyMessageQueueMessageTimedOutCallback (uint8_t sleepyMsgId)
Message Timed Out.
N/A | sleepyMsgId | Ver.: always |
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.
2367
of file ./app/framework/test/headers/plugin-callback.doc
Standalone Bootloader Client Plugin Callbacks Documentation#
emberAfPluginStandaloneBootloaderClientAllowIncomingMessageCallback#
bool emberAfPluginStandaloneBootloaderClientAllowIncomingMessageCallback (EmberEUI64 sourceEui64, uint8_t command)
Allow Incoming Message.
N/A | sourceEui64 | The EUI64 of the sending node. Ver.: always |
N/A | command | The incoming command ID Ver.: always |
Allows the application to control whether the plugin can respond to incoming bootload messages.
2382
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginStandaloneBootloaderClientAllowBootloadLaunchCallback#
bool emberAfPluginStandaloneBootloaderClientAllowBootloadLaunchCallback (EmberEUI64 sourceEui64)
Allow Bootload Launch.
N/A | sourceEui64 | The EUI64 of the node requesting the bootload. Ver.: always |
This function is a callback when the client is being told to launch the standalone bootloader. This is done after authentication has completed successfully.
2393
of file ./app/framework/test/headers/plugin-callback.doc
Standalone Bootloader Common Plugin Callbacks Documentation#
emberAfPluginStandaloneBootloaderCommonIncomingMessageCallback#
bool emberAfPluginStandaloneBootloaderCommonIncomingMessageCallback (EmberEUI64 longId, uint8_t length, uint8_t * message)
Incoming Message.
N/A | longId | The sender's EUI64 address Ver.: always |
N/A | length | The length of the incoming message. Ver.: always |
N/A | message | The array of bytes for the message. Ver.: always |
Indicates an Ember Bootload message has been received by the Standalone Bootloader Common plugin.
2409
of file ./app/framework/test/headers/plugin-callback.doc
Standalone Bootloader Server Plugin Callbacks Documentation#
emberAfPluginStandaloneBootloaderServerQueryResponseCallback#
void emberAfPluginStandaloneBootloaderServerQueryResponseCallback (bool queryWasBroadcast, const EmberAfStandaloneBootloaderQueryResponseData * queryData)
Query Response.
N/A | queryWasBroadcast | Boolean indicating whether the query was broadcast or unicast Ver.: always |
N/A | queryData | A data structure providing the details about the local device's bootloader. Ver.: always |
Allows the application to control whether the plugin can respond to incoming bootload messages.
2428
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginStandaloneBootloaderServerFinishedCallback#
void emberAfPluginStandaloneBootloaderServerFinishedCallback (bool success)
Finished.
N/A | success | Boolean indicating the success or failure of the bootload. Ver.: always |
Notifies the application when the standalone bootload has completed, successfully or otherwise.
2438
of file ./app/framework/test/headers/plugin-callback.doc
Sub-GHz Client Plugin Callbacks Documentation#
emberAfPluginSubGhzSuspendZclMessagesCallback#
bool emberAfPluginSubGhzSuspendZclMessagesCallback (uint8_t period)
Sub-GHz Cluster Suspend ZCL Messages.
N/A | period | suspend period in minutes |
'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
2457
of file ./app/framework/test/headers/plugin-callback.doc
Sub-GHz Server Plugin Callbacks Documentation#
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.
N/A | channelPage | the channel that registered a Duty Cycle state change |
N/A | channel | current Duty Cycle mode |
N/A | oldState | the previous Duty Cycle state |
N/A | newState | the current Duty Cycle state |
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.
2480
of file ./app/framework/test/headers/plugin-callback.doc
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.
N/A | channelPage | ........ current channel page |
N/A | channel | ............ current channel |
N/A | macTxUcastTotal | .... total number of Mac Tx transaction attempts |
N/A | macTxUcastFailures | . total number of Mac Tx transaction failures |
N/A | macTxUcastRetries | .. total number of Mac Tx transaction retries |
N/A | period | ............. time in minutes over which macTxUcastXxx were measured |
'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.
2500
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginSubGhzGetSuspendZclMessagesStatusCallback#
bool emberAfPluginSubGhzGetSuspendZclMessagesStatusCallback (void )
Sub-GHz Cluster Get Suspend ZCL Messages Status.
N/A |
'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
2518
of file ./app/framework/test/headers/plugin-callback.doc
Tamper Switch Interface Plugin Callbacks Documentation#
emberAfPluginTamperSwitchTamperActiveCallback#
void emberAfPluginTamperSwitchTamperActiveCallback (void )
Tamper is active.
N/A |
This function is called whenever the tamper switch detects that it has entered the enclosure, thereby activating tamper monitoring.
2531
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTamperSwitchTamperAlarmCallback#
void emberAfPluginTamperSwitchTamperAlarmCallback (void )
Tamper alarm.
N/A |
This function is called when the plugin detects that the enclosure has been opened.
2538
of file ./app/framework/test/headers/plugin-callback.doc
Temperature Measurement Server Cluster Plugin Callbacks Documentation#
emberAfPluginTemperatureMeasurementServerOverTemperatureCallback#
void emberAfPluginTemperatureMeasurementServerOverTemperatureCallback (uint8_t previousState, uint8_t newState)
Over temperature state changed.
N/A | previousState | state prior to the state change |
N/A | newState | new state of the state change |
This callback is generated when the temperature rises over the assert thresholds (warning and critical) or drops below the deassert thresholds (warning and critical)
EMBER_TEMPERATURE_MEASUREMENT_SERVER_OVER_TEMPERATURE_NORMAL : normal state EMBER_TEMPERATURE_MEASUREMENT_SERVER_OVER_TEMPERATURE_WARNING : warning state EMBER_TEMPERATURE_MEASUREMENT_SERVER_OVER_TEMPERATURE_CRITICAL : critical state
Ver.: always
2561
of file ./app/framework/test/headers/plugin-callback.doc
Gateway MQTT Transport Plugin Callbacks Documentation#
emberAfPluginTransportMqttStateChangedCallback#
void emberAfPluginTransportMqttStateChangedCallback (EmberAfPluginTransportMqttState state)
MQTT client state is changed.
N/A | state | Contains the new and current EmberAfPluginTransportMqttState state. |
This function is called when the state of the MQTT client changes.
2577
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTransportMqttMessageArrivedCallback#
bool emberAfPluginTransportMqttMessageArrivedCallback (const char * topic, const char * payload)
MQTT message arrived.
N/A | topic | A string containing the topic for the message that arrived. While the underlying MQTT libraries allow NULL characters in a topic, NULL characters are not supported in this implementation so the |
N/A | payload | A string containing the payload for the message that arrived. |
This function is called when the MQTT client for the gateway receives an incoming message on a topic. If the message is processed by the application, return true. If the message is not processed, return false. This function is called on a separate thread, so no stack calls should be made within the implementation of this function. Instead, use a global variable in that function to communicate the message arrival to a stack event or timer running from the main loop.
2594
of file ./app/framework/test/headers/plugin-callback.doc
Trust Center Keepalive Plugin Callbacks Documentation#
emberAfPluginTrustCenterKeepaliveTimeoutCallback#
bool emberAfPluginTrustCenterKeepaliveTimeoutCallback (void )
Timeout.
N/A |
This function is called by the Trust Center Keepalive plugin when the Trust Center fails to acknowledge enough keepalive messages. Upon timing out, the Trust Center Keepalive plugin code will initiate a search for a new Trust Center, which falls in line with the Trust Center Swapout feature. Applications may consume this callback and have it return true in order to prevent the Trust Center Keepalive plugin code from issuing a Trust Center (insecure) rejoin. Doing so will also give the application a chance to implement its own rejoin algorithm or logic. If this callback returns false, the Trust Center Keepalive plugin code will proceed with issuing a Trust Center rejoin.
2615
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTrustCenterKeepaliveConnectivityEstablishedCallback#
void emberAfPluginTrustCenterKeepaliveConnectivityEstablishedCallback (void )
ConnectivityEstablished This function is called by the Trust Center Keepalive plugin when a read attribute response command from the trust center is received after trust center connectivity had previously been lost. This function is also called after a match descriptor response.
N/A |
2622
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback#
bool emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback (void )
Serverless Keep Alive Supported This function is called by the Trust Center Keep Alive plugin when service discovery receives a response indicating that the server does not support the cluster. Applications may consume this callback and have it return true in order to have the Trust Center Keep Alive plugin code to still start the keep alive process even if the server cluster is not discovered. If this callback returns false, the Trust Center Keep Alive plugin code will only proceed to start the process in case the service discovery was succesful.
N/A |
2633
of file ./app/framework/test/headers/plugin-callback.doc
emberAfTrustCenterKeepaliveOverwriteDefaultTimingCallback#
bool emberAfTrustCenterKeepaliveOverwriteDefaultTimingCallback (uint16_t * baseTimeSeconds, uint16_t * jitterTimeSeconds)
Overwrite Default Timing Parameters This function is called by the Trust Center Keep Alive plugin when the Trust Center Keep Alive process is started. Applications may consume this callback and have it return true in order to have the Trust Center Keep Alive plugin code to start the keep alive process with timing parameters other than the default values. If this callback returns false, the Trust Center Keep Alive plugin code will proceed to start with the default timing parameters.
N/A | baseTimeSeconds | time for keep alive signalling to be set in seconds |
N/A | jitterTimeSeconds | time for keep alive signalling to be set in seconds |
2647
of file ./app/framework/test/headers/plugin-callback.doc
emberAfTrustCenterKeepaliveServerlessIsEnabledCallback#
bool emberAfTrustCenterKeepaliveServerlessIsEnabledCallback (void )
Serverless Keep Alive Enabled This function is called by the Trust Center Keep Alive plugin when a service discovery is done, a response has arrived and emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback() returned true. Applications may consume this callback and have it return true in order to have the Trust Center Keep Alive plugin code to start the keep alive process right away. If this callback returns false, the Trust Center Keep Alive plugin code will return to the disabled state waiting to be enabled.
N/A |
2657
of file ./app/framework/test/headers/plugin-callback.doc
Tunneling Client Cluster Plugin Callbacks Documentation#
emberAfPluginTunnelingClientTunnelOpenedCallback#
void emberAfPluginTunnelingClientTunnelOpenedCallback (uint8_t tunnelIndex, EmberAfPluginTunnelingClientStatus tunnelStatus, uint16_t maximumIncomingTransferSize)
Tunnel Opened.
N/A | tunnelIndex | The index of the tunnel that has been opened. Ver.: always |
N/A | tunnelStatus | The status of the request. Ver.: always |
N/A | maximumIncomingTransferSize | The maximum incoming transfer size of the server. Ver.: always |
This function is called by the Tunneling client plugin whenever a tunnel is opened. Clients may open tunnels by sending a Request Tunnel command.
2675
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingClientDataReceivedCallback#
void emberAfPluginTunnelingClientDataReceivedCallback (uint8_t tunnelIndex, uint8_t * data, uint16_t dataLen)
Data Received.
N/A | tunnelIndex | The index of the tunnel through which the data was received. Ver.: always |
N/A | data | Buffer containing the raw octets of the data. Ver.: always |
N/A | dataLen | The length in octets of the data. Ver.: always |
This function is called by the Tunneling client plugin whenever data is received from a server through a tunnel.
2688
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingClientDataErrorCallback#
void emberAfPluginTunnelingClientDataErrorCallback (uint8_t tunnelIndex, EmberAfTunnelingTransferDataStatus transferDataStatus)
Data Error.
N/A | tunnelIndex | The index of the tunnel on which this data error occurred. Ver.: always |
N/A | transferDataStatus | The error that occurred. Ver.: always |
This function is called by the Tunneling client plugin whenever a data error occurs on a tunnel. Errors occur if a device attempts to send data on tunnel that is no longer active or if the tunneling does not belong to the device.
2701
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingClientTunnelClosedCallback#
void emberAfPluginTunnelingClientTunnelClosedCallback (uint8_t tunnelIndex)
Tunnel Closed.
N/A | tunnelIndex | The index of the tunnel that has been closed. Ver.: always |
This function is called by the Tunneling client plugin whenever a server sends a notification that it preemptively closed an inactive tunnel. Servers are not required to notify clients of tunnel closures, so applications cannot rely on this callback being called for all tunnels.
2713
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingClientTransferDataFailureCallback#
void emberAfPluginTunnelingClientTransferDataFailureCallback (uint16_t indexOfDestination, EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status)
Transfer Data Failure.
N/A | indexOfDestination | The index or destination address of the TransferData command. Ver.: always |
N/A | apsFrame | The EmberApsFrame of the command. Ver.: always |
N/A | msgLen | The length of the payload sent in the command. Ver.: always |
N/A | message | The payload that was sent in the command. Ver.: always |
N/A | status | The non-success status code from the transmission of the command. Ver.: always |
This function is called when a TransferData command fails to be sent to the intended destination.
2727
of file ./app/framework/test/headers/plugin-callback.doc
Tunneling Server Cluster Plugin Callbacks Documentation#
emberAfPluginTunnelingServerIsProtocolSupportedCallback#
bool emberAfPluginTunnelingServerIsProtocolSupportedCallback (uint8_t protocolId, uint16_t manufacturerCode)
Is Protocol Supported.
N/A | protocolId | The identifier of the metering communication protocol for which the tunnel is requested. Ver.: always |
N/A | manufacturerCode | The manufacturer code for manufacturer-defined protocols or 0xFFFF in unused. Ver.: always |
This function is called by the Tunneling server plugin whenever a Request Tunnel command is received. The application should return true if the protocol is supported and false otherwise.
2749
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingServerTunnelOpenedCallback#
void emberAfPluginTunnelingServerTunnelOpenedCallback (uint16_t tunnelIndex, uint8_t protocolId, uint16_t manufacturerCode, bool flowControlSupport, uint16_t maximumIncomingTransferSize)
Tunnel Opened.
N/A | tunnelIndex | The index to the tunnel table entry that has been opened. Ver.: always |
N/A | protocolId | The identifier of the metering communication protocol for the tunnel. Ver.: always |
N/A | manufacturerCode | The manufacturer code for manufacturer-defined protocols or 0xFFFF in unused. Ver.: always |
N/A | flowControlSupport | true is flow control support is requested or false if it is not. Ver.: always |
N/A | maximumIncomingTransferSize | The maximum incoming transfer size of the client. Ver.: always |
This function is called by the Tunneling server plugin whenever a tunnel is opened. Clients may open tunnels by sending a Request Tunnel command.
2767
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingServerDataReceivedCallback#
void emberAfPluginTunnelingServerDataReceivedCallback (uint16_t tunnelIndex, uint8_t * data, uint16_t dataLen)
Data Received.
N/A | tunnelIndex | The identifier of the tunnel through which the data was received. Ver.: always |
N/A | data | Buffer containing the raw octets of the data. Ver.: always |
N/A | dataLen | The length in octets of the data. Ver.: always |
This function is called by the Tunneling server plugin whenever data is received from a client through a tunnel.
2782
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingServerDataErrorCallback#
void emberAfPluginTunnelingServerDataErrorCallback (uint16_t tunnelIndex, EmberAfTunnelingTransferDataStatus transferDataStatus)
Data Error.
N/A | tunnelIndex | The identifier of the tunnel on which this data error occurred. Ver.: always |
N/A | transferDataStatus | The error that occurred. Ver.: always |
This function is called by the Tunneling server plugin whenever a data error occurs on a tunnel. Errors occur if a device attempts to send data on tunnel that is no longer active or if the tunneling does not belong to the device.
2795
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginTunnelingServerTunnelClosedCallback#
void emberAfPluginTunnelingServerTunnelClosedCallback (uint16_t tunnelIndex, bool clientInitiated)
Tunnel Closed.
N/A | tunnelIndex | The identifier of the tunnel that has been closed. Ver.: always |
N/A | clientInitiated | true if the client initiated the closing of the tunnel or false if the server closed the tunnel due to inactivity. Ver.: always |
This function is called by the Tunneling server plugin whenever a tunnel is closed. Clients may close tunnels by sending a Close Tunnel command. The server can preemptively close inactive tunnels after a timeout.
2809
of file ./app/framework/test/headers/plugin-callback.doc
Update TC Link Key Plugin Callbacks Documentation#
emberAfPluginUpdateTcLinkKeyStatusCallback#
void emberAfPluginUpdateTcLinkKeyStatusCallback (EmberKeyStatus keyStatus)
Status.
N/A | keyStatus | An EmberKeyStatus value describing the success or failure of the key exchange process. Ver.: always |
This callback is fired when the Update Link Key exchange process is updated with a status from the stack. Implementations will know that the Update TC Link Key plugin has completed its link key request when the keyStatus parameter is EMBER_VERIFY_LINK_KEY_SUCCESS.
2827
of file ./app/framework/test/headers/plugin-callback.doc
ZCL Framework Core Plugin Callbacks Documentation#
emberAfPluginZclFrameworkCoreEzspErrorCallback#
bool emberAfPluginZclFrameworkCoreEzspErrorCallback (EzspStatus status)
EZSP Error Handler.
N/A | status | The EzspStatus error code received. |
This callback is fired when the host process receives an error from the EZSP link when talking to the NCP. The return boolean gives the user application the option to reboot the NCP. If this function returns true, the NCP will be rebooted and the connection between the host and NCP will drop. If not, the NCP will continue operating.
Returns
bool True to reset NCP, false not to.
Note
This callback is only fired on the host application. It has no use for SoC or NCP applications.
2849
of file ./app/framework/test/headers/plugin-callback.doc
ZLL Commissioning Client Plugin Callbacks Documentation#
emberAfPluginZllCommissioningClientTouchLinkFailedCallback#
void emberAfPluginZllCommissioningClientTouchLinkFailedCallback (EmberAfZllCommissioningStatus status)
Touch Link Failed.
N/A | status | The reason the touch link failed. Ver.: always |
This function is called by the ZLL Commissioning Client plugin if touch linking fails.
2863
of file ./app/framework/test/headers/plugin-callback.doc
ZLL Commissioning Common Plugin Callbacks Documentation#
emberAfPluginZllCommissioningCommonInitialSecurityStateCallback#
void emberAfPluginZllCommissioningCommonInitialSecurityStateCallback (EmberZllInitialSecurityState * securityState)
Initial Security State.
N/A | securityState | The security configuration to be populated by the application and ultimately set in the stack. Ver.: always |
This function is called by the ZLL Commissioning Common plugin to determine the initial security state to be used by the device. The application must populate the ::EmberZllInitialSecurityState structure with a configuration appropriate for the network being formed, joined, or started. Once the device forms, joins, or starts a network, the same security configuration will remain in place until the device leaves the network.
2882
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginZllCommissioningCommonTouchLinkCompleteCallback#
void emberAfPluginZllCommissioningCommonTouchLinkCompleteCallback (const EmberZllNetwork * networkInfo, uint8_t deviceInformationRecordCount, const EmberZllDeviceInfoRecord * deviceInformationRecordList)
Touch Link Complete.
N/A | networkInfo | The ZigBee and ZLL-specific information about the network and target. Ver.: always |
N/A | deviceInformationRecordCount | The number of sub-device information records for the target. Ver.: always |
N/A | deviceInformationRecordList | The list of sub-device information records for the target. Ver.: always |
This function is called by the ZLL Commissioning Common plugin when touch linking completes.
2895
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginZllCommissioningCommonResetToFactoryNewCallback#
void emberAfPluginZllCommissioningCommonResetToFactoryNewCallback (void )
Reset To Factory New.
N/A |
This function is called by the ZLL Commissioning Common plugin when a request to reset to factory new is received. The plugin will leave the network, reset attributes managed by the framework to their default values, and clear the group and scene tables. The application should perform any other necessary reset-related operations in this callback, including resetting any externally-stored attributes.
2908
of file ./app/framework/test/headers/plugin-callback.doc
ZLL Commissioning Network Plugin Callbacks Documentation#
emberAfPluginZllCommissioningNetworkJoinCallback#
bool emberAfPluginZllCommissioningNetworkJoinCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
Join.
N/A | networkFound | Ver.: always |
N/A | lqi | Ver.: always |
N/A | rssi | Ver.: always |
This callback is called by the ZLL Commissioning Network 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. Note that this callback is not called during touch linking.
2928
of file ./app/framework/test/headers/plugin-callback.doc
ZLL Commissioning Server Plugin Callbacks Documentation#
emberAfPluginZllCommissioningServerGroupIdentifierCountCallback#
uint8_t emberAfPluginZllCommissioningServerGroupIdentifierCountCallback (uint8_t endpoint)
Group Identifier Count.
N/A | endpoint | The endpoint for which the group identifier count is requested. Ver.: always |
This function is called by the ZLL Commissining Server plugin to determine the number of group identifiers in use by a specific endpoint on the device. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.
2947
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginZllCommissioningServerGroupIdentifierCallback#
bool emberAfPluginZllCommissioningServerGroupIdentifierCallback (uint8_t endpoint, uint8_t index, EmberAfPluginZllCommissioningGroupInformationRecord * record)
Group Identifier.
N/A | endpoint | The endpoint for which the group identifier is requested. Ver.: always |
N/A | index | The index of the group on the endpoint. Ver.: always |
N/A | record | The group information record. Ver.: always |
This function is called by the ZLL Commissining Server plugin to obtain information about the group identifiers in use by a specific endpoint on the device. The application should populate the record with information about the group identifier and return true. If no information is available for the given endpoint and index, the application should return false.
2961
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginZllCommissioningServerEndpointInformationCountCallback#
uint8_t emberAfPluginZllCommissioningServerEndpointInformationCountCallback (uint8_t endpoint)
Endpoint Information Count.
N/A | endpoint | The local endpoint for which the remote endpoint information count is requested. Ver.: always |
This function is called by the ZLL Commissining Server plugin to determine the number of remote endpoints controlled by a specific endpoint on the local device.
2973
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginZllCommissioningServerEndpointInformationCallback#
bool emberAfPluginZllCommissioningServerEndpointInformationCallback (uint8_t endpoint, uint8_t index, EmberAfPluginZllCommissioningEndpointInformationRecord * record)
Endpoint Information.
N/A | endpoint | The local endpoint for which the remote endpoint information is requested. Ver.: always |
N/A | index | The index of the remote endpoint information on the local endpoint. Ver.: always |
N/A | record | The endpoint information record. Ver.: always |
This function is called by the ZLL Commissining Server plugin to obtain information about the remote endpoints controlled by a specific endpoint on the local device. The application should populate the record with information about the remote endpoint and return true. If no information is available for the given endpoint and index, the application should return false.
2989
of file ./app/framework/test/headers/plugin-callback.doc
emberAfPluginZllCommissioningServerIdentifyCallback#
void emberAfPluginZllCommissioningServerIdentifyCallback (uint16_t durationS)
Identify.
N/A | durationS | If the duration is zero, the device should exit identify mode. If the duration is 0xFFFF, the device should remain in identify mode for the default time. Otherwise, the duration specifies the length of time in seconds that the device should remain in identify mode. Ver.: always |
This function is called by the ZLL Commissining Server plugin to notify the application that it should take an action to identify itself. This typically occurs when an Identify Request is received via inter-PAN messaging.
3003
of file ./app/framework/test/headers/plugin-callback.doc
ZLL On/Off Server Cluster Enhancements Plugin Callbacks Documentation#
emberAfPluginZllOnOffServerOffWithEffectCallback#
EmberAfStatus emberAfPluginZllOnOffServerOffWithEffectCallback (uint8_t endpoint, uint8_t effectId, uint8_t effectVariant)
Off With Effect.
N/A | endpoint | Ver.: always |
N/A | effectId | Ver.: always |
N/A | effectVariant | Ver.: always |
This callback is called by the ZLL On/Off Server plugin whenever an OffWithEffect command is received. The application should implement the effect and variant requested in the command and return EMBER_ZCL_STATUS_SUCCESS if successful or an appropriate error status otherwise.
3022
of file ./app/framework/test/headers/plugin-callback.doc