控制云台、预置点与巡航
控制云台、预置点与巡航
文档中的「预置点」对应 收藏点(CollectionPoint 能力集)。云台移动需 PT/PTZ;定时巡航需 TimedCruise。新能力见 云台(含 巡航);旧 HTTP 见 设备操作说明 与 收藏点、巡航配置。移动端云台走 OpenSDK,见 应用开发。
步骤
典型顺序:云台移动/定位 → 维护收藏点 → 配置并开启定时巡航(巡航前需有收藏点且使能开关为开)。三者无平台强制间隔,以设备能力为准。
云台
新接入可优先 设备能力 · 云台:ptz.aim.speed 配置转速 → 按速度转动 / 按步转动 → 复位。设备须具备对应 PT/PTZ 能力集;字段以 device.capability.list 发现为准。下列为 旧版 HTTP 接口,仍可用于已有集成:
- 按方向移动。controlMovePTZ:云台移动控制。功能详情:云台移动控制接口。说明页描述:控制设备云台进行移动。
operation的合法值:0 上,1 下,2 左,3 右,4 左上,5 左下,6 右上,7 右下,8 放大,9 缩小,10 停止。duration的说明:移动持续时间,单位毫秒。返回 data 为无 data 数据返回。子账号最小权限:"Permission":"Ptz","Resource":"cam:序列号:通道号"。请求地址https://openapi.lechange.cn/openapi/controlMovePTZ。 - 移到指定位置。controlLocationPTZ:云台定位。功能详情:云台定位接口。说明页描述:控制设备云台位移到指定位置。
h水平操作参数,取 [-1,1];v垂直操作参数,取 [-1,1];z变倍参数,取 [0,1],其中 0 表示缩到最小,1 表示放到最大。子账号最小权限与上一步相同。请求地址https://openapi.lechange.cn/openapi/controlLocationPTZ。 - 读当前位置。devicePTZInfo:获取设备云台控制接口。功能详情:获取设备通道当前 PTZ 云台位置信息。说明页描述:查询设备当前云台位置信息。子账号最小权限与上一步相同。请求地址
https://openapi.lechange.cn/openapi/devicePTZInfo。返回字段见 devicePTZInfo 接口页。
三页备注都是:云台相关功能需要设备拥有 PT 或 PTZ 云台能力集。
收藏点
设备收藏点配置说明 的接口:
- 新增。setCollection:新增收藏点。功能详情:新增收藏点。说明页描述:新增巡航收藏点。
needCruise的说明:是否加入巡航计划中;默认值 false;合法值 true、false。请求地址https://openapi.lechange.cn/openapi/setCollection。 - 删除。deleteCollection:删除收藏点。功能详情:删除收藏点。说明页描述:删除巡航收藏点。请求地址
https://openapi.lechange.cn/openapi/deleteCollection。 - 查询。getCollection:获取收藏点信息。功能详情:获取已添加的收藏点名称信息。说明页描述:查询巡航收藏点信息。请求地址
https://openapi.lechange.cn/openapi/getCollection。 - 改名。modifyCollection:修改收藏点名称。功能详情:修改已存在的收藏点名称。说明页描述:修改巡航收藏点名称。请求地址
https://openapi.lechange.cn/openapi/modifyCollection。 - 转到该点。turnCollection:转动到收藏点。功能详情:转动设备到目标收藏点。说明页描述:转动到巡航收藏点。请求地址
https://openapi.lechange.cn/openapi/turnCollection。
这五页备注都是:需要设备存在 CollectionPoint 收藏点位能力集。子账号最小权限都是 "Permission":"Config","Resource":"cam:序列号:通道号"。
定时巡航
设置。setCruiseConfig:设置定时巡航。功能详情:设置设备的定时巡航配置。说明页描述:设置设备的巡航模式、时间计划等。备注:只支持具有 TimedCruise 能力的单通道 IPC 设备;如果需要开启巡航,需要保证 regularCruise 使能开关状态为开(regularCruise 使能状态通过 getDeviceCameraStatus:获取设备使能开关状态 获取)。
mode的合法值:default 默认模式,即全景巡航;collection 定制模式,即收藏点巡航。cruisePath:当 mode=collection 时必填;default 默认路径,由设备端决定;custom 自定义路径,即 collection 中收藏点的顺序。cruises的period合法值:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday,只可设置一天,若需设置多天请设置多个巡航周期和起止时间。beginTime、endTime的时间格式为 THHMMSS。补充约束:- collection 字段必须存在且为列表。
- mode 为 default 时,cruisePath 可选,collection 字段长度和内容不限制。
- mode 为 collection 时,cruisePath 必须存在,且为 default 或者 custom 之一。cruisePath 是 default 时,collection 字段内容和数组长度不限。cruisePath 为 custom 时,collection 字段长度不能为 0,内容必须符合协议,且所设置收藏点 name 必须是加入巡航计划中的收藏点(即调用 setCollection 接口的 needCruise 字段为 true),否则将不生效。
子账号最小权限:
"Permission":"Config","Resource":"cam:序列号:通道号"。请求地址https://openapi.lechange.cn/openapi/setCruiseConfig。读取。getCruiseConfig:获取定时巡航设置。功能详情:获取设备的定时巡航配置。说明页描述:查询设备的巡航模式、时间计划等。备注:需要设备支持 TimedCruise 定时巡航能力集。这一页的备注没有重复「只支持单通道 IPC」。子账号最小权限与设置页相同。请求地址
https://openapi.lechange.cn/openapi/getCruiseConfig。
获取页备注与设置页备注用词不同,两处并列保留。
各端实现
服务端 HTTP
云台、收藏点、定时巡航按各页写出的请求地址调用。参数以原接口页为准。