Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Header file for the Bluetooth Mesh BLOB Transfer Client model API. More...

Go to the source code of this file.

Data Structures

struct  bt_mesh_blob_target_pull
 Target node's Pull mode (Pull BLOB Transfer Mode) context used while sending chunks to the Target node. More...
struct  bt_mesh_blob_target
 BLOB Transfer Client Target node. More...
struct  bt_mesh_blob_xfer_info
 BLOB transfer information. More...
struct  bt_mesh_blob_cli_inputs
 BLOB Transfer Client transfer inputs. More...
struct  bt_mesh_blob_cli_caps
 Transfer capabilities of a Target node. More...
struct  bt_mesh_blob_cli_cb
 Event handler callbacks for the BLOB Transfer Client model. More...
struct  bt_mesh_blob_cli
 BLOB Transfer Client model instance. More...

Macros

#define BT_MESH_MODEL_BLOB_CLI(_cli)
 BLOB Transfer Client model Composition Data entry.

Enumerations

enum  bt_mesh_blob_cli_state {
  BT_MESH_BLOB_CLI_STATE_NONE , BT_MESH_BLOB_CLI_STATE_CAPS_GET , BT_MESH_BLOB_CLI_STATE_START , BT_MESH_BLOB_CLI_STATE_BLOCK_START ,
  BT_MESH_BLOB_CLI_STATE_BLOCK_SEND , BT_MESH_BLOB_CLI_STATE_BLOCK_CHECK , BT_MESH_BLOB_CLI_STATE_XFER_CHECK , BT_MESH_BLOB_CLI_STATE_CANCEL ,
  BT_MESH_BLOB_CLI_STATE_SUSPENDED , BT_MESH_BLOB_CLI_STATE_XFER_PROGRESS_GET
}
 BLOB Transfer Client state. More...

Functions

int bt_mesh_blob_cli_caps_get (struct bt_mesh_blob_cli *cli, const struct bt_mesh_blob_cli_inputs *inputs)
 Retrieve transfer capabilities for a list of Target nodes.
int bt_mesh_blob_cli_send (struct bt_mesh_blob_cli *cli, const struct bt_mesh_blob_cli_inputs *inputs, const struct bt_mesh_blob_xfer *xfer, const struct bt_mesh_blob_io *io)
 Perform a BLOB transfer.
int bt_mesh_blob_cli_suspend (struct bt_mesh_blob_cli *cli)
 Suspend the active transfer.
int bt_mesh_blob_cli_resume (struct bt_mesh_blob_cli *cli)
 Resume the suspended transfer.
void bt_mesh_blob_cli_cancel (struct bt_mesh_blob_cli *cli)
 Cancel an ongoing transfer.
int bt_mesh_blob_cli_xfer_progress_get (struct bt_mesh_blob_cli *cli, const struct bt_mesh_blob_cli_inputs *inputs)
 Get the progress of BLOB transfer.
uint8_t bt_mesh_blob_cli_xfer_progress_active_get (struct bt_mesh_blob_cli *cli)
 Get the current progress of the active transfer in percent.
bool bt_mesh_blob_cli_is_busy (struct bt_mesh_blob_cli *cli)
 Get the current state of the BLOB Transfer Client.
void bt_mesh_blob_cli_set_chunk_interval_ms (struct bt_mesh_blob_cli *cli, uint32_t interval_ms)
 Set chunk sending interval in ms.

Detailed Description

Header file for the Bluetooth Mesh BLOB Transfer Client model API.