i2c-devices 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48ced98f8b85a2428ed61881a4cbca2de8df5c38
-  data.tar.gz: 8665b1e8b51a1fef07d4fe5347538543425769e4
+  metadata.gz: f2bb4b37022204715281e0f2410f0f630cc309d4
+  data.tar.gz: 8679f5547940d54b6ac03b5b39599f3d566b9c1f
 SHA512:
-  metadata.gz: 3d061a08b7e0e07b70fd889d23caf9a8f9d8059a86ce2b87406db6a4190632fa94f805684a083149031cbd0fcbf5973903085a9cafa720fb433e150630f96d2a
-  data.tar.gz: bd3ee03c6f6120ee54f2d9862d390fa972e26c974ed8f831f3acda95f9c22e4bd8bfc14cffa36afd33c27beb0ed33a9706fe9585c4ca42fe1e91202571938351
+  metadata.gz: fd7b98970e4d83b67286638d57f2896563f5cb8de142241a7909f100e71b11700e6ebdc81736abefcf356e86e34a6c4d06d8719d214647954c011097437c0867
+  data.tar.gz: fb036c7d5d2fce53bec00b9a264edc3d7e01be93063611d17a636c6d2f53e365ae067487384a2864c39691bfb941d57516a36c02da37d5a1da9d5aafdd63a00c

data/ChangeLog

@@ -1,6 +1,6 @@
 2014-02-20  SATOH Hiroh <cho45@lowreal.net>
 
 	* 0.0.1: initial release
-
 	* 0.0.2: Update module namespaces.
+	* 0.0.3: [FIX] Module structure
 

data/Rakefile

@@ -33,4 +33,6 @@ RDoc::Task.new do |rdoc|
 		"README.md",
 		"lib/**/*.rb"
 	)
+	# --format=
+	# rdoc.generator = 'bootstrap'
 end

data/i2c-devices.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |s|
 	s.homepage      = 'https://github.com/cho45/ruby-i2c-devices'
 	s.license       = 'MIT'
 	s.require_paths = ["lib"]
+	s.extra_rdoc_files = ['README.md']
+	s.rdoc_options << '--main' << 'README.md'
 
 	s.add_development_dependency "bundler", "~> 1.5"
 	s.add_development_dependency "rake"

data/lib/i2c.rb

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

data/lib/i2c/device/acm1602ni.rb

@@ -2,7 +2,8 @@
 
 require "i2c/device/hd44780"
 
-# Note: This device only run under speed=50kHz
+# 16x02 LCD module with I2C.
+# Note: This device only run under speed=50kHz.
 # http://akizukidenshi.com/catalog/g/gP-05693/
 class I2CDevice::ACM1602NI < I2CDevice::HD44780
 	def initialize(args={})

data/lib/i2c/device/adt7410.rb

@@ -2,20 +2,23 @@
 
 require "i2c"
 
+# Analog Devices ADT7410 (temperture sensor)
+# http://www.analog.com/en/mems-sensors/digital-temperature-sensors/adt7410/products/product.html
 class I2CDevice::ADT7410 < I2CDevice
