ruby-adsb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88ac5ff75d15c6af3a3d4ec0c36dc18f6b017cca
+  data.tar.gz: 3bd95ab7c548acf40b294edd72e96b3d6e0af95d
+SHA512:
+  metadata.gz: 3213d314aa5ec2e8016b2021b0ee6203a857e8143e480ada24bbb8c5de5b1a9d535616aee32b9922bd479c3a8d29a992755149ab29f9f71e32907d9fc6888e8a
+  data.tar.gz: d696265f869695a61efecc5c9493158d35797bcbf89575e7dd81e65199c6f97f6780c5919c1a4e36803f5bb35bd46941fc3a899055c62ad37267a19bb9be095b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-adsb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Laurens Boekhorst
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# ADSB
+
+Automatic Dependent Surveillance Broadcast is a cooperative surveillance
+technology in which an aircraft determines its position via satellite navigation
+and periodically broadcasts it. This gem decodes automatic dependent
+surveillance broadcasts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-adsb', require: 'adsb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-adsb
+
+## Usage
+
+Create a new message:
+
+```ruby
+message = ADSB::Message.new('8D4840D6202CC371C32CE0576098')
+```
+
+Get the address of the sender:
+
+```ruby
+address = message.address
+```
+
+Get the type of message:
+
+```ruby
+type = message.type
+```
+
+The type of message is either `:identification`, `:position`, or `:velocity`.
+
+### Identification
+
+Get the reported identification:
+
+```ruby
+identification = message.identification
+```
+
+### Position
+
+Create a new compact position report from a message of even parity and a message
+of odd parity:
+
+```ruby
+even = ADSB::Message.new('8D40621D58C382D690C8AC2863A7')
+odd = ADSB::Message.new('8D40621D58C386435CC412692AD6')
+report = ADSB::CPR::Report.new(even, odd)
+```
+
+Get the reported altitude:
+
+```ruby
+altitude = report.altitude
+```
+
+Get the reported latitude:
+
+```ruby
+latitude = report.latitude
+```
+
+Get the reported longitude:
+
+```ruby
+longitude = report.longitude
+```
+
+### Velocity
+
+Get the reported heading:
+
+```ruby
+heading = message.heading
+```
+
+Get the reported velocity:
+
+```ruby
+velocity = message.velocity
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/lboekhorst/ruby-adsb.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT](http://opensource.org/licenses/MIT) license.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/adsb.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adsb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-adsb"
+  spec.version       = ADSB::VERSION
+  spec.authors       = ["Laurens Boekhorst"]
+  spec.email         = ["laurens.boekhorst@gmail.com"]
+
+  spec.summary       = %q{Decode automatic dependent surveillance broadcasts}
+  spec.homepage      = "https://github.com/lboekhorst/ruby-adsb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "adsb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adsb/cpr/report.rb

@@ -0,0 +1,90 @@
+module ADSB
+  module CPR
+    class Report
+
+      # Create a new compact position report.
+      #
+      # ==== Attributes
+      # * +even+ - The position message of even parity
+      # * +odd+ - The position message of odd parity
+      #
+      # ==== Examples
+      #   even = ADSB::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   odd = ADSB::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   report = ADSB::CPR::Report.new(even, odd)
+      def initialize even, odd
+        @even = even
+        @odd = odd
+        @parity = even.created_at > odd.created_at ? 0 : 1
+      end
+
+      # Get the reported altitude in feet.
+      #
+      # ==== Examples
+      #   even = CPR::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   odd = CPR::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   report = CPR::Report.new(even, odd)
+      #   altitude = report.altitude
+      def altitude
+        message = @parity.eql?(0) ? @even : @odd
+        return message.altitude
+      end
+
+      # Get the reported latitude in decimal degrees.
+      #
+      # ==== Examples
+      #   even = CPR::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   odd = CPR::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   report = CPR::Report.new(even, odd)
+      #   latitude = report.latitude
+      def latitude
+        return @parity.eql?(0) ? even_latitude : odd_latitude
+      end
+
+      # Get the reported longitude in decimal degrees.
+      #
+      # ==== Examples
+      #   even = CPR::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   odd = CPR::Message.new('8D40621D58C382D690C8AC2863A7')
+      #   report = CPR::Report.new(even, odd)
+      #   longitude = report.longitude
+      def longitude
+        ni = n(latitude, @parity)
+        m = (@even.longitude * (transition_latitude(latitude) - 1) - @odd.longitude * transition_latitude(latitude) + 0.5).floor
+        longitude = @parity.eql?(0) ? 360.0 / ni * (m % ni + @even.longitude) : 360.0 / ni * (m % ni + @odd.longitude)
+        return longitude >= 180 ? longitude - 360 : longitude
+      end
+
+      private
+
+      def even_latitude
+        latitude = (latitude_index % 59) + @even.latitude
+        latitude = 360.0 / 60 * latitude
+        return latitude >= 270 ? latitude - 360 : latitude
+      end
+
+      def latitude_index
+        latitude_index = 59 * @even.latitude - 60 * @odd.latitude + 0.5
+        return latitude_index.floor
+      end
+
+      def odd_latitude
+        latitude = (latitude_index % 59) + @odd.latitude
+        latitude = 360.0 / 59 * latitude
+        return latitude >= 270 ? latitude - 360 : latitude
+      end
+
+      def n latitude, parity
+        transition_latitude = transition_latitude(latitude) - parity
+        return transition_latitude > 1 ? transition_latitude : 1
+      end
+
+      def transition_latitude latitude
+        a = 1 - Math.cos(Math::PI * 2 / 60)
+        b = Math.cos(Math::PI / 180.0 * latitude.abs) ** 2
+        transition_latitude = 2 * Math::PI / Math.acos(1 - a / b)
+        return transition_latitude.to_i
+      end
+    end
+  end
+end

data/lib/adsb/message.rb

@@ -0,0 +1,55 @@
+module ADSB
+  class Message
+    attr_reader :created_at
+    
+    # Create a new message.
+    #
+    # ==== Attributes
+    # * +body+ - The body of the message as a hexadecimal string
+    # * +created_at+ - The time at which the message was created
+    #
+    # ==== Examples
+    #   message = ADSB::Message.new('8D4840D6202CC371C32CE0576098')
+    #   message = ADSB::Message.new('8D4840D6202CC371C32CE0576098', Time.now)
+    def initialize body, created_at = Time.now
+      @body = body.hex.to_s(2)
+      @created_at = created_at
+      decoder = Kernel.const_get("ADSB::Messages::#{type.to_s.capitalize}")
+      extend(decoder)
+    end
+
+    # Get the address of the sender.
+    #
+    # ==== Examples
+    #   message = ADSB::Message.new('8D4840D6202CC371C32CE0576098')
+    #   address = message.address
+    def address
+       '%02x' % @body[8..31].to_i(2)
+    end
+
+    def data
+      @body[32..87]
+    end
+
+    def downlink_format
+      @body[0..4].to_i(2)
+    end
+
+    # Get type of message.
+    #
+    # ==== Examples
+    #   message = ADSB::Message.new('8D4840D6202CC371C32CE0576098')
+    #   type = message.type
+    def type
+      case type_code
+        when 1, 2, 3, 4 then :identification
+        when 9, 10, 11, 12, 13, 14, 15, 16, 17, 18 then :position
+        when 19 then :velocity
+      end
+    end
+
+    def type_code
+      @body[32..36].to_i(2)
+    end
+  end
+end

data/lib/adsb/messages/identification.rb

@@ -0,0 +1,19 @@
+module ADSB
+  module Messages
+    module Identification
+
+      # Get the reported identification.
+      #
+      # ==== Examples
+      #   message = ADSB::Message.new('8D4840D6202CC371C32CE0576098')
+      #   address = message.address
+      def identification
+        characters = '#ABCDEFGHIJKLMNOPQRSTUVWXYZ#####_###############0123456789######'
+        data = self.data[8..-1]
+        identification = String.new
+        (0..48).step(6) { |x| identification += characters[data[x..x + 5].to_i(2)] }
+        return identification.gsub(/(_|#)/, String.new)
+      end
+    end
+  end
+end

data/lib/adsb/messages/position.rb

@@ -0,0 +1,19 @@
+module ADSB
+  module Messages
+    module Position
+      def altitude
+        altitude = @body[40..51]
+        resolution = altitude.slice!(7).eql?(0) ? 100 : 25
+        altitude = altitude.to_i(2) * resolution - 1000
+      end
+
+      def latitude
+        @body[54..70].to_i(2).to_f / 131072
+      end
+
+      def longitude
+        @body[71..87].to_i(2).to_f / 131072
+      end
+    end
+  end
+end

data/lib/adsb/messages/velocity.rb

@@ -0,0 +1,38 @@
+module ADSB
+  module Messages
+    module Velocity
+
+      # Get the reported heading.
+      #
+      # ==== Examples
+      #   message = ADSB::Message.new('8D485020994409940838175B284F')
+      #   heading = message.heading
+      def heading
+        heading = Math.atan2(@west_east_velocity, @south_north_velocity) * 360 / (2 * Math::PI)
+        return heading < 0 ? heading + 360 : heading
+      end
+
+      def self.extended message
+        west_east_velocity = signed_velocity(message.data[14..23].to_i(2), message.data[13].to_i(2))
+        message.instance_variable_set(:@west_east_velocity, west_east_velocity)
+        south_north_velocity = signed_velocity(message.data[25..34].to_i(2), message.data[24].to_i(2))
+        message.instance_variable_set(:@south_north_velocity, south_north_velocity)
+      end
+
+      # Get the reported velocity.
+      #
+      # ==== Examples
+      #   message = ADSB::Message.new('8D485020994409940838175B284F')
+      #   velocity = message.velocity
+      def velocity
+        return Math.sqrt(@west_east_velocity ** 2 + @south_north_velocity ** 2)
+      end
+
+      private
+
+      def self.signed_velocity velocity, velocity_sign
+        return velocity_sign.eql?(0) ? velocity - 1 : -1 * (velocity - 1)
+      end
+    end
+  end
+end

data/lib/adsb/version.rb

@@ -0,0 +1,3 @@
+module ADSB
+  VERSION = "0.1.0"
+end

data/lib/adsb.rb

@@ -0,0 +1,6 @@
+require "adsb/cpr/report"
+require "adsb/message"
+require "adsb/messages/identification"
+require "adsb/messages/position"
+require "adsb/messages/velocity"
+require "adsb/version"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ruby-adsb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laurens Boekhorst
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- laurens.boekhorst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adsb.gemspec
+- bin/console
+- bin/setup
+- lib/adsb.rb
+- lib/adsb/cpr/report.rb
+- lib/adsb/message.rb
+- lib/adsb/messages/identification.rb
+- lib/adsb/messages/position.rb
+- lib/adsb/messages/velocity.rb
+- lib/adsb/version.rb
+homepage: https://github.com/lboekhorst/ruby-adsb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Decode automatic dependent surveillance broadcasts
+test_files: []