Over the Air Bootloading client APIs

Collaboration diagram for Over the Air Bootloading client APIs:

Functions
tr_over_the_air_bootloading_server_info_t *	tr_over_the_air_bootloading_client_get_server_info (void)
	API to get the OTA server info.
tr_over_the_air_bootloading_client_info_t *	tr_over_the_air_bootloading_client_get_client_info (void)
	API to get the OTA client info.
tr_zcl_over_the_air_bootloading_sub_element_t *	tr_over_the_air_bootloading_client_find_tag_header (zb_uint16_t tag_id)
	API to locate a specific tag header in the ota file that is in flash.
tr_zcl_over_the_air_bootloading_file_header_t *	tr_over_the_air_bootloading_client_get_ota_header (void)
	API to return a pointer to the downloaded OTA file header.
void	tr_over_the_air_bootloading_client_stop (void)
	API to stop the OTA upgrade client.
void	tr_over_the_air_bootloading_client_start (void)
	API to start the OTA upgrade client.

Detailed Description

---

---

Function Documentation

tr_over_the_air_bootloading_client_find_tag_header()

tr_zcl_over_the_air_bootloading_sub_element_t * tr_over_the_air_bootloading_client_find_tag_header

(

zb_uint16_t

tag_id

)

API to locate a specific tag header in the ota file that is in flash.

Parameters

tag_id

the tag id to look for

Returns

pointer to the tag sub element header

tr_over_the_air_bootloading_client_get_client_info()

tr_over_the_air_bootloading_client_info_t * tr_over_the_air_bootloading_client_get_client_info

(

void

)

API to get the OTA client info.

Returns

pointer to client info structure

tr_over_the_air_bootloading_client_get_ota_header()

tr_zcl_over_the_air_bootloading_file_header_t * tr_over_the_air_bootloading_client_get_ota_header

(

void

)

API to return a pointer to the downloaded OTA file header.

Returns

Pointer to the OTA file header

tr_over_the_air_bootloading_client_get_server_info()

tr_over_the_air_bootloading_server_info_t * tr_over_the_air_bootloading_client_get_server_info

(

void

)

API to get the OTA server info.

Returns

pointer to server info structure

tr_over_the_air_bootloading_client_start()

void tr_over_the_air_bootloading_client_start

(

void

)

API to start the OTA upgrade client.

tr_over_the_air_bootloading_client_stop()

void tr_over_the_air_bootloading_client_stop

(

void

)

API to stop the OTA upgrade client.