alphasign 0.2.0 → 0.3.1

data/CHANGELOG

@@ -1,4 +1,8 @@
-* 0.2.0 (pre)
+* 0.3.0
+  Implement fixed set of memory files
+  Implement string file write and call
+  Add examples/alphaclock.rb usage example
+* 0.2.0 
   write method now takes STRING and HASH of options (this is
         incompatible with older positional args)
   move constants into modules

data/Rakefile

@@ -19,11 +19,14 @@ Jeweler::Tasks.new do |gem|
   gem.license = "MIT"
   gem.summary = "A gem for communicating with LED signs using Alpha Sign Protocol "
   gem.description = <<-EOF
-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. 
-
-Initial release only handles writing text to the sign over rs232 serial port.  
+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.
+
+This release handles writing "text files" and "string" files to the
+sign over rs232 serial port, using a fixed memory configuration.  Upcoming
+releases will add "dots picture" files and memory user accesable memory 
+file configuration.
 EOF
   gem.email = "jon@jonproulx.com"
   gem.authors = ["Jon Proulx"]

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/alphasign.gemspec

@@ -5,16 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{alphasign}
-  s.version = "0.2.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jon Proulx"]
   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. 
+  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.
 
-Initial release only handles writing text to the sign over rs232 serial port.  
+This release handles writing "text files" and "string" files to the
+sign over rs232 serial port, using a fixed memory configuration.  Upcoming
+releases will add "dots picture" files and memory user accesable memory 
+file configuration.
 }
   s.email = %q{jon@jonproulx.com}
   s.extra_rdoc_files = [
@@ -31,6 +34,7 @@ Initial release only handles writing text to the sign over rs232 serial port.
     "Rakefile",
     "VERSION",
     "alphasign.gemspec",
+    "examples/alphaclock.rb",
     "lib/alphasign.rb",
     "lib/alphasign/format.rb",
     "lib/alphasign/protocol.rb",

data/examples/alphaclock.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby 
+#
+# This program display a clock on your alpha sign
+#
+# It uses a "String" file to hold the formatted time.  String files
+# use buffered writes so the display doesn't blank like it does when
+# writing "text" files, but they are limited to 125 bytes each max
+#
+# File types need to be set in memory before they can used, both their
+# type and size. For simplicity we use the default memory setup
+# provided by AlphaSign.new :default is a text file of 256 bytes max
+# and :str2 is a string file of 80 bytes max
+require 'rubygems'
+require 'alphasign'
+
+# use second of the two default string files
+stringfile=:str2
+sign=AlphaSign.new
+#seconds to sleep before refresh (signs can only handle updates every
+#2 sec or so)
+interval=5
+
+# write our message to the default text file
+#
+# setting color, fixed text, and call our variable string file
+sign.write(AlphaSign::Color[:amber] + 
+           "the time is " + sign.callstr(stringfile))
+
+#update stringfile every interval seconds
+while 1 
+  time = Time.new
+  # put time in our stringfile
+  # use fixed width so line doesn't squirm around when digits change
+  # this does force left justification rather than center
+  # set color, then write time
+  sign.writestr(AlphaSign::FixWidth + AlphaSign::Color[:green] + 
+                time.strftime("%I:%M:%S %p"),stringfile)
+  sleep interval - time.sec.modulo(interval)
+end

data/lib/alphasign.rb

@@ -12,55 +12,108 @@ class AlphaSign
   # @param [String] device the serial device the sign is connected to
   # for now we only speak rs232
   def  initialize (device = "/dev/ttyS0")
-    @device= device
+    @device=SerialPort.new(device, Baud,  DataBits,  StopBits,  Parity) 
+    @memsync=false
+    # default file setup, we should read this from the device, for now
+    # just enforce our own & hope no other process is messing with it
+    # (that's why we're 0.x.x)
+    @files={
+      # 256 byte text file always displayed
+      :default => AlphaFile.new(:txt, "A", "0100", "FF00"),
+      # 80 byte string file
+      :str1   => AlphaFile.new(:str, "B", "0050", "0000"),
+      # another string file
+      :str2   => AlphaFile.new(:str, "C", "0050", "0000"),
+      # 16 (0x10) row by 120 (0x78) column dots file in 3 colors
+      # not sure why but htat's what "2000" means in this context
+      :dot1   => AlphaFile.new(:dot, "D", "1078", "2000"),
+      # another dots file
+      :dot2   => AlphaFile.new(:dot, "E", "1078", "2000"),
+    }
 
     # Protocol allows multiple signs on the same port, we are not
     # going to expose that possibility yet but we will recognize this
-    # as an instance variable Where "Z" all units, "00" first unit or
-    # broadcast?
-    @addr = [ 'Z00' ].pack('A3')
-    
+    # as an instance variable Where "Z" all unit types, "00" is broadcast
+    @addr = 'Z00'
+
+    # write out initial memory config to sign
+    writemem
   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 @param
-  # @param [STRING] msg the message (text file in Alpha parlance) @see AlphaSign::Format
-  # for control characters for color, font, etc.
+  # This is for writing "txt" files
+  # @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
+  # @options opts [Symbol] :filename a key from @files hash for a configured :txt file
   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
+    # default to middle position
+    opts[:position]=:middle unless opts[:position] 
+
+    #default to static display
+    opts[:mode]=:hold unless opts[:mode] 
 
-     @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
-     sp.write msg
-     sp.write Footer
-     sp.close
+    # sign file to write to, carefule these need to be setup before
+    # they can be written to...
+    opts[:filename]=:default unless opts [:filename]
+    raise ArgumentError.new(":filename must be a preconfigured as a txt file in momory")unless @files[opts[:filename]].type == :txt
+    
+    @format = StartMode + Position[opts[:position]] + Mode[opts[:mode]]
+
+    rawwrite  StartCMD[:wtxt]+ @files[opts[:filename]].label + @format + msg 
    end
+  
+  # write to a string file (this must then be called from a text file
+  # for display, but string files are buffered so good for frequent
+  # updates without flashing screen like txt files do
+  # @param [STRING] msg the message string 
+  # @see AlphaSign::Format for control characters for color, font, etc.
+  # @param [Symbol] filename a key from @files hash for a configure :txt file
+  # defaults to ":str1" part of default memory config
+ 
+  def writestr (msg,filename=:str1)
+    raise ArgumentError.new("filename must be a preconfigured as a string file in momory")unless @files[filename].type == :str
+    rawwrite StartCMD[:wstr] + @files[filename].label + msg
+  end
 
-#raw serial port for testing this will go away (or atleast become private)
+  # this returns code to insert a named string file in txt file
+  def callstr (filename=:str1)
+    raise ArgumentError.new("filename must be a preconfigured as a string file in momory")unless @files[filename].type == :str
+    CallString +  @files[filename].label
+  end
+
+# write a memory config.  This is all at once can't add files even if
+# there's unassigned memory, so what ever is written overwrites
+# previous config
+  private
+  def writemem
+    #reset memorystring
+    @memorystring=StartCMD[:wfctn]+"$" # "$" is the memory function
+    locked="U"
+    # rebuld memory string from our current files hash damn this is
+    # ugly maybe I do want files to be a Class not a Struct...
+    @files.keys.each do |file|
+      if @files[file].type == :str
+        locked="L"
+      else
+        locked="U"
+      end
+      @memorystring=@memorystring + 
+        @files[file].label +
+        FileType[@files[file].type] + locked + 
+        @files[file].size_spec + @files[file].time_spec
+    end
+    rawwrite @memorystring
+    @memsync=true
+  end
+
+# the most generic write function
+  private
   def rawwrite (msg)
-    sp=SerialPort.new(@device,                                                             
-                      Baud,  DataBits,  StopBits,  Parity) 
-    sp.write msg
-    sp.close
+    @device.write  StartHeader + @addr + msg + Footer
   end
+
+
 end

data/lib/alphasign/format.rb

@@ -89,13 +89,15 @@ module AlphaSign::Format
             [0x18].pack("C"), [0x19].pack("C") ]
 
   #Control Codes (for insertion in text file data)
