i2c 0.1.1 → 0.2.0

data/README.rdoc

@@ -41,19 +41,26 @@ first I2c bus on the system.
 
 === MCP23017
 
-16bit IO-Expander MCP23017 from Microchip. Provides a wiringpi-ruby compatible
+16 bit IO-Expander MCP23017 from Microchip. Provides a wiringpi-ruby compatible
 API and may therefore be used as a drop-in replacement for IO tasks on a
-Raspberry Pi. Datasheet: http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf
+Raspberry Pi. 
+Datasheet: http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf
+
+=== MCP23008
+
+8 bit IO-Expander MCP23008 from Microchip. Basically a small version of the 
+MCP23017. 
+Datasheet: http://ww1.microchip.com/downloads/en/DeviceDoc/21919e.pdf
 
 == Acknowledgements
 
 The low-level IO (mainly in i2c-dev.rb) was extracted from Ruby-I2C 
 (http://rubyforge.org/projects/i2c/) by Jonas Bähr <jonas.baehr@fs.ei.tum.de> 
 
-== Legal stuff
+== Copyright / Licence
 
 This code may be used under the terms of the GNU General Public Licence, Version 2.
 
 Copyright (c) 2012 Christoph Anderegg <christoph@christoph-anderegg.ch>
-Copyright (c) 2008 Jonas Bähr, jonas.baehr@fs.ei.tum.de 
+Copyright (c) 2008 Jonas Bähr <jonas.baehr@fs.ei.tum.de>
 

data/lib/i2c.rb

@@ -8,6 +8,7 @@
 
 require 'i2c/i2c.rb'
 require 'i2c/backends/i2c-dev.rb'
+require 'i2c/drivers/mcp23008.rb'
 require 'i2c/drivers/mcp23017.rb'
 
 

data/lib/i2c/drivers/mcp23008.rb

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+# I2C IO-Expander driver 
+# for the MCP23008 8-bit IO-Expander.
+#
+# The interface is compatible to the interface
+# of the WiringPi gem. PWM is not supported though.
+#
+# Copyright (c) 2012 Christoph Anderegg <christoph@christoph-anderegg.ch>
+# This file may be distributed under the terms of the GNU General Public
+# License Version 2.
+#
+
+require 'i2c/i2c.rb'
+
+# Constants for mode()
+INPUT = 1
+OUTPUT = 0
+
+# Constants for write()
+HIGH = 1
+LOW = 0
+      
+module I2C
+  module Drivers
+    class MCP23008
+      # Registers
+      IODIR = 0x00
+      GPIO = 0x09
+      
+      # Creates an instance representing exactly one
+      # MCP23008 on one I2C-bus.
+      #
+      # device: I2C-device file (usually /dev/i2c-0).
+      #         Or an intantiated io class that supports
+      #         the necessary operations (#read, #write
+      #         and #ioctl).
+      # address: Device address on the bus.
+      def initialize(device, address)
+        if device.kind_of?(String)
+          @device = ::I2C.create(device)
+        else
+          [ :read, :write ].each do |m|
+            raise IncompatibleDeviceException, 
+            "Missing #{m} method in device object." unless device.respond_to?(m)
+          end
+          @device = device
+        end
+        @address = address
+        
+        @dir = 0xFF # Direction is input initially 
+        @device.write(@address, IODIR, @dir)
+        @data = @device.read(@address, 1, GPIO).unpack("C")[0]   
+      end  
+      
+      def mode?(pin)
+        @dir = @device.read(@address, 1, IODIR).unpack("C")[0]
+        return (@dir >> pin) & 0x01
+      end
+      
+      def mode(pin, pin_mode)
+        raise ArgumentError, "Pin not 0-7" unless (0..7).include?(pin)
+        raise ArgumentError, 'invalid value' unless [0,1].include?(pin_mode)
+        @dir = set_bit_value(@dir, pin, pin_mode)
+        @device.write(@address, IODIR, @dir)
+      end
+      
+      def []=(pin, value)
+        raise ArgumentError, "Pin not 0-7" unless (0..7).include?(pin)
+        raise ArgumentError, 'invalid value' unless [0,1].include?(value)
+        @data = set_bit_value(@data, pin, value)
+        @device.write(@address, GPIO, @data)
+      end
+      alias :write :[]= 
+        
+      def [](pin)
+        raise ArgumentError, "Pin not 0-7." unless (0..7).include?(pin)
+        @data = @device.read(@address, 1, GPIO).unpack("C")[0]
+        return (@data >> pin) & 0x01        
+      end
+      alias :read :[]
+      
+      private
+      def set_bit_value(byte, bit, value)
+        mask = 0x00
+        mask = (0x01 << bit)
+        case value
+        when 0
+          byte = (byte & ((~mask) & 0xFF)) & 0xFF
+        when 1
+          byte = (byte |  mask) & 0xFF
+        else
+          raise ArgumentError, "Bit not 0-7."
+        end
+        byte
+      end
+    end
+  end
+end

data/lib/i2c/drivers/mcp23017.rb

@@ -69,7 +69,7 @@ module I2C
       end
       
       def mode(pin, pin_mode)
-        raise ArgumentError, "Pin not 0-15" unless (0..16).include?(pin)
+        raise ArgumentError, "Pin not 0-15" unless (0..15).include?(pin)
         raise ArgumentError, 'invalid value' unless [0,1].include?(pin_mode)
         if 8 <= pin
           @dir_b = set_bit_value(@dir_b, (pin-8), pin_mode)

data/test/mcp23008_spec.rb

@@ -0,0 +1,86 @@
+require 'i2c'
+
+class MockI2CIO
+  attr_reader :registers
+  attr_reader :last_address
+
+  def initialize
+    @registers = Hash.new
+    # Initialize according to data sheet
+    @registers[0x00] = 0xFF
+    (0x01..0x0A).each do |reg|
+      @registers[reg] = 0x00
+    end
+  end
+
+  def write(address, *params)
+    @last_address = address
+    if params.count >= 1
+      reg_addr = params.shift
+      index = 0
+      params.each do |p|
+        @registers[reg_addr+index] = p
+        index += 1
+      end
+    end
+  end
+
+  def read(address, size, *params)
+    @last_address = address
+    answer = String.new
+    answer.force_encoding("US-ASCII")
+    if (size > 0) && (params.count >= 1)
+      reg_addr = params.shift
+      (0...size).each do |index|
+        answer << (@registers[reg_addr+index] & 0xFF)
+      end
+    end
+    answer
+  end
+end
+
+describe I2C::Drivers::MCP23008, "#mode?" do
+  it "initially returns 1 for all pin modes" do
+    io = MockI2CIO.new
+    mcp23008 = I2C::Drivers::MCP23008.new(io, 0x20)
+    (0..7).each do |pin|
+      mcp23008.mode?(pin).should eq(1)
+    end
+  end
+end
+
+describe I2C::Drivers::MCP23008, "#mode?" do
+  it "returns what has been set through #mode" do
+    io = MockI2CIO.new
+    mcp23008 = I2C::Drivers::MCP23008.new(io, 0x20)
+    (0..500).each do |pin|
+      pin = rand(8)
+      mode = rand(2)
+      mcp23008.mode(pin, mode)
+      mcp23008.mode?(pin).should eq(mode)
+    end
+  end
+end
+
+describe I2C::Drivers::MCP23008, "#[]" do
+  it "initially returns 0 for all I/O pins" do
+    io = MockI2CIO.new
+    mcp23008 = I2C::Drivers::MCP23008.new(io, 0x20)
+    (0..7).each do |pin|
+      mcp23008[pin].should eq(0)
+    end
+  end
+end
+
+describe I2C::Drivers::MCP23008, "#[]" do
+  it "returns what has been set through #[]=" do
+    io = MockI2CIO.new
+    mcp23008 = I2C::Drivers::MCP23008.new(io, 0x20)
+    (0..500).each do |pin|
+      pin = rand(8)
+      value = rand(2)
+      mcp23008[pin] = value
+      mcp23008[pin].should eq(value)
+    end
+  end
+end

data/test/mcp23017_spec.rb

@@ -44,9 +44,9 @@ end
 describe I2C::Drivers::MCP23017, "#mode?" do
   it "initially returns 1 for all pin modes" do
     io = MockI2CIO.new
-    mcp17026 = I2C::Drivers::MCP23017.new(io, 0x20)
+    mcp23017 = I2C::Drivers::MCP23017.new(io, 0x20)
     (0..15).each do |pin|
-      mcp17026.mode?(pin).should eq(1)
+      mcp23017.mode?(pin).should eq(1)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i2c
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-03 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies: []
 description: Interface to I2C (aka TWI) implementations. Also provides abstractions
   for some I2c-devices. Created with the Raspberry Pi in mind.
@@ -23,7 +23,9 @@ files:
 - lib/i2c/i2c.rb
 - lib/i2c/backends/i2c-dev.rb
 - lib/i2c/drivers/mcp23017.rb
+- lib/i2c/drivers/mcp23008.rb
 - test//mcp23017_spec.rb
+- test//mcp23008_spec.rb
 - rules/88-i2c.rules
 - README.rdoc
 homepage: https://github.com/andec/i2c