i2c 0.1.0

data/lib/i2c.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# I2C gem setup.
+#
+# 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'
+require 'i2c/backends/i2c-dev.rb'
+require 'i2c/drivers/mcp17026.rb'
+
+
+

data/lib/i2c/backends/i2c-dev.rb

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# I2C - Linux i2c-dev backend. 
+#
+# Copyright (c) 2012 Christoph Anderegg <christoph@christoph-anderegg.ch>
+# Copyright (c) 2008 Jonas Bähr, jonas.baehr@fs.ei.tum.de 
+# This file may be distributed under the terms of the GNU General Public
+# License Version 2.
+#
+module I2C
+  class Dev
+    # see i2c-dev.h
+    I2C_SLAVE = 0x0703
+
+    def self.create(device_path)
+      raise Errno::ENOENT, "Device #{device_path} not found." unless File.exists?(device_path)
+      @instances ||= Hash.new
+      @instances[device_path] = Dev.new(device_path) unless @instances.has_key?(device_path)
+      @instances[device_path]
+    end
+
+    # sends every param, begining with +params[0]+
+    # If the current param is a Fixnum, it is treated as one byte.
+    # If the param is a String, this string will be send byte by byte.
+    # You can use Array#pack to create a string from an array
+    # For Fixnum there is a convinient function to_short which transforms
+    # the number to a string this way: 12345.to_short == [12345].pack("s")
+    def write(address, *params)
+      data = String.new
+      data.force_encoding("US-ASCII")
+      params.each do |value|
+        data << value
+      end
+      @device.ioctl(I2C_SLAVE, address)
+      @device.syswrite(data)
+    end
+
+    # this sends *params as the write function and then tries to read
+    # +size+ bytes. The result is a String which can be treated with
+    # String#unpack afterwards
+    def read(address, size, *params)
+      ret = ""
+      write(address, *params)
+      ret = @device.sysread(size)
+      return ret
+    end
+
+    private
+    def initialize(device_path)
+      @device = File.new(device_path, 'r+')
+      # change the sys* functions of the file object to meet our requirements
+      class << @device
+        alias :syswrite_orig :syswrite
+        def syswrite(var)
+          begin
+            syswrite_orig var
+          rescue Errno::EREMOTEIO
+            raise AckError, "No acknowledge received"
+          end
+        end
+        alias :sysread_orig :sysread
+        def sysread(var)
+          begin
+            sysread_orig var
+          rescue Errno::EREMOTEIO
+            raise AckError, "No acknowledge received"
+          end
+        end
+      end # class
+    end # initialize
+  end
+end

data/lib/i2c/drivers/mcp17026.rb

@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+# I2C IO-Expander driver 
+# for the MCP23017 16-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 MCP17026
+      # Registers
+      IODIRA = 0x00
+      IODIRB = 0x01
+      GPIOA = 0x12
+      GPIOB = 0x13
+      
+      # Creates an instance representing exactly one
+      # MCP17026 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_a = 0xFF # Direction is input initially 
+        @dir_b = 0xFF # Direction is input initially
+        @device.write(@address, IODIRA, @dir_a, @dir_b)
+        
+        @data_a = 0xFF # Initial data
+        @data_b = 0xFF # Initial data
+        @data_a, @data_b = @device.read(@address, 2, GPIOA).unpack("CC")   
+      end  
+      
+      def mode?(pin)
+        @dir_a, @dir_b = @device.read(@address, 2, IODIRA).unpack("CC")
+        dir = @dir_a
+        if 8 <= pin
+          dir = @dir_b
+          pin -= 8
+        end
+        return (dir >> pin) & 0x01
+      end
+      
+      def mode(pin, pin_mode)
+        raise ArgumentError, "Pin not 0-15" unless (0..16).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)
+        else
+          @dir_a = set_bit_value(@dir_a, pin, pin_mode)
+        end
+        @device.write(@address, IODIRA, @dir_a, @dir_b)
+      end
+      
+      def []=(pin, value)
+        raise ArgumentError, "Pin not 0-15" unless (0..15).include?(pin)
+        raise ArgumentError, 'invalid value' unless [0,1].include?(value)
+        if 8 <= pin
+          @data_b = set_bit_value(@data_b, (pin-8), value)
+        else
+          @data_a = set_bit_value(@data_a, pin, value)
+        end
+        @device.write(@address, GPIOA, @data_a, @data_b)
+      end
+      alias :write :[]= 
+        
+      def [](pin)
+        raise ArgumentError, "Pin not 0-15." unless (0..15).include?(pin)
+        @data_a, @data_b = @device.read(@address, 2, GPIOA).unpack("CC")
+        data = @data_a
+        if 8 <= pin
+          data  = @data_b;
+          pin -= 8
+        end
+        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
+#        puts "Byte: (0x#{"%X" % byte}) 0b#{"%B" % byte}; " +
+#          "Mask: 0b#{"%B" % mask}; Bit: #{bit}; Value: #{value}"
+        byte
+      end
+    end
+  end
+end

