Class: ScrollySign

Inherits:
Object
  • Object
show all
Defined in:
lib/scrollysign.rb

Defined Under Namespace

Classes: TextBuilder

Constant Summary collapse

PortClosedError = 
Class.new(StandardError)
INITIALISATION_STRING = 
"\x00" * 5
SOH = 
"\x01"
STX = 
"\x02"
EOT = 
"\x04"
ESC = 
"\x1b"
CONTROLS = 
{
  "enable_double_high_characters" => "\x051",
  "disable_double_high_characters" => "\x050",
  "enable_true_descenders" => "\x061",
  "disable_true_descenders" => "\x060",
  "enable_character_flash" => "\x071",
  "disable_character_flash" => "\x070",
  "no_hold_speed" => "\x09",
  "new_line" => "\x0d",
  "call_date_mm/dd/yy" => "\x0b0",
  "call_date_dd/mm/yy" => "\x0b1",
  "call_date_mm-dd-yy" => "\x0b2",
  "call_date_dd-mm-yy" => "\x0b3",
  "call_date_mm.dd.yy" => "\x0b4",
  "call_date_dd.mm.yy" => "\x0b5",
  "call_date_mm dd yy" => "\x0b6",
  "call_date_dd mm yy" => "\x0b7",
  "call_date_mmm.dd, yyyy" => "\x0b8",
  "call_date_day_of_week" => "\x0b9",
  "new_page" => "\x0c",
  "new_line" => "\x0d",
  "call_string" => "\x10", # follow by label of string file
  "disable_wide_characters" => "\x11",
  "enable_wide_characters" => "\x12",
  "call_time" => "\x13",
  "call_small_dots_picture" => "\x14", # follow by label of dots picture
  "speed_1" => "\x15", # slowest
  "speed_2" => "\x16",
  "speed_3" => "\x17",
  "speed_4" => "\x18",
  "speed_5" => "\x19",
  "select_character_set" => "\x20", # follow by character set specifier

  "red" => "\x1c1",
  "green" => "\x1c2",
  "amber" => "\x1c3",
  "dim_red" => "\x1c4",
  "dim_green" => "\x1c5",
  "brown" => "\x1c6",
  "orange" => "\x1c7",
  "yellow" => "\x1c8",
  "rainbow_1" => "\x1c9",
  "rainbow_2" => "\x1cA",
  "color_mix" => "\x1cB",
  "autocolor" => "\x1cC",
  "rgb" => "\x1cZ", # alpha 3.0 only: follow by RRGGBB

  "proportional_characters" => "\x1e0",
  "fixed_width_characters" => "\x1e1"
}
COMMANDS = 
{
  "write_text_file" => "A",
  "write_string_file" => "G"
}
MODES = 
{
  "rotate" => 'a',
  "hold" => 'b',
  "flash" => 'c',
  "roll_up" => 'e',
  "roll_down" => 'f',
  "roll_left" => 'g',
  "roll_right" => 'h',
  "wipe_up" => 'i',
  "wipe_down" => 'j',
  "wipe_left" => 'k',
  "wipe_right" => 'l',
  "scroll" => 'm',
  "automode" => 'o',
  "roll_in" => 'p',
  "roll_out" => 'q',
  "wipe_in" => 'r',
  "wipe_out" => 's',
  "compressed_rotate" => 't', # some models only
  "explode" => 'u', # alpha 3.0 only
  "clock" => 'v', # alpha 3.0 only

  "special_twinkle" => 'n0',
  "special_sparkle" => 'n1',
  "special_snow" => 'n2',
  "special_interlock" => 'n3',
  "special_switch" => 'n4',
  "special_slide" => 'n5',
  "special_circle_colors" => 'n5',
  "special_spray" => 'n6',
  "special_starburst" => 'n7',
  "special_welcome" => 'n8',
  "special_slot_machine" => 'n9',
  "special_news_flash" => 'nA', # Betabrite 1036 only
  "special_trumpet_animation" => 'nB', # Betabrite 1036 only
  "special_cycle_colors" => 'nC' # AlphaEclipse 3600 only
}
DISPLAY_POSITIONS = 
{
  "middle_line" => ' ',
  "top_line" => '"',
  "bottom_line" => '&',
  "fill" => '0',
  "left" => '1',
  "right" => '2'
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(port, baud_rate = 9600) ⇒ ScrollySign

Returns a new instance of ScrollySign.



138
139
140
141
142
143
 
# File 'lib/scrollysign.rb', line 138

def initialize(port, baud_rate = 9600)
  @type_code = "Z" # all types of sign
  @sign_address = "00" # all signs

  @port = SerialPort.new(port, baud_rate)
end

Instance Attribute Details

#port ⇒ Object (readonly)

Returns the value of attribute port.



135
136
137
 
# File 'lib/scrollysign.rb', line 135

def port
  @port
end

#sign_address ⇒ Object

Returns the value of attribute sign_address.



136
137
138
 
# File 'lib/scrollysign.rb', line 136

def sign_address
  @sign_address
end

#type_code ⇒ Object

Returns the value of attribute type_code.



136
137
138
 
# File 'lib/scrollysign.rb', line 136

def type_code
  @type_code
end

Class Method Details

.open(port, baud_rate = 9600) ⇒ Object 



145
146
147
148
149
150
151
152
 
# File 'lib/scrollysign.rb', line 145

def self.open(port, baud_rate = 9600)
  sign = new(port, baud_rate)
  begin
    yield sign
  ensure
    sign.close
  end
end

Instance Method Details

#build_text(&block) ⇒ Object 



163
164
165
166
167
168
169
170
171
 
# File 'lib/scrollysign.rb', line 163

def build_text(&block)
  builder = TextBuilder.new
  if block.arity != 1
    builder.instance_eval(&block)
  else
    yield builder
  end
  builder.to_s
end

#c(name) ⇒ Object 



159
160
161
 
# File 'lib/scrollysign.rb', line 159

def c(name)
  CONTROLS.fetch(name)
end

#close ⇒ Object 



154
155
156
157
 
# File 'lib/scrollysign.rb', line 154

def close
  @port.close
  @port = nil
end

#write_raw(command, data) ⇒ Object

Raises:



187
188
189
190
191
192
193
 
# File 'lib/scrollysign.rb', line 187

def write_raw(command, data)
  raise PortClosedError, "port is closed" unless port

  command_code = COMMANDS.fetch(command)

  @port.write "#{INITIALISATION_STRING}#{SOH}#{@type_code}#{@sign_address}#{STX}#{command_code}#{data}#{EOT}"
end

#write_string(text, file_label) ⇒ Object 



183
184
185
 
# File 'lib/scrollysign.rb', line 183

def write_string(text, file_label)
  write_raw('write_string_file', "#{file_label}#{text}")
end

#write_text(text, file_label = "A", mode = nil, display_position = nil) ⇒ Object 



173
174
175
176
177
178
179
180
181
 
# File 'lib/scrollysign.rb', line 173

def write_text(text, file_label = "A", mode = nil, display_position = nil)
  data = if mode
    "#{file_label}#{ESC}#{DISPLAY_POSITIONS.fetch((display_position || 'fill').to_s)}#{MODES.fetch(mode.to_s)}#{text}"
  else
    "#{file_label}#{text}"
  end

  write_raw('write_text_file', data)
end