Sensor Data Collector#

sl_sdc_event_t#

sl_sdc_event_t

Enumeration for SDC Events.

sl_sdc_callback_t#

typedef void(* sl_sdc_callback_t) (uint8_t channel, sl_sdc_event_t event) )(uint8_t channel, sl_sdc_event_t event)

Callback function type for Sensor Data Controller (SDC) events.

This typedef defines a function pointer for SDC event callbacks. The callback function is invoked when SDC events occur.

Note

• The application must register this callback to receive notifications about SDC events

sl_si91x_sdc_driver_init#

sl_status_t sl_si91x_sdc_driver_init (float vref)

Initialize the SDC driver.

• This function initializes the SDC driver by performing the following steps:

  1. Initializes the RTC block.

  2. Starts the RTC.
     

  3. Initializes the SDC peripheral.

  4. Gets the chip voltage and update input voltage if required.

  5. Calibrates the ADC.

  6. Calculates the offset and gain values and stores them.

  7. Configures the SDC LDO voltage based on the reference voltage.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully initialized the SDC.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_deinit#

sl_status_t sl_si91x_sdc_driver_deinit (void )

Deinitialize the SDC driver.

• This function performs the following steps:

  1. Stops the RTC to ensure no further operations are performed on it.

  2. Disables the SDC NVIC interrupt to prevent further interrupts.

  3. Deinitializes the SDC peripheral.

  4. Disables the SDC LDO to save power.

  5. Resets the global variable sdc_channel_info to zero.

  6. Resets the global variable sdc_calibration_data to zero.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully deinitialized the SDC.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_config#

sl_status_t sl_si91x_sdc_driver_config (sl_si91x_sdc_config_t * sl_sdc_config)

Configure the SDC driver with channel and pin configuration.

• This function performs the following steps:

  1. Checks if the provided configuration pointer is NULL and returns an error if it is.

  2. Decrements the sample threshold and trigger event select values in the configuration to match the expected values in the SDC register.

  3. Configures the SDC with the provided configuration using the sl_si91x_sdc_config function.

  4. Returns the status of the configuration operation.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully configured the SDC.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

• For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_channel_config#

sl_status_t sl_si91x_sdc_driver_channel_config (sl_si91x_sdc_adc_config_t * pin_config, sl_si91x_sdc_channel_info_t * sdc_channel_config, sl_si91x_sdc_channel_misc_config_t * misc_config)

Configures an SDC channel with the specified settings.

• This function performs the following steps:

  1. Checks if the provided pin configuration and channel configuration pointers are NULL and returns an error if they are.

  2. Configures the SDC ADC pins using the sl_si91x_sdc_adc_pin_config function with the provided pin configuration and the number of channels.

  3. Iterates through each channel and initializes the channel information structure with the provided settings:

     • Sets the sample length for each channel.

     • Sets the receive buffer for each channel.

     • Sets the differential mode and auto buffer reset bits in the channel info bit field.

  4. Returns the status of the configuration operation.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

Note

• 1. pin_config structure is auto-generated when instance is created in the application user can directly use that structure.

Returns

• • SL_STATUS_OK on success.

  • SL_STATUS_FAIL on failure.

• For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_register_callback#

sl_status_t sl_si91x_sdc_driver_register_callback (sl_sdc_callback_t callback_event)

Register a callback for SDC events.

This API registers a user-provided callback function that is invoked when an SDC event occurs.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully registered the callback.

  • SL_STATUS_BUSY - Callback already registered.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_unregister_callback#

sl_status_t sl_si91x_sdc_driver_unregister_callback (void )

Unregister the SDC callback.

This API unregisters the callback function registered for SDC events.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

  • sl_si91x_sdc_driver_register_callback

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully unregistered the callback.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_read_data_start#

sl_status_t sl_si91x_sdc_driver_read_data_start (void )

Start reading data from SDC.

This API starts the SDC data acquisition process.

1. It prepares the SDC to read data and provides a buffer to store the received data.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

  • sl_si91x_sdc_driver_config

  • sl_si91x_sdc_driver_channel_config

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully started data read.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_stop#

sl_status_t sl_si91x_sdc_driver_stop (void )

Stop the SDC driver.

This API stops the SDC data acquisition process.

1. It disables the SDC interrupt and stops the SDC sampling process.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

  • sl_si91x_sdc_driver_config

  • sl_si91x_sdc_driver_channel_config

  • sl_si91x_sdc_driver_read_data_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully stopped the SDC.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_store_data#

sl_status_t sl_si91x_sdc_driver_store_data (void )

Store the data from SDC FIFO registers.

This API performs the following steps:

1. Reads the data from the SDC FIFO.

2. channel_id is decremented by 1 to match the zero-based index.

3. Checks if the channel is in differential mode and processes the data accordingly.

4. Stores the processed data in the channel's receive buffer.

5. Increments the transfer count for the channel.

6. Checks if the transfer count has reached the sample length for the channel. If it has, it calls the callback function with the SDC_EVENT_SAMPLE_COMPLETE event for that channel.

7. If the channel is set to auto buffer reset, it resets the transfer count for the channel and clears the transfer complete bit in the channel info bit field.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

  • sl_si91x_sdc_driver_config

  • sl_si91x_sdc_driver_channel_config

  • sl_si91x_sdc_driver_read_data_start

  • sl_si91x_sdc_driver_register_callback

Note

• 1. This API should be called only after the SDC is started.

  1. If auto buffer reset is enabled, the write pointer wraps around to the start of the buffer when it reaches the end, allowing new data to overwrite the oldest data.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Successfully reads the SDC data.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_sdc_driver_read_data#

sl_status_t sl_si91x_sdc_driver_read_data (uint32_t channel, int16_t * buffer, uint8_t length)

Reads data from the SDC driver for the specified channel.

This function reads data of specified length from the given SDC channel and stores it in the provided buffer.

• Pre-conditions:

  • sl_si91x_sdc_driver_init

  • sl_si91x_sdc_driver_config

  • sl_si91x_sdc_driver_channel_config

  • sl_si91x_sdc_driver_read_data_start

Returns

• • SL_STATUS_OK if the data was read successfully.

  • SL_INVALID_PARAMETER if the provided parameters are invalid (e.g., channel number out of range, buffer is NULL, or length > threshold). For more information on status codes, see SL STATUS DOCUMENTATION.