rmodbus 0.2 → 0.2.1

data/CHANGES

@@ -6,3 +6,8 @@
 - add retries for tcp connection and read, default of 10 retries, still 1 second timeout
 - fix typos
 
+2009-09-02 Release-0.2.1
+- add support ruby 1.9.1
+- fix bug in TCPServer class (it don't close connection after first request now)
+
+

data/README

@@ -5,6 +5,7 @@
 == Feature
 
 * Client ModBus-TCP
+* Server ModBus-TCP
 * Support functions:
   * 01 (0x01) Read Coils
   * 02 (0x02) Read Discrete Inputs

data/examples/add_new_function.rb

@@ -0,0 +1,19 @@
+begin 
+  require 'rubygems'
+rescue
+end
+require 'rmodbus'
+
+include ModBus
+
+class MyTCPClient < TCPClient
+
+  def user_define_function(arg1, arg2)
+    query("\x65" + arg1.to_bytes + arg2.to_bytes)
+  end
+
+end
+
+@my_mb = MyTCPClient.new('127.0.0.1', 502, 1)
+@my_mb.user_define_function(20,13)
+

data/examples/use_tcp_modbus.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+require 'rmodbus'
+
+srv = ModBus::TCPServer.new(8502,1)
+srv.coils = [1,0,1,1]
+srv.discret_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
+
+cl = ModBus::TCPClient.new('127.0.0.1', 8502, 1)
+puts cl.read_holding_registers(0,4)
+cl.write_multiple_registers(0, [4,4,4])
+puts cl.read_holding_registers(0,4)
+srv.stop

data/lib/rmodbus/client.rb

@@ -1,246 +1,283 @@
-# RModBus - free implementation of ModBus protocol on Ruby.
-#
-# Copyright (C) 2008  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.
-
-require 'rmodbus/exceptions'
-
-class String
-
-  def to_int16
-    self[0]*256 + self[1]
-  end
-
-  def to_array_int16
-    array_int16 = []
-    i = 0
-    while(i < self.size) do
-      array_int16 << self[i]*256 + self[i+1]
-      i += 2
-    end
-    array_int16
-  end
-
-  def to_array_bit
-    array_bit = []
-    self.each_byte do |byte|
-      mask = 0x01 
-      8.times {
-        unless (mask & byte) == 0
-          array_bit << 1
-        else
-          array_bit << 0
-        end
-        mask = mask << 1
-      }
-    end
-    array_bit
-  end
-
-end
-
-class Integer
-  def to_bytes
-    (self >> 8).chr + (self & 0xff).chr 
-  end
-end
-
-class Array
-
-  def to_ints16
-    s = ""
-    self.each do |int16|
-      s << int16.to_bytes
-    end
-    s
-  end
-
-  def bits_to_bytes
-    int16 = 0
-    s = ""
-    mask = 0x01
-
-    self.each do |bit| 
-      int16 |= mask if bit > 0
-      mask <<= 1
-      if mask  == 0x100
-        mask = 0x01
-        s << int16.chr
-        int16 = 0
-      end
-    end
-    s << int16.chr unless mask == 0x01
-  end
-
-end
-
-module ModBus
-
-  class Client
-  
-    include Errors
-    # Number of times to retry on connection and read timeouts
-    CONNECTION_RETRIES = 10
-    READ_RETRIES = 10
-
-    # Read value *ncoils* coils starting with *addr*
-    #
-    # Return array of their values
-    def read_coils(addr, ncoils)
-      query("\x1" + addr.to_bytes + ncoils.to_bytes).to_array_bit[0..ncoils-1]
-    end
-
-    # Read value *ncoils* discrete inputs starting with *addr*
-    #
-    # Return array of their values
-    def read_discrete_inputs(addr, ncoils)
-      query("\x2" + addr.to_bytes + ncoils.to_bytes).to_array_bit[0..ncoils-1]
-    end
-
-    # Deprecated version of read_discrete_inputs
-    def read_discret_inputs(addr, ncoils)
-      warn "[DEPRECATION] `read_discret_inputs` is deprecated.  Please use `read_discrete_inputs` instead."
-      read_discrete_inputs(addr, ncoils)
-    end
-
-    # Read value *nreg* holding registers starting with *addr*
-    #
-    # Return array of their values
-    def read_holding_registers(addr, nreg) 
-      query("\x3" + addr.to_bytes + nreg.to_bytes).to_array_int16
-    end
-
-    # Read value *nreg* input registers starting with *addr*
-    #
-    # Return array of their values
-    def read_input_registers(addr, nreg)
-      query("\x4" + addr.to_bytes + nreg.to_bytes).to_array_int16
-    end
-
-    # Write *val* in *addr* coil 
-    #
-    # if *val* lager 0 write 1
-    #
-    # Return self
-    def write_single_coil(addr, val)
-      if val == 0
-        query("\x5" + addr.to_bytes + 0.to_bytes)
-      else
-        query("\x5" + addr.to_bytes + 0xff00.to_bytes) 
-      end
-      self
-    end
-
-    # Write *val* in *addr* register
-    #
-    # Return self
-    def write_single_register(addr, val)
-      query("\x6" + addr.to_bytes + val.to_bytes)
-      self
-    end
-
-    # Write *val* in coils starting with *addr*
-    #
-    # *val* it is array of bits
-    #
-    # Return self
-    def write_multiple_coils(addr, val)
-      nbyte = ((val.size-1) >> 3) + 1
-      sum = 0
-      (val.size - 1).downto(0) do |i|
-        sum = sum << 1
-        sum |= 1 if val[i] > 0
-      end
-   
-      s_val = ""
-      nbyte.times do
-        s_val << (sum & 0xff).chr
-        sum >>= 8 
-      end
-
-      query("\xf" + addr.to_bytes + val.size.to_bytes + nbyte.chr + s_val)
-      self
-    end
-
-    # Write *val* in registers starting with *addr*
-    #
-    # *val* it is array of integer
-    #
-    # Return self
-    def write_multiple_registers(addr, val)
-      s_val = ""
-      val.each do |reg|
-        s_val << reg.to_bytes
-      end
-
-      query("\x10" + addr.to_bytes + val.size.to_bytes + (val.size * 2).chr + s_val)
-      self
-    end
-
-    # Write *current value & and_mask | or mask in *addr* register
-    #
-    # Return self
-    def mask_write_register(addr, and_mask, or_mask)
-      query("\x16" + addr.to_bytes + and_mask.to_bytes + or_mask.to_bytes)
-      self  
-    end
-
-    def query(pdu)    
-      send_pdu(pdu)
-
-      tried = 0
-      begin
-        timeout(1, ModBusTimeout) do
-        pdu = read_pdu
-       end
-      rescue ModBusTimeout => err
-        tried += 1
-        retry unless tried >= READ_RETRIES
-        raise ModBusTimeout.new, 'Timed out during read attempt'
-      end
-    
-      if pdu[0].to_i >= 0x80
-        case pdu[1].to_i
-          when 1
-            raise IllegalFunction.new, "The function code received in the query is not an allowable action for the server"  
-          when 2
-            raise IllegalDataAddress.new, "The data address received in the query is not an allowable address for the server"
-          when 3
-            raise IllegalDataValue.new, "A value contained in the query data field is not an allowable value for server"
-          when 4
-            raise SlaveDeviceFailure.new, "An unrecoverable error occurred while the server was attempting to perform the requested action"
-          when 5
-            raise Acknowledge.new, "The server has accepted the request and is processing it, but a long duration of time will be required to do so"
-          when 6
-            raise SlaveDeviceBus.new, "The server is engaged in processing a long duration program command"
-          when 8
-            raise MemoryParityError.new, "The extended file area failed to pass a consistency check"
-          else
-            raise ModBusException.new, "Unknown error"
-        end
-      end
-      pdu[2..-1]
-    end
-
-    protected
-    def send_pdu(pdu)
-    end
-
-    def read_pdu
-    end
-
-    def close
-    end
-
-  end
-
-end
+# RModBus - free implementation of ModBus protocol on Ruby.
+#
+# Copyright (C) 2008  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.
+
+require 'rmodbus/exceptions'
+
+class String
+
+
+  if RUBY_VERSION.to_f == 1.9
+    def to_array_int16
+      array_int16 = []
+      i = 0
+      while(i < self.bytesize) do
+        array_int16 << self.getbyte(i) * 256 + self.getbyte(i+1)
+        i += 2
+      end
+      array_int16
+    end
+
+    def to_array_bytes
+      array_bytes = []
+      self.each_byte do |b|
+        array_bytes << b
+      end
+      array_bytes
+    end
+    
+    def to_int16
+        self.getbyte(0)*256 + self.getbyte(1)
+    end
+
+  else
+    def to_array_int16
+      array_int16 = []
+      i = 0
+      while(i < self.size) do
+        array_int16 << (self[i].to_i)*256 + self[i+1].to_i
+        i += 2
+      end
+      array_int16
+    end
+
+    def to_array_bytes
+      array_bytes = []
+      i = 0
+      while(i<self.size) do
+        array_bytes << self[i].to_i
+        i += 1
+      end
+      array_bytes
+    end
+
+    def to_int16
+        self[0]*256 + self[1]
+    end
+  end  
+    
+
+  def to_array_bit
+    array_bit = []
+    self.each_byte do |byte|
+      mask = 0x01 
+      8.times {
+        unless (mask & byte) == 0
+          array_bit << 1
+        else
+          array_bit << 0
+        end
+        mask = mask << 1
+      }
+    end
+    array_bit
+  end
+
+end
+
+class Integer
+  def to_bytes
+    (self >> 8).chr + (self & 0xff).chr 
+  end
+end
+
+class Array
+
+  def to_ints16
+    s = ""
+    self.each do |int16|
+      s << int16.to_bytes
+    end
+    s
+  end
+
+  def bits_to_bytes
+    int16 = 0
+    s = ""
+    mask = 0x01
+
+    self.each do |bit| 
+      int16 |= mask if bit > 0
+      mask <<= 1
+      if mask  == 0x100
+        mask = 0x01
+        s << int16.chr
+        int16 = 0
+      end
+    end
+    s << int16.chr unless mask == 0x01
+  end
+
+end
+
+module ModBus
+
+  class Client
+  
+    include Errors
+    # Number of times to retry on connection and read timeouts
+    CONNECTION_RETRIES = 3
+    READ_RETRIES = 3 
+
+    # Read value *ncoils* coils starting with *addr*
+    #
+    # Return array of their values
+    def read_coils(addr, ncoils)
+      query("\x1" + addr.to_bytes + ncoils.to_bytes).to_array_bit[0..ncoils-1]
+    end
+
+    # Read value *ncoils* discrete inputs starting with *addr*
+    #
+    # Return array of their values
+    def read_discrete_inputs(addr, ncoils)
+      query("\x2" + addr.to_bytes + ncoils.to_bytes).to_array_bit[0..ncoils-1]
+    end
+
+    # Deprecated version of read_discrete_inputs
+    def read_discret_inputs(addr, ncoils)
+      warn "[DEPRECATION] `read_discret_inputs` is deprecated.  Please use `read_discrete_inputs` instead."
+      read_discrete_inputs(addr, ncoils)
+    end
+
+    # Read value *nreg* holding registers starting with *addr*
+    #
+    # Return array of their values
+    def read_holding_registers(addr, nreg) 
+      query("\x3" + addr.to_bytes + nreg.to_bytes).to_array_int16
+    end
+
+    # Read value *nreg* input registers starting with *addr*
+    #
+    # Return array of their values
+    def read_input_registers(addr, nreg)
+      query("\x4" + addr.to_bytes + nreg.to_bytes).to_array_int16
+    end
+
+    # Write *val* in *addr* coil 
+    #
+    # if *val* lager 0 write 1
+    #
+    # Return self
+    def write_single_coil(addr, val)
+      if val == 0
+        query("\x5" + addr.to_bytes + 0.to_bytes)
+      else
+        query("\x5" + addr.to_bytes + 0xff00.to_bytes) 
+      end
+      self
+    end
+
+    # Write *val* in *addr* register
+    #
+    # Return self
+    def write_single_register(addr, val)
+      query("\x6" + addr.to_bytes + val.to_bytes)
+      self
+    end
+
+    # Write *val* in coils starting with *addr*
+    #
+    # *val* it is array of bits
+    #
+    # Return self
+    def write_multiple_coils(addr, val)
+      nbyte = ((val.size-1) >> 3) + 1
+      sum = 0
+      (val.size - 1).downto(0) do |i|
+        sum = sum << 1
+        sum |= 1 if val[i] > 0
+      end
+   
+      s_val = ""
+      nbyte.times do
+        s_val << (sum & 0xff).chr
+        sum >>= 8 
+      end
+
+      query("\xf" + addr.to_bytes + val.size.to_bytes + nbyte.chr + s_val)
+      self
+    end
+
+    # Write *val* in registers starting with *addr*
+    #
+    # *val* it is array of integer
+    #
+    # Return self
+    def write_multiple_registers(addr, val)
+      s_val = ""
+      val.each do |reg|
+        s_val << reg.to_bytes
+      end
+
+      query("\x10" + addr.to_bytes + val.size.to_bytes + (val.size * 2).chr + s_val)
+      self
+    end
+
+    # Write *current value & and_mask | or mask in *addr* register
+    #
+    # Return self
+    def mask_write_register(addr, and_mask, or_mask)
+      query("\x16" + addr.to_bytes + and_mask.to_bytes + or_mask.to_bytes)
+      self  
+    end
+
+    def query(pdu)    
+      send_pdu(pdu)
+
+      tried = 0
+      begin
+        timeout(1, ModBusTimeout) do
+        pdu = read_pdu
+       end
+      rescue ModBusTimeout => err
+        tried += 1
+        retry unless tried >= READ_RETRIES
+        raise ModBusTimeout.new, 'Timed out during read attempt'
+      end
+    
+      if pdu[0].to_i >= 0x80
+        case pdu[1].to_i
+          when 1
+            raise IllegalFunction.new, "The function code received in the query is not an allowable action for the server"  
+          when 2
+            raise IllegalDataAddress.new, "The data address received in the query is not an allowable address for the server"
+          when 3
+            raise IllegalDataValue.new, "A value contained in the query data field is not an allowable value for server"
+          when 4
+            raise SlaveDeviceFailure.new, "An unrecoverable error occurred while the server was attempting to perform the requested action"
+          when 5
+            raise Acknowledge.new, "The server has accepted the request and is processing it, but a long duration of time will be required to do so"
+          when 6
+            raise SlaveDeviceBus.new, "The server is engaged in processing a long duration program command"
+          when 8
+            raise MemoryParityError.new, "The extended file area failed to pass a consistency check"
+          else
+            raise ModBusException.new, "Unknown error"
+        end
+      end
+      pdu[2..-1]
+    end
+
+    protected
+    def send_pdu(pdu)
+    end
+
+    def read_pdu
+    end
+
+    def close
+    end
+
+  end
+
+end