wifly 0.0.5 → 1.0.0

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wifly.gemspec
 gemspec
+
+group :test, :development do 
+  gem "pry"  
+end

data/README.md

@@ -1,8 +1,6 @@
 # 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.  
+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.  
 
 ## Installation
 
@@ -19,9 +17,9 @@ Or install it yourself as:
     $ gem install wifly
 
 ## Usage
-Create a client by passing in the host, port, and firmware version:
+Create a client by passing in the host and port
 
-    control = Wifly::Control.new('192.168.1.45', 2000, '2.38.3')
+    control = Wifly::Control.new('192.168.1.45', 2000)
 
 Read the high pins:
 

data/lib/wifly.rb

@@ -1,3 +1,4 @@
+$: << File.expand_path("..", __FILE__)
 require 'socket'
 require 'wifly/connection'
 require 'wifly/calculations'

data/lib/wifly/calculations.rb

@@ -5,9 +5,9 @@ module Wifly
     # into an array of pins that are high 
     #
     def parse_io(hex_str)
-                      #"8d08"   36104   "1000110100001000"   make it 16 bits
-      binary_string = hex_str   .hex     .to_s(2)             .rjust(hex_str.size*4, '0')
-      binary_string.reverse.split("").each_with_index.map do |value, pin|
+      # use sprintf to pad with 0's to 16 bits
+      binary_string = "%016b"  % hex_str.hex.to_i
+      binary_string.reverse.chars.each_with_index.map do |value, pin|
         pin if value == "1"
       end.compact
     end

data/lib/wifly/connection.rb

@@ -1,15 +1,13 @@
 module Wifly
   class Connection
-    attr_accessor :address, :port, :version
+    attr_accessor :address, :port
   
     ##
     # 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)
+    def initialize(address, port)
       self.address = address
       self.port    = port
-      self.version = version
     end
 
     ##
@@ -19,18 +17,15 @@ module Wifly
     # 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)
+    def send_command(str)
       str += "\r"
-      socket.write(str)
-      expected_return_length = str.length + "\r\n#{prompt}".length + return_len
-      socket.read(expected_return_length).gsub(prompt,'')
-    rescue Errno::EPIPE # connection closed on the client end
-      initialize_socket
-      retry
+      write(socket, str) # the write is blocking
+      sleep(0.2)
+      read(socket).gsub(prompt,'')
     end
 
+
     def close
       socket.close
     end
@@ -40,14 +35,43 @@ module Wifly
     end
     
     private
+
+    def read(sock)
+      result = ''
+      begin
+        result = sock.read_nonblock(1024)
+      # connection lost somehow
+      rescue Errno::ECONNRESET, Errno::EPIPE, IOError
+        initialize_socket
+        read(socket)
+      # No more data on socket
+      rescue Errno::EAGAIN
+        retry
+      rescue EOFError => e
+        # ain't nothin left on socket.  
+      end
+      result.strip
+    end
+
+    def write(sock, str)
+      begin
+        sock.write(str)
+      rescue Errno::EPIPE, IOError
+        initialize_socket
+        write(socket, str)
+      end
+    end
+
     def prompt
-      "<#{version}> "
+      # 2.32
+      # 3.2.23
+      /<[0-9]{1,}\.[0-9]{1,}(\.[0-9]{1,})?>/
     end
 
     def initialize_socket
       sock = Socket.tcp(address, port)
-      sock.write(COMMAND_MODE) # enter command mode 
-      sock.read(HELLO.length)  # read off the response
+      write(sock, COMMAND_MODE) # enter command mode 
+      read(sock) # read off the response
       sock
     end 
   end

data/lib/wifly/control.rb

@@ -7,12 +7,11 @@ module Wifly
     ##
     # 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)
+    def initialize(address, port, connection=nil)
+      self.connection   = connection || Connection.new(address, port)
     end
 
     ##
@@ -27,7 +26,7 @@ module Wifly
     #
     def set_high(pin)
       hex = pin_to_hex(pin)
-      connection.send_command "set sys output #{hex} #{hex}", AOK.length
+      connection.send_command "set sys output #{hex} #{hex}"
     end
 
     ##
@@ -35,7 +34,7 @@ module Wifly
     #
     def set_low(pin)
       hex = pin_to_hex(pin)
-      connection.send_command "set sys output 0x00 #{hex}", AOK.length
+      connection.send_command "set sys output 0x00 #{hex}"
     end
 
     ##
@@ -52,6 +51,13 @@ module Wifly
       parse_io(read_io)
     end
 
+    ##
+    # Close the connection.    
+    #
+    def close
+      connection.close
+    end
+
     private
 
     ##
