https://github.com/willrax/motion-distance

Easy distance tracking for RubyMotion projects.
https://github.com/willrax/motion-distance

Last synced: 14 days ago
JSON representation

Easy distance tracking for RubyMotion projects.

• Host: GitHub
• URL: https://github.com/willrax/motion-distance
• Owner: willrax
• License: mit
• Created: 2013-11-06T22:16:21.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-02-22T04:03:38.000Z (over 10 years ago)
• Last Synced: 2024-04-24T21:12:51.232Z (6 months ago)
• Language: Ruby
• Homepage:
• Size: 220 KB
• Stars: 20
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# motion-distance

Easy distance tracking for RubyMotion projects.

## Installation

Add this line to your application's Gemfile:

    gem "motion-distance"

And then execute:

    $ bundle

## Usage

Create a new instance of `Motion::Distance`.

You must also specify an activity type. This will help the OS know when to pause and resume updates that will help save battery.

```ruby

# CLActivityTypeOther,

# CLActivityTypeAutomotiveNavigation,

# CLActivityTypeFitness,

# CLActivityTypeOtherNavigation,

@distance = Motion::Distance.new

@distance.activity_type = CLActivityTypeFitness

```

You may also set a level of accuracy.

```ruby

# KCLLocationAccuracyBestForNavigation

# KCLLocationAccuracyBest

# KCLLocationAccuracyNearestTenMeters

# KCLLocationAccuracyHundredMeters

# KCLLocationAccuracyKilometer

# KCLLocationAccuracyThreeKilometers

@distance.accuracy = KCLLocationAccuracyBest

```

Now you can call `#get` to begin tracking any distance travelled. Each time the phone registers a location change

you'll recieve a hash that contains the total distance travelled and current location.

Distance is always returned in meters.

```ruby

@distance.get do |location|

  puts location[:total]

end

```

You can stop tracking location by calling:

```ruby

@distance.stop_updating

```

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request