pi_piper 2.0.beta.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4db33bd67174aa5889959cf3eddcb2e8b7a6ac7e
-  data.tar.gz: 2a9d53cc16b42c4642f99f15cfaa5600a990cd96
+  metadata.gz: ffd03a04567c42e342dab56e8e0630f39c6bf210
+  data.tar.gz: f15579a5bf7b6de3b764046b69a6fbf879c64b7e
 SHA512:
-  metadata.gz: 33caeb1cc9c76871be9c7ea6c49bf2f738eff563bac9bc41bbb5febfbaeb6161a1bb3740cfa15b673f92da2b299a601a332fbd717481706fe6e2534a23d0987c
-  data.tar.gz: 3feece4a4633c52ad6ea15c6acbfd596cdc2ab1ee5c558002c2e934682f985a73419e2d9a861387a25a142438134d9b06386d1a9f724f87f824d6cdff8cb9943
+  metadata.gz: 64ac8f84c2c77027d832e1654af96a09da38c373162b94aa289448f2904e0683e889cf1712906297f7d518b8cfa5bf56edd68f54698bd226f9e0a2c11d9e1dc5
+  data.tar.gz: 61049ba1ab09545ac764980170d3c3e154b1127cfa5a23a1b688a60fcf294f9f2429da5a36ecd4583024674f9a26b1e237f81fddcf7d8e73e11b4fe58c202a99

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,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+
+before_install:
+  - gem install bundler
+  - gem update

data/Gemfile

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

data/Gemfile.lock

@@ -1,37 +1,50 @@
+PATH
+  remote: .
+  specs:
+    pi_piper (1.9.9)
+      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.3)
-    ffi (1.4.0)
-    gemcutter (0.7.1)
-    json_pure (1.7.7)
-    rake (10.0.3)
-    rdoc (4.0.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
+    eventmachine (1.0.9)
+    ffi (1.9.0)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    rake (10.1.0)
+    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)
+    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.3)
+  eventmachine (~> 1.0.9)
   ffi
+  mocha
+  pi_piper!
   rake
-  rspec
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.11.2

