rmodbus 0.5.0 → 1.0.0

data/NEWS.md

@@ -0,0 +1,52 @@
+Release 1.0.0
+=====================================
+New API for client part of library
+---------------------------------------
+
+Example:
+
+    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.
+
+    # 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,87 @@
+RModBus
+==========================
+
+**RModBus** - free implementation of protocol ModBus.
+
+Features
+---------------------------
+  - Ruby 1.8, Ruby 1.9, 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**
+
+Example
+------------------------------------
+
+    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
+
+
+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
+----------------------------------
+
+You can checkout source code from GitHub repositry
+
+**$ git clone git://github.com/flipback/RModBus.git**
+
+Reference
+----------------------------------
+
+Home page: http://rmodbus.heroku.com
+
+RModBud on GitHub: http://github.com/flipback/RModBus
+
+ModBus community: http://www.modbus-ida.org

data/Rakefile

@@ -1,45 +1,31 @@
-require 'rbconfig'
-if RUBY_VERSION.to_f >= 1.9
-    require 'fileutils'
-else
-    require 'ftools'
-end
+# encoding: utf-8
 
+require 'rubygems'
+require 'bundler'
 begin
-  require 'rubygems'
-rescue Exception
+  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
 
-begin
- require 'spec/rake/spectask'
-
- Spec::Rake::SpecTask.new do |t|
-    t.spec_opts = ['-c']
-    t.libs << 'lib'
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.rcov = false 
+require 'rake'
+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"
+    spec.pattern.exclude("spec/rtu_client_spec.rb", "spec/rtu_server_spec.rb")
   end
-rescue Exception 
-  puts 'RSpec not available. Install it with: sudo gem install rspec'
 end
 
-include Config
-
-task :install do
-
-  sitedir = CONFIG['sitelibdir']
-  rmodbus_dest = File.join(sitedir, 'rmodbus')
-
-  File::makedirs(rmodbus_dest, true)
-  File::chmod(0755, rmodbus_dest)
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+end
 
-  files = Dir.chdir('lib') { Dir['**/*.rb'] }
+task :default => :spec
 
-  files.each do |fn|
-    fn_dir = File.dirname(fn)
-    target_dir = File.join(sitedir, fn_dir)
-    File::makedirs(target_dir) unless File.exist?(target_dir)
-    File::install(File.join('lib', fn), File.join(sitedir, fn), 0644, true)
-  end
-
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/examples/perfomance_rtu.rb

@@ -10,49 +10,47 @@ TIMES = 100
 
 srv = RTUServer.new 'com3', BAUD 
 srv.coils = [0,1]  * 50
-srv.discret_inputs = [1,0]  * 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
-
-
-Benchmark.bmbm do |x|
-  x.report('Read coils') do
-    TIMES.times { cl.read_coils 0, 100 }
-  end
-
-  x.report('Read discrete inputs') do
-    TIMES.times { cl.read_discrete_inputs 0, 100 }
-  end
-
-  x.report('Read holding registers') do
-    TIMES.times { cl.read_holding_registers 0, 100 } 
-  end
-
-  x.report('Read input registers') do
-    TIMES.times { cl.read_input_registers 0, 100 }
-  end
-
-  x.report('Write single coil') do
-    TIMES.times { cl.write_single_coil 0, 1 }
-  end
-
-  x.report('Write single register') do
-    TIMES.times { cl.write_single_register 100, 0xAAAA }
-  end
-
-  x.report('Write multiple coils') do
-    TIMES.times { cl.write_multiple_coils 0, [1,0] * 50 }
-  end
-
-
-  x.report('Write multiple registers') do
-    TIMES.times { cl.write_multiple_registers 0, [0,1,2,3,4,5,6,7,8,9] * 10  }
+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_tcp.rb

@@ -9,49 +9,47 @@ TIMES = 1000
 
 srv = ModBus::TCPServer.new 1502 
 srv.coils = [0,1]  * 50
-srv.discret_inputs = [1,0]  * 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 = TCPClient.new '127.0.0.1', 1502
-
-
-Benchmark.bmbm do |x|
-  x.report('Read coils') do
-    TIMES.times { cl.read_coils 0, 100 }
-  end
-
-  x.report('Read discrete inputs') do
-    TIMES.times { cl.read_discrete_inputs 0, 100 }
-  end
-
-  x.report('Read holding registers') do
-    TIMES.times { cl.read_holding_registers 0, 100 } 
-  end
-
-  x.report('Read input registers') do
-    TIMES.times { cl.read_input_registers 0, 100 }
-  end
-
-  x.report('Write single coil') do
-    TIMES.times { cl.write_single_coil 0, 1 }
-  end
-
-  x.report('Write single register') do
-    TIMES.times { cl.write_single_register 100, 0xAAAA }
-  end
-
-  x.report('Write multiple coils') do
-    TIMES.times { cl.write_multiple_coils 0, [1,0] * 50 }
-  end
-
-
-  x.report('Write multiple registers') do
-    TIMES.times { cl.write_multiple_registers 0, [0,1,2,3,4,5,6,7,8,9] * 10  }
+cl = TCPClient.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
-
-srv.stop
 cl.close
+srv.stop

data/examples/use_rtu_via_tcp_modbus.rb

@@ -9,11 +9,14 @@ srv.input_registers = [1,2,3,4]
 srv.debug = true
 srv.start
 
-ModBus::RTUViaTCPClient.connect('127.0.0.1', 10002, 1) do |cl|
-	cl.debug = true
-	puts cl.read_holding_registers(0,4).inspect
-	cl.write_multiple_registers(0, [4,4,4])
-	puts cl.read_holding_registers(0,4).inspect
+ModBus::RTUViaTCPClient.connect('127.0.0.1', 10002) do |cl|
+  cl.with_slave(1) do |slave|
+    slave.debug = true
+    regs = slave.holding_registers
+  	puts regs[0..3]
+  	regs[0..3] = [2,0,1,1]
+  	puts regs[0..3]
+  end
 end
 
 srv.shutdown

data/examples/use_tcp_modbus.rb

@@ -3,17 +3,21 @@ require 'rmodbus'
 
 srv = ModBus::TCPServer.new(8502,1)
 srv.coils = [1,0,1,1]
-srv.discret_inputs = [1,1,0,0]
+srv.discrete_inputs = [1,1,0,0]
 srv.holding_registers = [1,2,3,4]
 srv.input_registers = [1,2,3,4]
 srv.debug = true
 srv.audit = true
 srv.start
 
-ModBus::TCPClient.connect('127.0.0.1', 8502, 1) do |cl|
-	cl.debug = true
-	puts cl.read_holding_registers(0,4)
-	cl.write_multiple_registers(0, [4,4,4])
-	puts cl.read_holding_registers(0,4)
+ModBus::TCPClient.connect('127.0.0.1', 8502) do |cl|
+  cl.with_slave(1) do |slave|
+    slave.debug = true
+    regs = slave.holding_registers
+  	puts regs[0..3]
+  	regs[0..3] = [2,0,1,1]
+  	puts regs[0..3]
+  end
 end
+
 srv.stop