pi_facer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab54d4f2592cd0e45473a1b959a15da85309d11c
+  data.tar.gz: dda5407c3966f3bf22e47eb766c19c136e1e7a2e
+SHA512:
+  metadata.gz: b20b6b0d435e4c2a7bd633bf44cde09ff0eb2569b1e0e9133afaab171ad031ff6cb9951b73f9e9c3960e8547252d0648283f895b3b5854e136e21bf8f4946628
+  data.tar.gz: 65c47843eddb2f1e6713e11cfeb909d82feffde61006d1aa1f4452cece24ca22fa688c76c5f2ebb3a9c5d0d6ecd85182a271bf9a72f2f124b7b80583aabe71c2

data/Manifest

@@ -0,0 +1,24 @@
+.
+./examples
+./examples/2_bit_counter
+./examples/2_bit_counter/2_bit_counter.rb
+./examples/7-segment
+./examples/7-segment/7-segment.rb
+./examples/dsl_switch
+./examples/dsl_switch/dsl_switch.rb
+./examples/morse_code
+./examples/morse_code/circuit.png
+./examples/morse_code/morse_code.rb
+./examples/simple_switch
+./examples/simple_switch/circuit.png
+./examples/simple_switch/simple_switch.rb
+./lib
+./lib/pi_facer
+./lib/pi_facer/io.rb
+./lib/pi_facer.rb
+./Manifest
+./pi_facer.gemspec
+./Rakefile
+./README.md
+
+8 directories, 13 files

data/README.md

@@ -0,0 +1,48 @@
+## Overview
+
+Pi Facer brings event driven programming to the Raspberry Pi's PiFace accessory.  
+Pi Facer was designed for Ruby 2.0!
+Pi Facer was based and inspired on <a href="https://github.com/jwhitehorn/pi_piper">Pi Piper</a> and uses <a href="https://github.com/blakejakopovic/piface">piface</a>, and such is still alpha as piface is.
+
+To get started:
+
+To install Pi Facer:
+
+    sudo gem install pi_facer
+
+### PIFACE
+PiFace Digital plugs directly onto the top of your Raspberry Pi, and allows you to sense and control the real world.
+2 Changeover relays
+8 Open-collector outputs
+8 Digital inputs
+8 LED indicators
+4 Switches
+Graphical emulator and simulator
+
+```ruby
+require 'pi_facer'
+include PiFacer
+
+watch :io => 3 do
+  puts "FIO changed from #{last_value} to #{value}"
+end
+
+PiFacer.wait
+```
+
+Your block will be called when a change to the pin's state is detected.
+
+Additionally you can use the outputs too:
+
+```ruby
+pin = PiFacer::FIO.new(:io => 1, :direction => :out)
+pin.on
+sleep 1
+pin.off
+```
+
+
+***
+<img src="http://www.raspberrypi.org/wp-content/uploads/2012/03/Raspi_Colour_R.png" width="90" />
+
+Proudly developed exclusively on a [Raspberry Pi](http://www.raspberrypi.org)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'  
+require 'rake'  
+require 'echoe'  
+  
+Echoe.new('pi_facer', '0.0.1') do |p|  
+  p.description     = "Event driven Raspberry PIFace library"  
+  p.url             = "http://github.com/awls99/pi_piper"  
+  p.author          = "Arthur Silva"  
+  p.email           = "awls99@gmail.com"  
+  p.ignore_pattern  = ["examples/**/*"]  
+  p.dependencies = ['piface']  
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }  

data/lib/pi_facer.rb

@@ -0,0 +1,28 @@
+require 'piface'
+Dir[File.dirname(__FILE__) + '/pi_facer/*.rb'].each {|file| require file }
+
+module PiFacer
+	extend self
+	
+	#Defines an event block to be executed when an event occurs.
+	#
+	# == Parameters:
+	# options:
+	#   Options hash. Options include `:pin`, `:invert` and `:direction`.
+	# 
+	def watch(options, &block)
+		Thread.new do
+			pin = PiFacer::FIO.new(options)
+			loop do
+				pin.wait_for_change 
+				yield pin
+			end 
+		end.abort_on_exception = true  
+	end
+	
+	#Prevents the main thread from exiting. Required when using PiFacer.watch
+	def wait
+		loop do sleep 1 end
+	end
+
+end

