mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-26 13:39:41 +01:00
26 lines
989 B
Markdown
26 lines
989 B
Markdown
# The `#[app]` attribute and an RTIC application
|
|
|
|
## Requirements on the `app` attribute
|
|
|
|
All RTIC applications use the [`app`] attribute (`#[app(..)]`). This attribute
|
|
must be applied to a `mod`-item containing the RTIC application. The `app`
|
|
attribute has a mandatory `device`
|
|
argument that takes a *path* as a value. This must be a full path pointing to a
|
|
*peripheral access crate* (PAC) generated using [`svd2rust`] **v0.14.x** or
|
|
newer.
|
|
|
|
The `app` attribute will expand into a suitable entry point so it's not required
|
|
to use the [`cortex_m_rt::entry`] attribute.
|
|
|
|
[`app`]: ../../../api/cortex_m_rtic_macros/attr.app.html
|
|
[`svd2rust`]: https://crates.io/crates/svd2rust
|
|
[`cortex_m_rt::entry`]: ../../../api/cortex_m_rt_macros/attr.entry.html
|
|
|
|
## An RTIC application example
|
|
|
|
To give a flavor of RTIC, the following example contains commonly used features. In the following sections we will go through each feature in detail.
|
|
|
|
``` rust
|
|
{{#include ../../../../examples/common.rs}}
|
|
```
|
|
|