mruby-sysfs-gpio 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f1089ddaf2fac2419d96329266191f95fa186ce6874c413ec760ce613cea778
+  data.tar.gz: dbf651b91a38c20574400416d68927b453337acf658869b178eeef63dab0918d
+SHA512:
+  metadata.gz: bc9b8550ef886b679203cf5cd129cae6e3a56593c2fd4205ce9c0cbee68fb98411e0083aaaf2a512d51f401dfea87f9a2b54ab9da78bf056cfbfc03b5179af05
+  data.tar.gz: 3752775990083bc49c7a28fcead23d017adcc8a28d7ceadf5d32f58d2809646cdfbced9b1d0933eae3d0e86174b8f5c89ca55dcb19b6a7fa6c84899fccfc1a5a

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,48 @@
+# GPIO class using Linux sysfs.
+
+![TitleImage](img/led_anim.gif) >> [source code](test/led5sw1_event.rb) / [schematic](img/led5sw1_schema.png)
+
+## Overview
+
+This is an implementation of the GPIO class library for Linux.  
+Follows [mruby, mruby/c common I/O API guidelines.](https://github.com/mruby/microcontroller-peripheral-interface-guide)
+
+
+## Installation
+
+    $ gem install mruby-sysfs-gpio
+
+
+## Features
+
+  * Configure the pin as an input or output. (if hardware allows)
+  * Has an extension that allows you to define code to be executed when the input changes.
+
+
+## Usage
+
+about RaspberryPi...
+
+```
+# Flash LED a.k.a. ElChika (in japanese)
+# Connect Pin #37 (GPIO26) to LED.
+
+require "mruby/gpio"   # or "mruby/gpio/sysfs"
+
+led = GPIO.new(26, GPIO::OUT)
+while true
+  led.write( 1 )
+  sleep 1
+  led.write( 0 )
+  sleep 1
+end
+```
+
+Other case, see original guidelines.
+
+https://github.com/mruby/microcontroller-peripheral-interface-guide/blob/main/mruby_io_GPIO_en.md
+
+
+## Licence
+
+BSD 3-Clause License. see LICENSE file.

data/lib/mruby/gpio/sysfs/gpio_sysfs.rb

@@ -0,0 +1,309 @@
+#
+# GPIO class using Linux sysfs.
+#
+# Copyright (c) 2023 Shimane IT Open-Innovation Center.
+#
+# see: LICENSE file.
+# see: https://github.com/mruby/microcontroller-peripheral-interface-guide/blob/main/mruby_io_GPIO_en.md
+#
+# frozen_string_literal: true
+#
+
+##
+# class GPIO
+#
+class GPIO
+  DRIVER = "sysfs"
+
+  # Constants
+  IN         = 0b0000_0001
+  OUT        = 0b0000_0010
+  HIGH_Z     = 0b0000_0100
+  PULL_UP    = 0b0000_1000
+  PULL_DOWN  = 0b0001_0000
+  OPEN_DRAIN = 0b0010_0000
+
+  # extend
+  RISING     = 0b0100_0000
+  FALLING    = 0b1000_0000
+  BOTH       = 0b1100_0000
+  UNUSED     = 0b0000_0000
+
+  PATH_SYSFS = "/sys/class/gpio"
+
+
+  ##
+  # set pin to use
+  #
+  #@param  [Integer] pin        pin number
+  #@!visibility private
+  #
+  def self._set_use( pin )
+    File.binwrite("#{PATH_SYSFS}/export", pin.to_s) rescue nil
+    10.times {
+      return if File.writable?("#{PATH_SYSFS}/gpio#{pin}/direction")
+      sleep 0.1
+    }
+    raise "Can't write SYSFS node"
+  end
+
+
+  ##
+  # set pin to unused.
+  #
+  #@param  [Integer] pin        pin number
+  #@!visibility private
+  #
+  def self._set_unused( pin )
+    File.binwrite("#{PATH_SYSFS}/unexport", pin.to_s) rescue nil
+  end
+
+
+  ##
+  # set in or out setting.
+  #
+  #@param  [Integer] pin        pin number
+  #@param  [Constant] params    modes
+  #@!visibility private
+  #
+  def self._set_dir( pin, params )
+    flag_retry = false
+
+    begin
+      case (params & (IN|OUT|HIGH_Z|OPEN_DRAIN))
+      when IN
+        File.binwrite("#{PATH_SYSFS}/gpio#{pin}/direction", "in")
+        return IN
+      when OUT
+        File.binwrite("#{PATH_SYSFS}/gpio#{pin}/direction", "out")
+        return OUT
+      when HIGH_Z, OPEN_DRAIN
+        raise ArgumentError, "Unsupported."
+      end
+
+    rescue Errno::ENOENT =>ex
+      raise ex  if flag_retry
+      _set_use( pin )
+      flag_retry = true
+      retry
+    end
+
+    return nil
+  end
+
+
+  ##
+  # set pull-up or pull-down
+  #
+  #@!visibility private
+  #
+  def self._set_pull( pin, params )
+    case (params & (PULL_UP|PULL_DOWN))
+    when PULL_UP, PULL_DOWN
+      raise "Unsupported."
+    end
+  end
+
+
+  ##
+  # Specify the physical pin indicated by "pin" and change the mode of the GPIO.
+  #
+  #@param  [Integer] pin        pin number
+  #@param  [Constant] params    modes
+  #@return [nil]
+  #@raise [ArgumentError]
+  #
+  def self.setmode( pin, params )
+    if params == UNUSED
+      _set_unused( pin )
+      return nil
+    end
+
+    if ! _set_dir( pin, params )
+      raise ArgumentError, "You must specify one of IN, OUT and HIGH_Z"
+    end
+
+    _set_pull( pin, params )
+
+    return nil
+  end
+
+
+  ##
+  # Returns the value read from the specified pin as either 0 or 1.
+  #
+  #@param  [Integer] pin        pin number
+  #@return [Integer]
+  #
+  def self.read_at( pin )
+    return File.binread("#{PATH_SYSFS}/gpio#{pin}/value", 10).to_i
+  end
+
+
+  ##
+  # Return true If the value read from the specified pin is high (==1)
+  #
+  #@param  [Integer] pin        pin number
+  #@return [Boolean]
+  #
+  def self.high_at?( pin )
+    return read_at(pin) == 1
+  end
+
+
+  ##
+  # Return true If the value read from the specified pin is low (==0)
+  #
+  #@param  [Integer] pin        pin number
+  #@return [Boolean]
+  #
+  def self.low_at?( pin )
+    return read_at(pin) == 0
+  end
+
+
+  ##
+  # Output a value to the specified pin.
+  #
+  #@param  [Integer] pin        pin number
+  #@param  [Integer] value      data
+  #@return [void]
+  #
+  def self.write_at( pin, value )
+    case value
+    when 0,1
+      File.binwrite("#{PATH_SYSFS}/gpio#{pin}/value", value.to_s)
+    else
+      raise RangeError
+    end
+  end
+
+
+  ##
+  # constructor
+  #
+  #@param  [Integer] pin        pin number
+  #@param  [Constant] params    modes
+  #
+  def initialize( pin, params )
+    @pin = pin
+    GPIO.setmode( pin, params )
+    @value = File.open("#{PATH_SYSFS}/gpio#{pin}/value", "r+:ASCII-8BIT")
+  end
+
+
+  ##
+  # Return the loaded value as 0 or 1.
+  #
+  #@return [Integer]
+  #
+  def read()
+    @value.sysseek( 0 )
+    return @value.sysread( 10 ).to_i
+  end
+
+
+  ##
+  # If the loaded value is high level (==1), it returns true.
+  #
+  #@return [Boolean]
+  #
+  def high?()
+    return read() == 1
+  end
+
+
+  ##
+  # If the loaded value is low-level (==0), return true.
+  #
+  #@return [Boolean]
+  #
+  def low?()
+    return read() == 0
+  end
+
+
+  ##
+  # Specify the value to output to the pin as either 0 or 1.
+  #
+  #@param [Integer] value
+  #@return [void]
+  #
+  def write( value )
+    @value.syswrite( value == 0 ? "0" : "1" )
+  end
+
+
+  ##
+  # Change the GPIO mode at any timing.
+  #
+  #@param  [Constant] params    modes
+  #@return [nil]
+  #
+  def setmode( params )
+    if params == UNUSED
+      GPIO._set_unused( @pin )
+      return nil
+    end
+
+    GPIO._set_dir( @pin, params )
+    GPIO._set_pull( @pin, params )
+
+    return nil
+  end
+
+
+  ##
+  # rising/falling edge event
+  # (extend)
+  #
+  #@param  [Constant]   edge    GPIO::RISING, GPIO::FALLING or GPIO::BOTH
+  #@param  [Integer]    bounce_ms       bounce time (milliseconds)
+  #@return [Thread]     event thread.
+  #
+  #@example
+  #  gpio.event( GPIO::RISING ) { puts "Rising UP." }
+  #
+  def event( edge, bounce_ms:50, &block )
+    if !@event_thread
+      File.binwrite("#{PATH_SYSFS}/gpio#{@pin}/edge", "both")
+      @bounce_time = bounce_ms / 1000.0
+      @events_rising = []
+      @events_falling = []
+
+      @value.sysseek( 0 )
+      v1 = @value.sysread( 10 ).to_i
+
+      @event_thread = Thread.new {
+        while true
+          @value.sysseek(0)
+          rs,ws,es = IO.select(nil, nil, [@value], 1)
+
+          sleep @bounce_time
+          v2 = @value.sysread(10).to_i
+
+          if v1 == 0 && v2 == 1
+            @events_rising.each {|event| event.call( v2 ) }
+          elsif v1 == 1 && v2 == 0
+            @events_falling.each {|event| event.call( v2 ) }
+          end
+
+          v1 = v2
+        end
+      }
+    end
+
+    case edge
+    when RISING
+      @events_rising << block
+    when FALLING
+      @events_falling << block
+    when BOTH
+      @events_rising << block
+      @events_falling << block
+    end
+
+    return @event_thread
+  end
+
+end

data/lib/mruby/gpio/sysfs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class GPIO
+  VERSION = "0.9.0"
+end

data/lib/mruby/gpio/sysfs.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "sysfs/version"
+require_relative "sysfs/gpio_sysfs"

data/lib/mruby/gpio.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "gpio/sysfs"

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: mruby-sysfs-gpio
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+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/gpio.rb
+- lib/mruby/gpio/sysfs.rb
+- lib/mruby/gpio/sysfs/gpio_sysfs.rb
+- lib/mruby/gpio/sysfs/version.rb
+homepage: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-sysfs-gpio
+licenses:
+- BSD 3-CLAUSE
+metadata:
+  homepage_uri: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-sysfs-gpio
+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: GPIO class library using Linux sysfs. compliant with mruby, mruby/c common
+  I/O API guidelines.
+test_files: []