Bluetooth Mesh BLOB Transfer Client Model#

sl_btmesh_mbt_client_server_status_t#

sl_btmesh_mbt_client_server_status_t

The MBT Server Status.

sl_btmesh_mbt_client_transfer_mode_t#

sl_btmesh_mbt_client_transfer_mode_t

The MBT Transfer modes.

sl_btmesh_mbt_client_init#

sl_status_t sl_btmesh_mbt_client_init (uint16_t elem_index, uint16_t max_servers, uint16_t max_blocks, uint16_t max_chunks_per_block)

Initialize the MBT Client.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_mbt_client_setup#

sl_status_t sl_btmesh_mbt_client_setup (uint16_t elem_index, sl_bt_uuid_64_t blob_id, uint32_t blob_size, uint16_t appkey_index, uint8_t ttl, uint16_t timeout_base, uint8_t supported_transfer_modes, uint16_t group_address, uuid_128 virtual_address, uint16_t multicast_threshold, size_t servers_len, const uint8_t * servers)

Set up a new BLOB transfer.

This is the first step in starting a transfer. Basic information of the BLOB and the transfer are defined with this command.

After setting up a transfer, the information of the servers should be queried with sl_btmesh_mbt_client_query_information.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_mbt_client_query_information#

sl_status_t sl_btmesh_mbt_client_query_information (uint16_t elem_index)

Query MBT Server information.

After setting up a new BLOB transfer with sl_btmesh_mbt_client_setup, the server information needs to be queried with this command. The received query result for each server is carried in a separate sl_btmesh_evt_mbt_client_server_information_status event. This information should be used by the application to determine the size of blocks in which the BLOB is divided when transmitting, and the size of chunks in which each block is divided.

The sl_btmesh_evt_mbt_client_query_information_complete event indicates that all servers have responded to the query. If this is not received in a timely manner, the query may be resent by calling this command again.

After the information query is successfully completed, the BLOB transfer should be initiated with sl_btmesh_mbt_client_start_transfer.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_mbt_client_server_information_status

• sl_btmesh_evt_mbt_client_query_information_complete

sl_btmesh_mbt_client_get_server_status#

sl_status_t sl_btmesh_mbt_client_get_server_status (uint16_t elem_index, uint16_t server_index, uint16_t * server_address, uint8_t * current_procedure_status, uint16_t * rx_blocks, uint16_t * rx_chunks)

Check the status of a MBT Server participating in the transfer, as recorded in the Client's internal bookkeeping.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_mbt_client_add_server#

sl_status_t sl_btmesh_mbt_client_add_server (uint16_t elem_index, uint16_t server_address)

Add MBT Server. Server can be added after calling sl_btmesh_mbt_client_setup and before calling sl_btmesh_mbt_client_query_information.

Returns

• SL_STATUS_OK if successful. SL_STATUS_BT_MESH_LIMIT_REACHED if the configured maximun storage has been reached. SL_STATUS_INVALID_STATE if invalid state, as proper call time for this API specified within the description of the API. SL_STATUS_BT_MESH_DOES_NOT_EXIST if the MBT Client model does not exist within the element specifed by the input parameter.

sl_btmesh_mbt_client_start_transfer#

sl_status_t sl_btmesh_mbt_client_start_transfer (uint16_t elem_index, uint8_t block_size_log, uint8_t transfer_mode)

Initiate the BLOB transfer.

After receiving sl_btmesh_evt_mbt_client_query_information_complete event, the BLOB transfer should be initiated by this command. Each server's response is carried in a separate sl_btmesh_evt_mbt_client_server_transfer_status event.

The sl_btmesh_evt_mbt_client_start_transfer_complete event indicates that all servers have responded to this command. If this is not received in a timely manner, the initiation request may be resent by calling this command again.

After the transfer start is successfully completed, the first block should be started with sl_btmesh_mbt_client_start_block.

When the transfer is eventually complete, the sl_btmesh_evt_mbt_client_transfer_complete event is emitted.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_mbt_client_server_transfer_status

• sl_btmesh_evt_mbt_client_start_transfer_complete

• sl_btmesh_evt_mbt_client_transfer_complete

sl_btmesh_mbt_client_start_block#

