pigpiod 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7402311d7d55303c25209cbe6dd119955681714fe86e8ee830a0931575ddc79e
+  data.tar.gz: 9a1805587185f5724683d4f36801bb534ea8b5cd256e08f288161c6a59dace40
+SHA512:
+  metadata.gz: 608f85c221dc559a57c9273febf63c9c583049caa28a7e1fd506c9bb9c48bc0320cff7ce8694e8b58ec8cf8a2f019fc29671b6545cb766f3c446b0faee1b234f
+  data.tar.gz: 01e51a27bd50621c79380383735fb5a954379c552d94d1a636242be1830ef16ccc956888ca2ee4e454b3e61e03693a12a6e9785ef93bf2cefff29efbf556d397

data/exe/pigpio_mqtt_bridge

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "mqtt-homeassistant"
+require "optparse"
+require "pigpiod"
+require "yaml"
+
+config_file = nil
+device_id = "pigpio"
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: pigpio_mqtt_bridge MQTT_URI [options]"
+
+  opts.on("-c", "--config=YML", "Specify a configuration YAML file to set up the pins") { |v| config_file = v }
+  opts.on("-d", "--device-id=ID", "Specify Homie device ID") { |v| device_id = v }
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+options.parse!
+
+unless ARGV.length == 1
+  puts options
+  exit 1
+end
+
+config = {}
+config = YAML.load_file(config_file) if config_file
+
+config.each do |pin, gpio_config|
+  pin = pin.to_i
+  raise "Unrecognized gpio" unless (gpio = PiGPIO.instance.gpios[pin])
+
+  gpio.mode = gpio_config[:mode].to_sym if gpio_config[:mode]
+  gpio.pull_up_down = gpio_config[:pull_up_down].to_sym if gpio_config[:pull_up_down]
+  gpio.invert_logic = gpio_config[:invert_logic] if gpio_config[:invert_logic]
+end
+
+homie = MQTT::Homie::Device.new(device_id, "PiGPIO", mqtt: ARGV[0])
+homie.home_assistant_device = {
+  manufacturer: "Raspberry Pi Foundation"
+}
+
+PiGPIO.instance.gpios.each do |gpio|
+  homie.node("gpio#{gpio.g}", "GPIO #{gpio.g}", "GPIO") do |node|
+    node.property("mode", "Mode", :enum, gpio.mode, format: PiGPIO::GPIO::MODES)
+    node.property("level", "Logic Level", :boolean, gpio.level, hass: :switch) do |value, prop|
+      next unless gpio.mode == :output
+
+      prop.value = gpio.level = value
+    end
+    node.property("pull-up-down", "Internal Pull Up/Down Resistor", :enum, retained: false,
+                                                                           format: %w[up down off]) do |value|
+      gpio.pull_up_down = value.to_sym
+    end
+  end
+end
+
+homie.publish
+homie.join

