xplane 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+pkg
+*~
+#*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+end
+
+# Specify your gem's dependencies in xplane.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    xplane (0.0.1)
+      eventmachine
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    rake (10.1.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  rspec
+  xplane!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eloy Gomez
+
+MIT License
+
+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.org

@@ -0,0 +1,23 @@
+* Xplane Ruby
+** Usage
+#+BEGIN_SRC ruby
+  #!/usr/bin/env ruby
+
+  require 'xplane'
+
+  Xplane.config do |c|
+    c.xplane_host = "10.254.0.110" # default "127.0.0.1"
+    c.xplane_port = 49000 # default 49000
+    c.listen_port = 49000 # default 49001
+    c.listen_address = "0.0.0.0" # default "127.0.0.1"
+  end
+
+  Xplane.on_data_received do |msg|
+    puts "Pitch: #{msg.pitch}\t Roll: #{msg.roll}\t Heading: #{msg.heading}\tAlt: #{msg.alt}"
+    msg.send throttle_cmd_1: 1.0, throttle_cmd_2: 1.0, throttle_cmd_3: 1.0, throttle_cmd_4: 1.0
+  end
+#+END_SRC
+
+* Contribute
+At this moment lib/xplane/data_mapper.rb is very incomplete. Pull
+requests with new elements will be welcome.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/xplane.rb

@@ -0,0 +1,20 @@
+require 'socket'
+require 'eventmachine'
+require 'xplane/configuration'
+require 'xplane/data_mapper'
+require 'xplane/message_data_formatter'
+require 'xplane/message'
+require 'xplane/connection'
+require "xplane/version"
+
+module Xplane
+
+  def self.on_data_received(&block)
+    listen_address = Xplane.config.listen_address
+    port = Xplane.config.listen_port
+    EM.run do
+      EM.open_datagram_socket(listen_address, port, XplaneConnection, block)
+    end
+  end
+
+end

data/lib/xplane/configuration.rb

@@ -0,0 +1,18 @@
+module Xplane
+  class Configuration
+    attr_accessor :xplane_host, :xplane_port, :listen_address, :listen_port
+    def initialize
+      xplane_host = "127.0.0.1"
+      xplane_port = 49000
+      listen_port = 49001
+      listen_address = "127.0.0.1"
+    end
+  end
+  @@config ||= Configuration.new
+
+  def self.config(&block)
+    block.call @@config if block
+    return @@config
+  end
+
+end

data/lib/xplane/connection.rb

@@ -0,0 +1,14 @@
+module Xplane
+
+  class XplaneConnection < EventMachine::Connection
+    def initialize(block)
+      @block = block
+    end
+
+    def receive_data(binary_data)
+      message = Message.new self, binary_data
+      @block.call message
+    end
+  end
+
+end

data/lib/xplane/data_mapper.rb

@@ -0,0 +1,8 @@
+module Xplane
+  XPLANE_DATA_MAPPER = {
+    17 => [:pitch, :roll, :heading, :magnetic_heading],
+    20 => [:lattitude, :longitude, :alt, :alt_agl],
+    25 => [:throttle_cmd_1, :throttle_cmd_2, :throttle_cmd_3, :throttle_cmd_4 ],
+    26 => [:throttle_1, :throttle_2, :throttle_3, :throttle_4 ]
+  }
+end

data/lib/xplane/message.rb

@@ -0,0 +1,27 @@
+class Xplane::Message
+  include Xplane::MessageDataFormater
+
+  def initialize(connection, binary_data = false)
+    @conn = connection
+    @data = parse_binary_data(binary_data) if binary_data
+  end
+
+  # Send data back to Xplane
+  def send(data={})
+    binary_data = build_binary_data data
+    @conn.send_datagram binary_data, Xplane.config.xplane_host, Xplane.config.xplane_port
+  end
+
+
+  # Define getters
+  #----------------------------------------------------------------------
+
+  Xplane::XPLANE_DATA_MAPPER.values.each do |data_element|
+    data_element.each do |key|
+      define_method(key) do
+        @data[key]
+      end
+    end
+  end
+
+end

data/lib/xplane/message_data_formatter.rb

@@ -0,0 +1,74 @@
+module Xplane::MessageDataFormater
+
+  # Binary data formats
+  #----------------------------------------------------------------------
+
+  HEADER_FORMAT = "CCCCC"
+  DATA_FORMAT = "iffffffff"
+
+  DATA_ELEMENTS = 8
+
+
+  # Read and parse data received from XPlane
+  #----------------------------------------------------------------------
+
+  def parse_binary_data(binary_data)
+    chunk_size = DATA_ELEMENTS + 1 # plus header
+    data_elements = binary_data.length / DATA_FORMAT.length
+    data_format =  binary_format data_elements
+    unpacked = binary_data.unpack(data_format)
+    buffer = unpacked[HEADER_FORMAT.length..-1]
+    data = {}
+    data_elements.times do |element_index|
+      offset = element_index * chunk_size
+      chunk = buffer[offset..offset + chunk_size]
+      element_id = chunk[0]
+      map = Xplane::XPLANE_DATA_MAPPER[element_id]
+      if map
+        map.each_with_index do |key, i|
+          data[key] = chunk[i + 1] # plus header
+        end
+      end
+    end
+    return data
+  end
+
+  # Create a DATA package with the given data
+  def build_binary_data(data={})
+    buffer = [68, 65, 84, 65, 0] # D A T A
+    elements_to_send = []
+    keys_to_send = data.keys
+
+    Xplane::XPLANE_DATA_MAPPER.each do |element_id, included_elements|
+     element = nil
+      included_elements.each_with_index do |element_name, index|
+        if keys_to_send.include? element_name
+          element ||= new_element(element_id)
+          element[index + 1] = data[element_name]
+        end
+      end
+      elements_to_send.push element unless element.nil?
+    end
+
+    elements_to_send.each do |element|
+      buffer += element
+    end
+    buffer.pack binary_format(elements_to_send.length)
+  end
+
+  private
+
+  def binary_format(elements=1)
+    HEADER_FORMAT + DATA_FORMAT * elements
+  end
+
+  # Build an empty element
+  def new_element(element_id)
+    e = [element_id]
+    DATA_ELEMENTS.times do
+      e.push -999 # Ignore
+    end
+    return e
+  end
+
+end

data/lib/xplane/version.rb

@@ -0,0 +1,3 @@
+module Xplane
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+
+require 'xplane'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/message_data_formatter_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+class Formatter
+  include Xplane::MessageDataFormater
+end
+
+describe Xplane::MessageDataFormater do
+  let(:formatter) { Formatter.new }
+
+  describe 'MessageDataFormater#build_binary_data' do
+    it 'should create a binary message from the given binary data' do
+      binary_data = formatter.build_binary_data(throttle_cmd_1: 1.1)
+      data = formatter.parse_binary_data(binary_data)
+      expect(data[:throttle_cmd_1].round(1)).to eq 1.1
+    end
+  end
+end

data/xplane.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xplane/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xplane"
+  spec.version       = Xplane::VERSION
+  spec.authors       = ["Eloy Gomez"]
+  spec.email         = ["eloy@indeos.es"]
+  spec.description   =  "Gem for communicate with X-Plane via UDP packages"
+  spec.summary       = "EventMachine based library for send and receive data from X-Plane Flight Simulator with ruby."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency 'eventmachine'
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: xplane
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eloy Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for communicate with X-Plane via UDP packages
+email:
+- eloy@indeos.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.org
+- Rakefile
+- lib/xplane.rb
+- lib/xplane/configuration.rb
+- lib/xplane/connection.rb
+- lib/xplane/data_mapper.rb
+- lib/xplane/message.rb
+- lib/xplane/message_data_formatter.rb
+- lib/xplane/version.rb
+- spec/spec_helper.rb
+- spec/unit/message_data_formatter_spec.rb
+- xplane.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: EventMachine based library for send and receive data from X-Plane Flight
+  Simulator with ruby.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/message_data_formatter_spec.rb
+has_rdoc: