pi_piper 2.0.beta.4 → 2.0.0

data/lib/pi_piper/i2c.rb

@@ -28,7 +28,6 @@ module PiPiper
 
     def self.clock=(clock)
       valid_clocks = Platform.driver.i2c_allowed_clocks
-
       raise "Invalid clock rate. Valid clocks are 100 kHz, 399.3610 kHz, 1.666 MHz and 1.689 MHz" unless valid_clocks.include? clock
 
       Platform.driver.i2c_set_clock clock

data/lib/pi_piper/pin.rb

@@ -1,72 +1,114 @@
+require_relative 'pin_values'
+
 module PiPiper
   # Represents a GPIO pin on the Raspberry Pi
   class Pin
-    GPIO_PUD_OFF = 0
-    GPIO_PUD_DOWN = 1
-    GPIO_PUD_UP = 2
+    include PiPiper::PinValues
 
-    attr_reader :pin, :last_value, :value, :direction, :invert
+    attr_reader :pin, :last_value, :direction, :invert
 
     #Initializes a new GPIO pin.
     #
     # @param [Hash] options A hash of options
     # @option options [Fixnum] :pin The pin 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 pin 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.
-    # @option options [Symbol] :pull Indicates if and how pull mode must be set when pin direction is set to :in. Either :up, :down or :offing. Defaults to :off.
+    # 
+    # @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 pin 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.
+    # 
+    # @option options [Symbol] :pull Indicates if and how pull mode must be 
+    # set when pin direction is set to :in. Either :up, :down or :offing. 
+    # Defaults to :off.
+    #
     def initialize(options)
-      options = {:direction => :in, :invert => false, :trigger => :both, :pull => :off}.merge options
-      @pin = options[:pin]
-      @direction = options[:direction]
-      @invert = options[:invert]
-      @trigger = options[:trigger]
-      @pull = options[:pull]
+      options = { :direction => :in,
+                  :invert => false,
+                  :trigger => :both,
+                  :pull => :off }.merge(options)
 
-      raise "Invalid pull mode. Options are :up, :down or :float (default)" unless [:up, :down, :float, :off].include? @pull
-      raise "Unable to use pull-ups : pin direction must be ':in' for this" if @direction != :in && [:up, :down].include?(@pull)
-      raise "Invalid direction. Options are :in or :out" unless [:in, :out].include? @direction
-      raise "Invalid trigger. Options are :rising, :falling, or :both" unless [:rising, :falling, :both].include? @trigger
+      @pin       = options[:pin]
+      @direction = options[:direction]
+      @invert    = options[:invert]
+      @trigger   = options[:trigger]
+      @pull      = options[:pull]
 
-      @direction == :out ? Platform.driver.pin_output(@pin) : Platform.driver.pin_input(@pin)
+      raise ArgumentError, 'Pin # required' unless @pin
+      unless valid_pull?
+        raise PiPiper::PinError, 'Invalid pull mode. Options are :up, :down or :float (default)'
+      end
+      unless valid_direction?
+        raise PiPiper::PinError, 'Invalid direction. Options are :in or :out'
+      end
+      if @direction != :in && [:up, :down].include?(@pull)
+        raise PiPiper::PinError, 'Unable to use pull-ups : pin direction must be :in for this'
+      end
+      unless valid_trigger?
+        raise PiPiper::PinError, 'Invalid trigger. Options are :rising, :falling, or :both'
+      end
 
+      if @direction == :out
+        Platform.driver.pin_output(@pin)
+      else
+        Platform.driver.pin_input(@pin)
+      end
       pull!(@pull)
 
       read
     end
-    
-    # If the pin has been initialized for output this method will set the logic level high.
+
+    # If the pin has been initialized for output this method will set the 
+    # logic level high.
     def on
-      Platform.driver.pin_set(pin, 1) if direction == :out
+      Platform.driver.pin_set(pin, GPIO_HIGH) if direction == :out
     end
-    
+
     # Tests if the logic level is high.
     def on?
       not off?
     end
-    
-    # If the pin has been initialized for output this method will set the logic level low.
+
+    # If the pin has been initialized for output this method will set 
+    # the logic level low.
     def off
-      Platform.driver.pin_set(pin, 0) if direction == :out
+      Platform.driver.pin_set(pin, GPIO_LOW) if direction == :out
     end
-    
+
     # Tests if the logic level is low.
     def off?
-      value == 0
+      value == GPIO_LOW
     end
 
-    # If the pin has been initialized for output this method will either raise or lower the logic level depending on `new_value`.
+    def value
+      @value ||= read
+    end
+
+    # If the pin 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 pin will be set to off, otherwise on.
     def update_value(new_value)
-      !new_value || new_value == 0 ? off : on
+      !new_value || new_value == GPIO_LOW ? off : on
     end
+    alias_method :value=, :update_value
 
-    # When the pin has been initialized in input mode, internal resistors can be pulled up or down (respectively with :up and :down).
-    # Pulling an input pin wil prevent noise from triggering it when the input is floating. 
-    # For instance when nothing is plugged in, pulling the pin-up will make subsequent value readings to return 'on' (or high, or 1...).
-    # @param [Symbol] state Indicates if and how pull mode must be set when pin direction is set to :in. Either :up, :down or :offing. Defaults to :off.
+    # When the pin has been initialized in input mode, internal resistors can 
+    # be pulled up or down (respectively with :up and :down).
+    # 
+    # Pulling an input pin will prevent noise from triggering it when the input
+    # is floating.
+    # 
+    # For instance when nothing is plugged in, pulling the pin-up will make 
+    # subsequent value readings to return 'on' (or high, or 1...).
+    # @param [Symbol] state Indicates if and how pull mode must be set when 
+    # pin direction is set to :in. Either :up, :down or :offing. Defaults to :off.
     def pull!(state)
-      return nil unless @direction == :in
+     raise PiPiper::PinError, "Unable to use pull-ups : pin direction must be ':in' for this" if 
+        @direction != :in and [:up, :down].include?(state)
       @pull = case state
               when :up then GPIO_PUD_UP
               when :down then GPIO_PUD_DOWN
@@ -79,7 +121,8 @@ module PiPiper
       @pull
     end
 
-    # If the pin direction is input, it will return the current state of pull-up/pull-down resistor, either :up, :down or :off.
+    # If the pin direction is input, it will return the current state of 
+    # pull-up/pull-down resistor, either :up, :down or :off.
     def pull?
       case @pull
       when GPIO_PUD_UP then :up
@@ -93,42 +136,38 @@ module PiPiper
       last_value != value
     end
 
-    # blocks until a logic level change occurs. The initializer option `:trigger` modifies what edge this method will release on.
+    # Blocks until a logic level change occurs. The initializer option 
+    # `:trigger` modifies what edge this method will release on.
     def wait_for_change
-      fd = File.open(value_file, "r")
-      File.open(edge_file, "w") { |f| f.write("both") }
-      loop do
-        fd.read
-        IO.select(nil, nil, [fd], nil)
-        read 
-        if changed?
-          next if @trigger == :rising and value == 0
-          next if @trigger == :falling and value == 1
-          break
-        end
-      end
+      Platform.driver.pin_wait_for(@pin, @trigger)
     end
-
-    # Reads the current value from the pin. Without calling this method first, `value`, `last_value` and `changed?` will not be updated. 
-    # In short, you must call this method if you are curious about the current state of the pin.
-    def read 
-      @last_value = @value
+    
+    # Reads the current value from the pin. Without calling this method 
+    # first, `value`, `last_value` and `changed?` will not be updated.
+    # 
+    # In short, you must call this method if you are curious about the 
+    # current state of the pin.
+    def read
       val = Platform.driver.pin_read(@pin)
+      @last_value = @value
       @value = invert ? (val ^ 1) : val
     end
-    
-    private
-    def value_file
-      "/sys/class/gpio/gpio#{pin}/value"
+
+  private
+    def method_missing(method, *args, &block)
+      Platform.driver.send(method, @pin, *args, &block)
+		end
+		
+    def valid_trigger?
+      [:rising, :falling, :both].include?(@trigger)
     end
 
-    def edge_file
-      "/sys/class/gpio/gpio#{pin}/edge"
+    def valid_direction?
+      [:in, :out].include?(@direction)
     end
 
-    def direction_file
-      "/sys/class/gpio/gpio#{pin}/direction"
+    def valid_pull?
+      [:up, :down, :float, :off].include? @pull
     end
-  
   end
 end

data/lib/pi_piper/pin_error.rb

@@ -0,0 +1,3 @@
+module PiPiper
+  class PinError < StandardError; end
+end

data/lib/pi_piper/pin_values.rb

