betabrite 0.0.1

data/CHANGELOG

@@ -0,0 +1,6 @@
+= BetaBrite Changelog
+
+== 0.0.1
+
+* First release
+

data/EXAMPLES

@@ -0,0 +1,86 @@
+= BetaBrite Examples
+
+== 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
+  }
+
+== Reset the sign
+
+  require 'betabrite'
+  require 'serialport'
+  
+  sp = SerialPort.new(0, 9600, 8, 1, SerialPort::NONE)
+  
+  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
+  }
+
+== 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
+  }
+

data/LICENSE

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/NOTES

@@ -0,0 +1,7 @@
+= BetaBrite Release Notes
+
+== 0.0.1
+
+This is the first release of the BetaBrite sign library.  Please see the RDoc,
+the 'script' directory, and the EXAMPLES file for how to use this library.
+

data/README

@@ -0,0 +1,100 @@
+= BetaBrite Library
+
+== Synopsis
+
+This library is used for controlling BetaBrite LED signs via Ruby.
+
+== More Information
+
+The BetaBrite sign has memory that can be configured before any messages are
+displayed.  There are different types of "Files" that can be allocated.
+"Text Files" are files that are displayed on the sign.  To display any other
+type of file on the sign, that file must be referenced from a Text File.  Files
+must be labeled, and are given a single character file name.  The default text
+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
+  
+  sign.write { |text|
+    sp.write text
+  }
+
+== 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.
+
+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
+  }
+
+For more examples, see the EXAMPLES file.
+
+== Different File Types
+=== Text Files
+The data stored in a text file is not supposed to change frequently.  If the
+data in a text file is changed, the sign will go blank before anything is
+displayed.  This is not good for applications like a stock ticker which
+update data quite frequently.  This problem can be avoided by having the
+text file reference more volitile files like String Files.
+
+=== String Files
+String files contain more volitile memory.  The contents of a String File
+can be changed without the screen going blank.  String Files, however, cannot
+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
+  }
+
+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.
+
+=== Dots Files
+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.

data/lib/bb_version.rb

@@ -0,0 +1,3 @@
+class BetaBrite
+  Version = '0.0.1'
+end

data/lib/betabrite.rb

@@ -0,0 +1,121 @@
+require 'files/textfile'
+require 'files/stringfile'
+require 'files/dotsfile'
+require 'memory/memory'
+require 'string'
+require 'bb_version'
+
+# = 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

data/lib/files/dotsfile.rb

@@ -0,0 +1,24 @@
+class BetaBrite
+  class DotsFile
+    COMMAND_CODE = 0x49.chr
+
+    attr_accessor :label, :rows, :columns, :picture
+
+    def initialize(label, rows, columns, picture)
+      @label    = label
+      @rows     = rows
+      @columns  = columns
+      @picture  = picture
+    end
+
+    def id
+      BetaBrite::STRING << @label
+    end
+
+    def to_s
+      string = "#{BetaBrite::STX}#{COMMAND_CODE}#{@label.to_s}" +
+        "#{sprintf('%02x', @rows)}#{sprintf('%02x', @columns)}" +
+        "#{picture.join(BetaBrite::CR)}#{BetaBrite::CR}"
+    end
+  end
+end

data/lib/files/stringfile.rb

@@ -0,0 +1,22 @@
+class BetaBrite
+  class StringFile
+    COMMAND_CODE = 'G'
+
+    attr_accessor :label, :message
+
+    def initialize(label = nil, message = nil)
+      @label    = label
+      @message  = message
+      yield self if block_given?
+    end
+
+    def id
+      "#{BetaBrite::DLE}#{@label}"
+    end
+
+    def to_s
+      "#{BetaBrite::STX}#{COMMAND_CODE}#{@label.to_s}" +
+      "#{@message.to_s}#{BetaBrite::ETX}"
+    end
+  end
+end

data/lib/files/textfile.rb

