Throughput User Interface API#
API for drawing throughput test state and results to LCD
Functions#
Initilize the the UI.
Updates the the UI.
Sets the state value on UI.
Sets the role value on UI.
Sets the TX Power value on UI.
Sets the RSSI value on UI.
Sets the connection interval value on UI.
Sets the PDU size value on UI.
Sets the MTU size value on UI.
Sets the data size value on UI.
Sets the PHY on UI.
Sets the notification state on UI.
Sets the indication state on UI.
Sets the throughput value on UI.
Sets the counter value on UI.
Sets all values.
Macros#
Function Documentation#
throughput_ui_init#
void throughput_ui_init (void )
Initilize the the UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
throughput_ui_update#
void throughput_ui_update (void )
Updates the the UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
throughput_ui_set_state#
void throughput_ui_set_state (throughput_state_t state)
Sets the state value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_state_t | [in] | state | current state |
throughput_ui_set_role#
void throughput_ui_set_role (throughput_role_t role)
Sets the role value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_role_t | [in] | role | the role can be
|
throughput_ui_set_tx_power#
void throughput_ui_set_tx_power (throughput_tx_power_t power)
Sets the TX Power value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_tx_power_t | [in] | power | TX power in dBm |
throughput_ui_set_rssi#
void throughput_ui_set_rssi (throughput_rssi_t rssi)
Sets the RSSI value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_rssi_t | [in] | rssi | measured RSSI value |
throughput_ui_set_connection_interval#
void throughput_ui_set_connection_interval (throughput_time_t interval)
Sets the connection interval value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_time_t | [in] | interval | connectio interval in ms |
throughput_ui_set_pdu_size#
void throughput_ui_set_pdu_size (throughput_pdu_size_t size)
Sets the PDU size value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_pdu_size_t | [in] | size | PDU size in bytes |
throughput_ui_set_mtu_size#
void throughput_ui_set_mtu_size (throughput_mtu_size_t size)
Sets the MTU size value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_mtu_size_t | [in] | size | MTU size in bytes |
throughput_ui_set_data_size#
void throughput_ui_set_data_size (throughput_data_size_t size)
Sets the data size value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_data_size_t | [in] | size | data size in bytes |
throughput_ui_set_phy#
void throughput_ui_set_phy (throughput_phy_t phy)
Sets the PHY on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_phy_t | [in] | phy | can be either of
|
throughput_ui_set_notifications#
void throughput_ui_set_notifications (throughput_notification_t notifications)
Sets the notification state on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_notification_t | [in] | notifications | settings in CCCD, that can be either of
|
throughput_ui_set_indications#
void throughput_ui_set_indications (throughput_notification_t indications)
Sets the indication state on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_notification_t | [in] | indications | settings in CCCD, that can be either of
|
throughput_ui_set_throughput#
void throughput_ui_set_throughput (throughput_value_t throughput)
Sets the throughput value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_value_t | [in] | throughput | measured throughput in bits/second (bps) |
throughput_ui_set_count#
void throughput_ui_set_count (throughput_count_t count)
Sets the counter value on UI.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_count_t | [in] | count | counted bytes |
throughput_ui_set_all#
void throughput_ui_set_all (throughput_t status)
Sets all values.
Type | Direction | Argument Name | Description |
---|---|---|---|
throughput_t | [in] | status | throughput status |