生鲜识别SDK使用文档

本文档主要提供给生鲜秤端APP进行调用，进而来实现商品自动识别的功能。 需要在创迹AI开放平台购买该能力后， 下载SDK进行使用。 下文中的生鲜识别， 代表生鲜智能识别。本文将指引您如何开启开发之旅 。

1、生鲜识别SDK配置文档

1.1、SDK下载

请联系客服获取SDK。

1.2、SDK接入配置

1.2.1 aar放入libs文件夹

将SDK下载到本地后将文件解压，找到里面的.arr文件，将其放入项目中的libs文件中：

1.2.2 在build.gradle中加入代码：

//添加dependency：
implementation 'io.reactivex:rxjava:1.1.6'
implementation 'io.reactivex:rxandroid:1.2.1'
implementation 'org.pytorch:pytorch_android:1.6.0'
implementation 'org.pytorch:pytorch_android_torchvision:1.6.0'
implementation group: 'com.google.code.gson', name: 'gson', version: '2.8.5'
implementation 'com.squareup.okhttp3:okhttp:3.12.12'
implementation group: 'org.bouncycastle', name: 'bcprov-jdk15on', version: '1.55'
implementation group: 'com.rabbitmq', name: 'amqp-client', version: '5.12.0'
implementation group: 'org.bytedeco', name: 'openblas', version: '0.3.9-1.5.3', classifier: 'android-arm64'
implementation group: 'org.bytedeco', name: 'openblas', version: '0.3.9-1.5.3', classifier: 'android-arm'
implementation group: 'org.bytedeco', name: 'javacv', version: '1.5.3'
implementation group: 'org.bytedeco', name: 'javacpp', version: '1.5.3', classifier: 'android-arm64'
implementation group: 'org.bytedeco', name: 'javacpp', version: '1.5.3', classifier: 'android-arm'
implementation group: 'org.bytedeco', name: 'opencv', version: '4.3.0-1.5.3', classifier: 'android-arm64'
implementation group: 'org.bytedeco', name: 'opencv', version: '4.3.0-1.5.3', classifier: 'android-arm'

1.2.3 添加对应的权限：

1.3、SDK使用流程

需要按照操作流程来，先调用初始化接口，未初始化直接调用检测将会导致程序报错。

注意点：

①初始化完毕后进行检测（可以循环调用检测），初始化一次即可，识别工作完毕后，最后进行SDK注销接口的调用。

1.4、注意事项

1.SDK是按照设备数来购买的，当一个设备使用成功后就减少一台次数，所以请合理安排设备，避免造成购买次数的浪费。

2、生鲜识别SDK接口文档

2.1、能力介绍

实时调用usb-camera进行拍照，拍照之后进行AI识别，把识别结果返回给调用者App。

2.2、调用方式

该SDK 主要用于android端，服务授权请参考[接入指南-SDK接入指南]，根据指南进行服务授权，授权后进行SDK使用。

2.3、调用说明

点击下载,生鲜识别SDK。

下载完成后解压，对应文档目录:

|---libs
|    |---AISCALE-SDK-TRECHINA-release-20210823a-p.aar    生鲜识别的SDK
|---explanatoryDocument.txt            说明文件

建议硬件信息：

Android版本：6.0 +
内存：2G +

详细调用：

记录下网站下的appkey，secretkey，servicekey。
然后调用初始化接口，再调用生鲜识别接口。

2.4、接口说明

所有接口list：

1.public int RetailBot_Api_Init(String companyID, String keyInfo, @NonNull String rootPath)

功能：sdk初始化，此接口用于初始化RetailBot所有属性，并开启后台服务。添加sdk认证，通过认证后，才可以继续进行初始化。

参数详解：

返回值：

接口调用示例：

try{
String id = "8EZXQXWzB9PDTWTSCxYEiQ==";
JSONObject keyInfo = new JSONObject();
keyInfo.put("appKey",  "ac5a7fd3-afc0-438b-b0b1-3bada1aa057e");
keyInfo.put("appSecret",  "9e192a6a-384b-4555-a851-703f103c4fcb");
keyInfo.put("serviceKey",  "1a0545d6-ea94-4595-8fd0-c653ddd73c03");
int ret = RetailBot_Api_Init(id, keyInfo.toString(),"sdcard/cache");
}catch(Exception e){
}

2.public int RetailBot_Api_UnInit()

功能：此接口用于对SDK进行注销，与初始化对应。不再需要使用SDK功能的时候，调用该接口。

返回值：

接口调用示例：

int ret = RetailBot_Api_UnInit();

3.public int RetailBot_Api_GetSDKVersion(@NonNull StringBuffer sdkVersion)

功能：返回SDK版本号(此接口用于获取SDK版本，在未连接设备时也可使用)。

注：一般在连接上设备后使用 RetailBot_Api_Exec::GetDeviceInfo 获取所有信息。

返回值：

接口调用示例：

StringBuffer strBuf = new StringBuffer();
int ret = RetailBot_Api_GetSDKVersion(strBuf);

4.public int RetailBot_Api_GetRecognizedResult(@NonNull StringBuffer sid, @NonNull StringBuffer result)

功能：发起生鲜识别，识别当前商品。

返回值：

接口调用示例：

StringBuffer sid = new StringBuffer();
StringBuffer result = new StringBuffer(1024);
int ret = Api_GetRecognizedResult(sid,result);

返回样例：

