adsb2kml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bffdcf414c8bf8c95a2ae2df02a1655a7cc97654
+  data.tar.gz: e19ad042804dff14d00725cbbaac9773a737428a
+SHA512:
+  metadata.gz: 35e13e17080a5a7eec0b666bbce7972d614afca5f3b79dafb1e16aa17123dfa24ff711c53743555a9e7fd199cd00515192db0b55f8fa0d918e36c5453eb47c4b
+  data.tar.gz: 312e3a10e7b7b99f4b9310e0eb76d42ba4af3e13587147c2c964914c1c2a24a0872c50db99ff16733c330b533b67f10c4f142a7a93125b3e507cfd54c1fdc1dc

data/LICENSE.MIT

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014, Aaron Herting "qwertos" <aaron@herting.cc>
+
+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,47 @@
+#adsb2kml
+
+This is a library to make it easy to view [ADS-B](http://en.wikipedia.org/wiki/Automatic_dependent_surveillance-broadcast)
+traffic in [Google Earth](http://earth.google.com).
+
+It was originaly used as part of a presentation at [Imagine RIT](http://www.rit.edu/imagine/) where the data
+was merged with [APRS](http://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) 
+traffic from [aprs.fi](http://aprs.fi).
+
+##Using repository code
+
+When using the code cloned from the git repository, two basic implementations are included.
+
+`cons_fe.rb` is a basic console front end that looks very similar to the interactive view of dump1090.
+
+`sin_fe.rb` uses sinatra to provide the KML file to Google Earth. This KML file gets regenerated every time
+the server gets a new request. 
+
+In either case, a dump1090 server must be availible and serving SBS1 format data (any server providing this
+data should work but has only been tested with dump1090). The provided `config.rb.example` file can be copied
+to `config.rb` and edited to set the hostname and port number of the server providing this data.
+
+Also, after 120 seconds (2 minutes) of not hearing any packets from a plane, the plane will be removed from
+the list of planes.
+
+###sin_fe.rb specific info
+
+The plane clipart is a modified version of the image that was found [here](http://openclipart.org/detail/16400/boing-plane-icon-by-sabrog),
+and is in the public domian. You can set your own by changing the file `public/plane_icon.png`. What ever you
+put there, you should set the top of the image to be the front of the plane. This allows the heading 
+to be properly viewed in Google Earth.
+
+When sinatra is running, the "dynamic KML" can be found at the location `/adsb.kml`.
+
+
+##Dependencies
+
++	[rtl_sdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr)
++	[dump1090](https://github.com/antirez/dump1090)
++	Gems
+	+	[sinatra](http://sinatrarb.com)
+	+	[ruby_kml](https://github.com/schleyfox/ruby_kml)
+
+*NOTE: This project does add some files to the module created by ruby_kml.*
+
+
+

data/lib/adsb2kml.rb

@@ -0,0 +1,17 @@
+
+require 'ruby_kml'
+
+require_relative "ruby_kml/label_style.rb"
+
+require_relative "adsb2kml/listener.rb"
+require_relative "adsb2kml/database.rb"
+require_relative "adsb2kml/airplane.rb"
+
+module ADSB
+	
+	$MESSAGE_FORMAT = /^(?<type>(MSG|STA|ID|AIR|SEL|CLK)),(?<subtype>(1|2|3|4|5|6|7|8)?),(?<session_id>\d*),(?<aircraft_id>\d*),(?<address>\h{6}),(?<flight_id>\d*),\w*,\w*,\w*,\w*,(?<callsign>(\w|\s)*),(?<altitude>\d*),(?<speed>\d*),(?<track>\d*),(?<latitude>(-?\d{1,3}\.\d{5})?),(?<longitude>(-?\d{1,3}\.\d{5})?),(?<vert_rate>-?\d*),(?<squawk>\d*),(?<alert>\d*),(?<emergency>\d*),(?<ident>\d*),(?<ground>\d*)$/
+
+	$STRING_FORMAT = "%10s %10s %10s %10s %10s %10s %10s %10s\n"
+	
+
+end

data/lib/adsb2kml/airplane.rb

@@ -0,0 +1,89 @@
+require 'ruby_kml'
+
+
+module ADSB
+	class Airplane
+		
+		@@info = [
+			:latitude,
+			:longitude,
+			:last_heard,
+			:speed,
+			:vert_rate,
+			:track,
+			:altitude
+		]
+
+		@@info.each do |x|
+			attr_accessor x
+		end
+
+		attr_reader :address
+
+		def info
+			return @@info
+		end
+
+		def initialize address
+			@address = address
+			@altitude = "0"
+		end
+
+		def merge_with airplane
+			if airplane.address != @address then
+				return false
+			end
+
+			
+			@@info.each do |x|
+				if ! airplane.send(x).empty? then
+					send( x.to_s + "=" , airplane.send(x) )
+				end
+			end
+
+			return true
+		end
+
+		def placemark
+			to_return = KML::Placemark.new(
+				:name => @address,
+				:geometry => KML::Point.new(
+					:coordinates => {
+						:lat => @latitude,
+						:lng => @longitude,
+						:alt => @altitude
+					}
+				),
+				:style_url => "#" + @address + "_style"
+			)
+
+			return to_return
+		end
+
+		def icon url
+			to_return = KML::Style.new(
+				:id => @address + "_style",
+				:icon_style => KML::IconStyle.new(
+					:heading => @track,
+					:icon => KML::Icon.new(
+						:href => url
+					),
+					:scale => 1.4
+				),
+				:label_style => KML::LabelStyle.new(
+					:scale => 0.4
+				)
+			)
+		end
+
+		def to_cons
+			return sprintf $STRING_FORMAT, @address, @latitude, @longitude, @altitude, @speed, @last_heard, time_diff, @track
+		end
+
+		def time_diff
+			return Time.now.to_i - @last_heard.to_i
+		end
+			
+	end
+end
+

data/lib/adsb2kml/database.rb

@@ -0,0 +1,86 @@
+
+require 'ruby_kml'
+
+module ADSB
+	class Database
+		attr_accessor :icon_url	
+
+		def initialize name = "ADSB"
+			@name = name
+			@airplanes = {}
+			@icon_url = "/plane_icon.png"
+		end
+
+
+		def update airplane
+			if ( @airplanes.has_key? airplane.address ) then
+				@airplanes[airplane.address].merge_with airplane
+			else
+				@airplanes[airplane.address] = airplane
+			end
+		end
+
+		def update_t airplane
+			Thread.new do
+				update airplane
+			end
+		end
+
+
+		def to_kml
+			kml = KMLFile.new
+			folder = KML::Folder.new( :name => @name )
+			
+			@airplanes.each do |address, airplane|
+				folder.features << airplane.icon(@icon_url)
+				folder.features << airplane.placemark
+			end
+
+			kml.objects << folder
+
+			return kml
+		end
+
+		def to_cons
+			to_return = sprintf $STRING_FORMAT, "Address", "Latitude", "Longitude", "Altitude", "Speed", "Last Heard", "Time Diff", "Track"
+
+			@airplanes.each do |address, air|
+				to_return += air.to_cons
+			end
+			
+			return to_return
+
+		end
+
+
+		def expire_after time = 120
+			@time_expire = time
+			spawn_thread :watch_expire
+		end
+
+		private
+		def spawn_thread sym
+			Thread.new do
+				loop do
+					send sym
+				end
+			end
+		end
+
+		def watch_expire
+			expired = []
+			@airplanes.each do |addr, air|
+				if air.time_diff >= @time_expire then
+					expired.push addr
+				end
+			end
+
+			expired.each do |exp|
+				@airplanes.delete exp
+			end
+
+			sleep 10
+		end
+	end
+end
+

data/lib/adsb2kml/listener.rb

@@ -0,0 +1,71 @@
+require 'socket'
+
+
+module ADSB
+	class Listener
+
+		def initialize hostname, port, database
+			@hostname = hostname
+			@port = port
+			@database = database
+
+			@cons_sock = TCPSocket.new hostname, port
+			
+			@lt = spawn_thread :listener
+		end
+
+		private
+		def spawn_thread sym
+			Thread.new do
+				loop do
+					send sym
+				end
+			end
+		end
+
+		def listener
+			begin
+				line = @cons_sock.gets
+			rescue
+				puts "error"
+			end
+			line.strip!
+
+			match = nil
+			begin
+			if ! ( match = $MESSAGE_FORMAT.match line ) then
+				puts "no match"
+				puts line
+				return
+			end
+			rescue
+				puts "error2"
+			end
+			
+
+			temp_airplane = Airplane.new match[:address]
+
+			temp_airplane.last_heard = Time.now.to_i.to_s
+	
+
+			temp_airplane.info.each do |sym|
+			begin
+				if sym == :last_heard then
+					next
+				end
+
+				temp_airplane.send( sym.to_s + "=", match[sym])
+			rescue
+				puts "error " + sym.to_s
+			end
+			end
+			
+			
+			
+			
+			@database.update_t( temp_airplane )
+		end
+	end
+end
+
+

data/lib/ruby_kml/label_style.rb

@@ -0,0 +1,16 @@
+
+
+module KML
+	class LabelStyle < ColorStyle
+
+		attr_accessor :scale
+
+		def render(xm=Builder::XmlMarkup.new(:indent => 2) )
+			xm.LabelStyle {
+				super
+				xm.scale(scale) unless scale.nil?
+			}
+		end
+	end
+end
+	

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: adsb2kml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Herting 'qwertos'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_kml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+description: A library to convert SBS1 messages to KML
+email: aaron@herting.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.MIT
+- README.md
+- lib/adsb2kml.rb
+- lib/adsb2kml/airplane.rb
+- lib/adsb2kml/database.rb
+- lib/adsb2kml/listener.rb
+- lib/ruby_kml/label_style.rb
+homepage: https://github.com/qwertos/adsb2kml
+licenses:
+- MIT
+metadata: {}
+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.2
+signing_key: 
+specification_version: 4
+summary: A library to convert SBS1 messages to KML
+test_files: []