denko-piboard 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c16debfc8c34bd8bcca26bc7bfacb260b807d795a36be181c2b9216d8c65da8
-  data.tar.gz: 06d80503b03ba7cc4dea13f1737d822ad8b1c8546db57da6a8dad9708232f6c6
+  metadata.gz: 1e8e869c561c0673bcd8cafbef836a7e0c8fddb369a0b97a0c60a67a99380faf
+  data.tar.gz: 7f84e27065a552ad844c0483c8a5ff23e05fd7a4c2a7a8c5be2c92e99bfe9862
 SHA512:
-  metadata.gz: 4f374de73471722936aebb24831c8bc02f7eace99ca8874ab5a6675554bb593a8b6d79b1617e80dca08e263a60858627214665dfb65f973cda19e4cb3d55a403
-  data.tar.gz: c1584302567d48e2f02dac57870b85cd113c8c60ce547853a83fd7945550c2aa67f095ceee1fa3987d168ac05a9456b74fca8565448a6ef61b77d9a05804e0ed
+  metadata.gz: aa4600cdd0cd83070610255636ae318a4a3eff654fc7fce96097558a0d4bd673b30a6e206aadba7f26010a17e1aa3615b11d1f3735a4aef2096024bc9409d687
+  data.tar.gz: d9d8d876321f87d4bc47c91913e91159d094a7558353750f16afce38fabe6b5ff50c620cb571c588c715af9dba6f7d469fcc9c665427d488f3f11e85c55c8792

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in denko.gemspec
+gemspec

data/README.md

@@ -74,12 +74,13 @@ In theory, this should work on any SBC, running Linux, with drivers for the rele
 | BCM2711           | :green_heart:   | Raspberry Pi 4, Raspberry Pi 400       | Raspberry Pi OS
 | BCM2710A1         | :green_heart:   | Raspberry Pi Zero 2W                   | Raspberry Pi OS
 | BCM2712           | :question:      | Raspberry Pi 5                         |
+| AML-S905X-CC      | :green_heart:   | Libre Computer Le Potato               | Libre Computer Debian 12
 
 #### Software
 
 - Operating Systems:
   - DietPi (Bookworm)
-  - Amrbian (Bookworm)
+  - Armbian (Bookworm)
   - Raspberry Pi OS (Bookworm)
 
 - Rubies:
@@ -131,7 +132,7 @@ overlays=i2c1-pi spidev1_0
 
 ### Radxa Zero3W/E
 - For Armbian OS specifically. Newer and performs better than latest Radxa OS or DietPi available.
