movingsign_api 0.0.1

data/lib/movingsign_api/commands/software_reset_command.rb

@@ -0,0 +1,16 @@
+require 'movingsign_api/commands/write_control_command'
+
+module MovingsignApi
+  # Performs a soft reset of the sign
+  #
+  # @note The sign will restart after receiving this command.
+  class SoftwareResetCommand < WriteControlCommand
+    def subcommand_code
+      'B'
+    end
+
+    def subcommand_payload_bytes
+      []
+    end
+  end
+end

data/lib/movingsign_api/commands/write_control_command.rb

@@ -0,0 +1,35 @@
+require 'movingsign_api/commands/command'
+
+module MovingsignApi
+  # Write control command base class, subclassed by actual implementations
+  #
+  # In subclasses, be sure to implement:
+  # - {#subcommand_code}
+  # - {#subcommand_payload_bytes}
+  class WriteControlCommand < Command
+    def command_code
+      'W'
+    end
+
+    def subcommand_code
+      raise MovingsignApi::NotImplementedError, "Needs to be implemented in subclass."
+    end
+
+    private
+
+    def command_payload_bytes
+      bytes = []
+
+      bytes.concat string_to_ascii_bytes subcommand_code
+      bytes.concat subcommand_payload_bytes
+
+      bytes
+    end
+
+    # generates control sub-command specific bytes
+    def subcommand_payload_bytes
+      raise MovingsignApi::NotImplementedError, "Needs to be implemented in subclass."
+    end
+
+  end
+end

data/lib/movingsign_api/commands/write_text_command.rb

@@ -0,0 +1,116 @@
+require 'movingsign_api/commands/command'
+require 'movingsign_api/commands/internal/file_handle'
+require 'movingsign_api/commands/internal/display_mode'
+require 'movingsign_api/commands/internal/display_speed'
+require 'movingsign_api/commands/internal/display_pause'
+require 'movingsign_api/commands/internal/align_mode'
+
+module MovingsignApi
+  # Writes text to a sign
+  class WriteTextCommand < MovingsignApi::Command
+    # Index of the file to write to.  0 - 35 (363 total). See {FileHandle}
+    #
+    # @param value [Integer] 0 - 35 (default: 0)
+    attr_accessor :file_handle
+
+    # Display mode to use.  See {DisplayMode}
+    #
+    # @param value [Sybol] (default: +:hold+)
+    attr_accessor :display_mode
+
+    # Display speed of effects. See {DisplaySpeed}
+    #
+    # @param value [Symbol] default: +:normal+
+    attr_accessor :display_speed
+
+    # Display pause between screens of information.  See {DisplayPause}
+    #
+    # @param value [Integer] default: +2+
+    attr_accessor :display_pause
+
+    # Day of week mask.  See specification for an explaination of this parameter
+    #
+    # @param value [String] default: +'7F'+
+    attr_accessor :dayofweek_mask
+
+    # Align mode to use. See {AlignMode}
+    #
+    # @param value [Symbol] One of +:left+ +:right+ +:center+ (default +:left+)
+    attr_accessor :align_mode
+
+    # Display start time
+    # @note work in progress
+    #
+    # @param value [String] default: +'0000'+
+    attr_accessor :start_time
+
+    # Display end time
+    # @note work in progress
+    #
+    # @param value [String] default: +'2359'+
+    attr_accessor :end_time
+
+    # Text to display
+    #
+    # @param value [String] the message to display
+    attr_accessor :text
+
+    def file_handle=(handle)
+      @file_handle = FileHandle.new(handle)
+    end
+
+    def display_mode=(mode)
+      @display_mode = DisplayMode.parse(mode)
+    end
+
+    def display_speed=(speed)
+      @display_speed = DisplaySpeed.parse(speed)
+    end
+
+    def display_pause=(seconds)
+      @display_pause = DisplayPause.new seconds
+    end
+
+    def align_mode=(align)
+      @align_mode = AlignMode.parse(align)
+    end
+
+    # (see Command#command_code)
+    # 'A' for the "Write Text" command
+    def command_code
+      'A'
+    end
+
+    private
+
+    def command_payload_bytes
+      # set defaults if needed
+      self.file_handle      ||= 0
+      self.display_mode     ||= :hold
+      self.display_speed    ||= :normal
+      self.display_pause    ||= 2
+      self.dayofweek_mask   ||= '7F'
+      self.align_mode       ||= :left
+      self.start_time       ||= '0000'
+      self.end_time         ||= '2359'
+      raise InvalidInputError, "text not set" unless self.text
+
+      bytes = []
+
+      bytes.concat self.file_handle.to_bytes     # Filename
+      bytes.concat self.display_mode.to_bytes           # Display Mode
+      bytes.concat self.display_speed.to_bytes           # Display Speed
+      bytes.concat self.display_pause.to_bytes           # Display Pause
+      bytes.concat string_to_ascii_bytes(self.dayofweek_mask)           # Show Date
+      bytes.concat string_to_ascii_bytes(self.start_time)           # Start Time
+      bytes.concat string_to_ascii_bytes(self.end_time)           # End Time
+      bytes.concat string_to_ascii_bytes('000')           # Reserved
+      bytes.concat self.align_mode.to_bytes           # Align Mode
+      #bytes.concat string_to_ascii_bytes("\xFD\x42" + self.text.gsub("\n", "\x7F"))           # Text
+      bytes.concat string_to_ascii_bytes(self.text.gsub("\n", "\x7F"))           # Text
+
+      bytes
+    end
+  end
+end
+

