BasicConfig 基本配置接口

  1. 设置无线参数
  2. 设置无线参数(无需签名校验)
  3. 获取无线参数
  4. 获取无线扫描AP列表
  5. 获取无线扫描AP列表 (无需签名校验)
  6. 获取IP参数
  7. 设置IP参数
  8. 调焦
  9. 手动聚焦
  10. 自动聚焦
  11. 调焦聚焦复位
  12. 获取调焦和聚焦参数
  13. 设置夜视模式
  14. 获取夜视模式
  15. 设置动态侦测
  16. 获取动态侦测参数
  17. 设置IPC名称
  18. 获取IPC名称
  19. 设置指示灯开关
  20. 获取指示灯开关
  21. 设置画面旋转角度
  22. 获取画面旋转角度
  23. 获取支持的画面旋转角度
  24. 格式化存储卡
  25. 获取存储卡状态

1. 设置无线参数

描述

配置IPC连接AP的SSID和密码。

接口

public void setWifiConf(String deviceId, String ssid, String password, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
ssid要连接的AP的无线名称,也即SSID,不能超过32个字符WeWork
password要连接的AP的密码,如果无加密,填空即可,不支持WEP,不能超过64个字符12345678
callback调用结果

响应参数

字段名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、100、101,见错误码的描述

2. 设置无线参数(无需签名校验)

描述

设备激活前无需签名校验配置 IPC 连接 AP 的 SSID 和密码;设备激活后此接口即失效。

接口

public void setWifiConfWithoutAuth(String deviceId, String ssid, String password, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
ssid要连接的AP的无线名称,也即SSID,不能超过32个字符WeWork
password要连接的AP的密码,如果无加密,填空即可,不支持WEP,不能超过64个字符12345678
callback调用结果

响应参数

字段名称类型描述
codeint返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、100、101,见错误码的描述

3. 获取无线参数

描述

获取当前IPC的无线参数。

接口

public void getWifiConf(String deviceId, RPCCallback‹RPCResponse‹WifiConfBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

字段名称类型描述
codeint返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、100、101,见错误码的描述
dataWifiConfBean返回码成功才会有此字段,详见RPCResponse.WifiConfBean

回调示例

后续接口回调实现与此类似,后续不再进行说明。

new RPCCallback‹RPCResponse‹WifiConfBean››() {
    @Override
    public void onComplete(RPCResponse‹WifiConfBean› result) {
        if (result.code() == RPCErrorCode.SUCCESS) {
            WifiConfBean wifiConf = result.data();
        } else {
            shotToast("response.code: " + result.code());
        }
    }

    @Override
    public void onAbort(int httpStatus) {
        shotToast("http failed, status: " + httpStatus);
    }

    @Override
    public void onException(Throwable t) {
        shotToast("Exception: " + t.getMessage());
    }
});

4. 获取无线扫描AP列表

描述

获取当前IPC无线扫描到的AP列表。

接口

public void getApList(String deviceId, RPCCallback‹RPCResponse‹IpcApBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

字段名称 类型 描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、100、101,见错误码的描述
dataIpcApBean返回码成功才会有此字段,详见RPCResponse.IpcApBean

5. 获取无线扫描AP列表 (无需签名校验)

描述

获取当前IPC无线扫描到的AP列表,设备激活后此接口失效。

接口

public void getApListWithoutAuth(String deviceId, RPCCallback‹RPCResponse‹IpcApBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

字段名称类型 描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、100、101,见错误码的描述
dataIpcApBean返回码成功才会有此字段,详见RPCResponse.IpcApBean

6. 获取IP参数

描述

本接口用于获取IPC的IP地址获取方式。

接口

public void getIpConfiguration(String deviceId, RPCCallback‹RPCResponse‹IpConfigBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
dataIpConfigBean返回码成功才会有此字段,详见RPCResponse.IpConfigBean

7. 设置IP参数

描述

本接口用于设置IPC的IP地址获取方式。

接口

public void setIpConfiguration(String deviceId, HashMap‹String, String› options, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
options可设置的动态侦测的参数集合见下表option说明
callback调用结果

option说明

参数名称 类型 描述 是否必须 示例
protoString获取IP方式, dhcp或者static Y static
ipaddrString 范围[0, 3],0表示关闭,数值越大,越灵敏。 N192.168.1.102
netmaskString 子网掩码 N 255.255.255.0
gatewayString 网关 N 192.168.1.1
dns1 String dns服务器地址 N 202.96.128.86
dns2String dns服务器地址 N202.96.134.166

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述

8. 调焦

描述

用户根据实际环境,调节镜头的焦距,使得拍摄的画面放大或者缩小。所有的调焦、聚焦等接口仅变焦镜头支持,目前仅商米AI识客摄像机支持变焦镜头。

接口

public void setZoom(String deviceId, int zoom, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
zoom焦距大小,合理范围是[0, 500]200
callback调用结果

响应参数

字段名称类型描述
codeint返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、110,见错误码的描述

9. 手动聚焦

描述

调焦后镜头会自动聚焦,如果对自动聚焦效果不满意,可以调用此接口手动进行微调。

接口

public void manualFocus(String deviceId, int focus, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
focus聚焦大小,合理范围是[0, 780]200
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、111,见错误码的描述

10. 自动聚焦

描述

设置焦距后,IPC会自动聚焦,可以设置自动聚焦以哪个点(坐标)为中心进行。

接口

public void autoFocus(String deviceId, int focus_x, int focus_y, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述 示例
deviceIdIPC序列号C201D98T00094
focus_x 聚焦点在x方向的像素百分比,合理范围是[0, 100] 50
focus_y 聚焦点在y方向的像素百分比,合理范围是[0, 100] 50
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、112,见错误码的描述

11. 调焦聚焦复位

描述

用户可以通过此接口直接复位焦距和聚焦的参数。

接口

public void resetZoomFocus(String deviceId, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述

12. 获取调焦和聚焦参数

描述

获取当前IPC镜头的调焦聚焦参数。

接口

public void getZoomFocusConf(String deviceId, RPCCallback‹RPCResponse‹ZoomFocusBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
dataZoomFocusBean返回码成功才会有此字段,详见RPCResponse.ZoomFocusBean

13. 设置夜视模式

描述

配置镜头的夜视模式。

接口

public void setIrMode(String deviceId, int irmode, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述 示例
deviceIdIPC序列号C201D98T00094
irmode 0表示关闭,1表示开启,2表示自动。一般选2。 2
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、113,见错误码的描述

14. 获取夜视模式

描述

获取当前IPC的夜视模式。

接口

public void getIrMode(String deviceId, RPCCallback‹RPCResponse‹IrSettingBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
dataIrSettingBean返回码成功才会有此字段,详见RPCResponse.IrSettingBean

15. 设置动态侦测

描述

IPC的动态侦测支持根据画面变化和声音变化灵敏度来检测和报警,通过本API可以设置相关灵敏度和动态侦测的时间。

接口

public void setDynamicDetect(String deviceId, HashMap‹String, String› options, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
options可设置的动态侦测的参数集合见下表option说明
callback调用结果

option说明

参数名称 类型 描述 是否必须 示例
motion_level int范围[0, 3],0表示关闭,数值越大,越灵敏。 Y 2
audio_level int 范围[0, 3],0表示关闭,数值越大,越灵敏。 Y 2
weekday int 以周为一个循环,用0xYY来表示选择哪一天,具体是0x80直接表示7×24小时,其余的,
以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 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述

16. 获取动态侦测参数

描述

获取当前IPC镜头的动态侦测参数。

接口

public void getDynamicDetect(String deviceId, RPCCallback‹RPCResponse‹DynamicDetectBean›› callback);

参数说明

本接口没有私有参数,公共参数见HTTP接口调用

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
dataDynamicDetectBean返回码成功才会有此字段,详见RPCResponse.DynamicDetectBean

17. 设置IPC名称

描述

用户可以设置IPC的名称,以便区分不同的IPC设备。

接口

public void updateName(String deviceId, String name, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述 示例
deviceIdIPC序列号C201D98T00094
name 36个字符以内,12汉字以内 示例名称
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、118,见错误码的描述

18. 获取IPC名称

描述

获取当前IPC的名称。

接口

public void getName(String deviceId, RPCCallback‹RPCResponse‹IPCNameBean›› callback);

参数说明

本接口没有私有参数,公共参数见HTTP接口调用

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
dataIPCNameBean 返回码成功才会有此字段,详见RPCResponse.IPCNameBean

19. 设置指示灯开关

描述

设置指示灯是否需要关闭。

接口

public void setLedSwitch(String deviceId, int ledSwitch, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述 示例
deviceIdIPC序列号C201D98T00094
led_switch 0表示关闭指示灯,1表示开启指示灯,即可以亮 1
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、119, 见错误码的描述

20. 获取指示灯开关

描述

获取当前IPC的指示灯状态。

接口

public void getLedSwitch(String deviceId, RPCCallback‹RPCResponse‹LedSettingBean›› callback);

参数说明

本接口没有私有参数,公共参数见HTTP接口调用

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
dataLedSettingBean返回码成功才会有此字段,详见RPCResponse.LedSettingBean

21. 设置画面旋转角度

描述

设置拍摄的画面是否需要旋转一定角度,可用的旋转角度可通过获取支持的画面旋转角度获取到。

接口

public void setRotation(String deviceId, int rotation, RPCCallback‹RPCResponse› callback);

参数说明

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称描述 示例
deviceIdIPC序列号C201D98T00094
rotation 画面旋转角度 180
callback调用结果

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、120, 见错误码的描述

22. 获取画面旋转角度

描述

获取当前IPC当前的画面旋转角度。

接口

public void getRotation(String deviceId, RPCCallback‹RPCResponse‹RotationBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
dataRotationBean返回码成功才会有此字段,详见RPCResponse.RotationBean

23. 获取支持的画面旋转角度

描述

获取当前IPC设备支持的画面旋转角度。

接口

public void getSupportRotationAngles(String deviceId, RPCCallback‹RPCResponse‹SupportRotationsBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
dataSupportRotationsBean返回码成功才会有此字段,详见RPCResponse.SupportRotationsBean

24. 格式化存储卡

描述

格式化插入IPC里面的存储卡。

接口

public void formatMemoryCard(String deviceId, RPCCallback‹RPCResponse› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

参数名称类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、220、221, 见错误码的描述

25. 获取存储卡状态

描述

获取IPC上存储卡状态

接口

public void getMemoryCardStatus(String deviceId, RPCCallback‹RPCResponse‹ExternalStorageBean›› callback);

参数说明

参数名称描述示例
deviceIdIPC序列号C201D98T00094
callback调用结果

响应参数

类型 描述
int返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
ExternalStorageBean返回码成功才会有此字段,详见RPCResponse.ExternalStorageBean