gpsd2json 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61aaf077f1e5605afa404ee0b7639296273c1f43
-  data.tar.gz: 219dccf5fe3dc81841c126362a9eba3ddb983baa
+  metadata.gz: 8c49bbcd7d99574f44023b3c45e21d72346e9de2
+  data.tar.gz: eebfbedc75d4be1fe44128467e6522dcc5c577fd
 SHA512:
-  metadata.gz: 0dc9aadcfadb0779369fa5094ad951decb2d6deafbb93cb71e37c09868f333a665a8703f5b97e7b6a83741a417efe23cf78a1ff92331e74e02c3a9e78851608f
-  data.tar.gz: 0ddb145d5046fa5d313a29d392253ce14d28868eb2a83d4f69f149aa0f811a2c4a0d2403047c8caeb65e1e0c8563707619ced218cc3fed8cbcc38be6a6a9ed45
+  metadata.gz: 4957c8ca9e23b93961553fe786efef10491c71a2d675148b2c1f16b2b168b0575f014b2adf06c80f3100529b3360461ead5feb65292c2ec161aae5f38ccb213a
+  data.tar.gz: b03b35c6c397e209064ddc6539491bc42eeec4764d91e2e4598c5fec15d2c58ad88a367b297c46dc9940acce7c7b3eec71f009e3d1bdc552a1bdceb26db8b510

data/README.md

@@ -1,46 +1,79 @@
 # gpsd2json
 ruby client to receive JSON formatted info of the gps daemon
 
-## initialization
+## Setup
+
+Make sure you have gpsd installed and you have of course a gps connected to your device
 ```bash
+# Install
+sudo apt-get install gpsd
+# Check if your gps is available
+cgps
+# Install the gps2json gem
+gem install gps2json
+```
+
+## Usage
+
+Start an irb session
+
+```bash
+irb
 require 'gpsd2json'
 gps = GPSD2JSON.new()
 ```
-## First you set some callbacks on the most important changes
+
+Set the callbacks on the position and satellite change events
+
 ```bash
-gps.on_position_change { |pos| STDERR.puts pos.inpect }
+gps.on_position_change { |pos| STDERR.puts "New position: #{pos.inpect}" }
 gps.on_satellites_change { |sats| STDERR.puts "#{sats.count} found, #{sats.count{|sat| sat['used']} are used" }
 ```
-## Then, your start watching
+
+Then, your start watching
+
 ```bash
 gps.start
 ```
-after this, the positions will be given to the callback block
 
-## When you had enough, you can stop watching
+If you have the gps connected you should get the satelites callback first.
+It has to connect te the deamon and the deamon has to tell te gps to start
+dumping the data if it did not do so already, but this should be all done
+withing a second or so.
+
+To get position change callbacks, the gps should have enough sattelites with
+a fix and the speed should be higher then the minimum speed, which defaults to 0.
+
+
+You can stop watching with
+
 ```bash
 gps.stop
 ```
 
-## there is on more callback to receive all data as raw json
+There is also a on_raw_data callback you can use to see all data that is dumped by the deamon
+
 ```bash
 gps.on_raw_data { |json| STDERR.puts json.inspect}
 ```
 
-## Also, you can change the minimum speed requered to return a position change, with
+You can change the minimum speed requered to return a position change, with
+
 ```bash
 gps.change_min_speed(speed: <whatever speed>)
 ```
 
-## development
+## Development
+
 ```bash
 # Install
+git clone git@github.com:mmolhoek/gpsd2json.git
+cd gpsd2json
 bundle
 # irb
 bundle exec irb -r ./lib/gpsd2json.rb
-# test
+# test (with coverage to ./coverage/index.html)
 bundle exec rspec --color -fd spec/gpsd_client_test.rb
 ```
-it also have a code coverage dir for you to see if your test set is about 95%
 
-send me PR if you want changes, but only dare to do so when you added the proper tests
+Send me PR if you want changes, but only dare to do so when you added the proper tests and the overall coverage stays above 95%

data/lib/{gps2json.rb → gpsd2json.rb}

@@ -25,7 +25,7 @@ class GPSD2JSON
         @port = port
         @trackthread = nil
         @socket_init_thread = nil
-        @min_speed = 0.8 # speed needs to be higher than this to make the gps info count
+        @min_speed = 0 # speed needs to be higher than this to make the gps info count
         @last = nil #last gps info
         @sats = nil # last satellites info
         @json_raw_callback = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpsd2json
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mischa Molhoek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -110,7 +110,7 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
-- lib/gps2json.rb
+- lib/gpsd2json.rb
 homepage: http://github.com/mmolhoek/gpsd2json
 licenses:
 - MIT