gpio 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,76 @@
-gpio
+# description
 ====
 
-gpio ruby gem allows for ruby code running on devices such as raspberry pi or systems with 1wire usb adapters to speak to the system's input/output pins.
+a ruby gem and repository to contribute gpio code for devices such as Raspberry Pi to read sensors and control outputs.
 
-the end goal is for people to contribute code for specific devices, sensors and outputs.
+gpio allows for devices such as raspberry pi or systems with 1wire usb adapters to speak to the system's input/output pins.
+
+# installation
+====
+
+### bundler
+
+using bundler, add this to your Gemfile in the root of your app
+
+```ruby
+gem 'gpio'
+```
+install bundler and then run bundle install
+```bash
+gem install bundler
+bundle install
+```
+
+
+### gem install
+
+from command line
+
+```bash
+gem install gpio
+```
+
+require in your ruby file
+
+```ruby
+require 'gpio'
+```
+
+# example
+====
+
+let's setup a motion sensor on GPIO pin 17 on a RaspberryPi (default).
+
+```ruby
+motion = GPIO::MotionDetector.new(pin: 17)
+```
+
+do we detect and motion yet?
+
+```ruby
+motion.detect
+```
+
+let's print a message corresponding to the motion.detect?
+
+```ruby
+puts motion.detect ? "Motion detected!" : "No motion detected."
+```
+
+was the value any different than the last time it detected?
+
+```ruby
+motion.changed?
+puts "last: #{motion.last_reading}, current: #{motion.reading}"
+```
+
+wait until the value changes before we move on.
+
+```ruby
+until motion.changed? do
+	motion.detect
+	sleep 0.5
+end
+puts "Something changed!"
+puts "last: #{motion.last_reading}, current: #{motion.reading}"
+```

data/changelog

@@ -1,3 +1,10 @@
+version 0.0.3
+- updated readme with example
+- example usage code added
+- example sensor of motion_detector added
+- sensor class added
+- raspberry_pi module extends device module
+
 version 0.0.2
 - device/rasberrypi now modules instead of class
 - pin.new(params) now pass hash of params to pin.new {pin: 1, mode: :in, device: :RaspberryPi}

data/examples/motion_example.rb

@@ -0,0 +1,20 @@
+# 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}"

data/lib/gpio.rb

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

data/lib/gpio/device.rb

@@ -1,17 +1,17 @@
 module GPIO
 	module Device
-		def self.software_pin(pin)
-			raise "That software pin doesn't exist." unless software.include? pin
-			mapping == :software ? pin : software[hardware.index(pin)]
+		def software_pin(pin)
+			raise "That software pin doesn't exist." unless software_pins.include? pin
+			mapping == :software ? pin : software_pins[hardware_pins.index(pin)]
 		end
-		def self.hardware_pin(pin)
-			raise "That hardware pin doesn't exist." unless hardware.include? pin
-			mapping == :hardware ? pin : hardware[software.index(pin)]
+		def hardware_pin(pin)
+			raise "That hardware pin doesn't exist." unless hardware_pins.include? pin
+			mapping == :hardware ? pin : hardware_pins[software_pins.index(pin)]
 		end
-		def self.load_pins
+		def load_pins
 			get_pins(:hardware).map{|pin| Pin.new(pin,get_direction(pin),self)}
 		end
-		def self.unexport_all!
+		def unexport_all!
 			load_pins.map(&unexport!)
 		end
 	end

data/lib/gpio/motion_detector.rb

@@ -0,0 +1,7 @@
+module GPIO
+	class MotionDetector < Sensor
+		def detect
+			read
+		end
+	end
+end

data/lib/gpio/raspberry_pi.rb

@@ -1,5 +1,7 @@
 module GPIO
 	module RaspberryPi
+		extend Device
+
 		def self.mapping
 			:hardware
 		end
@@ -43,20 +45,5 @@ module GPIO
 			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'
 		end
-
-		def self.software_pin(pin)
-			raise "That software pin doesn't exist." unless software_pins.include? pin
-			mapping == :software ? pin : software_pins[hardware_pins.index(pin)]
-		end
-		def self.hardware_pin(pin)
-			raise "That hardware pin doesn't exist." unless hardware_pins.include? pin
-			mapping == :hardware ? pin : hardware_pins[software_pins.index(pin)]
-		end
-		def self.load_pins
-			get_pins(:hardware).map{|pin| Pin.new(pin,get_direction(pin),self)}
-		end
-		def self.unexport_all!
-			load_pins.map(&unexport!)
-		end
 	end
 end

data/lib/gpio/sensor.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Christopher Klapp
@@ -18,7 +18,7 @@ date: 2012-06-05 00:00:00 -04:00
 default_executable: 
 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. The end goal is for people to contribute code for specific devices, sensors and outputs.
+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: []
 
@@ -28,9 +28,12 @@ extra_rdoc_files: []
 
 files: 
 - lib/gpio/device.rb
+- lib/gpio/motion_detector.rb
 - lib/gpio/pin.rb
 - lib/gpio/raspberry_pi.rb
+- lib/gpio/sensor.rb
 - lib/gpio.rb
+- examples/motion_example.rb
 - README.md
 - changelog
 has_rdoc: true
@@ -62,6 +65,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: gpio allows for devices such as raspberry pi or systems with 1wire usb adapters to speak to the system's input/output pins.
+summary: a ruby gem and repository to contribute gpio code for devices such as Raspberry Pi to read sensors and control outputs.
 test_files: []