- 设置无线参数
- 设置无线参数(无需签名校验)
- 获取无线参数
- 获取无线扫描AP列表
- 调焦
- 手动聚焦
- 自动聚焦
- 调焦聚焦复位
- 获取调焦和聚焦参数
- 设置夜视模式
- 获取夜视模式
- 设置动态侦测
- 获取动态侦测参数
- 设置IPC名称
- 获取IPC名称
- 设置指示灯开关
- 获取指示灯开关
- 设置画面旋转角度
- 获取画面旋转角度
- 获取支持的画面旋转角度
- 格式化存储卡
- 获取存储卡状态
1. 设置无线参数
描述
配置IPC连接AP的SSID和密码。
请求地址
https://192.168.0.1/openapi/config/setWifiConf,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
ssid | string | 要连接的AP的无线名称,也即SSID,不能超过32个字符 | Y | WeWork |
password | string | 要连接的AP的密码,如果无加密,填空即可,不支持WEP,不能超过64个字符 | Y |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/setWifiConf HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& ssid=sunmi_ipc&password=1234567890 |
返回示例
{ “code”: 0 } |
2. 设置无线参数(无需签名校验)
描述
设备激活前无需签名校验配置 IPC 连接 AP 的 SSID 和密码;设备激活后此接口即失效。
请求地址
https://192.168.0.1/openapi/config/setWifiConfWithoutAuth,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有公共参数。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
ssid | string | 要连接的AP的无线名称,也即SSID,不能超过32个字符 | Y | WeWork |
password | string | 要连接的AP的密码,如果无加密,填空即可,不支持WEP,不能超过64个字符 | Y |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/setWifiConfWithoutAuth HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded ssid=sunmi_ipc&password=1234567890 |
返回示例
{ “code”: 0 } |
3. 获取无线参数
描述
获取当前IPC的无线参数。
请求地址
https://192.168.0.1/openapi/config/getWifiConf,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果,见错误码的描述 |
ssid | string | 当前连接的SSID |
password | string | 当前SSID的密码 |
请求示例
POST /openapi/config/getWifiConf HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “ssid”: “SUNMI_IPC”, “password”: “1234567890” } } |
4. 获取无线扫描AP列表
描述
获取当前IPC无线扫描到的AP列表。
请求地址
https://192.168.0.1/openapi/config/getApList,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数 ,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果,见错误码的描述 |
num | int | 返回扫描到的AP个数 |
ssid | string | 扫描到AP的ssid |
key_mgmt | string | 扫描到AP的加密方式 |
请求示例
POST /openapi/config/getApList HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”:0, “data”: { “num”: 3, “ap_list”:[ { “ssid”: “TP-LINK_3475”, “key_mgmt”: “WPA-PSK” }, { “ssid”: “WeWork”, “key_mgmt”: “WPA-PSK” }, { “ssid”: “WeWorkCorp”, “key_mgmt”: “WPA-PSK” } ] } } |
5. 调焦
描述
用户根据实际环境,调节镜头的焦距,使得拍摄的画面放大或者缩小。
请求地址
https://192.168.0.1/openapi/config/setZoom,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
zoom | int | 焦距大小,合理范围是[0, 500] | Y | 200 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/setZoom HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& zoom=100 |
返回示例
{ “code”: 0 } |
6. 手动聚焦
描述
调焦后镜头会自动聚焦,如果对自动聚焦效果不满意,可以调用此接口手动进行微调。
请求地址
https://192.168.0.1/openapi/config/manualFocus,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
focus | int | 聚焦大小,合理范围是[0, 780] | Y | 200 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/manualFocus HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& focus=100 |
返回示例
{ “code”: 0 } |
7. 自动聚焦
描述
设置焦距后,IPC会自动聚焦,可以设置自动聚焦以哪个点(坐标)为中心进行。
请求地址
https://192.168.0.1/openapi/config/autoFocus,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
focus_x | int | 聚焦点在x方向的像素百分比,合理范围是[0, 100] | Y | 50 |
focus_y | int | 聚焦点在y方向的像素百分比,合理范围是[0, 100] | Y | 50 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/autoFocus HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& focus_x=50&focus_y=50 |
返回示例
{ “code”: 0 } |
8. 调焦聚焦复位
描述
用户可以通过此接口直接复位焦距和聚焦的参数。
请求地址
https://192.168.0.1/openapi/config/resetZoomFocus,192.168.0.1需要替换成实际的IPC地址。
请求参数
此接口没有私有参数,公共参数见HTTP接口调用。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/resetZoomFocus HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0 } |
9. 获取调焦和聚焦参数
描述
获取当前IPC镜头的调焦聚焦参数。
请求地址
https://192.168.0.1/openapi/config/getZoomFocusConf,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果,见错误码的描述 |
max_zoom | int | 能够调整的焦距最大值 |
max_focus | int | 能够调整的聚焦最大值 |
zoom | int | 当前的焦距 |
focus | int | 当前的聚焦值 |
focus_x | int | 聚焦点在x方向的像素百分比 |
focus_y | int | 聚焦点在y方向的像素百分比 |
请求示例
POST /openapi/config/getZoomFocusConf HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “zoom”: 0, “max_zoom”: 500, “max_focus”: 780, “focus”: 0, “focused_x”: 50, “focused_y”: 50 } } |
10. 设置夜视模式
描述
配置镜头的夜视模式。
请求地址
https://192.168.0.1/openapi/config/setIrMode,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
irmode | int | 0表示关闭,1表示开启,2表示自动。一般选2。 | Y | 2 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/setIrMode HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& irmode=1 |
返回示例
{ “code”: 0 } |
11. 获取夜视模式
描述
获取当前IPC的夜视模式。
请求地址
https://192.168.0.1/openapi/config/getIrMode,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果,见错误码的描述 |
irmode | int | 返回码成功才会有此字段,当前夜视模式 |
请求示例
POST /openapi/config/getIrMode HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “irmode”: 1 } } |
12. 设置动态侦测
描述
IPC的动态侦测支持根据画面变化和声音变化灵敏度来检测和报警,通过本API可以设置相关灵敏度和动态侦测的时间。
请求地址
https://192.168.0.1/openapi/config/setDynamicDetect,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
---|---|---|---|---|
motion_level | int | 范围[0, 3],0表示关闭,数值越大,越灵敏。 | Y | 2 |
audio_level | int | 范围[0, 3],0表示关闭,数值越大,越灵敏。 | Y | 2 |
weekday | int | 以周为一个循环,用0xYY来表示选择哪一天,具体是0x80直接表示724小时,其余的, 以7bit来表示哪一天被选上,0x01表示选择周一,0x02表示选择周二,0x40表示选择 周天,0x7f表示选择一个礼拜的7天,与0x80的区别只是0x80直接默认724小时,而 0x7f选了7天后,还可以设置具体的开始时间和结束时间。 | Y | 128(0x80 的十进制) |
start_time | long | 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值, 60表示01:00,121表示02:01,依次类推。范围[0,1440] | Y | 200 |
stop_time | long | 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值, 60表示01:00,121表示02:01,依次类推。范围[0,1440] | Y | 400 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/setDynamicDetect HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K motion_level=1&audio_level=1&weekday=128&start_time=1260&stop_time=540 |
返回示例
{ “code”: 0 } |
13. 获取动态侦测参数
描述
获取当前IPC镜头的动态侦测参数。
请求地址
https://192.168.0.1/openapi/config/getDynamicDetect,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果,见错误码的描述 |
motion_level | int | 范围[0, 3],0表示关闭,数值越大,越灵敏。 |
audio_level | int | 范围[0, 3],0表示关闭,数值越大,越灵敏。 |
weekday | int | 以周为一个循环,用0xYY来表示选择哪一天,具体是0x80直接表示724小时,其余的, 以7bit来表示哪一天被选上,0x01表示选择周一,0x02表示选择周二,0x40表示选择 周天,0x7f表示选择一个礼拜的7天,与0x80的区别只是0x80直接默认724小时,而 0x7f选了7天后,还可以设置具体的开始时间和结束时间。 |
start_time | long | 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值, 60表示01:00,121表示02:01,依次类推。范围[0,1440] |
stop_time | long | 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值, 60表示01:00,121表示02:01,依次类推。范围[0,1440] |
请求示例
POST /openapi/config/getDynamicDetect HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “motion_level”: 1, “audio_level”: 1, “weekday”: 7, “start_time”: 120 “stop_time”: 240, } } |
14. 设置IPC名称
描述
用户可以设置IPC的名称,以便区分不同的IPC设备。
请求地址
https://192.168.0.1/openapi/config/updateName,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
name | string | 36个字符以内,12汉字以内 | Y | 示例名称 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果,见错误码的描述 |
请求示例
POST /openapi/config/updateName HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& name=front_door |
返回示例
{ “code”: 0 } |
15. 获取IPC名称
描述
获取当前IPC的名称。
请求地址
https://192.168.0.1/openapi/config/getName,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码, 表示操作的结果,见错误码的描述 |
name | int | IPC名称 |
请求示例
POST /openapi/config/getName HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “name”: “front_door” } } |
16. 设置指示灯开关
描述
设置指示灯是否需要关闭。
请求地址
https://192.168.0.1/openapi/config/setLedSwitch,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
led_switch | int | 0表示关闭指示灯,1表示开启指示灯,即可以亮 | Y | 1 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果, 见错误码的描述 |
请求示例
POST /openapi/config/setLedSwitch HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& led_switch=1 |
返回示例
{ “code”: 0 } |
17. 获取指示灯开关
描述
获取当前IPC的指示灯状态。
请求地址
https://192.168.0.1/openapi/config/getLedSwitch,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果, 见错误码的描述 |
led_switch | int | 0表示关闭指示灯,1表示开启指示灯,即可以亮 |
请求示例
POST /openapi/config/getLedSwitch HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “led_switch”: 1 } } |
18. 设置画面旋转角度
描述
设置拍摄的画面是否需要旋转一定角度,可用的旋转角度可通过获取支持的画面旋转角度获取到。
请求地址
https://192.168.0.1/openapi/config/setRotation,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见HTTP接口调用。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
rotation | int | 画面旋转角度 | Y | 180 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果, 见错误码的描述 |
请求示例
POST /openapi/config/setRotation HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& rotation=180 |
返回示例
{ “code”: 0 } |
19. 获取画面旋转角度
描述
获取当前IPC当前的画面旋转角度。
请求地址
https://192.168.0.1/openapi/config/getRotation,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果, 见错误码的描述 |
rotation | int | 当前画面的旋转角度 |
请求示例
POST /openapi/config/getRotation HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “rotation”: 180 } } |
20. 获取支持的画面旋转角度
描述
获取当前IPC设备支持的画面旋转角度。
请求地址
https://192.168.0.1/openapi/config/getRotationAngles,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果, 见错误码的描述 |
angles | string list | 当前IPC设备支持的画面旋转角度列表 |
请求示例
POST /openapi/config/getRotation HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “angles”: [ “0”, “90”, “180”, “270” ] } } |
21. 格式化存储卡
描述
格式化插入IPC里面的存储卡。
请求地址
https://192.168.0.1/openapi/config/formatMemoryCard,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果, 见错误码的描述 |
请求示例
POST /openapi/config/formatMemoryCard HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
- 返回示例
{ “code”: 0 } |
22. 获取存储卡状态
描述
获取IPC上存储卡状态
请求地址
https://192.168.0.1/openapi/config/getMemoryCardStatus,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见HTTP接口调用。
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,操作的结果, 见错误码的描述 |
status | int | 0表示未插入SD卡;1表示已插入SD卡但未初始化;2表示SD卡已插入且正常;3表示SD卡无法识别 |
请求示例
POST /openapi/config/getMemoryCardStatus HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “code”: 0, “data”: { “status”: 2 } } |