Crate rsiot

Компоненты для построения системы сбора, обработки и визуализации данных

Документация

Обзор

Описание

Компоненты представляют собой асинхронные функции. У всех функций три аргумента:

async fn component<TMessage, TConfig>(
    input: Option<tokio::sync::mpsc::Receiver<TMessage>>,
    output: Option<tokio::sync::mpsc::Sender<TMessage>>,
    config: TConfig,
) -> ()
where
    TMessage: IMessage
{}

Сообщения между компонентами передаются через каналы “many producers to a single consumer” библиотеки tokio.

Входной или выходной потоки могут быть не заданы, поэтому каналы обернуты в Option.

Структура конфигурации типа TConfig у каждого компонента своя.

Компоненты ничего не возвращают (точнее, возвращают тип ()). Если в компоненте возникает ошибка, логику перезапуска необходимо реализовать внутри данной функции. TODO - пересмотреть, возможно стоит возвращать Result при критических ошибках.

Сообщения представляют собой тип enum, например:

use rsiot_messages_core::eav::EavModel;
use rsiot_messages_core::IMessage;
use serde::{Deserialize, Serialize};

[derive(Clone, Debug, Deserialize, Serialize)]
enum Message {
    /// Текущее значение температуры
    Temperature(f64),
    /// Задание уставки
    ChangeSetpoint(f64),
}

impl IMessage for Message {
    fn into_eav(self) -> Vec<EavModel> {
        vec![]
    }}

Трейт IMessage реализует основные методы - см. документацию по крейту rsiot-messages-core

Для упрощения компоненты можно создавать и объединять в цепочку компонентов.

• может генерировать сообщения как на основе входных сообщений
• может генерировать сообщения периодически

Флаги feature:

• env_vars — Конфигурирование через переменные
• executor — Базовые компоненты
• logging — Настройка логгирования сообщений
• single-thread — Работа в однопоточном режиме
• cmp_auth — Компонент аутентификации
• cmp_http_client — Компонент http-клиент
• cmp_http_client_wasm — Компонент http-клиент для платформы WASM
• cmp_http_server — Компонент http-сервер
• cmp_esp — Компоненты для работы с микроконтроллером ESP
• cmp_influxdb — Компонент сохранения в БД InfluxDB
• cmp_leptos — Компонент для создания интерфейсов на базе Leptos
• cmp_modbus_client — Компонент Modbus клиент
• cmp_mqtt_client — Комонент клиента MQTT
• cmp_plc — Компонент ПЛК
• cmp_raspberrypi — Работа с периферией Raspberry Pi
• cmp_redis_client — Компонент клиента Redis
• cmp_slint — Компонент пользовательского интерфейса, реализованного с помощью библиотеки Slint
• cmp_surrealdb — Компонент доступа к БД SurrealDB
• cmp_system_info — Компонент получает системную информацию
• cmp_timescaledb — Компонент сохранения в БД TimescaleDB
• cmp_websocket_client — Компонент websocket клиента
• cmp_websocket_client_wasm — Компонент websocket клиента
• cmp_websocket_server — Компонент websocket сервера
• cmp_webstorage — Хранение и загрузка сообщений используя Web Storage API браузера

Modules

• components
  Компоненты
• components_config 🔒
  Структуры для конфигурации компонентов.
• executor
  Исполнитель - структура для запуска компонентов
• logging
  Настройки логгирования для разных платформ.
• message
  Представление сообщений в системе.