Board Control#
Functions to control Silicon Labs board features.
Enumerations#
Board Sensor Type.
Board Memory Type.
Functions#
Configure Virtual COM UART.
Enable Virtual COM UART.
Disable Virtual COM UART.
Enable a sensor.
Disable a sensor.
Enable display.
Disable display.
Enable memory.
Disable memory.
Enable an oscillator.
Disable a oscillator.
Enumeration Documentation#
sl_board_sensor_t#
sl_board_sensor_t
Board Sensor Type.
Enumerator | |
---|---|
SL_BOARD_SENSOR_RHT | Relative Humidity and Temperature Sensor. |
SL_BOARD_SENSOR_LIGHT | UV Index and Ambient Light Sensor. |
SL_BOARD_SENSOR_PRESSURE | Barometric Pressure Sensor. |
SL_BOARD_SENSOR_HALL | Hall Effect Sensor. |
SL_BOARD_SENSOR_GAS | Gas Sensor. |
SL_BOARD_SENSOR_IMU | Inertial Measurement Unit (Accelerometer/Gyroscope) |
SL_BOARD_SENSOR_MICROPHONE | Microphone. |
47
of file hardware/board/inc/sl_board_control.h
sl_board_memory_t#
sl_board_memory_t
Board Memory Type.
Enumerator | |
---|---|
SL_BOARD_MEMORY_SDCARD | SD Card. |
SL_BOARD_MEMORY_QSPI | Quad SPI Flash. |
58
of file hardware/board/inc/sl_board_control.h
sl_board_oscillator_t#
sl_board_oscillator_t
Board Oscillator Type.
Enumerator | |
---|---|
SL_BOARD_OSCILLATOR_TCXO | TCXO. |
64
of file hardware/board/inc/sl_board_control.h
Function Documentation#
sl_board_configure_vcom#
sl_status_t sl_board_configure_vcom (void )
Configure Virtual COM UART.
N/A |
Returns
Status code
77
of file hardware/board/inc/sl_board_control.h
sl_board_enable_vcom#
sl_status_t sl_board_enable_vcom (void )
Enable Virtual COM UART.
N/A |
Returns
Status code
87
of file hardware/board/inc/sl_board_control.h
sl_board_disable_vcom#
sl_status_t sl_board_disable_vcom (void )
Disable Virtual COM UART.
N/A |
Returns
Status code
97
of file hardware/board/inc/sl_board_control.h
sl_board_enable_sensor#
sl_status_t sl_board_enable_sensor (sl_board_sensor_t sensor)
Enable a sensor.
[in] | sensor | Sensor to enable |
Warnings
On boards 4166A, 4184A, and 4184B sensors
Pressure Sensor, RH/Temp Sensor, and UV/Ambient Light Sensor;
UV/Ambient Light Sensor, Hall-effect Sensor, and RH/Temp Sensor;
Ambient Light Sensor, Hall-effect Sensor, and RH/Temp Sensor respectively, are tied to the same enable pin. Calling the enable function for only one of these sensors has the side-effect of enabling all three; and calling the disable function for only one of them has the side-effect of disabling all three. The latter scenario seems less than desirable.
Returns
Status code
120
of file hardware/board/inc/sl_board_control.h
sl_board_disable_sensor#
sl_status_t sl_board_disable_sensor (sl_board_sensor_t sensor)
Disable a sensor.
[in] | sensor | Sensors to disable |
Warnings
On boards 4166A, 4184A, and 4184B sensors
Pressure Sensor, RH/Temp Sensor, and UV/Ambient Light Sensor;
UV/Ambient Light Sensor, Hall-effect Sensor, and RH/Temp Sensor;
Ambient Light Sensor, Hall-effect Sensor, and RH/Temp Sensor respectively, are tied to the same enable pin. Calling the enable function for only one of these sensors has the side-effect of enabling all three; and calling the disable function for only one of them has the side-effect of disabling all three. The latter scenario seems less than desirable.
Returns
Status code
143
of file hardware/board/inc/sl_board_control.h
sl_board_enable_display#
sl_status_t sl_board_enable_display (void )
Enable display.
N/A |
Returns
Status code
153
of file hardware/board/inc/sl_board_control.h
sl_board_disable_display#
sl_status_t sl_board_disable_display (void )
Disable display.
N/A |
Returns
Status code
163
of file hardware/board/inc/sl_board_control.h
sl_board_enable_memory#
sl_status_t sl_board_enable_memory (sl_board_memory_t memory)
Enable memory.
[in] | memory | Memory to enable |
Returns
Status code
175
of file hardware/board/inc/sl_board_control.h
sl_board_disable_memory#
sl_status_t sl_board_disable_memory (sl_board_memory_t memory)
Disable memory.
[in] | memory | Memory to disable |
Returns
Status code
187
of file hardware/board/inc/sl_board_control.h
sl_board_enable_oscillator#
sl_status_t sl_board_enable_oscillator (sl_board_oscillator_t oscillator)
Enable an oscillator.
[in] | oscillator | Oscillator to enable |
Returns
Status code
199
of file hardware/board/inc/sl_board_control.h
sl_board_disable_oscillator#
sl_status_t sl_board_disable_oscillator (sl_board_oscillator_t oscillator)
Disable a oscillator.
[in] | oscillator | Oscillator to disable |
Returns
Status code
211
of file hardware/board/inc/sl_board_control.h