pi_piper 1.3.2 → 1.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822b5150bab4929fca37ae9777209d9445cd663e
-  data.tar.gz: 84a0cd3979800a0ed62ce15fdeab0e9722ffa9b4
+  metadata.gz: 13fdeb8e5268450e6f5e16b76fadd8c86c21d14e
+  data.tar.gz: 0cf0fc4609e69c32a9f2fe67eb6b581a9959d021
 SHA512:
-  metadata.gz: d7b461f1e2ddae7fb25774cc66c9dcffcf9577dc8429c4020d8915fe96aa161713fa72e2db02d4a9169356b6036a982d86016721bd52e4f2c018b04a07140f1e
-  data.tar.gz: 96d61bf27a05ad1f305058ff283272c56651b9d33594bc64d1dcfd1a69dcb4c4897f163cba1d9ea6fc8472d114a065e515907797efffeeb4955e2eaab94e536e
+  metadata.gz: 87894270c282f9368be74074bd7872cd5fd3ce9e26f961cb5cace37a8599cb8ac5aef5c4fcd03368274800cb37da9a10d21012cae8b2a8db0461e3577b77f6f8
+  data.tar.gz: 51bc8cec9b89c1005881a20277543242e458c56c7e2e495daa32d46bdff5af3ab5671b7553d7ce66904d6d121ad76bccae618d2f4d65790d6524b1d332920c6c

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.swp
+*.gem
+coverage/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+before_install:
+  - gem install bundler
+  - gem update

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'echoe'
+gem 'rake'
+gem 'ffi'
+gem "eventmachine", "~> 1.0.9"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    pi_piper (2.0.beta.11)
+      eventmachine (= 1.0.9)
+      ffi
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    allison (2.0.3)
+    diff-lcs (1.2.4)
+    echoe (4.6.3)
+      allison (>= 2.0.3)
+      gemcutter (>= 0.7.0)
+      rake (>= 0.9.2)
+      rdoc (>= 3.6.1)
+      rubyforge (>= 2.0.4)
+    eventmachine (1.0.9)
+    ffi (1.9.0)
+    gemcutter (0.7.1)
+    json (1.8.1)
+    json_pure (1.8.1)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  echoe
+  eventmachine (~> 1.0.9)
+  ffi
+  mocha
+  pi_piper!
+  rake
+  rspec
+  simplecov
+
+BUNDLED WITH
+   1.11.2

data/Manifest

@@ -1,9 +1,14 @@
+Gemfile
+Gemfile.lock
 Manifest
 README.md
 Rakefile
 lib/pi_piper.rb
 lib/pi_piper/bcm2835.rb
+lib/pi_piper/frequency.rb
+lib/pi_piper/i2c.rb
 lib/pi_piper/libbcm2835.img
 lib/pi_piper/pin.rb
+lib/pi_piper/platform.rb
 lib/pi_piper/spi.rb
 pi_piper.gemspec

data/README.md

@@ -1,14 +1,16 @@
 ## Overview
 
