dino-piboard 0.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c818f293ae8e78640d008dea2a231c80bbff914ac04bb940ff7776eeb63cee5
+  data.tar.gz: b6af65be62e98f36c54f61530a06be17724c50b081b3d692b46ff07ec8c80bbf
+SHA512:
+  metadata.gz: 44b41a354d3f7596c3a31026729bf692c0316f0b88f8984b7202227623aca58761475731741e58c9b81049e5bd48465e10545bc2fa285c72c5385a5783b03b53
+  data.tar.gz: b6bc39739b03253c8a5811cf9c44521a3afc119f73e8466f099cf06e8700dba2cd2b270827e012f8c20c794492d90d78c8c54ffa4836915ebe44344de0a9a38d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 dino-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,99 @@
+# dino-piboard 0.13.0
+
+This is an add-on to the [`dino`](https://github.com/austinbv/dino) gem. It adds support for the GPIO interface on Raspberry Pi single board computers. Unlike the main `dino` gem, which connects a computer running Ruby to an external microcontroller, this requires only a Pi.
+
+`Dino::PiBoard` gives access to the Pi's own GPIO, and is a drop-in replacement for `Dino::Board`, which would represent an external microcontroller.
+
+**Note:** This is not for the Raspberry Pi Pico (W) / RPP2040. That microcontroller is covered by the main gem.
+
+## Installation
+**Note:** This gem is very new. It WILL NOT work with the version of `dino` (0.11.3) currently available on rubygems.org. Before installing `dino-piboard`, make sure to install the latest dino version (future 0.13.0) from the master branch source.
+
+Install dino from source:
+```shell
+sudo gem uninstall dino
+git clone https://github.com/austinbv/dino.git
+cd dino
+gem build
+sudo gem install dino-0.13.0.gem
+```
+
+Install the pigpo C library:
+```shell
+sudo apt-get install pigpio
+```
+
+Install this gem:
+```shell
+sudo gem install dino-piboard
+```
+
+## Example
+Create a script, `led_button.rb`:
+```ruby
+require 'dino/piboard'
+
+# Create a board instance for the Raspberry Pi.
+board = Dino::PiBoard.new
+
+# LED connected to GPIO4.
+led = Dino::LED.new(board: board, pin: 4)
+
+# Momentary button connected to GPIO17, using internal pullup.
+button = Dino::DigitalIO::Button.new(board: board, pin: 17, pullup: true)
+
+# Led on when button is down (0)
+button.down do
+  puts "Button down"
+  led.on
+end
+
+# Led is off when button is up (1)
+button.up do
+  puts "Button up"
+  led.off
+end
+
+# Sleep main thread. Ctrl+C to quit.
+sleep
+```
+
+Run the script as root (pigpio can only be used as root):
+```shell
+sudo ruby led_button.rb
+```
+
+See [`examples`](https://github.com/austinbv/dino/tree/master/examples) in the main gem for more. Remove any `Dino::Board::Connection` and `Dino::Board` objects that the script sets up, and do `board = Dino::PiBoard.new` instead. Not all features are implemented yet though, nor can be implemented. See [Feautres](#features) below.
+
+## How It Works
+
+This gem uses the [`pigpio_ffi`](https://github.com/dino-rb/pigpio_ffi) gem, which in turn uses [`ffi`](https://github.com/ffi/ffi) to map the functions of the [`pigpio`](https://github.com/joan2937/pigpio) C library. `pigpio` provides low-level access to the Raspberry Pi's GPIO interface.
+
+Building on that, `Dino::PiBoard` plugs in as a (mostly) seamless replacement for `Dino::Board`. This allows `dino` features and component classes to be used directly on a Raspberry Pi, without an external microcontroller.
+
+## Features
+
+### Already Implemented
+  - Internal Pull Down/Up
+  - Digital Out
+  - Digital In
+  - PWM Out
+
+### To Be Implemented
+  - Tone Out
+  - Servo
+  - I2C
+  - SPI
+  - OneWire
+  - Infrared Out
+
+### Won't Be Implemented
+  - UART. It would wrap a [`rubyserial`](https://github.com/hybridgroup/rubyserial) instance. Use that directly instead.
+
+### Might Be Different
+  - Variable Digital Listen Timing (pigpio doesn't have a real way to do this, but glitch filter might be even better?)
+
+### Incompatible
+  - Handshake (no need, since running on the same board)
+  - EEPROM (can't mess with that. Use the filesystem instead)
+  - Analog IO (No analog pins on Raspberry Pi. Use an ADC or DAC over I2C or SPI)

data/dino_piboard.gemspec

@@ -0,0 +1,18 @@
+require_relative 'lib/dino/piboard_version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dino-piboard'
+  s.version     = Dino::PiBoard::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = "Use a Raspberry Pi's built-in GPIO as a board with the dino gem"
+  s.description = "Dino::PiBoard plugs in as a (mostly) seamless replacement for Dino::Board. This allows dino features and component classes to be used directly on a Raspberry Pi, without an external microcontroller."
+
+  s.authors     = ["vickash"]
+  s.email       = 'vickashmahabir@gmail.com'
+  s.files       =  Dir['**/*'].reject { |f| f.match /.gem\z/}
+  s.homepage    = 'https://github.com/dino-rb/dino-piboard'
+  s.metadata    = { "source_code_uri" => "https://github.com/dino-rb/dino-piboard" }
+
+  s.add_dependency 'pigpio_ffi'
+  s.add_dependency 'dino'
+end

data/lib/dino/piboard.rb

@@ -0,0 +1,99 @@
+require 'pigpio_ffi'
+require 'dino'
+
+module Dino
+  class PiBoard
+    attr_reader :components, :high, :low
+
+    def initialize
+      @components = []
+
+      # Sample every 10us, using PCM peripheral. Keeps CPU usage down.
+      PiGPIO.gpioCfgClock(10, 1, 0)    
+      PiGPIO.gpioInitialise
+    
+      @low  = 0
+      @high = 1
+    end
+
+    def finish_write
+      PiGPIO.gpioTerminate
+    end
+
+    def update(pin, message, time)
+      update_component(pin, message)
+    end
+
+    def update_component(pin, message)
+      @components.each do |part|
+        part.update(message) if part.pin.to_i == pin
+      end
+    end
+
+    def add_component(component)
+      @components << component
+    end
+
+    def remove_component(component)
+      # component.stop if component.methods.include? :stop
+      @components.delete(component)
+    end
+
+    # CMD = 0
+    def set_pin_mode(pin, mode=:input)
+      # Output
+      if mode.to_s.match /output/
+        PiGPIO.gpioSetMode(pin, 1)
+
+      # Input
+      else  
+        PiGPIO.gpioSetMode(pin, 0)
+        # Only respond if level has been stable for 90us.
+        PiGPIO.gpioGlitchFilter(pin, 90)      
+
+        # Pull down/up/none
+        if mode.to_s.match /pulldown/
+          PiGPIO.gpioSetPullUpDown(pin, 1)
+        elsif mode.to_s.match /pullup/
+          PiGPIO.gpioSetPullUpDown(pin, 2)
+        else
+          PiGPIO.gpioSetPullUpDown(pin, 0)
+        end
+      end
+    end
+
+    # CMD = 1
+    def digital_write(pin, value)
+      PiGPIO.gpioWrite(pin, value)
+    end
+    
+    # CMD = 2
+    def digital_read(pin)
+      update(pin, PiGPIO.gpioRead(pin))
+    end
+
+    # CMD = 3
+    def pwm_write(pin, value)
+      PiGPIO.gpioPWM(pin, value)
+    end
+
+    # CMD = 6
+    def set_listener(set_pin, state=:off, options={})
+      if state == :on
+        PiGPIO.gpioSetAlertFunc(set_pin) do |pin, message, time|
+          update(pin, message, time)
+        end
+      else
+        PiGPIO._gpioSetAlertFunc(pin, nil)
+      end
+    end
+
+    def digital_listen(pin, divider=4)
+      set_listener(pin, :on, {})
+    end
+
+    def stop_listener(pin)
+      set_listener(pin, :off)
+    end
+  end
+end

data/lib/dino/piboard_version.rb

@@ -0,0 +1,5 @@
+module Dino
+  class PiBoard
+    VERSION = '0.13.0'
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: dino-piboard
+version: !ruby/object:Gem::Version
+  version: 0.13.0
+platform: ruby
+authors:
+- vickash
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pigpio_ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dino
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dino::PiBoard plugs in as a (mostly) seamless replacement for Dino::Board.
+  This allows dino features and component classes to be used directly on a Raspberry
+  Pi, without an external microcontroller.
+email: vickashmahabir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- dino_piboard.gemspec
+- lib/dino/piboard.rb
+- lib/dino/piboard_version.rb
+homepage: https://github.com/dino-rb/dino-piboard
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/dino-rb/dino-piboard
+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.4.8
+signing_key:
+specification_version: 4
+summary: Use a Raspberry Pi's built-in GPIO as a board with the dino gem
+test_files: []