onion_omega 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9d2c0b9d8143d9dc99dd4a636a01d4a4261188e
+  data.tar.gz: d741dac4ef006fe7fa760054d914e0ccec5ab699
+SHA512:
+  metadata.gz: e432c87f1e438d6074daa08cc4ef4bedbe2332f8fc7e0f4de79ab2870c356ed5fe7e7501c45592f329b5974e83f158e402f696c79552e338eb71fbfc0f661fc5
+  data.tar.gz: c73a9eff3adad498516ee21fa1f452b481da5e184daf0181abc0cfc012c548722fb17bf9b3b471eaac3fa6c23c50abf51c0a60f6e6168a3c9b8fadd89d9925dd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Steve Occhipinti
+
+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,87 @@
+OnionOmega
+==========
+
+A Ruby wrapper for the `fast-gpio` command line tool found on the Onion Omega
+base operating system.
+
+This gem provides a basic `GPIO` class and a `Stepper` class that uses the GPIO
+pins to drive a stepper motor.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'onion_omega'
+```
+
+And then execute `bundle`
+
+
+Usage
+-----
+
+The `GPIO` class simply wraps the `fast-gpio` command line tool and has a
+similar interface:
+
+```ruby
+gpio = OnionOmega::GPIO.new(dry_mode: false)  # dry_mode defaults to false
+gpio.set_output 0                             # Sets pin 0 to be an output pin
+gpio.set 0, 1                                 # Sets pin 0 to HIGH (on with 3v)
+```
+
+The `Stepper` class uses the GPIO class above to perform sequence of operations
+to drive a stepper motor:
+
+```ruby
+stepper = OnionOmega::Stepper.new(
+  range: 1000,                # Required. Used to calculate steps for percentage
+  pins: [0, 1, 2, 3],         # Defaults. Which pins used to drive stepper motor
+  half_stepping: false,       # Defaults. Whether to use full or half stepping
+  persist_to_file: nil,       # Defaults. Persist position to file at every step
+  gpio: GPIO.new              # Defaults. Allow GPIO object to be overridden
+)
+
+stepper.forward 1             # Defaults. Move forward 1 step
+stepper.backward 1            # Defaults. Move backward 1 step
+stepper.set_percentage 0.1    # Required. Move to percentage based on range
+stepper.reset                 # Move to 0% based on current position and range
+```
+
+While `range` is a required parameter, it is only used for
+`Stepper#set_percentage` and `Stepper#reset`.
+
+The option to override the `GPIO` object is useful for testing to allow a `GPIO`
+object that has `dry_mode` enabled to passed in which will only result in STDOUT
+messages instead of actual commands being executed.
+
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/stevenocchipinti/onion_omega.
+
+
+License
+-------
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

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,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "onion_omega"
+
+# 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

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/onion_omega.rb

@@ -0,0 +1,7 @@
+require_relative "onion_omega/version"
+require_relative "onion_omega/gpio"
+require_relative "onion_omega/stepper"
+require_relative "onion_omega/stepper_sequencer"
+
+module OnionOmega
+end

data/lib/onion_omega/gpio.rb

@@ -0,0 +1,21 @@
+class OnionOmega::GPIO
+  attr_accessor :dry_mode
+
+  def initialize(dry_mode: false)
+    @dry_mode = dry_mode
+  end
+
+  def set(pin, value)
+    execute "fast-gpio set #{pin} #{value}"
+  end
+
+  def set_output(pin)
+    execute "fast-gpio set-output #{pin}"
+  end
+
+  private
+
+  def execute(command)
+    @dry_mode ? puts(command) : system(command)
+  end
+end

data/lib/onion_omega/stepper.rb

@@ -0,0 +1,67 @@
+require_relative "./gpio"
+require_relative "./stepper_sequencer"
+
+module OnionOmega
+  class Stepper
+    def initialize(
+      range:,
+      pins: [0, 1, 2, 3],
+      half_stepping: false,
+      persist_to_file: nil,
+      gpio: GPIO.new
+    )
+      @range = range
+      @pins = pins
+      @sequencer = StepperSequencer.new(
+        number_of_pins: @pins.count,
+        half_stepping:  half_stepping
+      )
+      @file = persist_to_file
+      @current_step = (@file && File.exists?(@file)) ? File.read(@file).to_i : 0
+      @gpio = gpio
+      initialise_gpio
+    end
+
+    def forward(steps=1)
+      steps.times { step(1) }
+    end
+
+    def backward(steps=1)
+      steps.times { step(-1) }
+    end
+
+    def set_percentage(percentage)
+      desired_step = (percentage * @range).round
+      steps = desired_step - @current_step
+      if steps > 0
+        steps.times { forward }
+      elsif steps < 0
+        steps.abs.times { backward }
+      end
+    end
+
+    def reset
+      set_percentage 0
+    end
+
+    private
+
+    def initialise_gpio
+      @pins.each do |pin|
+        @gpio.set_output pin
+      end
+    end
+
+    def step(increment = 1)
+      @current_step += increment
+      set_pins @sequencer.pins_for_step(@current_step)
+      File.write @file, @current_step if @file
+    end
+
+    def set_pins(pins)
+      pins.each_with_index do |value, index|
+        @gpio.set @pins[index], value
+      end
+    end
+  end
+end

data/lib/onion_omega/stepper_sequencer.rb

@@ -0,0 +1,35 @@
+module OnionOmega
+  class StepperSequencer
+    attr_accessor :number_of_pins, :half_stepping
+
+    def initialize(number_of_pins: 4, half_stepping: false)
+      @number_of_pins = number_of_pins
+      @half_stepping = half_stepping
+    end
+
+    def pins_for_step(step)
+      @half_stepping ? pins_for_half_step(step) : pins_for_full_step(step)
+    end
+
+    private
+
+    def pins_for_full_step(step)
+      @number_of_pins.times.map do |index|
+        phase = step % @number_of_pins
+        index == phase ? 1 : 0
+      end
+    end
+
+    def pins_for_half_step(step)
+      phase = step % (@number_of_pins * 2)
+      @number_of_pins.times.map do |index|
+        case index * 2
+        when phase, phase - 1, (phase + 1) % (@number_of_pins * 2)
+          1
+        else
+          0
+        end
+      end
+    end
+  end
+end

data/lib/onion_omega/version.rb

@@ -0,0 +1,3 @@
+module OnionOmega
+  VERSION = "0.1.0"
+end

data/onion_omega.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onion_omega/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onion_omega"
+  spec.version       = OnionOmega::VERSION
+  spec.authors       = ["Steve Occhipinti"]
+  spec.email         = ["dev@stevenocchipinti.com"]
+
+  spec.summary       = %q{Control the Onion Omega GPIO pins with Ruby}
+  spec.homepage      = "https://github.com/stevenocchipinti/onion-omega"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: onion_omega
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Occhipinti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dev@stevenocchipinti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/onion_omega.rb
+- lib/onion_omega/gpio.rb
+- lib/onion_omega/stepper.rb
+- lib/onion_omega/stepper_sequencer.rb
+- lib/onion_omega/version.rb
+- onion_omega.gemspec
+homepage: https://github.com/stevenocchipinti/onion-omega
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Control the Onion Omega GPIO pins with Ruby
+test_files: []