rmodbus-ccutrer 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06318cd10a9aca4e65b4c15d4f153ef13d976054429f8343ac3b5cc1304063bc'
-  data.tar.gz: 16fb3bfccd80ac8dd02b5c5dda1ab0aeafa9d06b59b8cf53e5938de5f07fcf34
+  metadata.gz: d3f1eb7faa783c285b4152b693b9f2ea3b9639917e589714b4bea416e483998e
+  data.tar.gz: 0e9005770dab3ca0336583e59a9c1c7d098b11267199a83e1d65339b7bd68a6c
 SHA512:
-  metadata.gz: af77c4b113a51dc669c6d1127d1613ea3b21ac6b93efee52f02f7cdf4f898e9b7bd5ad0f39a7372f7f4a9a7064de522469ec73f1af94ac27cb7df2d27b6021d6
-  data.tar.gz: 5586969c9caf0269c8408f4a9c79faa089fe29fbb204523238f2541d36ce84d5606596e6086f4b983d1d8eaaf45d0bbcbce75a95a305039345aff00ae66b89f2
+  metadata.gz: 8ee2ba1774e37c5e111fc0242056a5c8fb3cb3cec0b7243782e54f06e7c9d0d4e595bc51b7c1e9dea13f7d93b52ce83a2d23eec252f22c7e24e57df34e166fb7
+  data.tar.gz: 5c4732bd7e8edbd18e8cffb942911d5c7cf161beb8c0935fbb2ed521505adfe607fe46dc6f80e8ea74cb6c1a5f36641f52364f43eb51c06cf90a77df50f1683e

data/Rakefile

@@ -1,29 +1,9 @@
 # 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
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rake'
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-  begin
-    require 'serialport'
-  rescue LoadError => e
-    spec.pattern.exclude("spec/rtu_client_spec.rb", "spec/rtu_server_spec.rb")
-  end
-end
-
-task :default => :spec
-
-task :pry do
-  sh "bundle exec pry -r ./lib/rmodbus.rb"
-end
+Bundler::GemHelper.install_tasks

data/lib/rmodbus/client.rb

@@ -17,7 +17,7 @@ module ModBus
     # @return [Client] client object
     def initialize(*args, &block)
       # Defaults
-      @debug = false
+      @logger = nil
       @raise_exception_on_mismatch = false
       @read_retry_timeout = 1
       @read_retries = 1
@@ -49,7 +49,7 @@ module ModBus
     # @return [Slave] slave object
     def with_slave(uid, &block)
       slave = get_slave(uid, @io)
-      slave.debug = debug
+      slave.logger = logger
       slave.raise_exception_on_mismatch = raise_exception_on_mismatch
       slave.read_retries = read_retries
       slave.read_retry_timeout = read_retry_timeout

data/lib/rmodbus/debug.rb

@@ -2,15 +2,16 @@ require 'time'
 
 module ModBus
   module Debug
-    attr_accessor :debug, :raise_exception_on_mismatch,
-                  :read_retries, :read_retry_timeout
+    attr_accessor :raise_exception_on_mismatch,
+                  :read_retries, :read_retry_timeout,
+                  :logger
 
 
     private
     # Put log message on standard output
     # @param [String] msg message for log
     def log(msg)
-      $stdout.puts "#{Time.now.utc.iso8601(2)} #{msg}" if @debug
+      logger&.debug(msg)
     end
 
     # Convert string of byte to string for log

data/lib/rmodbus/rtu.rb

@@ -8,8 +8,7 @@ module ModBus
     # We have to read specific amounts of numbers of bytes from the network depending on the function code and content
     def read_rtu_response(io)
 	    # Read the slave_id and function code
-      msg = read(io, 2)
-      log logging_bytes(msg)
+      msg = read(io, 2)      
 
       function_code = msg.getbyte(1)
       case function_code

data/lib/rmodbus/rtu_server.rb

@@ -7,7 +7,7 @@ module ModBus
   #   slave.discrete_inputs = [1,1,0,0]
   #   slave.holding_registers = [1,2,3,4]
   #   slave.input_registers = [1,2,3,4]
-  #   srv.debug = true
+  #   srv.logger = Logger.new($stdout)
   #   srv.start
   class RTUServer
     include Debug

data/lib/rmodbus/rtu_via_tcp_server.rb

@@ -13,7 +13,7 @@ module ModBus
   #   slave.discrete_inputs = [1,1,0,0]
   #   slave.holding_registers = [1,2,3,4]
   #   slave.input_registers = [1,2,3,4]
