grepnull/platypus

Platypus

镜像概述

Platypus是Hunter Douglas Platinum Gateway的REST API服务，基于libhdplatinum库开发，提供简洁的接口用于控制窗帘设备，简化客户端集成流程（注：本API未严格遵循HATEOAS规范，为方便集成做了部分简化）。

核心功能

• 查询所有窗帘列表，获取高度、ID、名称及所属房间ID信息
• 查询指定ID窗帘的详细信息
• 修改窗帘高度（支持提交完整窗帘对象或仅高度字段）

使用场景

• 智能家居系统集成，实现窗帘自动化控制
• 第三方应用对接Hunter Douglas窗帘设备，扩展控制功能
• 个人/家庭场景下快速调整窗帘状态

配置说明

• 确保容器网络可访问Hunter Douglas Platinum Gateway设备
• 默认暴露8080端口（具体以镜像实际配置为准）

部署示例

Docker Run命令

bash
docker run -d -p 8080:8080 --name platypus grepnull/platypus

接口详情

GET /shades

返回所有窗帘列表：

json
[{
    "height": 0,
    "id": "00",
    "name": "Foo",
    "roomId": "00"
},
{
    "height": 50,
    "id": "01",
    "name": "Bar",
    "roomId": "01"
}]

GET /shades/:id

返回指定ID的窗帘信息：

json
{
    "height": 0,
    "id": "00",
    "name": "Foo",
    "roomId": "00"
}

PUT /shades/:id

修改窗帘信息（仅高度字段生效）： 示例请求：

PUT /shades/00
{
    "height": 100,
    "id": "00",
    "name": "Foo",
    "roomId": "00"
}

PUT /shades/:id/height

单独修改窗帘高度： 示例请求：

PUT /shades/00/height
{
    "height": 100
}

错误处理

• 提交无效数据返回400错误
• 请求不存在的资源返回404错误
• 未处理异常可能返回500错误

高度范围说明

使用0-100的归一化高度范围（100表示完全打开），与libhdplatinum的范围不同。