pi_driver 0.0.2 → 0.0.3

data/lib/pi_driver/utils.rb

@@ -0,0 +1,10 @@
+require_relative 'utils/argument_helper'
+require_relative 'utils/byte'
+require_relative 'utils/edge'
+require_relative 'utils/interrupt'
+require_relative 'utils/state'
+
+module PiDriver
+  module Utils
+  end
+end

data/lib/pi_driver/utils/argument_helper.rb

@@ -0,0 +1,19 @@
+module PiDriver
+  module Utils
+    class ArgumentHelper
+      attr_accessor :prefix, :suffix
+
+      def initialize(options = {})
+        @prefix = options[:prefix]
+        @suffix = options[:suffix]
+      end
+
+      def check(type, arg, valid_options)
+        valid_options_for_message = valid_options.map { |value| "#{value.inspect}"}.join(', ')
+        middle = "invalid argument #{arg.inspect} for #{type.inspect} expected to be one of #{valid_options_for_message}"
+        message = "#{@prefix if @prefix} #{middle} #{@suffix if @suffix}"
+        raise ArgumentError, message unless valid_options.include?(arg)
+      end
+    end
+  end
+end

data/lib/pi_driver/utils/byte.rb

@@ -0,0 +1,21 @@
+module PiDriver
+  module Utils
+    class Byte
+      ALL_BITS_LOW = 0b00000000
+      ALL_BITS_HIGH = 0b11111111
+      NUM_BITS_PER_BYTE = 8
+
+      VALID_BYTES = (ALL_BITS_LOW..ALL_BITS_HIGH).to_a
+
+      private
+
+      def self.byte_to_bits(byte)
+        byte.to_s(2).rjust(NUM_BITS_PER_BYTE, '0').chars.map(&:to_i)
+      end
+
+      def self.bits_to_byte(bits)
+        bits.join.to_i(2)
+      end
+    end
+  end
+end

data/lib/pi_driver/utils/edge.rb

@@ -0,0 +1,17 @@
+module PiDriver
+  module Utils
+    class Edge
+      RISING = :rising
+      FALLING = :falling
+      BOTH = :both
+      NONE = :none
+
+      VALID_EDGES = [
+        RISING,
+        FALLING,
+        BOTH,
+        NONE
+      ]
+    end
+  end
+end

data/lib/pi_driver/utils/interrupt.rb

@@ -0,0 +1,60 @@
+module PiDriver
+  module Utils
+    class Interrupt
+      def initialize(edge, &block)
+        @argument_helper = Utils::ArgumentHelper.new prefix: "Utils::Interrupt"
+        @edge = edge
+
+        @argument_helper.check(:block, block_given?, [true])
+        @check = block
+      end
+
+      def start
+        @argument_helper.check(:block, block_given?, [true])
+
+        @thread = Thread.new do
+          last_state = check
+          loop do
+            new_state = check
+            edge = get_interrupt_edge(new_state, last_state)
+            yield(edge) if edge
+            last_state = new_state
+          end
+        end
+        @thread.tap { |me| me.abort_on_exception = true }
+      end
+
+      def clear
+        @thread.kill
+      end
+
+      private
+
+      def check
+        state = @check.call
+        @argument_helper.check(:state, state, Utils::State::VALID_STATES)
+        state
+      end
+
+      def get_interrupt_edge(new_state, last_state)
+        rising_trigger = new_state == Utils::State::HIGH && last_state == Utils::State::LOW
+        falling_trigger = new_state == Utils::State::LOW && last_state == Utils::State::HIGH
+
+        return Utils::Edge::RISING if rising_trigger && (both? || rising?)
+        return Utils::Edge::FALLING if falling_trigger && (both? || falling?)
+      end
+
+      def both?
+        @edge == Utils::Edge::BOTH
+      end
+
+      def rising?
+        @edge == Utils::Edge::RISING
+      end
+
+      def falling?
+        @edge == Utils::Edge::FALLING
+      end
+    end
+  end
+end

data/lib/pi_driver/utils/state.rb

@@ -0,0 +1,13 @@
+module PiDriver
+  module Utils
+    class State
+      LOW = 0
+      HIGH = 1
+
+      VALID_STATES = [
+        LOW,
+        HIGH
+      ]
+    end
+  end
+end

