i2c 0.1.0 → 0.1.1

data/README.rdoc

@@ -0,0 +1,59 @@
+= I2C - Ruby I2C library 
+
+== About
+
+Interface to Linux I2C (a.k.a. TWI) implementations. Right now targeted at the 
+Raspberry Pi, but should work with any linux i2c-dev I2C-hardware.
+
+== Structure
+
+The library is split into two parts: 
+ - A backend for accessing the I2C bus (right now only through the i2c-dev 
+   in Linux, other impementations are possible).
+ - Drivers for I2C enabled ICs. 
+
+== Installation
+
+To use the i2c-dev backend it is necessary to load the "i2c-dev" linux
+kernel module. This is not done automatically even if the module for the
+underlying I2C-hardware is. To automatically load the i2c-dev driver on startup
+add it to /etc/modules. Also the device file (usually /dev/i2c-0) must be 
+user accessible. A working (at least on a RaspberryPi running Raspbian) udev 
+rule file is available (rules/88-i2c.rules) and can be installed to
+/etc/udev/rules.d/.
+
+== Backends
+
+The backends are instantiated through the #I2C::create method. depending 
+on the format of the passed bus descriptor the correct backend is invoked.
+
+Right now there is only a i2c-dev backend available
+
+=== i2c-dev Backend
+
+Backend for the Linux I2C implementation. Accepts device file names as
+bus descriptors. E.g.
+
+I2C.create("/dev/i2c-0") returns an instance of I2C::Dev attached to the
+first I2c bus on the system.
+
+== Drivers
+
+=== MCP23017
+
+16bit 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
+
+== 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
+
+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 
+

data/lib/i2c.rb

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

data/lib/i2c/drivers/{mcp17026.rb → mcp23017.rb}

@@ -22,7 +22,7 @@ LOW = 0
       
 module I2C
   module Drivers
-    class MCP17026
+    class MCP23017
       # Registers
       IODIRA = 0x00
       IODIRB = 0x01
@@ -30,7 +30,7 @@ module I2C
       GPIOB = 0x13
       
       # Creates an instance representing exactly one
-      # MCP17026 on one I2C-bus.
+      # MCP23017 on one I2C-bus.
       #
       # device: I2C-device file (usually /dev/i2c-0).
       #         Or an intantiated io class that supports

data/test/{mcp17026_spec.rb → mcp23017_spec.rb}

@@ -1,8 +1,6 @@
 require 'i2c'
-#require 'mock/mock_i2c_io.rb'
 
 class MockI2CIO
-
   attr_reader :registers
   attr_reader :last_address
 
@@ -43,48 +41,48 @@ class MockI2CIO
   end
 end
 
-describe I2C::Drivers::MCP17026, "#mode?" do
+describe I2C::Drivers::MCP23017, "#mode?" do
   it "initially returns 1 for all pin modes" do
     io = MockI2CIO.new
-    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    mcp17026 = I2C::Drivers::MCP23017.new(io, 0x20)
     (0..15).each do |pin|
       mcp17026.mode?(pin).should eq(1)
     end
   end
 end
 
-describe I2C::Drivers::MCP17026, "#mode?" do
+describe I2C::Drivers::MCP23017, "#mode?" do
   it "returns what has been set through #mode" do
     io = MockI2CIO.new
-    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    mcp23017 = I2C::Drivers::MCP23017.new(io, 0x20)
     (0..500).each do |pin|
       pin = rand(16)
       mode = rand(2)
-      mcp17026.mode(pin, mode)
-      mcp17026.mode?(pin).should eq(mode)
+      mcp23017.mode(pin, mode)
+      mcp23017.mode?(pin).should eq(mode)
     end
   end
 end
 
-describe I2C::Drivers::MCP17026, "#[]" do
+describe I2C::Drivers::MCP23017, "#[]" do
   it "initially returns 0 for all I/O pins" do
     io = MockI2CIO.new
-    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    mcp23017 = I2C::Drivers::MCP23017.new(io, 0x20)
     (0..15).each do |pin|
-      mcp17026[pin].should eq(0)
+      mcp23017[pin].should eq(0)
     end
   end
 end
 
-describe I2C::Drivers::MCP17026, "#[]" do
+describe I2C::Drivers::MCP23017, "#[]" do
   it "returns what has been set through #[]=" do
     io = MockI2CIO.new
-    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    mcp23017 = I2C::Drivers::MCP23017.new(io, 0x20)
     (0..500).each do |pin|
       pin = rand(16)
       value = rand(2)
-      mcp17026[pin] = value
-      mcp17026[pin].should eq(value)
+      mcp23017[pin] = value
+      mcp23017[pin].should eq(value)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i2c
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,18 +11,21 @@ bindir: bin
 cert_chain: []
 date: 2012-08-03 00:00:00.000000000 Z
 dependencies: []
-description: Interface to Linux I2C (a.k.a. TWI) implementations.
+description: Interface to I2C (aka TWI) implementations. Also provides abstractions
+  for some I2c-devices. Created with the Raspberry Pi in mind.
 email: christoph@christoph-anderegg.ch
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
 - lib/i2c.rb
 - lib/i2c/i2c.rb
 - lib/i2c/backends/i2c-dev.rb
-- lib/i2c/drivers/mcp17026.rb
-- test//mcp17026_spec.rb
+- lib/i2c/drivers/mcp23017.rb
+- test//mcp23017_spec.rb
 - rules/88-i2c.rules
+- README.rdoc
 homepage: https://github.com/andec/i2c
 licenses: []
 post_install_message: 
@@ -46,5 +49,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: I2C access library.
+summary: I2C access library (for Linux).
 test_files: []