lgpio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3694843b060710d0fdf63c790b2857cd00bb37943fb80b52b4bb0e884c9eac63
+  data.tar.gz: 5749c5dbcaca251af6f5b2c6c3d189bcf1226f67ebabfc0dd418dee49361da77
+SHA512:
+  metadata.gz: e7cd82024168e24f5a776a39b364a7c9f2432de7de6d1966517c686d04acaddf338186074b7b7597051e9521bc93115292223e66a7fa34b2fcf7bb02090ae0ae
+  data.tar.gz: 6855f0811581f7c50803cf1372a9d3927399e547b9d3b9f05dd6162106949d3793d9ea40ee50d5253b9d3c252ed137bfe0859cf7bc38d00a3a2686e64d4be82e

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.*.swp
+.*.swo
+junk.*
+.idea/*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*DS_Store*
+.ruby-version
+.rvmrc
+.zed

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 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,16 @@
+# lgpio
+
+Ruby bindings for the [lgpio (lg)](https://github.com/joan2937/lg) C library, which provides GPIO, PWM, I2C, SPI and Serial features on single-board-computers (SBCs) running Linux.
+
+- [lg homepage](https://abyz.me.uk/lg/index.html)
+
+### Progress:
+
+- [x] GPIO Read/Write
+- [ ] GPIO Group Read/Write
+- [ ] GPIO Callbacks
+- [ ] PWM
+- [ ] Wave
+- [ ] I2C
+- [ ] SPI
+- [ ] Serial

data/Rakefile

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

data/examples/bench_in.rb

@@ -0,0 +1,16 @@
+require 'lgpio'
+
+GPIO_CHIP = 0
+PIN = 258
+COUNT = 1000000
+
+chip_handle = LGPIO.chip_open(GPIO_CHIP)
+LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_UP, PIN)
+
+t1 = Time.now
+COUNT.times do
+  value = LGPIO.gpio_read(chip_handle, PIN)
+end
+t2 = Time.now
+
+puts "Reads per second: #{COUNT.to_f / (t2 - t1).to_f}"

data/examples/bench_out.rb

@@ -0,0 +1,17 @@
+require 'lgpio'
+
+GPIO_CHIP = 0
+PIN = 260
+COUNT = 1000000
+
+chip_handle = LGPIO.chip_open(GPIO_CHIP)
+LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, PIN, LGPIO::LOW)
+
+t1 = Time.now
+COUNT.times do
+  LGPIO.gpio_write(chip_handle, PIN, 1)
+  LGPIO.gpio_write(chip_handle, PIN, 0)
+end
+t2 = Time.now
+
+puts "Toggles per second: #{COUNT.to_f / (t2 - t1).to_f}"

data/examples/blink.rb

@@ -0,0 +1,15 @@
+require 'lgpio'
+
+GPIO_CHIP = 0
+LED = 260
+INTERVAL = 0.25
+
+chip_handle = LGPIO.chip_open(GPIO_CHIP)
+LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LED, LGPIO::LOW)
+
+loop do
+  LGPIO.gpio_write(chip_handle, LED, 1)
+  sleep INTERVAL
+  LGPIO.gpio_write(chip_handle, LED, 0)
+  sleep INTERVAL
+end

data/examples/momentary.rb

@@ -0,0 +1,18 @@
+require 'lgpio'
+
+GPIO_CHIP = 0
+BUTTON    = 258
+LED       = 260
+
+chip_handle = LGPIO.chip_open(GPIO_CHIP)
+LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_UP, BUTTON)
+LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LED, LGPIO::LOW)
+
+loop do
+  if LGPIO.gpio_read(chip_handle, BUTTON) == 0
+    LGPIO.gpio_write(chip_handle, LED, 1)
+  else
+    LGPIO.gpio_write(chip_handle, LED, 0)
+  end
+  sleep 0.001
+end

data/ext/lgpio/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+#
+# Need lgpio installed.
+# See: https://github.com/joan2937/lg for instructions.
+#
+$libs += " -llgpio"
+
+create_makefile('lgpio/lgpio')

data/ext/lgpio/lgpio.c

@@ -0,0 +1,53 @@
+#include <lgpio.h>
+#include <ruby.h>
+
+static VALUE chip_open(VALUE self, VALUE gpio_dev) {
+  int result = lgGpiochipOpen(NUM2INT(gpio_dev));
+  return INT2NUM(result);
+}
+
+static VALUE chip_close(VALUE self, VALUE gpio_dev) {
+  int result = lgGpiochipClose(NUM2INT(gpio_dev));
+  return INT2NUM(result);
+}
+
+static VALUE gpio_claim_output(VALUE self, VALUE handle, VALUE flags, VALUE gpio, VALUE level) {
+  int result = lgGpioClaimOutput(NUM2INT(handle), NUM2INT(flags), NUM2INT(gpio), NUM2INT(level));
+  return INT2NUM(result);
+}
+
+static VALUE gpio_claim_input(VALUE self, VALUE handle, VALUE flags, VALUE gpio) {
+  int result = lgGpioClaimInput(NUM2INT(handle), NUM2INT(flags), NUM2INT(gpio));
+  return INT2NUM(result);
+}
+
+static VALUE gpio_read(VALUE self, VALUE handle, VALUE gpio) {
+  int result = lgGpioRead(NUM2INT(handle), NUM2INT(gpio));
+  return INT2NUM(result);
+}
+
+static VALUE gpio_write(VALUE self, VALUE handle, VALUE gpio, VALUE level) {
+  int result = lgGpioWrite(NUM2INT(handle), NUM2INT(gpio), NUM2INT(level));
+  return INT2NUM(result);
+}
+
+void Init_lgpio(void) {
+  // Modules
+  VALUE mLGPIO = rb_define_module("LGPIO");
+
+  // Constants
+  rb_define_const(mLGPIO, "SET_ACTIVE_LOW",   INT2NUM(LG_SET_ACTIVE_LOW));
+  rb_define_const(mLGPIO, "SET_OPEN_DRAIN",   INT2NUM(LG_SET_OPEN_DRAIN));
+  rb_define_const(mLGPIO, "SET_OPEN_SOURCE",  INT2NUM(LG_SET_OPEN_SOURCE));
+  rb_define_const(mLGPIO, "SET_PULL_UP",      INT2NUM(LG_SET_PULL_UP));
+  rb_define_const(mLGPIO, "SET_PULL_DOWN",    INT2NUM(LG_SET_PULL_DOWN));
+  rb_define_const(mLGPIO, "SET_PULL_NONE",    INT2NUM(LG_SET_PULL_NONE));
+
+  // Methods
+  rb_define_singleton_method(mLGPIO, "chip_open",          chip_open, 1);
+  rb_define_singleton_method(mLGPIO, "chip_close",         chip_close, 1);
+  rb_define_singleton_method(mLGPIO, "gpio_claim_input",   gpio_claim_input, 3);
+  rb_define_singleton_method(mLGPIO, "gpio_claim_output",  gpio_claim_output, 4);
+  rb_define_singleton_method(mLGPIO, "gpio_read",          gpio_read, 2);
+  rb_define_singleton_method(mLGPIO, "gpio_write",         gpio_write, 3);
+}

data/lgpio.gemspec

@@ -0,0 +1,17 @@
+require_relative 'lib/lgpio/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'lgpio'
+  s.version     = LGPIO::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = "lgpio (lg) bindings for Ruby"
+  s.description = "Use GPIO / PWM / I2C / SPI / UART on Linux SBCs in Ruby"
+
+  s.authors     = ["vickash"]
+  s.email       = 'mail@vickash.com'
+  s.files       = `git ls-files`.split($\)
+  s.homepage    = 'https://github.com/denko-rb/lgpio'
+  s.metadata    = { "source_code_uri" => "https://github.com/denko-rb/lgpio" }
+
+  s.extensions = %w[ext/lgpio/extconf.rb]
+end

data/lib/lgpio/version.rb

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

data/lib/lgpio.rb

@@ -0,0 +1,6 @@
+require_relative 'lgpio/lgpio'
+
+module LGPIO
+  LOW = 0
+  HIGH = 1
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: lgpio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vickash
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-24 00:00:00.000000000 Z
+dependencies: []
+description: Use GPIO / PWM / I2C / SPI / UART on Linux SBCs in Ruby
+email: mail@vickash.com
+executables: []
+extensions:
+- ext/lgpio/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- examples/bench_in.rb
+- examples/bench_out.rb
+- examples/blink.rb
+- examples/momentary.rb
+- ext/lgpio/extconf.rb
+- ext/lgpio/lgpio.c
+- lgpio.gemspec
+- lib/lgpio.rb
+- lib/lgpio/version.rb
+homepage: https://github.com/denko-rb/lgpio
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/denko-rb/lgpio
+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.9
+signing_key:
+specification_version: 4
+summary: lgpio (lg) bindings for Ruby
+test_files: []