BOARD Module for Thunderboard Sense 2
BSP > Thunderboard Sense BSP

Detailed Description

Board hardware control, configuraton and miscellaneous functions.

This module contains functions releated to board features. It allows control over power management features, interrupt controller and RGB LEDs.

The BOARD module uses the common I2CSPM driver to communicate with the I 2 C sensors on the board. The following board features can be enabled when needed using the BOARD Module:

  • Environmental sensor group
    • RH/Temp (Si7021)
    • UV/ALS (Si1133)
    • Barometric Pressure (BMP280)
  • Hall effect sensor (Si7210)
  • Indoor air quality sensor (CCS811)
  • Inertial sensor (ICM-20948)
  • Microphone (ICS-43434)
  • RGB LED boost converter

The BOARD Module also contains functions for controlling the RGB LEDs. The implementation uses one of the TIMER peripherals in PWM mode, with three compare capture channels, one each for red, green and blue.

Functions

void BOARD_alsClearIRQ (void)
Function to clear the ALS sensor interrupt.
uint32_t BOARD_alsEnable (bool enable)
Enables or disables the UV/Ambient light sensor.
uint32_t BOARD_alsEnableIRQ (bool enable)
Enables or disables the UV/Ambient light sensor GPIO interrupts.
void BOARD_alsSetIRQCallback ( BOARD_IrqCallback cb)
Function to register the ALS sensor interrupt callback function.
uint32_t BOARD_bapEnable (bool enable)
Enables or disables the Barometric Pressure sensor.
uint32_t BOARD_envSensEnable (bool enable)
Enables or disables the environmental sensor group (Pressure, RH/Temp, UV/Ambient light and Hall sensors)
uint32_t BOARD_envSensEnableIRQ (bool enable)
Enables or disables the environmental sensor group (Pressure, RH/Temp, UV/Ambient light and Hall sensors) GPIO interrupts.
void BOARD_flashDeepPowerDown (void)
Puts the Flash chip in deep power down mode.
void BOARD_gasSensorClearIRQ (void)
Function to clear the gas sensor interrupt.
uint32_t BOARD_gasSensorEnable (bool enable)
Enables or disables the Air Quality / Gas Sensor.
uint32_t BOARD_gasSensorEnableIRQ (bool enable)
Enables or disables the Air Quality / Gas Sensor GPIO interrupt.
void BOARD_gasSensorSetIRQCallback ( BOARD_IrqCallback cb)
Function to register the gas sensor interrupt callback function.
uint32_t BOARD_gasSensorWake (bool wake)
Wakes up the Air Quality / Gas Sensor.
void BOARD_hallSensorClearIRQ (void)
Function to clear the Hall sensor interrupt.
uint32_t BOARD_hallSensorEnable (bool enable)
Enables or disables the Hall sensor.
uint32_t BOARD_hallSensorEnableIRQ (bool enable)
Enables or disables the Hall sensor GPIO interrupt.
void BOARD_hallSensorSetIRQCallback ( BOARD_IrqCallback cb)
Function to register the Hall sensor interrupt callback function.
uint32_t BOARD_i2cBusSelect (uint8_t select)
Sets up the route register of the I2C device to use the correct set of pins.
void BOARD_imuClearIRQ (void)
Function to clear the IMU sensor interrupt.
uint32_t BOARD_imuEnable (bool enable)
Enables or disables the accelerometer and gyroscope sensor.
uint32_t BOARD_imuEnableIRQ (bool enable)
Enables or disables the accelerometer and gyroscope GPIO interrupt.
void BOARD_imuSetIRQCallback ( BOARD_IrqCallback cb)
Function to register the IMU sensor interrupt callback function.
uint32_t BOARD_init (void)
Initializes the Thunderboard Sense board.
void BOARD_ledSet (uint8_t leds)
Turns on or off the red and/or green LED.
uint32_t BOARD_micEnable (bool enable)
Enables or disables the MEMS microphone.
void BOARD_pushButton0ClearIRQ (void)
Function to clear the pushbutton 0 interrupt.
void BOARD_pushButton0SetIRQCallback ( BOARD_IrqCallback cb)
Function to register the pushbutton 0 interrupt callback function.
void BOARD_pushButton1ClearIRQ (void)
Function to clear the pushbutton 1 interrupt.
void BOARD_pushButton1SetIRQCallback ( BOARD_IrqCallback cb)
Function to register the pushbutton 1 interrupt callback function.
void BOARD_pushButtonEnableIRQ (bool enable)
Enables or disables the pushbutton GPIO interrupt.
uint8_t BOARD_pushButtonGetState (void)
Gets the state of the pushbuttons.
void BOARD_rgbledEnable (bool enable, uint8_t mask)
Enables or disables the RGB LED power supply line.
void BOARD_rgbledPowerEnable (bool enable)
Enables or disables the RGB LED power supply line.
void BOARD_rgbledSetColor (uint8_t red, uint8_t green, uint8_t blue)
Sets the color of the RGB LEDs. The brightness of the LEDs is almost linear to the color value.
void BOARD_rgbledSetRawColor (uint16_t red, uint16_t green, uint16_t blue)
Sets the raw color of the RGB LEDs. The brightness is non-linear function of the raw color value.
uint32_t BOARD_rhtempEnable (bool enable)
Enables or disables the RH/Temp sensor.

Function Documentation

void BOARD_alsClearIRQ ( void )

Function to clear the ALS sensor interrupt.

Clears the UV/Ambient light sensor GPIO interrupts.

Returns
Returns none

Definition at line 991 of file board_4166.c .

uint32_t BOARD_alsEnable ( bool enable )

Enables or disables the UV/Ambient light sensor.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 624 of file board_4166.c .

References BOARD_envSensEnable() , and BOARD_OK .

Referenced by SI1133_deInit() , and SI1133_init() .

uint32_t BOARD_alsEnableIRQ ( bool enable )

Enables or disables the UV/Ambient light sensor GPIO interrupts.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 664 of file board_4166.c .

References BOARD_OK .

void BOARD_alsSetIRQCallback ( BOARD_IrqCallback cb )

Function to register the ALS sensor interrupt callback function.

Parameters
[in] cb The callback function to be registered
Returns
Returns none

Definition at line 976 of file board_4166.c .

References GPIOINT_CallbackRegister() .

uint32_t BOARD_bapEnable ( bool enable )

Enables or disables the Barometric Pressure sensor.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 544 of file board_4166.c .

References BOARD_envSensEnable() , and BOARD_OK .

Referenced by BAP_deInit() , and BAP_init() .

uint32_t BOARD_envSensEnable ( bool enable )

Enables or disables the environmental sensor group (Pressure, RH/Temp, UV/Ambient light and Hall sensors)

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 513 of file board_4166.c .

References BOARD_OK .

Referenced by BOARD_alsEnable() , BOARD_bapEnable() , and BOARD_rhtempEnable() .

uint32_t BOARD_envSensEnableIRQ ( bool enable )

Enables or disables the environmental sensor group (Pressure, RH/Temp, UV/Ambient light and Hall sensors) GPIO interrupts.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 741 of file board_4166.c .

References BOARD_OK .

void BOARD_flashDeepPowerDown ( void )

Puts the Flash chip in deep power down mode.

Returns
Returns none

Definition at line 254 of file board_4166.c .

References UTIL_delay() .

void BOARD_gasSensorClearIRQ ( void )

Function to clear the gas sensor interrupt.

Clears the Air Quality / Gas Sensor GPIO interrupt.

Returns
Returns none

Definition at line 928 of file board_4166.c .

uint32_t BOARD_gasSensorEnable ( bool enable )

Enables or disables the Air Quality / Gas Sensor.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 780 of file board_4166.c .

References BOARD_OK .

Referenced by CCS811_deInit() , and CCS811_init() .

uint32_t BOARD_gasSensorEnableIRQ ( bool enable )

Enables or disables the Air Quality / Gas Sensor GPIO interrupt.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 846 of file board_4166.c .

References BOARD_OK .

void BOARD_gasSensorSetIRQCallback ( BOARD_IrqCallback cb )

Function to register the gas sensor interrupt callback function.

Parameters
[in] cb The callback function to be registered
Returns
Returns none

Definition at line 913 of file board_4166.c .

References GPIOINT_CallbackRegister() .

uint32_t BOARD_gasSensorWake ( bool wake )

Wakes up the Air Quality / Gas Sensor.

