ogn_client-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02438399c35649b6367b7c29b764915182edc72b
-  data.tar.gz: c1d8d0cccae554f55cb74b9944dbcfe91a6a1ea0
+  metadata.gz: 4a6d60e5f26f6b6c18c2e1f6e4aba695901e5473
+  data.tar.gz: 75e00d14055934f85c66acdd1c7046173425aeba
 SHA512:
-  metadata.gz: 102a7568799ecdbacb814fc7f5ab956a780ef237748f47e4bf4fcca6eedcf1bc11ea299b204a8a4d69da93e66d3f3e9ef4af0f6d55cb1937ca515e38ddc5e458
-  data.tar.gz: d9b989f3a32cc8b8c3316afa9a4d48391dee7de676326214a759eb76927f40c856e2008e792449a5df790c19cc605f6909a939631f450af22e404b7f0d3fb7fb
+  metadata.gz: 1c1e7c3788ab24ead12e31e5cc67bd0a3a9b12cfef99885dd16cef31d5a780faf1e7f860f7d2efdbf958085904bd36d0ee7031493e15ae89624fce0cf321b8f7
+  data.tar.gz: fb2171f7a02881b8a12c160271172c9bb515e35b7498320ffa9f5ae624cd7baf31dbc0ff51d2f9ae96c2c13d0d88721a93cbf7e0669e1288ad8b8229241dd564

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.3
+ruby-2.3.0

data/.travis.yml

@@ -1,6 +1,7 @@
 ---
 language: ruby
 rvm:
-  - 2.2.3
-  - 2.1.7
-before_install: gem install bundler -v 1.10.6
+  - 2.3.1
+  - 2.2.5
+  - 2.1.10
+before_install: gem install bundler -v 1.13.2

data/CHANGELOG.md

@@ -1,5 +1,27 @@
+## 0.1.2
+
+  * support for receiver versions <= 0.2.5
+  * faster message parsing
+  * new sender and receiver attributes
+    * `Sender#power`
+    * `Receiver#voltage`
+    * `Receiver#amperage`
+    * `Receiver#senders`
+    * `Receiver#senders_visible`
+    * `Receiver#senders_invisible`
+    * `Receiver#voltage`
+    * `Receiver#senders_signal`
+    * `Receiver#senders_messages`
+    * `Receiver#good_and_bad_senders`
+    * `Receiver#good_senders`
+    * `Receiver#bad_senders`
+  * renamed receiver attributes
+    * `Receiver#manual_correction` -> `Receiver#rf_correction_manual`
+    * `Receiver#automatic_correction` -> `Receiver#rf_correction_automatic`
+
 ## 0.1.1
 
+  * supported receiver versions <= 0.2.4
   * remove debug support and raise errors instead
   * convert raw messages to UTF-8 before parsing
   * new sender and receiver attributes
@@ -12,7 +34,6 @@
   * renamed message attribute
     * `Message#speed` -> `Message#ground_speed`
   * verification of supported receiver version
-  * supported receiver versions <= 0.2.5
 
 ## 0.1.0
 

data/README.md

@@ -2,6 +2,7 @@
 [![Continuous Integration](https://img.shields.io/travis/svoop/ogn_client-ruby/master.svg?style=flat)](https://travis-ci.org/svoop/ogn_client-ruby)
 [![Code Climate](https://img.shields.io/codeclimate/github/svoop/ogn_client-ruby.svg?style=flat)](https://codeclimate.com/github/svoop/ogn_client-ruby)
 [![Gitter](https://img.shields.io/gitter/room/svoop/ogn_client-ruby.svg?style=flat)](https://gitter.im/svoop/ogn_client-ruby)
+[![Donorbox](https://img.shields.io/badge/donate-on donorbox-yellow.svg)](https://donorbox.org/bitcetera-ogn_client-ruby)
 
 # ogn_client-ruby
 
@@ -10,7 +11,7 @@
 * Author: [Sven Schwyn](http://bitcetera.com)
 * Homepage: https://github.com/svoop/ogn_client-ruby
 
-:loudspeaker: A word from the shameless commerce division: Looking for a freelance Ruby developer? Contact Sven on http://bitcetera.com
+:loudspeaker: A word from the shameless commerce division: Looking for a freelance Ruby developer? Surf to http://bitcetera.com and contact Sven. Or [show your support with a donation](https://donorbox.org/bitcetera-ogn_client-ruby). Yes, we do sponsored features, too.
 
 ## Installation
 
@@ -69,14 +70,15 @@ Attributes:
 * **altitude** - WGS84 meters above mean see level QNH
 * **heading** - degrees from 1 to 360
 * **ground_speed** - kilometers per hour
-* **stealth_mode** - boolean (should always be false)
-* **no_tracking** - boolean
 * **sender_type** - see [SENDER_TYPES](https://github.com/svoop/ogn_client-ruby/blob/master/lib/ogn_client/messages/sender.rb)
 * **address_type** - see [ADDRESS_TYPES](https://github.com/svoop/ogn_client-ruby/blob/master/lib/ogn_client/messages/sender.rb)
 * **id** - device ID
+* **stealth_mode** - boolean (should always be false)
+* **no_tracking** - boolean
+* **flight_level** - 100 feet QNE
 * **climb_rate** - meters per second
 * **turn_rate** - revolutions per minute
-* **flight_level** - 100 feet QNE
+* **power** - power ratio in dBm
 * **signal** - signal to noise ratio in decibel
 * **errors** - number of CRC errors
 * **frequency_offset** - kilohertz
@@ -107,7 +109,20 @@ Attributes:
 * **ram_total** - megabytes
 * **ntp_offset** - milliseconds
 * **ntp_correction** - parts-per-million
+* **voltage** - board voltage in V
+* **amperage** - board amperage in A
+* **rf_correction_manual** - manual frequency correction as per configuration
+* **rf_correction_automatic** - automatic frequency correction based on GSM
+* **senders** - number of senders received within the last hour
+* **visible_senders** - number of visible senders withint the last hour
+* **invisible_senders** - number of invisible senders ("no-track" on device or "invisible" in database)
 * **signal** - signal-to-noise ratio in decibel
+* **senders_signal** - average signal-to-noise ratio across all senders
+* **senders_messages** - number of messages analyzed to calculate the above
+* **good_senders_signal** - average signal-to-noise ratio in decibel of good senders (transmitting properly) within the last 24 hours
+* **good_and_bad_senders** - number of good and bad senders within the last 24 hours
+* **good_senders** - number of good senders (transmitting properly) within the last 24 hours
+* **bad_senders** - number of bad senders (not transmitting properly) within the last 24 hours
 
 #### OGNClient::Comment
 
@@ -126,15 +141,21 @@ The following domain specific errors may be raised:
 They all inherit from `OGNClient::Error`. An fault-tolerant subscription could therefore look as follows:
 
 ```ruby
+require 'ogn_client'
+
 logger = Logger.new('/tmp/ogn_client.log')
-OGNClient::APRS.start(callsign: 'ROCT', filter: 'r/33/-97/200') do |aprs|
-  loop do
-    begin
-      message = OGNClient::Message.parse aprs.gets
-    rescue OGNClient::Error => error
-      logger.error error.message
+options = { callsign: 'ROCT', filter: 'r/47/2/500' }
+loop do
+  OGNClient::APRS.start(options) do |aprs|
+    while raw = aprs.gets
+      begin
+        message = OGNClient::Message.parse aprs.gets
+      rescue OGNClient::Error => error
+        logger.error error.message
+        next
+      end
+      puts message.raw   # do more interesting stuff here
     end
-    puts message.raw
   end
 end
 ```
@@ -143,7 +164,9 @@ end
 
 * Look for developers and users on [Gitter](https://gitter.im/svoop/ogn_client-ruby).
 * Ask your questions on [Stackoverflow](https://stackoverflow.com/questions/ask?tags=ogn_client-ruby,ruby,gem).
-* Bug reports and pull requests are welcome on [GitHub](https://github.com/svoop/ogn_client-ruby).
+* Annotated source code on [omniref](https://www.omniref.com/repositories/svoop/ogn_client-ruby)
+* Bug reports, feature and pull requests are welcome on [GitHub](https://github.com/svoop/ogn_client-ruby).
+* [Donations with Stripe or PayPal](https://donorbox.org/bitcetera-ogn_client-ruby) are welcome as well. If you prefer to sponsor a feature, please create an issue on [GitHub](https://github.com/svoop/ogn_client-ruby) first and state your intentions.
 
 ## Development
 

data/lib/ogn_client/aprs.rb

@@ -32,6 +32,7 @@ module OGNClient
     def start
     	@socket = TCPSocket.open SERVER, @port
       @socket.puts handshake
+      @socket.flush
       if block_given?
         begin
           return yield(@socket)

data/lib/ogn_client/message.rb

@@ -22,13 +22,12 @@ module OGNClient
   class Message
 
     POSITION_PATTERN = %r(^
-      (?<callsign>\w+?)>APRS,.+?,
-      (?<receiver>\w+):/
+      (?<callsign>.+?)>APRS,(?:.+?,){1,2}
+      (?<receiver>.+?):[/>]
       (?<time>\d{6})h
-      (?<latitude>\d{4}\.\d{2}[NS]).
-      (?<longitude>\d{5}\.\d{2}[EW]).
-      (?:(?<heading>\d{3})/(?<ground_speed>\d{3}))?.*?
-      /A=(?<altitude>\d{6})\s
+      (?:(?<latitude>\d{4}\.\d{2}[NS]).(?<longitude>\d{5}\.\d{2}[EW]).)?
+      (?:(?<heading>\d{3})/(?<ground_speed>\d{3}))?
+      (?:/A=(?<altitude>\d{6}))?\s+
       (?:!W((?<latitude_enhancement>\d)(?<longitude_enhancement>\d))!)?
     )x
 
@@ -47,7 +46,8 @@ module OGNClient
       raw = raw.chomp.force_encoding('ASCII-8BIT').encode('UTF-8')
       OGNClient::Sender.new.send(:parse, raw) ||
         OGNClient::Receiver.new.send(:parse, raw) ||
-        OGNClient::Comment.new.send(:parse, raw)
+        OGNClient::Comment.new.send(:parse, raw) ||
+        fail(OGNClient::MessageError, "message payload parsing failed: `#{raw}'")
     end
 
     def to_s
@@ -58,16 +58,16 @@ module OGNClient
 
     def parse(raw)
       @raw = raw
-      @raw.match(POSITION_PATTERN) do |match|
+      raw.match POSITION_PATTERN do |match|
         %i(callsign receiver time altitude).each do |attr|
-          send "#{attr}=", match[attr]
+          send("#{attr}=", match[attr]) if match[attr]
         end
         self.heading = match[:heading] if match[:heading] && match[:heading] != '000'
         self.ground_speed = match[:ground_speed] if match[:ground_speed] && match[:heading] != '000'
-        self.longitude = [match[:longitude], match[:longitude_enhancement]]
-        self.latitude = [match[:latitude], match[:latitude_enhancement]]
+        self.longitude = [match[:longitude], match[:longitude_enhancement]] if match[:longitude]
+        self.latitude = [match[:latitude], match[:latitude_enhancement]] if match[:latitude]
         self
-      end || fail(OGNClient::MessageError, "message parsing failed: `#{@raw}'")
+      end or fail(OGNClient::MessageError, "message position parsing failed: `#{@raw}'")
       self
     end
 

data/lib/ogn_client/messages/comment.rb

@@ -11,7 +11,7 @@ module OGNClient
     private
 
     def parse(raw)
-      @raw = raw
+      @raw ||= raw
       @raw.match COMMENT_PATTERN do |match|
         self.comment = match[:comment]
         self

data/lib/ogn_client/messages/receiver.rb

@@ -9,38 +9,63 @@ module OGNClient
       \s)?
       CPU:(?<cpu_load>[\d.]+)\s
       RAM:(?<ram_free>[\d.]+)/(?<ram_total>[\d.]+)MB\s
-      NTP:(?<ntp_offset>[\d.]+)ms/(?<ntp_correction>[+-][\d.]+)ppm\s?
+      NTP:(?<ntp_offset>[\d.]+)ms/(?<ntp_correction>[+-][\d.]+)ppm\s
+      (?:(?<voltage>[\d.]+)V\s)?
+      (?:(?<amperage>[\d.]+)A\s)?
       (?:(?<cpu_temperature>[+-][\d.]+)C\s*)?
+      (?:(?<visible_senders>\d+)/(?<senders>\d+)Acfts\[1h\]\s*)?
       (?:RF:
         (?:
-          (?<manual_correction>[+-][\d]+)
-          (?<automatic_correction>[+-][\d.]+)ppm/
+          (?<rf_correction_manual>[+-][\d]+)
+          (?<rf_correction_automatic>[+-][\d.]+)ppm/
         )?
         (?<signal>[+-][\d.]+)dB
+        (?:/(?<senders_signal>[+-][\d.]+)dB@10km\[(?<senders_messages>\d+)\])?
+        (?:/(?<good_senders_signal>[+-][\d.]+)dB@10km\[(?<good_senders>\d+)/(?<good_and_bad_senders>\d+)\])?
       )?
     $)x
 
     SUPPORTED_RECEIVER_VERSION = Gem::Version.new('0.2.5')
 
-    attr_reader :version                # software version as #<Gem::Version "major.minor.patch">
-    attr_reader :platform               # e.g. "ARM"
-    attr_reader :cpu_load               # as reported by "uptime"
-    attr_reader :cpu_temperature        # degrees celsius
-    attr_reader :ram_free               # megabytes
-    attr_reader :ram_total              # megabytes
-    attr_reader :ntp_offset             # milliseconds
-    attr_reader :ntp_correction         # parts-per-million
-    attr_reader :manual_correction      # as per configuration
-    attr_reader :automatic_correction   # based on GSM
-    attr_reader :signal                 # signal-to-noise ratio in decibel
+    attr_reader :version                   # software version as #<Gem::Version "major.minor.patch">
+    attr_reader :platform                  # e.g. "ARM"
+    attr_reader :cpu_load                  # as reported by "uptime"
+    attr_reader :cpu_temperature           # degrees celsius
+    attr_reader :ram_free                  # megabytes
+    attr_reader :ram_total                 # megabytes
+    attr_reader :ntp_offset                # milliseconds
+    attr_reader :ntp_correction            # parts-per-million
+    attr_reader :voltage                   # board voltage in V
+    attr_reader :amperage                  # board amperage in A
+    attr_reader :rf_correction_manual      # as per configuration
+    attr_reader :rf_correction_automatic   # based on GSM
+    attr_reader :senders                   # number of senders within the last hour
+    attr_reader :visible_senders           # number of visible senders within the last hour
+    attr_reader :signal                    # signal-to-noise ratio in decibel
+    attr_reader :senders_signal            # average signal-to-noise ratio in decibel across all senders
+    attr_reader :senders_messages          # number of messages analyzed to calculate the above
+    attr_reader :good_senders_signal       # average signal-to-noise ratio in decibel of good senders (transmitting properly) within the last 24 hours
+    attr_reader :good_and_bad_senders      # number of good and bad senders within the last 24 hours
+    attr_reader :good_senders              # number of good senders (transmitting properly) within the last 24 hours
+
+    def invisible_senders
+      senders - visible_senders
+    rescue
+      nil
+    end
+
+    def bad_senders
+      good_and_bad_senders - good_senders
+    rescue
+      nil
+    end
 
     private
 
     def parse(raw)
-      @raw = raw
-      @raw.match RECEIVER_PATTERN do |match|
-        return unless super
-        %i(version platform cpu_load cpu_temperature ram_free ram_total ntp_offset ntp_correction manual_correction automatic_correction signal).each do |attr|
+      raw.match RECEIVER_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 senders_signal senders_messages good_senders_signal good_and_bad_senders good_senders).each do |attr|
           send("#{attr}=", match[attr]) if match[attr]
         end
         self
@@ -81,18 +106,54 @@ module OGNClient
       @ntp_correction = raw.to_f.round(2)
     end
 
-    def manual_correction=(raw)
-      @manual_correction = raw.to_i
+    def voltage=(raw)
+      @voltage = raw.to_f.round(3)
+    end
+
+    def amperage=(raw)
+      @amperage = raw.to_f.round(3)
+    end
+
+    def rf_correction_manual=(raw)
+      @rf_correction_manual = raw.to_i
+    end
+
+    def rf_correction_automatic=(raw)
+      @rf_correction_automatic = raw.to_f.round(1)
+    end
+
+    def senders=(raw)
+      @senders = raw.to_i
     end
 
-    def automatic_correction=(raw)
-      @automatic_correction = raw.to_f.round(1)
+    def visible_senders=(raw)
+      @visible_senders = raw.to_i
     end
 
     def signal=(raw)
       @signal = raw.to_f.round(3)
     end
 
+    def senders_signal=(raw)
+      @senders_signal = raw.to_f.round(3)
+    end
+
+    def senders_messages=(raw)
+      @senders_messages = raw.to_i
+    end
+
+    def good_senders_signal=(raw)
+      @good_senders_signal = raw.to_f.round(3)
+    end
+
+    def good_and_bad_senders=(raw)
+      @good_and_bad_senders = raw.to_i
+    end
+
+    def good_senders=(raw)
+      @good_senders = raw.to_i
+    end
+
   end
 
 end

data/lib/ogn_client/messages/sender.rb

@@ -14,6 +14,7 @@ module OGNClient
       (?:s(?<flarm_software_version>[\d.]+)\s?)?
       (?:h(?<flarm_hardware_version>[\dA-F]{2})\s?)?
       (?:r(?<flarm_id>[\dA-F]+)\s?)?
+      (?:(?<power>[+-][\d.]+)dBm\s?)?
       (?:hear(?<proximity>.+))?
     $)x
 
@@ -41,14 +42,15 @@ module OGNClient
       3 => :ogn
     }
 
-    attr_reader :stealth_mode             # boolean
-    attr_reader :no_tracking              # boolean
     attr_reader :sender_type              # see SENDER_TYPES
     attr_reader :address_type             # see ADDRESS_TYPES
     attr_reader :id                       # device ID
+    attr_reader :stealth_mode             # boolean
+    attr_reader :no_tracking              # boolean
+    attr_reader :flight_level             # 100 feet QNE
     attr_reader :climb_rate               # meters per second
     attr_reader :turn_rate                # revolutions per minute
-    attr_reader :flight_level             # 100 feet QNE
+    attr_reader :power                    # power ratio in dBm
     attr_reader :signal                   # signal to noise ratio in decibel
     attr_reader :errors                   # number of CRC errors
     attr_reader :frequency_offset         # kilohertz
@@ -61,10 +63,9 @@ module OGNClient
     private
 
     def parse(raw)
-      @raw = raw
-      @raw.match SENDER_PATTERN do |match|
-        return unless super
-        %i(details id climb_rate turn_rate flight_level signal errors frequency_offset gps_accuracy flarm_software_version flarm_hardware_version flarm_id proximity).each do |attr|
+      raw.match SENDER_PATTERN do |match|
+        super unless @raw
+        %i(details id flight_level climb_rate turn_rate power signal errors frequency_offset gps_accuracy flarm_software_version flarm_hardware_version flarm_id proximity).each do |attr|
           send("#{attr}=", match[attr]) if match[attr]
         end
 # NOTE: [@svoop] [ruby21] workaround necessary until support for ruby21 is removed
@@ -86,6 +87,10 @@ module OGNClient
       @id = raw
     end
 
+    def flight_level=(raw)
+      @flight_level = raw.to_f.round(2)
+    end
+
     def climb_rate=(raw)
       @climb_rate = (raw.to_i / 60.0 / 3.2808).round(1)
     end
@@ -94,8 +99,8 @@ module OGNClient
       @turn_rate = (raw.to_i / 4.0).round(1)
     end
 
-    def flight_level=(raw)
-      @flight_level = raw.to_f.round(2)
+    def power=(raw)
+      @power = raw.to_f.round(3)
     end
 
     def signal=(raw)

data/lib/ogn_client/version.rb

@@ -1,3 +1,3 @@
 module OGNClient
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

data/tasks/test.rake

@@ -1,18 +1,29 @@
+require 'ogn_client'
 
 namespace :test do
 
+  desc "Receive and dump real-time APRS messages"
+  task :receiver do
+    OGNClient::APRS.start(callsign: "ROCT-#{rand(100)}") do |aprs|
+      loop do
+        print aprs.gets
+      end
+    end
+  end
+
   desc "Parse real-time APRS messages and test the parser"
   task :parser do
-    require 'ogn_client'
-    OGNClient::APRS.start(callsign: 'ROCT') do |aprs|
-      loop do
-        print '.'
-        raw = aprs.gets
-        begin
-          OGNClient::Message.parse raw
-        rescue OGNClient::Error => error
-          puts
-          warn "WARNING: #{error.message}"
+    callsign = "ROCT-#{rand(100)}"
+    loop do
+      OGNClient::APRS.start(callsign: callsign) do |aprs|
+        while raw = aprs.gets do
+          print '.'
+          begin
+            OGNClient::Message.parse raw
+          rescue OGNClient::Error => error
+            puts
+            warn "WARNING: #{error.message}"
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogn_client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sven Schwyn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,9 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Subscriber and parser for APRS messages from OGN
 test_files: []
-has_rdoc: