Zephyr API Documentation  3.7.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Bluetooth Mesh SAR Configuration Client Model

Bluetooth Mesh. More...

Data Structures

struct  bt_mesh_sar_cfg_cli
 Mesh SAR Configuration Client Model Context. More...
 

Macros

#define BT_MESH_MODEL_SAR_CFG_CLI(_cli)
 SAR Configuration Client model composition data entry.
 

Functions

int bt_mesh_sar_cfg_cli_transmitter_get (uint16_t net_idx, uint16_t addr, struct bt_mesh_sar_tx *rsp)
 Get the SAR Transmitter state of the target node.
 
int bt_mesh_sar_cfg_cli_transmitter_set (uint16_t net_idx, uint16_t addr, const struct bt_mesh_sar_tx *set, struct bt_mesh_sar_tx *rsp)
 Set the SAR Transmitter state of the target node.
 
int bt_mesh_sar_cfg_cli_receiver_get (uint16_t net_idx, uint16_t addr, struct bt_mesh_sar_rx *rsp)
 Get the SAR Receiver state of the target node.
 
int bt_mesh_sar_cfg_cli_receiver_set (uint16_t net_idx, uint16_t addr, const struct bt_mesh_sar_rx *set, struct bt_mesh_sar_rx *rsp)
 Set the SAR Receiver state of the target node.
 
int32_t bt_mesh_sar_cfg_cli_timeout_get (void)
 Get the current transmission timeout value.
 
void bt_mesh_sar_cfg_cli_timeout_set (int32_t timeout)
 Set the transmission timeout value.
 

Detailed Description

Bluetooth Mesh.

Macro Definition Documentation

◆ BT_MESH_MODEL_SAR_CFG_CLI

#define BT_MESH_MODEL_SAR_CFG_CLI (   _cli)

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

Value:
_bt_mesh_sar_cfg_cli_op, _cli.pub, _cli, \
&_bt_mesh_sar_cfg_cli_cb)
#define BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb)
Composition data SIG model entry with callback functions.
Definition: access.h:491
#define BT_MESH_MODEL_ID_SAR_CFG_CLI
SAR Configuration Client.
Definition: access.h:197

SAR Configuration Client model composition data entry.

Parameters
[in]_cliPointer to a Bluetooth Mesh SAR Configuration Client Model instance.

Function Documentation

◆ bt_mesh_sar_cfg_cli_receiver_get()

int bt_mesh_sar_cfg_cli_receiver_get ( uint16_t  net_idx,
uint16_t  addr,
struct bt_mesh_sar_rx rsp 
)

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

Get the SAR Receiver state of the target node.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
rspStatus response parameter.
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_sar_cfg_cli_receiver_set()

int bt_mesh_sar_cfg_cli_receiver_set ( uint16_t  net_idx,
uint16_t  addr,
const struct bt_mesh_sar_rx set,
struct bt_mesh_sar_rx rsp 
)

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

Set the SAR Receiver state of the target node.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
setNew SAR Receiver state to set on the target node.
rspStatus response parameter.
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_sar_cfg_cli_timeout_get()

int32_t bt_mesh_sar_cfg_cli_timeout_get ( void  )

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

Get the current transmission timeout value.

Returns
The configured transmission timeout in milliseconds.

◆ bt_mesh_sar_cfg_cli_timeout_set()

void bt_mesh_sar_cfg_cli_timeout_set ( int32_t  timeout)

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

Set the transmission timeout value.

Parameters
timeoutThe new transmission timeout.

◆ bt_mesh_sar_cfg_cli_transmitter_get()

int bt_mesh_sar_cfg_cli_transmitter_get ( uint16_t  net_idx,
uint16_t  addr,
struct bt_mesh_sar_tx rsp 
)

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

Get the SAR Transmitter state of the target node.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
rspStatus response parameter.
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_sar_cfg_cli_transmitter_set()

int bt_mesh_sar_cfg_cli_transmitter_set ( uint16_t  net_idx,
uint16_t  addr,
const struct bt_mesh_sar_tx set,
struct bt_mesh_sar_tx rsp 
)

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

Set the SAR Transmitter state of the target node.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
setNew SAR Transmitter state to set on the target node.
rspStatus response parameter.
Returns
0 on success, or (negative) error code on failure.