-	OPERATION_MODE = {
+	
+	OPERATION_MODE = { # :nodoc:
 		0b00 => :continuous_conversion,
 		0b01 => :one_shot,
 		0b10 => :one_sps_mode,
 		0b11 => :shutdown,
 	}
 
-	INT_CT_MODE = {
+	INT_CT_MODE = { # :nodoc:
 		0 => :interrupt_mode,  
 		1 => :comparator_mode,
 	}
 
-	RESOLUTION = {
+	RESOLUTION = { # :nodoc:
 		0 => 13,
 		1 => 16,
 	}

data/lib/i2c/device/aqm0802.rb

@@ -24,7 +24,7 @@ class I2CDevice::AQM0802A < I2CDevice::HD44780
 	end
 
 
-	# must set is = 1 before call
+	# Must set is = 1 by function_set before call.
 	def internal_osc_frequency(bs, f)
 		raise "is must be 1" unless @is == 1
 		f &= 0b111
@@ -47,7 +47,7 @@ class I2CDevice::AQM0802A < I2CDevice::HD44780
 		sleep 300e-3
 	end
 
-	# is : instruction set 1: extension, 0: normal
+	# <tt>is</tt> :: [Integer]  Instruction set 1: extension, 0: normal
 	def function_set(dl, n, f, is)
 		@is = is
 		i2cset(0, 0b00100000 | (dl<<4) | (n<<3) | (f<<2) | (is))

data/lib/i2c/device/hd44780.rb

@@ -21,6 +21,8 @@ class I2CDevice::HD44780 < I2CDevice
 		initialize_lcd
 	end
 
+	# Initialize LCD controller sequence
+	# Display is cleared.
 	def initialize_lcd
 		function_set(1, 1, 0)
 		sleep 4.1e-3
@@ -32,6 +34,12 @@ class I2CDevice::HD44780 < I2CDevice
 		clear
 	end
 
+	# <tt>line</tt>  :: [Integer]      Line number
+	# <tt>str</tt>   :: [String]       Display string
+	# <tt>force</tt> :: [true | false] Write data forcely.
+	#
+	# Note: This method keep previous put_line strings and does not write without change.
+	# You must specify _force_ to override this behaviour.
 	def put_line(line, str, force=false)
 		str.force_encoding(Encoding::BINARY)
 		str.gsub!(/#{MAP.keys.join('|')}/, MAP)
@@ -48,17 +56,19 @@ class I2CDevice::HD44780 < I2CDevice
 		@lines[line] = str
 	end
 
+	# <tt>n</tt>     :: [Integer] Character code.
+	# <tt>array</tt> :: [Array[Integer]] Character data.
 	# Usage:
-	# lcd.define_character(0, [
-	# 	0,1,1,1,0,
-	# 	1,0,0,0,1,
-	# 	1,1,0,1,1,
-	# 	1,0,1,0,1,
-	# 	1,1,0,1,1,
-	# 	1,0,0,0,1,
-	# 	1,0,0,0,1,
-	# 	0,1,1,1,0,
-	# ])
+	#     lcd.define_character(0, [
+	#         0,1,1,1,0,
+	#         1,0,0,0,1,
+	#         1,1,0,1,1,
+	#         1,0,1,0,1,
+	#         1,1,0,1,1,
+	#         1,0,0,0,1,
+	#         1,0,0,0,1,
+	#         0,1,1,1,0,
+	#     ])
 	def define_character(n, array)
 		raise "n < 8" unless n < 8
 		raise "array size must be 40 (5x8)" unless array.size == 40
@@ -72,61 +82,86 @@ class I2CDevice::HD44780 < I2CDevice
 		sleep 60e-6
 	end
 
-	def clear
-		@lines.clear
-		clear_display
-	end
-
 	def clear_display
+		@lines.clear
 		i2cset(0, 0b00000001)
 		sleep 2.16e-3
 	end
 
+	alias clear_display clear
+
 	def return_home
 		i2cset(0, 0b00000010)
 		sleep 1.52e-3
 	end
 
-	# i_d : increment or decrement: 1: increment, 0: decrement
-	# s   : shift entire display: 1: left, 0: right
+	# <tt>i_d</tt> :: [Integer] Increment or decrement
+	#                           0 :: Decrement
+	#                           1 :: Increment
+	# <tt>s</tt>   :: [Integer] Shift entire display
+	#                           0 :: Right
+	#                           1 :: Left
 	def entry_mode_set(i_d, s)
 		i2cset(0, 0b00000100 | (i_d<<1) | (s))
 		sleep 60e-6
 	end
 
-	# d: set entire display on/off
-	# c: cursor on/off
-	# b: blink cursor
+	# <tt>d</tt> :: [Integer] Set entire display on/off
+	#                         0 :: Off
+	#                         1 :: On
+	# <tt>c</tt> :: [Integer] Cursor on/off
+	#                         0 :: Off
+	#                         1 :: On
+	# <tt>b</tt> :: [Integer] Blink cursor
+	#                         0 :: Off
+	#                         1 :: On
 	def display_on_off_control(d, c, b)
 		i2cset(0, 0b00001000 | (d<<2) | (c<<1) | (b))
 		sleep 60e-6
 	end
 
+	# <tt>s_c</tt> :: [Integer] Cursor or display
+	#                           0 :: Cursor shift
+	#                           1 :: Display shift
+	# <tt>r_l</tt> :: [Integer] Direction
+	#                           0 :: Left
+	#                           1 :: Right
 	def cursor_or_display_shift(s_c, r_l)
 		i2cset(0, 0b00010000 | (s_c<<3) | (r_l<<2))
 		sleep 60e-6
 	end
 
-	# dl  data_length: 1: 8bit, 0: 4bit
-	# n   number_of_display_lines: 1: 2-line, 0: 1-line
-	# f   character_font: 1: double font, 0: normal
+	# <tt>dl</tt> :: [Integer] Data length
+	#                          0 :: 4bit 
+	#                          1 :: 8bit 
+	# <tt>n</tt>  :: [Integer] Number of display lines
+	#                          0 :: 1-line
+	#                          1 :: 2-line
+	# <tt>f</tt>  :: [Integer] Character font
+	#                          0 :: Normal
+	#                          1 :: Double font
 	def function_set(dl, n, f)
 		i2cset(0, 0b00100000 | (dl<<4) | (n<<3) | (f<<2))
 		sleep 60e-6
 	end
 
+	# <tt>address</tt> :: [Integer] CGRAM address 6-bit
 	def set_cgram_address(address)
 		address = address & 0b00111111
 		i2cset(0, 0b01000000 | address)
 		sleep 60e-6
 	end
 
+	# <tt>address</tt> :: [Integer] DDRAM address 7-bit
 	def set_ddram_address(address)
 		address = address & 0b01111111
 		i2cset(0, 0b10000000 | address)
 		sleep 60e-6
 	end
 
+	# <tt>Returns</tt> :: [Hash] Result
+	#                            :busy            :: [true | false] Busy flag
+	#                            :address_counter :: [Integer] Current address count. 7-bit
 	def read_busy_flag_and_address
 		read = i2cget(0b01000000)
 		{

data/lib/i2c/driver.rb

@@ -1,16 +1,27 @@
 #!/usr/bin/env ruby
 
+require "i2c"
 
 module I2CDevice::Driver
 	# Abstract class for I2CDevice::Driver
-	class  I2CDevice::Driver::Base
+	class Base
 		include I2CDevice::Driver
 	end
 
+	# Low-level method for i2cget
+	# Driver must implement this.
+	# <tt>address</tt> :: [Integer] 7-bit slave address without r/w bit. MSB is always 0.
+	# <tt>data</tt>    :: [Array[Integer]] Writing bytes array.
+	# Returns          :: [String] Wrote bytes
 	def i2cget(address, param, length=1)
 		raise NotImplementedError
 	end
 
+	# Low-level method for i2cset
+	# Driver must implement this.
+	# <tt>address</tt> :: [Integer] 7-bit slave address without r/w bit. MSB is always 0.
+	# <tt>data</tt>    :: [Array[Integer]] Writing bytes array.
+	# Returns          :: [String] Wrote bytes
 	def i2cset(address, *data)
 		raise NotImplementedError
 	end

data/lib/i2c/driver/gpio.rb

@@ -5,195 +5,209 @@ Generic software I2C Driver based on /sys/class/gpio.
 THIS MODULE WORKS WITH VERY SLOW SPEED ABOUT JUST 1kHz (normaly 100kHz).
 =end
 
-module I2CDevice::Driver
-	class GPIO < Base
-		@@DEBUG = false
+class I2CDevice::Driver::GPIO < Base
+	@@DEBUG = false
 
-		def self.export(pin)
-			File.open("/sys/class/gpio/export", "w") do |f|
-				f.syswrite(pin)
-			end
+	def self.export(pin) #:nodoc: 
+		File.open("/sys/class/gpio/export", "w") do |f|
+			f.syswrite(pin)
 		end
+	end
 
-		def self.unexport(pin)
-			File.open("/sys/class/gpio/unexport", "w") do |f|
-				f.syswrite(pin)
-			end
+	def self.unexport(pin) #:nodoc: 
+		File.open("/sys/class/gpio/unexport", "w") do |f|
+			f.syswrite(pin)
 		end
+	end
 
-		def self.direction(pin, direction)
-			# [:in, :out, :high, :low].include?(direction) or raise "direction must be :in, :out, :high or :low"
-			File.open("/sys/class/gpio/gpio#{pin}/direction", "w") do |f|
-				f.syswrite(direction)
-			end
+	def self.direction(pin, direction) #:nodoc: 
+		# [:in, :out, :high, :low].include?(direction) or raise "direction must be :in, :out, :high or :low"
+		File.open("/sys/class/gpio/gpio#{pin}/direction", "w") do |f|
+			f.syswrite(direction)
 		end
+	end
 
-		def self.read(pin)
-			File.open("/sys/class/gpio/gpio#{pin}/value", "r") do |f|
-				f.sysread(1).to_i
-			end
+	def self.read(pin) #:nodoc: 
+		File.open("/sys/class/gpio/gpio#{pin}/value", "r") do |f|
+			f.sysread(1).to_i
 		end
+	end
 
-		def self.write(pin, val)
-			File.open("/sys/class/gpio/gpio#{pin}/value", "w") do |f|
-				f.syswrite(val && val.nonzero?? "1" : "0")
-			end
+	def self.write(pin, val) #:nodoc: 
+		File.open("/sys/class/gpio/gpio#{pin}/value", "w") do |f|
+			f.syswrite(val && val.nonzero?? "1" : "0")
 		end
+	end
 
-		def self.finalizer(ports)
-			proc do
-				ports.each do |pin|
-					GPIO.unexport(pin)
-				end
+	def self.finalizer(ports)  #:nodoc: 
+		proc do
+			ports.each do |pin|
+				GPIO.unexport(pin)
 			end
 		end
+	end
 
-		attr_reader :sda, :scl, :speed
-
-		def initialize(opts={})
-			@sda = opts[:sda] or raise "opts[:sda] = [gpio pin number] is required"
-			@scl = opts[:scl] or raise "opts[:scl] = [gpio pin number] is required"
-			@speed = opts[:speed] || 1 # kHz but insane
-			@clock = 1.0 / (@speed * 1000)
+	# Pin-number of SDA
+	attr_reader :sda
+	# Pin-number of SCL
+	attr_reader :scl
+	# Clock speed in kHz
+	attr_reader :speed
+
+	# <tt>opts[:sda]</tt>           :: [Integer] Pin-number of SDA
+	# <tt>opts[:scl]</tt>           :: [Integer] Pin-number of SCL
+	# <tt>[ opts[:speed] = 1 ]</tt> :: [Integer] Clock speed in kHz
+	def initialize(opts={})
+		@sda = opts[:sda] or raise "opts[:sda] = [gpio pin number] is required"
+		@scl = opts[:scl] or raise "opts[:scl] = [gpio pin number] is required"
+		@speed = opts[:speed] || 1 # kHz but insane
+		@clock = 1.0 / (@speed * 1000)
+
+		begin
+			GPIO.export(@sda)
+			GPIO.export(@scl)
+		rescue Errno::EBUSY => e
+		end
+		ObjectSpace.define_finalizer(self, self.class.finalizer([@scl, @sda]))
+		begin
+			GPIO.direction(@sda, :high)
+			GPIO.direction(@scl, :high)
+			GPIO.direction(@sda, :in)
+			GPIO.direction(@scl, :in)
+		rescue Errno::EACCES => e # writing to gpio after export is failed in a while
+			retry
+		end
+	end
 
-			begin
-				GPIO.export(@sda)
-				GPIO.export(@scl)
-			rescue Errno::EBUSY => e
-			end
-			ObjectSpace.define_finalizer(self, self.class.finalizer([@scl, @sda]))
-			begin
-				GPIO.direction(@sda, :high)
-				GPIO.direction(@scl, :high)
-				GPIO.direction(@sda, :in)
-				GPIO.direction(@scl, :in)
-			rescue Errno::EACCES => e # writing to gpio after export is failed in a while
-				retry
-			end
+	# Interface of I2CDevice::Driver
+	def i2cget(address, param, length=1)
+		ret = ""
+		start_condition
+		unless write( (address << 1) + 0)
+			raise I2CDevice::I2CIOError, "Unknown slave device (address:#{address})"
+		end
+		write(param)
+		stop_condition # AVR stucked with SCL low without this (Does not AVR support Sr condition?)
+		start_condition
+		unless write( (address << 1) + 1)
+			raise I2CDevice::I2CIOError, "Unknown slave device (address:#{address})"
 		end
+		length.times do |n|
+			ret << read(n != length - 1).chr
+		end
+		ret
+	ensure
+		stop_condition
+	end
 
-		def i2cget(address, param, length=1)
-			ret = ""
-			start_condition
-			unless write( (address << 1) + 0)
-				raise I2CDevice::I2CIOError, "Unknown slave device (address:#{address})"
-			end
-			write(param)
-			stop_condition # AVR stucked with SCL low without this (Does not AVR support Sr condition?)
-			start_condition
-			unless write( (address << 1) + 1)
-				raise I2CDevice::I2CIOError, "Unknown slave device (address:#{address})"
-			end
-			length.times do |n|
-				ret << read(n != length - 1).chr
+	# Interface of I2CDevice::Driver
+	def i2cset(address, *data)
+		sent = 0
+		start_condition
+		unless write( (address << 1) + 0)
+			raise I2CDevice::I2CIOError, "Unknown slave device (address:#{address})"
+		end
+		data.each do |c|
+			unless write(c)
+				break
 			end
-			ret
-		ensure
-			stop_condition
+			sent += 1
 		end
+		sent
+	ensure
+		stop_condition
+	end
 
-		def i2cset(address, *data)
-			sent = 0
-			start_condition
-			unless write( (address << 1) + 0)
-				raise I2CDevice::I2CIOError, "Unknown slave device (address:#{address})"
-			end
-			data.each do |c|
-				unless write(c)
-					break
-				end
-				sent += 1
-			end
-			sent
-		ensure
-			stop_condition
+	private
+
+	# Send start condition (or repeated start condition)
+	# raise I2CDevice::I2CBUSBusy if SCL line is low
+	def start_condition
+		p :start_condition if @@DEBUG
+		sleep @clock
+		GPIO.direction(@sda, :in)
+		GPIO.direction(@scl, :in)
+		if GPIO.read(@scl) == 0
+			raise I2CDevice::I2CBUSBusy, "BUS is busy"
 		end
 
-		private
+		sleep @clock / 2
+		GPIO.direction(@scl, :high)
+		sleep @clock / 2
+		GPIO.direction(@sda, :low)
+		sleep @clock
+	end
 
-		def start_condition
-			p :start_condition if @@DEBUG
-			sleep @clock
-			GPIO.direction(@sda, :in)
+	# Send stop condition.
+	def stop_condition
+		p :stop_condition if @@DEBUG
+		GPIO.direction(@scl, :low)
+		sleep @clock / 2
+		GPIO.direction(@sda, :low)
+		sleep @clock / 2
+		GPIO.direction(@scl, :in)
+		sleep @clock / 2
+		GPIO.direction(@sda, :in)
+		sleep @clock / 2
+	end
+
+	# Write one _byte_ to BUS.
+	def write(byte)
+		p [:write, byte] if @@DEBUG
+		GPIO.direction(@scl, :low)
+		sleep @clock
+
+		7.downto(0) do |n|
+			GPIO.direction(@sda, byte[n] == 1 ? :high : :low)
 			GPIO.direction(@scl, :in)
-			if GPIO.read(@scl) == 0
-				raise I2CDevice::I2CBUSBusy, "BUS is busy"
+			until GPIO.read(@scl) == 1
+				# clock streching
+				sleep @clock
 			end
-
-			sleep @clock / 2
-			GPIO.direction(@scl, :high)
-			sleep @clock / 2
-			GPIO.direction(@sda, :low)
 			sleep @clock
-		end
-
-		def stop_condition
-			p :stop_condition if @@DEBUG
 			GPIO.direction(@scl, :low)
-			sleep @clock / 2
-			GPIO.direction(@sda, :low)
-			sleep @clock / 2
-			GPIO.direction(@scl, :in)
-			sleep @clock / 2
-			GPIO.direction(@sda, :in)
-			sleep @clock / 2
+			GPIO.write(@sda, false)
+			sleep @clock
 		end
 
-		def write(byte)
-			p [:write, byte] if @@DEBUG
-			GPIO.direction(@scl, :low)
+		GPIO.direction(@sda, :in)
+		GPIO.direction(@scl, :in)
+		sleep @clock / 2
+		ack = GPIO.read(@sda) == 0
+		sleep @clock / 2
+		while GPIO.read(@scl) == 0
 			sleep @clock
+		end
+		GPIO.direction(@scl, :low)
+		ack
+	end
 
-			7.downto(0) do |n|
-				GPIO.direction(@sda, byte[n] == 1 ? :high : :low)
-				GPIO.direction(@scl, :in)
-				until GPIO.read(@scl) == 1
-					# clock streching
-					sleep @clock
-				end
-				sleep @clock
-				GPIO.direction(@scl, :low)
-				GPIO.write(@sda, false)
-				sleep @clock
-			end
+	# Read one byte from BUS.
+	# <tt>ack</tt>    :: [true|flase] Send ack for this read. 
+	# Returns         :: [Integer]    Byte
+	def read(ack=true)
+		p [:read, ack] if @@DEBUG
+		ret = 0
 
-			GPIO.direction(@sda, :in)
+		GPIO.direction(@scl, :low)
+		sleep @clock
+		GPIO.direction(@sda, :in)
+
+		8.times do
 			GPIO.direction(@scl, :in)
 			sleep @clock / 2
-			ack = GPIO.read(@sda) == 0
+			ret = (ret << 1) | GPIO.read(@sda)
 			sleep @clock / 2
-			while GPIO.read(@scl) == 0
-				sleep @clock
-			end
-			GPIO.direction(@scl, :low)
-			ack
-		end
-
-		def read(ack=true)
-			p [:read, ack] if @@DEBUG
-			ret = 0
-
 			GPIO.direction(@scl, :low)
 			sleep @clock
-			GPIO.direction(@sda, :in)
-
-			8.times do
-				GPIO.direction(@scl, :in)
-				sleep @clock / 2
-				ret = (ret << 1) | GPIO.read(@sda)
-				sleep @clock / 2
-				GPIO.direction(@scl, :low)
-				sleep @clock
-			end
+		end
 
-			GPIO.direction(@sda, ack ? :low : :high)
+		GPIO.direction(@sda, ack ? :low : :high)
 
-			GPIO.write(@scl, true)
-			sleep @clock
-			GPIO.write(@scl, false)
-			sleep @clock
-			ret
-		end
+		GPIO.write(@scl, true)
+		sleep @clock
+		GPIO.write(@scl, false)
+		sleep @clock
+		ret
 	end
 end
-

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

@@ -2,53 +2,56 @@
 require "i2c"
 require "i2c/driver"
 
-module I2CDevice::Driver
-	class I2CDev < Base
-		# ioctl command
-		# Ref. https://www.kernel.org/pub/linux/kernel/people/marcelo/linux-2.4/include/linux/i2c.h
-		I2C_RETRIES     = 0x0701
-		I2C_TIMEOUT     = 0x0702
-		I2C_SLAVE       = 0x0703
-		I2C_SLAVE_FORCE = 0x0706
-		I2C_TENBIT      = 0x0704
-		I2C_FUNCS       = 0x0705
-		I2C_RDWR        = 0x0707
-		I2C_SMBUS       = 0x0720
-		I2C_UDELAY      = 0x0705
-		I2C_MDELAY      = 0x0706
-
-		def initialize(path=nil)
-			if path.nil?
-				path = Dir.glob("/dev/i2c-*").sort.last
-			end
-
-			unless File.exist?(path)
-				raise I2CDevice::I2CIOError, "/dev/i2c-0 is required"
-			end
-
-			@path = path
+class I2CDevice::Driver::I2CDev < Base
+	# ioctl command
+	# Ref. https://www.kernel.org/pub/linux/kernel/people/marcelo/linux-2.4/include/linux/i2c.h
+	I2C_RETRIES     = 0x0701
+	I2C_TIMEOUT     = 0x0702
+	I2C_SLAVE       = 0x0703
+	I2C_SLAVE_FORCE = 0x0706
+	I2C_TENBIT      = 0x0704
+	I2C_FUNCS       = 0x0705
+	I2C_RDWR        = 0x0707
+	I2C_SMBUS       = 0x0720
+	I2C_UDELAY      = 0x0705
+	I2C_MDELAY      = 0x0706
+
+	# 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.
+	#
+	# If _path_ is not specified, this method use <tt>Dir.glob("/dev/i2c-*").last</tt> for _path_
+	def initialize(path=nil)
+		if path.nil?
+			path = Dir.glob("/dev/i2c-*").sort.last
 		end
 
-		def i2cget(address, param, length)
-			i2c = File.open(@path, "r+")
-			i2c.ioctl(I2C_SLAVE, address)
-			i2c.syswrite(param.chr)
-			ret = i2c.sysread(length)
-			i2c.close
-			ret
-		rescue Errno::EIO => e
-			raise I2CDevice::I2CIOError, e.message
+		unless File.exist?(path)
+			raise I2CDevice::I2CIOError, "/dev/i2c-0 is required"
 		end
 
-		def i2cset(address, *data)
-			i2c = File.open(@path, "r+")
-			i2c.ioctl(I2C_SLAVE, address)
-			i2c.syswrite(data.pack("C*"))
-			i2c.close
-		rescue Errno::EIO => e
-			raise I2CDevice::I2CIOError, e.message
-		end
+		@path = path
+	end
+
+	# Interface of I2CDevice::Driver
+	def i2cget(address, param, length)
+		i2c = File.open(@path, "r+")
+		i2c.ioctl(I2C_SLAVE, address)
+		i2c.syswrite(param.chr)
+		ret = i2c.sysread(length)
+		i2c.close
+		ret
+	rescue Errno::EIO => e
+		raise I2CDevice::I2CIOError, e.message
 	end
-end
 
+	# Interface of I2CDevice::Driver
+	def i2cset(address, *data)
+		i2c = File.open(@path, "r+")
+		i2c.ioctl(I2C_SLAVE, address)
+		i2c.syswrite(data.pack("C*"))
+		i2c.close
+	rescue Errno::EIO => e
+		raise I2CDevice::I2CIOError, e.message
+	end
+end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i2c-devices
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - cho45
@@ -42,7 +42,8 @@ description: i2c-devices is a drivers for i2c devices
 email: cho45@lowreal.net
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - .gitignore
 - ChangeLog
@@ -72,7 +73,9 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement