Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
cfg.h File Reference

Runtime configuration APIs. More...

#include <stdbool.h>
#include <stddef.h>
#include <sys/types.h>

Go to the source code of this file.

Macros

#define BT_MESH_KR_NORMAL   0x00
 
#define BT_MESH_KR_PHASE_1   0x01
 
#define BT_MESH_KR_PHASE_2   0x02
 
#define BT_MESH_KR_PHASE_3   0x03
 
#define BT_MESH_RELAY_DISABLED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_RELAY_ENABLED   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_RELAY_NOT_SUPPORTED   BT_MESH_FEATURE_NOT_SUPPORTED
 
#define BT_MESH_BEACON_DISABLED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_BEACON_ENABLED   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_PRIV_BEACON_DISABLED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_PRIV_BEACON_ENABLED   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_GATT_PROXY_DISABLED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_GATT_PROXY_ENABLED   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_GATT_PROXY_NOT_SUPPORTED   BT_MESH_FEATURE_NOT_SUPPORTED
 
#define BT_MESH_PRIV_GATT_PROXY_DISABLED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_PRIV_GATT_PROXY_ENABLED   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_PRIV_GATT_PROXY_NOT_SUPPORTED   BT_MESH_FEATURE_NOT_SUPPORTED
 
#define BT_MESH_FRIEND_DISABLED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_FRIEND_ENABLED   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_FRIEND_NOT_SUPPORTED   BT_MESH_FEATURE_NOT_SUPPORTED
 
#define BT_MESH_NODE_IDENTITY_STOPPED   BT_MESH_FEATURE_DISABLED
 
#define BT_MESH_NODE_IDENTITY_RUNNING   BT_MESH_FEATURE_ENABLED
 
#define BT_MESH_NODE_IDENTITY_NOT_SUPPORTED   BT_MESH_FEATURE_NOT_SUPPORTED
 

Enumerations

enum  bt_mesh_feat_state { BT_MESH_FEATURE_DISABLED , BT_MESH_FEATURE_ENABLED , BT_MESH_FEATURE_NOT_SUPPORTED }
 Bluetooth Mesh feature states. More...
 

Functions

void bt_mesh_beacon_set (bool beacon)
 Enable or disable sending of the Secure Network Beacon.
 
bool bt_mesh_beacon_enabled (void)
 Get the current Secure Network Beacon state.
 
int bt_mesh_priv_beacon_set (enum bt_mesh_feat_state priv_beacon)
 Enable or disable sending of the Mesh Private beacon.
 
enum bt_mesh_feat_state bt_mesh_priv_beacon_get (void)
 Get the current Mesh Private beacon state.
 
void bt_mesh_priv_beacon_update_interval_set (uint8_t interval)
 Set the current Mesh Private beacon update interval.
 
uint8_t bt_mesh_priv_beacon_update_interval_get (void)
 Get the current Mesh Private beacon update interval.
 
int bt_mesh_default_ttl_set (uint8_t default_ttl)
 Set the default TTL value.
 
uint8_t bt_mesh_default_ttl_get (void)
 Get the current default TTL value.
 
int bt_mesh_od_priv_proxy_get (void)
 Get the current Mesh On-Demand Private Proxy state.
 
int bt_mesh_od_priv_proxy_set (uint8_t on_demand_proxy)
 Set state of Mesh On-Demand Private Proxy.
 
void bt_mesh_net_transmit_set (uint8_t xmit)
 Set the Network Transmit parameters.
 
uint8_t bt_mesh_net_transmit_get (void)
 Get the current Network Transmit parameters.
 
int bt_mesh_relay_set (enum bt_mesh_feat_state relay, uint8_t xmit)
 Configure the Relay feature.
 
enum bt_mesh_feat_state bt_mesh_relay_get (void)
 Get the current Relay feature state.
 
uint8_t bt_mesh_relay_retransmit_get (void)
 Get the current Relay Retransmit parameters.
 
int bt_mesh_gatt_proxy_set (enum bt_mesh_feat_state gatt_proxy)
 Enable or disable the GATT Proxy feature.
 
enum bt_mesh_feat_state bt_mesh_gatt_proxy_get (void)
 Get the current GATT Proxy state.
 
int bt_mesh_priv_gatt_proxy_set (enum bt_mesh_feat_state priv_gatt_proxy)
 Enable or disable the Private GATT Proxy feature.
 
enum bt_mesh_feat_state bt_mesh_priv_gatt_proxy_get (void)
 Get the current Private GATT Proxy state.
 
int bt_mesh_friend_set (enum bt_mesh_feat_state friendship)
 Enable or disable the Friend feature.
 
enum bt_mesh_feat_state bt_mesh_friend_get (void)
 Get the current Friend state.
 
uint8_t bt_mesh_subnet_add (uint16_t net_idx, const uint8_t key[16])
 Add a Subnet.
 
uint8_t bt_mesh_subnet_update (uint16_t net_idx, const uint8_t key[16])
 Update the given Subnet.
 
uint8_t bt_mesh_subnet_del (uint16_t net_idx)
 Delete a Subnet.
 
bool bt_mesh_subnet_exists (uint16_t net_idx)
 Check whether a Subnet is known.
 
uint8_t bt_mesh_subnet_kr_phase_set (uint16_t net_idx, uint8_t *phase)
 Set the Subnet's Key Refresh phase.
 
uint8_t bt_mesh_subnet_kr_phase_get (uint16_t net_idx, uint8_t *phase)
 Get the Subnet's Key Refresh phase.
 
uint8_t bt_mesh_subnet_node_id_set (uint16_t net_idx, enum bt_mesh_feat_state node_id)
 Set the Node Identity state of the Subnet.
 
uint8_t bt_mesh_subnet_node_id_get (uint16_t net_idx, enum bt_mesh_feat_state *node_id)
 Get the Node Identity state of the Subnet.
 
uint8_t bt_mesh_subnet_priv_node_id_set (uint16_t net_idx, enum bt_mesh_feat_state priv_node_id)
 Set the Private Node Identity state of the Subnet.
 
uint8_t bt_mesh_subnet_priv_node_id_get (uint16_t net_idx, enum bt_mesh_feat_state *priv_node_id)
 Get the Private Node Identity state of the Subnet.
 
ssize_t bt_mesh_subnets_get (uint16_t net_idxs[], size_t max, off_t skip)
 Get a list of all known Subnet indexes.
 
uint8_t bt_mesh_app_key_add (uint16_t app_idx, uint16_t net_idx, const uint8_t key[16])
 Add an Application key.
 
uint8_t bt_mesh_app_key_update (uint16_t app_idx, uint16_t net_idx, const uint8_t key[16])
 Update an Application key.
 
uint8_t bt_mesh_app_key_del (uint16_t app_idx, uint16_t net_idx)
 Delete an Application key.
 
bool bt_mesh_app_key_exists (uint16_t app_idx)
 Check if an Application key is known.
 
ssize_t bt_mesh_app_keys_get (uint16_t net_idx, uint16_t app_idxs[], size_t max, off_t skip)
 Get a list of all known Application key indexes.
 

Detailed Description

Runtime configuration APIs.