data/lib/movingsign_api/errors.rb

@@ -0,0 +1,22 @@
+module MovingsignApi
+  # Base error for all MovingsignApi errors.
+  class Error < StandardError
+
+  end
+
+  # Raised when a method has been be implemented, usually due to improperly subclassed class or code that is in
+  # progress.
+  class NotImplementedError < Error
+
+  end
+
+  # Raised when an input is invalid in the given context.
+  class InvalidInputError < Error
+
+  end
+
+  # Raised when there are errors reading/writing to the serial port
+  class IOError < Error
+
+  end
+end

data/lib/movingsign_api/sign.rb

@@ -0,0 +1,144 @@
+require 'serialport'
+
+module MovingsignApi
+  # Manipulates a Movingsign attached to a serial port
+  #
+  # @example Construct a sign
+  #   require 'movingsign_api'
+  #
+  #   sign = MovingsignApi::Sign.new('/dev/ttyUSB0')
+  #
+  # @example Show Text
+  #   sign.show_text('Hello World!')
+  #
+  # @example Turn Sound Off
+  #   sign.set_sound false
+  #
+  class Sign
+    # Serial port device path (ie: /dev/ttyUSB0)
+    attr_accessor :device_path
+
+    # @param device_path [String] the serial port device path (ie: /dev/ttyUSB0, different depending on platform)
+    def initialize(device_path)
+      @device_path = device_path
+    end
+
+    # Show the {#device_path} value on the display (useful for diagnostics)
+    def show_identity
+      cmd = WriteTextCommand.new
+      cmd.text = self.device_path
+
+      send_command cmd
+    end
+
+    # Displays the given text on the board.
+    #
+    # This is short-hand for the {WriteTextCommand}
+    #
+    # @param text [String] the text to display on the sign
+    # @param options [Hash] options for {WriteTextCommand}
+    # @option options [Integer] :display_pause (2) Time to pause (in seconds) between pages of text.  See {WriteTextCommand#display_pause}
+    #
+    # @return [self]
+    def show_text(text, options = {})
+      cmd = WriteTextCommand.new
+      cmd.display_pause = options[:display_pause] if options[:display_pause]
+      cmd.text = text
+
+      send_command cmd
+    end
+    alias :write_text :show_text
+
+    # Turns on/off sound when the sign receives a command
+    #
+    # This is a shorthand for {SetSoundCommand}
+    #
+    # @param on [Boolean] true to turn sound on, false otherwise
+    #
+    # @return [self]
+    def set_sound(on)
+      cmd = SetSoundCommand.new on
+
+      send_command cmd
+    end
+
+    # Sends the specified Movingsign command to this sign's serial port
+    #
+    # @param [MovingsignApi::Command] command subclass to send
+    #
+    # @return [self]
+    def send_command(command)
+      SerialPort.open(self.device_path, 9600, 8, 1) do |port|
+        # flush anything existing on the port
+        port.flush
+        flush_read_buffer(port)
+
+        byte_string = command.to_bytes.pack('C*')
+
+        begin
+          while byte_string && byte_string.length != 0
+            count = port.write_nonblock(byte_string)
+            byte_string = byte_string[count,-1]
+
+            port.flush
+          end
+        rescue IO::WaitWritable
+          if IO.select([], [port], [], 5)
+            retry
+          else
+            raise IOError, "Timeout writing command to #{self.device_path}"
+          end
+        end
+
+        # wait for expected confirmation signals
+        got_eot = false
+        got_soh = false
+        loop do
+          begin
+            c = port.read_nonblock(1)
+
+            case c
+              when "\x04"
+                if ! got_eot
+                  got_eot = true
+                else
+                  raise IOError, "Got EOT reply twice from #{self.device_path}"
+                end
+              when "\x01"
+                if got_eot
+                  if ! got_soh
+                    got_soh = true
+
+                    break
+                  else
+                    raise IOError, "Got SOH twice from #{self.device_path}"
+                  end
+                else
+                  raise IOError, "Got SOH before EOT from #{self.device_path}"
+                end
+            end
+          rescue IO::WaitReadable
+            if IO.select([port], [], [], 3)
+              retry
+            else
+              raise IOError, "Timeout waiting for command reply from #{self.device_path}.  EOT:#{got_eot} SOH:#{got_soh}"
+            end
+          end
+        end
+      end
+
+      self
+    end
+
+    private
+
+    def flush_read_buffer(port)
+      begin
+        while true
+          port.read_nonblock(1024)
+        end
+      rescue IO::WaitReadable
+      end
+    end
+  end
+end

