movingsign_api 0.0.1

data/spec/examples/expected.rb

@@ -0,0 +1,130 @@
+# Contains the expected binary output for the examples given in the "MovingSign Communication Protocol V2.1" specification
+
+EXAMPLE_A_EXPECTED = [
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x01,       # <SOH>
+    0x46,       # Sender Address, 'FF'
+    0x46,       # Sender Address, 'FF'
+    0x30,       # Receiver Address, '03'
+    0x33,       # Receiver Address, '03'
+    0x02,       # <SOT> Start of Text
+    0x41,       # Command 'A' - Write Text File
+    0x41,       # Text File Name 'A'
+    0x41,       # Text Display Mode 'A'
+    0x32,       # Text Display Speed '2'
+    0x32,       # Pause Seconds '2'
+    0x37,       # Display Every Day '7F'
+    0x46,       # Display Every Day '7F'
+    0x30,       # Display Time Start '0100'
+    0x31,       # Display Time Start '0100'
+    0x30,       # Display Time Start '0100'
+    0x30,       # Display Time Start '0100'
+    0x31,       # Display Time End '1200'
+    0x32,       # Display Time End '1200'
+    0x30,       # Display Time End '1200'
+    0x30,       # Display Time End '1200'
+    0x30,       # No Use '000'
+    0x30,       # No Use '000'
+    0x30,       # No Use '000'
+    0x31,       # Alight Left '1'
+    0x48,       # Text Body: 'HELLO'
+    0x45,       # Text Body: 'HELLO'
+    0x4C,       # Text Body: 'HELLO'
+    0x4C,       # Text Body: 'HELLO'
+    0x4F,       # Text Body: 'HELLO'
+    0x03,       # <ETX>
+    0x30,       # Checksum '0562' - spec says '0564' but it is wrong
+    0x35,       # Checksum '0562'
+    0x36,       # Checksum '0562'
+    0x32,       # Checksum '0562'
+    0x04,       # <EOT>
+]
+
+EXAMPLE_C_EXPECTED = [
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x01,       # <SOH>
+    0x46,       # Sender Address, 'FF'
+    0x46,       # Sender Address, 'FF'
+    0x32,       # Receiver Address, 34 dec, 22 hex
+    0x32,       # Receiver Address, 34 dec, 22 hex
+    0x02,       # <SOT> Start of Text
+    0x57,       # Command 'W' - Control Command
+    0x41,       # Sub Command 'A' - Write Clock Command
+    0x32,       # Clock Data 200404021236235 - 2
+    0x30,       # Clock Data 200404021236235 - 0
+    0x30,       # Clock Data 200404021236235 - 0
+    0x34,       # Clock Data 200404021236235 - 4
+    0x30,       # Clock Data 200404021236235 - 0
+    0x34,       # Clock Data 200404021236235 - 4
+    0x30,       # Clock Data 200404021236235 - 0
+    0x32,       # Clock Data 200404021236235 - 2
+    0x31,       # Clock Data 200404021236235 - 1
+    0x32,       # Clock Data 200404021236235 - 2
+    0x33,       # Clock Data 200404021236235 - 3
+    0x36,       # Clock Data 200404021236235 - 6
+    0x32,       # Clock Data 200404021236235 - 2
+    0x33,       # Clock Data 200404021236235 - 3
+    0x35,       # Clock Data 200404021236235 - 5
+    0x03,       # <EOT>
+    0x30,       # Checksum '038F'
+    0x33,       # Checksum '038F'
+    0x38,       # Checksum '038F'
+    0x46,       # Checksum '038F'
+    0x04,       # <EOT>
+]
+
+EXAMPLE_D_EXPECTED = [
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x01,       # <SOH>
+    0x46,       # Sender Address, 'FF'
+    0x46,       # Sender Address, 'FF'
+    0x32,       # Receiver Address, 34 dec, 22 hex
+    0x32,       # Receiver Address, 34 dec, 22 hex
+    0x02,       # <SOT> Start of Text
+    0x57,       # Command 'W' - Control Command
+    0x42,       # Sub Command 'B' - Software Reset
+    0x03,       # <EOT>
+    0x30,       # Checksum '009E'
+    0x30,       # Checksum '009E'
+    0x39,       # Checksum '009E'
+    0x45,       # Checksum '009E'
+    0x04,       # <EOT>
+]
+
+EXAMPLE_K_EXPECTED = [
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x00,       # <NUL> x 5
+    0x01,       # <SOH>
+    0x46,       # Sender Address, 'FF'
+    0x46,       # Sender Address, 'FF'
+    0x31,       # Receiver Address, 16 dec, 10 hex
+    0x30,       # Receiver Address, 16 dec, 10 hex
+    0x02,       # <SOT> Start of Text
+    0x57,       # Command 'W' - Control Command
+    0x4C,       # Sub Command 'L' - Software Reset
+    0x03,       # <EOT>
+    0x30,       # Checksum '00A8'
+    0x30,       # Checksum '00A8'
+    0x41,       # Checksum '00A8'
+    0x38,       # Checksum '00A8'
+    0x04,       # <EOT>
+]
+
+# Calc checksum
+sum = EXAMPLE_K_EXPECTED[10..-6].reduce(:+)
+puts ('%04x' % sum).upcase

