PUXELHUE
简体中文
  • 简体中文
  • English
  1. 2 设备
PUXELHUE
简体中文
  • 简体中文
  • English
  • API使用说明
  • 1 鉴权
    • 1.1 用户登录
      POST
    • 1.2 读取节点公开信息
      GET
  • 2 设备
    • 2.1 读取节点信息
      GET
    • 2.2 执行系统恢复出厂
      PUT
    • 2.3 设置切换特效
      PUT
    • 2.4 设置swap
      PUT
    • 2.5 读取节点监测状态
      GET
  • 3 接口
    • 3.1 读取详细信息列表
      GET
    • 3.2 设置输出定位
      PUT
    • 3.3 设置画质
      PUT
  • 4 屏幕
    • 4.1 获取屏幕信息
      GET
    • 4.2 设置屏幕冻结
      PUT
    • 4.3 设置屏幕ftb
      PUT
    • 4.4 操作屏幕cut
      PUT
    • 4.5 操作屏幕take
      PUT
  • 5 图层
    • 5.1 获取图层完整信息
      GET
    • 5.2 获取图层模板列表
      GET
    • 5.3 应用图层模板
      PUT
    • 5.4 设置图层换源信息
      PUT
    • 5.5 设置图层选中信息
      PUT
  • 6. 场景
    • 6.1 获取场景详细信息列表
      GET
    • 6.2 场景创建
      POST
    • 6.3 单场景应用
      POST
    • 6.4 场景名称修改
      POST
    • 6.5 场景删除
      POST
  • 7 图库
    • 7.1 图片信息列表
  1. 2 设备

2.1 读取节点信息

GET
/v1/node/detail
节点工作模式(按位表征):
76543210描述设备举例
ByPass解码器播放器拼接器切换器控制器光电转换器
√光电转换器
√√√MX系列
√QD
√T卡TU/TB
√√NPN10/20
√√H系列H
√√√√二合一K/V/VC/VX
√分布式解码器

请求参数

Query 参数
nodeId
string 
节点ID
必需
Header 参数
Authorization
string 
token
必需

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://prod-cn.your-api-server.com/v1/node/detail?nodeId' \
--header 'Authorization;'

返回响应

