switchy 0.2.2

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2009 David Brady github@shinybit.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/README.rdoc

@@ -0,0 +1,150 @@
+= Switchy
+
+Ruby Application to switch AC loads (e.g. turn a lamp on and off).
+
+Update 2009-09-26: This has actually become something of a
+unit-testing light dongle for me. The basic switching hardware was
+finished quite early, so the only thing left to do was to add a Killer
+Demo App(TM). The basic switching app is just called "switchy", and it
+controls individual pins 1 through 10 on the board.
+
+The Killer Demo, then, would be Sparky, Sparcumber, and Autospark.
+Each of these has a "christmas tree" LED arrangement: Five LEDs on
+each side of the device are wired for run, fail, warning, and pass.
+There are two green LEDs for pass on each side, so the pinouts are:
+
+Pins 1-5 (left side): blue, red, yellow, green, green
+Pins 10-6 (right side, note reverse order because pin numbering continues
+clockwise around the board): blue, red, yellow, green, green
+
+Sparky provides an RSpec progress formatter, so that it gets updated
+as each spec runs. While running it animates the LEDs to show the
+current overall progress. As each spec finishes an LED of the
+appropriate color lights up.
+
+Sparky also has a generic mode. If you run "sparky foo", sparky will
+turn on the running lights, then run the foo command. When foo
+finishes, its exit status will be used to turn on either the red or
+green lights.
+
+Sparcumber does for Cucumber what Sparky does for RSpec. Get Cucumber
+configured so you can type "cucumber" from the root of your project,
+then type "sparcumber" instead. Sparcumber will light up the board as
+Cucumber runs.
+
+Autospark is currently vaporware. All it should do is hook sparky into
+autospec. Patches are welcome. There is a spec.sparky.opts file in the
+res folder, however, that will achieve this for now, but it does cause
+your project to take a dependency on sparky, which in turn requires
+having the hardware dongle connected to run your specs, which is less
+than agile.
+
+
+= Example
+
+== Command-line Apps
+
+=== Switchy
+
+Switchy gives you control of each light individually.
+
+ $ switchy 1 1 2 0 10 1 8 1
+ # => Lights 1, 8, 10 turn on; light 2 turns off
+
+DANGER: This is wildly incompatible with the original design of
+switchy. The original design is intended to drive a single external
+device from a single pin through a relay.
+
+The prototype design, however, ended up getting optimizing for low
+part count, and in fact I just soldered LEDs directly to the logic
+board (and there ARE no other parts). This means that each LED is
+soldered across TWO pins.
+
+Turning on light 1, for instance, involves driving pin C4 high and
+driving pin C5 low.
+
+Remember that when discussing lights, we turn them on or off, but when
+discussing the logic pins we drive them high or low, because when you
+drive a pin low you are actually establishing a connection between
+that pin and ground, allowing current to "sink".
+
+=== Sparky
+
+A wrapper on top of switchy that gives you pass/pending/fail
+semantics.
+
+ $ sparky (run|pass|pending|fail)
+ # => turns on running|green|yellow|red lights
+
+ $ sparky <system command> [<command options>]
+
+ # => Turns on run lights and executise shell command. If the exit
+ #    code is 0, turns green. Any other exit code and it turns red.
+
+=== Sparcumber
+
+Sparcumber is a cucumber wrapper. It hooks into Cucumber's
+AST::Visitor class. Use it like you would use Cucumber:
+
+  $ sparcumber -r features features/
+
+One additional bit of cleverness: While running, each step that
+passes/pends/fails will turn on ONE light of the appropriate color. If
+another step exits in the same condition, that color light will
+advance (E.g. the currently lit green light will go out and the next
+one will turn on). This provides the visual effect of animating the
+feature output. Note that it is thus possible to 5 leds lit at once:
+the 2 running lights plus one each of red, yellow and green.
+
+== Ruby Library
+
+TODO: The ruby lib is pretty messed up. Here's what currently works:
+
+ s = Switchy.new
+ s.set_pin Switchy::PINS::D6, 0
+ # Drives pin D6 low (which turns on the on-board LED)
+ s.set_pin Switchy::PINS::B3, 1
+ # Drives pin B3 high
+
+= The Hardware
+
+...is currently very much in flux.
+
+TODO: Write me!
+
+= TODO
+
+- There's an enable line on the 74ls244 driver chip. Use it. Device
+  should boot disabled. Once everything's had a chance to settle
+  (10-100ms or so), enable the driver chip.
+
+- Add circuit schematics to the project.
+
+- [DONE] Fork the circuit, make a version with just a little LED light
+  bar and no 120VAC switching. (Trust me. The little LEDs are VERY
+  compelling!)
+
+- [ABANDONED] Add duty cycling/blinking to the board. (Tabled for now.
+  The USB serial port driver that comes with the Teensy board appears
+  to use blocking methods. The code libraries are poorly documented
+  and will require a significantly higher amount of expertise with AVR
+  programming than I currently have before I can port it to a
+  non-blocking form.)
+
+- Write a simulator for the 6.3E+06-1 people on the planet who do not
+  have the only existing prototype. I think a little MacRuby
+  Red/Green/Refactor applet would be spiffy all by itself--and would
+  make debugging/testing driver and linking apps much easier.
+
+- [DONE] 2009-04-20: Review previous TODOs in light of first finished
+  prototype.
+
+- [DONE] Change progress formatter lights, and light up only one
+  pass/fail/pending LED as specs run. As each example completes,
+  animate the display by moving the the one led to another spot. So if
+  all your specs are passing, you'll see the green light move 1 -> 2
+  -> 3 -> 4 -> 1 -> 2 etc. If you have any pending specs, they will
+  light up 1 -> 2 -> 1 -> 2 etc. When the test finishes, light up all
+  the status lights of the appropriate color.
+
+