data/LICENCE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2013-2016,  Jason Whitehorn, Zshawn Syed and contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -2,15 +2,15 @@
 
 [![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, 
+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
-    
+
+    sudo apt-get install ruby ruby1.9.1-dev libssl-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:
@@ -40,7 +40,7 @@ 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 
+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.
 
@@ -51,7 +51,7 @@ You can set resistors when creating a pin passing a :pull parameter
 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
+This way, the pin will always return 'on' if it is unconnected or if the
 sensor has an open collector output.
 
 You can later alter the pulling resistors using PiPiper#pull!
@@ -65,15 +65,44 @@ 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
+
+### Pulse Width Modulation (PWM)
+
+what is it !? https://en.wikipedia.org/wiki/Pulse-width_modulation
+
+PiPiper allow to use the hardware PWM channel of the bcm2835.....
+value should be between 0 and 1, clock between 0 and 19.2MHz, mode blaanced or markspace and range something greater than 0.
+Supported pin are : 12, 13, 18, 19, 40, 41, 45, 52, 53
+but only 18 is on the header..
+
+```ruby
+pwm = PiPiper::Pwm.new pin: 18 #, range: 1024, clock: 19.2.megahertz, mode: :markspace, value: 1, start: false
+pwm.value= 0.5
+pwm.off # works with stop
+pwm.on  # aliased start
+```
+
+apparently the clock is rounded to the next 2^n divider of 19.2MHz
+
 ## Documentation
 
 API documentation for Pi Piper can be found at [rdoc.info](http://rdoc.info/github/jwhitehorn/pi_piper/frames/).
@@ -87,19 +116,27 @@ 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)
 
-## License
+## Under the hood
 
-Copyright (c) 2013, [Jason Whitehorn](https://github.com/jwhitehorn) 
-All rights reserved.
+PiPiper use the libbcm2835 library from Mike McCauley at airspayce. (distributed with Open Source Licensing GPL V2)
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+http://www.airspayce.com/mikem/bcm2835/index.html
 
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+if you want to upgrade or downgrade the library for compatibility reason, get it and make it a shared object library :
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```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
 
+Distributed in accordance with the BSD licence, see LICENCE.md file.
 
 ***
 <img src="http://www.raspberrypi.org/wp-content/uploads/2012/03/Raspi_Colour_R.png" width="90" />

data/Rakefile

@@ -1,24 +1,6 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
-require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-#rake manifest
-#rake build_gemspec
-#gem build pi_piper.gemspec
-#gem push xxx.gem
+RSpec::Core::RakeTask.new(:spec)
 
-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 }
-
-Rake::TestTask.new do |t|
-    t.pattern = 'spec/**/*_spec.rb'
-end
+task :default => :spec

data/examples/2_bit_counter/2_bit_counter.rb

@@ -0,0 +1,21 @@
+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 += 1
+  puts sum 
+
+  # get single bits of sum
+  pin17.update_value(sum & 0b01 == 0b01) 
+  pin27.update_value(sum & 0b10 == 0b10)
+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/elro/README.md

@@ -0,0 +1,75 @@
+# Project: Elro-Switches
+
+In this sample project, we want to be able to use our RaspberryPi to switch the lights on and off. 
+We will be using 
+
+* a Elro-RF-Remote-Switch, which operates at 433 MHz
+* a little RF-Link-Transmitter, to send the signals
+* some code that knows how to send the correct signals
+
+## Elro Switch
+
+First we need a RF-remote-switch. Here in Europe Elro sells a lot of [these things](https://www.google.de/search?q=elro+ab440). We will be using a switch from the ab440-series, since they have dip-switches on the back, which will be used to specify a `key` and a `device` (think of it as IDs to select which lights to switch). Both will be parameters to our script.
+
+![elro switch](docs/elro-switch.jpg)
+![elro dips](docs/elro-dips.jpg)
+
+This switch will be connected to an outlet and to a lamp (or what ever you want to switch).
+
+![elro dips](docs/setup.jpg)
+
+
+## RF Link Transmitter
+
+To send signals from our RaspberryPi to the remote switch, we will be using a RF Link Transmitter that goes by the name `WRL-10534`. These can be [purchased](https://www.google.de/search?q=wrl10534) for little money.
+
+![wrl10534](docs/wrl10534.jpg)
+
+This little guy sports four pins: `GND`, `Data in`, `Vcc` and `ANT`.
+
+## Wire Plan
+
+Wiring up the rf transmitter is no big deal.
+
+![wire plan](docs/wireplan.jpg)
+
+
+## Code
+
+To send the signals we will be using the great pi-piper interface to the raspberry's GPIO. 
+
+Since the elro-switches are triggered through quite complex sequences (*1280 signals for one switch*) we will be using a little library called `ElroSwitch` that calculates and sends these sequences via a pi-piper pin.
+
+```ruby
+device = [1,0,0,0,0] # according to the dip-switches
+key    = [0,0,0,0,1] # according to the dip-switches
+
+pin = PiPiper::Pin.new(:pin => 17, :direction => :out)
+elro = ElroSwitch.new(device, key, pin)
+
+elro.switch(true) # switch on
+elro.switch(false) # switch off
+```
+
+## Warning
+
+The Raspberry is not build to be the fastest hardware in the world.
+Ruby (MRI) is not fastest programming language (but still the best).
+The Elro Switch expects the 1280 signals for each switch-event to be 
+transmitted with a frequency of 300 microseconds (but as I have observed
+will still operate while using frequencies from ≈100 to ≈600 microseconds
+per signal).
+
+This implementation (using PiPiper) reaches a frequency of around 
+500 microseconds on an RaspberryPi without any wait or sleep.
+
+Other implementation (in python or C) need to time their signals to
+not be too fast.
+
+Keep that in mind, if this code will run on faster hardware or faster Rubies.
+
+## Credits
+
+The `ElroSwitch` library is mostly a (heavily refactored) port from [this python script](http://pastebin.com/aRipYrZ6) by Heiko H., 
+which is a port from a [C++ snippet](http://www.jer00n.nl/433send.cpp) written by J. Lukas,
+and influenced by this [Arduino source](http://gathering.tweakers.net/forum/view_message/34919677) code written by Piepersnijder.