OTA Client#

API and Callbacks for the OTA Cluster Client Component.

Silicon Labs implementation of the Zigbee Over-the-air Bootload Client Cluster (a multi-hop, application bootloader). This implementation finds the OTA server in the network, periodically queries the server for a new image to download, downloads the data, and then waits for the server command to tell it to upgrade. Optionally, it can cryptographically verify the image before upgrade.

Modules#

OTA Client

API#

void

sl_zigbee_af_ota_server_send_upgrade_request()

Set whether OTA clients use non TC servers.

void

sl_zigbee_af_ota_client_set_ignore_non_trust_center(bool ignoreNonTc)

Set whether OTA clients use non TC servers.

bool

sl_zigbee_af_ota_client_get_ignore_non_trust_center()

Return the current value of ignoreNonTrustCenter for OTA clients.

void

sl_zigbee_af_set_disable_ota_downgrades(bool isDisabled)

Set whether OTA Clients will permit firmware downgrades.

bool

sl_zigbee_af_get_disable_ota_downgrades()

Return the current value of disableOtaDowngrades.

Variables#

uint8_t

sli_zigbee_af_ota_client_stop_download_percentage

Macros#

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_DOWNLOAD_DELAY_MS 0L

#define

SL_ZIGBEE_AF_OTA_SERVER_DISCOVERY_DELAY_MS (2 * MINUTES_IN_MS)

#define

SL_ZIGBEE_AF_OTA_QUERY_DELAY_MS (5 * MINUTES_IN_MS)

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_QUERY_ERROR_THRESHOLD 10

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_DOWNLOAD_ERROR_THRESHOLD 10

#define

SL_ZIGBEE_AF_RUN_UPGRADE_REQUEST_DELAY_MS (10 * MINUTES_IN_MS)

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_UPGRADE_WAIT_THRESHOLD 10

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_PAGE_REQUEST_SIZE 1024

#define

SL_ZIGBEE_AF_OTA_CLIENT_PAGE_REQUEST_SPACING_MS 50L

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_VERIFY_DELAY_MS 10L

#define

NULL_EUI64 { 0, 0, 0, 0, 0, 0, 0, 0 }

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_SIGNER_EUI0 NULL_EUI64

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_SIGNER_EUI1 NULL_EUI64

#define

SL_ZIGBEE_AF_PLUGIN_OTA_CLIENT_SIGNER_EUI2 NULL_EUI64

#define

SECONDS_IN_MS (1000L)

#define

MINUTES_IN_MS (60 * SECONDS_IN_MS)

#define

HOURS_IN_MS (60 * MINUTES_IN_MS)

#define

SL_ZIGBEE_AF_INVALID_HARDWARE_VERSION 0xFFFF

API Documentation#

sl_zigbee_af_ota_server_send_upgrade_request#

void sl_zigbee_af_ota_server_send_upgrade_request ( IgnoreNonTc)

Set whether OTA clients use non TC servers.

Parameters

Type	Direction	Argument Name	Description
	N/A	IgnoreNonTc	a bool determining whether client should ignore any non Trust Center OTA servers

Sets the behavior of OTA clients when determining whether or not to use non Trust Center OTA servers and abort any download that is in progress.

sl_zigbee_af_ota_client_set_ignore_non_trust_center#

void sl_zigbee_af_ota_client_set_ignore_non_trust_center (bool ignoreNonTc)

Set whether OTA clients use non TC servers.

Parameters

Type	Direction	Argument Name	Description
bool	N/A	ignoreNonTc	a bool determining whether client should ignore any non Trust Center OTA servers

Sets the behavior of OTA clients when determining whether or not to use non Trust Center OTA servers and abort any download that is in progress.

sl_zigbee_af_ota_client_get_ignore_non_trust_center#

bool sl_zigbee_af_ota_client_get_ignore_non_trust_center ()

Return the current value of ignoreNonTrustCenter for OTA clients.

sl_zigbee_af_set_disable_ota_downgrades#

void sl_zigbee_af_set_disable_ota_downgrades (bool isDisabled)

Set whether OTA Clients will permit firmware downgrades.

Parameters

Type	Direction	Argument Name	Description
bool	N/A	isDisabled	A bool value indicating whether or not downgrades will be disabled

sl_zigbee_af_get_disable_ota_downgrades#

bool sl_zigbee_af_get_disable_ota_downgrades ()

Return the current value of disableOtaDowngrades.

Variable Documentation#

sli_zigbee_af_ota_client_stop_download_percentage#

uint8_t sli_zigbee_af_ota_client_stop_download_percentage