+  CallString = [0x10].pack("C") # call a saved string file, must be followed but filelabel for a string file...
+  CallDots = [0x14].pack("C") # call a saved Dots Picture file, must be followed but filelabel for a dots file...
   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
-
+  FixWidth=[0x1E,0x31].pack("C2") # set fixed width useful for string files
   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

data/lib/alphasign/protocol.rb

@@ -30,6 +30,25 @@ module AlphaSign::Protocol
     :radots => [ 0x02, 'N' ].pack('CA'), # read ALPHAVISON DOTS picture file
     :bulletin => [ 0x02, 'O' ].pack('CA'), # write bulletin message
   } 
+
+  # FileType is used in allocating sign memory 
+  FileType = {
+    :txt => "A", # Text file
+    :str => "B", # String file
+    :dot => "D", # Dots picture file
+  }
+
+  # @param [Synmbol] type file type must be a key of
+  # AlphaSign::Protocol::FileType 
+  # @param [String] label, file label to assign 0x20 to 0x75 (0x30 is
+  # reserver for "priority text file"
+  # @param [String] file size, 4 char uppercase ASCII hex
+  # representation
+  # @param [String] time spec, 4 char uppercase ASCII hex
+  # representation.  First two char represent start time code, second
+  # two end time code "FF00" == always, see docs for full spec, it's
+  # wierd...
+  AlphaFile=Struct.new(:type,:label,:size_spec,:time_spec)
   
   Footer = [0x04].pack("C") # EOT end of transmission
   

