domotics-arduino 0.0.2 → 0.0.3

data/Rakefile

@@ -1 +1,14 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+desc "Publish gem to rubygems.org"
+task :publish do
+
+end

data/domotics-arduino.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |spec|
   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_runtime_dependency "serialport"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-end
+end

data/lib/domotics/arduino.rb

@@ -1,9 +1 @@
-require "serialport"
-require "thread"
-Dir[File.dirname(__FILE__) + '/arduino/**/*.rb'].sort.each {|file| require file}
-
-#module Domotics
-#  module Arduino
-#    # Your code goes here...
-#  end
-#end
+Dir[File.dirname(__FILE__) + '/arduino/**/*.rb'].sort.each {|file| require file}

data/lib/domotics/arduino/arduino_serial.rb

@@ -1,9 +1,14 @@
+require 'serialport'
+require 'thread'
+require 'logger'
+require 'timeout'
+
 module Domotics
   module Arduino
 
-    class ArduinoSerialError < StandardError; end
+    class ArduinoError < StandardError; end
 
-    module ArduinoSerial
+    module ArduinoBase
       # Constants from Arduino
       LOW = 0
       HIGH = 1
@@ -39,23 +44,24 @@ module Domotics
       TIMER_3 = 3
       TIMER_4 = 4
       TIMER_5 = 5
-      def initialize(args_hash = {})
+      def initialize(args = {})
         # grab args from hash
-        case @type = args_hash[:type] || :mega
+        case @type = args[:type] || :mega
         when :nano
-          @port_str = args_hash[:port] || "/dev/ttyUSB0"
+          @port_str = args[:port] || "/dev/ttyUSB0"
           @number_of_pins = 22
           # todo: address of last 2 pins on nano???
           @adc_pins = Array.new(8) { |index| 14+index }
           @pwm_pins = [3,5,6,9,10,11]
         when :mega
-          @port_str = args_hash[:port] || "/dev/ttyACM0"
+          @port_str = args[:port] || "/dev/ttyACM0"
           @number_of_pins = 70
           @adc_pins = Array.new(16) { |index| 54+index }
           @pwm_pins = Array.new(12) { |index| 2+index } + [44,45,46]
         else
-          raise ArduinoSerialError, 'Invalid board type.'
+          raise ArduinoError, 'Invalid board type.'
         end
+        @logger = args[:logger] || Logger.new(STDERR)
         # Not allow multiple command sends
         @command_lock = Mutex.new
         @reply = Queue.new
@@ -63,13 +69,13 @@ module Domotics
         @board = nil
         @board_listener = nil
         connect
-        super
+        super if self.class.superclass != Object
       end
 
       # ---0--- SETPINMODE 
       def set_mode(pin, mode)
         check_pin(pin); check_pin_watch(pin); raise ArgumentError, 'Error! Invalid mode.' unless MODES.include? mode
-        $logger.warn { "Already set mode for pin: #{pin}." } if @pin_mode[pin] == mode
+        @logger.warn { "Already set mode for pin: #{pin}." } if @pin_mode[pin] == mode
         @pin_mode[pin] = mode
         send_command(SETPINMODE, pin, mode)
       end
@@ -110,7 +116,7 @@ module Domotics
       end
 
       # ---9--- SETPWMFREQ
-      def set_pwm_frequency(pin, divisor)
+      def set_pwm_frequency(pin, divisor = 5)
         case @type
         when :nano
           case pin
@@ -145,7 +151,7 @@ module Domotics
         end
         send_command(SETPWMFREQ, timer, divisor)
       end
-      
+
       # ---5--- GETWATCH
       def get_watch(pin)
         check_pin(pin)
@@ -155,47 +161,49 @@ module Domotics
       # ---6--- SETWATCH
       def set_watch(pin, watch)
         check_pin(pin); raise ArgumentError, 'Invalid watch mode.' unless W_STATES.include? watch
-        $logger.warn { "Warning! already set watch mode for pin: #{pin}." } if @watch_list[pin] == watch
+        @logger.warn { "Warning! already set watch mode for pin: #{pin}." } if @watch_list[pin] == watch
         set_mode(pin, INPUT) if @pin_mode[pin] == OUTPUT
         @watch_list[pin] = watch
         send_command(SETWATCH, pin, watch)
       end
 
       def destroy
-        $logger.info { "Destroy board connection..." }
+        @logger.info { "Destroy board connection..." }
         @command_lock.synchronize do
-          @board_listener.exit if @board_listener
+          @board_listener.exit if @board_listener and @board_listener.alive?
           @board.close
         end
-        $logger.info { "done." }
-        super
+        @logger.info { "done." }
+        super if self.class.superclass != Object
       end
 
       private
 
       # Default event handler simple prints event.
       def event_handler(hash)
-        puts hash.inspect
+        raise ArduinoError, hash[:event].inspect
       end
 
       # Send command directly to board
       def send_command(command, pin = 0, value = 0)
         @command_lock.synchronize do
-          @board.puts("#{command} #{pin} #{value}")
-          # Get reply
-          case reply = @reply.pop
-          when 0
-            0
-          when 1
-            1
-          when SUCCESSREPRLY
-            true
-          when FAILREPRLY
-            false
-          when Array
-            reply
-          else
-            nil
+          Timeout.timeout(1) do
+            @board.puts("#{command} #{pin} #{value}")
+            # Get reply
+            case reply = @reply.pop
+            when 0
+              0
+            when 1
+              1
+            when SUCCESSREPRLY
+              true
+            when FAILREPRLY
+              false
+            when Array
+              reply
+            else
+              nil
+            end
           end
         end
       end
@@ -206,7 +214,7 @@ module Domotics
           begin
             loop do
               message = @board.gets
-              raise ArduinoSerialError, 'Board i/o error.' unless message # message nil - board disconected
+              raise ArduinoError, "Board[#{@port_str}] i/o error." unless message # message nil - board disconected
               message = message.force_encoding("ISO-8859-1").split
               case message.length
               when 1
@@ -216,18 +224,18 @@ module Domotics
               when 2
                 @reply.push(message.collect{ |m| m.to_i })
               else
-                raise ArduinoSerialError, 'Invalid reply from board.'
+                raise ArduinoError, "Invalid reply from board[#{@port_str}]."
               end
             end
-          rescue ArduinoSerialError => e
+          rescue ArduinoError => e
             # Continue to operate in new thread
             Thread.new do
-              $logger.error e.message
+              @logger.error e.message
               # Release command lock
               @reply.push(FAILREPRLY) if @command_lock.locked?
               # Close board connection
               @board.close
-              $logger.info 'Try to restart board in 5 seconds...'
+              @logger.info "Try to restart board[#{@port_str}] in 5 seconds..."
               sleep 5
               connect
             end
@@ -238,44 +246,46 @@ module Domotics
       end
       # Connect to board
       def connect
-        $logger.info { "Open serial connection to board..." }
+        @logger.info { "Open serial connection to board[#{@port_str}]..." }
         baudrate = 115200; databits = 8; stopbits = 1; parity = SerialPort::NONE
         @board = SerialPort.new(@port_str, baudrate, databits, stopbits, parity)
         @board.read_timeout = 0
         @board.sync = true
-        $logger.info { "done." }
-        $logger.info { "Initializing arduino board..." }
+        @logger.info { "done." }
+        @logger.info { "Initializing board[#{@port_str}]..." }
         # Pin states and mods
         @pin_mode = Array.new(@number_of_pins, INPUT)
         @watch_list = Array.new(@number_of_pins, WATCHOFF)
-        # Hard reset board
-        @board.dtr = 0
-        sleep(2)
-        $logger.info { "done." }
-        $logger.info { "Starting board listener..." }
+        # Hard reset board (unless it's not a fake board from emulator)
+        unless @port_str =~ /\A\/dev\/pts\/.*\Z/
+          @board.dtr = 0
+          sleep(2)
+        end
+        @logger.info { "done." }
+        @logger.info { "Starting board[#{@port_str}] listener..." }
         listen
-        $logger.info { "done." }
-        $logger.info { "Reset board to defaults..." }
-        $logger.info { "done." } if send_command(DEFAULTS)
-        $logger.info { "Checking connection with board..." }
+        @logger.info { "done." }
+        @logger.info { "Reset board[#{@port_str}] to defaults..." }
+        @logger.info { "done." } if send_command(DEFAULTS)
+        @logger.info { "Checking connection with board[#{@port_str}]..." }
         random = Random.new
         a, b = 2.times.map { random.rand(0..9) }
         if send_command(ECHOREPLY, a, b) == [b, a]
-          $logger.info { "done." }
+          @logger.info { "done." }
         else
-          $logger.error { "Bad reply from board (wrong firmware?)." }
-          raise ArduinoSerialError
+          @logger.error { "Bad reply from board[#{@port_str}] (wrong firmware?)." }
+          raise ArduinoError
         end
       rescue Exception => e
-        $logger.error { e.message }
+        @logger.error { e.message }
         tries = tries || 0
         tries += 1
         if tries <= 3
-          $logger.info { "Attempt #{tries}: try to reconnect in #{5**tries} seconds." }
+          @logger.info { "Attempt #{tries}: try to reconnect in #{5**tries} seconds." }
           sleep 5**tries
           retry
         end
-        $logger.error { "Board malfunction. Automatic restart failed." }
+        @logger.error { "Board[#{@port_str}] malfunction. Automatic restart failed." }
         event_handler :event => :malfunction
       end
       # Checks
@@ -285,9 +295,9 @@ module Domotics
       def check_pin_watch(pin)
         raise ArgumentError, 'Cant access watched pin.' if @watch_list[pin] == WATCHON
       end
-      
+
     rescue ArgumentError => e
-      $logger.error e.message
+      @logger.error e.message
       nil
     end
   end

data/lib/domotics/arduino/digital_pin.rb

@@ -2,23 +2,28 @@
 module Domotics
   module Arduino
     module DigitalPin
+
       def initialize(args_hash = {})
         @board = Domotics::Device[args_hash[:device]]
         @pin = args_hash[:pin]
         @board.register_pin self, @pin
         super
       end
+
       def state!
         to_hls @board.get_digital(@pin)
       end
+
       def set_state(value)
         @board.set_digital @pin, to_lls(value)
         super
       end
+
       # Convert to High Level State
       def to_hls(value)
         value == ArduinoSerial::HIGH ? :on : :off
       end
+
       # Convert to Low Level State
       def to_lls(value)
         value == :on ? ArduinoSerial::HIGH : ArduinoSerial::LOW

data/lib/domotics/arduino/pwm_pin.rb

@@ -1,12 +1,14 @@
 module Domotics
   module Arduino
     module PWMPin
+
       def initialize(args_hash = {})
         @board = Domotics::Device[args_hash[:device]]
         @pin = args_hash[:pin]
         @board.set_pwm_frequency @pin, 1
         super
       end
+
       def set_state(value = 0)
         value = case value
         when 0, :off
@@ -21,6 +23,7 @@ module Domotics
         end
         super value
       end
+
     end
   end
 end

data/lib/domotics/arduino/version.rb

@@ -1,5 +1,5 @@
 module Domotics
   module Arduino
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/board_emulator.rb

@@ -0,0 +1,26 @@
+require 'pty'
+
+class BoardEmulator
+  def initialize(args = {})
+    success = Domotics::Arduino::ArduinoBase::SUCCESSREPRLY
+    @master, @slave = PTY.open
+    type = args[:type] || :normal
+    unless type == :dead
+      Thread.new do
+        loop do
+          raise unless message = @master.gets
+          command, pin, value = message.chomp.split(" ").map{ |m| m.to_i }
+          case command
+          when Domotics::Arduino::ArduinoBase::ECHOREPLY
+            @master.puts "#{value} #{pin}\n"
+          else
+            @master.puts success
+          end
+        end
+      end
+    end
+  end
+  def port
+    @slave.path
+  end
+end

data/test/test_arduino.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require 'domotics/arduino'
+require 'board_emulator'
+
+class ArduinoTestBoard
+  include Domotics::Arduino::ArduinoBase
+end
+
+class ArduinoTest < Test::Unit::TestCase
+  def setup
+  end
+  def test_open_connection
+    assert brd = ArduinoTestBoard.new(port: BoardEmulator.new.port)
+    assert !brd.destroy
+  end
+  def test_dead_board
+    assert_raise Domotics::Arduino::ArduinoError do
+      ArduinoTestBoard.new(port: BoardEmulator.new(type: :dead).port)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: domotics-arduino
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,6 +11,22 @@ bindir: bin
 cert_chain: []
 date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +81,8 @@ files:
 - lib/domotics/arduino/firmware/stepper.c
 - lib/domotics/arduino/pwm_pin.rb
 - lib/domotics/arduino/version.rb
+- test/board_emulator.rb
+- test/test_arduino.rb
 homepage: ''
 licenses:
 - MIT
@@ -90,4 +108,6 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Arduino part of Domotics
-test_files: []
+test_files:
+- test/board_emulator.rb
+- test/test_arduino.rb