-  #   srv.debug = true
+  #   srv.logger = Logger.new($stdout)
   #   srv.start
   class RTUViaTCPServer < GServer
     include Debug

data/lib/rmodbus/sp.rb

@@ -1,36 +1,31 @@
 begin
-  require 'serialport'
+  require 'ccutrer-serialport'
 rescue Exception => e
-  warn "[WARNING] Install `serialport` gem for use RTU protocols"
+  warn "[WARNING] Install `ccutrer-serialport` gem for use RTU protocols"
 end
 
 module ModBus
   module SP
     attr_reader :port, :baud, :data_bits, :stop_bits, :parity, :read_timeout
     # Open serial port
-    # @param [String] port name serial ports ("/dev/ttyS0" POSIX, "com1" - Windows)
+    # @param [String] port name serial ports ("/dev/ttyS0")
     # @param [Integer] baud rate serial port (default 9600)
     # @param [Hash] opts the options of serial port
     #
     # @option opts [Integer] :data_bits from 5 to 8
     # @option opts [Integer] :stop_bits 1 or 2
-    # @option opts [Integer] :parity NONE, EVEN or ODD
-    # @option opts [Integer] :read_timeout default 100 ms
+    # @option opts [Integer] :parity :none, :even or :odd
     # @return [SerialPort] io serial port
     def open_serial_port(port, baud, opts = {})
       @port, @baud = port, baud
 
-      @data_bits, @stop_bits, @parity, @read_timeout = 8, 1, SerialPort::NONE, 100
+      @data_bits, @stop_bits, @parity = 8, 1, :none
 
       @data_bits = opts[:data_bits] unless opts[:data_bits].nil?
       @stop_bits = opts[:stop_bits] unless opts[:stop_bits].nil?
       @parity = opts[:parity] unless opts[:parity].nil?
-      @read_timeout = opts[:read_timeout] unless opts[:read_timeout].nil?
 
-      io = SerialPort.new(@port, @baud, @data_bits, @stop_bits, @parity)
-      io.flow_control = SerialPort::NONE
-      io.read_timeout = @read_timeout
-      io
+      CCutrer::SerialPort.new(@port, baud: @baud, data_bits: @data_bits, stop_bits: @stop_bits, parity: @parity)
     end
   end
 end

data/lib/rmodbus/tcp_server.rb

@@ -13,7 +13,7 @@ module ModBus
   #   slave.discrete_inputs = [1,1,0,0]
   #   slave.holding_registers = [1,2,3,4]
   #   slave.input_registers = [1,2,3,4]
-  #   srv.debug = true
+  #   srv.logger = Logger.new($stdout)
   #   srv.start
 	class TCPServer < GServer
 		include Debug

data/lib/rmodbus/version.rb

@@ -1,3 +1,3 @@
 module ModBus
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/client_spec.rb

@@ -39,13 +39,13 @@ describe ModBus::Client do
   end
 
   it 'should common for all slaves :debug flag' do
-    @cl.debug = true
+    @cl.logger = true
     @cl.with_slave(1) do |slave_1|
-      slave_1.debug.should be_truthy
+      slave_1.logger.should eq true
     end
     @cl.with_slave(2) do |slave_2|
-      slave_2.debug = false
-      slave_2.debug.should be_falsey
+      slave_2.logger = false
+      slave_2.logger.should eq false
     end
   end
 

data/spec/logging_spec.rb

@@ -11,19 +11,19 @@ describe ModBus::TCPClient  do
     @sock.stub(:read).with(0).and_return('')
 
     @slave = ModBus::TCPClient.new('127.0.0.1', 1502).with_slave(@uid)
-    @slave.debug = true
+    @slave.logger = double("logger")
   end
 
   it 'should log rec\send bytes' do
     request, response = "\x3\x0\x6b\x0\x3", "\x3\x6\x2\x2b\x0\x0\x0\x64"
     mock_query(request,response)
-    $stdout.should_receive(:puts).with("Tx (12 bytes): [00][01][00][00][00][06][01][03][00][6b][00][03]")
-    $stdout.should_receive(:puts).with("Rx (15 bytes): [00][01][00][00][00][09][01][03][06][02][2b][00][00][00][64]")
+    @slave.logger.should_receive(:debug).with("Tx (12 bytes): [00][01][00][00][00][06][01][03][00][6b][00][03]")
+    @slave.logger.should_receive(:debug).with("Rx (15 bytes): [00][01][00][00][00][09][01][03][06][02][2b][00][00][00][64]")
     @slave.query(request)
   end
 
   it "should don't logging if debug disable" do
-    @slave.debug = false
+    @slave.logger = nil
     request, response = "\x3\x0\x6b\x0\x3", "\x3\x6\x2\x2b\x0\x0\x0\x64"
     mock_query(request,response)
     @slave.query(request)
@@ -35,10 +35,10 @@ describe ModBus::TCPClient  do
     @sock.should_receive(:read).with(7).and_return("\000\002\000\000\000\001" + @uid.chr)
     @sock.should_receive(:read).with(7).and_return("\000\001\000\000\000\001" + @uid.chr)
 
-    $stdout.should_receive(:puts).with("Tx (7 bytes): [00][01][00][00][00][01][01]")
-    $stdout.should_receive(:puts).with("Rx (7 bytes): [00][02][00][00][00][01][01]")
-    $stdout.should_receive(:puts).with("Transaction number mismatch. A packet is ignored.")
-    $stdout.should_receive(:puts).with("Rx (7 bytes): [00][01][00][00][00][01][01]")
+    @slave.logger.should_receive(:debug).with("Tx (7 bytes): [00][01][00][00][00][01][01]")
+    @slave.logger.should_receive(:debug).with("Rx (7 bytes): [00][02][00][00][00][01][01]")
+    @slave.logger.should_receive(:debug).with("Transaction number mismatch. A packet is ignored.")
+    @slave.logger.should_receive(:debug).with("Rx (7 bytes): [00][01][00][00][00][01][01]")
 
     @slave.query('')
   end
@@ -52,35 +52,28 @@ describe ModBus::TCPClient  do
 end
 
 begin
-  require "serialport"
+  require "ccutrer-serialport"
   describe ModBus::RTUClient do
     before do 
       @sp = double('Serial port')
+      allow(@sp).to receive(:flush)
 
-      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)
+      CCutrer::SerialPort.should_receive(:new).with("/dev/port1", baud: 9600, data_bits: 7, stop_bits: 2, parity: :odd).and_return(@sp)
 
-      @sp.stub(:class).and_return(SerialPort)
-      @sp.should_receive(:flow_control=).with(SerialPort::NONE)
-      @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 = ModBus::RTUClient.new("/dev/port1", 9600, :data_bits => 7, :stop_bits => 2, :parity => :odd).with_slave(1)
       @slave.read_retries = 0
-
     end
     
     it 'should log rec\send bytes' do
       request = "\x3\x0\x1\x0\x1"
       @sp.should_receive(:write).with("\1#{request}\xd5\xca")
-      @sp.should_receive(:flush_input)  # Clean a garbage
       @sp.should_receive(:read).with(2).and_return("\x1\x3")
       @sp.should_receive(:read).with(1).and_return("\x2")
       @sp.should_receive(:read).with(4).and_return("\xff\xff\xb9\xf4")
       
-      @slave.debug = true
-      $stdout.should_receive(:puts).with("Tx (8 bytes): [01][03][00][01][00][01][d5][ca]")
-      $stdout.should_receive(:puts).with("Rx (7 bytes): [01][03][02][ff][ff][b9][f4]")
+      @slave.logger = double("logger")
+      @slave.logger.should_receive(:debug).with("Tx (8 bytes): [01][03][00][01][00][01][d5][ca]")
+      @slave.logger.should_receive(:debug).with("Rx (7 bytes): [01][03][02][ff][ff][b9][f4]")
       
       @slave.query(request).should == "\xff\xff"
     end

data/spec/proxy_spec.rb

@@ -12,7 +12,7 @@ describe Array do
 
   # Handle all of the coil methods
   it "should call read_coil" do
-    @slave.should_receive(:read_coil).with(0, 1)
+    @slave.should_receive(:read_coil).with(0)
     @coil_proxy[0]
   end
   it "should call read_coils" do
@@ -31,7 +31,7 @@ describe Array do
 
   # Discrete input tests
   it "should call read_discrete_input" do
-    @slave.should_receive(:read_discrete_input).with(0, 1)
+    @slave.should_receive(:read_discrete_input).with(0)
     @discrete_input_proxy[0]
   end
 
@@ -43,7 +43,7 @@ describe Array do
 
   # Holding Register Tess
   it "should call read_holding_register" do
-    @slave.should_receive(:read_holding_register).with(0, 1)
+    @slave.should_receive(:read_holding_register).with(0)
     @holding_register_proxy[0]
   end
   it "should call read_holding_registers" do
@@ -62,7 +62,7 @@ describe Array do
 
   # Input Register Tests
   it "should call read_discrete_input" do
-    @slave.should_receive(:read_input_register).with(0, 1)
+    @slave.should_receive(:read_input_register).with(0)
     @input_register_proxy[0]
   end
 

