BasicConfig 基本配置接口

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

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. 调焦

描述

用户根据实际环境,调节镜头的焦距,使得拍摄的画面放大或者缩小。

接口

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

参数说明

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

响应参数

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

7. 手动聚焦

描述

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

接口

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,见错误码的描述

8. 自动聚焦

描述

设置焦距后,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,见错误码的描述

9. 调焦聚焦复位

描述

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

接口

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

参数说明

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

响应参数

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

10. 获取调焦和聚焦参数

描述

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

接口

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

参数说明

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

响应参数

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

11. 设置夜视模式

描述

配置镜头的夜视模式。

接口

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,见错误码的描述

12. 获取夜视模式

描述

获取当前IPC的夜视模式。

接口

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

参数说明

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

响应参数

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

13. 设置动态侦测

描述

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,见错误码的描述

14. 获取动态侦测参数

描述

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

接口

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

参数说明

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

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

响应参数

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

15. 设置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,见错误码的描述

16. 获取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

17. 设置指示灯开关

描述

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

接口

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, 见错误码的描述

18. 获取指示灯开关

描述

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

接口

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

参数说明

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

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

响应参数

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

19. 设置画面旋转角度

描述

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

接口

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

参数说明

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

参数名称描述 示例
deviceIdIPC序列号C201D98T00094
rotation 画面旋转角度
对于FM010,支持的参数有0,90,180,270;
对于FM020,支持的参数有0,180
180
callback调用结果

响应参数

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

20. 获取画面旋转角度

描述

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

接口

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

参数说明

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

响应参数

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

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

描述

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

接口

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

参数说明

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

响应参数

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

22. 格式化存储卡

描述

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

接口

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

参数说明

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

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

响应参数

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

23. 获取存储卡状态

描述

获取IPC上存储卡状态

接口

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

参数说明

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

响应参数

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

DeviceManage 设备管理接口

  1. 激活设备
  2. 获取设备基本信息
  3. 恢复出厂设置
  4. 重启设备

1.激活设备

描述

使用设备前调用此接口激活设备,使用前确保设备是联网的。

激活设备后会在SD卡中新建两个默认的人脸分组,名称分别为stranger和regular,如果在SD卡中有人脸分组的条件下激活,则会先删除所有的人脸分组,然后再新建默认库。

接口

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

参数说明

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

响应参数

响应参数指的是回调函数返回的RPCResponse,后续不再说明。

字段名称类型描述
codeint返回码,表示操作的结果;
本接口返回码有 0、1、2、3、4、8、9、10、11,见错误码章节的描述

示例代码

IPCameraManager.getInstance(context).init(APP_ID, SECRET_KEY, LICENSE);
DeviceManage.getInstance(context).activate(ipcList.get(postion).getDeviceid(), new RPCCallback‹RPCResponse›() {
    @Override
    public void onComplete(RPCResponse result) {
        Log.i(TAG, "return code= " + result.code());
        if (result.code() == RPCErrorCode.SUCCESS || result.code() == RPCErrorCode.DEVICE_ACTIVATED) {
            Log.i(TAG, "ipc activate success");
        }else if(result.code() == RPCErrorCode.DEVICE_ACTIVATED) {
            Log.i(TAG, "ipc has been activated");
        } else {
            Log.i(TAG, "ipc activate failed, code:" + result.code());
        }
    }

    @Override
    public void onError(Throwable t) {
        Log.i(TAG, t.getMessage());
    }
});

返回示例

{
  "code":0
}

2.获取设备基本信息

描述

使用此接口可以获取设备的基本信息。

接口

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

参数说明

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

响应参数

字段名称 类型描述
codeint返回码,表示操作的结果;
本接口返回码有 0、1、2、3、4、8、9、10、11,见错误码章节的描述
dataIpcInfoBean 返回码成功才会有此字段,详见RPCResponse.IpcInfoBean

示例代码

IPCameraManager.getInstance(context).init(APP_ID, SECRET_KEY, LICENSE);
DeviceManage.getInstance(context).getInfo(ipcList.get(postion).getDeviceid(), new RPCCallback‹RPCResponse‹IpcInfoBean››() {
    @Override
    public void onComplete(RPCResponse‹IpcInfoBean› result) {
        if (result.code() == RPCErrorCode.SUCCESS) {
            IpcInfoBean info = result.data();
            Log.i(TAG, "getInfo success, ip: " + info.ip);
        } else {
            Log.i(TAG, "getInfo failed, code:" + result.code());
        }
    }

    @Override
    public void onError(Throwable t) {
        Log.i(TAG, t.getMessage());
    }
});

返回示例

{
  "code": 0,
    "data": {
      "sn": "SS101D8BS00083",
      "model_name": "FM020",
      "name": "My FS",
      "software_version": "1.1.0",
      "hardware_version": "1.0.0",
      "ip": "192.168.0.1",
      "mac": "04:12:24:E3:45:12 ",
    }
}

注:参考以上实现,后续接口不再说明。

3.恢复出厂设置

描述

使用此接口可以使得设备恢复出厂设置。

接口

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

参数说明

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

响应参数

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

4.重启设备

描述

使用此接口可以重启设备。

接口

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

参数说明

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

响应参数

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

集成指南

  1. 准备工作
  2. 添加SDK到工程
  3. 权限声明
  4. 开发步骤

1. 准备工作

申请license

请联系商米售前团队申请license。

下载SDK

请联系商米售前团队申请SDK。

2. 添加SDK到工程

右键点击app,选择New->Module->Import .JAR/.AAR Package

导入SDK 库aar包

在app的build.gradle的导入libipcsdk

第三方包依赖

implementation ‘com.squareup.retrofit2:retrofit:2.8.1’

3. 权限声明

‹uses-permission android:name="android.permission.INTERNET"/›
‹uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /›
‹uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /›

4. 开发步骤

第一次使用IPC前,需要给IPC配置网络、激活、调整画面、设置门线(仅FS需要)。

4.1 SDK初始化

详见: 示例参考->SDK初始化

4.2 首次配网并激活

详见: 示例参考->设备发现 、示例参考->首次配网并激活

4.3 画面调整

详见: 示例参考->画面调整

4.4 设置门线

详见 : 示例参考->设置门线

简介

1. 功能介绍

IPC设备端Android SDK是IPC离线 Openapi接口的开发包, 包含了设备管理、基本配置、视频流、人脸识别和人流统计等功能 。

使用场景

开发者通过集成Android SDK开发完相关业务后,即可把APP应用运行在Android设备(如手机),然后APP跟摄像头在同一局网内即可完成相关的业务应用。

注意一定是同一个局域网内,由于摄像头本身接入的网络一般都是一个路由器的局域网,因此一定要在同一局域网内才能进行网络通信和API调用。

软件结构

2. 兼容性说明

系统:支持 Android 7.1.1(API Level 25)及以上系统。需要开发者通过 minSdkVersion来保证支持系统的检测。

机型:手机、平板以及SUNMI OS设备皆可。

构架:支持 CPU架构平台[armeab-v7a,arm64-v8a]

网络:支持 WIFI或以太网络

3. 开发包说明

文件/文件夹名说明
/ipcsdk SDK lib 库相关代码的 aar
/IpcGuideDemo工程

IPC 会员对接Demo

1 店铺对齐

您可以下载商米助手APP (测试环境的商米助手,会单独提供), 注册并创建商户。 您也可以通过我们的商米数字店铺web(测试版)链接 https://store.uat.sunmi.com/ 进行注册。注册完成之后,您可以

调用

https://store.uat.sunmi.com/openapi/shop/bind

接口将店铺进行对齐,接口所需参数可参考 《商米数字店铺开放平台 -> 商户店铺》

2 设备配网

通过商米助手APP进行FS识客摄像机设备的配网和绑定工作,然后进行进店划线和调焦以保证识别率和准确性。下图为设备配网成功后的状态,指示灯变为蓝色。

在设备完成配置后,您可以在商米助手app或商米数字店铺web端上看到该设备的直播视频以及客流数据

3 设定门店设备人脸分组

接下来您需要对该门店下所有设备配置人脸分组。目前每个门店支持最多十个人脸分组。( 其中包含一个自带的生客分组,一个 自带的熟客 分组 )根据不同的分组信息,不同分组的人进入摄像机的进店区域之后会自动上报信息。在会员场景下,请在调用接口的入参 type 指定为 5.

调用

https://store.uat.sunmi.com/openapi/face/group/create

接口将店铺进行对齐,接口所需参数可参考 《商米数字店铺开放平台 -> 智能摄像机IPC -> 云端API -> 接口文档 -> 第5章》

在成功调用该接口会,您会在返回结果中获得一个 group_id, 作为该分组的唯一标识。

4 录入会员信息

要对会员进行实时识别,您需要首先录入会员信息到平台,建立相应的底库。

调用

https://store.uat.sunmi.com/openapi/member/create

接口将会员信息在我方平台创建,接口所需参数可参考 《商米数字店铺开放平台 -> 智能摄像机IPC -> 会员库》

在接口成功返回之后,您的会员信息即已经录入我方平台。接下来需要把指定的会员信息下发到指定门店的摄像机中。这样在该门店的摄像机上即可以保留相关的特征数据,用来做人脸抓拍后的比对工作。

调用接口

https://store.uat.sunmi.com/openapi/member/assign

接口将会员信息下发到指定门店的摄像机,接口所需参数可参考 《商米数字店铺开放平台 -> 智能摄像机IPC -> 会员库》

在此之后,该会员的记录会添加到门店数据中,在客流数据等场景下都可以体现。您也可以在商米助手app和商米数字店铺web上看到客流统计数据的变化。相关的openAPI接口也都已经开放, 接口将店铺进行对齐,接口所需参数可参考 《商米数字店铺开放平台 -> 智能摄像机IPC -> 云端API -> 接口文档 -> 6人流统计接口》中可以

5 实时到店推送

如果您需要对会员到店的情况,需要获得实时提醒,可以采用消息中心的接口进行订阅。

调用

https://store.uat.sunmi.com/openapi/hook/add

接口可以先订阅您要收到推送的门店以及推送的HTTP地址。事件event选择为2001 .

之后在FS摄像机侦测到会员进店之后,就会实时推送至此订阅的HTTP地址链接。返回的消息大致如下。

{
    "ipc_id": "512369745691",
    "face_id": "235698745612",
    "gender": 1,
    "age_range": 4,
    "group_id": "8927",
    "group_name": "stranger",
    "group_type": 2,
    "member_id": "2938203938",  //如果获取的人员为录入会员,则返回会员id,非会员,则返回为""
}

首次配置

1.有线联网
2.无线联网
3.获取设备IP地址
4.设备发现协议

需要使用IPC的API就要求对接系统能够获取到IPC的IP地址,然后通过IP与IPC通信,调用相关的API来获取对应的服务。

因此调用IPC前需要先获取到IPC的IP地址,故第一步是把IPC接入网络,IPC连接网络的方式有有线连接和无线连接两种方式。

由于有线网络相对不容易受到环境干扰,稳定性和可靠性较高,故首选是有线方式接入网络。

1. 有线联网

对于有以太网网口的IPC设备,可以使用以太网线连接IPC设备和网关(例如无线路由器),使得IPC通过DHCP服务获取到IP地址。