🟢200成功
application/json
Body
code
integer 
错误码
必需
默认值:
200
message
string 
ok
必需
错误描述
data
object 
业务数据
必需
nodeId
integer 
节点ID
必需
configInfo
object 
必需
设备能力配置文件信息
modeId
integer 
必需
节点的modeId,即节点上,主控的modeId
status
enum<integer> 
必需
节点运行状态【-1:设备非法0:加载中1:加载完成,业务空闲2:加载完成,处于升级中3 : 加载完成,处于工程文件创建中4 : 加载完成,处于工程文件应用中5 : 加载完成,处于设备模式切换中6 : 加载完成,处于设备恢复出厂中7:加载完成,处于保存图片中8:加载完成,处于压缩日志中9:加载完成,处于备份数据同步中10 :加载完成,处于设备自检中11 :hdr生效中12 :加载完成,处于箱体固化中13 :加载完成,处于箱体参数重载中14:加载完成,处于抓图中15:加载完成,处于take过程中:take cut 以及TBar100%的时候才使用这个字段16: 加载完成,处于接收卡升级中17: 加载完成,处于接收卡刷新中18:加载完成,处于接收卡下发配置文件中19:加载完成,处于内置源图片转换中20:加载完成,处于箱体旋转中21:加载完成,处于修正打屏中22:加载完成,处于箱体参数固化中23:加载完成,处于应用场景预设中24:加载完成,处于上传箱体画质文件中25:加载完成,处于联机校正中26:加载完成,处于校正系数管理中27:加载完成,处于箱体工具连接中28:加载完成,处于NCP文件导入中29:加载完成,处于NCP文件删除中30:加载完成,处于NCP文件导出中31:加载完成,处于格式刷中32:加载完成,处于接收卡重启中33:加载完成,设备忙,需查看子状态;34:加载完成,处于图层规格切换中;35:待机状态,设备处于待机状态中】
>= 0<= 2
枚举值:
012
默认值:
1
subStatus
array[integer]
必需
节点子状态定义,多个状态可能同时存在:【1:设备一控多执行中;2:场景执行keyframe过程中;3:预览执行keyframe过程中;】
sn
string 
SN/序列号
必需
version
string 
版本号
必需
默认值:
v12.1
general
object 
general信息
必需
versionMatching
object 
版本匹配信息
必需
powerState
number 
设备通电后状态
必需
1:自动开机
2:保持关机
3:恢复断电前状态;
area
object 
必需
区域信息, 地理位置
mode
object 
节点模式
必需
location
object 
节点定位
必需
time
object 
授时时间
必需
stateInfo
object 
监控状态
必需
syncTime
object 
时间同步
必需
networkType
number 
必需
当前终端的网络类型网络类型 0:没有网络, 1:有线网络,2:wifi, 3:2G, 4:3G, 5:4G
> 0< 5
默认值:
1
subcards
array [object {5}] 
必需
节点子卡列表(所有卡槽)
>= 1 items<= 1 items
genlock
object 
必需
genlockStatus
object 
必需
Genlock当前的状态
deviceBackup
object 
设备备份
必需
deviceBeacon
integer 
必需
设备定位:0关闭,1开启
deviceType
integer 
设备类型
必需
0:无效参数 1:单卡式设备 2:插卡式设备
presetPlayEffect
integer 
场景切换特效
必需
0 : 直切 1:黑屏过渡
virtualId
integer 
必需
设备虚拟ID,设备级联id
layerMode
number 
图层规格模式
必需
0:默认模式(切换器: 0:2MAIN+10PIP; 1:4*MAIN+4PIP;.)
authorInfo
object 
授权相关信息
必需
fanMode
number 
必需
0-未知 1-标准模式 2-高性能模式
plugin
object 
插件信息
必需
示例
{
    "code": "200",
    "message": "string",
    "data": {
        "nodeId": 0,
        "configInfo": {
            "md5": "string"
        },
        "modeId": 0,
        "status": "1",
        "subStatus": [
            0
        ],
        "sn": "string",
        "version": "v12.1",
        "general": {
            "name": "system1"
        },
        "versionMatching": {
            "serverVersion": "string",
            "minMatchingVersion": "string",
            "minProductVersion": "string"
        },
        "powerState": 0,
        "area": {
            "areaId": "0",
            "areaName": "name1"
        },
        "mode": {
            "workMode": 0,
            "masterSlave": 0
        },
        "location": {
            "enable": 0
        },
        "time": {
            "timestamp": 0,
            "timezone": 0
        },
        "stateInfo": {
            "slot": [
                {
                    "slotId": 0,
                    "status": [
                        {
                            "type": 0,
                            "index": 0,
                            "state": 0,
                            "value": 0
                        }
                    ]
                },
                {
                    "slotId": 0,
                    "status": [
                        {
                            "type": 0,
                            "index": 0,
                            "state": 0,
                            "value": 0
                        }
                    ]
                },
                {
                    "slotId": 0,
                    "status": [
                        {
                            "type": 0,
                            "index": 0,
                            "state": 0,
                            "value": 0
                        }
                    ]
                }
            ]
        },
        "syncTime": {
            "timeMode": "2",
            "gps": {},
            "lora": {
                "groupId": "121212"
            },
            "ntp": {
                "server": "string"
            }
        },
        "networkType": "1",
        "subcards": [
            {
                "slotId": "1",
                "modeId": "1",
                "boardId": "1",
                "online": "1",
                "rotate": 0
            }
        ],
        "genlock": {
            "type": 0,
            "sourceId": 0,
            "phase": {
                "enable": 0,
                "offset": 0
            }
        },
        "genlockStatus": {
            "type": 0
        },
        "deviceBackup": {
            "master": {
                "sn": "string",
                "mac": "string",
                "ip": "string",
                "name": "string",
                "modeId": 0
            },
            "slave": [
                {
                    "sn": "string",
                    "mac": "string",
                    "ip": "string",
                    "name": "string",
                    "modeId": 0
                }
            ]
        },
        "deviceBeacon": 0,
        "deviceType": 0,
        "presetPlayEffect": 0,
        "virtualId": 0,
        "layerMode": 0,
        "authorInfo": {
            "startTimestamp": 0,
            "durationTimestamp": 0,
            "flag": 0
        },
        "fanMode": 0,
        "plugin": {
            "resource": {
                "url": "string",
                "md5": "string",
                "version": "string"
            }
        }
    }
}
修改于 2025-04-22 02:48:20
上一页
1.2 读取节点公开信息
下一页
2.2 执行系统恢复出厂
Built with