rmodbus 0.1.0 → 0.1.1

data/AUTHORS

@@ -1,2 +1,3 @@
 Timin Aleksey
+
 Dilshod Samatov

data/CHANGES

@@ -0,0 +1,2 @@
+2008-25-01 Release-0.1.1
+- fixed bug in function "read discrete inputs (0x2)" of ModBus client

data/LICENSE

@@ -1,4 +1,5 @@
                     GNU GENERAL PUBLIC LICENSE
+
                        Version 3, 29 June 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>

data/README

@@ -5,7 +5,15 @@
 == Feature
 
 * Client ModBus-TCP
-* Support functions:  0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xf, 0x10
+* Support functions:
+  * 01 (0x01) Read Coils
+  * 02 (0x02) Read Discrete Inputs
+  * 03 (0x03) Read Holding Registers
+  * 04 (0x04) Read Input Registers 
+  * 05 (0x05) Write Single Coil
+  * 06 (0x06) Write Single Register
+  * 15 (0x0F) Write Multiple Coils
+  * 16 (0x10) Write Multiple registers
 
 == Installation
 
@@ -32,6 +40,12 @@ or
 
 $ svn checkout http://rubyforge.org/var/svn/rmodbus/trunk
 
+== Reference 
+
+RModBus project: http://rubyforge.org/projects/rmodbus
+
+ModBus community: http://www.modbus-ida.org
+
 
 
  

data/lib/rmodbus/adu.rb

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

data/lib/rmodbus/client.rb

@@ -1,5 +1,7 @@
 # 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
@@ -58,22 +60,39 @@ module ModBus
   
     include Errors
 
-    def read_coils(addr, nreg)
-      query("\x1" + addr.to_bytes + nreg.to_bytes).to_array_bit[0..nreg-1]
+    # 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
 
-    def read_discret_inputs(addr, nreg)
-      query("\x2" + addr.to_bytes + nreg.to_bytes).to_array_bit
+    # Read value *ncoils* discrete inputs starting with *addr*
+    #
+    # Return array of their values
+    def read_discret_inputs(addr, ncoils)
+      query("\x2" + addr.to_bytes + ncoils.to_bytes).to_array_bit[0..ncoils-1]
     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)
@@ -83,11 +102,19 @@ module ModBus
       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
@@ -106,6 +133,11 @@ module ModBus
       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|
@@ -116,6 +148,13 @@ module ModBus
       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)
@@ -146,12 +185,14 @@ module ModBus
       end
       pdu[2..-1]
     end
-  end
 
-  protected
-  def send_pdu(pdu)
-  end
+     protected
+    def send_pdu(pdu)
+    end
+
+    def read_pdu
+    end
 
-  def read_pdu
   end
+
 end

data/lib/rmodbus/exceptions.rb

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

data/lib/rmodbus/tcp_client.rb

@@ -1,5 +1,7 @@
 # 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
@@ -17,10 +19,12 @@ require 'rmodbus/adu'
 
 module ModBus
 
+  # Implementation clients(master) ModBusTCP
   class TCPClient < Client
 
     include Timeout
 
+    # Connect with a ModBus server
     def initialize(ipaddr, port = 502, slaveaddr = 1)
       timeout(1) do
         @sock = TCPSocket.new(ipaddr, port)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rmodbus
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
-- A.Timin
+- A.Timin, D.Samatov
 autorequire: rmodbus
 bindir: bin
 cert_chain: []
 
-date: 2008-01-11 00:00:00 +05:00
+date: 2008-01-25 00:00:00 +05:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - README
 - AUTHORS
 - LICENSE
+- CHANGES
 files: 
 - lib/rmodbus/exceptions.rb
 - lib/rmodbus/tcp_client.rb
@@ -32,6 +33,7 @@ files:
 - README
 - AUTHORS
 - LICENSE
+- CHANGES
 has_rdoc: true
 homepage: 
 post_install_message: