i2c-devices 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3513dbcf14f87bf4c6f8c53b3b5e26a0c82f406
-  data.tar.gz: bf21da782f160272187c5631fa50c8f8b22d11f1
+  metadata.gz: 48ced98f8b85a2428ed61881a4cbca2de8df5c38
+  data.tar.gz: 8665b1e8b51a1fef07d4fe5347538543425769e4
 SHA512:
-  metadata.gz: 03e1802fbca28f590fda962582901c34dcd35755c93d7d050ca02eb7808853110eb1b7e30254edd666f9a6d69bfbe57985aab31c2c77ef10354a23d098e967f8
-  data.tar.gz: 5309612e7dd287a78e315566b707da4deb4e9466d3e26b699ed4e0b568e1bc481830304948e07c251c7fa3cc454a699307a0e12c5e3dbe692971fc58bee78beb
+  metadata.gz: 3d061a08b7e0e07b70fd889d23caf9a8f9d8059a86ce2b87406db6a4190632fa94f805684a083149031cbd0fcbf5973903085a9cafa720fb433e150630f96d2a
+  data.tar.gz: bd3ee03c6f6120ee54f2d9862d390fa972e26c974ed8f831f3acda95f9c22e4bd8bfc14cffa36afd33c27beb0ed33a9706fe9585c4ca42fe1e91202571938351

data/.gitignore

@@ -1,3 +1,3 @@
 *.gem
 sketch.rb
-
+html

data/ChangeLog

@@ -2,3 +2,5 @@
 
 	* 0.0.1: initial release
 
+	* 0.0.2: Update module namespaces.
+

data/Rakefile

@@ -1,3 +1,4 @@
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 require 'pathname'
 
@@ -12,6 +13,10 @@ RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
 task :release do
