Crate veecle_freertos_integration

Crate veecle_freertos_integration 

Source
Expand description

§Veecle FreeRTOS Integration

Rust wrapper for FreeRTOS.

Requires dynamic memory allocation backed by the operating system.

Be sure to check the FreeRTOS documentation.

Modules§

hooks
scheduler
task
Utilities for working with FreeRTOS tasks.

Structs§

AsyncQueueReceiver
An asynchronous queue receiver. Can be used to receive data from an AsyncQueueSender. Use channel to create.
AsyncQueueSender
An asynchronous queue sender. Can be used to send data to an AsyncQueueReceiver. Use channel to create.
AsyncToBlockingQueueTaskBuilder
Builder for a task that can receive items from an asynchronous queue and send them to a blocking Queue.
BlockingToAsyncQueueTaskBuilder
Builder for a task that can receive items from a blocking Queue and send them to an asynchronous queue.
CurrentTask
Helper methods to be performed on the task that is currently executing.
Duration
A FreeRTOS duration, internally represented as ticks.
FreeRtosAllocator
Use with:
InterruptContext
Keep track of whether we need to yield the execution to a different task at the end of the interrupt.
Queue
A blocking queue with a finite size. For an asynchronous queue, see AsyncQueueSender and AsyncQueueReceiver.
Task
Handle for a FreeRTOS task
TaskBuilder
Helper for spawning a new task. Instantiate with Task::new().
TaskPriority
Task’s execution priority. Low priority numbers denote low priority tasks.
Timer
A FreeRTOS software timer.
TimerHandle
Wraps the reference to a FreeRTOS’s timer handle, exposing an API to safely communicate with FreeRTOS and perform actions over the corresponding Timer.

Enums§

FreeRtosError
Basic error type for the library.
TaskNotification
Notification to be sent to a task.

Functions§

block_on_future
Runs a future to completion on the current task and returns its output value.
channel
Creates a AsyncQueueSender AsyncQueueReceiver pair.
vPortGetHeapStats
Wraps __vPortGetHeapStats in a safe function.

Type Aliases§

BaseType_t
QueueHandle_t
TaskHandle_t
TickType_t
TimerHandle_t
UBaseType_t
eNotifyAction