Skip to main content

wordval_iot/
lib.rs

1//! # wordval-iot —— Wordval 物联网大数据平台扩展
2//!
3//! 在 [`wordval`](https://docs.rs/wordval) 之上,以**插件**形式补齐框架原生
4//! 不具备的物联网多协议采集能力,覆盖"数据采集 → 传输 → 归一化 → 存储 → 查询"
5//! 全链路,对接 MQTT / TCP / Modbus / HTTP 等异构设备。
6//!
7//! ## 与 wordval 的关系
8//!
9//! 每个采集器都实现 wordval 的 [`wordval_core::Plugin`] trait,因此可直接注册进
10//! 应用生命周期,随框架统一启动 / 优雅停机:
11//!
12//! ```ignore
13//! use wordval::prelude::*;
14//! use wordval_iot::prelude::*;
15//! use std::sync::Arc;
16//!
17//! #[tokio::main]
18//! async fn main() -> wordval::Result<()> {
19//!     let store = MemStore::new(10_000);
20//!     let pipeline = Pipeline::new(vec![Arc::new(store.clone()), Arc::new(LoggingSink)]);
21//!     let codec: SharedCodec = Arc::new(JsonCodec);
22//!
23//!     // MQTT 插件的管道在构造后延迟注入(set_pipeline 须在插件启动前调用)
24//!     let mqtt = MqttBrokerPlugin::new(MqttConfig::default(), codec.clone());
25//!     mqtt.set_pipeline(pipeline.clone());
26//!
27//!     App::from_config()?
28//!         .plugin(mqtt)
29//!         .plugin(TcpCollectorPlugin::new(TcpConfig::default(), codec.clone(), pipeline.clone()))
30//!         .plugin(ModbusMasterPlugin::new(ModbusConfig::default(), pipeline.clone()))
31//!         .get("/api/iot/devices", move || {
32//!             let s = store.clone();
33//!             async move { Res::ok(s.devices()) }
34//!         })
35//!         .serve("8080")
36//!         .await
37//! }
38//! ```
39//!
40//! ## 架构分层
41//!
42//! - [`types`]:统一数据模型 [`DeviceMessage`](数据接入规范落地)
43//! - [`codec`]:报文编解码(JSON / CSV 行 / 自定义)
44//! - [`pipeline`]:采集与消费解耦的数据管道 + [`DataSink`]
45//! - [`rule`]:类 SQL 规则引擎(`sqlparser` 解析 + 自定义求值),命中触发告警/转发
46//! - [`thing`]:物模型 TSL(属性/事件/服务定义 + 类型/范围校验)+ [`DeviceRegistry`]
47//! - [`shadow`]:设备影子(上报态/期望态 + 在线/离线状态)
48//! - [`command`]:下行指令(平台→设备),[`CommandRouter`] 按协议选路下发
49//! - [`ota`]:OTA 固件仓库 + 灰度升级任务 + 进度回报(复用下行通道与采集管道)
50//! - [`store`]:演示级内存时序存储(可替换为 ClickHouse/TDengine 等)
51//! - [`tcp`] / [`mqtt`] / [`modbus`] / [`coap`]:四大协议采集插件
52//! - [`sink_queue`]:队列转发 sink,对接 Kafka/NATS/Flink 等大数据下游
53//! - [`config`]:与 wordval 风格一致的 TOML 配置
54
55pub mod coap;
56pub mod codec;
57pub mod command;
58pub mod config;
59pub mod modbus;
60pub mod mqtt;
61pub mod ota;
62pub mod pipeline;
63pub mod rule;
64pub mod shadow;
65pub mod sink_queue;
66pub mod store;
67pub mod tcp;
68pub mod thing;
69pub mod types;
70
71pub use coap::CoapCollectorPlugin;
72pub use codec::{Codec, CodecError, JsonCodec, LineCodec, SharedCodec};
73pub use command::{Command, CommandError, CommandRouter, Downlink};
74pub use config::{
75    CoapConfig, DeviceBinding, IotConfig, ModbusConfig, ModbusFunction, ModbusPoll, MqttConfig,
76    RuleConfig, TcpConfig,
77};
78pub use modbus::{ModbusMasterPlugin, ModbusSlaveSim};
79pub use mqtt::{AuthIdentity, MqttAuth, MqttBrokerPlugin, MqttDownlink};
80pub use ota::{
81    DeviceProgress, Firmware, FirmwareRepo, OtaError, OtaManager, OtaState, OtaStorage,
82    OtaTaskSnapshot,
83};
84pub use pipeline::{DataSink, FnSink, LoggingSink, Pipeline};
85pub use rule::{ForwardAction, LogAlertAction, Rule, RuleAction, RuleEngine};
86pub use shadow::{ShadowSnapshot, ShadowStore};
87pub use sink_queue::{BusSink, TopicStrategy};
88pub use store::{DataPoint, MemStore};
89pub use tcp::TcpCollectorPlugin;
90pub use thing::{
91    DataType, DeviceRegistry, EventSpec, PropertySpec, ServiceSpec, ThingModel, Validation,
92};
93pub use types::{DeviceMessage, MetricValue, Protocol};
94
95/// 常用导出集合
96pub mod prelude {
97    pub use crate::coap::CoapCollectorPlugin;
98    pub use crate::codec::{Codec, JsonCodec, LineCodec, SharedCodec};
99    pub use crate::command::{Command, CommandError, CommandRouter, Downlink};
100    pub use crate::config::{
101        CoapConfig, DeviceBinding, IotConfig, ModbusConfig, ModbusPoll, MqttConfig, RuleConfig,
102        TcpConfig,
103    };
104    pub use crate::modbus::{ModbusMasterPlugin, ModbusSlaveSim};
105    pub use crate::mqtt::{AuthIdentity, MqttAuth, MqttBrokerPlugin, MqttDownlink};
106    pub use crate::ota::{
107        DeviceProgress, Firmware, FirmwareRepo, OtaError, OtaManager, OtaState, OtaStorage,
108        OtaTaskSnapshot,
109    };
110    pub use crate::pipeline::{DataSink, FnSink, LoggingSink, Pipeline};
111    pub use crate::rule::{ForwardAction, LogAlertAction, Rule, RuleAction, RuleEngine};
112    pub use crate::shadow::{ShadowSnapshot, ShadowStore};
113    pub use crate::sink_queue::{BusSink, TopicStrategy};
114    pub use crate::store::{DataPoint, MemStore};
115    pub use crate::tcp::TcpCollectorPlugin;
116    pub use crate::thing::{
117        DataType, DeviceRegistry, EventSpec, PropertySpec, ServiceSpec, ThingModel, Validation,
118    };
119    pub use crate::types::{DeviceMessage, MetricValue, Protocol};
120}