如果连接的网络是可以正常上网的话,IPC获取到IP后很快就会亮蓝灯,此时表明IPC可以正常连接Internet了。

2. 无线联网

无线配网方式相对要复杂点,步骤如下:

  1. 使用手机/PC的无线网卡扫描IPC的AP热点,一般AP热点的名称为SUNMI_XXXX,其中XXXX为MAC地址最后2个字节的16进制数字,MAC地址可以通过设备机身后背的标贴或者包装盒的标贴查到,AP热点本身是无加密的。
  2. 使用手机/PC的无线网卡连接IPC的AP热点,此时手机/PC就会获取到IPC分配的IP地址,一般会是192.168.200.XXX,手机/PC的网关地址就是IPC的地址,一般会是192.168.200.1。
  3. 使用IPC的IP地址(一般是192.168.200.1),调用无线配置 API(见3.2.1一节的描述)设置IPC要连接的无线网络(例如无线路由器的SSID和密码),使得IPC能够从网关处获取到IP地址。
  4. 如果网络是可以正常上网的话,IPC取到IP地址后很快就会亮蓝灯,此时表明IPC可以正常连接Internet了。

3. 获取设备IP地址

完成IPC的网络接入后,接下来就是要获取到IPC的IP地址。

商米提供一套协议,用于发现同一局域网内所有支持此协议的设备,以获取到设备的基本信息,其中包括SN和IP地址。此协议叫设备发现协议。

4. 设备发现协议

商米发现协议简单来说,就是通过在局域网内广播UDP报文来询问同一局域网内有哪些商米设备,支持此协议的商米设备会在收到询问报文后单播响应报文,响应报文中就包括了设备的基本信息。这样就完成了一次设备发现的过程。

4.1 协议报文格式

UDP报文的载荷部分,格式如下图所示,整个协议报文有报头Head、载荷Payload和CRC校验和组成。

  • Header

协议报头,包括标记为Flag、协议版本Version、报文类型 Type和长度Len。

Flag:为报文的开头部分,是一个标记,目前固定为0xFFFF33FF。

Version:为协议版本,目前只支持版本号0x1。

Type:为报文类型,发起方一般Type为0x01,表示发现请求,Discovery Request;响应方回复的报文Type为0x02,表示Discovery Response。

Len: 表示Payload部分的长度,要求是原始的数据部分进行base64编码前的长度。

  • Payload

真正的载荷部分,原始的数据采用json格式,json数据需要进行base64编码,然后放到Payload上。

接收方接收到后,需要进行base64解码才能还原为json数据。

  • CRC

发送的数据需要进行简单的CRC32校验,校验字段包括Header和Payload。

接收方接收到数据后,会对CRC进行校验,校验通过才能使用。

4.2 协议通信端口

端口号10001,发送端和接收端双方使用相同的端口号。

4.3 Discovery Request

当发送方想知道局域网内有哪些设备,就需要发送UDP广播报文,报文内容如下:

类型为0x01,长度为0x0,即没有载荷部分。

4.4 Discovery Response

由响应方回复,告诉发送方自己的设备信息,类型为0x02,长度根据实际情况计算。

回复的载荷内容如下图所示,也即是json格式的设备信息,具体含义解析如下。

ip:设备的IP地址。

mac:设备的MAC地址。

firmware:设备的固件版本,如1.0.0。

name:设备名称标记,目前固定为SUNMI。

model:设备型号,如FM020。

type:设备类型,IPC设备回复的值为IPC。

network:发送端的网络连接方式,如果发送端连接的是IPC的AP热点则值为AP,如果发送端与IPC同时连接在另一个路由器的局域网内,则值为LAN。

deviceid:设备序列号SN。

4.5 超时处理

建议发送端发送Discovery Request报文后,间隔1s再次发送,最多发送3次,每次间隔都是1s。之所以发送3次,是防止丢失有些设备没有收到的情况。

发送完3次后,设置超时时间为2s,2s后不再接收Discovery Response报文,即从发送第一个Discovery Request后,5s内接收Discovery Response报文,并解析所有设备的信息。

接收端接收到Discovery Request报文后,立即单播回复Discovery Response报文。

升级线上环境固件

1. 概述

本文指导用户通过线下手动的方式升级IPC摄像头的固件到正式线上环境,用于在完成开发环境对接API和联调测试后,将IPC升级回正式线上环境正式使用。

如果您的设备已经是运行正式线上环境,则可以跳过以下章节。

2. 获取升级固件

请务必从商米售前获取对应型号摄像头的升级固件 ,否则出现升级异常概不负责。

目前商米有的IPC摄像头有两款,分别是

  1. AI识客摄像机,英文名Face Sense Camera,简称FS,目前的型号是FM020。
  2. 智能看店摄像机,英文名Store Sense Camera,简称SS,目前的型号是FM010。

3. 升级规则

  1. 不同机型之间系统固件不能互相升级,例如FS和SS之间不能升级,所以请务必根据自己的机型来获取对应的正式环境固件。
  2. 开发环境和正式环境的固件之间可以互升成功。但如果都是开发环境或者正式环境的固件,且待升级固件版本号与当前设备上的版本号完全一致,则不会升级,版本号不同才会升级,当前固件显示的版本号格式形如1.2.0 。
  3. 正常情况是升级到高版本的,如果出现异常也支持从高版本升级回低版本。
  4. 固件本身有自己的签名机制和升级校验方法,所以请务必从商米处获取固件,切勿随便从第三方获取固件,否则升级失败或者存在升级变砖的风险。

4. 详细流程

