Over the Air Bootloading Client Callbacks

Collaboration diagram for Over the Air Bootloading Client Callbacks:

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.

Detailed Description

---

---

Function Documentation

tr_over_the_air_bootloading_client_image_notify_cb()

zb_bool_t tr_over_the_air_bootloading_client_image_notify_cb

(

void

)

Callback fires when an OTA upgrade image notifiy is received.

Returns

ZB_TRUE to allow image notify to be processed by the plugin, ZB_FALSE if app handled it

tr_over_the_air_bootloading_client_init_cb()

void tr_over_the_air_bootloading_client_init_cb

(

void

)

Callback fires when the OTA upgrade client is initialized.

tr_over_the_air_bootloading_client_query_next_image_resp_cb()

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.

Parameters

fw_version	FW version from the server
image_type	Image type from the server
mfg_id	Mfg ID form the server

Returns

ZB_TRUE to allow plugin to process query next image response, ZB_FALSE if app handled it

tr_over_the_air_bootloading_client_server_not_found_cb()

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.

tr_over_the_air_bootloading_client_upgrade_end_resp_cb()

zb_bool_t tr_over_the_air_bootloading_client_upgrade_end_resp_cb

(

void

)

Callback fires to allow app.

Returns

ZB_TRUE to allow plugin to process upgrade end response, ZB_FALSE if app handled it

tr_over_the_air_bootloading_client_upgrade_start_cb()

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.

Parameters

image_version	FW version of new image
image_size	size of new image

tr_over_the_air_bootloading_client_version_cb()

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.

Parameters

endpoint	device endpoint
fw_version	pointer used to return FW version
mfg_id	pointer used to return manufacturer id
image_type	pointer used to return image type
hw_version	pointer used to return hardware version