rmodbus 1.0.4 → 1.1.0

data/NEWS.md

@@ -1,6 +1,23 @@
+2011-10-29 Release 1.1.0
+===================================
+1. Fixed issue [#12](https://github.com/flipback/rmodbus/issues/12). Added option Slave#raise_exception_on_mismatch to turn to check response and raise exception
+   if it's mismatch.
+2. Added pass options :debug, :raise_exception_on_mismatch, :read_retry_timeout, :read_retries from clients to slaves
+  `ruby
+    @cl.debug = true
+    @cl.with_slave(1) do |slave_1|
+      slave_1.debug #=> true
+    end
+    @cl.with_slave(2) do |slave_2|
+      slave_2.debug = false
+      slave_2.debug #=> false
+    end
+  ` 
+3. Deleted dependency with `serialport` gem. Install it manual for using RTU
+
 2011-08-10 Release 1.0.4
 ====================================
-1. Fixed issue [#11](https://github.com/flipback/rmodbus/issues/9)
+1. Fixed issue [#11](https://github.com/flipback/rmodbus/issues/11)
 
 
 2011-07-17 Release 1.0.3
@@ -27,7 +44,7 @@ New API for client part of library
 ---------------------------------------
 
 Example:
-
+  `ruby
     require 'rmodbus'
 
     ModBus::TCPClient.new('127.0.0.1', 8502) do |cl|
@@ -45,7 +62,7 @@ Example:
         slave.holding_registers[16..20] = [1, 2, 3, 4, 5]
       end
     end
-
+  `
 for more information [see](http://rdoc.info/gems/rmodbus/1.0.0/frames)
 
 Conversion to/from 32bit registers
@@ -54,7 +71,7 @@ Conversion to/from 32bit registers
 Some modbus devices use two registers to store 32bit values.
 RModbus provides some helper functions to go back and forth between these two things when reading/writing.
 The built-in examples assume registers in a particular order but it's trivial to change.
-
+  `ruby
     # Reading values in multiple registers (you can read more than 2 and convert them all so long as they are in multiples of 2)
     res = slave.holding_registers[0..1]
     res.inspect => [20342, 17344]
@@ -66,7 +83,7 @@ The built-in examples assume registers in a particular order but it's trivial to
     cl.holding_registers[0..1] => [20342, 17344]
     cl.holding_registers[2..3] = [384.620788574219].from_32f
     cl.holding_registers[2..3] => [20342, 17344]
-
+  `
 Support JRuby
 --------------------------------------
 Now you could use RModBus on JRuby without RTU implementation.

data/README.md

@@ -1,4 +1,4 @@
-RModBus
+RModBus [![Build Status](https://secure.travis-ci.org/flipback/rmodbus.png)](http://travis-ci.org/flipback/rmodbus)
 ==========================
 
 **RModBus** - free implementation of protocol ModBus.
@@ -50,26 +50,6 @@ Example
       end
     end
 
-
-Conversion to/from 32bit registers
------------------------------------
-
-Some modbus devices use two registers to store 32bit values.
-RModbus provides some helper functions to go back and forth between these two things when reading/writing.
-The built-in examples assume registers in a particular order but it's trivial to change.
-
-    # Reading values in multiple registers (you can read more than 2 and convert them all so long as they are in multiples of 2)
-    res = slave.holding_registers[0..1]
-    res.inspect => [20342, 17344]
-    res.to_32i => [1136676726]
-    res.to_32f => [384.620788574219]
-
-    # Writing 32b values to multiple registers
-    cl.holding_registers[0..1] = [1136676726].from_32i
-    cl.holding_registers[0..1] => [20342, 17344]
-    cl.holding_registers[2..3] = [384.620788574219].from_32f
-    cl.holding_registers[2..3] => [20342, 17344]
-
 GitHub
 ----------------------------------
 
@@ -80,8 +60,8 @@ You can checkout source code from GitHub repositry
 Reference
 ----------------------------------
 
-Home page: http://rmodbus.heroku.com
+Home page: http://rmodbus.flipback.net
 
 RModBud on GitHub: http://github.com/flipback/RModBus
 
-ModBus community: http://www.modbus-ida.org
+ModBus community: http://www.modbus-ida.org

data/Rakefile

@@ -15,7 +15,9 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
-  if RUBY_PLATFORM == "java"
+  begin
+    require 'serialport'
+  rescue LoadError => e
     spec.pattern.exclude("spec/rtu_client_spec.rb", "spec/rtu_server_spec.rb")
   end
 end

data/lib/rmodbus/client.rb

@@ -16,6 +16,8 @@ module ModBus
   # @abstract
   class Client
     include Errors
+    include Debug
+    include Options
 
     # Initialized client (alias :connect)
     # @example
@@ -26,6 +28,12 @@ module ModBus
     # @yield return client object and close it before exit
     # @return [Client] client object
     def initialize(*args, &block)
+      # Defaults 
+      @debug = false
+      @raise_exception_on_mismatch = false
+      @read_retry_timeout = 1
+      @read_retries = 10
+
       @io = open_connection(*args)
       if block_given?
         yield self
@@ -50,6 +58,10 @@ module ModBus
     # @return [Slave] slave object
     def with_slave(uid, &block)
       slave = get_slave(uid, @io)
+      slave.debug = debug
+      slave.raise_exception_on_mismatch = raise_exception_on_mismatch
+      slave.read_retries = read_retries
+      slave.read_retry_timeout = read_retry_timeout
       if block_given?
         yield slave
       else

data/lib/rmodbus/{common.rb → debug.rb}

@@ -1,6 +1,6 @@
 # RModBus - free implementation of ModBus protocol in Ruby.
 #
-# Copyright (C) 2010  Timin Aleksey
+# Copyright (C) 2010-2011  Timin Aleksey
 # Copyright (C) 2010  Kelley Reynolds
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,12 +14,10 @@
 # GNU General Public License for more details.
 
 module ModBus
-  module Common
-    # @return [Boolean] debug mode
-    # default false
-    attr_accessor :debug
+  module Debug
+    attr_accessor :debug, :raise_exception_on_mismatch, 
+                  :read_retries, :read_retry_timeout 
 
-    @debug = false
 
     private
     # Put log message on standart output

data/lib/rmodbus/errors.rb

@@ -1,6 +1,6 @@
 # RModBus - free implementation of ModBus protocol on Ruby.
 #
-# Copyright (C) 2008  Timin Aleksey
+# Copyright (C) 2008-2011  Timin Aleksey
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -14,7 +14,6 @@
 module ModBus
 
   module Errors
-
     class ProxyException < StandardError
     end
 
@@ -45,6 +44,13 @@ module ModBus
     class ModBusTimeout < ModBusException
     end
 
+    class ResponseMismatch < ModBusException
+      attr_reader :request, :response
+      def initialize(msg, request, response)
+        super(msg)
+        @request = request
+        @response = response
+      end 
+    end
   end
-
 end

data/lib/rmodbus/ext.rb

@@ -27,7 +27,13 @@ class String
     end
     array_bit
   end
-  
+ 
+  # Get word by index
+  # @param [Integer] i index first bytes of word
+  # @return unpacked word
+  def getword(i)
+    self[i,2].unpack('n')[0]
+  end
 end
 
 class Integer

data/lib/rmodbus/options.rb

@@ -0,0 +1,21 @@
+# RModBus - free implementation of ModBus protocol in Ruby.
+#
+# Copyright (C) 2011  Timin Aleksey
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+module ModBus
+  module Options
+    attr_accessor :raise_exception_on_mismatch, 
+                  :read_retries, :read_retry_timeout 
+  end
+end
+

data/lib/rmodbus/rtu.rb

@@ -23,6 +23,7 @@ module ModBus
       msg = nil
       while msg.nil?
 	      msg = io.read(2)
+        sleep(0.01)
       end
 
       function_code = msg.getbyte(1)
@@ -44,6 +45,32 @@ module ModBus
       end
     end
 
+    def send_rtu_pdu(pdu)
+      msg = @uid.chr + pdu
+      msg << crc16(msg).to_word
+      @io.write msg
+
+      log "Tx (#{msg.size} bytes): " + logging_bytes(msg)
+    end
+
+    def read_rtu_pdu
+      msg = read_rtu_response(@io)
+
+      log "Rx (#{msg.size} bytes): " + logging_bytes(msg)
+
+      if msg.getbyte(0) == @uid
+        return msg[1..-3] if msg[-2,2].unpack('n')[0] == crc16(msg[0..-3])
+        log "Ignore package: don't match CRC"
+      else
+        log "Ignore package: don't match uid ID"
+      end
+      loop do
+        #waite timeout
+        sleep(0.1)
+      end
+    end
+
+
     def read_rtu_request(io)
 			# Read the slave_id and function code
 			msg = io.read(2)
@@ -83,6 +110,7 @@ module ModBus
           log "Server TX (#{resp.size} bytes): #{logging_bytes(resp)}"
           io.write resp
 		    end
+        sleep(0.01)
 	    end
     end
 

data/lib/rmodbus/rtu_server.rb

@@ -11,8 +11,7 @@
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-require 'serialport'
-
+#
 module ModBus
   # RTU server implementation
   # @example
@@ -24,7 +23,7 @@ module ModBus
   #   srv.debug = true
   #   srv.start
   class RTUServer
-    include Common
+    include Debug
     include Server
     include RTU
     include SP

data/lib/rmodbus/rtu_slave.rb

@@ -26,34 +26,17 @@ module ModBus
   class RTUSlave < Slave
     include RTU
 
-    protected
-
+    private
     # overide method for RTU implamentaion
     # @see Slave#query
     def send_pdu(pdu)
-      msg = @uid.chr + pdu
-      msg << crc16(msg).to_word
-      @io.write msg
-
-      log "Tx (#{msg.size} bytes): " + logging_bytes(msg)
+      send_rtu_pdu(pdu)
     end
 
     # overide method for RTU implamentaion
     # @see Slave#query
     def read_pdu
-	    msg = read_rtu_response(@io)
-
-      log "Rx (#{msg.size} bytes): " + logging_bytes(msg)
-
-      if msg.getbyte(0) == @uid
-        return msg[1..-3] if msg[-2,2].unpack('n')[0] == crc16(msg[0..-3])
-        log "Ignore package: don't match CRC"
-      else
-        log "Ignore package: don't match uid ID"
-      end
-      loop do
-        #waite timeout
-      end
+      read_rtu_pdu
     end
   end
 end

data/lib/rmodbus/rtu_via_tcp_server.rb

@@ -26,7 +26,7 @@ module ModBus
   #   srv.debug = true
   #   srv.start
   class RTUViaTCPServer < GServer
-    include Common
+    include Debug
     include RTU
     include Server
 

data/lib/rmodbus/rtu_via_tcp_slave.rb

@@ -26,33 +26,17 @@ module ModBus
   class RTUViaTCPSlave < Slave
 		include RTU
 
-		protected
-    # overide method for RTU over TCP implamentaion
+    private
+    # overide method for RTU implamentaion
     # @see Slave#query
-		def send_pdu(pdu)
-			msg = @uid.chr + pdu
-			msg << crc16(msg).to_word
-			@io.write msg
+    def send_pdu(pdu)
+      send_rtu_pdu(pdu)
+    end
 
-			log "Tx (#{msg.size} bytes): " + logging_bytes(msg)
-		end
-
-    # overide method for RTU over TCP implamentaion
+    # overide method for RTU implamentaion
     # @see Slave#query
-		def read_pdu
-			# Read the response appropriately
-			msg = read_rtu_response(@io)
-
-			log "Rx (#{msg.size} bytes): " + logging_bytes(msg)
-			if msg.getbyte(0) == @uid
-				return msg[1..-3] if msg[-2,2].unpack('n')[0] == crc16(msg[0..-3])
-				log "Ignore package: don't match CRC"
-			else
-				log "Ignore package: don't match uid ID"
-			end
-			loop do
-				#waite timeout
-			end
-		end
+    def read_pdu
+      read_rtu_pdu
+    end
 	end
 end

data/lib/rmodbus/slave.rb

@@ -16,10 +16,10 @@
 module ModBus
   class Slave
     include Errors
-  	include Common
+    include Debug
+    include Options
     # Number of times to retry on read and read timeouts
-    attr_accessor :read_retries, :read_retry_timeout, :uid
-
+    attr_accessor :uid
     Exceptions = {
           1 => IllegalFunction.new("The function code received in the query is not an allowable action for the server"),
           2 => IllegalDataAddress.new("The data address received in the query is not an allowable address for the server"),
@@ -31,8 +31,6 @@ module ModBus
     }
     def initialize(uid, io)
 	    @uid = uid
-      @read_retries = 10
-      @read_retry_timeout = 1
       @io = io
     end
 
@@ -231,6 +229,7 @@ module ModBus
     # @param [String] pdu request to slave
     # @return [String] received data
     #
+    # @raise [ResponseMismatch] the received echo response differs from the request
     # @raise [ModBusTimeout] timed out during read attempt
     # @raise [ModBusException] unknown error
     # @raise [IllegalFunction] function code received in the query is not an allowable action for the server
@@ -240,12 +239,13 @@ module ModBus
     # @raise [Acknowledge] server has accepted the request and is processing it, but a long duration of time will be required to do so
     # @raise [SlaveDeviceBus] server is engaged in processing a long duration program command
     # @raise [MemoryParityError] extended file area failed to pass a consistency check
-    def query(pdu)
+    def query(request)
       tried = 0
+      response = ""
       begin
         timeout(@read_retry_timeout, ModBusTimeout) do
-          send_pdu(pdu)
-          pdu = read_pdu
+          send_pdu(request)
+          response = read_pdu
         end
       rescue ModBusTimeout => err
         log "Timeout of read operation: (#{@read_retries - tried})"
@@ -254,15 +254,70 @@ module ModBus
         raise ModBusTimeout.new, "Timed out during read attempt"
       end
 
-      return nil if pdu.size == 0
+      return nil if response.size == 0
 
-      if pdu.getbyte(0) >= 0x80
-        exc_id = pdu.getbyte(1)
+      read_func = response.getbyte(0)
+      if read_func >= 0x80
+        exc_id = response.getbyte(1)
         raise Exceptions[exc_id] unless Exceptions[exc_id].nil?
 
         raise ModBusException.new, "Unknown error"
       end
-      pdu[2..-1]
+
+      check_response_mismatch(request, response) if raise_exception_on_mismatch
+      response[2..-1]
+    end
+
+    private
+    def check_response_mismatch(request, response)
+      read_func = response.getbyte(0)
+      data = response[2..-1]
+      #Mismatch functional code
+      send_func = request.getbyte(0)
+      if read_func != send_func
+        msg = "Function code is mismatch (expected #{send_func}, got #{read_func})"
+      end
+
+      case read_func
+      when 1,2
+        bc = request.getword(3)/8 + 1
+        if data.size != bc
+          msg = "Byte count is mismatch (expected #{bc}, got #{data.size} bytes)"
+        end
+      when 3,4
+        rc = request.getword(3) 
+        if data.size/2 != rc
+          msg = "Register count is mismatch (expected #{rc}, got #{data.size/2} regs)"
+        end
+      when 5,6
+        exp_addr = request.getword(1)
+        got_addr = response.getword(1)
+        if exp_addr != got_addr
+          msg = "Address is mismatch (expected #{exp_addr}, got #{got_addr})"
+        end
+
+        exp_val = request.getword(3)
+        got_val = response.getword(3)
+        if exp_val != got_val
+          msg = "Value is mismatch (expected 0x#{exp_val.to_s(16)}, got 0x#{got_val.to_s(16)})"
+        end
+      when 15,16
+        exp_addr = request.getword(1)
+        got_addr = response.getword(1)
+        if exp_addr != got_addr
+          msg = "Address is mismatch (expected #{exp_addr}, got #{got_addr})"
+        end
+      
+        exp_quant = request.getword(3)
+        got_quant = response.getword(3)
+        if exp_quant != got_quant
+          msg = "Quantity is mismatch (expected #{exp_quant}, got #{got_quant})"
+        end
+      else
+        warn "Fuiction (#{read_func}) is not supported raising response mismatch"
+      end
+
+      raise ResponseMismatch.new(msg, request, response) if msg
     end
   end
 end

data/lib/rmodbus/sp.rb

@@ -12,8 +12,6 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 
-require 'serialport'
-
 module ModBus
   module SP
     attr_reader :port, :baud, :data_bits, :stop_bits, :parity, :read_timeout
@@ -42,4 +40,5 @@ module ModBus
       io
     end
   end
-end
+end
+

data/lib/rmodbus/tcp_server.rb

@@ -1,19 +1,19 @@
-# RModBus - free implementation of ModBus protocol on Ruby.
-#
-# Copyright (C) 2008  Timin Aleksey
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-require 'gserver'
-
-module ModBus
+# RModBus - free implementation of ModBus protocol on Ruby.
+#
+# Copyright (C) 2008-2011  Timin Aleksey
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+require 'gserver'
+
+module ModBus
   # TCP server implementation
   # @example
   #   srv = TCPServer.new(10002, 1)
@@ -22,45 +22,43 @@ module ModBus
   #   srv.holding_registers = [1,2,3,4]
   #   srv.input_registers = [1,2,3,4]
   #   srv.debug = true
-  #   srv.start
-	class TCPServer < GServer
-		include Common
-		include Server 
-    
+  #   srv.start
+	class TCPServer < GServer
+		include Debug
+		include Server 
+    
     # Init server
     # @param [Integer] port listen port
-    # @param [Integer] uid slave device
-    # @param [Hash] opts options of server
+    # @param [Integer] uid slave device
+    # @param [Hash] opts options of server
     # @option opts [String] :host host of server default '127.0.0.1'
-    # @option opts [Float, Integer] :max_connection max of TCP connection with server default 4
-		def initialize(port = 502, uid = 1, opts = {})
-			@uid = uid
-      opts[:host] = DEFAULT_HOST unless opts[:host]
-      opts[:max_connection] = 4 unless opts[:max_connection]
-			super(port, host = opts[:host], maxConnection = opts[:max_connection])
-		end
-
+    # @option opts [Float, Integer] :max_connection max of TCP connection with server default 4
+		def initialize(port = 502, uid = 1, opts = {})
+			@uid = uid
+      opts[:host] = DEFAULT_HOST unless opts[:host]
+      opts[:max_connection] = 4 unless opts[:max_connection]
+			super(port, host = opts[:host], maxConnection = opts[:max_connection])
+		end
+
     # Serve requests
-    # @param [TCPSocket] io socket
-		def serve(io)
-			loop do
-				req = io.read(7)
-				if req[2,2] != "\x00\x00" or req.getbyte(6) != @uid
-					io.close
-					break
-				end
-
-				tr = req[0,2]
-				len = req[4,2].unpack('n')[0]
-				req = io.read(len - 1)
-				log "Server RX (#{req.size} bytes): #{logging_bytes(req)}"
-
-				pdu = exec_req(req, @coils, @discrete_inputs, @holding_registers, @input_registers)
-
-				resp = tr + "\0\0" + (pdu.size + 1).to_word + @uid.chr + pdu
-				log "Server TX (#{resp.size} bytes): #{logging_bytes(resp)}"
-				io.write resp
-			end
-		end
-	end
-end
+    # @param [TCPSocket] io socket
+		def serve(io)
+			while not stopped? 
+				req = io.read(7)
+				if req[2,2] == "\x00\x00" or req.getbyte(6) == @uid
+          tr = req[0,2]
+          len = req[4,2].unpack('n')[0]
+          req = io.read(len - 1)
+          log "Server RX (#{req.size} bytes): #{logging_bytes(req)}"
+
+          pdu = exec_req(req, @coils, @discrete_inputs, @holding_registers, @input_registers)
+
+          resp = tr + "\0\0" + (pdu.size + 1).to_word + @uid.chr + pdu
+          log "Server TX (#{resp.size} bytes): #{logging_bytes(resp)}"
+          io.write resp
+        end
+        sleep(0.01)
+			end
+		end
+	end
+end

data/lib/rmodbus/version.rb

@@ -13,5 +13,5 @@
 # GNU General Public License for more details.
 module ModBus
   # Package version
-  VERSION = '1.0.4'
-end
+  VERSION = '1.1.0'
+end