lgpio 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3007d43d8623a895efdcfb2089ccc3c9105bde952af5095d904019d2df56eaaf
-  data.tar.gz: 8aa7f8ecf78eff10e04deb2bc5a5732b939cbbaa99f7b4f578dd8320a7634fb7
+  metadata.gz: 968e706762503c9d172b41ff4df8a9c17021af5b4a4cb4372eeaaa166c30f5ff
+  data.tar.gz: 82d8221f8e28293f542c4bd1913f85addb567c217d071fdbb1e47451c3be1da1
 SHA512:
-  metadata.gz: 93cc1be6fcafd45e98a11272f608241adc2c809f0ff6d71333a63f93453bb34fba4a75155cb973c06407b6cea281fbdd934664970077a1608718f0f218eb49cd
-  data.tar.gz: f94f8859d0b7c3999687263a54979472fd73df50c0a3e09319aeb908c3b4e7de1bac458d97478f0ddeba19e4fe10d061c57e9331fc6910f386101315f4d087d5
+  metadata.gz: 8749280110629032e20ac94c203c512a699e90b58266f78f7c26a9305b8e22ef0f97822247744403c2723b7417838b5972c2618a65ebcb0ee2ae483cd0d12e41
+  data.tar.gz: a9bbac8e2f8c80de6adf86249bf559b10c590234597a15d3bf6dce37bc3b60ce27856f2343bdc1fe885a1a78105401419e221eb0ae5a10fa404ec7fc9c90a4fd

data/README.md

@@ -43,16 +43,21 @@ These use the sysfs PWM interface, not lgpio C, but are a good fit for this gem.
 ## Installation
 On Debian-based Linuxes (RaspberryPi OS, Armbian, DietPi etc.):
 ```bash
-sudo apt install swig python3-dev python3-setuptools
+# Requirements to install lgpio C
+sudo apt install swig python3-dev python3-setuptools gcc make
 
 # Temporary fork of: wget https://github.com/joan2937/lg/archive/master.zip
 wget https://github.com/vickash/lg/archive/refs/heads/master.zip
 
+# Install lgpio C
 unzip master.zip
 cd lg-master
 make
 sudo make install
 
+# The latest Ruby 3 + YJIT is recommended, but you can use the system Ruby from apt too.
+# sudo apt install ruby ruby-dev
+
 gem install lgpio
 ```
 
@@ -76,4 +81,10 @@ Even when these are enabled, you may not have permission to access them. To run
   - Method names have the leading `lg` removed, since inside the `LGPIO` class.
   - Constants have leading `LG_` removed, as above.
   - "count" or "length" arguments associated with array args are not needed.
+  - Arg order for `_claim_` methods varies from lgpio C, so that gpio number always follows handle. The general pattern is `handle, gpio, flags, state`. This affects:
+    - `gpio_claim_input`
+    - `gpio_claim_output`
+    - `gpio_claim_alert`
+    - `group_claim_input`
+    - `group_claim_output`
 - Check the return values of your method calls. On failure, they return negative values, matching the `LG_` error codes at the bottom of the C API doc page.

data/examples/gpio_bench_in.rb

@@ -5,7 +5,7 @@ PIN       = 260
 COUNT     = 1000000
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_UP, PIN)
+LGPIO.gpio_claim_input(chip_handle, PIN, LGPIO::SET_PULL_UP)
 
 t1 = Time.now
 COUNT.times do

data/examples/gpio_bench_out.rb

@@ -5,7 +5,7 @@ PIN       = 272
 COUNT     = 1000000
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, PIN, LGPIO::LOW)
+LGPIO.gpio_claim_output(chip_handle, PIN, LGPIO::SET_PULL_NONE, LGPIO::LOW)
 
 t1 = Time.now
 COUNT.times do

data/examples/gpio_blink.rb

@@ -5,7 +5,7 @@ LED       = 272
 INTERVAL  = 0.25
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LED, LGPIO::LOW)
+LGPIO.gpio_claim_output(chip_handle, LED, LGPIO::SET_PULL_NONE, LGPIO::LOW)
 
 loop do
   LGPIO.gpio_write(chip_handle, LED, 1)

data/examples/gpio_group_in.rb

@@ -7,8 +7,8 @@ LEDS        = [272, 258]
 INIT_STATE  = [0, 0]
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.group_claim_input(chip_handle, LGPIO::SET_PULL_UP, BUTTONS)
-LGPIO.group_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LEDS, INIT_STATE)
+LGPIO.group_claim_input(chip_handle, BUTTONS, LGPIO::SET_PULL_UP)
+LGPIO.group_claim_output(chip_handle, LEDS, LGPIO::SET_PULL_NONE, INIT_STATE)
 
 # The inverted (active-low) state of each button controls the corresponding LED.
 loop do

data/examples/gpio_group_out.rb

@@ -7,7 +7,7 @@ INTERVAL    = 250_000 # 250ms
 TIMES       = 10
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.group_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LEDS, INIT_STATE)
+LGPIO.group_claim_output(chip_handle, LEDS, LGPIO::SET_PULL_NONE, INIT_STATE)
 
 # Convert us interval to seconds.
 interval = INTERVAL.to_f / 1_000_000

data/examples/gpio_momentary.rb

@@ -5,8 +5,8 @@ BUTTON    = 259
 LED       = 272
 
 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)
+LGPIO.gpio_claim_input(chip_handle, BUTTON, LGPIO::SET_PULL_UP)
+LGPIO.gpio_claim_output(chip_handle, LED, LGPIO::SET_PULL_NONE, LGPIO::LOW)
 
 loop do
   if LGPIO.gpio_read(chip_handle, BUTTON) == 0

data/examples/gpio_reports.rb

@@ -5,9 +5,9 @@ PIN       = 259
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
 
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_NONE, PIN)
+LGPIO.gpio_claim_input(chip_handle, PIN, LGPIO::SET_PULL_NONE)
 LGPIO.gpio_set_debounce(chip_handle, PIN, 1)
-LGPIO.gpio_claim_alert(chip_handle, 0, LGPIO::BOTH_EDGES, PIN)
+LGPIO.gpio_claim_alert(chip_handle, PIN, 0, LGPIO::BOTH_EDGES)
 LGPIO.gpio_start_reporting
 
 loop do

data/examples/gpio_rotary_encoder.rb

@@ -17,17 +17,17 @@ state_b  = 0
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
 
 # Encoder pin setup
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_NONE, PIN_A)
+LGPIO.gpio_claim_input(chip_handle, PIN_A, LGPIO::SET_PULL_NONE)
 LGPIO.gpio_set_debounce(chip_handle, PIN_A, 1)
-LGPIO.gpio_claim_alert(chip_handle, 0, LGPIO::BOTH_EDGES, PIN_A)
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_NONE, PIN_B)
+LGPIO.gpio_claim_alert(chip_handle, PIN_A, 0, LGPIO::BOTH_EDGES)
+LGPIO.gpio_claim_input(chip_handle, PIN_B, LGPIO::SET_PULL_NONE)
 LGPIO.gpio_set_debounce(chip_handle, PIN_B, 1)
-LGPIO.gpio_claim_alert(chip_handle, 0, LGPIO::BOTH_EDGES, PIN_B)
+LGPIO.gpio_claim_alert(chip_handle, PIN_B, 0, LGPIO::BOTH_EDGES)
 
 # Switch pin setup
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_UP,     PIN_SW)
+LGPIO.gpio_claim_input(chip_handle, PIN_SW, LGPIO::SET_PULL_UP)
 LGPIO.gpio_set_debounce(chip_handle, PIN_SW, 1)
-LGPIO.gpio_claim_alert(chip_handle, 0, LGPIO::FALLING_EDGE, PIN_SW)
+LGPIO.gpio_claim_alert(chip_handle, PIN_SW, 0, LGPIO::FALLING_EDGE)
 
 # Start generating reports for GPIO level changes.
 LGPIO.gpio_start_reporting

data/examples/gpio_rotary_encoder_led.rb

@@ -21,15 +21,15 @@ led_duty = 0
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
 
 # LED pin setup
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, PIN_LED, LGPIO::LOW)
+LGPIO.gpio_claim_output(chip_handle, PIN_LED, LGPIO::SET_PULL_NONE, LGPIO::LOW)
 
 # Encoder pin setup
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_NONE, PIN_A)
+LGPIO.gpio_claim_input(chip_handle, PIN_A, LGPIO::SET_PULL_NONE)
 LGPIO.gpio_set_debounce(chip_handle, PIN_A, 1)
-LGPIO.gpio_claim_alert(chip_handle, 0, LGPIO::BOTH_EDGES, PIN_A)
-LGPIO.gpio_claim_input(chip_handle, LGPIO::SET_PULL_NONE, PIN_B)
+LGPIO.gpio_claim_alert(chip_handle, PIN_A, 0, LGPIO::BOTH_EDGES)
+LGPIO.gpio_claim_input(chip_handle, PIN_B, LGPIO::SET_PULL_NONE)
 LGPIO.gpio_set_debounce(chip_handle, PIN_B, 1)
-LGPIO.gpio_claim_alert(chip_handle, 0, LGPIO::BOTH_EDGES, PIN_B)
+LGPIO.gpio_claim_alert(chip_handle, PIN_B, 0, LGPIO::BOTH_EDGES)
 
 # Start generating reports for GPIO level changes.
 LGPIO.gpio_start_reporting

data/examples/gpio_wave.rb