data/spec/file_handle_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe MovingsignApi::FileHandle do
+  it '::handle_to_code' do
+    expect(described_class.handle_to_code(0)).to eq '0'
+    expect(described_class.handle_to_code(9)).to eq '9'
+    expect(described_class.handle_to_code(10)).to eq 'A'
+    expect(described_class.handle_to_code(35)).to eq 'Z'
+  end
+
+  it '::code_to_handle' do
+    expect(described_class.code_to_handle('0')).to eq 0
+    expect(described_class.code_to_handle('9')).to eq 9
+    expect(described_class.code_to_handle('A')).to eq 10
+    expect(described_class.code_to_handle('Z')).to eq 35
+  end
+end

data/spec/sender_receiver_address_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe MovingsignApi::SenderReceiverAddress do
+  describe '::parse' do
+    it "Integer" do
+      # valid broadcast address
+      expect(described_class.parse(0).to_s).to eq '00'
+      expect(described_class.parse(0)).to be_broadcast
+
+      expect(described_class.parse(3).to_s).to eq '03'
+
+      # valid pc address
+      expect(described_class.parse(255).to_s).to eq 'FF'
+      expect(described_class.parse(255)).to be_pc
+
+      # out of range
+      expect { described_class.parse(-1) }.to raise_error(MovingsignApi::InvalidInputError)
+      expect { described_class.parse(256) }.to raise_error(MovingsignApi::InvalidInputError)
+    end
+
+    it "Symbols :pc and :broadcast" do
+      expect(described_class.parse(:broadcast).to_s).to eq '00'
+      expect(described_class.parse(:broadcast)).to be_broadcast
+
+      expect(described_class.parse(:pc).to_s).to eq 'FF'
+      expect(described_class.parse(:pc)).to be_pc
+
+      expect { described_class.parse(:invalid) }.to raise_error(MovingsignApi::InvalidInputError)
+    end
+
+    it 'String' do
+      # valid broadcast address
+      expect(described_class.parse('00').to_s).to eq '00'
+      expect(described_class.parse('00')).to be_broadcast
+
+      expect(described_class.parse('0a').to_s).to eq '0A'
+
+      # valid pc address
+      expect(described_class.parse('ff').to_s).to eq 'FF'
+      expect(described_class.parse('FF').to_s).to eq 'FF'
+      expect(described_class.parse('FF')).to be_pc
+
+      # valid with wildcard
+      expect(described_class.parse('1?').to_s).to eq '1?'
+      expect(described_class.parse('?5').to_s).to eq '?5'
+
+      # invalid (only one character)
+      expect { described_class.parse('?') }.to raise_error(MovingsignApi::InvalidInputError)
+      expect { described_class.parse('0') }.to raise_error(MovingsignApi::InvalidInputError)
+
+      # invalid (out of hex range)
+      expect { described_class.parse('?Z') }.to raise_error(MovingsignApi::InvalidInputError)
+    end
+  end
+
+  it "#to_bytes" do
+    expect(described_class.parse(:pc).to_bytes).to eq [0x46, 0x46]
+    expect(described_class.parse(3).to_bytes).to eq [0x30, 0x33]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'movingsign_api'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/tutorials/readme_1.rb

@@ -0,0 +1,5 @@
+require 'movingsign_api'
+
+sign = MovingsignApi::Sign.new '/dev/ttyUSB0'
+
+sign.show_text "Hello World"

data/spec/tutorials/readme_2.rb

@@ -0,0 +1,5 @@
+require 'movingsign_api'
+
+sign = MovingsignApi::Sign.new '/dev/ttyUSB0'
+
+sign.show_text "Hello World"

data/spec/tutorials/tutorials_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "Tutorial Examples" do
+  describe "README Example 1" do
+    it "Works" do
+      pending "Todo"
+
+      path = File.join(File.dirname(__FILE__), 'readme_1.rb')
+      script = File.read(path)
+
+      eval(File.read(path), nil, path)
+    end
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: movingsign_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Webb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: MovingSign Communication Protocol V2.1 Implementation in Ruby
+email:
+- opensource@collectivegenius.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/movingsign_api.rb
+- lib/movingsign_api/commands/command.rb
+- lib/movingsign_api/commands/hard_reset_command.rb
+- lib/movingsign_api/commands/internal/align_mode.rb
+- lib/movingsign_api/commands/internal/display_mode.rb
+- lib/movingsign_api/commands/internal/display_pause.rb
+- lib/movingsign_api/commands/internal/display_speed.rb
+- lib/movingsign_api/commands/internal/file_handle.rb
+- lib/movingsign_api/commands/internal/pretty_keyable.rb
+- lib/movingsign_api/commands/internal/sender_receiver_address.rb
+- lib/movingsign_api/commands/internal/utilities.rb
+- lib/movingsign_api/commands/set_clock_command.rb
+- lib/movingsign_api/commands/set_sound_command.rb
+- lib/movingsign_api/commands/software_reset_command.rb
+- lib/movingsign_api/commands/write_control_command.rb
+- lib/movingsign_api/commands/write_text_command.rb
+- lib/movingsign_api/errors.rb
+- lib/movingsign_api/sign.rb
+- lib/movingsign_api/version.rb
+- movingsign_api.gemspec
+- spec/align_mode_spec.rb
+- spec/commands/set_sound_command_spec.rb
+- spec/display_mode_spec.rb
+- spec/display_speed_spec.rb
+- spec/examples/example_A_spec.rb
+- spec/examples/example_C_spec.rb
+- spec/examples/example_D_spec.rb
+- spec/examples/example_K_spec.rb
+- spec/examples/expected.rb
+- spec/file_handle_spec.rb
+- spec/sender_receiver_address_spec.rb
+- spec/spec_helper.rb
+- spec/tutorials/readme_1.rb
+- spec/tutorials/readme_2.rb
+- spec/tutorials/tutorials_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: MovingSign Communication Protocol V2.1 Implementation in Ruby
+test_files:
+- spec/align_mode_spec.rb
+- spec/commands/set_sound_command_spec.rb
+- spec/display_mode_spec.rb
+- spec/display_speed_spec.rb
+- spec/examples/example_A_spec.rb
+- spec/examples/example_C_spec.rb
+- spec/examples/example_D_spec.rb
+- spec/examples/example_K_spec.rb
+- spec/examples/expected.rb
+- spec/file_handle_spec.rb
+- spec/sender_receiver_address_spec.rb
+- spec/spec_helper.rb
+- spec/tutorials/readme_1.rb
+- spec/tutorials/readme_2.rb
+- spec/tutorials/tutorials_spec.rb
+has_rdoc: