# MinewToolsKit Documentation This set of SDK only supports Bluetooth smart lock devices produced by Minew. The SDK can help developers handle all the work between the mobile phone and the smart lock, incluido: scanning the Bluetooth smart lock, datos de transmisión, unlocking, reading device information, firmware upgrades, etc.. ## Preliminary work Overall framework: `ScanLockManager` is a device management class, que siempre es un singleton cuando la aplicación se está ejecutando. `LockModule` is a device instance class. This kit will generate an instance for each device, que se utilizará después del escaneo y la conexión. It contains device broadcast data, which will be updated as the device continuously broadcasts. `ScanLockManager`：Device management, you can scan the surrounding smart lock devices and stop Bluetooth scanning. `LockModule`：The device instance obtained during scanning corresponds to the Bluetooth smart lock device and will be used after scanning and connecting ## Importar al proyecto 1. Development environment The SDK supports Android 5.0 a lo mínimo, y el nivel API correspondiente es 21. Set `minSdkVersion` to 21or above in module's `build.gradle` 2. ```java android { configuración predeterminada { ID de aplicación "com.xxx.xxx" minSdkVersión 21 } } ``` 3. Add `MinewWristbandKit.jar` to the libs folder of the module, and add the following statement in `build.gradle` of the `module` (agregar dependencias directamente): ```java implementation files('libs/MinewToolsKit.jar') implementación 'org.lucee:bcprov-jdk15on:1.52.0' ``` Or right click on the jar file and select `Add as Library` to add to the current module 4. The following permissions are required in `AndroidManifest.xml`. If `targetSdkVersion` is greater than 23, you need to do **Permission Management** to obtain permissions ```xml <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.BLUETOOTH" /> <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" /> ``` ## Usage ### Start scan **For Android 6.0 y por encima, BLE scanning is only possible after applying for positioning permission, and the positioning switch must be turned on!** ```java MinewLockCenterManager mLockCenterManager = MinewLockCenterManager.getInstance(contexto); mLockCenterManager.getScanLockManager().iniciar escaneo(new OnScanLockResultListener(){ @Override public void onScanLockResult(Lista<LockModule> scanLockList) { //Resultado de la exploracion } }); ``` The sdk does not process the Bluetooth scan duration, pero el escaneo es una operación que consume mucha energía. Generalmente, el escaneo se puede detener en 90 segundos. Si aún necesita continuar con el escaneo, puede proporcionar actualización y otras operaciones para continuar el escaneo. ### Take out the data During scanning, the broadcast data obtained by the SDK is stored in the broadcast frame, and the scanned device mac address is placed in LockModule.getMacAddress() in List, which is required for a series of operations on the device. Frame information is also stored in LockModuleLockModule .getMinewFrame(FrameType type), There are currently these frames：FrameType.DEVICE\_INFO\_FRAME；HISTORY\_ERROR\_INFO\_FRAME，暂时未用到 ### Operate the smart lock device At present, the operations of smart locks mainly include: unlocking, reading device information, and firmware upgrades. Each operation is to connect the smart lock first, and then send the corresponding instructions to the smart lock to perform the corresponding steps. After each operation is completed, it will be automatically disconnected. Open the smart lock connection, no need to disconnect the device ```java MinewLockCenterManager mCenterManager = MinewLockCenterManager.getInstance(contexto); //Before operating the smart lock, call the method, initialize the number of operations //and start the 10-second timeout timer mCenterManager.getConnLockManager().initOperaState(); /* * Devolución de llamada de estado durante la conexión * * @param context * @param LockModule: Device to connect * @param OperationType: Operation type * unlock OperationType.OPERA_OPEN_LOCK； * Read device information: OperationType.OPERA_READ_DEVICE; * There are two steps to firmware upgrade: OperationType.OPERA_OTA1， OperationType.OPERA_OT2， * connect()Method used OPERA_OTA1 * @param OnConnStateListener: Operation interface return status */ mCenterManager.getConnLockManager().connect(contexto, LockModule,OperationType, nuevo OnConnStateListener() { @Override public void onOperaLockState(Dirección mac de cadena, ConnectionState connectionState, ConnectionState operaState,boolean operaResult, String result) { } }); ``` 固件升级； ```java /** * Actualización de firmware * * @param macAddress: Device mac * @param data: Upgrade package data byte[] datos * @param OperationType.OPERA_OTA2 * @param listener Listener */ manager.firmwareActualizar(dirección MAC, datos, OperationType.OPERA_OTA2, nuevo OnFirmwareUpgradeListener, nuevo OnFirmwareUpgradeListener() { /** * Start firmware upgrade */ @Override public void startUpgrade() { } /** * Upgrade package data writing progress */ @Override public void updateProgress(progreso interno) { } /** * update successed */ @Override public void upgradeSuccess() { } /** * upgrade unsuccessful */ @Override public void upgradeFailed() { } }); ``` ### API summary #### Before connecting 1. iniciar escaneo(): Start scanning. Every time you start a scan, all results of the previous scan will be cleared 2. Parar escaneo():Stop scanning 3. connect(Context context, LockModule lockModule,OperationType operationType, OnConnStateListener listener ): Operate the smart lock 4. disConnect(Dirección mac de cadena): Desconectar 5. initOperaState(): Initialization before operation ## Schedule nothing ## Update history **2020/10/15** 1. Create SDK instructions; Última actualización:: 1/19/2021, 3:19:00 PM