alphasign 0.1.2 → 0.2.0

data/ACKNOWLEDGEMENTS

@@ -0,0 +1,8 @@
+
+Major props to Walt wls@wls.wwco.com for hunting down and hosting the ALpha
+Signs protocol documentation at
+http://wls.wwco.com/ledsigns/alpha/led97088061.html
+
+Thanks also got to Sean Reifschneider who's python code I started
+hacking from ftp://ftp.tummy.com/pub/tummy/betabritelinux/ though
+almost none of that is left so all tahnks to him all blame to me...

data/CHANGELOG

@@ -0,0 +1,16 @@
+* 0.2.0 (pre)
+  write method now takes STRING and HASH of options (this is
+        incompatible with older positional args)
+  move constants into modules
+  add many formatting constants
+  expose rawwrite method for testing (this will not stay)
+  improve code coments
+  add Acknowledgements
+  add link to protocol spec in README
+* 0.1.2
+  fix StartCMD by splitting out file label which is different and variable
+  add some formatting constants
+* 0.1.1
+  add trivial example code to README
+* 0.1.0
+  write textfile to sign over rs232 works

data/README.rdoc

@@ -17,7 +17,8 @@ to work.
 
 
 == Contributing to alphasign
- 
+
+* Protocol specification can be found at http://wls.wwco.com/ledsigns/alpha/led97088061.html (complete with sample code in BASIC), this is a good place to start reading 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/alphasign.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{alphasign}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jon Proulx"]
-  s.date = %q{2012-03-05}
+  s.date = %q{2012-03-10}
   s.description = %q{Alphasign is handles communication with LED signs using the Alpha Sign Protocol. 
 These include Alpha signs  and  Betabrite signs by Adaptive Micro Systems, maybe 
 others too, YMMV. 
@@ -23,6 +23,8 @@ Initial release only handles writing text to the sign over rs232 serial port.
   ]
   s.files = [
     ".document",
+    "ACKNOWLEDGEMENTS",
+    "CHANGELOG",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
@@ -30,6 +32,8 @@ Initial release only handles writing text to the sign over rs232 serial port.
     "VERSION",
     "alphasign.gemspec",
     "lib/alphasign.rb",
+    "lib/alphasign/format.rb",
+    "lib/alphasign/protocol.rb",
     "test/helper.rb",
     "test/test_alphasign.rb"
   ]

data/lib/alphasign.rb

@@ -1,93 +1,13 @@
 class AlphaSign
   # Require 'serialport' gem 
   require 'serialport'
-  
-  #We have a relatively large number of potocol constants
 
-  ###Serial config
-  Baud=9600
-  DataBits=7
-  Parity=SerialPort::EVEN
-  StopBits=2
-  ###
+  #We have a relatively large number of potocol and formatting constants
+  require 'alphasign/protocol'
+  require 'alphasign/format'
+  include AlphaSign::Protocol
+  include AlphaSign::Format
 
-  #this was much more complex in original, but due to packing spec
-  #effectively reduced to this, and remains voodoo but apparently
-  #necessary voodoo
-  Preamble = [ ']', ']'].pack('x10ax10a')
-  # everything starts with this, nulls are to auto set baud on unit
-  StartHeader = Preamble + [ 0x01 ].pack('x20C')
-  # only handlers for :wtxt implemented so far
-  StartCMD = {
-    :wtxt => [ 0x02, 'A' ].pack('CA'), # write text file
-    :rtxt => [ 0x02, 'B' ].pack('CA'), # read text file
-    :wfctn => [ 0x02, 'E' ].pack('CA'), # write special function
-    :rfctn => [ 0x02, 'F' ].pack('CA'), # read special function
-    :wstr => [ 0x02, 'G' ].pack('CA'), # write string file
-    :rstr => [ 0x02, 'H' ].pack('CA'), # read string file
-    :wdots => [ 0x02, 'I' ].pack('CA'), # write DOTS picture file
-    :rdots => [ 0x02, 'J' ].pack('CA'), # read DOTS picture file
-    :wadots => [ 0x02, 'M' ].pack('CA'), # write ALPHAVISON DOTS picture file
-    :radots => [ 0x02, 'N' ].pack('CA'), # read ALPHAVISON DOTS picture file
-    :bulletin => [ 0x02, 'O' ].pack('CA'), # write bulletin message
-  } 
-  
-  # Marker for start of mode config
-  StartMode = [ 0x1b ].pack('C')
-
-  # Vertical Position
-  Position = {
-    :middle => [ 0x20 ].pack('C'),
-    :top => [ 0x22 ].pack('C'),
-    :bottom => [ 0x26 ].pack('C'),
-    :fill => [ 0x30 ].pack('C'),
-  }
-  # Mode Code, names taken form documentation
-  # since these are ascii probably don't need packing?
-  Mode = {
-    :rotate => ["a"].pack('A'), #scroll right to left
-    :hold => ["b"].pack('A'), # stationary
-    :flash => ["c"].pack('A'), #"flash"
-    # these are all transitions from previous message:
-    :rollup => ["e"].pack('A'),
-    :rolldown => ["f"].pack('A'),
-    :rollleft => ["g"].pack('A'),
-    :rollright => ["h"].pack('A'),
-    :wipeup => ["i"].pack('A'),
-    :wipedown => ["j"].pack('A'),
-  }
-
-  Footer = [0x04].pack("C") # EOT end of transmission
-  
-  # standard color codes, limited by hardware
-  Color = {
-    :red => [0x1c,0x31].pack("C2"),
-    :green => [0x1c,0x32].pack("C2"),
-    :amber => [0x1c,0x33].pack("C2"),
-    :dimred => [0x1c,0x34].pack("C2"),
-    :dimgreen => [0x1c,0x35].pack("C2"),
-    :brown => [0x1c,0x36].pack("C2"),
-    :orange => [0x1c,0x37].pack("C2"),
-    :yellow => [0x1c,0x38].pack("C2"),
-    :rainbow1 => [0x1c,0x39].pack("C2"),
-    :rainbow2 => [0x1c,0x41].pack("C2"),
-    :mix => [0x1c,0x42].pack("C2"),
-    :auto => [0x1c,0x43].pack("C2"),
-  }
-
-  # Character sets height & style
-  CharSet = {
-    :std5 => [0x1a,0x31].pack("C2"),
-    :std7 => [0x1a,0x33].pack("C2"),
-    :fancy7 => [0x1a,0x35].pack("C2"),
-    :std10 => [0x1a,0x36].pack("C2"),
-    :fullfancy => [0x1a,0x38].pack("C2"),
-    :fullstd => [0x1a,0x39].pack("C2"),
-  }
-
-  # speeds from slow to fast
-  Speed = [ [0x15].pack("C"), [0x16].pack("C"), [0x17].pack("C"),
-            [0x18].pack("C"), [0x19].pack("C") ]
 
   # @param [String] device the serial device the sign is connected to
   # for now we only speak rs232
@@ -103,14 +23,31 @@ class AlphaSign
   end
 
   # we don't have an open yet so this still kludgey and enfoces using
-  # only :wtxt command as thats the only one we know we can do
-   def  write (msg, position=:middle, mode=:hold)
-     @fileLabel = [ 0x41 ].pack("C") # any value from 0x20 to 0x75
-                                     # except 0x30 which is reserved
-                                     # for "Priority Text" file
-                                     # according to docs
-     @alphaFormat = StartMode + Position[position] + Mode[mode]
-     @alphaHeader =  StartHeader + @addr +  StartCMD[:wtxt] + @fileLabel + @alphaFormat
+  # only :wtxt command as thats the only one we know we can do @param
+  # @param [STRING] msg the message (text file in Alpha parlance) @see AlphaSign::Format
+  # for control characters for color, font, etc.
+  # @param [HASH] opts the write options
+  # @option opts [Symbol] :position display position @see AlphaSign::Format::Position 
+  # @options opts [Symbol] :mode display mode @see AlphaSign::Format::Mode
+  # @options opts [Integer] or [Nil] :fileLabel file label to write to
+  # or  nil (for comand modes that don't use it) any value from 0x20
+  # to 0x75 except 0x30 which is reserved
+  def  write (msg, opts={ })
+    opts[:position]=:middle unless opts[:position] # default to middle position
+    opts[:mode]=:hold unless opts[:mode] #default to static display
+    opts[:fileLabel] =  0x41 unless opts[:fileLabel] #this was default in exampelso why not..
+
+    raise ArgumentError.new("unkown position #{opts[:position]}") unless Position.has_key?(opts[:position])
+    raise ArgumentError.new("unkown mode #{opts[:mode]}") unless Mode.has_key?(opts[:mode])
+    raise ArgumentError.new("invalid File Label specification") unless (opts[:fileLabel] == nil) or  ((opts[:fileLabel].kind_of? Integer) and ( opts[:fileLabel] >= 0x20 and opts[:fileLabel] <= 0x75 and opts[:fileLabel] != 0x30))
+    if opts[:fileLabel] == nil
+      @filelabel=""
+    else
+      @filelabel=[opts[:fileLabel]].pack("C")
+    end
+
+     @alphaFormat = StartMode + Position[opts[:position]] + Mode[opts[:mode]]
+     @alphaHeader =  StartHeader + @addr +  StartCMD[:wtxt] + @filelabel + @alphaFormat
      sp=SerialPort.new(@device,  
                      Baud,  DataBits,  StopBits,  Parity)
      sp.write @alphaHeader