4.1 拷贝固件到TF卡

  1. 将TF卡插入电脑,执行格式化操作,文件系统设置为exfat,卷标设置为SUNMI-XXXX(其中XXXX为摄像头MAC地址最后四位,摄像头MAC地址见机身背面标贴)。注:卷标SUNMI-XXXX中的-为英文半角符号,非中文全角符号;XXXX中的字母为大写。
  2. 进入TF卡目录,在根目录下新建firmware目录,将从商米处 (详见2. 获取正式环境固件)获取到的正式环境的升级固件拷贝到新建的firmware目录下,并把固件重命名为ipc-up.bin

4.2 升级固件

  1. 将带有固件的TF卡重新插入摄像头的TF卡槽中。
  2. 重新上电摄像头。
  3. 等待1min左右,直到设备闪烁红灯,则说明正在升级固件。
  4. 升级需要一些时间,再耐心等待1min左右,直到重新亮绿灯说明设备开始重启,当设备再次闪烁绿灯或者亮蓝灯说明设备已经重启完毕。

4.3 进行首配

  1. 重启后, 长按设备上的Reset按键5秒以上进行恢复出厂设置。
  2. 恢复出厂重启后,使用正式环境的商米APP,按照《用户指南》手册中的软件配置指引完成摄像头的首次配置。
  3. 首配完成后,如果没有格式化TF卡,请使用商米助手APP或登录正式环境的WEB服务网站https://store.sunmi.com对TF进行格式化即可。
  4. 记得删除原来SD卡中的firmware/ipc-up.bin文件,避免不必要的意外升级。

错误码

API调用返回结果的所有错误码列表如下:

错误码 描述
0 正常,操作成功
1 app_id不合法
2 合法性检查失败
3 未知错误
4 请求激活的设备没有联网
5 app_id或者secret key错误
6 URL错误
7 设备未激活
8 设备激活失败
9 设备已激活,不需要重复激活
10 设备已绑定,激活失败
11 SN错误,激活失败
12 操作不允许
13 操作不支持
100 SSID不符合规范
101 密码不合法
102 不支持无线联网
110 焦距范围不合法
111 聚焦范围不合法
112 自动聚焦的百分比错误
113 夜视模式参数不合法
114 动态侦测画面灵敏度不合法
115 动态侦测声音灵敏度不合法
116 动态侦测日期不合法
117 动态侦测开始时间或者结束时间不合法
118 名字长度超出范围
119 指示灯开关参数错误
120 旋转参数不合法
121 指定时间段内的视频数据不存在
122 指定的页码不存在
200 人脸分组重名
201 人脸分组名称不合法
202 分组容量超出范围
203 人脸分组ID不存在
204 指定人脸分组不存在
205 要删除的人脸分组还有人脸,请先删除分组中的所有人脸
206 存在同样的人脸ID
207 指定人脸ID不存在
208 超出人脸分组的容量大小
209 人脸ID操作不允许
210 人脸照片不合格
211 人脸服务未开启
212 人脸分组描述不合法
220 SD卡不存在
221 SD卡格式化失败,原因未知
230 回放时间参数不正确
231 查询录像时间参数不正确
232 RTSP服务未开启
233 截图不成功
234 查询录像page参数不正确
235 录像不存在
240 人脸属性名称不合法
241 人脸属性重名
242 人脸属性数量超过最大限制
243 指定人脸属性不存在
260 拌线左边端点X坐标超出范围
261 拌线左边端点Y坐标超出范围
262 拌线右边端点X坐标超出范围
263 拌线右边端点Y坐标超出范围
264 分辨率设置超出范围
265 人流统计信息粒度参数超出范围
266 开始时间设置异常,必须使用UNIX时间戳
267 结束时间设置异常,必须使用UNIX时间戳
268 查询参数order设置异常
269 查询参数group name设置异常
270 查询参数gender设置异常
271 查询参数age设置异常
272 查询参数age_range设置异常
273 查询参数page_num设置异常
274 查询参数page_size设置异常
275 查询参数faceid设置异常
276 拌线右边端点X坐标-拌线左边端点X坐标差值小于100,距离不足
277 传入参数不是合理的json table格式
278 配置保存失败
279 配置读取失败
280 数据库中未发现人脸信息
281 查询参数 用户新增人脸属性 设置异常
282 查询参数 用户新增人脸属性值 数据类型设置异常
310 订阅的消息事件不存在

IPC消息中心

IPC设备产生的实时消息客户端可通过两种方式获得:一是用户通过订阅相关事件并给出回调地址,IPC产生相关消息时会向对应回调地址发送一个POST消息; 二是用户可通过与IPC建立长连接来传递 。

1. 消息推送

消息推送是客户端向IPC订阅相关的消息事件,当IPC产生消息事件是,会像订阅的回调地址发送一条http post消息,通知客户端,其实现的功能与消息通道一节一致。

1. 1 签名规则

签名规则一节一致。

1.2 订阅管理

1.2.1 订阅消息

描述

订阅消息接口用于向IPC设备端订阅相关的消息,一旦订阅了消息,当设备端产生了相关消息的时候,便会向订阅时传入的回调接口发送一个HTTP POST消息,从而达到通知订阅者的目的。

请求地址

https://192.168.0.1/openapi/hook/add,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

参数名称类型描述是否必须
event_listarray[string]事件类型,可以是[“face_recog_event”,”dynamic_detect_event”]或者其中一个,其中” face_recog_event “仅FM020支持 Y
http_callbackstring回调含函数地址,当IPC产生相关消息时,会向该地址发送一个http post消息Y

响应参数

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

请求示例

POST openapi/hook/add HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&
event_list=[“face_recog_event”,”dynamic_detect_event”]&http_callback=http://192.168.0.100/msg

返回示例

{
     ‘code’:          0,
}

1.2.2 取消已订阅消息

描述

用于取消已经向IPC设备端订阅过的消息,取消订阅后,当设备端产生相关消息时,便不会向对应的回调地址发送HTTP POST消息。

