o3d3xx 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Christian Ege
+
+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.md

@@ -0,0 +1,66 @@
+# o3d3xx Ruby library
+
+Ruby libray and tools for the ifm Efector O3D3xx series of Time of Flight (ToF) Cameras
+This library adds support for the following interfaces:
+
+- XML-RPC, provides an interface for camera configuration and set-up
+- PCIC, provides result data and images
+- SWUpdate, provides software updates
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'o3d3xx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install o3d3xx
+
+## Usage
+
+### PCIC Client
+The PCIC is the propritary process interface which is based on TC/IP
+
+```
+pcic = O3D3XX::PCIC.new()
+pcic.connect('172.25.125.26','50010')
+pcic.transfer('p0')
+pcic.async_trigger()
+```
+
+### Firmware Update
+
+This assumes the device is already bootet in swupdate mode
+
+```
+o3d3xx-fwupdate.rb -f ~/Downloads/Goldeneye_1.5.205-unstable.swu -I 172.25.125.26 -r
+```
+The possible command line options are:
+```
+Usage: o3d3xx-fwupdate.rb [options]
+    -f, --file SWU-IMG               Image file to upload
+    -r, --reboot                     Force reboot to productive mode after all other action
+    -I, --ip-addr IP-ADDR            Set TCP/IP address of target
+    -p, --start-productive           Start productive system only without uploading file
+    -h, --help                       Display this help message
+```
+
+
+## Contributors
+
+* [Christian Ege](https://github.com/graugans/)
+* [Daniel Schnell](https://github.com/lumpidu)
+* [Christoph Freundl](https://github.com/cfreundl)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/o3d3xx-fwupdate.rb

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+
+require 'timeout'
+require 'optparse'
+require 'o3d3xx'
+
+
+def usage(opts)
+  puts opts
+end
+
+
+# Check sanity of given options
+def check_options(opts, optparse)
+  rv = false
+  loop do
+    if (! opts[:ip_addr])
+      usage(optparse)
+      puts 'Required argument(s) -I/--ip-addr missing !'
+      break
+    end
+
+    if ((opts[:ip_addr]) && (! (opts[:start_productive] || opts[:file] || opts[:reboot])))
+      usage(optparse)
+      puts 'You have to specify at least one of -p/-f/-r!'
+      break
+    end
+
+    if (((opts[:start_productive]) && (opts[:file] || opts[:reboot]) ))
+      usage(optparse)
+      puts 'Options -p and -r/-f don\'t fit together'
+      break
+    end
+
+    rv = true
+    break
+  end
+  rv
+end
+
+options = {}
+optparse = OptionParser.new do|opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
+
+  options[:file] = nil
+  opts.on( '-f', '--file SWU-IMG', 'Image file to upload' ) do |file|
+    options[:file] = file
+  end
+  options[:reboot] = false
+  opts.on( '-r', '--reboot', 'Force reboot to productive mode after all other action' ) do
+    options[:reboot] = true
+  end
+
+  options[:ip_addr] = nil
+  opts.on( '-I', '--ip-addr IP-ADDR', 'Set TCP/IP address of target' ) do |ip_addr|
+    options[:ip_addr] = ip_addr
+  end
+
+  options[:start_productive] = false
+    opts.on( '-p', '--start-productive', 'Start productive system only without uploading file' ) do
+      options[:start_productive] = true
+  end
+
+  opts.on( '-h', '--help', 'Display this help message' ) do
+    usage(opts)
+    exit 0
+  end
+end
+
+optparse.parse!(ARGV)
+
+exit(1) unless check_options(options, optparse)
+
+ip_addr = options[:ip_addr] || ENV['IP_ADDR'] || raise('Error: no ip address given!')
+
+swupdate_settings = {
+  :host => ip_addr,
+  :port => 8080,
+  :ssh_ident => options[:identity]
+}
+
+swupdate = O3D3XX::Swupdate.new(swupdate_settings)
+
+rv = 0
+
+if options[:file]
+  if swupdate.read_status_empty()
+    print "Uploading swu image #{options[:file]} ..."
+    swupdate.upload_file(options[:file])
+    if swupdate.wait_for_status(O3D3XX::Swupdate::UPLOAD_SUCCESS, 60)
+      puts ' OK'
+      rv = 0
+    else
+      puts ' FAILED!'
+      rv = 1
+    end
+  else
+    puts 'Status of http server could not settle!?'
+  end
+end
+
+if (options[:start_productive] || options[:reboot]) && (rv == 0)
+  print 'Starting productive mode ...'
+  if swupdate.restart_device()
+      puts ' OK'
+      rv = 0
+  else
+    puts ' FAILED!'
+  end
+end
+
+exit(rv)
+# EOF

data/lib/o3d3xx.rb

@@ -0,0 +1,16 @@
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+require "o3d3xx/version"
+require "o3d3xx/xmlrpc"
+require "o3d3xx/pcic"
+require "o3d3xx/swupdate"

data/lib/o3d3xx/pcic.rb

@@ -0,0 +1,277 @@
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+
+
+require 'socket'
+require 'timeout'
+require 'logger'
+
+module O3D3XX
+
+  CHUNKTYPE = {
+    CT_USERDATA:                  0,
+    CT_RADIAL_DISTANCE_IMAGE:   100,
+    CT_AMPLITUDE_IMAGE:         103,
+    CT_INTENSITY_IMAGE:         102,
+    CT_NORM_AMPLITUDE_IMAGE:    101,
+    CT_CARTESIAN_X_COMPONENT:   200,
+    CT_CARTESIAN_Y_COMPONENT:   201,
+    CT_CARTESIAN_Z_COMPONENT:   202,
+    CT_CARTESIAN_ALL:           203,
+    CT_UNIT_VECTOR_E1:          220,
+    CT_UNIT_VECTOR_E2:          221,
+    CT_UNIT_VECTOR_E3:          222,
+    CT_UNIT_VECTOR_ALL:         223,
+    CT_CONFIDENCE_IMAGE:        300,
+    CT_RAWDATA:                 301,
+    CT_DIAGNOSTIC:              302,
+    CT_EXTRINSIC_CALIBRATION:   400,
+    CT_JSON_MODEL:              500,
+  }
+
+  CHUNKPIXELFORMAT = {
+    PF_FORMAT_8U:    0,
+    PF_FORMAT_8S:    1,
+    PF_FORMAT_16U:   2,
+    PF_FORMAT_16S:   3,
+    PF_FORMAT_32U:   4,
+    PF_FORMAT_32S:   5,
+    PF_FORMAT_32F:   6,
+    PF_FORMAT_64U:   7,
+    PF_FORMAT_64F:   8,
+    PF_FORMAT_16U2:  9,
+    PF_FORMAT_32F3: 10,
+    PF_FORMAT_12U:  11,
+  }
+
+  class PCIC
+    def initialize()
+      @remote = nil
+      @protocol = 3
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::WARN
+    end
+    def connect(host="192.168.0.69",port="50010")
+      unless @remote == nil
+        disconnect()
+      end
+      @remote = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
+      @protocol = 3
+      begin
+        timeout(3) do
+          @remote.connect(Socket.pack_sockaddr_in(port, host))
+        end
+      rescue
+        @logger.fatal("Unable to connect to tcp://#{host}:#{port}")
+        @remote = nil
+        return false
+      end
+      #@protocol = detect_protocol()
+      #set_version(3)
+    end
+    def disconnect()
+      @remote.close()
+      @remote = nil
+    end
+    def detect_protocol()
+      proto = nil
+      begin
+        result = nil
+        @logger.debug("detect_protocol ")
+        begin
+          timeout(11) do
+            send_v3("V?")
+            result = @remote.recvfrom(20)
+            @logger.debug("Received: #{result} ")
+          end
+        rescue Timeout::Error => e
+          @logger.fatal("Timeout while receiving data occurred: #{e.message}")
+          return
+        end
+        test = result.join()
+        proto = nil
+        proto = 1 if test =~ /(\?)|(\d{2} \d{2} \d{2})\r\n/
+        proto = 2 if test =~ /\d{4}(\?)|(\d{2} \d{2} \d{2})\r\n/
+        proto = 3 if test =~ /\d{4}L\d{9}\r\n\d{4}/
+        proto = 4 if test =~ /L\d{9}\r\n(\?)|(\d{2} \d{2} \d{2})\r\n/
+        # If the device is in continuous mode and asynchronous messages are enabled
+        # we have to pull the complete frame out of the socket. Otherwise every consecutive
+        # PCIC call will fail due to the fact that we start in the middle of a frame.
+        if(proto == 3 )
+          ticket,length = test.match(/(\d{4})L(\d{9})\r\n/i).captures
+          timeout(5) do
+            # get the rest of the response
+            trailer = @remote.read(length.to_i-4)
+          end
+          # recv_v3 handles asynchronous messages so let it handle them.
+          dum = recv_v3() if '0000' == ticket
+        end
+        raise 'Unable to detect PCIC protocol' if proto == nil
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace.inspect
+        raise('Timeout while detecting version')
+        proto = nil
+      end
+      proto
+    end
+    def set_version(version=3)
+      res = transfer("v%02d"%version)
+      @protocol = version
+      res
+    end
+    def version()
+      return transfer("V?")
+    end
+    def help()
+      transfer("H?")
+    end
+    def device_info()
+      transfer("G?")
+    end
+    def async_trigger()
+      return transfer("t")
+    end
+    def sync_trigger()
+      transfer("T?")
+    end
+
+    def get_lastimage(img = 3)
+      transfer("I%02d?"%img)
+    end
+
+
+    def async_result(state=false)
+      data = "p%d" % [ state ? 1 : 0 ]
+      res = true
+      transfer(data)
+      res
+    end
+    def transfer(data)
+      raise 'Protocol #{@protocol} currently not supported' if @protocol == 1
+      raise 'Protocol #{@protocol} currently not supported' if @protocol == 2
+      return transfer_v3(data) if @protocol == 3
+      raise 'Protocol #{@protocol} currently not supported' if @protocol == 4
+    end
+    def send_v3(data)
+      ticket = "%04d" % [1000+rand(8999)]
+      length = "%09d" % [data.bytesize+6]
+      sendbuf = "#{ticket}L#{length}\r\n#{ticket}#{data}\r\n"
+      @logger.info("Request (#{@protocol}) : %{sendbuf}" % {:sendbuf => escape_pcic_string(sendbuf)})
+      timeout(5) do
+        @remote.send(sendbuf,0)
+      end
+    end
+    def transfer_v3(data,omit_async=true)
+      send_v3(data)
+      continue = true
+      response = nil
+      begin
+        async,ticket,response = recv_v3()
+        continue = false; continue = true if async and omit_async
+      end while continue
+      return response
+    end
+
+    def recv_v3()
+      data = nil
+      async = false
+      trailer = nil
+      # The V3 response shall look like this
+      # <4 Byte ticket >L<9 Byte Length in dec>\r\n<4 Byte ticket ><Response>\r\n
+      # receive <ticket>L<length>\r\n to check if we in sync and how much
+      # data we have to receive in the next step
+      timeout(5) do
+        data = @remote.read(16)
+      end
+      @logger.info("Header   : %{res}" % {:res => escape_pcic_string(data)})
+      begin
+        ticket,length = data.match(/(\d{4})L(\d{9})\r\n/i).captures
+      rescue
+        @logger.fatal(">>> rescue: #{data} <<<")
+      end
+      size = length.to_i
+      @logger.info("Length   : %d " % size )
+      if ticket == "0000"
+        @logger.info('ASYNC reply Caught !!!!')
+        async = true
+      else
+        async = false
+      end
+      timeout(5) do
+        trailer = @remote.read(size)
+      end
+      if size < 80 and trailer.length < 80
+        @logger.debug("Trailer  : %{res} <<<<" % {:res => escape_pcic_string(trailer)})
+      else
+        escaped = escape_pcic_string(trailer)
+        @logger.debug("Trailer  : %{start} [...] %{stop}" % {:start => escaped[0..20], :stop => escaped[-20..-1]})
+      end
+      ticket_trailer = trailer[0..3]
+      unless ticket_trailer == ticket
+        raise "Ticket mismatch. Header ticket: #{ticket} trailer ticket: #{ticket_trailer}"
+      end
+      # remove ticket and trailing \r\n
+      return async,ticket,trailer[4..-3]
+    end
+
+    def escape_pcic_string(data)
+      result = ""
+      result = data.gsub("\n","\\\\n").gsub("\r","\\\\r") unless data == nil
+    end
+  end
+
+  # Handle PCIC binary/image chunks
+  class Chunk
+    def self.parse(data)
+      chunk_header =  data.unpack('L<9*')
+      result = {
+        :CHUNK_TYPE => chunk_header[0],
+        :CHUNK_SIZE => chunk_header[1],
+        :HEADER_SIZE => chunk_header[2],
+        :HEADER_VERSION => chunk_header[3],
+        :IMAGE_WIDTH => chunk_header[4],
+        :IMAGE_HEIGTH => chunk_header[5],
+        :PIXEL_FORMAT => chunk_header[6],
+        :TIME_STAMP => chunk_header[7],
+        :FRAME_COUNT => chunk_header[8],
+        :PIXEL_DATA => data[chunk_header[2]...chunk_header[1]],
+      }
+    end
+    def self.info(chunk)
+      info = Array.new
+      info.push("CHUNK type        : #{chunk[:CHUNK_TYPE]}")
+      info.push("CHUNK size        : #{chunk[:CHUNK_SIZE]}")
+      info.push("CHUNK header size : #{chunk[:HEADER_SIZE]}")
+      info.push("CHUNK version     : #{chunk[:HEADER_VERSION]}")
+      info.push("CHUNK height      : #{chunk[:IMAGE_HEIGTH]}")
+      info.push("CHUNK width       : #{chunk[:IMAGE_WIDTH]}")
+      info.push("CHUNK format      : #{chunk[:PIXEL_FORMAT]}")
+      info.push("CHUNK time stamp  : #{chunk[:TIME_STAMP]}")
+      info.push("CHUNK frame count : #{chunk[:FRAME_COUNT]}")
+      info.push("CHUNK data size   : #{chunk[:PIXEL_DATA].length}")
+    end
+
+    def self.parseChunkArray(data)
+      result = Array.new
+      offset = 0
+      while offset < data.size
+        chunk = self.parse(data[offset..data.size])
+        result << chunk
+        offset += chunk[:CHUNK_SIZE]
+      end
+      return result
+    end
+
+  end
+end

data/lib/o3d3xx/swupdate.rb

@@ -0,0 +1,142 @@
+
+# The module provides access to the swupdate process
+#
+# swupdate - Software Update for Embedded Systems provides a web ui to upload
+# an installation file to an embedded target. This can also be used for an automated
+# installation process.
+#
+#
+# For manual access an web ui is provided
+# Web-Browser: http://<ip of the device>:8080
+#
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+
+require 'timeout'
+require 'uri'
+require 'net/http'
+require 'json'
+
+module O3D3XX
+
+  class Swupdate
+    UPLOAD_SUCCESS={"Status"=>"3", "Msg"=>"SWUPDATE successful !", "Error"=>"0"}
+
+    def initialize (settings={})
+      raise 'No host name given !' if settings[:host].nil?
+      @config = {
+        :host => settings[:host],
+      }
+      if settings[:port].nil?
+        @config[:port] = 8080
+      else
+        @config[:port] = settings[:port]
+      end
+      @base_uri = "http://#{@config[:host]}:#{@config[:port]}"
+    end
+
+    # Uploads a file to swupdate system. So far this file has
+    # to be a swu image file.
+    # This call is asynchronous to the following installation
+    # procedure, i.e. one has to poll for installation finish
+    # via query_status()
+    #
+    # @param filename   filename of swu image to install on target
+    #
+    def upload_file(filename)
+      raise 'Invalid file name given !' unless File.exist?(filename)
+      uri = URI.parse("#{@base_uri}/handle_post_request")
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = File.read(filename)
+      request['Content-Type'] = 'application/octet-stream'
+      request['Connection'] = 'keep-alive'
+      request['X_FILENAME'] = "#{File.basename(filename)}"
+      http.request(request)
+    end
+
+    # Reads status queue empty on http server, i.e.
+    # will return status from server until two consecutive
+    # status values are identical.
+    #
+    # @param timeout    Time to wait for http server to settle
+    #
+    def read_status_empty(timeout = 5)
+      rv = false
+      Timeout::timeout(timeout) do
+        loop do
+          rv1 = query_status
+          rv2 = query_status
+          break if rv1 == rv2
+        end
+        rv = true
+      end
+      rv
+    end
+
+    # Query status from http server
+    #
+    # @return json representation of http status
+    #         e.g. {"Status"=>"0", "Msg"=>"", "Error"=>"0"}
+    #
+    def query_status()
+      rv = ''
+      uri = URI.parse("#{@base_uri}/getstatus.json")
+      begin
+        response = Net::HTTP.get_response(uri)
+        rv = JSON.parse(response.body)
+        #Net::HTTP.get_print(uri)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError,
+          Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      end
+      #puts rv
+      rv
+    end
+
+    # Waits for specific status of http server with max. timeout
+    #
+    # @param status_hash    Hash of status values, e.g.
+    #                       {"Status"=>"0", "Msg"=>"", "Error"=>"0"}
+    #
+    # @param timeout        Time in seconds to wait for given status to be returned
+    #                       from http server
+    #
+    def wait_for_status(status_hash, timeout)
+      rv = false
+      Timeout::timeout(timeout) do
+        loop do
+          rv1 = query_status
+          break if rv1 == status_hash
+          # Print error messages
+          if rv1['Status'] && (rv1['Status'] == '4')
+            puts rv1['Msg'] if rv1['Msg']
+          end
+          sleep 1
+        end
+        rv = true
+      end
+      rv
+    end
+
+
+    # Restarts device
+    def restart_device()
+      uri = URI.parse("#{@base_uri}/reboot_to_live")
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Connection'] = 'keep-alive'
+      http.request(request)
+    end
+
+  end
+end

data/lib/o3d3xx/version.rb

@@ -0,0 +1,15 @@
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+module O3D3XX
+  VERSION = "0.0.1"
+end

data/lib/o3d3xx/xml_rpc_base.rb

@@ -0,0 +1,71 @@
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+
+require 'xmlrpc/client'
+require 'timeout'
+
+class XmlRPCBase
+
+  attr_reader :rpc_cl
+
+  # Initializes XMLRPC connection. Needs connection and
+  # Request parameters via given settings hash
+  #
+  # @param settings   hash of settings: :host, :port, :path
+  #
+  def initialize(settings={})
+    raise 'No host name given !' if settings[:host].nil?
+    raise 'No port given !' if settings[:port].nil?
+    raise 'No endpoint given !' if settings[:path].nil?
+    @config = {
+      :host => settings[:host],
+      :port => settings[:port],
+      :path => '/api/rpc/v1/' + settings[:path]
+    }
+
+    @rpc_cl = XMLRPC::Client.new(@config[:host],
+                                 @config[:path],
+                                 @config[:port], nil, nil,
+                                 nil, nil, nil, 20)   # 20 seconds connection timeout
+    #dump
+  end
+
+
+  # Calls any method via xmlrpc
+  def method_missing(meth, *args)
+    arg = args
+    begin
+      @rpc_cl.call_async(meth.to_s, *arg)
+    rescue XMLRPC::FaultException => e
+      if e.message.include? 'method not found'
+        super
+      else
+        raise
+      end
+    end
+  end
+
+
+  # Returns configuration object
+  def getConfig
+    return @config
+  end
+
+
+  # Dumps configuration
+  def dump
+    puts "Host: #{@config[:host]}"
+    puts "Port: #{@config[:port]}"
+    puts "URL : #{@config[:path]}"
+  end
+end

data/lib/o3d3xx/xmlrpc.rb

@@ -0,0 +1,160 @@
+# The module provides a transparent XML-RPC proxy for access to the O3D3XX
+# class of devices.
+# To get an rough overview of the API connect to the device using your preferred
+# Web-Browser: http://192.168.0.69/api/rpc/v1/com.ifm.efector/
+#
+# Author::    Christian Ege  (mailto:k4230r6@gmail.com)
+# Copyright:: Copyright (c) 2014 - 2016
+# License::   MIT
+#
+# 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.
+
+
+require 'o3d3xx/xml_rpc_base'
+
+module O3D3XX
+
+  # This class encapsulates the XML-RPC network configuration settings
+  class NetworkProxy < XmlRPCBase
+    def initialize(proxy)
+      config = proxy.getConfig()
+      path = "com.ifm.efector/session_#{proxy.getSessionID()}/edit/device/network/"
+      super(:host => config[:host], :port => config[:port], :path => path)
+    end
+  end
+
+  module Application
+    TriggerMode = {
+      :FREE_RUN       =>  1,
+      :PCIC           =>  2,
+      :POSITIVE_EDGE  =>  3,
+      :NEGATIVE_EDGE  =>  4,
+      :BOTH_EDGE      =>  5,
+    }
+  end
+
+  # This class encapsulates the XML-RPC imager access
+  class ImagerProxy < XmlRPCBase
+    def initialize(proxy)
+      config = proxy.getConfig()
+      path = "com.ifm.efector/session_#{proxy.getSessionID()}/edit/application/imager_001" # On O3D3xx only imager_001 is available
+      super(:host => config[:host], :port => config[:port], :path => path)
+    end
+  end
+
+
+  # This class encapsulates the XML-RPC application access
+  class ApplicationProxy < XmlRPCBase
+    def initialize(proxy)
+      config = proxy.getConfig()
+      path = "com.ifm.efector/session_#{proxy.getSessionID()}/edit/application/"
+      super(:host => config[:host], :port => config[:port], :path => path)
+      @img_proxy = O3D3xx::ImagerProxy.new(proxy)
+    end
+
+    def getImagerProxy()
+      @img_proxy
+    end
+
+  end
+
+  # This class encapsulates the XML-RPC device access
+  class DeviceProxy < XmlRPCBase
+    def initialize(proxy)
+      config = proxy.getConfig()
+      path = "com.ifm.efector/session_#{proxy.getSessionID()}/edit/device/"
+      super(:host => config[:host], :port => config[:port], :path => path)
+      @net_proxy = O3D3xx::NetworkProxy.new(proxy)
+    end
+
+    def getNetworkProxy()
+      @net_proxy
+    end
+  end
+
+  # This class encapsulates the XML-RPC Edit-Mode access
+  class EditProxy < XmlRPCBase
+    def initialize(proxy)
+      config = proxy.getConfig()
+      path = "com.ifm.efector/session_#{proxy.getSessionID()}/edit/"
+      super(:host => config[:host], :port => config[:port], :path => path)
+      @proxy = proxy
+      @device = O3D3xx::DeviceProxy.new(@proxy)
+      @application = nil
+    end
+
+    def getApplicationProxy(index)
+      self.editApplication(index)
+      @application = O3D3xx::ApplicationProxy.new(@proxy)
+    end
+
+    def closeApplication()
+      self.stopEditingApplication() unless @application == nil
+      @application = nil
+    end
+
+    def getDeviceProxy()
+      @device
+    end
+  end
+
+  module Session
+    OperationMode = {
+      :RUN   =>   0,
+      :EDIT  =>   1,
+    }
+  end
+
+
+  # This class encapsulates the XML-RPC session access
+  class SessionProxy  < XmlRPCBase
+    def initialize(proxy)
+      config = proxy.getConfig()
+      path = "com.ifm.efector/session_#{proxy.getSessionID()}/"
+      super(:host => config[:host], :port => config[:port], :path => path)
+      @edit = nil
+      @proxy = proxy
+    end
+
+    def getEditObjectProxy()
+      if nil == @edit
+        self.setOperatingMode(O3D3xx::Session::OperationMode[:EDIT])
+        @edit = O3D3xx::EditProxy.new(@proxy)
+      end
+      @edit
+    end
+    def closeEdit()
+      self.setOperatingMode(O3D3xx::Session::OperationMode[:RUN]) unless @edit == nil
+      @edit = nil
+    end
+  end
+
+  # This class encapsulates the XML-RPC general o3d3xx access
+  class O3D3xxProxy < XmlRPCBase
+
+    def initialize(host='192.168.0.69', port=80)
+      super(:host => host, :port => port, :path => 'com.ifm.efector/')
+      @session = nil
+    end
+
+    def getSessionProxy(*args)
+      @session_id = requestSession(*args)
+      @session = O3D3xx::SessionProxy.new(self)
+    end
+    def closeSession()
+      @session_id = nil
+      @session.cancelSession() unless @session == nil
+      @session = nil
+    end
+
+    def getSessionID
+      return @session_id
+    end
+  end
+end

data/o3d3xx.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'o3d3xx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "o3d3xx"
+  spec.version       = O3D3XX::VERSION
+  spec.authors       = ["Christian Ege"]
+  spec.email         = ["k4230r6@gmail.com"]
+  spec.description   = "Ruby interface for ifm efector O3d3xx"
+  spec.summary       = "Ruby interface for ifm efector O3d3xx"
+  spec.homepage      = "https://github.com/graugans/ruby-o3d3xx"
+  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.required_ruby_version = ">= 1.9.3"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: o3d3xx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Ege
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-22 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'
+description: Ruby interface for ifm efector O3d3xx
+email:
+- k4230r6@gmail.com
+executables:
+- o3d3xx-fwupdate.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/o3d3xx-fwupdate.rb
+- lib/o3d3xx.rb
+- lib/o3d3xx/pcic.rb
+- lib/o3d3xx/swupdate.rb
+- lib/o3d3xx/version.rb
+- lib/o3d3xx/xml_rpc_base.rb
+- lib/o3d3xx/xmlrpc.rb
+- o3d3xx.gemspec
+homepage: https://github.com/graugans/ruby-o3d3xx
+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: 1.9.3
+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: Ruby interface for ifm efector O3d3xx
+test_files: []