data/lib/i2c/i2c.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# Entry point to the I2C library.
+#
+# Essentially this requires the correct backend
+# driver, right now this means the linux i2c-dev driver.
+# This could be extended to do some system specific
+#
+# Copyright (c) 2012 Christoph Anderegg <christoph@christoph-anderegg.ch>
+# Copyright (c) 2008 Jonas Bähr, jonas.baehr@fs.ei.tum.de 
+#
+# This file may be distributed under the terms of the GNU General Public
+# License Version 2.
+#
+
+require 'i2c/backends/i2c-dev.rb'
+
+module I2C
+  # some common error classes
+  class AckError < StandardError; end
+
+  # Returns an instance of the current backend 
+  # driver.
+  #
+  # Is there a system agnostic way to do this?
+  #
+  # +bus_descriptor+ describes the bus to use. This is
+  #                  of course system specific. For the
+  #                  Linux i2c-dev driver this is the
+  #                  device file (e.g. /dev/i2c-0").
+  def self.create(bus_descriptor)
+    I2C::Dev.create(bus_descriptor)
+  end
+end
+
+

data/rules/88-i2c.rules

@@ -0,0 +1 @@
+KERNEL=="i2c-[0-9]", GROUP="i2c", MODE="0660"

data/test/mcp17026_spec.rb

@@ -0,0 +1,90 @@
+require 'i2c'
+#require 'mock/mock_i2c_io.rb'
+
+class MockI2CIO
+
+  attr_reader :registers
+  attr_reader :last_address
+
+  def initialize
+    @registers = Hash.new
+    # Initialize according to data sheet
+    (0x00..0x01).each do |reg| 
+      @registers[reg] = 0xFF
+    end
+    (0x02..0x15).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::MCP17026, "#mode?" do
+  it "initially returns 1 for all pin modes" do
+    io = MockI2CIO.new
+    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    (0..15).each do |pin|
+      mcp17026.mode?(pin).should eq(1)
+    end
+  end
+end
+
+describe I2C::Drivers::MCP17026, "#mode?" do
+  it "returns what has been set through #mode" do
+    io = MockI2CIO.new
+    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    (0..500).each do |pin|
+      pin = rand(16)
+      mode = rand(2)
+      mcp17026.mode(pin, mode)
+      mcp17026.mode?(pin).should eq(mode)
+    end
+  end
+end
+
+describe I2C::Drivers::MCP17026, "#[]" do
+  it "initially returns 0 for all I/O pins" do
+    io = MockI2CIO.new
+    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    (0..15).each do |pin|
+      mcp17026[pin].should eq(0)
+    end
+  end
+end
+
+describe I2C::Drivers::MCP17026, "#[]" do
+  it "returns what has been set through #[]=" do
+    io = MockI2CIO.new
+    mcp17026 = I2C::Drivers::MCP17026.new(io, 0x20)
+    (0..500).each do |pin|
+      pin = rand(16)
+      value = rand(2)
+      mcp17026[pin] = value
+      mcp17026[pin].should eq(value)
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: i2c
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Christoph Anderegg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies: []
+description: Interface to Linux I2C (a.k.a. TWI) implementations.
+email: christoph@christoph-anderegg.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/i2c.rb
+- lib/i2c/i2c.rb
+- lib/i2c/backends/i2c-dev.rb
+- lib/i2c/drivers/mcp17026.rb
+- test//mcp17026_spec.rb
+- rules/88-i2c.rules
+homepage: https://github.com/andec/i2c
+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: I2C access library.
+test_files: []