Zephyr API Documentation  3.7.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Bluetooth Mesh On-Demand Private GATT Proxy Client

Data Structures

struct  bt_mesh_od_priv_proxy_cli
 On-Demand Private Proxy Client Model Context. More...
 

Macros

#define BT_MESH_MODEL_OD_PRIV_PROXY_CLI(cli_data)
 On-Demand Private Proxy Client model composition data entry.
 

Functions

int bt_mesh_od_priv_proxy_cli_get (uint16_t net_idx, uint16_t addr, uint8_t *val_rsp)
 Get the target's On-Demand Private GATT Proxy state.
 
int bt_mesh_od_priv_proxy_cli_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *val_rsp)
 Set the target's On-Demand Private GATT Proxy state.
 
void bt_mesh_od_priv_proxy_cli_timeout_set (int32_t timeout)
 Set the transmission timeout value.
 

Detailed Description

Macro Definition Documentation

◆ BT_MESH_MODEL_OD_PRIV_PROXY_CLI

#define BT_MESH_MODEL_OD_PRIV_PROXY_CLI (   cli_data)

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

Value:
_bt_mesh_od_priv_proxy_cli_op, NULL, cli_data, \
&_bt_mesh_od_priv_proxy_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_ON_DEMAND_PROXY_CLI
Private Proxy Client.
Definition: access.h:213

On-Demand Private Proxy Client model composition data entry.

Function Documentation

◆ bt_mesh_od_priv_proxy_cli_get()

int bt_mesh_od_priv_proxy_cli_get ( uint16_t  net_idx,
uint16_t  addr,
uint8_t val_rsp 
)

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

Get the target's On-Demand Private GATT Proxy state.

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

To process the response arguments of an async method, register the od_status callback in bt_mesh_od_priv_proxy_cli struct.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
val_rspResponse buffer for On-Demand Private GATT Proxy value.
Returns
0 on success, or (negative) error code otherwise.

◆ bt_mesh_od_priv_proxy_cli_set()

int bt_mesh_od_priv_proxy_cli_set ( uint16_t  net_idx,
uint16_t  addr,
uint8_t  val,
uint8_t val_rsp 
)

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

Set the target's On-Demand Private GATT Proxy state.

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

To process the response arguments of an async method, register the od_status callback in bt_mesh_od_priv_proxy_cli struct.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
valOn-Demand Private GATT Proxy state to be set
val_rspResponse buffer for On-Demand Private GATT Proxy value.
Returns
0 on success, or (negative) error code otherwise.

◆ bt_mesh_od_priv_proxy_cli_timeout_set()

void bt_mesh_od_priv_proxy_cli_timeout_set ( int32_t  timeout)

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

Set the transmission timeout value.

Parameters
timeoutThe new transmission timeout in milliseconds.