pi_driver 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db8ff0ea07f81396952ed0e32dcb93568789b07b
-  data.tar.gz: f9bbf070326600cc2baa2af12753a71660f0924c
+  metadata.gz: 3a7911c66c972390a7e29125befb058062ca4843
+  data.tar.gz: 96117a7d39eb4ff1b0a391ee672a9c49b0460353
 SHA512:
-  metadata.gz: 305c2726c2f1063ebb0159f7ff50d99a1655e94cdd6c812c2801c80bb155f7b7c45a66aadc9cdff1389efa5bd009c862757b876610961a82603bccebc373458d
-  data.tar.gz: 6e50dda35d0213b347ddc5fb0ae5577cdaa8256bd9d1fb341fc99732fb8a0dadc311d63c3073fae83b3b2207b94a17acf448cca6a2dc3d5e85ffdfaf55fee4a0
+  metadata.gz: 4b63ed0825623d485602850e0f70ae8ad2d5768a9a2145b11b1c97cd37698622e19ab5f14e2c61833e81fe3e7ca7fc6ddc5e65e9b4ca962b3c577d80828fa9db
+  data.tar.gz: 1d0249b62cf2f6e653178760dc17e3b8caf7d62a83bd22096b4b48ef38d211b1e0967bcea18f2cbfe5eccb3da0183418e23de228aea9481160ae8341b28d82b5

data/lib/pi_driver.rb

@@ -1,5 +1,7 @@
-require_relative 'pi_driver/pin'
+require_relative 'pi_driver/device'
 require_relative 'pi_driver/i2c_master'
+require_relative 'pi_driver/pin'
+require_relative 'pi_driver/utils'
 
 module PiDriver
 end

data/lib/pi_driver/device.rb

@@ -0,0 +1,6 @@
+require_relative 'device/mcp23017'
+
+module PiDriver
+  class Device
+  end
+end

data/lib/pi_driver/device/mcp23017.rb

@@ -0,0 +1,129 @@
+require_relative 'mcp23017/hardware_address'
+require_relative 'mcp23017/port'
+require_relative 'mcp23017/register'
+require_relative 'mcp23017/register/iodir'
+require_relative 'mcp23017/register/ipol'
+require_relative 'mcp23017/register/gpinten'
+require_relative 'mcp23017/register/defval'
+require_relative 'mcp23017/register/intcon'
+require_relative 'mcp23017/register/iocon'
+require_relative 'mcp23017/register/gppu'
+require_relative 'mcp23017/register/intf'
+require_relative 'mcp23017/register/intcap'
+require_relative 'mcp23017/register/gpio'
+require_relative 'mcp23017/register/olat'
+
+module PiDriver
+  class Device
+    class MCP23017
+      attr_reader :hardware_address
+
+      def initialize(options = {})
+        @argument_helper = Utils::ArgumentHelper.new prefix: "MCP23017"
+        @i2c_master = options[:i2c_master]
+        @hardware_address = HardwareAddress.new observer: self
+        update_opcodes
+      end
+
+      def update_registers
+        bank = registers[:iocon].bank
+        registers.each do |_, register|
+          register.update_address bank
+        end
+      end
+
+      def update_opcodes
+        bits = [0, 1, 0, 0, @hardware_address.a2, @hardware_address.a1, @hardware_address.a0]
+        base = Utils::Byte.bits_to_byte(bits)
+        @opcode_for_write = PiDriver::I2CMaster.prepare_address_for_write base
+        @opcode_for_read = PiDriver::I2CMaster.prepare_address_for_read base
+      end
+
+      def write(*register_array)
+        @i2c_master.start
+
+        register_array.each_with_index do |register, index|
+          @argument_helper.check(:register, register, registers.keys)
+
+          @i2c_master.write @opcode_for_write
+          @i2c_master.ack
+          @i2c_master.write registers[register].address
+          @i2c_master.ack
+          @i2c_master.write registers[register].byte
+          @i2c_master.ack
+
+          @i2c_master.restart unless index == register_array.length - 1
+        end
+
+        @i2c_master.stop
+      end
+
+      def read(*register_array)
+        @i2c_master.start
+
+        register_array.each_with_index do |register, index|
+          @argument_helper.check(:register, register, registers.keys)
+
+          @i2c_master.write @opcode_for_write
+          @i2c_master.ack
+          @i2c_master.write registers[register].address
+          @i2c_master.ack
+
+          @i2c_master.restart
+
+          @i2c_master.write @opcode_for_read
+          @i2c_master.ack
+          registers[register].byte = @i2c_master.read
+
+          @i2c_master.restart unless index == register_array.length - 1
+        end
+
+        @i2c_master.stop
+      end
+
+      private
+
+      def self.register_reader(*register_array)
+        register_array.each do |register|
+          define_method register do
+            registers[register]
+          end
+        end
+      end
+
+      register_reader :iodira, :iodirb
+      register_reader :ipola, :ipolb
+      register_reader :gpintena, :gpintenb
+      register_reader :defvala, :defvalb
+      register_reader :intcona, :intconb
+      register_reader :iocon
+      register_reader :gppua, :gppub
+      register_reader :intfa, :intfb
+      register_reader :intcapa, :intcapb
+      register_reader :gpioa, :gpiob
+      register_reader :olata, :olatb
+
+      def registers
+        @registers ||= initialize_registers
+      end
+
+      def initialize_registers
+        {
+          iodira: Iodir.new(port: :a),      iodirb: Iodir.new(port: :b),
+          ipola: Ipol.new(port: :a),        ipolb: Ipol.new(port: :b),
+          gpintena: Gpinten.new(port: :a),  gpintenb: Gpinten.new(port: :b),
+          defvala: Defval.new(port: :a),    defvalb: Defval.new(port: :b),
+          intcona: Intcon.new(port: :a),    intconb: Intcon.new(port: :b),
+
+          iocon: Iocon.new(observer: self),
+
+          gppua: Gppu.new(port: :a),        gppub: Gppu.new(port: :b),
+          intfa: Intf.new(port: :a),        intfb: Intf.new(port: :b),
+          intcapa: Intcap.new(port: :a),    intcapb: Intcap.new(port: :b),
+          gpioa: Gpio.new(port: :a),        gpiob: Gpio.new(port: :b),
+          olata: Olat.new(port: :a),        olatb: Olat.new(port: :b)
+        }
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/hardware_address.rb

