Brown-Out Detection and Blackout Monitoring#

bod_callback_t#

typedef void(* bod_callback_t) (void) )(void)

BOD callback function type.

bod_button_callback_t#

typedef void(* bod_button_callback_t) (uint8_t button) )(uint8_t button)

Button callback function type.

sl_button_en_t#

typedef uint8_t sl_button_en_t

Button enable type.

sl_si91x_bod_set_mode#

sl_status_t sl_si91x_bod_set_mode (uint8_t mode)

Set the BOD mode.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the operation.

  • SL_STATUS_OK if the operation was successful.

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

• Note

  • The mode can be set to either SL_BOD_MANUAL_MODE or SL_BOD_AUTOMATIC_MODE.

    • SL_BOD_MANUAL_MODE allows manual control of the BOD settings.

    • SL_BOD_AUTOMATIC_MODE enables automatic BOD operation based on predefined settings.

sl_si91x_bod_config_slot_value#

sl_status_t sl_si91x_bod_config_slot_value (uint16_t slot_value)

Configure the slot value for BOD.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

  • The BOD mode must be set using sl_si91x_bod_set_mode() As SL_BOD_MODE_AUTOMATIC.

Returns

• Status of the operation.

  • SL_STATUS_OK if the operation was successful.

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

sl_si91x_bod_init#

sl_status_t sl_si91x_bod_init (void )

Initialize the BOD module.

This function initializes the BOD module with the specified battery voltage threshold.

Returns

• Status of the BOD initialization operation.

  • SL_STATUS_OK if the initialization was successful.

  • SL_STATUS_FAIL if the initialization failed.

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

sl_si91x_bod_deinit#

sl_status_t sl_si91x_bod_deinit (void )

Deinitialize the BOD module.

This function deinitializes the BOD module.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the BOD deinitialization operation.

  • SL_STATUS_OK if the deinitialization was successful.

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

sl_si91x_bod_get_threshold#

sl_status_t sl_si91x_bod_get_threshold (float * vbatt_threshold)

Get the BOD threshold value.

This function retrieves the current threshold value set for the BOD.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the BOD configuration operation.

  • SL_STATUS_OK if the configuration was successful.

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

sl_si91x_bod_NVIC_enable_irq#

void sl_si91x_bod_NVIC_enable_irq (void )

Enable the BOD interrupt in the NVIC.

This function enables the interrupt for the BOD in the NVIC, allowing the system to handle BOD-related interrupts.

sl_si91x_bod_get_blackout_status#

en_t sl_si91x_bod_get_blackout_status (void )

sl_si91x_bod_get_blackout_status

This function is used to get the blackout status.

Returns

• Returns the blackout enable status.

sl_si91x_bod_set_configuration#

sl_status_t sl_si91x_bod_set_configuration (sl_bod_uc_param_t usr_config_params)

Set the BOD configuration.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the BOD configuration operation.

  • SL_STATUS_OK if the configuration was successful.

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

sl_si91x_bod_button_configuration#

void sl_si91x_bod_button_configuration (uint16_t button_max_value, uint16_t button1_min_value, uint16_t button2_min_value, uint16_t button3_min_value)

Configures the BOD (Brown-Out Detector) button values.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init() and

  • The BOD button must be initialized using sl_si91x_bod_button_wakeup_enable().

This function sets the maximum value for the button and the minimum values for three different buttons.

sl_si91x_bod_button_wakeup_enable#

void sl_si91x_bod_button_wakeup_enable (uint8_t enable)

Enable or disable button wakeup functionality for the BOD (Brown-Out Detector).

This function allows the user to enable or disable the button wakeup feature for the BOD. When enabled, the system can wake up from a low-power state using a button press.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init() and

  • The BOD button must be initialized using sl_si91x_bod_button_wakeup_enable().

sl_si91x_bod_register_callback#

sl_status_t sl_si91x_bod_register_callback (bod_callback_t callback)

Register a callback function for BOD interrupts.

This function registers a callback function to be called when a BOD interrupt occurs.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the callback registration operation.

  • SL_STATUS_OK if the operation was successful.

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

sl_si91x_bod_button_register_callback#

sl_status_t sl_si91x_bod_button_register_callback (bod_button_callback_t callback)

