neotrellis 0.1.0

data/lib/neotrellis/seesaw.rb

@@ -0,0 +1,139 @@
+# Neotrellis - Driver for Adafruit's NeoTrellis keypad
+# Copyleft 2019 - Nicolas AGIUS <nicolas.agius@lps-it.fr>
+
+###########################################################################
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+###########################################################################
+
+require 'i2c'
+
+# Monkey patch, sorry
+class Numeric
+	# Helper to display hex number as string
+	def to_shex
+		"0x%02X" % [self]
+	end
+end
+
+module Neotrellis
+	# Driver for Seesaw i2c generic conversion chip.
+	# See https://www.adafruit.com/product/3657 for example board.
+	#
+	# @example Display Seesaw's device version
+	#   seesaw = Neotrellis::Seesaw.new(device: "/dev/i2c-1", addr: 0x2E)
+	#   puts seesaw.version
+	class Seesaw
+
+		DEFAULT_I2C_ADDR = 0x49  # Default SeeSaw I2C address
+
+		private
+			# SeeSaw hardware ID
+			HW_ID_CODE = 0x55
+
+			# Internal SeeSaw registers
+			STATUS_BASE = 0x00
+			STATUS_SWRST = 0x7F
+			STATUS_HW_ID = 0x01
+			STATUS_VERSION = 0x02
+
+		public
+
+		# Initialize a Seesaw chip on the i2c bus.
+		# It use the i2c kernel driver to communicate with the chip.
+		#
+		# @param device [String] Linux I2C-dev file the SeeSaw device is connected to
+		# @param addr [Integer] I2C address of the SeeSaw device
+		# @param debug [Boolean] Enable debug ouput on stdout
+		def initialize(device: '/dev/i2c-0', addr: DEFAULT_I2C_ADDR, debug: false)
+			@i2c = I2C.create(device)
+			@addr = addr
+			@debug = debug
+
+			sw_reset
+		rescue I2C::AckError
+			STDERR.puts "I2C initialization error, check your wiring and I2C addresses."
+			raise
+		end
+
+		# Trigger a software reset of the SeeSaw chip
+		def sw_reset()
+			write(STATUS_BASE, STATUS_SWRST, 0xFF)
+
+			# Give some time to the device to reset (but not when testing)
+			sleep(0.5) unless testing?
+
+			chip_id = read_byte(STATUS_BASE, STATUS_HW_ID)
+
+			if chip_id != HW_ID_CODE
+				raise "Seesaw hardware ID returned #{chip_id.to_shex} is not correct! Expected #{HW_ID_CODE.to_shex}. Please check your wiring."
+			end
+		end
+
+		# Get the version of the Seesaw chip
+		#
+		# @return [Integer] Version number
+		def version()
+			# 4 bytes for Unsigned Int Big Endian
+			@i2c.read(@addr, 4, STATUS_BASE, STATUS_VERSION).unpack('I>').first
+		end
+
+		# Read a byte from a Seesaw register
+		#
+		# @param base_reg [Byte] Base register address
+		# @param function_reg [Byte] Function register address
+		#
+		# @return [Byte] Value read in the given register
+		def read_byte(base_reg, function_reg)
+			read_raw(1, base_reg, function_reg).ord
+		end
+
+		# Read bytes from a Seesaw register
+		#
+		# @param size [Integer] Number of bytes to read
+		# @param base_reg [Byte] Base register address
+		# @param function_reg [Byte] Function register address
+		#
+		# @return [Array] Array of bytes read in the given register
+		def read_bytes(size, base_reg, function_reg)
+			read_raw(size, base_reg, function_reg).unpack("C#{size}")
+		end
+
+		# Write data to the given register
+		#
+		# @param base_reg [Byte] Base register address
+		# @param function_reg [Byte] Function register address
+		# @param data [Array] Data to write. Must be an array of bytes or a binary string with big endian format
+		def write(base_reg, function_reg, *data)
+			puts "DEBUG: I2C WRITE: %02X %02X %s" % [base_reg, function_reg, data.map{|i| "%02X" % [i]}.join(' ')] if @debug
+			@i2c.write(@addr, base_reg, function_reg, *data)
+		end
+
+		private
+
+		def read_raw(size, base_reg, function_reg)
+			data = @i2c.read(@addr, size, base_reg, function_reg)
+			puts "DEBUG: I2C READ: %02X %02X %s" % [base_reg, function_reg, data.unpack("C#{size}").map{|i| "%02X" % [i]}.join(' ')] if @debug
+
+			data
+		end
+
+		def testing?
+			ENV['RSPEC_TEST']&.downcase == 'true'
+		end
+	end
+end
+
+# vim: ts=4:sw=4:ai

data/lib/neotrellis/version.rb

@@ -0,0 +1,6 @@
+module Neotrellis
+	# Version number
+	VERSION = "0.1.0"
+end
+
+# vim: ts=4:sw=4:ai

data/neotrellis.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "neotrellis/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "neotrellis"
+  spec.version       = Neotrellis::VERSION
+  spec.authors       = ["Nicolas AGIUS"]
+  spec.email         = ["nicolas.agius@lps-it.fr"]
+
+  spec.summary       = %q{Neotrellis is a ruby driver for Adafruit's NeoTrellis keypad.}
+  spec.homepage      = "https://github.com/nagius/neotrellis"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "i2c", "~>0.4" 
+  spec.add_runtime_dependency "ya_gpio", "~>0.1" 
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: neotrellis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas AGIUS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i2c
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: ya_gpio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- nicolas.agius@lps-it.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- datasheets/adafruit-neotrellis.pdf
+- datasheets/neotrellis.jpg
+- datasheets/seesaw-atsamd09.pdf
+- lib/neotrellis.rb
+- lib/neotrellis/keypad.rb
+- lib/neotrellis/neopixel.rb
+- lib/neotrellis/seesaw.rb
+- lib/neotrellis/version.rb
+- neotrellis.gemspec
+homepage: https://github.com/nagius/neotrellis
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nagius/neotrellis
+  source_code_uri: https://github.com/nagius/neotrellis
+post_install_message: 
+rdoc_options: []
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Neotrellis is a ruby driver for Adafruit's NeoTrellis keypad.
+test_files: []