+	tags = `git tag`.split(/\n/)
+	if tags.include? I2CDevice::VERSION
+		raise "Already exist tag #{I2CDevice::VERSION}"
+	end
 	sh %{gem build i2c-devices.gemspec}
 	sh %{gem push i2c-devices-#{I2CDevice::VERSION}.gem}
 	sh %{git add -u}
@@ -20,3 +25,12 @@ task :release do
 	sh %{git push}
 	sh %{git push --tags}
 end
+
+
+RDoc::Task.new do |rdoc|
+	rdoc.main = "README.md"
+	rdoc.rdoc_files.include(
+		"README.md",
+		"lib/**/*.rb"
+	)
+end

data/lib/i2c.rb

@@ -1,12 +1,17 @@
+# Generic abstract class for I2C manipulation.
 class I2CDevice
-	VERSION = "0.0.1"
+	VERSION = "0.0.2"
 
+	# Super class of all of this library.
 	class I2CException < Exception; end
 	class I2CIOError < I2CException; end
 	class I2CBUSBusy < I2CIOError; end
 
+	# Slave address
 	attr_accessor :address
 
+	# <tt>args[:address]</tt> :: [Integer] 7-bit slave address without r/w bit. MSB is always 0.
+	# <tt>args[:driver]</tt>  :: [I2CDevice::Driver::I2CDev] Instance of driver class
 	def initialize(args={})
 		if args[:driver].nil?
 			require "i2c/driver/i2c-dev"
@@ -17,10 +22,22 @@ class I2CDevice
 		@address = args[:address] or raise I2CException, "args[:address] required"
 	end
 
+	# This method read data from slave with following process:
+	#
+	# 1. Write `param` to slave
+	# 2. re-start
+	# 3. Read data until NACK or `length`
+	#
+	# <tt>param</tt>    :: [Integer] First writing byte. Typically, this is slave memory address.
+	# <tt>length=1</tt> :: [Integer] Read bytes length
+	# Returns           :: [String] Bytes
 	def i2cget(param, length=1)
 		@driver.i2cget(@address, param, length)
 	end
 
+	# Write _data_ to slave.
+	# <tt>data</tt>     :: [Array[Integer]] Writing bytes array.
+	# Returns           :: [String] Wrote bytes
 	def i2cset(*data)
 		@driver.i2cset(@address, *data)
 	end

data/lib/i2c/device/acm1602ni.rb

@@ -4,7 +4,7 @@ require "i2c/device/hd44780"
 
 # Note: This device only run under speed=50kHz
 # http://akizukidenshi.com/catalog/g/gP-05693/
-class ACM1602NI < HD44780
+class I2CDevice::ACM1602NI < I2CDevice::HD44780
 	def initialize(args={})
 		args[:address] ||= 0x50
 		super

data/lib/i2c/device/adt7410.rb

@@ -2,7 +2,7 @@
 
 require "i2c"
 
-class ADT7410 < I2CDevice
+class I2CDevice::ADT7410 < I2CDevice
 	OPERATION_MODE = {
 		0b00 => :continuous_conversion,
 		0b01 => :one_shot,

data/lib/i2c/device/aqm0802.rb

@@ -3,7 +3,7 @@
 require "i2c"
 require "i2c/device/hd44780"
 
-class AQM0802A < HD44780
+class I2CDevice::AQM0802A < I2CDevice::HD44780
 	def initialize(args={})
 		args[:address] ||= 0x3e
 		super

data/lib/i2c/device/hd44780.rb

@@ -3,7 +3,7 @@
 require "i2c"
 
 # I2C interface with HD44780 compatible commands
-class HD44780 < I2CDevice
+class I2CDevice::HD44780 < I2CDevice
 	MAP = Hash[
 		[
 			"｡｢｣､・ｦｧｨｩｪｫｬｭｮｯｰｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜﾝﾞﾟ".split(//).map {|c|

data/lib/i2c/device/mpl115a2.rb

@@ -1,7 +1,7 @@
 
 require "i2c"
 
-class MPL115A2 < I2CDevice
+class I2CDevice::MPL115A2 < I2CDevice
 	def initialize(args={})
 		args[:address] = 0x60
 		super

data/lib/i2c/driver.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+
+module I2CDevice::Driver
+	# Abstract class for I2CDevice::Driver
+	class  I2CDevice::Driver::Base
+		include I2CDevice::Driver
+	end
+
+	def i2cget(address, param, length=1)
+		raise NotImplementedError
+	end
+
+	def i2cset(address, *data)
+		raise NotImplementedError
+	end
+end
+

data/lib/i2c/driver/gpio.rb

@@ -1,11 +1,12 @@
 require "i2c"
+require "i2c/driver"
 =begin
 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
+	class GPIO < Base
 		@@DEBUG = false
 
 		def self.export(pin)

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

@@ -1,8 +1,9 @@
 
 require "i2c"
+require "i2c/driver"
 
 module I2CDevice::Driver
-	class I2CDev
+	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

data/spec/device/adt7410_spec.rb

@@ -1,15 +1,15 @@
 #!rspec
 
 
-$LOAD_PATH.unshift "lib"
+$LOAD_PATH.unshift "lib", "."
 
 require "tempfile"
 
 require "i2c/device/adt7410"
 require "i2c/driver/i2c-dev"
-require "i2c/mocki2cdevice"
+require "spec/mocki2cdevice"
 
-describe ADT7410 do
+describe I2CDevice::ADT7410 do
 	before do
 		@mock = MockI2CDevice.new
 		File.stub(:open) do
@@ -27,7 +27,7 @@ describe ADT7410 do
 				@mock.memory[0x00] = 0b00000000
 				@mock.memory[0x01] = 0b00000001
 
-				device = ADT7410.new(address: 0x50, driver: @driver)
+				device = I2CDevice::ADT7410.new(address: 0x50, driver: @driver)
 				expect(device.read_configuration).to eq({
 					:fault_queue      => 1,
 					:ct_pin_polarity  => false,
@@ -46,7 +46,7 @@ describe ADT7410 do
 				@mock.memory[0x00] = 0b10000000
 				@mock.memory[0x01] = 0b00000000
 
-				device = ADT7410.new(address: 0x50, driver: @driver)
+				device = I2CDevice::ADT7410.new(address: 0x50, driver: @driver)
 				expect(device.calculate_temperature).to eq(-256)
 			end
 		end
@@ -59,7 +59,7 @@ describe ADT7410 do
 				@mock.memory[0x00] = 0b00000000
 				@mock.memory[0x01] = 0b00001000
 
-				device = ADT7410.new(address: 0x50, driver: @driver)
+				device = I2CDevice::ADT7410.new(address: 0x50, driver: @driver)
 				device.configuration({
 					resolution: 13,
 				})
@@ -74,7 +74,7 @@ describe ADT7410 do
 				@mock.memory[0x00] = 0b11100100
 				@mock.memory[0x01] = 0b10000000
 
-				device = ADT7410.new(address: 0x50, driver: @driver)
+				device = I2CDevice::ADT7410.new(address: 0x50, driver: @driver)
 				device.configuration({
 					resolution: 13,
 				})

data/spec/device/hd44780_spec.rb

@@ -8,7 +8,7 @@ require "tempfile"
 require "i2c/device/hd44780"
 require "i2c/driver/i2c-dev"
 
-describe HD44780 do
+describe I2CDevice::HD44780 do
 	before do
 		@i2cout = ""
 		@i2cin  = ""
@@ -41,7 +41,7 @@ describe HD44780 do
 
 	describe "#initialize_lcd" do
 		it "should initialize lcd" do
-			lcd = HD44780.new(address: 0x10, driver: @driver)
+			lcd = I2CDevice::HD44780.new(address: 0x10, driver: @driver)
 
 			expect(@i2cout.unpack("C*")).to eq([
 				0b00000000,
@@ -62,7 +62,7 @@ describe HD44780 do
 
 	describe "#put_line" do
 		it "should be put_line 1/2" do
-			lcd = HD44780.new(address: 0x10, driver: @driver)
+			lcd = I2CDevice::HD44780.new(address: 0x10, driver: @driver)
 
 			@i2cout.clear
 
@@ -122,7 +122,7 @@ describe HD44780 do
 
 	describe "#define_character" do
 		it "should define character" do
-			lcd = HD44780.new(address: 0x10, driver: @driver)
+			lcd = I2CDevice::HD44780.new(address: 0x10, driver: @driver)
 
 			@i2cout.clear
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i2c-devices
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - cho45
@@ -55,13 +55,14 @@ files:
 - lib/i2c/device/aqm0802.rb
 - lib/i2c/device/hd44780.rb
 - lib/i2c/device/mpl115a2.rb
+- lib/i2c/driver.rb
 - lib/i2c/driver/gpio.rb
 - lib/i2c/driver/i2c-dev.rb
-- lib/i2c/mocki2cdevice.rb
 - spec/device/adt7410_spec.rb
 - spec/device/hd44780_spec.rb
 - spec/driver/gpio_spec.rb
 - spec/i2cdevice_spec.rb
+- spec/mocki2cdevice.rb
 - xt/acm1602ni.rb
 - xt/driver-gpio.rb
 - xt/i2cdetect.rb
@@ -95,3 +96,4 @@ test_files:
 - spec/device/hd44780_spec.rb
 - spec/driver/gpio_spec.rb
 - spec/i2cdevice_spec.rb
+- spec/mocki2cdevice.rb