文档中心
从上手到精通的全套资料，点击卡片进入对应章节。
🚀 快速上手
| 文档 | 说明 | 适合 |
|---|---|---|
| 快速开始 | 10 分钟从零到第一台设备上线 | 首次接触 |
| Docker 部署 | docker compose / Kubernetes 集群部署 | 运维、生产 |
📡 设备接入
5 种协议任你选，覆盖从资源极受限到企业级网关的全部场景：
| 协议 | 端口 | 特点 | 文档 |
|---|---|---|---|
| MQTT | 1884 | 主协议，EMQX Broker，最通用 | MQTT 接入 |
| CoAP | 5683 | 低功耗 UDP，自研 RFC 7252 精简子集 | CoAP 接入 |
| HTTP Digest | 8080 | 标准 HTTP 设备，RFC 7616 | HTTP Digest |
| Modbus | 502 | 工业现场总线，TCP/RTU 轮询 | Modbus 接入 |
| TCP/UDP | 11000/11001 | 自研二进制帧，极低开销 | TCP/UDP 协议 |
⚙️ 平台功能
| 文档 | 说明 |
|---|---|
| 规则引擎 | LiteFlow 块式编排：触发源 / 条件 / 动作，无需代码实现设备联动 |
| 告警与通知 | 四级告警生命周期管理，钉钉 / 企微 / 短信 / 邮件四通道触达 |
| 多租户管理 | 主库 + tenant_* 动态库物理隔离，RBAC 权限模型 |
| 视频监控 | PE 版 ZLMediaKit：RTMP / RTSP / GB28181 接入，Web 低延迟播放 |
| OTA 固件升级 | 固件版本管理、批次推送、进度跟踪与失败重试 |
| SaaS 部署与计费 | EE 版套餐订阅，Stripe / 微信支付双通道计费与回调 |
🔧 开发参考
| 文档 | 说明 |
|---|---|
| API 参考 | 全部 REST 接口：认证、设备、产品、物模型、规则、告警、计费，含 curl 示例 |
| 架构设计 | 模块分层、技术栈、多租户、数据流、AGPLv3 隔离策略 |
| 常见问题 | 高频问题排查手册：启动、设备接入、前端、部署、开发 6 大类 18 条 |
🛠️ 开发环境配置
| 工具 | 版本 | 下载 |
|---|---|---|
| JDK | 21 LTS | Adoptium |
| Maven | 3.9+ | Apache Maven |
| Docker Desktop | 最新 | Docker |
| Node.js | 18+ | Node.js |
详细配置步骤见 快速开始。
📦 快速导航
mermaid
graph LR
A[开始] --> B[环境准备]
B --> C[部署依赖]
C --> D[启动后端]
D --> E[创建产品]
E --> F[注册设备]
F --> G[设备接入]
G --> H[数据查看]
H --> I[规则/告警]| 步骤 | 文档 |
|---|---|
| 1. 环境准备 | 快速开始 |
| 2. 部署依赖 | Docker Compose |
| 3. 启动后端 | 快速开始 · 四 |
| 4. 创建产品/设备 | 快速开始 · 五 |
| 5. 设备接入 | 按设备协议选 MQTT / CoAP / HTTP / Modbus / TCP |
| 6. 数据查看 | 快速开始 · 七 |
| 7. 规则/告警 | API · 规则引擎 |