-Pi Piper brings event driven programming to the Raspberry Pi's GPIO pins. Pi Piper works with all revisions of the Raspberry Pi, 
-and has been tested with Ruby 1.9.3 under both [Raspbian "wheezy"](http://www.raspberrypi.org/downloads) and [Occidentalis v0.2](http://learn.adafruit.com/adafruit-raspberry-pi-educational-linux-distro/occidentalis-v0-dot-2).
+[![Build Status](https://travis-ci.org/jwhitehorn/pi_piper.png)](https://travis-ci.org/jwhitehorn/pi_piper)
+
+Pi Piper brings event driven programming to the Raspberry Pi's GPIO pins. Pi Piper works with all revisions of the Raspberry Pi,
+and has been tested with Ruby 1.9.3 & 2.0 under both [Raspbian "wheezy"](http://www.raspberrypi.org/downloads) and [Occidentalis v0.2](http://learn.adafruit.com/adafruit-raspberry-pi-educational-linux-distro/occidentalis-v0-dot-2).
 
 To get started:
 
 If you do not already have Ruby installed, first you'll need to:
-    
+
     sudo apt-get install ruby ruby1.9.1-dev
-    
+
 Despite one of the packages being titled "ruby1.9.1-dev", the above command will install Ruby 1.9.3 (as of January 2013) and the Ruby dev tools.
 
 To install Pi Piper:
@@ -38,6 +40,22 @@ PiPiper.wait
 
 Your block will be called when a change to the pin's state is detected.
 
+When using pins as input, you can use internal resistors to pull the pin
+up or pull down. This is important if you use open-collector sensors
+which have floating output in some states.
+
+You can set resistors when creating a pin passing a :pull parameter
+(which can be :up, :down or :off, which is the default).
+
+```ruby
+pin = PiPiper::Pin.new(:pin => 17, :direction => :in, :pull => :up)
+```
+
+This way, the pin will always return 'on' if it is unconnected or of the
+sensor has an open collector output.
+
+You can later alter the pulling resistors using PiPiper#pull!
+
 Additionally you can use pins as output too:
 
 ```ruby
@@ -47,15 +65,26 @@ sleep 1
 pin.off
 ```
 
+_please note, in the above context "pin" refers to the GPIO number of the Raspberry Pi._
+
 ### SPI
-Starting with version 1.2, Pi Piper offers SPI support. 
+Starting with version 1.2, Pi Piper offers SPI support.
 
 ```ruby
-PiPiper::Spi.begin do 
-  puts write [0x01, 0x80, 0x00] 
+PiPiper::Spi.begin do
+  puts write [0x01, 0x80, 0x00]
 end
 ```
 
+If you are using an operating system that supports `/dev/spidev0.0` like the [adafruit
+distro][adafruit-linux] you can also write to the spi using `PiPiper::Spi.spidev_out`
+
+```ruby
+# Example writing red, green, blue to a string of WS2801 pixels
+PiPiper::Spi.spidev_out([255,0,0,0,255,0,0,0,255])
+```
+[adafruit-linux]:http://learn.adafruit.com/adafruit-raspberry-pi-educational-linux-distro/overview
+
 ## Documentation
 
 API documentation for Pi Piper can be found at [rdoc.info](http://rdoc.info/github/jwhitehorn/pi_piper/frames/).
@@ -69,9 +98,26 @@ Looking for more examples/sample code for Pi Piper? Then check out the following
 * [Project 3: 2-bit counter](https://github.com/jwhitehorn/pi_piper/wiki/Project-3:-2-bit-counter)
 * [Project 4: MCP3008](https://github.com/jwhitehorn/pi_piper/wiki/Project-4:-MCP3008)
 
+## Under the hood
+
+PiPiper use the libbcm2835 library from Mike McCauley at airspayce.
+
+http://www.airspayce.com/mikem/bcm2835/index.html
+
+if you want to upgrade or downgrade the library for compatibility reason, get it and make it a shared object library :
+
+```script
+wget http://www.airspayce.com/mikem/bcm2835/bcm2835-1.49.tar.gz
+tar zxvf bcm2835-1.49.tar.gz && cd bcm2835-1.49
+./configure && make
+sudo make check
+sudo make install
+cd src && cc -shared bcm2835.o -o libbcm2835.so
+cp libbcm2835.so ~/pi_piper/lib/pi_piper
+
 ## License
 
-Copyright (c) 2013, [Jason Whitehorn](https://github.com/jwhitehorn) 
+Copyright (c) 2013, [Jason Whitehorn](https://github.com/jwhitehorn)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/Rakefile

@@ -1,14 +1,24 @@
-require 'rubygems'  
-require 'rake'  
-require 'echoe'  
-  
-Echoe.new('pi_piper', '1.3.2') do |p|  
-  p.description     = "Event driven Raspberry Pi GPIO library"  
-  p.url             = "http://github.com/jwhitehorn/pi_piper"  
-  p.author          = "Jason Whitehorn"  
-  p.email           = "jason.whitehorn@gmail.com"  
-  p.ignore_pattern  = ["examples/**/*"]  
-  p.dependencies = ['ffi']  
-end  
-  
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }  
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'rspec/core/rake_task'
+
+#rake manifest
+#rake build_gemspec
+#gem build pi_piper.gemspec
+#gem push xxx.gem
+
+Echoe.new('pi_piper', '2.0.beta.4') do |p|
+  p.description     = "Event driven Raspberry Pi GPIO library"
+  p.url             = "http://github.com/jwhitehorn/pi_piper"
+  p.author          = "Jason Whitehorn"
+  p.email           = "jason.whitehorn@gmail.com"
+  p.ignore_pattern  = ["examples/**/*", "spec/**/*"]
+  p.dependencies    = ['ffi', 'eventmachine 1.0.3']
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/2_bit_counter/2_bit_counter.rb

@@ -0,0 +1,22 @@
+require 'pi_piper'
+
+puts "Press the switch to get started"
+pin17 = PiPiper::Pin.new(:pin => 17, :direction => :out)
+pin27 = PiPiper::Pin.new(:pin => 27, :direction => :out)
+
+pin17.off
+pin27.off
+
+sum = 0
+
+PiPiper.watch :pin => 22, :trigger => :rising do |pin|
+  sum = sum + 1
+  display = sum % 4
+  puts sum 
+
+  pin17.update_value(display == 2 || display == 3)
+  pin27.update_value(display == 1 || display == 3)
+end
+
+PiPiper.wait
+

data/examples/7-segment/7-segment.rb

@@ -0,0 +1,37 @@
+require 'pi_piper'
+
+s1 = PiPiper::Pin.new(:direction => :out, :pin => 27)
+s2 = PiPiper::Pin.new(:direction => :out, :pin => 24)
+s3 = PiPiper::Pin.new(:direction => :out, :pin => 23)
+s4 = PiPiper::Pin.new(:direction => :out, :pin => 25)
+s5 = PiPiper::Pin.new(:direction => :out, :pin => 18)
+s6 = PiPiper::Pin.new(:direction => :out, :pin => 22)
+s7 = PiPiper::Pin.new(:direction => :out, :pin => 17)
+
+
+pins = [s1, s2, s3, s4, s5, s6, s7]
+
+zero = Proc.new { s1.on; s2.on; s3.on; s4.on; s5.on; s6.on; s7.off; }
+one = Proc.new { s1.off; s2.off; s3.on; s4.on; s5.off; s6.off; s7.off; }
+two = Proc.new { s1.off; s2.on; s3.on; s4.off; s5.on; s6.on; s7.on; }
+three = Proc.new { s1.off; s2.on; s3.on; s4.on; s5.on; s6.off; s7.on; }
+four = Proc.new { s1.on; s2.off; s3.on; s4.on;; s5.off; s6.off; s7.on; }
+five = Proc.new { s1.on; s2.on; s3.off; s4.on; s5.on; s6.off; s7.on; }
+six = Proc.new { s1.on; s2.on; s3.off; s4.on; s5.on; s6.on; s7.on; }
+seven = Proc.new { s1.off; s2.on; s3.on; s4.on; s5.off; s6.off; s7.off; }
+eight = Proc.new { s1.on; s2.on; s3.on; s4.on; s5.on; s6.on; s7.on; }
+nine = Proc.new { s1.on; s2.on; s3.on; s4.on; s5.off; s6.off; s7.on; }
+
+numbers = [zero, one, two, three, four, five, six, seven, eight, nine]
+
+pins.each { |p| p.off }
+
+PiPiper.watch :pin => 4, :trigger => :rising do
+  (0..250).each do
+    pins.each { |p| p.update_value(Random.rand(2) == 1) }
+  end
+  number = Random.rand(10)
+  numbers[number].call
+end
+
+PiPiper.wait

data/examples/dsl_switch/dsl_switch.rb

@@ -0,0 +1,15 @@
+require 'pi_piper'
+include PiPiper
+
+puts "Press the switch to get started"
+
+watch :pin => 17, :invert => true do 
+  puts "Pin changed from #{last_value} to #{value}"
+end
+
+after :pin => 17, :goes => :high do
+  puts "ouch!" 
+end
+
+PiPiper.wait
+

data/examples/mcp3008/mcp3008.rb

@@ -0,0 +1,55 @@
+require 'pi_piper'
+#port of the Adafruit MCP3008 interface code found @ http://learn.adafruit.com/send-raspberry-pi-data-to-cosm/python-script
+
+def read_adc(adc_pin, clockpin, adc_in, adc_out, cspin)
+  cspin.on
+  clockpin.off
+  cspin.off
+  
+  command_out = adc_pin
+  command_out |= 0x18
+  command_out <<= 3
+
+  (0..4).each do
+    adc_in.update_value((command_out & 0x80) > 0)
+    command_out <<= 1
+    clockpin.on
+    clockpin.off
+  end
+  result = 0
+
+  (0..11).each do
+    clockpin.on
+    clockpin.off
+    result <<= 1
+    adc_out.read
+    if adc_out.on?
+      result |= 0x1
+    end
+  end 
+
+  cspin.on
+
+  result >> 1
+end
+  
+clock = PiPiper::Pin.new :pin => 18, :direction => :out
+adc_out = PiPiper::Pin.new :pin => 23
+adc_in = PiPiper::Pin.new :pin => 24, :direction => :out
+cs = PiPiper::Pin.new :pin => 25, :direction => :out
+
+adc_pin = 0
+
+loop do
+  value = read_adc(adc_pin, clock, adc_in, adc_out, cs)
+  invert = 1023 - value
+  mvolts = invert * (3300.0 / 1023.0)
+  if mvolts < 2700
+    temp = (mvolts - 380.0) / (2320.0 / 84.0)
+  else
+    temp = (mvolts - 2700.0) / (390.0 / 92.0) + 84.0
+  end
+  temp_f = (temp * 9.0 / 5.0) + 32
+  puts "Value = #{value}, invert = #{invert}, mvolts = #{mvolts}, temp = #{temp} C | #{temp_f} F"
+  sleep 1
+end

data/examples/mcp3008_spi/mcp3008_spi.rb

@@ -0,0 +1,24 @@
+require 'pi_piper'
+#special thanks to Jeremy Blythe, and his article @ http://jeremyblythe.blogspot.com/2012/09/raspberry-pi-hardware-spi-analog-inputs.html
+#it greatly helped in getting the MCP3008 setup with SPI
+
+adc_num = 0 
+
+loop do
+  value = 0
+  PiPiper::Spi.begin do |spi|
+    raw = spi.write [1, (8+adc_num)<<4, 0] 
+    value = ((raw[1]&3) << 8) + raw[2]
+  end
+
+  invert = 1023 - value
+  mvolts = invert * (3300.0 / 1023.0)
+  if mvolts < 2700
+    temp = (mvolts - 380.0) / (2320.0 / 84.0)
+  else
+    temp = (mvolts - 2700.0) / (390.0 / 92.0) + 84.0
+  end
+  temp_f = (temp * 9.0 / 5.0) + 32
+  puts "Value = #{value}, invert = #{invert}, mvolts = #{mvolts}, temp = #{temp} C | #{temp_f} F"
+  sleep 1
+end

data/examples/morse_code/morse_code.rb

@@ -0,0 +1,43 @@
+require 'pi_piper'
+
+unit = 0.1
+dot = unit
+dash = unit * 3
+inter_element_gap = unit
+short_gap = unit * 3
+medium_gap = unit * 7
+
+#http://en.wikipedia.org/wiki/Morse_code
+character_timing = { "a" => [dot, dash],             "b" => [dash, dot, dot, dot],   "c" => [dash, dot, dash, dot],
+                     "d" => [dash, dot, dot],        "e" => [dot],                   "f" => [dot, dot, dash, dot], 
+                     "g" => [dash, dash, dot],       "h" => [dot, dot, dot, dot],    "i" => [dot, dot],
+                     "j" => [dot, dash, dash, dash], "k" => [dash, dot, dash],       "l" => [dot, dash, dot, dot],
+                     "m" => [dash, dash],            "n" => [dash, dot],             "o" => [dash, dash, dash],
+                     "p" => [dot, dash, dash, dot],  "q" => [dash, dash, dot, dash], "r" => [dot, dash, dot],
+                     "s" => [dot, dot, dot],         "t" => [dash],                  "u" => [dot, dot, dash],
+                     "v" => [dot, dot, dot, dash],   "w" => [dot, dash, dash],       "x" => [dash, dot, dot, dash],
+                     "y" => [dash, dot, dash, dash], "z" => [dash, dash, dot, dot]} 
+
+pin = PiPiper::Pin.new(:pin => 17, :direction => :out)
+pin.off
+
+loop do
+  puts "Please type something"
+  something = gets.chomp.downcase
+
+  something.each_char do |letter|
+    if letter == " "
+      pin.off
+      sleep medium_gap
+    else
+      character_timing[letter].each do |timing| 
+        pin.on
+        sleep timing
+        pin.off
+        sleep inter_element_gap
+      end
+      sleep short_gap - inter_element_gap
+    end
+  end
+
+end