rsiot/components/cmp_inject_periodic/mod.rs
1//! Компонент для периодического создания сообщений.
2//!
3//! # Структура
4//!
5#![doc = include_str!("doc/diagram.svg")]
6//!
7//! Компонент состоит из одной задачи InjectPeriodic. С периодом [Config::period] на основе функции
8//! [Config::fn_periodic] формируются исходящие сообщения и передаются в шину MsgBus.
9//!
10//! # Конфигурация
11//!
12//! Конфигурация задаётся структурой [Config].
13//!
14//! # Примеры
15//!
16//! ## Пример 1
17//!
18//! Счётчик увеличивается каждые 100 миллисекунд и отправляется в шину MsgBus.
19//!
20//! Содержимое файла `config_inject_periodic/mod.rs`:
21//!
22//! ```rust
23#![doc = include_str!("../../../examples/cmp_inject_periodic/config_inject_periodic.rs")]
24//! ```
25
26mod component;
27mod config;
28mod error;
29mod fn_process;
30
31pub use {
32 component::{COMPONENT_NAME, Cmp},
33 config::Config,
34 error::Error,
35};