ogn_client-ruby 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cac6cf6364fa78e20954308deb6258c8ae789661
-  data.tar.gz: b5c802a8c11071a73549abaa50d7cf8e7cf03128
+  metadata.gz: cc7bfb92c9ee1a6a43a8fbe34b66a795c1a34551
+  data.tar.gz: 663f89af96ca723f2042fa46c943abf831c0dc9e
 SHA512:
-  metadata.gz: e60aabf34f6e4967e9423b732d676149fda8fb1f3470d3e02b37f791b4804ddc637dfb09538dcac92ecc4687672eb4c2cf84f802d694a031f59734394ac448b1
-  data.tar.gz: 1e6903681dcb6c26c5f3612f304914b867113b7598f7816f5d907c46cbade23d8392bc0a31fa43a4d61102fa08fe402e1a818bb0e9aaed06ac33c8c9d12c67df
+  metadata.gz: 47cd82bc99d6c9147ab1af0cbf29dbff876d536e50416f914a00a292b82dbb50b8f3e87a91faad2fe91ff52eb8024d57baa83541d504389895c6030a7852330e
+  data.tar.gz: 58a4744ec0cb1b4bcb9c35a3138b080d7bca6c301f953ceb08cb0204f0e8669ea6237aa04e5c0db68a8a88baeb8ba76332e4e97d577738a961627c506ff67618

data/.travis.yml

@@ -1,7 +1,7 @@
 ---
 language: ruby
 rvm:
-  - 2.3.3
-  - 2.2.6
-  - 2.1.10
-before_install: gem install bundler -v 1.13.6
+  - 2.4.1
+  - 2.3.4
+  - 2.2.7
+before_install: gem install bundler -v 1.14.6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.2
+
+  * add example executables
+    * ognlogd
+    * ogn2kml
+
 ## 0.2.0
 
   * support for receiver versions <= 0.2.6

data/README.md

@@ -180,6 +180,20 @@ end
 
 :point_up: Receiver versions ("major.minor.patch") are will only raise an error when the offending version has a higher major or minor version digit. Patch level differences will only trigger a warning.
 
+## Executables
+
+### ognlogd
+
+A simple daemon to log raw APRS messages to daily files.
+
+    ognlogd --help
+
+### ogn2kml
+
+Convert raw APRS messages (e.g. from `ognlogd`) to KML.
+
+    ogn2kml --help
+
 ## Community Support
 
 * Look for developers and users on [Gitter](https://gitter.im/svoop/ogn_client-ruby).

data/exe/ogn2kml

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+require 'optparse'
+
+gemfile do
+  source 'https://rubygems.org'
+  ruby '>= 2.4'
+  gem 'progressbar', '~> 1.8'
+  gem 'libxml-ruby', '~> 3.0', require: 'xml'
+  gem 'ogn_client-ruby', '~> 0.2', require: 'ogn_client'
+end
+
+class Converter
+  def initialize
+    OptionParser.new do |o|
+      o.banner = <<~END
+        Convert raw OGN APRS to KML tracks.
+        Usage: ogn2kml [options] infile
+      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('-o', '--outfile FILE', String, 'generated KML file (default: INFILE.kml)') { |v| @outfile = v.sub(/\.kml$/, '') + '.kml' }
+    end.parse!
+    @infile = ARGV.pop
+    fail 'infile not found' unless @infile && File.exists?(@infile)
+    @outfile ||= @infile.sub(/\.\w+$/, '') + '.kml'
+  end
+
+  def style_nodes
+    fragment = <<~END
+      <Fragment>
+        <Style id="track_normal">
+          <IconStyle>
+            <Icon>
+              <href>http://earth.google.com/images/kml-icons/track-directional/track-0.png</href>
+            </Icon>
+          </IconStyle>
+          <LineStyle>
+            <color>99ffac59</color>
+            <width>6</width>
+          </LineStyle>
+        </Style>
+        <Style id="track_highlight">
+          <IconStyle>
+            <scale>1.2</scale>
+            <Icon>
+              <href>http://earth.google.com/images/kml-icons/track-directional/track-0.png</href>
+            </Icon>
+          </IconStyle>
+          <LineStyle>
+            <color>99ffac59</color>
+            <width>8</width>
+          </LineStyle>
+        </Style>
+        <StyleMap id="track">
+          <Pair>
+            <key>normal</key>
+            <styleUrl>#track_normal</styleUrl>
+          </Pair>
+          <Pair>
+            <key>highlight</key>
+            <styleUrl>#track_highlight</styleUrl>
+          </Pair>
+        </StyleMap>
+      </Fragment>
+    END
+    XML::Parser.string(fragment).parse.root.each_child { |c| yield c }
+  end
+
+  def convert!
+    lines = File.readlines(@infile)
+    progressbar = ProgressBar.create(format: '%e |%b>%i| %p%% %t', total: lines.count)
+    xml = XML::Document.new
+    root = xml.root = XML::Node.new(:kml)
+    root['xmlns'] = 'http://www.opengis.net/kml/2.2'
+    root['xmlns:gx'] = 'http://www.google.com/kml/ext/2.2'
+    root << (document = XML::Node.new(:Document))
+    document << XML::Node.new(:name, 'OGN')
+    style_nodes { |n| document << xml.import(n) }
+    document << (folder = XML::Node.new(:Folder))
+    folder << XML::Node.new(:name, 'Tracks')
+    folder << (placemark = XML::Node.new(:Placemark))
+    placemark << XML::Node.new(:name, @callsign || 'all')
+    placemark << XML::Node.new(:styleUrl, '#track')
+    placemark << (track = XML::Node.new(:'gx:Track'))
+    track << XML::Node.new(:altitudeMode, 'absolute')
+    time = XML::Node.new(:'gx:SimpleArrayData')
+    time['name'] = 'Time'
+    ground_speed = XML::Node.new(:'gx:SimpleArrayData')
+    ground_speed['name'] = 'Ground Speed'
+    climb_rate = XML::Node.new(:'gx:SimpleArrayData')
+    climb_rate['name'] = 'Climb Rate'
+    turn_rate = XML::Node.new(:'gx:SimpleArrayData')
+    turn_rate['name'] = 'Turn Rate'
+    lines.each do |line|
+      if (sender = OGNClient::Message.parse(line)).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")
+          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)
+          turn_rate << XML::Node.new(:'gx:value', sender.turn_rate.to_i.to_s)
+        end
+      end
+      progressbar.increment
+    end
+    track << (extended_data = XML::Node.new(:ExtendedData))
+    extended_data << (schema_data = XML::Node.new(:SchemaData))
+    schema_data['schemaUrl'] = '#schema'
+    schema_data << time
+    schema_data << ground_speed
+    schema_data << climb_rate
+    schema_data << turn_rate
+    xml.save(@outfile, encoding: XML::Encoding::UTF_8)
+  end
+end
+
+begin
+  Converter.new.convert!
+rescue => exception
+  puts "#{File.basename($0)}: #{exception.message}"
+  exit 1
+end

data/exe/ognlogd

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+require 'optparse'
+require 'time'
+
+gemfile do
+  source 'https://rubygems.org'
+  ruby '>= 2.4'
+  gem 'ogn_client-ruby', '~> 0.2', require: 'ogn_client'
+  gem 'daemons', '~> 1.2'
+end
+
+class Daemon
+  attr_reader :name, :command, :rundir, :monitor
+
+  def initialize
+    @name = File.basename($0)
+    @callsign = "ROCD#{rand(1000)}"
+    @filter = "r/44/4/20"
+    @outdir = "/tmp"
+    @rundir = '/var/run'
+    @gzip = true
+    @monitor = false
+    OptionParser.new do |o|
+      o.banner = <<~END
+        Log raw OGN APRS messages to daily files.
+        Usage: #{@name} [options] {start|stop|restart|run|status|zap}
+      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, 'daemon callsign (default: ROCDnnnn)') { |v| @callsign = v }
+      o.on('-f', '--filter STRING', String, "APRS filter (default: #{@filter})") { |v| @filter = v }
+      o.on('-g', '--[no-]gzip', "gzip log files at midnight (default: #{@gzip})") { |v| @gzip = v }
+      o.on('-m', '--[no-]monitor', "automatically restart daemon after crash (default: #{@monitor})") { |v| @monitor = v }
+      o.on('-o', '--outdir DIR', String, "directory to write the files (default: #{@outdir})") { |v| @outdir = v }
+      o.on('-r', '--rundir DIR', String, "directory to write the PID file (default: #{@rundir})") { |v| @rundir = v }
+    end.parse!
+    @command = ARGV.pop&.to_sym
+    fail "command not recognized" unless %i(start stop restart run status zap).include? @command
+  end
+
+  def capture!
+    loop do
+      catch :cut do
+        `gzip "#{logfile}"` if @gzip && defined?(logfile)
+        logfile = "#{@outdir}/ogn.log-#{Time.now.strftime('%Y%m%d')}"
+        end_of_day = Time.parse("24:00").to_i
+        File.open(logfile, 'a') do |file|
+          file.sync = true
+          loop do
+            OGNClient::APRS.start(callsign: @callsign, filter: @filter) do |aprs|
+              while raw = aprs.gets
+                file.puts raw
+                throw :cut if end_of_day < Process.clock_gettime(Process::CLOCK_REALTIME, :second)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+begin
+  daemon = Daemon.new
+  Daemons.run_proc(
+    daemon.name,
+    multiple: false,
+    ARGV: [daemon.command.to_s],
+    dir_mode: :normal,
+    dir: daemon.rundir,
+    monitor: daemon.monitor,
+    monitor_interval: 60
+  ) do
+    daemon.capture!
+  end
+rescue => exception
+  puts "#{File.basename($0)}: #{exception.message}"
+  exit 1
+end

data/lib/ogn_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogn_client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Sven Schwyn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,9 @@ description: OGN (glidernet.org) broadcasts aircraft positions as APRS/APRS-IS m
   the raw message strings into meaningful objects.
 email:
 - ruby@bitcetera.com
-executables: []
+executables:
+- ogn2kml
+- ognlogd
 extensions: []
 extra_rdoc_files: []
 files:
@@ -116,6 +118,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/ogn2kml
+- exe/ognlogd
 - lib/ogn_client.rb
 - lib/ogn_client/aprs.rb
 - lib/ogn_client/errors.rb