Structure, enum, default values, and API prototypes for the OTA bootload client plugin. More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	tr_ota_server_info_t

struct	tr_ota_client_info_t

Macros
#define	TR_OTA_UPGRADE_QUERY_DELAY_MIN 5

#define	TR_OTA_UPGRADE_MAX_DATA_SIZE 64

#define	tr_ota_upgrade_client_printf(...)

#define	tr_ota_upgrade_client_println(...)

Enumerations
enum	tr_ota_upgrade_client_state_t { TR_OTA_UPGRADE_STATE_IDLE , TR_OTA_UPGRADE_STATE_IN_PROGRESS , TR_OTA_UPGRADE_STATE_RESUME }

Functions
void	tr_over_the_air_bootloading_client_version_cb (zb_uint8_t endpoint, zb_uint32_t fw_version, zb_uint16_t mfg_id, zb_uint16_t image_type, zb_uint16_t hw_version)
	Callback fires to allow app to provide information for a query next image request.

void	tr_over_the_air_bootloading_client_upgrade_start_cb (zb_uint32_t image_version, zb_uint32_t image_size)
	Callback fires to notify app that OTA download is about to start.

void	tr_over_the_air_bootloading_client_server_not_found_cb (void)
	Callback fires to alert app that an OTA upgrade server was not found.

void	tr_over_the_air_bootloading_client_init_cb (void)
	Callback fires when the OTA upgrade client is initialized.

zb_bool_t	tr_over_the_air_bootloading_client_image_notify_cb (void)
	Callback fires when an OTA upgrade image notifiy is received.

zb_bool_t	tr_over_the_air_bootloading_client_query_next_image_resp_cb (zb_uint32_t fw_version, zb_uint16_t image_type, zb_uint16_t mfg_id)
	Callback fires to allow app to decide if an image should be downloaded.

zb_bool_t	tr_over_the_air_bootloading_client_upgrade_end_resp_cb (void)
	Callback fires to allow app.

tr_ota_server_info_t *	tr_ota_upgrade_client_get_server_info (void)
	API to get the OTA server info.

tr_ota_client_info_t *	tr_ota_upgrade_client_get_client_info (void)
	API to get the OTA client info.

void	zb_zcl_ota_upgrade_stop_client (void)
	API to stop the OTA upgrade client.

void	zb_zcl_ota_upgrade_pause_client (void)
	API to pause the OTA upgrade client.

void	tr_over_the_air_bootloading_client_connection_state_cb (tr_conn_state_e conn_state)

void	tr_ota_init (zb_uint8_t param)

void	tr_over_the_air_bootloading_client_init (void)

Detailed Description

Structure, enum, default values, and API prototypes for the OTA bootload client plugin.

SPDX-License-Identifier: LicenseRef-TridentMSLA SPDX-FileCopyrightText: 2025 Trident IoT, LLC https://www.tridentiot.com

Macro Definition Documentation

◆ tr_ota_upgrade_client_printf

#define tr_ota_upgrade_client_printf ( ... )

debug prints

◆ tr_ota_upgrade_client_println

#define tr_ota_upgrade_client_println ( ... )

◆ TR_OTA_UPGRADE_MAX_DATA_SIZE

#define TR_OTA_UPGRADE_MAX_DATA_SIZE 64

◆ TR_OTA_UPGRADE_QUERY_DELAY_MIN

#define TR_OTA_UPGRADE_QUERY_DELAY_MIN 5

Enumeration Type Documentation

◆ tr_ota_upgrade_client_state_t

enum tr_ota_upgrade_client_state_t

Enumerator
TR_OTA_UPGRADE_STATE_IDLE
TR_OTA_UPGRADE_STATE_IN_PROGRESS
TR_OTA_UPGRADE_STATE_RESUME

Function Documentation

◆ tr_ota_init()

void tr_ota_init ( zb_uint8_t param )

◆ tr_over_the_air_bootloading_client_connection_state_cb()

void tr_over_the_air_bootloading_client_connection_state_cb ( tr_conn_state_e conn_state )

function prototypes consumed by framework

◆ tr_over_the_air_bootloading_client_init()

void tr_over_the_air_bootloading_client_init ( void )

Trident IoT Zigbee SDK

Data Structures

Macros

Enumerations

Functions