请求地址

https://192.168.0.1/openapi/hook/delete,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

参数名称类型描述是否必须
event_listarray[string]事件类型,可以是[“face_recog_event”,”dynamic_detect_event”]或者其中一个,其中” face_recog_event “仅FM020支持 Y
http_callback string 之前订阅的回调函数地址,指定此参数,设备端只取消此地址的订阅,不指定此参数,设备端将取消所有地址的订阅 N

响应参数

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

请求示例

POST openapi/hook/delete HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&
event_list=[“dynamic_detect_event”,”face_recog_event”]&http_callback=http://192.168.0.100/msg

返回示例

{
     ‘code’:          0,
}

1.2.3 查询所有已订阅消息

描述

用于查询IPC设备端所有订阅的消息,当设备端产生相关消息时,会向对应的回调地址发送HTTP POST消息。

请求地址

https://192.168.0.1/openapi/hook/query,192.168.0.1需要替换成实际的IPC地址。

请求参数

此接口不需要私有参数,公共参数见公共参数一节描述。

响应参数

字段名称类型 描述
code int 返回码,表示操作的结果; 本接口返回码有0、1、5,见错误码的描述
sub_event array 订阅列表
event string 订阅的事件类型
http_callback array 订阅该事件的所有回调地址列表
num string 订阅事件的个数

请求示例

POST openapi/hook/query HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&

返回示例

{
    “data”: {
        “num”: 2,
        “sub_event”: [
            {
                “event”: “face_recog_event”,
                “http_callback”: [
                    “10.10.61.206:8000”
                ]
            },
            {
                “event”: “dynamic_detect_event”,
                “http_callback”: [
                    “10.10.61.206:8000”
                ]
            }
        ]
    },
    “code”: 0
}

1.3 推送消息

IPC通过HTTP POST的方式推送消息,会提交form表单,Content-Type为multipart/form-data,消息内容封装在payload中。

动态侦测消息

动态侦测消息如下:

POST / HTTP/1.1
Host: 10.10.61.206:8000
User-Agent: libcurl/7.52.1 OpenSSL/1.0.2p
Accept: */*
Content-Length: 826
Expect: 100-continue
Content-Type: multipart/form-data; boundary=————————c83c36cd4ee4082f
 
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”app_id”
 
123
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”random”
 
692777
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”timestamp”
 
1579158766
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”sign”
 
372F669601E8347737744FFC88B74665
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”payload”  

{“event_id”:1,”detect_type”:2,”video_url”:”https://10.10.63.19/mnt/sd-card/sunmi_video/video_detect/1579158761.flv?auth_key=1579158765-d701e761fecf0df84853440d4dbc3fe1″,”event_type”:”dynamic_detect_event”,”sn”:”SS101D8BS00080″,”report_time”:1579158765}
————————–c83c36cd4ee4082f–

消息有效载荷在payload中,各字段内容如下:

参数名称 类型 描述
event_id long 事件ID
event_type string 事件类型
report_time long 事件发生的时间戳
detect_type int 动态侦测检测到的类型,1表示画面变化,2表示声音变化,3表示既有画面变化,也有声音变化
video_url string 视频下载路径
sn string 发出此消息的IPC序列号

人脸识别消息

人脸识别消息如下:

POST / HTTP/1.1
Host: 192.168.103.173:8010
User-Agent: libcurl/7.52.1 OpenSSL/1.0.2p
Accept: */*
Content-Length: 906
Content-Type: multipart/form-data; boundary=————————7faeecefd4fb5aaf

————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”app_id”

KJQJ89V956U9O9UI
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”random”

956429
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”timestamp”

1597894809
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”sign”

