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§
Structs§
- Async
Queue Receiver - An asynchronous queue receiver. Can be used to receive data from an
AsyncQueueSender. Usechannelto create. - Async
Queue Sender - An asynchronous queue sender. Can be used to send data to an
AsyncQueueReceiver. Usechannelto create. - Async
ToBlocking Queue Task Builder - Builder for a task that can receive items from an asynchronous queue and send them to a
blocking
Queue. - Blocking
ToAsync Queue Task Builder - Builder for a task that can receive items from a blocking
Queueand send them to an asynchronous queue. - Current
Task - Helper methods to be performed on the task that is currently executing.
- Duration
- A FreeRTOS duration, internally represented as ticks.
- Free
Rtos Allocator - Use with:
- Interrupt
Context - 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
AsyncQueueSenderandAsyncQueueReceiver. - Task
- Handle for a FreeRTOS task
- Task
Builder - Helper for spawning a new task. Instantiate with
Task::new(). - Task
Priority - Task’s execution priority. Low priority numbers denote low priority tasks.
- Timer
- A FreeRTOS software timer.
- Timer
Handle - 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§
- Free
Rtos Error - Basic error type for the library.
- Task
Notification - 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
AsyncQueueSenderAsyncQueueReceiverpair. - vPort
GetHeap Stats - Wraps
__vPortGetHeapStatsin a safe function.