Register a callback function for BOD button interrupts.

This function registers a callback function to be called when a BOD button interrupt occurs.

• Pre-conditions:

  • The BOD module must be initialized using .and

  • The BOD button must be initialized using sl_si91x_bod_button_wakeup_enable().

Returns

• Status of the callback registration operation.

  • SL_STATUS_OK if the operation was successful.

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

sl_si91x_bod_unregister_callback#

void sl_si91x_bod_unregister_callback (void )

Unregister the callback function for BOD interrupts.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

  • BOD callback must be registered using sl_si91x_bod_register_callback().

This function unregisters the callback function for BOD interrupts.

sl_si91x_bod_interrupt_handler#

void sl_si91x_bod_interrupt_handler (void )

Handle BOD interrupts.

This function handles BOD interrupts.

sl_si91x_bod_get_battery_status#

sl_status_t sl_si91x_bod_get_battery_status (float * battery_status)

Get the current battery status.

This function retrieves the current battery status.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the battery status retrieval operation.

  • SL_STATUS_OK if the operation was successful.

  • SL_STATUS_INVALID_PARAMETER if the battery_status pointer is NULL.

For more information on status codes, see SL STATUS DOCUMEN TATION.

sl_si91x_bod_set_threshold#

sl_status_t sl_si91x_bod_set_threshold (float threshold)

Set the BOD voltage threshold.

This function sets the BOD voltage threshold to the specified value.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

Returns

• Status of the BOD threshold setting operation.

  • SL_STATUS_OK if the setting was successful.

  • SL_STATUS_INVALID_PARAMETER if the threshold is out of range.

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

sl_si91x_bod_enable_interrupt#

void sl_si91x_bod_enable_interrupt (void )

Enable BOD interrupt.

This function enables the BOD interrupt for detecting voltage drops below the threshold.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

sl_si91x_bod_disable_interrupt#

void sl_si91x_bod_disable_interrupt (void )

Disable BOD interrupt.

This function disables the BOD interrupt.

• Pre-conditions:

  • The BOD module must be initialized using sl_si91x_bod_init().

  • BOD interrupt must be enabled using sl_si91x_bod_enable_interrupt().

sl_si91x_bod_clear_interrupt#

void sl_si91x_bod_clear_interrupt (void )

Clear BOD interrupt.

This function clears the BOD interrupt flag.

sl_si91x_bod_battery_percentage#

sl_status_t sl_si91x_bod_battery_percentage (float voltage, float * vbat_per)

Calculate the battery percentage based on the given voltage.

This function takes a voltage value and calculates the corresponding battery percentage, storing the result in the provided pointer.

• Pre-conditions:

  • BOD battery status must be read using sl_si91x_bod_get_battery_status()

Returns

• sl_status_t Returns the status of the operation.

  • SL_STATUS_OK if the operation was successful.

  • SL_STATUS_INVALID_PARAMETER if the input voltage is out of range.

sl_si91x_bod_black_out_reset#

void sl_si91x_bod_black_out_reset (en_t enable)

Controls the Black Out Detector (BOD) reset functionality.

This function enables or disables the Black Out Detector (BOD) reset. The BOD reset is used to reset the system when the supply voltage drops below a certain threshold, ensuring the system does not operate under unsafe conditions.

sl_si91x_bod_button_interrupt_clear#

void sl_si91x_bod_button_interrupt_clear (void )

Clears the BOD (Brown-Out Detector) button interrupt.

This function is used to clear the interrupt triggered by the BOD button. It ensures that the interrupt flag is reset, allowing for subsequent interrupts to be detected and handled appropriately.

sl_si91x_bod_enable_blackout_in_sleep_mode#

void sl_si91x_bod_enable_blackout_in_sleep_mode (void )

Enable the blackout reset in sleep mode.

This API is used to enable the blackout reset functionality when the device is in sleep mode. Blackout reset helps in protecting the device from unexpected power failures by resetting the device.

sl_si91x_bod_disable_blackout_in_sleep_mode#

void sl_si91x_bod_disable_blackout_in_sleep_mode (void )

Disable the blackout reset in sleep mode.

This API is used to disable the blackout reset functionality when the device is in sleep mode. Blackout reset helps in protecting the device from unexpected power failures by resetting the device.