gpio 0.0.5 → 0.0.6

data/changelog

@@ -1,3 +1,11 @@
+version 0.0.6
+- new reading method File.new and f.getc/rewind that gets into ~35 microsecond reads instead of ~55 microsecond IO.new io.getc/rewind and ~350 microsecond reads with IO.read
+- typed input/output pins, mainly to prepare for pwm, bidirectional/1wire, and more
+- organized folders for devices/pins/sensors
+
+version 0.0.5
+- date bump
+
 version 0.0.4
 - major changes to reading/writing from/to gpio including checking permissions with hands free fallback to older sudo method
 - path_write method checks permissions and writes using IO.write for performance and falls back to shelling out to sudo echo

data/lib/gpio.rb

@@ -1 +1 @@
-%w[device raspberry_pi pin sensor motion_detector].each{|file| require File.dirname(__FILE__)+'/gpio/'+file}
+%w[device devices/raspberry_pi pin pins/input_pin pins/output_pin sensor sensors/motion_detector].each{|file| require File.dirname(__FILE__)+'/gpio/'+file}

data/lib/gpio/device.rb

@@ -1,12 +1,12 @@
 module GPIO
 	module Device
 		def software_pin(pin)
-			raise "That software pin #{pin} doesn't exist." unless software_pins.include? pin
-			mapping == :software ? pin : software_pins[hardware_pins.index(pin)]
+			raise "That software pin #{pin} doesn't exist." unless self::SOFTWARE_PINS.include? pin
+			self::MAPPING == :software ? pin : self::SOFTWARE_PINS[self::HARDWARE_PINS.index(pin)]
 		end
 		def hardware_pin(pin)
-			raise "That hardware pin #{pin} doesn't exist." unless hardware_pins.include? pin
-			mapping == :hardware ? pin : hardware_pins[software_pins.index(pin)]
+			raise "That hardware pin #{pin} doesn't exist." unless self::HARDWARE_PINS.include? pin
+			self::MAPPING == :hardware ? pin : self::HARDWARE_PINS[self::SOFTWARE_PINS.index(pin)]
 		end
 		def load_pins
 			get_pins(:hardware).map{|pin| Pin.new(pin,get_direction(pin),self)}
@@ -16,7 +16,7 @@ module GPIO
 		end
 
 		def get_pins(mapping)
