jetlinks-official-protocol

Go to file

PengyuDeng ff7e796a09 doc: 完善TCP文档内容 (#16 ) * doc: 完善TCP文档内容 * doc: 增加设备上报示例 * doc: 增加请求设备上线示例 * doc: 文档增加byteBuf构建示例 * doc: 使用databuffer构建报文		2024-01-24 19:22:33 +08:00
package	3.0.0	2023-04-04 09:43:48 +08:00
src	doc: 修复TCP协议解析注释错误 (#15 )	2024-01-05 11:27:33 +08:00
.gitignore	增加基本的tcp实现	2022-08-08 18:34:15 +08:00
README.md	优化文档链接	2023-02-13 13:52:05 +08:00
binary-protocol.md	doc: 完善TCP文档内容 (#16 )	2024-01-24 19:22:33 +08:00
pom.xml	Update pom.xml	2023-08-03 16:40:12 +08:00

README.md

JetLinks 官方设备接入协议

JetLinks官方实现的设备接入协议,可用于参考实现自定义协议开发.

注意: 本协议仅用于参考自定义协议开发,在实际使用中请根据不同的场景进行调整.如认证方式,加密等.

MQTT

查看TOPIC说明

用户名密码可以使用生成工具进行生成

HTTP

HTTP接入时需要使用Bearer 认证,URL和MQTT的接入Topic一致.

POST /{productId}/{deviceId}/properties/report
Authorization: Bearer {产品或者设备中配置的Token}
Content-Type: application/json

{
 "properties":{
   "temp":38.5
 }
}

TCP

报文格式说明:

第0-4字节对应的32位整型值为接下来报文的长度,

后续为报文数据，具体报文格式见: 二进制格式说明

创建连接后第一个数据包需要发送认证包, 密钥需要在产品-设备接入或者设备详情中进行配置

UDP

报文格式说明:

第0字节表示认证类型,目前固定为0x00.

第1-n字节为密钥信息,编码使用STRING见: 数据类型定义

密钥需要在产品-设备接入或者设备详情中进行配置

后续为报文数据,具体报文格式见: 二进制格式说明

UDP无需发送认证包,但是需要每个报文中都包含密钥信息.

除了ACK以外,其他平台下发的指令也都会包含认证密钥信息,用于设备侧校验请求.

测试

可以使用模拟器进行模拟测试