wifly 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wifly.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Billy Reisinger
+
+MIT License
+
+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.md

@@ -0,0 +1,49 @@
+# Wifly
+
+This Ruby gem can be used to talk to a [WiFly RN-XV](http://www.rovingnetworks.com/products/RN171XV) device at a specified address.  The gem has no dependencies other than the socket libraries that ship with any Ruby installation.  The gem takes advantage of the predictable size of the response strings from the WiFly by using blocking IO operations.  Using blocking operations significantly reduces the complexity of the code.  There are a couple of caveats with using blocking reads, though: 
+* Unexpected output from the WiFly could cause the client to deadlock on a socket read, or could cause corrupt data in subsequent reads.  I've tried to find the variants of output that I'm concerned with in my project; however, you might find some edge cases I haven't covered.  In that case, pull requests are welcome. 
+* The version of the firmware must be passed into the client so that the size of the response strings can be predicted.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wifly'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wifly
+
+## Usage
+Create a client by passing in the host, port, and firmware version:
+
+    control = Wifly::Control.new('192.168.1.45', 2000, '2.31.7')
+
+Read the high pins:
+
+    control.high_pins   # [3,7,9,15]
+
+Set a pin to high or low:
+
+    control.set_high(5)
+    control.high_pins   # [3,5,7,9,15]
+
+    control.set_low(7)
+    control.high_pins   # [3,5,9,15]
+
+Read a single pin:
+
+    control.read_pin(7) # 0
+    control.read_pin(5) # 1
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |config|
+
+end
+
+task :default => :spec
+

data/lib/wifly/connection.rb

@@ -0,0 +1,53 @@
+module Wifly
+  class Connection
+    HELLO = '*HELLO*CMD\r\n'
+
+    attr_accessor :address, :port, :version
+  
+    ##
+    # address => the hostname or IP address of the wifly device
+    # port =>    the port for communicating with the wifly
+    # version => the firmware version of the device
+    def initialize(address, port, version)
+      self.address = address
+      self.port    = port
+      self.version = version
+    end
+
+    ##
+    # str =>  the command to send to the wifly, without any carriage return
+    # [return_len] => the expected length of the return string; defaults to 0
+    #
+    # The wifly will echo back the command (with carriage return)
+    # along with another CRLF and the command prompt string.
+    # Something like "lites\r\r\n<2.32> "
+    # Since the string has a predictable length, we can do a blocking read.
+    #
+    def send_command(str, return_len=0)
+      str += '\r'
+      socket.write(str)
+      expected_return_length = str.length + '\r\n#{prompt}'.length + return_len
+      socket.read(expected_return_length).gsub(prompt,'') 
+    end
+
+    def close
+      socket.close
+    end
+
+    def socket
+      @socket ||= initialize_socket
+    end
+    
+    private
+    def prompt
+      "<#{version}> "
+    end
+
+    def initialize_socket
+      sock = Socket.tcp(address, port)
+      sock.write('$$$\r') # enter command mode 
+      sock.read(HELLO.length)       # read off the response, "*HELLO*CMD\r\n"
+      sock
+    end 
+  end
+end

data/lib/wifly/control.rb

@@ -0,0 +1,86 @@
+module Wifly
+  class Control
+    AOK = "\r\nAOK"
+
+    attr_accessor :connection
+
+    ##
+    # address    - the hostname or IP address 
+    # port       - defaults to 2000
+    # version    - the firmware version (a string)
+    # connection - the object to use for talking to the wifly. Responds to "send_command."
+    #              Defaults to Wifly::Connection. 
+    #
+    def initialize(address, port, version, connection=nil)
+      self.connection   = connection || Connection.new(address, port, version)
+    end
+
+    ##
+    # Toggle the blinking lights on the device
+    #
+    def lites
+      connection.send_command("lites")
+    end
+
+    ##
+    # Return an array containing the numbers of the pins that are in HIGH state
+    #
+    def high_pins
+      io=read_io
+                      #"8d08"   36104   "1000110100001000"   make it 16 bits
+      binary_string = io       .hex     .to_s(2)             .rjust(io.size*4, '0')
+      binary_string.reverse.split("").each_with_index.map do |value, pin|
+        pin if value == "1"
+      end.compact
+    end
+
+    ##
+    # set a pin high
+    #
+    def set_high(pin)
+      hex = pin_to_hex(pin)
+      connection.send_command "set sys output #{hex} #{hex}", AOK.length
+    end
+
+    ##
+    # set a pin low
+    #
+    def set_low(pin)
+      hex = pin_to_hex(pin)
+      connection.send_command "set sys output 0x00 #{hex}", AOK.length
+    end
+
+    ##
+    # given a pin number, return 1 if high or 0 if low
+    #
+    def read_pin(pin)
+      high_pins.include?(pin) ? 1 : 0
+    end
+
+    ## 
+    # Given a pin number, return the hex code that corresponds to it
+    #
+    def pin_to_hex(pin)
+      return "0x0" if pin == 0
+      binstr = "0b1" + ("0" * pin) # make a binary string with a 1 in `pin` position
+      base10 = binstr.to_i(2)      # convert to base 10
+      "0x" + base10.to_s(16)       # return hexadecimal string
+    end
+
+    private
+
+    ##
+    # Gets the status of all IO pins on wifly. Returns a hex string.
+    #
+    def read_io
+      cmd = "show io\r"
+
+      # wifly spits back something like 'show io\r\r\n8d08\r\n<2.32> '
+      # crucially, the middle part "8d08\r\n" is always the same length
+      str = connection.send_command("show io", "8d08\r\n".length)
+
+      # Return only the middle part, which is the io state
+      str.gsub(cmd,'').strip
+    end
+  end
+end

data/lib/wifly/version.rb

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

data/lib/wifly.rb

@@ -0,0 +1,4 @@
+require 'socket'
+require 'wifly/connection'
+require 'wifly/control'
+require 'wifly/version'

data/spec/connection_spec.rb

@@ -0,0 +1,59 @@
+require 'wifly'
+class Wifly::TestServer
+  attr_accessor :input
+
+  def initialize(port)
+    @socket = TCPServer.new(port)
+  end
+
+  def simple_connect
+    @client = @socket.accept
+    self.input = @client.read('$$$\r'.length) 
+    @client.write(Wifly::Connection::HELLO)
+    @client.close
+  end
+
+  def receive_command(command, version)
+    @client = @socket.accept
+
+    @client.write(Wifly::Connection::HELLO)
+    @client.read((command + '\r').length)
+    @client.write(command + '\r\r\n<' + version + '> ')
+    @client.close
+  end
+end
+
+describe Wifly::Connection do
+  before(:all) do
+    @server = Wifly::TestServer.new(2000)
+  end
+  it 'should set stuff on initialize' do
+    connection = Wifly::Connection.new('localhost', 2000, '2.3.13')
+    connection.address.should eq('localhost')
+    connection.port.should eq(2000)
+    connection.version.should eq('2.3.13')
+  end
+
+  it 'should enter command mode' do
+    t = Thread.new do
+      @server.simple_connect
+    end
+    connection = Wifly::Connection.new('localhost', 2000, '2.3.13')
+    connection.socket
+    t.join
+    @server.input.should eq('$$$\r')
+    connection.close
+  end
+
+  it 'should send commands correctly' do
+    t = Thread.new do
+      @server.receive_command("lites", '123')
+    end
+    connection = Wifly::Connection.new('localhost', 2000, '123')
+
+    result = connection.send_command("lites")
+    t.join
+    result.should eq('lites\r\r\n')
+    connection.close
+  end
+end

data/spec/control_spec.rb

@@ -0,0 +1,27 @@
+require 'wifly'
+describe Wifly::Control do
+  it 'should convert pin to hex' do
+    control = Wifly::Control.new('localhost', 2000, '1.2', {})
+    control.pin_to_hex(5).should eq("0x20")
+    control.pin_to_hex(0).should eq("0x0")
+  end 
+
+  it 'should get high pins' do
+    connection = double('connection')
+    connection.should_receive(:send_command).exactly(3).times.and_return("show io\r\r\n8d08\r\n")
+    control = Wifly::Control.new('localhost', 2000, '1.2', connection)
+    result = control.high_pins
+    result.should eq([3, 8, 10, 11, 15])
+    control.read_pin(8).should eq(1)
+    control.read_pin(7).should eq(0)
+  end
+
+  it 'should set high and low' do
+    connection = double('connection')
+    connection.should_receive(:send_command).with("set sys output 0x20 0x20", Wifly::Control::AOK.length)
+    connection.should_receive(:send_command).with("set sys output 0x00 0x20", Wifly::Control::AOK.length)
+    control = Wifly::Control.new('localhost', 2000, '1.2', connection)
+    control.set_high(5)
+    control.set_low(5)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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/wifly.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wifly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wifly"
+  spec.version       = Wifly::VERSION
+  spec.authors       = ["Billy Reisinger"]
+  spec.email         = ["billy.reisinger@govdelivery.com"]
+  spec.description   = %q{A small Ruby gem to connect to a WiFly RN-XV device}
+  spec.summary       = %q{This gem can be used to talk to a WiFly RN-XV device at a specified address.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: wifly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Billy Reisinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small Ruby gem to connect to a WiFly RN-XV device
+email:
+- billy.reisinger@govdelivery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wifly.rb
+- lib/wifly/connection.rb
+- lib/wifly/control.rb
+- lib/wifly/version.rb
+- spec/connection_spec.rb
+- spec/control_spec.rb
+- spec/spec_helper.rb
+- wifly.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 277051527078828641
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 277051527078828641
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This gem can be used to talk to a WiFly RN-XV device at a specified address.
+test_files:
+- spec/connection_spec.rb
+- spec/control_spec.rb
+- spec/spec_helper.rb