domotics-arduino 0.0.1 → 0.0.2

data/lib/domotics/arduino/arduino_serial.rb

@@ -0,0 +1,294 @@
+module Domotics
+  module Arduino
+
+    class ArduinoSerialError < StandardError; end
+
+    module ArduinoSerial
+      # Constants from Arduino
+      LOW = 0
+      HIGH = 1
+      STATES = [LOW, HIGH]
+      INPUT = 0
+      OUTPUT = 1
+      INPUTPULLUP = 2
+      MODES = [INPUT, OUTPUT, INPUTPULLUP]
+      # Replies from board
+      SUCCESSREPRLY = 2
+      FAILREPRLY = 3
+      # Board events
+      EVENTS = {'0' => :pin_state_change}
+      # Commands for board
+      SETPINMODE = 0
+      GETDIGITAL = 1
+      SETDIGITAL = 2
+      GETADC = 3
+      SETPWM = 4
+      GETWATCH = 5
+      SETWATCH = 6
+      ECHOREPLY = 7
+      DEFAULTS = 8
+      SETPWMFREQ = 9
+      # Watch states
+      WATCHOFF = 0
+      WATCHON = 1
+      W_STATES = [WATCHOFF, WATCHON]
+      # Timers
+      TIMER_0 = 0
+      TIMER_1 = 1
+      TIMER_2 = 2
+      TIMER_3 = 3
+      TIMER_4 = 4
+      TIMER_5 = 5
+      def initialize(args_hash = {})
+        # grab args from hash
+        case @type = args_hash[:type] || :mega
+        when :nano
+          @port_str = args_hash[: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"
+          @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.'
+        end
+        # Not allow multiple command sends
+        @command_lock = Mutex.new
+        @reply = Queue.new
+        # Open connection
+        @board = nil
+        @board_listener = nil
+        connect
+        super
+      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
+        @pin_mode[pin] = mode
+        send_command(SETPINMODE, pin, mode)
+      end
+      def set_input_pullup(pin)
+        set_mode(pin, INPUTPULLUP)
+      end
+
+      # ---1--- GETDIGITAL
+      def get_digital(pin)
+        check_pin(pin)
+        send_command(GETDIGITAL, pin)
+      end
+
+      # ---2--- SETDIGITAL
+      def set_digital(pin, state)
+        check_pin(pin); check_pin_watch(pin); raise ArgumentError, 'Error! Invalid state.' unless STATES.include? state
+        set_mode(pin, OUTPUT) unless @pin_mode[pin] == OUTPUT
+        send_command(SETDIGITAL, pin, state)
+      end
+      def set_high(pin)
+        set_digital(pin, HIGH)
+      end
+      def set_low(pin)
+        set_digital(pin, LOW)
+      end
+
+      # ---3--- GETADC
+      def get_adc(pin)
+        check_pin(pin); raise ArgumentError, 'Not ADC pin.' unless @adc_pins.include? pin
+        send_command(GETADC, pin)
+      end
+
+      # ---4--- SETPWM
+      def set_pwm(pin, value)
+        check_pin(pin); check_pin_watch(pin); raise ArgumentError, 'Not PWM or DAC pin.' unless @pwm_pins.include? pin
+        raise ArgumentError, 'Invalid PWM value' unless value.is_a?(Integer) and value>=0 and value<=255
+        send_command(SETPWM, pin, value)
+      end
+
+      # ---9--- SETPWMFREQ
+      def set_pwm_frequency(pin, divisor)
+        case @type
+        when :nano
+          case pin
+          when 9,10
+            timer = TIMER_1
+          when 3,11
+            timer = TIMER_2
+          else
+            timer = nil
+          end
+        when :mega
+          case pin
+          when 2,3,5
+            timer = TIMER_3
+          when 6,7,8
+            timer = TIMER_4
+          when 9,10
+            timer = TIMER_2
+          when 11,12
+            timer = TIMER_1
+          when 44,45,46
+            timer = TIMER_5
+          else
+            timer = nil
+          end
+        end
+        raise ArgumentError, 'Invalid PWM pin for change frequency.' unless timer
+        if timer == TIMER_2
+          raise ArgumentError, 'Invalid timer divisor.' unless (1..7).include? divisor
+        else
+          raise ArgumentError, 'Invalid timer divisor.' unless (1..5).include? divisor
+        end
+        send_command(SETPWMFREQ, timer, divisor)
+      end
+      
+      # ---5--- GETWATCH
+      def get_watch(pin)
+        check_pin(pin)
+        send_command(GETWATCH, pin)
+      end
+
+      # ---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
+        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..." }
+        @command_lock.synchronize do
+          @board_listener.exit if @board_listener
+          @board.close
+        end
+        $logger.info { "done." }
+        super
+      end
+
+      private
+
+      # Default event handler simple prints event.
+      def event_handler(hash)
+        puts hash.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
+          end
+        end
+      end
+      # Listen for board replies and alarms
+      def listen
+        @board_listener.exit if @board_listener
+        @board_listener = Thread.new do
+          begin
+            loop do
+              message = @board.gets
+              raise ArduinoSerialError, 'Board i/o error.' unless message # message nil - board disconected
+              message = message.force_encoding("ISO-8859-1").split
+              case message.length
+              when 1
+                @reply.push(message[0].to_i)
+              when 3
+                event_handler :event => EVENTS[message[0]], :pin => message[1].to_i, :state => message[2].to_i
+              when 2
+                @reply.push(message.collect{ |m| m.to_i })
+              else
+                raise ArduinoSerialError, 'Invalid reply from board.'
+              end
+            end
+          rescue ArduinoSerialError => e
+            # Continue to operate in new thread
+            Thread.new do
+              $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...'
+              sleep 5
+              connect
+            end
+            # Exit errored thread
+            @board_listener.exit
+          end
+        end
+      end
+      # Connect to board
+      def connect
+        $logger.info { "Open serial connection to board..." }
+        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..." }
+        # 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..." }
+        listen
+        $logger.info { "done." }
+        $logger.info { "Reset board to defaults..." }
+        $logger.info { "done." } if send_command(DEFAULTS)
+        $logger.info { "Checking connection with board..." }
+        random = Random.new
+        a, b = 2.times.map { random.rand(0..9) }
+        if send_command(ECHOREPLY, a, b) == [b, a]
+          $logger.info { "done." }
+        else
+          $logger.error { "Bad reply from board (wrong firmware?)." }
+          raise ArduinoSerialError
+        end
+      rescue Exception => e
+        $logger.error { e.message }
+        tries = tries || 0
+        tries += 1
+        if tries <= 3
+          $logger.info { "Attempt #{tries}: try to reconnect in #{5**tries} seconds." }
+          sleep 5**tries
+          retry
+        end
+        $logger.error { "Board malfunction. Automatic restart failed." }
+        event_handler :event => :malfunction
+      end
+      # Checks
+      def check_pin(pin)
+        raise ArgumentError, 'Invalid pin number.' unless pin.is_a?(Integer) and pin>=0 and pin<@number_of_pins
+      end
+      def check_pin_watch(pin)
+        raise ArgumentError, 'Cant access watched pin.' if @watch_list[pin] == WATCHON
+      end
+      
+    rescue ArgumentError => e
+      $logger.error e.message
+      nil
+    end
+  end
+end

data/lib/domotics/arduino/digital_pin.rb

@@ -0,0 +1,28 @@
+# Digital pin
+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
+      end
+    end
+  end
+end

data/lib/domotics/arduino/digital_pin/nc_sensor.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby -w
+# coding: utf-8
+module Domotics
+  module Arduino
+    # Normal_close sensor
+    module NCSensor
+      include  DigitalPin
+      def initialize(args_hash = {})
+        super
+        @board.set_input_pullup @pin
+        @board.set_watch @pin, ArduinoSerial::WATCHON
+      end
+    end
+  end
+end

data/lib/domotics/arduino/digital_pin/no_sensor.rb

@@ -0,0 +1,12 @@
+module Domotics
+  module Arduino
+    # Normal_open sensor
+    module NOSensor
+      include DigitalPin
+      def initialize(args_hash = {})
+        super
+        @board.set_watch @pin, ArduinoSerial::WATCHON
+      end
+    end
+  end
+end

data/lib/domotics/arduino/firmware/duino.pde

@@ -0,0 +1,149 @@
+/*
+ * Serial communication for gHome.
+ * 
+ * Input(space separeted):
+ * 1. command
+ * 2. pin
+ * 3. option
+ * 
+ * created 03 Sep 2012
+ * by goredar
+ */
+
+
+
+// Cons
+// Replys definitions
+const int SuccessReprly = 2;
+const int FailReprly = 3;
+// Input commands definitions
+const int SetPinMode = 0;
+const int GetDigital = 1;
+const int SetDigital = 2;
+const int GetADC = 3;
+const int SetPWM = 4;
+const int GetWatch = 5;
+const int SetWatch = 6;
+const int EchoReply = 7;
+const int Defaults = 8;
+const int SetPWMFreq = 9;
+// Output message definitions
+const int WatchAlarm = 0;
+// Number of pins for board:
+// nano - 22, mega - 70
+const int NumberOfPins = 70;
+// For watch function
+const int WatchOFF = 0;
+const int WatchON = 1;
+// Vars
+int command = 0;
+int pin = 0;
+int option = 0;
+int state = 0;
+boolean watchlist[NumberOfPins];
+int statelist[NumberOfPins];
+
+void setup() {
+  default_state();
+  // Begin serial
+  Serial.begin(115200);
+}
+// Main stream
+void loop() {
+  if (Serial.available() > 0) {
+    // Parse command
+    command = Serial.parseInt();
+    pin = Serial.parseInt();
+    option = Serial.parseInt();
+    if (Serial.read() == '\n') {
+      switch (command) {
+        case SetPinMode:
+          pinMode(pin, option);
+          Serial.println(SuccessReprly, DEC);
+          break;
+        case GetDigital:
+          Serial.println(digitalRead(pin), DEC);
+          break;
+        case SetDigital:
+          digitalWrite(pin, option);
+          Serial.println(SuccessReprly, DEC);
+          break;
+        case GetADC:
+          Serial.println(analogRead(pin), DEC);
+          break;
+        case SetPWM:
+          analogWrite(pin, option);
+          Serial.println(SuccessReprly, DEC);
+          break;
+        case SetPWMFreq:
+          switch (pin) {
+            case 1: TCCR1B = (TCCR1B & 0xF8) | option; break;
+            case 2: TCCR2B = (TCCR2B & 0xF8) | option; break;
+            //#ifdef __AVR_ATmega2560__
+            case 3: TCCR3B = (TCCR3B & 0xF8) | option; break;
+            case 4: TCCR4B = (TCCR4B & 0xF8) | option; break;
+            case 5: TCCR5B = (TCCR5B & 0xF8) | option; break;
+            //#endif
+          }
+          Serial.println(SuccessReprly, DEC);
+          break;
+        case GetWatch:
+          if (watchlist[pin]) {
+            Serial.println(WatchON, DEC);
+          }
+          else {
+            Serial.println(WatchOFF, DEC);
+          }
+          break;
+        case SetWatch:
+          if (option == WatchOFF) {
+            watchlist[pin] = false;
+          }
+          else {
+            statelist[pin] = digitalRead(pin);
+            watchlist[pin] = true;
+          }
+          Serial.println(SuccessReprly, DEC);
+          break;
+        case EchoReply:
+          Serial.print(option, DEC);
+          Serial.print(' ');
+          Serial.println(pin, DEC);
+          break;
+        case Defaults:
+          default_state();
+          Serial.println(SuccessReprly, DEC);
+          break;
+        default:
+          // Invalid command
+          Serial.println(FailReprly, DEC);
+          break;
+      }
+    }
+    else {
+      // Invalid input
+      Serial.println(FailReprly, DEC);
+    }
+  }
+  for (int i=2; i < NumberOfPins; i++){
+    // Watch for changes on digital pins
+    if (watchlist[i]) {
+      state = digitalRead(i);
+      if (state != statelist[i]) {
+        statelist[i] = state;
+        Serial.print(WatchAlarm, DEC);
+        Serial.print(' ');
+        Serial.print(i, DEC);
+        Serial.print(' ');
+        Serial.println(state, DEC);
+      }
+    }
+  }
+}
+
+void default_state() {
+  for (int i=0; i < NumberOfPins; i++) {
+    pinMode(i, INPUT);
+    watchlist[i] = false;
+  }
+}

data/lib/domotics/arduino/firmware/stepper.c

@@ -0,0 +1,16 @@
+
+int command =						0;
+int pin =							0;
+int option =						0;
+int state =							0;
+
+void setup() {
+	Serial.begin(115200);
+}
+
+void loop() {
+	PORTD maps to Arduino digital pins 0 to 7
+	PORTB maps to Arduino digital pins 8 to 13
+	PORTC maps to Arduino analog pins 0 to 5.
+PORTB |= B1100;
+}

data/lib/domotics/arduino/pwm_pin.rb

@@ -0,0 +1,26 @@
+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
+          @board.set_low @pin
+          0
+        when 1..254
+          @board.set_pwm @pin, value
+          value
+        when 255, :on
+          @board.set_high @pin
+          255
+        end
+        super value
+      end
+    end
+  end
+end

data/lib/domotics/arduino/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: domotics-arduino
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -57,6 +57,13 @@ files:
 - Rakefile
 - domotics-arduino.gemspec
 - lib/domotics/arduino.rb
+- lib/domotics/arduino/arduino_serial.rb
+- lib/domotics/arduino/digital_pin.rb
+- lib/domotics/arduino/digital_pin/nc_sensor.rb
+- lib/domotics/arduino/digital_pin/no_sensor.rb
+- lib/domotics/arduino/firmware/duino.pde
+- lib/domotics/arduino/firmware/stepper.c
+- lib/domotics/arduino/pwm_pin.rb
 - lib/domotics/arduino/version.rb
 homepage: ''
 licenses: