rmodbus-ccutrer 2.0.0 → 2.1.1

data/lib/rmodbus/tcp_server.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 begin
-  require 'gserver'
+  require "gserver"
 rescue
   warn "[WARNING] Install `gserver` gem for use TCPServer"
 end
@@ -13,11 +15,11 @@ 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
-		include Server
+  class TCPServer < GServer
+    include Debug
+    include Server
 
     # Init server
     # @param [Integer] port listen port
@@ -25,11 +27,11 @@ module ModBus
     # @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, opts = {})
+    def initialize(port = 502, opts = {})
       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
+      super(port, opts[:host], opts[:max_connection])
+    end
 
     # set the default param
     def with_slave(uid = 255)
@@ -39,29 +41,29 @@ module ModBus
     # Serve requests
     # @param [TCPSocket] io socket
     def serve(io)
-      while not stopped?
+      until stopped?
         header = io.read(7)
-        tx_id = header[0,2]
-        proto_id = header[2,2]
-        len = header[4,2].unpack('n')[0]
+        tx_id = header[0, 2]
+        proto_id = header[2, 2]
+        len = header[4, 2].unpack1("n")
         unit_id = header.getbyte(6)
-        if proto_id == "\x00\x00"
-          req = io.read(len - 1)
-          log "Server RX (#{req.size} bytes): #{logging_bytes(req)}"
+        next unless proto_id == "\x00\x00"
+
+        req = io.read(len - 1)
+        log "Server RX (#{req.size} bytes): #{logging_bytes(req)}"
 
-          func = req.getbyte(0)
-          params = parse_request(func, req)
-          pdu = exec_req(unit_id, func, params, req)
+        func = req.getbyte(0)
+        params = parse_request(func, req)
+        pdu = exec_req(unit_id, func, params, req)
 
-          if pdu
-            resp = tx_id + "\0\0" + (pdu.size + 1).to_word + unit_id.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
+        if pdu
+          resp = "#{tx_id}\x00\x00#{(pdu.size + 1).to_word}#{unit_id.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

data/lib/rmodbus/tcp_slave.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModBus
   # TCP slave implementation
   # @example
@@ -16,16 +18,17 @@ module ModBus
     # @see Slave::initialize
     def initialize(uid, io)
       @transaction = 0
-      super(uid, io)
+      super
     end
 
     private
+
     # overide method for RTU over TCP implamentaion
     # @see Slave#query
     def send_pdu(pdu)
-      @transaction = 0 if @transaction.next > 65535
+      @transaction = 0 if @transaction.next > 65_535
       @transaction += 1
-      msg = @transaction.to_word + "\0\0" + (pdu.size + 1).to_word + @uid.chr + pdu
+      msg = "#{@transaction.to_word}\x00\x00#{(pdu.size + 1).to_word}#{@uid.chr}#{pdu}"
       @io.write msg
 
       log "Tx (#{msg.size} bytes): " + logging_bytes(msg)
@@ -36,19 +39,17 @@ module ModBus
     def read_pdu
       loop do
         header = @io.read(7)
-        if header
-          trn = header[0,2].unpack('n')[0]
-          len = header[4,2].unpack('n')[0]
-          msg = @io.read(len-1)
-
-          log "Rx (#{(header + msg).size} bytes): " + logging_bytes(header + msg)
-
-          if trn == @transaction
-            return msg
-          else
-            log "Transaction number mismatch. A packet is ignored."
-          end
-        end
+        next unless header
+
+        trn = header[0, 2].unpack1("n")
+        len = header[4, 2].unpack1("n")
+        msg = @io.read(len - 1)
+
+        log "Rx (#{(header + msg).size} bytes): " + logging_bytes(header + msg)
+
+        return msg if trn == @transaction
+
+        log "Transaction number mismatch. A packet is ignored."
       end
     end
   end

data/lib/rmodbus/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModBus
-  VERSION = '2.0.0'
+  VERSION = "2.1.1"
 end

data/lib/rmodbus.rb

@@ -1,21 +1,23 @@
-require 'rmodbus/ext'
-require 'rmodbus/proxy'
-require 'rmodbus/version'
+# frozen_string_literal: true
+
+require "rmodbus/ext"
+require "rmodbus/proxy"
+require "rmodbus/version"
 
 module ModBus
-  autoload :Errors, 'rmodbus/errors'
-  autoload :Debug, 'rmodbus/debug'
-  autoload :Options, 'rmodbus/options'
-  autoload :SP, 'rmodbus/sp'
-  autoload :RTU, 'rmodbus/rtu'
-  autoload :TCP, 'rmodbus/tcp'
-  autoload :Client, 'rmodbus/client'
-  autoload :Server, 'rmodbus/server'
-  autoload :TCPSlave, 'rmodbus/tcp_slave'
-  autoload :TCPClient, 'rmodbus/tcp_client'
-  autoload :TCPServer, 'rmodbus/tcp_server'
-  autoload :RTUSlave, 'rmodbus/rtu_slave'
-  autoload :RTUClient, 'rmodbus/rtu_client'
-  autoload :RTUServer, 'rmodbus/rtu_server'
-  autoload :RTUViaTCPServer, 'rmodbus/rtu_via_tcp_server'
+  autoload :Errors, "rmodbus/errors"
+  autoload :Debug, "rmodbus/debug"
+  autoload :Options, "rmodbus/options"
+  autoload :SP, "rmodbus/sp"
+  autoload :RTU, "rmodbus/rtu"
+  autoload :TCP, "rmodbus/tcp"
+  autoload :Client, "rmodbus/client"
+  autoload :Server, "rmodbus/server"
+  autoload :TCPSlave, "rmodbus/tcp_slave"
+  autoload :TCPClient, "rmodbus/tcp_client"
+  autoload :TCPServer, "rmodbus/tcp_server"
+  autoload :RTUSlave, "rmodbus/rtu_slave"
+  autoload :RTUClient, "rmodbus/rtu_client"
+  autoload :RTUServer, "rmodbus/rtu_server"
+  autoload :RTUViaTCPServer, "rmodbus/rtu_via_tcp_server"
 end

metadata

@@ -1,113 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: rmodbus-ccutrer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 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: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ccutrer-serialport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: gserver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: serialport
+  name: rubocop-inst
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: gserver
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 description: 
-email: atimin@gmail.com
+email: cody@cutrer.us
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -132,11 +146,10 @@ extra_rdoc_files:
 files:
 - NEWS.md
 - README.md
-- Rakefile
 - examples/perfomance_rtu.rb
 - examples/perfomance_rtu_via_tcp.rb
 - examples/perfomance_tcp.rb
-- examples/simple-xpca-gateway.rb
+- examples/simple_xpca_gateway.rb
 - examples/use_rtu_via_tcp_modbus.rb
 - examples/use_tcp_modbus.rb
 - lib/rmodbus.rb
@@ -160,25 +173,13 @@ files:
 - lib/rmodbus/tcp_server.rb
 - lib/rmodbus/tcp_slave.rb
 - lib/rmodbus/version.rb
-- spec/client_spec.rb
-- spec/exception_spec.rb
-- spec/ext_spec.rb
-- spec/logging_spec.rb
-- spec/proxy_spec.rb
-- spec/read_rtu_response_spec.rb
-- spec/response_mismach_spec.rb
-- spec/rtu_client_spec.rb
-- spec/rtu_server_spec.rb
-- spec/rtu_via_tcp_client_spec.rb
-- spec/rtu_via_tcp_server_spec.rb
-- spec/slave_spec.rb
-- spec/spec_helper.rb
-- spec/tcp_client_spec.rb
-- spec/tcp_server_spec.rb
-homepage: https://github.com/ccutrer/rmodbus
+homepage: https://github.com/rmodbus/rmodbus
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/rmodbus/rmodbus/blob/main/NEWS.md
+  source_code_uri: https://github.com/rmodbus/rmodbus
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options:
 - "--title"
@@ -192,14 +193,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: RModBus - free implementation of protocol ModBus

data/Rakefile

@@ -1,29 +0,0 @@
-# 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
-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

data/examples/simple-xpca-gateway.rb

