iot-dc3

<p align="right"> <a href="./README.md">English</a> | <a href="./README.zh.md">中文</a> | <a href="./README.ja.md">日本語</a> | <a href="./README.vi.md">Tiếng Việt</a> | <a href="./README.ko.md">한국어</a> | <a href="./README.es.md">Español</a> | <a href="./README.ru.md">Русский</a> </p>

AI assistants: Read README.ai.md first for a concise, AI-friendly overview of IoT DC3.

<p align="center"> <img src="./.github/brand/png/banner.en.png" alt="IoT DC3 — 多协议接入、云原生、AI 赋能的开源工业物联网平台，面向智能体演进"> </p> <p align="center"> <a href="https://github.com/pnoker/iot-dc3/stargazers"> <img src="https://img.shields.io/github/stars/pnoker/iot-dc3?style=flat&logo=github&color=green" alt="GitHub Stars"> </a> <a href="https://gitee.com/pnoker/iot-dc3/stargazers"> <img src="https://gitee.com/pnoker/iot-dc3/badge/star.svg?theme=gvp" alt="Gitee Star"> </a> <a href="https://gitee.com/pnoker/iot-dc3/members"> <img src="https://gitee.com/pnoker/iot-dc3/badge/fork.svg?theme=gvp" alt="Gitee Fork"> </a> <a href="https://github.com/pnoker/iot-dc3/graphs/contributors"> <img src="https://img.shields.io/github/contributors/pnoker/iot-dc3?label=contributors&color=orange" alt="Contributors"> </a> <img src="https://img.shields.io/badge/License-AGPL%203.0-blue" alt="License"> <img src="https://img.shields.io/badge/Java-21-orange?logo=openjdk" alt="Java 21"> <img src="https://img.shields.io/badge/Spring%20Boot-4.0-6DB33F?logo=springboot" alt="Spring Boot 4"> </p> <p align="center"> <strong> IoT DC3 — the multi-protocol, cloud-native, open-source industrial IoT platform.<br> AI-powered — from device connectivity to industrial agents </strong> </p> <p align="center"> <a href="https://dc3.site">https://dc3.site</a> </p> <p align="center"> 🔌 <strong>Multi-protocol connectivity</strong> &nbsp;·&nbsp; 🤖 <strong>AI Agentic Center</strong> &nbsp;·&nbsp; ☁️ <strong>Cloud-native microservices</strong> </p>

---

📸 Product Preview

<table> <tr> <th width="33%">📸 Platform Overview</th> <th width="33%">📸 Device Management</th> <th width="33%">📸 AI Chat</th> </tr> <tr> <td align="center"> <img src="https://docs.dc3.site/images/screenshot-overview.png" alt="Platform dashboard" width="100%"> <br> <strong>Home / Dashboard</strong><br> <em>System overview · Online device metrics · Data trend charts</em> </td> <td align="center"> <img src="https://docs.dc3.site/images/screenshot-device.png" alt="Device management page" width="100%"> <br> <strong>Device Management</strong><br> <em>Device list · Online status · Search and filtering</em> </td> <td align="center"> <img src="https://docs.dc3.site/images/screenshot-ai.png" alt="AI chat page" width="100%"> <br> <strong>AI Chat</strong><br> <em>Natural-language device queries · Data analysis · Intelligent assistance</em> </td> </tr> </table>

🏗️ Architecture Overview

Architecture at a Glance

Six-layer microservice architecture at a glance: clients → gateway → four center services → message bus → 36 protocol drivers → field devices. PostgreSQL (TimescaleDB + pgvector + AGE) persistence and optional observability stack (ELK + Prometheus + Grafana) laid out in one view.

🧱 Design principles — cross-service calls always go through Facade interfaces; the DO/BO/VO three-tier model keeps persistence, business, and API shapes strictly separated; and tenant isolation runs end to end across database, cache, and API paths. Clear boundaries that scale across services and teams.

📖 For the full architecture documentation, see System Architecture Overview.

✨ Core Features

🔌 Multi-Protocol Device Connectivity

IoT DC3 includes 36 access driver modules for industrial automation, IoT communication, data bridging, basic communication, and simulation/debugging scenarios, reducing the cost of connecting common devices and data sources:

The Driver SDK supports fast development of custom protocol drivers and registration into the runtime platform.

🤖 AI Capability Integration

The agentic center is built on Spring AI and connects large language models into IoT operations workflows:

• Natural-language assisted operations - through Tool Calling and under access control, LLMs can query devices, read/write points, and assist with command execution
• Intelligent alarm analysis - AI assists with root-cause analysis and response suggestions
• Data insights - Query device data in natural language and generate visual charts
• Multi-model support - Compatible with OpenAI API-style providers and mainstream models such as GPT, Claude, DeepSeek, and Qwen
• Conversation memory - Multi-turn conversations and context memory persisted to the database

🏗️ Cloud-Native Microservices

Distributed microservice architecture based on Spring Boot 4 + Spring Cloud 2025:

• Service governance - Spring Cloud Gateway as the unified entrypoint, with static routes and flexible environment variables
• Efficient communication - gRPC service calls with Protobuf serialization
• Horizontal scaling - Stateless design for scaling individual services by workload
• Resilience - Replaceable service nodes and fault isolation

📊 Real-Time Data Engine

• Data collection - Drivers collect device telemetry and send it asynchronously through the internal message broker — pluggable per deployment: RabbitMQ (default), Kafka, Pulsar or any MQTT 5 broker (broker guide)
• Time-series storage - Efficient queries for real-time and historical data
• Rule engine - Flexible alarm rules with multi-level alarms and notifications
• Event traceability - Full command and event history

🔐 Enterprise Security and Multi-Tenancy

• Tenant isolation - Tenant-level isolation across database, cache, and API paths
• Authentication and authorization - JWT + Spring Security with RBAC
• Transport encryption - TLS/SSL communication support
• Audit tracking - User operation and system event logs

🧩 Developer Friendly

• Driver SDK - A complete driver development toolkit. See the Driver Authoring Guide
• Separated frontend and backend - Vue 3 + TypeScript frontend, RESTful and gRPC APIs
• Containerized deployment - One-command startup with Podman / Docker Compose, plus compose scaling, Docker Swarm, Kubernetes and Helm deployment configs. See the Deployment Guide.
• Complete documentation - Online docs, quickstart guide, and troubleshooting guide

⚡ Quick Start

For source-based local development, start PostgreSQL and RabbitMQ, load local environment variables, then build:

make up-db
source dc3/env/dev.env.sh
mvn -s .mvn/settings.xml clean package

Use make up-db-cn if you prefer the Alibaba Cloud registry in Mainland China.

📖 For service startup order, IDE setup, verification commands, and common pitfalls, see the full Quickstart.

🛠️ Technology Stack

IoT DC3 is built on Java 21, Spring Boot 4, Spring Cloud 2025, Spring AI 2, PostgreSQL, a pluggable message broker (RabbitMQ, Kafka, Pulsar or MQTT 5 — selection guide), gRPC, Vue 3, TypeScript, and Vite.

See Technology Stack for component details and where each technology is used.

📖 Documentation and Community

🌍 Use Cases

<table> <tr> <td align="center" width="60">🏭</td> <td><strong>Smart Factory</strong></td> <td>Production-line device monitoring, process parameter collection, predictive maintenance, and OEE analysis</td> </tr> <tr> <td align="center">⚡</td> <td><strong>Energy Monitoring</strong></td> <td>Remote metering for power, water, and gas; energy trend analysis; anomaly alarms</td> </tr> <tr> <td align="center">🌾</td> <td><strong>Smart Agriculture</strong></td> <td>Greenhouse monitoring, automatic irrigation control, pest and disease warnings, yield forecasting</td> </tr> <tr> <td align="center">🏙️</td> <td><strong>Smart City</strong></td> <td>Streetlight management, environmental monitoring, municipal facility operations, safety monitoring</td> </tr> </table>

🤝 Contributing

Contributions of all kinds are welcome. Please follow this workflow:

1. Fork and branch - Create a branch from main, using the format feature/your_name/feature_description (for example: feature/pnoker/mqtt_driver)
2. Develop and commit - Complete your changes on the new branch and follow the Conventional Commits specification
3. Open a PR - Submit a Pull Request to the develop branch for maintainer review and merge

📄 License

IoT DC3 is open source under the AGPL 3.0 license.

• ✅ Personal learning, research, and internal use - Free
• ✅ Modify the code and open source your changes - Welcome
• ⚠️ Offering it as a commercial service to third parties without open-sourcing modifications - Requires a commercial license

For commercial licensing details, see LICENSE.txt.