Zephyr API Documentation  3.7.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Large Composition Data Client model

Data Structures

struct  bt_mesh_large_comp_data_rsp
 Large Composition Data response. More...
 
struct  bt_mesh_large_comp_data_cli_cb
 Large Composition Data Status messages callbacks. More...
 
struct  bt_mesh_large_comp_data_cli
 Large Composition Data Client model context. More...
 

Macros

#define BT_MESH_MODEL_LARGE_COMP_DATA_CLI(cli_data)
 Large Composition Data Client model Composition Data entry.
 

Functions

int bt_mesh_large_comp_data_get (uint16_t net_idx, uint16_t addr, uint8_t page, size_t offset, struct bt_mesh_large_comp_data_rsp *rsp)
 Send Large Composition Data Get message.
 
int bt_mesh_models_metadata_get (uint16_t net_idx, uint16_t addr, uint8_t page, size_t offset, struct bt_mesh_large_comp_data_rsp *rsp)
 Send Models Metadata Get message.
 

Detailed Description

Macro Definition Documentation

◆ BT_MESH_MODEL_LARGE_COMP_DATA_CLI

#define BT_MESH_MODEL_LARGE_COMP_DATA_CLI (   cli_data)

#include <zephyr/bluetooth/mesh/large_comp_data_cli.h>

Value:
_bt_mesh_large_comp_data_cli_op, NULL, cli_data, \
&_bt_mesh_large_comp_data_cli_cb)
#define BT_MESH_MODEL_ID_LARGE_COMP_DATA_CLI
Large Composition Data Client.
Definition: access.h:205
#define BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb)
Composition data SIG model entry with callback functions.
Definition: access.h:491

Large Composition Data Client model Composition Data entry.

Parameters
cli_dataPointer to a Large Composition Data Client model instance.

Function Documentation

◆ bt_mesh_large_comp_data_get()

int bt_mesh_large_comp_data_get ( uint16_t  net_idx,
uint16_t  addr,
uint8_t  page,
size_t  offset,
struct bt_mesh_large_comp_data_rsp rsp 
)

#include <zephyr/bluetooth/mesh/large_comp_data_cli.h>

Send Large Composition Data Get message.

This API is used to read a portion of a Composition Data Page.

This API can be used asynchronously by setting rsp as NULL. This way, the method will not wait for a response and will return immediately after sending the command.

When rsp is set, the user is responsible for providing a buffer for the Composition Data in bt_mesh_large_comp_data_rsp::data. If a buffer is not provided, the metadata won't be copied.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node element address.
pageComposition Data Page to read.
offsetOffset within the Composition Data Page.
rspPointer to a struct storing the received response from the server, or NULL to not wait for a response.
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_models_metadata_get()

int bt_mesh_models_metadata_get ( uint16_t  net_idx,
uint16_t  addr,
uint8_t  page,
size_t  offset,
struct bt_mesh_large_comp_data_rsp rsp 
)

#include <zephyr/bluetooth/mesh/large_comp_data_cli.h>

Send Models Metadata Get message.

This API is used to read a portion of a Models Metadata Page.

This API can be used asynchronously by setting rsp as NULL. This way, the method will not wait for a response and will return immediately after sending the command.

When rsp is set, a user is responsible for providing a buffer for metadata in bt_mesh_large_comp_data_rsp::data. If a buffer is not provided, the metadata won't be copied.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node element address.
pageModels Metadata Page to read.
offsetOffset within the Models Metadata Page.
rspPointer to a struct storing the received response from the server, or NULL to not wait for a response.
Returns
0 on success, or (negative) error code on failure.