@@ -0,0 +1,37 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class HardwareAddress
+        attr_reader :a0, :a1, :a2
+
+        def initialize(options)
+          @argument_helper = Utils::ArgumentHelper.new prefix: "MCP23017::HardwareAddress"
+
+          @observer = options.delete :observer
+
+          @a0 = Utils::State::LOW
+          @a1 = Utils::State::LOW
+          @a2 = Utils::State::LOW
+        end
+
+        private
+
+        def self.address_writer(*addresses)
+          addresses.each do |address|
+            setter_symbol = "#{address}=".to_sym
+            getter_instance = "@#{address}"
+
+            define_method setter_symbol do |value|
+              @argument_helper.check(:hardware_address, value, Utils::State::VALID_STATES)
+              instance_variable_set(getter_instance, value)
+              @observer.update_opcodes
+              instance_variable_get getter_instance
+            end
+          end
+        end
+
+        address_writer :a0, :a1, :a2
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/port.rb

@@ -0,0 +1,23 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Port
+        A = :a
+        B = :b
+
+        VALID_PORTS = [
+          A,
+          B
+        ]
+
+        def self.default(options)
+          if options[:register] == MCP23017::Register::RegisterHelper::IODIR
+            Utils::Byte::ALL_BITS_HIGH
+          else
+            Utils::Byte::ALL_BITS_LOW
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register.rb