data/bin/sparcumber

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+libdir = File.expand_path(File.join(File.dirname(Gem.bin_path("switchy", "switchy", ">=0")), "..", "lib"))
+cmd = "cucumber --require #{libdir}/sparky_cucumber.rb " + ARGV.map {|a| '"' + a.gsub(/"/, '\"') + '"' } * ' '
+system(cmd)
+

data/bin/sparky

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+class Sparky
+  def show_run
+    #  system "switchy 1 0 2 1 3 1 4 1"
+    system "switchy 1 1 2 0 3 0 4 0 5 0 6 0 7 0 8 0 9 0 10 1"
+  end
+
+  def show_fail
+    system "switchy 1 0 2 1 3 0 4 0 5 0 6 0 7 0 8 0 9 1 10 0"
+  end
+
+  def show_pending
+    system "switchy 1 0 2 0 3 1 4 0 5 0 6 0 7 0 8 1 9 0 10 0"
+  end
+
+  def show_pass
+    system "switchy 1 0 2 0 3 0 4 1 5 1 6 1 7 1 8 0 9 0 10 0"
+  end
+
+  def show_reset
+    system "switchy 1 0 2 0 3 0 4 0 5 0 6 0 7 0 8 0 9 0 10 0"
+  end
+
+  def show_all
+    system "switchy 1 1 2 1 3 1 4 1 5 1 6 1 7 1 8 1 9 1 10 1"
+  end
+  
+  def show_selftest
+    show_reset
+    
+    show_all
+    sleep 1.0
+    show_reset
+    
+    1.upto(10) do |i|
+      system "switchy #{i} 1"
+      system "switchy #{i} 0"
+    end
+    
+    %w(run fail pending pass).each do |msg|
+      send "show_#{msg}"
+      sleep 0.5
+    end
+    sleep 0.5
+    show_reset
+  end
+end
+
+if __FILE__==$0
+  s = Sparky.new
+  
+  case ARGV[0].downcase
+  when "reset" then s.show_reset
+  when "pending" then s.show_pending
+  when "fail" then s.show_fail
+  when "pass" then s.show_pass
+  when "run" then s.show_run
+  when "test" then s.show_test
+  when "selftest" then s.show_selftest
+  when "spec"
+    lib_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'sparky_progress_formatter.rb'))
+    args = ARGV[1..-1].dup.map {|a| '"' + a.gsub(/"/, '\"') + '"' } * ' '
+    cmd = "spec --require #{lib_path} --format Spec::Runner::Formatter::SparkyProgressFormatter #{args}"
+    system(cmd)
+  else
+    # TODO: If spec or rake spec:*, bind formatter
+    # TODO: If autospec, bind formatter
+    s.show_run
+
+    cmd = ARGV.map {|a| '"' + a.gsub(/"/, '\"') + '"' } * ' '
+
+    if system(cmd)
+      s.show_pass
+    else
+      s.show_fail
+    end
+  end
+end

data/bin/switchy

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+def usage
+  u = <<USAGE
+switchy - turn external lights on/off
+switchy <light> <0|1> [<light2> <0|1> [...]]
+
+light:
+  0 - Onboard LED (reversed: 0 = on, 1 = off)
+  1-4 External Switches (1 = on)
+
+example: Turn off onboard LED, turn on lights 2 and 4, turn off light 3, leave light 1 alone:
+switchy 0 1 2 1 4 1 3 0
+USAGE
+end
+
+require 'switchy'
+
+args = ARGV.dup
+
+s = Switchy.new
+# The serial port is a bit tetchy. Give it a few cycles to settle.
+sleep 0.05
+
+
+# lights by number => pair of pins, one to set high, the other low
+# TODO: change these into on/off arrays so we can set multiple lights with a single command
+# TODO: consider dropping this altogether and doing "switchy C4 1 C5 0" etc?
+lights = {
+  0 => [nil, Switchy::PINS::D6 ],
+  1 => [Switchy::PINS::C4, Switchy::PINS::C5 ],
+  2 => [Switchy::PINS::C6, Switchy::PINS::C7 ],
+  3 => [Switchy::PINS::B7, Switchy::PINS::B6 ],
+  4 => [Switchy::PINS::B5, Switchy::PINS::B4 ],
+  5 => [Switchy::PINS::B3, Switchy::PINS::B2 ],
+  6 => [Switchy::PINS::D7, Switchy::PINS::B0 ],
+  7 => [Switchy::PINS::D5, Switchy::PINS::D6 ],
+  8 => [Switchy::PINS::D3, Switchy::PINS::D4 ],
+  9 => [Switchy::PINS::D1, Switchy::PINS::D2 ],
+  10 => [Switchy::PINS::C2, Switchy::PINS::D0 ],
+}
+
+until args.empty?
+  light = args.shift.to_i
+  command = args.shift.to_i
+
+  unless light >= 0 && light <= 10
+    puts usage
+    raise "ERROR: ARGV[1] must be between 0 and 10"
+  end
+
+  unless command >= 0 && command <= 1
+    puts usage
+    raise "ERROR: ARGV[2] must be one of on/off/status"
+  end
+
+  raise "ERROR: status not yet implemented" if command == 'status'
+
+  s.set_pin(lights[light][0], command) if lights[light][0]
+  s.set_pin(lights[light][1], 1-command) if lights[light][1]
+end
+
+

data/lib/sparky.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+dir = File.expand_path(File.dirname(__FILE__))
+$: << dir unless $:.include?(dir)
+require 'switchy'
+
+class Sparky
+  attr_accessor :passed, :failed, :pending
+  
+  @@run_pins = [[Switchy::PINS::C4, Switchy::PINS::C2], [Switchy::PINS::C5, Switchy::PINS::D0 ]]
+  @@fail_pins = [[Switchy::PINS::C6, Switchy::PINS::D1], [Switchy::PINS::C7, Switchy::PINS::D2]]
+  @@pending_pins = [[Switchy::PINS::B7, Switchy::PINS::D3], [Switchy::PINS::B6, Switchy::PINS::D4]]
+  @@pass_pins = [[Switchy::PINS::B3, Switchy::PINS::D7, Switchy::PINS::B5, Switchy::PINS::D5],
+                 [Switchy::PINS::B2, Switchy::PINS::B0, Switchy::PINS::B4, Switchy::PINS::D6]]
+
+  @@reset_pins = [[Switchy::PINS::C4, Switchy::PINS::C2,
+                  Switchy::PINS::C6, Switchy::PINS::D1,
+                  Switchy::PINS::B7, Switchy::PINS::D3, 
+                  Switchy::PINS::B5, Switchy::PINS::B3, 
+                  Switchy::PINS::D7, Switchy::PINS::D5]]
+  def initialize
+    @passed, @failed, @pending = -1, -1, -1
+    @switchy = Switchy.new
+  end
+  
+  def set_pins(pins)
+    pins.first.each do |pin|
+      @switchy.set_pin pin, 1
+    end
+    pins.last.each do |pin|
+      @switchy.set_pin pin, 0
+    end
+  end
+  
+  def set_pin(pin)
+    @switchy.set_pin pin.first, 1
+    @switchy.set_pin pin.last, 0
+  end
+  
+  def clear_pin(pin)
+    @switchy.set_pin pin.first, 0
+  end
+  
+  def clear_pins(pins)
+    pins.first.each do |pin|
+      @switchy.set_pin pin, 0
+    end
+  end
+  
+  def pass
+    set_pins @@pass_pins
+  end
+  alias :passed :pass
+  
+  def clear_pass
+    clear_pins @@pass_pins
+  end
+  
+  def fail
+    set_pins @@fail_pins
+  end
+  alias :failed :fail
+  
+  def clear_failed
+    clear_pins @@fail_pins
+  end
+
+  def pending
+    set_pins @@pending_pins
+  end
+
+  def clear_pending
+    clear_pins @@pending_pins
+  end
+
+  def run
+    set_pins @@run_pins
+  end
+  
+  def clear_run
+    clear_pins @@run_pins
+  end
+  
+  def reset
+    clear_pins @@reset_pins
+  end
+  
+  def start_run
+    reset
+    run
+  end
+  
+  def finish_run
+    reset
+    if @failed > -1
+      failed
+    elsif @pending > -1
+      pending
+    else
+      pass
+    end
+  end
+  
+  def example_passed
+    clear_pin pin(:passed, @passed % 4) if @passed >= 0
+    @passed += 1
+    set_pin pin(:passed, @passed % 4)
+  end
+  
+  def example_failed
+    clear_pin pin(:failed, @failed % 2) if @failed >= 0
+    @failed += 1
+    set_pin pin(:failed, @failed % 2)
+  end
+  
+  def example_pending
+    clear_pin pin(:pending, @pending % 2) if @pending >= 0
+    @pending += 1
+    set_pin pin(:pending, @pending % 2)
+  end
+  
+  def pin(set, idx)
+    pins = case set
+           when :passed then @@pass_pins
+           when :failed then @@fail_pins
+           when :pending then @@pending_pins
+           end
+    [ pins.first[idx], pins.last[idx] ]
+  end
+end
+

data/lib/sparky_cucumber.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+gem 'cucumber', '>= 0.3.0'
+
+require 'sparky'
+
+module Cucumber
+  module Ast
+    class Visitor
+
+      alias :orig_visit_step_result :visit_step_result
+      alias :orig_visit_features :visit_features
+      
+      def visit_features(features)
+        begin
+          @sparky = Sparky.new
+          @sparky.start_run
+          orig_visit_features(features)
+        ensure
+          @sparky.finish_run
+        end
+      end
+
+      def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+        @sparky.send "example_#{status}" if [:passed, :failed, :pending].include?(status)
+        orig_visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+      end 
+    end 
+  end
+end

data/lib/sparky_progress_formatter.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'spec/runner/formatter/progress_bar_formatter'
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sparky'
+
+# TODO: rewire this to just patch the base class like I did in
+# sparky_cucumber.rb. May be problematic as the child classes here
+# ain't so good at calling super, so I may just need to patch the key
+# formatters I normally use like ProgressBar and Html.
+
+module Spec
+  module Runner
+    module Formatter
+      class SparkyProgressFormatter < ProgressBarFormatter
+        @@anything_failed_ever = false
+        @@anything_pended_ever = false
+        
+        def initialize(a,b)
+          super
+          @sparky = Sparky.new
+          @sparky.start_run
+        end
+
+        def start_dump
+          @sparky.finish_run
+          super
+        end
+        
+        def example_passed(example)
+          @sparky.example_passed
+          super
+        end
+        
+        def example_failed(example, counter, failure)
+          @@anything_failed_ever = true
+          @sparky.example_failed
+          super
+        end
+        
+        def example_pending(example, message)
+          @@anything_pended_ever = true
+          @sparky.example_pending
+          super
+        end
+      end
+    end
+  end
+end

data/lib/switchy.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+require "serialport"
+
+class Switchy
+  module PINS
+    B0 = "B0"
+    B1 = "B1"
+    B2 = "B2"
+    B3 = "B3"
+    B4 = "B4"
+    B5 = "B5"
+    B6 = "B6"
+    B7 = "B7"
+
+    C2 = "C2"
+    C4 = "C4"
+    C5 = "C5"
+    C6 = "C6"
+    C7 = "C7"
+    
+    D0 = "D0"
+    D1 = "D1"
+    D2 = "D2"
+    D3 = "D3"
+    D4 = "D4"
+    D5 = "D5"
+    D6 = "D6"
+    D7 = "D7"
+    
+    OC1B = "C5"
+
+    OC1A = "C6"
+    
+    ICP1 = "C7"
+    INT4 = "C7"
+    
+    OC1C = "B7"
+
+    T1 = "B4"
+
+    M1S0 = "B3"
+
+    M0S1 = "B2"
+
+    SCLK = "B1"
+    
+    SS = "B0"
+    
+    INT7 = "D7"
+    HWB = "D7"
+    CTS = "D7"
+    T0 = "D7"
+    
+    INT6 = "D6"
+    RTS = "D6"
+    LED = "D6"
+    
+    XCK = "D5"
+    
+    INT5 = "D4"
+    
+    INT3 = "D3"
+    TXD1 = "D3"
+    TXD = "D3"
+    
+    INT2 = "D2"
+    AIN1 = "D2"
+    RXD1 = "D2"
+    RXD = "D2"
+    
+    INT1 = "D1"
+    AIN0 = "D1"
+    
+    INT0 = "D0"
+    OC0B = "D0"
+
+    PD0 = "D0"
+    PD1 = "D1"
+    PD2 = "D2"
+    PD3 = "D3"
+    PD4 = "D4"
+    PD5 = "D5"
+    PD6 = "D6"
+    PD7 = "D7"
+  end
+
+  attr_accessor :modem, :baud
+  attr_accessor :borked # true when the device was not found at startup. Makes switchy-inclusive apps noncrashy when they find themselves unexpectedly switchy-excluded
+  def borked?; @borked; end
+  
+  def initialize(modem = '/dev/tty.usbmodem12341', baud=38400)
+    @borked = !File.exists?(modem)
+    puts "**** Could not find Switchy device on #{modem}" if borked?
+    @modem, @baud = modem, baud
+    connect
+  end
+  
+  def connect
+    return if borked?
+    @sp = SerialPort.new @modem, @baud
+  end
+  
+  def disconnect
+    return if borked?
+    # ???
+  end
+  
+  # Set pin "b4", 1 # turn on pin b4
+  def set_pin(p, v)
+    return if borked?
+    cmd = "#{p.upcase}=#{v}\r\n"
+    @sp.write cmd
+  end
+    
+  def set_light(l, v)
+    return if borked?
+    cmd = "C#{l+3}=#{v}\r\n"
+    @sp.write cmd
+  end
+  
+  def light1=(v)
+    return if borked?
+    set_light 1, v
+  end
+  
+  def light2=(v)
+    return if borked?
+    set_light 2, v
+  end
+  
+  def light3=(v)
+    return if borked?
+    set_light 3, v
+  end
+  
+  def light4=(v)
+    return if borked?
+    set_light 4, v
+  end
+  
+end
+

data/res/spec.sparky.opts

@@ -0,0 +1,6 @@
+--colour
+--require /Library/Ruby/Gems/1.8/gems/dbrady-switchy-0.2.2/lib/sparky_progress_formatter.rb
+--format Spec::Runner::Formatter::SparkyProgressFormatter
+--loadby mtime
+--reverse
+--backtrace

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: switchy
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- David Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-09 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-serialport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Switchy USB serial load switcher
+email: github@shinybit.com
+executables: 
+- switchy
+- sparky
+- sparcumber
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- bin/sparky
+- bin/switchy
+- bin/sparcumber
+- lib/sparky.rb
+- lib/sparky_cucumber.rb
+- lib/sparky_progress_formatter.rb
+- res/spec.sparky.opts
+- lib/switchy.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/dbrady/switchy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+- --title
+- Switchy -  USB serial load switcher
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Switchy USB serial load switcher
+test_files: []
+