Bootloader#
EmberZNet bootload API.
See bootload.h for source code.
Functions#
Transmit the given bootload message to a neighboring node using a specific 802.15.4 header that allows the EmberZNet stack and the Ember bootloader to recognize the message but will not interfere with other Zigbee stacks.
Invoked by the EmberZNet stack when a bootload message is received. If the application includes emberIncomingBootloadMessageHandler(), it must define EMBER_APPLICATION_HAS_BOOTLOAD_HANDLERS in its CONFIGURATION_HEADER.
Invoked by the EmberZNet stack when the MAC has finished transmitting a bootload message. If the application includes this callback, it must define EMBER_APPLICATION_HAS_BOOTLOAD_HANDLERS in its CONFIGURATION_HEADER.
Function Documentation#
emberSendBootloadMessage#
EmberStatus emberSendBootloadMessage (bool broadcast, EmberEUI64 destEui64, EmberMessageBuffer message)
Transmit the given bootload message to a neighboring node using a specific 802.15.4 header that allows the EmberZNet stack and the Ember bootloader to recognize the message but will not interfere with other Zigbee stacks.
N/A | broadcast | If true, the destination address and PAN ID are both set to the broadcast address. |
N/A | destEui64 | The EUI64 of the target node. Ignored if the broadcast field is set to true. |
N/A | message | The bootloader message to send. |
Returns
EMBER_SUCCESS if the message was successfully submitted to the transmit queue, and EMBER_ERR_FATAL otherwise.
43
of file stack/include/bootload.h
emberIncomingBootloadMessageHandler#
void emberIncomingBootloadMessageHandler (EmberEUI64 longId, EmberMessageBuffer message)
Invoked by the EmberZNet stack when a bootload message is received. If the application includes emberIncomingBootloadMessageHandler(), it must define EMBER_APPLICATION_HAS_BOOTLOAD_HANDLERS in its CONFIGURATION_HEADER.
N/A | longId | The EUI64 of the sending node. |
N/A | message | The bootload message that was sent. |
56
of file stack/include/bootload.h
emberBootloadTransmitCompleteHandler#
void emberBootloadTransmitCompleteHandler (EmberMessageBuffer message, EmberStatus status)
Invoked by the EmberZNet stack when the MAC has finished transmitting a bootload message. If the application includes this callback, it must define EMBER_APPLICATION_HAS_BOOTLOAD_HANDLERS in its CONFIGURATION_HEADER.
N/A | message | The message that was sent. |
N/A | status | EMBER_SUCCESS if the transmission was successful, or EMBER_DELIVERY_FAILED if not. |
68
of file stack/include/bootload.h