PAwR Advertiser#

sl_bt_pawr_advertiser_start#

sl_status_t sl_bt_pawr_advertiser_start (uint8_t advertising_set, uint16_t interval_min, uint16_t interval_max, uint32_t flags, uint8_t num_subevents, uint8_t subevent_interval, uint8_t response_slot_delay, uint8_t response_slot_spacing, uint8_t response_slots)

Start PAwR advertising on the specified advertising set.

According to the Bluetooth Core specification, PAwR advertising PDUs cannot be transmitted until at least one extended advertising event has been completed. If the application needs exact control over the extended advertising data and parameters, use the Advertiser class to configure the parameters of the advertising set and the Extended Advertiser class to set or generate the desired extended advertising data payload. If the application does not configure the parameters or set the data, the default parameters and empty advertising data are used for the extended advertising.

If the application has not already started extended advertising and the flag SL_BT_PERIODIC_ADVERTISER_AUTO_START_EXTENDED_ADVERTISING is set in flags, the stack will automatically start extended advertising with the parameters and extended advertising data currently configured to the advertising set. The application may stop the automatically started extended advertising using the sl_bt_advertiser_stop command.

If the application has not already started extended advertising and the flag SL_BT_PERIODIC_ADVERTISER_AUTO_START_EXTENDED_ADVERTISING is not set in flags, the stack will momentarily start extended advertising with the parameters and extended advertising data currently configured to the advertising set. Unless the application starts extended advertising before the first extended advertising event has completed, the stack will automatically stop the momentary extended advertising after the first extended advertising event.

PAwR advertising PDUs are transmitted on the secondary PHY configured for the advertising set with the sl_bt_extended_advertiser_set_phy command.

To stop PAwR advertising, use sl_bt_pawr_advertiser_stop command.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_pawr_advertiser_set_subevent_data#

sl_status_t sl_bt_pawr_advertiser_set_subevent_data (uint8_t advertising_set, uint8_t subevent, uint8_t response_slot_start, uint8_t response_slot_count, size_t adv_data_len, const uint8_t * adv_data)

Set data to be sent in the specified subevent of an active PAwR train. Data is transmitted only once and is discarded after it has been transmitted.

Data given to this command is passed to the Bluetooth controller, which will queue data and transmit it at the correct time. The application may always opportunistically try to queue more data with this command, but the controller may reject data and return an error if the queuing capacity is exceeded. In this case, the Bluetooth stack will trigger the sl_bt_evt_pawr_advertiser_subevent_data_request event later when the controller is ready to accept more data.

To ensure effective use of the available memory, applications are encouraged to observe the sl_bt_evt_pawr_advertiser_subevent_data_request events and set data for the subevents that are being requested and for which the application has data to send. Applications should also note that PAwR is an unreliable transport and cannot guarantee delivery. If reliability is required, the application must implement an acknowledgment mechanism using response slots of the PAwR train and set subevent data again for a re-transmission if it was not successfully delivered.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_pawr_advertiser_subevent_data_request - This event is triggered when the Bluetooth stack is ready to accept more subevent data.

• sl_bt_evt_pawr_advertiser_subevent_tx_failed - This event is triggered if transmitting the subevent data has failed.

• sl_bt_evt_pawr_advertiser_response_report - If the subevent data was successfully transmitted, this event is triggered for each response slot that was marked as used in this subevent.

sl_bt_pawr_advertiser_create_connection#

sl_status_t sl_bt_pawr_advertiser_create_connection (uint8_t advertising_set, uint8_t subevent, bd_addr address, uint8_t address_type, uint8_t * connection)

Initiate a connection request to a device that is synchronized to the specified active PAwR train. The connection is established on the secondary PHY configured for the advertising set with the sl_bt_extended_advertiser_set_phy command. The connection uses the parameters configured with command sl_bt_connection_set_default_parameters.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_connection_closed - This event is triggered if the connection failed to be created.

• sl_bt_evt_connection_opened - This event is triggered after the connection is opened and indicates whether the devices are already bonded and the role of the device in this connection.

• sl_bt_evt_connection_parameters - This event indicates the connection parameters and security mode of the connection.

sl_bt_pawr_advertiser_stop#

sl_status_t sl_bt_pawr_advertiser_stop (uint8_t advertising_set)

Stop PAwR advertising on an advertising set. Counterpart to sl_bt_pawr_advertiser_start.

This command does not affect the enable state of the advertising set, i.e., legacy or extended advertising is not stopped.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_cmd_pawr_advertiser_start_id#

#define sl_bt_cmd_pawr_advertiser_start_id

0x00550020

sl_bt_cmd_pawr_advertiser_set_subevent_data_id#

#define sl_bt_cmd_pawr_advertiser_set_subevent_data_id

0x01550020

sl_bt_cmd_pawr_advertiser_create_connection_id#

#define sl_bt_cmd_pawr_advertiser_create_connection_id

0x02550020

sl_bt_cmd_pawr_advertiser_stop_id#

#define sl_bt_cmd_pawr_advertiser_stop_id

0x03550020

sl_bt_rsp_pawr_advertiser_start_id#

#define sl_bt_rsp_pawr_advertiser_start_id

0x00550020

sl_bt_rsp_pawr_advertiser_set_subevent_data_id#

#define sl_bt_rsp_pawr_advertiser_set_subevent_data_id

0x01550020

sl_bt_rsp_pawr_advertiser_create_connection_id#

#define sl_bt_rsp_pawr_advertiser_create_connection_id

0x02550020

sl_bt_rsp_pawr_advertiser_stop_id#

#define sl_bt_rsp_pawr_advertiser_stop_id

0x03550020