Readme and license

Author: philips77

LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, Nordic Semiconductor
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of Nordic Semiconductor ASA nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

README.md

@@ -0,0 +1,55 @@
+# Android BLE Library
+
+This library has been extracted from [nRF Toolbox](https://github.com/NordicSemiconductor/Android-nRF-Toolbox)
+project. It contains classes useful when doing a connection to a Bluetooth LE device.
+
+### Features
+
+**BleManager** class provides the following features:
+
+1. Connection
+2. Service discovery
+3. Bonding (optional)
+4. Enabling Service Changed indications
+5. Device initialization
+6. Async BLE operations using queue
+7. Reading Battery Level value
+8. Requesting MTU and connection priority
+9. Error handling
+10. Logging (in LogCat and optionally nRF Logger)
+
+It may be used for a single connection (see [nRF Toolbox](https://github.com/NordicSemiconductor/Android-nRF-Toolbox) -> RSC profile) 
+or when multiple connections are required (see nRF Toolbox -> Proximity profile), 
+from a Service (see nRF Toolbox -> RSC profile), 
+ViewModel's repo (see [Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html) and [nRF Blinky](https://github.com/NordicSemiconductor/Android-nRF-Blinky)),
+or as a singleton (not recommended, see nRF Toolbox -> HRM).
+
+**BleManager** exposes a high level API instead of low level BLE operations. 
+If autoConnect option is to be used, the manager also handles initial connection (with autoConnect = false),
+which is much faster, and then reconnects in case of link loss with this parameter set to true.
+Just return *true* from `shouldAutoConnect()` method in your manager.
+
+### How to include it in your project
+
+Clone this project and add *ble* module as a dependency to your project:
+
+1. In *settings.gradle* file add the following lines:
+```groovy
+include ':ble'
+project(':ble').projectDir = file('../Android-BLE-Library/ble')
+```
+2. In *app/build.gradle* file add `implementation project(':ble')` inside dependencies.
+3. Sync project and build it
+
+See example projects listed below.
+
+### How to use it
+
+1. Define your device API by extending BleManagerCallbacks: [example](https://github.com/NordicSemiconductor/Android-nRF-Blinky/blob/master/app/src/main/java/no/nordicsemi/android/blinky/profile/BlinkyManagerCallbacks.java)
+2. Extend BleManager class and implement required methods: [example](https://github.com/NordicSemiconductor/Android-nRF-Blinky/blob/master/app/src/main/java/no/nordicsemi/android/blinky/profile/BlinkyManager.java)
+
+### Example
+
+Find the simple example here [Android nRF Blinky](https://github.com/NordicSemiconductor/Android-nRF-Blinky).
+
+For an example how to use it from an Activity or a Service, check the base Activity and Service classes in [nRF Toolbox](https://github.com/NordicSemiconductor/Android-nRF-Toolbox/tree/master/app/src/main/java/no/nordicsemi/android/nrftoolbox/profile).