data/lib/pi_gpio/errors.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+class PiGPIO
+  class Error < RuntimeError
+    attr_reader :code
+
+    def initialize(code, message)
+      @code = code
+      super(message)
+    end
+  end
+
+  ERRORS = [
+    "gpioInitialise failed",
+    "GPIO not 0-31",
+    "GPIO not 0-53",
+    "mode not 0-7",
+    "level not 0-1",
+    "pud not 0-2",
+    "pulsewidth not 0 or 500-2500",
+    "dutycycle outside set range",
+    "timer not 0-9",
+    "ms not 10-60000",
+    "timetype not 0-1",
+    "seconds < 0",
+    "micros not 0-999999",
+    "gpioSetTimerFunc failed",
+    "timeout not 0-60000",
+    "DEPRECATED: no alert func",
+    "clock peripheral not 0-1",
+    "DEPRECATED: bad clk source",
+    "clock micros not 1, 2, 4, 5, 8, or 10",
+    "buf millis not 100-10000",
+    "dutycycle range not 25-40000",
+    "signum not 0-63",
+    "can't open pathname",
+    "no handle available",
+    "unknown handle",
+    "ifFlags > 4",
+    "DMA channel not 0-15",
+    "socket port not 1024-32000",
+    "unrecognized fifo command",
+    "DMA secondary channel not 0-15",
+    "function called before gpioInitialise",
+    "function called after gpioInitialise",
+    "waveform mode not 0-3",
+    "bad parameter in gpioCfgInternals call",
+    "baud rate not 50-250K(RX)/50-1M(TX)",
+    "waveform has too many pulses",
+    "waveform has too many chars",
+    "no bit bang serial read on GPIO",
+    "bad (null) serial structure parameter",
+    "bad (null) serial buf parameter",
+    "GPIO operation not permitted",
+    "one or more GPIO not permitted",
+    "bad WVSC subcommand",
+    "bad WVSM subcommand",
+    "bad WVSP subcommand",
+    "trigger pulse length not 1-100",
+    "invalid script",
+    "unknown script id",
+    "add serial data offset > 30 minutes",
+    "GPIO already in use",
+    "must read at least a byte at a time",
+    "script parameter id not 0-9",
+    "script has duplicate tag",
+    "script has too many tags",
+    "illegal script command",
+    "script variable id not 0-149",
+    "no more room for scripts",
+    "can't allocate temporary memory",
+    "socket read failed",
+    "socket write failed",
+    "too many script parameters (> 10)",
+    "script initialising",
+    "script has unresolved tag",
+    "bad MICS delay (too large)",
+    "bad MILS delay (too large)",
+    "non existent wave id",
+    "No more CBs for waveform",
+    "No more OOL for waveform",
+    "attempt to create an empty waveform",
+    "no more waveforms",
+    "can't open I2C device",
+    "can't open serial device",
+    "can't open SPI device",
+    "bad I2C bus",
+    "bad I2C address",
+    "bad SPI channel",
+    "bad i2c/spi/ser open flags",
+    "bad SPI speed",
+    "bad serial device name",
+    "bad serial baud rate",
+    "bad i2c/spi/ser parameter",
+    "i2c write failed",
+    "i2c read failed",
+    "bad SPI count",
+    "ser write failed",
+    "ser read failed",
+    "ser read no data available",
+    "unknown command",
+    "spi xfer/read/write failed",
+    "bad (NULL) pointer",
+    "no auxiliary SPI on Pi A or B",
+    "GPIO is not in use for PWM",
+    "GPIO is not in use for servo pulses",
+    "GPIO has no hardware clock",
+    "GPIO has no hardware PWM",
+    "invalid hardware PWM frequency",
+    "hardware PWM dutycycle not 0-1M",
+    "invalid hardware clock frequency",
+    "need password to use hardware clock 1",
+    "illegal, PWM in use for main clock",
+    "serial data bits not 1-32",
+    "serial (half) stop bits not 2-8",
+    "socket/pipe message too big",
+    "bad memory allocation mode",
+    "too many I2C transaction segments",
+    "an I2C transaction segment failed",
+    "SMBus command not supported by driver",
+    "no bit bang I2C in progress on GPIO",
+    "bad I2C write length",
+    "bad I2C read length",
+    "bad I2C command",
+    "bad I2C baud rate, not 50-500k",
+    "bad chain loop count",
+    "empty chain loop",
+    "too many chain counters",
+    "bad chain command",
+    "bad chain delay micros",
+    "chain counters nested too deeply",
+    "chain is too long",
+    "deprecated function removed",
+    "bit bang serial invert not 0 or 1",
+    "bad ISR edge value, not 0-2",
+    "bad ISR initialisation",
+    "loop forever must be last command",
+    "bad filter parameter",
+    "bad pad number",
+    "bad pad drive strength",
+    "file open failed",
+    "bad file mode",
+    "bad file flag",
+    "bad file read",
+    "bad file write",
+    "file not open for read",
+    "file not open for write",
+    "bad file seek",
+    "no files match pattern",
+    "no permission to access file",
+    "file is a directory",
+    "bad shell return status",
+    "bad script name",
+    "bad SPI baud rate, not 50-500k",
+    "no bit bang SPI in progress on GPIO",
+    "bad event id",
+    "Used by Python",
+    "not available on BCM2711",
+    "only available on BCM2711"
+  ].freeze
+  private_constant :ERRORS
+end