@@ -119,6 +56,11 @@ class AlphaSign
      sp.close
    end
 
-
-
+#raw serial port for testing this will go away (or atleast become private)
+  def rawwrite (msg)
+    sp=SerialPort.new(@device,                                                             
+                      Baud,  DataBits,  StopBits,  Parity) 
+    sp.write msg
+    sp.close
+  end
 end

data/lib/alphasign/format.rb

@@ -0,0 +1,110 @@
+# Constants for format codes users may want to include
+# @see AlphaSign::Protocol for protocol constants
+module AlphaSign::Format
+  # Marker for start of mode config
+  StartMode = [ 0x1b ].pack('C')
+  # Vertical Position
+  Position = {
+    :middle => [ 0x20 ].pack('C'),
+    :top => [ 0x22 ].pack('C'),
+    :bottom => [ 0x26 ].pack('C'),
+    :fill => [ 0x30 ].pack('C'),
+  }
+  # Mode Code, names taken form documentation
+  Mode = {
+    :rotate => "a", #scroll right to left
+    :hold => "b", # stationary
+    :flash => "c", #"flash"
+    # these are all transitions from previous message:
+    :rollup => "e",
+    :rolldown => "f",
+    :rollleft => "g",
+    :rollright => "h",
+    :wipeup => "i",
+    :wipedown => "j",
+    :wipeleft => "k",
+    :wiperight => "l",
+    :scroll => "m", # push bottom line to top (2line units only)
+    :auto => "o", 
+    :rollin => "p",
+    :rollout => "q",
+    :wipein => "r",
+    :wipeout => "s",
+    :compressed_rotate => "t", 
+    # only certain (unspecified) models
+    # special modes, note these are ascii "n" and ascii digits so "1"
+    # is 0x31 not not 0x01 
+    :twinkle => "n0", 
+    :sparkle => "n1",
+    :snow => "n2",
+    :interlock => "n3",
+    :switch => "n4",
+    :slide => "n5",
+    :spray => "n6",
+    :starburst => "n7",
+    # @note special graphics are not display modes, though they are in
+    # the same manual seciton and transmision frame placement.  If
+    # ASCII message data is to b edisplayed following a special
+    # graphic, another mode field is required other wise the message
+    # will appear in "automode"
+    :script_welcome => "n8",
+    :slot_machine => "n9",
+    :script_thx => "nS",
+    :no_smoking => "nU",
+    :dont_drink_drive => "nV",
+    :running_animal => "nW",
+    :fireworks => "nX",
+    :turbo_car => "nY",
+    :cherry_bomb => "nZ",
+  }
+  
+  # standard color codes, limited by hardware
+  Color = {
+    :red => [0x1c,0x31].pack("C2"),
+    :green => [0x1c,0x32].pack("C2"),
+    :amber => [0x1c,0x33].pack("C2"),
+    :dimred => [0x1c,0x34].pack("C2"),
+    :dimgreen => [0x1c,0x35].pack("C2"),
+    :brown => [0x1c,0x36].pack("C2"),
+    :orange => [0x1c,0x37].pack("C2"),
+    :yellow => [0x1c,0x38].pack("C2"),
+    :rainbow1 => [0x1c,0x39].pack("C2"),
+    :rainbow2 => [0x1c,0x41].pack("C2"),
+    :mix => [0x1c,0x42].pack("C2"),
+    :auto => [0x1c,0x43].pack("C2"),
+  }
+  
+  # Character sets height & style
+  CharSet = {
+    :std5 => [0x1a,0x31].pack("C2"),
+    :std7 => [0x1a,0x33].pack("C2"),
+    :fancy7 => [0x1a,0x35].pack("C2"),
+    :std10 => [0x1a,0x36].pack("C2"),
+    :fullfancy => [0x1a,0x38].pack("C2"),
+    :fullstd => [0x1a,0x39].pack("C2"),
+  }
+  
+  # speeds from slow to fast
+  Speed = [ [0x15].pack("C"), [0x16].pack("C"), [0x17].pack("C"),
+            [0x18].pack("C"), [0x19].pack("C") ]
+
+  #Control Codes (for insertion in text file data)
+  DoubleHighOn = [0x05,0x31].pack("C2") # not supported on all units
+  DoubleHighOff= [0x05,0x30].pack("C2") # default
+  TrueDecendersOn = [0x06,0x31].pack("C2") # not supported on all units
+  TrueDecendersOff= [0x06,0x30].pack("C2") # default
+  FlashCharOn = [0x07,0x31].pack("C2") # not supported on all units
+  FlashCharOff= [0x07,0x30].pack("C2") # default
+
+  Extended=[0x08].pack("C") # access extended ascci of following char for example Extended + "I" would put a degree symbol on the display, see docs
+
+  TempF=[0x08,0x1C].pack("C2") #only available on incandescent message centers
+  TempC=[0x08,0x1D].pack("C2") #only available on incandescent message centers
+  Count1=[0x08,0x7A].pack("C2") #display current value of counter 1
+  Count2=[0x08,0x7B].pack("C2") #display current value of counter 2
+  Count3=[0x08,0x7C].pack("C2") #display current value of counter 3
+  Count4=[0x08,0x7D].pack("C2") #display current value of counter 4
+  Count5=[0x08,0x7E].pack("C2") #display current value of counter 5
+
+  
+end

