tio
是一个轻量的 IotHub 核心实现。
t
代表 tiny(微小),io
代表其职责是在设备与服务端之间提供通信渠道,也可理解为 iothub。
在我们实际的项目和产品中,使用过和深度了解过 AWS IoT、Azure IotHub、阿里云物联网平台等。曾经遇到过以下场景和问题:
- 私有化部署:部署到客户指定的环境下,没有使用公有云的条件
- 物联网定向卡问题:有些提供方只支持 IP 白名单,但公有云的服务往往会有多个 IP ,甚至不同区域解析到的 IP 也不一样,且 IP 过一段时间会发生变化
- 被公有云厂商绑定:切换到不同公有云厂商的物联网平台,有比较大的成本
- 低成本运行:初期业务尝试或规模比较小的项目,客户抱着尝试探索的目的,比较在乎成本控制,而公有云平台服务往往开通服务后有一个起步的每月费用
当我们去寻找一个支持私有化部署的 “IotHub”时,在开源社区中没找到一个这样定位的项目,大多是作为“物联网平台”的形式出现。然而,一些场景是不需要物联网平台中其他各种用不到的功能,也不愿意承受其比较重的代码实现和部署运维,加之各自的抽象设计和公有云厂商“经典”的抽象设计差异比较多。
于是,就设想能不能基于各大云厂商通过多年实践和相互间学习借鉴而形成的 IoTHub 的核心抽象和设计,开发一个轻量实用的 “IoTHub”。一个完整的 IotHub 是个庞大的东西(见个云厂商的产品文档),但其核心内涵其实是对“物模型”(或叫设备模型)的抽象和设计,而物模型中 Shadow(设备影子或叫设备孪生)又是一个大家都事实上非常雷同的一个核心抽象。
基于此,tio 在 2022-09-07 日诞生。通过在多个项目和产品中的实践,确实能解决问题。想着其他有类似需求的人或许也需要这样的东西,于是将其完整开源出来。
- 轻量:部署最简可以只有一个 golang 编译出的二进制程序(特别适合于开发、测试和设备数量不多的场景);当然也可以根据需要使用不同的数据库和消息中间件来提供更好的性能
- 简单:专注于 IotHub 的核心功能,不求大而全,保持简单稳定。并提供了 web 调试管理后台,便于调试和对 tio 接口的熟悉
- 实用:简化与物联网设备的交互过程和实现,特别是通过
设备影子
(Shadow)的抽象简化了服务端和设备的交互 - 生产可用:已在生产环境多个项目和产品中使用
- 与主流公有云 IotHub 一脉相承:深度参考了主流公有云厂商的设计抽象,经得起推敲;对于熟悉这部分的人,其知识可被迁移使用;对于既有私有化部署又有公有云部署(使用公有云IotHub)的场景,其对接方式非常类似,不会对原有流程和代码带来大的影响
- Thing:用于设备的基本管理,例如:CRUD、授权认证
- Connector:设备连接层(目前主要是 MQTT broker),有内置 MQTT Broker 和 EMQX 的集成
- Shadow:设备影子,类似于 AWS IoT Shadow、Azure Device Twin、阿里云设备影子,各大公有云厂商都有设备影子(名称各有不同)的抽象,且其内涵都高度一致,在我们实际的项目开发中确实是非常有用的工具,极大地减少上层业务系统和设备交互的复杂度和心智负担
- 设备直接方法(Direct Method):服务端对设备的方法调用,采用“请求-响应”模式,类似于 HTTP 请求。参考了 Azure Direct method 的设计
- Job: 任务管理。通过批量、定时地将任务发送给设备执行,并管理任务的状态和生命周期,任务操作可以是设备直接方法调用、 Shadow 更新、自定义操作等 —— 一方面,加强了设备直接方法调用、 Shadow 更新的功能性和易用性,批量定时异步执行这些操作、并且有操作记录(即 Job 和 Task 的记录);另一方面,自定义 Job 提供了一个通用的机制方便在设备上执行各类远程操作。
Shadow:
Thing app Back end
┌───────────────────────┐
│ Shadow │
│ ┌─────────────────┐ │
│ │ Tags ├──┼─────── Read,write
│ └─────────────────┘ │
│ ┌─────────────────┐ │
│ │ States │ │
│ │ ┌──────────┐ │ │
Read,receive ─────┼──┼───┤ Desired ├──┼──┼─────── Read,write
change notifications │ │ └──────────┘ │ │ change notifications
│ │ ┌──────────┐ │ │
Read,write ─────┼──┼───┤ Reported ├──┼──┼─────── Read
│ │ └──────────┘ │ │ change notifications
│ └─────────────────┘ │
└───────────────────────┘
Shadow Query:
Shadow 查询接口采用类 SQL 的方式查询,配合上灵活可扩展的 Shadow 属性,给到上层使用方很大自由,按需要的视图和查询条件让 Shadow 的数据获取有了很大的适应性。参考 Azure。
默认运行一个内置的 MQTT Broker,采用 github.com/mochi-mqtt/server。对于测试、开发和对轻量环境有需求的场景非常有用。
- 支持 MQTT v3.1.1 和 v5.0
- 支持 MQTT over Websocket
- 支持 SSL/TLS (包括 TCP 和 Websocket)
EMQX 是一个易于使用的优秀的 MQTT broker。
tio 集成了其 v5
版本,以提供更强的功能性和性能(水平扩展)。
- MySQL:用于生产环境
- sqlite3:用于测试、开发或轻量使用场景。当配置为
":memory:"
时,sqlite3 甚至支持内存模式,方便测试。请查看config.yaml
进行相应配置
- 检查
config.yaml
文件中的配置是否符合你的需求 - 运行
cd web && yarn && yarn build && cd - && go run cmd/tio/main.go
- 访问 https://127.0.0.1:9000 打开调试管理后台
- 访问 https://127.0.0.1:9000/docs 查看 API 文档
# 构建 web 后台
cd web && yarn && yarn build
# 构建 go 主程序
# CGO_ENABLED=1 用于 sqlite3,如果你不使用 sqlite,可以删除此参数。
CGO_ENABLED=1 go build -o tio cmd/tio/main.go
# 运行
./tio
构建 Docker 镜像
bash build/docker/build.sh
构建适用于基于 Debian 的 Linux 发行版的 deb 软件包
# deb 软件包在 ./dist 目录下
bash build/deb/build.sh
chmod +x ./githooks/*
git config core.hooksPath githooks
.
├── api # api 配置和 swagger 配置等
├── auth # 设备认证
├── shadow # tio 的核心,含 shadow、direct method 的定义和实现(涉及到消息通信的部分在 connector 中)
├── thing # thing 基本的 CRUD
├── job # 任务管理。任务操作含设备直接方法调用、更新Shadow、自定义操作等
├── ntp # 设备 ntp 服务
├── connector # connector 实现
│ └── mqtt
│ ├── embed # 内置的 MQTT Broker
│ └── emqx # 集成 EMQX MQTT Broker
├── cmd # main 入口代码
│ └── tio
├── web # 调试管理后台
├── config # 程序配置
├── db # db 配置
│ ├── mysql
│ └── sqlite
├── demos
│ └── light # 以路灯控制为示例,展示设备侧和服务端对 tio 的集成
│ ├── README.md
│ ├── device
│ └── server
├── build # 构建脚本和配置
│ ├── deb # debian 类系统中用到的 deb 包构建
│ └── docker
├── githooks # 代码规范和提交相关的 githooks
└── pkg # 业务无关的一些库
参考 Light Demo,有比较完整的设备侧和服务端的代码示例
golang + sqlite/mysql + 内置MQTT服务/emqx
前端(调试管理后台):vue3 + element-plus