gpio 0.0.3 → 0.0.4

data/changelog

@@ -1,3 +1,14 @@
+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
+- using IO.read and Dir.methods where possible for performance gains, added self.pin_prefix
+- raspberry_pi.rb => device.rb: moved methods that are now generic enough to be in device.
+- extracted paths to separate methods to allow for generic gpio methods to be moved to device and allow raspberr_pi.rb and other modules that extend device to be configuration.
+- removed sudo from reads, only needed for writes
+- print pin in error message raised
+- benchmarks added to see timings of different methods of reading/writing
+- found new methods of reading file that may be viable for microsecond intervals
+
 version 0.0.3
 - updated readme with example
 - example usage code added
@@ -12,4 +23,4 @@ version 0.0.2
 - lib files now load properly
 
 version 0.0.1: initial public release
-- proof of concept / prototype
+- proof of concept / prototype

data/lib/gpio/device.rb

@@ -1,11 +1,11 @@
 module GPIO
 	module Device
 		def software_pin(pin)
-			raise "That software pin doesn't exist." unless software_pins.include? pin
+			raise "That software pin #{pin} doesn't exist." unless software_pins.include? pin
 			mapping == :software ? pin : software_pins[hardware_pins.index(pin)]
 		end
 		def hardware_pin(pin)
-			raise "That hardware pin doesn't exist." unless hardware_pins.include? pin
+			raise "That hardware pin #{pin} doesn't exist." unless hardware_pins.include? pin
 			mapping == :hardware ? pin : hardware_pins[software_pins.index(pin)]
 		end
 		def load_pins
@@ -14,5 +14,45 @@ module GPIO
 		def unexport_all!
 			load_pins.map(&unexport!)
 		end
+
+		def get_pins(mapping)
+			pins = Dir.entries 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)
+			IO.read(direction_path(software_pin)).chomp!
+		end
+
+		def initialize_pin(software_pin, direction)
+			unexport!(software_pin) if exported?(software_pin) && direction != get_direction(software_pin)
+			export!(software_pin, direction) unless exported?(software_pin)
+		end
+
+		def exported?(software_pin)
+			Dir.exists? pin_path(software_pin)
+		end
+		def export!(software_pin,direction)
+			path_write 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
+			!exported? software_pin
+		end
+
+		def read(software_pin)
+			IO.read(value_path(software_pin), 1) == '1'
+		end
+		def write(software_pin,value)
+			raise "This pin is an input." if get_direction(software_pin) == 'in'
+			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)
+		end
+		def path_write_sudo(path, value)
+			`sudo bash -c "echo #{value} > #{path}"`.chomp!
+		end
 	end
-end
+end

data/lib/gpio/raspberry_pi.rb

@@ -11,39 +11,27 @@ module GPIO
 		def self.software_pins
 			[0,1,4,14,15,17,18,21,22,23,24,10,9,25,11,8,7]
 		end
-
-		def self.get_pins(mapping=@mapping)
-			pins = `sudo ls /sys/class/gpio`.scan(/(?:gpio)(\d+)/).flatten.map!(&:to_i)
-			pins.map!{|pin| Pin.new(pin,nil,self).pin}
+		
+		def self.base_path
+			'/sys/class/gpio/'
 		end
-		def self.get_direction(software_pin)
-			`sudo cat /sys/class/gpio/gpio#{software_pin}/direction`.chomp
+		def self.pin_path(n)
+			"#{base_path}#{pin_prefix}#{n}/"
 		end
-
-		def self.initialize_pin(software_pin, direction)
-			unexport!(software_pin) if exported?(software_pin) && direction != get_direction(software_pin)
-			export!(software_pin, direction) unless exported?(software_pin)
+		def self.direction_path(n)
+			"#{pin_path(n)}direction"
 		end
-
-		def self.exported?(software_pin)
-			`sudo [ -d /sys/class/gpio/gpio#{software_pin} ] && echo true || false`.chomp == 'true'
+		def self.value_path(n)
+			"#{pin_path(n)}value"
 		end
-		def self.export!(software_pin,direction)
-			`sudo bash -c "echo #{software_pin} > /sys/class/gpio/export"`
-			`sudo bash -c "echo #{direction} > /sys/class/gpio/gpio#{software_pin}/direction"`
-			exported?(software_pin)
+		def self.export_path
+			"#{base_path}export"
 		end
-		def self.unexport!(software_pin)
-			`sudo bash -c "echo #{software_pin} > /sys/class/gpio/unexport"`
-			!exported?(software_pin)
-		end
-
-		def self.read(software_pin)
-			`sudo cat /sys/class/gpio/gpio#{software_pin}/value`.chomp == '1'
+		def self.unexport_path
+			"#{base_path}unexport"
 		end
-		def self.write(software_pin,value)
-			raise "This pin is an input." if get_direction(software_pin) == 'in'
-			`sudo bash -c "echo #{value} > /sys/class/gpio/gpio#{software_pin}/value && echo true || false"`.chomp == 'true'
+		def self.pin_prefix
+			"gpio"
 		end
 	end
-end
+end

metadata

@@ -1,70 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gpio
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Christopher Klapp
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-05 00:00:00 -04:00
-default_executable: 
+date: 2012-06-05 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.
+description: gpio allows for devices such as raspberry pi or systems with 1wire usb
+  adapters to speak to the system's input/output pins.
 email: christopher@klapp.name
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/gpio/device.rb
-- lib/gpio/motion_detector.rb
-- lib/gpio/pin.rb
+files:
+- lib/gpio.rb
 - lib/gpio/raspberry_pi.rb
 - lib/gpio/sensor.rb
-- lib/gpio.rb
-- examples/motion_example.rb
+- lib/gpio/pin.rb
+- lib/gpio/motion_detector.rb
+- lib/gpio/device.rb
 - README.md
 - changelog
-has_rdoc: true
 homepage: http://klappy.github.com/gpio
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: a ruby gem and repository to contribute gpio code for devices such as Raspberry Pi to read sensors and control outputs.
+summary: a ruby gem and repository to contribute gpio code for devices such as Raspberry
+  Pi to read sensors and control outputs.
 test_files: []
-

data/examples/motion_example.rb

@@ -1,20 +0,0 @@
-# Let's setup a motion sensor on GPIO pin 17 on a RaspberryPi (default).
-motion = GPIO::MotionDetector.new(pin: 17)
-
-# Do we detect and motion yet?
-motion.detect
-
-# Let's print a message corresponding to the motion.detect?
-puts motion.detect ? "Motion detected!" : "No motion detected."
-
-# Was the value any different than the last time it detected?
-motion.changed?
-puts "last: #{motion.last_reading}, current: #{motion.reading}"
-
-# Wait until the value changes before we move on.
-until motion.changed? do
-	motion.detect
-	sleep 0.5
-end
-puts "Something changed!"
-puts "last: #{motion.last_reading}, current: #{motion.reading}"