Proxy
The Proxy feature allows legacy devices like phones to access the Bluetooth
mesh network through GATT. The Proxy feature is only compiled in if the
CONFIG_BT_MESH_GATT_PROXY option is set. The Proxy feature state is
controlled by the Configuration Server, and the initial value
can be set with bt_mesh_cfg_srv.gatt_proxy.
API reference
- group bt_mesh_proxy
Proxy.
Defines
-
BT_MESH_PROXY_CB_DEFINE(_name)
Register a callback structure for Proxy events.
Registers a structure with callback functions that gets called on various Proxy events.
- Parameters
_name – Name of callback structure.
Functions
-
int bt_mesh_proxy_identity_enable(void)
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.
-
int bt_mesh_proxy_connect(uint16_t net_idx)
Allow Proxy Client to auto connect to a network.
This API allows a proxy client to auto-connect a given network.
- Parameters
net_idx – Network Key Index
- Returns
0 on success, or (negative) error code on failure.
-
int bt_mesh_proxy_disconnect(uint16_t net_idx)
Disallow Proxy Client to auto connect to a network.
This API disallows a proxy client to connect a given network.
- Parameters
net_idx – Network Key Index
- Returns
0 on success, or (negative) error code on failure.
-
struct bt_mesh_proxy_cb
- #include <proxy.h>
Callbacks for the Proxy feature.
Should be instantiated with BT_MESH_PROXY_CB_DEFINE.
Public Members
-
void (*identity_enabled)(uint16_t net_idx)
Started sending Node Identity beacons on the given subnet.
- Param net_idx
Network index the Node Identity beacons are running on.
-
void (*identity_disabled)(uint16_t net_idx)
Stopped sending Node Identity beacons on the given subnet.
- Param net_idx
Network index the Node Identity beacons were running on.
-
void (*identity_enabled)(uint16_t net_idx)
-
BT_MESH_PROXY_CB_DEFINE(_name)