O1
O1 单目单轴旋转式视觉位移计 API 参考手册
型号: O1 | 版本: 1.0 | 更新: 2026-09-11
O1 是单目单轴旋转式视觉位移计,支持水平方向云台控制和巡航。
1. 快速开始
连接与数据接收见快速入门。完整代码见 GitHub SDK 和告警接入示例。
2. API 列表
基础 API
| 方法 | 说明 |
|---|---|
getAttr | 获取属性 |
setAttr | 设置属性 |
reboot | 重启设备 |
syncTime | 同步时间 |
标靶管理 API
| 方法 | 说明 |
|---|---|
initRefTargets | 初始化标靶参考位置 |
addTargets | 添加标靶 |
getTargets | 获取标靶列表 |
setTargets | 更新标靶配置 |
deleteTargets | 删除标靶 |
测量控制 API
| 方法 | 说明 |
|---|---|
startMeasurement | 启动测量 |
stopMeasurement | 停止测量 |
setLightLevel | 设置补光灯发光挡位 |
getLightLevel | 获取补光灯发光挡位 |
snapshot | 获取快照 |
电机控制 API(仅水平)
| 方法 | 说明 |
|---|---|
setMotorAngle | 设置电机角度(仅 pan) |
getMotorAngle | 获取电机角度 |
setMotorZero | 设置电机零点 |
enableMotor | 启用电机 |
disableMotor | 禁用电机 |
巡航查询 API
| 方法 | 说明 |
|---|---|
getCruisePaths | 获取巡航路径 |
3. API 详情
标靶管理 API 的完整字段约束参考 API参考。
initRefTargets
对指定标靶执行参考位置初始化/标定。通常先通过 addTargets 或 setTargets 保存标靶配置;初始化时可只传 targetId。如需覆盖保存配置,可在本次请求中提供 roi、distance 或 targetModel。
addTargets
在已有标靶基础上添加新标靶。
getTargets
获取当前标靶列表。
响应字段:
| 字段 | 类型 | 说明 |
|---|---|---|
targets[].targetId | String | 标靶 ID,1-64 字节,非空,不包含控制字符 |
targets[].sensorId | Integer | 视觉传感器 ID,单目设备为 0 |
targets[].roi | Object | 标靶 ROI 区域 |
targets[].distance | Float | 测量距离,单位 m |
targets[].role | String | 标靶角色:MP 为被测点,RP 为稳定基准点,CP 为控制/校核点 |
targets[].targetModel | String | 标靶型号,取值 T10、T20、T50、T100、T200 |
targets[].skipMeasurement | Boolean | 是否跳过测量 |
setTargets
更新已有标靶的配置。
deleteTargets
删除指定标靶。
setMotorAngle
设置电机角度。
注意: O1 仅支持水平 (pan) 方向,不支持 tilt 参数。
参数:
| 字段 | 类型 | 范围 | 说明 |
|---|---|---|---|
pan | Float | -180 ~ 180 | 水平角度 (°) |
speed | Integer | 1-100 | 转动速度 (%) |
请求:
{"reqId": 1, "method": "setMotorAngle", "params": {"pan": 45.0, "speed": 50}}
getMotorAngle
获取当前电机角度。
请求:
{"reqId": 1, "method": "getMotorAngle", "params": {}}
响应:
{"reqId": 1, "code": 0, "data": {"pan": 45.0}}
4. 遥测数据
设备通过 vdm/{deviceId}/telemetry 上报位移和设备状态;环境字段按设备传感器能力提供。字段、单位及 Protobuf / JSON 示例见遥测数据。
5. 公共告警、事件和错误
- 告警生命周期和强类型字段见 告警上报。
- 告警抓拍图像包格式和 ACK 流程见 告警抓拍图像包分块 Header。
- 事件类型及明细字段见 事件上报。
- 外层响应使用统一数值错误码:
code=0成功,任意非零码均为失败,见 错误码。