i2c-devices 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 246d5743687852c69c063e4bdcb689320446ce70
-  data.tar.gz: ca1a2ca228efb4273a950b5f6cf75f54c4abb2d7
+  metadata.gz: abd7319b1639effcf37ef2584d1dd5fcc846878d
+  data.tar.gz: 9ac7dbc2ce4960681f32bfc80af3024754d90977
 SHA512:
-  metadata.gz: a5275d90cca868f5529428dcc26498883a61979b36e35ff7306086665a3df190cdffb8cb46204f8668cdfd833264ab67229a23a7fc368c3983feb38481444c5a
-  data.tar.gz: c1526218e9e11d57affcc896dbe0f747e1ccdc7d7ba69e1fc4c629eb41e0bcdd90531fb58d4d4c32935713b7feca3b42fdd51b69e0a281c49d85886fdc892705
+  metadata.gz: 9f3e71d8dbb775c36e9d4339a3ece41363b555df1e6bec0e2bf3f21e53b606f907620fc4a0531a40cd43ddbb70a5ab084a31c57b20895f13b54adc7c485bcd95
+  data.tar.gz: 80d576eff61fc748facb7708df9731f152f38bcdcdc5d6f8a83fe05ebe55b11ca972d6aac6cdf469705c1e671d73dc1095be423fc1c40f6809db4b4d4d1967c8

data/README.md

