rmodbus 0.3.1 → 0.4.0

data/ChangeLog

@@ -17,6 +17,40 @@
 2010-01-7 Timin Aleksey <atimin@gmail.com>
 	* lib/rmodbus/tcp_client.rb: Fixed bug of overflow transaction counter (thanks
 	Tallak Tveide)
+2010-01-8 Timin Aleksey <atimin@gmail.com>
+	* lib/rmodbus/tcp_client.rb: Added new method TCPClient::connect,
+	TCPClient#ipaddr, TCPClient#port, TCPClient#slave
+	* lib/rmodbus/rtu_client.rb: Added new methods RTUClient::connect,
+	RTUClient#close, RTUClient#port, RTUClient#baud, RTUClient#slave
+2010-01-9 Timin Aleksey <atimin@gmail.com>
+	* rmodbus.gemspec: Added Rakefile into gem, dependencie on
+	serialport-0.8.0.gem
+	* spec/logging_spec.rb: Added specs for debug logging
+	* lib/rmodbus/client.rb, lib/rmodbus/tcp_client.rb,
+	lib/rmodbus/rtu_client.rb: Added debug logging functional
 2010-01-12 Timin Aleksey <atimin@gmail.com>
-	* lib/rmodbus/rtu_client.rb: RTUClient is live!!!
-
+	* lib/rmodbus/rtu_client.rb: RTUClient is live!
+2010-01-14 Timin Aleksey <atimin@gmail.com>
+	* lib/rmodbus/crc16.rb: Added module for calculation CRC16
+	* lib/rmodbus/parsers.rb: Added module for parsing requiest from clients
+	* lib/rmodbus/rtu_server.rb: Added RTUServer class
+	* rmodbus.gemspec: Update verison => 0.4.0
+	* README: Update information about project
+2010-01-16 Timin Aleksey <atimin@gmail.com>
+	* lib/rmodbus/ext.rb, lib/rmodbus/client.rb: Fixed for ruby-1.8.6 compatibility 
+	* lib/rmodbus/parsers.rb: Fixed bug for response on write requests
+	* lib/rmodbus/rtu_client.rb: Fixed bug in verifing CRC
+	* lib/rmodbus/rtu_server.rb: Reanimation RTUServer
+	* examples/perfomance_rtu.rb: Added test perfomance for ModBus RTU
+2010-01-17 Timin Aleksey <atimin@gmail.com>
+	* lib/rmodbus/rtu_server, lib/rmodbus/tcp_server.rb: Fixed typo
+	discret_inputs -> discrete_inputs
+	* examples/perfomance_tcp.rb: Added test perfomance for ModBus TCP
+	* lib/rmodbus/tcp_client.rb: Added method TCPClient#closed?
+	* lib/rmodbus/rtu_client.rb: Added method RTUClient#closed?
+2010-01-18 Timin Aleksey <atimin@gmail.com>
+	* lib/rmodbus/rtu_client.rb, lib/rmodbus/rtu_server.rb: Added support
+	modem parameters - :data_bits => 5..8, :stop_bits => 1 or 2, :parity =>
+	SerialPort::NONE, SerialPort::EVEN, SerialPort::ODD
+2010-01-20 Timin Aleksey <atimin@gmail.com>
+	* lib/rmodbus/ext.rb: Fixed bug for	divisible 8 data in Array#pack_to_word 

data/README

@@ -2,10 +2,11 @@
 
 *RModBus* - free implementation of protocol ModBus.
 
-== Feature
+== Features
 
-* Client\Server ModBus-TCP
-* Client ModBus-RTU (experimental) with serialport gem
+* Support Ruby 1.8, Ruby 1.9
+* Support ModBus-TCP, ModBus-RTU protocol
+* Support client(master) and server(slave)
 * Support functions:
   * 01 (0x01) Read Coils
   * 02 (0x02) Read Discrete Inputs
@@ -19,17 +20,19 @@
 
 == Installation
 
-You can install RModBus with the following command
+Download and install RModBus with the following
 
-$ rake install
+$ gem install --remote rmodbus
 
-from its distribution directory
+== Example
 
-== Gem installation
+require 'rmodbus'
 
-Download and install RModBus with the following
+cl = ModBus::TCPClient.new('127.0.0.1', 8502, 1)
 
