multi_movingsign 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+/temp.rb
+/testrc.yml
+/rspec.log
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3-p194  # Ruby version on Ubuntu
+  - 1.9.3-p484  # Latest in 1.9.3 series
+  - 2.0.0-p353  # Latest in 2.0.0 series
+  - 2.1.1       # Latest
+before_script:
+  - gem install bundler --version "~> 1.3"
+  - bundle install
+script: bundle exec rspec -fd

data/.yardopts

@@ -0,0 +1 @@
+- README.md CHANGELOG.md PAGE_DEFINITION.md

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## Version 0.0.1 (March 3, 2014)
+
+#### Added
+
+* Initial working version
+* `multi_movingsign` CLI tool
+  * setup
+  * `show-identity`
+  * `show-page`
+* Server mode
+  * start/stop server
+  * add/update page
+  * delete page
+  * display alert
+  * stop server

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Webb
+
+MIT License
+
+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/PAGE_DEFINITION.md

@@ -0,0 +1,115 @@
+# Page Definition Specification
+
+A "page definition" is a term used internally to represent a page of information you'd like displayed on multiple LED signs.  This page of information likely is both wider and longer than the number of signs you have can accomodate.
+
+For example:
+
+``` Text
+RACE RESULTS
+1. Eric 10 seconds
+2. Mike 11 seconds
+3. Justin 15 seconds
+4. Dan 20 seconds
+```
+
+If you have 4 LED signs arranged vertically:
+
+``` text
+[                ]
+[                ]
+[                ]
+[                ]
+```
+
+The 5 lines on the page above won't fit at one time.  So, we need to break things up into lines and screens...which can be rendered into something displayable on the screens.
+
+So, for the page above, it might get rendered as follows:
+
+``` text
+# First
+[RACE RESULTS    ]
+[1. Eric 10 seconds]
+[2. Mike 11 seconds]
+[3. Justin 15 seconds]
+
+# Second
+[4. Dan 20 seconds]
+[                ]
+[                ]
+[                ]
+```
+
+Notice, we broke up the 5 lines into 2 four line screenfulls (with 3 blank lines on the second screenful).
+
+To specify this as a page definition YAML, we'd write the following:
+
+``` YAML
+---
+title: RACE RESULTS
+lines:
+- prefix: '1. '
+  content:
+  - Eric
+  - 10 seconds
+- prefix: '2. '
+  content:
+  - Mike
+  - 11 seconds
+- prefix: '3. '
+  content:
+  - Justin
+  - 15 seconds
+- prefix: '4. '
+  content:
+  - Dan
+  - 20 seconds
+```
+
+A page definition consists of the following:
+
+* `title`
+  * Title to be displayed when showing this page of the information (it will stick to the stop LED sign)
+* `lines`
+  * An array of line definitions
+  * `prefix`
+      * If the content of one line is too long for a single screen, each screen of information will be prefixed with this text
+  * `content`
+      * An array of screen fulls of information.  Each element of the array will be displayed in it's own screen.
+
+Given the page definition above, the page would render as follows:
+
+``` text
+# First
+
+[RACE RESULTS    ]
+[1. Eric         ]
+[2. Mike         ]
+[3. Justin       ]
+
+# Second
+
+[RACE RESULTS    ]
+[1. 10 seconds   ]
+[2. 11 seconds   ]
+[3. 15 seconds   ]
+
+# Third
+
+[RACE RESULTS    ]
+[4. Dan          ]
+[                ]
+[                ]
+[                ]
+
+# Fourth
+
+[RACE RESULTS    ]
+[1. 20 seconds   ]
+[                ]
+[                ]
+[                ]
+```
+
+Play around with it and see how things render!  The "truth" is in [MultiMovingsign::PageRender page_renderer.rb](lib/multi_movingsign/page_renderer.rb) and in the related [test cases](lib/multi_movingsign/page_renderer.rb).
+
+Pull requests and fixes welcome.

data/README.md

