pnoker
9aa6a425d8
- Replace slogan with capability-oriented messaging across en/zh/ja/vi - Add design principles section (Facade, DO/BO/VO, tenant isolation) - Add contributors badge - Fix Japanese blockquote rendering breakage
14 KiB
English | 中文 | 日本語 | Tiếng Việt
AI assistants: Read README.ai.md first for a concise, AI-friendly overview of IoT DC3.
IoT DC3 — 让大模型直接操控设备的开源工业物联网平台
Spring AI 原生集成 · 自然语言运维 · 28 个开箱即用驱动
🔌 多协议接入 · 🤖 AI Agentic 中心 · ☁️ 云原生微服务
📸 产品预览
| 📸 平台概览 | 📸 设备管理 | 📸 AI 智能对话 |
|---|---|---|
平台首页 / 仪表盘 系统概览 · 设备在线统计 · 数据趋势图表 |
设备管理页面 设备列表 · 在线状态指示 · 搜索筛选 |
AI 智能对话页面 自然语言操控设备 · 数据查询 · 智能分析 |
✨ 核心特性
🔌 多协议设备接入
内置 28 个接入驱动模块，覆盖工业自动化、物联网通信、数据桥接、基础通信与仿真调试场景，降低常见设备与数据源的接入成本：
| 分类 | 驱动模块 |
|---|---|
| 🏭 工业协议 | Modbus TCP · Modbus RTU · OPC UA · OPC DA · Siemens S7 · BACnet/IP · EtherNet/IP · Omron FINS · Mitsubishi MELSEC · IEC 60870-5-104 · SL651 · DLMS |
| 📡 物联网协议 | MQTT · CoAP · LwM2M · HTTP · BLE · Zigbee |
| 🗄️ 数据桥接 | MySQL · PostgreSQL · Oracle · SQL Server |
| 🔧 基础通信与管理 | TCP/UDP · Serial · SNMP · CAN |
| 🧪 仿真与调试 | Virtual · Listening Virtual |
提供完整的 Driver SDK，支持快速开发自定义协议驱动，热插拔注册到运行平台。
🤖 AI 能力集成
基于 Spring AI 构建的智能体中心，将大语言模型接入 IoT 运营流程：
- 自然语言操控设备 — LLM 通过 Tool-Calling 机制直接查询设备、读写数据点、执行命令
- 智能告警分析 — AI 辅助分析告警原因，提供处置建议
- 数据洞察 — 自然语言查询设备数据，自动生成可视化图表
- 多模型支持 — 兼容 OpenAI API 标准，可接入 GPT、Claude、DeepSeek、通义千问等主流模型
- 对话记忆 — 支持多轮对话与上下文记忆，持久化到数据库
🏗️ 云原生微服务
基于 Spring Boot 4 + Spring Cloud 2025 构建的分布式微服务架构：
- 服务治理 — Spring Cloud Gateway 统一入口，静态路由 + 环境变量灵活配置
- 高效通信 — gRPC 服务间调用，Protobuf 序列化
- 横向扩展 — 无状态设计，支持按业务负载独立扩缩容
- 容错韧性 — 可替换服务节点，故障自动隔离
📊 实时数据引擎
- 数据采集 — 驱动层实时采集设备遥测数据，通过 RabbitMQ 异步传输
- 时序存储 — 支持实时与历史数据的高效查询
- 规则引擎 — 灵活的告警规则配置，支持多级告警与通知
- 事件溯源 — 完整的命令与事件历史记录
🔐 企业级安全与多租户
- 租户隔离 — 数据库、缓存、API 全链路租户级隔离
- 认证授权 — JWT + Spring Security，支持 RBAC 权限模型
- 传输加密 — 支持 TLS/SSL 加密通信
- 审计追踪 — 完整的用户操作与系统事件日志
🧩 开发者友好
- Driver SDK — 完善的驱动开发工具包，参考 驱动开发指南
- 前后端分离 — Vue 3 + TypeScript 前端，RESTful + gRPC 双协议 API
- 容器化部署 — Podman / Docker Compose 一键启动，便于迁移到 Kubernetes 等容器平台
- 完整文档 — 在线文档站 + 快速开始指南 + 故障排查手册
⚡ 快速开始
前置条件
| 依赖 | 版本要求 |
|---|---|
| Java (JDK) | 21+ |
| Maven | 3.9+ |
| Podman 或 Docker | 最新稳定版 |
三步启动
① 克隆项目
git clone https://github.com/pnoker/iot-dc3.git
cd iot-dc3
② 启动基础依赖（PostgreSQL + RabbitMQ）
# 全球镜像
make up-db
# 中国大陆用户（阿里云镜像）
make up-db-cn
③ 加载本地环境变量，构建并启动
source dc3/env/dev.env.sh
mvn -s .mvn/settings.xml clean package
dc3/env/dev.env.sh 会把本地 Java 进程连接到 localhost 上已发布的 PostgreSQL、RabbitMQ 和 gRPC 端口。
后续 java -jar 命令请在同一个终端会话中执行。
按顺序启动服务：
java -jar dc3-gateway/target/dc3-gateway.jar # API 网关
java -jar dc3-center/dc3-center-auth/target/dc3-center-auth.jar # 认证中心
java -jar dc3-center/dc3-center-manager/target/dc3-center-manager.jar # 管理中心
java -jar dc3-center/dc3-center-data/target/dc3-center-data.jar # 数据中心
java -jar dc3-center/dc3-center-agentic/target/dc3-center-agentic.jar # AI 智能体中心
java -jar dc3-driver/dc3-driver-virtual/target/dc3-driver-virtual.jar # 虚拟驱动（演示用）
🔧 更多启动选项（可选依赖、单服务启动、环境变量配置）
启动可选基础设施（EMQX、ELK/APM、Prometheus、Grafana 等）：
make up-optional-cn # 启动可选依赖
make up-db-cn && make up-optional-cn && make up-dev-cn # 启动全部依赖
按需启动单个服务（适用于前端/接口测试）：
make up SERVICES=agentic REGISTRY=cn # 单个服务
make up SERVICES="gateway agentic" REGISTRY=cn # 多个服务
make up GROUP=core REGISTRY=cn # 核心服务组
make up GROUP=drivers REGISTRY=cn # 驱动服务组
make logs SERVICES="gateway agentic" # 查看日志
Compose 环境变量覆盖：
cp .env.example .env # 复制模板文件
根目录 .env 用于 Compose 变量插值（镜像仓库、版本、端口等），应用运行时变量在 dc3/env/dev.env 中配置。
详见 环境变量文档。
🏗️ 架构概览
| 层级 | 职责 |
|---|---|
| 驱动层 | SDK 驱动开发，标准/私有协议设备接入，南向数据采集与命令执行 |
| 数据层 | 设备数据采集、存储与查询，支撑实时与历史数据服务 |
| 管理层 | 微服务协作核心：服务注册、设备/驱动管理、命令编排、配置治理 |
| 应用层 | 数据开放、任务调度、告警消息、日志管理、第三方集成、AI 自动化 |
🧱 设计原则 — 跨服务调用统一经 Facade 接口；DO/BO/VO 三层模型严格分离持久化、业务与接口形态；租户隔离贯穿数据库、缓存到 API 全链路。边界清晰，易于规模化扩展与多团队协作。
📖 完整模块依赖关系和运行时流程请参阅 模块与依赖。
🛠️ 技术栈
| 分类 | 技术 |
|---|---|
| 语言与框架 | Java 21 · Spring Boot 4 · Spring Cloud 2025 · Spring AI 2.0 |
| 数据、缓存与调度 | PostgreSQL · Caffeine · MyBatis-Plus · Quartz |
| 消息与通信 | RabbitMQ · gRPC · MQTT (Paho + EMQX) · Protobuf |
| 安全与认证 | Spring Security · JWT · BouncyCastle |
| 可观测性 | Micrometer · Prometheus · Grafana · ELK |
| 前端 | Vue 3 · TypeScript 6 · Vite 8 · Element Plus · AntV G2/G6 |
| 桌面端 | Tauri 2 |
| 部署 | Podman · Docker Compose |
💡 前端源码位于 iot-dc3-web 仓库。
📖 文档与社区
| 资源 | 链接 |
|---|---|
| 📚 在线文档 | pnoker.github.io/iot-dc3 |
| 🚀 快速开始 | 快速开始指南 |
| 🏗️ 架构说明 | 模块与依赖 |
| 🔧 驱动开发 | 驱动开发指南 |
| 🐛 故障排查 | 常见问题与解决方案 |
| 📋 变更日志 | 版本更新记录 |
| 🐛 问题反馈 | GitHub Issues |
| 🇨🇳 码云镜像 | Gitee GVP 最有价值开源项目 |
🌍 应用场景
| 🏭 | 智慧工厂 | 产线设备状态监控、工艺参数采集、预测性维护、OEE 分析 |
| ⚡ | 能源监测 | 电力 / 水务 / 燃气远程抄表、能耗趋势分析、异常告警 |
| 🌾 | 智慧农业 | 温室环境监测、自动灌溉控制、病虫害预警、产量预测 |
| 🏙️ | 智慧城市 | 路灯照明管理、环境质量监测、市政设施运维、安全监控 |
🤝 参与贡献
我们欢迎任何形式的贡献！请遵循以下流程：
- Fork & 分支 — 从
main创建分支，命名格式：feature/your_name/feature_description（例：feature/pnoker/mqtt_driver） - 开发 & 提交 — 在新分支上完成修改并提交，遵循 Conventional Commits 规范
- 发起 PR — 提交 Pull Request 到
develop分支，维护者会审核并合并
📄 开源协议
IoT DC3 基于 AGPL 3.0 协议开源。
- ✅ 个人学习、研究、内部使用 — 完全免费
- ✅ 修改代码并开源你的修改 — 欢迎
- ⚠️ 作为商业服务提供给第三方且未开源修改 — 需要商业授权
商业授权详情请参阅 LICENSE.txt。