rgb_led 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25b6c19e58af5b0db2a1058b5d674ffecfbb3e6f
+  data.tar.gz: a2268a464b44d42882c915e442d8bf9fa83304a4
+SHA512:
+  metadata.gz: 75318c782f56471409ffe5f97a36b07e244a46531e75052097e891160c343ba9d05c8ab72b8d9327d837f81ede2c198f8d3c03705a756955d352c9425cc49aa8
+  data.tar.gz: df86999720e815813c5d2310f06fafcc452255a49057b48d7b00076242a75520fd7fe1e8c82396e1eee2e65f5107d9ef4742fc602f3a7f0cc3c22cdb3bb63575

data/.gitignore

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

data/Gemfile

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

data/License.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright © 2016 Ryan Scott Lewis <ryanscottlewis@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,64 @@
+# RGB LED
+
+An RGB LED controller for AT microcontrollers with bonus RSpec formatter.
+
+## Install
+
+### Bundler: `gem 'rgb_led'`
+
+### RubyGems: `gem install rgb_led`
+
+## Usage
+
+```rb
+require 'rgb_led'
+
+RGBLED::Controller.open('/dev/usbdevicepath') do |controller|
+  controller.red
+  sleep 1
+  controller.green
+  sleep 1
+  controller.blue
+  sleep 1
+  controller.update(1, 0.1, 0) # Yellow. Really depends on how bright each diode is within the LED
+  sleep 1
+  controller.off
+end
+```
+
+## Without Block
+
+```rb
+require 'rgb_led'
+
+controller = RGBLED::Controller.open('/dev/usbdevicepath')
+# ...
+controller.close
+```
+
+## RSpec Formatter
+
+> Note: You can use multiple formatters with RSpec by passing multiple `--format` options.
+
+**spec_helper.rb**
+
+```rb
+RSpec.configure do |config|
+  # ...
+  config.rgb_led_path = '/dev/usbdevicepath'
+  # ...
+end
+```
+
+**.rspec**
+
+```
+--format RGBLED::RSpecFormatter
+```
+
+## Copyright
+
+Copyright © 2016 Ryan Scott Lewis <ryanscottlewis@gmail.com>.
+
+The MIT License (MIT) - See License.md for further details.
+

data/Todo.md

@@ -0,0 +1,10 @@
+# TODO
+
+* Sane defaults. Maybe a RGBLED.scan to find correct USB device? Or some kind of device reporter?
+* i2c support
+* ATTiny support? Much cheaper than ATMega. Must have 3 digital outputs with PWM support
+* Custom colors for each state for RSpec formatter
+* Other test suite formatters
+* Use GPL? Look into other licenses
+* Tests! Oh the irony..
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rgb_led"
+
+# 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/exe/rgb_led

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pry'
+require 'rgb_led'
+
+Pry.config.prompt = proc { "RGB LED > " }
+
+# TODO: ARGV[0] below for path
+RGBLED::Controller.open('/dev/cu.usbmodem1431') do |controller|
+  controller.pry
+end
+

data/lib/rgb_led.rb

@@ -0,0 +1,3 @@
+require "rgb_led/version"
+require "rgb_led/controller"
+

data/lib/rgb_led/controller.rb

@@ -0,0 +1,91 @@
+module RGBLED
+  class Controller
+    # Open the USB device for the RGB controller
+    #
+    # @param [String] path The path to the USB device
+    def self.open(path, &block)
+      new.open(path, &block)
+    end
+
+    # Open the USB device for the RGB controller
+    #
+    # @param [String] path The path to the USB device
+    def open(path, &block)
+      @io = File.open(path, 'r+') # TODO: r+ will create the file if it doesn't exist =(
+
+      @io.readbyte # Sync
+
+      if block_given?
+        yield(self)
+
+        close
+      end
+
+      self
+    end
+
+    # Close the device
+    def close
+      return if @io.nil?
+
+      @io.close
+    end
+
+    # Update the RGB LED color using floats between 0.0...1.0
+    #
+    # @param [#to_f] red
+    # @param [#to_f] green
+    # @param [#to_f] blue
+    def update(red, green, blue)
+      return false if @io.nil?
+
+      red   = convert_float_to_byte(red)
+      green = convert_float_to_byte(green)
+      blue  = convert_float_to_byte(blue)
+
+      @io.write(red)
+      @io.write(green)
+      @io.write(blue)
+
+      return true
+    end
+
+    # Turn off the LED entirely
+    def off
+      update(0, 0, 0)
+    end
+
+    # Set the RGB LED to the color red
+    #
+    # @param [#to_f] brightness
+    def red(brightness=1.0)
+      update(brightness, 0, 0)
+    end
+
+    # Set the RGB LED to the color green
+    #
+    # @param [#to_f] brightness
+    def green(brightness=1.0)
+      update(0, brightness, 0)
+    end
+
+    # Set the RGB LED to the color blue
+    #
+    # @param [#to_f] brightness
+    def blue(brightness=1.0)
+      update(0, 0, brightness)
+    end
+
+    protected
+
+    def convert_float_to_byte(value)
+      value = value.to_f
+      value = 0.0 if value < 0
+      value = 1.0 if value > 1
+      value = value * 255
+
+      value.to_i.chr
+    end
+  end
+end
+

data/lib/rgb_led/rspec_formatter.rb

@@ -0,0 +1,54 @@
+require 'stringio'
+require 'rgb_led/controller'
+
+RSpec.configuration.add_setting(:rgb_led_path, default: '/dev/cu.usbmodem1431')
+
+module RGBLED
+  class RSpecFormatter
+    class << self
+      attr_reader :path
+
+      def path=(value)
+        value = value.to_s.strip
+
+        return nil if value.empty?
+        return nil unless File.exist?(value)
+
+        @path = value
+      end
+    end
+
+    def initialize(output)
+      @output = output || StringIO.new
+      @state  = :green
+    end
+
+    def start(notification)
+      path        = RSpec.configuration.rgb_led_path
+      @controller = RGBLED::Controller.open(path) unless path.nil?
+
+      @controller.off
+    end
+
+    def example_pending(notification)
+      @state = :yellow if @state == :green
+    end
+
+    def example_failed(notification)
+      @state = :red
+    end
+
+    def close(notification)
+      return if @controller.nil?
+
+      case @state
+      when :green  then @controller.green
+      when :yellow then @controller.update(1, 0.1, 0)
+      when :red    then @controller.red
+      end
+    end
+
+    RSpec::Core::Formatters.register(self, :start, :example_pending, :example_failed, :close)
+  end
+end
+

data/lib/rgb_led/version.rb

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

data/rgb_led.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rgb_led/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rgb_led"
+  spec.version       = RGBLED::VERSION
+  spec.authors       = ["Ryan Scott Lewis"]
+  spec.email         = ["ryanscottlewis@gmail.com"]
+
+  spec.summary       = "REG LED controller"
+  spec.description   = "A controller for RGB LED using Arduino"
+  spec.homepage      = "https://github.com/RyanScottLewis/rgb_led"
+  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_dependency "pry", "0.10.4"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/src/rgb_led.ino

@@ -0,0 +1,30 @@
+const int pinR = 3;
+const int pinG = 5;
+const int pinB = 6;
+
+char inData[3];
+int brightnessR = 0;
+int brightnessG = 0;
+int brightnessB = 0;
+
+void setup() {
+  Serial.begin(9600);
+  Serial.flush();
+  while(!Serial);
+  Serial.print(0);
+}
+
+void loop() {
+  if (Serial.available() > 0) {
+    Serial.readBytes(inData, 3);
+
+    brightnessR = inData[0];
+    brightnessG = inData[1];
+    brightnessB = inData[2];
+  }
+
+  analogWrite(pinR, brightnessR);
+  analogWrite(pinG, brightnessG);
+  analogWrite(pinB, brightnessB);
+}
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rgb_led
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A controller for RGB LED using Arduino
+email:
+- ryanscottlewis@gmail.com
+executables:
+- rgb_led
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- License.md
+- Rakefile
+- Readme.md
+- Todo.md
+- bin/console
+- bin/setup
+- exe/rgb_led
+- lib/rgb_led.rb
+- lib/rgb_led/controller.rb
+- lib/rgb_led/rspec_formatter.rb
+- lib/rgb_led/version.rb
+- rgb_led.gemspec
+- src/rgb_led.ino
+homepage: https://github.com/RyanScottLewis/rgb_led
+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.5.1
+signing_key: 
+specification_version: 4
+summary: REG LED controller
+test_files: []