data/test/test_alphasign.rb

@@ -2,37 +2,49 @@ require 'helper'
 
 class TestAlphasign < Test::Unit::TestCase
   def setup
+    # this test *will* fail if you don't have serialport on /dev/ttyS0 
     @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_nothing_raised { @sign.write("foo" ) }
+    exception=assert_raise(ArgumentError) {
+      @notsign=AlphaSign.new('/dev/null') 
+    }
     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))
+    assert_nothing_raised do
+      AlphaSign::Mode.keys.each do |mode|
+        @sign.write("foo", :mode => mode.to_sym)
+      end
     end
   end
 
   def test_write_positions
-    AlphaSign::Position.keys.each do |pos|
-      assert_nil(@sign.write("foo", :position => pos.to_sym))
+    assert_nothing_raised do
+      AlphaSign::Position.keys.each do |pos|
+        @sign.write("foo", :position => pos.to_sym)
+      end
     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)}
+  def test_sting_files
+    assert_nothing_raised do
+      @sign.writestr("foo")
+      @sign.writestr("foo",:str1)
+      @sign.writestr("foo",:str2)
+      @sign.callstr
+      @sign.callstr(:str1)
+      @sign.callstr(:str2)
+    end
+    assert_raise(ArgumentError) do
+      @sign.writestr("foo",:default)
+      @sign.writestr("foo",:nonesuch)
+      @sign.callstr(:default)
+      @sign.callstr(:nonesuch)
+    end
   end
 end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: alphasign
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 0
-  version: 0.2.0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jon Proulx
@@ -109,11 +109,14 @@ dependencies:
         version: "0"
   requirement: *id006
 description: |
-  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. 
+  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.
   
-  Initial release only handles writing text to the sign over rs232 serial port.  
+  This release handles writing "text files" and "string" files to the
+  sign over rs232 serial port, using a fixed memory configuration.  Upcoming
+  releases will add "dots picture" files and memory user accesable memory 
+  file configuration.
 
 email: jon@jonproulx.com
 executables: []
@@ -133,6 +136,7 @@ files:
 - Rakefile
 - VERSION
 - alphasign.gemspec
+- examples/alphaclock.rb
 - lib/alphasign.rb
 - lib/alphasign/format.rb
 - lib/alphasign/protocol.rb