Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
dfu_cli.h File Reference

Go to the source code of this file.

Data Structures

struct  bt_mesh_dfu_target
 DFU Target node. More...
 
struct  bt_mesh_dfu_metadata_status
 Metadata status response. More...
 
struct  bt_mesh_dfu_target_status
 DFU Target node status parameters. More...
 
struct  bt_mesh_dfu_cli_cb
 Firmware Update Client event callbacks. More...
 
struct  bt_mesh_dfu_cli
 Firmware Update Client model instance. More...
 
struct  bt_mesh_dfu_cli_xfer_blob_params
 BLOB parameters for Firmware Update Client transfer: More...
 
struct  bt_mesh_dfu_cli_xfer
 Firmware Update Client transfer parameters: More...
 

Macros

#define BT_MESH_DFU_CLI_INIT(_handlers)
 Initialization parameters for the Firmware Uppdate Client model.
 
#define BT_MESH_MODEL_DFU_CLI(_cli)
 Firmware Update Client model Composition Data entry.
 

Typedefs

typedef enum bt_mesh_dfu_iter(* bt_mesh_dfu_img_cb_t) (struct bt_mesh_dfu_cli *cli, struct bt_mesh_msg_ctx *ctx, uint8_t idx, uint8_t total, const struct bt_mesh_dfu_img *img, void *cb_data)
 DFU image callback.
 

Functions

int bt_mesh_dfu_cli_send (struct bt_mesh_dfu_cli *cli, const struct bt_mesh_blob_cli_inputs *inputs, const struct bt_mesh_blob_io *io, const struct bt_mesh_dfu_cli_xfer *xfer)
 Start distributing a DFU.
 
int bt_mesh_dfu_cli_suspend (struct bt_mesh_dfu_cli *cli)
 Suspend a DFU transfer.
 
int bt_mesh_dfu_cli_resume (struct bt_mesh_dfu_cli *cli)
 Resume the suspended transfer.
 
int bt_mesh_dfu_cli_cancel (struct bt_mesh_dfu_cli *cli, struct bt_mesh_msg_ctx *ctx)
 Cancel a DFU transfer.
 
int bt_mesh_dfu_cli_apply (struct bt_mesh_dfu_cli *cli)
 Apply the completed DFU transfer.
 
int bt_mesh_dfu_cli_confirm (struct bt_mesh_dfu_cli *cli)
 Confirm that the active transfer has been applied on the Target nodes.
 
uint8_t bt_mesh_dfu_cli_progress (struct bt_mesh_dfu_cli *cli)
 Get progress as a percentage of completion.
 
bool bt_mesh_dfu_cli_is_busy (struct bt_mesh_dfu_cli *cli)
 Check whether a DFU transfer is in progress.
 
int bt_mesh_dfu_cli_imgs_get (struct bt_mesh_dfu_cli *cli, struct bt_mesh_msg_ctx *ctx, bt_mesh_dfu_img_cb_t cb, void *cb_data, uint8_t max_count)
 Perform a DFU image list request.
 
int bt_mesh_dfu_cli_metadata_check (struct bt_mesh_dfu_cli *cli, struct bt_mesh_msg_ctx *ctx, uint8_t img_idx, const struct bt_mesh_dfu_slot *slot, struct bt_mesh_dfu_metadata_status *rsp)
 Perform a metadata check for the given DFU image slot.
 
int bt_mesh_dfu_cli_status_get (struct bt_mesh_dfu_cli *cli, struct bt_mesh_msg_ctx *ctx, struct bt_mesh_dfu_target_status *rsp)
 Get the status of a Target node.
 
int32_t bt_mesh_dfu_cli_timeout_get (void)
 Get the current procedure timeout value.
 
void bt_mesh_dfu_cli_timeout_set (int32_t timeout)
 Set the procedure timeout value.