Throughput Test Receiver (Central) Role API#

throughput_central_allowlist_add#

bool throughput_central_allowlist_add (uint8_t *address)

Add an address to the allowlist. Returns

• true if adding the address was successful

throughput_central_allowlist_clear#

bool throughput_central_allowlist_clear (void)

Clear the allowlist Returns

• true if adding the clear was succesful

throughput_central_enable#

void throughput_central_enable (void)

Enable receiver.

throughput_central_disable#

sl_status_t throughput_central_disable (void)

Disable receiver.

throughput_central_set_mode#

sl_status_t throughput_central_set_mode (throughput_mode_t mode, uint32_t amount)

Set receiver mode. Returns

• status of the operation

throughput_central_set_mtu_size#

sl_status_t throughput_central_set_mtu_size (uint8_t mtu)

Set data sizes for reception. Returns

• status of the operation

throughput_central_set_tx_power#

sl_status_t throughput_central_set_tx_power (throughput_tx_power_t tx_power, bool power_control, bool deep_sleep)

Set transmission power. Returns

• status of the operation

throughput_central_set_connection_parameters#

sl_status_t throughput_central_set_connection_parameters (throughput_time_t min_interval, throughput_time_t max_interval, throughput_time_t latency, throughput_time_t timeout)

Set connection parameters. Returns

• status of the operation

throughput_central_set_type#

sl_status_t throughput_central_set_type (throughput_notification_t type)

Set type of transmission. Returns

• status of the operation

throughput_central_start#

sl_status_t throughput_central_start (void)

Start transmission on remote side. Returns

• status of the operation

throughput_central_stop#

sl_status_t throughput_central_stop (void)

Stop transmission on remote side. Returns

• status of the operation

throughput_central_set_scan_phy#

sl_status_t throughput_central_set_scan_phy (throughput_scan_phy_t phy)

Set PHY used for scanning. Returns

• status of the operation

throughput_central_set_connection_phy#

sl_status_t throughput_central_set_connection_phy (throughput_phy_t phy)

Set PHY used for connection. Returns

• status of the operation

throughput_central_change_phy#

sl_status_t throughput_central_change_phy (void)

Change PHY to next one.

• In case of scanning, it is used for changing between CODED and 1M PHY

• In a connection, it is used to change between 1M, 2M and CODED PHYs Returns

  • status of the operation

throughput_central_step#

void throughput_central_step (void)

Process step for throughput central.

bt_on_event_central#

void bt_on_event_central (sl_bt_msg_t *evt)

Bluetooth stack event handler.

throughput_central_on_role_set#

void throughput_central_on_role_set (throughput_role_t role)

Callback to handle role settings. Note

• To be implemented in user code.

throughput_central_on_state_change#

void throughput_central_on_state_change (throughput_state_t state)

Callback to handle state change. Note

• To be implemented in user code.

throughput_central_on_mode_change#

void throughput_central_on_mode_change (throughput_mode_t mode)

Callback to handle mode change. Note

• To be implemented in user code.

throughput_central_on_start#

void throughput_central_on_start (void)

Callback to handle transmission start event. Note

• To be implemented in user code.

throughput_central_on_finish#

void throughput_central_on_finish (throughput_value_t throughput, throughput_count_t count, throughput_count_t lost, throughput_count_t error, throughput_time_t time)

Callback to handle transmission finished event. Note

• To be implemented in user code.

throughput_central_on_transmit_power_change#

void throughput_central_on_transmit_power_change (throughput_tx_power_t power)

Callback to handle tx power changed event. Note

• To be implemented in user code.

throughput_central_on_rssi_change#

void throughput_central_on_rssi_change (throughput_rssi_t rssi)

Callback to handle RSSI changed event. Note

• To be implemented in user code.

throughput_central_on_phy_change#

void throughput_central_on_phy_change (throughput_phy_t phy)

Callback to handle phy changed event. Note

• To be implemented in user code.

throughput_central_on_notification_change#

void throughput_central_on_notification_change (throughput_notification_t notification)

Callback to handle notification changed event. Note

• To be implemented in user code.

throughput_central_on_indication_change#

void throughput_central_on_indication_change (throughput_notification_t indication)

Callback to handle indication changed event. Note

• To be implemented in user code.

throughput_central_on_result_indication_change#

void throughput_central_on_result_indication_change (throughput_notification_t result)

Callback to handle result indication changed event. Note

• To be implemented in user code.

throughput_central_on_data_size_change#

void throughput_central_on_data_size_change (throughput_pdu_size_t data_size)

Callback to handle data size change when receiving data. Note

• To be implemented in user code.

throughput_central_on_connection_settings_change#

void throughput_central_on_connection_settings_change (throughput_pdu_size_t pdu, throughput_mtu_size_t mtu)

Callback to handle connection parameter changes. Note

• To be implemented in user code.

throughput_central_on_connection_timings_change#