data/lib/movingsign_api/version.rb

@@ -0,0 +1,3 @@
+module MovingsignApi
+  VERSION = "0.0.1"
+end

data/lib/movingsign_api.rb

@@ -0,0 +1,13 @@
+require "movingsign_api/errors"
+require "movingsign_api/version"
+require 'movingsign_api/commands/write_text_command'
+require 'movingsign_api/commands/set_clock_command'
+require 'movingsign_api/commands/software_reset_command'
+require 'movingsign_api/commands/hard_reset_command'
+require 'movingsign_api/commands/set_clock_command'
+require 'movingsign_api/commands/set_sound_command'
+require 'movingsign_api/sign'
+
+module MovingsignApi
+  # Your code goes here...
+end

data/movingsign_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'movingsign_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "movingsign_api"
+  spec.version       = MovingsignApi::VERSION
+  spec.authors       = ["Eric Webb"]
+  spec.email         = ["opensource@collectivegenius.net"]
+  spec.description   = "MovingSign Communication Protocol V2.1 Implementation in Ruby"
+  spec.summary       = "MovingSign Communication Protocol V2.1 Implementation in Ruby"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+      .reject { |path| path.match /\A\.idea\//  }     # Ignore .idea/ IntelliJ project directory
+      .reject { |path| path.match /\A[^\/]+\.iml/ }   # Ignore *.iml IntelliJ module file
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "yard", "0.8.7.3"
+  spec.add_development_dependency "wwtd"
+
+  spec.add_runtime_dependency 'serialport', '~> 1.3'
+end

data/spec/align_mode_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+
+ALIGN_MODES = {
+  :left => '1',
+  :right => '3',
+  :center => '2',
+}
+
+describe MovingsignApi::AlignMode do
+  describe '::parse' do
+    it "Symbol" do
+      # valid keys
+      ALIGN_MODES.keys.each do |key|
+        expect(described_class.parse(key).key).to eq key
+      end
+
+      # invalid keys
+      expect {described_class.parse(:invalid).key}.to raise_error(MovingsignApi::InvalidInputError)
+      expect {described_class.parse(nil).key}.to raise_error(MovingsignApi::InvalidInputError)
+    end
+
+    it 'Code' do
+
+    end
+
+  end
+end

data/spec/commands/set_sound_command_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe MovingsignApi::SetSoundCommand do
+  describe "sound on" do
+    subject { MovingsignApi::SetSoundCommand.new(true) }
+
+    it "#subcommand_payload_bytes" do
+      expect(subject.subcommand_payload_bytes).to eq [0x31]
+    end
+  end
+
+  describe "sound off" do
+    subject { MovingsignApi::SetSoundCommand.new(false) }
+
+    it "#subcommand_payload_bytes" do
+      expect(subject.subcommand_payload_bytes).to eq [0x30]
+    end
+  end
+end

data/spec/display_mode_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+
+DISPLAY_MODES = {
+  :auto => 'A',
+  :flash => 'B',
+  :hold => 'C',
+  :interlock => 'D',
+  :rolldown => 'E',
+  :rollup => 'F',
+  :rollin => 'G',
+  :rollout => 'H',
+  :rollleft => 'I',
+  :rollright => 'J',
+  :rotate => 'K',
+  :slide => 'L',
+  :snow => 'M',
+  :sparkle => 'N',
+  :spray => 'O',
+  :starburst => 'P',
+  :switch => 'Q',
+  :twinkle => 'R',
+  :wipedown => 'S',
+  :wipeup => 'T',
+  :wipein => 'U',
+  :wipeout => 'V',
+  :wipeleft => 'W',
+  :wiperight => 'X',
+  :cyclecolor => 'Y',
+  :clock => 'Z',
+}
+
+describe MovingsignApi::DisplayMode do
+  describe '::parse' do
+    it "Symbol" do
+      # All valid keys
+      DISPLAY_MODES.keys.each do |key|
+        expect(described_class.parse(key).key).to eq key
+      end
+
+      # invalid keys
+      expect {described_class.parse(:invalid).key}.to raise_error(MovingsignApi::InvalidInputError)
+      expect {described_class.parse(:+).key}.to raise_error(MovingsignApi::InvalidInputError)
+      expect {described_class.parse(nil).key}.to raise_error(MovingsignApi::InvalidInputError)
+    end
+
+    it "ASCII Code" do
+      # All valid ASCII codes
+      DISPLAY_MODES.each_pair do |key, code|
+        expect(described_class.parse(code).key).to eq key
+      end
+
+      expect {described_class.parse('0').key}.to raise_error(MovingsignApi::InvalidInputError)
+      expect {described_class.parse('z').key}.to raise_error(MovingsignApi::InvalidInputError)
+    end
+  end
+end

data/spec/display_speed_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+DISPLAY_SPEEDS = {
+  :fastest => '1',
+  :faster => '2',
+  :normal => '3',
+  :slow => '4',
+  :slower => '5',
+}
+
+describe MovingsignApi::DisplaySpeed do
+  describe '::parse' do
+    it "Symbol" do
+      DISPLAY_SPEEDS.keys.each do |key|
+        expect(described_class.parse(key).key).to eq key
+      end
+
+      # invalid keys
+      expect {described_class.parse(:invalid).key}.to raise_error(MovingsignApi::InvalidInputError)
+      expect {described_class.parse(nil).key}.to raise_error(MovingsignApi::InvalidInputError)
+    end
+  end
+end

data/spec/examples/example_A_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+require_relative 'expected'
+
+describe "Specification Example A - Write Text File" do
+  it "Generates Expected Output" do
+    command = MovingsignApi::WriteTextCommand.new
+
+    command.sender = :pc
+    command.receiver = 3
+
+    command.file_handle = 'A' # aka 10
+    command.display_mode = :auto
+    command.display_speed = :faster
+    command.display_pause = 2
+    command.dayofweek_mask = '7F' # todo: make this pretty
+    command.start_time = '0100'
+    command.end_time = '1200'
+    command.align_mode = :left
+    command.text = 'HELLO'
+
+    expect(command.to_bytes).to eq EXAMPLE_A_EXPECTED
+  end
+end

data/spec/examples/example_C_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+require_relative 'expected'
+
+describe "Specification Example C - Set Clock Command" do
+  it "Generates Expected Output" do
+    command = MovingsignApi::SetClockCommand.new
+
+    command.sender = :pc
+    command.receiver = 34
+
+    command.datetime = Time.new(2004,04,02,12,36,23)
+
+    expect(command.to_bytes).to eq EXAMPLE_C_EXPECTED
+  end
+end

data/spec/examples/example_D_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+require_relative 'expected'
+
+describe "Specification Example D - Software Reset Command" do
+  it "Generates Expected Output" do
+    command = MovingsignApi::SoftwareResetCommand.new
+
+    command.sender = :pc
+    command.receiver = 34
+
+    expect(command.to_bytes).to eq EXAMPLE_D_EXPECTED
+  end
+end

data/spec/examples/example_K_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+require_relative 'expected'
+
+describe "Specification Example K - Hard Reset Command" do
+  it "Generates Expected Output" do
+    command = MovingsignApi::HardResetCommand.new
+
+    command.sender = :pc
+    command.receiver = 16
+
+    expect(command.to_bytes).to eq EXAMPLE_K_EXPECTED
+  end
+end