@@ -60,9 +66,8 @@ module Wifly
     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)
+      # result is something like 'show io\r\r\n8d08'
+      str = connection.send_command "show io"
 
       # Return only the middle part, which is the io state
       str.gsub(cmd,'').strip

data/lib/wifly/version.rb

@@ -1,3 +1,3 @@
 module Wifly
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/spec/calculations_spec.rb

@@ -15,5 +15,7 @@ describe Wifly::Calculations do
     control = WiflyControlShim.new
     result = control.parse_io('8d08')
     result.should eq([3, 8, 10, 11, 15])
+    result = control.parse_io('8103')
+    result.should eq([0, 1, 8, 15])
   end
 end

data/spec/connection_spec.rb

@@ -13,12 +13,12 @@ class Wifly::TestServer
     @client.close
   end
 
-  def receive_command(command, version)
+  def receive_command(command)
     @client = @socket.accept
 
     @client.write(Wifly::HELLO)
     @client.read((command + "\r").length)
-    @client.write(command + "\r\r\n<" + version + '> ')
+    @client.write(command + "\r\r\n<2.32> ")
     @client.close
   end
 end
@@ -28,17 +28,16 @@ describe Wifly::Connection do
     @server = Wifly::TestServer.new(2000)
   end
   it 'should set stuff on initialize' do
-    connection = Wifly::Connection.new('localhost', 2000, '2.3.13')
+    connection = Wifly::Connection.new('localhost', 2000)
     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 = Wifly::Connection.new('localhost', 2000)
     connection.socket
     t.join
     @server.input.should eq(Wifly::COMMAND_MODE)
@@ -47,9 +46,9 @@ describe Wifly::Connection do
 
   it 'should send commands correctly' do
     t = Thread.new do
-      @server.receive_command("lites", '123')
+      @server.receive_command("lites")
     end
-    connection = Wifly::Connection.new('localhost', 2000, '123')
+    connection = Wifly::Connection.new('localhost', 2000)
 
     result = connection.send_command("lites")
     t.join

data/spec/control_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 describe Wifly::Control do
   it 'should set high and low' do
     connection = double('connection')
-    connection.should_receive(:send_command).with("set sys output 0x20 0x20", Wifly::AOK.length)
-    connection.should_receive(:send_command).with("set sys output 0x00 0x20", Wifly::AOK.length)
-    control = Wifly::Control.new('localhost', 2000, '1.2', connection)
+    connection.should_receive(:send_command).with("set sys output 0x20 0x20")
+    connection.should_receive(:send_command).with("set sys output 0x00 0x20")
+    control = Wifly::Control.new('localhost', 2000, connection)
     control.set_high(5)
     control.set_low(5)
   end
@@ -12,7 +12,7 @@ describe Wifly::Control do
   it 'should get high pins' do
     connection = double('connection')
     connection.should_receive(:send_command).exactly(2).times.and_return("show io\r\r\n8d08\r\n")
-    control = Wifly::Control.new('localhost', 2000, '1.2', connection)
+    control = Wifly::Control.new('localhost', 2000, connection)
 
     control.read_pin(8).should eq(1)
     control.read_pin(7).should eq(0)

data/spec/integration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+# 
+# This test excercizes pretty much most of the control methods
+# on an actual WiFly.  Supplying the WIFLY_IP as an environment
+# variable activates this test. 
+# That means you should have the WiFly connected to a network 
+# accessible by the computer running this test. 
+#
+if WIFLY_IP
+  describe Wifly do
+    it 'should really work' do
+      2.times do 
+        control=Wifly::Control.new(WIFLY_IP, 2000)
+        5.times do |n|
+          control.set_high(7)
+          control.read_pin(7).should eq(1)
+          control.set_low(7)
+          control.read_pin(7).should eq(0)
+        end
+        control.close
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,6 +5,10 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'wifly'
+require 'pry'
+
+# If you set WIFLY_IP, a special "real" test will run against your WiFly.
+WIFLY_IP = ENV['WIFLY_IP'] || nil
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wifly
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,7 @@ files:
 - spec/calculations_spec.rb
 - spec/connection_spec.rb
 - spec/control_spec.rb
+- spec/integration_spec.rb
 - spec/spec_helper.rb
 - wifly.gemspec
 homepage: ''
@@ -113,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3199720615391178109
+      hash: 17962621
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3199720615391178109
+      hash: 17962621
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -133,4 +134,5 @@ test_files:
 - spec/calculations_spec.rb
 - spec/connection_spec.rb
 - spec/control_spec.rb
+- spec/integration_spec.rb
 - spec/spec_helper.rb