@@ -0,0 +1,35 @@
+module PiPiper
+  module PinValues
+    GPIO_PUD_OFF = 0
+    GPIO_PUD_DOWN = 1
+    GPIO_PUD_UP = 2
+
+    GPIO_HIGH = 1
+    GPIO_LOW  = 0
+
+    GPIO_FSEL_INPT = 0b000
+    GPIO_FSEL_OUTP = 0b001
+    GPIO_FSEL_ALT0 = 0b100
+    GPIO_FSEL_ALT1 = 0b101
+    GPIO_FSEL_ALT2 = 0b110
+    GPIO_FSEL_ALT3 = 0b111
+    GPIO_FSEL_ALT4 = 0b011
+    GPIO_FSEL_ALT5 = 0b010
+    GPIO_FSEL_MASK = 0b111
+
+
+    PWM_PIN = {
+        12 => {:channel => 0, :alt_fun => GPIO_FSEL_ALT0},
+        13 => {:channel => 1, :alt_fun => GPIO_FSEL_ALT0},
+        18 => {:channel => 0, :alt_fun => GPIO_FSEL_ALT5},
+        19 => {:channel => 1, :alt_fun => GPIO_FSEL_ALT5},
+        40 => {:channel => 0, :alt_fun => GPIO_FSEL_ALT0},
+        41 => {:channel => 1, :alt_fun => GPIO_FSEL_ALT0},
+        45 => {:channel => 1, :alt_fun => GPIO_FSEL_ALT0},
+        52 => {:channel => 0, :alt_fun => GPIO_FSEL_ALT1},
+        53 => {:channel => 1, :alt_fun => GPIO_FSEL_ALT1}
+    }
+
+    PWM_MODE = [:balanced, :markspace]
+  end
+end

data/lib/pi_piper/platform.rb

@@ -1,4 +1,3 @@
-#require 'bcm2835.rb'
 module PiPiper
 
   #Hardware abstraction manager. Not intended for direct use.
@@ -8,10 +7,13 @@ module PiPiper
     #gets the current platform driver. Defaults to BCM2835.
     def self.driver
       unless @@driver
-        #require 'bcm2835.rb'
+        require 'pi_piper/bcm2835'
         PiPiper::Bcm2835.init
         @@driver = PiPiper::Bcm2835
-        at_exit { Bcm2835.close }
+        at_exit do
+          Bcm2835.unexport_all
+          Bcm2835.close
+        end
       end
       @@driver
     end
@@ -19,7 +21,5 @@ module PiPiper
     def self.driver=(instance)
       @@driver = instance
     end
-
   end
-
 end

data/lib/pi_piper/pwm.rb

@@ -0,0 +1,95 @@
+require_relative 'pin_values'
+
+module PiPiper
+  
+  # Represents a Pwm output on the Raspberry Pi (only GPIO18 is avaliable on header)
+  class Pwm
+    include PiPiper::PinValues
+
+    attr_reader :value, :options
+    
+    # Initializes a new PWM pin.
+    #
+    # @param [Hash] options A hash of options
+    # @option options [Fixnum] :pin The pin number to initialize. Required.
+    def initialize(options)
+      @options = {
+        :mode => :balanced,
+        :clock => 19.2.megahertz,
+        :range => 1024,
+        :start => true,
+        :value => 0
+      }.merge(options)
+
+      unless PWM_PIN[@options[:pin]]
+        raise ArgumentError, ":pin should be one of  #{PWM_PIN.keys} not #{@options[:pin]}"
+      end
+
+      unless PWM_MODE.include? @options[:mode]
+        raise ArgumentError, ":mode should be one of #{PWM_MODE}, not #{@options[:mode]}"
+      end
+
+      self.value= @options.delete(:value)
+      self.pin=   @options[:pin]
+      self.range= @options[:range]
+      self.clock= @options[:clock]
+
+      @options.delete(:start) ? self.on : self.off
+    end
+
+    # Start the Pwm signal
+    def on
+      @on = true
+      Platform.driver.pwm_mode(PWM_PIN[@options[:pin]][:channel], PWM_MODE.index(options[:mode]), 1)
+    end
+    
+    alias :start :on
+
+    # Stop the Pwm signal
+    def off
+      @on = false
+      Platform.driver.pwm_mode(PWM_PIN[@options[:pin]][:channel], PWM_MODE.index(options[:mode]), 0)
+    end
+
+    alias :stop :off
+
+    def on?
+      @on
+    end
+
+    def off?
+      not on?
+    end
+
+    def value=(new_value)
+      @value = sanitize_value(new_value)
+      Platform.driver.pwm_data(PWM_PIN[@options[:pin]][:channel], data(@value))
+    end
+
+    private
+
+    def range=(range)
+      Platform.driver.pwm_range(PWM_PIN[@options[:pin]][:channel], range)
+    end
+
+    def clock=(clock)
+      Platform.driver.pwm_clock(get_clock_divider(clock))
+    end
+
+    def pin=(bcm_pin_number)
+      Platform.driver.gpio_select_function(bcm_pin_number, PWM_PIN[@options[:pin]][:alt_fun])
+    end
+
+    def get_clock_divider(clock)
+      (19.2.megahertz.to_f / clock).to_i
+    end
+
+    def data(sanitized_value)
+      (sanitized_value * @options[:range]).to_i
+    end
+
+    def sanitize_value(raw_value)
+      [0, [raw_value, 1].min ].max
+    end
+  end
+end

