betabrite 0.0.2 → 1.0.0

data/.autotest

@@ -0,0 +1,7 @@
+require 'betabrite/autotest'
+require 'usb'
+
+Autotest::BetaBrite.hook(BetaBrite::USB) do |failures, erorrs|
+  failures.rgb('0000FF') if failures.green?
+end
+

data/EXAMPLES

@@ -2,85 +2,40 @@
 
 == Allocate Memory
 
-  require 'betabrite'
-  require 'serialport'
-  
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
-  
-  sign = BetaBrite.new
-  
-  string  = BetaBrite::Memory::String.new('0', 32)
-  dots    = BetaBrite::Memory::Dots.new('1', 7, 7)
-  text    = BetaBrite::Memory::Text.new('A', 256)
-  
-  sign.add text
-  sign.add dots
-  sign.add string
-  
-  sign.allocate { |text|
-    sp.write text
-  }
+  bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
+    sign.allocate do |memory|
+      memory.text('A', 4096)
+      memory.string('0', 64)
+      memory.dots('1', 7, 7)
+    end
+  end
+  bb.write_memory!
 
 == Reset the sign
 
-  require 'betabrite'
-  require 'serialport'
-  
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
+  BetaBrite::Serial.new('/dev/ttyUSB0').clear_memory!
   
-  sign = BetaBrite.new
-  sign.add BetaBrite::Memory::Clear.new
-  
-  sign.allocate { |text|
-    sp.write text
-  }
-
 == Write a text file
 
-  require 'serialport'
-  require 'betabrite'
-  
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
-  
-  sign = BetaBrite.new
-  tf = BetaBrite::TextFile.new
-  tf.message = ARGV[0]
-  
-  sign.add tf
-  
-  sign.write { |text|
-    sp.write text
-  }
+  bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
+    sign.textfile do
+      print left_arrow + string("Hello ").green
+      print string(" world.").green + sail_boat
+    end
+  end
+  bb.write!
 
 == Write a text file that references a string file
 
-  require 'betabrite'
-  require 'serialport'
-  
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
-  
-  sign = BetaBrite.new
-  
-  # Create a new TextFile with the COMPRESSED_ROTATE mode.
-  tf = BetaBrite::TextFile.new { |a|
-    a.mode = BetaBrite::TextFile::Mode::COMPRESSED_ROTATE
-  }
-  
-  # Set up a BetaBrite::String
-  name = BetaBrite::String.new('James',
-                                    :color => BetaBrite::String::Color::AMBER
-                                  )
-  # Create a StringFile which can be modified without making the sign blink.
-  sf = BetaBrite::StringFile.new('0', name)
-  
-  # Set the TextFile message and reference the StringFile
-  tf.message = BetaBrite::String.new("Aaron #{sf.id} Patterson")
-  
-  
-  sign.add tf
-  sign.add sf 
-  
-  sign.write { |text|
-    sp.write text
-  }
-
+  bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
+    sign.stringfile('0') do
+      print string("cruel").red
+    end
+  
+    sign.textfile do
+      print left_arrow + string("Hello ").green
+      print stringfile("0")
+      print string(" world.").green + sail_boat
+    end
+  end
+  bb.write!

data/History.txt

@@ -0,0 +1,16 @@
+=== 1.0.0
+
+* 3 Major Enhancements:
+
+  * Adding support for USB betabrite signs (Thanks Thought Hammer)
+  * Added an autotest hook
+  * Changed API to use more DSL type interface
+
+=== 0.0.2
+
+* Added new syntax to BetaBrite::String and BetaBrite::TextFile
+
+=== 0.0.1
+
+* First release
+

data/Manifest.txt

@@ -0,0 +1,35 @@
+.autotest
+EXAMPLES
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+lib/betabrite.rb
+lib/betabrite/autotest.rb
+lib/betabrite/base.rb
+lib/betabrite/files.rb
+lib/betabrite/files/dots.rb
+lib/betabrite/files/file_dsl.rb
+lib/betabrite/files/string.rb
+lib/betabrite/files/text.rb
+lib/betabrite/memory.rb
+lib/betabrite/serial.rb
+lib/betabrite/string.rb
+lib/betabrite/usb.rb
+script/alloc.rb
+script/clear_memory.rb
+script/client.rb
+script/dots_file.rb
+script/server.rb
+script/sign_test.rb
+script/stock_alloc.rb
+script/stock_client.rb
+script/stockdata.rb
+test/helper.rb
+test/test_many_mem.rb
+test/test_memory.rb
+test/test_set_string.rb
+test/test_string.rb
+test/test_text_file.rb
+test/test_usb_betabrite.rb

