rmodbus-ccutrer 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '06318cd10a9aca4e65b4c15d4f153ef13d976054429f8343ac3b5cc1304063bc'
+  data.tar.gz: 16fb3bfccd80ac8dd02b5c5dda1ab0aeafa9d06b59b8cf53e5938de5f07fcf34
+SHA512:
+  metadata.gz: af77c4b113a51dc669c6d1127d1613ea3b21ac6b93efee52f02f7cdf4f898e9b7bd5ad0f39a7372f7f4a9a7064de522469ec73f1af94ac27cb7df2d27b6021d6
+  data.tar.gz: 5586969c9caf0269c8408f4a9c79faa089fe29fbb204523238f2541d36ce84d5606596e6086f4b983d1d8eaaf45d0bbcbce75a95a305039345aff00ae66b89f2

data/NEWS.md

@@ -0,0 +1,180 @@
+###UPCOMING
+
+1. [BREAKING] Servers now support publishing multiple slaves
+2. [BREAKING] RTUViaTCPClient/RTUViaTCPSlave are gone. Please just use RTUClient directly
+3. [BREAKING] Proxy collections no longer return an array when requesting a single item.
+3. Don't time out waiting to read a response that will never come from broadcast commands
+4. Don't send responses to broadcast commands as a server
+5. Properly function as a server in an environment with multiple RTU slaves
+6. Server now supports promiscuous mode to dump the conversation happening between a master and other slaves.
+7. Add read/write multiple registers function (server and client)
+8. Add mask write register function to server
+
+###2017-03-30 Release 1.3.2
+
+1. Fix Fixnum warning on Ruby 2.4
+2. Add extension method to support unpacking 32-bit Int using little-endian order
+
+###2016-10-18 Release 1.3.0
+
+1. Turn the following dependencies optional: serialport, gserver
+
+###2016-09-20 Release 1.2.8
+
+1. Fix warning on ruby 2.3 when calling Timeout.timeout
+
+###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).
+
+###2015-03-12 Release 1.2.5
+
+1. Fixed issue [#34](https://github.com/flipback/rmodbus/issues/34).
+
+###2015-01-29 Release 1.2.4
+
+1. Added ruby-2.2 compatibility
+
+###2015-01-29 Release 1.2.3
+
+1. Fixed bug [#30](https://github.com/flipback/rmodbus/pull/30) in parsing command 'write_register' for server implementation part.
+
+###2013-10-28 Release 1.2.2
+
+1. Fixed issue [#29](https://github.com/flipback/rmodbus/pull/29). The server part supports 2000 of coils/discrete inputs for reading instead of 125.
+
+###2013-06-28 Release 1.2.1
+
+1. Fixed issue [#27](https://github.com/flipback/rmodbus/issues/27) for read_nonblock error on Windows
+
+###2013-03-12 Release 1.2.0
+
+1. Transaction number mismatch doesn't throw exception in TCPSlave#query method.
+Now this method will wait correct transaction until timeout breaks waiting.  
+2. Added ruby-2.0 experimental compatibility
+
+###2012-07-17 Release 1.1.5
+
+1. Fixed issue [#24](https://github.com/flipback/rmodbus/issues/24) for RTUClient.
+
+###2012-06-28 Release 1.1.4
+
+1. Fixed issue [#23](https://github.com/flipback/rmodbus/issues/23).
+2. Improved speed of the RTU\RTUViaTCP part.
+
+###2012-06-06 Release 1.1.3
+
+1. Fixed issue [#22](https://github.com/flipback/rmodbus/issues/22)
+
+###2012-05-12 Release 1.1.2
+
+1. Fixed issue [#20](https://github.com/flipback/rmodbus/issues/20)
+
+###2012-04-12 Release 1.1.1
+
+1. Fixed issue [#15](https://github.com/flipback/rmodbus/issues/15)
+
+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/11)
+
+
+###2011-07-17 Release 1.0.3
+
+1. Fixed issue #10
+2. Added new options for TCPServer#new and RTUViaTCPServer#new
+   :host - ip of host server (default 127.0.0.1)
+   :max_connection - maximum (client default 4)
+
+###2011-07-1 Release 1.0.2
+
+1. Fixed issue #9
+
+###2011-06-30 Release 1.0.1
+
+1. Fixed issue #8
+
+2011-06-27 Release 1.0.0
+=====================================
+New API for client part of library
+---------------------------------------
+
+Example:
+
+  ```ruby
+    require 'rmodbus'
+
+    ModBus::TCPClient.new('127.0.0.1', 8502) do |cl|
+      cl.with_slave(1) do |slave|
+        # Read a single holding register at address 16
+        slave.holding_registers[16]
+
+        # Write a single holding register at address 16
+        slave.holding_registers[16] = 123
+
+        # Read holding registers 16 through 20
+        slave.holding_registers[16..20]
+
+        # Write holding registers 16 through 20 with some values
+        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
+-----------------------------------
+
+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]
+    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]
+  ```
+
+Support JRuby
+--------------------------------------
+Now you could use RModBus on JRuby without RTU implementation.
+
+RTU classes requires gem [serialport](https://github.com/hparra/ruby-serialport) which
+currently not compatible with JRuby

data/README.md

@@ -0,0 +1,115 @@
+RModBus [![Build Status](https://secure.travis-ci.org/rmodbus/rmodbus.png)](http://travis-ci.org/rmodbus/rmodbus) [![Gem Version](https://badge.fury.io/rb/rmodbus.svg)](http://badge.fury.io/rb/rmodbus)
+==========================
+
+**RModBus** - free implementation of ModBus protocol in pure Ruby.
+
+Features
+---------------------------
+  - Ruby 2.2, 2.3 and JRuby (without serial ModBus RTU)
+  - TCP, RTU, RTU over TCP protocols
+  - Client(master) and server(slave)
+  - 16, 32 -bit and float registers
+
+Support functions
+---------------------------
+  * Read Coils (0x01)
+  * Read Discrete Inputs (0x02)
+  * Read Holding Registers (0x03)
+  * Read Input Registers (0x04)
+  * Write Single Coil (0x05)
+  * Write Single Register (0x06)
+  * Write Multiple Coils (0x0F)
+  * Write Multiple registers (0x10)
+  * Mask Write register (0x16)
+
+Installation
+------------------------------------
+
+Download and install RModBus with the following:
+
+```
+gem install rmodbus
+```
+
+Or if you are using bundler, add to your Gemfile:
+
+```
+gem 'rmodbus'
+```
+
+If you want to use ModBus over serial, you will also need to install the 'serialport' gem.
+If you are using bundler, add to your Gemfile:
+
+```
+gem 'serialport'
+```
+
+If you want to use ModBus::TCPServer or ModBus::RTUViaTCPServer and are using Ruby >= 2.2,
+you will also need to install the 'gserver' gem. If you are using bundler, add to your Gemfile:
+
+```
+gem 'gserver'
+```
+
+Please note that GServer is deprecated, and I'm looking for a better solution.
+Contributions are welcome!
+
+Example
+------------------------------------
+
+  ```ruby
+    require 'rmodbus'
+
+    ModBus::TCPClient.new('127.0.0.1', 8502) do |cl|
+      cl.with_slave(1) do |slave|
+        # Read a single holding register at address 16
+        slave.holding_registers[16]
+
+        # Write a single holding register at address 16
+        slave.holding_registers[16] = 123
+
+        # Read holding registers 16 through 20
+        slave.holding_registers[16..20]
+
+        # Write holding registers 16 through 20 with some values
+        slave.holding_registers[16..20] = [1, 2, 3, 4, 5]
+      end
+    end
+  ```
+
+Versioning
+----------------------------------
+
+This project will follow http://semver.org/
+
+```
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+MAJOR version when you make incompatible API changes,
+MINOR version when you add functionality in a backwards-compatible manner, and
+PATCH version when you make backwards-compatible bug fixes.
+```
+
+Contributing
+----------------------------------
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+Reference
+----------------------------------
+
+RModBus on GitHub: http://github.com/rmodbus/rmodbus
+
+Documentation: http://www.rubydoc.info/github/rmodbus/rmodbus
+
+ModBus specifications: http://www.modbus.org/specs.php
+
+License
+----------------------------------
+
+BSD-3-Clause
+
+Credits
+----------------------------------
+
+Aleksey Timin - original author

data/Rakefile

@@ -0,0 +1,29 @@
+# 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/perfomance_rtu.rb

@@ -0,0 +1,56 @@
+$:.unshift File.join(File.dirname(__FILE__),'../lib')
+
+require 'rmodbus'
+require 'benchmark'
+
+include ModBus
+
+BAUD = 9600 
+TIMES = 100
+
+srv = RTUServer.new 'com3', BAUD 
+srv.coils = [0,1]  * 50
+srv.discrete_inputs = [1,0]  * 50
+srv.holding_registers = [0,1,2,3,4,5,6,7,8,9]  * 10
+srv.input_registers = [0,1,2,3,4,5,6,7,8,9]  * 10
+srv.start
+
+
+cl = RTUClient.new('com4', BAUD)
+cl.with_slave(1) do |slave|
+  Benchmark.bmbm do |x|
+    x.report('Read coils') do
+      TIMES.times { slave.read_coils 0, 100 }
+    end
+      
+    x.report('Read discrete inputs') do
+      TIMES.times { slave.read_discrete_inputs 0, 100 }
+    end
+    
+    x.report('Read holding registers') do
+      TIMES.times { slave.read_holding_registers 0, 100 } 
+    end
+    
+    x.report('Read input registers') do
+      TIMES.times { slave.read_input_registers 0, 100 }
+    end
+    
+    x.report('Write single coil') do
+      TIMES.times { slave.write_single_coil 0, 1 }
+    end
+    
+    x.report('Write single register') do
+      TIMES.times { slave.write_single_register 100, 0xAAAA }
+    end
+    
+    x.report('Write multiple coils') do
+      TIMES.times { slave.write_multiple_coils 0, [1,0] * 50 }
+    end
+    
+    x.report('Write multiple registers') do
+      TIMES.times { slave.write_multiple_registers 0, [0,1,2,3,4,5,6,7,8,9] * 10  }
+    end
+  end
+end
+srv.stop
+cl.close

data/examples/perfomance_rtu_via_tcp.rb

@@ -0,0 +1,55 @@
+$:.unshift File.join(File.dirname(__FILE__),'../lib')
+
+require 'rmodbus'
+require 'benchmark'
+
+include ModBus
+
+TIMES = 1000
+
+srv = ModBus::RTUViaTCPServer.new 1502 
+srv.coils = [0,1]  * 50
+srv.discrete_inputs = [1,0]  * 50
+srv.holding_registers = [0,1,2,3,4,5,6,7,8,9]  * 10
+srv.input_registers = [0,1,2,3,4,5,6,7,8,9]  * 10
+srv.start
+
+
+cl = RTUClient.new('127.0.0.1', 1502)
+cl.with_slave(1) do |slave|
+  Benchmark.bmbm do |x|
+    x.report('Read coils') do
+      TIMES.times { slave.read_coils 0, 100 }
+    end
+    
+    x.report('Read discrete inputs') do
+      TIMES.times { slave.read_discrete_inputs 0, 100 }
+    end
+    
+    x.report('Read holding registers') do
+      TIMES.times { slave.read_holding_registers 0, 100 } 
+    end
+    
+    x.report('Read input registers') do
+      TIMES.times { slave.read_input_registers 0, 100 }
+    end
+    
+    x.report('Write single coil') do
+      TIMES.times { slave.write_single_coil 0, 1 }
+    end
+    
+    x.report('Write single register') do
+      TIMES.times { slave.write_single_register 100, 0xAAAA }
+    end
+    
+    x.report('Write multiple coils') do
+      TIMES.times { slave.write_multiple_coils 0, [1,0] * 50 }
+    end    
+    
+    x.report('Write multiple registers') do
+      TIMES.times { slave.write_multiple_registers 0, [0,1,2,3,4,5,6,7,8,9] * 10  }
+    end
+  end
+end
+cl.close
+srv.stop