data/lib/pi_gpio/gpio.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class PiGPIO
+  class GPIO
+    MODE_VALUES = %i[
+      input
+      output
+      alt5
+      alt4
+      alt0
+      alt1
+      alt2
+      alt3
+    ].freeze
+    MODE_CODES = {
+      input: "R",
+      output: "W",
+      alt0: 0,
+      alt1: 1,
+      alt2: 2,
+      alt3: 3,
+      alt4: 4,
+      alt5: 5
+    }.freeze
+    MODES = MODE_CODES.keys.freeze
+    private_constant :MODE_VALUES, :MODE_CODES
+
+    attr_accessor :invert_logic
+    attr_reader :g
+
+    def initialize(pigpio, g) # rubocop:disable Naming/MethodParameterName
+      @pigpio = pigpio
+      @g = g
+      @invert_logic = false
+    end
+
+    def inspect
+      vals = {
+        g: g,
+        invert_logic: invert_logic,
+        mode: @mode
+      }.compact
+      "#<PiGPIO::GPIO #{vals.map { |k, v| "#{k}=#{v.inspect}" }.join(" ")}>"
+    end
+
+    def mode
+      @mode ||= MODE_VALUES[command("mg #{g}")]
+    end
+
+    def mode=(value)
+      raise ArgumentError, "Invalid mode #{value.inspect}" unless MODE_CODES.key?(value)
+
+      @mode = nil
+      command("m #{g} #{MODE_CODES[value]}")
+    end
+
+    def pull_up_down=(value)
+      raise ArgumentError, "Invalid setting #{value.inspect}" unless %i[up down off].include?(value)
+
+      command("pud #{g} #{value.to_s.first}")
+    end
+
+    def level
+      result = !command("r #{g}").zero?
+      result = !result if invert_logic
+      result
+    end
+
+    def level=(value)
+      raise ArgumentError, "Invalid level #{value.inspect}" unless [true, false].include?(value)
+
+      value = !value if invert_logic
+      command("w #{g} #{value ? 1 : 0}")
+    end
+
+    private
+
+    def command(command)
+      @pigpio.send(:command, command)
+    end
+  end
+end

data/lib/pigpiod.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "io/wait"
+require "singleton"
+
+require "pi_gpio/errors"
+require "pi_gpio/gpio"
+
+class PiGPIO
+  include Singleton
+
+  attr_reader :gpios
+
+  def initialize
+    @pigpio = File.open("/dev/pigpio", "wb")
+    @pigout = File.open("/dev/pigout", "rb")
+
+    @gpios = Array.new(54) { |g| GPIO.new(self, g) }
+  end
+
+  def inspect
+    "#<PiGPIO>"
+  end
+
+  private
+
+  def command(command)
+    @pigpio.puts(command)
+    @pigpio.flush
+    @pigout.wait_readable
+    result = @pigout.read_nonblock(256).strip.to_i
+    if result.negative?
+      error_index = -result - 1
+      raise Error.new(result, ERRORS[error_index])
+    end
+    result
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: pigpiod
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mqtt-homeassistant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: 
+email: cody@cutrer.com'
+executables:
+- pigpio_mqtt_bridge
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/pigpio_mqtt_bridge
+- lib/pi_gpio/errors.rb
+- lib/pi_gpio/gpio.rb
+- lib/pigpiod.rb
+homepage: https://github.com/ccutrer/ruby-pigpiod
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: Publish pigpiod access to MQTT
+test_files: []