data/test/device/mcp23017/test_alias.rb

@@ -0,0 +1,27 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017AliasTest < MCP23017Test
+  def test_register_aliases
+    assert_equal @mcp23017.iodira.method(:bit0), @mcp23017.iodira.method(:io0)
+    assert_equal @mcp23017.ipola.method(:bit0), @mcp23017.ipola.method(:ip0)
+    assert_equal @mcp23017.gpintena.method(:bit0), @mcp23017.gpintena.method(:gpint0)
+    assert_equal @mcp23017.defvala.method(:bit0), @mcp23017.defvala.method(:def0)
+    assert_equal @mcp23017.intcona.method(:bit0), @mcp23017.intcona.method(:ioc0)
+
+    assert_equal @mcp23017.gppua.method(:bit0), @mcp23017.gppua.method(:pu0)
+    assert_equal @mcp23017.intfa.method(:bit0), @mcp23017.intfa.method(:int0)
+    assert_equal @mcp23017.intcapa.method(:bit0), @mcp23017.intcapa.method(:icp0)
+    assert_equal @mcp23017.gpioa.method(:bit0), @mcp23017.gpioa.method(:gp0)
+    assert_equal @mcp23017.olata.method(:bit0), @mcp23017.olata.method(:ol0)
+  end
+
+  def test_iocon_aliases
+    assert_equal @mcp23017.iocon.method(:bit7), @mcp23017.iocon.method(:bank)
+    assert_equal @mcp23017.iocon.method(:bit6), @mcp23017.iocon.method(:mirror)
+    assert_equal @mcp23017.iocon.method(:bit5), @mcp23017.iocon.method(:seqop)
+    assert_equal @mcp23017.iocon.method(:bit4), @mcp23017.iocon.method(:disslw)
+    assert_equal @mcp23017.iocon.method(:bit3), @mcp23017.iocon.method(:haen)
+    assert_equal @mcp23017.iocon.method(:bit2), @mcp23017.iocon.method(:odr)
+    assert_equal @mcp23017.iocon.method(:bit1), @mcp23017.iocon.method(:intpol)
+  end
+end

data/test/device/mcp23017/test_error.rb

@@ -0,0 +1,37 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017ErrorTest < MCP23017Test
+  def test_error_hardware_address
+    assert_raises ArgumentError do
+      @mcp23017.hardware_address.a0 = 2
+    end
+  end
+
+  def test_error_register_bit
+    assert_raises ArgumentError do
+      @mcp23017.iodira.bit0 = 2
+    end
+  end
+
+  def test_error_register_port
+    assert_raises ArgumentError do
+      @mcp23017.iodira.byte = 256
+    end
+
+    assert_raises ArgumentError do
+      @mcp23017.iodira.byte = -1
+    end
+  end
+
+  def test_error_write
+    assert_raises ArgumentError do
+      @mcp23017.write :invalid_register
+    end
+  end
+
+  def test_error_read
+    assert_raises ArgumentError do
+      @mcp23017.read :invalid_register
+    end
+  end
+end

data/test/device/mcp23017/test_hardware_address.rb

@@ -0,0 +1,29 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017HardwareAddressTest < MCP23017Test
+  def test_low_new_default
+    mcp23017 = PiDriver::Device::MCP23017.new i2c_master: @i2c_master
+    assert_equal 0, mcp23017.hardware_address.a0
+    assert_equal 0, mcp23017.hardware_address.a1
+    assert_equal 0, mcp23017.hardware_address.a2
+  end
+
+  def test_set_high
+    mcp23017 = PiDriver::Device::MCP23017.new i2c_master: @i2c_master
+
+    mcp23017.hardware_address.a0 = 1
+    mcp23017.hardware_address.a1 = 1
+    mcp23017.hardware_address.a2 = 1
+
+    assert_equal 1, mcp23017.hardware_address.a0
+    assert_equal 1, mcp23017.hardware_address.a1
+    assert_equal 1, mcp23017.hardware_address.a2
+  end
+
+  def test_opcode_change
+    PiDriver::I2CMaster.expects(:prepare_address_for_write).with(0b0100110)
+    PiDriver::I2CMaster.expects(:prepare_address_for_read).with(0b0100110)
+
+    @mcp23017.hardware_address.a0 = 0
+  end
+end

data/test/device/mcp23017/test_i2c_master.rb

@@ -0,0 +1,10 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017I2CMasterTest < MCP23017Test
+  def test_prepare_address_new
+    PiDriver::I2CMaster.expects(:prepare_address_for_write).with(0b0100000)
+    PiDriver::I2CMaster.expects(:prepare_address_for_read).with(0b0100000)
+
+    PiDriver::Device::MCP23017.new i2c_master: @i2c_master
+  end
+end

data/test/device/mcp23017/test_read.rb

@@ -0,0 +1,63 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017ReadTest < MCP23017Test
+  def test_single
+    seq = sequence('single')
+
+    @i2c_master.expects(:start).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001110).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0x15).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:restart).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001111).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:read).with(nil).returns(0b10101010).in_sequence(seq)
+
+    @i2c_master.expects(:stop).with(nil).in_sequence(seq)
+
+    @mcp23017.read :olatb
+
+    assert_equal 0b10101010, @mcp23017.olatb.byte
+  end
+
+  def test_multiple
+    seq = sequence('multiple')
+
+    @i2c_master.expects(:start).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001110).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0x14).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:restart).with(nil).in_sequence(seq)
+    
+    @i2c_master.expects(:write).with(0b01001111).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:read).with(nil).returns(0b01010101).in_sequence(seq)
+
+    @i2c_master.expects(:restart).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001110).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0x15).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:restart).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001111).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:read).with(nil).returns(0b10101010).in_sequence(seq)
+
+    @i2c_master.expects(:stop).with(nil).in_sequence(seq)
+
+    @mcp23017.read :olata, :olatb
+
+    assert_equal 0b01010101, @mcp23017.olata.byte
+    assert_equal 0b10101010, @mcp23017.olatb.byte
+  end
+end

data/test/device/mcp23017/test_register.rb