data/lib/alphasign/protocol.rb

@@ -0,0 +1,36 @@
+# These are a pile of constants for the protocol functions
+# @see AlphaSign::Format for constants users may want to interact with
+module AlphaSign::Protocol
+  
+  ###Serial config
+  Baud=9600
+  DataBits=7
+  Parity=SerialPort::EVEN
+  StopBits=2
+  ###
+
+  #this was much more complex in original, but due to packing spec
+  #effectively reduced to this, and remains voodoo but apparently
+  #necessary voodoo
+  Preamble = [ ']', ']'].pack('x10ax10a')
+  # everything starts with this, nulls are to auto set baud on unit
+  StartHeader = Preamble + [ 0x01 ].pack('x20C')
+
+  # only handlers for :wtxt implemented so far
+  StartCMD = {
+    :wtxt => [ 0x02, 'A' ].pack('CA'), # write text file
+    :rtxt => [ 0x02, 'B' ].pack('CA'), # read text file
+    :wfctn => [ 0x02, 'E' ].pack('CA'), # write special function
+    :rfctn => [ 0x02, 'F' ].pack('CA'), # read special function
+    :wstr => [ 0x02, 'G' ].pack('CA'), # write string file
+    :rstr => [ 0x02, 'H' ].pack('CA'), # read string file
+    :wdots => [ 0x02, 'I' ].pack('CA'), # write DOTS picture file
+    :rdots => [ 0x02, 'J' ].pack('CA'), # read DOTS picture file
+    :wadots => [ 0x02, 'M' ].pack('CA'), # write ALPHAVISON DOTS picture file
+    :radots => [ 0x02, 'N' ].pack('CA'), # read ALPHAVISON DOTS picture file
+    :bulletin => [ 0x02, 'O' ].pack('CA'), # write bulletin message
+  } 
+  
+  Footer = [0x04].pack("C") # EOT end of transmission
+  
+end

data/test/test_alphasign.rb

@@ -1,7 +1,38 @@
 require 'helper'
 
 class TestAlphasign < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  def setup
+    @sign=AlphaSign.new()
+    @notsign=AlphaSign.new('/dev/null')
+  end
+
+  def test_simple_write
+    assert_nil( @sign.write("foo" )) # this test *will* fail if you don't have serialport on /dev/ttyS0 
+    exception=assert_raise(ArgumentError) { @notsign.write("foo" ) }
+    assert_equal("not a serial port",exception.message)
+  end
+
+  def test_write_modes
+    AlphaSign::Mode.keys.each do |mode|
+      assert_nil(@sign.write("foo", :mode => mode.to_sym))
+    end
+  end
+
+  def test_write_positions
+    AlphaSign::Position.keys.each do |pos|
+      assert_nil(@sign.write("foo", :position => pos.to_sym))
+    end
+  end
+
+  def test_write_to_file_label
+    assert_nil(@sign.write("foo", :fileLabel=>nil))
+    assert_nil(@sign.write("foo", :fileLabel=>0x20))
+    assert_nil(@sign.write("foo", :fileLabel=>0x29))
+    assert_nil(@sign.write("foo", :fileLabel=>0x31))
+    assert_nil(@sign.write("foo", :fileLabel=>0x75))
+    assert_raise(ArgumentError) {@sign.write("foo", :fileLabel=>"foo")}
+    assert_raise(ArgumentError) {@sign.write("foo", :fileLabel=>0x19)}
+    assert_raise(ArgumentError) {@sign.write("foo", :fileLabel=>0x30)}
+    assert_raise(ArgumentError) {@sign.write("foo", :fileLabel=>0x76)}
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: alphasign
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jon Proulx
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-05 00:00:00 -05:00
+date: 2012-03-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -125,6 +125,8 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- ACKNOWLEDGEMENTS
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -132,6 +134,8 @@ files:
 - VERSION
 - alphasign.gemspec
 - lib/alphasign.rb
+- lib/alphasign/format.rb
+- lib/alphasign/protocol.rb
 - test/helper.rb
 - test/test_alphasign.rb
 has_rdoc: true