alphasign 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "serialport","~>1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jon Proulx
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,33 @@
+= alphasign
+
+A little gem to put messages on an LED sign, if that sign speak Alpha
+Sign protocol, and if I don't get my sign taken away before I get this
+to work.
+
+== Example code
+
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'alphasign'
+
+#specify serial port
+sign=AlphaSign.new('/dev/ttyS0')
+#write text to sign
+sign.write("foo")
+
+
+== Contributing to alphasign
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jon Proulx. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "alphasign"
+  gem.homepage = "http://github.com/jon-proulx/alphasign"
+  gem.license = "MIT"
+  gem.summary = "A gem for communicating with LED signs using Alpha Sign Protocol "
+  gem.description = <<-EOF
+Alphasign is handles communication with LED signs using the Alpha Sign Protocol. 
+These include Alpha signs  and  Betabrite signs by Adaptive Micro Systems, maybe 
+others too, YMMV. 
+
+Initial release only handles writing text to the sign over rs232 serial port.  
+EOF
+  gem.email = "jon@jonproulx.com"
+  gem.authors = ["Jon Proulx"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "alphasign #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/alphasign.rb

@@ -0,0 +1,93 @@
+class AlphaSign
+  # Require 'serialport' gem 
+  require 'serialport'
+  
+  #We have a relatively large number of potocol constants
+
+  ###Serial config
+  Baud=9600
+  DataBits=7
+  Parity=SerialPort::EVEN
+  StopBits=2
+  ###
+
+  #this was much more complex in original, but due to packing spec
+  #effectively reduced to this, and remains voodoo but apparently
+  #necessary voodoo
+  Preamble = [ ']', ']'].pack('x10ax10a')
+  # everything starts with this, nulls are to auto set baud on unit
+  StartHeader = Preamble + [ 0x01 ].pack('x20C')
+  # this is still a bit dubious, docs say "A" for write text file, but
+  # example and experience show "AA" is needed, other codes are as yet
+  # untested YMMV..I simply doubled the char listed in docs. only 'wtxt'
+  # actually works with anything else here
+  StartCMD = {
+    :wtxt => [ 0x02, 'AA' ].pack('CA2'), # write text file
+    :rtxt => [ 0x02, 'BB' ].pack('CA2'), # read text file
+    :wfctn => [ 0x02, 'EE' ].pack('CA2'), # write special function
+    :rfctn => [ 0x02, 'FF' ].pack('CA2'), # read special function
+    :wstr => [ 0x02, 'GG' ].pack('CA2'), # write string file
+    :rstr => [ 0x02, 'HH' ].pack('CA2'), # read string file
+    :wdots => [ 0x02, 'II' ].pack('CA2'), # write DOTS picture file
+    :rdots => [ 0x02, 'JJ' ].pack('CA2'), # read DOTS picture file
+    :wadots => [ 0x02, 'MM' ].pack('CA2'), # write ALPHAVISON DOTS picture file
+    :radots => [ 0x02, 'NN' ].pack('CA2'), # read ALPHAVISON DOTS picture file
+    :bulletin => [ 0x02, 'OO' ].pack('CA2'), # write bulletin message
+  } 
+  
+  # Marker for start of mode config
+  StartMode = [ 0x1b ].pack('C')
+
+  # Vertical Position
+  Position = {
+    :middle => [ 0x20 ].pack('C'),
+    :top => [ 0x22 ].pack('C'),
+    :bottom => [ 0x26 ].pack('C'),
+    :fill => [ 0x30 ].pack('C'),
+  }
+  # Mode Code, names taken form documentation
+  # since these are ascii probably don't need packing?
+  Mode = {
+    :rotate => ["a"].pack('A'), #scroll right to left
+    :hold => ["b"].pack('A'), # stationary
+    :flash => ["c"].pack('A'), #"flash"
+    # these are all transitions from previous message:
+    :rollup => ["e"].pack('A'),
+    :rolldown => ["f"].pack('A'),
+    :rollleft => ["g"].pack('A'),
+    :rollright => ["h"].pack('A'),
+    :wipeup => ["i"].pack('A'),
+    :wipedown => ["j"].pack('A'),
+  }
+
+  Footer = [0x04].pack("C") # EOT end of transmission
+  
+  # @param [String] device the serial device the sign is connected to
+  # for now we only speak rs232
+  def  initialize (device = "/dev/ttyS0")
+    @device= device
+
+    # 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 units, "00" first unit or
+    # broadcast?
+    @addr = [ 'Z00' ].pack('A3')
+    
+  end
+
+  # we don't have an open yet so this still kludgey and enfoces using
+  # only :wtxt command as thats the only one we know we can do
+   def  write (msg, position=:middle, mode=:rotate)
+     @alphaFormat = StartMode + Position[position] + Mode[mode]
+     @alphaHeader =  StartHeader + @addr +  StartCMD[:wtxt] + @alphaFormat
+     sp=SerialPort.new(@device,  
+                     Baud,  DataBits,  StopBits,  Parity)
+     sp.write @alphaHeader
+     sp.write msg
+     sp.write Footer
+     sp.close
+   end
+
+
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'alphasign'
+
+class Test::Unit::TestCase
+end

data/test/test_alphasign.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAlphasign < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification 
+name: alphasign
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jon Proulx
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: serialport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rdoc
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 1
+        - 8
+        - 3
+        version: 1.8.3
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+description: |
+  Alphasign is handles communication with LED signs using the Alpha Sign Protocol. 
+  These include Alpha signs  and  Betabrite signs by Adaptive Micro Systems, maybe 
+  others too, YMMV. 
+  
+  Initial release only handles writing text to the sign over rs232 serial port.  
+
+email: jon@jonproulx.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/alphasign.rb
+- test/helper.rb
+- test/test_alphasign.rb
+has_rdoc: true
+homepage: http://github.com/jon-proulx/alphasign
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem for communicating with LED signs using Alpha Sign Protocol
+test_files: []
+