@@ -0,0 +1,118 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017RegisterTest < MCP23017Test
+  def test_addresses_bank_low
+    assert_equal 0x00, @mcp23017.iodira.address
+    assert_equal 0x01, @mcp23017.iodirb.address
+
+    assert_equal 0x02, @mcp23017.ipola.address
+    assert_equal 0x03, @mcp23017.ipolb.address
+
+    assert_equal 0x04, @mcp23017.gpintena.address
+    assert_equal 0x05, @mcp23017.gpintenb.address
+
+    assert_equal 0x06, @mcp23017.defvala.address
+    assert_equal 0x07, @mcp23017.defvalb.address
+
+    assert_equal 0x08, @mcp23017.intcona.address
+    assert_equal 0x09, @mcp23017.intconb.address
+
+    assert_equal 0x0a, @mcp23017.iocon.address
+
+    assert_equal 0x0c, @mcp23017.gppua.address
+    assert_equal 0x0d, @mcp23017.gppub.address
+
+    assert_equal 0x0e, @mcp23017.intfa.address
+    assert_equal 0x0f, @mcp23017.intfb.address
+
+    assert_equal 0x10, @mcp23017.intcapa.address
+    assert_equal 0x11, @mcp23017.intcapb.address
+
+    assert_equal 0x12, @mcp23017.gpioa.address
+    assert_equal 0x13, @mcp23017.gpiob.address
+
+    assert_equal 0x14, @mcp23017.olata.address
+    assert_equal 0x15, @mcp23017.olatb.address
+  end
+
+  def test_addresses_bank_high
+  	@mcp23017.iocon.bank = 1
+    assert_equal 0x05, @mcp23017.iocon.address
+
+    assert_equal 0x00, @mcp23017.iodira.address
+    assert_equal 0x01, @mcp23017.ipola.address
+    assert_equal 0x02, @mcp23017.gpintena.address
+    assert_equal 0x03, @mcp23017.defvala.address
+    assert_equal 0x04, @mcp23017.intcona.address
+    assert_equal 0x06, @mcp23017.gppua.address
+    assert_equal 0x07, @mcp23017.intfa.address
+    assert_equal 0x08, @mcp23017.intcapa.address
+    assert_equal 0x09, @mcp23017.gpioa.address
+    assert_equal 0x0a, @mcp23017.olata.address
+
+    assert_equal 0x10, @mcp23017.iodirb.address
+    assert_equal 0x11, @mcp23017.ipolb.address
+    assert_equal 0x12, @mcp23017.gpintenb.address
+    assert_equal 0x13, @mcp23017.defvalb.address
+    assert_equal 0x14, @mcp23017.intconb.address
+    assert_equal 0x16, @mcp23017.gppub.address
+    assert_equal 0x17, @mcp23017.intfb.address
+    assert_equal 0x18, @mcp23017.intcapb.address
+    assert_equal 0x19, @mcp23017.gpiob.address
+    assert_equal 0x1a, @mcp23017.olatb.address
+  end
+
+  def test_byte_new
+    assert_equal 0b11111111, @mcp23017.iodira.byte
+    assert_equal 0b11111111, @mcp23017.iodirb.byte
+
+    assert_equal 0b00000000, @mcp23017.ipola.byte
+    assert_equal 0b00000000, @mcp23017.ipolb.byte
+
+    assert_equal 0b00000000, @mcp23017.gpintena.byte
+    assert_equal 0b00000000, @mcp23017.gpintenb.byte
+
+    assert_equal 0b00000000, @mcp23017.defvala.byte
+    assert_equal 0b00000000, @mcp23017.defvalb.byte
+
+    assert_equal 0b00000000, @mcp23017.intcona.byte
+    assert_equal 0b00000000, @mcp23017.intconb.byte
+
+    assert_equal 0b00000000, @mcp23017.iocon.byte
+
+    assert_equal 0b00000000, @mcp23017.gppua.byte
+    assert_equal 0b00000000, @mcp23017.gppub.byte
+
+    assert_equal 0b00000000, @mcp23017.intfa.byte
+    assert_equal 0b00000000, @mcp23017.intfb.byte
+
+    assert_equal 0b00000000, @mcp23017.intcapa.byte
+    assert_equal 0b00000000, @mcp23017.intcapb.byte
+
+    assert_equal 0b00000000, @mcp23017.gpioa.byte
+    assert_equal 0b00000000, @mcp23017.gpiob.byte
+
+    assert_equal 0b00000000, @mcp23017.olata.byte
+    assert_equal 0b00000000, @mcp23017.olatb.byte
+  end
+
+  def test_writing_byte_is_mirrored_on_bits
+    @mcp23017.iodira.byte = 0b00000000
+    assert_equal 0, @mcp23017.iodira.bit0
+    assert_equal 0, @mcp23017.iodira.bit1
+    assert_equal 0, @mcp23017.iodira.bit2
+    assert_equal 0, @mcp23017.iodira.bit3
+    assert_equal 0, @mcp23017.iodira.bit4
+    assert_equal 0, @mcp23017.iodira.bit5
+    assert_equal 0, @mcp23017.iodira.bit6
+    assert_equal 0, @mcp23017.iodira.bit7
+  end
+
+  def test_writing_bits_is_mirrored_on_byte
+    @mcp23017.iodira.bit1 = 0
+    @mcp23017.iodira.bit3 = 0
+    @mcp23017.iodira.bit5 = 0
+    @mcp23017.iodira.bit7 = 0
+    assert_equal 0b01010101, @mcp23017.iodira.byte
+  end
+end

data/test/device/mcp23017/test_write.rb

@@ -0,0 +1,49 @@
+require_relative '../mcp23017_test_helper'
+
+class MCP23017WriteTest < MCP23017Test
+  def test_single
+    seq = sequence('single')
+
+    @i2c_master.expects(:start).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001110).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0x15).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0b10101010).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:stop).with(nil).in_sequence(seq)
+
+    @mcp23017.olatb.byte = 0b10101010
+    @mcp23017.write :olatb
+  end
+
+  def test_multiple
+    seq = sequence('multiple')
+
+    @i2c_master.expects(:start).with(nil).in_sequence(seq)
+    
+    @i2c_master.expects(:write).with(0b01001110).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0x14).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0b01010101).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:restart).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:write).with(0b01001110).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0x15).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+    @i2c_master.expects(:write).with(0b10101010).in_sequence(seq)
+    @i2c_master.expects(:ack).with(nil).in_sequence(seq)
+
+    @i2c_master.expects(:stop).with(nil).in_sequence(seq)
+
+    @mcp23017.olata.byte = 0b01010101
+    @mcp23017.olatb.byte = 0b10101010
+    @mcp23017.write :olata, :olatb
+  end
+end