跳到主要内容

AsyncAPI MQTT 合同

本页是给人阅读的。AsyncAPI YAML 文件是供开发工具读取的机器合同,正常使用方式是下载或导入,而不是把它当成带样式的网页打开。

文件包含什么

  • 精确的默认下行主题:/{ProductKey}/{DeviceName}/user/get
  • 精确的默认上行主题:/{ProductKey}/{DeviceName}/user/update
  • 服务端到机柜、机柜到服务端的操作方向。
  • ASCII 帧包络和带有效 CRC 的合成示例。
  • 按约定关联完整指令目录。

哪些值仍由项目配置决定

  • 生产 MQTT/IoT 域名和端口。
  • 认证值、设备密钥和证书。
  • 实际 ProductKeyDeviceName
  • 已购买机柜对应的指令/固件支持矩阵。
  • 运营方选定的频率、超时和发布限制。

YAML 中保留的 mqtt.example.invalid 无法连接,是有意使用的安全占位符。它保证文件可被工具导入,同时不会泄露生产访问入口。

推荐使用流程

  1. 阅读本页和帧格式与指令总表
  2. 下载指令目录 JSON
  3. 把 AsyncAPI YAML 导入文档或事件合同工具。
  4. 使用参考代码测试向量
  5. 只在服务端配置中替换经过授权的项目配置值。