Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itzmeanjan/locate
A Flutter plugin to fetch GPS/ Network based Location Data Feed on Android, made with <3
https://github.com/itzmeanjan/locate
android android-location android-location-navigator flutter flutter-apps flutter-examples flutter-plugin location-services locationprovider
Last synced: 3 days ago
JSON representation
A Flutter plugin to fetch GPS/ Network based Location Data Feed on Android, made with <3
- Host: GitHub
- URL: https://github.com/itzmeanjan/locate
- Owner: itzmeanjan
- License: mit
- Created: 2019-03-06T18:34:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T05:25:17.000Z (about 4 years ago)
- Last Synced: 2023-08-20T22:31:45.999Z (about 1 year ago)
- Topics: android, android-location, android-location-navigator, flutter, flutter-apps, flutter-examples, flutter-plugin, location-services, locationprovider
- Language: Kotlin
- Homepage: https://itzmeanjan.github.io/locate/
- Size: 107 MB
- Stars: 17
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# locate
A Flutter plugin to fetch GPS/ Network based Location Data Feed on Android.
**locate v1.2.0 is readily availble for [use](https://pub.dev/packages/locate).**
# intro
`locate` can be used on Android for fetching Location Data Feed.
Two location service providers are available
- Google Mobile Services i.e. GMS based _FusedLocationProvider_ **( this is recommended )**
- Standard Android _LocationManager_ **( in this case you get freedom to choose which provider to use )**
- Network provider
- GPS provider
It has **androidX** support, along with latest version of all dependencies.
# installation
- Add `locate` as dependency in in your flutter project's pubspec.yaml
```yaml
dependencies:
locate: ^1.2.0
```
- Fetch flutter packages from pub.dev
```bash
$ flutter pub get
```
- Import `locate` in your dart code & start getting location data feed
```dart
import 'package:locate/locate.dart';
```
# usage
## permission
- First thing first, add permission declaration in your project's `AndroidManifest.xml`.
- If you're planning to use Google Mobile Services based _FusedLocationProvider_, request for *ACCESS_FINE_LOCATION*, which automagically selects location data source for you.
- Otherwise you may only request for
- *ACCESS_FINE_LOCATION* _( GPS based location data )_
- *ACCESS_COARSE_LOCATION* _( Network based location data )_
```xml
```
## API
- Get an intance of *Locate*.
```dart
var _locate = Locate();
```
- Let's first request Location Access Permission from user.
```dart
_locate.requestLocationPermission().then((bool result) {
if (result)
// we're good to go
else
// let user know it's required
});
```
- Time to enable Location.
```dart
_locate.enableLocation().then((bool result) {
if (result) {
// update UI & request *locate* for location Data
setState(() => _areWeGettingLocationUpdate = true);
// Location data will be fetched and delivered as Stream
else
// user didn't enable location
}
});
```
- Now we start getting Location Data Feed.
```dart
_locate.getLocationDataFeed()
..listen(
// we listen for location data, which is received as stream
(MyLocation data) =>
setState(() => _locationData.add(data)), // as soon as data received, will update UI/ perform some other task using location data.
cancelOnError: true,
onError: (e) => print(e),
);
```
- Aah I just forgot to mention one thing, *how to stop listening location update ?*
```dart
_locate.stopLocationDataFeed().then((bool result) {
// do some UI updation kind of work/ or something else
});
```
## what's in **MyLocation** class ?
- *MyLocation* class can be thought of as a Location Data container & manipulator.
```dart
/// constructor of MyLocation
MyLocation(
this.longitude,
this.latitude,
this.time, // in DateTime
this.altitude, // in meters
this.bearing, // in degree
this.speed, // in meters/s
this.accuracy, // in meters
this.verticalAccuracy, // in meters
this.bearingAccuracy, // in meters
this.speedAccuracy, // in meters/s
this.provider, // as String,either gps/ network/ fused
this.satelliteCount);
```
- I've added some companion methods which can be used from *MyLocation*, such as
```dart
// will fetch you name of direction of movement from bearing value
bearingToDirectionName();
// m/s to km/h converion for speedaccuracy
getSpeedAccuracyInKiloMetersPerHour();
/// same as above, but works on speed
getSpeedInKiloMetersPerHour();
/// displays time in pretty format
getParsedTimeString();
```
## example
Here's an [example](./example) application using all these API(s).
# notes
You can also set some optional named parameters while invoking methods from *Locate* class.
While requesting permission, you can set *provider*
- *LocationProvider.Network*, if you want to use Network based Location
- *LocationProvider.GPS*, if you want to use GPS based Location **[ default ]**
Before requesting Location Data Feed, you can also set via which location manager to fetch data and location data provider name.
- For `LocationServiceProvider.GMSBasedLocation`, make sure you've declared & requested for permission of accessing FINE Location.
- Otherwise for `LocationServiceProvider.LocationManagerBasedLocation` as `locationServiceProvider`, you may use any of them, depending upon your declared & requested permissions.
- `LocationProvider.GPS`
- `LocationProvider.Network`