Bootloader
EmberZNet Stack API Reference

EmberZNet bootload API.

Functions

EmberStatus emberSendBootloadMessage (bool broadcast, EmberEUI64 destEui64, EmberMessageBuffer message)
 Transmits 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.
 
void emberIncomingBootloadMessageHandler (EmberEUI64 longId, EmberMessageBuffer message)
 A callback 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.
 
void emberBootloadTransmitCompleteHandler (EmberMessageBuffer message, EmberStatus status)
 A callback 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.

Detailed Description

EmberZNet bootload API.

See bootload.h for source code.

Function Documentation

◆ emberBootloadTransmitCompleteHandler()

void emberBootloadTransmitCompleteHandler ( EmberMessageBuffer  message,
EmberStatus  status 
)

A callback 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.

Parameters
messageThe message that was sent.
statusEMBER_SUCCESS if the transmission was successful, or EMBER_DELIVERY_FAILED if not.

◆ emberIncomingBootloadMessageHandler()

void emberIncomingBootloadMessageHandler ( EmberEUI64  longId,
EmberMessageBuffer  message 
)

A callback 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.

Parameters
longIdThe EUI64 of the sending node.
messageThe bootload message that was sent.

◆ emberSendBootloadMessage()

EmberStatus emberSendBootloadMessage ( bool  broadcast,
EmberEUI64  destEui64,
EmberMessageBuffer  message 
)

Transmits 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.

Parameters
broadcastIf true, the destination address and PAN ID are both set to the broadcast address.
destEui64The EUI64 of the target node. Ignored if the broadcast field is set to true.
messageThe bootloader message to send.
Returns
EMBER_SUCCESS if the message was successfully submitted to the transmit queue, and EMBER_ERR_FATAL otherwise.