Support multiple services or characteristics with the same id (#776)

* Allow multiple services/characteristics of the same type on iOS

* Allow multiple services/characteristics of the same type on Android

* Update example to use new interface

* Rename QualifiedCharacteristic to CharacteristicInstance to match Dart

* Extend documentation

* Update and extend tests

* Address review comments

* Update Kotlin tests

---------

Co-authored-by: Sander Kersten <[email protected]>

Author: spkersten

example/lib/main.dart

@@ -24,11 +24,10 @@ void main() {
     logMessage: _bleLogger.addToLog,
   );
   final _serviceDiscoverer = BleDeviceInteractor(
-    bleDiscoverServices: _ble.discoverServices,
-    readCharacteristic: _ble.readCharacteristic,
-    writeWithResponse: _ble.writeCharacteristicWithResponse,
-    writeWithOutResponse: _ble.writeCharacteristicWithoutResponse,
-    subscribeToCharacteristic: _ble.subscribeToCharacteristic,
+    bleDiscoverServices: (deviceId) async {
+      await _ble.discoverAllServices(deviceId);
+      return _ble.getDiscoveredServices(deviceId);
+    },
     logMessage: _bleLogger.addToLog,
   );
   runApp(

example/lib/src/ble/ble_device_interactor.dart

@@ -4,44 +4,16 @@ import 'package:flutter_reactive_ble/flutter_reactive_ble.dart';
 
 class BleDeviceInteractor {
   BleDeviceInteractor({
-    required Future<List<DiscoveredService>> Function(String deviceId)
-        bleDiscoverServices,
-    required Future<List<int>> Function(QualifiedCharacteristic characteristic)
-        readCharacteristic,
-    required Future<void> Function(QualifiedCharacteristic characteristic,
-            {required List<int> value})
-        writeWithResponse,
-    required Future<void> Function(QualifiedCharacteristic characteristic,
-            {required List<int> value})
-        writeWithOutResponse,
+    required Future<List<Service>> Function(String deviceId) bleDiscoverServices,
     required void Function(String message) logMessage,
-    required Stream<List<int>> Function(QualifiedCharacteristic characteristic)
-        subscribeToCharacteristic,
   })  : _bleDiscoverServices = bleDiscoverServices,
-        _readCharacteristic = readCharacteristic,
-        _writeWithResponse = writeWithResponse,
-        _writeWithoutResponse = writeWithOutResponse,
-        _subScribeToCharacteristic = subscribeToCharacteristic,
         _logMessage = logMessage;
 
-  final Future<List<DiscoveredService>> Function(String deviceId)
-      _bleDiscoverServices;
-
-  final Future<List<int>> Function(QualifiedCharacteristic characteristic)
-      _readCharacteristic;
-
-  final Future<void> Function(QualifiedCharacteristic characteristic,
-      {required List<int> value}) _writeWithResponse;
-
-  final Future<void> Function(QualifiedCharacteristic characteristic,
-      {required List<int> value}) _writeWithoutResponse;
-
-  final Stream<List<int>> Function(QualifiedCharacteristic characteristic)
-      _subScribeToCharacteristic;
+  final Future<List<Service>> Function(String deviceId) _bleDiscoverServices;
 
   final void Function(String message) _logMessage;
 
-  Future<List<DiscoveredService>> discoverServices(String deviceId) async {
+  Future<List<Service>> discoverServices(String deviceId) async {
     try {
       _logMessage('Start discovering services for: $deviceId');
       final result = await _bleDiscoverServices(deviceId);
@@ -52,59 +24,4 @@ class BleDeviceInteractor {
       rethrow;
     }
   }
-
-  Future<List<int>> readCharacteristic(
-      QualifiedCharacteristic characteristic) async {
-    try {
-      final result = await _readCharacteristic(characteristic);
-
-      _logMessage('Read ${characteristic.characteristicId}: value = $result');
-      return result;
-    } on Exception catch (e, s) {
-      _logMessage(
-        'Error occurred when reading ${characteristic.characteristicId} : $e',
-      );
-      // ignore: avoid_print
-      print(s);
-      rethrow;
-    }
-  }
-
-  Future<void> writeCharacteristicWithResponse(
-      QualifiedCharacteristic characteristic, List<int> value) async {
-    try {
-      _logMessage(
-          'Write with response value : $value to ${characteristic.characteristicId}');
-      await _writeWithResponse(characteristic, value: value);
-    } on Exception catch (e, s) {
-      _logMessage(
-        'Error occurred when writing ${characteristic.characteristicId} : $e',
-      );
-      // ignore: avoid_print
-      print(s);
-      rethrow;
-    }
-  }
-
-  Future<void> writeCharacteristicWithoutResponse(
-      QualifiedCharacteristic characteristic, List<int> value) async {
-    try {
-      await _writeWithoutResponse(characteristic, value: value);
-      _logMessage(
-          'Write without response value: $value to ${characteristic.characteristicId}');
-    } on Exception catch (e, s) {
-      _logMessage(
-        'Error occurred when writing ${characteristic.characteristicId} : $e',
-      );
-      // ignore: avoid_print
-      print(s);
-      rethrow;
-    }
-  }
-
-  Stream<List<int>> subScribeToCharacteristic(
-      QualifiedCharacteristic characteristic) {
-    _logMessage('Subscribing to: ${characteristic.characteristicId} ');
-    return _subScribeToCharacteristic(characteristic);
-  }
 }

example/lib/src/ui/device_detail/characteristic_interaction_dialog.dart

@@ -10,50 +10,27 @@ class CharacteristicInteractionDialog extends StatelessWidget {
     required this.characteristic,
     Key? key,
   }) : super(key: key);
-  final QualifiedCharacteristic characteristic;
+  final Characteristic characteristic;
 
   @override
   Widget build(BuildContext context) => Consumer<BleDeviceInteractor>(
-      builder: (context, interactor, _) => _CharacteristicInteractionDialog(
-            characteristic: characteristic,
-            readCharacteristic: interactor.readCharacteristic,
-            writeWithResponse: interactor.writeCharacteristicWithResponse,
-            writeWithoutResponse: interactor.writeCharacteristicWithoutResponse,
-            subscribeToCharacteristic: interactor.subScribeToCharacteristic,
-          ));
+        builder: (context, interactor, _) => _CharacteristicInteractionDialog(characteristic: characteristic),
+      );
 }
 
 class _CharacteristicInteractionDialog extends StatefulWidget {
   const _CharacteristicInteractionDialog({
     required this.characteristic,
-    required this.readCharacteristic,
-    required this.writeWithResponse,
-    required this.writeWithoutResponse,
-    required this.subscribeToCharacteristic,
     Key? key,
   }) : super(key: key);
 
-  final QualifiedCharacteristic characteristic;
-  final Future<List<int>> Function(QualifiedCharacteristic characteristic)
-      readCharacteristic;
-  final Future<void> Function(
-          QualifiedCharacteristic characteristic, List<int> value)
-      writeWithResponse;
-
-  final Stream<List<int>> Function(QualifiedCharacteristic characteristic)
-      subscribeToCharacteristic;
-
-  final Future<void> Function(
-          QualifiedCharacteristic characteristic, List<int> value)
-      writeWithoutResponse;
+  final Characteristic characteristic;
 
   @override
-  _CharacteristicInteractionDialogState createState() =>
-      _CharacteristicInteractionDialogState();
+  _CharacteristicInteractionDialogState createState() => _CharacteristicInteractionDialogState();
 }
 
-class _CharacteristicInteractionDialogState
-    extends State<_CharacteristicInteractionDialog> {
+class _CharacteristicInteractionDialogState extends State<_CharacteristicInteractionDialog> {
   late String readOutput;
   late String writeOutput;
   late String subscribeOutput;
@@ -71,13 +48,13 @@ class _CharacteristicInteractionDialogState
 
   @override
   void dispose() {
+    textEditingController.dispose();
     subscribeStream?.cancel();
     super.dispose();
   }
 
   Future<void> subscribeCharacteristic() async {
-    subscribeStream =
-        widget.subscribeToCharacteristic(widget.characteristic).listen((event) {
+    subscribeStream = widget.characteristic.subscribe().listen((event) {
       setState(() {
         subscribeOutput = event.toString();
       });
@@ -88,28 +65,23 @@ class _CharacteristicInteractionDialogState
   }
 
   Future<void> readCharacteristic() async {
-    final result = await widget.readCharacteristic(widget.characteristic);
+    final result = await widget.characteristic.read();
     setState(() {
       readOutput = result.toString();
     });
   }
 
-  List<int> _parseInput() => textEditingController.text
-      .split(',')
-      .map(
-        int.parse,
-      )
-      .toList();
+  List<int> _parseInput() => textEditingController.text.split(',').map(int.parse).toList();
 
   Future<void> writeCharacteristicWithResponse() async {
-    await widget.writeWithResponse(widget.characteristic, _parseInput());
+    await widget.characteristic.write(_parseInput());
     setState(() {
       writeOutput = 'Ok';
     });
   }
 
   Future<void> writeCharacteristicWithoutResponse() async {
-    await widget.writeWithoutResponse(widget.characteristic, _parseInput());
+    await widget.characteristic.write(_parseInput(), withResponse: false);
     setState(() {
       writeOutput = 'Done';
     });
@@ -202,7 +174,7 @@ class _CharacteristicInteractionDialogState
               Padding(
                 padding: const EdgeInsets.symmetric(vertical: 8.0),
                 child: Text(
-                  widget.characteristic.characteristicId.toString(),
+                  widget.characteristic.id.toString(),
                 ),
               ),
               divider,
@@ -217,8 +189,9 @@ class _CharacteristicInteractionDialogState
                 child: Padding(
                   padding: const EdgeInsets.only(top: 20.0),
                   child: ElevatedButton(
-                      onPressed: () => Navigator.of(context).pop(),
-                      child: const Text('close')),
+                    onPressed: () => Navigator.of(context).pop(),
+                    child: const Text('close'),
+                  ),
                 ),
               )
             ],