data/spec/rtu_client_spec.rb

@@ -4,16 +4,11 @@ require 'rmodbus'
 describe ModBus::RTUClient do
   before do 
     @sp = double('Serial port')
+    allow(@sp).to receive(:flush)
 
-    SerialPort.should_receive(:new).with("/dev/port1", 9600, 8, 1, 0).and_return(@sp)    
-    SerialPort.stub(:public_method_defined?).with(:flush_input).and_return(true)
+    CCutrer::SerialPort.should_receive(:new).with("/dev/port1", baud: 9600, data_bits: 8, stop_bits: 1, parity: :none).and_return(@sp)    
 
-    @sp.stub(:read_timeout=)
-    @sp.stub(:class).and_return(SerialPort)
-    @sp.should_receive(:flow_control=).with(SerialPort::NONE)
-    @sp.stub(:flush_input)
-
-    @cl = ModBus::RTUClient.new("/dev/port1", 9600, :data_bits => 8, :stop_bits => 1, :parity => SerialPort::NONE)
+    @cl = ModBus::RTUClient.new("/dev/port1", 9600, :data_bits => 8, :stop_bits => 1, :parity => :none)
     @slave = @cl.with_slave(1)
     @slave.read_retries = 1
   end
@@ -41,16 +36,15 @@ describe ModBus::RTUClient do
 
   it 'should sugar connect method' do
     port, baud = "/dev/port1", 4800
-    SerialPort.should_receive(:new).with(port, baud, 8, 1, SerialPort::NONE).and_return(@sp)    
+    CCutrer::SerialPort.should_receive(:new).with(port, baud: baud, data_bits: 8, stop_bits: 1, parity: :none).and_return(@sp)    
     @sp.should_receive(:closed?).and_return(false)
     @sp.should_receive(:close)
-    @sp.should_receive(:flow_control=).with(SerialPort::NONE)
     ModBus::RTUClient.connect(port, baud) do |cl|
       cl.port.should == port
       cl.baud.should == baud
       cl.data_bits.should == 8
       cl.stop_bits.should == 1
-      cl.parity.should == SerialPort::NONE
+      cl.parity.should == :none
     end
   end
 

data/spec/rtu_server_spec.rb

@@ -4,9 +4,7 @@ require 'rmodbus'
 describe ModBus::RTUServer do
   before do
     @sp = double('SerialPort')
-    SerialPort.should_receive(:new).with('/dev/ttyS0', 4800, 7, 2, SerialPort::NONE).and_return(@sp)
-    @sp.stub(:read_timeout=)
-    @sp.should_receive(:flow_control=).with(SerialPort::NONE)
+    CCutrer::SerialPort.should_receive(:new).with('/dev/ttyS0', baud: 4800, data_bits: 7, stop_bits: 2, parity: :none).and_return(@sp)
 
     @server = ModBus::RTUServer.new('/dev/ttyS0', 4800, :data_bits => 7, :stop_bits => 2)
     @slave = @server.with_slave(1)
@@ -26,6 +24,6 @@ describe ModBus::RTUServer do
     @server.baud.should == 4800
     @server.data_bits.should == 7
     @server.stop_bits.should == 2
-    @server.parity.should == SerialPort::NONE
+    @server.parity.should == :none
   end
 end

data/spec/rtu_via_tcp_server_spec.rb

@@ -24,10 +24,6 @@ describe ModBus::RTUViaTCPServer do
     @io = @cl.instance_variable_get(:@io)
   end
 
-  before do
-    @server.debug = false
-  end
-
   it "should have options :host" do
     host = '192.168.0.1'
     srv = ModBus::RTUViaTCPServer.new(1010, :host => '192.168.0.1')
@@ -43,7 +39,6 @@ describe ModBus::RTUViaTCPServer do
   it "should properly ignore responses from other slaves" do
     request = "\x10\x03\x0\x1\x0\x1\xd6\x8b"
     response = "\x10\x83\x1\xd0\xf5"
-    @server.debug = true
     @server.should receive(:log).ordered.with("Server RX (8 bytes): [10][03][00][01][00][01][d6][8b]")
     @server.should receive(:log).ordered.with("Server RX function 3 to 16: {:quant=>1, :addr=>1}")
     @server.should receive(:log).ordered.with("Server RX (5 bytes): [10][83][01][d0][f5]")

metadata

@@ -1,99 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rmodbus-ccutrer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - A.Timin, J. Sanders, K. Reynolds, F. Luizão, C. Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
-  name: serialport
+  name: ccutrer-serialport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: gserver
   requirement: !ruby/object:Gem::Requirement