 |
Zephyr Project API 4.4.99
A Scalable Open Source RTOS
|
|
Zephyr Project API 4.4.99
A Scalable Open Source RTOS
|
Connection management. More...
Data Structures | |
| struct | bt_le_conn_param |
| Connection parameters for LE connections. More... | |
| struct | bt_conn_le_phy_info |
| Connection PHY information for LE connections. More... | |
| struct | bt_conn_le_phy_param |
| Preferred PHY parameters for LE connections. More... | |
| struct | bt_conn_le_data_len_info |
| Connection data length information for LE connections. More... | |
| struct | bt_conn_le_data_len_param |
| Connection data length parameters for LE connections. More... | |
| struct | bt_conn_le_subrate_param |
| Connection subrating parameters for LE connections. More... | |
| struct | bt_conn_le_subrating_info |
| Subrating information for LE connections. More... | |
| struct | bt_conn_le_subrate_changed |
| Updated subrating connection parameters for LE connections. More... | |
| struct | bt_conn_le_min_conn_interval_group |
| Minimum supported connection interval group. More... | |
| struct | bt_conn_le_min_conn_interval_info |
| Minimum supported connection interval information. More... | |
| struct | bt_conn_le_conn_rate_param |
| Connection rate parameters for LE connections. More... | |
| struct | bt_conn_le_conn_rate_changed |
| Updated connection rate parameters. More... | |
| struct | bt_conn_le_read_all_remote_feat_complete |
| Read all remote features complete callback params. More... | |
| struct | bt_conn_le_frame_space_update_param |
| Frame space update params. More... | |
| struct | bt_conn_le_frame_space_updated |
| Frame space updated callback params. More... | |
| struct | bt_conn_le_cs_capabilities |
| Remote channel sounding capabilities for LE connections supporting CS. More... | |
| struct | bt_conn_le_cs_fae_table |
| Remote FAE Table for LE connections supporting CS. More... | |
| struct | bt_conn_le_cs_config |
| Channel sounding configuration. More... | |
| struct | bt_conn_le_cs_subevent_result |
| Subevent data for LE connections supporting CS. More... | |
| struct | bt_conn_le_info |
| LE Connection Info Structure. More... | |
| struct | bt_conn_br_info |
| BR/EDR Connection Info Structure. More... | |
| struct | bt_conn_sco_info |
| SCO Connection Info Structure. More... | |
| struct | bt_security_info |
| Security Info Structure. More... | |
| struct | bt_conn_info |
| Connection Info Structure. More... | |
| struct | bt_conn_le_remote_info |
| LE Connection Remote Info Structure. More... | |
| struct | bt_conn_br_remote_info |
| BR/EDR Connection Remote Info structure. More... | |
| struct | bt_conn_remote_info |
| Connection Remote Info Structure. More... | |
| struct | bt_conn_le_tx_power |
| LE Transmit Power Level Structure. More... | |
| struct | bt_conn_le_tx_power_report |
| LE Transmit Power Reporting Structure. More... | |
| struct | bt_conn_le_path_loss_threshold_report |
| LE Path Loss Monitoring Threshold Change Report Structure. More... | |
| struct | bt_conn_le_path_loss_reporting_param |
| LE Path Loss Monitoring Parameters Structure as defined in Core Spec. More... | |
| struct | bt_conn_le_create_param |
| struct | bt_conn_le_create_synced_param |
| struct | bt_conn_le_cs_procedure_enable_complete |
| struct | bt_conn_br_cb |
| BR/EDR specific connection callbacks. More... | |
| struct | bt_conn_cb |
| Connection callback structure. More... | |
| struct | bt_conn_oob_info |
| Info Structure for OOB pairing. More... | |
| struct | bt_conn_pairing_feat |
| Pairing request and pairing response info structure. More... | |
| struct | bt_conn_auth_cb |
| Authenticated pairing callback structure. More... | |
| struct | bt_conn |
| Opaque type representing a connection to a remote device. More... | |
Macros | |
| #define | BT_LE_CONN_PARAM_INIT(int_min, int_max, lat, to) |
| Initialize connection parameters. | |
| #define | BT_LE_CONN_PARAM(int_min, int_max, lat, to) |
| Helper to declare connection parameters inline. | |
| #define | BT_LE_CONN_PARAM_DEFAULT |
| Default LE connection parameters: Connection Interval: 30-50 ms Latency: 0 Timeout: 4 s. | |
| #define | BT_CONN_LE_PHY_PARAM_INIT(_pref_tx_phy, _pref_rx_phy) |
| Initialize PHY parameters. | |
| #define | BT_CONN_LE_PHY_PARAM(_pref_tx_phy, _pref_rx_phy) |
| Helper to declare PHY parameters inline. | |
| #define | BT_CONN_LE_PHY_PARAM_1M |
| Only LE 1M PHY. | |
| #define | BT_CONN_LE_PHY_PARAM_2M |
| Only LE 2M PHY. | |
| #define | BT_CONN_LE_PHY_PARAM_CODED |
| Only LE Coded PHY. | |
| #define | BT_CONN_LE_PHY_PARAM_ALL |
| All LE PHYs. | |
| #define | BT_CONN_LE_DATA_LEN_PARAM_INIT(_tx_max_len, _tx_max_time) |
| Initialize transmit data length parameters. | |
| #define | BT_CONN_LE_DATA_LEN_PARAM(_tx_max_len, _tx_max_time) |
| Helper to declare transmit data length parameters inline. | |
| #define | BT_LE_DATA_LEN_PARAM_DEFAULT |
| Default LE data length parameters. | |
| #define | BT_LE_DATA_LEN_PARAM_MAX |
| Maximum LE data length parameters. | |
| #define | BT_CONN_LE_MAX_CONN_INTERVAL_GROUPS 41 |
| Maximum Connection Interval Groups possible. | |
| #define | BT_CONN_LE_FRAME_SPACE_TYPES_MASK_ACL_IFS |
| #define | BT_CONN_LE_FRAME_SPACE_TYPES_MASK_ACL |
| #define | BT_CONN_LE_FRAME_SPACE_TYPES_MASK_CIS |
| #define | BT_CONN_LE_FRAME_SPACE_MAX (10000U) |
| Maximum frame space in microseconds. | |
| #define | BT_CONN_LE_CS_MODE_MAIN_MODE_PART(x) |
| Extract main mode part from bt_conn_le_cs_mode. | |
| #define | BT_CONN_LE_CS_MODE_SUB_MODE_PART(x) |
| Extract sub-mode part from bt_conn_le_cs_mode. | |
| #define | BT_CONN_INTERVAL_TO_MS(interval) |
| Convert connection interval to milliseconds. | |
| #define | BT_CONN_INTERVAL_TO_US(interval) |
| Convert connection interval to microseconds. | |
| #define | BT_CONN_SCI_INTERVAL_TO_US(_interval) |
| Convert shorter connection interval to microseconds. | |
| #define | bt_conn_dst_str(_conn) |
| Get a string pointer to a connection destination (peer) address. | |
| #define | BT_CONN_LE_CREATE_PARAM_INIT(_options, _interval, _window) |
| Initialize create connection parameters. | |
| #define | BT_CONN_LE_CREATE_PARAM(_options, _interval, _window) |
| Helper to declare create connection parameters inline. | |
| #define | BT_CONN_LE_CREATE_CONN |
| Default LE create connection parameters. | |
| #define | BT_CONN_LE_CREATE_CONN_AUTO |
| Default LE create connection using filter accept list parameters. | |
| #define | BT_CONN_PARAM_REJECT_ERR_L2CAP_CPUP 0xFF |
| Synthetic error value for an L2CAP Connection Parameter Update Procedure (CPUP) rejection. | |
| #define | BT_CONN_CB_DEFINE(_name) |
| Register a callback structure for connection events. | |
| #define | BT_PASSKEY_RAND 0xffffffff |
| Special passkey value that can be used to generate a random passkey when using the app_passkey callback from bt_conn_auth_cb. | |
Functions | |
| struct bt_conn * | bt_conn_ref (struct bt_conn *conn) |
| Increment a connection's reference count. | |
| void | bt_conn_unref (struct bt_conn *conn) |
| Decrement a connection's reference count. | |
| static struct bt_conn * | bt_conn_take (struct bt_conn **orig) |
| Take ownership of a connection pointer, setting the original to NULL. | |
| void | bt_conn_drop (struct bt_conn **orig) |
| Drop a connection reference and clear the pointer. | |
| void | bt_conn_foreach (enum bt_conn_type type, void(*func)(struct bt_conn *conn, void *data), void *data) |
| Iterate through all bt_conn objects. | |
| struct bt_conn * | bt_conn_lookup_addr_le (uint8_t id, const bt_addr_le_t *peer) |
| Look up an existing connection by address. | |
| const bt_addr_le_t * | bt_conn_get_dst (const struct bt_conn *conn) |
| Get destination (peer) address of a connection. | |
| uint8_t | bt_conn_index (const struct bt_conn *conn) |
| Get array index of a connection. | |
| int | bt_conn_get_info (const struct bt_conn *conn, struct bt_conn_info *info) |
| Get connection info. | |
| bool | bt_conn_is_type (const struct bt_conn *conn, enum bt_conn_type type) |
| Function to determine the type of a connection. | |
| int | bt_conn_get_remote_info (const struct bt_conn *conn, struct bt_conn_remote_info *remote_info) |
| Get connection info for the remote device. | |
| int | bt_conn_le_get_tx_power_level (struct bt_conn *conn, struct bt_conn_le_tx_power *tx_power_level) |
| Get connection transmit power level. | |
| int | bt_conn_le_enhanced_get_tx_power_level (struct bt_conn *conn, struct bt_conn_le_tx_power *tx_power) |
| Get local enhanced connection transmit power level. | |
| int | bt_conn_le_get_remote_tx_power_level (struct bt_conn *conn, enum bt_conn_le_tx_power_phy phy) |
| Get remote (peer) transmit power level. | |
| int | bt_conn_le_set_tx_power_report_enable (struct bt_conn *conn, bool local_enable, bool remote_enable) |
| Enable transmit power reporting. | |
| int | bt_conn_le_set_path_loss_mon_param (struct bt_conn *conn, const struct bt_conn_le_path_loss_reporting_param *param) |
| Set Path Loss Monitoring Parameters. | |
| int | bt_conn_le_set_path_loss_mon_enable (struct bt_conn *conn, bool enable) |
| Enable or Disable Path Loss Monitoring. | |
| int | bt_conn_le_subrate_set_defaults (const struct bt_conn_le_subrate_param *params) |
| Set Default Connection Subrating Parameters. | |
| int | bt_conn_le_subrate_request (struct bt_conn *conn, const struct bt_conn_le_subrate_param *params) |
| Request New Subrating Parameters. | |
| int | bt_conn_le_read_min_conn_interval_groups (struct bt_conn_le_min_conn_interval_info *info) |
| Read Minimum Supported Connection Interval Groups. | |
| int | bt_conn_le_read_min_conn_interval (uint16_t *min_interval_us) |
| Read Minimum Supported Connection Interval. | |
| int | bt_conn_le_conn_rate_set_defaults (const struct bt_conn_le_conn_rate_param *params) |
| Set Default Connection Rate Parameters. | |
| int | bt_conn_le_conn_rate_request (struct bt_conn *conn, const struct bt_conn_le_conn_rate_param *params) |
| Request New Connection Rate Parameters. | |
| int | bt_conn_le_read_all_remote_features (struct bt_conn *conn, uint8_t pages_requested) |
| Read remote feature pages. | |
| int | bt_conn_le_frame_space_update (struct bt_conn *conn, const struct bt_conn_le_frame_space_update_param *params) |
| Update frame space. | |
| int | bt_conn_le_param_update (struct bt_conn *conn, const struct bt_le_conn_param *param) |
| Update the connection parameters. | |
| int | bt_conn_le_data_len_update (struct bt_conn *conn, const struct bt_conn_le_data_len_param *param) |
| Update the connection transmit data length parameters. | |
| int | bt_conn_le_phy_update (struct bt_conn *conn, const struct bt_conn_le_phy_param *param) |
| Update the connection PHY parameters. | |
| int | bt_conn_le_set_default_phy (uint8_t pref_tx_phy, uint8_t pref_rx_phy) |
| Update the default PHY parameters to be used for all subsequent connections over the LE transport. | |
| int | bt_conn_disconnect (struct bt_conn *conn, uint8_t reason) |
| Disconnect from a remote device or cancel pending connection. | |
| int | bt_conn_le_create (const bt_addr_le_t *peer, const struct bt_conn_le_create_param *create_param, const struct bt_le_conn_param *conn_param, struct bt_conn **conn) |
| Initiate an LE connection to a remote device. | |
| int | bt_conn_le_create_synced (const struct bt_le_ext_adv *adv, const struct bt_conn_le_create_synced_param *synced_param, const struct bt_le_conn_param *conn_param, struct bt_conn **conn) |
| Create a connection to a synced device. | |
| int | bt_conn_le_create_auto (const struct bt_conn_le_create_param *create_param, const struct bt_le_conn_param *conn_param) |
| Automatically connect to remote devices in the filter accept list. | |
| int | bt_conn_create_auto_stop (void) |
| Stop automatic connect creation. | |
| int | bt_conn_set_security (struct bt_conn *conn, bt_security_t sec) |
| Set security level for a connection. | |
| bt_security_t | bt_conn_get_security (const struct bt_conn *conn) |
| Get security level for a connection. | |
| uint8_t | bt_conn_enc_key_size (const struct bt_conn *conn) |
| Get encryption key size. | |
| int | bt_conn_cb_register (struct bt_conn_cb *cb) |
| Register connection callbacks. | |
| int | bt_conn_cb_unregister (struct bt_conn_cb *cb) |
| Unregister connection callbacks. | |
| static const char * | bt_security_err_to_str (enum bt_security_err err) |
| Converts a security error to string. | |
| void | bt_set_bondable (bool enable) |
| Enable/disable bonding. | |
| bool | bt_get_bondable (void) |
| Get bonding flag. | |
| int | bt_conn_set_bondable (struct bt_conn *conn, bool enable) |
| Set/clear the bonding flag for a given connection. | |
| void | bt_le_oob_set_sc_flag (bool enable) |
| Allow/disallow remote LE SC OOB data to be used for pairing. | |
| void | bt_le_oob_set_legacy_flag (bool enable) |
| Allow/disallow remote legacy OOB data to be used for pairing. | |
| int | bt_le_oob_set_legacy_tk (struct bt_conn *conn, const uint8_t *tk) |
| Set OOB Temporary Key to be used for pairing. | |
| int | bt_le_oob_set_sc_data (struct bt_conn *conn, const struct bt_le_oob_sc_data *oobd_local, const struct bt_le_oob_sc_data *oobd_remote) |
| Set OOB data during LE Secure Connections (SC) pairing procedure. | |
| int | bt_le_oob_get_sc_data (struct bt_conn *conn, const struct bt_le_oob_sc_data **oobd_local, const struct bt_le_oob_sc_data **oobd_remote) |
| Get OOB data used for LE Secure Connections (SC) pairing procedure. | |
Connection management.
| #define BT_CONN_CB_DEFINE | ( | _name | ) |
#include <conn.h>
Register a callback structure for connection events.
| _name | Name of callback structure. |
| #define bt_conn_dst_str | ( | _conn | ) |
#include <conn.h>
Get a string pointer to a connection destination (peer) address.
| _conn | Pointer to the connection object. |
| #define BT_CONN_INTERVAL_TO_MS | ( | interval | ) |
#include <conn.h>
Convert connection interval to milliseconds.
Multiply by 1.25 to get milliseconds.
Note that this may be inaccurate, as something like 7.5 ms cannot be accurately presented with integers.
| #define BT_CONN_INTERVAL_TO_US | ( | interval | ) |
#include <conn.h>
Convert connection interval to microseconds.
Multiply by 1250 to get microseconds.
| #define BT_CONN_LE_CREATE_CONN |
#include <conn.h>
Default LE create connection parameters.
Scan continuously by setting scan interval equal to scan window.
| #define BT_CONN_LE_CREATE_CONN_AUTO |
#include <conn.h>
Default LE create connection using filter accept list parameters.
Scan window: 30 ms. Scan interval: 60 ms.
| #define BT_CONN_LE_CREATE_PARAM | ( | _options, | |
| _interval, | |||
| _window ) |
#include <conn.h>
Helper to declare create connection parameters inline.
| _options | Create connection options. |
| _interval | Create connection scan interval (N * 0.625 ms). |
| _window | Create connection scan window (N * 0.625 ms). |
| #define BT_CONN_LE_CREATE_PARAM_INIT | ( | _options, | |
| _interval, | |||
| _window ) |
#include <conn.h>
Initialize create connection parameters.
| _options | Create connection options. |
| _interval | Create connection scan interval (N * 0.625 ms). |
| _window | Create connection scan window (N * 0.625 ms). |
| #define BT_CONN_LE_CS_MODE_MAIN_MODE_PART | ( | x | ) |
#include <conn.h>
Extract main mode part from bt_conn_le_cs_mode.
| x | bt_conn_le_cs_mode value |
| 1 | Matches BT_HCI_OP_LE_CS_MAIN_MODE_1 (0x01) |
| 2 | Matches BT_HCI_OP_LE_CS_MAIN_MODE_2 (0x02) |
| 3 | Matches BT_HCI_OP_LE_CS_MAIN_MODE_3 (0x03) |
| #define BT_CONN_LE_CS_MODE_SUB_MODE_PART | ( | x | ) |
#include <conn.h>
Extract sub-mode part from bt_conn_le_cs_mode.
| x | bt_conn_le_cs_mode value |
| 0 | Internal encoding for BT_HCI_OP_LE_CS_SUB_MODE_UNUSED (0xFF) |
| 1 | Matches BT_HCI_OP_LE_CS_SUB_MODE_1 (0x01) |
| 2 | Matches BT_HCI_OP_LE_CS_SUB_MODE_2 (0x02) |
| 3 | Matches BT_HCI_OP_LE_CS_SUB_MODE_3 (0x03) |
| #define BT_CONN_LE_DATA_LEN_PARAM | ( | _tx_max_len, | |
| _tx_max_time ) |
#include <conn.h>
Helper to declare transmit data length parameters inline.
| _tx_max_len | Maximum Link Layer transmission payload size in bytes. |
| _tx_max_time | Maximum Link Layer transmission payload time in us. |
| #define BT_CONN_LE_DATA_LEN_PARAM_INIT | ( | _tx_max_len, | |
| _tx_max_time ) |
#include <conn.h>
Initialize transmit data length parameters.
| _tx_max_len | Maximum Link Layer transmission payload size in bytes. |
| _tx_max_time | Maximum Link Layer transmission payload time in us. |
| #define BT_CONN_LE_FRAME_SPACE_MAX (10000U) |
#include <conn.h>
Maximum frame space in microseconds.
As defined in Bluetooth Core Specification, Vol 4, Part E, Section 7.8.151.
| #define BT_CONN_LE_FRAME_SPACE_TYPES_MASK_ACL |
#include <conn.h>
| #define BT_CONN_LE_FRAME_SPACE_TYPES_MASK_ACL_IFS |
| #define BT_CONN_LE_FRAME_SPACE_TYPES_MASK_CIS |
#include <conn.h>
| #define BT_CONN_LE_MAX_CONN_INTERVAL_GROUPS 41 |
#include <conn.h>
Maximum Connection Interval Groups possible.
The practical maximum is 41 groups based on HCI event size constraints: (HCI event max size - cmd_complete overhead - response fields) / sizeof(group) (255 - 4 - 3) / 6 = 41 groups max
| #define BT_CONN_LE_PHY_PARAM | ( | _pref_tx_phy, | |
| _pref_rx_phy ) |
#include <conn.h>
Helper to declare PHY parameters inline.
| _pref_tx_phy | Bitmask of preferred transmit PHYs. |
| _pref_rx_phy | Bitmask of preferred receive PHYs. |
| #define BT_CONN_LE_PHY_PARAM_1M |
#include <conn.h>
Only LE 1M PHY.
| #define BT_CONN_LE_PHY_PARAM_2M |
| #define BT_CONN_LE_PHY_PARAM_ALL |
#include <conn.h>
All LE PHYs.
| #define BT_CONN_LE_PHY_PARAM_CODED |
#include <conn.h>
Only LE Coded PHY.
| #define BT_CONN_LE_PHY_PARAM_INIT | ( | _pref_tx_phy, | |
| _pref_rx_phy ) |
#include <conn.h>
Initialize PHY parameters.
| _pref_tx_phy | Bitmask of preferred transmit PHYs. |
| _pref_rx_phy | Bitmask of preferred receive PHYs. |
| #define BT_CONN_PARAM_REJECT_ERR_L2CAP_CPUP 0xFF |
#include <conn.h>
Synthetic error value for an L2CAP Connection Parameter Update Procedure (CPUP) rejection.
Passed as the hci_err argument to bt_conn_cb::le_param_update_rejected when the remote peer does not support the HCI Connection Parameter Request (CPR) procedure and the L2CAP CPUP fallback is rejected instead. This is a host-internal sentinel; it is not a real HCI error code.
| #define BT_CONN_SCI_INTERVAL_TO_US | ( | _interval | ) |
#include <conn.h>
Convert shorter connection interval to microseconds.
Multiply by 125 to get microseconds.
| #define BT_LE_CONN_PARAM | ( | int_min, | |
| int_max, | |||
| lat, | |||
| to ) |
#include <conn.h>
Helper to declare connection parameters inline.
| int_min | Minimum Connection Interval (N * 1.25 ms) |
| int_max | Maximum Connection Interval (N * 1.25 ms) |
| lat | Connection Latency |
| to | Supervision Timeout (N * 10 ms) |
| #define BT_LE_CONN_PARAM_DEFAULT |
#include <conn.h>
Default LE connection parameters: Connection Interval: 30-50 ms Latency: 0 Timeout: 4 s.
| #define BT_LE_CONN_PARAM_INIT | ( | int_min, | |
| int_max, | |||
| lat, | |||
| to ) |
#include <conn.h>
Initialize connection parameters.
| int_min | Minimum Connection Interval (N * 1.25 ms) |
| int_max | Maximum Connection Interval (N * 1.25 ms) |
| lat | Connection Latency |
| to | Supervision Timeout (N * 10 ms) |
| #define BT_LE_DATA_LEN_PARAM_DEFAULT |
#include <conn.h>
Default LE data length parameters.
| #define BT_LE_DATA_LEN_PARAM_MAX |
| #define BT_PASSKEY_RAND 0xffffffff |
#include <conn.h>
Special passkey value that can be used to generate a random passkey when using the app_passkey callback from bt_conn_auth_cb.
| anonymous enum |
| anonymous enum |
| anonymous enum |
#include <conn.h>
Connection PHY options.
| anonymous enum |
#include <conn.h>
| Enumerator | |
|---|---|
| BT_CONN_ROLE_CENTRAL | |
| BT_CONN_ROLE_PERIPHERAL | |
| anonymous enum |
#include <conn.h>
| Enumerator | |
|---|---|
| BT_CONN_LE_OPT_NONE | Convenience value when no options are specified. |
| BT_CONN_LE_OPT_CODED | Enable LE Coded PHY. Enable scanning on the LE Coded PHY. |
| BT_CONN_LE_OPT_NO_1M | Disable LE 1M PHY. Disable scanning on the LE 1M PHY.
|
#include <conn.h>
Passkey Keypress Notification type.
The numeric values are the same as in the Core specification for Pairing Keypress Notification PDU.
| Enumerator | |
|---|---|
| BT_CONN_AUTH_KEYPRESS_ENTRY_STARTED | |
| BT_CONN_AUTH_KEYPRESS_DIGIT_ENTERED | |
| BT_CONN_AUTH_KEYPRESS_DIGIT_ERASED | |
| BT_CONN_AUTH_KEYPRESS_CLEARED | |
| BT_CONN_AUTH_KEYPRESS_ENTRY_COMPLETED | |
#include <conn.h>
Supported AA-Only RTT precision.
#include <conn.h>
Supported Random Payload RTT precision.
#include <conn.h>
Supported Sounding Sequence RTT precision.
#include <conn.h>
Channel sounding channel sequence shape.
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_CH3C_SHAPE_HAT | Use Hat shape for user-specified channel sequence. |
| BT_CONN_LE_CS_CH3C_SHAPE_X | Use X shape for user-specified channel sequence. |
#include <conn.h>
Channel sounding channel selection type.
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_CHSEL_TYPE_3B | Use Channel Selection Algorithm #3b for non-mode-0 CS steps. |
| BT_CONN_LE_CS_CHSEL_TYPE_3C | Use Channel Selection Algorithm #3c for non-mode-0 CS steps. |
| enum bt_conn_le_cs_mode |
#include <conn.h>
Channel sounding mode (main and sub-mode).
Represents the combination of Channel Sounding (CS) main mode and sub-mode.
#include <conn.h>
Procedure abort reason.
#include <conn.h>
Procedure done status.
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_PROCEDURE_COMPLETE | |
| BT_CONN_LE_CS_PROCEDURE_INCOMPLETE | |
| BT_CONN_LE_CS_PROCEDURE_ABORTED | |
#include <conn.h>
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_PROCEDURES_DISABLED | |
| BT_CONN_LE_CS_PROCEDURES_ENABLED | |
| enum bt_conn_le_cs_role |
#include <conn.h>
Channel sounding role.
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_ROLE_INITIATOR | CS initiator role. |
| BT_CONN_LE_CS_ROLE_REFLECTOR | CS reflector role. |
#include <conn.h>
Channel sounding RTT type.
#include <conn.h>
Subevent abort reason.
#include <conn.h>
Subevent done status.
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_SUBEVENT_COMPLETE | |
| BT_CONN_LE_CS_SUBEVENT_ABORTED | |
#include <conn.h>
Channel sounding PHY used for CS sync.
| Enumerator | |
|---|---|
| BT_CONN_LE_CS_SYNC_1M_PHY | LE 1M PHY. |
| BT_CONN_LE_CS_SYNC_2M_PHY | LE 2M PHY. |
| BT_CONN_LE_CS_SYNC_2M_2BT_PHY | LE 2M 2BT PHY. |
#include <conn.h>
CS Test Tone Antenna Config Selection.
See Bluetooth Core Specification, Vol 6, Part A, Section 5.3 and Bluetooth Core Specification, Vol 6, Part H, Section 4.7
These enum values are indices in the following table, where N_AP is the maximum number of antenna paths (in the range [1, 4]).
+-----------—+----------—+--------------------—+--------------------—+-----—+ | Config Index | Total Paths | Initiator: # Antennas | Reflector: # Antennas | Config | +-----------—+----------—+--------------------—+--------------------—+-----—+ | 0 | 1 | 1 | 1 | 1:1 | | 1 | 2 | 2 | 1 | N_AP:1 | | 2 | 3 | 3 | 1 | N_AP:1 | | 3 | 4 | 4 | 1 | N_AP:1 | | 4 | 2 | 1 | 2 | 1:N_AP | | 5 | 3 | 1 | 3 | 1:N_AP | | 6 | 4 | 1 | 4 | 1:N_AP | | 7 | 4 | 2 | 2 | 2:2 | +-----------—+----------—+--------------------—+--------------------—+-----—+
There are therefore four groups of possible antenna configurations:
#include <conn.h>
Frame space update initiator.
#include <conn.h>
Path Loss zone that has been entered.
The path loss zone that has been entered in the most recent LE Path Loss Monitoring Threshold Change event as documented in Core Spec. Version 5.4 Vol.4, Part E, 7.7.65.32.
#include <conn.h>
| enum bt_conn_state |
#include <conn.h>
| enum bt_conn_type |
#include <conn.h>
Connection Type.
| Enumerator | |
|---|---|
| BT_CONN_TYPE_LE | LE Connection Type. |
| BT_CONN_TYPE_BR | BR/EDR Connection Type. |
| BT_CONN_TYPE_SCO | SCO Connection Type. |
| BT_CONN_TYPE_ISO | ISO Connection Type. |
| BT_CONN_TYPE_ALL | All Connection Type. |
| enum bt_security_err |
#include <conn.h>
| enum bt_security_flag |
#include <conn.h>
Security Info Flags.
| Enumerator | |
|---|---|
| BT_SECURITY_FLAG_SC | Paired with Secure Connections. |
| BT_SECURITY_FLAG_OOB | Paired with Out of Band method. |
| enum bt_security_t |
#include <conn.h>
Security level.
| int bt_conn_cb_register | ( | struct bt_conn_cb * | cb | ) |
#include <conn.h>
Register connection callbacks.
Register callbacks to monitor the state of connections.
| cb | Callback struct. Must point to memory that remains valid. |
| 0 | Success. |
| -EEXIST | if cb was already registered. |
| int bt_conn_cb_unregister | ( | struct bt_conn_cb * | cb | ) |
#include <conn.h>
Unregister connection callbacks.
Unregister the state of connections callbacks.
| cb | Callback struct point to memory that remains valid. |
| 0 | Success |
| -EINVAL | If cb is NULL |
| -ENOENT | if cb was not registered |
| int bt_conn_create_auto_stop | ( | void | ) |
#include <conn.h>
Stop automatic connect creation.
#include <conn.h>
Disconnect from a remote device or cancel pending connection.
Disconnect an active connection with the specified reason code or cancel pending outgoing connection.
The disconnect reason for a normal disconnect should be: BT_HCI_ERR_REMOTE_USER_TERM_CONN.
The following disconnect reasons are accepted:
| conn | Connection to disconnect. |
| reason | Reason code for the disconnection. |
| void bt_conn_drop | ( | struct bt_conn ** | orig | ) |
#include <conn.h>
Drop a connection reference and clear the pointer.
This performs an atomic exchange on orig, setting it to NULL and unreferencing the previous value if it was not NULL.
| orig | Pointer to the connection pointer to drop (must not be NULL). On return, *orig is set to NULL. |
#include <conn.h>
Get encryption key size.
This function gets encryption key size. If there is no security (encryption) enabled 0 will be returned.
| conn | BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection object. |
conn is not a valid BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection. | void bt_conn_foreach | ( | enum bt_conn_type | type, |
| void(* | func )(struct bt_conn *conn, void *data), | ||
| void * | data ) |
#include <conn.h>
Iterate through all bt_conn objects.
Iterates through all bt_conn objects that are alive in the Host allocator.
To find established connections, combine this with bt_conn_get_info. Check that bt_conn_info::state is BT_CONN_STATE_CONNECTED.
Thread safety: This API is thread safe, but it does not guarantee a sequentially-consistent view for objects allocated during the current invocation of this API. E.g. If preempted while allocations A then B then C happen then results may include A and C but miss B.
| type | Connection Type |
| func | Function to call for each connection. |
| data | Data to pass to the callback function. |
| const bt_addr_le_t * bt_conn_get_dst | ( | const struct bt_conn * | conn | ) |
#include <conn.h>
Get destination (peer) address of a connection.
| conn | Connection object. |
conn is a valid BT_CONN_TYPE_LE connection | int bt_conn_get_info | ( | const struct bt_conn * | conn, |
| struct bt_conn_info * | info ) |
#include <conn.h>
Get connection info.
| conn | Connection object. |
| info | Connection info object. |
| int bt_conn_get_remote_info | ( | const struct bt_conn * | conn, |
| struct bt_conn_remote_info * | remote_info ) |
#include <conn.h>
Get connection info for the remote device.
| conn | BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection object. |
| remote_info | Connection remote info object. |
CONFIG_BT_REMOTE_VERSIONmust be enabled
conn is not a valid BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection. | bt_security_t bt_conn_get_security | ( | const struct bt_conn * | conn | ) |
#include <conn.h>
Get security level for a connection.
| conn | BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection object. |
CONFIG_BT_SMPor
CONFIG_BT_CLASSICis enabled, else BT_SECURITY_L1
conn is not a valid BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection. | bool bt_conn_is_type | ( | const struct bt_conn * | conn, |
| enum bt_conn_type | type ) |
#include <conn.h>
Function to determine the type of a connection.
| conn | The connection object |
| type | The types to check against. It is possible to supply multiple types, e.g. BT_CONN_TYPE_LE | BT_CONN_TYPE_SCO. |
| int bt_conn_le_conn_rate_request | ( | struct bt_conn * | conn, |
| const struct bt_conn_le_conn_rate_param * | params ) |
#include <conn.h>
Request New Connection Rate Parameters.
Request a change to the connection parameters of a connection. This includes Subrate parameters. This allows changing the connection interval to below the Baseline ConnInterval Values (BCV) and with finer granularity, if supported.
Valid intervals of the local and peer controller should be known. See bt_conn_le_read_min_conn_interval_groups
CONFIG_BT_SHORTER_CONNECTION_INTERVALS.
| conn | BT_CONN_TYPE_LE connection object. |
| params | Connection rate parameters. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_conn_rate_set_defaults | ( | const struct bt_conn_le_conn_rate_param * | params | ) |
#include <conn.h>
Set Default Connection Rate Parameters.
Configure the range of Connection Rate values that this device will accept from a Peripheral initiating a Connection Rate Update procedure.
The configured bounds:
CONFIG_BT_SHORTER_CONNECTION_INTERVALS,
CONFIG_BT_CENTRAL.
| params | Connection rate parameters. |
| int bt_conn_le_create | ( | const bt_addr_le_t * | peer, |
| const struct bt_conn_le_create_param * | create_param, | ||
| const struct bt_le_conn_param * | conn_param, | ||
| struct bt_conn ** | conn ) |
#include <conn.h>
Initiate an LE connection to a remote device.
Allows initiate new LE link to remote peer using its address.
The caller gets a new reference to the connection object which must be released with bt_conn_unref() once done using the object. If
CONFIG_BT_CONN_CHECK_NULL_BEFORE_CREATE
is enabled, this function will return -EINVAL if dereferenced conn is not NULL.
This uses the General Connection Establishment procedure.
The application must disable explicit scanning before initiating a new LE connection if
CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL
is not enabled.
| [in] | peer | Remote address. |
| [in] | create_param | Create connection parameters. |
| [in] | conn_param | Initial connection parameters. |
| [out] | conn | Valid connection object on success. |
| int bt_conn_le_create_auto | ( | const struct bt_conn_le_create_param * | create_param, |
| const struct bt_le_conn_param * | conn_param ) |
#include <conn.h>
Automatically connect to remote devices in the filter accept list.
This uses the Auto Connection Establishment procedure. The procedure will continue until a single connection is established or the procedure is stopped through bt_conn_create_auto_stop. To establish connections to all devices in the filter accept list the procedure should be started again in the connected callback after a new connection has been established.
| create_param | Create connection parameters |
| conn_param | Initial connection parameters. |
| int bt_conn_le_create_synced | ( | const struct bt_le_ext_adv * | adv, |
| const struct bt_conn_le_create_synced_param * | synced_param, | ||
| const struct bt_le_conn_param * | conn_param, | ||
| struct bt_conn ** | conn ) |
#include <conn.h>
Create a connection to a synced device.
Initiate a connection to a synced device from a Periodic Advertising with Responses (PAwR) train.
The caller gets a new reference to the connection object which must be released with bt_conn_unref() once done using the object. If
CONFIG_BT_CONN_CHECK_NULL_BEFORE_CREATE
is enabled, this function will return -EINVAL if dereferenced conn is not NULL.
This uses the Periodic Advertising Connection Procedure.
| [in] | adv | The adverting set the PAwR advertiser belongs to. |
| [in] | synced_param | Create connection parameters. |
| [in] | conn_param | Initial connection parameters. |
| [out] | conn | Valid connection object on success. |
| int bt_conn_le_data_len_update | ( | struct bt_conn * | conn, |
| const struct bt_conn_le_data_len_param * | param ) |
#include <conn.h>
Update the connection transmit data length parameters.
| conn | BT_CONN_TYPE_LE connection object. |
| param | Updated data length parameters. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_enhanced_get_tx_power_level | ( | struct bt_conn * | conn, |
| struct bt_conn_le_tx_power * | tx_power ) |
#include <conn.h>
Get local enhanced connection transmit power level.
| conn | BT_CONN_TYPE_LE connection object. |
| tx_power | Transmit power level descriptor. |
| -ENOBUFS | HCI command buffer is not available. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_frame_space_update | ( | struct bt_conn * | conn, |
| const struct bt_conn_le_frame_space_update_param * | params ) |
#include <conn.h>
Update frame space.
Request a change to the frame space parameters of a connection. This function will trigger the frame_space_updated callback when the procedure is completed.
CONFIG_BT_FRAME_SPACE_UPDATE..
| conn | BT_CONN_TYPE_LE connection object. |
| params | Frame Space Update parameters. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_get_remote_tx_power_level | ( | struct bt_conn * | conn, |
| enum bt_conn_le_tx_power_phy | phy ) |
#include <conn.h>
Get remote (peer) transmit power level.
| conn | BT_CONN_TYPE_LE connection object. |
| phy | PHY information. |
| -ENOBUFS | HCI command buffer is not available. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_get_tx_power_level | ( | struct bt_conn * | conn, |
| struct bt_conn_le_tx_power * | tx_power_level ) |
#include <conn.h>
Get connection transmit power level.
| conn | BT_CONN_TYPE_LE connection object. |
| tx_power_level | Transmit power level descriptor. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_param_update | ( | struct bt_conn * | conn, |
| const struct bt_le_conn_param * | param ) |
#include <conn.h>
Update the connection parameters.
If the local device is in the peripheral role then updating the connection parameters will be delayed. This delay can be configured by through the
CONFIG_BT_CONN_PARAM_UPDATE_TIMEOUT
option.
| conn | BT_CONN_TYPE_LE connection object. |
| param | Updated connection parameters. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_phy_update | ( | struct bt_conn * | conn, |
| const struct bt_conn_le_phy_param * | param ) |
#include <conn.h>
Update the connection PHY parameters.
Update the preferred transmit and receive PHYs of the connection. Use BT_GAP_LE_PHY_NONE to indicate no preference.
| conn | BT_CONN_TYPE_LE connection object. |
| param | Updated connection parameters. |
conn is not a valid BT_CONN_TYPE_LE connection. #include <conn.h>
Read remote feature pages.
Request remote feature pages, from 0 up to pages_requested or the number of pages supported by the peer. There is a maximum of 10 pages. This function will trigger the read_all_remote_feat_complete callback when the procedure is completed.
CONFIG_BT_LE_EXTENDED_FEAT_SET.
| conn | BT_CONN_TYPE_LE connection object. |
| pages_requested | Number of feature pages to be requested from peer. There is a maximum of 10 pages. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_read_min_conn_interval | ( | uint16_t * | min_interval_us | ) |
#include <conn.h>
Read Minimum Supported Connection Interval.
Read the minimum supported connection interval from the local controller.
CONFIG_BT_SHORTER_CONNECTION_INTERVALS.
| min_interval_us | Pointer to variable to receive the minimum connection interval in microseconds. |
| int bt_conn_le_read_min_conn_interval_groups | ( | struct bt_conn_le_min_conn_interval_info * | info | ) |
#include <conn.h>
Read Minimum Supported Connection Interval Groups.
Read the minimum supported connection interval and supported interval groups from the local controller. This information describes what the local controller supports.
CONFIG_BT_SHORTER_CONNECTION_INTERVALS.
| info | Pointer to structure to receive the minimum connection interval information. |
#include <conn.h>
Update the default PHY parameters to be used for all subsequent connections over the LE transport.
Update the preferred transmit and receive PHYs of LE transport. Use BT_GAP_LE_PHY_NONE to indicate no preference. For possible PHY values see bt_gap_le_phy.
| pref_tx_phy | Preferred transmitter phy parameters. |
| pref_rx_phy | Preferred receiver phy parameters. |
#include <conn.h>
Enable or Disable Path Loss Monitoring.
Enable or disable Path Loss Monitoring, which will decide whether Path Loss Threshold events are sent from the controller to the host.
CONFIG_BT_PATH_LOSS_MONITORINGmust be set.
| conn | BT_CONN_TYPE_LE connection object. |
| enable | Enable/disable path loss reporting. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_set_path_loss_mon_param | ( | struct bt_conn * | conn, |
| const struct bt_conn_le_path_loss_reporting_param * | param ) |
#include <conn.h>
Set Path Loss Monitoring Parameters.
Change the configuration for path loss threshold change events for a given conn handle.
CONFIG_BT_PATH_LOSS_MONITORINGmust be set.
| conn | BT_CONN_TYPE_LE connection object. |
| param | Path Loss Monitoring parameters |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_set_tx_power_report_enable | ( | struct bt_conn * | conn, |
| bool | local_enable, | ||
| bool | remote_enable ) |
#include <conn.h>
Enable transmit power reporting.
| conn | BT_CONN_TYPE_LE connection object. |
| local_enable | Enable/disable reporting for local. |
| remote_enable | Enable/disable reporting for remote. |
| -ENOBUFS | HCI command buffer is not available. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_subrate_request | ( | struct bt_conn * | conn, |
| const struct bt_conn_le_subrate_param * | params ) |
#include <conn.h>
Request New Subrating Parameters.
Request a change to the subrating parameters of a connection.
CONFIG_BT_SUBRATINGmust be set.
| conn | BT_CONN_TYPE_LE connection object. |
| params | Subrating parameters. |
conn is not a valid BT_CONN_TYPE_LE connection. | int bt_conn_le_subrate_set_defaults | ( | const struct bt_conn_le_subrate_param * | params | ) |
#include <conn.h>
Set Default Connection Subrating Parameters.
Change the default subrating parameters for all future ACL connections where the local device is the central. This command does not affect any existing connection. Parameters set for specific connection will always have precedence.
CONFIG_BT_SUBRATINGand
CONFIG_BT_CENTRALmust be set.
| params | Subrating parameters. |
| struct bt_conn * bt_conn_lookup_addr_le | ( | uint8_t | id, |
| const bt_addr_le_t * | peer ) |
#include <conn.h>
Look up an existing connection by address.
Look up an existing connection based on the remote address.
The caller gets a new reference to the connection object which must be released with bt_conn_unref() once done using the object.
| id | Local identity (in most cases BT_ID_DEFAULT). |
| peer | Remote address. |
#include <conn.h>
Increment a connection's reference count.
Increment the reference count of a connection object.
| conn | Connection object. |
#include <conn.h>
Set/clear the bonding flag for a given connection.
Set/clear the Bonding flag in the Authentication Requirements of SMP Pairing Request/Response data for a given connection.
The bonding flag for a given connection cannot be set/cleared if security procedures in the SMP module have already started. This function can be called only once per connection.
If the bonding flag is not set/cleared for a given connection, the value will depend on global configuration which is set using bt_set_bondable. The default value of the global configuration is defined using CONFIG_BT_BONDABLE Kconfig option.
| conn | BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection object. |
| enable | Value allowing/disallowing to be bondable. |
| 0 | Success |
| -EALREADY | Already in the requested state |
conn is not a valid BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection conn is a valid BT_CONN_TYPE_LE but could not get SMP context | int bt_conn_set_security | ( | struct bt_conn * | conn, |
| bt_security_t | sec ) |
#include <conn.h>
Set security level for a connection.
This function enable security (encryption) for a connection. If the device has bond information for the peer with sufficiently strong key encryption will be enabled. If the connection is already encrypted with sufficiently strong key this function does nothing.
If the device has no bond information for the peer and is not already paired then the pairing procedure will be initiated. Note that sec has no effect on the security level selected for the pairing process. The selection is instead controlled by the values of the registered bt_conn_auth_cb. If the device has bond information or is already paired and the keys are too weak then the pairing procedure will be initiated.
This function may return an error if the required level of security defined using sec is not possible to achieve due to local or remote device limitation (e.g., input output capabilities), or if the maximum number of paired devices has been reached.
This function may return an error if the pairing procedure has already been initiated by the local device or the peer device.
CONFIG_BT_SMP_SC_ONLYis enabled then the security level will always be level 4.
CONFIG_BT_SMP_OOB_LEGACY_PAIR_ONLYis enabled then the security level will always be level 3.
sec is enabled then the pairing procedure will always be initiated.| conn | BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection object. |
| sec | Requested minimum security level. |
conn is not a valid BT_CONN_TYPE_LE or BT_CONN_TYPE_BR connection. #include <conn.h>
Take ownership of a connection pointer, setting the original to NULL.
This performs an atomic exchange on orig, setting it to NULL and returning the previous value. The reference count is not modified; the reference held by orig is transferred to the caller, who must eventually release it with bt_conn_unref().
| orig | Pointer to the connection pointer to transfer (must not be NULL). On return, *orig is set to NULL. |
orig, which may be NULL. | void bt_conn_unref | ( | struct bt_conn * | conn | ) |
#include <conn.h>
Decrement a connection's reference count.
Decrement the reference count of a connection object. Unless the pointer variable is immediately going out of scope, it's recommended to use bt_conn_drop instead, which will also set the pointer to NULL to prevent accidental reuse.
| conn | Connection object. |
| bool bt_get_bondable | ( | void | ) |
#include <conn.h>
Get bonding flag.
Get current bonding flag. The initial value of this flag depends on
CONFIG_BT_BONDABLE
Kconfig setting. The Bonding flag can be updated using bt_set_bondable().
| int bt_le_oob_get_sc_data | ( | struct bt_conn * | conn, |
| const struct bt_le_oob_sc_data ** | oobd_local, | ||
| const struct bt_le_oob_sc_data ** | oobd_remote ) |
#include <conn.h>
Get OOB data used for LE Secure Connections (SC) pairing procedure.
This function allows to get OOB data during the LE SC pairing procedure that were set by the bt_le_oob_set_sc_data() API.
| conn | BT_CONN_TYPE_LE connection object. |
| oobd_local | Local OOB data or NULL if not set |
| oobd_remote | Remote OOB data or NULL if not set |
conn is not a valid BT_CONN_TYPE_LE connection. | void bt_le_oob_set_legacy_flag | ( | bool | enable | ) |
#include <conn.h>
Allow/disallow remote legacy OOB data to be used for pairing.
Set/clear the OOB data flag for legacy SMP Pairing Request/Response data.
| enable | Value allowing/disallowing remote legacy OOB data. |
#include <conn.h>
Set OOB Temporary Key to be used for pairing.
This function allows to set OOB data for the LE legacy pairing procedure. The function should only be called in response to the oob_data_request() callback provided that the legacy method is user pairing.
| conn | BT_CONN_TYPE_LE connection object. |
| tk | Pointer to 16 byte long TK array. The TK value should be generated randomly for each new pairing process. |
| 0 | Success |
conn is not a valid BT_CONN_TYPE_LE connection. tk is NULL. | int bt_le_oob_set_sc_data | ( | struct bt_conn * | conn, |
| const struct bt_le_oob_sc_data * | oobd_local, | ||
| const struct bt_le_oob_sc_data * | oobd_remote ) |
#include <conn.h>
Set OOB data during LE Secure Connections (SC) pairing procedure.
This function allows to set OOB data during the LE SC pairing procedure. The function should only be called in response to the oob_data_request() callback provided that LE SC method is used for pairing.
The user should submit OOB data according to the information received in the callback. This may yield three different configurations: with only local OOB data present, with only remote OOB data present or with both local and remote OOB data present.
| conn | BT_CONN_TYPE_LE connection object. |
| oobd_local | Local OOB data or NULL if not present |
| oobd_remote | Remote OOB data or NULL if not present |
conn is not a valid BT_CONN_TYPE_LE connection. | void bt_le_oob_set_sc_flag | ( | bool | enable | ) |
#include <conn.h>
Allow/disallow remote LE SC OOB data to be used for pairing.
Set/clear the OOB data flag for LE SC SMP Pairing Request/Response data.
| enable | Value allowing/disallowing remote LE SC OOB data. |
|
inlinestatic |
#include <conn.h>
Converts a security error to string.
CONFIG_BT_SECURITY_ERR_TO_STRis not enabled, this just returns the empty string
| void bt_set_bondable | ( | bool | enable | ) |
#include <conn.h>
Enable/disable bonding.
Set/clear the Bonding flag in the Authentication Requirements of SMP Pairing Request/Response data. The initial value of this flag depends on BT_BONDABLE Kconfig setting. For the vast majority of applications calling this function shouldn't be needed.
| enable | Value allowing/disallowing to be bondable. |
| union { ... } bt_conn_remote_info |
| union { ... } bt_conn_le_info |
| union { ... } bt_conn_info |
Connection Type specific Info.
| union { ... } bt_conn_oob_info |
| uint8_t { ... } ::abort_step |
Step number, on which the subevent was aborted if subevent_done_status is BT_CONN_LE_CS_SUBEVENT_COMPLETE then abort_step will be unused and set to 255.
| uint8_t bt_conn_le_cs_subevent_result::abort_step |
Step number, on which the subevent was aborted if subevent_done_status is BT_CONN_LE_CS_SUBEVENT_COMPLETE then abort_step will be unused and set to 255.
| uint8_t bt_conn_sco_info::air_mode |
SCO air mode (codec type).
Allow the application to provide a passkey for pairing.
If implemented, this callback allows the application to provide passkeys for pairing. The valid range of passkeys is 0 - 999999. The application shall return the passkey for pairing, or BT_PASSKEY_RAND to generate a random passkey. This callback is invoked only for the Passkey Entry method as defined in Core Specification Vol. 3, Part H. Which device in the pairing is showing the passkey depends on the IO capabilities of the device; see Table 2.8 of the Bluetooth Core Specification V6.0, Vol. 3, Part H for more details. For the purposes of this table, the device gains the "display" capability when this callback is non-NULL. This is irrespective of whether the callback returns a specified key or BT_PASSKEY_RAND.
| conn | Connection where pairing is currently active. |
| uint8_t bt_conn_pairing_feat::auth_req |
AuthReq, Core Spec.
Vol 3, Part H, 3.5.1, Fig. 3.3
| struct bt_conn_br_cb bt_conn_cb::br |
BR/EDR specific callbacks.
| struct bt_conn_br_info { ... } ::br |
BR/EDR Connection specific Info.
| struct bt_conn_br_info bt_conn_info::br |
BR/EDR Connection specific Info.
| struct bt_conn_br_remote_info { ... } ::br |
BR/EDR connection remote info.
| struct bt_conn_br_remote_info bt_conn_remote_info::br |
BR/EDR connection remote info.
| void(* bt_conn_auth_cb::cancel) (struct bt_conn *conn) |
Cancel the ongoing user request.
This callback will be called to notify the application that it should cancel any previous user request (passkey display, entry or confirmation).
This may be set to NULL, but must always be provided whenever the passkey_display, passkey_entry passkey_confirm or pairing_confirm callback has been provided.
| conn | Connection where pairing is currently active. |
| uint8_t bt_conn_le_cs_config::ch3c_jump |
Number of channels skipped in each rising and falling sequence.
| enum bt_conn_le_cs_ch3c_shape bt_conn_le_cs_config::ch3c_shape |
User-specified channel sequence shape.
| uint8_t bt_conn_le_cs_config::channel_map[10] |
Channel map used for CS procedure Channels n = 0, 1, 23, 24, 25, 77, and 78 are not allowed and shall be set to zero.
Channel 79 is reserved for future use and shall be set to zero. At least 15 channels shall be enabled.
| uint8_t bt_conn_le_cs_config::channel_map_repetition |
The number of times the Channel_Map field will be cycled through for non-mode-0 steps within a CS procedure.
| enum bt_conn_le_cs_chsel_type bt_conn_le_cs_config::channel_selection_type |
Channel selection type.
| bool bt_conn_le_cs_capabilities::chsel_alg_3c_supported |
Subfeature: Channel Selection Algorithm #3c.
| uint8_t bt_conn_le_cs_procedure_enable_complete::config_id |
| uint8_t { ... } ::config_id |
CS configuration identifier.
Range: 0 to 3
If these results were generated by a CS Test, this value will be set to 0 and has no meaning.
| uint8_t bt_conn_le_cs_subevent_result::config_id |
CS configuration identifier.
Range: 0 to 3
If these results were generated by a CS Test, this value will be set to 0 and has no meaning.
| void(* bt_conn_cb::conn_rate_changed) (struct bt_conn *conn, uint8_t status, const struct bt_conn_le_conn_rate_changed *params) |
LE Connection Rate Changed event.
This callback notifies the application that the connection rate parameters (including both connection interval and subrating) of the connection may have changed.
| conn | Connection object. |
| status | HCI Status from LE Connection Rate Change event. Possible Status codes:
|
| params | New connection rate parameters. The connection rate parameters will be NULL if status is not BT_HCI_ERR_SUCCESS. |
A new connection has been established.
This callback notifies the application of a new connection. In case the err parameter is non-zero it means that the connection establishment failed.
| conn | New connection object. |
| err | HCI error. Zero for success, non-zero otherwise. |
err can mean either of the following:
CONFIG_BT_CREATE_CONN_TIMEOUTseconds.
BT_HCI_ERR_ADV_TIMEOUT High duty cycle directed connectable advertiser started by bt_le_adv_start failed to be connected within the timeout. | uint16_t bt_conn_le_conn_rate_changed::continuation_number |
Number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received.
Range: BT_HCI_LE_CONTINUATION_NUM_MIN - BT_HCI_LE_CONTINUATION_NUM_MAX
| uint16_t bt_conn_le_conn_rate_param::continuation_number |
Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received.
Range: BT_HCI_LE_CONTINUATION_NUM_MIN - BT_HCI_LE_CONTINUATION_NUM_MAX
| uint16_t bt_conn_le_subrate_changed::continuation_number |
Number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received.
| uint16_t bt_conn_le_subrate_param::continuation_number |
Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received.
| uint16_t bt_conn_le_subrating_info::continuation_number |
Number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received.
| uint8_t bt_conn_le_cs_config::cs_enhancements_1 |
CS enhancements 1 Bit 0 - IPT is enabled in the CS reflector.
All other bits are reserved and shall be set to 0.
| bool bt_conn_le_cs_capabilities::cs_ipt_reflector |
Subfeature: IPT in the CS reflector.
| bool bt_conn_le_cs_capabilities::cs_sync_2m_2bt_phy_supported |
CS_SYNC LE 2M 2BT PHY.
| bool bt_conn_le_cs_capabilities::cs_sync_2m_phy_supported |
CS_SYNC LE 2M PHY.
| enum bt_conn_le_cs_sync_phy bt_conn_le_cs_config::cs_sync_phy |
CS Sync PHY.
| bool bt_conn_le_cs_capabilities::cs_without_fae_supported |
Subfeature: CS with no Frequency Actuation Error.
| void(* bt_conn_cb::cte_report_cb) (struct bt_conn *conn, const struct bt_df_conn_iq_samples_report *iq_report) |
Callback for IQ samples report collected when sampling CTE received by data channel PDU.
| conn | The connection object. |
| iq_report | Report data for collected IQ samples. |
| int8_t bt_conn_le_tx_power::current_level |
Output: current transmit power level in dBm.
Range depends on which HCI command is used:
phy is 0 (HCI_Read_Transmit_Power_Level)phy is non-zero (HCI_LE_Enhanced_Read_Transmit_Power_Level) | const struct bt_conn_le_data_len_info* bt_conn_le_info::data_len |
Connection maximum single fragment parameters.
| int8_t bt_conn_le_tx_power_report::delta |
Change in transmit power level.
A connection has been disconnected.
This callback notifies the application that a connection has been disconnected.
When this callback is called the stack still has one reference to the connection object. If the application in this callback tries to start either a connectable advertiser or create a new connection this might fail because there are no free connection objects available. To avoid this issue, it's recommended to rely instead on bt_conn_cb::recycled which notifies the application when a connection object has actually been freed.
| conn | Connection object. |
| reason | BT_HCI_ERR_* reason for the disconnection. |
| const bt_addr_t* bt_conn_br_info::dst |
Destination (Remote) BR/EDR address.
| const bt_addr_le_t* bt_conn_le_info::dst |
Destination (Remote) Identity Address or remote Resolvable Private Address (RPA) before identity has been resolved.
| uint8_t bt_security_info::enc_key_size |
Encryption Key Size.
| uint16_t bt_conn_le_cs_procedure_enable_complete::event_interval |
| uint16_t bt_conn_le_subrate_changed::factor |
Connection subrate factor.
| uint16_t bt_conn_le_subrating_info::factor |
Connection subrate factor.
| const uint8_t* bt_conn_br_remote_info::features |
Remote feature set (pages of bitmasks).
| const uint8_t* bt_conn_le_read_all_remote_feat_complete::features |
Pointer to array of size 248, with feature bits of remote supported features.
Page 0 being 8 bytes, with the following 10 pages of 24 bytes. Refer to BT_LE_FEAT_BIT_* for values. Refer to the BT_FEAT_LE_* macros for value comparison. See Bluetooth Core Specification, Vol 6, Part B, Section 4.6.
| const uint8_t* bt_conn_le_remote_info::features |
Remote LE feature set (bitmask).
| enum bt_security_flag bt_security_info::flags |
Flags.
| uint16_t bt_conn_le_frame_space_updated::frame_space |
Updated frame space in microseconds.
| uint16_t bt_conn_le_frame_space_update_param::frame_space_max |
Maximum frame space in microseconds.
Bluetooth Core Specification, Vol 4, Part E, Section 7.8.151 allows for a range of frame space from 0 to 10000 microseconds. The actual supported frame space values will be dependent on the controller's capabilities.
| uint16_t bt_conn_le_frame_space_update_param::frame_space_min |
Minimum frame space in microseconds.
Bluetooth Core Specification, Vol 4, Part E, Section 7.8.151 allows for a range of frame space from 0 to 10000 microseconds. The actual supported frame space values will be dependent on the controller's capabilities.
| void(* bt_conn_cb::frame_space_updated) (struct bt_conn *conn, const struct bt_conn_le_frame_space_updated *params) |
Frame Space Update Complete event.
This callback notifies the application that the frame space of the connection may have changed. The frame space update parameters will be invalid if status is not BT_HCI_ERR_SUCCESS.
This callback can be triggered by calling bt_conn_le_frame_space_update, by the procedure running autonomously in the controller or by the peer.
| conn | Connection object. |
| params | New frame space update parameters. |
| uint16_t { ... } ::frequency_compensation |
Frequency compensation value in units of 0.01 ppm.
This is a 15-bit signed integer in the range [-100, 100] ppm.
A value of BT_HCI_LE_CS_SUBEVENT_RESULT_FREQ_COMPENSATION_NOT_AVAILABLE indicates that the role is not the initiator, or that the frequency compensation value is unavailable.
| uint16_t bt_conn_le_cs_subevent_result::frequency_compensation |
Frequency compensation value in units of 0.01 ppm.
This is a 15-bit signed integer in the range [-100, 100] ppm.
A value of BT_HCI_LE_CS_SUBEVENT_RESULT_FREQ_COMPENSATION_NOT_AVAILABLE indicates that the role is not the initiator, or that the frequency compensation value is unavailable.
| struct bt_conn_le_min_conn_interval_group bt_conn_le_min_conn_interval_info::groups[41] |
Array of supported connection interval groups.
Multiple groups allow representing non-contiguous or differently-strided ranges.
| struct { ... } bt_conn_le_cs_subevent_result::header |
| uint8_t bt_conn_le_path_loss_reporting_param::high_hysteresis |
Hysteresis value for the high threshold (dB).
| uint8_t bt_conn_le_path_loss_reporting_param::high_threshold |
High threshold for the path loss (dB).
| uint8_t bt_conn_info::id |
Which local identity the connection was created with.
| uint8_t bt_conn_le_cs_config::id |
CS configuration ID.
| void(* bt_conn_cb::identity_resolved) (struct bt_conn *conn, const bt_addr_le_t *rpa, const bt_addr_le_t *identity) |
Remote Identity Address has been resolved.
This callback notifies the application that a remote Identity Address has been resolved
| conn | Connection object. |
| rpa | Resolvable Private Address. |
| identity | Identity Address. |
| uint8_t bt_conn_pairing_feat::init_key_dist |
Initiator Key Distribution/Generation, Core Spec.
Vol 3, Part H, 3.6.1, Fig. 3.11
| enum bt_conn_le_frame_space_update_initiator bt_conn_le_frame_space_updated::initiator |
Initiator of the frame space update.
| bool bt_conn_le_cs_capabilities::initiator_supported |
Initiator role.
| uint16_t bt_conn_le_create_param::interval |
Scan interval (N * 0.625 ms).
CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLELis enabled and the application wants to scan and connect in parallel, the Bluetooth Controller may require the scan interval used for scanning and connection establishment to be equal to obtain the best performance.
| uint16_t { ... } ::interval |
Connection interval in units of 1.25 ms.
| uint16_t bt_conn_le_info::interval |
Connection interval in units of 1.25 ms.
| uint16_t bt_conn_le_create_param::interval_coded |
Scan interval LE Coded PHY (N * 0.625 MS).
Set zero to use same as LE 1M PHY scan interval
| uint16_t bt_le_conn_param::interval_max |
| uint16_t bt_conn_le_conn_rate_param::interval_max_125us |
Maximum connection interval.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_INTERVAL_MIN_125US - BT_HCI_LE_SCI_INTERVAL_MAX_125US
| uint16_t bt_le_conn_param::interval_min |
| uint16_t bt_conn_le_conn_rate_param::interval_min_125us |
Minimum connection interval.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_INTERVAL_MIN_125US - BT_HCI_LE_SCI_INTERVAL_MAX_125US
| uint32_t bt_conn_le_conn_rate_changed::interval_us |
Connection interval.
Unit: microseconds
Range: BT_HCI_LE_SCI_INTERVAL_MIN_US - BT_HCI_LE_SCI_INTERVAL_MAX_US
| uint32_t bt_conn_le_info::interval_us |
Connection interval in microseconds.
| uint8_t bt_conn_pairing_feat::io_capability |
IO Capability, Core Spec.
Vol 3, Part H, 3.5.1, Table 3.4
| uint16_t bt_conn_le_info::latency |
Connection peripheral latency.
| uint16_t bt_le_conn_param::latency |
| struct bt_conn_le_info { ... } ::le |
LE Connection specific Info.
| struct bt_conn_le_info bt_conn_info::le |
LE Connection specific Info.
| struct bt_conn_le_remote_info { ... } ::le |
LE connection remote info.
| struct bt_conn_le_remote_info bt_conn_remote_info::le |
LE connection remote info.
| void(* bt_conn_cb::le_cs_config_complete) (struct bt_conn *conn, uint8_t status, struct bt_conn_le_cs_config *config) |
LE CS Config created.
This callback notifies the application that a Channel Sounding Configuration procedure has completed.
If status is BT_HCI_ERR_SUCCESS, a new CS config is created.
| conn | Connection object. |
| status | HCI status of complete event. |
| config | Pointer to CS configuration on success or NULL otherwise. |
LE CS Config removed.
This callback notifies the application that a Channel Sounding Configuration procedure has completed and a CS config is removed
| conn | Connection object. |
| config_id | ID of the CS configuration that was removed. |
| void(* bt_conn_cb::le_cs_procedure_enable_complete) (struct bt_conn *conn, uint8_t status, struct bt_conn_le_cs_procedure_enable_complete *params) |
LE CS Procedure Enabled.
This callback notifies the application that a Channel Sounding Procedure Enable procedure has completed.
If status is BT_HCI_ERR_SUCCESS, CS procedure is enabled.
| conn | Connection object. |
| status | HCI status. |
| params | Pointer to CS Procedure Enable parameters on success or NULL otherwise. |
| void(* bt_conn_cb::le_cs_read_remote_capabilities_complete) (struct bt_conn *conn, uint8_t status, struct bt_conn_le_cs_capabilities *params) |
LE CS Read Remote Supported Capabilities Complete event.
This callback notifies the application that a Channel Sounding Capabilities Exchange procedure has completed.
If status is BT_HCI_ERR_SUCCESS, the remote channel sounding capabilities have been received from the peer.
| conn | Connection object. |
| status | HCI status of complete event. |
| params | Pointer to CS Capabilities on success or NULL otherwise. |
| void(* bt_conn_cb::le_cs_read_remote_fae_table_complete) (struct bt_conn *conn, uint8_t status, struct bt_conn_le_cs_fae_table *params) |
LE CS Read Remote FAE Table Complete event.
This callback notifies the application that a Channel Sounding Mode-0 FAE Table Request procedure has completed.
If status is BT_HCI_ERR_SUCCESS, the remote mode-0 FAE Table has been received from the peer.
| conn | Connection object. |
| status | HCI status of complete event. |
| params | Pointer to FAE Table on success or NULL otherwise. |
LE CS Security Enabled.
This callback notifies the application that a Channel Sounding Security Enable procedure has completed.
If status is BT_HCI_ERR_SUCCESS, CS Security is enabled.
| conn | Connection object. |
| status | HCI status of complete event. |
| void(* bt_conn_cb::le_cs_subevent_data_available) (struct bt_conn *conn, struct bt_conn_le_cs_subevent_result *result) |
Subevent Results from a CS procedure are available.
This callback notifies the user that CS subevent results are available for the given connection object.
| conn | Connection objects. |
| result | Subevent results |
| void(* bt_conn_cb::le_data_len_updated) (struct bt_conn *conn, struct bt_conn_le_data_len_info *info) |
The data length parameters of the connection has changed.
This callback notifies the application that the maximum Link Layer payload length or transmission time has changed.
| conn | Connection object. |
| info | Connection data length information. |
| bool(* bt_conn_cb::le_param_req) (struct bt_conn *conn, struct bt_le_conn_param *param) |
LE connection parameter update request.
This callback notifies the application that a remote device is requesting to update the connection parameters. The application accepts the parameters by returning true, or rejects them by returning false. Before accepting, the application may also adjust the parameters to better suit its needs.
It is recommended for an application to have just one of these callbacks for simplicity. However, if an application registers multiple it needs to manage the potentially different requirements for each callback. Each callback gets the parameters as returned by previous callbacks, i.e. they are not necessarily the same ones as the remote originally sent.
If the application does not have this callback then the default is to accept the parameters.
| conn | Connection object. |
| param | Proposed connection parameters. |
LE connection parameter update was rejected by the peer.
This callback notifies the application that a connection parameter update request initiated by bt_conn_le_param_update was rejected by the peer.
hci_err will be BT_CONN_PARAM_REJECT_ERR_L2CAP_CPUP.| conn | Connection object. |
| hci_err | HCI error code (BT_HCI_ERR_*) for CPR rejection, or BT_CONN_PARAM_REJECT_ERR_L2CAP_CPUP for L2CAP fallback rejection. |
| void(* bt_conn_cb::le_param_updated) (struct bt_conn *conn, uint16_t interval, uint16_t latency, uint16_t timeout) |
The parameters for an LE connection have been updated.
This callback notifies the application that the connection parameters for an LE connection have been updated.
| conn | Connection object. |
| interval | Connection interval. |
| latency | Connection latency. |
| timeout | Connection supervision timeout. |
| void(* bt_conn_cb::le_phy_updated) (struct bt_conn *conn, struct bt_conn_le_phy_info *param) |
The PHY of the connection has changed.
This callback notifies the application that the PHY of the connection has changed.
| conn | Connection object. |
| param | Connection LE PHY information. |
| struct { ... } bt_conn_oob_info::lesc |
LE Secure Connections OOB pairing parameters.
| struct { ... } bt_conn_oob_info::lesc |
LE Secure Connections OOB pairing parameters.
| bt_security_t bt_security_info::level |
Security Level.
| uint8_t bt_conn_sco_info::link_type |
SCO link type.
| const bt_addr_le_t* bt_conn_le_info::local |
Local device address used during connection setup.
| uint8_t bt_conn_le_path_loss_reporting_param::low_hysteresis |
Hysteresis value for the low threshold (dB).
| uint8_t bt_conn_le_path_loss_reporting_param::low_threshold |
Low threshold for the path loss (dB).
| uint8_t bt_conn_le_cs_config::main_mode_repetition |
Number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event.
| uint16_t bt_conn_remote_info::manufacturer |
Remote manufacturer identifier.
| uint16_t bt_conn_le_min_conn_interval_group::max_125us |
Upper bound of group interval range.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_INTERVAL_MIN_125US - BT_HCI_LE_SCI_INTERVAL_MAX_125US
| uint8_t bt_conn_le_cs_capabilities::max_antenna_paths_supported |
Maximum number of antenna paths.
| uint16_t bt_conn_le_conn_rate_param::max_ce_len_125us |
Maximum length of connection event.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_CE_LEN_MIN_125US - BT_HCI_LE_SCI_CE_LEN_MAX_125US
| uint16_t bt_conn_le_cs_capabilities::max_consecutive_procedures_supported |
Maximum number of consecutive CS procedures.
When set to zero, indicates support for both fixed and indefinite numbers of CS procedures before termination.
| uint8_t bt_conn_pairing_feat::max_enc_key_size |
Maximum Encryption Key Size, Core Spec.
Vol 3, Part H, 3.5.1
| uint16_t bt_conn_le_conn_rate_param::max_latency |
Maximum Peripheral latency.
Unit: subrated connection intervals bt_conn_le_conn_rate_changed::subrate_factor
Range: BT_HCI_LE_PERIPHERAL_LATENCY_MIN - BT_HCI_LE_PERIPHERAL_LATENCY_MAX
| uint16_t bt_conn_le_subrate_param::max_latency |
Maximum Peripheral latency in units of subrated connection intervals.
| int8_t bt_conn_le_tx_power::max_level |
Output: maximum transmit power level in dBm.
Range depends on which HCI command is used:
phy is 0 (HCI_Read_Transmit_Power_Level)phy is non-zero (HCI_LE_Enhanced_Read_Transmit_Power_Level) | uint8_t bt_conn_le_cs_config::max_main_mode_steps |
Maximum number of CS main mode steps to be executed before a submode step is executed.
| uint16_t bt_conn_le_cs_procedure_enable_complete::max_procedure_len |
| uint8_t bt_conn_le_read_all_remote_feat_complete::max_remote_page |
Number of pages supported by remote device.
| uint8_t bt_conn_le_read_all_remote_feat_complete::max_valid_page |
Number of pages fetched from remote device.
| uint16_t bt_conn_le_min_conn_interval_group::min_125us |
Lower bound of group interval range.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_INTERVAL_MIN_125US - BT_HCI_LE_SCI_INTERVAL_MAX_125US
| uint16_t bt_conn_le_conn_rate_param::min_ce_len_125us |
Minimum length of connection event.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_CE_LEN_MIN_125US - BT_HCI_LE_SCI_CE_LEN_MAX_125US
| uint8_t bt_conn_le_cs_config::min_main_mode_steps |
Minimum number of CS main mode steps to be executed before a submode step is executed.
| uint16_t bt_conn_le_min_conn_interval_info::min_supported_conn_interval_us |
Minimum supported connection interval.
Unit: microseconds
Range: BT_HCI_LE_MIN_SUPP_CONN_INT_MIN_US - BT_HCI_LE_MIN_SUPP_CONN_INT_MAX_US
| uint16_t bt_conn_le_path_loss_reporting_param::min_time_spent |
Minimum time in number of connection events to be observed once the path loss crosses the threshold before an event is generated.
| enum bt_conn_le_cs_mode bt_conn_le_cs_config::mode |
CS main and sub mode.
| uint8_t bt_conn_le_cs_config::mode_0_steps |
Number of CS mode-0 steps to be included at the beginning of each CS subevent.
| bool bt_conn_le_cs_capabilities::mode_3_supported |
Mode-3.
A BR/EDR connection mode has changed.
This callback notifies the application that the sniff mode has changed.
| conn | Connection object. |
| mode | Active/Sniff mode. |
| interval | Sniff interval. |
| uint8_t { ... } ::num_antenna_paths |
Number of antenna paths used during the phase measurement stage.
| uint8_t bt_conn_le_cs_subevent_result::num_antenna_paths |
Number of antenna paths used during the phase measurement stage.
| uint8_t bt_conn_le_cs_capabilities::num_antennas_supported |
Number of antennas.
| uint8_t bt_conn_le_cs_capabilities::num_config_supported |
Number of CS configurations.
| uint8_t bt_conn_le_min_conn_interval_info::num_groups |
Number of interval groups.
Range: 0 - BT_CONN_LE_MAX_CONN_INTERVAL_GROUPS
If zero, the controller only supports Rounded ConnInterval Values (RCV).
| uint8_t bt_conn_br_remote_info::num_pages |
Number of pages in the remote feature set.
| uint8_t { ... } ::num_steps_reported |
Number of CS steps in the subevent.
| uint8_t bt_conn_le_cs_subevent_result::num_steps_reported |
Number of CS steps in the subevent.
| enum { ... } bt_conn_oob_info::oob_config |
OOB data configuration.
| enum { ... } bt_conn_oob_info::oob_config |
OOB data configuration.
| uint8_t bt_conn_pairing_feat::oob_data_flag |
OOB data flag, Core Spec.
Vol 3, Part H, 3.5.1, Table 3.5
| void(* bt_conn_auth_cb::oob_data_request) (struct bt_conn *conn, struct bt_conn_oob_info *info) |
Request the user to provide Out of Band (OOB) data.
When called the user is expected to provide OOB data. The required data are indicated by the information structure.
For LE Secure Connections OOB pairing, the user should provide local OOB data, remote OOB data or both depending on their availability. Their value should be given to the stack using the bt_le_oob_set_sc_data() API.
This callback must be set to non-NULL in order to support OOB pairing.
| conn | Connection where pairing is currently active. |
| info | OOB pairing information. |
| uint32_t bt_conn_le_create_param::options |
Bit-field of create connection options.
| uint16_t bt_conn_le_phy_param::options |
Connection PHY options.
| void(* bt_conn_br_cb::packet_type_changed) (struct bt_conn *conn, uint8_t status, uint16_t packet_type) |
The packet type of the BR/EDR connection has changed.
This callback notifies the application that the connection packet type change procedure has completed.
| conn | Connection object. |
| status | HCI status of the event. |
| packet_type | New packet type bitmask. |
| enum bt_security_err(* bt_conn_auth_cb::pairing_accept) (struct bt_conn *conn, const struct bt_conn_pairing_feat *const feat) |
Query to proceed incoming pairing or not.
On any incoming pairing req/rsp this callback will be called for the application to decide whether to allow for the pairing to continue.
The pairing info received from the peer is passed to assist making the decision.
As this callback is synchronous the application should return a response value immediately. Otherwise it may affect the timing during pairing. Hence, this information should not be conveyed to the user to take action.
The remaining callbacks are not affected by this, but do notice that other callbacks can be called during the pairing. Eg. if pairing_confirm is registered both will be called for Just-Works pairings.
This callback may be unregistered in which case pairing continues as if the Kconfig flag was not set.
For BR/EDR Secure Simple Pairing (SSP), this callback is called when receiving the BT_HCI_EVT_IO_CAPA_REQ hci event. The feat is NULL here.
| conn | Connection where pairing is initiated. |
| feat | Pairing req/resp info. It is NULL in BR/EDR SSP. |
| void(* bt_conn_auth_cb::pairing_confirm) (struct bt_conn *conn) |
Request confirmation for an incoming pairing.
This callback will be called to confirm an incoming pairing request where none of the other user callbacks is applicable.
If the user decides to accept the pairing the bt_conn_auth_pairing_confirm() API should be called. If the user decides to reject the pairing the bt_conn_auth_cancel() API should be called.
This callback may be set to NULL, which means that the local device lacks the ability to confirm a pairing request. If set to non-NULL the cancel callback must also be provided, since this is the only way the application can find out that it should stop requesting the user to confirm a pairing request.
| conn | Connection where pairing is currently active. |
Request the user to confirm a passkey.
When called the user is expected to confirm that the given passkey is also shown on the peer device.. The passkey will be in the range of 0 - 999999, and should be zero-padded to always be six digits (e.g. 37 would be shown as 000037).
Once the user has confirmed the passkey to match, the bt_conn_auth_passkey_confirm() API should be called. If the user concluded that the passkey doesn't match the bt_conn_auth_cancel() API should be called.
This callback may be set to NULL, which means that the local device lacks the ability to confirm a passkey. If set to non-NULL the cancel callback must also be provided, since this is the only way the application can find out that it should stop requesting the user to confirm a passkey.
| conn | Connection where pairing is currently active. |
| passkey | Passkey to be confirmed. |
Display a passkey to the user.
When called the application is expected to display the given passkey to the user, with the expectation that the passkey will then be entered on the peer device. The passkey will be in the range of 0 - 999999, and is expected to be padded with zeroes so that six digits are always shown. E.g. the value 37 should be shown as 000037.
This callback may be set to NULL, which means that the local device lacks the ability do display a passkey. If set to non-NULL the cancel callback must also be provided, since this is the only way the application can find out that it should stop displaying the passkey.
| conn | Connection where pairing is currently active. |
| passkey | Passkey to show to the user. |
| void(* bt_conn_auth_cb::passkey_display_keypress) (struct bt_conn *conn, enum bt_conn_auth_keypress type) |
Receive Passkey Keypress Notification during pairing.
This allows the remote device to use the local device to give users feedback on the progress of entering the passkey over there. This is useful when the remote device itself has no display suitable for showing the progress.
The handler of this callback is expected to keep track of the number of digits entered and show a password-field-like feedback to the user.
This callback is only relevant while the local side does Passkey Display.
The event type is verified to be in range of the enum. No other sanitization has been done. The remote could send a large number of events of any type in any order.
| conn | The related connection. |
| type | Type of event. Verified in range of the enum. |
| void(* bt_conn_auth_cb::passkey_entry) (struct bt_conn *conn) |
Request the user to enter a passkey.
When called the user is expected to enter a passkey. The passkey must be in the range of 0 - 999999, and should be expected to be zero-padded, as that's how the peer device will typically be showing it (e.g. 37 would be shown as 000037).
Once the user has entered the passkey its value should be given to the stack using the bt_conn_auth_passkey_entry() API.
This callback may be set to NULL, which means that the local device lacks the ability to enter a passkey. If set to non-NULL the cancel callback must also be provided, since this is the only way the application can find out that it should stop requesting the user to enter a passkey.
| conn | Connection where pairing is currently active. |
| uint8_t bt_conn_le_path_loss_threshold_report::path_loss |
Current path loss (dB).
| void(* bt_conn_cb::path_loss_threshold_report) (struct bt_conn *conn, const struct bt_conn_le_path_loss_threshold_report *report) |
LE Path Loss Threshold event.
This callback notifies the application that there has been a path loss threshold crossing or reporting the initial path loss threshold zone after using bt_conn_le_set_path_loss_mon_enable.
| conn | Connection object. |
| report | Path loss threshold report. |
| bool bt_conn_le_cs_capabilities::pbr_from_rtt_sounding_seq_supported |
Subfeature: Phase-based Ranging from RTT sounding sequence.
| const bt_addr_le_t* bt_conn_le_create_synced_param::peer |
Remote address.
The peer must be synchronized to the PAwR train.
| uint16_t bt_conn_le_conn_rate_changed::peripheral_latency |
Peripheral latency.
Unit: subrated connection intervals bt_conn_le_conn_rate_changed::subrate_factor
Range: BT_HCI_LE_PERIPHERAL_LATENCY_MIN - BT_HCI_LE_PERIPHERAL_LATENCY_MAX
| uint16_t bt_conn_le_subrate_changed::peripheral_latency |
Peripheral latency in units of subrated connection intervals.
| bool bt_conn_le_cs_capabilities::phase_based_nadm_random_supported |
Phase-based normalized attack detector metric when a CS_SYNC with random sequence is received.
| bool bt_conn_le_cs_capabilities::phase_based_nadm_sounding_supported |
Phase-based normalized attack detector metric when a CS_SYNC with sounding sequence is received.
| const struct bt_conn_le_phy_info* bt_conn_le_info::phy |
Connection PHY info.
| uint8_t bt_conn_le_tx_power::phy |
Input: 1M, 2M, Coded S2 or Coded S8.
| enum bt_conn_le_tx_power_phy bt_conn_le_tx_power_report::phy |
Phy of Transmit power reporting.
| uint8_t bt_conn_le_frame_space_update_param::phys |
Phy mask of the PHYs to be updated.
Refer to BT_HCI_LE_FRAME_SPACE_UPDATE_PHY_* for values.
| uint8_t bt_conn_le_frame_space_updated::phys |
Phy mask of the PHYs updated.
Refer to BT_HCI_LE_FRAME_SPACE_UPDATE_PHY_* for values.
Request the user to enter a passkey.
This callback will be called for a BR/EDR (Bluetooth Classic) connection where pairing is being performed. Once called the user is expected to enter a PIN code with a length between 1 and 16 digits. If the highsec parameter is set to true the PIN code must be 16 digits long.
Once entered, the PIN code should be given to the stack using the bt_conn_auth_pincode_entry() API.
This callback may be set to NULL, however in that case pairing over BR/EDR will not be possible. If provided, the cancel callback must be provided as well.
| conn | Connection where pairing is currently active. |
| highsec | true if 16 digit PIN is required. |
| uint8_t bt_conn_le_phy_param::pref_rx_phy |
Bitmask of preferred receive PHYs.
| uint8_t bt_conn_le_phy_param::pref_tx_phy |
Bitmask of preferred transmit PHYs.
| enum bt_conn_le_cs_procedure_abort_reason { ... } ::procedure_abort_reason |
Abort reason.
If the procedure status is BT_CONN_LE_CS_PROCEDURE_ABORTED, this field will specify the reason for the abortion.
| enum bt_conn_le_cs_procedure_abort_reason bt_conn_le_cs_subevent_result::procedure_abort_reason |
Abort reason.
If the procedure status is BT_CONN_LE_CS_PROCEDURE_ABORTED, this field will specify the reason for the abortion.
| uint16_t bt_conn_le_cs_procedure_enable_complete::procedure_count |
| uint16_t { ... } ::procedure_counter |
CS procedure count associated with these results.
This is the CS procedure count since the completion of the Channel Sounding Security Start procedure.
| uint16_t bt_conn_le_cs_subevent_result::procedure_counter |
CS procedure count associated with these results.
This is the CS procedure count since the completion of the Channel Sounding Security Start procedure.
| enum bt_conn_le_cs_procedure_done_status { ... } ::procedure_done_status |
Procedure status.
| enum bt_conn_le_cs_procedure_done_status bt_conn_le_cs_subevent_result::procedure_done_status |
Procedure status.
| uint16_t bt_conn_le_cs_procedure_enable_complete::procedure_interval |
| void(* bt_conn_cb::read_all_remote_feat_complete) (struct bt_conn *conn, const struct bt_conn_le_read_all_remote_feat_complete *params) |
Read all remote features complete event.
This callback notifies the application that a 'read all remote features' procedure of the connection is completed. The other params will not be populated if status is not BT_HCI_ERR_SUCCESS.
This callback can be triggered by calling bt_conn_le_read_all_remote_features or by the procedure running autonomously in the controller.
| conn | Connection object. |
| params | Remote features. |
| uint8_t bt_conn_le_tx_power_report::reason |
Reason for Transmit power reporting, as documented in Core Spec.
Version 5.4 Vol. 4, Part E, 7.7.65.33.
| void(* bt_conn_cb::recycled) (void) |
A connection object has been returned to the pool.
This callback notifies the application that it might be able to allocate a connection object. No guarantee, first come, first serve. Only connections that are configurable by
CONFIG_BT_MAX_CONN
trigger this callback, i.e. connections of type BT_CONN_TYPE_LE or BT_CONN_TYPE_BR.
The maximum number of simultaneous connections is configured by
CONFIG_BT_MAX_CONN
.
This is the event to listen for to start a new connection or connectable advertiser, both when the intention is to start it after the system is completely finished with an earlier connection, and when the application wants to start a connection for any reason but failed and is waiting for the right time to retry.
| int8_t { ... } ::reference_power_level |
Reference power level in dBm.
Range: -127 to 20
A value of BT_HCI_LE_CS_REF_POWER_LEVEL_UNAVAILABLE indicates that the reference power level was not available during a subevent.
| int8_t bt_conn_le_cs_subevent_result::reference_power_level |
Reference power level in dBm.
Range: -127 to 20
A value of BT_HCI_LE_CS_REF_POWER_LEVEL_UNAVAILABLE indicates that the reference power level was not available during a subevent.
| bool bt_conn_le_cs_capabilities::reflector_supported |
Reflector role.
| const bt_addr_le_t* bt_conn_le_info::remote |
Remote device address used during connection setup.
| int8_t* bt_conn_le_cs_fae_table::remote_fae_table |
| void(* bt_conn_cb::remote_info_available) (struct bt_conn *conn, struct bt_conn_remote_info *remote_info) |
Remote information procedures has completed.
This callback notifies the application that the remote information has been retrieved from the remote peer.
| conn | Connection object. |
| remote_info | Connection information of remote device. |
| uint8_t bt_conn_pairing_feat::resp_key_dist |
Responder Key Distribution/Generation, Core Spec.
Vol 3, Part H 3.6.1, Fig. 3.11
| uint8_t bt_conn_info::role |
Connection Role.
| enum bt_conn_le_cs_role bt_conn_le_cs_config::role |
CS role.
A BR/EDR connection role has changed.
This callback notifies the application that the BR/EDR role switch procedure has completed.
| conn | Connection object. |
| status | HCI status of role change event. |
| uint8_t bt_conn_le_cs_capabilities::rtt_aa_only_n |
Number of CS steps needed to achieve the accuracy requirements for RTT AA Only.
Set to 0 if RTT AA Only isn't supported.
| enum bt_conn_le_cs_capability_rtt_aa_only bt_conn_le_cs_capabilities::rtt_aa_only_precision |
RTT AA-Only.
| uint8_t bt_conn_le_cs_capabilities::rtt_random_payload_n |
Number of CS steps needed to achieve the accuracy requirements for RTT Random Payload.
Set to 0 if RTT Random Payload isn't supported.
| enum bt_conn_le_cs_capability_rtt_random_payload bt_conn_le_cs_capabilities::rtt_random_payload_precision |
RTT Random Payload.
| uint8_t bt_conn_le_cs_capabilities::rtt_sounding_n |
Number of CS steps needed to achieve the accuracy requirements for RTT Sounding.
Set to 0 if RTT Sounding isn't supported
| enum bt_conn_le_cs_capability_rtt_sounding bt_conn_le_cs_capabilities::rtt_sounding_precision |
RTT Sounding.
| enum bt_conn_le_cs_rtt_type bt_conn_le_cs_config::rtt_type |
RTT type.
| uint16_t bt_conn_le_data_len_info::rx_max_len |
Maximum Link Layer reception payload size in bytes.
| uint16_t bt_conn_le_data_len_info::rx_max_time |
Maximum Link Layer reception payload time in us.
| uint8_t bt_conn_le_phy_info::rx_phy |
Connection transmit PHY.
| struct bt_conn_sco_info { ... } ::sco |
SCO Connection specific Info.
| struct bt_conn_sco_info bt_conn_info::sco |
SCO Connection specific Info.
| struct bt_security_info bt_conn_info::security |
Security specific info.
| void(* bt_conn_cb::security_changed) (struct bt_conn *conn, bt_security_t level, enum bt_security_err err) |
The security level of a connection has changed.
This callback notifies the application that the security of a connection has changed.
The security level of the connection can either have been increased or remain unchanged. An increased security level means that the pairing procedure has been performed or the bond information from a previous connection has been applied. If the security level remains unchanged this means that the encryption key has been refreshed for the connection.
| conn | Connection object. |
| level | New security level of the connection. |
| err | Security error. Zero for success, non-zero otherwise. |
| int8_t bt_conn_le_cs_procedure_enable_complete::selected_tx_power |
| uint16_t bt_conn_le_frame_space_update_param::spacing_types |
Spacing types mask of the spacing types to be updated.
Refer to BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_* and BT_CONN_LE_FRAME_SPACE_TYPES_MASK_* for values.
| uint16_t bt_conn_le_frame_space_updated::spacing_types |
Spacing types mask of the spacing types updated.
Refer to BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_* and BT_CONN_LE_FRAME_SPACE_TYPES_MASK_* for values.
| const bt_addr_le_t* bt_conn_le_info::src |
Source (Local) Identity Address.
| uint16_t { ... } ::start_acl_conn_event |
Starting ACL connection event counter.
If these results were generated by a CS Test, this value will be set to 0 and has no meaning.
| uint16_t bt_conn_le_cs_subevent_result::start_acl_conn_event |
Starting ACL connection event counter.
If these results were generated by a CS Test, this value will be set to 0 and has no meaning.
| enum bt_conn_state bt_conn_info::state |
Connection state.
| enum bt_conn_le_cs_procedure_enable_state bt_conn_le_cs_procedure_enable_complete::state |
| uint8_t bt_conn_le_frame_space_updated::status |
HCI Status from LE Frame Space Update Complete event.
The remaining parameters will be invalid if status is not BT_HCI_ERR_SUCCESS.
| uint8_t bt_conn_le_read_all_remote_feat_complete::status |
HCI Status from LE Read All Remote Features Complete event.
The remaining parameters will be unchanged if status is not BT_HCI_ERR_SUCCESS.
| uint8_t bt_conn_le_subrate_changed::status |
HCI Status from LE Subrate Changed event.
The remaining parameters will be unchanged if status is not BT_HCI_ERR_SUCCESS.
| struct net_buf_simple* bt_conn_le_cs_subevent_result::step_data_buf |
Pointer to buffer containing step data.
NULL if num_steps_reported is 0.
| uint16_t bt_conn_le_min_conn_interval_group::stride_125us |
Increment between consecutive supported intervals.
Unit: 125 microseconds
Range: BT_HCI_LE_SCI_STRIDE_MIN_125US - BT_HCI_LE_SCI_INTERVAL_MAX_125US
| uint8_t bt_conn_le_create_synced_param::subevent |
The subevent where the connection will be initiated.
| enum bt_conn_le_cs_subevent_abort_reason { ... } ::subevent_abort_reason |
Abort reason.
If the subevent status is BT_CONN_LE_CS_SUBEVENT_ABORTED, this field will specify the reason for the abortion.
| enum bt_conn_le_cs_subevent_abort_reason bt_conn_le_cs_subevent_result::subevent_abort_reason |
Abort reason.
If the subevent status is BT_CONN_LE_CS_SUBEVENT_ABORTED, this field will specify the reason for the abortion.
| enum bt_conn_le_cs_subevent_done_status { ... } ::subevent_done_status |
Subevent status.
For aborted subevents, this will be set to BT_CONN_LE_CS_SUBEVENT_ABORTED and abort_step will contain the step number on which the subevent was aborted. Consider the following example:
subevent_done_status = BT_CONN_LE_CS_SUBEVENT_ABORTED num_steps_reported = 160 abort_step = 100
this would mean that steps from 0 to 99 are complete and steps from 100 to 159 are aborted.
| enum bt_conn_le_cs_subevent_done_status bt_conn_le_cs_subevent_result::subevent_done_status |
Subevent status.
For aborted subevents, this will be set to BT_CONN_LE_CS_SUBEVENT_ABORTED and abort_step will contain the step number on which the subevent was aborted. Consider the following example:
subevent_done_status = BT_CONN_LE_CS_SUBEVENT_ABORTED num_steps_reported = 160 abort_step = 100
this would mean that steps from 0 to 99 are complete and steps from 100 to 159 are aborted.
| uint16_t bt_conn_le_cs_procedure_enable_complete::subevent_interval |
| uint32_t bt_conn_le_cs_procedure_enable_complete::subevent_len |
| uint8_t bt_conn_le_cs_procedure_enable_complete::subevents_per_event |
| const struct bt_conn_le_subrating_info* bt_conn_le_info::subrate |
Connection subrating parameters.
| void(* bt_conn_cb::subrate_changed) (struct bt_conn *conn, const struct bt_conn_le_subrate_changed *params) |
LE Subrate Changed event.
This callback notifies the application that the subrating parameters of the connection may have changed. The connection subrating parameters will be unchanged if status is not BT_HCI_ERR_SUCCESS.
| conn | Connection object. |
| params | New subrating parameters. |
| uint16_t bt_conn_le_conn_rate_changed::subrate_factor |
Connection subrate factor.
Range: BT_HCI_LE_SUBRATE_FACTOR_MIN - BT_HCI_LE_SUBRATE_FACTOR_MAX
| uint16_t bt_conn_le_conn_rate_param::subrate_max |
Maximum subrate factor.
Range: BT_HCI_LE_SUBRATE_FACTOR_MIN - BT_HCI_LE_SUBRATE_FACTOR_MAX
| uint16_t bt_conn_le_subrate_param::subrate_max |
Maximum subrate factor.
| uint16_t bt_conn_le_conn_rate_param::subrate_min |
Minimum subrate factor.
Range: BT_HCI_LE_SUBRATE_FACTOR_MIN - BT_HCI_LE_SUBRATE_FACTOR_MAX
| uint16_t bt_conn_le_subrate_param::subrate_min |
Minimum subrate factor.
| uint16_t bt_conn_remote_info::subversion |
Per-manufacturer unique revision.
| uint16_t bt_conn_le_subrate_changed::supervision_timeout |
Connection Supervision timeout (N * 10 ms).
| uint16_t bt_conn_le_subrate_param::supervision_timeout |
Connection Supervision timeout (N * 10 ms).
If using bt_conn_le_subrate_set_defaults, this is the maximum supervision timeout allowed in requests by a peripheral.
| uint16_t bt_conn_le_conn_rate_changed::supervision_timeout_10ms |
Connection Supervision timeout.
Unit: 10 milliseconds
Range: BT_HCI_LE_SUPERVISION_TIMEOUT_MIN - BT_HCI_LE_SUPERVISION_TIMEOUT_MAX
| uint16_t bt_conn_le_conn_rate_param::supervision_timeout_10ms |
Connection Supervision timeout.
Unit: 10 milliseconds
Range: BT_HCI_LE_SUPERVISION_TIMEOUT_MIN - BT_HCI_LE_SUPERVISION_TIMEOUT_MAX
| uint8_t bt_conn_le_cs_config::t_fcs_time_us |
Time in microseconds for frequency changes.
| uint16_t bt_conn_le_cs_capabilities::t_fcs_times_supported |
Optional T_FCS time durations during CS steps.
| uint8_t bt_conn_le_cs_config::t_ip1_time_us |
Interlude time in microseconds between the RTT packets.
| uint16_t bt_conn_le_cs_capabilities::t_ip1_times_supported |
Optional T_IP1 time durations during CS steps.
| uint16_t bt_conn_le_cs_capabilities::t_ip2_ipt_times_supported |
Supported T_IP2_IPT time durations during CS steps.
| uint8_t bt_conn_le_cs_config::t_ip2_time_us |
Interlude time in microseconds between the CS tones.
| uint16_t bt_conn_le_cs_capabilities::t_ip2_times_supported |
Optional T_IP2 time durations during CS steps.
| uint8_t bt_conn_le_cs_config::t_pm_time_us |
Time in microseconds for the phase measurement period of the CS tones.
| uint16_t bt_conn_le_cs_capabilities::t_pm_times_supported |
Optional T_PM time durations during CS steps.
| uint8_t bt_conn_le_cs_capabilities::t_sw_ipt_time_supported |
Supported time in microseconds for the antenna switch period of the CS tones during IPT.
0x00, 0x01, 0x02, 0x04, or 0x0A - Time in microseconds for the antenna switch period of the CS tones
| uint8_t bt_conn_le_cs_capabilities::t_sw_time |
Time in microseconds for the antenna switch period of the CS tones.
| uint16_t bt_conn_le_create_param::timeout |
Connection initiation timeout (N * 10 MS).
Set zero to use the default
CONFIG_BT_CREATE_CONN_TIMEOUT
timeout.
| uint16_t bt_conn_le_info::timeout |
Connection supervision timeout.
| uint16_t bt_le_conn_param::timeout |
| enum bt_conn_le_cs_tone_antenna_config_selection bt_conn_le_cs_procedure_enable_complete::tone_antenna_config_selection |
| uint16_t bt_conn_le_data_len_info::tx_max_len |
Maximum Link Layer transmission payload size in bytes.
| uint16_t bt_conn_le_data_len_param::tx_max_len |
Maximum Link Layer transmission payload size in bytes.
| uint16_t bt_conn_le_data_len_info::tx_max_time |
Maximum Link Layer transmission payload time in us.
| uint16_t bt_conn_le_data_len_param::tx_max_time |
Maximum Link Layer transmission payload time in us.
| uint8_t bt_conn_le_phy_info::tx_phy |
| int8_t bt_conn_le_tx_power_report::tx_power_level |
Transmit power level.
| uint8_t bt_conn_le_tx_power_report::tx_power_level_flag |
Bit 0: Transmit power level is at minimum level.
Bit 1: Transmit power level is at maximum level.
| void(* bt_conn_cb::tx_power_report) (struct bt_conn *conn, const struct bt_conn_le_tx_power_report *report) |
LE Read Remote Transmit Power Level procedure has completed or LE Transmit Power Reporting event.
This callback notifies the application that either the remote transmit power level has been read from the peer or transmit power level has changed for the local or remote controller when transmit power reporting is enabled for the respective side using bt_conn_le_set_tx_power_report_enable.
| conn | Connection object. |
| report | Transmit power report. |
| uint8_t bt_conn_le_cs_capabilities::tx_snr_capability |
Supported SNR levels used in RTT packets.
| enum bt_conn_type bt_conn_info::type |
Connection Type.
| enum { ... } bt_conn_oob_info::type |
Type of OOB pairing method.
| uint8_t bt_conn_remote_info::type |
Connection Type.
| uint8_t bt_conn_remote_info::version |
Remote Link Layer version.
| uint16_t bt_conn_le_create_param::window |
Scan window (N * 0.625 ms).
CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLELis enabled and the application wants to scan and connect in parallel, the Bluetooth Controller may require the scan window used for scanning and connection establishment to be equal to obtain the best performance.
| uint16_t bt_conn_le_create_param::window_coded |
Scan window LE Coded PHY (N * 0.625 MS).
Set zero to use same as LE 1M PHY scan window.
| enum bt_conn_le_path_loss_zone bt_conn_le_path_loss_threshold_report::zone |
Path Loss zone as documented in Core Spec.
Version 5.4 Vol.4, Part E, 7.7.65.32.
1.16.1