004B3CD3FACB562E06CC04A0935410A5
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”payload”
{“event_id”:2,”faceid”:”358526″,”group_name”:”db_0″,”age”:0,”age_range”:5,”gender”:0,”arrive_times”:3,”pic_url”:”https://192.168.103.117/mnt/sd-card/sunmi_image/snap/1597894624456_7.jpg?auth_key=1597894624-f88c2f9a6e69834430648c2f4931ffae”,”event_type”:”face_recog_event”,”sn”:”FS101D8BS00080″,”report_time”:1597894809}
————————–7faeecefd4fb5aaf–

消息有效载荷在payload中,各字段内容如下:

参数名称 类型 描述
event_id long 事件ID
event_type string 事件类型
sn string 发出此消息的IPC序列号
report_time long 事件发生的时间戳
faceid string 人脸ID
group_name string 所在分组名称
age int 年龄,为空则表示用户没有设置过此人脸的年龄
age_range int 所属年龄段,1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁,5表示29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100
gender int 性别,0表示未知,1表示男性,2表示女性
arrive_times int 到达过的总次数
pic_urlstring人脸照片下载地址
item1 string 自定义属性1,用户添加过才会返回
item2 string 自定义属性2,用户添加过才会返回
item3 string 自定义属性3,用户添加过才会返回
item4 string 自定义属性4,用户添加过才会返回
item5 string 自定义属性5,用户添加过才会返回

2. 消息通道

消息通道是客户端与IPC设备维持的一条长连接,用于IPC设备主动向客户端实时推送消息事件。其实现的功能与消息推送一节一致。

2.1. 消息协议

通信协议端口

通信协议采用TCP连接,同时为了保证数据的安全性,采用SSL套接字,是C/S模式,IPC设备是Server。Server端的端口暂时固定为10021。

通信格式

本节简述报文格式,主要由头部、载荷和CRC校验和构成;如下图所示。

  • 头部

Flag

为协议标识符,暂定为0xFF3E3EFF。

Version

本协议的版本号,目前为0x01,高版本兼容低版本。

Packet Type

包类型,目前支持如下:

类型 方向 描述
保留 0 禁止 保留
CONNECT 1 客户端到服务端 客户端发起建立消息通道的报文
CONNACK 2 服务端到客户端 连接确认报文,报文内容会标志连接是否合法
PINGREQ 3 客户端到服务端 心跳请求
PINGRESP 4 服务端到客户端 心跳响应
SUBSCRIBE 5 客户端到服务端 客户端订阅消息事件
SUBACK 6 服务端到客户端 订阅请求确认
UNSUBSCRIBE 7 客户端到服务端 客户端取消订阅消息事件
UNSUBACK 8 服务端到客户端 取消订阅请求确认
PUBLISH 9 两个方向都可以 目前来说只支持服务端到客户端的消息发布
PUBACK 10 两个方向都可以 发布消息收到确认
DISCONNECT 11 客户端到服务端 断开连接

Length

为载荷长度,范围是0 ~ N,N最大是65535。

  • 载荷Payload

载荷就是实际的报文内容,采用json格式。根据Packet Type的不同而不一样。

  • CRC校验和

是Payload的CRC校验和,占用4B。

2.2 建立连接

由客户端发起到IPC服务端的连接。

  • 发起连接

报头包类型为0x01,报文载荷格式如下,客户端带上一些参数,并用secret key做签名,详见签名规则一节的介绍。服务端会采用同样的规则来检查客户端的连接是否合法。

{
“app_id”:”mdk923idkf”,
“timestamp”:”15930292837″,
“random”:”289192″,
“sign”:”IDKNFLK392038KDS932K”,
“keep_alive”:30
}

keep_alive:心跳包的周期,以秒为单位,有客户端根据实际情况指定心跳周期。

  • 响应连接

报头包类型为0x02,报文内容如下。code 为返回码,表示操作的结果。本接口返回码有 0、1、2、3、5、7,见错误码描述。

{
“code”:0
}

2.3 心跳

客户端根据预定好的心跳周期,周期性地向服务端发送心跳报文,服务端会在3次都没有收到心跳报文后,断开连接。

  • 心跳请求

报头类型为0x03,没有载荷。

  • 心跳响应

报头类型为0x04,没有载荷。

2.4 订阅消息

由客户端向服务端订阅消息事件。

  • 发起订阅(或取消订阅)

报头类型为0x05(或0x07),载荷内容如下:

{
“event_list”:[
“dynamic_detect_event”,
“face_recog_event”
]
}

字段解释如下

参数名称 类型 描述
event_list string 需要订阅的消息事件列表

目前支持事件列表如下

事件类型 描述
dynamic_detect_event 动态侦测消息
face_recog_event 人脸识别消息(仅FM020支持)
  • 响应订阅(或响应取消订阅)

报头类型为0x06(或0x07),载荷内容如下。code 为返回码,表示操作的结果。本接口返回码有 0、1、2、3、5、7、310、311,见错误码描述。

{
“code”:0
}

2.5 发布消息

  • 发布消息

由IPC服务端推送消息到客户端,报头类型为0x09,内容因事件类型不同而有所不同。

  • 动态侦测消息

报文载荷内容如下:

{
“event_id”:1,
“event_type”:”dynamic_detect_event”,
“sn”:”FS101D8BS00106″,
“report_time”:15930292837,
“detect_type”:1,
“video_url”:”https://192.168.0.1/mnt/sd-card/sunmi_video/video_detect/1565535983.flv?auth_key=1564129415215f61f3c5f552c5bf8f43ccef5c66a9″
}

各字段如下:

参数名称 类型 描述
event_id long 事件ID
event_type string 事件类型
report_time long 事件发生的时间戳
detect_type int 动态侦测检测到的类型,1表示画面变化,2表示声音变化,3表示既有画面变化,也有声音变化
video_url string 视频下载路径
sn string 发出此消息的IPC序列号
  • 人脸识别消息

报文内容如下:

{
“event_id”:2,
“event_type”:”face_recog_event”,
“sn”:”FS101D8BS00106″,
“report_time”:15930292837,
“group_name”:”vip”,
“faceid”:”00000001″,
“age”:10,
“gender”:2,
“arrive_times”:4,
“pic_url”:”https://192.168.103.117/mnt/sd-card/sunmi_image/snap/1597894545153_5.jpg?auth_key=1597894545-acb4f1ba497caeef146de1d4a0e926d9″,
“vip_level”:”1″, //自定义属性,用户定义了才会有,这里是举例
“hobby”:”tennis”, //自定义属性
“weight”:”60″, //自定义属性
“height”:”180″ //自定义属性
}

各字段描述如下

参数名称 类型 描述
event_id long 事件ID
event_type string 事件类型
sn string 发出此消息的IPC序列号
report_time long 事件发生的时间戳
faceid string 人脸ID
group_name string 所在分组名称
age int 年龄,为空则表示用户没有设置过此人脸的年龄
age_range int 所属年龄段,1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁,
5表示29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100
gender int 性别,0表示未知,1表示男性,2表示女性
arrive_times int 到达过的总次数
pic_urlstring人脸照片下载地址
item1 string 自定义属性1,用户添加过才会返回
item2 string 自定义属性2,用户添加过才会返回
item3 string 自定义属性3,用户添加过才会返回
item4 string 自定义属性4,用户添加过才会返回
item5 string 自定义属性5,用户添加过才会返回
  • 发布消息确认

如果订阅者收到此消息,则返回确认。报头类型为0x0a,内容如下。

{
“event_id”:1
}

报文字段描述如下:

参数名称 类型 描述
event_id long 正常接收的消息ID

2.6 断开连接

报头类型为0x11,载荷内容为空。

人流统计API

1.设置进门拌线坐标

描述

进门拌线是IPC设备用来判断某个人是否已经进来的基础,因此对于人脸识别和客流统计,需要通过此接口来设置这个拌线的坐标。

请求地址

https://192.168.0.1/openapi/peopleFlow/setDoorLine,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

参数名称 类型 描述是否必须示例
resolutionint只能取值0和1,0表示1080P的分辨率,1表示720P的分辨率Y0
start_xint拌线的左边端点X坐标,1080p范围0<=x<=1920,720p范围0<=x<=1280Y500
start_yint拌线的左边端点Y坐标,1080p范围0<=y<=1080,720p范围0<=y<=720Y 500
end_xint拌线的右边端点X坐标,1080p范围0<=x<=1920,720p范围0<=x<=1280Y 500
end_yint拌线的右边端点Y坐标,1080p范围0<=y<=1080,720p范围0<=y<=720Y 500

响应参数

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

请求示例

POST openapi/peopleFlow/setDoorLine HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&resolution=0&start_x=1200&start_y=900&end_x =1500&end_y=900

返回示例

{
    "code":  0
}

2.获取进门拌线坐标

描述

获取进门拌线的坐标信息。

请求地址

https://192.168.0.1/openapi/peopleFlow/getDoorLine,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

响应参数

字段名称类型描述
codeint返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、260、261、262、263、264、276、277、279,见错误码的描述
resolutionint取值0和1,0表示1080P的分辨率,1表示720P的分辨率
start_xint拌线的左边端点X坐标
start _yint拌线的左边端点Y坐标
end_xint拌线的右边端点X坐标
end_yint拌线的右边端点Y坐标

请求示例

POST openapi/peopleFlow/getDoorLine HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    "code": 0,
    "data": {
    "resolution": 0,
    "start_x": 1200,
    "start_y": 900,
    "end_x": 1500,
    "end_y": 900
    }
}

