Zephyr API Documentation  3.7.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Proxy. More...

Data Structures

struct  bt_mesh_proxy_cb
 Callbacks for the Proxy feature. More...
 

Macros

#define BT_MESH_PROXY_CB_DEFINE(_name)
 Register a callback structure for Proxy events.
 

Functions

int bt_mesh_proxy_identity_enable (void)
 Enable advertising with Node Identity.
 
int bt_mesh_proxy_private_identity_enable (void)
 Enable advertising with Private Node Identity.
 
int bt_mesh_proxy_connect (uint16_t net_idx)
 Allow Proxy Client to auto connect to a network.
 
int bt_mesh_proxy_disconnect (uint16_t net_idx)
 Disallow Proxy Client to auto connect to a network.
 
int bt_mesh_proxy_solicit (uint16_t net_idx)
 Schedule advertising of Solicitation PDUs.
 

Detailed Description

Proxy.

Macro Definition Documentation

◆ BT_MESH_PROXY_CB_DEFINE

#define BT_MESH_PROXY_CB_DEFINE (   _name)

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

Value:
static const STRUCT_SECTION_ITERABLE( \
bt_mesh_proxy_cb, _CONCAT(bt_mesh_proxy_cb_, _name))
#define STRUCT_SECTION_ITERABLE(struct_type, varname)
Defines a new element for an iterable section.
Definition: iterable_sections.h:216
Callbacks for the Proxy feature.
Definition: proxy.h:33

Register a callback structure for Proxy events.

Registers a structure with callback functions that gets called on various Proxy events.

Parameters
_nameName of callback structure.

Function Documentation

◆ bt_mesh_proxy_connect()

int bt_mesh_proxy_connect ( uint16_t  net_idx)

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

Allow Proxy Client to auto connect to a network.

This API allows a proxy client to auto-connect a given network.

Parameters
net_idxNetwork Key Index
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_proxy_disconnect()

int bt_mesh_proxy_disconnect ( uint16_t  net_idx)

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

Disallow Proxy Client to auto connect to a network.

This API disallows a proxy client to connect a given network.

Parameters
net_idxNetwork Key Index
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_proxy_identity_enable()

int bt_mesh_proxy_identity_enable ( void  )

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

Enable advertising with Node Identity.

This API requires that GATT Proxy support has been enabled. Once called each subnet will start advertising using Node Identity for the next 60 seconds.

Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_proxy_private_identity_enable()

int bt_mesh_proxy_private_identity_enable ( void  )

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

Enable advertising with Private Node Identity.

This API requires that GATT Proxy support has been enabled. Once called each subnet will start advertising using Private Node Identity for the next 60 seconds.

Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_proxy_solicit()

int bt_mesh_proxy_solicit ( uint16_t  net_idx)

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

Schedule advertising of Solicitation PDUs.

Once called, the device will schedule advertising Solicitation PDUs for the amount of time defined by adv_int * (CONFIG_BT_MESH_SOL_ADV_XMIT + 1), where adv_int is 20ms for Bluetooth v5.0 or higher, or 100ms otherwise.

If the number of advertised Solicitation PDUs reached 0xFFFFFF, the advertisements will no longer be started until the node is reprovisioned.

Parameters
net_idxNetwork Key Index
Returns
0 on success, or (negative) error code on failure.