void throughput_central_on_connection_timings_change (throughput_time_t interval, throughput_time_t latency, throughput_time_t timeout)

Callback to handle connection timing changes. Note

• To be implemented in user code.

throughput_central_on_characteristics_found#

void throughput_central_on_characteristics_found (throughput_central_characteristic_found_t characteristics)

Callback to handle characteristic found event. Note

• To be implemented in user code.

throughput_central_on_discovery_state_change#

void throughput_central_on_discovery_state_change (throughput_discovery_state_t state)

Callback to handle discovery state change. Note

• To be implemented in user code.

throughput_central_calculate#

float throughput_central_calculate (throughput_value_t *throughput)

Calculate throughput. Returns

• the elapsed time in seconds since measurement started

throughput_central_decode_address#

bool throughput_central_decode_address (char *addess_str, uint8_t *address)

Convert address string to address data bytes. Returns

• true if operation was successful

waiting_indication#

void waiting_indication (void)

ASCII graphics for indicating wait status

timer_start#

void timer_start ()

Start timer

timer_end#

float timer_end ()

Timer end. The return value of this function shall be the time passed form the timer_start() call in seconds.

timer_refresh_rssi_start#

void timer_refresh_rssi_start (void)

Start RSSI refresh timer

timer_refresh_rssi_stop#

void timer_refresh_rssi_stop (void)

Stop RSSI refresh timer

timer_on_refresh_rssi#

void timer_on_refresh_rssi (void)

Event handler

THROUGHPUT_CENTRAL_TEST_TYPE#

#define THROUGHPUT_CENTRAL_TEST_TYPE

sl_bt_gatt_notification

THROUGHPUT_CENTRAL_MODE_DEFAULT#

#define THROUGHPUT_CENTRAL_MODE_DEFAULT

THROUGHPUT_MODE_CONTINUOUS

THROUGHPUT_CENTRAL_FIXED_DATA_SIZE#

#define THROUGHPUT_CENTRAL_FIXED_DATA_SIZE

100000

THROUGHPUT_CENTRAL_FIXED_TIME#

#define THROUGHPUT_CENTRAL_FIXED_TIME

10000

THROUGHPUT_CENTRAL_MTU_SIZE#

#define THROUGHPUT_CENTRAL_MTU_SIZE

247

THROUGHPUT_DEFAULT_SCAN_PHY#

#define THROUGHPUT_DEFAULT_SCAN_PHY

sl_bt_scanner_scan_phy_1m

THROUGHPUT_DEFAULT_PHY#

#define THROUGHPUT_DEFAULT_PHY

sl_bt_gap_phy_coding_1m_uncoded

THROUGHPUT_CENTRAL_CONNECTION_INTERVAL_MIN#

#define THROUGHPUT_CENTRAL_CONNECTION_INTERVAL_MIN

32

THROUGHPUT_CENTRAL_CONNECTION_INTERVAL_MAX#

#define THROUGHPUT_CENTRAL_CONNECTION_INTERVAL_MAX

32

THROUGHPUT_CENTRAL_CONNECTION_RESPONDER_LATENCY#

#define THROUGHPUT_CENTRAL_CONNECTION_RESPONDER_LATENCY

0

THROUGHPUT_CENTRAL_CONNECTION_TIMEOUT#

#define THROUGHPUT_CENTRAL_CONNECTION_TIMEOUT

1000

THROUGHPUT_CENTRAL_TX_POWER#

#define THROUGHPUT_CENTRAL_TX_POWER

10

THROUGHPUT_CENTRAL_POWER_CONTROL_ENABLE#

#define THROUGHPUT_CENTRAL_POWER_CONTROL_ENABLE

0

THROUGHPUT_CENTRAL_SLEEP_ENABLE#

#define THROUGHPUT_CENTRAL_SLEEP_ENABLE

0

THROUGHPUT_CENTRAL_ALLOWLIST_ENABLE#

#define THROUGHPUT_CENTRAL_ALLOWLIST_ENABLE

0

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_1_ENABLE#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_1_ENABLE

0

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_1#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_1

"00:00:00:00:00:00"

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_2_ENABLE#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_2_ENABLE

0

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_2#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_2

"00:00:00:00:00:00"

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_3_ENABLE#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_3_ENABLE

0

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_3#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_3

"00:00:00:00:00:00"

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_4_ENABLE#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_4_ENABLE

0

THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_4#

#define THROUGHPUT_CENTRAL_ALLOWLIST_SLOT_4

"00:00:00:00:00:00"

THROUGHPUT_CENTRAL_CHARACTERISTICS_ALL#

#define THROUGHPUT_CENTRAL_CHARACTERISTICS_ALL

0x0F

ADR_LEN#

#define ADR_LEN

6

THROUGHPUT_CENTRAL_REFRESH_TIMER_PERIOD#

#define THROUGHPUT_CENTRAL_REFRESH_TIMER_PERIOD

1000