@@ -0,0 +1,133 @@
+# MultiMovingsign
+
+Command line tool to drive multiple [`movingsign_api`](https://github.com/webmonarch/movingsign_api) compatible [LED signs](http://www.signsdirect.com/Home/LED-Signs-Programmable/7x80-LED-Indoor-Brightness-Sign-Red.html) in unison.
+
+For example: (below) `multi_movingsign` being used to display [Kegbot ](https://kegbot.org) top drinker stats.
+
+![Example](example.jpg)
+
+
+# Why?
+
+It's a fun, low-fi way to display various things.  Some examples:
+
+* Business Stats
+  * Sales
+  * Revenue
+  * Users
+* Social
+  * Tweets
+  * Facebook Wall
+* [Kegbot!](https://kegbot.org)
+  * Keg Status
+  * Drinker Stats
+* Pretty much anything!
+
+
+# Components
+
+This gem comprises of the following main features:
+
+* A command line tool `multi_movingsign` (see `multi_movingsign help` or [cli.rb](lib/multi_movingsign/cli.rb))
+* CLI for individual operations
+  * setup + configuration
+  * displaying a page of information on screen
+* A server mode to continuously alternate between pages of information (see `multi_movingsign server help` or [server.rb](lib/multi_movingsign/server.rb))
+  * `server start`
+  * `server add-page`
+      * adds/updates a page on display rotation
+  * `server alert`
+      * send a page to be display immediately (on demand) and not put into rotation
+  * `server stop`
+
+To get help on the CLI tools, run help:
+
+``` bash
+$ multi_movingsign help
+  Commands:
+    multi_movingsign help [COMMAND]             # Describe available commands or one specific command
+    multi_movingsign server SUBCOMMAND ...ARGS  # Run or manipuate the MultiMovingsign server
+    multi_movingsign settings                   # Prints settings to terminal
+    multi_movingsign setup                      # Setup available Movingsign LED signs and preferences
+    multi_movingsign show-identity              # Show sign identifying information on all signs
+    multi_movingsign show-page --page=PAGE      # Renders the specified page to the configured signs
+
+  Options:
+    [--rc=RC]  # Path the persistent settings file. Defaults to: ~/.multi_movingsign.yml
+```
+
+# Getting Started
+
+## Requirements
+
+To use the `multi_movingsign` gem,  you need:
+
+* 2 - 4 `movingsign_api` LED signs
+  * More signs possible...just not tested
+* Ruby >= 2.0.0 Recommended
+  * Ruby 1.9.3 is also tested
+* UNIX-y OS (Linux, Mac)
+  * Windows *may* work, but not tested
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multi_movingsign'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_movingsign
+
+## Usage
+
+The workflow is as follows:
+
+1. Configure `multi_movingsign` with the attached LED sign device paths
+2. Create a page of information to display (see [page definition](PAGE_DEFINITION.md))
+3. Start the MultiMovingsign server
+4. Add the page to the server
+5. Stop the server
+
+``` bash
+$ multi_movingsign setup --signs /dev/ttyUSB0 /dev/ttyUSB1      # Setup the sign device paths
+
+$ cat > page.yml <<PAGE                                         # Create page definition in page.yml
+---
+title: Page Title
+lines:
+- prefix: 'L 1: '
+  content:
+  - Screen 1
+  - Screen 2
+- prefix: 'L 2: '
+  content:
+  - Screen 1
+  - Screen 2
+PAGE
+
+$ multi_movingsign server start                                 # Start the sign server
+
+$ multi_movingsign server add-page --page page.yml              # Add a page to the running server (do in a separate terminal window from the 'server start' above)
+
+$ multi_movingsign server stop                                  # Stop the server
+```
+
+For examples on using `multi_movingsign` programmatically, see [cli.rb](lib/multi_movingsign/cli.rb).
+
+## Version History
+
+For a complete list of versions, see [CHANGELOG.md](CHANGELOG.md).
+
+
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/multi_movingsign

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'multi_movingsign'
+
+MultiMovingsign::Cli.start(ARGV)

data/fonts/README.md

@@ -0,0 +1 @@
+Screenshots of the various MovingSign fonts.

data/lib/multi_movingsign.rb

@@ -0,0 +1,9 @@
+require "multi_movingsign/version"
+require "multi_movingsign/errors"
+require "multi_movingsign/page_renderer"
+require "multi_movingsign/cli"
+require "multi_movingsign/settings"
+
+module MultiMovingsign
+  # Your code goes here...
+end

data/lib/multi_movingsign/cli.rb

@@ -0,0 +1,81 @@
+require 'thor'
+require 'multi_movingsign/server'
+require 'multi_movingsign/settings'
+require 'multi_movingsign/signs'
+
+module MultiMovingsign
+  # Command line interface to MultiMovingsign
+  class Cli < Thor
+    class_option :rc, :desc => 'Path the persistent settings file. Defaults to: ~/.multi_movingsign.yml'
+    class_option :testrc, :desc => 'Path to a script loaded BEFORE execution (used for testing)', :hide => true
+
+    desc 'setup', "Setup available Movingsign LED signs and preferences"
+    option :signs, :type => :array, :desc => "List of Movingsign LED board serial ports"
+    def setup
+      if signs = options[:signs]
+        settings = Settings.load settings_path
+        settings.sign_paths = signs
+
+        settings.dump settings_path
+      end
+    end
+
+    desc 'settings', 'Prints settings to terminal'
+    def settings
+      settings = Settings.load settings_path
+
+      puts "Signs (#{settings.signs.length}): #{settings.signs.map { |s| s.path }.join(' ')}"
+    end
+
+    desc 'show-identity', 'Show sign identifying information on all signs'
+    def show_identity
+      TestRCLoader.load(options['testrc']) if options['testrc']
+
+      settings = Settings.load settings_path
+
+      # validate we have signs
+      raise_no_signs unless settings.signs?
+
+      signs = Signs.new settings.signs
+
+      signs.show_identity
+    end
+
+    desc 'show-page', 'Renders the specified page to the configured signs'
+    option :page, :required => true, :desc => "YAML containing page definition"
+    def show_page
+      TestRCLoader.load(options['testrc']) if options['testrc']
+
+      settings = Settings.load settings_path
+      raise_no_signs unless settings.signs?
+
+      signs = settings.signs
+
+      page = YAML.load(File.read(options[:page]))
+
+      renderer = PageRenderer.new
+      solution = renderer.render(page, :count => signs.length)
+
+      threads = []
+      solution['signs'].each_with_index do |hash, i|
+        threads << Thread.new do
+          signs[i].show_text hash['content'], :display_pause => 3
+        end
+      end
+      threads.each { |t| t.join }
+    end
+
+    desc 'server SUBCOMMAND ...ARGS', 'Run or manipuate the MultiMovingsign server'
+    subcommand 'server', Server
+
+    private
+
+    def settings_path
+      options[:rc] || Settings.default_settings_path
+    end
+
+    def raise_no_signs
+      raise InvalidInputError, "No signs specified.  Please run setup with the --signs option."
+    end
+  end
+end