See Bootloader for documentation.

License#

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.

/***************************************************************************/
#ifndef SILABS_BOOTLOAD_H
#define SILABS_BOOTLOAD_H

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

void emberIncomingBootloadMessageHandler(EmberEUI64 longId,
                                         EmberMessageBuffer message);

void emberBootloadTransmitCompleteHandler(EmberMessageBuffer message,
                                          EmberStatus status);

#endif // SILABS_BOOTLOAD_H

Functions#

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.

Function Documentation#

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
N/Abroadcast

If true, the destination address and PAN ID are both set to the broadcast address.

N/AdestEui64

The EUI64 of the target node. Ignored if the broadcast field is set to true.

N/Amessage

The bootloader message to send.

Returns


Definition at line 43 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/bootload.h

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
N/AlongId

The EUI64 of the sending node.

N/Amessage

The bootload message that was sent.


Definition at line 56 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/bootload.h

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
N/Amessage

The message that was sent.

N/Astatus

EMBER_SUCCESS if the transmission was successful, or EMBER_DELIVERY_FAILED if not.


Definition at line 68 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/bootload.h