react-native-lostlocationprovider

A simple React Native Android module that wraps Mapzen's LOST (Location Open Source Tracker) as an alternative to the standard React Native MapView component.

Showing:

Popularity

Downloads/wk

1

GitHub Stars

7

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

0

License

GPL-3.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

#React-Native-LOSTLocationProvider A simple React Native Android module that wraps Mapzen's LOST (https://github.com/mapzen/LOST) as an alternative to Google's FusedLocationProviderAPI.

Current Version: 0.0.4

##Installation (Gradle)

  • Install module

npm i --save react-native-lostlocationprovider

  • android/settings.gradle
...
include :react-native-lostlocationprovider
project(':react-native-lostlocationprovider').projectDir = new File(settingsDir, '../node_modules/react-native-lostlocationprovider')
  • android/app/build.gradle
dependencies {
  ...
  compile project(':react-native-lostlocationprovider')
}
  • Register module
import io.whereat.lostlocationprovider.LOSTLocationPackage;
public class MainActivity extends ReactActivity {
  ...
  @Override
  protected List<ReactPackage> getPackages() {
    return Arrays.asList(
      ...,
      new LOSTLocationPackage());
    }

  }
  ...
}
  • Import into React Native
import {NativeModules} from 'react-native';
const location = NativeModules.LOSTLocationProvider;

##Usage ####Constants (Mapped from LOST LocationRequest Constants)

  • BALANCED_POWER_ACCURACY
  • HIGH_ACCURACY
  • LOW_POWER
  • NO_POWER

####Methods

  • startLocationPolling(Integer interval, Float distance, int priority)
    • Request location updates from LOST
    • Parameters:
      • interval - Polling frequency in milliseconds
      • distance - Minimum distance for update in meters
      • priority - Poling priority mode (Should use provided constants)
    • NOTE: This method lazy loads the location listener. StartLocationPolling must be called before other methods are called.
  • stopLocationPolling()
    • Stop location updates from LOST
  • mockLocation(Float latitude, Float longitude)
    • Immediately send a mock location to the location listener.
    • NOTE: This method requires a location listener to have been loaded for it to work. Call startLocationPolling() first.
    • NOTE: This method leaves LOST in mock mode. Calling startLocationPolling() after this without turning off mock mode will not work.
  • setMockMode(Boolean value)
    • Set LOST mock mode. When mock mode is off, location polling will work as expected, using cell networks, wifi, and gps to resolve device location. When mock mode is on, polling will stop and the location listener will immediately broadcast any locations sent through mockLocation().

####Events ######location_changed

  • parameters:

    • longitude
    • latitude
    • altitude
    • bearing
    • speed
    • accuracy
    • time
    • hasAccuracy
    • hasAltitude
    • hasBearing
    • hasSpeed
  • example:

    DeviceEventEmitter.addListener('location_changed', this.myEventHandler);

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100