ffi-wiring_pi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b093eca499d179c3e519ff1538646aa14f9c5857ad81594407cbf9571a15669
+  data.tar.gz: 19775a22037d0c3af959a33d0550ea4cf38c5f3e566a23b901e179a79373e40e
+SHA512:
+  metadata.gz: 1768ba1ccd52dedf96527da90a2613249f18b0918aef34cd6bf1a7546ee17cf02c32e9d41687ab45b0f34700c42de328fb211a3b9c94490dd361a63fddf0d665
+  data.tar.gz: 05eb09d62cac5c272e0bc6cff217006891e6075c2d2db16af7d8064956c5d278261256099ddef9bcf6b13fc3d856a4e5977ade4c3ad6b601f43f075f98c41cde

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+before_install:
+  - git clone git://git.drogon.net/wiringPi
+  - cd wiringPi
+  - ./build
+  - gem install ffi
+rvm:
+  - 2.6.1
+script: rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    ffi-wiring_pi (0.1.0)
+      ffi (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ffi (1.10.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    yard (0.9.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ffi-wiring_pi!
+  rspec (~> 3.8)
+  yard (~> 0.9.1)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Mark Huk
+
+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,44 @@
+# ffi-wiring-pi
+
+* [Source](https://github.com/vimutter/ffi-wiring_pi/)
+* [Issues](https://github.com/vimutter/ffi-wiring_pi/issues)
+
+## Description
+
+Ruby FFI bindings for the [wiringPi](http://wiringpi.com) library.
+
+## Features
+
+* Can setup and work with GPIO
+
+## Examples
+
+Setup GPIO:
+
+    require 'ffi/wiring_pi'
+
+    # Will setup with wiringPi pin numbering scheme
+    FFI::WiringPi::GPIO.setup
+    FFI::WiringPi::GPIO.set_pin_mode(0, FFI::WiringPi::GPIO::OUTPUT)
+    FFI::WiringPi::GPIO.write(0, true)
+    # Or
+    FFI::WiringPi::GPIO.up(0)
+    # Or
+    pin = FFI::WiringPi::GPIO.get(0)
+    pin.up!
+
+## Requirements
+
+* [Ruby](http://ruby-lang.org/) >= 2.6.1 or
+* [wiringPi](http://wiringpi.com/download-and-install/) >= 2.46
+* [ffi](http://github.com/ffi/ffi) ~> 1.0
+
+## Install
+
+    $ gem install ffi-wiring_pi
+
+## License
+
+Copyright (c) 2019 Mark Huk
+
+See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rspec'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :test => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.9.18'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/ffi-wiring_pi.gemspec

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split($/)
+          elsif File.directory?('.svn')
+            `svn ls -R`.split($/).select { |path| File.file?(path) }
+          else
+            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+          end
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/ffi/wiring_pi/version.rb',
+    :constant => 'FFI::WiringPi::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  gemspec.files = filter_files[metadata['files']]
+
+  gemspec.executables = metadata['executables']
+  gemspec.extensions = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])
+    end
+  end
+end

data/gemspec.yml

@@ -0,0 +1,18 @@
+name: ffi-wiring_pi
+version: 0.1.0
+summary: FFI bindings for wiringPi
+description: Ruby FFI bindings for the wiringPi library.
+license: MIT
+authors: Mark Huk
+email: mark.guk.e@gmail.com
+homepage: https://github.com/vimutter/ffi-wiring_pi
+has_yard: true
+
+requirements: wiringPi >= 2.46
+
+dependencies:
+  ffi: ~> 1.0
+
+development_dependencies:
+  rspec: ~> 3.8
+  yard: ~> 0.9.1

data/lib/ffi/wiring_pi.rb

@@ -0,0 +1,3 @@
+#frozen_string_literal: true
+
+require 'ffi/wiring_pi'

data/lib/ffi/wiring_pi/gpio.rb

@@ -0,0 +1,124 @@
+#frozen_string_literal: true
+
+module FFI::WiringPi::GPIO
+  extend FFI::Library
+
+  INPUT = 0
+  OUTPUT = 1
+  PWM_OUTPUT = 2
+  GPIO_CLOCK = 3
+  SOFT_PWM_OUTPUT = 4
+  SOFT_TONE_OUTPUT = 5
+  PWM_TONE_OUTPUT = 6
+
+  LOW = 0
+  HIGH = 1
+
+  PUD_OFF = 0
+  PUD_DOWN = 1
+  PUD_UP = 2
+
+  PWM_MODE_MS = 0
+  PWM_MODE_BAL = 1
+
+
+  ffi_lib 'wiringPi'
+
+  attach_function :setup, :wiringPiSetup, [], :int
+  attach_function :setup_as_gpio, :wiringPiSetupGpio, [], :int
+  attach_function :setup_as_physical, :wiringPiSetupPhys, [], :int
+
+  # This initialises wiringPi but uses the /sys/class/gpio interface rather
+  # than accessing the hardware directly. This can be called as a non-root user
+  # provided the GPIO pins have been exported before-hand using the gpio program.
+  # Pin numbering in this mode is the native Broadcom GPIO numbers – the same as
+  # wiringPiSetupGpio() above, so be aware of the differences between Rev 1 and Rev 2 boards.
+  # Note: In this mode you can only use the pins which have been exported via the /sys/class/gpio
+  #   interface before you run your program. You can do this in a separate shell-script, or by
+  #   using the system() function from inside your program to call the gpio program.
+  # Also note that some functions have no effect when using this mode as they’re
+  # not currently possible to action unless called with root privileges.
+  # (although you can use system() to call gpio to set/change modes if needed)
+  #
+  # @see http://wiringpi.com/reference/setup/
+  attach_function :setup_system_mode, :wiringPiSetupSys, [], :int
+
+  #
+  # @param pin [Integer] pin position (depends on setup mode)
+  # @param mode [Integer] `FFI::WiringPi::GPIO::INPUT`, `FFI::WiringPi::GPIO::OUTPUT`,
+  #   `FFI::WiringPi::GPIO::PWM_OUTPUT` or `FFI::WiringPi::GPIO::GPIO_CLOCK`
+  attach_function :set_pin_mode, :pinMode, [:int, :int], :void
+
+  def get(pin, mode = FFI::WiringPi::GPIO::OUTPUT)
+    set_pin_mode(pin, mode)
+    Pin.new(pin, mode)
+  end
+
+  # @param pin [Integer] pin position (depends on setup mode)
+  # @param mode [Integer] `FFI::WiringPi::GPIO::LOW` or `FFI::WiringPi::GPIO::HIGH`
+  attach_function :digital_write, :digitalWrite, [:int, :int], :void
+
+  # Write pin state (aka digital_write)
+  #
+  # @param pin [Integer] pin position (depends on setup mode)
+  # @param state [Boolean] `true` to set to HIGH, `false` to set to LOW
+  #
+  def write(pin, state)
+    digital_write(state ? HIGH : LOW)
+  end
+
+  # Sets pin to HIGH state
+  #
+  # @param pin [Integer] pin position (depends on setup mode)
+  #
+  def up(pin)
+    write(pin, true)
+  end
+
+  # Sets pin to LOW state
+  #
+  # @param pin [Integer] pin position (depends on setup mode)
+  #
+  def down(pin)
+    write(pin, false)
+  end
+
+  # @param pin [Integer] pin position (depends on setup mode)
+  #
+  # @returns [Integer] `FFI::WiringPi::GPIO::LOW` or `FFI::WiringPi::GPIO::HIGH`
+  attach_function :digital_read, :digitalRead, [:int], :int
+
+  # Read pin state (aka digital_read)
+  #
+  # @param pin [Integer] pin position (depends on setup mode)
+  # @returns [Boolean] `true` if pin is in high state, `false` if in low
+  #
+  def read(pin)
+    result = digital_read(pin)
+    case result
+    when LOW
+      false
+    when HIGH
+      true
+    else
+      raise "Unknown result: #{result.inspect}"
+    end
+  end
+
+  class Pin
+    def initialize(position, mode)
+      @position = position
+      @mode = mode
+    end
+
+    def up!
+      raise ArgumentError('Can only set in OUTPUT mode') && return unless @mode == OUTPUT
+      GPIO.up(@position)
+    end
+
+    def down!
+      raise ArgumentError('Can only set in OUTPUT mode') && return unless @mode == OUTPUT
+      GPIO.down(@position)
+    end
+  end
+end

data/lib/ffi/wiring_pi/wiring_pi.rb

@@ -0,0 +1,10 @@
+#frozen_string_literal: true
+
+require 'ffi'
+require 'ffi/wiring_pi/gpio'
+
+module FFI
+  module WiringPi
+    extend FFI::Library
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+
+require 'ffi'
+include FFI

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ffi-wiring_pi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Huk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Ruby FFI bindings for the wiringPi library.
+email: mark.guk.e@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".gitignore"
+- ".rake_tasks~"
+- ".rspec"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ffi-wiring_pi.gemspec
+- gemspec.yml
+- lib/ffi/wiring_pi.rb
+- lib/ffi/wiring_pi/gpio.rb
+- lib/ffi/wiring_pi/wiring_pi.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vimutter/ffi-wiring_pi
+licenses:
+- MIT
+metadata: {}
+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:
+- wiringPi >= 2.46
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: FFI bindings for wiringPi
+test_files: []