@@ -1,84 +0,0 @@
-=begin
-It's very simple example of implementation XPCA gateway (see http://www.xpca.org)
-for communication with TCP ModBus devices
-It receives  REST requests (e.g http://127.0.0.1:4567/mb/127.0.0.1/8502/1/coils/6/17 )
-and returns data in JSON format addr : data:
-{"coils": {
-  "6":{
-    "value":0,
-    "timestamp":"2011-07-12 18:11:03 +0000",
-    "quality":"good"
-  },
-  "7":{
-    "value":0,
-    "timestamp":"2011-07-12 18:11:03 +0000",
-    "quality":"good"
-    }
-  ...
-}
-
-This code requies gems: rmodbus, sinatra and json
-2011 (c) Aleksey Timin
-=end
-
-require 'rubygems'
-require 'rmodbus'
-require 'sinatra'
-require 'json'
-
-# Launche TCP ModBus server for test
-IP = '127.0.0.1'
-PORT = 8502
-
-@srv = ModBus::TCPServer.new(PORT,1)
-
-@srv.holding_registers = Array.new(100) { |i| i = i + 1  }
-@srv.input_registers = Array.new(100) { |i| i = i + 1  }
-@srv.coils = Array.new(100) { |i| i = 0 }
-@srv.discrete_inputs = Array.new(100) { |i| i = 0  }
-
-@srv.start
-
-
-# Calc a GET request
-# @example
-# http://127.0.0.1:4567/mb/127.0.0.1/8502/1/coils/6/17
-#
-# HTTP route: GET http://localhost/mb/:ip/:port/:slave/:dataplace/:firstaddr/:lastaddr
-#
-# :ip - ip addr of ModBus TCP Server
-# :port - port of ModBUs TCP Server
-# :slave - id of slave device
-# :dataplace - valid values: coils, discrete_inputs, input_registers, holding_registers
-# :firstaddr - first addr of registers(contacts)
-# :lastaddr - last addr of registers(contacts)
-get '/mb/:ip/:port/:slave/:dataplace/:firstaddr/:lastaddr' do
-  resp = {}
-  begin
-    data = []
-    ModBus::TCPClient.new(params[:ip].to_s, params[:port].to_i) do |cl|
-      cl.with_slave(params[:slave].to_i) do |slave|
-        slave.debug = true
-        dataplace = slave.send params[:dataplace]
-        data = dataplace[params[:firstaddr].to_i .. params[:lastaddr].to_i]
-      end
-    end
-
-    resp = { params[:dataplace] => {}}
-    data.each_with_index do |v,i|
-      resp[params[:dataplace]][params[:firstaddr].to_i + i] = {
-        :value => v,
-        :timestamp => Time.now.utc.strftime("%Y-%m-%d %H:%M:%S %z"),
-        :quality => "good"
-      }
-    end
-  rescue Exception => e
-    resp = { :error => {
-      :type => e.class,
-      :message => e.message }
-    }
-  end
-
-  content_type "application/json"
-  resp.to_json
-end

data/spec/client_spec.rb

@@ -1,88 +0,0 @@
-# -*- coding: ascii
-require 'rmodbus'
-
-describe ModBus::Client do
-  before do
-    @cl = ModBus::Client.new
-  end
-
-  it "should give object provider for slave" do
-    slave = @cl.with_slave(1)
-    slave.uid.should eq(1)
-  end
-
-  it "should give object provider for slave in block" do
-    @cl.with_slave(1) do |slave|
-      slave.uid.should eq(1)
-    end
-  end
-  
-  it "should connect with TCP server" do
-    ModBus::Client.connect do |cl|
-      cl.should be_instance_of(ModBus::Client)
-    end
-  end
-  
-  it ":new alias :connect" do
-    ModBus::Client.new do |cl|
-      cl.should be_instance_of(ModBus::Client)
-    end
-  end
-
-  it "should close the connection when an exception is raised in the given block" do
-    expect {
-      ModBus::Client.new do |client|
-        client.should_receive(:close)
-        raise
-      end
-    }.to raise_error
-  end
-
-  it 'should common for all slaves :debug flag' do
-    @cl.debug = true
-    @cl.with_slave(1) do |slave_1|
-      slave_1.debug.should be_truthy
-    end
-    @cl.with_slave(2) do |slave_2|
-      slave_2.debug = 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_truthy
-    end
-
-    @cl.with_slave(2) do |slave_2|
-      slave_2.raise_exception_on_mismatch = false
-      slave_2.raise_exception_on_mismatch.should be_falsey
-    end
-  end
-  
-  it 'should common for all slaves :read_retries options' do
-   @cl.read_retries = 5
-    @cl.with_slave(1) do |slave_1|
-      slave_1.read_retries.should eql(5)
-    end
-
-    @cl.with_slave(2) do |slave_2|
-      slave_2.read_retries = 15
-      slave_2.read_retries.should eql(15)
-    end
-  end
-
-  it 'should common for all slaves :read_retry_timeout options' do
-   @cl.read_retry_timeout = 5
-    @cl.with_slave(1) do |slave_1|
-      slave_1.read_retry_timeout.should eql(5)
-    end
-
-    @cl.with_slave(2) do |slave_2|
-      slave_2.read_retry_timeout = 15
-      slave_2.read_retry_timeout.should eql(15)
-    end
-  end
-
-end