@@ -0,0 +1,98 @@
+require_relative 'register/register_helper'
+
+# for class level methods
+require_relative '../../utils'
+
+module PiDriver
+  class Device
+    class MCP23017
+      class Register
+        attr_reader :address, :byte
+
+        def initialize(options)
+          @argument_helper = Utils::ArgumentHelper.new prefix: "MCP23017::Register"
+
+          @register = options[:register]
+          @port = options[:port]
+          options[:bank] = Utils::State::LOW
+
+          @address = RegisterHelper.address options
+          @byte = Port.default options
+
+          mirror_bits_from_byte
+        end
+
+        def byte=(value)
+          @argument_helper.check(:register_byte, value, Utils::Byte::VALID_BYTES)
+          @byte = value
+          mirror_bits_from_byte
+          @byte
+        end
+
+        def update_address(bank)
+          options = { register: @register, port: @port, bank: bank }
+          @address = RegisterHelper.address options
+        end
+
+        private
+
+        def self.bit_accessors
+          Utils::Byte::NUM_BITS_PER_BYTE.times do |bit_number|
+            string = "bit#{bit_number}"
+
+            getter_symbol = string.to_sym
+            setter_symbol = "#{string}=".to_sym
+
+            getter_instance = "@#{getter_symbol}"
+
+            define_method getter_symbol do
+              instance_variable_get getter_instance
+            end
+
+            define_method setter_symbol do |value|
+              @argument_helper.check(:register_bit, value, Utils::State::VALID_STATES)
+              instance_variable_set(getter_instance, value)
+              mirror_byte_from_bits
+              instance_variable_get getter_instance
+            end
+          end
+        end
+
+        bit_accessors
+
+        def self.mirror_bit_accessors(prefix_symbol)
+          Utils::Byte::NUM_BITS_PER_BYTE.times do |bit_number|
+            bit_string = "bit#{bit_number}"
+            new_string = "#{prefix_symbol}#{bit_number}"
+
+            bit_getter_symbol = bit_string.to_sym
+            bit_setter_symbol = "#{bit_string}=".to_sym
+
+            new_getter_symbol = new_string.to_sym
+            new_setter_symbol = "#{new_string}=".to_sym
+
+            alias_method new_getter_symbol, bit_getter_symbol
+            alias_method new_setter_symbol, bit_setter_symbol
+          end
+        end
+
+        def mirror_bits_from_byte
+          byte_bits = Utils::Byte::byte_to_bits(@byte)
+
+          @bit0 = byte_bits.pop
+          @bit1 = byte_bits.pop
+          @bit2 = byte_bits.pop
+          @bit3 = byte_bits.pop
+          @bit4 = byte_bits.pop
+          @bit5 = byte_bits.pop
+          @bit6 = byte_bits.pop
+          @bit7 = byte_bits.pop
+        end
+
+        def mirror_byte_from_bits
+          @byte = Utils::Byte::bits_to_byte [@bit7, @bit6, @bit5, @bit4, @bit3, @bit2, @bit1, @bit0]
+        end
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/defval.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Defval < Register
+        def initialize(options)
+          options[:register] = :defval
+          super(options)
+        end
+
+        mirror_bit_accessors :def
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/gpinten.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Gpinten < Register
+        def initialize(options)
+          options[:register] = :gpinten
+          super(options)
+        end
+
+        mirror_bit_accessors :gpint
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/gpio.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Gpio < Register
+        def initialize(options)
+          options[:register] = :gpio
+          super(options)
+        end
+
+        mirror_bit_accessors :gp
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/gppu.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Gppu < Register
+        def initialize(options)
+          options[:register] = :gppu
+          super(options)
+        end
+
+        mirror_bit_accessors :pu
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/intcap.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Intcap < Register
+        def initialize(options)
+          options[:register] = :intcap
+          super(options)
+        end
+
+        mirror_bit_accessors :icp
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/intcon.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Intcon < Register
+        def initialize(options)
+          options[:register] = :intcon
+          super(options)
+        end
+
+        mirror_bit_accessors :ioc
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/intf.rb

@@ -0,0 +1,14 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Intf < Register
+        def initialize(options)
+          options[:register] = :intf
+          super(options)
+        end
+
+        mirror_bit_accessors :int
+      end
+    end
+  end
+end

data/lib/pi_driver/device/mcp23017/register/iocon.rb

@@ -0,0 +1,41 @@
+module PiDriver
+  class Device
+    class MCP23017
+      class Iocon < Register
+        def initialize(options)
+          @observer = options.delete :observer
+          options[:register] = :iocon
+          # IOCON is a single register with two addresses, go with PORT A
+          options[:port] = :a
+          super(options)
+        end
+
+        def bit7=(value)
+          super
+          @observer.update_registers
+        end
+
+        alias_method :bank, :bit7
+        alias_method :bank=, :bit7=
+
+        alias_method :mirror, :bit6
+        alias_method :mirror=, :bit6=
+
+        alias_method :seqop, :bit5
+        alias_method :seqop=, :bit5=
+
+        alias_method :disslw, :bit4
+        alias_method :disslw=, :bit4=
+
+        alias_method :haen, :bit3
+        alias_method :haen=, :bit3=
+
+        alias_method :odr, :bit2
+        alias_method :odr=, :bit2=
+
+        alias_method :intpol, :bit1
+        alias_method :intpol=, :bit1=
+      end
+    end
+  end
+end