Modules#

Advertiser#

Advertiser.

This is the base class of legacy, extended, and periodic advertisings for common functionalities including advertising set management, TX power setting, advertising address, and so on.

On an advertising set, either the legacy or extended advertising can be enabled at a time but they cannot be enabled simultaneously on the same advertising set. For example, the following sequence shows how to start the legacy advertising on an advertising set. Starting the extended advertising is similar. The only difference is to use the extended_advertiser API class.

Create an advertise set with the sl_bt_advertiser_create_set command.
Configure and set advertising parameters for the advertising set as needed.
Set the advertising data with the sl_bt_legacy_advertiser_set_data or sl_bt_legacy_advertiser_generate_data command.
Start the legacy advertising with the sl_bt_legacy_advertiser_start command.

Periodic advertising can be enabled independently on the advertising set regardless of the state of the legacy or extended advertising. However, to ensure that scanners can find the periodic advertising information and establish a synchronization, the extended advertising must be enabled simultaneously with the periodic advertising.

When the bluetooth_feature_legacy_advertiser, bluetooth_feature_extended_advertiser or bluetooth_feature_periodic_advertiser component is included by the application, commands that have been superseded by the new classes are no longer available for use in the advertiser class. Calling them will receive SL_STATUS_NOT_SUPPORTED error code. These commands are as follows: sl_bt_advertiser_set_phy, sl_bt_advertiser_set_configuration, sl_bt_advertiser_clear_configuration, sl_bt_advertiser_set_data, sl_bt_advertiser_set_long_data, sl_bt_advertiser_start, sl_bt_advertiser_start_periodic_advertising, and sl_bt_advertiser_stop_periodic_advertising. See the command descriptions for the replacements.

Enumerations#

enum

sl_bt_advertiser_connection_mode_t {

sl_bt_advertiser_non_connectable = 0x0

sl_bt_advertiser_connectable_scannable = 0x2

sl_bt_advertiser_scannable_non_connectable = 0x3

sl_bt_advertiser_connectable_non_scannable = 0x4

}

These values define the available connection modes, which indicate whether the device accepts connection requests or scan requests.

enum

sl_bt_advertiser_discovery_mode_t {

sl_bt_advertiser_non_discoverable = 0x0

sl_bt_advertiser_limited_discoverable = 0x1

sl_bt_advertiser_general_discoverable = 0x2

sl_bt_advertiser_broadcast = 0x3

sl_bt_advertiser_user_data = 0x4

}

These values define the available discovery modes, which dictate how the device is visible to other devices in the legacy and extended advertising.

enum

sl_bt_advertiser_adv_address_type_t {

sl_bt_advertiser_identity_address = 0x0

sl_bt_advertiser_non_resolvable = 0x1

}

Address type to use for the legacy and extended advertising.

enum

sl_bt_advertiser_packet_type_t {

sl_bt_advertiser_advertising_data_packet = 0x0

sl_bt_advertiser_scan_response_packet = 0x1

}

These values define the packet types in legacy and extended advertising.

Functions#

sl_status_t

sl_bt_advertiser_create_set(uint8_t *handle)

sl_status_t

sl_bt_advertiser_configure(uint8_t advertising_set, uint32_t flags)

sl_status_t

sl_bt_advertiser_set_timing(uint8_t advertising_set, uint32_t interval_min, uint32_t interval_max, uint16_t duration, uint8_t maxevents)

sl_status_t

sl_bt_advertiser_set_channel_map(uint8_t advertising_set, uint8_t channel_map)

sl_status_t

sl_bt_advertiser_set_tx_power(uint8_t advertising_set, int16_t power, int16_t *set_power)

sl_status_t

sl_bt_advertiser_set_report_scan_request(uint8_t advertising_set, uint8_t report_scan_req)

sl_status_t

sl_bt_advertiser_set_random_address(uint8_t advertising_set, uint8_t addr_type, bd_addr address, bd_addr *address_out)

sl_status_t

sl_bt_advertiser_clear_random_address(uint8_t advertising_set)

sl_status_t

sl_bt_advertiser_stop(uint8_t advertising_set)

sl_status_t

sl_bt_advertiser_delete_set(uint8_t advertising_set)