@@ -0,0 +1,93 @@
+class BetaBrite
+  class TextFile
+    WRITE   = 0x41.chr
+    READ    = 0x42.chr
+
+    class Position
+      MIDDLE  = 0x20.chr
+      TOP     = 0x22.chr
+      BOTTOM  = 0x26.chr
+      FILL    = 0x30.chr
+      LEFT    = 0x31.chr
+      RIGHT   = 0x32.chr
+    end
+
+    class Mode
+      # Standard Modes
+      ROTATE      = 0x61.chr # Message travels right to left
+      HOLD        = 0x62.chr # Message remains stationary
+      FLASH       = 0x63.chr # Message remains stationary and flashes
+      ROLL_UP     = 0x65.chr # Message is pushed up by new message
+      ROLL_DOWN   = 0x66.chr # Message is pushed down by new message
+      ROLL_LEFT   = 0x67.chr # Message is pushed left by a new message
+      ROLL_RIGHT  = 0x68.chr # Message is pushed right by a new message
+      WIPE_UP     = 0x69.chr # Message is wiped over bottom to top
+      WIPE_DOWN   = 0x6A.chr # Message is wiped over top to bottom
+      WIPE_LEFT   = 0x6B.chr # Message is wiped over right to left
+      WIPE_RIGHT  = 0x6C.chr # Message is wiped over left to right
+      SCROLL      = 0x6D.chr # New message pushes up if 2 line sign
+      AUTOMODE    = 0x6F.chr # Various modes are called automatically
+      ROLL_IN     = 0x70.chr # Message pushed toward center of display
+      ROLL_OUT    = 0x71.chr # Message pushed away from center of display
+      WIPE_IN     = 0x72.chr # Message wiped over in inward motion
+      WIPE_OUT    = 0x73.chr # Message wiped over in outward motion
+      COMPRESSED_ROTATE = 0x74.chr # Left to right, chars half normal width
+      EXPLODE     = 0x75.chr # Message flies apart (Alpha 3.0)
+      CLOCK       = 0x76.chr # Wipe in clockwise direction (Alpha 3.0)
+
+      # Special Modes
+      TWINKLE     = 0x6E.chr << 0x30.chr # Message will twinkle
+      SPARKLE     = 0x6E.chr << 0x31.chr # Message will sparkle
+      SNOW        = 0x6E.chr << 0x32.chr # Message will snow
+      INTERLOCK   = 0x6E.chr << 0x33.chr # Message will interlock
+      SWITCH      = 0x6E.chr << 0x34.chr # Message will switch
+      SLIDE       = 0x6E.chr << 0x35.chr # Message will slide
+      SPRAY       = 0x6E.chr << 0x36.chr # Message will spray across
+      STARBURST   = 0x6E.chr << 0x37.chr # Explodes message to screen
+      WELCOME     = 0x6E.chr << 0x38.chr # The world "Welcome" is written
+      SLOT_MACHINE= 0x6E.chr << 0x39.chr # Slot Machine shows up
+      NEWS_FLASH  = 0x6E.chr << 0x3A.chr # News flash animation
+      TRUMPET     = 0x6E.chr << 0x3B.chr # Trumpet animation
+      CYCLE_COLORS= 0x6E.chr << 0x43.chr # Color changes from one to another
+
+      # Special Graphics
+      THANK_YOU   = 0x6E.chr << 0x53.chr # "Thank You" in script
+      NO_SMOKING  = 0x6E.chr << 0x55.chr # No smoking
+      DRINK_DRIVE = 0x6E.chr << 0x56.chr # Don't drink and drive
+      ANIMAL_ANIM = 0x6E.chr << 0x57.chr # Animal animation
+      FIREWORKS   = 0x6E.chr << 0x58.chr # Fireworks animation
+      BALLOONS    = 0x6E.chr << 0x59.chr # Balloon animation
+      CHERRY_BOMB = 0x6E.chr << 0x5A.chr # A bomb animation
+    end
+
+    attr_accessor :label, :display_position, :mode, :message
+
+    def initialize
+      @display_position = Position::MIDDLE
+      @label = "A"
+      @mode  = Mode::ROTATE
+      yield self if block_given?
+    end
+
+    def to_s
+      "#{combine}#{checksum(combine)}"
+    end
+
+    def checksum(string)
+      total = 0
+      0.upto(string.length - 1) do |i|
+        total += string[i]
+      end
+
+      sprintf("%04x", total).upcase
+    end
+
+    alias :inspect :to_s
+
+    private
+    def combine
+      "#{BetaBrite::STX}#{WRITE}#{@label}#{BetaBrite::ESC}" <<
+      "#{@display_position}#{@mode}#{@message}#{BetaBrite::ETX}"
+    end
+  end
+end

data/lib/memory/memory.rb

@@ -0,0 +1,76 @@
+class BetaBrite
+  class Memory
+    COMMAND_CODE = "E$"
+    TEXT         = 'A'
+    STRING       = 'B'
+    DOTS         = 'D'
+    LOCKED       = 'L'
+    UNLOCKED     = 'U'
+    def self.clear
+      BetaBrite::STX << COMMAND_CODE
+    end
+
+    attr_accessor :label, :type, :locked, :size, :time
+    def initialize(opts = {})
+      args = {  :label  => 'A',
+                :type   => STRING,
+                :locked => LOCKED,
+                :size   => sprintf("%04x", 0),
+                :time   => '0000'
+              }.merge opts
+      @label  = args[:label]
+      @type   = args[:type]
+      @locked = args[:locked]
+      @size   = args[:size]
+      @time   = args[:time]
+      yield self if block_given?
+    end
+
+    def format
+      #BetaBrite::STX << COMMAND_CODE << @label << @type << @locked <<
+      @label << @type << @locked << @size.upcase << @time
+    end
+
+    alias :to_s :format
+
+    class String < Memory
+      def initialize(label, size)
+        super(  :label  => label,
+                :type   => STRING,
+                :locked => LOCKED,
+                :size   => sprintf("%04x", size),
+                :time   => '0000'
+             )
+      end
+    end
+
+    class Text < Memory
+      def initialize(label, size)
+        super(  :label  => label,
+                :type   => TEXT,
+                :locked => UNLOCKED,
+                :size   => sprintf("%04x", size),
+                :time   => 'FF00'
+             )
+      end
+    end
+
+    class Dots < Memory
+      def initialize(label, rows, columns)
+        size = sprintf("%02x", rows) << sprintf("%02x", columns)
+        super(  :label  => label,
+                :type   => DOTS,
+                :locked => UNLOCKED,
+                :size   => size,
+                :time   => '4000'
+             )
+      end
+    end
+
+    class Clear < Memory
+      def to_s
+        "#{BetaBrite::STX}#{COMMAND_CODE}"
+      end
+    end
+  end
+end

data/lib/string.rb

@@ -0,0 +1,72 @@
+class BetaBrite
+  # This class encapsulates a string and attributes about the string such as
+  # color, character set, and also contains special characters.
+  class String
+    LEFT_ARROW      = 0xc6.chr
+    RIGHT_ARROW     = 0xc6.chr
+    PACKMAN         = 0xc8.chr
+    SAIL_BOAT       = 0xc9.chr
+    BALL            = 0xca.chr
+    TELEPHONE       = 0xcb.chr
+    HEART           = 0xcc.chr
+    CAR             = 0xcd.chr
+    HANDICAP        = 0xce.chr
+    RHINO           = 0xcf.chr
+    MUG             = 0xd0.chr
+    SATELLITE_DISH  = 0xd1.chr
+    COPYRIGHT       = 0xd2.chr
+    MALE_SYM        = 0xd3.chr
+    FEMALE_SYM      = 0xd4.chr
+    BOTTLE          = 0xd5.chr
+    DISKETTE        = 0xd6.chr
+    PRINTER         = 0xd7.chr
+    NOTE            = 0xd8.chr
+    INFINITY        = 0xd9.chr
+    class Color
+      RED       = '1'
+      GREEN     = '2'
+      AMBER     = '3'
+      DIM_RED   = '4'
+      DIM_GREEN = '5'
+      BROWN     = '6'
+      ORANGE    = '7'
+      YELLOW    = '8'
+      RAINBOW_1 = '9'
+      RAINBOW_2 = 'A'
+      COLOR_MIX = 'B'
+      AUTOCOLOR = 'C'
+    end
+    class CharSet
+      FIVE_HIGH     = '1'
+      FIVE_STROKE   = '2'
+      SEVEN_HIGH    = '3'
+      SEVEN_STROKE  = '4'
+      SEVEN_FANCY   = '5'
+      TEN_HIGH      = '6'
+      SEVEN_SHADOW  = '7'
+      FULL_FANCY    = '8'
+      FULL_HEIGHT   = '9'
+      SEVEN_SHDW_F  = ':'
+      FIVE_WIDE     = ';'
+      SEVEN_WIDE    = '<'
+      SEVEN_WIDE_F  = '='
+      WIDE_SRK_FIVE = '>'
+    end
+    attr_accessor :color, :charset, :string
+
+    def initialize(string, opts = {})
+      args = {  :color    => Color::GREEN,
+                :charset  => CharSet::SEVEN_HIGH
+             }.merge opts
+      @string   = string
+      @color    = args[:color]
+      @charset  = args[:charset]
+    end
+
+    def to_s
+      "#{0x1a.chr}#{@charset}#{0x1c.chr}#{@color}#{@string}"
+    end
+
+    #alias :to_s :format
+  end
+end

data/test/bb_override.rb

@@ -0,0 +1,5 @@
+class BetaBrite
+  def sleep_time
+    0
+  end
+end

data/test/tc_many_mem.rb

@@ -0,0 +1,41 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift File.join(File.dirname(__FILE__), "..", "test")
+
+require 'test/unit'
+require 'betabrite'
+require 'bb_override'
+
+class MemoryAllocTest < Test::Unit::TestCase
+  def setup
+    @sign = BetaBrite.new
+  end
+
+  def test_text_and_string
+    final = 
+[
+0x00,0x00,0x00,0x00,0x00,0x01,0x5a,0x30,0x30,0x02,0x45,0x24,0x41,0x41,0x55,0x31,
+0x30,0x30,0x30,0x46,0x46,0x30,0x30,0x30,0x42,0x4c,0x30,0x30,0x34,0x30,0x30,0x30,
+0x30,0x30,0x31,0x42,0x4c,0x30,0x30,0x34,0x30,0x30,0x30,0x30,0x30,0x32,0x42,0x4c,
+0x30,0x30,0x34,0x30,0x30,0x30,0x30,0x30,0x33,0x42,0x4c,0x30,0x30,0x34,0x30,0x30,
+0x30,0x30,0x30,0x34,0x42,0x4c,0x30,0x30,0x34,0x30,0x30,0x30,0x30,0x30,0x35,0x42,
+0x4c,0x30,0x30,0x34,0x30,0x30,0x30,0x30,0x30,0x36,0x42,0x4c,0x30,0x30,0x34,0x30,
+0x30,0x30,0x30,0x30,0x37,0x42,0x4c,0x30,0x30,0x34,0x30,0x30,0x30,0x30,0x30,0x38,
+0x42,0x4c,0x30,0x30,0x34,0x30,0x30,0x30,0x30,0x30,0x39,0x42,0x4c,0x30,0x30,0x34,
+0x30,0x30,0x30,0x30,0x30,0x04
+]
+    final_s = final.collect { |x| x.chr }.join
+    @sign.add BetaBrite::Memory::Text.new('A', 4096)
+
+    0.upto(9) { |i| 
+      string  = BetaBrite::Memory::String.new(i.to_s, 64)
+      @sign.add string
+    }
+
+    test_string = ''
+    @sign.allocate { |text|
+      #obj.tty.write text
+      test_string << text
+    }
+    assert_equal(final_s, test_string)
+  end
+end

data/test/tc_memory.rb

@@ -0,0 +1,71 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift File.join(File.dirname(__FILE__), "..", "test")
+
+require 'test/unit'
+require 'betabrite'
+require 'bb_override'
+
+class MemoryAllocTest < Test::Unit::TestCase
+  def setup
+    @sign = BetaBrite.new
+  end
+
+  def test_text_file
+    alloc_string = [ 0, 0, 0, 0, 0, 1, 90, 48, 48, 2, 69, 36, 65, 65, 85, 48, 49, 48, 48, 70, 70, 48, 48, 4 ]
+    string = alloc_string.collect { |x| x.chr }.join
+    mem = BetaBrite::Memory::Text.new('A', 256)
+
+    @sign.add mem
+    test_string = ''
+    @sign.allocate { |text|
+      test_string << text
+    }
+
+    assert_equal(string, test_string)
+  end
+
+  def test_string_file
+    alloc_string = [ 0, 0, 0, 0, 0, 1, 90, 48, 48, 2, 69, 36, 48, 66, 76, 48, 48, 50, 48, 48, 48, 48, 48, 4 ]
+    string = alloc_string.collect { |x| x.chr }.join
+    mem = BetaBrite::Memory::String.new('0', 32)
+
+    @sign.add mem
+    test_string = ''
+    @sign.allocate { |text|
+      test_string << text
+    }
+
+    assert_equal(string, test_string)
+  end
+
+  def test_dots_file
+    alloc_string = [ 0, 0, 0, 0, 0, 1, 90, 48, 48, 2, 69, 36, 49, 68, 85, 48, 55, 48, 55, 52, 48, 48, 48, 4 ]
+    string = alloc_string.collect { |x| x.chr }.join
+    mem = BetaBrite::Memory::Dots.new('1', 7, 7)
+
+    @sign.add mem
+    test_string = ''
+    @sign.allocate { |text|
+      test_string << text
+    }
+
+    assert_equal(string, test_string)
+  end
+
+  def test_string_text_file
+    alloc_string = [ 0, 0, 0, 0, 0, 1, 90, 48, 48, 2, 69, 36, 48, 66, 76, 48, 48, 50, 48, 48, 48, 48, 48, 65, 65, 85, 48, 49, 48, 48, 70, 70, 48, 48, 4 ]
+    string = alloc_string.collect { |x| x.chr }.join
+    mem = BetaBrite::Memory::String.new('0', 32)
+    text = BetaBrite::Memory::Text.new('A', 256)
+
+    @sign.add mem
+    @sign.add text
+
+    test_string = ''
+    @sign.allocate { |text|
+      test_string << text
+    }
+
+    assert_equal(string, test_string)
+  end
+end

data/test/tc_set_string.rb

@@ -0,0 +1,58 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift File.join(File.dirname(__FILE__), "..", "test")
+
+require 'test/unit'
+require 'betabrite'
+require 'bb_override'
+
+class MemoryAllocTest < Test::Unit::TestCase
+  def setup
+    @sign = BetaBrite.new
+  end
+
+  def test_many_mem
+    final =
+[
+0x00,0x00,0x00,0x00,0x00,0x01,0x5a,0x30,0x30,0x02,0x47,0x30,0x31,0x31,0x30,0x34,
+0x35,0x2e,0x32,0x38,0x20,0x03,0x02,0x47,0x31,0x32,0x2e,0x34,0x31,0x20,0x03,0x02,
+0x47,0x32,0x31,0x39,0x2e,0x39,0x32,0x20,0x03,0x02,0x47,0x33,0x31,0x36,0x2e,0x35,
+0x36,0x20,0x03,0x02,0x47,0x34,0x33,0x2e,0x33,0x37,0x20,0x03,0x02,0x47,0x35,0x31,
+0x36,0x2e,0x34,0x37,0x20,0x03,0x04
+]
+    final_s = final.collect { |x| x.chr }.join
+    [ 
+      '11045.28 ',
+      '2.41 ',
+      '19.92 ',
+      '16.56 ',
+      '3.37 ',
+      '16.47 '
+    ].each_with_index do |price,idx|
+      @sign.add_stringfile BetaBrite::StringFile.new(idx, price)
+    end
+
+    assert_equal('11045.28 ', @sign.string_files[0].message)
+    assert_equal(0, @sign.string_files[0].label)
+    assert_equal('2.41 ', @sign.string_files[1].message)
+    assert_equal(1, @sign.string_files[1].label)
+    assert_equal('19.92 ', @sign.string_files[2].message)
+    assert_equal(2, @sign.string_files[2].label)
+    assert_equal('16.56 ', @sign.string_files[3].message)
+    assert_equal(3, @sign.string_files[3].label)
+    assert_equal('3.37 ', @sign.string_files[4].message)
+    assert_equal(4, @sign.string_files[4].label)
+    assert_equal('16.47 ', @sign.string_files[5].message)
+    assert_equal(5, @sign.string_files[5].label)
+
+    assert_equal(6, @sign.string_files.length)
+    assert_equal(0, @sign.text_files.length)
+    assert_equal(0, @sign.dots_files.length)
+
+    printed = ''
+    count = 0
+    @sign.write { |text|
+      printed << text
+    }
+    assert_equal(final_s, printed)
+  end
+end

data/test/ts_bb.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+require 'tc_many_mem.rb'
+require 'tc_memory.rb'
+require 'tc_set_string.rb'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: betabrite
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-07-09 00:00:00 -07:00
+summary: Provides a Ruby interface to BetaBrite LED signs
+require_paths: 
+  - lib
+email: aaronp@rubyforge.org
+homepage: betabrite.rubyforge.org
+rubyforge_project: betabrite
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+  - Aaron Patterson
+files: 
+  - test/bb_override.rb
+  - test/tc_many_mem.rb
+  - test/tc_memory.rb
+  - test/tc_set_string.rb
+  - test/ts_bb.rb
+  - lib/bb_version.rb
+  - lib/betabrite.rb
+  - lib/files
+  - lib/memory
+  - lib/string.rb
+  - lib/files/dotsfile.rb
+  - lib/files/stringfile.rb
+  - lib/files/textfile.rb
+  - lib/memory/memory.rb
+  - README
+  - EXAMPLES
+  - CHANGELOG
+  - LICENSE
+  - NOTES
+test_files: []
+rdoc_options: 
+  - "--main"
+  - README
+  - "--title"
+  - "'BetaBrite RDoc'"
+extra_rdoc_files: 
+  - README
+  - EXAMPLES
+  - CHANGELOG
+  - LICENSE
+  - NOTES
+executables: []
+extensions: []
+requirements: []
+dependencies: []