README.md · sweeter/jetlinks-official-protocol - Gitee.com

5月24日 | Gitee Talk 模力方舟 AI 应用沙龙合肥站，多个 AI+ 项目实践分享，跨行业 AI 场景落地，报名现已开启~

forked from JetLinks物联网基础平台/jetlinks-official-protocol

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

文件

该仓库未声明开源许可证文件（LICENSE），使用请关注具体项目描述及其代码上游依赖。

克隆/下载

README.md 1.79 KB

## JetLinks 官方设备接入协议

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

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

### MQTT

[查看TOPIC说明](http://doc.jetlinks.cn/dev-guide/jetlinks-protocol-support.html)

用户名密码可以使用[生成工具进行生成](http://doc.jetlinks.cn/basics-guide/mqtt-auth-generator.html)

### HTTP

HTTP接入时需要使用`Bearer`
认证,URL和[MQTT的接入Topic]((http://doc.jetlinks.cn/basics-guide/jetlinks-protocol-support.html))一致.

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

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

### TCP

报文格式说明:

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

后续为报文数据，
具体报文格式见: [二进制格式说明](binary-protocol.md)

创建连接后第一个数据包需要发送[认证包](binary-protocol.md#0x01-online-首次连接),
密钥需要在`产品-设备接入`或者`设备详情`中进行配置

### UDP

报文格式说明:

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

第`1-n`字节为`密钥信息`,编码使用`STRING`见: [数据类型定义](binary-protocol.md#数据类型)

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

后续为报文数据,具体报文格式见: [二进制格式说明](binary-protocol.md)

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

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

### 测试

可以使用[模拟器](http://github.com/jetlinks/device-simulator)进行模拟测试

一键复制编辑原始数据按行查看历史

提交于 2023-02-13 13:52 +08:00 . 优化文档链接

## JetLinks 官方设备接入协议

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

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

### MQTT

[查看TOPIC说明](http://doc.jetlinks.cn/dev-guide/jetlinks-protocol-support.html)

用户名密码可以使用[生成工具进行生成](http://doc.jetlinks.cn/basics-guide/mqtt-auth-generator.html)

### HTTP

HTTP接入时需要使用`Bearer`
认证,URL和[MQTT的接入Topic]((http://doc.jetlinks.cn/basics-guide/jetlinks-protocol-support.html))一致.

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

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

### TCP

报文格式说明:

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

后续为报文数据，
具体报文格式见: [二进制格式说明](binary-protocol.md)

创建连接后第一个数据包需要发送[认证包](binary-protocol.md#0x01-online-首次连接),
密钥需要在`产品-设备接入`或者`设备详情`中进行配置

### UDP

报文格式说明:

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

第`1-n`字节为`密钥信息`,编码使用`STRING`见: [数据类型定义](binary-protocol.md#数据类型)

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

后续为报文数据,具体报文格式见: [二进制格式说明](binary-protocol.md)

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

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


### 测试

可以使用[模拟器](http://github.com/jetlinks/device-simulator)进行模拟测试

Loading...

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

1

https://gitee.com/sweeter-open/jetlinks-official-protocol.git

git@gitee.com:sweeter-open/jetlinks-official-protocol.git

sweeter-open

jetlinks-official-protocol

jetlinks-official-protocol

v3