data/lib/pi_facer/io.rb

@@ -0,0 +1,76 @@
+module PiFacer
+	# Represents a Piface io on the Raspberry Pi
+	class FIO
+		attr_reader :io, :last_value, :value, :direction, :invert
+		
+		#Initializes a new Piface io.
+		#
+		# @param [Hash] options A hash of options
+		# @option options [Fixnum] :io The io number to initialize. Required.
+		# @option options [Symbol] :direction The direction of communication, either :in or :out. Defaults to :in.
+		# @option options [Boolean] :invert Indicates if the value read from the physical io should be inverted. Defaults to false.
+		# @option options [Symbol] :trigger Indicates when the wait_for_change method will detect a change, either :rising, :falling, or :both edge triggers. Defaults to :both.
+		def initialize(direction: :in, invert: true, trigger: :both, **options)
+			raise "Invalid direction. Options are :in or :out" unless [:in, :out].include? direction
+			raise "Invalid IO, Piface IO numbers go from 1 to 8" unless (1..8).include? options[:io]
+			raise 'Invalid trigger' unless %I[rising falling both].include? trigger 
+
+			@io        = options[:io]
+			@direction = direction
+			@invert    = invert
+			@trigger   = trigger
+		 
+			read
+		end
+		
+		# If the io has been initialized for output this method will set the logic level high.
+		def on
+			Piface.write( @io, 1 )  if direction == :out
+		end
+		
+		# Tests if the logic level is high.
+		def on?
+			not off?
+		end
+		
+		# If the io has been initialized for output this method will set the logic level low.
+		def off
+			Piface.write( @io, 0 )  if direction == :out
+		end
+		
+		# Tests if the logic level is low.
+		def off?
+			value == 0
+		end
+
+		# If the io has been initialized for output this method will either raise or lower the logic level depending on `new_value`.
+		# @param [Object] new_value If false or 0 the io will be set to off, otherwise on.
+		def update_value(new_value)
+			!new_value || new_value == 0 ? off : on
+		end
+		
+		# Tests if the logic level has changed since the io was last read.
+		def changed?
+			read
+			last_value != value
+		end
+
+		# blocks until a logic level change occurs. The initializer option `:trigger` modifies what edge this method will release on.
+		def wait_for_change
+			loop do
+				if changed?
+					next if @trigger == :rising  and @value == 0
+					next if @trigger == :falling and @value == 1
+					break
+				end
+			end
+		end
+
+		def read 
+			@last_value = @value
+			val         = Piface.read @io
+			@value      = invert ? (val ^ 1) : val
+		end
+		
+	end
+end

data/pi_facer.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+	s.name = "pi_facer"
+	s.version = "0.0.1"
+
+	s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+	s.authors = ["Arthur Silva"]
+	s.date = Time.now.strftime("%Y-%m-%d")
+	s.description = "Event driven Raspberry Pi Piface library based on pi_piper lib"
+	s.email = "awls99@gmail.com"
+	s.extra_rdoc_files = ["README.md", "lib/pi_facer.rb", "lib/pi_facer/io.rb"]
+	s.files = ["Manifest", "README.md", "Rakefile", "lib/pi_facer.rb", "lib/pi_facer/io.rb", "pi_facer.gemspec"]
+	s.homepage = "https://github.com/awls99/pi_piper"
+	s.require_paths = ["lib"]
+	s.rubygems_version = "1.8.23"
+	s.summary = "Event driven Raspberry Pi Piface library based on pi_piper lib"
+	s.add_dependency(%q<piface>, [">= 0"])
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: pi_facer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arthur Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: piface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Event driven Raspberry Pi Piface library based on pi_piper lib
+email: awls99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- lib/pi_facer.rb
+- lib/pi_facer/io.rb
+files:
+- Manifest
+- README.md
+- Rakefile
+- lib/pi_facer.rb
+- lib/pi_facer/io.rb
+- pi_facer.gemspec
+homepage: https://github.com/awls99/pi_piper
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Event driven Raspberry Pi Piface library based on pi_piper lib
+test_files: []