Parameters
[in] wake Set true to wake up, false otherwise
Returns
Returns zero on OK, non-zero otherwise

Definition at line 823 of file board_4166.c .

References BOARD_OK , and UTIL_delay() .

Referenced by CCS811_deInit() , CCS811_getMeasurement() , CCS811_getRawData() , CCS811_init() , CCS811_readMailbox() , CCS811_setEnvData() , CCS811_setMeasureMode() , and CCS811_softwareReset() .

void BOARD_hallSensorClearIRQ ( void )

Function to clear the Hall sensor interrupt.

Returns
Returns none

Definition at line 960 of file board_4166.c .

uint32_t BOARD_hallSensorEnable ( bool enable )

Enables or disables the Hall sensor.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 681 of file board_4166.c .

References BOARD_OK .

Referenced by HALL_deInit() , and HALL_init() .

uint32_t BOARD_hallSensorEnableIRQ ( bool enable )

Enables or disables the Hall sensor GPIO interrupt.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 723 of file board_4166.c .

References BOARD_OK .

Referenced by HALL_deInit() , and HALL_init() .

void BOARD_hallSensorSetIRQCallback ( BOARD_IrqCallback cb )

Function to register the Hall sensor interrupt callback function.

Parameters
[in] cb The callback function to be registered
Returns
Returns none

Definition at line 945 of file board_4166.c .

References GPIOINT_CallbackRegister() .

Referenced by HALL_init() .

uint32_t BOARD_i2cBusSelect ( uint8_t select )

Sets up the route register of the I2C device to use the correct set of pins.

  • Parameters
    [in] select The I2C bus route to use (None, Environmental sensors, Gas sensor, Hall sensor)
    Returns
    Returns zero on OK, non-zero otherwise

Definition at line 865 of file board_4166.c .

References BOARD_ERROR_I2C_BUS_SELECT_INVALID , and BOARD_OK .

Referenced by CCS811_getMeasurement() , CCS811_getRawData() , CCS811_readMailbox() , CCS811_setEnvData() , CCS811_setMeasureMode() , CCS811_softwareReset() , SI1133_registerBlockRead() , SI1133_registerBlockWrite() , SI1133_registerRead() , SI1133_registerWrite() , SI7021_cmdRead() , SI7021_cmdWrite() , SI7210_registerRead() , SI7210_registerWrite() , and SI7210_wakeUp() .

void BOARD_imuClearIRQ ( void )

Function to clear the IMU sensor interrupt.

Clears the accelerometer and gyroscope GPIO interrupt In the ThunderBoard Sense app example the IMU registers need to be read at quite high rate. Clearing the PIC interrupt register would take too much time. Due to the nature of this example only the IMU interrupt is active and the program can work correctly without identifying the interrupt source and clearing the IT flag in the PIC. If speed is not a limiting factor then always clear the PIC interrupt register by calling the BOARD_picIntClear(BOARD_PIC_REG_INT_CLEAR_IMU); function.

Returns
Returns none

Definition at line 1022 of file board_4166.c .

Referenced by IMU_clearDataReadyFlag() , and IMU_config() .

uint32_t BOARD_imuEnable ( bool enable )

Enables or disables the accelerometer and gyroscope sensor.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 472 of file board_4166.c .

References BOARD_OK .

Referenced by ICM20648_deInit() , and ICM20648_init() .

uint32_t BOARD_imuEnableIRQ ( bool enable )

Enables or disables the accelerometer and gyroscope GPIO interrupt.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 495 of file board_4166.c .

References BOARD_OK .

Referenced by IMU_config() .

void BOARD_imuSetIRQCallback ( BOARD_IrqCallback cb )

Function to register the IMU sensor interrupt callback function.

Parameters
[in] cb The callback function to be registered
Returns
Returns none

Definition at line 1007 of file board_4166.c .

References GPIOINT_CallbackRegister() .

Referenced by IMU_config() .

uint32_t BOARD_init ( void )

Initializes the Thunderboard Sense board.

Returns
Returns zero on OK, non-zero otherwise

Push button config

HALL effect sensor pin config

IMU pin config

ENV Sensor pin config

Microphone pin config

Gas sensor pin config

RGBLED / LED config

Definition at line 130 of file board_4166.c .

