Merge pull request #1283 from carp-dk/bardram-movesense-plus-hr-update

Update of docs on address format

Author: bardram

packages/movesense_plus/CHANGELOG.md

@@ -1,6 +1,13 @@
+## 1.1.1
+
+Update of docs to highlight that the `address` format is platform dependent:
+
+* on Android, the address is the Bluetooth MAC address (e.g. `0C:8C:DC:1B:23:BF`).
+* on iOS, the address is the UUID of the device (e.g. `00000000-0000-0000-0000-000000000000`).
+
 ## 1.1.0
 
-* added R-R interval to HR reading
+Added R-R interval to HR reading
 
 ## 1.0.0
 

packages/movesense_plus/README.md

@@ -73,7 +73,7 @@ The singleton `Movesense` can be used for scanning devices:
 ```dart
 /// Listen for discovered devices
 Movesense().devices.listen((device) {
-  debugPrint('Discovered device: ${device.name} [${device.address}]');
+  print('Discovered device: ${device.name} [${device.address}]');
 });
 /// Start scanning.
 Movesense().scan();

packages/movesense_plus/lib/movesense_device.dart

@@ -7,7 +7,8 @@ class MovesenseDevice {
 
   /// The Movesense device address.
   ///
-  /// Address is Bluetooth MAC address for Android devices and UUID for iOS devices.
+  /// Address is Bluetooth MAC address for Android devices and UUID for
+  /// iOS devices.
   String? address;
 
   /// The Movesense device serial number.
@@ -36,6 +37,13 @@ class MovesenseDevice {
   final _statusController =
       StreamController<DeviceConnectionStatus>.broadcast();
 
+  /// Creates a new Movesense device with the given [address].
+  ///
+  /// The [address] must be set in before connecting to the device.
+  /// Note that the [address] format is platform dependent:
+  /// - On Android, the address is the Bluetooth MAC address (e.g. "0C:8C:DC:1B:23:BF").
+  /// - On iOS, the address is the UUID of the device (e.g. "00000000-0000-0000-0000-000000000000").
+  /// The [serial], [name] and [deviceType] are set upon successful connection.
   MovesenseDevice({
     this.address,
     this.serial,

packages/movesense_plus/pubspec.yaml

@@ -1,6 +1,6 @@
 name: movesense_plus
 description: "A Flutter package for Movesense sensor integration. Wraps the MDS plugin and provides easy access to Movesense device features and data streams."
-version: 1.1.0
+version: 1.1.1
 homepage: https://github.com/cph-cachet/flutter-plugins/tree/master/packages/movesense_plus
 
 environment: