wiringpi-ruby 2.0.1 → 2.1.4

data/lib/wiringpi.rb

@@ -1,10 +1,23 @@
 require 'wiringpi/wiringpi'
+
 module WiringPi
   extend self
 
+  # GPIO WiringPi PIN layout mode
+  GPIO_WPI = 0
+  GPIO_NORMAL = 1
+  GPIO_PHYSICAL = 2
+  GPIO_SYSTEM = 3
+
+  # GPIO signal
   HIGH = 1
   LOW = 0
 
+  # GPIO signal event
+  FALLING = :falling
+  RISING = :rising
+
+  # PIN mode
   INPUT = 0
   OUTPUT = 1
   PWM_OUTPUT = 1
@@ -18,25 +31,25 @@ module WiringPi
 
   class Modules
     class ModuleBase
-
-      @name = 'Unknown'
-      @pin_base = 0
-      @pin_count = 0
-      @pin_end = 0
-
       attr_reader :name, :pin_base, :pin_count, :pin_end
 
+      def initialize
+        @name = 'Unknown'
+        @pin_base = 0
+        @pin_count = 0
+        @pin_end = 0
+      end
+
       def new
         @pin_end = @pin_base + @pin_count
-        updateName
+        update_name
       end
 
-      def updateName
-        @name = ' at offset ' + @pin_base.to_s
+      def update_name
+        @name = " at offset #{@pin_base}"
       end
-
     end
   end
-
 end
-Dir[File.dirname(__FILE__) + '/wiringpi/*.rb'].each {|file| require file }
+
+Dir[File.dirname(__FILE__) + '/wiringpi/**/*.rb'].each { |file| require file }

data/lib/wiringpi/gpio.rb

@@ -1,135 +1,147 @@
 module WiringPi
   class GPIO
+    attr_reader :modules, :pins
 
-    @modules = Array.new
-    @pins = Array.new
+    @@system_ready = false
 
-    attr_reader :modules, :pins
+    def self.setup(pin_layout = GPIO_WPI)
+      return if @@system_ready
+
+      case pin_layout
+      when GPIO_WPI; Wiringpi.wiringPiSetup
+      when GPIO_NORMAL; Wiringpi.wiringPiSetupGpio
+      when GPIO_PHYSICAL; Wiringpi.wiringPiSetupPhys
+      when GPIO_SYSTEM; Wiringpi.wiringPiSetupSys
+      else raise 'unknown pin layout to setup'
+      end
+
+      @@system_ready = true
+    end
 
     def initialize(&block)
-      Wiringpi.wiringPiSetup
-      @pins = Array.new
+      raise 'system is not ready, please call WiringPi::GPIO.setup first' unless @@system_ready
+
+      @pins = []
+      @modules = []
+      setup_wiring_pi
       instance_eval &block if block_given?
     end
 
     def read_byte(starting_pin)
-      bits = Array.new
-      8.times do |time|
-        bits << Wiringpi.digitalRead(starting_pin + time)
-      end
-      bits.join
+      8.times.map { |time| Wiringpi.digitalRead(starting_pin + time) }.join
     end
 
     def write_byte(starting_pin, byte)
-      byte = byte.to_s(2) unless byte.length = 8
+      bits = byte.to_s(2) unless byte.length == 8
       offset = starting_pin
-      byte.each_char do |bit|
+      bits.each_char do |bit|
         Wiringpi.digitalWrite(offset, bit)
         offset += 1
       end
     end
 
     def digital_read(pin)
-      if pin.respond_to?(:each)
-        pin.collect do |pin|
-          Wiringpi.digitalRead(pin)
-        end
-      else
-        Wiringpi.digitalRead(pin)
-      end
+      pins = [pin] unless pin.is_a?(Array)
+      res = pins.collect { |pin| Wiringpi.digitalRead(pin) }
+      res.count == 1 ? res.first : res
     end
 
     def digital_write(pin, value)
-      if pin.respond_to?(:each)
-        pin.each do |pin|
-          Wiringpi.digitalWrite(pin, value)
-        end
-      else
-        Wiringpi.digitalWrite(pin, value)
-      end
+      pins = [pin] unless pin.is_a?(Array)
+      pins.each { |pin| Wiringpi.digitalWrite(pin, value) }
+    end
+
+    def analog_read(pin)
+      pins = [pin] unless pin.is_a?(Array)
+      res = pins.collect { |pin| Wiringpi.analogRead(pin) }
+      res.count == 1 ? res.first : res
+    end
+
+    def analog_write(pin, value)
+      pins = [pin] unless pin.is_a?(Array)
+      pins.each { |pin| Wiringpi.analogWrite(pin, value) }
     end
 
     def pin_mode(pin, mode)
       Wiringpi.pinMode(pin, mode)
     end
 
-    def pull_up_dn_control(pin,mode)
+    def pull_up_dn_control(pin, mode)
       Wiringpi.pullUpDnControl(pin, mode)
     end
 
-	def delay(ms)
-	  Wiringpi.delay(ms)
-	end
+    def delay(ms)
+      Wiringpi.delay(ms)
+    end
 
-	def delay_microseconds(ms)
-	  Wiringpi.delayMicroseconds(ms)
-	end
+    def delay_microseconds(ms)
+      Wiringpi.delayMicroseconds(ms)
+    end
 
-	def millis()
-	  return Wiringpi.millis()
-	end
+    def millis
+      Wiringpi.millis
+    end
 
-	def micros()
-	  return Wiringpi.micros()
-	end
+    def micros
+      Wiringpi.micros
+    end
 
-       def pi_board_rev()
-          return Wiringpi.piBoardRev()
-       end
+    # NOTE: deprecated call to Wiringpi.piBoardRev
+    def pi_board_rev
+      Wiringpi.piBoardRev
+    end
 
-       def wpi_pin_to_gpio(pin)
-          return Wiringpi.wpiPinToGpio(pin)
-       end
+    def wpi_pin_to_gpio(pin)
+      Wiringpi.wpiPinToGpio(pin)
+    end
 
-       def phys_pin_to_gpio(pin)
-          return Wiringpi.physPinToGpio(pin)
-       end
+    def phys_pin_to_gpio(pin)
+      Wiringpi.physPinToGpio(pin)
+    end
 
-	def pwm_set_mode(mode)
-	  return Wiringpi.pwmSetMode(mode)
-	end
+    def pwm_set_mode(mode)
+      Wiringpi.pwmSetMode(mode)
+    end
 
-	def pwm_set_range(range)
-	  return Wiringpi.pwmSetRange(range)
-	end
+    def pwm_set_range(range)
+      Wiringpi.pwmSetRange(range)
+    end
 
-	def pwm_set_clock(divisor)
-	  return Wiringpi.pwmSetClock(divisor)
-	end
+    def pwm_set_clock(divisor)
+      Wiringpi.pwmSetClock(divisor)
+    end
 
-  def soft_pwm_create(pin, initial_value, pwm_range)
-    return Wiringpi.softPwmCreate(pin, initial_value, pwm_range)
-  end
+    def soft_pwm_create(pin, initial_value, pwm_range)
+      Wiringpi.softPwmCreate(pin, initial_value, pwm_range)
+    end
 
-  def soft_pwm_write(pin, value)
-    Wiringpi.softPwmWrite(pin, value)
-  end
+    def soft_pwm_write(pin, value)
+      Wiringpi.softPwmWrite(pin, value)
+    end
 
-	def gpio_clock_set(pin, freq)
-	  return Wiringpi.gpioClockSet(pin, freq)
-	end
+    def gpio_clock_set(pin, freq)
+      Wiringpi.gpioClockSet(pin, freq)
+    end
 
-	def wait_for_interrupt(pin, ms)
-	  Wiringpi.waitForInterrupt(pin, ms)
-	end
+    def wait_for_interrupt(pin, ms)
+      Wiringpi.waitForInterrupt(pin, ms)
+    end
 
-	def wiringpi_isr(pin, mode, fn)
-	  Wiringpi.wiringPiISR(pin, mode, fn)
-	end
+    def wiringpi_isr(pin, mode, fn)
+      Wiringpi.wiringPiISR(pin, mode, fn)
+    end
 
-	def shift_out(dpin, cpin, order, val )
-	  Wiringpi.shiftOut(dpin,cpin,order,val)
-	end
+    def shift_out(dpin, cpin, order, val )
+      Wiringpi.shiftOut(dpin,cpin,order,val)
+    end
 
-	def shift_in(dpin, cpin, order)
-	  Wiringpi.shiftIn(dpin,cpin,order)
-	end
+    def shift_in(dpin, cpin, order)
+      Wiringpi.shiftIn(dpin,cpin,order)
+    end
 
     def add_module(module_instance)
-      @modules = Array.new if @modules.nil?
-
       @modules << module_instance
-      puts 'Added module ' + module_instance.name.to_s
+      puts "Added module #{module_instance.name}"
 
       module_instance.pin_count.times do |offset|
         @pins[offset + module_instance.pin_base] = 'ENABLED'

data/lib/wiringpi/i2c.rb

@@ -1,26 +1,33 @@
 module WiringPi
   class I2C
-	@device_id = 0
-	def initialize(device_address)
-	  @device_id = Wiringpi.wiringPiI2CSetup(device_address)
-	end
-	def read()
-	  return Wiringpi.wiringPiI2CRead(@device_id)
-	end
-	def write(data)
-	  return Wiringpi.wiringPiI2CWrite(@device_id,data)
-	end
-	def read_reg_8(reg)
-	  return Wiringpi.wiringPiI2CReadReg8(@device_id,reg)
-	end
-	def write_reg_8(reg,data)
-	  return Wiringpi.wiringPiI2CWriteReg8(@device_id,reg,data)
-	end
-	def read_reg_16(reg)
-	  return Wiringpi.wiringPiI2CReadReg16(@device_id,reg)
-	end
-	def write_reg_16(reg,data)
-	  return Wiringpi.wiringPiI2CWriteReg16(@device_id,reg,data)
-	end
+		attr_reader :device_id
+
+		def initialize(device_address)
+			@device_id = Wiringpi.wiringPiI2CSetup(device_address)
+		end
+
+		def read
+			Wiringpi.wiringPiI2CRead(@device_id)
+		end
+
+		def write(data)
+			Wiringpi.wiringPiI2CWrite(@device_id, data)
+		end
+
+		def read_reg_8(reg)
+			Wiringpi.wiringPiI2CReadReg8(@device_id, reg)
+		end
+
+		def write_reg_8(reg, data)
+			Wiringpi.wiringPiI2CWriteReg8(@device_id, reg, data)
+		end
+
+		def read_reg_16(reg)
+			Wiringpi.wiringPiI2CReadReg16(@device_id, reg)
+		end
+
+		def write_reg_16(reg, data)
+			Wiringpi.wiringPiI2CWriteReg16(@device_id, reg, data)
+		end
   end
 end

data/lib/wiringpi/modules/mcp23017.rb

@@ -0,0 +1,15 @@
+module WiringPi
+  class Modules
+    class Mcp23017 < ModuleBase
+      attr_reader :i2c_address
+
+      def initialize(pin_base, i2c_address = 0x0)
+        super
+        @pin_base = pin_base
+        @pin_count = 16
+        @i2c_address = i2c_address
+        Wiringpi.mcp23017Setup(pin_base, i2c_address)
+      end
+    end
+  end
+end

data/lib/wiringpi/modules/mcp23s17.rb

@@ -0,0 +1,16 @@
+module WiringPi
+  class Modules
+    class Mcp23s17 < ModuleBase
+      attr_reader :spi_port, :device_id
+
+      def initialize(pin_base, spi_port, device_id)
+        super
+        @pin_base = pin_base
+        @pin_count = 16
+        @spi_port = spi_port || 0
+        @device_id = device_id || 0
+        Wiringpi.mcp23s17Setup(pin_base, spi_port, device_id)
+      end
+    end
+  end
+end

data/lib/wiringpi/scrollphat.rb

@@ -1,35 +1,35 @@
 module WiringPi
 	class ScrollPhat
-		def initialize()
-			Wiringpi.scrollPhatSetup()
+		def initialize
+			Wiringpi.scrollPhatSetup
 		end
 
 		def printf(text)
 			Wiringpi.scrollPhatPrintf(text)
 		end
 
-		def point(x, y, colour)
-			Wiringpi.scrollPhatPoint(x, y, colour)
+		def point(x, y, color)
+			Wiringpi.scrollPhatPoint(x, y, color)
 		end
 
-		def line(x0, y0, x1, y1, colour)
-			Wiringpi.scrollPhatLine(x0, y0, x1, y1, colour)
+		def line(x0, y0, x1, y1, color)
+			Wiringpi.scrollPhatLine(x0, y0, x1, y1, color)
 		end
 
-		def lineTo(x, y, colour)
-			Wiringpi.scrollPhatLineTo(x, y, colour)
+		def lineTo(x, y, color)
+			Wiringpi.scrollPhatLineTo(x, y, color)
 		end
 
-		def rectangle(x1, y1, x2, y2, colour)
-			Wiringpi.scrollPhatRectangle(x1, y1, x2, y2, colour)
+		def rectangle(x1, y1, x2, y2, color)
+			Wiringpi.scrollPhatRectangle(x1, y1, x2, y2, color)
 		end
 
-		def update()
-			Wiringpi.scrollPhatUpdate()
+		def update
+			Wiringpi.scrollPhatUpdate
 		end
 
-		def clear()
-			Wiringpi.scrollPhatClear()
+		def clear
+			Wiringpi.scrollPhatClear
 		end
 
 		def putChar(char)

data/lib/wiringpi/serial.rb

@@ -1,49 +1,39 @@
 module WiringPi
   class Serial
-
+    attr_reader :id, :device, :baud
     @id = 0
     @device = '/dev/ttyAMA0'
     @baud = 9600
 
-    def initialize(device='/dev/ttyAMA0', baud=9600)
-
+    def initialize(device = '/dev/ttyAMA0', baud = 9600)
+      @id = Wiringpi.serialOpen(device, baud)
       @device = device
       @baud = baud
-
-      @id = Wiringpi.serialOpen(@device, @baud)
-
     end
 
     def serial_close
-
       Wiringpi.serialClose(@id)
-      @id = 0
-
+      @id = nil
     end
 
     def serial_put_char(char)
-
+      raise 'serial connection is closed' if @id.nil?
       Wiringpi.serialPutchar(@id, char)
-
     end
 
     def serial_puts(string)
-
+      raise 'serial connection is closed' if @id.nil?
       Wiringpi.serialPuts(@id, string)
-
     end
 
     def serial_data_avail
-
+      raise 'serial connection is closed' if @id.nil?
       Wiringpi.serialDataAvail(@id)
-
     end
 
     def serial_get_char
-
+      raise 'serial connection is closed' if @id.nil?
       Wiringpi.serialGetchar(@id)
-
     end
-
   end
 end