class AlphaSign - alphasign-0.3.1 Documentation

Public Class Methods

new(device = "/dev/ttyS0") click to toggle source

@param [String] device the serial device the sign is connected to for now we only speak rs232

# File lib/alphasign.rb, line 14
def  initialize (device = "/dev/ttyS0")
  @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 unit types, "00" is broadcast
  @addr = 'Z00'

  # write out initial memory config to sign
  writemem
end

Public Instance Methods

callstr(filename=:str1) click to toggle source

this returns code to insert a named string file in txt file

# File lib/alphasign.rb, line 82
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(msg, opts={ }) click to toggle source

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 [Symbol] :filename a key from @files hash for a configured :txt file

# File lib/alphasign.rb, line 50
def  write (msg, opts={ })

  # default to middle position
  opts[:position]=:middle unless opts[:position] 

  #default to static display
  opts[:mode]=:hold unless opts[:mode] 

  # 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

writestr(msg,filename=:str1) click to toggle source

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

# File lib/alphasign.rb, line 76
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

Private Instance Methods

rawwrite(msg) click to toggle source

the most generic write function

# File lib/alphasign.rb, line 114
def rawwrite (msg)
  @device.write  StartHeader + @addr + msg + Footer
end

writemem() click to toggle source

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

# File lib/alphasign.rb, line 91
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