Over the Air Bootloading client Callbacks

Collaboration diagram for Over the Air Bootloading client Callbacks:

Functions
void	tr_over_the_air_bootloading_client_init_cb (zb_uint8_t endpoint)
	Callback fires when the Over the Air Bootloading client cluster plugin is initialized.
zb_bool_t	tr_over_the_air_bootloading_client_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Over the Air Bootloading client commands.
void	tr_over_the_air_bootloading_client_write_attr_cb (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value, zb_uint16_t manuf_code)
	Callback fires when an Over the Air Bootloading client attribute is about to be written.
zb_bool_t	tr_over_the_air_bootloading_client_image_notify_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t payload_type, zb_uint8_t query_jitter, zb_uint16_t manufacturer_id, zb_uint16_t image_type, zb_uint32_t new_file_version)
	Callback that user can declare to handle over the air bootloading cluster image notify command.
zb_bool_t	tr_over_the_air_bootloading_client_query_next_image_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t manufacturer_id, zb_uint16_t image_type, zb_uint32_t file_version, zb_uint32_t image_size)
	Callback that user can declare to handle over the air bootloading cluster query next image response command.
zb_bool_t	tr_over_the_air_bootloading_client_image_block_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t manufacturer_id, zb_uint16_t image_type, zb_uint32_t file_version, zb_uint32_t file_offset, zb_uint8_t data_size, zb_uint8_t *image_data)
	Callback that user can declare to handle over the air bootloading cluster image block response command.
zb_bool_t	tr_over_the_air_bootloading_client_upgrade_end_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t manufacturer_id, zb_uint16_t image_type, zb_uint32_t file_version, zb_uint32_t current_time, zb_uint32_t upgrade_time)
	Callback that user can declare to handle over the air bootloading cluster upgrade end response command.
zb_bool_t	tr_over_the_air_bootloading_client_query_specific_file_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t manufacturer_id, zb_uint16_t image_type, zb_uint32_t file_version, zb_uint32_t image_size)
	Callback that user can declare to handle over the air bootloading cluster query specific file response command.
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 that user can declare to override image upgrade parameters.
void	tr_over_the_air_bootloading_client_upgrade_start_cb (zb_uint32_t image_version, zb_uint32_t image_size, zb_uint32_t starting_offset)
	Callback fires to notify the application that an OTA download is about to start.
void	tr_over_the_air_bootloading_client_mfg_tag_found_cb (tr_zcl_over_the_air_bootloading_sub_element_t *tag_header)
	Callback fires when a file is fully downloaded and verified, and has manufacturer specific tags.
zb_bool_t	tr_over_the_air_bootloading_client_check_for_zigbee_upgrade_cb (zb_uint32_t downloaded_fw_version)
	Callback to allow the application to determine if the zigbee firmware needs to be upgraded.
void	tr_over_the_air_bootloading_client_server_not_found_cb (void)
	Callback to notify the application that no ota upgrade server was found.

Detailed Description

---

---

Function Documentation

tr_over_the_air_bootloading_client_check_for_zigbee_upgrade_cb()

zb_bool_t tr_over_the_air_bootloading_client_check_for_zigbee_upgrade_cb

(

zb_uint32_t

downloaded_fw_version

)

Callback to allow the application to determine if the zigbee firmware needs to be upgraded.

Parameters

downloaded_fw_version

version of the downloaded file

Returns

ZB_TRUE if zigbee is to be upgraded, ZB_FALSE if not

tr_over_the_air_bootloading_client_command_received_cb()

zb_bool_t tr_over_the_air_bootloading_client_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

Callback that user can declare to handle any Over the Air Bootloading client commands.

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_over_the_air_bootloading_client_image_block_response_cb()

zb_bool_t tr_over_the_air_bootloading_client_image_block_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	manufacturer_id,
		zb_uint16_t	image_type,
		zb_uint32_t	file_version,
		zb_uint32_t	file_offset,
		zb_uint8_t	data_size,
		zb_uint8_t *	image_data )

Callback that user can declare to handle over the air bootloading cluster image block response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	status of the image block response
manufacturer_id	manufacturer id of the firmware image
image_type	image type of the firmware image
file_version	version of the firmware image
file_offset	offset in bytes into the firmware image
data_size	number of bytes included in this image block response
image_data	firmware image bytes in this image block response

Returns

ZB_FALSE to allow framework to continue processing the command

tr_over_the_air_bootloading_client_image_notify_cb()

zb_bool_t tr_over_the_air_bootloading_client_image_notify_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	payload_type,
		zb_uint8_t	query_jitter,
		zb_uint16_t	manufacturer_id,
		zb_uint16_t	image_type,
		zb_uint32_t	new_file_version )

Callback that user can declare to handle over the air bootloading cluster image notify command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
payload_type	payload type for the image notify command
query_jitter	jitter value used to determine which devices respond to this image notify
manufacturer_id	manufacturer id that this image notify applies to IF specified by the payload type
image_type	image type that this image notify applies to IF specified by the payload type
new_file_version	version of the availble upgrade file IF specified by the payload type

Returns

ZB_FALSE to allow framework to continue processing the command

tr_over_the_air_bootloading_client_init_cb()

void tr_over_the_air_bootloading_client_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Over the Air Bootloading client cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_over_the_air_bootloading_client_mfg_tag_found_cb()

void tr_over_the_air_bootloading_client_mfg_tag_found_cb

(

tr_zcl_over_the_air_bootloading_sub_element_t *

tag_header

)

Callback fires when a file is fully downloaded and verified, and has manufacturer specific tags.

Parameters

tag_header

pointer to the manufacturer specific tag found

tr_over_the_air_bootloading_client_query_next_image_response_cb()

zb_bool_t tr_over_the_air_bootloading_client_query_next_image_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	manufacturer_id,
		zb_uint16_t	image_type,
		zb_uint32_t	file_version,
		zb_uint32_t	image_size )

Callback that user can declare to handle over the air bootloading cluster query next image response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	status of the query next image response
manufacturer_id	manufacturer id of the available firmware image
image_type	image type of the available firmware image
file_version	version of the available firmware image
image_size	size in bytes of the available firmware image

Returns

ZB_FALSE to allow framework to continue processing the command

tr_over_the_air_bootloading_client_query_specific_file_response_cb()

zb_bool_t tr_over_the_air_bootloading_client_query_specific_file_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	manufacturer_id,
		zb_uint16_t	image_type,
		zb_uint32_t	file_version,
		zb_uint32_t	image_size )

Callback that user can declare to handle over the air bootloading cluster query specific file response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	status of the query specific file response
manufacturer_id	manufacturer id of the firmware image
image_type	image type of the firmware image
file_version	version of the firmware image
image_size	size in bytes of the firmware image

Returns

ZB_FALSE to allow framework to continue processing the command

tr_over_the_air_bootloading_client_server_not_found_cb()

void tr_over_the_air_bootloading_client_server_not_found_cb

(

void

)

Callback to notify the application that no ota upgrade server was found.

tr_over_the_air_bootloading_client_upgrade_end_response_cb()

zb_bool_t tr_over_the_air_bootloading_client_upgrade_end_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	manufacturer_id,
		zb_uint16_t	image_type,
		zb_uint32_t	file_version,
		zb_uint32_t	current_time,
		zb_uint32_t	upgrade_time )

Callback that user can declare to handle over the air bootloading cluster upgrade end response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
manufacturer_id	manufacturer id of the firmware image
image_type	image type of the firmware image
file_version	version of the firmware image
current_time	current time as noted by the over the air bootloading server
upgrade_time	upgraded time requested by the over the air bootloading server

Returns

ZB_FALSE to allow framework to continue processing the command

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,
		zb_uint32_t	starting_offset )

Callback fires to notify the application that an OTA download is about to start.

Parameters

image_version	FW version of new image
image_size	size of new image
starting_offset	file offset the upgrade is starting at (non-zero value indicates resuming upgrade)

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 that user can declare to override image upgrade parameters.

Parameters

endpoint	device endpoint
fw_version	pointer used for returning the device firmware version, value is preset to attribute value
mfg_id	pointer used for returning the manufacturer id, value is preset to attribute value
image_type	pointer used for returning the image type, value is preset to attribute value
hw_version	pointer used for returning the hardware version, value is preset to attribute value

tr_over_the_air_bootloading_client_write_attr_cb()

void tr_over_the_air_bootloading_client_write_attr_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	attr_id,
		zb_uint8_t *	new_value,
		zb_uint16_t	manuf_code )

Callback fires when an Over the Air Bootloading client attribute is about to be written.

Parameters

endpoint	device endpoint
attr_id	ZCL attribute id
new_value	pointer to the new attribute value
manuf_code	manufacturer specific code