3.获取指定时间内的进入人流统计信息

描述

获取指定某一时间内的人流统计信息,如果设备不存在这个时间内的信息则会返回错误。

请求地址

https://192.168.0.1/openapi/peopleFlow/getComeInPeopleStat,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

参数名称 类型 描述是否必须 示例
start_timelongUnix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小
时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者
2019-07-01 10:30这样的时间对应的时间戳。
Y1578969264
end_timelongUnix格式时间戳,精确至秒,结束时间。时间要求同上。Y1579055640
periodint人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别
为1,2和3。
Y2

响应参数

字段名称 类型 描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述
totalint总人流数量/统计粒度内的人流数量
start_timelong统计粒度的开始时间
end_timelong统计粒度的结束时间
male_num_statarray整数数组,表示男性统计数据,共有8个整数,从第一个整数开始依次表
示1~6岁、7~12岁、13~18岁、19~28岁、29~35岁、36~45岁、46~55岁、
56岁~100岁的男性人数。
female_num_statarray整数数组,表示女性统计数组,含义同上

请求示例

POST openapi/peopleFlow/getComeInPeopleStat HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3

注:本示例表示获取2019-07-01到2019-07-02这两天的统计信息,且统计信息以天为粒度的人流统计信息。

返回示例

{
    "code": 0,
    "data": {
    "total": 2998,
    "stat_list": [{
            "start_time": 1561910400,
            "end_time": 1561996800,
            "total": 1499,
            "male_num_stat": [10, 20, 50, 109, 280, 380, 156, 10],
            "female_num_stat": [11, 34, 50, 78, 132, 45, 123, 11]
        },
        {
            "start_time": 1561996800,
            "end_time": 1562083200,
            "total": 1499,
            "male_num_stat": [10, 20, 50, 109, 280, 380, 156, 10],
            "female_num_stat": [11, 34, 50, 78, 132, 45, 123, 11]
    	}]
    }
}

4.获取指定时间内的路过人流统计信息

描述

获取指定某一时间内的经过人流统计信息,如果设备不存在这个时间内的信息则会返回错误。

请求地址

https://192.168.0.1/openapi/peopleFlow/getPassByPeopleStat ,192.168.0.1 需要替换成实际的 IPC 地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

参数名称类型描述是否必须示例
start_timelongUnix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小
时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者
2019-07-01 10:30这样的时间对应的时间戳。
Y1578969264
end_timelongUnix格式时间戳,精确至秒,结束时间。时间要求同上。Y1579055640
periodint人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别
为1,2和3。
Y2

响应参数

字段名称类型描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述
totalint总人流数量/统计粒度内的人流数量
start_timelong统计粒度的开始时间
end_timelong统计粒度的结束时间

请求示例

POST openapi/peopleFlow/getPassByPeopleStat HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3

注:本示例表示获取2019-07-01到2019-07-02这两天的统计信息,且统计信息以天为粒度的人流统计信息。

返回示例

{
    "code": 0,
    "data": {
    "total": 2998,
    "stat_list": [{
        "start_time": 1561910400,
        "end_time": 1561996800,
        "total": 1513
    	}, {
    	"start_time": 1561996800,
        "end_time": 1562083200,
        "total":1485
    	}]
    }
}

5.获取指定时间内的外出人流统计信息

描述

获取指定某一时间内的人流统计信息,如果设备不存在这个时间内的信息则会返回错误。

请求地址

https://192.168.0.1/openapi/peopleFlow/ getGoOutPeopleStat ,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见公共参数一节描述。

参数名称类型描述是否必须示例
start_timelongUnix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小
时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者
2019-07-01 10:30这样的时间对应的时间戳。
Y1578969264
end_timelongUnix格式时间戳,精确至秒,结束时间。时间要求同上。Y1579055640
periodint人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别
为1,2和3。
Y2

响应参数

字段名称类型描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述
totalint总人流数量/统计粒度内的人流数量
start_timelong统计粒度的开始时间
end_timelong统计粒度的结束时间

请求示例

POST openapi/peopleFlow/getGoOutPeopleStat HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192& timestamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3

注:本示例表示获取2019-07-01到2019-07-02这两天的统计信息,且统计信息以天为粒度的人流统计信息。

返回示例

{
    "code": 0,
    "data": {
    "total": 2998,
    "stat_list": [{
    	"start_time": 1561910400,
        "end_time": 1561996800,
        "total": 1513
    	}, {
    	"start_time": 1561996800,
        "end_time": 1562083200,
        "total":1485
    	}]
    }
}

6.获取指定时间内的来访列表

描述

获取指定时间内,来过次数排名前N的人脸ID列表信息。

请求地址

https://192.168.0.1/openapi/peopleFlow/getVisitorList,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数公共参数一节描述。

参数名称 类型 描述是否必须 示例
start_timelongUnix时间戳Y1578969264
end_timelongUnix时间戳Y1579055640
orderint表示抵达次数排名前order的人脸信息Y50
group_namestring指定某个人脸分组,默认为所有人脸分组Nvip
genderint性别,1表示男性,2表示女性,默认不分性别N1
age_rangeint年龄段,1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁,
5表示29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100
N4
ageint年龄,与上面age_range是或的关系,不是与的关系。即查询age_range或
者age满足的人脸,只要有一个符合即可。
N4
item1string可以根据自定义属性来匹配,自定义属性1的匹配。如果需要使用自定义属
性查询,请确保指定的人脸分组添加过对应的自定义属性,否则查询失败(生
人与熟人分组不能添加自定义属性)
N value1
item2string自定义属性2的匹配N value2
item3string自定义属性3的匹配N value3
item4string自定义属性4的匹配N value4
item5string自定义属性5的匹配N value5
page_numint当前页码,默认值和最小值为1N1
page_sizeint当前页面条目数,默认为10,范围为[1, 100]N10

响应参数

参数名称 类型 描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述
total_numint符合条件的总人脸数量
return_numint当前人脸数量
faceidstring人脸ID
group_namestring所属分组
agestring年龄,为空则表示没有设置真实年龄
age_rangeint1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁,5表示
29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100
genderint性别, 0表示未知,1表示男性,2表示女性
arrive_timesint到达过的次数
item1string自定义属性1,用户添加过才会返回
item2string自定义属性2,用户添加过才会返回
item3string自定义属性3,用户添加过才会返回
item4string自定义属性4,用户添加过才会返回
item5string自定义属性5,用户添加过才会返回

请求示例

如下是获取VIP贵宾中30岁男性在2019-06-14到2019-06-15两天内到过次数最多的人脸ID列表信息。

POST openapi/peopleFlow/getVisitorList HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&
order=2&start_date=1560441600&end_date=1560528000&gropu_name=vip&age=30&gender=1&item1=value1&&item2=value2&&item3=value3&&item4=value5&&item5=value5

返回示例

{
    "code": 0,
    "data": {
    "total_num": 2,
    "return_num": 2,
    "face_list": [{
    	"faceid": "000001",
    	"group_name": "vip",
    	"age": "32",
    	"age_range": 5,
    	"gender': 1, 
    	"arrive_times": 100,
    	"item1": value1, //自定义属性 
    	"item2": value2, //自定义属性 
    	"item3": value3, //自定义属性 
    	"item4": value4, //自定义属性 
    	"item5": value5 //自定义属性 
    	}, {
    	"faceid": "000002",
    	"group_name": "vip",
    	"age": "30",
    	"age_range": 5,
    	"gender": 1,
    	"arrive_times": 99,
    	"item1": value1, //自定义属性 
    	"item2": value2, //自定义属性 
    	"item3": value3, //自定义属性 
    	"item4": value4, //自定义属性 
    	"item5": value5 //自定义属性 
    	}]
    }
}

7.获取指定人脸的来访记录

描述

查询指定某个人在指定时间内的到访记录。

请求地址

https://192.168.0.1/openapi/peopleFlow/getFaceVisitDetail,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数公共参数一节描述。

参数名称类型描述是否必须示例
start_timelongUnix时间戳,开始时间Y1578969264
end_timelongUnix时间戳,结束时间Y1579055640
faceidstring人脸IDY 000001

响应参数

字段名称类型描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述
total_timesint总到访次数
came_in_timelong array到访的具体时间戳

请求示例

POST openapi/peopleFlow/getFaceVisitDetail HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&faceid=000002

注:本示例表示获取2019-07-01到2019-07-02这两天faceid为000002的人脸的到访时间记录。

返回示例

{
    "code": 0,
    "data": {
    "total_times": 2,
    "came_in_time": [1561910400, 1561996800]
    }
}

8.获取人流统计设置

描述

查询指定某个人在指定时间内的到访记录。

请求地址

https://192.168.0.1/openapi/peopleFlow/getConfig,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见公共参数一节描述。

响应参数

字段名称类型描述
codeint 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、211,见错误码的描述
facerecog_intervalint设备端人脸识别去重时间间隔,单位秒。

请求示例

POST openapi/peopleFlow/getConfig HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    "code": 0,
    "data": {
        "facerecog_interval": 60
    }
}

9.更新人流统计设置

描述

查询指定某个人在指定时间内的到访记录。

请求地址

https://192.168.0.1/openapi/peopleFlow/setConfig,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数公共参数一节描述。

参数名称类型描述是否必须示例
facerecog_intervalint设备端人脸识别去重时间间隔,单位秒,取值范围[0,86400]。 Y60

响应参数

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

请求示例

POST openapi/peopleFlow/getConfig HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&facerecog=60

返回示例

{
    "code": 0
}