-$ gem install --remote rmodbus
+puts cl.read_holding_registers(0,4)
+
+cl.write_multiple_registers(0, [4,4,4])
 
 == GitHub 
 
@@ -39,14 +42,10 @@ $ git clone git://github.com/flipback/RModBus.git
 
 == Reference 
 
+Home page: http://rmodbus.heroku.com
+
 RModBus project: http://rubyforge.org/projects/rmodbus
 
 RModBud on GitHub: http://github.com/flipback/RModBus
 
 ModBus community: http://www.modbus-ida.org
-
-
-
- 
-
- 

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rbconfig'
+if RUBY_VERSION.to_f >= 1.9
+    require 'fileutils'
+else
+    require 'ftools'
+end
+
+begin
+  require 'rubygems'
+rescue Exception
+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 
+  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)
+
+  files = Dir.chdir('lib') { Dir['**/*.rb'] }
+
+  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

data/examples/perfomance_rtu.rb

@@ -0,0 +1,58 @@
+$:.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.discret_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  }
+  end
+end
+
+srv.stop
+cl.close

data/examples/perfomance_tcp.rb

@@ -0,0 +1,57 @@
+$:.unshift File.join(File.dirname(__FILE__),'../lib')
+
+require 'rmodbus'
+require 'benchmark'
+
+include ModBus
+
+TIMES = 1000
+
+srv = ModBus::TCPServer.new 1502 
+srv.coils = [0,1]  * 50
+srv.discret_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  }
+  end
+end
+
+srv.stop
+cl.close

data/examples/use_tcp_modbus.rb

@@ -11,6 +11,7 @@ srv.audit = true
 srv.start
 
 cl = ModBus::TCPClient.new('127.0.0.1', 8502, 1)
+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)

data/lib/rmodbus/client.rb

@@ -29,6 +29,7 @@ module ModBus
       @read_retries = 10
     end
     # Read value *ncoils* coils starting with *addr*
+    #
     # Return array of their values
     def read_coils(addr, ncoils)
       query("\x1" + addr.to_word + ncoils.to_word).unpack_bits[0..ncoils-1]
@@ -134,19 +135,17 @@ module ModBus
 
       tried = 0
       begin
-        timeout(1, ModBusTimeout) do
-        pdu = read_pdu
-      end
+        timeout(1, ModBusTimeout) { pdu = read_pdu }
       rescue ModBusTimeout => err
         tried += 1
         retry unless tried >= @read_retries
         raise ModBusTimeout.new, "Timed out during read attempt"
-      rescue 
-        raise ModBusException.new, "Server did not respond"
       end
     
-      if pdu[0].to_i >= 0x80
-        case pdu[1].to_i
+      return nil if pdu.size == 0
+
+      if pdu.getbyte(0) >= 0x80
+        case pdu.getbyte(1)
           when 1
             raise IllegalFunction.new, "The function code received in the query is not an allowable action for the server"  
           when 2
@@ -178,6 +177,20 @@ module ModBus
     def close
     end
 
+    private
+    def logging_bytes(msg)
+      result = ""
+      msg.each_byte do |c|
+        byte = if c < 16
+          '0' + c.to_s(16)
+        else
+          c.to_s(16)
+        end
+        result << "[#{byte}]"
+      end
+      result
+    end
+
   end
 
 end

data/lib/rmodbus/crc16.rb

