Release/v1.1.1 (#27)

* chore: start with userId and propagation profile

* chore: update version 1.1.1

Author: julian-bridgefy

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Bridgefy Flutter 1.1.0
+# Bridgefy Flutter 1.1.1
 ### BLUETOOTH MESH NETWORKS
 
 Devices running your app create Bluetooth Low-Energy mesh networks, which work in large crowds, during and after natural disasters, and whenever else your users lose access to the Internet.

README.md

@@ -44,7 +44,7 @@ To install this SDK, you'll need to either add the following to your `pubspec.ya
 
 ```yaml
 dependencies:
-  bridgefy: ^1.1.0
+  bridgefy: ^1.1.1
 ```
 
 Or run this flutter command:
@@ -57,11 +57,11 @@ flutter pub add bridgefy
 
 ### Initialization
 
-The init method initializes the Bridgefy SDK with the given API key and propagation profile. The
+The init method initializes the Bridgefy SDK with the given API key and verbose logging. The
 delegate parameter is required and should be an object that conforms to the `BridgefyDelegate`
 mixin.
 
-The following code shows how to start the SDK (using your API key) and how to assign the delegate.
+The following code shows how to init the SDK (using your API key) and how to assign the delegate.
 
 ```dart
 import 'package:bridgefy/bridgefy.dart';
@@ -72,13 +72,29 @@ class _MyAppState extends State<MyApp> implements BridgefyDelegate {
   @override
   void initState() {
     super.initState();
-    _bridgefy.initialize(
-      apiKey: "<API_KEY>",
-      propagationProfile: BridgefyPropagationProfile.longReach,
-      delegate: this
-    );
+    try {
+      await _bridgefy.initialize(
+        apiKey: "<API_KEY>",
+        delegate: this,
+        verboseLogging: true,
+      );
+    } catch (e) {
+      _log("Unable to initialize: $e");
+    }
   }
 ```
+### Start Bridgefy
+
+The following code shows how to start the SDK with propagation profile and custom user Id.
+
+````dart
+
+    _bridgefy.start(
+      userId: "Custom UUID",
+      propagationProfile: BridgefyPropagationProfile.standard
+    );
+
+````
 
 ### Sending data
 
@@ -124,6 +140,26 @@ void bridgefyDidReceiveData({
 }
 ```
 
+### Nearby peer detection
+
+The following method is invoked when a peer has established connection:
+
+```dart
+    @override
+    void bridgefyDidConnect({required String userID}) {
+      // `userID` the peer connected
+    }
+```
+
+When a peer is disconnected(out of range), the following method will be invoked:
+
+```dart
+    @override
+    void bridgefyDidDisconnect({required String userID}) {
+      // `userID` the peer disconnected
+    }
+```
+
 To see a full list of events, take a look at the `BridgefyDelegate` mixin.
 
 ## Multi-Platform Support

android/src/main/kotlin/me/bridgefy/plugin/flutter/BridgefyPlugin.kt

@@ -180,7 +180,13 @@ class BridgefyPlugin : FlutterPlugin, MethodCallHandler {
     }
 
     private fun start(@NonNull call: MethodCall, @NonNull result: Result) {
-        bridgefy.start()
+        val args = call.arguments as HashMap<String, Any>
+        val userId: String? = args["userId"] as String?
+        val propagationProfile = propagationProfileFromString(args["propagationProfile"] as String) ?: PropagationProfile.Standard
+        bridgefy.start(
+            userId?.let{ UUID.fromString(it)},
+            propagationProfile
+        )
         result.success(null)
     }
 

example/lib/main.dart

@@ -26,16 +26,16 @@ class _MyAppState extends State<MyApp> implements BridgefyDelegate {
   final _scrollController = ScrollController();
 
   @override
-  void dispose() { 
+  void dispose() {
     _scrollController.dispose();
     super.dispose();
   }
 
-  _goToEnd(){
-    Timer(const Duration(milliseconds:300), (){
+  _goToEnd() {
+    Timer(const Duration(milliseconds: 300), () {
       _scrollController.animateTo(
-        _scrollController.position.maxScrollExtent, 
-        duration: const Duration(milliseconds:200), 
+        _scrollController.position.maxScrollExtent,
+        duration: const Duration(milliseconds: 200),
         curve: Curves.linear,
       );
     });
@@ -68,10 +68,8 @@ class _MyAppState extends State<MyApp> implements BridgefyDelegate {
 
   @override
   Widget build(BuildContext context) {
-    SystemChrome.setPreferredOrientations([
-      DeviceOrientation.portraitUp,
-      DeviceOrientation.portraitDown
-    ]);
+    SystemChrome.setPreferredOrientations(
+        [DeviceOrientation.portraitUp, DeviceOrientation.portraitDown]);
 
     return MaterialApp(
       theme: ThemeData(
@@ -93,28 +91,26 @@ class _MyAppState extends State<MyApp> implements BridgefyDelegate {
                   mainAxisAlignment: MainAxisAlignment.center,
                   children: [
                     ElevatedButton.icon(
-                      icon: _didStart ? 
-                        const Icon(Icons.stop_circle) : 
-                        const Icon(Icons.check_circle),
-                      onPressed: _toggleStart,
-                      label: Text(_buttonText)
-                    ),
+                        icon: _didStart
+                            ? const Icon(Icons.stop_circle)
+                            : const Icon(Icons.check_circle),
+                        onPressed: _toggleStart,
+                        label: Text(_buttonText)),
                     const SizedBox(width: 7),
                     ElevatedButton.icon(
-                      icon: const Icon(Icons.send),
-                      onPressed: _didStart ? _send : null,
-                      label: const Text("Send")
-                    ),
+                        icon: const Icon(Icons.send),
+                        onPressed: _didStart ? _send : null,
+                        label: const Text("Send")),
                     const SizedBox(width: 7),
                     ElevatedButton.icon(
-                      icon: const Icon(Icons.delete_forever),
-                      onPressed: _logStr!='' ? _clearLogs : null,
-                      label: const Text("Logs")
-                    ),
+                        icon: const Icon(Icons.delete_forever),
+                        onPressed: _logStr != '' ? _clearLogs : null,
+                        label: const Text("Logs")),
                   ],
                 ),
                 const SizedBox(height: 10),
-                const Text("Logs", style: TextStyle(fontWeight: FontWeight.bold)),
+                const Text("Logs",
+                    style: TextStyle(fontWeight: FontWeight.bold)),
                 const SizedBox(height: 10),
                 Expanded(
                   child: SafeArea(
@@ -179,7 +175,8 @@ class _MyAppState extends State<MyApp> implements BridgefyDelegate {
   }
 
   @override
-  void bridgefyDidFailSendingMessage({required String messageID, BridgefyError? error}) {
+  void bridgefyDidFailSendingMessage(
+      {required String messageID, BridgefyError? error}) {
     _log("bridgefyDidFailSendingMessage: $messageID, $error");
   }
 

example/test/widget_test.dart

@@ -18,8 +18,8 @@ void main() {
     // Verify that platform version is retrieved.
     expect(
       find.byWidgetPredicate(
-        (Widget widget) => widget is Text &&
-                           widget.data!.startsWith('Running on:'),
+        (Widget widget) =>
+            widget is Text && widget.data!.startsWith('Running on:'),
       ),
       findsOneWidget,
     );

lib/bridgefy.dart

@@ -214,7 +214,8 @@ mixin BridgefyDelegate {
   /// - Parameters:
   ///   - messageId: The id of the message that was tried to be sent
   ///   - error: Error reason.
-  void bridgefyDidFailSendingMessage({required String messageID, BridgefyError? error});
+  void bridgefyDidFailSendingMessage(
+      {required String messageID, BridgefyError? error});
 
   /// This function is called when a new message is received
   /// - Parameters:
@@ -257,8 +258,16 @@ class Bridgefy {
   }
 
   /// Start Bridgefy SDK operations
-  Future<void> start() {
-    return BridgefyPlatform.instance.start();
+  /// - Parameters:
+  ///   - userId: set custom user Id
+  ///   - propagationProfile: start with propagation profile
+  Future<void> start({
+    String? userId,
+    BridgefyPropagationProfile propagationProfile =
+        BridgefyPropagationProfile.standard,
+  }) async {
+    return BridgefyPlatform.instance
+        .start(userId: userId, propagationProfile: propagationProfile);
   }
 
   /// Stop Bridgefy SDK operations

lib/bridgefy_method_channel.dart

@@ -39,16 +39,14 @@ class MethodChannelBridgefy extends BridgefyPlatform {
   @override
   Future<void> start({
     String? userId,
-    BridgefyPropagationProfile propagationProfile = BridgefyPropagationProfile.standard,
+    BridgefyPropagationProfile propagationProfile =
+        BridgefyPropagationProfile.standard,
   }) {
     assert(_initialized, 'Bridgefy is not initialized');
-    return methodChannel.invokeMethod(
-      'start',
-      {
-        "userId": userId,
-        "propagationProfile": propagationProfile.name,
-      }
-    );
+    return methodChannel.invokeMethod('start', {
+      "userId": userId,
+      "propagationProfile": propagationProfile.name,
+    });
   }
 
   @override
@@ -62,7 +60,10 @@ class MethodChannelBridgefy extends BridgefyPlatform {
         'send',
         {
           "data": data,
-          "transmissionMode": {"mode": transmissionMode.type.name, "uuid": transmissionMode.uuid},
+          "transmissionMode": {
+            "mode": transmissionMode.type.name,
+            "uuid": transmissionMode.uuid
+          },
         },
       );
       return result["messageId"] as String;
@@ -94,7 +95,8 @@ class MethodChannelBridgefy extends BridgefyPlatform {
   @override
   Future<void> establishSecureConnection({required String userID}) {
     assert(_initialized, 'Bridgefy is not initialized');
-    return methodChannel.invokeMethod('establishSecureConnection', {"userId": userID});
+    return methodChannel
+        .invokeMethod('establishSecureConnection', {"userId": userID});
   }
 
   @override
@@ -122,7 +124,8 @@ class MethodChannelBridgefy extends BridgefyPlatform {
 
   BridgefyTransmissionMode _transmissionMode(dynamic result) {
     return BridgefyTransmissionMode(
-      type: BridgefyTransmissionModeType.values.byName(result["transmissionMode"]["mode"]),
+      type: BridgefyTransmissionModeType.values
+          .byName(result["transmissionMode"]["mode"]),
       uuid: result["transmissionMode"]["uuid"],
     );
   }
@@ -150,7 +153,8 @@ class MethodChannelBridgefy extends BridgefyPlatform {
   Future<dynamic> delegateCallHandler(MethodCall call) async {
     switch (call.method) {
       case "bridgefyDidStart":
-        _delegate?.bridgefyDidStart(currentUserID: call.arguments['userId'] as String);
+        _delegate?.bridgefyDidStart(
+            currentUserID: call.arguments['userId'] as String);
         break;
       case "bridgefyDidFailToStart":
         _delegate?.bridgefyDidFailToStart(
@@ -172,13 +176,16 @@ class MethodChannelBridgefy extends BridgefyPlatform {
         _delegate?.bridgefyDidFailToDestroySession();
         break;
       case "bridgefyDidConnect":
-        _delegate?.bridgefyDidConnect(userID: call.arguments['userId'] as String);
+        _delegate?.bridgefyDidConnect(
+            userID: call.arguments['userId'] as String);
         break;
       case "bridgefyDidDisconnect":
-        _delegate?.bridgefyDidDisconnect(userID: call.arguments['userId'] as String);
+        _delegate?.bridgefyDidDisconnect(
+            userID: call.arguments['userId'] as String);
         break;
       case "bridgefyDidEstablishSecureConnection":
-        _delegate?.bridgefyDidEstablishSecureConnection(userID: call.arguments['userId'] as String);
+        _delegate?.bridgefyDidEstablishSecureConnection(
+            userID: call.arguments['userId'] as String);
         break;
       case "bridgefyDidFailToEstablishSecureConnection":
         _delegate?.bridgefyDidFailToEstablishSecureConnection(
@@ -187,7 +194,8 @@ class MethodChannelBridgefy extends BridgefyPlatform {
         );
         break;
       case "bridgefyDidSendMessage":
-        _delegate?.bridgefyDidSendMessage(messageID: call.arguments['messageId'] as String);
+        _delegate?.bridgefyDidSendMessage(
+            messageID: call.arguments['messageId'] as String);
         break;
       case "bridgefyDidFailSendingMessage":
         _delegate?.bridgefyDidFailSendingMessage(

lib/bridgefy_platform_interface.dart

@@ -36,7 +36,8 @@ abstract class BridgefyPlatform extends PlatformInterface {
 
   Future<void> start({
     String? userId,
-    BridgefyPropagationProfile propagationProfile = BridgefyPropagationProfile.standard,
+    BridgefyPropagationProfile propagationProfile =
+        BridgefyPropagationProfile.standard,
   }) {
     throw UnimplementedError('start() has not been implemented.');
   }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: bridgefy
 description: The Bridgefy SDK is a state-of-the-art, plug-and-play package that lets people use apps when they don’t have access to the Internet by using mesh networ
-version: 1.1.0
+version: 1.1.1
 homepage: https://bridgefy.me/sdk
 repository: https://github.com/bridgefy/bridgefy_flutter
 issue_tracker: https://github.com/bridgefy/bridgefy_flutter/issues