sl_status_t sl_btmesh_mbt_client_start_block (uint16_t elem_index, uint16_t chunk_size, uint16_t * block_number, uint32_t * block_size)

Initiate block start.

After receiving sl_btmesh_evt_mbt_client_start_transfer_complete event in the beginning of the transfer, or sl_btmesh_evt_mbt_client_query_block_status_complete event indicating the previous block is complete, the next incomplete block should be started by this command. Each server's response is carried in in a separate sl_btmesh_evt_mbt_client_server_block_status event.

The sl_btmesh_evt_mbt_client_start_block_complete event indicates that all servers have responded to this command. If this is not received in a timely manner, the initiation request may be resent by calling this command again.

After the block start is successfully completed, the MBT Client starts sending chunks to the servers. The data to send is requested from the application via sl_btmesh_evt_mbt_client_send_chunk_request events.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_mbt_client_server_block_status

• sl_btmesh_evt_mbt_client_start_block_complete

• sl_btmesh_evt_mbt_client_send_chunk_request

sl_btmesh_mbt_client_send_chunk_request_rsp#

sl_status_t sl_btmesh_mbt_client_send_chunk_request_rsp (uint16_t elem_index, size_t data_len, const uint8_t * data)

Provide requested chunk data.

This command is used to provide the chunk data requested by the MBT Client in a sl_btmesh_evt_mbt_client_send_chunk_request event.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_mbt_client_query_block_status#

sl_status_t sl_btmesh_mbt_client_query_block_status (uint16_t elem_index)

Query the current block status.

After receiving sl_btmesh_evt_mbt_client_send_chunks_complete, the block statuses of the MBT Servers should be queried to determine if any chunks are still missing. Each server's response is carried in a separate sl_btmesh_evt_mbt_client_server_block_status event.

The sl_btmesh_evt_mbt_client_query_block_status_complete event indicates that all servers have responded to this command. If this is not received in a timely manner, the block status query may be resent by calling this command again.

After the block status query is successfully completed, but some servers still have chunks missing, the MBT Client starts resending those automatically. See sl_btmesh_evt_mbt_client_query_block_status_complete for more information.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_mbt_client_server_block_status

• sl_btmesh_evt_mbt_client_query_block_status_complete

• sl_btmesh_evt_mbt_client_send_chunk_request

sl_btmesh_mbt_client_get_status#

sl_status_t sl_btmesh_mbt_client_get_status (uint16_t elem_index, uint8_t * state, uint16_t * total_blocks, uint16_t * total_chunks)

Get the status of the current transfer.

This command returns the MBT Client's current state and the status of each server in the current transfer.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_mbt_client_get_transfer_status#

sl_status_t sl_btmesh_mbt_client_get_transfer_status (uint16_t elem_index, uint16_t server_address, uuid_128 virtual_address, uint16_t appkey_index, uint8_t ttl)

Get the transfer status of an MBT Server.

This command can be used to check whether an MBT Server (or several, if a group address is used) is already taking part in a transfer. This command does not need to be used when executing a transfer.

The sl_btmesh_evt_mbt_client_server_transfer_status event contains the status response received from the server.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_mbt_client_server_transfer_status

sl_btmesh_mbt_client_cancel_transfer#

sl_status_t sl_btmesh_mbt_client_cancel_transfer (uint16_t elem_index)

Cancel a transfer.

This command may be used to cancel a transfer at any point after it has been set up with the sl_btmesh_mbt_client_setup command. Each server's response is carried in a separate sl_btmesh_evt_mbt_client_server_transfer_status event.

The sl_btmesh_evt_mbt_client_transfer_complete event indicates that all servers have responded to the cancellation. If this is not received in a timely manner, the cancellation may be retried by calling this command again.

After the transfer is successfully canceled, a new transfer may be set up with the sl_btmesh_mbt_client_setup command.

It's also possible to use this for canceling a previous transfer on a list of MBT Servers in order to start a new one. In this case, the cancel would be issued right after setting up the transfer with the ID of the BLOB to be canceled.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_btmesh_evt_mbt_client_server_transfer_status

• sl_btmesh_evt_mbt_client_transfer_complete

sl_btmesh_mbt_client_abort#

sl_status_t sl_btmesh_mbt_client_abort (uint16_t elem_index)

Abort a previously set up BLOB transfer.

Abort a transfer and clear the Client's state. Note that this function does not inform the Servers that the Client has aborted the transfer.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_cmd_mbt_client_init_id#

#define sl_btmesh_cmd_mbt_client_init_id

0x09280028

sl_btmesh_cmd_mbt_client_setup_id#

#define sl_btmesh_cmd_mbt_client_setup_id

0x00280028

sl_btmesh_cmd_mbt_client_query_information_id#

#define sl_btmesh_cmd_mbt_client_query_information_id

0x01280028

sl_btmesh_cmd_mbt_client_get_server_status_id#

#define sl_btmesh_cmd_mbt_client_get_server_status_id

0x0d280028

sl_btmesh_cmd_mbt_client_add_server_id#

#define sl_btmesh_cmd_mbt_client_add_server_id

0x0e280028

sl_btmesh_cmd_mbt_client_start_transfer_id#

#define sl_btmesh_cmd_mbt_client_start_transfer_id

0x02280028

sl_btmesh_cmd_mbt_client_start_block_id#

#define sl_btmesh_cmd_mbt_client_start_block_id

0x03280028

sl_btmesh_cmd_mbt_client_send_chunk_request_rsp_id#

#define sl_btmesh_cmd_mbt_client_send_chunk_request_rsp_id

0x04280028

sl_btmesh_cmd_mbt_client_query_block_status_id#

#define sl_btmesh_cmd_mbt_client_query_block_status_id

0x05280028

sl_btmesh_cmd_mbt_client_get_status_id#

#define sl_btmesh_cmd_mbt_client_get_status_id

0x06280028

sl_btmesh_cmd_mbt_client_get_transfer_status_id#

#define sl_btmesh_cmd_mbt_client_get_transfer_status_id

0x0a280028

sl_btmesh_cmd_mbt_client_cancel_transfer_id#

#define sl_btmesh_cmd_mbt_client_cancel_transfer_id

0x0b280028

sl_btmesh_cmd_mbt_client_abort_id#

#define sl_btmesh_cmd_mbt_client_abort_id

0x0c280028

sl_btmesh_rsp_mbt_client_init_id#

#define sl_btmesh_rsp_mbt_client_init_id

0x09280028

sl_btmesh_rsp_mbt_client_setup_id#

#define sl_btmesh_rsp_mbt_client_setup_id

0x00280028

sl_btmesh_rsp_mbt_client_query_information_id#

#define sl_btmesh_rsp_mbt_client_query_information_id

0x01280028

sl_btmesh_rsp_mbt_client_get_server_status_id#

#define sl_btmesh_rsp_mbt_client_get_server_status_id

0x0d280028

sl_btmesh_rsp_mbt_client_add_server_id#

#define sl_btmesh_rsp_mbt_client_add_server_id

0x0e280028

sl_btmesh_rsp_mbt_client_start_transfer_id#

#define sl_btmesh_rsp_mbt_client_start_transfer_id

0x02280028

sl_btmesh_rsp_mbt_client_start_block_id#

#define sl_btmesh_rsp_mbt_client_start_block_id

0x03280028

sl_btmesh_rsp_mbt_client_send_chunk_request_rsp_id#

#define sl_btmesh_rsp_mbt_client_send_chunk_request_rsp_id

0x04280028

sl_btmesh_rsp_mbt_client_query_block_status_id#

#define sl_btmesh_rsp_mbt_client_query_block_status_id

0x05280028

sl_btmesh_rsp_mbt_client_get_status_id#

#define sl_btmesh_rsp_mbt_client_get_status_id

0x06280028

sl_btmesh_rsp_mbt_client_get_transfer_status_id#

#define sl_btmesh_rsp_mbt_client_get_transfer_status_id

0x0a280028

sl_btmesh_rsp_mbt_client_cancel_transfer_id#

#define sl_btmesh_rsp_mbt_client_cancel_transfer_id

0x0b280028

sl_btmesh_rsp_mbt_client_abort_id#

#define sl_btmesh_rsp_mbt_client_abort_id

0x0c280028