CS Initiator Display#
Prints Channel Sounding (CS) Initiator status information to the LCD of the WSTK.
Modules#
cs_initiator_display_content_t
Enumerations#
enum
ROW_SYSTEM
ROW_ROLE
ROW_MODE
ROW_DISTANCE_TEXT
ROW_DISTANCE_VALUE
ROW_LIKELINESS_TEXT
ROW_LIKELINESS_VALUE
ROW_RSSI_DISTANCE_TEXT
ROW_RSSI_DISTANCE_VALUE
ROW_BIT_ERROR_RATE_TEXT
ROW_BIT_ERROR_RATE_VALUE
ROW_STATE
}
Display rows.
enum
CS_INITIATOR_DISPLAY_ALIGNMENT_LEFT = 0u
CS_INITIATOR_DISPLAY_ALIGNMENT_CENTER
CS_INITIATOR_DISPLAY_ALIGNMENT_RIGHT
}
UI alignment.
Functions#
void
cs_initiator_display_set_distance(float distance)
void
cs_initiator_display_set_distance_progress(float progress_percentage)
void
cs_initiator_display_set_rssi_distance(float distance)
void
cs_initiator_display_set_likeliness(float likeliness)
void
cs_initiator_display_set_bit_error_rate(float ber)
void
cs_initiator_display_set_measurement_mode(sl_bt_cs_mode_t mode, uint8_t algo_mode)
void
cs_initiator_display_print_float_value(float value, uint8_t row, char *unit)
void
cs_initiator_display_on_event(sl_bt_msg_t *evt)
sl_status_t
void
void
cs_initiator_display_set_alignment(cs_initiator_display_alignment_t align)
void
cs_initiator_display_write_text(char *str, uint8_t row)
Macros#
#define
CS_INITIATOR_DISPLAY_LOG (1)
#define
CS_INITIATOR_DISPLAY_GLOBAL_ALIGNMENT CS_INITIATOR_DISPLAY_ALIGNMENT_LEFT
#define
CS_INITIATOR_DISPLAY_TITLE_VENDOR_TEXT "Silicon Labs"
#define
CS_INITIATOR_DISPLAY_TITLE_DEVICE_TEXT "CS Initiator"
#define
CS_INITIATOR_DISPLAY_MODE_TEXT "Mode:"
#define
CS_INITIATOR_DISPLAY_DISTANCE_TEXT "Distance:"
#define
CS_INITIATOR_DISPLAY_RSSI_DISTANCE_TEXT "Distance [RSSI]:"
#define
CS_INITIATOR_DISPLAY_LIKELINESS_TEXT "Likeliness:"
#define
CS_INITIATOR_DISPLAY_BER_TEXT "Bit error rate:"
#define
CS_INITIATOR_DISPLAY_STATE_ESTIMATE_TEXT "ST: Estimate"
#define
CS_INITIATOR_DISPLAY_STATE_CONNECTED_TEXT "ST: Connected"
#define
CS_INITIATOR_DISPLAY_STATE_DISCONNECTED_TEXT "ST: Disconnected"
#define
CS_INITIATOR_DISPLAY_STATE_SCANNING_TEXT "ST: Scanning..."
#define
CS_INITIATOR_DISPLAY_STATE_INITIALIZED_TEXT "ST: Initialized"
#define
CS_INITIATOR_DISPLAY_MODE_RTT_TEXT "RTT"
#define
CS_INITIATOR_DISPLAY_MODE_PBR_TEXT "PBR"
#define
CS_INITIATOR_DISPLAY_AMODE_STATIONARY_OBJ_TEXT " [stationary]"
#define
CS_INITIATOR_DISPLAY_AMODE_MOVING_OBJ_TEXT " [moving ]"
#define
NL
#define
display_log_debug (...)
#define
display_log_info (...)
#define
display_log_warning (...)
#define
display_log_error (...)
#define
display_log_critical (...)
Enumeration Documentation#
cs_initiator_display_row_t#
cs_initiator_display_row_t
Display rows.
| Enumerator | |
|---|---|
| ROW_SYSTEM | |
| ROW_ROLE | |
| ROW_MODE | |
| ROW_DISTANCE_TEXT | |
| ROW_DISTANCE_VALUE | |
| ROW_LIKELINESS_TEXT | |
| ROW_LIKELINESS_VALUE | |
| ROW_RSSI_DISTANCE_TEXT | |
| ROW_RSSI_DISTANCE_VALUE | |
| ROW_BIT_ERROR_RATE_TEXT | |
| ROW_BIT_ERROR_RATE_VALUE | |
| ROW_STATE | |
Definition at line
80 of file common/cs_initiator_display/inc/cs_initiator_display_core.hcs_initiator_display_alignment_t#
cs_initiator_display_alignment_t
UI alignment.
| Enumerator | |
|---|---|
| CS_INITIATOR_DISPLAY_ALIGNMENT_LEFT | |
| CS_INITIATOR_DISPLAY_ALIGNMENT_CENTER | |
| CS_INITIATOR_DISPLAY_ALIGNMENT_RIGHT | |
Definition at line
96 of file common/cs_initiator_display/inc/cs_initiator_display_core.hFunction Documentation#
cs_initiator_display_set_distance#
void cs_initiator_display_set_distance (float distance)
Parameters
| [in] | distance | Distance value |
Set distance value to display
Definition at line
95 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_set_distance_progress#
void cs_initiator_display_set_distance_progress (float progress_percentage)
Parameters
| [in] | progress_percentage | Distance progress percentage |
Set distance progress percentage to display
Definition at line
101 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_set_rssi_distance#
void cs_initiator_display_set_rssi_distance (float distance)
Parameters
| [in] | distance | RSSI distance value |
Set RSSI based distance value to display
Definition at line
107 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_set_likeliness#
void cs_initiator_display_set_likeliness (float likeliness)
Parameters
| [in] | likeliness | likeliness value |
Set the likeliness parameter to display
Definition at line
113 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_set_bit_error_rate#
void cs_initiator_display_set_bit_error_rate (float ber)
Parameters
| [in] | ber | BER value |
Set the Bit Error Rate (BER) value to display
Definition at line
119 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_set_measurement_mode#
void cs_initiator_display_set_measurement_mode (sl_bt_cs_mode_t mode, uint8_t algo_mode)
Parameters
| [in] | mode | CS measurement mode. |
| [in] | algo_mode | Object tracking mode. |
Set the measurement mode and object tracking mode to display
Definition at line
127 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_print_float_value#
void cs_initiator_display_print_float_value (float value, uint8_t row, char * unit)
Parameters
| [in] | value | the calculated value |
| [in] | row | number of the row to print on, see cs_initiator_display_row_t |
| [in] | unit | unit string, in case of NULL no unit displayed |
Print floating point value on the LCD with an optional unit string.
Definition at line
137 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_on_event#
void cs_initiator_display_on_event (sl_bt_msg_t * evt)
Parameters
| [in] | evt | Event coming from the Bluetooth stack. |
Bluetooth stack event handler.
Definition at line
148 of file common/cs_initiator_display/inc/cs_initiator_display.hcs_initiator_display_init#
sl_status_t cs_initiator_display_init (void )
Parameters
| N/A |
Initialize the display.
Definition at line
108 of file common/cs_initiator_display/inc/cs_initiator_display_core.hcs_initiator_display_update#
void cs_initiator_display_update (void )
Parameters
| N/A |
Update the display.
Definition at line
113 of file common/cs_initiator_display/inc/cs_initiator_display_core.hcs_initiator_display_set_alignment#
void cs_initiator_display_set_alignment (cs_initiator_display_alignment_t align)
Parameters
| [in] | align | text alignment to use |
Set the display text alignment.
Definition at line
120 of file common/cs_initiator_display/inc/cs_initiator_display_core.hcs_initiator_display_write_text#
void cs_initiator_display_write_text (char * str, uint8_t row)
Parameters
| [in] | str | pointer to the text to print |
| [in] | row | row to print the text on |
Write text on the LCD.
Definition at line
128 of file common/cs_initiator_display/inc/cs_initiator_display_core.h