denko-piboard 0.13.2 → 0.15.0

data/scripts/set_permissions.rb

@@ -0,0 +1,131 @@
+require 'yaml'
+
+# `whoami` returns the name of the user running this script.
+#
+# If you automate this to run on startup (as root), you must put
+# your literal Linux username here instead. If not, it will attempt
+# to load a map from root's home, and root will get permissions, not you.
+#
+USERNAME = `whoami`.strip
+
+GPIO_GROUP_NAME = "gpio"
+I2C_GROUP_NAME = "i2c"
+SPI_GROUP_NAME = "spi"
+PWM_GROUP_NAME = "pwm"
+
+MAP_FILENAME = ".denko_piboard_map.yml"
+$added_to_group = false
+
+# Create groups and add the user to them as needed.
+def group_setup(group_name)
+  group_line = `egrep -i "^#{group_name}" /etc/group`
+
+  if group_line.empty?
+    `sudo groupadd #{group_name}`
+  end
+
+  unless group_line.match(/#{USERNAME}/)
+    `sudo usermod -aG #{group_name} #{USERNAME}`
+    puts "Added user #{USERNAME} to group #{group_name}. "
+    $added_to_group = true
+  else
+    puts "User #{USERNAME} already in group #{group_name}. "
+  end
+end
+
+# Change gpiochip ownership and permissions.
+def setup_gpio
+  gpiochips = $map["pins"].each_value.map { |pin_def| pin_def["chip"] }.uniq
+  group_setup(GPIO_GROUP_NAME) unless gpiochips.empty?
+  gpiochips.each do |chip_index|
+    `sudo chgrp #{GPIO_GROUP_NAME} /dev/gpiochip#{chip_index}*`
+    `sudo chmod g+rw /dev/gpiochip#{chip_index}*`
+    puts "Set permissions for /dev/gpiochip#{chip_index}"
+  end
+end
+
+# Change I2C ownership and permissions
+def setup_i2c
+  i2cs = $map["i2cs"].keys
+  group_setup(I2C_GROUP_NAME) unless i2cs.empty?
+  i2cs.each do |i2c_index|
+    dev = "/dev/i2c-#{i2c_index}"
+    `sudo chgrp #{I2C_GROUP_NAME} #{dev}`
+    `sudo chmod g+rw #{dev}`
+    puts "Set permissions for #{dev}"
+  end
+end
+
+# Change SPI ownership and permissions
+def setup_spi
+  spis = $map["spis"].keys
+  group_setup(SPI_GROUP_NAME) unless spis.empty?
+  spis.each do |spi_index|
+    dev = "/dev/spidev#{spi_index}"
+    `sudo chgrp #{SPI_GROUP_NAME} #{dev}*`
+    `sudo chmod g+rw #{dev}*`
+    puts "Set permissions for #{dev}.*"
+  end
+end
+
+def setup_pwm
+# Change PWM ownership and permissions
+  pwms = $map["pwms"]
+  unless pwms.empty?
+    group_setup(PWM_GROUP_NAME)
+    print "Exported and set permissions for: /sys/class/pwm/{"
+  end
+
+  i = 0
+  pwms.each_value do |hash|
+    i += 1
+    chip = hash["pwmchip"]
+    chan = hash["channel"]
+    chip_dir = "/sys/class/pwm/pwmchip#{chip}"
+    channel_dir = "/sys/class/pwm/pwmchip#{chip}/pwm#{chan}"
+
+    # Chip dir permissions
+    `sudo chgrp -RH #{PWM_GROUP_NAME} #{chip_dir}`
+    `sudo chmod -R g+rw #{chip_dir}`
+
+    # Export
+    `sudo echo #{chan} > #{chip_dir}/export` unless Dir.exist?(channel_dir)
+
+    # Channel dir permissions
+    `sudo chgrp -RH #{PWM_GROUP_NAME} #{channel_dir}`
+    `sudo chmod -R g+rw #{channel_dir}`
+
+    print channel_dir.gsub("/sys/class/pwm/", "")
+    print ", " unless i == pwms.length
+  end
+  puts "}"
+end
+
+# Load map
+home = Dir.home(USERNAME)
+yaml_path = home +"/#{MAP_FILENAME}"
+$map = YAML.load_file(yaml_path)
+puts
+
+case ARGV[0]
+when "gpio"
+  setup_gpio
+when "i2c"
+  setup_i2c
+when "spi"
+  setup_spi
+when "pwm"
+  setup_pwm
+else
+  setup_gpio
+  setup_i2c
+  setup_spi
+  setup_pwm
+end
+
+# Notify user
+if $added_to_group
+  puts
+  puts "User #{USERNAME} has been added to new group(s). Log out, then log back in for this to take effect."
+end
+puts

metadata

@@ -1,76 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: denko-piboard
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.15.0
 platform: ruby
 authors:
 - vickash
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pigpio
+  name: lgpio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.12
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.12
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: denko
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-description: Denko::PiBoard is a drop-in replacement for Denko::Board. Use denko features
-  and component classes to be used directly on a Raspberry Pi.
+        version: '0.15'
+description: Use Linux single-board-computer GPIO, I2C, SPI and PWM in Ruby
 email: mail@vickash.com
 executables: []
-extensions:
-- ext/gpiod/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- board_maps/README.md
+- board_maps/le_potato.yml
+- board_maps/orange_pi_zero_2w.yml
+- board_maps/radxa_zero3.yml
+- board_maps/raspberry_pi.yml
+- board_maps/raspberry_pi5.yml
 - denko_piboard.gemspec
+- examples/digital_io/bench_out.rb
+- examples/digital_io/rotary_encoder.rb
+- examples/display/ssd1306.rb
+- examples/i2c/bitbang_aht10.rb
+- examples/i2c/bitbang_search.rb
+- examples/i2c/bitbang_ssd1306_bench.rb
+- examples/i2c/search.rb
+- examples/led/blink.rb
+- examples/led/fade.rb
+- examples/led/ws2812_bounce.rb
+- examples/motor/servo.rb
 - examples/pi_system_monitor.rb
-- ext/gpiod/extconf.rb
-- ext/gpiod/gpiod.c
+- examples/pulse_io/buzzer.rb
+- examples/pulse_io/infrared.rb
+- examples/sensor/aht10.rb
+- examples/sensor/dht.rb
+- examples/sensor/ds18b20.rb
+- examples/sensor/hcsr04.rb
+- examples/sensor/neat_tph_readings.rb
+- examples/spi/bb_loopback.rb
+- examples/spi/loopback.rb
+- examples/spi/output_register.rb
 - lib/denko/piboard.rb
 - lib/denko/piboard_base.rb
 - lib/denko/piboard_core.rb
+- lib/denko/piboard_core_optimize_lookup.rb
+- lib/denko/piboard_hardware_pwm.rb
 - lib/denko/piboard_i2c.rb
+- lib/denko/piboard_i2c_bb.rb
 - lib/denko/piboard_infrared.rb
+- lib/denko/piboard_led_array.rb
 - lib/denko/piboard_map.rb
+- lib/denko/piboard_one_wire.rb
 - lib/denko/piboard_pulse.rb
-- lib/denko/piboard_servo.rb
 - lib/denko/piboard_spi.rb
+- lib/denko/piboard_spi_bb.rb
 - lib/denko/piboard_tone.rb
 - lib/denko/piboard_version.rb
-- lib/gpiod.rb
+- scripts/99-denko.rules
+- scripts/set_permissions.rb
 homepage: https://github.com/denko-rb/denko-piboard
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/denko-rb/denko-piboard
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,15 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Use Raspberry Pi built-in GPIO as a Board class with the denko gem
+summary: Linux SBC GPIO in Ruby
 test_files: []

data/ext/gpiod/extconf.rb

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

data/ext/gpiod/gpiod.c

@@ -1,179 +0,0 @@
-#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 mDenko  = rb_define_module("Denko");
-  VALUE mGPIOD = rb_define_module_under(mDenko, "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/lib/denko/piboard_servo.rb

@@ -1,18 +0,0 @@
-module Denko
-  class PiBoard
-    # CMD = 10
-    def servo_toggle(pin, value=:off, options={})
-      if value == :off
-        pwm_clear(pin)
-        digital_write(pin, 0)
-      else
-        @pwms[pin] = :servo
-      end
-    end
-    
-    # CMD = 11
-    def servo_write(pin, value=0)
-      Pigpio::IF.set_servo_pulsewidth(pi_handle, pin, value)
-    end
-  end
-end

data/lib/gpiod.rb

@@ -1,6 +0,0 @@
-require_relative 'gpiod/gpiod'
-
-module Denko
-  module GPIOD
-  end
-end