piface 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b43f10c9a88d6a0c608ca43d4e1860f0420bf45
+  data.tar.gz: 26d96b13751d18c479ac1ace336b064881b0e8e1
+SHA512:
+  metadata.gz: 04e6ff4046cc0d866b0342452bf2a69292a3d7bf4e311f94049063d5192b4108894bdb4cf7b0060dd579aac868ef7d1948e4dbeb558a4aac8df305378f9001af
+  data.tar.gz: ddc296d7592048ddf663b353ac780b9aa05d237a770e76f7589072c36dafddd7d3c070ba8b5a8775146abae8eb3993b34db42b3d865c456a841033167de12639

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+ideas.md

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+
+## Upcoming v1.0
+- Interrupts (change, high, low)
+
+## v0.3
+ - added new pfio.c native methods using ffi
+ - updated ffi to ~> v1.7.dev
+ - implemented Piface.read_input and Piface.read_output
+ - changed all piface code references to lowercase (excluding the primary module)
+ - changed gem name to lowercase
+ - added Piface::HIGH and Piface::LOW
+ - updated README.md
+ - added ffi_lib path fallbacks
+
+## v0.2
+ - Initial Public Release
+
+## v0.1
+ - Internal Release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in piface.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Blake
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Ruby Bindings for [pfio.c](https://github.com/thomasmacpherson/piface/tree/master/c)
+
+The [pfio C Library](https://github.com/thomasmacpherson/piface/blob/master/c/) is used to control the [Pi-Face Digital Interface](http://pi.cs.man.ac.uk/interface.htm) for [Raspberry Pi](http://www.raspberrypi.org/). This gem uses the [Ruby-FFI](https://github.com/ffi/ffi) gem to bind the C functions to ruby.
+
+## !! Project is currently in ALPHA (Things may change)
+Ruby method names, as well as other aspects, may change until version 1.0 is released.
+
+## Basic Usage
+
+The PiFace has 8 inputs and 8 outputs. Both the inputs and outputs are linked to connectors 1-8 respectfully.
+
+Note: The pfio C library will set all outputs to LOW (zero) when first initialized.
+
+### Using Outputs
+Writing to outputs 1 to 8 with all turn on the LEDs. Write to outputs using Piface::LOW (or 0) for off/disable and Piface::HIGH (or 1) for on/enable.
+
+Please note that the PiFace outputs are all open-collectors (meaning that they do not output any voltage). Please read the [PiFace Manual](http://www.farnell.com/datasheets/1684425.pdf) for more information.
+
+```ruby
+require 'piface'
+
+# Enable output 4
+Piface.write 4, 1
+
+sleep 1 # wait one second
+
+# Disable output 4
+Piface.write 4, 0
+```
+
+### Using Relays
+Write to outputs 1 and 2 to control the relays (if jumpers JP5 and JP6 are enabled on the PiFace).
+```ruby
+require 'piface'
+
+# Turn on the first relay
+Piface.write 1, 1
+
+sleep 1 # wait one second
+
+# Turn off first relay
+Piface.write 1, 0
+```
+
+### Using Classes
+Sometimes it's nice to represent an output using a class. One common example is when you want to track the current state of the output.
+```ruby
+require 'piface'
+
+# Relay class implementing toggle functionality
+class Relay
+  def initialize(relay_number)
+    @relay_number = relay_number
+    @state = 0
+  end
+
+  def turn_on
+    Piface.write @relay_number, 1
+    @state = 1
+  end
+
+  def turn_off
+    Piface.write @relay_number, 0
+    @state = 0
+  end
+
+  def toggle
+    @state == 1 ? turn_off : turn_on
+  end
+end
+
+relay1 = Relay.new(1)
+
+# Turn the relay on and off 3 times
+6.times do
+  relay1.toggle
+  sleep 1 # wait one second
+end
+```
+
+### Using Inputs
+The PiFace uses digital inputs. Reading the value with return either a 0 or 1. Since the PiFace uses pull-up resistors for inputs, by default they will read 1. This means to check for input (such as button presses), you must compare the read input value with 0 for on.
+```ruby
+require 'piface'
+
+# Read value from input 6 (without active input)
+Piface.read 6
+# => 1
+
+# Read value from input 6 (with active input)
+Piface.read 6
+# => 0
+```
+
+### Using Buttons
+The PiFace has 4 built-in buttons that correspond to inputs 1 to 4.
+```ruby
+require 'piface'
+
+# Listen for button 4 press
+loop do
+  # Check if the button has been pressed
+  if (Piface.read(4) == Piface::LOW)
+    puts "Button 4 pressed"
+  end
+  sleep 0.1 # sleep to be kind to the CPU
+end
+```
+
+## Additional Resources
+* [The PiFace Digital PDF Manual](http://www.farnell.com/datasheets/1684425.pdf)
+* [pfio C Library](https://github.com/thomasmacpherson/piface/blob/master/c/)
+* [WiriingPi Library](https://github.com/WiringPi/WiringPi)
+
+## Installation
+
+First install the pfio C Library
+
+[https://github.com/thomasmacpherson/piface](https://github.com/thomasmacpherson/piface)
+
+Enable RaspberryPi's SPI module
+
+    $ sudo modprobe spi-bcm2708
+    or
+    $ gpio load spi
+
+Add this line to your application's Gemfile:
+
+    gem 'piface'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install piface
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/piface/native.rb

@@ -0,0 +1,22 @@
+require "ffi"
+
+module Piface
+  module Native
+    extend FFI::Library
+    ffi_lib ['libpiface', 'libpiface-1.0', 'libpiface-1.0.so.1', '/usr/local/lib/libpiface-1.0']
+
+    attach_function :pfio_init, [], :char
+    attach_function :pfio_deinit, [], :char
+
+    attach_function :pfio_digital_read, [ :char ], :char
+    attach_function :pfio_digital_write, [ :char, :char ], :void
+
+    attach_function :pfio_read_input, [], :char
+    attach_function :pfio_read_output, [], :char
+
+    # attach_function :pfio_write_output, [ :char ], :void
+
+    attach_function :pfio_get_pin_bit_mask, [ :char ], :char
+    attach_function :pfio_get_pin_number, [ :char ], :char
+  end
+end

data/lib/piface/version.rb

@@ -0,0 +1,3 @@
+module Piface
+  VERSION = "0.3.0"
+end

data/lib/piface.rb

@@ -0,0 +1,49 @@
+require "piface/version"
+require "piface/native"
+
+module Piface
+  LOW  = 0
+  HIGH = 1
+
+  def self.read(pin_number)
+    Native.pfio_digital_read(pin_number)
+  end
+
+  def self.write(pin_number, value)
+    Native.pfio_digital_write(pin_number, value)
+  end
+
+  def self.read_input(pin_number)
+    current_state = Native.pfio_read_input
+    pin_state(current_state, pin_number)
+  end
+
+  def self.read_output(pin_number)
+    current_state = Native.pfio_read_output
+    pin_state(current_state, pin_number)
+  end
+
+  private
+  def self.init
+    Native.pfio_init
+  end
+
+  def self.deinit
+    Native.pfio_init
+  end
+
+  def self.pin_number_to_flag(pin_number)
+    2**(pin_number - 1)
+  end
+
+  def self.flag_active?(mask, pin_number)
+    mask & pin_number_to_flag(pin_number) > 0
+  end
+
+  def self.pin_state(mask, pin_number)
+    flag_active?(mask, pin_number) ? HIGH : LOW
+  end
+end
+
+at_exit { Piface.deinit }
+Piface.init

data/piface.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'piface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "piface"
+  spec.version       = Piface::VERSION
+  spec.authors       = ["Blake Jakopovic"]
+  spec.email         = ["blake.jakopovic@gmail.com"]
+  spec.description   = %q{Ruby gem for using PiFace Extension Board (and Raspberry Pi)}
+  spec.summary       = %q{Ruby Bindings for the pfio.c C Library for use with the PiFace Digital extension board and your Raspberry Pi}
+  spec.homepage      = "http://twitter.com/blakejakopovic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "ffi", "~> 1.7.dev"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: piface
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Blake Jakopovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.dev
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.dev
+description: Ruby gem for using PiFace Extension Board (and Raspberry Pi)
+email:
+- blake.jakopovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/piface.rb
+- lib/piface/native.rb
+- lib/piface/version.rb
+- piface.gemspec
+homepage: http://twitter.com/blakejakopovic
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby Bindings for the pfio.c C Library for use with the PiFace Digital extension
+  board and your Raspberry Pi
+test_files: []
+has_rdoc: