Bluetooth Mesh Standalone Updater#

sl_btmesh_fw_standalone_updater_init#

sl_status_t sl_btmesh_fw_standalone_updater_init (uint16_t elem_index, uint16_t max_node_list_size)

Initializes the Standalone Updater. Before initializing the Standalone Updater, the Update Client and MBT Client models on the same element must be initialized.

The Distribution Server is not supported on the same element at the same time.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_deinit#

sl_status_t sl_btmesh_fw_standalone_updater_deinit (uint16_t elem_index)

Deinitializes the Standalone Updater. The corresponding Update Client and MBT Client models can be deinitialized before or after this model.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_setup#

sl_status_t sl_btmesh_fw_standalone_updater_setup (uint16_t elem_index, uint32_t fw_size, sl_bt_uuid_64_t blob_id, size_t fwid_len, const uint8_t * fwid)

Set up parameters for a firmware distribution

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_set_metadata#

sl_status_t sl_btmesh_fw_standalone_updater_set_metadata (uint16_t elem_index, size_t metadata_len, const uint8_t * metadata)

Set the metadata of the image to be distributed. Should be called after the sl_btmesh_fw_standalone_updater_setup command. Cannot be called after the distribution is started.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_set_multicast_threshold#

sl_status_t sl_btmesh_fw_standalone_updater_set_multicast_threshold (uint16_t elem_index, uint16_t multicast_threshold)

Set the multicast threshold value.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_add_receiver#

sl_status_t sl_btmesh_fw_standalone_updater_add_receiver (uint16_t elem_index, uint16_t address, uint8_t fw_index)

Add a receiver to the distribution

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_delete_all_receivers#

sl_status_t sl_btmesh_fw_standalone_updater_delete_all_receivers (uint16_t elem_index)

Clears the list of receivers

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_start#

sl_status_t sl_btmesh_fw_standalone_updater_start (uint16_t elem_index, uint16_t dist_appkey_index, uint8_t dist_ttl, uint16_t dist_timeout_base, uint8_t transfer_mode, uint16_t group_address, uuid_128 virtual_address)

Start the firmware image distribution. The command sl_btmesh_fw_standalone_updater_execute_distribution_step is used to progress through the procedures.

The Receivers List must have been populated via the sl_btmesh_fw_standalone_updater_add_receiver command. The distribution parameters must have been set via the sl_btmesh_fw_standalone_updater_setup and sl_btmesh_fw_standalone_updater_set_metadata commands.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_fw_standalone_updater_dist_state_changed

• sl_btmesh_evt_fw_standalone_updater_node_failed

sl_btmesh_fw_standalone_updater_execute_distribution_step#

sl_status_t sl_btmesh_fw_standalone_updater_execute_distribution_step (uint16_t elem_index)

Execute the next action for the distribution state machine. Must be repeated by the application if the Target Nodes do not respond in a timely manner. Calling this function sends out the necessary messages to all nodes that have not responded. Note that the distribution step dist_step_transferring_image is executed via the MBT Client API, and thus the command does not need to be called in that state.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_apply#

sl_status_t sl_btmesh_fw_standalone_updater_apply (uint16_t elem_index)

Enter the apply step after the distribution is in the "verification complete" step. The Standalone Updater can proceed to the apply step immediately after the verification is complete. This state transition exists only for keeping the API as similar as possible to the Distribution Server. The execute_distribution_step command must be called to send out the Update Apply messages.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_get_state#

sl_status_t sl_btmesh_fw_standalone_updater_get_state (uint16_t elem_index, uint8_t * state, uint16_t * total_nodes, uint16_t * num_active_nodes)

Get the current state of the distribution process. If an error is returned, the other return values should be ignored.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_get_node_status_by_index#

sl_status_t sl_btmesh_fw_standalone_updater_get_node_status_by_index (uint16_t elem_index, uint16_t entry_index, uint16_t * address, uint8_t * retrieved_phase, uint8_t * update_server_status, uint8_t * mbt_server_status, uint8_t * transfer_progress, uint8_t * fw_index)

Retrieve information about the ongoing update on a node

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_get_node_status_by_address#

sl_status_t sl_btmesh_fw_standalone_updater_get_node_status_by_address (uint16_t elem_index, uint16_t node_address, uint16_t * address, uint8_t * retrieved_phase, uint8_t * update_server_status, uint8_t * mbt_server_status, uint8_t * transfer_progress, uint8_t * fw_index)

Retrieve information about the ongoing update by a node address

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_fw_standalone_updater_cancel#

sl_status_t sl_btmesh_fw_standalone_updater_cancel (uint16_t elem_index)

Cancel a distribution process and clear any information about receivers. If the current distribution was not started, or it is completed or failed, a transition to the idle state will be made immediately. If the receivers need to be informed about the cancellation, a transition to the cancelling state will be made. The sl_btmesh_fw_standalone_updater_execute_distribution_step function should be called to send out the cancellation messages to the receivers.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_cmd_fw_standalone_updater_init_id#

