Skip to main content

Software Timer

LibXR provides a lightweight software timer that can even be used in bare-metal environments.

For non-bare-metal environments (e.g., with an RTOS), the software timer requires specifying thread priority and stack depth.

Example​

For bare-metal systems, the following code will be generated without any parameters:

PlatformInit();

For RTOS environments, you need to provide thread priority and stack depth:

PlatformInit(2, 512);

The first parameter is the thread priority, and the second is the stack depth.

Thread priorities are defined as follows:

  enum class Priority : uint8_t
  {
    IDLE = 0,      ///< Idle priority
    LOW = 1,       ///< Low priority
    MEDIUM = 2,    ///< Medium priority
    HIGH = 3,      ///< High priority
    REALTIME = 4,  ///< Realtime priority
    NUMBER = 5     ///< Number of priority levels
  };

Configuration File​

For non-bare-metal systems, the following configuration will be generated in User/libxr_config.yaml:

software_timer:
  priority: 2
  stack_depth: 512

You can modify this file directly. To apply updated settings, run xr_cubemx_cfg -d . or
xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp to regenerate the code.