Skip to content

照明控制 API

照明控制模块提供对建筑/区域照明设备的远程管理:查询状态、开关切换和批量控制。对接底层 IoT 网关协议,支持 Mock 模式用于开发调试。

所有端点均需认证。

完整的 API 参考可在运行时通过 Swagger UI 查阅(本地开发:http://localhost:3000/documentation,生产环境:/documentation

查询照明状态

GET /api/control/lighting/:labelId/status

查询指定照明标签组的状态。

参数类型说明
:labelId (path)string照明标签标识(如区域编码)
响应字段类型说明
labelIdstring标签 ID
onboolean是否开启(false=关,true=开)
brightnessnumber (可选)亮度百分比(0-100)
powernumber (可选)当前功率 (W)
updatedAtstring状态更新时间

开关切换

POST /api/control/lighting/:labelId/toggle

切换指定照明标签组的开关状态。

参数类型说明
:labelId (path)string照明标签标识
on (body)booleantrue 开灯,false 关灯;half 半开(仅 toggle 端支持)
响应字段类型说明
successboolean操作是否成功
labelIdstring标签 ID
onboolean切换后状态

批量控制

POST /api/control/lighting/:labelId/batch

向指定标签组下发批量控制指令。适用于场景联动(如"一键关灯")。

参数类型说明
:labelId (path)string照明标签标识
action (body)string控制动作:on / off / dim / scene
value (body, 可选)any动作参数(如 dim 时的亮度值,scene 时的场景 ID)
devices (body, 可选)array设备子集,不传则控制组内全部设备
响应字段类型说明
successboolean整体操作结果
resultsarray每个设备的执行结果
results[].deviceIdstring设备 ID
results[].successboolean单设备执行结果

完整的 API 参考可在运行时通过 Swagger UI 查阅(本地开发:http://localhost:3000/documentation,生产环境:/documentation

基于 MIT 协议发布