Commit fd807473 authored by 陈宇雄's avatar 陈宇雄

doc: 优化文档

parent d2042549
...@@ -41,6 +41,7 @@ ...@@ -41,6 +41,7 @@
1. 术语说明 1. 术语说明
+ WmCateringService:元芒餐饮服务 + WmCateringService:元芒餐饮服务
+ WmSdk:元芒餐饮服务SDK
2. 本文中所有传输内容均使用UTF-8编码; 2. 本文中所有传输内容均使用UTF-8编码;
3. 本文SDK适用于Android 11及以上,主板要求RK3568(带有NPU模块),使用JAVA 1.8 版本; 3. 本文SDK适用于Android 11及以上,主板要求RK3568(带有NPU模块),使用JAVA 1.8 版本;
4. 本文中的服务程序支持armeabi-v7a、arm64-v8a架构。 4. 本文中的服务程序支持armeabi-v7a、arm64-v8a架构。
...@@ -77,9 +78,9 @@ ...@@ -77,9 +78,9 @@
# 三、 接口说明 # 三、 接口说明
## 主流程接口 ## 3. 主流程接口
## 3.1 bindService(绑定服务) ### 3.1 bindService(绑定服务)
- 使用场景: 此接口用于绑定WmCateringService本地服务,推荐在主页Activity的onCreate()中调用 - 使用场景: 此接口用于绑定WmCateringService本地服务,推荐在主页Activity的onCreate()中调用
- 函数名: bindService - 函数名: bindService
...@@ -111,7 +112,7 @@ WmSdk.getInstance().bindService(mContext, new IOnServiceConListener() { ...@@ -111,7 +112,7 @@ WmSdk.getInstance().bindService(mContext, new IOnServiceConListener() {
}); });
``` ```
## 3.2 unbindService(解绑服务程序) ### 3.2 unbindService(解绑服务程序)
- 使用场景:用于解绑服务,推荐在主页Activity的onStop()中调用 - 使用场景:用于解绑服务,推荐在主页Activity的onStop()中调用
- 函数名: unbindService - 函数名: unbindService
...@@ -128,7 +129,7 @@ public void unbindService(); ...@@ -128,7 +129,7 @@ public void unbindService();
WmSdk.getInstance().unbindService(); WmSdk.getInstance().unbindService();
``` ```
## 3.3 init(初始化接口) ### 3.3 init(初始化接口)
- 使用场景:此接口用于初始化,请在服务绑定成功后调用一次 - 使用场景:此接口用于初始化,请在服务绑定成功后调用一次
- 函数名:init - 函数名:init
...@@ -160,7 +161,7 @@ WmSdk.getInstance().init(new IOnInitListener.Stub() { ...@@ -160,7 +161,7 @@ WmSdk.getInstance().init(new IOnInitListener.Stub() {
}); });
``` ```
## 3.4 importProducts(导入商品资料) ### 3.4 importProducts(导入商品资料)
- 使用场景: 导入商品资料 - 使用场景: 导入商品资料
- 函数名: importProducts - 函数名: importProducts
...@@ -206,7 +207,7 @@ WmSdk.getInstance().importProducts(list); ...@@ -206,7 +207,7 @@ WmSdk.getInstance().importProducts(list);
log("商品资料导入完成"); log("商品资料导入完成");
``` ```
## 3.5 registerDetectionListener(注册识别结果回调) ### 3.5 registerDetectionListener(注册识别结果回调)
- 使用场景: 此接口用于注册识别结果回调,注意当MainActivity初次启动时,服务未完成连接,该方法不会生效,需要在服务连接成功后,再次调用该接口注册回调 - 使用场景: 此接口用于注册识别结果回调,注意当MainActivity初次启动时,服务未完成连接,该方法不会生效,需要在服务连接成功后,再次调用该接口注册回调
- 函数名: registerDetectionListener - 函数名: registerDetectionListener
...@@ -229,7 +230,7 @@ public void registerDetectionListener(boolean generateBitmap, IOnDetectionListen ...@@ -229,7 +230,7 @@ public void registerDetectionListener(boolean generateBitmap, IOnDetectionListen
WmSdk.getInstance().registerDetectionListener(generateBitmap, detectionListener); WmSdk.getInstance().registerDetectionListener(generateBitmap, detectionListener);
``` ```
## 3.6 unregisterDetectionListener(反注册识别结果回调) ### 3.6 unregisterDetectionListener(反注册识别结果回调)
- 使用场景: 此接口用于反注册识别结果回调 - 使用场景: 此接口用于反注册识别结果回调
- 函数名: unregisterDetectionListener - 函数名: unregisterDetectionListener
...@@ -247,7 +248,7 @@ public void unregisterDetectionListener(); ...@@ -247,7 +248,7 @@ public void unregisterDetectionListener();
WmSdk.getInstance().unregisterDetectionListener(); WmSdk.getInstance().unregisterDetectionListener();
``` ```
## 3.7 autoDetect(重新识别) ### 3.7 autoDetect(重新识别)
- 使用场景: 重新识别 - 使用场景: 重新识别
- 函数名: autoDetect - 函数名: autoDetect
...@@ -275,9 +276,9 @@ executorService.execute(()->{ ...@@ -275,9 +276,9 @@ executorService.execute(()->{
``` ```
## 状态信息接口 ## 4. 状态信息接口
## 4.1 checkServiceAppInstalled(获取服务程序安装状态) ### 4.1 checkServiceAppInstalled(获取服务程序安装状态)
- 使用场景: 获取服务程序安装状态 - 使用场景: 获取服务程序安装状态
- 函数名: checkServiceAppInstalled - 函数名: checkServiceAppInstalled
...@@ -302,7 +303,7 @@ if (WmSdk.getInstance().checkServiceAppInstalled(this)) { ...@@ -302,7 +303,7 @@ if (WmSdk.getInstance().checkServiceAppInstalled(this)) {
} }
``` ```
## 4.2 checkServiceConnected(获取服务连接状态) ### 4.2 checkServiceConnected(获取服务连接状态)
- 使用场景: 获取服务连接状态 - 使用场景: 获取服务连接状态
- 函数名: checkServiceConnected - 函数名: checkServiceConnected
...@@ -320,7 +321,7 @@ boolean isServiceConnected = WmSdk.getInstance().checkServiceConnected(); ...@@ -320,7 +321,7 @@ boolean isServiceConnected = WmSdk.getInstance().checkServiceConnected();
log("获取服务程序连接状态:" + isServiceConnected); log("获取服务程序连接状态:" + isServiceConnected);
``` ```
## 4.3 checkActivation(获取激活状态) ### 4.3 checkActivation(获取激活状态)
- 使用场景: 获取激活状态 - 使用场景: 获取激活状态
- 函数名: checkActivation - 函数名: checkActivation
...@@ -338,7 +339,7 @@ boolean isActivated = WmSdk.getInstance().checkActivation(); ...@@ -338,7 +339,7 @@ boolean isActivated = WmSdk.getInstance().checkActivation();
log("获取服务程序激活状态:" + isActivated); log("获取服务程序激活状态:" + isActivated);
``` ```
## 4.4 checkCameraCrop(获取摄像头裁剪状态) ### 4.4 checkCameraCrop(获取摄像头裁剪状态)
- 使用场景: 获取摄像头裁剪状态 - 使用场景: 获取摄像头裁剪状态
- 函数名: checkCameraCrop - 函数名: checkCameraCrop
...@@ -356,7 +357,7 @@ boolean isCameraCropped = WmSdk.getInstance().checkCameraCrop(); ...@@ -356,7 +357,7 @@ boolean isCameraCropped = WmSdk.getInstance().checkCameraCrop();
log("获取摄像头裁剪状态:" + isCameraCropped); log("获取摄像头裁剪状态:" + isCameraCropped);
``` ```
## 4.5 checkLearningDataInitCompleted(获取算法初始化状态) ### 4.5 checkLearningDataInitCompleted(获取算法初始化状态)
- 使用场景: 获取算法初始化状态 - 使用场景: 获取算法初始化状态
- 函数名: checkLearningDataInitCompleted - 函数名: checkLearningDataInitCompleted
...@@ -374,9 +375,9 @@ boolean isLearningDataInitCompleted = WmSdk.getInstance().checkLearningDataInitC ...@@ -374,9 +375,9 @@ boolean isLearningDataInitCompleted = WmSdk.getInstance().checkLearningDataInitC
log("获取学习数据初始化状态:" + isLearningDataInitCompleted); log("获取学习数据初始化状态:" + isLearningDataInitCompleted);
``` ```
## 其他接口 ## 5. 其他接口
## 5.1 openSettingPage(打开设置页) ### 5.1 openSettingPage(打开设置页)
- 使用场景: 此接口用于打开设置页面 - 使用场景: 此接口用于打开设置页面
- 函数名: openSettingPage - 函数名: openSettingPage
...@@ -393,7 +394,7 @@ public static void openSettingPage(); ...@@ -393,7 +394,7 @@ public static void openSettingPage();
```java ```java
WmSdk.getInstance().openSettingPage(); WmSdk.getInstance().openSettingPage();
``` ```
## 5.2 resetCameraBackground(重置摄像头背景) ### 5.2 resetCameraBackground(重置摄像头背景)
- 使用场景: 此接口用于重置摄像头背景。重置摄像头背景,请先清空摄像头下的台面 - 使用场景: 此接口用于重置摄像头背景。重置摄像头背景,请先清空摄像头下的台面
- 函数名: resetCameraBackground - 函数名: resetCameraBackground
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment