mruby-sysfs-gpio 0.9.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c812293aaa4692733917044dfa1b167cbe1aec3eb63dd780a7b50b75750576d
-  data.tar.gz: b3aed7109587cd127b31cc4566016e622235447c1cf0275efb5ea8c0f0d9c425
+  metadata.gz: eb917e12cce816c2b697c373998159c1aa65837452fa232ba484f6cc1fe0560e
+  data.tar.gz: 46ed16bba8561ad357c5f17c2e007356986211ad56a9cf0fa60399eef28c44ef
 SHA512:
-  metadata.gz: 349090b7dd666ef7e91b894c74654b9fb0d5eaded6df755c81ad2e22ef1b6373b69fe93c1ef44d184df767fa77c93712df476316e7989f3595d1442697bfeafe
-  data.tar.gz: 1eafcb90df9c71b13a81129c3a79aa6383552f1acdd9f81f1bace9bd42fd3a84af297db7b63c74dfdfab92bf98df9f9fc73f76b863d60afef1ef63e6b043f57a
+  metadata.gz: faf269900edb889f54e7b540cc20bf447deb1f23429938bce58a92304cc63940fe7db41ec583f6b252b2877cd022ba879cf21c94d3a6070381c5eb0ece137223
+  data.tar.gz: 3e9effd008df980a8f3ffd69958618a3a9d24ebc78d02df90f25099a55f5304fb5199ba3859491a116e13d86fdf4eb9d56244f877544ae715f1c66aec8c062a5

data/README.md

@@ -7,6 +7,9 @@
 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)
 
+This library uses the Linux sysfs.  
+Works well on 32-bit and 64-bit OS.
+
 
 ## Installation
 
@@ -19,6 +22,12 @@ Follows [mruby, mruby/c common I/O API guidelines.](https://github.com/mruby/mic
   * Has an extension that allows you to define code to be executed when the input changes.
 
 
+## Operation check target
+
+  * [Raspberry Pi 4](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/)
+  * [Armadillo-IoT G3](https://armadillo.atmark-techno.com/armadillo-iot-g3)
+
+
 ## Usage
 
 about RaspberryPi...

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

@@ -16,6 +16,7 @@ class GPIO
   DRIVER = "sysfs"
 
   # Constants
+  UNUSED     = 0b0000_0000      # option
   IN         = 0b0000_0001
   OUT        = 0b0000_0010
   HIGH_Z     = 0b0000_0100
@@ -23,11 +24,8 @@ class GPIO
   PULL_DOWN  = 0b0001_0000
   OPEN_DRAIN = 0b0010_0000
 
-  # extend
-  RISING     = 0b0100_0000
-  FALLING    = 0b1000_0000
-  BOTH       = 0b1100_0000
-  UNUSED     = 0b0000_0000
+  EDGE_RISE  = 0b0001_0000_0000
+  EDGE_FALL  = 0b0010_0000_0000
 
   PATH_SYSFS = "/sys/class/gpio"
 
@@ -183,7 +181,7 @@ class GPIO
   # constructor
   #
   #@param  [Integer] pin        pin number
-  #@param  [Constant] params    modes
+  #@param  [Constant] params    modes (GPIO::IN or GPIO::OUT)
   #
   def initialize( pin, params )
     @pin = pin
@@ -199,7 +197,7 @@ class GPIO
   #
   def read()
     @value.sysseek( 0 )
-    return @value.sysread( 10 ).to_i
+    return @value.sysread(10).to_i
   end
 
 
@@ -254,27 +252,23 @@ class GPIO
 
 
   ##
-  # rising/falling edge event
-  # (extend)
+  # (option) IRQ event handling
   #
-  #@param  [Constant]   edge    GPIO::RISING, GPIO::FALLING or GPIO::BOTH
-  #@param  [Integer]    bounce_ms       bounce time (milliseconds)
-  #@return [Thread]     event thread.
+  #@param  [Constant]   cond            EDGE_RISE or EDGE_FALL
+  #@param  [Integer]    bounce_ms       bounce time in milliseconds.
+  #@return [void]
   #
   #@example
-  #  gpio.event( GPIO::RISING ) { puts "Rising UP." }
+  #  gpio.irq( GPIO::EDGE_RISE ) {|reason| puts "Rising UP." }
   #
-  def event( edge, bounce_ms:50, &block )
-    if !@event_thread
+  def irq( cond, bounce_ms:50, &block )
+    if !@irq_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
+      v1 = @value.sysread(10).to_i
 
-      @event_thread = Thread.new {
+      @irq_thread = Thread.new {
         while true
           @value.sysseek(0)
           rs,ws,es = IO.select(nil, nil, [@value], 1)
@@ -283,9 +277,9 @@ class GPIO
           v2 = @value.sysread(10).to_i
 
           if v1 == 0 && v2 == 1
-            @events_rising.each {|event| event.call( v2 ) }
+            @handler_rise && @handler_rise.call( EDGE_RISE )
           elsif v1 == 1 && v2 == 0
-            @events_falling.each {|event| event.call( v2 ) }
+            @handler_fall && @handler_fall.call( EDGE_FALL )
           end
 
           v1 = v2
@@ -293,17 +287,10 @@ class GPIO
       }
     end
 
-    case edge
-    when RISING
-      @events_rising << block
-    when FALLING
-      @events_falling << block
-    when BOTH
-      @events_rising << block
-      @events_falling << block
-    end
+    @handler_rise = block  if (cond & EDGE_RISE) != 0
+    @handler_fall = block  if (cond & EDGE_FALL) != 0
 
-    return @event_thread
+    return nil
   end
 
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mruby-sysfs-gpio
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.0
 platform: ruby
 authors:
 - HirohitoHigashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-14 00:00:00.000000000 Z
+date: 2023-12-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -28,8 +28,8 @@ licenses:
 - BSD 3-CLAUSE
 metadata:
   homepage_uri: https://github.com/HirohitoHigashi/mruby-mio/
-  source_code_uri: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-sysfs-gpio
-  documentation_uri: https://www.rubydoc.info/gems/mruby-sysfs-gpio
+  source_code_uri: https://github.com/HirohitoHigashi/mruby-mio/tree/v1.0.0/mruby-sysfs-gpio
+  documentation_uri: https://www.rubydoc.info/gems/mruby-sysfs-gpio/1.0.0/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -38,7 +38,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="