# IoTSharp
[英文](README.md) | [中文](README.zh.md)
[](LICENSE)
[](https://github.com/IoTSharp/IoTSharp/actions/workflows/dotnet-build.yml)
[](https://github.com/IoTSharp/IoTSharp/actions/workflows/docs-deploy.yml)
[](https://github.com/IoTSharp/IoTSharp/actions/workflows/dotnet-publish.yml)
[](https://github.com/IoTSharp/IoTSharp/actions/workflows/pack-nupkg.yml)
[](https://github.com/IoTSharp/IoTSharp/actions/workflows/docker-release.yml)
IoTSharp 是一个面向工业与企业场景的开源 IoT 平台，覆盖设备接入、遥测采集、规则链处理、可视化管理、多租户运营与产品化交付。
## 🚀 项目概览
IoTSharp 将构建生产级 IoT 平台所需的关键能力组合在一起：
- 支持 HTTP、MQTT、CoAP 等协议的设备与网关接入能力。
- 围绕遥测、属性、告警、产品、资产和租户形成统一的数据与管理模型。
- 通过规则链完成数据转换、通知下发、自动化动作和业务处理。
- 支持关系型数据库与时序数据库，以适配不同部署和扩展场景。
- 提供 Docker、Windows 服务、Linux 服务、安装向导与发布包等多种交付方式。
- 路线图已把 AI 工作台、MCP 工具与智能体辅助运维定义为横切能力，覆盖采集、规则与发布三大场景。
当前主应用基于 `.NET 10`，Web 控制台基于 Vue 3，并已全面统一为 IoTSharp 品牌界面。
## 🧱 产品矩阵（云边一体）
IoTSharp 不只是单个平台应用，而是一套覆盖「平台 - 边缘 - 设备」三层加一个 AI 底座的开源产品矩阵：
| 层级 | 项目 | 说明 |
| --- | --- | --- |
| 平台层 | [IoTSharp](https://github.com/IoTSharp/IoTSharp)（本仓库） | 设备接入、遥测、规则链、多租户、EdgeNode 管理与发布运营的平台控制面 |
| 边缘层 | [IoTEdge](https://github.com/IoTSharp/IoTEdge) | 边缘网关运行时：单宿主程序 + 本地管理界面，内置 Modbus、OPC UA 及主流 PLC 采集驱动与脚本转换，对接平台的注册、心跳、能力上报、采集配置下发与任务回执 |
| 设备层 | [IoTEmbedded](https://github.com/IoTSharp/IoTEmbedded) | 嵌入式设备运行时：面向 MCU/RTOS 的固件级运行时，内置 BASIC 脚本引擎、Modbus RTU 与 MQTT 接入，支持脚本双槽存储与失败回滚 |
| AI 底座 | [Tomur](https://github.com/IoTSharp/Tomur) | 本地模型运行时：离线/内网环境下承载平台 AI 能力，支持 GGUF 大模型、语音、图像与 OCR 多模态推理，提供 OpenAI 兼容 API，单文件部署 |
各层均为开源自研，可独立使用，也可以组合为端到端的工业采集与运营方案；离线或内网场景下配合 SonnetDB 与 Tomur 可实现零外部依赖的全功能部署。
## 🧭 快速开始
### 🖥️ 5 分钟 SonnetDB Profile 体验
首次本地试用时，默认从 SonnetDB Profile 开始。该路径只需要 IoTSharp 与 SonnetDB 两个容器，关系库、遥测库、缓存、对象存储和平台事件队列都指向 SonnetDB：
```bash
docker compose -f docker-compose.sonnetdb.yml up -d
```
启动后访问 `http://localhost:2927`，按页面提示完成 Installer 初始化。
该 Profile 使用 `ASPNETCORE_ENVIRONMENT=SonnetDB` 并挂载 `appsettings.SonnetDB.json`。传统 PostgreSQL / TimescaleDB Compose 仍保留用于兼容性和生产拓扑验证，但快速体验默认优先走 SonnetDB。
### 🖥️ 本地运行 IoTSharp
建议先从以下文档入口开始：
- 快速开始：
- 部署指南：
- 产品文档首页：
- 安装方式：
前端本地开发默认端口为：
- 前端：`http://localhost:27915`
### 🤖 使用 OpenClaw 协助搭建 SQLite 体验实例
如果你明确需要 SQLite 体验实例，也可以让 OpenClaw 引导你完成本地 SQLite 版 IoTSharp 的安装。建议直接给它下面这两样内容：
-
- 提示词模板：[`tools/prompts/openclaw-sqlite-instance.txt`](tools/prompts/openclaw-sqlite-instance.txt)
运行手册里已经定义了 SQLite 引导流程、安装向导初始化路径、Docker Desktop 扩展的回退方案，以及后续通过 `appsettings.{Environment}.Installer.json` 安全切换数据库的规则。
## 🧩 支持的组件
| 领域 | 概览 |
| --- | --- |
| 接入能力 | 面向工业场景的设备接入、网关接入与协议扩展能力 |
| 平台模型 | 遥测、属性、告警、产品、资产、租户与用户等核心模型 |
| 数据基础 | 关系型存储、时序存储，以及安装阶段可选的配置模板体系 |
| 集成处理 | 规则链、脚本、通知、事件传递与自动化动作 |
| 交付方式 | Docker、系统服务、安装向导与 Docker Desktop 扩展等形态 |
如果你需要更细的数据库矩阵、时序引擎、消息中间件支持和配置示例，请直接查看文档：
-
-
-
## 📦 部署方式
- Docker：
- Docker Desktop 扩展：
- Windows 服务：
- Linux 服务：
- 应用配置：
在线演示：
-
## 🗂️ 仓库结构
仓库中的关键目录如下：
- [`IoTSharp`](IoTSharp)：主 ASP.NET Core 应用。
- [`ClientApp`](ClientApp)：Vue 3 前端控制台。
- [`docs`](docs)：Docusaurus 帮助手册站点。
- [`docker-desktop-extension`](docker-desktop-extension)：Docker Desktop 扩展体验包。
- [`IoTSharp.Installer.Windows`](IoTSharp.Installer.Windows)：Windows 安装工程。
- `IoTSharp.Agent`：面向未来本地桌面 companion / 语音入口的规划方向，当前仓库中尚无对应目录。
- [`IoTSharp.SDKs`](IoTSharp.SDKs)：SDK 与面向客户端的相关项目。
## 🌐 生态与相关项目
NuGet 包与生态库包括：
- `IoTSharp.Sdk.Http`
- `IoTSharp.Sdk.MQTT`
- `IoTSharp.Extensions`
- `IoTSharp.Extensions.AspNetCore`
- `IoTSharp.Extensions.EFCore`
- `IoTSharp.Extensions.QuartzJobScheduler`
- `IoTSharp.HealthChecks.*`
- `IoTSharp.X509Extensions`
相关仓库包括：
- [IoTEdge](https://github.com/IoTSharp/IoTEdge)：边缘网关运行时
- [IoTEmbedded](https://github.com/IoTSharp/IoTEmbedded)：嵌入式设备运行时
- IoTSharp MQTT C SDK
- IoTEdge paho.mqtt.c
- IoTEdge nanoFramework
- IoTSharp RT-Thread package
## 📚 文档
- 英文说明： [README.md](README.md)
- 文档首页：
- 路线图： [ROADMAP.md](/docs/iotsharp/roadmap/)
- 变更记录： [CHANGELOG.md](CHANGELOG.md)
## 🤝 参与贡献
欢迎通过 Issue 与 Pull Request 参与 IoTSharp：
- Pull Requests：
- Issues：
在提交改动前，建议先阅读当前的文档结构、仓库模块划分以及发布与分发方向。
## 💬 社区支持
如果你在使用或部署 IoTSharp 时遇到问题，可以通过以下渠道获取帮助：
- GitHub：
- Gitee：
- 官网：
## ❤️ 捐赠
IoTSharp 采用 Apache 2.0 协议发布。如果你希望支持项目持续发展，可以通过以下方式：
- OpenCollective：
- 爱发电：
- 支持者列表： [BACKERS.md](BACKERS.md)
## ✨ 祝福
- 愿你行善而不作恶。
- 愿你学会宽恕自己，也宽恕他人。
- 愿你乐于分享，不取多于所予。