Sensor Hub#
Introduction#
Sensor Hub products are primarily intended to address consumer, industrial, and medical applications that require wireless connectivity, extremely low power, and high performance for sensor fusion algorithms. The MCU core, wireless connectivity, and peripherals are identical to the SI917 CCP Radio board.
Sensor Hub functions as a sensor management system, facilitating hardware abstraction layer, peripheral drivers, and sensor driver layer integration to collect and distribute desired sensor data.
It enables users to collect sensor data based on time interval or number of samples or when a specific data requirement are met.
Sensor Hub serves as a framework that can be seamlessly integrated into any application requiring sensor management.
The Sensor HUB works with sensors as per configurations provided by the application and notifies the necessary events throughout the application.
The configuration for the sensors must be provided through the sensor hub config file on which the sensor hub should act.
Sensor Hub relies on FreeRTOS using CMSIS RTOS version 2 wrapper.
Configuration#
Sensor Hub has 2 Sensor Mode:
SL_SH_POLLING_MODE: This mode is Timer based.
SL_SH_INTERRUPT_MODE: This mode is NPSS Button 0 GPIO Interrupt based.
There are 3 types of data_deliver.mode in Polling Sensor Mode and they are SL_SH_THRESHOLD, SL_SH_TIMEOUT and SL_SH_NUM_OF_SAMPLES.
SL_SH_NO_DATA data_deliver.mode is used when Interrupt Sensor Mode is selected.
If the user wants a value that sets a limit or boundary, above which the sensor data should be shown then SL_SH_THRESHOLD mode should be chosen
SL_SH_TIMEOUT mode is used when user wants to get the data at some intervals of time for some sampling time
SL_SH_NUM_OF_SAMPLES mode is used when user wants to get the particular number of sensor data
SL_SH_NO_DATA mode is used when .
Here data_deliver.timeout is the time for which the sensor should keep collecting the data for.
sampling_interval is the the amount of time between two sensor data read is sampled or collected.
sampling_intr_req_pin is the GPIO pin for sampling the sensor data
Configure the number of sensors info in the **\sensors\inc\sensors_config.h** file
#define SL_MAX_NUM_SENSORS 5 // Maximum sensors present in the systemModes: Using the configuration structure, one can configure the following parameters in the sensorhub_config.c file:
For POLLING Sensor Mode configure the below parameters:
.sensor_mode = SL_SH_POLLING_MODE, .sampling_interval = 100,If sensor_mode is selected as SL_SH_POLLING_MODE, then data_deliver.mode should be configured as one of the following for a sensor configuration structure:
For TIMEOUT Data Mode configure the below parameters:
.data_deliver.mode = SL_SH_TIMEOUT, .data_deliver.timeout = 1000,For THRESHOLD Data Mode configure the below parameters:
.data_deliver.mode = SL_SH_THRESHOLD, .data_deliver.threshold = 1000,For SAMPLING Data Mode configure the below parameters:
.data_deliver.mode = SL_SH_NUM_OF_SAMPLES, .data_deliver.numOfSamples = 5,
For INTERRUPT Sensor Mode configure the below parameters:
.sensor_mode = SL_SH_INTERRUPT_MODE, .sampling_intr_req_pin = BUTTON_0_GPIO_PIN, .sensor_intr_type = SL_SH_FALL_EDGE, .data_deliver.data_mode = SL_SH_NO_DATA_MODE,
To configure the PS2, please update the below macro in the preprocessor settings:
SL_SENSORHUB_POWERSAVE=1 Enabling this macro will move the application from PS4 state to PS2 state. In PS2 state the sensor data will be sampled and collected.To configure the power states to PS4 sleep or PS2 Sleep, please update the defines in ***\gecko_sdk_4.3.2\util\third_party\freertos\kernel.h** file as below:
#ifndef configUSE_TICKLESS_IDLE #define configUSE_TICKLESS_IDLE 1 // 1 is to Enable the tickless Idle mode #endif #ifndef configPRE_SLEEP_PROCESSING #define configPRE_SLEEP_PROCESSING(x) sli_si91x_sleep_wakeup(x) // Here x is idle time, #endif // Configure the sleep time by using the below macro. // If the number of Ideal task ticks exceeds this value, the system is allowed to sleep. #ifndef configEXPECTED_IDLE_TIME_BEFORE_SLEEP #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP 70 #endifNote:
By using above sleep configuration, sensor hub is going to sleep by using the idle task and idle time.
If the Ideal time exceeds the expected sleep time value, the system is allowed to sleep.
The above idle time is fed to the Alarm timer, which we are using as a wake-up source.
ADC Configurations: Configure only below parameters for ADC to change its mode from FIFO to STATIC and vice versa
For ADC FIFO mode, configure as shown below:
.adc_config.adc_cfg.operation_mode = SL_ADC_FIFO_MODE, .adc_config.adc_ch_cfg.sampling_rate[0] = SL_SH_ADC_SAMPLING_RATE, // Use 100 for FIFO ModeFor ADC Static mode, configure as shown below:
.adc_config.adc_cfg.operation_mode = SL_ADC_STATIC_MODE, .adc_config.adc_ch_cfg.sampling_rate[0] = SL_SH_ADC_SAMPLING_RATE, // Use 1000 for Static ModeTo configure the PS1 power state from PS2 State, please update the below macro in the preprocessor settings:
SL_SH_ADC_PS1=1 Enabling this macro will move the core from PS2 Active state to PS1 statePlease update the defines in ***\gecko_sdk_4.3.2\util\third_party\freertos\kernel.h** file as below:
#ifndef configUSE_TICKLESS_IDLE #define configUSE_TICKLESS_IDLE 1 // 1 is to Enable the tickless Idle mode #endif #ifndef configPRE_SLEEP_PROCESSING #define configPRE_SLEEP_PROCESSING(x) sli_si91x_sleep_wakeup(x) // Here x is idle time, #endifNote:
The PS1 state transition only applies to ADC FIFO Mode. Before entering this mode, kindly turn off any other sensors.
Usage#
Sensorhub provides two apis which user can use for intergrating into any application
sl_si91x_sensorhub_app_task(void);
sl_si91x_sensor_event_handler(uint8_t sensor_id, uint8_t event);
sl_si91x_sensorhub_app_task(void): initialises and starts sensor data collection. it achieves this by calling the following apis
sl_si91x_sensorhub_notify_cb_register(sl_sensor_signalEvent_t cb_event, sl_sensor_id_t *cb_ack): links the event handler provided by the user as a callback function in the event task
sl_si91x_sensorhub_init(): initializes the peripherals I2C, SPI, ADC, SDC
sl_si91x_sensorhub_detect_sensors(sl_sensor_id_t *sensor_id_info, uint8_t num_of_sensors): scans the i2c sensors provided in the sensorhub_config.c and returns the number of these sensors that are currently connected
sl_si91x_sensorhub_create_sensor(sl_sensor_id_t sensor_id): Initializes the sensor by calling the init function of the sensor provided by the user in the respective HAL, Assigs memory to it based on the data delivery mode, Creates a timer for this sensor if required
sl_si91x_sensor_hub_start(): initializes the sensor task, event task and power task
sl_si91x_sensorhub_start_sensor(sl_sensor_id_t sensor_id): starts the timers of the sensors created in create sensor api
sl_si91x_sensor_event_handler(uint8_t sensor_id, uint8_t event) is called by the event task after sensor data is collected ,in the sensorhub appilcation it prints the data based on the sensor id and uploads it to the cloud
Modules#
Enumerations#
Enumeration for Sensor HUB data reading mode.
Enumeration for Sensors HUB Callback Events.
Enumeration for GPIO Interrupt Configurations.
Enumeration for Sensor HUB data delivery mode.
Enumeration for Sensors Status.
Typedefs#
ADC bus interface configuration structure.
Variables#
I2C bus error status.
SPI bus error status.
ADC bus error status.
All buses error status.
Threshold value for the sensor.
Threshold value for the sensor.
Timeout values for the sensor.
Timeout values for the sensor.
Number of samples for the sensor.
Number of samples for the sensor.
Name of the sensor.
GPIO Interrupt Configurations.
GPIO pin for sampling the sensor data.
Sensor data sampling interval.
Address of sensor.
Address of sensor.
Channel for adc.
Channel for adc.
Sensor id.
Protocol for the sensor(spi/i2c)
Sensor Mode(Enumeration)
Range of sensor.
Data delivery mode for the sensor.
Sensor data storage structure.
Sensor handle.
Sensor control handle.
Sensor event bits.
Sensor event acknowledge.
Maximum samples for the sensors.
Sensor configuration structure.
Sensor implementation structure.
Sensor status.
RTOS timer handle.
Sensor index.
Sensor handle structure.
Interrupt mode sensor index.
Interrupt GPIO Pin.
Channel number for ADC interrupt.
Channel number for ADC interrupt.
Map Table Index.
Sensor list MAP Table.
String the sensor data address.
Sensor id information.
Sensors HUB Callback Events.
Event callback.
Event callback acknowledge.
I2C instances(I2C0/1/2)
I2C power state.
I2C bus control configuration.
I2C bus speed.
I2C slave address.
SPI bus width.
SPI Mode(Master/Slave)
SPI bus power mode.
Chip select number.
SPI miscellaneous for chip select.
SPI slave select signal definitions.
SPI bus data transmission speed(clock)
SPI bus phase and polarity.
SPI control slave select mode.
flag to know if adc is initialized, this is necessary to deinit
flag to indicate data availability for all 16 channels
adc configuration
adc channel configuration
I2C configuration structure.
SPI configuration structure.
ADC configuration structure.
GPIO configuration structure.
SDC configuration structure.
Functions#
Initialization Peripherals of Sensor HUB.
Detect the sensors.
Delete the specific sensor from the Sensor HUB.
Create a sensor instance in the sensor hub.
Start the sensor operation for the given sensor.
Stop the sensor operation of the given sensor.
Post the events to event manager(EM) to be notified to the application.
Task to handle the sensor operations.
Task to handle the system power operations.
Task to handle the operations of the Event Manager(EM)
Initialize the I2C Interface based on configuration.
Initialize SPI Interface based on configuration.
Scan the I2C sensors.
to get sensor implementation.
Create the sensor list index.
Get the sensor index for the sensor list.
Delete the sensor index for the sensor list.
get the sensor info from the sensor configuration structure.
Call back function to the application.
Sensor OS timer callback function.
Configuring the different types of NPSS GPIO interrupts in the Sensor HUB.
Enable and set the priority of NPSS GPIO interrupt.
Mask and Disable the NPSS GPIO interrupt.
Start the sensor hub Tasks.
set the alarm interrupt time.
initialize the Alarm block.
Configure the wake-up source for the system.
Configures sleep/wakeup sources for the system.
Change the system status from PS4 to PS2.
Change the system status from PS2 to PS4.
Initialize ADC Interface based on configuration.
Initialize and configure the systic timer for the RTOS.
I2C event handler.
Fetch ADC bus interface information.
ADC callback from RSI_ADC_InterruptHandler.
Initialize the sdc Interface based on the configuration.
Macros#
Sensor task stack size.
EM task stack size.
Power task stack size.
Max wait time of message queue in Event task.
Size of the sensors interrupt MAP table.
NPSS gpio IRQ handler.
NPSS gpio IRQ Number 21.
Periodic alarm configuration in milliseconds.
RC clock trigger time.
RO clock trigger time.
Number of hours in a day.
Number of minutes in an hour.
Number of Seconds in a minute.
Number of milliseconds in a second.
Number of months in a year.
Start year for alarm configuration.
Month with 28 days.
Month with 29 days.
Month with 30 days.
Month with 31 days.
Alarm IRQ handler.
Alarm IRQ number 28.
Creating OS timer for the sensor failed.
Deleting OS timer of the sensor failed.
Starting OS timer of the sensor failed.
Stopping OS timer of the sensor failed.
Max number of sensor limit reached.
Memory allocation for sensor data storage failed.
Sensor API is called for a sensor without creating it.
Sensor set power command execution failed.
Sensor set range command execution failed.
Sensor self-test command execution failed.
Generic error code for any invalid parameters.
Invalid gpio number.
No hal implementation found for given sensor type.
Interrupt type configuration failed.
Allocating memory for sensor hal failed.
Sensor not created.
Sensor configuration not found.
No sensor found at given address.
Invalid interrupt type is given for the sensor.
Invalid mode is given for the sensor.
Invalid delivery mode is given for the sensor.
Create sensor in HAL failed.
Delete sensor in HAL failed.
Sample sensor in HAL failed.
Control sensor in HAL failed.
Power task creation failed.
Sensor task creation failed.
EM task creation failed.
All(i2c,spi,adc) peripheral's initialization failed.
Enumeration Documentation#
sl_sensor_mode_t#
sl_sensor_mode_t
Enumeration for Sensor HUB data reading mode.
| Enumerator | |
|---|---|
| SL_SH_POLLING_MODE | POLLING_MODE. |
| SL_SH_INTERRUPT_MODE | INTERRUPT_MODE. |
| SL_SH_NO_MODE | |
sl_sensorhub_event_t#
sl_sensorhub_event_t
Enumeration for Sensors HUB Callback Events.
| Enumerator | |
|---|---|
| SL_SENSOR_CREATION_FAILED | |
| SL_SENSOR_STARTED | |
| SL_SENSOR_STOPPED | |
| SL_SENSOR_DATA_READY | |
| SL_SENSOR_CNFG_INVALID | |
| SL_SENSOR_START_FAILED | |
| SL_SENSOR_STOP_FAILED | |
| SL_SENSOR_DELETED | |
| SL_SENSOR_DELETE_FAILED | |
sl_gpio_intr_type_t#
sl_gpio_intr_type_t
Enumeration for GPIO Interrupt Configurations.
| Enumerator | |
|---|---|
| SL_SH_RISE_EDGE | Interrupt at GPIO rise edge. |
| SL_SH_FALL_EDGE | Interrupt at GPIO fall edge. |
| SL_SH_LOW_LEVEL | Interrupt at GPIO low level. |
| SL_SH_HIGH_LEVEL | Interrupt at GPIO high level. |
sl_data_deliver_mode_t#
sl_data_deliver_mode_t
Enumeration for Sensor HUB data delivery mode.
| Enumerator | |
|---|---|
| SL_SH_THRESHOLD | Threshold value for sensor data delivery. |
| SL_SH_TIMEOUT | Timeout value for sensor data delivery. |
| SL_SH_NUM_OF_SAMPLES | Number of samples for sensor data delivery. |
| SL_SH_NO_DATA_MODE | |
sl_sensor_status_t#
sl_sensor_status_t
Enumeration for Sensors Status.
| Enumerator | |
|---|---|
| SL_SENSOR_INVALID | Sensor is Invalid. |
| SL_SENSOR_VALID | Sensor is Valid. |
| SL_SENSOR_START | Sensor is Started. |
| SL_SENSOR_STOP | Sensor is Stoped. |
Typedef Documentation#
Variable Documentation#
sampling_intr_req_pin#
uint16_t sl_sensor_info_t::sampling_intr_req_pin
GPIO pin for sampling the sensor data.
data_deliver#
sl_data_deliver_type_t sl_sensor_info_t::data_deliver
Data delivery mode for the sensor.
sensor_data_ptr#
sl_sensor_data_group_t* sl_sensor_info_t::sensor_data_ptr
Sensor data storage structure.
sl_sensors_st#
sl_sensor_handle_t sl_sensor_list_t::sl_sensors_st[SL_MAX_NUM_SENSORS]
Sensor handle structure.
adc_init#
uint8_t sl_adc_config::adc_init
flag to know if adc is initialized, this is necessary to deinit
adc_data_ready#
uint16_t sl_adc_config::adc_data_ready
flag to indicate data availability for all 16 channels
Function Documentation#
sl_si91x_sensorhub_init#
sl_status_t sl_si91x_sensorhub_init ( -, -)
Initialization Peripherals of Sensor HUB.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | - | NULL | |
| [out] | - | Return the Sensor Hub bus Initialization status |
This function will initialize the Peripherals, based on the user configuration. like - I2C/SPI/ADC
Returns
status 0 if successful, else error code as follow:
SL_STATUS_FAIL (0x0001)- Fail, Peripherals initialization failed
SL_STATUS_OK (0X000)- Success, Peripherals initialization done properly
sl_si91x_sensorhub_detect_sensors#
sl_status_t sl_si91x_sensorhub_detect_sensors (sl_sensor_id_t sensor_id_info, uint8_t num_of_sensors, -)
Detect the sensors.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id_info | - Sensor IDs |
| uint8_t | [in] | num_of_sensors | - Number of sensors given by user |
| [out] | - | None |
This function will detect the sensor, based on the user configuration. and it will store the scanned sensor ID in the structure.
Returns
if successful, Return number of sensors scanned else error code
sl_si91x_sensorhub_delete_sensor#
sl_status_t sl_si91x_sensorhub_delete_sensor (sl_sensor_id_t sensor_id, -)
Delete the specific sensor from the Sensor HUB.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Sensor ID |
| [out] | - | Return the delete sensors status |
This function will delete the specific sensor from the sensor list, modify the sensor status to invalid, and publish the events to the event task.
Returns
status 0 if successful, else error code as follow:
SL_STATUS_FAIL (0x0001) - Fail, Delete sensor failed
SL_STATUS_OK (0X000) - Success, Delete sensor Success
sl_si91x_sensorhub_create_sensor#
sl_status_t sl_si91x_sensorhub_create_sensor (sl_sensor_id_t sensor_id, -)
Create a sensor instance in the sensor hub.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Id of sensor |
| [out] | - | Return the create sensors status |
This function creates a sensor instance as per user configuration.It also allocates max sample memory for the configured sensor.
Returns
status 0 if successful, else error code as follow:
SL_STATUS_FAIL (0x0001)- Fail, Create sensor instance failed
SL_STATUS _OK (0X000) - Create sensor instanceSuccess ,
sl_si91x_sensorhub_start_sensor#
sl_status_t sl_si91x_sensorhub_start_sensor (sl_sensor_id_t sensor_id, -)
Start the sensor operation for the given sensor.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Id of sensor |
| [out] | - | Return the Start sensors status |
This function can be called after creating a sensor with given sensor ID It does following operations
Starts timer for sensor with polling mode.
Enable IRQ handle for sensor with interrupt mode.
Returns
status 0 if successful, else error code as follow:
SL_STATUS_FAIL (0x0001)- Fail, Sensor start failed
SL_STATUS _OK (0X000) - Success ,Sensor start done properly
sl_si91x_sensorhub_stop_sensor#
sl_status_t sl_si91x_sensorhub_stop_sensor (sl_sensor_id_t sensor_id, -)
Stop the sensor operation of the given sensor.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Id of sensor |
| [out] | - | Return the Stop sensor status |
This function does following operations
Stop the sensor operations of the given sensor.
Based on the sensor mode it will stop the Polling/interrupt mode operations and updates the sensor statutes.
Disable IRQ handles of the interrupt mode sensors.
Returns
status 0 if successful, else error code as follows:
SL_STATUS_FAIL (0x0001)- Fail, Sensor stop failed
SL_STATUS _OK (0X000) - Success ,Sensor stop done properly
sl_si91x_em_post_event#
void sl_si91x_em_post_event (sl_sensor_id_t sensor_id, sl_sensorhub_event_t event, void * dataPtr, TickType_t ticks_to_wait, -)
Post the events to event manager(EM) to be notified to the application.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - id of the sensor |
| sl_sensorhub_event_t | [in] | event | - sensor hub events |
| void * | [in] | dataPtr | - sensor data pointer |
| TickType_t | [in] | ticks_to_wait | - max time to wait for the post |
| [out] | - | None |
It waits for mutex till ticks_to_wait and updates event queue if mutex is acquired
Returns
- NULL
sl_si91x_sensor_task#
void sl_si91x_sensor_task (void , -)
Task to handle the sensor operations.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
Sensor Task does following operations
Create the OS event and mutex to perform the sensor operations.
Sample the Sensor data based on the event flags.
Check the events and post the sensor data to the em task based on the sensor data delivery mode.
Returns
- NULL
sl_si91x_power_state_task#
void sl_si91x_power_state_task (void , -)
Task to handle the system power operations.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
Power state task changes the system from one power save mode to another power save mode like(PS4 to PS2),(PS2toPS4),(Sleep_mode) using Binary semaphore
Returns
- NULL
sl_si91x_em_task#
void sl_si91x_em_task (void , -)
Task to handle the operations of the Event Manager(EM)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
Em task does following operaions
Create the osMessageQueue and mutex to perform the event operations.
Calls the callback event Returns
- NULL
sli_si91x_i2c_init#
int32_t sli_si91x_i2c_init (void , -)
Initialize the I2C Interface based on configuration.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
This function will configure/Initialize I2C Interface based on configuration.
Returns
I2C Initializtion status
sli_si91x_spi_init#
int32_t sli_si91x_spi_init (void , -)
Initialize SPI Interface based on configuration.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
This function will configure/Initialize SPI Interface based on configuration.
Returns
SPI Initializtion status.
sli_si91x_i2c_sensors_scan#
int32_t sli_si91x_i2c_sensors_scan (uint16_t address, -)
Scan the I2C sensors.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | address | - Address of sensor |
| [out] | - | None |
This function will scan the I2C sensors based on the sensor address.
Returns
status 0 if successful, else it will wait for the sensor response.
sli_si91x_get_sensor_implementation#
sl_sensor_impl_type_t * sli_si91x_get_sensor_implementation (int32_t sensor_id, -)
to get sensor implementation.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| int32_t | [in] | sensor_id | - Id of sensor |
| [out] | - | None |
This function will get the sensor implementation of the sensor based on sensor ID.
Returns
if successful, returns the Sensor implementation structure else returns an error code.
sli_si91x_create_sensor_list_index#
int32_t sli_si91x_create_sensor_list_index ( -, -)
Create the sensor list index.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | - | None | |
| [out] | - | Returns the Sensor ID from the implementation struct |
This function will Create the sensor list index based on the sensor status For the maximum sensors available in the sensor hub
Returns
returns the sensor index in sensor_list
sli_si91x_get_sensor_index#
uint32_t sli_si91x_get_sensor_index (sl_sensor_id_t sensor_id, -)
Get the sensor index for the sensor list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Id of sensor |
| [out] | - | None |
This function will retrieve the sensor index from the sensor list based on the sensor status and sensor ID for the maximum number of sensors available in the sensor hub.
Returns
if successful, returns the sensor index else returns SL_SH_SENSOR_INDEX_NOT_FOUND(0XFF).
sli_si91x_delete_sensor_list_index#
uint32_t sli_si91x_delete_sensor_list_index (sl_sensor_id_t sensor_id, -)
Delete the sensor index for the sensor list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Id of sensor |
| [out] | - | None |
This function will delete the sensor from the sensor list based on The sensor ID for the maximum number of sensors available in the sensor hub.
Returns
if successful, returns the sensor index else returns error code SL_SH_SENSOR_INDEX_NOT_FOUND(0XFF).
sli_si91x_get_sensor_info#
sl_sensor_info_t * sli_si91x_get_sensor_info (sl_sensor_id_t sensor_id, -)
get the sensor info from the sensor configuration structure.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_id_t | [in] | sensor_id | - Id of sensor |
| [out] | - | None |
This function will retrieve sensor data from the sensor configuration structure to update the sensor list configuration structure for the maximum number of sensors available in the sensor hub.
Returns
if successful, returns the sensor information. else returns NULL.
sl_si91x_sensorhub_notify_cb_register#
sl_status_t sl_si91x_sensorhub_notify_cb_register (sl_sensor_signalEvent_t cb_event, sl_sensor_id_t * cb_ack, -)
Call back function to the application.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_sensor_signalEvent_t | [in] | cb_event | - Pointer to the callback event |
| sl_sensor_id_t * | [in] | cb_ack | - Pointer to callback acknowledge to the application |
| [out] | - | None |
This function will update the callback function event and acknowledgment.
Returns
- If successful returns SL_STATUS_OK else returns error code
sl_si91x_sensors_timer_cb#
void sl_si91x_sensors_timer_cb (TimerHandle_t xTimer, -)
Sensor OS timer callback function.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| TimerHandle_t | [in] | xTimer | - Timer handle |
| [out] | - | None |
This function will set the event flag bits based on the sensor sampling intervals. In the polling mode call the timer call-back function.
Returns
- NULL
sl_si91x_gpio_interrupt_config#
sl_status_t sl_si91x_gpio_interrupt_config (uint16_t gpio_pin, sl_gpio_intr_type_t intr_type, -)
Configuring the different types of NPSS GPIO interrupts in the Sensor HUB.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | gpio_pin | - NPSS gpio pin number |
| sl_gpio_intr_type_t | [in] | intr_type | NPSS gpio interrupt type |
| [out] | - | None |
This function configures the NPSS gpios and enables the interrupt mode for the gpios.
Returns
- If successful returns SL_STATUS_OK else returns error code
sl_si91x_gpio_interrupt_start#
void sl_si91x_gpio_interrupt_start (uint16_t gpio_pin, -)
Enable and set the priority of NPSS GPIO interrupt.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | gpio_pin | - NPSS gpio pin number |
| [out] | - | None |
This function configures and sets the priority of the NPSS GPIO interrupt. GPIO interrupt priority is (configMAX_SYSCALL_INTERRUPT_PRIORITY - 1)
Returns
- NULL
sl_si91x_gpio_interrupt_stop#
void sl_si91x_gpio_interrupt_stop (uint16_t gpio_pin, -)
Mask and Disable the NPSS GPIO interrupt.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | gpio_pin | - NPSS gpio pin number |
| [out] | - | None |
This function masks and disables the IRQ handler of the NPSS GPIO interrupt.
Returns
- NULL
sl_si91x_sensor_hub_start#
sl_status_t sl_si91x_sensor_hub_start (void , -)
Start the sensor hub Tasks.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
This Starts the sensor hub Tasks.
Returns
- If succesfull returns SL_STATUS_OK else returns error code
sli_si91x_set_alarm_intr_time#
void sli_si91x_set_alarm_intr_time (uint16_t interval, -)
set the alarm interrupt time.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | interval | - interval time |
| [out] | - | None |
This function will set the alarm interrupt based on the periodic time.
Returns
- NULL
sli_si91x_init_m4alarm_config#
void sli_si91x_init_m4alarm_config (void , -)
initialize the Alarm block.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
This function will initialize the Alarm block.
Returns
- NULL
sli_si91x_config_wakeup_source#
void sli_si91x_config_wakeup_source (uint16_t sleep_time, -)
Configure the wake-up source for the system.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | sleep_time | - Sleep time for the sensor hub |
| [out] | - | None |
This function will configure the wake-up source to the system.
Returns
- NULL
sli_si91x_sleep_wakeup#
void sli_si91x_sleep_wakeup (uint16_t sh_sleep_time, -)
Configures sleep/wakeup sources for the system.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | sh_sleep_time | - Sleep time for the sensor hub, in ADC PS-1 no parameters |
| [out] | - | None |
This function will configure sleep/wakeup sources.
Returns
- NULL
sli_si91x_sensorhub_ps4tops2_state#
void sli_si91x_sensorhub_ps4tops2_state (void , -)
Change the system status from PS4 to PS2.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
This function will change the system status from PS4 to PS2.
Returns
- NULL
sli_si91x_sensorhub_ps2tops4_state#
void sli_si91x_sensorhub_ps2tops4_state (void , -)
Change the system status from PS2 to PS4.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
This function will change the system status from PS2 to PS4.
Returns
- NULL
sli_si91x_adc_init#
sl_status_t sli_si91x_adc_init (void )
Initialize ADC Interface based on configuration.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None |
This function will configure/Initialize ADC Interface based on configuration.
Returns
error code SL_STATUS_FAIL (0x0001)- Fail , SL_STATUS_OK (0X000)- Success
vPortSetupTimerInterrupt#
void vPortSetupTimerInterrupt (void , -)
Initialize and configure the systic timer for the RTOS.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] | None | |
| [out] | - | None |
Set up the systic timer to generate the tick interrupts at the required frequency.
Returns
Initialize status to the application.
ARM_I2C_SignalEvent#
void ARM_I2C_SignalEvent (uint32_t event, -)
I2C event handler.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | [in] | event | - I2C transmit and receive events |
| [out] | - | None |
Returns
None
sl_si91x_fetch_adc_bus_intf_info#
sl_adc_cfg_t * sl_si91x_fetch_adc_bus_intf_info (void )
Fetch ADC bus interface information.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
This can be used by lower level layers Returns
Pointer to ADC configuration structure
sl_si91x_adc_callback#
void sl_si91x_adc_callback (uint8_t channel_no, uint8_t event)
ADC callback from RSI_ADC_InterruptHandler.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | [in] | channel_no | - respective channel number |
| uint8_t | [in] | event | - callback event (ADC_STATIC_MODE_CALLBACK, ADC_THRSHOLD_CALLBACK, INTERNAL_DMA, FIFO_MODE_EVENT) |
sli_si91x_sdc_init#
uint8_t sli_si91x_sdc_init (void )
Initialize the sdc Interface based on the configuration.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
status 0 if successful, else error code SL_STATUS_FAIL (0x0001)- Fail , SL_STATUS_OK (0X000)- Success,
sli_config_sdc_params#
void sli_config_sdc_params (sl_drv_sdc_config_t * sdc_config_st_p)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_drv_sdc_config_t * | N/A | sdc_config_st_p |