First submission

README.md

@@ -1,3 +1,5 @@
+[TOC]
+
 # TPMS SDK instructions-Android
 
 [![](https://jitpack.io/v/elinkthings/TmpsSDKRepositoryAndroid.svg)](https://jitpack.io/#elinkthings/TmpsSDKRepositoryAndroid)
@@ -6,9 +8,9 @@
 
 [key registered address](http://sdk.aicare.net.cn)
 
-[中文文档](README_CN.md)
 
-This document is to guide Android developers to integrate TPMS-SDK-Android in Android 4.4 and above systems.
+
+
 ## 1. Conditions of use:
 1. Android SDK minimum version android4.4 (API 19).
 2. The Bluetooth version used by the device requires 4.0 or above.
@@ -81,12 +83,14 @@ You can also use the aar package dependency, please download it yourself and put
 
 
 
-### 1, Initialization, [key registered address](http://sdk.aicare.net.cn)
+- First configure the key and secret for the SDK, [application address](http://sdk.aicare.net.cn)
+
 ```
 TpmsSDK.init(this, key, secret);
 ```
 
-### 2, Implement the TpmsScan.TpmsScanListener method
+- Implement the TpmsScan.TpmsScanListener method
+
 ```
 TpmsScan mTpmsScan = new TpmsScan (new TpmsScan.TpmsScanListener () {
             @Override
@@ -94,8 +98,11 @@ TpmsScan mTpmsScan = new TpmsScan (new TpmsScan.TpmsScanListener () {
                 
             }
         });
+
 ```
+
 ### 3, search for TpmsScan.startScan (String [] deviceIdS);
+
 ```
     / **
      * Search device, search all devices by default and return through TpmsScanListener interface
@@ -109,8 +116,11 @@ TpmsScan mTpmsScan = new TpmsScan (new TpmsScan.TpmsScanListener () {
      TpmsScan.startScan (String [] deviceIdS)
 
 The found devices will be returned in onGetData (...) in the TpmsScan.TpmsScanListener interface
+
 ```
+
 ### 4, Data analysis returned by the TpmsScan.TpmsScanListener interface
+
 ```
 public void onGetData (String mac, String deviceId, int rssi, float pressure, float battery, int temp, int status, float mcuVersion, int year, int month, int day, float bleVersion);
 
@@ -191,4 +201,28 @@ bleVersion: Bluetooth version number
     }
 
 ```
-### 5, stop searching TpmsScan.stopScan ();
+
+### 5, stop searching TpmsScan.stopScan ();
+
+
+
+## FAQ
+
+- Can't scan the Bluetooth device?
+
+1. Check whether the permissions of the App are normal. The 6.0 and above systems must locate the permissions and need to manually obtain the permissions
+2. Check whether the location service of the mobile phone is turned on, some mobile phones may need to turn on the GPS
+
+
+
+## Contact Us
+Shenzhen elink things Co., Ltd.
+
+Phone: 0755-81773367
+
+Official website: www.elinkthings.com
+
+Email: app@elinkthings.com
+
+
+

README_CN.md

@@ -1,3 +1,4 @@
+[TOC]
 
 # TPMS SDK使用说明 - Android
 [![](https://jitpack.io/v/elinkthings/TmpsSDKRepositoryAndroid.svg)](https://jitpack.io/#elinkthings/TmpsSDKRepositoryAndroid)
@@ -6,16 +7,15 @@
 
 [key注册地址](http://sdk.aicare.net.cn)
 
-[English documentation](README.md)
 
-该文档为指导Android开发人员在Android 4.4及以上系统中集成TPMS-SDK-Android，主要为一些关键的使用示例
-## 一、使用条件：
+
+## 使用条件：
 1.Android SDK最低版本android4.4（API 19）。
 2.设备所使用蓝牙版本需要4.0及以上。
 3.配置java1.8
 4.项目依赖androidx库
 
-## 二、导入SDK
+## 导入SDK
 
 
 ```
@@ -56,7 +56,7 @@ repositories {
 
 ```
 
-## 二、权限设置
+## 权限设置
 
 ```
 <!--In most cases, you need to ensure that the device supports BLE.-->
@@ -77,16 +77,18 @@ repositories {
 
 >  6.0及以上系统必须要定位权限，且需要手动获取权限
 
-## 三、开始集成
+## 开始集成
+
 
 
+- 首先给SDK配置key和secret，[申请地址](http://sdk.aicare.net.cn)
 
-### 1,初始化,[key注册地址](http://sdk.aicare.net.cn)
 ```
 booTpmsSDK.init(this,key,secret);
 ```
 
-### 2,实现TpmsScan.TpmsScanListener方法
+- 实现TpmsScan.TpmsScanListener方法
+
 ```
 TpmsScan mTpmsScan = new TpmsScan(new TpmsScan.TpmsScanListener() {
             @Override
@@ -95,7 +97,7 @@ TpmsScan mTpmsScan = new TpmsScan(new TpmsScan.TpmsScanListener() {
             }
         });
 ```
-### 3,搜索 TpmsScan.startScan(String[] deviceIdS);
+### 搜索 TpmsScan.startScan(String[] deviceIdS);
 ```
     /**
      * 搜索设备,默认搜索所有的设备并通过TpmsScanListener接口返回
@@ -109,8 +111,12 @@ TpmsScan mTpmsScan = new TpmsScan(new TpmsScan.TpmsScanListener() {
      TpmsScan.startScan(String[] deviceIdS)
 
 搜索到的设备会在TpmsScan.TpmsScanListener接口中的onGetData(...)返回
+
 ```
-### 4,TpmsScan.TpmsScanListener接口返回的数据解析
+
+
+### TpmsScan.TpmsScanListener接口返回的数据解析
+
 ```
 public void onGetData(String mac, String deviceId, int rssi, float pressure, float battery,int temp, int status, float mcuVersion, int year, int month, int day,float bleVersion);
 
@@ -191,4 +197,25 @@ bleVersion:蓝牙版本号
     }
 
 ```
-### 5,停止搜索TpmsScan.stopScan();
+
+### 停止搜索TpmsScan.stopScan();
+
+
+## FAQ
+
+- 扫描不到蓝牙设备？
+
+1.查看App权限是否正常,6.0及以上系统必须要定位权限，且需要手动获取权限
+2.查看手机的定位服务是否开启,部分手机可能需要打开GPS
+
+
+
+
+## 联系我们
+深圳市易连物联网有限公司
+
+电话：0755-81773367
+
+官网：www.elinkthings.com
+
+邮箱：app@elinkthings.com