Throughput User Interface API#

API for drawing throughput test state and results to LCD

Functions#

void
throughput_ui_init(void)

Initilize the the UI.

void
throughput_ui_update(void)

Updates the the UI.

void
throughput_ui_set_state(throughput_state_t state)

Sets the state value on UI.

void
throughput_ui_set_role(throughput_role_t role)

Sets the role value on UI.

void
throughput_ui_set_tx_power(throughput_tx_power_t power)

Sets the TX Power value on UI.

void
throughput_ui_set_rssi(throughput_rssi_t rssi)

Sets the RSSI value on UI.

void
throughput_ui_set_connection_interval(throughput_time_t interval)

Sets the connection interval value on UI.

void
throughput_ui_set_pdu_size(throughput_pdu_size_t size)

Sets the PDU size value on UI.

void
throughput_ui_set_mtu_size(throughput_mtu_size_t size)

Sets the MTU size value on UI.

void
throughput_ui_set_data_size(throughput_data_size_t size)

Sets the data size value on UI.

void
throughput_ui_set_phy(throughput_phy_t phy)

Sets the PHY on UI.

void
throughput_ui_set_notifications(throughput_notification_t notifications)

Sets the notification state on UI.

void
throughput_ui_set_indications(throughput_notification_t indications)

Sets the indication state on UI.

void
throughput_ui_set_throughput(throughput_value_t throughput)

Sets the throughput value on UI.

void
throughput_ui_set_count(throughput_count_t count)

Sets the counter value on UI.

void
throughput_ui_set_all(throughput_t status)

Sets all values.

Macros#

Function Documentation#

throughput_ui_init#

void throughput_ui_init (void )

Initilize the the UI.

Parameters
N/A

Definition at line 49 of file common/throughput_ui/throughput_ui.h

throughput_ui_update#

void throughput_ui_update (void )

Updates the the UI.

Parameters
N/A

Definition at line 55 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_state#

void throughput_ui_set_state (throughput_state_t state)

Sets the state value on UI.

Parameters
[in]state

current state


Definition at line 63 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_role#

void throughput_ui_set_role (throughput_role_t role)

Sets the role value on UI.

Parameters
[in]role

the role can be

  • THROUGHPUT_UI_ROLE_PERIPHERAL or

  • THROUGHPUT_UI_ROLE_CENTRAL


Definition at line 73 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_tx_power#

void throughput_ui_set_tx_power (throughput_tx_power_t power)

Sets the TX Power value on UI.

Parameters
[in]power

TX power in dBm


Definition at line 81 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_rssi#

void throughput_ui_set_rssi (throughput_rssi_t rssi)

Sets the RSSI value on UI.

Parameters
[in]rssi

measured RSSI value


Definition at line 89 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_connection_interval#

void throughput_ui_set_connection_interval (throughput_time_t interval)

Sets the connection interval value on UI.

Parameters
[in]interval

connectio interval in ms


Definition at line 97 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_pdu_size#

void throughput_ui_set_pdu_size (throughput_pdu_size_t size)

Sets the PDU size value on UI.

Parameters
[in]size

PDU size in bytes


Definition at line 105 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_mtu_size#

void throughput_ui_set_mtu_size (throughput_mtu_size_t size)

Sets the MTU size value on UI.

Parameters
[in]size

MTU size in bytes


Definition at line 113 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_data_size#

void throughput_ui_set_data_size (throughput_data_size_t size)

Sets the data size value on UI.

Parameters
[in]size

data size in bytes


Definition at line 121 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_phy#

void throughput_ui_set_phy (throughput_phy_t phy)

Sets the PHY on UI.

Parameters
[in]phy

can be either of

  • sl_bt_gap_phy_coding_1m_uncoded: 1M phy

  • sl_bt_gap_phy_coding_2m_uncoded: 2M phy

  • sl_bt_gap_phy_coding_500k_coded: Coded phy


Definition at line 132 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_notifications#

void throughput_ui_set_notifications (throughput_notification_t notifications)

Sets the notification state on UI.

Parameters
[in]notifications

settings in CCCD, that can be either of

  • sl_bt_gatt_notification: notifications enabled

  • sl_bt_gatt_disable: notifications disabled


Definition at line 142 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_indications#

void throughput_ui_set_indications (throughput_notification_t indications)

Sets the indication state on UI.

Parameters
[in]indications

settings in CCCD, that can be either of

  • sl_bt_gatt_indication: indications enabled

  • sl_bt_gatt_disable: indications disabled


Definition at line 152 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_throughput#

void throughput_ui_set_throughput (throughput_value_t throughput)

Sets the throughput value on UI.

Parameters
[in]throughput

measured throughput in bits/second (bps)


Definition at line 160 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_count#

void throughput_ui_set_count (throughput_count_t count)

Sets the counter value on UI.

Parameters
[in]count

counted bytes


Definition at line 168 of file common/throughput_ui/throughput_ui.h

throughput_ui_set_all#

void throughput_ui_set_all (throughput_t status)

Sets all values.

Parameters
[in]status

throughput status


Definition at line 176 of file common/throughput_ui/throughput_ui.h

Macro Definition Documentation#

THROUGHPUT_UI_LOG_ENABLE#

#define THROUGHPUT_UI_LOG_ENABLE
Value:
1

Definition at line 14 of file common/throughput_ui/config/throughput_ui_config.h

THROUGHPUT_UI_PRINT_RSSI#

#define THROUGHPUT_UI_PRINT_RSSI
Value:
0

Definition at line 19 of file common/throughput_ui/config/throughput_ui_config.h

THROUGHPUT_UI_LOG_ENABLE#

#define THROUGHPUT_UI_LOG_ENABLE
Value:
1

Definition at line 13 of file common/throughput_ui/config/throughput_ui_log_config.h

THROUGHPUT_UI_LOG_REFRESH_ALL#

#define THROUGHPUT_UI_LOG_REFRESH_ALL
Value:
1

Definition at line 17 of file common/throughput_ui/config/throughput_ui_log_config.h

THROUGHPUT_UI_LOG_BOX_ENABLE#

#define THROUGHPUT_UI_LOG_BOX_ENABLE
Value:
1

Definition at line 21 of file common/throughput_ui/config/throughput_ui_log_config.h