i2c 0.4.2.dev → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2254a2d32b8a0d9feb7e7718477e4bca157a521d
-  data.tar.gz: 918e34eca0c218eab8330efa1ee5b71426c91625
+  metadata.gz: 67d39ae8002f56f83353c642d7eda7d04ac00533
+  data.tar.gz: 0aa819ee206b76f7db54d20c46841b6dcc919187
 SHA512:
-  metadata.gz: 453ebbf2217f1ca9e105c95cd188b1c9d08c311d7a913927312ca7aabfaed490c0836052076e07425f5709a9409430f75626d1d064e3e40c047a0f20b8980c00
-  data.tar.gz: fbd3cd2ea165014d405a781591f13c88b96bc018c9a31cc223bdac2490c8859dc4a1969b2902d85a2546fe4a133b22a00280fcdd2fbe5730c25eef827b774890
+  metadata.gz: 7835158a580b3a5b8dccf31b66ab579515a527be631474f943edc651587b5426c3428ae63d11759eaa813bf293cabb180e3b0c58afc5e1743a8a77232bc9f836
+  data.tar.gz: 321dfa963f27de78e8afe95ed93a74d087d8e1abe9e11863c3977d2a256734041aed280826d3eba5a6fee97eb3543f81da4c68bc335acb503b4370af666071c0

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

@@ -7,113 +7,117 @@
 # License Version 2.
 #
 module I2C
-  class Dev
-    # see i2c-dev.h
-    I2C_SLAVE = 0x0703
-
-    def self.create(device_path)
-      raise Errno::ENOENT, "Device #{device_path} not found." unless File.exists?(device_path)
-      @instances ||= Hash.new
-      @instances[device_path] = Dev.new(device_path) unless @instances.has_key?(device_path)
-      @instances[device_path]
-    end
-
-	 attr_reader :comsMutex
-
-	 # this tries to lock the coms mutex, unless already held,
-    # then sends every param, begining with +params[0]+
-    # If the current param is a Fixnum, it is treated as one byte.
-    # If the param is a String, this string will be sent byte by byte.
-    # You can use Array#pack to create a string from an array
-    # For Fixnum there is a convenient function to_short which transforms
-    # the number to a string this way: 12345.to_short == [12345].pack("s")
-    def write(address, *params)
-		if(@comsMutex.owned?)
-		 	keepLock = true;
-		else
-			@comsMutex.lock;
+	class Dev
+		# see i2c-dev.h
+		I2C_SLAVE = 0x0703
+
+		def self.create(device_path)
+			raise Errno::ENOENT, "Device #{device_path} not found." unless File.exists?(device_path)
+			@instances ||= Hash.new
+			@instances[device_path] = Dev.new(device_path) unless @instances.has_key?(device_path)
+			@instances[device_path]
 		end
 
-		setup_device(address);
-		raw_write(params);
-
-		@comsMutex.unlock() unless keepLock;
-    end
-
-	 # this tries to lock the coms mutex (unless already held),
-    # then sends *params, if given, and then tries to read
-    # +size+ bytes. The result is a String which can be treated with
-    # String#unpack afterwards
-    def read(address, size, *params)
-		 if(@comsMutex.owned?)
-			 keepLock = true;
-		 else
-			 @comsMutex.lock;
-		 end
-
-		setup_device(address);
-		raw_write(params) unless params.empty?
-		result = raw_read(size);
-
-		@comsMutex.unlock() unless keepLock;
-		return result;
-    end
+		attr_reader :comsMutex
+
+		# this tries to lock the coms mutex, unless already held,
+		# then sends every param, begining with +params[0]+
+		# If the current param is a Fixnum, it is treated as one byte.
+		# If the param is a String, this string will be sent byte by byte.
+		# You can use Array#pack to create a string from an array
+		# For Fixnum there is a convenient function to_short which transforms
+		# the number to a string this way: 12345.to_short == [12345].pack("s")
+		def write(address, *params)
+			if(@comsMutex.owned?)
+				keepLock = true;
+			else
+				@comsMutex.lock;
+			end
+
+			begin
+				setup_device(address);
+				raw_write(params);
+			ensure
+				@comsMutex.unlock() unless keepLock;
+			end
+		end
 
-    # Read a byte from the current address. Return a one char String which
-    # can be treated with String#unpack
-    def read_byte(address)
-   	read(address, 1);
-    end
+		# this tries to lock the coms mutex (unless already held),
+		# then sends *params, if given, and then tries to read
+		# +size+ bytes. The result is a String which can be treated with
+		# String#unpack afterwards
+		def read(address, size, *params)
+			if(@comsMutex.owned?)
+				keepLock = true;
+			else
+				@comsMutex.lock;
+			end
+
+			begin
+				setup_device(address);
+				raw_write(params) unless params.empty?
+				result = raw_read(size);
+			ensure
+				@comsMutex.unlock() unless keepLock;
+				return result;
+			end
+		end
 
-    private
-	 # Set up @device for a I2C communication to address
-	 def setup_device(address)
-		 @device.ioctl(I2C_SLAVE, address);
-	 end
+		# Read a byte from the current address. Return a one char String which
+		# can be treated with String#unpack
+		def read_byte(address)
+			read(address, 1);
+		end
 
-	 # Read size bytes from @device, if possible. Raise an error otherwise
-	 def raw_read(size)
-		 return @device.sysread(size)
-	 end
+		private
+		# Set up @device for a I2C communication to address
+		def setup_device(address)
+			@device.ioctl(I2C_SLAVE, address);
+		end
 
-	 # Write "params" to @device, unrolling them first should they be an array.
-	 # params should be a string, formatted with Array.pack as explained for write()
-	 def raw_write(params)
-		 data = String.new();
-		 data.force_encoding("US-ASCII")
+		# Read size bytes from @device, if possible. Raise an error otherwise
+		def raw_read(size)
+			return @device.sysread(size)
+		end
 
-		 if(params.is_a? Array)
-			 params.each do |i| data << i; end
-		 else
-			 data << params;
-		 end
+		# Write "params" to @device, unrolling them first should they be an array.
+		# params should be a string, formatted with Array.pack as explained for write()
+		def raw_write(params)
+			data = String.new();
+			data.force_encoding("US-ASCII")
 
-		 @device.syswrite(data);
-	 end
+			if(params.is_a? Array)
+				params.each do |i| data << i; end
+			else
+				data << params;
+			end
 
-    def initialize(device_path)
-		@comsMutex = Mutex.new();
+			@device.syswrite(data);
+		end
 
-      @device = File.new(device_path, 'r+')
-      # change the sys* functions of the file object to meet our requirements
-      class << @device
-        alias :syswrite_orig :syswrite
-        def syswrite(var)
-          begin
-            syswrite_orig var
-          rescue Errno::EREMOTEIO, Errno::EIO
-            raise AckError, "No acknowledge received"
-          end
-        end
-        alias :sysread_orig :sysread
-        def sysread(var)
-          begin
-            sysread_orig var
-          rescue Errno::EREMOTEIO, Errno::EIO
-            raise AckError, "No acknowledge received"
-          end
-        end
-      end # class
-    end # initialize
-  end
-end
+		def initialize(device_path)
+			@comsMutex = Mutex.new();
+
+			@device = File.new(device_path, 'r+')
+			# change the sys* functions of the file object to meet our requirements
+			class << @device
+				alias :syswrite_orig :syswrite
+				def syswrite(var)
+					begin
+						syswrite_orig var
+					rescue Errno::EREMOTEIO, Errno::EIO
+						raise AckError, "No acknowledge received"
+					end
+				end
+				alias :sysread_orig :sysread
+				def sysread(var)
+					begin
+						sysread_orig var
+					rescue Errno::EREMOTEIO, Errno::EIO
+						raise AckError, "No acknowledge received"
+					end
+				end
+			end # virtual class
+		end # initialize
+	end # Class
+end # Module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i2c
 version: !ruby/object:Gem::Version
-  version: 0.4.2.dev
+  version: 0.4.2
 platform: ruby
 authors:
 - Christoph Anderegg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-06-15 00:00:00.000000000 Z
 dependencies: []
 description: Interface to I2C (aka TWI) implementations. Also provides abstractions
   for some I2c-devices. Created with the Raspberry Pi in mind.
@@ -43,9 +43,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14.1