Functions#

This section provides a reference to the External Host Interface API Functions.

Functions#

void
sl_si91x_host_delay_ms(uint32_t delay_milliseconds)

Delay execution for a specified number of milliseconds.

sl_si91x_host_timestamp_t

Retrieves the current timestamp.

sl_si91x_host_timestamp_t
sl_si91x_host_elapsed_time(uint32_t starting_timestamp)

Calculates the elapsed time since a given starting timestamp.

bool

Checks if the device is initialized.

Function Documentation#

sl_si91x_host_delay_ms#

void sl_si91x_host_delay_ms (uint32_t delay_milliseconds)

Delay execution for a specified number of milliseconds.

Parameters
TypeDirectionArgument NameDescription
uint32_t[in]delay_milliseconds

The time delay in milliseconds.

This function introduces a delay for the specified amount of time in milliseconds. It uses the underlying OS delay function (osDelay) to yield the CPU, allowing other tasks to execute during the delay period. This ensures that the delay does not block the execution flow.


sl_si91x_host_get_timestamp#

sl_si91x_host_timestamp_t sl_si91x_host_get_timestamp (void )

Retrieves the current timestamp.

Parameters
TypeDirectionArgument NameDescription
voidN/A

This function retrieves the current timestamp from the host system. The timestamp can be used for various purposes such as logging, time measurements, and synchronization.

Returns

  • The current timestamp of type sl_si91x_host_timestamp_t.


sl_si91x_host_elapsed_time#

sl_si91x_host_timestamp_t sl_si91x_host_elapsed_time (uint32_t starting_timestamp)

Calculates the elapsed time since a given starting timestamp.

Parameters
TypeDirectionArgument NameDescription
uint32_t[in]starting_timestamp

The starting timestamp from which the elapsed time is calculated.

This function calculates the difference between the current timestamp and a provided starting timestamp. It is useful for measuring the time elapsed during operations.

Returns

  • The elapsed time in milliseconds of type sl_si91x_host_timestamp_t.


sl_si91x_is_device_initialized#

bool sl_si91x_is_device_initialized (void )

Checks if the device is initialized.

Parameters
TypeDirectionArgument NameDescription
voidN/A

This function verifies whether the device has been properly initialized. It is typically used to ensure that the device is ready for operation before performing any further actions.

Returns

  • Returns true if the device is initialized, false otherwise.