dream-cheeky-led 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95e5a7d14600aa08f271d1d80a0b4974fcbf0663
+  data.tar.gz: a7982c55c9e88eed97afb6693004c7bb8721d2d6
+SHA512:
+  metadata.gz: ee8d873c3507793b4ba7de6042f9deafd19983dd7ba112cf7f0db0763cc3f2002a70937a9e8cdeda8028179454ec0a14965102f587b06197e5ba565310ec2d9b
+  data.tar.gz: 974be5400e861ceb1bae36f524ec9eca88607cdb6c2fc075c27f3e587fc1246366c9cc913f7017cf745ccf01328fc210282ad127a827e8c6d6489034a8297ce5

data/.gitignore

@@ -0,0 +1,17 @@
+*.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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pete Nicholls
+
+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/README.md

@@ -0,0 +1,69 @@
+# Dream Cheeky LED Message Board
+
+[![Very build status](https://travis-ci.org/Aupajo/dream-cheeky-led.png?branch=master)](https://travis-ci.org/Aupajo/dream-cheeky-led)
+[![So Code Climate](https://codeclimate.com/github/Aupajo/dream-cheeky-led.png)](https://codeclimate.com/github/Aupajo/dream-cheeky-led)
+
+![Such art](http://i.imgur.com/CVZJcqd.jpg)
+
+Control the [Dream Cheeky LED Message Board](http://www.dreamcheeky.com/led-message-board) by drawing ASCII.
+
+For scrolling text, see also:
+
+  https://github.com/Lewis-Clayton/dcled_ruby
+
+## Installation
+
+**This gem is a prerelease version. The API is liable to change.**
+
+Add this line to your application's Gemfile:
+
+    gem 'dream-cheeky-led', '0.0.1.pre'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dream-cheeky-led --pre
+
+## Usage
+
+### Drawing with ASCII
+
+The message board contains 21 x 7 pixels. Any drawing that fits within those dimensions will work.
+
+```ruby
+require 'dream-cheeky/led'
+
+message_board = DreamCheeky::LEDMessageBoard.first
+
+art = <<-ART 
+  *   *
+   * *
+    *
+   * *
+  *   *
+ART
+
+message_board.draw(art)
+```
+
+You can use any character that isn't a space to represent a pixel (e.g. `*`, `x`, `o`).
+
+The drawing will appear briefly, and disappear. This is a limitation with the device. To persist the drawing to the screen, wrap the call to `draw` in a loop:
+
+```ruby
+loop do
+  message_board.draw(art)
+  sleep 0.3
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/aupajo/dream-cheeky-led/fork )
+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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/dream-cheeky-led.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dream-cheeky/led/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dream-cheeky-led"
+  spec.version       = DreamCheeky::LEDMessageBoard::VERSION
+  spec.authors       = ["Pete Nicholls"]
+  spec.email         = ["pete@metanation.com"]
+  spec.summary       = %q{A Dream Cheeky LED Message Board driver in Ruby.}
+  spec.description   = %q{Control the Dream Cheeky LED Message Board with ASCII art.}
+  spec.homepage      = "https://github.com/aupajo/dream-cheeky-led"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "libusb"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dream-cheeky/led.rb

@@ -0,0 +1,8 @@
+require "libusb"
+require "dream-cheeky/led/version"
+require "dream-cheeky/led/message_board"
+require "dream-cheeky/led/device"
+require "dream-cheeky/led/pattern"
+require "dream-cheeky/led/ascii_drawing"
+require "dream-cheeky/led/ascii_table"
+require "dream-cheeky/led/screen_state"

data/lib/dream-cheeky/led/ascii_drawing.rb

@@ -0,0 +1,70 @@
+module DreamCheeky
+  module LEDMessageBoard
+    class ASCIIDrawing
+      EMPTY_VALUES = [nil, " "]
+
+      attr_reader :lines
+
+      def initialize(string, ignore_leading_whitespace: false)
+        @lines = string.split("\n")
+        @ignore_leading_whitespace = ignore_leading_whitespace
+      end
+
+      def to_pattern
+        Pattern.new(rows)
+      end
+
+      def self.to_pattern(string)
+        self.new(string).to_pattern
+      end
+
+      protected
+
+      def lines
+        if ignore_leading_whitespace?
+          lines_without_leading_whitespace  
+        else
+          @lines
+        end
+      end
+
+      private
+
+      def max_row_length
+        lines.max_by(&:length).length
+      end
+
+      def ignore_leading_whitespace?
+        @ignore_leading_whitespace
+      end
+
+      def rows
+        lines.map do |line|
+          Array.new(max_row_length).map.with_index do |state, index|
+            character_state(line[index])
+          end
+        end
+      end
+
+      def lines_without_leading_whitespace
+        @lines.map do |line|
+          line[position_of_earliest_char..-1]
+        end
+      end
+
+      def position_of_earliest_char
+        @lines.map do |line|
+          line.index(/[^\s+]/) || 0
+        end.min
+      end
+
+      def is_empty?(char)
+        EMPTY_VALUES.include?(char)
+      end
+
+      def character_state(char)
+        is_empty?(char) ? Pattern::OFF_STATE : Pattern::ON_STATE
+      end
+    end
+  end
+end

data/lib/dream-cheeky/led/ascii_table.rb

@@ -0,0 +1,18 @@
+module DreamCheeky
+  module LEDMessageBoard
+    class ASCIITable < ASCIIDrawing
+
+      def initialize(string, ignore_leading_whitespace: false)
+        super string, ignore_leading_whitespace: true
+      end
+
+      protected
+
+      def lines
+        lines_without_leading_whitespace[1..-1].map do |line|
+          line[2..-1].each_char.each_slice(2).map(&:first).join
+        end
+      end
+    end
+  end
+end

data/lib/dream-cheeky/led/device.rb

@@ -0,0 +1,45 @@
+module DreamCheeky
+  module LEDMessageBoard
+    class Device
+      VENDOR_ID = 0x1d34
+      PRODUCT_ID = 0x0013
+
+      def device_handle
+        @device_handle ||= open_handle!
+      end
+
+      def send_bytes(bytes)
+        device_handle.control_transfer(
+          bmRequestType: 0x21,
+          bRequest:      0x09,
+          wValue:        0x0000,
+          wIndex:        0x0000,
+          dataOut:       bytes.pack('cccccccc')
+        )
+      end
+
+      def send_packets(packets)
+        packets.each do |bytes|
+          send_bytes(bytes)
+        end
+      end
+
+      def draw(ascii)
+        pattern = Pattern.from_ascii(ascii)
+        screen_state = ScreenState.new(pattern.to_a)
+        send_packets(screen_state.packets)
+      end
+
+      private
+
+      def open_handle!
+        usb = LIBUSB::Context.new
+        device = usb.devices(idVendor: VENDOR_ID, idProduct: PRODUCT_ID).first
+
+        handle = device.open
+        handle.detach_kernel_driver(0) if handle.kernel_driver_active?(0)
+        handle
+      end
+    end
+  end
+end

data/lib/dream-cheeky/led/message_board.rb

@@ -0,0 +1,7 @@
+module DreamCheeky
+  module LEDMessageBoard
+    def self.first
+      Device.new
+    end
+  end
+end

data/lib/dream-cheeky/led/pattern.rb

@@ -0,0 +1,24 @@
+module DreamCheeky
+  module LEDMessageBoard
+    class Pattern
+      OFF_STATE = 0
+      ON_STATE = 1
+
+      def initialize(rows)
+        @rows = rows
+      end
+
+      def to_a
+        @rows
+      end
+
+      def self.from_ascii(*args)
+        ASCIIDrawing.new(*args).to_pattern
+      end
+
+      def self.from_ascii_table(*args)
+        ASCIITable.new(*args).to_pattern
+      end
+    end
+  end
+end

data/lib/dream-cheeky/led/screen_state.rb

@@ -0,0 +1,70 @@
+module DreamCheeky
+  module LEDMessageBoard
+    class ScreenState
+      BRIGHTNESS = {
+        max: 0,
+        mid: 1,
+        min: 2
+      }
+
+      WIDTH = 21
+      HEIGHT = 7
+
+      NUM_PACKETS = (HEIGHT.to_f / 2).ceil
+      ROWS_PER_PACKET = 2
+      
+      def initialize(rows, brightness: :max)
+        @rows = rows
+        @brightness = brightness
+      end
+
+      def packets
+        Array.new(NUM_PACKETS) do |i|
+          packet(i * ROWS_PER_PACKET)
+        end
+      end
+
+      def packet(row_start)
+        [
+          brightness,
+          row_start,
+          rows_data(row_start)
+        ].flatten.compact
+      end
+
+      private
+
+      def rows_data(row_start)
+        Array.new(ROWS_PER_PACKET) do |i|
+          row_data(row_start + i)
+        end
+      end
+
+      def row_data(row_index)
+        row = @rows[row_index] || Array.new(8, 0)
+
+        row.fill(0, row.length...WIDTH)
+
+        row.each_slice(8).map do |states|
+          byte_data(states)
+        end.reverse
+      end
+
+      def byte_data(states)
+        byte = 0
+
+        0.upto(7) do |i|
+          state = states[i] || 0
+          byte |= state << i
+        end
+
+        0xFF - byte
+      end
+
+      def brightness
+        BRIGHTNESS[@brightness]
+      end
+
+    end
+  end
+end

data/lib/dream-cheeky/led/version.rb

@@ -0,0 +1,5 @@
+module DreamCheeky
+  module LEDMessageBoard
+    VERSION = "0.0.1.pre"
+  end
+end

data/spec/pattern_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+module DreamCheeky::LEDMessageBoard
+
+  describe Pattern do
+    describe "#to_a" do
+      it "returns an array of rows" do
+        pattern = Pattern.new([
+          [0, 0, 0, 1],
+          [0, 0, 1, 0],
+          [0, 1, 0, 0],
+          [1, 0, 0, 0]
+        ])
+
+        expect(pattern.to_a).to eq([
+          [0, 0, 0, 1],
+          [0, 0, 1, 0],
+          [0, 1, 0, 0],
+          [1, 0, 0, 0]
+        ])
+      end
+    end
+
+    describe ".from_ascii" do
+      it "reads data from an ASCII drawing" do
+        pattern = Pattern.from_ascii <<-CROSS
+x   x
+ x x
+  x
+ x x
+x   x
+        CROSS
+
+        expect(pattern.to_a).to eq([
+          [1, 0, 0, 0, 1],
+          [0, 1, 0, 1, 0],
+          [0, 0, 1, 0, 0],
+          [0, 1, 0, 1, 0],
+          [1, 0, 0, 0, 1]
+        ])
+      end
+
+      it "can ignore leading whitespace" do
+        drawing = <<-DRAWING
+          o
+           o
+          o o
+        DRAWING
+
+        pattern = Pattern.from_ascii(drawing, ignore_leading_whitespace: true)
+
+        expect(pattern.to_a).to eq([
+          [1, 0, 0],
+          [0, 1, 0],
+          [1, 0, 1]
+        ])
+      end
+    end
+
+    describe ".from_ascii_table" do
+      it "reads data from an ASCII table" do
+        grid = <<-GRID
+            A B C D E
+          1       x
+          2     x   x
+          3   x
+        GRID
+
+        pattern = Pattern.from_ascii_table(grid)
+
+        expect(pattern.to_a).to eq([
+          [0, 0, 0, 1, 0],
+          [0, 0, 1, 0, 1],
+          [0, 1, 0, 0, 0]
+        ])
+      end
+    end
+
+    it "translates a pattern into bytes" do
+      table = <<-TABLE
+          A B C D E F G H I J K L M N O P Q R S T U
+        1                 x
+        2               x   x
+        3             x       x
+        4           x           x
+        5             x       x
+        6               x   x
+        7                 x
+      TABLE
+
+
+      pattern = Pattern.from_ascii_table(table)
+      screen = ScreenState.new(pattern.to_a)
+
+      expect(screen.packets).to eql([
+        [0x00, 0x00,  0xFF, 0xFE, 0xFF,  0xFF, 0xFD, 0x7F],
+        [0x00, 0x02,  0xFF, 0xFB, 0xBF,  0xFF, 0xF7, 0xDF],
+        [0x00, 0x04,  0xFF, 0xFB, 0xBF,  0xFF, 0xFD, 0x7F],
+        [0x00, 0x06,  0xFF, 0xFE, 0xFF,  0xFF, 0xFF, 0xFF]
+      ])
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'dream-cheeky/led'
+
+# Include support files
+support_files_pattern = File.expand_path('../support/**/*.rb', __FILE__)
+Dir.glob(support_files_pattern).each { |f| require f }
+
+RSpec.configure do |config|
+  # Will be the default in RSpec 3
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: dream-cheeky-led
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Pete Nicholls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libusb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Control the Dream Cheeky LED Message Board with ASCII art.
+email:
+- pete@metanation.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dream-cheeky-led.gemspec
+- lib/dream-cheeky/led.rb
+- lib/dream-cheeky/led/ascii_drawing.rb
+- lib/dream-cheeky/led/ascii_table.rb
+- lib/dream-cheeky/led/device.rb
+- lib/dream-cheeky/led/message_board.rb
+- lib/dream-cheeky/led/pattern.rb
+- lib/dream-cheeky/led/screen_state.rb
+- lib/dream-cheeky/led/version.rb
+- spec/pattern_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aupajo/dream-cheeky-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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: A Dream Cheeky LED Message Board driver in Ruby.
+test_files:
+- spec/pattern_spec.rb
+- spec/spec_helper.rb
+has_rdoc: