# 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, включая: scanning the Bluetooth smart lock, широковещательные данные, unlocking, reading device information, firmware upgrades, и т. д.. ## Preliminary work Overall framework: `ScanLockManager` is a device management class, который всегда является синглтоном, когда приложение работает. `LockModule` is a device instance class. This kit will generate an instance for each device, который будет использоваться после сканирования и подключения. 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 ## Импортировать в проект 1. Development environment The SDK supports Android 5.0 минимум, и соответствующий уровень API 21. Set `minSdkVersion` to 21or above in module's `build.gradle` 2. ```java android { defaultConfig { идентификатор приложения "com.xxx.xxx" minSdkVersion 21 } } ``` 3. Add `MinewWristbandKit.jar` to the libs folder of the module, and add the following statement in `build.gradle` of the `module` (добавить зависимости напрямую): ```java implementation files('libs/MinewToolsKit.jar') реализация '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" /> ``` ## Использование ### Start scan **For Android 6.0 и выше, BLE scanning is only possible after applying for positioning permission, and the positioning switch must be turned on!** ```java MinewLockCenterManager mLockCenterManager = MinewLockCenterManager.getInstance(контекст); mLockCenterManager.getScanLockManager().startScan(new OnScanLockResultListener(){ @Override public void onScanLockResult(Список<LockModule> scanLockList) { //результат сканирования } }); ``` The sdk does not process the Bluetooth scan duration, но сканирование — энергозатратная операция. В целом, сканирование можно остановить в 90 секунды. Если вам все еще нужно продолжить сканирование, вы можете выполнить обновление и другие операции для продолжения сканирования.. ### 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(контекст); //Before operating the smart lock, call the method, initialize the number of operations //and start the 10-second timeout timer mCenterManager.getConnLockManager().initOperaState(); /* * Обратный вызов статуса во время соединения * * @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(контекст, LockModule,OperationType, новый OnConnStateListener() { @Override public void onOperaLockState(Строка macAddress, ConnectionState connectionState, ConnectionState operaState,boolean operaResult, String result) { } }); ``` 固件升级； ```Ява /** * Обновление прошивки * * @param macAddress: Device mac * @param data: Upgrade package data byte[] данные * @param OperationType.OPERA_OTA2 * @param listener Listener */ Manager.firmwareUpgrade(MAC-адрес, данные, OperationType.OPERA_OTA2, новый прослушиватель OnFirmwareUpgradeListener, новый прослушиватель OnFirmwareUpgradeListener() { /** * Start firmware upgrade */ @Override public void startUpgrade() { } /** * Upgrade package data writing progress */ @Override public void updateProgress(внутренний прогресс) { } /** * update successed */ @Override public void upgradeSuccess() { } /** * upgrade unsuccessful */ @Override public void upgradeFailed() { } }); ``` ### API summary #### Before connecting 1. startScan(): Start scanning. Every time you start a scan, all results of the previous scan will be cleared 2. stopScan():Stop scanning 3. connect(Context context, LockModule lockModule,OperationType operationType, OnConnStateListener listener ): Operate the smart lock 4. disConnect(Строка macAddress): Отключить 5. initOperaState(): Initialization before operation ## Schedule nothing ## Update history **2020/10/15** 1. Create SDK instructions; Last Updated:: 1/19/2021, 3:19:00 ПМ