Skip to main content

Crate wordval_iot

Crate wordval_iot 

Source
Expand description

§wordval-iot —— Wordval 物联网大数据平台扩展

在 wordval 之上,以插件形式补齐框架原生 不具备的物联网多协议采集能力,覆盖“数据采集 → 传输 → 归一化 → 存储 → 查询“ 全链路,对接 MQTT / TCP / Modbus / HTTP 等异构设备。

§与 wordval 的关系

每个采集器都实现 wordval 的 wordval_core::Plugin trait,因此可直接注册进 应用生命周期,随框架统一启动 / 优雅停机:

ⓘ
use wordval::prelude::*;
use wordval_iot::prelude::*;
use std::sync::Arc;

#[tokio::main]
async fn main() -> wordval::Result<()> {
    let store = MemStore::new(10_000);
    let pipeline = Pipeline::new(vec![Arc::new(store.clone()), Arc::new(LoggingSink)]);
    let codec: SharedCodec = Arc::new(JsonCodec);

    // MQTT 插件的管道在构造后延迟注入(set_pipeline 须在插件启动前调用)
    let mqtt = MqttBrokerPlugin::new(MqttConfig::default(), codec.clone());
    mqtt.set_pipeline(pipeline.clone());

    App::from_config()?
        .plugin(mqtt)
        .plugin(TcpCollectorPlugin::new(TcpConfig::default(), codec.clone(), pipeline.clone()))
        .plugin(ModbusMasterPlugin::new(ModbusConfig::default(), pipeline.clone()))
        .get("/api/iot/devices", move || {
            let s = store.clone();
            async move { Res::ok(s.devices()) }
        })
        .serve("8080")
        .await
}

§架构分层

  • types:统一数据模型 DeviceMessage(数据接入规范落地)
  • codec:报文编解码(JSON / CSV 行 / 自定义)
  • pipeline:采集与消费解耦的数据管道 + DataSink
  • rule:类 SQL 规则引擎(sqlparser 解析 + 自定义求值),命中触发告警/转发
  • thing:物模型 TSL(属性/事件/服务定义 + 类型/范围校验)+ DeviceRegistry
  • shadow:设备影子(上报态/期望态 + 在线/离线状态)
  • command:下行指令(平台→设备),CommandRouter 按协议选路下发
  • ota:OTA 固件仓库 + 灰度升级任务 + 进度回报(复用下行通道与采集管道)
  • store:演示级内存时序存储(可替换为 ClickHouse/TDengine 等)
  • tcp / mqtt / modbus / coap:四大协议采集插件
  • sink_queue:队列转发 sink,对接 Kafka/NATS/Flink 等大数据下游
  • config:与 wordval 风格一致的 TOML 配置

Re-exports§

pub use coap::CoapCollectorPlugin;
pub use codec::Codec;
pub use codec::CodecError;
pub use codec::JsonCodec;
pub use codec::LineCodec;
pub use codec::SharedCodec;
pub use command::Command;
pub use command::CommandError;
pub use command::CommandRouter;
pub use config::CoapConfig;
pub use config::DeviceBinding;
pub use config::IotConfig;
pub use config::ModbusConfig;
pub use config::ModbusFunction;
pub use config::ModbusPoll;
pub use config::MqttConfig;
pub use config::RuleConfig;
pub use config::TcpConfig;
pub use modbus::ModbusMasterPlugin;
pub use modbus::ModbusSlaveSim;
pub use mqtt::AuthIdentity;
pub use mqtt::MqttAuth;
pub use mqtt::MqttBrokerPlugin;
pub use ota::DeviceProgress;
pub use ota::Firmware;
pub use ota::FirmwareRepo;
pub use ota::OtaError;
pub use ota::OtaManager;
pub use ota::OtaState;
pub use ota::OtaStorage;
pub use ota::OtaTaskSnapshot;
pub use pipeline::DataSink;
pub use pipeline::FnSink;
pub use pipeline::LoggingSink;
pub use pipeline::Pipeline;
pub use rule::ForwardAction;
pub use rule::LogAlertAction;
pub use rule::Rule;
pub use rule::RuleAction;
pub use rule::RuleEngine;
pub use shadow::ShadowSnapshot;
pub use shadow::ShadowStore;
pub use sink_queue::BusSink;
pub use sink_queue::TopicStrategy;
pub use store::DataPoint;
pub use store::MemStore;
pub use tcp::TcpCollectorPlugin;
pub use thing::DataType;
pub use thing::DeviceRegistry;
pub use thing::EventSpec;
pub use thing::PropertySpec;
pub use thing::ServiceSpec;
pub use thing::ThingModel;
pub use thing::Validation;
pub use types::DeviceMessage;
pub use types::MetricValue;
pub use types::Protocol;

Modules§

coap
CoAP over UDP 采集插件 —— 基于成熟库 coap-lite 的报文编解码
codec
报文编解码 —— 将各协议的原始 payload 归一化为 DeviceMessage
command
下行指令 (Command) —— 平台 → 设备方向
config
IoT 采集配置 —— 可从 wordval 的 TOML 配置或代码直接构造
modbus
Modbus TCP 主站插件 —— 基于成熟库 tokio-modbus
mqtt
MQTT broker 采集插件 —— 报文编解码基于成熟库 mqttbytes
ota
OTA 固件升级 —— 平台侧的固件仓库、灰度任务与进度回报
pipeline
数据管道 —— 采集与消费解耦的核心
prelude
常用导出集合
rule
类 SQL 规则引擎 —— 在归一化遥测流上做「过滤 → 判断 → 触发动作」
shadow
设备影子与在线状态 —— 设备管理的核心
sink_queue
总线转发 sink —— 把归一化遥测发布到 wordval-bus 事件总线(本地 / NATS)
store
内存时序存储 —— 演示级 TSDB,可作为 DataSink 直接挂到管道
tcp
原始 TCP 采集插件 —— 面向裸 TCP 长连接设备
thing
物模型 TSL (Thing Model) —— 设备的语义契约
types
IoT 统一数据模型 —— 全链路的“数据接入规范“落地