OneNET Studio 简介 产品介绍
功能介绍 资源模型 名词解释
快速入门
账户与登录 实名认证
设备接入与管理
设备接入流程 创建产品 开发产品物模型
什么是物模型？ 物模型管理 物模型通信协议
OneJSON
协议简介 设备属性/事件 设备服务 设备期望属性值 管理拓扑关系 子设备上下线 子设备数据交互 LwM2M拓展
数据解析
什么是数据解析？ 脚本开发 MQTT设备开发 LwM2M设备开发 最佳实践
创建设备 转移设备 文件管理 远程配置 标准协议接入
接入概述 接入安全认证 设备接入SDK MQTT协议接入
MQTT设备连接 通信主题 使用限制 最佳实践
CoAP协议接入
CoAP设备连接 使用限制
LwM2M协议接入
LwM2M协议规范 LwM2M-Studio概览 LwM2M设备创建 LwM2M设备开发
HTTP协议接入
HTTP接入使用说明 HTTP接入接口列表
直连设备API
设备属性上报 设备事件上报 批量数据上报 历史数据上报
代理设备API
设备属性上报 设备事件上报 批量数据上报 历史数据上报 子设备上线 子设备下线 添加子设备 删除子设备 获取拓扑关系
泛协议接入
服务概述 代理直连设备 代理网关设备 SDK开发指南 最佳实践-云云对接 最佳实践-代理直接设备 最佳实践-代理网关设备 相关限制 SDK历史版本文档
1.0.3 Version
SDK开发指南 最佳实践-代理直接设备
物模版库 生态接入认证
应用开发
应用开发流程 新建项目 添加设备 设备分组 场景联动 应用数据流转
规则引擎
服务概述 消息源格式 SQL说明 消息目的地
消息队列MQ HTTP推送
HTTP数据推送 消息队列MQ
应用API
使用说明 安全鉴权 错误码 SDK下载 设备管理类
设备创建 设备批量创建 设备编辑 设备删除 设备详情 设备转移 物模型系统功能点 物模型查询 设备工业标识注册
应用开发类
项目概况 项目集成产品列表 项目集成设备列表 项目添加设备 项目移除设备 分组创建 分组删除 分组编辑 分组详情 分组列表 分组设备添加 分组设备移除 设备详情 设备状态查询 设备状态记录查询 设备属性设置 设备属性获取 设备属性期望设置 设备属性期望查询 设备属性期望删除 设备操作日志查询 设备最新数据查询 设备属性记录查询 设备事件记录查询 设备服务调用 设备服务执行记录查询 设备文件上传 设备文件下载 设备文件删除 账户文件列表查询 账户文件存储空间查询 账户设备文件数量查询 场景联动规则创建 场景联动规则编辑 场景联动规则详情 场景联动规则列表 场景联动触发日志
LwM2M-IPSO类
即时命令API
设备资源列表获取 资源发现 资源订阅 读设备资源 写设备资源 命令下发
缓存命令API
读设备资源 写设备资源 命令下发
DTLS相关API
查看设备bs_psk 更新bs_psk 新增acc_psk 编辑acc_psk 查看设备acc_psk
应用长连接
服务概述 最佳实践
规则引擎（新）
服务概述 消息源格式 SQL说明
运维监控
设备调试 API调试 日志服务 告警中心 远程升级 设备防御
数据可视化 边缘计算 人工智能AI 位置定位
服务简介 产品定价 基站定位开发指南 基站位置查询API WiFi定位开发指南 WiFi位置查询API
语音通话
服务简介 产品定价 语音通知模板规范 API接口
API使用说明 错误码 语音通知 语音通知状态呼叫通知 点击拨号 点击拨号状态呼叫通知
工业互联网标识
服务简介 服务开通 前缀管理 数据模板 标识管理
权限管理
服务简介 主账户操作 协作账户操作
服务协议
公测服务协议 位置定位服务协议 语音通话服务协议 工业互联网标识服务协议
更新日志

应用长连接

1. 服务概述

2. 服务地址

3. 客户端鉴权

4. 消息通信主题

1. 服务概述

应用长连接是提供点对点通信的服务，可实现应用设备数据的实时获取和控制命令下发，适用于设备操作频繁，对交互性、时效性要求比较高的应用场景，如智能家居APP、大屏应用等，可以减少网络请求次数和流量开销。


图 1 应用长连接通信流程