#define sl_btmesh_cmd_fw_standalone_updater_init_id

0x005a0028

sl_btmesh_cmd_fw_standalone_updater_deinit_id#

#define sl_btmesh_cmd_fw_standalone_updater_deinit_id

0x015a0028

sl_btmesh_cmd_fw_standalone_updater_setup_id#

#define sl_btmesh_cmd_fw_standalone_updater_setup_id

0x025a0028

sl_btmesh_cmd_fw_standalone_updater_set_metadata_id#

#define sl_btmesh_cmd_fw_standalone_updater_set_metadata_id

0x035a0028

sl_btmesh_cmd_fw_standalone_updater_set_multicast_threshold_id#

#define sl_btmesh_cmd_fw_standalone_updater_set_multicast_threshold_id

0x045a0028

sl_btmesh_cmd_fw_standalone_updater_add_receiver_id#

#define sl_btmesh_cmd_fw_standalone_updater_add_receiver_id

0x055a0028

sl_btmesh_cmd_fw_standalone_updater_delete_all_receivers_id#

#define sl_btmesh_cmd_fw_standalone_updater_delete_all_receivers_id

0x065a0028

sl_btmesh_cmd_fw_standalone_updater_start_id#

#define sl_btmesh_cmd_fw_standalone_updater_start_id

0x075a0028

sl_btmesh_cmd_fw_standalone_updater_execute_distribution_step_id#

#define sl_btmesh_cmd_fw_standalone_updater_execute_distribution_step_id

0x085a0028

sl_btmesh_cmd_fw_standalone_updater_apply_id#

#define sl_btmesh_cmd_fw_standalone_updater_apply_id

0x095a0028

sl_btmesh_cmd_fw_standalone_updater_get_state_id#

#define sl_btmesh_cmd_fw_standalone_updater_get_state_id

0x0a5a0028

sl_btmesh_cmd_fw_standalone_updater_get_node_status_by_index_id#

#define sl_btmesh_cmd_fw_standalone_updater_get_node_status_by_index_id

0x0b5a0028

sl_btmesh_cmd_fw_standalone_updater_get_node_status_by_address_id#

#define sl_btmesh_cmd_fw_standalone_updater_get_node_status_by_address_id

0x0c5a0028

sl_btmesh_cmd_fw_standalone_updater_cancel_id#

#define sl_btmesh_cmd_fw_standalone_updater_cancel_id

0x0d5a0028

sl_btmesh_rsp_fw_standalone_updater_init_id#

#define sl_btmesh_rsp_fw_standalone_updater_init_id

0x005a0028

sl_btmesh_rsp_fw_standalone_updater_deinit_id#

#define sl_btmesh_rsp_fw_standalone_updater_deinit_id

0x015a0028

sl_btmesh_rsp_fw_standalone_updater_setup_id#

#define sl_btmesh_rsp_fw_standalone_updater_setup_id

0x025a0028

sl_btmesh_rsp_fw_standalone_updater_set_metadata_id#

#define sl_btmesh_rsp_fw_standalone_updater_set_metadata_id

0x035a0028

sl_btmesh_rsp_fw_standalone_updater_set_multicast_threshold_id#

#define sl_btmesh_rsp_fw_standalone_updater_set_multicast_threshold_id

0x045a0028

sl_btmesh_rsp_fw_standalone_updater_add_receiver_id#

#define sl_btmesh_rsp_fw_standalone_updater_add_receiver_id

0x055a0028

sl_btmesh_rsp_fw_standalone_updater_delete_all_receivers_id#

#define sl_btmesh_rsp_fw_standalone_updater_delete_all_receivers_id

0x065a0028

sl_btmesh_rsp_fw_standalone_updater_start_id#

#define sl_btmesh_rsp_fw_standalone_updater_start_id

0x075a0028

sl_btmesh_rsp_fw_standalone_updater_execute_distribution_step_id#

#define sl_btmesh_rsp_fw_standalone_updater_execute_distribution_step_id

0x085a0028

sl_btmesh_rsp_fw_standalone_updater_apply_id#

#define sl_btmesh_rsp_fw_standalone_updater_apply_id

0x095a0028

sl_btmesh_rsp_fw_standalone_updater_get_state_id#

#define sl_btmesh_rsp_fw_standalone_updater_get_state_id

0x0a5a0028

sl_btmesh_rsp_fw_standalone_updater_get_node_status_by_index_id#

#define sl_btmesh_rsp_fw_standalone_updater_get_node_status_by_index_id

0x0b5a0028

sl_btmesh_rsp_fw_standalone_updater_get_node_status_by_address_id#

#define sl_btmesh_rsp_fw_standalone_updater_get_node_status_by_address_id

0x0c5a0028

sl_btmesh_rsp_fw_standalone_updater_cancel_id#

#define sl_btmesh_rsp_fw_standalone_updater_cancel_id

0x0d5a0028