omega2_gpio 0.1.05

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecba9beae161bb3fdb27be8113b2274995d2ee13e3c12c3aed228e6b832f416a
+  data.tar.gz: 4f4ef467a1729b7f0c40be973be147cc4d4d379553d2943b7f4d9512fbde70c0
+SHA512:
+  metadata.gz: f31e693e896c1169ebb5bf384a79477a0054f3e15d0467328d6e1622f3ea8a77bf55c16337b5590bf4d2da137d6f89aa97421eb2a1739db4d7f60f07df936c6c
+  data.tar.gz: 92397fdba753f798fc36c77023193dc56844e052972f69c9d867cb95f3ab7815356d991c7e3671197773f3b5a6c8727cbb06c1af9c9176dc3df8c92488cf8a01

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+.idea

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+before_install: gem install bundler -v 1.11.2
+
+rvm:
+  - 1.9
+  - 2.2.4
+  - 2.3
+  - 2.4
+
+script: echo "Running tests against $(ruby -v) ..."
+
+jobs:
+  include:
+    - stage: gem build
+      rvm: 2.2
+      script: echo "Deploying to rubygems.org ..."
+      deploy:
+        provider: rubygems
+        #gem: omega2_gpio
+        api_key: $RUBYGEMS_API_KEY
+        on:
+          branch: master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at freizeitnerd@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 freizeitnerd
+
+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,58 @@
+# Ruby Gem to control Omega2 GPIO
+
+Control [Onion Omega2](https://onion.io/omega2/) GPIOs in ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omega2_gpio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omega2_gpio
+
+
+## Get Started
+An Omega2 GPIO can be 
+  - an Input, 
+  - an Output or
+  - a PWM Output.
+### Input GPIO
+To use GPIO1 as an input, just instantiate an Omega2GPIO::Input using the `new`methode and pass in the number of the GPIO to use. (In this case 1 for GPIO1)
+This will set the GPIO orientation to 'output'.
+```ruby
+gpio_number = 1
+my_input_gpio = Omega2Gpio::Output.new(gpio_number)
+```
+Read the value of this GPIO as follows
+```ruby
+my_input_gpio_value = my_input_gpio.read
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Contributing
+
+Bug reports and pull requests are welcome! This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Similar Gems
+[@stevenocchipinti's onion_omega](https://github.com/stevenocchipinti/onion_omega) uses a slightly different approach to include GPIO control. It even supports stepper motors.
+https://github.com/stevenocchipinti/onion_omega
+
+[@glurp's ruby-onion-omega2](https://github.com/glurp/ruby-onion-omega2)
+https://github.com/glurp/ruby-onion-omega2 uses Omega2 file system instead of fast-gpio to control GPIO's. It even allows PWM  and OLED access.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omega2_gpio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omega2_gpio/configuration.rb

@@ -0,0 +1,56 @@
+# coding: utf-8
+module Omega2Gpio
+  class Configuration
+
+    # Controls whether the GPIO shall be controlled on Onion Omegas file system
+    # or just mocked/faked as valid to allow development on systems that
+    # do not support Omega's GPIO control and would raise errors constantly
+    # Defaults to `false`. Set to `true` to mock Onion Omega GPIO
+    attr_accessor :mock
+
+    # Controls whether the Gem shall write debug messages
+    # to standard out.
+    # This can be helpful messages like file system commands that are mocked
+    # Defaults to :debug.
+    # Defined are
+    #   2  ==> puts all messages
+    #   1  ==> puts warnings
+    #   0  ==> no messages at all
+    attr_accessor :messaging_level
+
+    # depends on Onion Omega2 hardware,
+    # needed to raise error in mock-mode
+    attr_accessor :highest_gpio_number
+
+    def initialize
+      @mock = false
+      @messaging_level = 2
+      @highest_gpio_number = 46
+    end
+  end
+
+  # @return [Omega2Gpio::Configuration] Omega2Gpio's current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  ## Set Omega2Gpio's configuration
+  ## @param config [Omega2Gpio::Configuration]
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  # Modify Omega2Gpio's current configuration
+  # @yieldparam [Omega2Gpio::Configuration] config current Omega2Gpio config
+  # ```
+  # Omega2Gpio.configure do |config|
+  #   config.routes = false
+  # end
+  # ```
+  def self.configure
+    yield configuration
+  end
+end
+
+# Configuration pattern stolen from Thoughtbot's Clearance
+# https://github.com/thoughtbot/clearance/blob/master/lib/clearance/configuration.rb

data/lib/omega2_gpio/fast_gpio_error.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+module Omega2Gpio
+  class FastGpioError < StandardError
+  end
+
+  def raise_error(error)
+    raise(FastGpioError, error.message)
+  end
+end

data/lib/omega2_gpio/gpio.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+module Omega2Gpio
+  class Gpio
+    attr_reader :gpio_number
+    attr_reader :value
+
+    def initialize(gpio_number)
+      @gpio_number = gpio_number
+      @value = 0
+
+      if Omega2Gpio.configuration.mock and gpio_number.between?(0, Omega2Gpio.configuration.highest_gpio_number)
+        Omega2Gpio.messenger.debug "Init Fake-GPIO#{@gpio_number} and mock all interactions as valid"
+      else
+        set_direction('output')
+      end
+
+      self
+    end
+
+    def self.is_mock?
+      Omega2Gpio.configuration.mock
+    end
+
+    def set_direction(direction)
+      execute_fast_gpio_command "fast-gpio set-#{direction} #{self.gpio_number}"
+    end
+
+    def read
+      if Omega2Gpio.configuration.mock
+        Omega2Gpio.messenger.debug "Mocked GPIO#{self.gpio_number} value is '#{@value}'"
+      else
+        stdin, stdout, stderr = Open3.popen3("fast-gpio read #{@gpio_number}")
+        if stderr.gets
+          raise_error(stderr.gets)
+        else
+          @value = stdout.gets.to_s.split.last.to_i
+        end
+      end
+
+      @value
+    end
+
+    def get
+      read
+    end
+
+    def is_high?
+      self.read == 1
+    end
+
+    def is_low?
+      self.read == 0
+    end
+
+    private
+
+    def execute_fast_gpio_command(command)
+      stdin, stdout, stderr = Open3.popen3(command)
+      if stderr.gets
+        Omega2Gpio.raise_error(stderr.gets)
+      end
+    end
+  end
+end

data/lib/omega2_gpio/input.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+module Omega2Gpio
+  class Input < Gpio
+  end
+end

data/lib/omega2_gpio/messaging.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+module Omega2Gpio
+  class Messaging
+    def debug(message)
+      puts message if Omega2Gpio.configuration.messaging_level >= 2
+    end
+
+    def warn(message)
+      puts message if Omega2Gpio.configuration.messaging_level >= 1
+    end
+  end
+
+  def self.messenger
+    @messenger ||= Messaging.new
+  end
+end

data/lib/omega2_gpio/output.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+module Omega2Gpio
+  class Output < Gpio
+
+    def set(value)
+      if Omega2Gpio.configuration.mock
+        Omega2Gpio.messenger.debug "Mocked GPIO#{self.gpio_number} is set to '#{value}'"
+      else
+        execute_fast_gpio_command "fast-gpio set #{self.gpio_number} #{value}"
+      end
+      @value = value
+
+      self
+    end
+
+  end
+end

data/lib/omega2_gpio/version.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+module Omega2Gpio
+  VERSION = "0.1.05".freeze
+end

data/lib/omega2_gpio.rb

@@ -0,0 +1,11 @@
+require "open3"
+require_relative "omega2_gpio/fast_gpio_error"
+require_relative "omega2_gpio/version"
+require_relative "omega2_gpio/configuration"
+require_relative "omega2_gpio/messaging"
+require_relative "omega2_gpio/gpio"
+require_relative "omega2_gpio/input"
+require_relative "omega2_gpio/output"
+
+module Omega2Gpio
+end

data/omega2_gpio.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omega2_gpio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omega2_gpio"
+  spec.version       = Omega2Gpio::VERSION
+  spec.authors       = ["Sönke Ohls"]
+  spec.email         = ["s@ohls.eu"]
+
+  spec.summary       = "Ruby wrapper to control Onion Omega2 GPIOs"
+  spec.description   = "Ruby wrapper to control Onion Omega2 GPIOs"
+  spec.homepage      = "https://github.com/freizeitnerd/omega2_gpio"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-hooks", "~> 1.4"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: omega2_gpio
+version: !ruby/object:Gem::Version
+  version: 0.1.05
+platform: ruby
+authors:
+- Sönke Ohls
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Ruby wrapper to control Onion Omega2 GPIOs
+email:
+- s@ohls.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omega2_gpio.rb
+- lib/omega2_gpio/configuration.rb
+- lib/omega2_gpio/fast_gpio_error.rb
+- lib/omega2_gpio/gpio.rb
+- lib/omega2_gpio/input.rb
+- lib/omega2_gpio/messaging.rb
+- lib/omega2_gpio/output.rb
+- lib/omega2_gpio/version.rb
+- omega2_gpio.gemspec
+homepage: https://github.com/freizeitnerd/omega2_gpio
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper to control Onion Omega2 GPIOs
+test_files: []