@@ -0,0 +1,69 @@
+# RModBus - free implementation of ModBus protocol in Ruby.
+#
+# Copyright (C) 2010  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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+module ModBus
+  module CRC16
+    def crc16(msg)
+      crc_lo = 0xff
+      crc_hi = 0xff
+
+      msg.unpack('c*').each do |byte|
+        i = crc_hi ^ byte
+        crc_hi = crc_lo ^ CrcHiTable[i]
+        crc_lo = CrcLoTable[i]
+      end
+
+      return ((crc_hi << 8) + crc_lo)
+    end
+
+    CrcHiTable = [
+        0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81,
+        0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
+        0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01,
+        0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41,
+        0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81,
+        0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
+        0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01,
+        0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
+        0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81,
+        0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
+        0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01,
+        0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
+        0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81,
+        0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
+        0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01,
+        0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
+        0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81,
+        0x40]
+    CrcLoTable = [
+        0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2, 0xC6, 0x06, 0x07, 0xC7, 0x05, 0xC5, 0xC4,
+        0x04, 0xCC, 0x0C, 0x0D, 0xCD, 0x0F, 0xCF, 0xCE, 0x0E, 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09,
+        0x08, 0xC8, 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A, 0x1E, 0xDE, 0xDF, 0x1F, 0xDD,
+        0x1D, 0x1C, 0xDC, 0x14, 0xD4, 0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6, 0xD2, 0x12, 0x13, 0xD3,
+        0x11, 0xD1, 0xD0, 0x10, 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3, 0xF2, 0x32, 0x36, 0xF6, 0xF7,
+        0x37, 0xF5, 0x35, 0x34, 0xF4, 0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE, 0xFA, 0x3A,
+        0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38, 0x28, 0xE8, 0xE9, 0x29, 0xEB, 0x2B, 0x2A, 0xEA, 0xEE,
+        0x2E, 0x2F, 0xEF, 0x2D, 0xED, 0xEC, 0x2C, 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26,
+        0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0, 0xA0, 0x60, 0x61, 0xA1, 0x63, 0xA3, 0xA2,
+        0x62, 0x66, 0xA6, 0xA7, 0x67, 0xA5, 0x65, 0x64, 0xA4, 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F,
+        0x6E, 0xAE, 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68, 0x78, 0xB8, 0xB9, 0x79, 0xBB,
+        0x7B, 0x7A, 0xBA, 0xBE, 0x7E, 0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C, 0xB4, 0x74, 0x75, 0xB5,
+        0x77, 0xB7, 0xB6, 0x76, 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71, 0x70, 0xB0, 0x50, 0x90, 0x91,
+        0x51, 0x93, 0x53, 0x52, 0x92, 0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54, 0x9C, 0x5C,
+        0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E, 0x5A, 0x9A, 0x9B, 0x5B, 0x99, 0x59, 0x58, 0x98, 0x88,
+        0x48, 0x49, 0x89, 0x4B, 0x8B, 0x8A, 0x4A, 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C,
+        0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86, 0x82, 0x42, 0x43, 0x83, 0x41, 0x81, 0x80,
+        0x40]
+  end
+end

data/lib/rmodbus/ext.rb

@@ -1,61 +1,65 @@
-# RModBus - free implementation of ModBus protocol on Ruby.
-#
-# Copyright (C) 2009  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
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-
-class String
-
-  unless RUBY_VERSION.to_f == 1.9
-    def getbyte(index)
-      self[index].to_i
-    end
-  end
-
-  def unpack_bits
-    array_bit = []
-    self.unpack('b*')[0].each_char do |b|
-        array_bit << b.to_i
-    end
-    array_bit
-  end
-
-end
-
-class Integer
-
-  def to_word
-    (self >> 8).chr + (self & 0xff).chr 
-  end
-
-end
-
-class Array
-
-  def pack_to_word
-    word = 0
-    s = ""
-    mask = 0x01
-
-    self.each do |bit| 
-      word |= mask if bit > 0
-      mask <<= 1
-      if mask  == 0x100
-        mask = 0x01
-        s << word.chr
-        word = 0
-      end
-    end
-    s << word.chr unless mask == 0x01
-  end
-
-end
-
+# RModBus - free implementation of ModBus protocol on Ruby.
+#
+# Copyright (C) 2009  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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+class String
+
+  unless RUBY_VERSION =~ /^1\.9/
+    def getbyte(index)
+      self[index].to_i
+    end
+  end
+
+  def unpack_bits
+    array_bit = []
+    self.unpack('b*')[0].each_byte do |b|
+        array_bit << b.chr.to_i
+    end
+    array_bit
+  end
+
+end
+
+class Integer
+
+  def to_word
+    (self >> 8).chr + (self & 0xff).chr 
+  end
+
+end
+
+class Array
+
+  def pack_to_word
+    word = 0
+    s = ""
+    mask = 0x01
+
+    self.each do |bit| 
+      word |= mask if bit > 0
+      mask <<= 1
+      if mask  == 0x100
+        mask = 0x01
+        s << word.chr
+        word = 0
+      end
+    end
+    unless mask == 0x01
+      s << word.chr
+    else
+      s
+    end
+  end
+
+end
+