@@ -10,7 +10,7 @@ Usage of I2CDevice class directly:
 
 ```
 require "i2c"
-
+require "i2c/driver/i2c-dev"
 device = I2CDevice.new(address: 0x60, driver: I2CDevice::Driver::I2CDev.new("/dev/i2c-1"))
 
 # like i2c-tools's i2cget command

data/lib/i2c.rb

@@ -1,6 +1,6 @@
 # Generic abstract class for I2C manipulation.
 class I2CDevice
-	VERSION = "0.0.5"
+	VERSION = "0.0.6"
 
 	# Super class of all of this library.
 	class I2CException < Exception; end

data/lib/i2c/device/bmp180.rb

@@ -0,0 +1,207 @@
+require 'i2c'
+
+# Implements the I2C-Device BMP085/BMP180
+# This code was inspired by https://github.com/adafruit/Adafruit_Python_BMP
+#
+# Datasheet: https://www.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf
+#
+# Currently this code was tested on a Banana Pi with a BMP185 device. It should work on a Raspberry or any other Linux with I2C-Dev
+#
+# ==Example
+#   Using i2c-2 device (e.g. if you using a banana pi)
+#
+#   bmp = I2CDevice::Bmp180.new(driver: I2CDevice::Driver::I2CDev.new("/dev/i2c-2"), mode: 0)
+#   puts "#{bmp.read_temperature / 10.0}°C"
+#   sleep 1
+#   puts "#{bmp.read_pressure / 100.0}hPa abs"
+#   sleep 1
+#   m_above_sealevel = 500 # position realtive to sealevel in m
+#   puts "#{bmp.read_sealevel_pressure(m_above_sealevel) / 100.0}hPa rel"
+#
+class I2CDevice::Bmp180 < I2CDevice
+    # BMP085 default address.
+    BMP085_I2CADDR           = 0x77
+
+    # Operating Modes
+    BMP085_ULTRALOWPOWER     = 0
+    BMP085_STANDARD          = 1
+    BMP085_HIGHRES           = 2
+    BMP085_ULTRAHIGHRES      = 3
+
+    # BMP085 Registers
+    BMP085_CAL_AC1           = 0xAA  # R   Calibration data (16 bits)
+    BMP085_CAL_AC2           = 0xAC  # R   Calibration data (16 bits)
+    BMP085_CAL_AC3           = 0xAE  # R   Calibration data (16 bits)
+    BMP085_CAL_AC4           = 0xB0  # R   Calibration data (16 bits) unsigned
+    BMP085_CAL_AC5           = 0xB2  # R   Calibration data (16 bits) unsigned
+    BMP085_CAL_AC6           = 0xB4  # R   Calibration data (16 bits) unsigned
+    BMP085_CAL_B1            = 0xB6  # R   Calibration data (16 bits)
+    BMP085_CAL_B2            = 0xB8  # R   Calibration data (16 bits)
+    BMP085_CAL_MB            = 0xBA  # R   Calibration data (16 bits)
+    BMP085_CAL_MC            = 0xBC  # R   Calibration data (16 bits)
+    BMP085_CAL_MD            = 0xBE  # R   Calibration data (16 bits)
+    BMP085_CONTROL           = 0xF4
+    BMP085_TEMPDATA          = 0xF6
+    BMP085_PRESSUREDATA      = 0xF6
+
+    # Commands
+    BMP085_READTEMPCMD       = 0x2E
+    BMP085_READPRESSURECMD   = 0x34
+
+    # initialize the device and read the calibration registers
+    #
+    # ==params
+    #  * args : hash defaults to {}
+    #  ** :mode : one of BMP085_ULTRALOWPOWER | BMP085_STANDARD | BMP085_HIGHRES | BMP085_ULTRAHIGHRES defaults to BMP085_STANDARD see datasheet for more information
+    #  ** :address : device address defaults to 0x77
+    def initialize(args={})
+        @mode = args.delete(:mode) || BMP085_STANDARD
+        args = {
+        address: BMP085_I2CADDR
+        }.merge(args)
+
+        super args
+
+        raise "Mode must be between #{BMP085_ULTRALOWPOWER} and #{BMP085_ULTRAHIGHRES}" unless [BMP085_ULTRALOWPOWER, BMP085_STANDARD, BMP085_HIGHRES, BMP085_ULTRAHIGHRES].include?(@mode)
+
+        calibration
+    end
+
+    # read the current real temperature in 0.1°C
+    def read_temperature
+        return calc_real_temperature(read_raw_temperature)
+    end
+
+    # read the current relative pressure in Pa
+    def read_pressure
+        return calc_real_pressure(read_raw_temperature, read_raw_pressure)
+    end
+
+    # Read current temperature and realtive pressure
+    #
+    # ==return
+    #  * temperature in 0.1°C, pressure in Pa
+    def read_temperature_and_pressure
+        ut = read_raw_temperature
+        up = read_raw_pressure
+
+        return calc_real_temperature(ut), calc_real_pressure(ut, up)
+    end
+
+    # calculate the current pressure at sealevel from the current relative pressure and the gitven altitude
+    #
+    # ==params
+    #  * altitude : curren altitude above sealevel in m defaults to 0
+    def read_sealevel_pressure(altitude = 0.0)
+        pressure = read_pressure()
+        return cacl_sealevel_pressure(pressure, altitude)
+    end
+
+    # calculate the current pressure at sealevel from the given relative pressure and the gitven altitude
+    #
+    # ==params
+    #  * altitude : curren altitude above sealevel in m
+    #  * pressure : current relative pressure in Pa
+    def cacl_sealevel_pressure(pressure, altitude)
+        return pressure.to_f / ((1.0 - altitude.to_f / 44330.0) ** 5.255)
+    end
+    
+    # get the calibration values
+    #
+    # ==return
+    #  array of calibration data
+    def get_cal
+        return @cal_AC1, @cal_AC2, @cal_AC3, @cal_AC4, @cal_AC5, @cal_AC6, @cal_B1, @cal_B2, @cal_MB, @cal_MC, @cal_MD
+    end
+
+  private
+    # read the current raw temperature value
+    def read_raw_temperature
+        i2cset(BMP085_CONTROL, BMP085_READTEMPCMD)
+        sleep 0.005
+        return i2cget(BMP085_TEMPDATA, 2).unpack('s>')[0]
+    end
+
+    # read the current raw pressure value
+    def read_raw_pressure
+        i2cset(BMP085_CONTROL, BMP085_READPRESSURECMD + (@mode << 6))
+
+        if @mode == BMP085_ULTRALOWPOWER
+        sleep 0.005
+        elsif @mode == BMP085_HIGHRES
+        sleep 0.014
+        elsif @mode == BMP085_ULTRAHIGHRES
+        sleep 0.026
+        else
+        sleep 0.008
+        end
+
+        sleep 1 # safety for testing
+
+        msb, lsb, xlsb  = i2cget(BMP085_PRESSUREDATA, 3).unpack('C*')
+        up  = ((msb << 16) + (lsb << 8) + xlsb) >> (8 - @mode)
+
+        return up
+    end
+
+    # load the calibration registers into instance variables
+    def calibration
+        @cal_AC1, @cal_AC2, @cal_AC3, @cal_AC4, @cal_AC5, @cal_AC6, @cal_B1, @cal_B2,
+            @cal_MB, @cal_MC, @cal_MD = i2cget(BMP085_CAL_AC1, 22).unpack('s>s>s>S>S>S>s>s>s>s>s>')
+    end
+
+    # calculate the read temperature using the calibration registers
+    #
+    # ==params
+    #  * ut : raw templerature value
+    # ==return
+    #  true temperature in 0.1°C -> 150 = 15.0 °C
+    def calc_real_temperature(ut)
+        x1 = ((ut - @cal_AC6) * @cal_AC5)  / 2**15
+        x2 = (@cal_MC * 2**11) / (x1 + @cal_MD)
+        b5 = x1 + x2
+        t = (b5 + 8) / 2**4
+
+        return t
+    end
+
+    # calculate the read pressure using the calibration registers
+    #
+    # ==params
+    #  * up : raw pressure value
+    # ==return
+    #  true pressure in Pa
+    def calc_real_pressure(ut, up)
+        x1 = ((ut - @cal_AC6) * @cal_AC5) / 2**15
+        x2 = (@cal_MC * 2**11) / (x1 + @cal_MD)
+        b5 = x1 + x2
+
+        # Pressure Calculations
+        b6 = b5 - 4000
+        x1 = (@cal_B2 * (b6 * b6) / 2**12) / 2**11
+        x2 = (@cal_AC2 * b6) / 2**11
+        x3 = x1 + x2
+        b3 = (((@cal_AC1 * 4 + x3) << @mode) + 2) / 4
+
+        x1 = (@cal_AC3 * b6) / 2**13
+        x2 = (@cal_B1 * ((b6 * b6) / 2**12)) / 2**16
+        x3 = ((x1 + x2) + 2) / 2**2
+        b4 = (@cal_AC4 * (x3 + 32768)) / 2**15
+
+        b7 = (up - b3) * (50000 >> @mode)
+
+        if b7 < 0x80000000
+            pr = (b7 * 2) / b4
+        else
+            pr = (b7 / b4) * 2
+        end
+
+        x1 = (pr / 2**8) * (pr / 2**8)
+        x1 = (x1 * 3038) / 2**16
+        x2 = (-7357 * pr) / 2**16
+        pr += ((x1 + x2 + 3791) / 2**4)
+
+        return pr
+    end
+
+end 

data/lib/i2c/device/d6t-44l.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+
+class I2CDevice::D6T44L < I2CDevice
+	class InvalidParityException < Exception; end
+
+	def initialize(args={})
+		args[:address] = 0x0a
+		super
+	end
+
+	def read_data
+		data = i2cget(0x4c, 35)
+		unless checkPEC(data, false)
+			raise InvalidParityException
+		end
+
+		# PTAT はセンサ内部の参照温度データ
+		ptat, *pixels = data[0..-2].unpack("v*")
+		{
+			:PTAT => ptat,
+			:PIXELS => pixels.each_slice(4).to_a
+		}
+	end
+
+	private
+	def calc_crc(data)
+		8.times do
+			tmp = data
+			data = (data << 1) & 0xff
+			if tmp & 0x80 != 0
+				data ^= 0x07
+			end
+		end
+		data
+	end
+
+	def checkPEC(data, userr=true)
+		crc = 0
+		if userr
+			crc = calc_crc(0x14)
+			crc = calc_crc(0x4c ^ crc)
+			crc = calc_crc(0x15 ^ crc)
+		else
+			crc = calc_crc(0x15)
+		end
+		(data.size - 1).times do |i|
+			crc = calc_crc(data[i].ord ^ crc)
+		end
+		data[data.size-1].ord == crc
+	end
+end

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

@@ -18,9 +18,13 @@ class I2CDevice::Driver::I2CDev < I2CDevice::Driver::Base
 
 	# This depends on /dev/i2c-* (i2c-dev) feature on Linux. You may load i2c-dev kernel module.
 	# <tt>path</tt> :: [String] Path to /dev/i2c-* file.
-	#
+	# <tt>force</tt> :: [Boolean] Force the driver to read or set values even if the device is in use. 
+  #                   This is dangerous, as it can seriously confuse the kernel driver in question. 
+  #                   It can also cause i2cget and i2cset to writ to the wrong register. 
+  #                   Use at your own risk and only if you know what you're doing.
+  #
 	# If _path_ is not specified, this method use <tt>Dir.glob("/dev/i2c-*").last</tt> for _path_
-	def initialize(path=nil)
+	def initialize(path=nil, force=false)
 		if path.nil?
 			path = Dir.glob("/dev/i2c-*").sort.last
 		end
@@ -30,12 +34,13 @@ class I2CDevice::Driver::I2CDev < I2CDevice::Driver::Base
 		end
 
 		@path = path
+    @slave_command = force ? I2C_SLAVE_FORCE : I2C_SLAVE
 	end
 
 	# Interface of I2CDevice::Driver
 	def i2cget(address, param, length)
 		i2c = File.open(@path, "r+")
-		i2c.ioctl(I2C_SLAVE, address)
+		i2c.ioctl(@slave_command, address)
 		i2c.syswrite(param.chr) unless param.nil?
 		ret = i2c.sysread(length)
 		i2c.close
@@ -47,7 +52,7 @@ class I2CDevice::Driver::I2CDev < I2CDevice::Driver::Base
 	# Interface of I2CDevice::Driver
 	def i2cset(address, *data)
 		i2c = File.open(@path, "r+")
-		i2c.ioctl(I2C_SLAVE, address)
+		i2c.ioctl(@slave_command, address)
 		i2c.syswrite(data.pack("C*"))
 		i2c.close
 	rescue Errno::EIO => e

data/spec/device/adt7410_spec.rb

@@ -12,7 +12,7 @@ require "spec/mocki2cdevice"
 describe I2CDevice::ADT7410 do
 	before do
 		@mock = MockI2CDevice.new
-		File.stub(:open) do
+		allow(File).to receive(:open) do
 			@mock.open
 		end
 		@driver = I2CDevice::Driver::I2CDev.new(@mock.path)

data/spec/device/bmp180_spec.rb

@@ -0,0 +1,90 @@
+#!rspec
+
+$LOAD_PATH.unshift "lib"
+
+require "tempfile"
+
+require "i2c/device/bmp180"
+require "i2c/driver/i2c-dev"
+require "spec/mocki2cdevice"
+
+describe I2CDevice::Bmp180 do
+	before do
+		@mock = MockI2CDevice.new
+		allow(File).to receive(:open) do
+			@mock.open
+		end
+		
+		(0x00..0xFF).each do |i|
+		   @mock.memory[i] =0x00
+		end
+
+		# Write example calibration data from datasheet
+		@mock.memory[0xAA] = 0x01
+		@mock.memory[0xAB] = 0x98
+		@mock.memory[0xAC] = 0xFF
+		@mock.memory[0xAD] = 0xB8
+		@mock.memory[0xAE] = 0xC7
+		@mock.memory[0xAF] = 0xD1
+		@mock.memory[0xB0] = 0x7F
+		@mock.memory[0xB1] = 0xE5
+		@mock.memory[0xB2] = 0x7F
+		@mock.memory[0xB3] = 0xF5
+		@mock.memory[0xB4] = 0x5A
+		@mock.memory[0xB5] = 0x71
+		@mock.memory[0xB6] = 0x18
+		@mock.memory[0xB7] = 0x2E
+		@mock.memory[0xB8] = 0x00
+		@mock.memory[0xB9] = 0x04
+		@mock.memory[0xBA] = 0x80
+		@mock.memory[0xBB] = 0x01
+		@mock.memory[0xBC] = 0xDD
+		@mock.memory[0xBD] = 0XF9
+		@mock.memory[0xBE] = 0x0B
+		@mock.memory[0xBF] = 0x34
+		
+		@driver = I2CDevice::Driver::I2CDev.new(@mock.path)
+	end
+	
+	describe "do read and calculate temperature" do
+		it "should reand and calculate temperature" do
+			bmp = I2CDevice::Bmp180.new(driver: @driver)
+			expect(bmp.get_cal).to eq([408, -72, -14383, 32741, 32757, 23153, 6190, 4, -32767, -8711, 2868])
+			@mock.memory[0xF6] = 0x6C
+			@mock.memory[0xF7] = 0xFA
+			
+			expect(bmp.read_temperature).to eq(150) # Temperature 0.1C -> 15.0C
+			expect(@mock.memory[0XF4]).to eq(0x2E)
+		end
+	end
+	
+	describe "do read and calculate pressure" do
+		it "should reand and calculate pressure" do
+			bmp = I2CDevice::Bmp180.new(driver: @driver)
+			expect(bmp.get_cal).to eq([408, -72, -14383, 32741, 32757, 23153, 6190, 4, -32767, -8711, 2868])
+			@mock.memory[0xF6] = 0x5D
+			@mock.memory[0xF7] = 0x33
+
+			# expect(bmp.read_pressure).to eq(69964) # datasheet test at 15.0C
+			
+			# Using 0x5D, 0x33 as temp and pressure -> 63524Pa at -26.8C
+			expect(bmp.read_pressure).to eq(63524) # pressure in Pa
+			expect(@mock.memory[0xF4]).to eq(0x74) # 0x34 + (mode << 6) with mode = 1
+		end
+	end
+
+	describe "do read and calculate relative pressure" do
+		it "should reand and calculate relative pressure" do
+			bmp = I2CDevice::Bmp180.new(driver: @driver)
+			expect(bmp.get_cal).to eq([408, -72, -14383, 32741, 32757, 23153, 6190, 4, -32767, -8711, 2868])
+			@mock.memory[0xF6] = 0x5D
+			@mock.memory[0xF7] = 0x33
+
+			# at sea level
+			expect(bmp.read_sealevel_pressure(0)).to eq(63524) # pressure in Pa
+			# at 500m above sea level
+			expect(bmp.read_sealevel_pressure(500).to_i).to eq(67425) # pressure in Pa
+		end
+	end
+	
+end

data/spec/device/hd44780_spec.rb

@@ -29,7 +29,7 @@ describe I2CDevice::HD44780 do
 		@temp = Tempfile.new("i2c")
 		file = nil
 		open = File.method(:open)
-		File.stub(:open) do
+		allow(File).to receive(:open) do
 			file = open.call(@temp.path, "r+")
 			file.define_singleton_method(:ioctl) {|cmd,arg| ioctl.call(ioctl) }
 			file.define_singleton_method(:syswrite) {|str| syswrite.call(str) }

data/spec/driver/gpio_spec.rb

@@ -331,7 +331,7 @@ describe I2CDevice::Driver::GPIO do
 	describe "i2c abstract interface:" do
 		it "should initialize with sda, scl properties" do
 			expect { I2CDevice::Driver::GPIO.new() }.to raise_error(/required/)
-			expect { I2CDevice::Driver::GPIO.new(sda: 1) }.to raise_error
+			expect { I2CDevice::Driver::GPIO.new(sda: 1) }.to raise_error(/required/)
 			expect { I2CDevice::Driver::GPIO.new(sda: 1, scl: 2) }.not_to raise_error
 		end
 

data/spec/i2cdevice_spec.rb

@@ -27,7 +27,7 @@ describe I2CDevice do
 		@temp = Tempfile.new("i2c")
 		file = nil
 		open = File.method(:open)
-		File.stub(:open) do
+		allow(File).to receive(:open) do
 			file = open.call(@temp.path, "r+")
 			file.define_singleton_method(:ioctl) {|cmd,arg| ioctl.call(cmd, arg) }
 			file.define_singleton_method(:syswrite) {|str| syswrite.call(str) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i2c-devices
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - cho45
@@ -14,28 +14,28 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: i2c-devices is a drivers for i2c devices
@@ -45,7 +45,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
+- .gitignore
 - ChangeLog
 - README.md
 - Rakefile
@@ -54,6 +54,8 @@ files:
 - lib/i2c/device/acm1602ni.rb
 - lib/i2c/device/adt7410.rb
 - lib/i2c/device/aqm0802.rb
+- lib/i2c/device/bmp180.rb
+- lib/i2c/device/d6t-44l.rb
 - lib/i2c/device/hd44780.rb
 - lib/i2c/device/hdc1000.rb
 - lib/i2c/device/mpl115a2.rb
@@ -61,6 +63,7 @@ files:
 - lib/i2c/driver/gpio.rb
 - lib/i2c/driver/i2c-dev.rb
 - spec/device/adt7410_spec.rb
+- spec/device/bmp180_spec.rb
 - spec/device/hd44780_spec.rb
 - spec/driver/gpio_spec.rb
 - spec/i2cdevice_spec.rb
@@ -77,28 +80,29 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: i2c device drivers
 test_files:
 - spec/device/adt7410_spec.rb
+- spec/device/bmp180_spec.rb
 - spec/device/hd44780_spec.rb
 - spec/driver/gpio_spec.rb
 - spec/i2cdevice_spec.rb