rmodbus 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32a45f98ff103499e6446a926f9819928716602a
-  data.tar.gz: 0f883902d6eb8a80330769ca519e69915343d857
+  metadata.gz: 72ada248b0d55d8dfecb8cb022e30e0dbd4e50b3
+  data.tar.gz: 8de3ae040a26b173faa3bb1eca98b6d9bdba37c8
 SHA512:
-  metadata.gz: e050abe8430ef0b8f58bc953c249b6b8143d90e673889c3ec91723deba0888d8ddf081ba7efcfbba7a3517a1287bce028386e203505156c5cb00a40005fa2ad2
-  data.tar.gz: 0badca7a5158d6ab27d094c27f3c1b030a14c70e50079fedf4533041d5f340e6fa871d8383ab3e3f5cfb53fa8dea413efca44bb217e8525b2bec602b01dd81d7
+  metadata.gz: 52ba64f23e37297732981cfb7a21f0633b4959b813a20005903148539cb341086250135ff7607c68d7c204e5c71d93be428ea6bf78253409ef7bce153d1e1008
+  data.tar.gz: acc3b11d3b438c2af0ed52dcb2126f1e7360523efb6135ecd933999550869b57a5820d034ee6907277a0ca6b879084f7b0bdf5b0b04d4ebc26deab72edad18af

data/NEWS.md