-			pins = Dir.entries base_path.select!{|pin| pin[/(?:#{pin_prefix})(\d+)/]}.to_i
+			pins = Dir.entries self::BASE_PATH.select!{|pin| pin[/(?:#{PIN_PREFIX})(\d+)/]}.to_i
 			pins.map!{|pin| Pin.new(pin,nil,self).pin}
 		end
 		def get_direction(software_pin)
@@ -29,18 +29,27 @@ module GPIO
 		end
 
 		def exported?(software_pin)
-			Dir.exists? pin_path(software_pin)
+			File.exists? pin_path(software_pin)
 		end
 		def export!(software_pin,direction)
-			path_write export_path, software_pin
+			path_write self::EXPORT_PATH, software_pin
 			path_write direction_path(software_pin), direction
 			exported?(software_pin)
 		end
 		def unexport!(software_pin)
-			path_write unexport_path, software_pin
+			path_write self::UNEXPORT_PATH, software_pin
 			!exported? software_pin
 		end
 
+		def pin_file(software_pin, mode)
+			m = case mode.to_s
+			when 'in'; 'r'
+			when 'out'; 'w'
+			when 'bi'; 'r+'
+			end
+			File.new value_path(software_pin), m
+		end
+
 		def read(software_pin)
 			IO.read(value_path(software_pin), 1) == '1'
 		end
@@ -49,10 +58,24 @@ module GPIO
 			path_write value_path(software_pin), value
 		end
 		def path_write(path, value)
-			File::Stat.writable?(path) ? IO.write(path, value) : path_write_sudo(path, value)
+			File::Stat.new(path).writable? ? IO.write(path, value) : path_write_sudo(path, value)
 		end
 		def path_write_sudo(path, value)
 			`sudo bash -c "echo #{value} > #{path}"`.chomp!
 		end
+
+		def pin_path(n)
+			"#{self::BASE_PATH}#{self::PIN_PREFIX}#{n}/"
+		end
+		def direction_path(n)
+			"#{pin_path(n)}#{self::DIRECTION_FILE}"
+		end
+		def value_path(n)
+			"#{pin_path(n)}#{self::VALUE_FILE}"
+		end
+
+		def valid?
+			IO.read(self::VALIDATE_FILE).chomp! == self::VALIDATE_VALUE
+		end
 	end
 end

data/lib/gpio/devices/other.rb

@@ -0,0 +1,18 @@
+module GPIO
+	module Other
+		extend Device
+
+		VALIDATE_FILE = "/sys/class/gpio/gpiochip0/label"
+		VALIDATE_VALUE = "chipset_gpio"
+
+		MAPPING = :hardware
+		HARDWARE_PINS = [0,1,2]
+		SOFTWARE_PINS = [2,1,0]
+		BASE_PATH = '/sys/class/gpio/'
+		EXPORT_PATH = "#{BASE_PATH}export"
+		UNEXPORT_PATH = "#{BASE_PATH}unexport"
+		PIN_PREFIX = "gpio"
+		DIRECTION_FILE = "mode"
+		VALUE_FILE = "value"
+	end
+end

data/lib/gpio/devices/raspberry_pi.rb

@@ -0,0 +1,18 @@
+module GPIO
+	module RaspberryPi
+		extend Device
+
+		VALIDATE_FILE = "/sys/class/gpio/gpiochip0/label"
+		VALIDATE_VALUE = "bcm2708_gpio"
+
+		MAPPING = :hardware
+		HARDWARE_PINS = [3,5,7,8,10,11,12,13,15,16,17,19,21,22,23,24,26]
+		SOFTWARE_PINS = [0,1,4,14,15,17,18,21,22,23,24,10,9,25,11,8,7]
+		BASE_PATH = '/sys/class/gpio/'
+		EXPORT_PATH = "#{BASE_PATH}export"
+		UNEXPORT_PATH = "#{BASE_PATH}unexport"
+		PIN_PREFIX = "gpio"
+		DIRECTION_FILE = "direction"
+		VALUE_FILE = "value"
+	end
+end

data/lib/gpio/pin.rb

@@ -1,6 +1,6 @@
 module GPIO
 	class Pin
-		attr_reader :pin, :mode, :device, :hardware_pin, :software_pin
+		attr_reader :pin, :mode, :device, :hardware_pin, :software_pin, :file
 		def initialize(params) #(pin, mode, device=:RaspberryPi)
 			@device = GPIO.const_get(params[:device]||:RaspberryPi)
 
@@ -8,22 +8,16 @@ module GPIO
 			@hardware_pin = device.hardware_pin(pin)
 			@software_pin = device.software_pin(pin)
 
-			@mode = params[:mode].to_s || device.get_direction
+			@mode = params[:mode].to_s
 			raise "Mode should be :in, :out, :bi, :pwm." unless ['in','out'].include? @mode
 
 			device.initialize_pin(software_pin, @mode)
+			@mode ||= get_direction
+			@file = @device.pin_file(pin, mode)
 		end
 
-		def on
-			device.write software_pin, 1
-			read
-		end
-		def off
-			device.write software_pin, 0
-			read
-		end
 		def read
-			device.read(software_pin)
+			file.rewind; file.getc
 		end
 	end
 end

data/lib/gpio/pins/input_pin.rb

@@ -0,0 +1,17 @@
+module GPIO
+	class InputPin < Pin
+		attr_reader :last_reading, :reading
+		def initialize(params) #(pin, mode, device=:RaspberryPi)
+			params.merge!(:mode => :in)
+			super(params)
+		end
+
+		def changed?
+			@last_reading != @reading
+		end
+		def read
+			@last_reading = @reading
+			@reading = super
+		end
+	end
+end

data/lib/gpio/pins/output_pin.rb

@@ -0,0 +1,17 @@
+module GPIO
+	class OutputPin < Pin
+		def initialize(params) #(pin, mode, device=:RaspberryPi)
+			params.merge!(:mode => :out)
+			super(params)
+		end
+
+		def on
+			device.write software_pin, 1
+			read
+		end
+		def off
+			device.write software_pin, 0
+			read
+		end
+	end
+end

data/lib/gpio/sensor.rb

@@ -1,15 +1,20 @@
 module GPIO
 	class Sensor
-		attr_reader :reading, :last_reading
+		attr_reader :pin
 		def initialize(params)
-			@pin = Pin.new(:pin => params[:pin], :mode => :in, :device => params[:device])
+			@pin = InputPin.new(:pin => params[:pin], :mode => :in, :device => params[:device])
 		end
 		def changed?
-			@last_reading != @reading
+			pin.changed?
 		end
 		def read
-			@last_reading = @reading
-			@reading = @pin.read
+			pin.read
+		end
+		def reading
+			pin.reading
+		end
+		def last_reading
+			pin.last_reading
 		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpio
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies: []
 description: gpio allows for devices such as raspberry pi or systems with 1wire usb
   adapters to speak to the system's input/output pins.
@@ -19,11 +19,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gpio.rb
-- lib/gpio/raspberry_pi.rb
+- lib/gpio/sensors/motion_detector.rb
 - lib/gpio/sensor.rb
 - lib/gpio/pin.rb
-- lib/gpio/motion_detector.rb
+- lib/gpio/pins/output_pin.rb
+- lib/gpio/pins/input_pin.rb
 - lib/gpio/device.rb
+- lib/gpio/devices/raspberry_pi.rb
+- lib/gpio/devices/other.rb
 - README.md
 - changelog
 homepage: http://klappy.github.com/gpio

data/lib/gpio/raspberry_pi.rb

@@ -1,37 +0,0 @@
-module GPIO
-	module RaspberryPi
-		extend Device
-
-		def self.mapping
-			:hardware
-		end
-		def self.hardware_pins
-			[3,5,7,8,10,11,12,13,15,16,17,19,21,22,23,24,26]
-		end
-		def self.software_pins
-			[0,1,4,14,15,17,18,21,22,23,24,10,9,25,11,8,7]
-		end
-		
-		def self.base_path
-			'/sys/class/gpio/'
-		end
-		def self.pin_path(n)
-			"#{base_path}#{pin_prefix}#{n}/"
-		end
-		def self.direction_path(n)
-			"#{pin_path(n)}direction"
-		end
-		def self.value_path(n)
-			"#{pin_path(n)}value"
-		end
-		def self.export_path
-			"#{base_path}export"
-		end
-		def self.unexport_path
-			"#{base_path}unexport"
-		end
-		def self.pin_prefix
-			"gpio"
-		end
-	end
-end