References BOARD_OK , GPIOINT_Init() , i2cInit() , I2CSPM_Init() , I2CSPM_Init_TypeDef::port , I2CSPM_Init_TypeDef::sclPin , I2CSPM_Init_TypeDef::sclPort , I2CSPM_Init_TypeDef::sdaPin , and I2CSPM_Init_TypeDef::sdaPort .

void BOARD_ledSet ( uint8_t leds )

Turns on or off the red and/or green LED.

Parameters
[in] leds The two LSB bits determine the state of the green and red LED. If the bit is 1 then the LED will be turned on.
Returns
None

Definition at line 385 of file board_4166.c .

uint32_t BOARD_micEnable ( bool enable )

Enables or disables the MEMS microphone.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 759 of file board_4166.c .

References BOARD_OK .

Referenced by MIC_deInit() , and MIC_init() .

void BOARD_pushButton0ClearIRQ ( void )

Function to clear the pushbutton 0 interrupt.

Returns
Returns none

Definition at line 1054 of file board_4166.c .

void BOARD_pushButton0SetIRQCallback ( BOARD_IrqCallback cb )

Function to register the pushbutton 0 interrupt callback function.

Parameters
[in] cb The callback function to be registered
Returns
Returns none

Definition at line 1039 of file board_4166.c .

References GPIOINT_CallbackRegister() .

void BOARD_pushButton1ClearIRQ ( void )

Function to clear the pushbutton 1 interrupt.

Returns
Returns none

Definition at line 1086 of file board_4166.c .

void BOARD_pushButton1SetIRQCallback ( BOARD_IrqCallback cb )

Function to register the pushbutton 1 interrupt callback function.

Parameters
[in] cb The callback function to be registered
Returns
Returns none

Definition at line 1071 of file board_4166.c .

References GPIOINT_CallbackRegister() .

void BOARD_pushButtonEnableIRQ ( bool enable )

Enables or disables the pushbutton GPIO interrupt.

Parameters
[in] enable Set true to enable, false to disable the pushbutton interrupts
Returns
None

Definition at line 308 of file board_4166.c .

uint8_t BOARD_pushButtonGetState ( void )

Gets the state of the pushbuttons.

Returns
Returns the state of the buttons

Definition at line 285 of file board_4166.c .

void BOARD_rgbledEnable ( bool enable,
uint8_t mask
)

Enables or disables the RGB LED power supply line.

Parameters
[in] enable Set true to enable, false to disable
[in] mask Mask indicating which bits to modify
Returns
None

Definition at line 348 of file board_4166.c .

References BOARD_rgbledPowerEnable() .

void BOARD_rgbledPowerEnable ( bool enable )

Enables or disables the RGB LED power supply line.

Parameters
[in] enable Set true to enable, false to disable
Returns
None

Definition at line 324 of file board_4166.c .

Referenced by BOARD_rgbledEnable() .

void BOARD_rgbledSetColor ( uint8_t red,
uint8_t green,
uint8_t blue
)

Sets the color of the RGB LEDs. The brightness of the LEDs is almost linear to the color value.

Parameters
[in] red An 8-bit value, which determines the brightness of the red channel
[in] green An 8-bit value, which determines the brightness of the green channel
[in] blue An 8-bit value, which determines the brightness of the blue channel
Returns
None

Definition at line 453 of file board_4166.c .

References BOARD_rgbledSetRawColor() .

void BOARD_rgbledSetRawColor ( uint16_t red,
uint16_t green,
uint16_t blue
)

Sets the raw color of the RGB LEDs. The brightness is non-linear function of the raw color value.

Parameters
[in] red A 16-bit value, which determines the PWM value of the red channel
[in] green A 16-bit value, which determines the PWM value of the green channel
[in] blue A 16-bit value, which determines the PWM value of the blue channel
Returns
None

Definition at line 415 of file board_4166.c .

Referenced by BOARD_rgbledSetColor() .

uint32_t BOARD_rhtempEnable ( bool enable )

Enables or disables the RH/Temp sensor.

Parameters
[in] enable Set true to enable, false to disable
Returns
Returns zero on OK, non-zero otherwise

Definition at line 584 of file board_4166.c .

References BOARD_envSensEnable() , and BOARD_OK .

Referenced by SI7021_deInit() , and SI7021_init() .