@@ -7,7 +7,7 @@ INTERVAL    = 250_000 # 250ms
 TIMES       = 10
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.group_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LEDS, INIT_STATE)
+LGPIO.group_claim_output(chip_handle, LEDS, LGPIO::SET_PULL_NONE, INIT_STATE)
 
 # Generic pulse that updates both LED states (first element) each INTERVAL.
 generic_pulse = [ nil, 0b11, INTERVAL ]

data/examples/pwm_sw.rb

@@ -7,7 +7,7 @@ PWM_OFFSET  = 0
 PWM_CYCLES  = 0    # 0 = infinite
 
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, LED, LGPIO::LOW)
+LGPIO.gpio_claim_output(chip_handle, LED, LGPIO::SET_PULL_NONE, LGPIO::LOW)
 
 # Seamless loop from 0-100 and back.
 duty_cycles = (0..100).to_a + (1..99).to_a.reverse

data/examples/spi_bb_ssd1306_bench.rb

@@ -15,9 +15,9 @@ DC_PIN      = 6
 # Initialize
 chip_handle = LGPIO.chip_open(GPIO_CHIP)
 spi_bb      = LGPIO::SPIBitBang.new(handle: chip_handle, clock: CLOCK_PIN, output: OUTPUT_PIN)
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, SELECT_PIN, LGPIO::HIGH)
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, RESET_PIN, LGPIO::LOW)
-LGPIO.gpio_claim_output(chip_handle, LGPIO::SET_PULL_NONE, DC_PIN, LGPIO::LOW)
+LGPIO.gpio_claim_output(chip_handle, SELECT_PIN, LGPIO::SET_PULL_NONE, LGPIO::HIGH)
+LGPIO.gpio_claim_output(chip_handle, RESET_PIN, LGPIO::SET_PULL_NONE, LGPIO::LOW)
+LGPIO.gpio_claim_output(chip_handle, DC_PIN, LGPIO::SET_PULL_NONE, LGPIO::LOW)
 
 # OLED STARTUP
 LGPIO.gpio_write(chip_handle, RESET_PIN, 1)

data/ext/lgpio/lgpio.c

@@ -60,12 +60,12 @@ static VALUE gpio_get_mode(VALUE self, VALUE handle, VALUE gpio) {
   return INT2NUM(result);
 }
 
-static VALUE gpio_claim_output(VALUE self, VALUE handle, VALUE flags, VALUE gpio, VALUE level) {
+static VALUE gpio_claim_output(VALUE self, VALUE handle, VALUE gpio, VALUE flags, 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) {
+static VALUE gpio_claim_input(VALUE self, VALUE handle, VALUE gpio, VALUE flags) {
   int result = lgGpioClaimInput(NUM2INT(handle), NUM2INT(flags), NUM2INT(gpio));
   return INT2NUM(result);
 }
@@ -85,7 +85,7 @@ static VALUE gpio_write(VALUE self, VALUE handle, VALUE gpio, VALUE level) {
   return INT2NUM(result);
 }
 
-static VALUE group_claim_input(VALUE self, VALUE handle, VALUE flags, VALUE gpios) {
+static VALUE group_claim_input(VALUE self, VALUE handle, VALUE gpios, VALUE flags) {
   int count = rb_array_len(gpios);
   int lgGpios[count];
   int i;
@@ -96,7 +96,7 @@ static VALUE group_claim_input(VALUE self, VALUE handle, VALUE flags, VALUE gpio
   return INT2NUM(result);
 }
 
-static VALUE group_claim_output(VALUE self, VALUE handle, VALUE flags, VALUE gpios, VALUE levels) {
+static VALUE group_claim_output(VALUE self, VALUE handle, VALUE gpios, VALUE flags, VALUE levels) {
   int count = rb_array_len(gpios);
   int lgGpios[count];
   int lgLevels[count];
@@ -130,7 +130,7 @@ static VALUE gpio_set_debounce(VALUE self, VALUE handle, VALUE gpio, VALUE debou
   return INT2NUM(result);
 }
 
-static VALUE gpio_claim_alert(VALUE self, VALUE handle, VALUE flags, VALUE eFlags, VALUE gpio) {
+static VALUE gpio_claim_alert(VALUE self, VALUE handle, VALUE gpio, VALUE flags, VALUE eFlags) {
   int result = lgGpioClaimAlert(NUM2INT(handle), NUM2INT(flags), NUM2INT(eFlags), NUM2INT(gpio), -1);
   return INT2NUM(result);
 }

data/lib/lgpio/version.rb

@@ -1,3 +1,3 @@
 module LGPIO
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lgpio
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - vickash
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-09-28 00:00:00.000000000 Z
 dependencies: []
 description: Use Linux GPIO, I2C, SPI and PWM in Ruby
 email: mail@vickash.com
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: Use Linux GPIO, I2C, SPI and PWM in Ruby