设备命令
说明
- 设备命令均通过websocket下发
- 所有命令下发格式统一
- 如下结构中的自定义数据,就是命令列表中的数据结构
- 回执数据均通过API进行回执
- 所有需要回执服务器的数据全部使用API[回执服务器(channelPublish/target/v2/resultNotify)],通过入参data进行回执。
- 无回执数据的仅回执收到下发,有回执数据的还需要回执业务数据。
命令分类
登录
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
登录成功 | 5 | N | 参考 | 登陆成功后会下发后台设备信息 |
退出登录状态 | 310 | N | 参考 | 远程设备退出登录状态 |
查询登录信息 | 311 | N | 参考 |
设备
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
接收后台设备信息 | 4 | N | 参考 | 无 |
设备方向旋转 | 12 | N | 参考 | |
重启机器 | 102 | Y | 参考 | |
关机 | 103 | N | 参考 | |
设备旋转 | 206 | N | 参考 | |
获取设备信息 | 208 | N | 参考 | |
获取定时开关机信息 | 337 | N | 参考 | |
设置定时开关机 | 101 | Y | 参考 | |
设置屏幕背光 | 109 | Y | 参考 | |
执行shell | 110 | Y | 参考 | |
输入文本 | 336 | N | 参考 |
APP
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
截图 | 104 | N | 参考 | |
重启APP | 107 | N | 参考 | |
退出APP | 108 | N | 参考 | |
定向升级APP | 301 | N | 参考 | boss平台命令 |
定向升级APP | 324 | N | 参考 | 商户平台命令 |
记忆升级APP | 329 | N | 参考 | 如果未执行完成,会一直下发,直到升级完成 |
查看APP是否在前台 | 316 | N | 参考 | |
查看app是否在线 | 327 | N | 参考 |
播放与数据
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
接收播放数据 | 1 | N | 参考 | |
禁用排期 | 9 | N | 参考 | |
清理所有无效资源 | 313 | N | 参考 | |
删除所有排期 | 314 | N | 参考 | |
同步排期 | 315 | N | 参考 | |
退出播放 | 309 | N | 参考 | |
查看本地排期与节目 | 322 | N | 参考 | |
获取播放数据来源 | 338 | N | 参考 | |
设置播放数据来源 | 339 | N | 参考 | |
查看节目是否在播放 | 317 | N | 参考 | |
根据oss获取本地路径 | 328 | N | 参考 |
上传与下载
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
读取文件 | 303 | N | 参考 | |
下载文件 | 304 | N | 参考 |
数据库
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
获取本地数据库 | 305 | N | 参考 | |
执行sql语句 | 307 | N | 参考 | |
清空数据库 | 308 | N | 参考 |
日志
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
日志模式配置 | 7 | N | 参考 | |
上传事件日志 | 207 | N | 参考 | |
查询开发日志列表 | 302 | N | 参考 | |
查询日志模式 | 312 | N | 参考 | |
设置日志开发模式 | 306 | N | 参考 | |
清理日志 | 319 | N | 参考 | |
上传本地事件 | 321 | N | 参考 |
配置
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
商户配置 | 6 | N | 参考 | 首屏图等 |
设备配置 | 8 | N | 参考 |
应用
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
OFFICE远程控制 | 323 | N | 参考 | |
抖音控制 | 325 | N | 参考 | |
获取应用信息 | 326 | N | 参考 |
内核管理
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
切换浏览器内核 | 320 | N | 参考 | |
切换图片模式 | 330 | N | 参考 | |
切换播放器模式 | 331 | N | 参考 |
API管理
名称 | 编码 | 系统ROOT权限 | 数据结构 | 说明 |
---|---|---|---|---|
设置API请求间隔时长 | 332 | N | 参考 | |
获取API请求间隔时长 | 333 | N | 参考 | |
设置请求服务端API根地址 | 334 | N | 参考 | |
获取请求服务端API根地址 | 335 | N | 参考 |
使用
数据结构示例
{
"methodCode":302, // 命令编码
"data":{
"notifyId":-1, // 下发id
"notifyTime":"2024-01-08 20:00:09", // 下发时间
"publishTime":"2024-01-08 20:00:09", // 发布时间
"data":{}, // 下发数据 自定义json数据
"uuid":"1rWNFFzx3ti0NUzM84OsihyGOjMr0ZzzQBZy5nuPYZCRmgHYKvYboPPyU62wwdpZ" // 需要回执数据时使用uuid
}
}
下发-有数据
//示例: 206 旋转屏幕
{
"methodCode":206, // 命令编码
"data":{
"notifyId":-1, // 下发id
"notifyTime":"2024-01-08 20:00:09", // 下发时间
"publishTime":"2024-01-08 20:00:09", // 发布时间
"data":{
orientation:0
},
"uuid":"1rWNFFzx3ti0NUzM84OsihyGOjMr0ZzzQBZy5nuPYZCRmgHYKvYboPPyU62wwdpZ" // 需要回执数据时使用uuid
}
}
下发-无数据
//示例: 102 重启
{
"methodCode":102, // 命令编码
"data":{
"notifyId":-1, // 下发id
"notifyTime":"2024-01-08 20:00:09", // 下发时间
"publishTime":"2024-01-08 20:00:09", // 发布时间
"data":{}, // 自定义数据
"uuid":"1rWNFFzx3ti0NUzM84OsihyGOjMr0ZzzQBZy5nuPYZCRmgHYKvYboPPyU62wwdpZ" // 需要回执数据时使用uuid
}
}
回执-收到下发
- 所有命令收到下发后,会立即调用api回执服务器已收到命令
// 回执数据
{
data:[
{
id:'notifyId',
code:0,
type:1
}
]
}
// 回执api:channelPublish/target/v2/resultNotify
// 使用jquery的ajax示例:
$.ajax({
type: 'POST',
url: 'https://www.pointshow.net/api/channelPublish/target/v2/resultNotify',
data:JSON.stringify({
data:[{
id:'notifyId',
code:0,
type:1
}]
}),
dataType: 'json',
contentType: 'application/json',
headers:{
token:token
},
success: function (result) {
if (result.code == 0) {
// 业务处理
// todo ...
} else {
// 异常处理
// todo ...
}
},
error: function () {
// 网络异常处理
}
})
回执-有业务数据
- 使用参考[回执-收到下发]
- 命令中有业务数据进行回执的,回执数据是下面结构中的自定义data(命令[1、6、8、9]的回执数据除外)
// 回执数据格式
{
data:[
{
id:'notifyId',
code:0,
type:2,
data:{}, // 自定业务数据
uuid:'uuid'
}
]
}
// 104 截图
{
data:[
{
id:'notifyId',
code:0,
type:2,
data:{// 自定业务数据
url:'http://s.pointshow.cn/xxx.png'
},
uuid:'uuid'
}
]
}
回执-无业务数据
- 使用参考[回执-收到下发]
// 回执数据
{
data:[
{
id:'notifyId',
code:0,
type:2
}
]
}
注意事项
- 数据编码是[1,5,9]的和标准数据格式不一致