@@ -1,3 +1,10 @@
+###2015-07-30 Release 1.2.7
+
+1. RTUServer doesn't stop serving when there is no RTU messages. Pull request [#37](https://github.com/flipback/rmodbus/pull/37).
+2. Fixed a bug with flushing buffer in RTUviaTCPClient.
+3. Added validation for UDI in TCPServer. See request [#38](https://github.com/flipback/rmodbus/pull/38).
+4. Added a warning message to ask use UID=255 for TCP Server  according to the protocol specification.
+
 ###2015-03-21 Release 1.2.6
 
 1. Fixed issue [#35](https://github.com/flipback/rmodbus/issues/35).

data/README.md

@@ -1,7 +1,7 @@
 RModBus [![Build Status](https://secure.travis-ci.org/flipback/rmodbus.png)](http://travis-ci.org/flipback/rmodbus)
 ==========================
 
-**RModBus** - free implementation of protocol ModBus written in pure Ruby.
+**RModBus** - free implementation of ModBus protocol in pure Ruby.
 
 Features
 ---------------------------
@@ -25,9 +25,11 @@ Support functions
 Installation
 ------------------------------------
 
-Download and install RModBus with the following
+Download and install RModBus with the following:
 
-**$ gem install rmodbus**
+```
+gem install rmodbus
+```
 
 Example
 ------------------------------------
@@ -55,15 +57,17 @@ Example
 GitHub
 ----------------------------------
 
-You can checkout source code from GitHub repositry
+You can checkout source code from GitHub repository:
 
-**$ git clone git://github.com/flipback/RModBus.git**
+```
+git clone git://github.com/flipback/RModBus.git
+```
 
 Reference
 ----------------------------------
 
 Home page: http://rmodbus.flipback.net
 
-RModBud on GitHub: http://github.com/flipback/RModBus
+RModBus on GitHub: http://github.com/flipback/RModBus
 
-ModBus community: http://www.modbus-ida.org
+ModBus specifications: http://www.modbus.org/specs.php

data/lib/rmodbus/rtu.rb

@@ -46,7 +46,11 @@ module ModBus
 
     def clean_input_buff
       # empty the input buffer
-      @io.flush_input
+      if @io.class.public_method_defined? :flush_input
+        @io.flush_input 
+      else
+        @io.flush
+      end
     end
 
     def send_rtu_pdu(pdu)
@@ -105,8 +109,8 @@ module ModBus
       loop do
         # read the RTU message
         msg = read_rtu_request(io)
-        # If there is no RTU message, we're done serving this client
-        break if msg.nil?
+
+        next if msg.nil?
 
         if msg.getbyte(0) == @uid and msg[-2,2].unpack('n')[0] == crc16(msg[0..-3])
           pdu = yield msg

data/lib/rmodbus/tcp_server.rb

@@ -25,8 +25,8 @@ module ModBus
   #   srv.start
 	class TCPServer < GServer
 		include Debug
-		include Server 
-    
+		include Server
+
     # Init server
     # @param [Integer] port listen port
     # @param [Integer] uid slave device
@@ -35,6 +35,9 @@ module ModBus
     # @option opts [Float, Integer] :max_connection max of TCP connection with server default 4
 		def initialize(port = 502, uid = 1, opts = {})
 			@uid = uid
+
+      warn "[WARNING] Please, use UID = 255. It will be fixed in the next release." if @uid != 0xff
+
       opts[:host] = DEFAULT_HOST unless opts[:host]
       opts[:max_connection] = 4 unless opts[:max_connection]
 			super(port, host = opts[:host], maxConnection = opts[:max_connection])
@@ -42,22 +45,28 @@ module ModBus
 
     # Serve requests
     # @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]
+    def serve(io)
+      while not stopped?
+        header = io.read(7)
+        tx_id = header[0,2]
+        proto_id = header[2,2]
+        len = header[4,2].unpack('n')[0]
+        unit_id = header.getbyte(6)
+        if proto_id == "\x00\x00"
           req = io.read(len - 1)
-          log "Server RX (#{req.size} bytes): #{logging_bytes(req)}"
+          if unit_id == @uid || unit_id == 0
+            log "Server RX (#{req.size} bytes): #{logging_bytes(req)}"
 
-          pdu = exec_req(req, @coils, @discrete_inputs, @holding_registers, @input_registers)
+            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
+            resp = tx_id + "\0\0" + (pdu.size + 1).to_word + @uid.chr + pdu
+            log "Server TX (#{resp.size} bytes): #{logging_bytes(resp)}"
+            io.write resp
+          else
+            log "Ignored server RX (invalid unit ID #{unit_id}, #{req.size} bytes): #{logging_bytes(req)}"
+          end
         end
-			end
-		end
+      end
+    end
 	end
 end

data/lib/rmodbus/version.rb

@@ -1,6 +1,6 @@
 # RModBus - free implementation of ModBus protocol on Ruby.
 #
-# Copyright (C) 2012  Timin Aleksey
+# Copyright (C) 2012-2015  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
@@ -13,5 +13,5 @@
 # GNU General Public License for more details.
 module ModBus
   # Package version
-  VERSION = '1.2.6'
+  VERSION = '1.2.7'
 end

data/spec/client_spec.rb

@@ -41,23 +41,23 @@ describe ModBus::Client do
   it 'should common for all slaves :debug flag' do
     @cl.debug = true
     @cl.with_slave(1) do |slave_1|
-      slave_1.debug.should be_true
+      slave_1.debug.should be_truthy
     end
     @cl.with_slave(2) do |slave_2|
       slave_2.debug = false
-      slave_2.debug.should be_false
+      slave_2.debug.should be_falsey
     end
   end
 
   it 'should common for all slaves :raise_exception_on_mismatch flag' do
     @cl.raise_exception_on_mismatch = true
     @cl.with_slave(1) do |slave_1|
-      slave_1.raise_exception_on_mismatch.should be_true
+      slave_1.raise_exception_on_mismatch.should be_truthy
     end
 
     @cl.with_slave(2) do |slave_2|
       slave_2.raise_exception_on_mismatch = false
-      slave_2.raise_exception_on_mismatch.should be_false
+      slave_2.raise_exception_on_mismatch.should be_falsey
     end
   end
   

data/spec/logging_spec.rb

@@ -4,11 +4,11 @@ require 'rmodbus'
 describe ModBus::TCPClient  do
   before(:each) do
     @uid = 1
-    @sock = mock("Socket")
+    @sock = double('Socket')
     @adu = "\000\001\000\000\000\001\001"
 
     TCPSocket.should_receive(:new).with('127.0.0.1', 1502).and_return(@sock)
-    @sock.stub!(:read).with(0).and_return('')
+    @sock.stub(:read).with(0).and_return('')
 
     @slave = ModBus::TCPClient.new('127.0.0.1', 1502).with_slave(@uid)
     @slave.debug = true
@@ -55,14 +55,19 @@ begin
   require "serialport"
   describe ModBus::RTUClient do
     before do 
-      @sp = mock('Serial port')
-      SerialPort.should_receive(:new).with("/dev/port1", 9600, 7, 2, SerialPort::ODD).and_return(@sp)    
-      
+      @sp = double('Serial port')
+
+      SerialPort.should_receive(:new).with("/dev/port1", 9600, 7, 2, SerialPort::ODD).and_return(@sp)
+      SerialPort.stub(:public_method_defined?).with(:flush_input).and_return(true)
+
+      @sp.stub(:class).and_return(SerialPort)
       @sp.should_receive(:flow_control=).with(SerialPort::NONE)
-      @sp.stub!(:read_timeout=)
-      
+      @sp.stub(:read_timeout=)
+      @sp.stub(:flush_input)
+
       @slave = ModBus::RTUClient.new("/dev/port1", 9600, :data_bits => 7, :stop_bits => 2, :parity => SerialPort::ODD).with_slave(1)
       @slave.read_retries = 0
+
     end
     
     it 'should log rec\send bytes' do

data/spec/proxy_spec.rb

@@ -3,7 +3,7 @@ require 'rmodbus'
 
 describe Array do
   before do
-    @slave = mock('ModBus Slave')
+    @slave = double('ModBus Slave')
     @coil_proxy = ModBus::ReadWriteProxy.new(@slave, :coil)
     @discrete_input_proxy = ModBus::ReadOnlyProxy.new(@slave, :discrete_input)
     @holding_register_proxy = ModBus::ReadWriteProxy.new(@slave, :holding_register)

data/spec/rtu_client_spec.rb

@@ -3,11 +3,15 @@ require 'rmodbus'
 
 describe ModBus::RTUClient do
   before do 
-    @sp = mock('Serial port')
+    @sp = double('Serial port')
+
     SerialPort.should_receive(:new).with("/dev/port1", 9600, 8, 1, 0).and_return(@sp)    
-    @sp.stub!(:read_timeout=)
+    SerialPort.stub(:public_method_defined?).with(:flush_input).and_return(true)
+
+    @sp.stub(:read_timeout=)
+    @sp.stub(:class).and_return(SerialPort)
     @sp.should_receive(:flow_control=).with(SerialPort::NONE)
-    @sp.stub!(:flush_input)
+    @sp.stub(:flush_input)
 
     @cl = ModBus::RTUClient.new("/dev/port1", 9600, :data_bits => 8, :stop_bits => 1, :parity => SerialPort::NONE)
     @slave = @cl.with_slave(1)

data/spec/rtu_server_spec.rb

@@ -3,9 +3,9 @@ require 'rmodbus'
 
 describe ModBus::RTUServer do
   before do
-    @sp = mock "SerialPort"
+    @sp = double('SerialPort')
     SerialPort.should_receive(:new).with('/dev/ttyS0', 4800, 7, 2, SerialPort::NONE).and_return(@sp)
-    @sp.stub!(:read_timeout=)
+    @sp.stub(:read_timeout=)
     @sp.should_receive(:flow_control=).with(SerialPort::NONE)
 
     @server = ModBus::RTUServer.new('/dev/ttyS0', 4800, 1, :data_bits => 7, :stop_bits => 2)

data/spec/rtu_via_tcp_client_spec.rb

@@ -4,10 +4,10 @@ require 'rmodbus'
 describe ModBus::RTUViaTCPClient do
   describe "method 'query'" do    
     before do 
-      @sock = mock('Socked')
+      @sock = double('Socket')
       TCPSocket.should_receive(:new).with("127.0.0.1", 10002).and_return(@sock)    
-      @sock.stub!(:read_timeout=)
-      @sock.stub!(:flush_input)
+      @sock.stub(:read_timeout=)
+      @sock.stub(:flush)
       
       @cl = ModBus::RTUViaTCPClient.new("127.0.0.1")
       @slave = @cl.with_slave(1)

data/spec/slave_spec.rb

@@ -5,7 +5,7 @@ describe ModBus::Slave do
   before do
     @slave = ModBus::Client.new.with_slave(1)
 
-    @slave.stub!(:query).and_return('')
+    @slave.stub(:query).and_return('')
   end
 
   it "should support function 'read coils'" do

data/spec/tcp_client_spec.rb

@@ -5,11 +5,11 @@ describe ModBus::TCPClient do
   describe "method 'query'" do    
     before(:each) do
       @uid = 1
-      @sock = mock("Socket")
+      @sock = double('Socket')
       @adu = "\000\001\000\000\000\001\001"
   
       TCPSocket.should_receive(:new).with('127.0.0.1', 1502).and_return(@sock)
-      @sock.stub!(:read).with(0).and_return('')
+      @sock.stub(:read).with(0).and_return('')
       @cl = ModBus::TCPClient.new('127.0.0.1', 1502)
       @slave = @cl.with_slave(@uid)
     end
@@ -33,8 +33,8 @@ describe ModBus::TCPClient do
     it 'should throw timeout exception if do not get own transaction' do
       @slave.read_retries = 2
       @adu[0,2] = @slave.transaction.next.to_word
-      @sock.should_receive(:write).any_number_of_times.with(/\.*/)
-      @sock.should_receive(:read).any_number_of_times.with(7).and_return("\000\x3\000\000\000\001" + @uid.chr)
+      @sock.should_receive(:write).at_least(1).times.with(/\.*/)
+      @sock.should_receive(:read).at_least(1).times.with(7).and_return("\000\x3\000\000\000\001" + @uid.chr)
 
       expect{ @slave.query('') }.to raise_error(ModBus::Errors::ModBusTimeout, "Timed out during read attempt")
     end

data/spec/tcp_server_spec.rb

@@ -3,23 +3,28 @@ require "rmodbus"
 
 describe ModBus::TCPServer do
   before :all do
-    @server = ModBus::TCPServer.new(8502,1)
+    unit_ids = (1..247).to_a.shuffle
+    valid_unit_id = unit_ids.first
+    @invalid_unit_id = unit_ids.last
+    @server = ModBus::TCPServer.new(8502, valid_unit_id)
     @server.coils = [1,0,1,1]
     @server.discrete_inputs = [1,1,0,0]
     @server.holding_registers = [1,2,3,4]
     @server.input_registers = [1,2,3,4]
     @server.start
     @cl = ModBus::TCPClient.new('127.0.0.1', 8502)
-    @slave = @cl.with_slave(1)
-    @slave.read_retries = 1
+    @cl.read_retries = 1
+    @slave = @cl.with_slave(valid_unit_id)
   end
 
-  it "should silent if UID has mismatched" do
-    @cl.with_slave(2).read_coils(1,3)
-    #lambda { @cl.with_slave(2).read_coils(1,3) }.should raise_exception(
-    #  ModBus::Errors::ModBusException,
-    #  "Server did not respond"
-    #)
+  it "should succeed if UID is broadcast" do
+    @cl.with_slave(0).read_coils(1,3)
+  end
+
+  it "should fail if UID is mismatched" do
+    lambda { @cl.with_slave(@invalid_unit_id).read_coils(1,3) }.should raise_exception(
+      ModBus::Errors::ModBusTimeout
+    )
   end
 
   it "should send exception if function not supported" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rmodbus
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - A.Timin, J. Sanders, K. Reynolds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement