ogn_client-ruby 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc7bfb92c9ee1a6a43a8fbe34b66a795c1a34551
-  data.tar.gz: 663f89af96ca723f2042fa46c943abf831c0dc9e
+  metadata.gz: 457a6b32a8d8a124283e05e320f14b6d4d2a1310
+  data.tar.gz: cca65cf62df04c2ae068ba0adeee9fe1805769d8
 SHA512:
-  metadata.gz: 47cd82bc99d6c9147ab1af0cbf29dbff876d536e50416f914a00a292b82dbb50b8f3e87a91faad2fe91ff52eb8024d57baa83541d504389895c6030a7852330e
-  data.tar.gz: 58a4744ec0cb1b4bcb9c35a3138b080d7bca6c301f953ceb08cb0204f0e8669ea6237aa04e5c0db68a8a88baeb8ba76332e4e97d577738a961627c506ff67618
+  metadata.gz: 4b1dee00b45b66bdfe7a02070e6c8acb518a5df6f7d9c248aee836dab60ce01907bd84590e3b346c9c9defb9a39b6b8c19eda8cf814a1ee8278d6b64e11f4160
+  data.tar.gz: d6f3e85e414a4d3533376295676019e0f9c78015bec1346743711f9c3859782a80f7578d2d18b42bfe2ae9c3b7f37e4c6e03a9e257fd01ebf44104f4503e6dc3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.3
+
+  * add support for explicit message date
+  * fix ogn2kml for larger tracks
+
 ## 0.2.2
 
   * add example executables

data/README.md

@@ -61,6 +61,13 @@ The factory method `OGNClient::Message.parse` will return one an instance of `OG
 
 In production, you may want to rescue from these errors and ignore the message. You should, however, log the offending messages messages, [file a bug](#community-support) and replay them once the bug has been fixed.
 
+:point_up: Raw APRS messages do not contain the date, but assume the current day. This may cause trouble around midnight, however, the parser deals with such edge cases gracefully. Things are a little different when parsing raw APRS messages recorded in the past e.g. with `ognlogd`. Since the parser has no means to detect the date the APRS messages have been sent, you have to pass it as an option:
+
+```ruby
+raw_aprs = File.open('2017-06-24.log', &:gets)
+OGNClient::Message.parse(raw_aprs, date: '2017-06-24')
+```
+
 #### OGNClient::SenderBeacon
 
 Sender beacons are usually coming from aircraft equipped with [FLARM](https://flarm.com) (anti-collision warning system) or similar devices which broadcast position data as RF beacons.

data/exe/ogn2kml

@@ -20,6 +20,7 @@ class Converter
       END
       o.on('-a', '--about', 'author and license information') { puts 'Written by Sven Schwyn (bitcetera.com) and distributed under MIT license.'; exit }
       o.on('-c', '--callsign STRING', String, 'aircraft callsign (e.g. FLRAABBCC)') { |v| @callsign = v }
+      o.on('-d', '--date YYYY-MM-DD', String, 'date the APRS messages were recorded (default: today)') { |v| @date = v }
       o.on('-o', '--outfile FILE', String, 'generated KML file (default: INFILE.kml)') { |v| @outfile = v.sub(/\.kml$/, '') + '.kml' }
     end.parse!
     @infile = ARGV.pop
@@ -93,12 +94,13 @@ class Converter
     climb_rate['name'] = 'Climb Rate'
     turn_rate = XML::Node.new(:'gx:SimpleArrayData')
     turn_rate['name'] = 'Turn Rate'
+    array_data = { when: [], coord: [], angles: [] }
     lines.each do |line|
-      if (sender = OGNClient::Message.parse(line)).is_a? OGNClient::SenderBeacon
+      if (sender = OGNClient::Message.parse(line, date: @date)).is_a? OGNClient::SenderBeacon
         if !@callsign || sender.callsign == @callsign
-          track << XML::Node.new(:when, sender.time.xmlschema)
-          track << XML::Node.new(:'gx:coord', "#{sender.longitude} #{sender.latitude} #{sender.altitude}")
-          track << XML::Node.new(:'gx:angles', "#{sender.heading} 0 0")
+          array_data[:when] << XML::Node.new(:when, sender.time.xmlschema)
+          array_data[:coord] << XML::Node.new(:'gx:coord', "#{sender.longitude} #{sender.latitude} #{sender.altitude}")
+          array_data[:angles] << XML::Node.new(:'gx:angles', "#{sender.heading} 0 0")
           time << XML::Node.new(:'gx:value', sender.time.getlocal.strftime('%H:%M:%S'))
           ground_speed << XML::Node.new(:'gx:value', sender.ground_speed.to_i.to_s)
           climb_rate << XML::Node.new(:'gx:value', sender.climb_rate.to_i.to_s)
@@ -107,6 +109,9 @@ class Converter
       end
       progressbar.increment
     end
+    array_data.keys.each do |key|
+      array_data[key].each { |d| track << d }
+    end
     track << (extended_data = XML::Node.new(:ExtendedData))
     extended_data << (schema_data = XML::Node.new(:SchemaData))
     schema_data['schemaUrl'] = '#schema'

data/lib/ogn_client.rb

@@ -1,4 +1,5 @@
 require 'socket'
+require 'time'
 
 require_relative 'ogn_client/version'
 require_relative 'ogn_client/errors'

data/lib/ogn_client/message.rb

@@ -42,12 +42,12 @@ module OGNClient
     attr_reader :heading        # degrees from 1 to 360
     attr_reader :ground_speed   # kilometers per hour
 
-    def self.parse(raw)
+    def self.parse(raw, date: nil)
       fail(OGNClient::MessageError, "raw message must be String but is #{raw.class}") unless raw.is_a? String
       raw = raw.chomp.force_encoding('ASCII-8BIT').encode('UTF-8')
-      OGNClient::SenderBeacon.new.send(:parse, raw) ||
-        OGNClient::ReceiverStatus.new.send(:parse, raw) ||
-        OGNClient::ReceiverBeacon.new.send(:parse, raw) ||
+      OGNClient::SenderBeacon.new.send(:parse, raw, date: date) ||
+        OGNClient::ReceiverStatus.new.send(:parse, raw, date: date) ||
+        OGNClient::ReceiverBeacon.new.send(:parse, raw, date: date) ||
         OGNClient::Comment.new.send(:parse, raw) ||
         fail(OGNClient::MessageError, "message payload parsing failed: `#{raw}'")
     end
@@ -58,8 +58,9 @@ module OGNClient
 
     private
 
-    def parse(raw)
+    def parse(raw, date: nil)
       @raw = raw
+      @date = Date.parse(date) if date
       raw.match POSITION_PATTERN do |match|
         %i(callsign receiver time altitude).each do |attr|
           send("#{attr}=", match[attr]) if match[attr]
@@ -82,9 +83,13 @@ module OGNClient
     end
 
     def time=(raw)
-      now = Time.now.utc
-      time = Time.new(now.year, now.month, now.day, raw[0,2], raw[2,2], raw[4,2], 0)
-      time -= 86400 if time > now   # adjust date of beacons sent just before midnight
+      if @date
+        time = Time.new(@date.year, @date.month, @date.day, raw[0,2], raw[2,2], raw[4,2], 0)
+      else
+        now = Time.now.utc
+        time = Time.new(now.year, now.month, now.day, raw[0,2], raw[2,2], raw[4,2], 0)
+        time -= 86400 if time > now   # adjust date of beacons sent just before midnight
+      end
       @time = time
     end
 

data/lib/ogn_client/messages/receiver_beacon.rb

@@ -9,7 +9,7 @@ module OGNClient
 
     private
 
-    def parse(raw)
+    def parse(raw, date: nil)
       raw.match RECEIVER_BEACON_PATTERN do
         super unless @raw
         self

data/lib/ogn_client/messages/receiver_status.rb

@@ -63,7 +63,7 @@ module OGNClient
 
     private
 
-    def parse(raw)
+    def parse(raw, date: nil)
       raw.match RECEIVER_STATUS_PATTERN do |match|
         super unless @raw
         %i(version platform cpu_load cpu_temperature ram_free ram_total ntp_offset ntp_correction voltage amperage rf_correction_manual rf_correction_automatic senders visible_senders signal_quality senders_signal_quality senders_messages good_senders_signal_quality good_and_bad_senders good_senders).each do |attr|

data/lib/ogn_client/messages/sender_beacon.rb

@@ -3,7 +3,7 @@ module OGNClient
   class SenderBeacon < Message
 
     SENDER_BEACON_PATTERN = %r(
-      id(?<details>\w{2})(?<id>\w+?)\s?
+      id(?<details>\w{2})(?<id>\w{6})\s?
       (?:(?<climb_rate>[+-]\d+?)fpm\s)?
       (?:(?<turn_rate>[+-][\d.]+?)rot\s)?
       (?:FL(?<flight_level>[\d.]+)\s)?
@@ -62,7 +62,7 @@ module OGNClient
 
     private
 
-    def parse(raw)
+    def parse(raw, date: nil)
       raw.match SENDER_BEACON_PATTERN do |match|
         super unless @raw
         %i(details id flight_level climb_rate turn_rate signal_power signal_quality errors frequency_offset gps_accuracy flarm_software_version flarm_hardware_version flarm_id proximity).each do |attr|

data/lib/ogn_client/version.rb

@@ -1,3 +1,3 @@
 module OGNClient
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogn_client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Sven Schwyn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler