bcm2835 0.0.1

data/.gitignore

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

data/.yardopts

@@ -0,0 +1 @@
+--exclude lib/bcm2835/native.rb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,111 @@
+# Ruby Bindings for [libbcm2835](http://www.open.com.au/mikem/bcm2835/)
+
+The BCM2835 is the ARM11 core used in the Raspberry PI. It exposes several harware peripherals:
+
+- [GPIO](#gpio)
+- [SPI](#spi)
+- [I²C](#i%C2%B2c)
+- [UART](#uart)
+
+This library is a wrapper on top of [libbcm2835](http://www.open.com.au/mikem/bcm2835/) that provides a high level interface for accessing the ARM's hardware features from Ruby
+
+**[View the Full Documentation on rubydoc.info](http://rubydoc.info/github/joshnuss/bcm2835/master/frames)**
+
+## GPIO 
+
+[General Purpose Input/Output](http://en.wikipedia.org/wiki/GPIO) 
+
+### Using Inputs
+```ruby
+pin = 17
+
+# make pin an input
+GPIO.input(pin)
+
+# check if the input is HIGH i.e. true
+puts "door is closed" if GPIO[pin]
+```
+
+### Using Outputs
+```ruby
+pin = 17
+
+# make pin an output
+GPIO.output(pin)
+
+# blink
+loop do
+  GPIO[pin] = true
+  sleep(1)
+  GPIO[pin] = false
+  sleep(1)
+end
+```
+## SPI
+
+[Serial Peripheral Interface](http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus)
+
+### Reading from the SPI bus
+```ruby
+SPI.begin do |spi| 
+  puts spi.read       # returns 1 byte
+  puts spi.read(1024) # returns an array of 1024 bytes 
+end
+```
+
+### Writing to the SPI bus
+```ruby
+SPI.begin do |spi| 
+  spi.write(0x22)           # write 1 byte
+  spi.write("hello")        # write 5 bytes
+  spi.write(0x22,0x45,0x71) # write several bytes at once 
+end
+```
+
+## I²C
+
+[Two Wire Interface](http://en.wikipedia.org/wiki/I²C)
+
+Not yet implemented
+
+## UART
+
+[Universal Asynchronous Receiver/Transmitter](http://en.wikipedia.org/wiki/UART) 
+
+You can use the Ruby Standard Library to read and write from the UART
+
+### Echo Example
+```ruby
+File.open('/dev/ttyAMA0', 'a+') do |file|
+  loop do 
+    data = file.read
+    file.puts(data)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bcm2835'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bcm2835
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+end
+
+task(default: :spec)

data/bcm2835.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bcm2835/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = "Joshua Nussbaum"
+  gem.email         = "joshnuss@gmail.com"
+  gem.description   = %q{Bindings for libbcm2385}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bcm2835"
+  gem.require_paths = ["lib"]
+  gem.version       = Bcm2835::VERSION
+
+	gem.add_dependency "ffi"
+	gem.add_development_dependency "rspec"
+end

data/lib/bcm2835.rb

@@ -0,0 +1,27 @@
+require "bcm2835/version"
+require "bcm2835/native"
+require "bcm2835/gpio"
+require "bcm2835/spi"
+
+# Provides access to library initialization and shutdown
+module Bcm2835
+
+  # Initialize the native library
+  #
+  # @return [Boolean] true if the library was opened successfully
+  def init
+    raise Errno::EACCES.new unless Native.init == 1
+  end
+
+  # Close the native library
+  #
+  # @return [Boolean] true if the library was closed successfully
+  def close
+    Native.close == 1
+  end
+
+  module_function :init, :close
+end
+
+at_exit { Bcm2835.close }
+Bcm2835.init

data/lib/bcm2835/gpio.rb

@@ -0,0 +1,123 @@
+module Bcm2835
+  # Provides access to the CPU's General Purpose I/Os
+  module GPIO
+
+    # Configures the direction of a pin as either an input or an output
+    #
+    # @example
+    #   button_pin = 17
+    #   led_pin = 16
+    #
+    #   GPIO.direction(button_pin, :input)
+    #   GPIO.direction(led_pin,    :output)
+    #
+    # @param [Number] pin the id of the pin
+    # @param [Symbol] mode the direction of the pin, either :input or :output
+    def direction(pin, mode)
+      case mode
+        when :input
+          input(pin)
+        when :output
+          output(pin)
+        else
+          raise ArgumentError.new("Mode #{mode} is invalid. Use :input or :output")
+      end
+    end
+
+    # Configures a pin as input
+    #
+    # @example
+    #   pin = 17
+    #   GPIO.input(pin)
+    #
+    # @param [Number] pin the id of the pin
+    def input(pin)
+      Native.gpio_function(pin, Native::GPIO_FSEL_INPT)
+    end
+
+    # Configures a pin as output
+    #
+    # @example
+    #   pin = 17
+    #   GPIO.output(pin)
+    #
+    # @param [Number] pin the id of the pin
+    def output(pin)
+      Native.gpio_function(pin, Native::GPIO_FSEL_OUTP)
+    end
+
+    # Sets an output pin to HIGH
+    #
+    # @example
+    #   pin = 17
+    #
+    #   GPIO.output(pin)
+    #   GPIO.set(pin) # make pin HIGH
+    #
+    # @param [Number] pin the id of the pin
+    def set(pin)
+      Native.gpio_set(pin)
+    end
+
+    # Clears an output pin to LOW
+    #
+    # @example
+    #   pin = 17
+    #
+    #   GPIO.output(pin)
+    #   GPIO.clear(pin) # make pin LOW
+    #
+    # @param [Number] pin the id of the pin
+    def clear(pin)
+      Native.gpio_clear(pin)
+    end
+
+    # Sets or clears an output pin 
+    #
+    # @example Using indexer (preferred)
+    #   pin = 17
+    #
+    #   GPIO.output(pin)
+    #   GPIO[pin] = true  # make pin HIGH
+    #   GPIO[pin] = false # make pin LOW
+    #
+    # @example Using write
+    #   pin = 17
+    #
+    #   GPIO.output(pin)
+    #   GPIO.write(pin, true)  # make pin HIGH
+    #   GPIO.write(pin, false) # make pin LOW
+    #
+    # @param [Number] pin the id of the pin
+    # @param [Boolean] value true sets the pin HIGH, false sets the pin LOW
+    def write(pin, value)
+      value ? set(pin) : clear(pin)
+    end
+
+    alias :[]= :write
+
+    # Reads an input pin 
+    #
+    # @example Using indexer (preferred)
+    #   pin = 17
+    #
+    #   GPIO.input(pin)
+    #   puts GPIO[pin]
+    #
+    # @example Using read
+    #   pin = 17
+    #
+    #   GPIO.input(pin)
+    #   puts GPIO.read(pin)
+    #
+    # @param [Number] pin the id of the pin
+    # @return [Boolean] true if the pin is HIGH, false if the pin is LOW
+    def read(pin)
+      Native.gpio_level(pin) == Native::HIGH
+    end
+
+    alias :[] :read
+
+    module_function :direction, :input, :output, :set, :clear, :read, :write, :[], :[]=
+  end
+end

data/lib/bcm2835/native.rb

@@ -0,0 +1,38 @@
+require 'ffi'
+
+module Bcm2835
+  module Native
+    extend FFI::Library
+    ffi_lib '/usr/local/lib/libbcm2835.so'
+
+    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
+
+    LOW  = 0
+    HIGH = 1
+    
+    attach_function :init,          :bcm2835_init,      [], :uint8
+    attach_function :close,         :bcm2835_close,     [], :uint8
+
+    attach_function :gpio_function, :bcm2835_gpio_fsel, [:uint8, :uint8], :void
+    attach_function :gpio_set,      :bcm2835_gpio_set,  [:uint8], :void
+    attach_function :gpio_clear,    :bcm2835_gpio_clr,  [:uint8], :void
+    attach_function :gpio_level,    :bcm2835_gpio_lev,  [:uint8], :uint8
+
+    attach_function :spi_begin,       :bcm2835_spi_begin,            [], :uint8
+    attach_function :spi_end,         :bcm2835_spi_end,              [], :uint8
+    attach_function :spi_transfer,    :bcm2835_spi_transfer,       [:uint8], :uint8
+    attach_function :spi_clock,       :bcm2835_spi_setClockDivider,  [:uint8], :void
+    attach_function :spi_bit_order,   :bcm2835_spi_setBitOrder,      [:uint8], :void
+    attach_function :spi_chip_select, :bcm2835_spi_chipSelect,       [:uint8], :void
+    attach_function :spi_chip_select_polarity, 
+                    :bcm2835_spi_setChipSelectPolarity,              [:uint8, :uint8], :void
+  end
+end

data/lib/bcm2835/spi.rb

@@ -0,0 +1,245 @@
+module Bcm2835
+  # Provides access to the Serial Peripheral Interface Bus
+  class SPI
+    # 65536 = 256us = 4kHz
+    CLOCK_DIVIDER_65536 = 0
+    # 32768 = 126us = 8kHz
+    CLOCK_DIVIDER_32768 = 32768
+    # 16384 = 64us = 15.625kHz
+    CLOCK_DIVIDER_16384 = 16384
+    # 8192 = 32us = 31.25kHz
+    CLOCK_DIVIDER_8192  = 8192
+    # 4096 = 16us = 62.5kHz
+    CLOCK_DIVIDER_4096  = 4096
+    # 2048 = 8us = 125kHz
+    CLOCK_DIVIDER_2048  = 2048
+    # 1024 = 4us = 250kHz
+    CLOCK_DIVIDER_1024  = 1024
+    # 512 = 2us = 500kHz
+    CLOCK_DIVIDER_512   = 512
+    # 256 = 1us = 1MHz
+    CLOCK_DIVIDER_256   = 256
+    # 128 = 500ns = = 2MHz
+    CLOCK_DIVIDER_128   = 128
+    # 64 = 250ns = 4MHz
+    CLOCK_DIVIDER_64    = 64
+    # 32 = 125ns = 8MHz
+    CLOCK_DIVIDER_32    = 32
+    # 16 = 50ns = 20MHz
+    CLOCK_DIVIDER_16    = 16
+
+    # Least signifigant bit first, e.g. 4 = 0b001
+    LSBFIRST = 0
+    # Most signifigant bit first, e.g. 4 = 0b100
+    MSBFIRST = 1
+
+    # Select Chip 0
+    CHIP_SELECT_0 = 0
+    # Select Chip 1
+    CHIP_SELECT_1 = 1
+    # Select both chips (ie pins CS1 and CS2 are asserted)
+    CHIP_SELECT_BOTH = 2
+    # No CS, control it yourself
+    CHIP_SELECT_NONE = 3
+
+    # Initializes SPI, must be called before SPI can be used
+    #
+    # @example With a block
+    #   SPI.begin do |spi| 
+    #     spi.write 1
+    #   end
+    #
+    # @example Without a block
+    #   spi = SPI.begin
+    #   spi.write 1
+    #   spi.end # must call end yourself
+    #
+    # @example Specifying the chip select line
+    #   SPI.begin(SPI::CHIP_SELECT_1) do |spi|
+    #     spi.write 1
+    #   end
+    #
+    # @yield [SPI] 
+    # @param [optional, CHIP_SELECT_*] chip defaults to CHIP_SELECT_0
+    # @return [SPI] 
+    def self.begin(chip=nil)
+      Native.spi_begin
+      chip = CHIP_SELECT_0 if !chip && block_given?
+      spi = new(chip)
+
+      if block_given?
+        begin
+          yield(spi)
+        ensure
+          self.end
+        end
+      else
+        spi
+      end
+    end
+
+    # Manually shut down SPI
+    #
+    # Not needed when #begin is called with a block
+    def self.end
+      Native.spi_end
+    end
+
+    # Configure the clock prescaler
+    # 
+    # Default is CLOCK_DIVIDER_65536 (4kHz)
+    #
+    # @example Run SPI at 2MHz
+    #   spi.clock(SPI::CLOCK_DIVIDER_128)
+    #
+    # @param [CLOCK_DIVIDER_*] divider the value to prescale the clock by
+    def clock(divider)
+      Native.spi_clock(divider)
+    end
+
+    # Configure the order that bits are sent and received from the bus
+    #
+    # @example Most signifigant bit first
+    #   spi.bit_order(7..0)
+    #   # or
+    #   spi.bit_order(SPI::MSBFIRST)
+    #
+    # @example Least signifigant bit first
+    #   spi.bit_order(0..7)
+    #   # or
+    #   spi.bit_order(SPI::LSBFIRST)
+    #
+    # @param [Range|LSBFIRST|MSBFIRST] order
+    def bit_order(order=MSBFIRST)
+      if order.is_a?(Range)  
+        if order.begin < order.end
+          order = LSBFIRST
+        else
+          order = MSBFIRST
+        end
+      end
+
+      Native.spi_bit_order(order)
+    end
+
+    # Activate a specific chip so that communication can begin
+    #
+    # When a block is provided, the chip is automatically deactivated after the block completes.
+    # When a block is not provided, the user is responsible for calling chip_select(CHIP_SELECT_NONE) 
+    #
+    # @example With block (preferred)
+    #   spi.chip_select do
+    #     spi.write(0xFF)
+    #   end
+    #
+    # @example Without block
+    #   spi.chip_select(CHIP_SELECT_0)
+    #   spi.write(0xFF)
+    #   spi.write(0x22)
+    #   spi.chip_select(CHIP_SELECT_NONE)
+    #
+    # @yield 
+    # @param [optional, CHIP_SELECT_*] chip the chip select line options
+    def chip_select(chip=CHIP_SELECT_0)
+      chip = @chip if @chip 
+      Native.spi_chip_select(chip) 
+      if block_given?
+        begin
+          yield
+        ensure
+          Native.spi_chip_select(CHIP_SELECT_NONE)
+        end
+      end
+    end
+
+    # Configure the active state of the chip select line
+    #
+    # The default state for most chips is active low.
+    #
+    # "active low" means the clock line is kept high during idle, and goes low when communicating.
+    #
+    # "active high" means the clock line is kept low during idle, and goes high when communicating.
+    #
+    # @param [Boolean] active_low true for active low, false for active high 
+    # @param [optional, CHIP_SELECT_*] chip one of CHIP_SELECT_*
+    def chip_select_active_low(active_low, chip=nil)
+      chip = @chip if @chip
+      chip = CHIP_SELECT_0 unless chip
+
+      Native.spi_chip_select_polarity(chip, active_low ? Native::LOW : Native::HIGH)
+    end
+
+    # Read from the bus
+    #
+    # @example Read a single byte
+    #   byte = spi.read
+    #
+    # @example Read array of bytes
+    #   array = spi.read(3)
+    #
+    #
+    # @param [optional, Number] count the number of bytes to read. 
+    #   When count is provided, an array is returned.
+    #   When count is nil, a single byte is returned.
+    # @return [Number|Array] data that was read from the bus
+    def read(count=nil)
+      if count
+        write([0xFF] * count)
+      else
+        enable { Native.spi_transfer(0) }
+      end
+    end
+
+    # Write to the bus
+    #
+    # @example Write a single byte
+    #   spi.write(0x22)
+    #
+    # @example Write multiple bytes
+    #   spi.write(0x22, 0x33, 0x44)
+    #
+    # @example Write a string
+    #   spi.write("Hello SPI!")
+    #
+    # @example Write any enumerable
+    #   spi.write(30..40)
+    #
+    # @return [Number|Array|String] data that came out of MISO during write
+    def write(*args)
+      case args.count
+        when 0
+          raise ArgumentError.new("missing arguments")
+        when 1
+          data = args.first
+        else
+          data = args
+      end
+
+      enable do
+        case data
+        when Numeric
+          Native.spi_transfer(data)
+        when String
+          data.each_byte.map {|byte| Native.spi_transfer(byte).chr }.join 
+        when Enumerable
+          data.map {|byte| Native.spi_transfer(byte) }
+        else
+          raise ArgumentError.new("#{data.class} is not valid data. User Numeric, String or an Enumerable of numbers")
+        end
+      end
+    end
+
+  private
+    def initialize(chip)
+      @chip = chip
+    end
+
+    def enable(&block)
+      if @chip
+        chip_select(&block)
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/bcm2835/version.rb

@@ -0,0 +1,3 @@
+module Bcm2835
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: bcm2835
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Nussbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bindings for libbcm2385
+email: joshnuss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bcm2835.gemspec
+- lib/bcm2835.rb
+- lib/bcm2835/gpio.rb
+- lib/bcm2835/native.rb
+- lib/bcm2835/spi.rb
+- lib/bcm2835/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []
+has_rdoc: