dgiot/apps/dgiot_mqtt
2022-01-12 20:02:10 +08:00
..
etc fix:topo,evidence 2022-01-06 16:57:37 +08:00
include add mqtt 2021-07-05 15:11:12 +08:00
priv fix:topo,evidence 2022-01-06 16:57:37 +08:00
src feat: close mqtt hook 2022-01-10 10:14:00 +08:00
.gitignore add mqtt 2021-07-05 15:11:12 +08:00
LICENSE add mqtt 2021-07-05 15:11:12 +08:00
README.md feat: add dashboard ci 2022-01-12 20:02:10 +08:00
rebar.config refactor: rm plugin Makefile 2022-01-04 12:40:51 +08:00

Dlink协议

Dlink协议是针对物联网开发领域设计的一种数据交换规范数据格式是JSON用于设备端和物联网平台的双向通信更便捷地实现和规范了设备端和物联网平台之间的业务数据交互。

协议框架

dlink proctol.png

  • 设备层和用户层隔离,物理层和逻辑层隔离
  • 用户层mqtt权限与openApi权限保持一致性
  • 设备侧topic交互采用 {productId}/{deviceAddr}的组合来唯一标识设备, deviceAddr为设备物理地址
  • 用户侧topic交互采用{deviceId}来唯一标识设备,用{userId}来唯一标识用户,deviceId为设备虚拟地址

鉴权设计

  • deviceId=md5("Device" + {productId} + {devAddr}).subString(10)
  • %u 表示用Username做ACL规则
  • %c 表示用ClientId做ACL规则
  • %d 表示用DeviceAddr做ACL规则, Token是dgiot用户登录权限系统的token,与API权限一致
  • %t 表示用Token做ACL规则, Token是dgiot用户登录权限系统的token,与API权限一致
客户端 Username Password ClientId 登录鉴权 订阅ACL 发布ACL
Device {productId} {productSecret} {deviceId} 一型一密 $dg/device/%u/# $dg/thing/%u/#
Device {productId} {deviceSecret} {deviceId} 一机一密 $dg/device/%u/%d/# $dg/thing/%u/%d/#
Device {productId} {productSecret} {deviceId} 证书加密 $dg/device/%u/# $dg/thing/%u/#
User {userId} {Token} {Token} Token认证 $dg/user/%t/# $dg/thing/%t/#

topic设计

分类 Topic 发布者 订阅者
双向消息 $dg/device/{productId}/{deviceAddr}/messages 平台 设备
双向消息 $dg/thing/{productId}/{deviceAddr}/messages 设备 平台
双向消息 $dg/thing/{deviceId}/messages 用户 平台
双向消息 $dg/user/{deviceId}/messages 平台 用户
双向命令 $dg/device/{productId}/{deviceAddr}/commands/request_id={request_id} 平台 设备
双向命令 $dg/thing/{productId}/{deviceAddr}/commands/request_id={request_id} 设备 平台
双向命令 $dg/thing/{deviceId}/commands/request_id={request_id} 用户 平台
双向命令 $dg/user/{deviceId}/commands/request_id={request_id} 平台 用户
属性上报 $dg/thing/{productId}/{deviceAddr}/properties/report 设备 平台
属性上报 $dg/user/{deviceId}/properties/report 平台 用户
子属性上报 $dg/thing/{productId}/{deviceAddr}/gateway/sub_devices/properties/report 设备 平台
子属性上报 $dg/user/{deviceId}/gateway/sub_devices/properties/report 平台 用户
属性设置 $dg/thing/{deviceId}/properties/set/request_id={request_id} 用户 平台
属性设置 $dg/device/{productId}/{deviceAddr}/properties/set/request_id={request_id} 平台 设备
属性设置 $dg/thing/{productId}/{deviceAddr}/properties/set/request_id={request_id} 设备 平台
属性设置 $dg/user/{deviceId}/properties/set/request_id={request_id} 平台 用户
属性获取 $dg/thing/{deviceId}/properties/get/request_id={request_id} 用户 平台
属性获取 $dg/device/{productId}/{deviceAddr}/properties/get/response/request_id={request_id} 平台 设备
属性获取 $dg/thing/{productId}/{deviceAddr}/properties/get/response/request_id={request_id} 设备 平台
属性获取 $dg/{deviceId}/user/properties/get/request_id={request_id} 平台 用户
属性获取 $dg/thing/{productId}/{deviceAddr}/shadow/get/request_id={request_id} 设备 平台
属性获取 $dg/device/{productId}/{deviceAddr}/shadow/get/request_id={request_id} 平台 设备
事件上报 $dg/thing/{productId}/{deviceAddr}/events 设备 平台
事件上报 $dg/user/{deviceId}/events 平台 用户

payload设计

待设计