中控环境基本说明(指令)
目的
本文通过对该中控控制API指令的功能说明和语法的详细介绍,使阅读人员能够快速了解中控控制模块的相关功能,并能指导开发人员完成后续的开发编码工作。能够根据说明完成与yealink VCS 产品的网络模式的控制主机的开发。
简介
2.1 网络模式配置说明
设备支持网络模式对主机设备进行控制,采用 TCP 协议建立连接,客户端需要知道主机的ip地址和端口号才能连接主机端。
以下是网络模式需要配置的参数:
1> 中控的网络模式的控制端口配置为:6024
2> ip 地址可以根据实际情况查看即可
3> 如果中控的网络模式开启了密码鉴权,通过TCP协议建立连接时,需要输入密码并鉴权通过后,才能正常执行中控指令。输入密码格式为 "XXXX\r\n" ,其中XXXX为正确的密码。
例如:建立 TCP 连接后,收到"Password:\r\n"信息,即提示需要输入鉴权密码。
当前输入错误的密码,连接会返回"Invalid Password!\r\nPassword:\r\n",提示需要重新输入密码进行鉴权。
只要输入正确的密码,连接会返回"welcome yealink centralcontrol"。
2.2 串口模式配置说明
部分设备支持串口模式对主机设备进行控制,例如:M500和M900。客户端需要通过串口线连接到主机设备,主机正常识别到串口,采用串口协议建立连接。
串口的波特率、数据位、奇偶校验位和结束位可以通过设备的网页进行配置。
API指令
3.1 API 基本语法说明
本介绍设备中控API指令说明文件,为了便于说明 API 指令语法,对API书写的格式做如下声明与约定:
指令单词均为小写
指令基本结构:命令+参数
参数组成:参数名+参数值 ------ 以:号分隔,指令参数总体同httpapi格式,以json字串形式传输
注意:"app"为特殊参数,区别于其他参数,独立在json格式外传输,此参数代表指令调用的是app的指令,不带该参数默认为系统层指令
3.2 基本数据包格式说明
发送格式说明: 采用\r\n (回车换行符)作为结束标识符
所有API 指令发送最后都需要加入\r\n结束的标识符
返回格式说明:采用\r\n作为结束标识符
所有返回包都会带有\r\n的结束标识符
指令基本格式:
Command + \r\n(无参数类型)
Command + 空格 + json字符串 + \r\n(带参数类型)
Command + 空格 + app:value + 空格 + json字符串 + \r\n(带参数及app参数类型)
3.2 API指令详细说明
目前支持的API指令列表如下文所述,请读者参考指令说明,在调试时,可以使用tcp调试工具,根据上文的环境支持说明进行搭建,测试API命令。不同版本与机型支持的命令和参数会有差异。 以下API指令参数中以"[]"包含的为可选参数。
系统层指令
前言:以下指令说明中,"[]"的请求参数均代表为选填项,指令入参维持json字符串格式,像名字之类的涉及中文的,必须要用utf8格式的字符。
system语法
1. 获取系统版本信息
返回参数
名称 类型 参数说明
model string 设备机型
firmware string 软件版本号
hardware string 硬件版本号
serialnumber string 设备sn号
macaddress string 设备mac地址
cc-version string 中控版本号
说明
system 指令 system get version
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingDisplay,MeetingEye 500/900,MeetingBar A10/A40/A50,UVC40
发送格式 system get version\r\n
返回格式 system get version {"model":"MeetingEye 500","firmware":"280.320.254.125","hardware":"280.0.0.0.0.0.0","macaddress":"00:15:65:00:00:00","serialnumber":"506607D117000009","cc-version":"1.0.0.2"}\r\n
示例 Send:system get version \r\nReturn: system get version {"model":"MeetingEye 500","firmware":"280.320.254.125","hardware":"280.0.0.0.0.0.0","macaddress":"00:15:65:00:00:00","serialnumber":"506607D117000009","cc-version":"1.0.0.2"} \r\n
2. 获取系统状态
返回参数
名称 类型 取值范围 参数说明
status string [sleeping,wake-up] 系统状态sleeping:休眠wake-up:唤醒
说明
system 指令 system get status
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingDisplay,MeetingEye 500/900,MeetingBar A10/A40/A50
发送格式 system get status\r\n
返回格式 system get status {"status":"sleeping"}\r\n
示例 Send:system get status \r\nReturn: system get status {"status":"sleeping"} \r\n
3. 设置系统状态
请求参数
名称 类型 取值范围 是否必须 参数说明
status string [sleeping,wake-up,reboot,reset] 是 系统状态sleeping:休眠wake-up:唤醒reboot:重启reset:恢复出厂
sn string 无 否 设备唯一标识sn
说明
system 指令 system set status {"status":"<value>",["sn":"<value>"]}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingDisplay,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect,UVC40, SmartVision 40AP08,AVBridge,CM20,CM50,CS10,CS10-D注意:1、Yealink RoomConnect/UVC40仅支持重启,恢复出厂2、仅Yealink RoomConnect支持传sn参数3、SmartVision 40支持重启4、AP08,AVBridge,CM20,CM50,CS10,CS10-D支持重启和恢复出厂
发送格式 system set status {"status":"wake-up",["sn":"506607D117000009"]} \r\n
返回格式 system set status {"status":"wake-up",["sn":"506607D117000009"]} \r\n
示例 带sn情况: Send:system set status {"status":"wake-up","sn":"506607D117000009"} \r\nReturn: system set status {"status":"wake-up","sn":"506607D117000009"} \r\n 不带sn情况:Send:system set status {"status":"wake-up"} \r\nReturn: system set status {"status":"wake-up"} \r\n
4. 设置日志服务器地址
请求参数
名称 类型 取值范围 是否必须 参数说明
enable int [0,1] 是 日志服务器功能开关1:启用0:关闭
facility int [0-23] 是 日志存储设备 0: 内核消息, 1: 用户消息 2: 邮件系统 3: 系统守护进程 4: 安全/授权消息 5: 系统内部生成信息 6: 打印子系统 7: 网络消息子系统 8: UUCP子系统 9: 时钟守护进程 10: 安全/授权消息 11: FTP守护进程 12: NTP子系统 13: 日志审计 14: 日志警告 15: 时钟守护进程 16: 本地使用0 17: 本地使用1 18: 本地使用2 19: 本地使用3 20: 本地使用4 21: 本地使用5 22: 本地使用6 23: 本地使用7
level int [1-7] 是 日志等级
transport-type int [0,1,2] 是 传输类型 0: UDP 1: TCP 2: TLS
port int 无 是 端口
server string 无 是 同步日志的服务器地址
说明
system 指令 system set log-server {"enable":<value>,"facility":<value>,"level":<value>,"transport-type":<value>,"port":<value>,"server":"<value>"}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingDisplay,MeetingEye 500/900,MeetingBar A10/A40/A50,UVC40注意:1、当关闭日志服务器时,可以不输入其他参数,否则必须携带参数2、建议使用参数:facility(16),level(6),transport-type(0)
发送格式 system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514, "facility":1, "level":6,"transport-type":2} \r\n
返回格式 system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514, "facility":1, "level":6,"transport-type":2} \r\n
示例 Send:system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514,"facility":1, "level":6,"transport-type":2}\r\n Return: system set log-server {"enable": 1,"server":"syslog.test.yealink.com", "port":514, "facility":1, "level":6,"transport-type":2}\r\n
5. 获取设备列表
返回参数
名称 类型 取值范围 备注
device-list device_info [] 无 设备信息列表
device_info
名称 类型 备注
model string 设备类型
firmware string 固件版本号
hardware string 硬件版本号
serialnumber string 设备sn号
macaddress string 设备mac地址
id int 设备标识(可用于设置或获取屏幕参数)
说明**
system 指令 system get devices
支持机型 Yealink RoomConnect,SmartVision 40,MeetingEye 500/900
发送格式 system get devices \r\n
返回格式 system get devices {"device-list": [{ "model":"UVC86", "firmware":"128.423.253.104", "hardware":"263.0.19.0.3.0.36", "macaddress":"00:15:65:00:00:00", "serialnumber":"506607D117000009", }, { "model":"UVC84", "firmware":"130.303.253.44", "hardware":"261.0.5.10.43.0.58", "macaddress":"00:24:13:00:00:00", "serialnumber":"803032E070000031", "id": 0 } ] }\r\n
示例 Send:system get devices \r\nReturn: system get devices {"device-list": [{ "model":"UVC86", "firmware":"128.423.253.104", "hardware":"263.0.19.0.3.0.36", "macaddress":"00:15:65:00:00:00", "serialnumber":"506607D117000009", }, { "model":"UVC84", "firmware":"130.303.253.44", "hardware":"261.0.5.10.43.0.58", "macaddress":"00:24:13:00:00:00", "serialnumber":"803032E070000031", "id": 0 } ] } \r\n
6. 获取工作时间
返回参数
名称 类型 取值范围 参数说明
value int >0 工作时长(以分钟为单位)
说明
system 指令 system get uptime
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingDisplay,MeetingEye 500/900,MeetingBar A10/A40/A50,SmartVision 40
发送格式 system get uptime\r\n
返回格式 system get uptime{"value":840}\r\n
示例 Send:system get uptime\r\nReturn: system get uptime{"value":840} \r\n
7. 获取CPU信息
返回参数
名称 类型 取值范围 参数说明
cpu-usage int [1~100] cpu占用率(以百分之一为单位)
cpu-temp int [-10,100] cpu温度,单位:℃
说明
system 指令 system get cpu-info
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingDisplay,MeetingEye 500/900,MeetingBar A10/A40/A50, SmartVision 40 说明:1、SmartVision40支持cpu-temp
发送格式 system get cpu-info\r\n
返回格式 system get cpu-info{"cpu-usage":25}\r\n
示例 Send:system get cpu-info\r\nReturn: system get cpu-info{"cpu-usage":25} \r\n **SmartVision 40:**Send: system get cpu-info\r\nReturn:``system get cpu-info {"cpu-usage":11,"cpu-temp":69}\r\n
8.获取系统硬件信息
返回参数
名称 类型 参数说明
model string 设备机型
firmware string 软件版本号
hardware string 硬件版本号
serialnumber string 设备sn号
macaddress string 设备mac地址
cc-version string 中控版本号
vendor string 设备厂商名称
说明
system 指令 system get sys-info
支持机型 SmartVision 40
发送格式 system get sys-info\r\n
返回格式 system get sys-info {"model":"SmartVision40","firmware":"286.0.253.1068","hardware":"286.0.16.0.0.0.0","serialnumber":"506656F110000056","macaddress":"24:9a:d8:db:a2:3b","cc-version":"1.0.0.16","vendor":"Yealink"}
示例 Send:<br> system get sys-info <br> Return:<br> system get sys-info{"model":"SmartVision40","firmware":"286.0.253.1068","hardware":"286.0.16.0.0.0.0","serialnumber":"506656F110000056","macaddress":"24:9a:d8:db:a2:3b","cc-version":"1.0.0.16","vendor":"Yealink"}\r\n
9. 读取usb接口连接状态
返回参数
名称 类型 取值范围 说明
status string [on,off] 连接状态:on:已连接off:未连接
说明
system指令 system get pc-connect-status
支持机型 SmartVision 40
发送格式 system get pc-connect-status\r\n
返回格式 system get pc-connect-status {"status":"on"}\r\n
示例 Send:system get pc-connect-status\r\nReturn:``system get pc-connect-status {"status":"on"}\r\n
10. 读取内存信息
返回参数
名称 类型 取值范围 说明
memory-usage int [0,100] 内存使用率
total-memory int >0 总内存,单位Mb
free-memory int >=0 未使用内存,单位Mb
used-memory int >0 已使用内存,单位Mb
说明
sytem指令 system get memory-info
支持机型 Smartvision 40
发送格式 system get memory-info\r\n
返回格式 system get memory-info {"memory-usage":20,"total-memory":953,"free-memory":758,"used-memory":195}\r\n
示例 Send:<br>system get memory-info\r\n Return:system get memory-info {"memory-usage":20,"total-memory":953,"free-memory":758,"used-memory":195}\r\n
11. 读取设备状态
返回参数
名称 类型 取值范围 说明
normal string [true,false] 设备是否正常 normal = !(memorytoohigh|| cpuusagetoohigh)
memorytoohigh string [true,false] 内存占用是否过高,默认大于80返回true
cpuusagetoohigh string [true,false] cpu占用是否过高,默认大于80返回true
说明
system指令 system get alert-status
支持机型 SmartVision 40
发送格式 system get alert-status\r\n
返回格式 system get alert-status {"normal":"true","memorytoohigh":"false","cpuusagetoohigh":"false"}\r\n
示例 Send:system get alert-status\r\nReturn:``system get alert-status {"normal":"true","memorytoohigh":"false","cpuusagetoohigh":"false"}\r\n
12. 设置告警信息规则
请求参数
参数 类型 取值范围 说明
cpu int [0,100] 设置cpu过高的阈值,单位:%,默认为80,请求参数为取值范围之外的数值时,设置为默认值
memory int [0,100] 设置memory过高的阈值,单位:%,默认为80,请求参数为取值范围之外的数值时,设置为默认值
说明
system指令 system set alert-rules {"cpu":90,"memory":70}
支持机型 SmartVision 40
发送格式 system set alert-rules {"cpu":90,"memory":70}\r\n
返回格式 system set alert-rules {"cpu":90,"memory":70}\r\n
示例 Send:system set alert-rules {"cpu":90,"memory":70}\r\nReturn:``system set alert-rules {"cpu":90,"memory":70}\r\n
13. 获取当下时间
返回参数
参数 类型 取值范围 说明
value int NA linux时间戳
说明
system指令 system get current-time
支持机型 SmartVision 40
发送格式 system get current-time\r\n
返回格式 system get current-time {"value":1725459796}\r\n
示例 Send:system get current-time\r\nReturn:``:system get current-time {"value":1725459796}\r\n
14. 获取硬件信息
返回参数
名称 类型 取值范围 参数说明
» hardware_list body [object] 是
»» type body string 是
»» index body [string] 否
说明
system 指令 system get hardware
支持机型 AP08
发送格式 system get hardware{"hal_list": [{"type": "<value>","mode": "<value>","index": [<value>]}]}\r\n
返回格式 system get hardware{"hal_list":[{"type":"<value>","mode":"<value>","status":[{"index":<value>,"status":"<value>"}]}]}\r\n
示例 Send:system get hardware{"hal_list":[{"type":"gpio","mode":"input","index":[1,2]}]}\r\nReturn: system get hardware{"hal_list":[{"type":"gpio","mode":"input","status":[{"index":1,"status":"high"},{"index":2,"status":"low"}]}]}\r\n
15. 获取BYOD-EXTENDER的状态
返回参数
名称 类型 取值范围 说明
status string [available,in_use, disconnected, unknown] USB连接状态:available: MVC-BYOD-Extender连接主机,但未使用in_use: MVC-BYOD-Extender使用中disconnected: MVC-BYOD-Extender未连接unknown: 未知状态
说明
system 指令 byod get extender-status
支持机型 Yealink RoomConnect
发送格式 byod get extender-status {"sn":"806009F040000357"}\r\n
返回格式 byod get extender-status {"status":"unknown"}\r\n
示例 Send:byod get extender-status {"sn":"806009F040000357"}\r\nReturn: byod get extender-status {"status":"unknown"}\r\n
16. 设置设备定位开关
请求参数
名称 类型 取值范围 是否必须 参数说明
status string {on,off} 是 on:打开设备定位off:关闭设备定位
说明
system指令 system set locating-status
支持机型 AP08,AVBridge,CM20,CM50,CS10,CS10-D
发送格式 system set locating-status {"status": "on"}\r\n
返回格式 system set locating-status {"status": "on"}\r\n
示例 Send:system set locating-status {"status": "on"}\r\nReturn:system set locating-status {"status": "on"}\r\n
17. 设置LED灯开关
请求参数
名称 类型 取值范围 是否必须 参数说明
enable string {on, off} 是 on: 打开LED灯off: 关闭LED灯注意:打开及关闭的都是对应事件的LED灯
说明
system指令 system set led-preset-status
支持机型 CM20、CM50、CS10、CS10-D
发送格式 system set led-preset-status {"enable": "on"}\r\n
返回格式 system set led-preset-status {"enable": "on"}\r\n
示例 Send:system set led-preset-status {"enable": "on"}\r\nReturn:system set led-preset-status {"enable": "on"}\r\n
18. 获取LED灯开关状态
返回参数
名称 类型 取值范围 参数说明
enable string {on,off} on:开启状态off:关闭状态
说明
system指令 system get led-preset enable
支持机型 CM20、CM50、CS10、CS10-D
发送格式 system get led-preset enable\r\n
返回格式 system get led-preset enable {"enbale":"off"}\r\n
示例 Send:system get led-preset enable\r\nReturn:system get led-preset enable {"enbale":"off"}\r\n
19. 设置LED灯事件的颜色
请求参数
名称 类型 取值范围 是否必须 参数说明
event string {mute,unmute} 是 灯事件
color string {red,green,orange,#xxxxxx} 是 对应事件的灯的颜色
说明
system system set led-preset config
支持机型 CM20、CM50、CS10、CS10-D
发送格式 system set led-preset config {"event":"mute", "color":"red"}\r\n
返回格式 system set led-preset config {"event":"mute", "color":"red"}\r\n
示例 Send:system set led-preset config {"event":"mute", "color":"red"}\r\nReturn:system set led-preset config {"event":"mute", "color":"red"}\r\n
20. 获取LED灯事件的颜色
请求参数
名称 类型 取值范围 是否必须 参数说明
event string {mute, unmute} 是 要获取灯颜色的事件
返回参数
名称 类型 取值范围 参数说明
event string {mute, unmute} -
color string {red, green, orange,#xxxxxx} 灯的颜色
说明
system语法 system get led-preset config
支持机型 CM20、CM50、CS10、CS10-D
发送格式 system get led-preset config {“event":"unmute"}\r\n
返回格式 system get led-preset config {“event":"unmute","color":"#856974"}\r\n
示例 Send:system get led-preset config {“event":"unmute"}\r\nReturn:system get led-preset config {“event":"unmute","color":"#856974"}\r\n
button语法
1. 遥控器按键操作
请求参数
名称 类型 取值范围 是否必须 参数说明
key string [power,F1,F2,F3,volume+,volume-,zoom+,zoom-,up,down,right,left,select,mute,back,call,delete,hangup,0~9*#] 是 遥控器按键名
说明
button 指令 button {"key": "<value>"}
支持机型 MeetingEye 500,UVC40,SamrtVision 40注意:1、UVC40机型仅支持volume+和volume-2、SmartVision 40仅支持volume+和volume-
发送格式 button {"key":"power"}\r\n
返回格式 button {"key":"power"}\r\n
示例 Send:button {"key":"power"} \r\n Return: button {"key":"power"} \r\n
camera语法
1. 控制摄像头移动
请求参数
名称 类型 取值范围 是否必须 参数说明
direction string [up,down,left,right,stop] 是 摄像头移动方向up:控制摄像头方向向上改变down:控制摄像头方向向下改变left:控制摄像头方向向左改变right:控制摄像头方向向右改变stop:控制摄像头停止改变
sn string 无 否 摄像头唯一标识注意:如果指令请求时带了sn参数,代表控制的是指定sn的设备,否则控制的是摄像机列表第一个设备
说明
camera 指令 camera move {"direction":"<value>",["sn":"<value>"]}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect,UVC40, UVC85, UVC86, SmartVision 40, AVHub, SmartVision 80注意:1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro,MeetingEye 500/900仅有一个摄像机时,可以选填sn参数,如果存在多个摄像头时,需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数
发送格式 camera move {"direction":"up",["sn":"506607D117000009"]} \r\n
返回格式 camera move {"direction":"up",["sn":"506607D117000009"]} \r\n
示例 带sn参数情况: Send:camera move {"direction":"up","sn":"506607D117000009"} \r\n Return: camera move {"direction":"up","sn":"506607D117000009"} \r\n 不带sn参数情况: Send:camera move {"direction":"up"} \r\n Return: camera move {"direction":"up"} \r\n
2. 控制摄像头焦距
请求参数
名称 类型 取值范围 是否必须 参数说明
direction string [in,out,stop] 是 摄像头焦距方向in:放大out:缩小stop:控制摄像头停止改变
sn string 无 否 摄像头唯一标识注意:如果指令请求时带了sn参数,代表控制的是指定sn的设备,否则控制的是摄像机列表第一个设备
说明
camera 指令 camera zoom {"direction":"<value>",["sn":"<value>"]}
功能说明 控制摄像头焦距
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect,UVC40, UVC85,UVC86, SmartVision 40, AVHub, SmartVision 80注意:1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro,MeetingEye 500/900仅有一个摄像机时,可以选填sn参数,如果存在多个摄像头时,需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数
发送格式 camera zoom {"direction":"in",["sn":"506607D117000009"]} \r\n
返回格式 camera zoom {"direction":"in",["sn":"506607D117000009"]} \r\n
示例 带sn参数情况: Send:camera zoom {"direction":"in","sn":"506607D117000009"} \r\n Return: camera zoom {"direction":"in","sn":"506607D117000009"} \r\n不带sn参数情况: Send:camera zoom {"direction":"in"} Return: camera zoom {"direction":"in"} \r\n
3. 获取摄像头位置
请求参数
名称 类型 取值范围 是否必须 参数说明
sn string 无 否 摄像头唯一标识注意:如果指令请求时带了sn参数,代表获取的是指定sn的设备,否则获取的是摄像机列表第一个设备
返回参数
名称 类型 取值范围 参数说明
x double 参考范围:[0~3360] 存在机型差异,以实际获取为准 x轴坐标注意:受焦距值限制
y double 参考范围:[0~1890] 存在机型差异,以实际获取为准 y轴坐标注意:受焦距值限制
z double 参考范围:[-1890~0] 存在机型差异,以实际获取为准 焦距
说明
camera 指令 camera get position {["sn":"<value>"]}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect,UVC40, UVC85, UVC86,SmartVision 40, AVHub, SmartVision 80注意:1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro,MeetingEye 500/900仅有一个摄像机时,可以选填sn参数,如果存在多个摄像头时,需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数
发送格式 camera get position {["sn":"506607D117000009"]} r\n
返回格式 camera get position {"x":1910.0,"y":1060.0,"z":50.5}\r\n
示例 带sn参数情况: Send:camera get position {"sn":"506607D117000009"} \r\n Return: camera get position {"x":1910.0,"y":1060.0,"z":50.5} \r\n不带sn参数情况: Send:camera get position \r\n Return: camera get position {"x":1910.0,"y":1060.0,"z":50.5} \r\n
4. 设置摄像头位置
请求参数
名称 类型 取值范围 是否必须 参数说明
sn string 无 否 摄像头唯一标识注意:如果指令请求时带了sn参数,代表获取的是指定sn的设备,否则获取的是摄像机列表第一个设备
x double 参考范围:[0~3360] 存在机型差异,以实际获取为准 是 x轴坐标注意:受焦距值限制,入参为double类型,即使是整数值也需要带小数点,否则无法成功执行
y double 参考范围:[0~1890] 存在机型差异,以实际获取为准 是 y轴坐标注意:受焦距值限制,入参为double类型,即使是整数值也需要带小数点,否则无法成功执行
z double 参考范围:[-1890~0] 存在机型差异,以实际获取为准 是 焦距注意:入参为double类型,即使是整数值也需要带小数点,否则无法成功执行
说明
camera 指令 camera set position {"x":<value>,"y":<value>,"z":<value>,["sn":"<value>"]}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect,UVC40, UVC85,UVC86, SmartVision 40, AVHub, SmartVision 80注意:1、Yealink RoomConnect和AVHub使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数3、MeetingBoard 65/86/75-Pro,MeetingEye 500/900仅有一个摄像机时,可以选填sn参数,如果存在多个摄像头时,需要使用sn指定对应摄像头进行正确操作4、UVC设备和SmartVision设备不需要携带sn参数
发送格式 camera set position {"x":1910.0,"y":1060.0,"z":50.5,["sn":"506607D117000009"]} r\n
返回格式 camera set position {"x":1910.0,"y":1060.0,"z":50.5,["sn":"506607D117000009"]} \r\n
示例 带sn参数情况: Send:camera set position {"x":1910.0,"y":1060.0,"z":50.5,"sn":"506607D117000009"} \r\n Return: camera set position {"x":1910.0,"y":1060.0,"z":50.5,"sn":"506607D117000009"} \r\n不带sn参数情况: Send:camera set position {"x":1910.0,"y":1060.0,"z":50.5} \r\n Return: camera set position {"x":1910.0,"y":1060.0,"z":50.5} \r\n
5. 获取摄像头列表
返回参数
名称 类型 参数说明
sn-list string 摄像头sn列表
说明
camera 指令 camera get list
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect, AVHub
发送格式 camera get list\r\n
返回格式 camera get list {"sn-list":["803032E070000031"]} \r\n
示例 Send:camera get list \r\n Return: camera get list {"sn-list":["803032E070000031"]} \r\n
6. 获取摄像头详细信息
请求参数
名称 类型 取值范围 是否必须 参数说明
sn string 无 是 摄像头唯一标识
返回参数
名称 类型 参数说明
ip string 摄像头ip
mac string 摄像头mac地址
name string 摄像头名称
firmware string 摄像头软件版本
hardware string 摄像头硬件版本
spec string 摄像头规格
model string 摄像头机型
sn string 摄像头sn
说明
camera 指令 camera get detail {"sn":"<value>"}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect
发送格式 camera get detail {"sn":"506607D117000009"} r\n
返回格式 camera get detial {"ip":"169.254.1.150","mac":"80:5E:C0:60:00:62","name":"Yealink UVC84 -1","firmware":"262.302.5.5","hardware":"262.0.96.0.0.0.0","spec":"PTZ 12x Optical Zoom","model":"UVC84","sn":"8703018090000132"}\r\n
示例 Send:camera get detail {"sn":"506607D117000009"} \r\n Return: camera get detial {"ip":"169.254.1.150","mac":"80:5E:C0:60:00:62","name":"Yealink UVC84 -1","firmware":"262.302.5.5","hardware":"262.0.96.0.0.0.0","spec":"PTZ 12x Optical Zoom","model":"UVC84","sn":"8703018090000132"} \r\n
7. 设置摄像头AI模式
请求参数
名称 类型 取值范围 是否必须 参数说明
type string [ptz,auto-frame,speaker-tracking,view-cropping,multi-screen,smart-gallery,pip,multi-pip,presenter-tracking,intellifocus,virtual-background,multi-stream-intelliframe] 是 模式类型ptz:手动控制auto-frame:自动框景speaker-tracking:语音追踪view-cropping:视角裁剪multi-screen:多分屏smart-gallery:智能画廊/多流模式pip:画中画multi-pip:多分屏+画中画presenter-tracking:跟拍模式intellifocus:多发言者跟踪virtual-background:虚拟背景multi-stream-intelliframe:多流Intelliframe
sn string 无 否 摄像头唯一标识注意:如果指令请求时带了sn参数,代表获取的是指定sn的设备,否则获取的是摄像机列表第一个设备
说明
camera 指令 camera set ai-mode {"type":"<value>",["sn":"<value>"]}
支持机型 MeetingBoard 65/86/65 Pro/75 Pro/86 Pro,MeetingEye 500/900,MeetingBar A10/A40/A50,Yealink RoomConnect,UVC40, UVC85,UVC86,SmartVision 40, AVHub, SmartVision 80注意:1、Yealink RoomConnect使用该指令sn为必带参数2、MeetingBar A10/A40/A50可选填sn参数,A10仅支持"ptz, auto-frame, speaker-tracking, view-cropping, multi-screen, pip"模式3、MeetingBoard 65/86/75-Pro,MeetingEye