data/{README → README.txt}

@@ -1,8 +1,20 @@
 = BetaBrite Library
 
-== Synopsis
+* http://rubyforge.org/projects/betabrite/
+* http://betabrite.rubyforge.org/
+* mailto:aaron@tenderlovemaking.com
 
-This library is used for controlling BetaBrite LED signs via Ruby.
+== DESCRIPTION
+
+Provides a Ruby interface to BetaBrite LED signs.
+
+== DEPENDENCIES
+
+  * ruby-usb[http://raa.ruby-lang.org/project/ruby-usb/]
+  * ruby-serialport[http://rubyforge.org/projects/ruby-serialport/]
+
+PLEASE NOTE!!!!  You must require 'usb' or 'serialport' depending on which
+sign you are using!!!!
 
 == More Information
 
@@ -15,42 +27,40 @@ file displayed on the sign is labeled 'A'.
 
 Here is an example of modifying the default sign text:
 
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
-  
-  sign = BetaBrite.new
-  tf = BetaBrite::TextFile.new
-  tf.message = ARGV[0]
-  
-  sign.add tf
+  bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
+    sign.textfile do
+      print ARGV[0]
+    end
+  end
+  bb.write!
+
+== Autotest Support
+Here is an example of a .autotest file using the BetaBrite module:
+
+  require 'betabrite/autotest'
+  require 'usb'
   
-  sign.write { |text|
-    sp.write text
-  }
+  Autotest::BetaBrite.hook(BetaBrite::USB) do |failures, erorrs|
+    failures.rgb('0000FF') if failures.green?
+  end
+
+You don't need to give the hook method a block, but you can if you'd like to
+customize your messages.
 
 == Allocating Memory
 The memory in the BetaBrite sign should be configured before anything is
-written to it.  This means writing a seperate script to allocate the memory
-from the one that actually writes data.  This may change in the future, I
-just haven't figured out if it is possible to allocate memory and write data
-at the same time.
+written to it.  You only have to configure the memory once before writing to
+it.  So subsequent executions of your script do not require allocating memory.
 
 Here is an example of allocating memory on the sign:
 
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
-  
-  sign = BetaBrite.new
-  
-  string  = BetaBrite::Memory::String.new('0', 32)
-  dots    = BetaBrite::Memory::Dots.new('1', 7, 7)
-  text    = BetaBrite::Memory::Text.new('A', 256)
-  
-  sign.add text
-  sign.add dots
-  sign.add string
-  
-  sign.allocate { |text|
-    sp.write text
-  }
+  bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
+    sign.memory do |memory|
+      memory.text('A', 4096)
+      memory.string('0', 64)
+    end
+  end
+  bb.write_memory!
 
 For more examples, see the EXAMPLES file.
 
@@ -69,27 +79,18 @@ be displayed unless referenced from a Text File.
 
 Here is an example of referencing a String File from a Text File:
 
-  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
-  sign = BetaBrite.new
-  tf = BetaBrite::TextFile.new
-  
-  # Set up a BetaBrite::String
-  middle_name = BetaBrite::String.new('James',
-                                    :color => BetaBrite::String::Color::AMBER
-                                  )
-  # Create a StringFile which can be modified without making the sign blink.
-  sf = BetaBrite::StringFile.new('0', middle_name)
-  
-  # Set the TextFile message and reference the StringFile
-  tf.message = BetaBrite::String.new("Aaron #{sf.id} Patterson")
-  
-  
-  sign.add tf
-  sign.add sf 
-  
-  sign.write { |text|
-    sp.write text
-  }
+  bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
+    sign.stringfile('0') do
+      print string("cruel").red
+    end
+
+    sign.textfile do
+      print string("Goodbye ").green
+      print stringfile("0")
+      print string(" world.").green + sail_boat
+    end
+  end
+  bb.write!
 
 Once the String file is allocated and displayed, it can be changed at any
 time and the string will be updated without the screen going blank.
@@ -98,3 +99,8 @@ time and the string will be updated without the screen going blank.
 Dots files can contain pictures.  Each pixel is set in an array of strings.
 See dots_file.rb under the script directory for an example.  Or see the
 EXAMPLES file.
+
+== Author
+
+* {Aaron Patterson}[http://tenderlovemaking.com] <aaronp@rubyforge.org>
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'hoe'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "lib")
+require 'betabrite'
+
+Hoe.new('betabrite', BetaBrite::VERSION) do |p|
+  p.rubyforge_name  = 'betabrite'
+  p.author          = 'Aaron Patterson'
+  p.email           = 'aaronp@rubyforge.org'
+  p.summary         = "Provides a Ruby interface to BetaBrite LED signs"
+end

data/lib/betabrite.rb

@@ -1,121 +1,7 @@
-require 'files/textfile'
-require 'files/stringfile'
-require 'files/dotsfile'
-require 'memory/memory'
-require 'string'
-require 'bb_version'
+require 'betabrite/string'
+require 'betabrite/files'
+require 'betabrite/base'
+require 'betabrite/usb'
+require 'betabrite/serial'
+require 'betabrite/memory'
 
-# = Synopsis
-# This class assembles all packets (different files) and yields the data
-# that needs to be written back to the caller of the BetaBrite#write method.
-class BetaBrite
-  HEADER    = [ 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 ]
-  STX       = 0x02.chr
-  ETX       = 0x03.chr
-  EOT       = 0x04.chr
-  ESC       = 0x1b.chr
-  DLE       = 0x10.chr
-  STRING    = 0x14.chr
-  CR        = 0x0d.chr
-  MEMORY_CODE = "E$"
-
-  # Beta Brite sign
-  SIGN_TYPE = 0x5a.chr
-
-  attr_reader :sleep_time
-  attr_reader :string_files, :text_files, :dots_files
-
-  def initialize
-    # Default address is "00" which means broadcast to all signs
-    @sign_address = [ 0x30, 0x30 ]
-    @string_files = []
-    @text_files   = []
-    @dots_files   = []
-    @memory       = []
-
-    # This shouldn't change except for unit testing
-    @sleep_time = 1
-  end
-
-  def header
-    header_str = HEADER.collect { |a| a.chr }.join
-    header_str << SIGN_TYPE << @sign_address.collect { |a| a.chr }.join
-  end
-
-  def inspect
-    header
-  end
-
-  def add(packet)
-    if packet.is_a? BetaBrite::Memory
-      add_memory packet
-    elsif packet.is_a? BetaBrite::StringFile
-      add_stringfile packet
-    elsif packet.is_a? BetaBrite::TextFile
-      add_textfile packet
-    elsif packet.is_a? BetaBrite::DotsFile
-      add_dotsfile packet
-    end
-  end
-
-  def add_stringfile(packet)
-    @string_files << packet
-  end
-
-  def add_textfile(packet)
-    @text_files << packet
-  end
-
-  def add_dotsfile(packet)
-    @dots_files << packet
-  end
-
-  def add_memory(packet)
-    @memory << packet
-  end
-
-  # This method is used to write on the sign
-  def write(&block)
-    if @text_files.length > 0 || @string_files.length > 0
-      write_header &block
-      @text_files.each { |packet| yield packet.to_s }
-      @string_files.each { |packet| block.call(packet.to_s) }
-      write_end &block
-    end
-  end
-
-  def write_dots(&block)
-    if @dots_files.length > 0
-      write_header &block
-      @dots_files.each { |packet|
-        yield packet.to_s
-        sleep sleep_time
-      }
-      write_end &block
-    end
-  end
-
-  # This method is used to allocate memory on the sign
-  def allocate(&block)
-    if @memory.length > 0
-      write_header &block
-      yield STX
-      yield MEMORY_CODE
-      @memory.each { |packet| yield packet.to_s }
-      write_end &block
-    end
-  end
-
-  private
-
-  def write_header(&block)
-    header.split(//).each { |c|
-      yield c
-      sleep sleep_time
-    }
-  end
-
-  def write_end(&block)
-    yield EOT
-  end
-end