版本	修改说明	修改时间	注释
V1.0.0	初始版本	2025-04-30
V2.0.0	1、新增屏幕指定逻辑，删除屏幕选中逻辑 2、新增绝对场景和相对场景 3、新增接口模块协议 4、新增图层模块协议 5、新增图库模块协议 6、屏幕4.1章节/场景6.1章节适配设备1.7.0以下版本 7、屏幕4.2章节/场景6.2章节适配设备1.7.0及以上版本	2025-07-28	设备范围(P10,P20,Q8)
V2.0.1	1、协议新增针对P80设备的支持	2025-10-14	设备范围(P10,P20,Q8,P80)

1 环境准备

在调用相关API时，需确保以下环境：

确保PC与设备通信正常

2 基本使用步骤

打开相应API调用工具

找到需要使用的接口信息

根据接口协议调用相关API

3 请求方式说明

3.1 调用格式

所有的API请求，必须按照如下格式调用

协议调用前缀：http://ip:port/pixelhue/+协议url (ip:设备地址，port:8088)

例如:http://10.40.41.226:8088/pixelhue/v1/node/open-detail

http的header信息中必须填充下面信息：

Authorization: token信息

token生成方法

调用节点信息接口(不需要携带token)

URL: http://ip:port/pixelhue/v1/node/open-detail
Method：get
Query:
{
    "nodeId": 1
}
Response:
{
    "code": 0,
    "message": "ok",
    "data": {
        "sn": "1231231042541226",
        "startTime": "1718282915976"    }
}

客户端生成token

var Secret = []byte("whatasecret")  //客户端通过调用UServer新增的节点信息接口，获取到的服务启动时间作为秘钥

// jwt过期时间, 按照实际环境设置
const expiration = 2 * time.Minute

type Claims struct {
    // 自定义字段, 可以存在用户名, 用户ID, 用户角色等等
    SN string
    // jwt.StandardClaims包含了官方定义的字段
    jwt.StandardClaims
}

func GetToken(SN string) (string, error) {
    // 创建声明
    a := &Claims{
        SN: SN(open-detail接口返回的sn值),
        StandardClaims: jwt.StandardClaims{
            ExpiresAt: time.Now().Add(expiration).Unix(), // 过期时间
            IssuedAt:  time.Now().Unix(),                 // 签发时间
            Issuer:    "gin-jwt-demo",                    // 签发者
            Id:        "",                                // 按需求选这个, 有些实现中, 会控制这个ID是不是在黑/白名单来判断是否还有效
            NotBefore: 0,                                 // 生效起始时间
            Subject:   "",                                // 主题
        },
    }
    // 用指定的哈希方法创建签名对象
    tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a)
    return tt.SignedString(Secret)
}