Code Monkey home page Code Monkey logo

rxlocationmanager's Introduction

RxLocationManager

Android Reactive LocationManager callbacks.

This library also includes some helper observables to get altitude using GPS, barometric sensor or a remote service (build in Google elevation API implementation included). GPS altitude may returned both ellipsoidal and geoidal (mean sea level), android Location.getAltitude() returns ellipsoidal altitude but in most case you want to get geoidal one.

An extra standalone library is available to parse NMEA messages (v2.3+ specification) that may be returned from observeNmea(). Actual available parsers are:

  • GGA
  • GLL
  • GSA
  • RMC (timing and navigational)
  • more to come... and PR welcome!

You can easily add you own parser, just inherit from net.samystudio.rxlocationmanager.nmea.Nmea class and use net.samystudio.rxlocationmanager.nmea.TokenValidator to validate your messages.

Download

implementation 'net.samystudio.rxlocationmanager:rxlocationmanager:0.7.1'

If you need altitude helpers observables add this as well:

implementation 'net.samystudio.rxlocationmanager:rxlocationmanager-altitude:0.7.1'

If you want to easily parse nmea messages you can use this standalone artifact (note this is already include if you added rxlocationmanager-altitude dependency):

implementation 'net.samystudio.rxlocationmanager:rxlocationmanager-nmea:0.7.1'

Snapshots are available from Sonatype's snapshots repository. If you want to run latest snapshot add its repository from your root build.gradle:

allprojects {
    repositories {
        google()
        // ...
        maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
    }
}

and change versions:

implementation 'net.samystudio.rxlocationmanager:rxlocationmanager:0.7.2-SNAPSHOT'
implementation 'net.samystudio.rxlocationmanager:rxlocationmanager-altitude:0.7.2-SNAPSHOT'
implementation 'net.samystudio.rxlocationmanager:rxlocationmanager-nmea:0.7.2-SNAPSHOT'

Usage

Check xxx-sample directories. A lot of samples showcase RxPermissions library as well to easily request location permission for callbacks that require it.

Publishing

  1. Change the version in gradle.properties to a non-SNAPSHOT version.
  2. Update the CHANGELOG.md for the impending release.
  3. Update the README.md with the new version.
  4. git commit -am "Prepare for release X.Y.Z" (where X.Y.Z is the new version)
  5. ./gradlew publish --no-daemon --no-parallel
  6. git tag -a X.Y.Z -m "Version X.Y.Z" (where X.Y.Z is the new version)
  7. Update the gradle.properties to the next SNAPSHOT version.
  8. git commit -am "Prepare next development version"
  9. git push && git push --tags
  10. ./gradlew closeAndReleaseRepository or visit Sonatype Nexus and promote the artifact.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

rxlocationmanager's People

Contributors

samystudio avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

balao7 avianey

rxlocationmanager's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.