mruby-linux-i2c 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46c4225897adb0648942d42ea1e4eb65c243e61a2af6de9c504879f3c1afcd5c
+  data.tar.gz: eafb1599d08a9815f626117fce36808c4c65ad882ce67421bb66480c0ede0ffd
+SHA512:
+  metadata.gz: 85391b9c9aa58c83499536de06aea0b8abddf4ae0d4d036888c3981cdbdb604dc91720b98d04c1cdc4f6cda7986ca3b8a5e5f5d3fda607ee3b7e51a5bd9d2506
+  data.tar.gz: b43912f6aa1f1369a202cc56e3ee1331600d5790b22c9be7a44cf7932b0468809880172bd05250e5c3ab3f25f5de922de53bef099e9017b5fa160ca8fed6c088

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Shimane IT Open-Innovation Center.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,47 @@
+# I2C class using Linux i2cdev.
+
+## Overview
+
+This is an implementation of the I2C class library for Linux.  
+Follows [mruby, mruby/c common I/O API guidelines.](https://github.com/mruby/microcontroller-peripheral-interface-guide)
+
+This library uses the Linux i2cdev device driver.
+
+## Installation
+
+    $ gem install mruby-linux-i2c
+
+
+## Features
+
+  * This library only implements the high-level methods that the guidelines say.
+  * This library only supports master devices with 7-bit addresses.
+
+
+## Usage
+
+about RaspberryPi...
+
+```
+# Connect pin #3 as SDA, #5 as SCL.
+
+require "mruby/i2c"
+
+# create instance
+i2c = I2C.new("/dev/i2c-1")
+
+# Write to device at address 0x5c, data 0x20, 0x90.
+i2c.write( 0x5c, 0x20, 0x90 )
+
+# Read 5 bytes from the device at address 0x5c.
+# Outputs 0xa8 before reading.
+s = i2c.read( 0x5c, 5, 0xa8 )
+```
+
+Other case, see original guidelines.  
+https://github.com/mruby/microcontroller-peripheral-interface-guide/blob/main/mruby_io_I2C_en.md
+
+
+## Licence
+
+BSD 3-Clause License. see LICENSE file.

data/lib/mruby/i2c/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module I2C
+  VERSION = "0.9.1"
+end

data/lib/mruby/i2c.rb

@@ -0,0 +1,152 @@
+#
+# I2C class using Linux i2cdev.
+#
+# Copyright (c) 2023 Shimane IT Open-Innovation Center.
+#
+# see: LICENSE file.
+# see: https://github.com/mruby/microcontroller-peripheral-interface-guide/blob/main/mruby_io_I2C_en.md
+#
+# frozen_string_literal: true
+#
+
+require_relative "i2c/version"
+
+##
+# I2C namespace
+#
+module I2C
+  ##
+  # constructor
+  #
+  #@see I2C::LinuxI2Cdev.initialize
+  #
+  def self.new(node = "/dev/i2c-1", *params)
+    I2C::LinuxI2Cdev.new(node, *params)
+  end
+end
+
+
+##
+# I2C bus driver
+#
+# only implement high-level methods.
+#
+class I2C::LinuxI2Cdev
+
+  # see /usr/include/linux/i2c.h i2c-dev.h
+  I2C_SLAVE = 0x0703
+  I2C_RDWR  = 0x0707
+  I2C_M_RD  = 0x0001
+
+
+  ##
+  # constructor
+  #
+  #@param [String]  node        device node of I2C
+  #@param [nil]  params         dummy.
+  #@see I2C.new
+  #
+  def initialize(node, *params)
+    @device = File.open(node, "r+:ASCII-8BIT")
+  end
+
+
+  def read
+  end
+
+
+  ##
+  # Reads data of read_bytes bytes from the device with the address i2c_adrs_7.
+  # using sysread
+  #
+  #@see #read_ioctl
+  #
+  def read_sysread( i2c_adrs_7, read_bytes, *param )
+    out_data = _rebuild_output_data( param )
+
+    _use_slave_adrs( i2c_adrs_7 )
+    @device.syswrite( out_data )  if !out_data.empty?
+    @device.sysread( read_bytes )
+  end
+
+
+  ##
+  # Reads data of read_bytes bytes from the device with the address i2c_adrs_7.
+  # using ioctl
+  #
+  #@param [Integer] i2c_adrs_7  I2C slave address (7bit address)
+  #@param [Integer] read_bytes  read bytes.
+  #@param [Integer,String,Array<Integer>] param  output data before reading.
+  #@return [String]     reading datas.
+  #
+  def read_ioctl( i2c_adrs_7, read_bytes, *param )
+    out_data = _rebuild_output_data( param )
+    recv_data = "\x00".b * read_bytes
+
+    # prepare the struct i2c_msg[2]
+    # struct i2c_msg {
+    #        __u16 addr;
+    #        __u16 flags;
+    #        __u16 len;         << hidden padding _u16
+    #        __u8 *buf;
+    # };
+    i2c_msg_s = [ i2c_adrs_7, 0, out_data.bytesize, 0,
+                  [out_data].pack('p').unpack1('J') ].pack('SSSSJ')
+    i2c_msg_r = [ i2c_adrs_7, I2C_M_RD, read_bytes, 0,
+                  [recv_data].pack('p').unpack1('J') ].pack('SSSSJ')
+
+    # prepare the struct i2c_rdwr_ioctl_data
+    # struct i2c_rdwr_ioctl_data {
+    #         struct i2c_msg *msgs;   /* pointers to i2c_msgs */
+    #         __u32 nmsgs;            /* number of i2c_msgs */
+    # };
+    if out_data.empty?
+      arg = [ [i2c_msg_r            ].pack('P').unpack1('J'), 1 ].pack('JL')
+    else
+      arg = [ [i2c_msg_s + i2c_msg_r].pack('P').unpack1('J'), 2 ].pack('JL')
+    end
+
+    @device.ioctl( I2C_RDWR, arg )
+    return recv_data
+  end
+
+  alias read read_ioctl
+
+
+  ##
+  # Writes data specified in outputs to the device with the address i2c_adrs_7.
+  #
+  #@param [Integer] i2c_adrs_7  I2C slave address (7bit address)
+  #@param [Integer,String,Array<Integer>] outputs  output data.
+  #@return [Integer]     number of bytes actually write.
+  #
+  def write( i2c_adrs_7 , *outputs )
+    out_data = _rebuild_output_data( outputs )
+
+    _use_slave_adrs( i2c_adrs_7 )
+    @device.syswrite( out_data )
+  end
+
+
+  private
+  def _use_slave_adrs( i2c_adrs_7 )
+    @device.ioctl( I2C_SLAVE, i2c_adrs_7 )
+  end
+
+  def _rebuild_output_data( arg )
+    data = "".b
+    arg.flatten.each {|d|
+      case d
+      when Integer
+        data << d.chr
+      when String
+        data << d.force_encoding(Encoding::ASCII_8BIT)
+      else
+        raise ArgumentError
+      end
+    }
+
+    return data
+  end
+
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: mruby-linux-i2c
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- HirohitoHigashi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-13 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- higashi@s-itoc.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mruby/i2c.rb
+- lib/mruby/i2c/version.rb
+homepage: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-linux-i2c
+licenses:
+- BSD 3-CLAUSE
+metadata:
+  homepage_uri: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-linux-i2c
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: I2C bus driver class library using Linux i2cdev.
+test_files: []