data/lib/pi_piper/spi.rb

@@ -1,36 +1,3 @@
-#--
-#Modifications Copyright 2013, Jason Whitehorn and released under the terms
-#of the license included in README.md
-#
-#Based on works, Copyright (c) 2012 Joshua Nussbaum
-#
-#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.
-#++
-
-
-
-
-
 module PiPiper
   # class for SPI interfaces on the Raspberry Pi
   class Spi
@@ -48,18 +15,24 @@ module PiPiper
     # No CS, control it yourself
     CHIP_SELECT_NONE = 3
 
+    # SPI Modes
+    SPI_MODE0 = 0
+    SPI_MODE1 = 1
+    SPI_MODE2 = 2
+    SPI_MODE3 = 3 
+
     #Sets the SPI mode. Defaults to mode (0,0).
     def self.set_mode(cpol, cpha)
       mode = SPI_MODE0 #default
       mode = SPI_MODE1 if cpol == 0 and cpha == 1
       mode = SPI_MODE2 if cpol == 1 and cpha == 0
       mode = SPI_MODE3 if cpol == 1 and cpha == 1
-      Bcm2835.spi_set_data_mode mode
+      Platform.driver.spi_set_data_mode mode
     end
 
     #Begin an SPI block. All SPI communications should be wrapped in a block.
     def self.begin(chip=nil, &block)
-      Bcm2835.spi_begin
+      Platform.driver.spi_begin
       chip = CHIP_SELECT_0 if !chip && block_given?
       spi = new(chip)
 
@@ -72,7 +45,19 @@ module PiPiper
 
     # Not needed when #begin is called with a block
     def self.end
-      Bcm2835.spi_end
+      Platform.driver.spi_end
+    end
+
+    # Uses /dev/spidev0.0 to write to the SPI
+    # NOTE: Requires that you have /dev/spidev0.0
+    #  see: http://learn.adafruit.com/adafruit-raspberry-pi-educational-linux-distro/overview
+    #  most likely requires `chmod 666 /dev/spidev0.0`
+    #
+    # @example Writing red, green, blue to a string of WS2801 pixels
+    #   PiPiper::Spi.spidev_out([255,0,0,0,255,0,0,0,255])
+    #
+    def self.spidev_out(array)
+      Platform.driver.spidev_out(array)
     end
 
     # Sets the SPI clock frequency
@@ -92,7 +77,7 @@ module PiPiper
                  20000000 => 16      #20 MHz
                }
       divider = options[frequency]
-      Bcm2835.spi_clock(divider)
+      Platform.driver.spi_clock(divider)
     end
 
     def bit_order(order=MSBFIRST)
@@ -104,7 +89,7 @@ module PiPiper
         end
       end
 
-      Bcm2835.spi_bit_order(order)
+      Platform.driver.spi_bit_order(order)
     end
 
     # Activate a specific chip so that communication can begin
@@ -126,13 +111,13 @@ module PiPiper
     # @yield 
     # @param [optional, CHIP_SELECT_*] chip the chip select line options
     def chip_select(chip=CHIP_SELECT_0)
-      chip = @chip if @chip 
-      Bcm2835.spi_chip_select(chip) 
+      chip = @chip if @chip
+      Platform.driver.spi_chip_select(chip) 
       if block_given?
         begin
           yield
         ensure
-          Bcm2835.spi_chip_select(CHIP_SELECT_NONE)
+          Platform.driver.spi_chip_select(CHIP_SELECT_NONE)
         end
       end
     end
@@ -151,7 +136,7 @@ module PiPiper
       chip = @chip if @chip
       chip = CHIP_SELECT_0 unless chip
 
-      Bcm2835.spi_chip_select_polarity(chip, active_low ? 0 : 1)
+      Platform.driver.spi_chip_select_polarity(chip, active_low ? 0 : 1)
     end
 
     # Read from the bus
@@ -171,7 +156,7 @@ module PiPiper
       if count
         write([0xFF] * count)
       else
-        enable { Bcm2835.spi_transfer(0) }
+        enable { Platform.driver.spi_transfer(0) }
       end
     end
 
@@ -197,9 +182,9 @@ module PiPiper
       enable do
         case data
         when Numeric
-          Bcm2835.spi_transfer(data)
+          Platform.driver.spi_transfer(data)
         when Enumerable
-          Bcm2835.spi_transfer_bytes(data)
+          Platform.driver.spi_transfer_bytes(data)
         else
           raise ArgumentError.new("#{data.class} is not valid data. Use Numeric or an Enumerable of numbers")
         end