gpiod 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa08910a821f653b7a8e24bb23d4179b1bc830ad476b07483c7b07ad8932348e
+  data.tar.gz: 335c870b62e4a83ae059d40ea161ab213d9af5ebff25803005c29b3259e59bd9
+SHA512:
+  metadata.gz: 27996555e451e2cd7c4bb1d79f5cd5a69979d2db1ef66a6bd1613d8862075d22d71da8c0969ace049db5ff30b42f4399ba18a911396ad31e9d72fcee32c9615c
+  data.tar.gz: d54d80244f65bf29ae4fa928c0d065f3dfc19f87f7095a4eb6c1afb0f1ea27e99627c31ee84a5cdaf455d7f797bbd8124fbbab85aac2f7b6c158a4dc04710d17

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 denko-rb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+# gpiod
+
+# Experimental (DO NOT USE!)
+
+If you need to use Linux GPIO in Ruby, please see [denko-piboard](https://github.com/denko-rb/denko-piboard) or [lgpio](https://github.com/denko-rb/lgpio) instead.
+
+This gem only contains some (probably bad) code, extracted from an old version of `denko-piboard`. I started building that on top of `libgpiod` directly, but eventually settled on [lgpio](https://github.com/joan2937/lg) which has more features and was simpler to implement.
+
+At some point, I will probably finish the `libgpiod` implementation, and substitute it where applicable in `denko-piboard`, in place of `lgpio`. It performs ~15-20% better, but `lgpio` + YJIT is already pretty fast, so this isn't a priority.

data/Rakefile

@@ -0,0 +1,5 @@
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new "gpiod" do |ext|
+  ext.lib_dir = "lib/gpiod"
+end

data/examples/bench_out.rb

@@ -0,0 +1,21 @@
+require 'gpiod'
+
+GPIO_CHIP = 0
+PIN       = 17
+COUNT     = 1000000
+
+# Always opens gpiochip0 for now.
+GPIOD.open_chip
+GPIOD.open_line_output(PIN)
+
+t1 = Time.now
+COUNT.times do
+  GPIOD.set_value(PIN, 1)
+  GPIOD.set_value(PIN, 0)
+end
+t2 = Time.now
+
+puts "Toggles per second: #{COUNT.to_f / (t2 - t1).to_f}"
+
+GPIOD.close_line(PIN)
+GPIOD.close_chip

data/ext/gpiod/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+#
+# Need libgpiod-dev installed.
+#   sudo apt install libgpiod-dev
+#
+$libs += " -lgpiod"
+
+create_makefile('gpiod/gpiod')

data/ext/gpiod/gpiod.c

@@ -0,0 +1,178 @@
+#include <ruby.h>
+#include <gpiod.h>
+
+#define GPIO_CHIP_NAME "gpiochip0"
+
+static struct gpiod_chip *chip;
+
+// Save mapping of lowest 32 GPIOs to gpiod_line structs.
+static struct gpiod_line *lines[32] = { NULL };
+
+// Input and output values.
+static int gpio_number;
+static int gpio_value;
+static int return_value;
+
+static VALUE open_chip(VALUE self) {
+  chip = gpiod_chip_open_by_name(GPIO_CHIP_NAME);
+  if (!chip) {
+    rb_raise(rb_eRuntimeError, "libgpiod error: Could not open GPIO chip");
+    return Qnil;
+  }
+  return Qnil;
+}
+
+static VALUE close_chip(VALUE self) {
+  gpiod_chip_close(chip);
+  return Qnil;
+}
+
+static void validate_gpio_number(int gpio_number) {
+  if ((gpio_number < 0) || (gpio_number > 31)) {
+    VALUE error_message = rb_sprintf("libgpiod error: GPIO line (%d) out of range. Valid range is 0..31", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+  }
+}
+
+static void validate_gpio_value(int value) {
+  if (!((value == 0) || (value == 1))) {
+    VALUE error_message = rb_sprintf("libgpiod error: GPIO value (%d) out of range. Valid values are 0 or 1", value);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+  }
+}
+
+static VALUE open_line_output(VALUE self, VALUE gpio) {
+  gpio_number = NUM2INT(gpio);
+  validate_gpio_number(gpio_number);
+
+  lines[gpio_number] = gpiod_chip_get_line(chip, gpio_number);
+  if (!lines[gpio_number]) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not get GPIO line %d", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+
+  return_value = gpiod_line_request_output(lines[gpio_number], "GPIOD_RB", 0);
+  if (return_value < 0) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not request output for GPIO line %d", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+
+  return Qnil;
+}
+
+static VALUE set_value(VALUE self, VALUE gpio, VALUE value) {
+  gpio_number = NUM2INT(gpio);
+  validate_gpio_number(gpio_number);
+  gpio_value = NUM2INT(value);
+  validate_gpio_value(gpio_value);
+
+  return_value = gpiod_line_set_value(lines[gpio_number], gpio_value);
+
+  if (return_value < 0) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not set value %d on GPIO line %d", gpio_value, gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+
+  return value;
+}
+
+static VALUE open_line_input(VALUE self, VALUE gpio) {
+  gpio_number = NUM2INT(gpio);
+  validate_gpio_number(gpio_number);
+
+  lines[gpio_number] = gpiod_chip_get_line(chip, gpio_number);
+  if (!lines[gpio_number]) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not get GPIO line %d", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+
+  return_value = gpiod_line_request_input(lines[gpio_number], "GPIOD_RB");
+  if (return_value < 0) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not request input for GPIO line %d", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+
+  return Qnil;
+}
+
+static VALUE get_value(VALUE self, VALUE gpio) {
+  gpio_number = NUM2INT(gpio);
+  validate_gpio_number(gpio_number);
+
+  return_value = gpiod_line_get_value(lines[gpio_number]);
+
+  if (return_value < 0) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not get value from GPIO line %d", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+
+  return INT2NUM(return_value);
+}
+
+static VALUE close_line(VALUE self, VALUE gpio) {
+  gpio_number = NUM2INT(gpio);
+  validate_gpio_number(gpio_number);
+
+  // Only try to close the line if it was opened before.
+  if (lines[gpio_number] == NULL) return Qnil;
+
+  gpiod_line_release(lines[gpio_number]);
+  lines[gpio_number] = NULL;
+  return Qnil;
+}
+
+static VALUE set_value_raw(VALUE self, VALUE gpio, VALUE value) {
+  gpio_number = NUM2INT(gpio);
+  gpio_value = NUM2INT(value);
+
+  return_value = gpiod_line_set_value(lines[gpio_number], gpio_value);
+
+  if (return_value < 0) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not set value %d on GPIO line %d", gpio_value, gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+  return value;
+}
+
+static VALUE get_value_raw(VALUE self, VALUE gpio) {
+  gpio_number = NUM2INT(gpio);
+
+  return_value = gpiod_line_get_value(lines[gpio_number]);
+
+  if (return_value < 0) {
+    gpiod_chip_close(chip);
+    VALUE error_message = rb_sprintf("libgpiod error: Could not get value from GPIO line %d", gpio_number);
+    rb_raise(rb_eRuntimeError, "%s", StringValueCStr(error_message));
+    return Qnil;
+  }
+  return INT2NUM(return_value);
+}
+
+void Init_gpiod(void) {
+  VALUE mGPIOD = rb_define_module("GPIOD");
+  rb_define_singleton_method(mGPIOD, "open_chip",        open_chip,        0);
+  rb_define_singleton_method(mGPIOD, "close_chip",       close_chip,       0);
+  rb_define_singleton_method(mGPIOD, "open_line_output", open_line_output, 1);
+  rb_define_singleton_method(mGPIOD, "set_value",        set_value,        2);
+  rb_define_singleton_method(mGPIOD, "open_line_input",  open_line_input,  1);
+  rb_define_singleton_method(mGPIOD, "get_value",        get_value,        1);
+  rb_define_singleton_method(mGPIOD, "close_line",       close_line,       1);
+
+  // These do no validation.
+  rb_define_singleton_method(mGPIOD, "set_value_raw",    set_value_raw,    2);
+  rb_define_singleton_method(mGPIOD, "get_value_raw",    get_value_raw,    1);
+}

data/gpiod.gemspec

@@ -0,0 +1,18 @@
+require_relative 'lib/gpiod/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'gpiod'
+  s.version     = GPIOD::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = "Use Linux SBC GPIO in Ruby"
+  s.description = "This gem provides Ruby bindings to the Linux gpiod C library"
+
+  s.authors     = ["vickash"]
+  s.email       = 'mail@vickash.com'
+  s.files       =  Dir['**/*'].reject { |f| f.match /.gem\z/}
+  s.homepage    = "https://github.com/denko-rb/gpiod"
+  s.metadata    = { "source_code_uri" => "https://github.com/denko-rb/gpiod" }
+
+  # libgpio C extension
+  s.extensions = %w[ext/gpiod/extconf.rb]
+end

data/lib/gpiod/version.rb

@@ -0,0 +1,3 @@
+module GPIOD
+  VERSION = "0.1.0"
+end

data/lib/gpiod.rb

@@ -0,0 +1,2 @@
+require_relative 'gpiod/gpiod'
+require_relative 'gpiod/version'

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: gpiod
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vickash
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-02 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides Ruby bindings to the Linux gpiod C library
+email: mail@vickash.com
+executables: []
+extensions:
+- ext/gpiod/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- examples/bench_out.rb
+- ext/gpiod/extconf.rb
+- ext/gpiod/gpiod.c
+- gpiod.gemspec
+- lib/gpiod.rb
+- lib/gpiod/version.rb
+homepage: https://github.com/denko-rb/gpiod
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/denko-rb/gpiod
+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: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Use Linux SBC GPIO in Ruby
+test_files: []