-- Unfortunately, Armbian does not package all device tree overlays for the RK3566. I built binaries for this default config, on kernel `6.6.31-current-sunxi64`, and made them available [here](https://github.com/vickash/linux-sbc-overlays/tree/master/radxa/rockchip). To use, download the `.dtbo` files into `/boot/dtb/rockchip/overlay` on your Zero3. Make sure your kernel version matches.
+- Unfortunately, Armbian does not package all device tree overlays for the RK3566. I built binaries for this default config, on kernel `6.1.75-vendor-rk35xx`, and made them available [here](https://github.com/vickash/linux-sbc-overlays/tree/master/radxa/rockchip). To use, download the `.dtbo` files into `/boot/dtb/rockchip/overlay` on your Zero3. Make sure your kernel version matches.
 
 If you rather build the overlays yourself, that repo contains the script too. On the Zero3:
 ```console
@@ -167,6 +168,32 @@ dtparam=i2c_arm_baudrate=400000
 dtoverlay=spi0-1cs
 ```
 
+### Raspberry Pi 5
+- Instructions are same as Pi <= 4, but use the [Pi 5 map](board_maps/raspberry_pi5.yml) instead.
+- NOTE: This is based on Raspberry Pi docs, but untested in hardware. If you notice anything that should be fixed, please open a PR.
+
+### Libre Computer Le Potato
+- Use [Libre Computer Debian 12](https://distro.libre.computer/ci/debian/12/debian-12-base-arm64%2Baml-s905x-cc.img.xz)
+- Save the [default map](board_maps/le_potato.yml) as `~/.denko_piboard_map.yml` on your Le Potato.
+- Fix invalid signatures for apt:
+```console
+wget https://deb.libre.computer/repo/pool/main/libr/libretech-keyring/libretech-keyring_2024.05.19_all.deb
+sudo dpkg -i libretech-keyring_2024.05.19_all.deb
+sudo apt update
+```
+- Install the Libre Computer Wiring Tool:
+```console
+sudo apt install libretech-gpio libretech-dtoverlay
+```
+- Enable the default overlays for PWM, I2C and SPI:
+```console
+# 1 PWM on GPIO 95
+# 1 I2C (/dev/i2c-0) on GPIO 4 (SCL) and GPIO 5 (SDA)
+# 1 SPI (/dev/spidev0.0) on GPIO 90 (CLK), GPIO 87 (MOSI), GPIO 88 (MISO), GPIO 98 (CS)
+sudo ldto merge pwm-e i2c-ao spicc spicc-spidev
+```
+- Reboot to enable overlays
+
 ## Get Permissions
 By default, only the Linux `root` user can use GPIO / I2C / SPI / PWM. If you have a default board map at `~/.denko_piboard_map.yml`, save [this script](scripts/set_permissions.rb) to your SBC, then run it:
 

data/board_maps/README.md

@@ -53,7 +53,7 @@ This information enables denko-piboard to:
 - Refer to I2C and SPI by their Linux device indices
 - Raise errors if you try to use any reserved pin. This fails silently otherwise, which is confusing.
 
-There are pre-made maps for some boards [here](board_maps), which can be followed as templates. In general, these enable:
+There are pre-made maps for some boards [here](./), which can be followed as templates. In general, these enable:
 - 2 PWM pins
 - 1 I2C interface (on physical pins 3,5 when possible)
 - 1 SPI interface (on physical pins 19,21,23 when possible)

data/board_maps/le_potato.yml

@@ -0,0 +1,89 @@
+#
+# Tested on:
+#   - Libre Computer Le Potato AML-S905X-CC, using Libre Computing's official Debian 12 (2024-01-25), with kernel 6.1.92-15907-gf36fd2695db3
+#
+# Based on https://docs.google.com/spreadsheets/d/1U3z0Gb8HUEfCIMkvqzmhMpJfzRqjPXq7mFLC-hvbKlE
+# Uses "Linux" GPIO numbers from that table
+#
+---
+pins:
+  # Left side (odd numbered physical pins)
+  # PIN 1 is 3V3
+  5: { phy: 3, chip: 0, line: 5 }
+  4: { phy: 5, chip: 0, line: 4 }
+  98: { phy: 7, chip: 1, line: 98 }
+  # PIN 9 is GND
+  8: { phy: 11, chip: 0, line: 8 }
+  9: { phy: 13, chip: 0, line: 9 }
+  10: { phy: 15, chip: 0, line: 10 }
+  # PIN 17 is 3V3
+  87: { phy: 19, chip: 1, line: 87 }
+  88: { phy: 21, chip: 1, line: 88 }
+  90: { phy: 23, chip: 1, line: 90 }
+  # PIN 25 is GND
+  75: { phy: 27, chip: 1, line: 75 }
+  96: { phy: 29, chip: 1, line: 96 }
+  97: { phy: 31, chip: 1, line: 97 }
+  85: { phy: 33, chip: 1, line: 85 }
+  86: { phy: 35, chip: 1, line: 86 }
+  84: { phy: 37, chip: 1, line: 84 }
+  # PIN 39 is GND
+
+  # Right side (even numbered physical pins)
+  # PIN 2 is 5V
+  # PIN 4 is 5V
+  # PIN 6 is GND
+  91: { phy: 8, chip: 1, line: 91 }
+  92: { phy: 10, chip: 1, line: 92 }
+  6: { phy: 12, chip: 0, line: 6 }
+  # PIN 14 is GND
+  93: { phy: 16, chip: 1, line: 93 }
+  94: { phy: 18, chip: 1, line: 94 }
+  # PIN 20 is GND
+  79: { phy: 22, chip: 1, line: 79 }
+  89: { phy: 24, chip: 1, line: 89 }
+  80: { phy: 26, chip: 1, line: 80 }
+  76: { phy: 28, chip: 1, line: 76 }
+  # PIN 30 is GND
+  95: { phy: 32, chip: 1, line: 95 }
+  # PIN 34 is GND
+  81: { phy: 36, chip: 1, line: 81 }
+  82: { phy: 38, chip: 1, line: 82 }
+  83: { phy: 40, chip: 1, line: 83 }
+
+pwms:
+  # Overlay:        pwm-e
+  # Enable on boot: sudo ldto merge pwm-e
+  # Device:         /sys/class/pwm/pwmchip0/pwm0
+  #
+  95:
+    pwmchip: 0
+    channel: 0
+
+i2cs:
+  # Overlay:        i2c-ao
+  # Enable on boot: sudo ldto merge i2c-ao
+  # Device:         /dev/i2c-0
+  #
+  0:
+    scl: 4
+    sda: 5
+
+  # Overlay:        i2c-b
+  # Enable on boot: sudo ldto merge i2c-b
+  # Device:         /dev/i2c-0 (if enabled alone), /dev/i2c-1 (if enabled with i2c-ao)
+  #
+  # 1:
+  #   scl: 76
+  #   sda: 75
+
+spis:
+  # Overlays:       spicc, spicc-spidev
+  # Enable on boot: sudo ldto merge spicc spicc-spidev
+  # Device:         /dev/spidev0.0
+  #
+  0:
+    clk: 90
+    mosi: 87
+    miso: 88
+    cs0: 89

data/board_maps/raspberry_pi.yml

@@ -80,8 +80,8 @@ spis:
     clk: 11
     mosi: 10
     miso: 9
-    cs0: 8
-    # cs1: 7
+    # cs0: 8 # only if using dtoverlay=spi0-1cs or dtoverlay=spi0-2cs
+    # cs1: 7 # only if using dtoverlay=spi0-2cs
 
   #
   # To enable in /boot/config.txt:
@@ -91,5 +91,5 @@ spis:
     # mosi: 20
     # miso: 19
     # cs0: 18
-    ## cs1: 17
-    ## cs2: 16
+    # cs1: 17 # only if using dtoverlay=spi1-2cs or dtoverlay=spi1-3cs
+    # cs2: 16 # only if using dtoverlay=spi1-3cs

data/board_maps/raspberry_pi5.yml

@@ -0,0 +1,95 @@
+#
+# This is based on Rasperry Pi documentation, but UNTESTED in hardware.
+# It should work for the Raspberry Pi 5.
+#   - GPIO line numbers are same as older Pis, but the gpiochip has changed from 0 to 4.
+#   - dtparam/dtoverlay for PWM, I2C and SPI are all unchanged, based on info from:
+#       https://github.com/raspberrypi/firmware/blob/master/boot/overlays/README
+#   - Expected to work on current Raspberry Pi OS.
+#
+---
+pins:
+  # Left side (odd numbered physical pins)
+  # PIN 1 is 3V3
+  2: { phy: 3, chip: 4, line: 2 }
+  3: { phy: 5, chip: 4, line: 3 }
+  4: { phy: 7, chip: 4, line: 4 }
+  # PIN 9 is GND
+  17: { phy: 11, chip: 4, line: 17 }
+  27: { phy: 13, chip: 4, line: 27 }
+  22: { phy: 15, chip: 4, line: 22 }
+  # PIN 17 is 3V3
+  10: { phy: 19, chip: 4, line: 10 }
+  9: { phy: 21, chip: 4, line: 9 }
+  11: { phy: 23, chip: 4, line: 11 }
+  # PIN 25 is GND
+  0: { phy: 27, chip: 4, line: 0 }
+  5: { phy: 29, chip: 4, line: 5 }
+  6: { phy: 31, chip: 4, line: 6 }
+  13: { phy: 33, chip: 4, line: 13 }
+  19: { phy: 35, chip: 4, line: 19 }
+  26: { phy: 37, chip: 4, line: 26 }
+  # PIN 39 is GND
+
+  # Right side (even numbered physical pins)
+  # PIN 2 is 5V
+  # PIN 4 is 5V
+  # PIN 6 is GND
+  14: { phy: 8, chip: 4, line: 14 }
+  15: { phy: 10, chip: 4, line: 15 }
+  18: { phy: 12, chip: 4, line: 18 }
+  # PIN 14 is GND
+  23: { phy: 16, chip: 4, line: 23 }
+  24: { phy: 18, chip: 4, line: 24 }
+  # PIN 20 is GND
+  25: { phy: 22, chip: 4, line: 25 }
+  8: { phy: 24, chip: 4, line: 8 }
+  7: { phy: 6, chip: 4, line: 7 }
+  1: { phy: 28, chip: 4, line: 1 }
+  # PIN 30 is GND
+  12: { phy: 32, chip: 4, line: 12 }
+  # PIN 34 is GND
+  16: { phy: 36, chip: 4, line: 16 }
+  20: { phy: 38, chip: 4, line: 20 }
+  21: { phy: 40, chip: 4, line: 21 }
+
+pwms:
+  #
+  # To enable in /boot/config.txt:
+  #   dtoverlay=pwm-2chan,pin=12,func=4,pin2=13,func2=4
+  12:
+    pwmchip: 0
+    channel: 0
+  13:
+    pwmchip: 0
+    channel: 1
+
+i2cs:
+  #
+  # To enable in /boot/config.txt:
+  #   dtparam=i2c_arm=on
+  #   dtparam=i2c_arm_baudrate=400000
+  1:
+    scl: 3
+    sda: 2
+
+spis:
+  #
+  # To enable in /boot/config.txt:
+  #   dtoverlay=spi0-0cs
+  0:
+    clk: 11
+    mosi: 10
+    miso: 9
+    # cs0: 8 # only if using dtoverlay=spi0-1cs or dtoverlay=spi0-2cs
+    # cs1: 7 # only if using dtoverlay=spi0-2cs
+
+  #
+  # To enable in /boot/config.txt:
+  #   dtoverlay=spi1-1cs
+  # 1:
+    # clk: 21
+    # mosi: 20
+    # miso: 19
+    # cs0: 18
+    # cs1: 17 # only if using dtoverlay=spi1-2cs or dtoverlay=spi1-3cs
+    # cs2: 16 # only if using dtoverlay=spi1-3cs

data/denko_piboard.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>=3'
 
   s.add_dependency 'lgpio',  '~> 0.1'
-  s.add_dependency 'denko',  '~> 0.14'
+  s.add_dependency 'denko',  '~> 0.15'
 end

data/examples/display/ssd1306.rb

@@ -27,16 +27,26 @@ oled = Denko::Display::SSD1306.new(bus: bus, rotate: true) # address: 0x3C is de
 # select: and dc: pins must be given. reset is optional (can be pulled high instead).
 # oled = Denko::Display::SSD1306.new(bus: bus, pins: {reset: 259, dc: 260, select: chip_select}, rotate: true)
 
+# Transformation features in hardware.
+# oled.reflect_x
+# oled.reflect_y
+oled.rotate
+
 # Draw some text on the OLED's canvas (a Ruby memory buffer).
 canvas = oled.canvas
-canvas.text_cursor = [27,60]
-canvas.print("Hello World!")
+baseline = 42
+canvas.text_cursor = 27, baseline+15
+canvas.text "Hello World!"
 
 # Add some shapes to the canvas.
-baseline = 40
-canvas.rectangle(10, baseline, 30, -30)
-canvas.circle(66, baseline - 15, 15)
-canvas.triangle(87, baseline, 117, baseline, 102, baseline - 30)
+canvas.rectangle  x: 10, y: baseline,    w: 30, h: -30
+canvas.circle     x: 66, y: baseline-15, r: 15
+canvas.triangle   x1: 87,   y1: baseline,
+                  x2: 117,  y2: baseline,
+                  x3: 102,  y3: baseline-30
+
+# 1px border to test screen edges.
+canvas.rectangle x1: 0, y1: 0, x2: canvas.x_max, y2: canvas.y_max
 
 # Send the canvas to the OLED's graphics RAM so it shows.
 oled.draw

data/examples/led/fade.rb

@@ -17,6 +17,6 @@ end
 values = (0..100).to_a + (1..99).to_a.reverse
 
 values.cycle do |v|
-  led.write(v)
+  led.duty = v
   sleep 0.020
 end

data/lib/denko/piboard.rb

@@ -8,7 +8,6 @@ require_relative 'piboard_pulse'
 require_relative 'piboard_tone'
 
 require_relative 'piboard_hardware_pwm'
-require_relative 'piboard_servo'
 require_relative 'piboard_infrared'
 
 require_relative 'piboard_i2c'

data/lib/denko/piboard_base.rb

@@ -22,6 +22,10 @@ module Denko
       parse_map(map_yaml_file)
     end
 
+    def platform
+      :linux
+    end
+
     def finish_write
       gpio_handles.each { |h| LGPIO.chip_close(h) if h }
     end

data/lib/denko/piboard_core.rb

@@ -73,11 +73,13 @@ module Denko
 
     def pwm_write(pin, duty)
       if hardware_pwms[pin]
-        hardware_pwms[pin].duty_percent = duty
+        hardware_pwms[pin].duty = duty
       else
-        frequency    = pin_configs[pin][:frequency] || 1000
         handle, line = gpio_tuple(pin)
-        LGPIO.tx_pwm(handle, line, frequency, duty, 0, 0)
+        frequency    = pin_configs[pin][:frequency] || 1000
+        period       = pin_configs[pin][:period]    || 1_000_000
+        duty_percent = (duty.to_f / period) * 100
+        LGPIO.tx_pwm(handle, line, frequency, duty_percent, 0, 0)
       end
     end
 

data/lib/denko/piboard_hardware_pwm.rb

@@ -1,5 +1,10 @@
 module Denko
   class PiBoard
+    # Check if a GPIO number is bound to a hardware PWM.
+    def pin_is_pwm?(pin)
+      map[:pwms][pin]
+    end
+
     def hardware_pwms
       @hardware_pwms ||= []
     end

data/lib/denko/piboard_map.rb

@@ -128,5 +128,9 @@ module Denko
     def convert_pin(pin)
       pin.to_i if pin
     end
+    
+    def pin_is_pwm?(pin)
+      map[:pwms][pin]
+    end
   end
 end

data/lib/denko/piboard_spi.rb

@@ -1,5 +1,9 @@
 module Denko
   class PiBoard
+    def spi_limit
+      4096
+    end
+
     def spi_flags(mode)
       mode ||= 0
       raise ArgumentError, "invalid SPI mode #{mode}" unless (0..3).include? mode

data/lib/denko/piboard_version.rb

@@ -1,5 +1,5 @@
 module Denko
   class PiBoard
-    VERSION = '0.14.0'
+    VERSION = '0.15.0'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: denko-piboard
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - vickash
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lgpio
@@ -30,27 +29,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
 description: Use Linux single-board-computer GPIO, I2C, SPI and PWM in Ruby
 email: mail@vickash.com
 executables: []
 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
@@ -86,7 +88,6 @@ files:
 - 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
@@ -98,7 +99,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/denko-rb/denko-piboard
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Linux SBC GPIO in Ruby
 test_files: []

data/lib/denko/piboard_servo.rb

@@ -1,19 +0,0 @@
-module Denko
-  class PiBoard
-    # CMD = 10
-    def servo_toggle(pin, value=:off, options={})
-      pwm = hardware_pwm_from_pin(pin)
-      if (value == :off)
-        pwm.duty_cycle = 0
-        pwm.disable
-      elsif
-        pwm.frequency = 50
-      end
-    end
-
-    # CMD = 11
-    def servo_write(pin, value=0)
-      hardware_pwms[pin].duty_us = value
-    end
-  end
-end