bucaneer 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Josh Bassett
+
+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,5 @@
+# Bucaneer
+
+## Introduction
+
+Bucaneer is a Ruby library which allows you to control your BusPirate bitbang modes (I2C, SPI, etc).

data/lib/bucaneer/alone.rb

@@ -0,0 +1,14 @@
+rc = "#{ENV['HOME']}/.rubyrc"
+load(rc) if File.exist?(rc)
+
+require 'rubygems'
+require 'bundler'
+
+envs = [:default]
+envs << ENV["BUCANEER_ENV"].downcase.to_sym if ENV["BUCANEER_ENV"]
+Bundler.setup(*envs)
+
+path = File.join(File.expand_path(File.dirname(__FILE__)), '..')
+$LOAD_PATH.unshift(path)
+
+require 'bucaneer'

data/lib/bucaneer/bus_pirate.rb

@@ -0,0 +1,115 @@
+require 'serialport'
+
+module Bucaneer
+  class BusPirate
+    DEFAULT_BAUD = 115200
+
+    TIMEOUT   = 0.0005
+    MAX_TRIES = 40
+
+    BITBANG_MODE = 0x00
+    RESET        = 0x0f
+
+    SET_PERIPHERALS = 0x40
+    POWER_ON        = 0x08
+    PULLUPS_ON      = 0x04
+    AUX_ON          = 0x02
+    CS_ON           = 0x01
+
+    FAILURE = 0x00
+    SUCCESS = 0x01
+
+    attr_reader :serial_port, :protocol
+
+    def self.connect(options = {})
+      dev  = options.delete(:dev)
+      mode = options.delete(:mode)
+      baud = options.delete(:baud) || DEFAULT_BAUD
+
+      raise "no device specified" unless dev
+      raise "no mode specified"   unless mode
+
+      serial_port = SerialPort.new(dev, baud)
+
+      begin
+        bus_pirate = Bucaneer::BusPirate.new(serial_port, mode, options)
+        yield bus_pirate.protocol if block_given?
+      ensure
+        begin
+          if bus_pirate
+            bus_pirate.exit_bitbang_mode
+            bus_pirate.reset
+          end
+
+          serial_port.close
+        rescue
+          # Do nothing.
+        end
+      end
+    end
+
+    def initialize(serial_port, mode, options)
+      @serial_port = serial_port
+      set_mode(mode.to_sym, options)
+    end
+
+    def tx(byte, expected = SUCCESS)
+      @serial_port.putc byte
+      sleep TIMEOUT
+      response = @serial_port.getc
+      raise "failed to send data" unless response == expected
+      response
+    end
+
+    def enter_bitbang_mode
+      tries = 0
+      begin
+        raise "failed to enter bitbang mode" if tries >= MAX_TRIES
+        @serial_port.puts BITBANG_MODE.chr
+        sleep TIMEOUT
+        response = @serial_port.read(5)
+        tries += 1
+      end until response == "BBIO1"
+    end
+
+    def exit_bitbang_mode
+      tx(BITBANG_MODE)
+    end
+
+    def reset
+      tx(RESET)
+    end
+
+    def set_peripherals(options)
+      mask = SET_PERIPHERALS
+
+      mask |= POWER_ON   if options[:power]
+      mask |= PULLUPS_ON if options[:pullups]
+      mask |= AUX_ON     if options[:aux]
+      mask |= CS_ON      if options[:cs]
+
+      tx(mask)
+    end
+
+  private
+    # Set the BusPirate to the given mode.
+    def set_mode(mode, options)
+      enter_bitbang_mode
+
+      @protocol =
+        case mode
+        when :i2c
+          Bucaneer::Protocol::I2C.new(self, options)
+        when :spi
+          Bucaneer::Protocol::SPI.new(self, options)
+        else
+          raise "unknown mode '#{mode}'"
+        end
+
+      set_peripherals(options)
+
+      # Allow things to settle down.
+      sleep 1
+    end
+  end
+end

data/lib/bucaneer/protocol/i2c.rb

