Board Control

Description

Functions to control Silicon Labs board features.

Functions

sl_status_t sl_board_enable_vcom (void)
Enable Virtual COM UART.
sl_status_t sl_board_disable_vcom (void)
Disable Virtual COM UART.
sl_status_t sl_board_enable_sensor ( sl_board_sensor_t sensor)
Enable a sensor.
sl_status_t sl_board_disable_sensor ( sl_board_sensor_t sensor)
Disable a sensor.
sl_status_t sl_board_enable_display (void)
Enable display.
sl_status_t sl_board_disable_display (void)
Disable display.
sl_status_t sl_board_enable_memory ( sl_board_memory_t memory)
Enable memory.
sl_status_t sl_board_disable_memory ( sl_board_memory_t memory)
Disable memory.
sl_status_t sl_board_enable_oscillator ( sl_board_oscillator_t oscillator)
Enable an oscillator.
sl_status_t sl_board_disable_oscillator ( sl_board_oscillator_t oscillator)
Disable a oscillator.

Enumerations

enum sl_board_sensor_t {
SL_BOARD_SENSOR_RHT = (1UL << 0UL),
SL_BOARD_SENSOR_LIGHT = (1UL << 1UL),
SL_BOARD_SENSOR_PRESSURE = (1UL << 2UL),
SL_BOARD_SENSOR_HALL = (1UL << 3UL),
SL_BOARD_SENSOR_GAS = (1UL << 4UL),
SL_BOARD_SENSOR_IMU = (1UL << 5UL),
SL_BOARD_SENSOR_MICROPHONE = (1UL << 6UL)
}
Board Sensor Type.
enum sl_board_memory_t {
SL_BOARD_MEMORY_SDCARD = (1UL << 0UL),
SL_BOARD_MEMORY_QSPI = (1UL << 1UL)
}
Board Memory Type.
enum sl_board_oscillator_t { SL_BOARD_OSCILLATOR_TCXO = (1UL << 0UL) }
Board Oscillator Type.

Function Documentation

◆ sl_board_enable_vcom()

sl_status_t sl_board_enable_vcom ( void )

Enable Virtual COM UART.

Returns
Status code
Return values
SL_STATUS_OK VCOM was successfully enabled
SL_STATUS_FAIL Enabling VCOM failed
SL_STATUS_NOT_AVAILABLE VCOM control is not available on this board

◆ sl_board_disable_vcom()

sl_status_t sl_board_disable_vcom ( void )

Disable Virtual COM UART.

Returns
Status code
Return values
SL_STATUS_OK VCOM was successfully disabled
SL_STATUS_FAIL Disabling VCOM failed
SL_STATUS_NOT_AVAILABLE VCOM control is not available on this board

◆ sl_board_enable_sensor()

sl_status_t sl_board_enable_sensor ( sl_board_sensor_t sensor )

Enable a sensor.

Warning
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.
Parameters
[in] sensor Sensor to enable
Returns
Status code
Return values
SL_STATUS_OK Sensor was successfully enabled
SL_STATUS_FAIL Enabling sensor failed
SL_STATUS_NOT_AVAILABLE Sensor control is not available on this board

◆ sl_board_disable_sensor()

sl_status_t sl_board_disable_sensor ( sl_board_sensor_t sensor )

Disable a sensor.

Warning
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.
Parameters
[in] sensor Sensors to disable
Returns
Status code
Return values
SL_STATUS_OK Sensor was successfully disabled
SL_STATUS_FAIL Disabling sensor failed
SL_STATUS_NOT_AVAILABLE Sensor control is not available on this board

◆ sl_board_enable_display()

sl_status_t sl_board_enable_display ( void )

Enable display.

Returns
Status code
Return values
SL_STATUS_OK Display was successfully enabled
SL_STATUS_FAIL Enabling display failed
SL_STATUS_NOT_AVAILABLE Display control is not available on this board

◆ sl_board_disable_display()

sl_status_t sl_board_disable_display ( void )

Disable display.

Returns
Status code
Return values
SL_STATUS_OK Display was successfully disabled
SL_STATUS_FAIL Disabling display failed
SL_STATUS_NOT_AVAILABLE Display control is not available on this board

◆ sl_board_enable_memory()

sl_status_t sl_board_enable_memory ( sl_board_memory_t memory )

Enable memory.

Parameters
[in] memory Memory to enable
Returns
Status code
Return values
SL_STATUS_OK Memory was successfully enabled
SL_STATUS_FAIL Enabling memory failed
SL_STATUS_NOT_AVAILABLE Memory control is not available on this board

◆ sl_board_disable_memory()

sl_status_t sl_board_disable_memory ( sl_board_memory_t memory )

Disable memory.

Parameters
[in] memory Memory to disable
Returns
Status code
Return values
SL_STATUS_OK Memory was successfully disabled
SL_STATUS_FAIL Disabling memory failed
SL_STATUS_NOT_AVAILABLE Memory control is not available on this board

◆ sl_board_enable_oscillator()

sl_status_t sl_board_enable_oscillator ( sl_board_oscillator_t oscillator )

Enable an oscillator.

Parameters
[in] oscillator Oscillator to enable
Returns
Status code
Return values
SL_STATUS_OK Oscillator was successfully enabled
SL_STATUS_FAIL Enabling oscillator failed
SL_STATUS_NOT_AVAILABLE Oscillator control is not available on this board

◆ sl_board_disable_oscillator()

sl_status_t sl_board_disable_oscillator ( sl_board_oscillator_t oscillator )

Disable a oscillator.

Parameters
[in] oscillator Oscillator to disable
Returns
Status code
Return values
SL_STATUS_OK Oscillator was successfully disabled
SL_STATUS_FAIL Disabling oscillator failed
SL_STATUS_NOT_AVAILABLE Oscillator control is not available on this board

Enumeration Type Documentation

◆ sl_board_sensor_t

enum 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.

◆ sl_board_memory_t

enum sl_board_memory_t

Board Memory Type.

Enumerator
SL_BOARD_MEMORY_SDCARD

SD Card.

SL_BOARD_MEMORY_QSPI

Quad SPI Flash.

◆ sl_board_oscillator_t

enum sl_board_oscillator_t

Board Oscillator Type.

Enumerator
SL_BOARD_OSCILLATOR_TCXO

TCXO.