apiotics_factory 1.0.0

data/lib/templates/grove_pi/i2c/driver/gpio.rb

@@ -0,0 +1,213 @@
+require_relative "../../i2c"
+require_relative "../../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
+
+class I2CDevice::Driver::GPIO < I2CDevice::Driver::Base
+	@@DEBUG = false
+
+	def self.export(pin) #:nodoc: 
+		File.open("/sys/class/gpio/export", "w") do |f|
+			f.syswrite(pin)
+		end
+	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) #: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) #:nodoc: 
+		File.open("/sys/class/gpio/gpio#{pin}/value", "r") do |f|
+			f.sysread(1).to_i
+		end
+	end
+
+	def self.write(pin, val) #:nodoc: 
+		File.open("/sys/class/gpio/gpio#{pin}/value", "w") do |f|
+			f.syswrite(val ? "1" : "0")
+		end
+	end
+
+	def self.finalizer(ports)  #:nodoc: 
+		proc do
+			ports.each do |pin|
+				GPIO.unexport(pin)
+			end
+		end
+	end
+
+	# 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
+
+	# 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
+
+	# 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
+			sent += 1
+		end
+		sent
+	ensure
+		stop_condition
+	end
+
+	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
+
+		sleep @clock / 2
+		GPIO.direction(@scl, :high)
+		sleep @clock / 2
+		GPIO.direction(@sda, :low)
+		sleep @clock
+	end
+
+	# 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)
+			until GPIO.read(@scl) == 1
+				# clock streching
+				sleep @clock
+			end
+			sleep @clock
+			GPIO.direction(@scl, :low)
+			GPIO.write(@sda, false)
+			sleep @clock
+		end
+
+		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
+
+	# 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(@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
+
+		GPIO.direction(@sda, ack ? :low : :high)
+
+		GPIO.write(@scl, true)
+		sleep @clock
+		GPIO.write(@scl, false)
+		sleep @clock
+		ret
+	end
+end

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

@@ -0,0 +1,60 @@
+require_relative "../../i2c"
+require_relative "../../i2c/driver"
+
+class I2CDevice::Driver::I2CDev < I2CDevice::Driver::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.
+	# <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, force=false)
+		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
+    @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(@slave_command, address)
+		i2c.syswrite(param.chr) unless param.nil?
+		ret = i2c.sysread(length)
+		i2c.close
+		ret
+	rescue Errno::EIO => e
+		raise I2CDevice::I2CIOError, e.message
+	end
+
+	# Interface of I2CDevice::Driver
+	def i2cset(address, *data)
+		i2c = File.open(@path, "r+")
+		i2c.ioctl(@slave_command, address)
+		i2c.syswrite(data.pack("C*"))
+		i2c.close
+	rescue Errno::EIO => e
+		raise I2CDevice::I2CIOError, e.message
+	end
+end

data/lib/templates/grove_pi/i2c/driver.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require_relative "../i2c"
+
+module I2CDevice::Driver
+	# Abstract class for I2CDevice::Driver
+	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
+end

data/lib/templates/grove_pi/i2c/i2c.rb

@@ -0,0 +1,45 @@
+# Generic abstract class for I2C manipulation.
+class I2CDevice
+	VERSION = "0.0.6"
+
+	# 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"
+			args[:driver] = I2CDevice::Driver::I2CDev.new
+		end
+
+		@driver  = args[:driver]
+		@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
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: apiotics_factory
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Apiotics
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A gem to quickly create stub drivers for Apiotics devices.
+email: info@apiotics.com
+executables:
+- apiotics_factory
+extensions: []
+extra_rdoc_files: []
+files:
+- License
+- bin/apiotics_factory
+- lib/apiotics_factory.rb
+- lib/apiotics_factory/clear_credentials.rb
+- lib/apiotics_factory/configuration.rb
+- lib/apiotics_factory/generator.rb
+- lib/apiotics_factory/my_command.rb
+- lib/apiotics_factory/portal.rb
+- lib/apiotics_factory/publish.rb
+- lib/apiotics_factory/underscore.rb
+- lib/apiotics_factory/version.rb
+- lib/templates/apiotics_driver.rb.erb
+- lib/templates/apiotics_interfaces.rb.erb
+- lib/templates/config.json.erb
+- lib/templates/exec.rb.erb
+- lib/templates/grove_pi/grove_pi.rb
+- lib/templates/grove_pi/i2c/device/acm1602ni.rb
+- lib/templates/grove_pi/i2c/device/adt7410.rb
+- lib/templates/grove_pi/i2c/device/aqm0802.rb
+- lib/templates/grove_pi/i2c/device/bmp180.rb
+- lib/templates/grove_pi/i2c/device/d6t-44l.rb
+- lib/templates/grove_pi/i2c/device/hd44780.rb
+- lib/templates/grove_pi/i2c/device/hdc1000.rb
+- lib/templates/grove_pi/i2c/device/mpl115a2.rb
+- lib/templates/grove_pi/i2c/driver.rb
+- lib/templates/grove_pi/i2c/driver/gpio.rb
+- lib/templates/grove_pi/i2c/driver/i2c-dev.rb
+- lib/templates/grove_pi/i2c/i2c.rb
+homepage: https://www.apiotics.com
+licenses:
+- Apiotics Factory License
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Gem To Generate Apiotics Drivers
+test_files: []