@@ -0,0 +1,55 @@
+module Bucaneer::Protocol
+  # I2C bitbang on the BusPirate:
+  #   http://dangerousprototypes.com/docs/I2C_(binary)
+  #
+  # I2C protocol:
+  #   http://en.wikipedia.org/wiki/I²C
+  class I2C
+    I2C_MODE = 0x02
+
+    SET_SPEED  = 0x62
+    START      = 0x02
+    STOP       = 0x03
+    BULK_WRITE = 0x10
+
+    I2C_WRITE_BIT = 0x00
+    I2C_READ_BIT  = 0x01
+
+    ACK  = 0x00
+    NACK = 0x01
+
+    CHUNK_SIZE = 16
+
+    def initialize(controller, options = {})
+      @controller = controller
+      enter_i2c_mode
+      @controller.tx(SET_SPEED)
+    end
+
+    def tx(address, *bytes)
+      bytes.flatten!
+
+      @controller.tx(START)
+
+      bytes.to_enum.each_slice(CHUNK_SIZE) do |chunk|
+        start_bulk_write(chunk.length + 1)
+        @controller.tx((address << 1) | I2C_WRITE_BIT, ACK)
+        chunk.each {|byte| @controller.tx(byte, ACK) }
+      end
+
+      @controller.tx(STOP)
+    end
+
+  private
+    def start_bulk_write(length)
+      @controller.tx(BULK_WRITE | (length - 1))
+    end
+
+    def enter_i2c_mode
+      @controller.serial_port.puts I2C_MODE.chr
+      sleep Bucaneer::BusPirate::TIMEOUT
+      response = @controller.serial_port.read(4)
+      raise "failed to enter I2C mode" unless response == "I2C1"
+    end
+  end
+end

data/lib/bucaneer/protocol/spi.rb

@@ -0,0 +1,61 @@
+module Bucaneer::Protocol
+  # SPI bitbang on the BusPirate:
+  #   http://dangerousprototypes.com/docs/SPI_(binary)
+  #
+  # SPI protocol:
+  #   http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus
+  class SPI
+    SPI_MODE = 0x01
+
+    SET_CS     = 0x02
+    SET_SPEED  = 0x61
+    BULK_WRITE = 0x10
+
+    ENABLE = 0x01
+
+    CHUNK_SIZE = 16
+
+    def initialize(controller, options = {})
+      @controller = controller
+      enter_spi_mode
+      @controller.tx(SET_SPEED)
+      @controller.tx(0x82)
+    end
+
+    def tx(bytes)
+      set_cs(false)
+
+      sleep 0.0005
+
+      bytes.to_enum.each_slice(CHUNK_SIZE) do |chunk|
+        start_bulk_write(chunk.length)
+        chunk.each do |byte|
+          @controller.serial_port.putc byte
+        end
+        @controller.serial_port.read(chunk.length)
+      end
+
+      sleep 0.0005
+
+      set_cs(true)
+    end
+
+  private
+    def set_cs(enable)
+      mask  = SET_CS
+      mask |= ENABLE if enable
+      @controller.tx(mask)
+    end
+
+    def start_bulk_write(length)
+      @controller.tx(BULK_WRITE | (length - 1))
+    end
+
+    def enter_spi_mode
+      @controller.serial_port.puts SPI_MODE.chr
+      sleep Bucaneer::BusPirate::TIMEOUT
+      response = @controller.serial_port.read(4)
+      raise "failed to enter SPI mode" unless response == "SPI1"
+    end
+  end
+end

data/lib/bucaneer/protocol.rb

@@ -0,0 +1,4 @@
+module Bucaneer::Protocol
+  autoload :I2C, 'bucaneer/protocol/i2c'
+  autoload :SPI, 'bucaneer/protocol/spi'
+end

data/lib/bucaneer/version.rb

@@ -0,0 +1,3 @@
+module Bucaneer
+  VERSION = "0.1.0" unless defined?(Bucaneer::VERSION)
+end

data/lib/bucaneer.rb

@@ -0,0 +1,6 @@
+module Bucaneer
+end
+
+require 'bucaneer/bus_pirate'
+require 'bucaneer/protocol'
+require 'bucaneer/version'

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification 
+name: bucaneer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Josh Bassett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-22 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-serialport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hirb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: wirble
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :development
+  version_requirements: *id008
+description: Bucaneer is a Ruby library which allows you to control your BusPirate bitbang modes (I2C, SPI, etc).
+email: josh.bassett@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bucaneer/alone.rb
+- lib/bucaneer/bus_pirate.rb
+- lib/bucaneer/protocol/i2c.rb
+- lib/bucaneer/protocol/spi.rb
+- lib/bucaneer/protocol.rb
+- lib/bucaneer/version.rb
+- lib/bucaneer.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/nullobject/bucaneer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: bucaneer
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: BusPirate library for Ruby.
+test_files: []
+