["20191116155718582894697",  //session_id
["800116",  0.325056], //商品ID，置信度
["800115",  0.0590677],
["800148",  0.0549332],
["800126",  0.0441865],
["800144",  0.042612],
["800140",  0.0355421],
["800123",  0.00685513],
["800124",  0.00685513],
["800121",  0.00685513],
["800122",  0.00685513]]

5.public int RetailBot_Api_UploadReport(String sid ,String itemID,String weight,String inTop,String itemName) ;

功能：此接口用于回传点选结果。

返回值：

接口调用示例：

int ret = RetailBot_Api_UploadReport("20191116155718582894697","800116","3.2","true",   "西红 柿");

6.int RetailBot_Api_Exec(String strIn ,@NonNull StringBuffer strOut,int timeOut);

功能：此接口为通用指令接口。

返回值：

7.通用指令接口之GetDeviceInfo

功能：此接口用于查询当前设备的综合信息。 如果信息没有查到，默认为空字符。

输入指令：

指令返回：

超时设置：建议2000ms

返回值：

接口调用示例：

try{
JSONObject jo = new JSONObject();
jo.put("method",  "get_device_info");
StringBuffer strBuf = new StringBuffer(512);
int ret = RetailBot_Api_Exec(jo.toString(),strBuf,1000*2);
if(ret == 0){
JSONObject joRoot   = new JSONObject(strBuf.toString());
String clientCheck  = joRoot.getString("clientCheck");
String clientID = joRoot.getString("clientID");
String clientName   = joRoot.getString("clientName");
String firmware_version = joRoot.getString("firmware_version");
String model_version    =  joRoot.getString("model_version");
String online_version   =  joRoot.getString("online_version");
String sdk_version  = joRoot.getString("sdk_version");
String sn   = joRoot.getString("sn");
}
}catch(Exception e){
}

8.通用指令接口之ActiveDevice

功能：此接口完成设备与门店的绑定功能。 如果当前设备已经存在有效门店编号， 绑定失败， 不生效 。该指令无需理会返回字符串，绑定结果见错误码。

输入指令：

指令返回：无

超时设置：建议2000ms

返回值：

接口调用示例：

try{
JSONObject jo = new JSONObject();
jo.put("method", "ActiveDevice");
String clientID = “0001”;
String clientName= “xxxx超市(花园城店)”;
JSONObject joo = new JSONObject(); \
joo.put("clientID",clientID);
joo.put("clientName",clientName);
jo.put("parameters",joo);
StringBuffer strBuf = new StringBuffer();
int ret = RetailBot_Api_Exec(jo.toString(), strBuf,2000);
}catch(Exception e){
}

9.通用指令接口之GetImage

功能：此指令为获取当前摄像头图片。 在秤盘标定时，需要图片作为参考。

输入指令：

指令返回：

超时设置：建议13000ms

返回值：

接口调用示例：

try{
JSONObject jo = new JSONObject(); jo.put("method", "GetImage");
StringBuffer strBuf = new StringBuffer(1024 * 300);
int ret = RetailBot_Api_Exec(jo.toString(), strBuf, 13000);
if (ret == 0)
{
JSONObject joRoot = new JSONObject(sb.toString());
String md5 = joRoot.getString("ImageMD5");
String imageData = joRoot.getString("Image");
}
}catch (Exception e){
}

10.通用指令接口之SetCalib

功能：此指令为设置秤盘标定参数。 位置参数基于1280x720分辨率，图像坐上角为坐标原点。 应保证left>=0 且 top>=0 且 (left+width)<1280 且 (top+height)<720。 并保证(height/width)尽量接近(3/4)，比值误差<0.01(大于0.74且小于0.76)。 height应在375~600之间。 无指令返回，执行结果见 RetailBot_Api_Exec 返回值。

输入指令：

指令返回：无

超时设置：建议2000ms

返回值：

接口调用示例：

try{
JSONObject jo = new JSONObject();
jo.put("method", "SetCalib");
JSONObject joo = new JSONObject();
joo.put("height",450);  // 应根据实际值，此处仅为示例
joo.put("left",100); // 应根据实际值，此处仅为示例
joo.put("top",100); // 应根据实际值，此处仅为示例
joo.put("width",600); // 应根据实际值，此处仅为示例
jo.put("parameters",joo);
StringBuffer strBuf = new StringBuffer();
int ret = RetailBot_Api_Exec(jo.toString(), strBuf, 2000);
}catch(Exception e){

}

11.通用指令接口之GetCalib

功能：此指令为获取当前使用的秤盘标定参数。 位置参数基于1280x720分辨率，图像坐上角为坐标原点。

输入指令：

指令返回

超时设置：建议2000ms

返回值：

接口调用示例：

try{
JSONObject jo = new JSONObject();
jo.put("method", "GetCalib");
StringBuffer strBuf = new StringBuffer();
int ret = RetailBot_Api_Exec(jo.toString(), strBuf, 2000);
if(ret == 0){
JSONObject joRoot = new JSONObject(strBuf);
int height = joRoot.getInt("height");
int left    = joRoot.getInt("left");
int top = joRoot.getInt("top");
int width   = joRoot.getInt("width");
}
}catch (Exception e){

}

2.5、错误码表：

• 生鲜识别/SDK使用文档
• 1.1、SDK下载
• 1.2、SDK配置
• 1.3 SDK使用流程
• 1.4、注意事项
• 2.1、能力介绍
• 2.2、调用方式
• 2.3、调用说明
• 2.4、接口说明
• 2.5.错误码表