Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Bluetooth Mesh Private Beacon Client

Data Structures

struct  bt_mesh_priv_beacon
 Private Beacon. More...
 
struct  bt_mesh_priv_node_id
 Private Node Identity. More...
 
struct  bt_mesh_priv_beacon_cli_cb
 Private Beacon Client Status messages callbacks. More...
 
struct  bt_mesh_priv_beacon_cli
 Mesh Private Beacon Client model. More...
 

Macros

#define BT_MESH_MODEL_PRIV_BEACON_CLI(cli_data)
 Private Beacon Client model composition data entry.
 

Functions

int bt_mesh_priv_beacon_cli_set (uint16_t net_idx, uint16_t addr, struct bt_mesh_priv_beacon *val, struct bt_mesh_priv_beacon *rsp)
 Set the target's Private Beacon state.
 
int bt_mesh_priv_beacon_cli_get (uint16_t net_idx, uint16_t addr, struct bt_mesh_priv_beacon *val)
 Get the target's Private Beacon state.
 
int bt_mesh_priv_beacon_cli_gatt_proxy_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *rsp)
 Set the target's Private GATT Proxy state.
 
int bt_mesh_priv_beacon_cli_gatt_proxy_get (uint16_t net_idx, uint16_t addr, uint8_t *val)
 Get the target's Private GATT Proxy state.
 
int bt_mesh_priv_beacon_cli_node_id_set (uint16_t net_idx, uint16_t addr, struct bt_mesh_priv_node_id *val, struct bt_mesh_priv_node_id *rsp)
 Set the target's Private Node Identity state.
 
int bt_mesh_priv_beacon_cli_node_id_get (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, struct bt_mesh_priv_node_id *val)
 Get the target's Private Node Identity state.
 

Detailed Description

Macro Definition Documentation

◆ BT_MESH_MODEL_PRIV_BEACON_CLI

#define BT_MESH_MODEL_PRIV_BEACON_CLI ( cli_data)

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

Value:
bt_mesh_priv_beacon_cli_op, NULL, cli_data, \
#define BT_MESH_MODEL_ID_PRIV_BEACON_CLI
Private Beacon Client.
Definition access.h:197
#define BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb)
Composition data SIG model entry with callback functions.
Definition access.h:495
Private Beacon Client Status messages callbacks.
Definition priv_beacon_cli.h:56

Private Beacon Client model composition data entry.

Parameters
cli_dataPointer to a Bluetooth Mesh Private Beacon Client instance.

Function Documentation

◆ bt_mesh_priv_beacon_cli_gatt_proxy_get()

int bt_mesh_priv_beacon_cli_gatt_proxy_get ( uint16_t net_idx,
uint16_t addr,
uint8_t * val )

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

Get the target's Private GATT Proxy state.

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

◆ bt_mesh_priv_beacon_cli_gatt_proxy_set()

int bt_mesh_priv_beacon_cli_gatt_proxy_set ( uint16_t net_idx,
uint16_t addr,
uint8_t val,
uint8_t * rsp )

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

Set the target's Private GATT Proxy state.

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

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
valNew Private GATT Proxy value.
rspIf set, returns response status on success.
Returns
0 on success, or (negative) error code otherwise.

◆ bt_mesh_priv_beacon_cli_get()

int bt_mesh_priv_beacon_cli_get ( uint16_t net_idx,
uint16_t addr,
struct bt_mesh_priv_beacon * val )

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

Get the target's Private Beacon state.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
valResponse buffer for Private Beacon value.
Returns
0 on success, or (negative) error code otherwise.

◆ bt_mesh_priv_beacon_cli_node_id_get()

int bt_mesh_priv_beacon_cli_node_id_get ( uint16_t net_idx,
uint16_t addr,
uint16_t key_net_idx,
struct bt_mesh_priv_node_id * val )

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

Get the target's Private Node Identity state.

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
key_net_idxNetwork index to get the Private Node Identity state of.
valResponse buffer for Private Node Identity value.
Returns
0 on success, or (negative) error code otherwise.

◆ bt_mesh_priv_beacon_cli_node_id_set()

int bt_mesh_priv_beacon_cli_node_id_set ( uint16_t net_idx,
uint16_t addr,
struct bt_mesh_priv_node_id * val,
struct bt_mesh_priv_node_id * rsp )

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

Set the target's Private Node Identity state.

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

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
valNew Private Node Identity value.
rspIf set, returns response status on success.
Returns
0 on success, or (negative) error code otherwise.

◆ bt_mesh_priv_beacon_cli_set()

int bt_mesh_priv_beacon_cli_set ( uint16_t net_idx,
uint16_t addr,
struct bt_mesh_priv_beacon * val,
struct bt_mesh_priv_beacon * rsp )

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

Set the target's Private Beacon state.

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

Parameters
net_idxNetwork index to encrypt with.
addrTarget node address.
valNew Private Beacon value.
rspIf set, returns response status on success.
Returns
0 on success, or (negative) error code otherwise.