GAP#

sl_bt_gap_address_type_t#

sl_bt_gap_address_type_t

These values define Bluetooth device address types. Commands and events that have Bluetooth device address parameters will specify which values are valid for that particular command or event.

If the application does not include the bluetooth_feature_use_accurate_api_address_types component, most Bluetooth commands and events use a coarse address type that only differentiates between a public address and any random address. When the application includes the bluetooth_feature_use_accurate_api_address_types component, Bluetooth commands and events that include an address type will systematically use values of this sl_bt_gap_address_type_t enumeration to indicate the accurate address type.

The values sl_bt_gap_public_address_resolved_from_rpa and sl_bt_gap_static_address_resolved_from_rpa are reported by the Bluetooth stack only when the application includes the bluetooth_feature_resolving_list component and the address was resolved in the Bluetooth controller. If the application uses these two types in input parameters, they are treated as synonyms of sl_bt_gap_public_address and sl_bt_gap_static_address, respectively.

sl_bt_gap_phy_t#

sl_bt_gap_phy_t

Types of PHYs.

sl_bt_gap_phy_coding_t#

sl_bt_gap_phy_coding_t

PHY types with coding schemes.

sl_bt_gap_set_privacy_mode#

sl_status_t sl_bt_gap_set_privacy_mode (uint8_t privacy, uint8_t interval)

Enable or disable the privacy feature on all GAP roles. New privacy mode will take effect for advertising next time advertising is enabled, for scanning next time scanning is enabled, and for initiating on the next open connection command.

When privacy is enabled and the device is advertising or scanning, the stack will maintain a periodic timer with the specified time interval as a timeout value. At each timeout, the stack generates a new resolvable private address and uses it in scanning requests. For advertisers, the stack generates a new resolvable or non-resolvable private address and uses it in advertising data packets for each advertising set if its address is not application-managed, i.e., the address was not set by the application (with the sl_bt_advertiser_set_random_address command). The application is fully responsible for application-managed advertiser addresses. For an application-managed resolvable private address, the application should schedule periodic address updates for enhancing the privacy. It is recommended to use different schedules for different advertising sets.

Disabling the privacy during active advertising or scanning is not allowed.

By default, privacy feature is disabled.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gap_set_data_channel_classification#

sl_status_t sl_bt_gap_set_data_channel_classification (size_t channel_map_len, const uint8_t *channel_map)

Specify a channel classification for data channels. This classification persists until overwritten with a subsequent command or until the system is reset. The value length of channel_map must be 5 bytes.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gap_enable_whitelisting#

SL_BGAPI_DEPRECATED sl_status_t sl_bt_gap_enable_whitelisting (uint8_t enable)

Deprecated and replaced by functionality-specific settings provided by the bluetooth_feature_accept_list component. For advertising, use the command sl_bt_advertiser_configure and flags bits SL_BT_ADVERTISER_USE_FILTER_FOR_SCAN_REQUESTS and SL_BT_ADVERTISER_USE_FILTER_FOR_CONNECTION_REQUESTS to configure the advertising filter policy. For scanning, use the command sl_bt_scanner_set_parameters_and_filter to control the scanning filter policy.

Enable or disable accept list filtering. The setting will be effective the next time that scanning is enabled. Use command sl_bt_sm_add_to_whitelist to add devices to the accept list.

When the built-in bonding database (bluetooth_feature_builtin_bonding_database) is used, bonded devices are added into the accept list automatically by the stack. Note that the Bluetooth stack uses the built-in bonding database by default.

When the application specifically uses the external bonding database (bluetooth_feature_external_bonding_database), the application is fully responsible for managing the accept list using sl_bt_sm_add_to_whitelist and sl_bt_sm_delete_bondings commands.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gap_set_identity_address#

sl_status_t sl_bt_gap_set_identity_address (bd_addr address, uint8_t addr_type)

Set the device's Bluetooth identity address to be used in advertising, scanning, connection initiation, and identity address exchange in bonding. The address is stored in RAM only and does not change the identity address in persistent storage. The address can be a public device address or static device address. It will be effective immediately in the next advertising, scanning, connection initiation, and bonding. Error SL_STATUS_INVALID_PARAMETER is returned if the address does not conform to the Bluetooth specification.

Note that advertising sets that have own addresses set by sl_bt_advertiser_set_random_address are not affected by this command, i.e., they will continue to use their own user defined addresses.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_cmd_gap_set_privacy_mode_id#

#define sl_bt_cmd_gap_set_privacy_mode_id

0x01020020

sl_bt_cmd_gap_set_data_channel_classification_id#

#define sl_bt_cmd_gap_set_data_channel_classification_id

0x02020020

sl_bt_cmd_gap_enable_whitelisting_id#

#define sl_bt_cmd_gap_enable_whitelisting_id

0x03020020

sl_bt_cmd_gap_set_identity_address_id#

#define sl_bt_cmd_gap_set_identity_address_id

0x04020020

sl_bt_rsp_gap_set_privacy_mode_id#

#define sl_bt_rsp_gap_set_privacy_mode_id

0x01020020

sl_bt_rsp_gap_set_data_channel_classification_id#

#define sl_bt_rsp_gap_set_data_channel_classification_id

0x02020020

sl_bt_rsp_gap_enable_whitelisting_id#

#define sl_bt_rsp_gap_enable_whitelisting_id

0x03020020

sl_bt_rsp_gap_set_identity_address_id#

#define sl_bt_rsp_gap_set_identity_address_id

0x04020020