CS Initiator Display#

Prints Channel Sounding (CS) Initiator status information to the LCD of the WSTK.

Modules#

cs_initiator_display_content_t

Enumerations#

enum
cs_initiator_display_row_t {
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_t {
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_progress(float progress_percentage)
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
cs_initiator_display_init(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_GLOBAL_ALIGNMENT CS_INITIATOR_DISPLAY_ALIGNMENT_LEFT
#define
CS_INITIATOR_DISPLAY_RSSI_DISTANCE_TEXT "Distance [RSSI]:"
#define
CS_INITIATOR_DISPLAY_BER_TEXT "Bit error rate:"
#define
NL
#define
display_log_debug (...)
#define
display_log_info (...)
#define
display_log_warning (...)
#define
display_log_error (...)

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

cs_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

Function Documentation#

cs_initiator_display_set_distance#

void cs_initiator_display_set_distance (float distance)
Parameters
TypeDirectionArgument NameDescription
float[in]distance

Distance value

Set distance value to display


cs_initiator_display_set_distance_progress#

void cs_initiator_display_set_distance_progress (float progress_percentage)
Parameters
TypeDirectionArgument NameDescription
float[in]progress_percentage

Distance progress percentage

Set distance progress percentage to display


cs_initiator_display_set_rssi_distance#

void cs_initiator_display_set_rssi_distance (float distance)
Parameters
TypeDirectionArgument NameDescription
float[in]distance

RSSI distance value

Set RSSI based distance value to display


cs_initiator_display_set_likeliness#

void cs_initiator_display_set_likeliness (float likeliness)
Parameters
TypeDirectionArgument NameDescription
float[in]likeliness

likeliness value

Set the likeliness parameter to display


cs_initiator_display_set_bit_error_rate#

void cs_initiator_display_set_bit_error_rate (float ber)
Parameters
TypeDirectionArgument NameDescription
float[in]ber

BER value

Set the Bit Error Rate (BER) value to display


cs_initiator_display_set_measurement_mode#

void cs_initiator_display_set_measurement_mode (sl_bt_cs_mode_t mode, uint8_t algo_mode)
Parameters
TypeDirectionArgument NameDescription
sl_bt_cs_mode_t[in]mode

CS measurement mode.

uint8_t[in]algo_mode

Object tracking mode.

Set the measurement mode and object tracking mode to display


cs_initiator_display_print_float_value#

void cs_initiator_display_print_float_value (float value, uint8_t row, char * unit)
Parameters
TypeDirectionArgument NameDescription
float[in]value

the calculated value

uint8_t[in]row

number of the row to print on, see cs_initiator_display_row_t

char *[in]unit

unit string, in case of NULL no unit displayed

Print floating point value on the LCD with an optional unit string.


cs_initiator_display_on_event#

void cs_initiator_display_on_event (sl_bt_msg_t * evt)
Parameters
TypeDirectionArgument NameDescription
sl_bt_msg_t *[in]evt

Event coming from the Bluetooth stack.

Bluetooth stack event handler.


cs_initiator_display_init#

sl_status_t cs_initiator_display_init (void )
Parameters
TypeDirectionArgument NameDescription
voidN/A

Initialize the display.


cs_initiator_display_update#

void cs_initiator_display_update (void )
Parameters
TypeDirectionArgument NameDescription
voidN/A

Update the display.


cs_initiator_display_set_alignment#

void cs_initiator_display_set_alignment (cs_initiator_display_alignment_t align)
Parameters
TypeDirectionArgument NameDescription
cs_initiator_display_alignment_t[in]align

text alignment to use

Set the display text alignment.


cs_initiator_display_write_text#

void cs_initiator_display_write_text (char * str, uint8_t row)
Parameters
TypeDirectionArgument NameDescription
char *[in]str

pointer to the text to print

uint8_t[in]row

row to print the text on

Write text on the LCD.


Macro Definition Documentation#

CS_INITIATOR_DISPLAY_LOG#

#define CS_INITIATOR_DISPLAY_LOG
Value:
(1)

CS_INITIATOR_DISPLAY_GLOBAL_ALIGNMENT#

#define CS_INITIATOR_DISPLAY_GLOBAL_ALIGNMENT
Value:
CS_INITIATOR_DISPLAY_ALIGNMENT_LEFT

CS_INITIATOR_DISPLAY_TITLE_VENDOR_TEXT#

#define CS_INITIATOR_DISPLAY_TITLE_VENDOR_TEXT
Value:
"Silicon Labs"

CS_INITIATOR_DISPLAY_TITLE_DEVICE_TEXT#

#define CS_INITIATOR_DISPLAY_TITLE_DEVICE_TEXT
Value:
"CS Initiator"

CS_INITIATOR_DISPLAY_MODE_TEXT#

#define CS_INITIATOR_DISPLAY_MODE_TEXT
Value:
"Mode:"

CS_INITIATOR_DISPLAY_DISTANCE_TEXT#

#define CS_INITIATOR_DISPLAY_DISTANCE_TEXT
Value:
"Distance:"

CS_INITIATOR_DISPLAY_RSSI_DISTANCE_TEXT#

#define CS_INITIATOR_DISPLAY_RSSI_DISTANCE_TEXT
Value:
"Distance [RSSI]:"

CS_INITIATOR_DISPLAY_LIKELINESS_TEXT#

#define CS_INITIATOR_DISPLAY_LIKELINESS_TEXT
Value:
"Likeliness:"

CS_INITIATOR_DISPLAY_BER_TEXT#

#define CS_INITIATOR_DISPLAY_BER_TEXT
Value:
"Bit error rate:"

CS_INITIATOR_DISPLAY_STATE_ESTIMATE_TEXT#

#define CS_INITIATOR_DISPLAY_STATE_ESTIMATE_TEXT
Value:
"ST: Estimate"

CS_INITIATOR_DISPLAY_STATE_CONNECTED_TEXT#

#define CS_INITIATOR_DISPLAY_STATE_CONNECTED_TEXT
Value:
"ST: Connected"

CS_INITIATOR_DISPLAY_STATE_DISCONNECTED_TEXT#

#define CS_INITIATOR_DISPLAY_STATE_DISCONNECTED_TEXT
Value:
"ST: Disconnected"

CS_INITIATOR_DISPLAY_STATE_SCANNING_TEXT#

#define CS_INITIATOR_DISPLAY_STATE_SCANNING_TEXT
Value:
"ST: Scanning..."

CS_INITIATOR_DISPLAY_STATE_INITIALIZED_TEXT#

#define CS_INITIATOR_DISPLAY_STATE_INITIALIZED_TEXT
Value:
"ST: Initialized"

CS_INITIATOR_DISPLAY_MODE_RTT_TEXT#

#define CS_INITIATOR_DISPLAY_MODE_RTT_TEXT
Value:
"RTT"

CS_INITIATOR_DISPLAY_MODE_PBR_TEXT#

#define CS_INITIATOR_DISPLAY_MODE_PBR_TEXT
Value:
"PBR"

CS_INITIATOR_DISPLAY_AMODE_STATIONARY_OBJ_TEXT#

#define CS_INITIATOR_DISPLAY_AMODE_STATIONARY_OBJ_TEXT
Value:
" [stationary]"

CS_INITIATOR_DISPLAY_AMODE_MOVING_OBJ_TEXT#

#define CS_INITIATOR_DISPLAY_AMODE_MOVING_OBJ_TEXT
Value:
" [moving    ]"

NL#

#define NL

display_log_debug#

#define display_log_debug

display_log_info#

#define display_log_info

display_log_warning#

#define display_log_warning

display_log_error#

#define display_log_error

display_log_critical#

#define display_log_critical