User Guide

User Guide

This guide is for application developers who want to write real-time Rust applications using an existing RTICX distribution.

What is RTICX?

RTICX is a Rust framework for building event-driven, real-time embedded applications. It uses a set of attributes (#[rticx-distro::app], #[task], #[shared], etc.) to generate code that implements the Stack Resource Policy (SRP) for safe resource sharing between tasks and interrupts.

Core concepts

• Tasks — units of work that can be triggered by interrupts or by other tasks.
• Shared resources — data protected by the SRP ceiling protocol.
• Priorities — RTICX assigns ceilings based on task priorities so that higher-priority tasks can preempt safely.
• Init — the startup task that runs once and returns the initial shared resources together with the TaskInits struct holding every task.
• Idle — the loop that runs when no task is active.
• Multicore — RTICX supports single-binary multicore (e.g. dual-core RP2040). Tasks are assigned to cores via core = N and communicate through cross-core task spawning. See the Multicore section in the Syntax Reference and the Architecture page for the underlying design.

Next steps

• Getting Started — build your first RTICX application.
• Syntax Reference — learn the RTICX attributes supported by the core and software-task passes.
• Supported Distributions — pick the right distribution for your target hardware.