NMEA Messages on Android

geolocator/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 9.1.0
+
+- Added functionality to receive NMEA messages.
+
 ## 9.0.2
 
 - Updated dependency on geolocator_android to version 4.1.3
@@ -33,6 +37,7 @@
 
 - Endorses the geolocator_windows package.
 
+
 ## 8.0.5
 
 - Fix code coverage issues by adding iOS specific test for getCurrentPosition
@@ -51,7 +56,7 @@
 
 ## 8.0.1
 
-- Fix "forceAndroidLocationManager" for getLastKnownPosition 
+- Fix "forceAndroidLocationManager" for getLastKnownPosition
 - Upgrade geolocator_platform_interface to 3.0.1
 - Upgrade geolocator_web to 2.1.1
 
@@ -124,7 +129,7 @@
 ## 7.0.3
 
 - Android: Throw the `ActivityMissingException` when requesting permissions while the activity is not available (e.g. when the App is in the background);
-- iOS: Support the `NSLocationAlwaysAndWhenInUseUsageDescription` key on iOS 11+ (this key replaces the `NSLocationAlwaysDescription` key which has been marked [deprecated](https://developer.apple.com/documentation/bundleresources/information_property_list/nslocationalwaysusagedescription?language=objc)). 
+- iOS: Support the `NSLocationAlwaysAndWhenInUseUsageDescription` key on iOS 11+ (this key replaces the `NSLocationAlwaysDescription` key which has been marked [deprecated](https://developer.apple.com/documentation/bundleresources/information_property_list/nslocationalwaysusagedescription?language=objc)).
 
 ## 7.0.2
 
@@ -136,7 +141,7 @@
 
 ## 7.0.0
 
-This release contains the following **breaking changes**: 
+This release contains the following **breaking changes**:
 - Stable release of null safety migration;
 - Checking permissions on Android can no longer result in `LocationPermissions.deniedForever`. More details can be found in issue [#653](https://github.com/Baseflow/flutter-geolocator/issues/653) and the [wiki](https://github.com/Baseflow/flutter-geolocator/wiki/Breaking-changes-in-7.0.0#android-permission-update);
 - Removed deprecated `timeInterval` parameter from the `getPositionStream` method;
@@ -419,7 +424,7 @@ Complete rebuild of the geolocator plugin. Please note the this version contains
 ## 1.7.0
 
 - Added timestamp to instances of the `Position` class indicating when the GPS fix was acquired;
-- Updated the dependency on the `PermissionHandler` to version >=2.0.0 <3.0.0. 
+- Updated the dependency on the `PermissionHandler` to version >=2.0.0 <3.0.0.
 
 ## 1.6.5
 
@@ -459,14 +464,14 @@ Complete rebuild of the geolocator plugin. Please note the this version contains
 - Solved a bug on Android where requesting permissions twice would cause the App to crash [[ISSUE #61](https://github.com/BaseflowIT/flutter-geolocator/issues/61)]
 
 > **Important:**
-> 
+>
 > To be able to correctly fix [issue #58](https://github.com/BaseflowIT/flutter-geolocator/issues/58) we had to change the `getPositionStream` method into a `async` method. This means the signature of the method has been changed from:
 >
-> `Stream<Position> getPositionStream([LocationOptions locationOptions = const LocationOptions()])` 
+> `Stream<Position> getPositionStream([LocationOptions locationOptions = const LocationOptions()])`
 >
-> to 
+> to
 >
-> `Future<Stream<Position>> getPositionStream([LocationOptions locationOptions = const LocationOptions()])`. 
+> `Future<Stream<Position>> getPositionStream([LocationOptions locationOptions = const LocationOptions()])`.
 >
 > Meaning as a developer you'll now have to `await` the result of the method to get access to the actual stream.
 
@@ -515,9 +520,9 @@ Complete rebuild of the geolocator plugin. Please note the this version contains
 
 ## 1.1.0
 
-- Introduced the option to supply a desired accuracy. 
+- Introduced the option to supply a desired accuracy.
 
-> **Important:*- 
+> **Important:*-
 >
 >This introduces a breaking change, the `getPosition` and `onPositionChanged` properties have been replaced by methods (`getPosition([LocationAccuracy desiredAccuracy = LocationAccuracy.Best])` and `getPositionStream([LocationAccuracy desiredAccuracy = LocationAccuracy.Best])` respectively) accepting a parameter to indicate the desired accuracy.
 - Updated the Android part to make use of the [LocationManager](https://developer.android.com/reference/android/location/LocationManager) instead of the [FusedLocationProviderClient](https://developers.google.com/android/reference/com/google/android/gms/location/FusedLocationProviderClient)

geolocator/example/lib/main.dart

@@ -40,6 +40,7 @@ class _GeolocatorWidgetState extends State<GeolocatorWidget> {
   final GeolocatorPlatform _geolocatorPlatform = GeolocatorPlatform.instance;
   final List<_PositionItem> _positionItems = <_PositionItem>[];
   StreamSubscription<Position>? _positionStreamSubscription;
+  StreamSubscription<NmeaMessage>? _nmeaStreamSubscription;
   StreamSubscription<ServiceStatus>? _serviceStatusStreamSubscription;
   bool positionStreamStarted = false;
 
@@ -337,6 +338,10 @@ class _GeolocatorWidgetState extends State<GeolocatorWidget> {
       _positionStreamSubscription!.cancel();
       _positionStreamSubscription = null;
     }
+    if (_nmeaStreamSubscription != null) {
+      _nmeaStreamSubscription!.cancel();
+      _nmeaStreamSubscription = null;
+    }
 
     super.dispose();
   }

geolocator/example/pubspec.yaml

@@ -35,6 +35,13 @@ dev_dependencies:
     sdk: flutter
   flutter_lints: ^1.0.4
 
+# TODO: REMOVE BEFORE MERGING
+dependency_overrides:
+  geolocator_platform_interface:
+    path: ../../geolocator_platform_interface/
+  geolocator_android:
+    path: ../../geolocator_android/
+
 # For information on the generic Dart part of this file, see the
 # following page: https://dart.dev/tools/pub/pubspec
 

geolocator/lib/geolocator.dart

@@ -91,6 +91,35 @@ class Geolocator {
         .getCurrentPosition(locationSettings: locationSettings);
   }
 
+  /// Returns a stream emitting NMEA-0183 sentences Android only, no-op on iOS.
+  ///
+  /// With devices running an Android API level lower than 24 NMEA-0183
+  /// sentences are received from the GPS engine. From API level 24 and up the
+  /// GNSS engine is used.
+  ///
+  /// This event starts all location sensors on the device and will keep them
+  /// active until you cancel listening to the stream or when the application
+  /// is killed.
+  ///
+  /// ```
+  /// StreamSubscription<NmeaMessage> nmeaStream =
+  ///     Geolocator.getNmeaStream().listen((NmeaMessage nmea) {
+  ///       // Handle NMEA changes
+  ///     });
+  /// ```
+  ///
+  /// When no longer needed cancel the subscription
+  /// nmeaStream.cancel();
+  ///
+  /// Throws a [PermissionDeniedException] when trying to request the device's
+  /// location when the user denied access.
+  /// Throws a [LocationServiceDisabledException] when the user allowed access,
+  /// but the location services of the device are disabled.
+  ///
+  /// for more info about NMEA 0183 see https://en.wikipedia.org/wiki/NMEA_0183
+  static Stream<NmeaMessage> getNmeaStream() =>
+      GeolocatorPlatform.instance.getNmeaStream();
+
   /// Fires whenever the location changes inside the bounds of the
   /// supplied [LocationSettings.accuracy].
   ///

geolocator/pubspec.yaml

@@ -2,7 +2,7 @@ name: geolocator
 description: Geolocation plugin for Flutter. This plugin provides a cross-platform (iOS, Android) API for generic location (GPS etc.) functions.
 repository: https://github.com/baseflow/flutter-geolocator/tree/main/geolocator
 issue_tracker: https://github.com/baseflow/flutter-geolocator/issues?q=is%3Aissue+is%3Aopen
-version: 9.0.2
+version: 9.1.0
 
 environment:
   sdk: ">=2.15.0 <3.0.0"
@@ -26,8 +26,8 @@ dependencies:
   flutter:
     sdk: flutter
 
-  geolocator_platform_interface: ^4.0.3
-  geolocator_android: ^4.1.3
+  geolocator_platform_interface: ^4.1.0
+  geolocator_android: ^4.2.0
   geolocator_apple: ^2.1.1+1
   geolocator_web: ^2.1.3
   geolocator_windows: ^0.1.0
@@ -38,3 +38,10 @@ dev_dependencies:
   flutter_lints: ^1.0.4
   mockito: ^5.0.0-nullsafety.7
   plugin_platform_interface: ^2.0.0
+
+# TODO: REMOVE BEFORE MERGING
+dependency_overrides:
+  geolocator_platform_interface:
+    path: ../geolocator_platform_interface/
+  geolocator_android:
+    path: ../geolocator_android/

geolocator/test/geolocator_test.dart

@@ -17,6 +17,14 @@ Position get mockPosition => Position(
     speed: 0.0,
     speedAccuracy: 0.0);
 
+NmeaMessage get mockNmeaMessage => NmeaMessage(
+    message:
+        "GPGGA,170834,4124.8963,N,08151.6838,W,1,05,1.5,280.2,M,-34.0,M,,,*75",
+    timestamp: DateTime.fromMillisecondsSinceEpoch(
+      500,
+      isUtc: true,
+    ));
+
 void main() {
   group('Geolocator', () {
     setUp(() {
@@ -97,6 +105,11 @@ void main() {
       expect(position, emitsInOrder([emits(mockPosition), emitsDone]));
     });
 
+    test('getNmeaStream', () async {
+      final nmeaMessage = Geolocator.getNmeaStream();
+      expect(nmeaMessage, emitsInOrder([emits(mockNmeaMessage), emitsDone]));
+    });
+
     test('openAppSettings', () async {
       final hasOpened = await Geolocator.openAppSettings();
       expect(hasOpened, true);
@@ -177,6 +190,9 @@ class MockGeolocatorPlatform extends Mock
     );
   }
 
+  @override
+  Stream<NmeaMessage> getNmeaStream() => Stream.value(mockNmeaMessage);
+
   @override
   Future<bool> openAppSettings() => Future.value(true);
 

geolocator_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.2.0
+
+- Additional functionality to receive NMEA messages.
+
 ## 4.1.5
 
 - Mark `geolocator_android` as implementation of `geolocator` 

geolocator_android/android/src/main/java/com/baseflow/geolocator/GeolocatorPlugin.java

@@ -17,6 +17,7 @@
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.embedding.engine.plugins.activity.ActivityAware;
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
+import io.flutter.plugin.common.BinaryMessenger;
 
 /** GeolocatorPlugin */
 public class GeolocatorPlugin implements FlutterPlugin, ActivityAware {
@@ -53,6 +54,8 @@ public void onServiceDisconnected(ComponentName name) {
       };
   @Nullable private LocationServiceHandlerImpl locationServiceHandler;
 
+  @Nullable private NmeaStreamHandlerImpl nmeaStreamHandler;
+
   @SuppressWarnings("deprecation")
   @Nullable
   private io.flutter.plugin.common.PluginRegistry.Registrar pluginRegistrar;
@@ -94,14 +97,21 @@ public static void registerWith(io.flutter.plugin.common.PluginRegistry.Registra
     LocationServiceHandlerImpl locationServiceHandler = new LocationServiceHandlerImpl();
     locationServiceHandler.startListening(registrar.context(), registrar.messenger());
     locationServiceHandler.setContext(registrar.activeContext());
+
+    NmeaStreamHandlerImpl nmeaStreamHandler = new NmeaStreamHandlerImpl(geolocatorPlugin.permissionManager);
+    nmeaStreamHandler.startListening(registrar.context(), registrar.messenger());
+    nmeaStreamHandler.setActivity(registrar.activity());
+
     geolocatorPlugin.bindForegroundService(registrar.activeContext());
   }
 
   @Override
   public void onAttachedToEngine(@NonNull FlutterPluginBinding flutterPluginBinding) {
     methodCallHandler =
         new MethodCallHandlerImpl(
-            this.permissionManager, this.geolocationManager, this.locationAccuracyManager);
+            this.permissionManager,
+            this.geolocationManager,
+            this.locationAccuracyManager);
     methodCallHandler.startListening(
         flutterPluginBinding.getApplicationContext(), flutterPluginBinding.getBinaryMessenger());
     streamHandler = new StreamHandlerImpl(this.permissionManager);
@@ -113,6 +123,10 @@ public void onAttachedToEngine(@NonNull FlutterPluginBinding flutterPluginBindin
     locationServiceHandler.startListening(
         flutterPluginBinding.getApplicationContext(), flutterPluginBinding.getBinaryMessenger());
 
+    nmeaStreamHandler = new NmeaStreamHandlerImpl(this.permissionManager);
+    nmeaStreamHandler.startListening(
+        flutterPluginBinding.getApplicationContext(), flutterPluginBinding.getBinaryMessenger());
+
     bindForegroundService(flutterPluginBinding.getApplicationContext());
   }
 
@@ -134,6 +148,9 @@ public void onAttachedToActivity(@NonNull ActivityPluginBinding binding) {
     if (streamHandler != null) {
       streamHandler.setActivity(binding.getActivity());
     }
+    if (nmeaStreamHandler != null) {
+      nmeaStreamHandler.setActivity(binding.getActivity());
+    }
     if (foregroundLocationService != null) {
       foregroundLocationService.setActivity(pluginBinding.getActivity());
     }
@@ -162,6 +179,9 @@ public void onDetachedFromActivity() {
     if (foregroundLocationService != null) {
       foregroundLocationService.setActivity(null);
     }
+    if (nmeaStreamHandler != null) {
+     nmeaStreamHandler.setActivity(null);
+    }
     if (pluginBinding != null) {
       pluginBinding = null;
     }
@@ -225,6 +245,11 @@ private void dispose() {
       locationServiceHandler.stopListening();
       locationServiceHandler = null;
     }
+    if (nmeaStreamHandler != null) {
+      nmeaStreamHandler.stopListening();
+      nmeaStreamHandler.setActivity(null);
+      nmeaStreamHandler = null;
+    }
     if (foregroundLocationService != null) {
       foregroundLocationService.setActivity(null);
     }