Release 2.2.1

HerdX · Feb 21, 2020 · 489c9f4 · 489c9f4
2 parents 7a5e301 + 07e346a
commit 489c9f4
Show file tree

Hide file tree

Showing 21 changed files with 282 additions and 92 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 2.2.1
+
+* Hide private APIs
+* Add setup instructions to README
+* Add missing descriptor operations information to README
+* Moved permission_handler dependency to its place in example
+
 ## 2.2.0
 
 * **NEW** operations on descriptors

diff --git a/README.md b/README.md
@@ -6,46 +6,83 @@
 
 # FlutterBleLib
 
-A library for all your Bluetooth Low Energy needs in Flutter. Internally utilises Polidea's 
-[MultiPlatformBleAdapter](https://github.com/Polidea/MultiPlatformBleAdapter), 
+A library for all your Bluetooth Low Energy needs in Flutter. Internally utilises Polidea's
+[MultiPlatformBleAdapter](https://github.com/Polidea/MultiPlatformBleAdapter),
 which runs on [RxAndroidBle](https://github.com/Polidea/RxAndroidBle)
- and [RxBluetoothKit](https://github.com/Polidea/RxBluetoothKit).
+and [RxBluetoothKit](https://github.com/Polidea/RxBluetoothKit).
 
 ## BLE Simulator
-This library supports [BLEmulator](https://github.com/Polidea/blemulator_flutter), the BLE simulator. 
+
+This library supports [BLEmulator](https://github.com/Polidea/blemulator_flutter), the BLE simulator.
 The simulation allows one to develop without physical smartphone or BLE peripheral and use one's production BLE–related code in automated testing.
 
+## Installation
+
+To use this plugin, add `flutter_ble_lib` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/packages-and-plugins/using-packages).
+
+### Android
+
+Set `minSDKVersion` in `[project]/android/app/build.gradle` file to 18.
+
+```gradle
+defaultConfig {
+  ...
+  minSdkVersion 18
+  ...
+}
+```
+
+Support for Bluetooth Low Energy has been added in API 18, hence the library requires `minSDKVersion` to be set to 18. If BLE is not core to your application, [you can override it](https://stackoverflow.com/questions/27335889/how-do-i-ignore-minsdkversion-of-library-in-android-studio) and handle support detection in your code.
+
+**Notice:** You don't need to add any permissions related to BLE to the `AndroidManifest.xml`, because they are already declared in the library's native module. However, you still need to request `ACCESS_FINE_LOCATION` permission at runtime to be able to scan for peripheral. See [example's code](https://github.com/Polidea/FlutterBleLib/blob/202c6fe48300be207f80567ca4bee5b6fbc83eb5/example/lib/devices_list/devices_bloc.dart#L80) and [example's pubspec](https://github.com/Polidea/FlutterBleLib/blob/202c6fe48300be207f80567ca4bee5b6fbc83eb5/example/pubspec.yaml#L20).
+
+### iOS
+
+Go to `[project]/ios` directory and run `pod install`.
+
+Add [Privacy - Bluetooth Always Usage Description](https://developer.apple.com/documentation/bundleresources/information_property_list/nsbluetoothalwaysusagedescription) key to `[project]/ios/Runner/Info.plist` file.
+
+```xml
+...
+<key>NSBluetoothAlwaysUsageDescription</key>
+<string>Your own description of the purpose.</string>
+...
+```
+
 ## Usage
-To use this plugin, add `flutter_ble_lib` as a [dependency in your pubspec.yaml file](https://pub.dev/packages/flutter_ble_lib/versions/2.0.0-dev.4).
 
-## Overview
 The library is organised around a few base entities, which are:
-* **BleManager**
-* **Peripheral**
-* **Service**
-* **Characteristic**
 
-You have to create an instance _BleManager_ and initialise underlying native resources. 
+- **BleManager**
+- **Peripheral**
+- **Service**
+- **Characteristic**
+* **Descriptor**
+
+You have to create an instance _BleManager_ and initialise underlying native resources.
 Using that instance you then obtain an instance of _Peripheral_,
- which can be used to run operations on the corresponding peripheral.
- 
- All operations passing the Dart-native bridge are asynchronous,
-  hence all operations in the plugin return either Future or Stream.
+which can be used to run operations on the corresponding peripheral.
+
+All operations passing the Dart-native bridge are asynchronous,
+hence all operations in the plugin return either Future or Stream.
 
 For more informations, see [REFERENCE](https://github.com/Polidea/FlutterBleLib/blob/master/REFERENCE.md).
 
-**Notice:** this library will not handle any permissions for you. To be able to scan for peripherals on Android you need `ACCESS_FINE_LOCATION` [according to Android Developer Guide](https://developer.android.com/guide/topics/connectivity/bluetooth-le#permissions). 
+**Notice:** this library will not handle any permissions for you. To be able to scan for peripherals on Android you need `ACCESS_FINE_LOCATION` [according to Android Developer Guide](https://developer.android.com/guide/topics/connectivity/bluetooth-le#permissions).
 
 ### Initialising
+
 ```dart
 BleManager bleManager = BleManager();
 await bleManager.createClient(); //ready to go!
 // your peripheral logic
 bleManager.destroyClient(); //remember to release native resources when you're done!
 ```
+
 Following snippets assume the library has been initialised.
 
 ### Handling Bluetooth adapter state
+
 ```dart
 enum BluetoothState {
   UNKNOWN,
@@ -65,7 +102,9 @@ bleManager.observeBluetoothState().listen((btState) {
   //do your BT logic, open different screen, etc.
 });
 ```
+
 ### Scanning for peripherals
+
 ```dart
 bleManager.startPeripheralScan(
   uuids: [
@@ -78,13 +117,15 @@ bleManager.startPeripheralScan(
 });
 ```
 
-The snippet above starts peripheral scan and stops it after receiving first result. 
+The snippet above starts peripheral scan and stops it after receiving first result.
 It filters the scan results to those that advertise a service with specified UUID.
 
 **NOTE:** `isConnectable` and `overflowServiceUuids` fields of `ScanResult` are iOS-only and remain `null` on Android.
 
 ### Connecting to peripheral
+
 First you must obtain a _ScanResult_ from _BleManager.startPeripheralScan()_.
+
 ```dart
 Peripheral peripheral = scanResult.peripheral;
 peripheral.observeConnectionState(emitCurrentValue: true, completeOnDisconnect: true)
@@ -97,20 +138,21 @@ await peripheral.disconnectOrCancelConnection();
 ```
 
 The snippet above starts observing the state of the connection to the peripheral,
- connects to it, checks if it's connected and then disconnects from it.
+connects to it, checks if it's connected and then disconnects from it.
 
 ### Transactions
 
 Methods that do not have counterpart with opposite effect and are asynchronous accept
- `String transactionId` as an optional argument, to allow the user to cancel such an operation.
- The Future returned to Dart will then finish with a _BleError(BleErrorCode.operationCancelled...)_,
- **but this will only discard the result of the operation, the operation itself will be executed either way**.
- 
+`String transactionId` as an optional argument, to allow the user to cancel such an operation.
+The Future returned to Dart will then finish with a _BleError(BleErrorCode.operationCancelled...)_,
+**but this will only discard the result of the operation, the operation itself will be executed either way**.
+
 For example, if I decided that I no longer want to run discovery on the selected peripheral:
+
 ```dart
 //assuming peripheral is connected
-peripheral.discoverAllServicesAndCharacteristics(transactionId: "discovery"); 
-//will return operation cancelled error after calling the below 
+peripheral.discoverAllServicesAndCharacteristics(transactionId: "discovery");
+//will return operation cancelled error after calling the below
 bleManager.cancelTransaction("discovery");
 ```
 
@@ -136,10 +178,13 @@ List<Characteristic> characteristics2 = await services.firstWhere(
 ```
 
 Objects representing characteristics have a unique identifer, so they point to one specific characteristic,
- even if there are multiple service/characteristic uuid matches.
+even if there are multiple service/characteristic uuid matches.
+
 ### Manipulating characteristics
+
 Below are 3 methods of writing to a characteristic, which all result in the same effect given
- there's only one service with specified UUID and only one characteristic with specified UUID.
+there's only one service with specified UUID and only one characteristic with specified UUID.
+
 ```dart
 peripheral.writeCharacteristic(
   "F000AA00-0451-4000-B000-000000000000",
@@ -156,22 +201,32 @@ characteristic.write(Uint8List.fromList([0]), false); //returns void
 ```
 
 Monitoring or reading a characteristic from _Peripheral_/_Service_ level 
- return _CharacteristicWithValue_ object, which is _Characteristic_ with additional `Uint8List value` property.
+return _CharacteristicWithValue_ object, which is _Characteristic_ with additional `Uint8List value` property.
+
+ ### Descriptor operations
+
+List of descriptors from a single characteristic can be obtained in a similar fashion to a list of characteristics from a single service, either from Peripheral, Service or Characteristic object.
+Descriptors can be read/written from Peripheral, Service or Characteristic by supplying necessary UUIDs, or from Descriptor object.
+
+**Note:** to enable monitoring of characteristic you should use `characteristic.monitor()` or `(peripheral/service).monitorCharacteristic()` instead of changing the value of the underlying descriptor yourself.
 
 ## Facilitated by Frontside 
 [Frontside](https://github.com/thefrontside) provided architectural advice and financial support for this library on behalf of [Resideo](https://github.com/resideo). 
 
 ## Maintained by
+
 This library is maintained by [Polidea](https://www.polidea.com/?utm_source=Github&utm_medium=Npaid&utm_campaign=Main&utm_term=Code&utm_content=GH_NOP_MPG_COD_FBLE001)
 
 [Contact us](https://www.polidea.com/project/?utm_source=Github&utm_medium=Npaid&utm_campaign=Kontakt&utm_term=Code&utm_content=GH_NOP_KKT_COD_FBLE001)
 
 [Learn more about Polidea's BLE services](https://www.polidea.com/services/ble/?utm_source=Github&utm_medium=Npaid&utm_campaign=Tech_BLE&utm_term=Code&utm_content=GH_NOP_BLE_COD_FBLE001).
 
 #### Maintainers
+
 TBD
 
 ## License
+
 Copyright 2019 Polidea Sp. z o.o
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -187,7 +242,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 ## More from Polidea
+
 Check out other Polidea's BLE libraries:
-* [react-native-ble-plx](https://github.com/Polidea/react-native-ble-plx)
-* [RxAndroidBle](https://github.com/Polidea/RxAndroidBle)
-* [RxBluetoothKit](https://github.com/Polidea/RxBluetoothKit)
+
+- [react-native-ble-plx](https://github.com/Polidea/react-native-ble-plx)
+- [RxAndroidBle](https://github.com/Polidea/RxAndroidBle)
+- [RxBluetoothKit](https://github.com/Polidea/RxBluetoothKit)