应用长连接采用MQTT协议进行通信，每个应用客户端作为一个MQTT Client，平台作为MQTT Server，通信流程可概括为建立连接、订阅主题、接收消息并处理、发布消息四个步骤。

  • 建立连接：
    • 应用客户端创建MQTT Client，设置clineid、username、password鉴权参数。
    • 应用客户端设置keepalive、协议版本、tls等连接会话参数。
  • 订阅主题
    • 根据应用场景需求，客户端订阅系统主题，目前提供设备生命周期状态变更、设备属性功能点、设备事件功能点及属性设置响应4种类型主题。
    • 系统通信主题以单设备作为发布和订阅的层级。
  • 接收消息并处理
    • 设备发生状态更改或者上报数据后，平台将消息推送给订阅该通道的客户端，客户端对数据进行处理。
    • 应用长连接不提供消息缓存功能，对于需要获取项目设备全量数据，支持消息缓存的应用场景，建议使用HTTP推送或消息队列MQ。
  • 发布消息
    • 用户可通过向指定主题发布消息，实现对设备的属性设置及属性期望值设置。

2. 服务地址

应用长连接支持标准 MQTT V3.1.1 版本，接入服务地址如下：

地址端口证书说明
183.230.102.11625002-tcp非加密端口

3. 客户端鉴权说明

应用客户端与平台建立连接时，平台会对MQTT Client设置的clienid，username，password参数信息进行鉴权，目前平台支持用户维度和项目分组维度两种鉴权方式。鉴权参数如下表所示：

参数说明
clientid应用客户端自定义，每个clientid在平台保持唯一，避免信息重复可不设置，由系统自动生成
username目前支持两种类型：
基于用户权限订阅 userid/{userId}
基于项目分组订阅 projectid/{projectId}/groupid/{groupId} 项目ID、分组ID作为变量参数
password安全鉴权参数，username参数值作为安全鉴权计算中的res策略值参与运算

4. 消息通信主题

客户端只能订阅当前账号权限下的设备主题，服务提供主题列表如下所示：

TOPIC说明可订阅可发布
$sys/{productId}/{deviceName}/thing/lifecycle设备生命周期状态更改√
$sys/{productId}/{deviceName}/thing/property设备属性上报√
$sys/{productId}/{deviceName}/thing/event设备事件上报√
$sys/{productId}/{deviceName}/thing/property/set设备属性设置√
$sys/{productId}/{deviceName}/thing/property/desired/set设备属性期望值设置√
$sys/{productId}/{deviceName}/thing/property/set/reply设备属性设置响应√
设备生命周期数据
Topic：$sys/{productId}/{deviceName}/thing/lifecycle

Message：{    
    "productId": "00001",                    
    "deviceName": "iot-0001",      
    "messageType": "lifecycle", 
    "data":  {
        "status": "online",
        "time": 1524448722123
    }
}
设备属性功能点上报：
Topic：$sys/{product_id}/{device_name}/thing/property

Message: {  
    "productId": "00001",                   
    "deviceName": "iot-0001",     
    "messageType": "notify",
    "notifyType": "property",
    "data": {                         
        "id":  "12345",                
        "params": {
            "Power": {
                "value": "on",
                "time": 1524448722123
            },
            "WF": {
                "value": 23.6,
                "time": 1524448722123
            ｝
        ｝
    } 
}
设备事件功能点上报：
Topic：$sys/{product_id}/{device_name}/thing/event

Message: {
    "productId": "00001",                        
    "deviceName": "iot-0001",    
    "messageType": "notify",
    "notifyType": "event",
    "data": {
        "id": "123",
        "version": "1.0",
        "params": {
            "identifier1":{
                "value": {
                    "Power": "on",
                    "WF": "2"
                },
                "time": 1524448722123
            },
            "identifier2": {
                "value": {
                    "Power": "on",
                    "WF": "2"
                },
                "time": 1524448722123
            }
        }
    }
}
设备属性设置
Topic：$sys/{product_id}/{device_name}/thing/property/set

Message： {
    "requestId": "8906582E6722409AA6C40E7863B733A5",
    "data": {
        "version": "1.0",  // 可选，不填默认为1.0
        "params": {        // 属性设置，必须为对
            "temperature":"30.5"
        }
    }  
}
设备属性期望值设置
Topic：$sys/{product_id}/{device_name}/thing/property/desired/set

Message： {
    "requestId": "8906582E6722409AA6C40E7863B733A5",
    "data": {
        "version": "1.0",  // 可选，不填默认为1.0
        "params": {        // 属性设置，必须为对
            "temperature":"30.5"
        }
    }  
}
设备属性设置响应
Topic：$sys/{product_id}/{device_name}/thing/property/set/reply

成功响应：
{
    "requestId": "8906582E6722409AA6C40E7863B733A5", //用户自定义id 
    "success": true,
}

失败响应：
{
    "requestId": "8906582E6722409AA6C40E7863B733A5",
    "code":  "deviceNotFound",
    "msg": "device does not exist", 
    "success": false
}

个搜索结果，搜索内容 “”

    0 个搜索结果，搜索内容 “”