Class: MovingsignApi::DisplayMode

Inherits:
Object
  • Object
show all
Includes:
PrettyKeyable
Defined in:
lib/movingsign_api/commands/internal/display_mode.rb

Overview

Text display mode setting.

Display Mode Constants collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mode) ⇒ DisplayMode

Returns a new instance of DisplayMode.



49
50
51
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 49

def initialize(mode)
  @key = mode
end

Instance Attribute Details

#auto ⇒ Symbol (readonly)

Display mode auto (protocol display mode ‘A’)

Returns:

  • (Symbol) —

    :auto



18
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 18

display_mode :auto, 'A'

#clock ⇒ Symbol (readonly)

Display mode clock (protocol display mode ‘Z’)

Returns:

  • (Symbol) —

    :clock



43
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 43

display_mode :clock, 'Z'

#cyclecolor ⇒ Symbol (readonly)

Display mode cyclecolor (protocol display mode ‘Y’)

Returns:

  • (Symbol) —

    :cyclecolor



42
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 42

display_mode :cyclecolor, 'Y'

#flash ⇒ Symbol (readonly)

Display mode flash (protocol display mode ‘B’)

Returns:

  • (Symbol) —

    :flash



19
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 19

display_mode :flash, 'B'

#hold ⇒ Symbol (readonly)

Display mode hold (protocol display mode ‘C’)

Returns:

  • (Symbol) —

    :hold



20
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 20

display_mode :hold, 'C'

#interlock ⇒ Symbol (readonly)

Display mode interlock (protocol display mode ‘D’)

Returns:

  • (Symbol) —

    :interlock



21
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 21

display_mode :interlock, 'D'

#key ⇒ Symbol

Returns display mode constant (see attributes #auto, #flash, #hold, etc.).

Returns:

  • (Symbol) —

    display mode constant (see attributes #auto, #flash, #hold, etc.)



47
48
49
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 47

def key
  @key
end

#rolldown ⇒ Symbol (readonly)

Display mode rolldown (protocol display mode ‘E’)

Returns:

  • (Symbol) —

    :rolldown



22
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 22

display_mode :rolldown, 'E'

#rollin ⇒ Symbol (readonly)

Display mode rollin (protocol display mode ‘G’)

Returns:

  • (Symbol) —

    :rollin



24
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 24

display_mode :rollin, 'G'

#rollleft ⇒ Symbol (readonly)

Display mode rollleft (protocol display mode ‘I’)

Returns:

  • (Symbol) —

    :rollleft



26
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 26

display_mode :rollleft, 'I'

#rollout ⇒ Symbol (readonly)

Display mode rollout (protocol display mode ‘H’)

Returns:

  • (Symbol) —

    :rollout



25
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 25

display_mode :rollout, 'H'

#rollright ⇒ Symbol (readonly)

Display mode rollright (protocol display mode ‘J’)

Returns:

  • (Symbol) —

    :rollright



27
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 27

display_mode :rollright, 'J'

#rollup ⇒ Symbol (readonly)

Display mode rollup (protocol display mode ‘F’)

Returns:

  • (Symbol) —

    :rollup



23
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 23

display_mode :rollup, 'F'

#rotate ⇒ Symbol (readonly)

Display mode rotate (protocol display mode ‘K’)

Returns:

  • (Symbol) —

    :rotate



28
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 28

display_mode :rotate, 'K'

#slide ⇒ Symbol (readonly)

Display mode slide (protocol display mode ‘L’)

Returns:

  • (Symbol) —

    :slide



29
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 29

display_mode :slide, 'L'

#snow ⇒ Symbol (readonly)

Display mode snow (protocol display mode ‘M’)

Returns:

  • (Symbol) —

    :snow



30
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 30

display_mode :snow, 'M'

#sparkle ⇒ Symbol (readonly)

Display mode sparkle (protocol display mode ‘N’)

Returns:

  • (Symbol) —

    :sparkle



31
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 31

display_mode :sparkle, 'N'

#spray ⇒ Symbol (readonly)

Display mode spray (protocol display mode ‘O’)

Returns:

  • (Symbol) —

    :spray



32
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 32

display_mode :spray, 'O'

#starburst ⇒ Symbol (readonly)

Display mode starburst (protocol display mode ‘P’)

Returns:

  • (Symbol) —

    :starburst



33
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 33

display_mode :starburst, 'P'

#switch ⇒ Symbol (readonly)

Display mode switch (protocol display mode ‘Q’)

Returns:

  • (Symbol) —

    :switch



34
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 34

display_mode :switch, 'Q'

#twinkle ⇒ Symbol (readonly)

Display mode twinkle (protocol display mode ‘R’)

Returns:

  • (Symbol) —

    :twinkle



35
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 35

display_mode :twinkle, 'R'

#wipedown ⇒ Symbol (readonly)

Display mode wipedown (protocol display mode ‘S’)

Returns:

  • (Symbol) —

    :wipedown



36
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 36

display_mode :wipedown, 'S'

#wipein ⇒ Symbol (readonly)

Display mode wipein (protocol display mode ‘U’)

Returns:

  • (Symbol) —

    :wipein



38
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 38

display_mode :wipein, 'U'

#wipeleft ⇒ Symbol (readonly)

Display mode wipeleft (protocol display mode ‘W’)

Returns:

  • (Symbol) —

    :wipeleft



40
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 40

display_mode :wipeleft, 'W'

#wipeout ⇒ Symbol (readonly)

Display mode wipeout (protocol display mode ‘V’)

Returns:

  • (Symbol) —

    :wipeout



39
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 39

display_mode :wipeout, 'V'

#wiperight ⇒ Symbol (readonly)

Display mode wiperight (protocol display mode ‘X’)

Returns:

  • (Symbol) —

    :wiperight



41
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 41

display_mode :wiperight, 'X'

#wipeup ⇒ Symbol (readonly)

Display mode wipeup (protocol display mode ‘T’)

Returns:

  • (Symbol) —

    :wipeup



37
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 37

display_mode :wipeup, 'T'

Class Method Details

.parse(input) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/movingsign_api/commands/internal/display_mode.rb', line 53

def self.parse(input)
  if key = parse_to_key(input)
    self.new key
  else
    raise InvalidInputError, "Display mode '#{input}' is not valid."
  end
end