libmodbus4r 0.2.2 → 0.3.0

data/NEWS

@@ -1,9 +1,18 @@
-libmodbus 0.2.2 (2009-08-16)
+libmodbus4r 0.3.0 (2009-09-21)
+===========================
+- Added support slave for TCP and RTU protocol
+- Migrated on libmodbus 0.2.2
+- Added source of libmodbus in project
+- Compatibility with ruby-1.8.7
+
+libmodbus4r 0.2.2 (2009-08-16)
+===========================
 - Fixed bug in Master::read_input_registers
 
-libmodbus 0.2.1 (2009-08-10)
+libmodbus4r 0.2.1 (2009-08-10)
+===========================
 - Fixed bug in Master::read_input_coils
 
-libmodbus 0.2.0 (2009-07-30)
+libmodbus4r 0.2.0 (2009-07-30)
 ===========================
 - First public release

data/README

@@ -1,41 +1,46 @@
-== About
+== About project
 
-Binding use *libmodbus* (free implementation of modbus for Linux\MacOS) for Ruby.
+libmodbus4r –a wrapper for library libmodbus wrote in Ruby. libmodbus – a free implementation of protocol ModBus TCP\RTU for Linux and OSX operation systems. It's very fast and stable library wrote in C. Goal of project is ability writing application in Ruby that use ModBus protocol for communication with devices.
 
 == Features
 
-* Use only Ruby-1.9.x
-* Use C library *libmodbus*;
+* Use only Ruby-1.9.x and Ruby-1.8.7
+* Include C library *libmodbus*;
 * ModBus TCP and RTU master(client);
+* ModBus TCP and RTU slave(server);
 * Support functions: 
-* * read coil status (0x01)
-* * read input status (0x02)
-* * read holding registers (0x03)
-* * read input registers (0x04)
-* * force single coil (0x05)
-* * preset single register (0x06)
-* * force multiple coils (0x0F)
-* * preset multiple registers (0x10)
-
-== Install
-
-1. Install last release ruby 1.9.1 from http://ruby-lang.org
-2. Install libmodbus-2.0.3 from https://launchpad.net/libmodbus
-3. Install libmodbus4r 
-   *$ sudo rake install*
-   or
-   *$ gem install libmodbus4r
-
-== Authorss
+  * read coil status (0x01)
+  * read input status (0x02)
+  * read holding registers (0x03)
+  * read input registers (0x04)
+  * force single coil (0x05)
+  * preset single register (0x06)
+  * force multiple coils (0x0F)
+  * preset multiple registers (0x10)
+
+== Installation
+
+Importan! libmodbus4 work only in Linux и OSX
+
+    Simplest installation is use rubygems
+    $ sudo gem install libmodbus4r
+    or  installation from source with command:
+    $ sudo rake install
+
+== Authors
 
 Aleksey Timin <atimin@gmail.com> 
 
-== Refernces 
+== References 
 
 Home page projects : http://flipback.github.com/libmodbus4r/
+
 Hosting on RubyForge : http://rubyforge.org/projects/libmodbus4r
+
 Hosting on GitHub : http://github.com/flipback/libmodbus4r/tree/master
 
 Ruby site : http://ruby-lang.org
+
 libmobus on Launchpad : https://launchpad.net/libmodbus
+
 ModBus community: http://www.modbus-ida.org

data/examples/use_rtu_master.rb

@@ -9,42 +9,35 @@ mstr = ModBus::RTUMaster.new('/dev/ttyS0', # device
                              9600,         # baud: 9600, 19200, etc
                              "none",       # parity: "even", "odd", "none"
                              8,            # data bits: 5, 6, 7, 8
-                             1)            # stop bits: 1, 2
+                             1,            # stop bits: 1, 2
+                             1)            # slave id
 mstr.connect
 # Reads the coils status in the slave
-puts mstr.read_coil_status(1,   #slave id
-                           0,   #start address
+puts mstr.read_coil_status(0,   #start address
                            10)  #number
 # Reads the input status in the slave
-puts mstr.read_input_status(1,  #slave id
-                            0,  #start address
+puts mstr.read_input_status(0,  #start address
                             10) #number
 # Reads the holding registers in the slave
-puts mstr.read_holding_registers(1, #slave id
-                            0,  #start address
+puts mstr.read_holding_registers(0,  #start address
                             5)   #number
 # Reads the input registers in the slave
-puts mstr.read_input_registers(1, #slave id
-                            0,  #start address
+puts mstr.read_input_registers(0,  #start address
                             5)  #number
 # Turns a single coil in the slave
-mstr.force_single_coil(1, #slave id
-                        0, #coil address
+mstr.force_single_coil(0, #coil address
                         true) #state
 
 # Sets a value in one holding register in the slave
-mstr.preset_single_register(1, #slave id
-                        0, #reg address
+mstr.preset_single_register(0, #reg address
                         0xa0a0) #value
 
 # Sets\reset the coils in the slave
-mstr.force_multiple_coils(1, #slave id
-                        0, #start address
+mstr.force_multiple_coils(0, #start address
                         [true, false, true]) #data
 
 #Copies the values in th slave
-mstr.preset_multiple_registers(1, #slave id
-                        0, #start address
+mstr.preset_multiple_registers(0, #start address
                         [1, 0xdf, 2]) #data
 
 mstr.close

data/examples/use_rtu_slave.rb

@@ -0,0 +1,24 @@
+begin 
+  require 'rubygems'
+rescue
+end
+
+require 'modbus4r'
+
+sl = ModBus::RTUSlave.new('/dev/ttyS0', # device
+                             9600,         # baud: 9600, 19200, etc
+                             "none",       # parity: "even", "odd", "none"
+                             8,            # data bits: 5, 6, 7, 8
+                             1,            # stop bits: 1, 2
+                             1)            # slave id
+
+sl.coil_status = [false, false, false, false, false] 
+sl.input_status = [false, false, false, false, false]
+sl.holding_registers = [0, 0, 0, 0, 0, 0, 0, 0]
+sl.input_registers = [0, 0, 0, 0, 0, 0, 0, 0]
+
+sl.start 
+
+sl.join
+
+sl.stop

data/examples/use_tcp_master.rb

@@ -5,42 +5,36 @@ end
 
 require 'modbus4r'
 
-mstr = ModBus::TCPMaster.new('127.0.0.1', 1502)
+mstr = ModBus::TCPMaster.new('127.0.0.1', #ip -address
+                                1502,     #port  
+                                1)        #slave id
 mstr.connect
 # Reads the coils status in the slave
-puts mstr.read_coil_status(1,   #slave id
-                           0,   #start address
+puts mstr.read_coil_status(0,   #start address
                            10)  #number
 # Reads the input status in the slave
-puts mstr.read_input_status(1,  #slave id
-                            0,  #start address
+puts mstr.read_input_status(0,  #start address
                             10) #number
 # Reads the holding registers in the slave
-puts mstr.read_holding_registers(1, #slave id
-                            0,  #start address
+puts mstr.read_holding_registers(0,  #start address
                             5)   #number
 # Reads the input registers in the slave
-puts mstr.read_input_registers(1, #slave id
-                            0,  #start address
+puts mstr.read_input_registers(0,  #start address
                             5)  #number
 # Turns a single coil in the slave
-mstr.force_single_coil(1, #slave id
-                        0, #coil address
+mstr.force_single_coil(0, #coil address
                         true) #state
 
 # Sets a value in one holding register in the slave
-mstr.preset_single_register(1, #slave id
-                        0, #reg address
+mstr.preset_single_register(0, #reg address
                         0xa0a0) #value
 
 # Sets\reset the coils in the slave
-mstr.force_multiple_coils(1, #slave id
-                        0, #start address
+mstr.force_multiple_coils(0, #start address
                         [true, false, true]) #data
 
 #Copies the values in th slave
-mstr.preset_multiple_registers(1, #slave id
-                        0, #start address
+mstr.preset_multiple_registers(0, #start address
                         [1, 0xdf, 2]) #data
 
 mstr.close

data/examples/use_tcp_slave.rb

@@ -0,0 +1,21 @@
+begin 
+  require 'rubygems'
+rescue
+end
+
+require 'modbus4r'
+
+sl = ModBus::TCPSlave.new('127.0.0.1', #ip-address
+                            1502,      #port
+                            1)         #slave id
+
+sl.coil_status = [false, false, false, false, false] 
+sl.input_status = [false, false, false, false, false]
+sl.holding_registers = [0, 0, 0, 0, 0, 0, 0, 0]
+sl.input_registers = [0, 0, 0, 0, 0, 0, 0, 0]
+
+sl.start 
+
+sl.join
+
+sl.stop

data/ext/errors.c

@@ -52,17 +52,8 @@ void mb_raise_error(int exception)
         case GATEWAY_PROBLEM_TARGET:
             rb_raise(eGatewayProblemTarget, "Gateway problem target (%i)", GATEWAY_PROBLEM_TARGET);
             break;
-        case COMM_TIME_OUT:
-            rb_raise(eModBusError, "Communication timeout (%i)", COMM_TIME_OUT);
-            break;
-        case PORT_SOCKET_FAILURE:
-            rb_raise(eModBusError, "Port socket failure (%i)", PORT_SOCKET_FAILURE);
-            break;
-        case SELECT_FAILURE:
-            rb_raise(eModBusError, "Select failure (%i)", SELECT_FAILURE);
-            break;
-        case TOO_MANY_DATA:
-            rb_raise(eModBusError, "Too many data (%i)", TOO_MANY_DATA);
+        case INVALID_DATA:
+            rb_raise(eModBusError, "Invalid data (%i)", INVALID_DATA);
             break;
         case INVALID_CRC:
             rb_raise(eModBusError, "Invalid CRC (%i)", INVALID_CRC);
@@ -70,6 +61,15 @@ void mb_raise_error(int exception)
         case INVALID_EXCEPTION_CODE:
             rb_raise(eModBusError, "Invalid exception code (%i)", INVALID_EXCEPTION_CODE);
             break;
+        case SELECT_TIMEOUT:
+            rb_raise(eModBusError, "Select timeout (%i)", SELECT_TIMEOUT);
+            break;
+        case SELECT_FAILURE:
+            rb_raise(eModBusError, "Select failure (%i)", SELECT_FAILURE);
+            break;
+         case SOCKET_FAILURE:
+            rb_raise(eModBusError, "Socket failure (%i)", SOCKET_FAILURE);
+            break;
         case CONNECTION_CLOSED:
             rb_raise(eModBusError, "Connection closed (%i)", CONNECTION_CLOSED);
             break;

data/ext/extconf.rb

@@ -1,4 +1,9 @@
 require 'mkmf'
 
-have_library 'modbus'
+printf "checking for ruby version... "
+STDOUT.flush
+ruby_ver = RUBY_VERSION
+puts ruby_ver
+$CFLAGS += " -DRUBY_1_8" if ruby_ver.to_f == 1.8
+
 create_makefile '_modbus4r'

data/ext/master.c

@@ -11,9 +11,17 @@ 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. */
 
+#include <unistd.h>
 #include "modbus4r.h"
 #include "errors.h"
 
+void mb_mstr_free(modbus_param_t *mb_param )
+{
+    modbus_close(mb_param);
+    free(mb_param);
+}
+
+
 VALUE mb_mstr_is_closed(VALUE self)
 {
     modbus_param_t *mb_param;
@@ -46,19 +54,17 @@ VALUE mb_mstr_close(VALUE self)
     return self;
 }
 
-VALUE mb_mstr_read_coil(VALUE self, VALUE slave, 
-                    VALUE start_addr, VALUE nb, 
-                    int (*func)(modbus_param_t*, int, int, int, uint8_t*))
+VALUE mb_mstr_read_coil(VALUE self, VALUE start_addr, VALUE nb, 
+                    int (*func)(modbus_param_t*, int, int, uint8_t*))
 {
     modbus_param_t *mb_param;
     Data_Get_Struct(self, modbus_param_t, mb_param);
 
-    slave = rb_funcall(slave, rb_intern("to_i"), 0);
     start_addr = rb_funcall(start_addr, rb_intern("to_i"), 0);
     nb = rb_funcall(nb, rb_intern("to_i"), 0);
     
     uint8_t dest[FIX2INT(nb)];
-    int status = (*func)(mb_param, FIX2INT(slave), FIX2INT(start_addr), FIX2INT(nb), dest);
+    int status = (*func)(mb_param, FIX2INT(start_addr), FIX2INT(nb), dest);
 
     if (status < 0) {
         mb_raise_error(status);
@@ -73,33 +79,27 @@ VALUE mb_mstr_read_coil(VALUE self, VALUE slave,
     return ret;
 }
 
-VALUE mb_mstr_read_coil_status(VALUE self, VALUE slave, 
-                                    VALUE start_addr, VALUE nb)
+VALUE mb_mstr_read_coil_status(VALUE self, VALUE start_addr, VALUE nb)
 {
-    return mb_mstr_read_coil(self, slave, start_addr, nb, 
-                            read_coil_status);
+    return mb_mstr_read_coil(self, start_addr, nb, read_coil_status);
 }
 
-VALUE mb_mstr_read_input_status(VALUE self, VALUE slave,
-                                    VALUE start_addr, VALUE nb)
+VALUE mb_mstr_read_input_status(VALUE self, VALUE start_addr, VALUE nb)
 {
-    return mb_mstr_read_coil(self, slave, start_addr, nb, 
-                            read_input_status);
+    return mb_mstr_read_coil(self, start_addr, nb, read_input_status);
 }
 
-VALUE mb_mstr_read_registers(VALUE self, VALUE slave,
-                    VALUE start_addr, VALUE nb,
-                    int (*func)(modbus_param_t*, int, int, int, uint16_t*))
+VALUE mb_mstr_read_registers(VALUE self, VALUE start_addr, VALUE nb,
+                    int (*func)(modbus_param_t*, int, int, uint16_t*))
 {
     modbus_param_t *mb_param;
     Data_Get_Struct(self, modbus_param_t, mb_param);
 
-    slave = rb_funcall(slave, rb_intern("to_i"), 0);
     start_addr = rb_funcall(start_addr, rb_intern("to_i"), 0);
     nb = rb_funcall(nb, rb_intern("to_i"), 0);
     
     uint16_t dest[FIX2INT(nb)];
-    int status = (*func)(mb_param, FIX2INT(slave), FIX2INT(start_addr), FIX2INT(nb), dest);
+    int status = (*func)(mb_param, FIX2INT(start_addr), FIX2INT(nb), dest);
 
     if (status < 0) {
         mb_raise_error(status);
@@ -115,30 +115,26 @@ VALUE mb_mstr_read_registers(VALUE self, VALUE slave,
     return ret;
 }
 
-VALUE mb_mstr_read_holding_registers(VALUE self, VALUE slave,
-                                    VALUE start_addr, VALUE nb)
+VALUE mb_mstr_read_holding_registers(VALUE self, VALUE start_addr, VALUE nb)
 {
-    return mb_mstr_read_registers(self, slave, start_addr, nb,
+    return mb_mstr_read_registers(self, start_addr, nb,
                                 read_holding_registers);
 }
 
-VALUE mb_mstr_read_input_registers(VALUE self, VALUE slave,
-                                    VALUE start_addr, VALUE nb)
+VALUE mb_mstr_read_input_registers(VALUE self, VALUE start_addr, VALUE nb)
 {
-    return mb_mstr_read_registers(self, slave, start_addr, nb,
+    return mb_mstr_read_registers(self, start_addr, nb,
                                 read_input_registers);
 }
 
-VALUE mb_mstr_force_single_coil(VALUE self, VALUE slave,
-                                    VALUE coil_addr, VALUE state)
+VALUE mb_mstr_force_single_coil(VALUE self, VALUE coil_addr, VALUE state)
 {
     modbus_param_t *mb_param;
     Data_Get_Struct(self, modbus_param_t, mb_param);
 
-    slave = rb_funcall(slave, rb_intern("to_i"), 0);
     coil_addr = rb_funcall(coil_addr, rb_intern("to_i"), 0);
 
-    int status = force_single_coil(mb_param, FIX2INT(slave), FIX2INT(coil_addr), (state == Qfalse ? 0 : 1));
+    int status = force_single_coil(mb_param, FIX2INT(coil_addr), (state == Qfalse ? 0 : 1));
 
     if (status < 0) {
         mb_raise_error(status);
@@ -148,17 +144,15 @@ VALUE mb_mstr_force_single_coil(VALUE self, VALUE slave,
 }
 
 
-VALUE mb_mstr_preset_single_register(VALUE self, VALUE slave,
-                                    VALUE reg_addr, VALUE value)
+VALUE mb_mstr_preset_single_register(VALUE self, VALUE reg_addr, VALUE value)
 {
     modbus_param_t *mb_param;
     Data_Get_Struct(self, modbus_param_t, mb_param);
 
-    slave = rb_funcall(slave, rb_intern("to_i"), 0);
     reg_addr = rb_funcall(reg_addr, rb_intern("to_i"), 0);
     value = rb_funcall(value, rb_intern("to_i"), 0);
 
-    int status = preset_single_register(mb_param, FIX2INT(slave), FIX2INT(reg_addr), FIX2INT(value));
+    int status = preset_single_register(mb_param, FIX2INT(reg_addr), FIX2INT(value));
 
     if (status < 0) {
         mb_raise_error(status);
@@ -167,13 +161,11 @@ VALUE mb_mstr_preset_single_register(VALUE self, VALUE slave,
     return self;
 }
 
-VALUE mb_mstr_force_multiple_coils(VALUE self, VALUE slave, 
-                                    VALUE start_addr, VALUE data) 
+VALUE mb_mstr_force_multiple_coils(VALUE self, VALUE start_addr, VALUE data) 
 {
     modbus_param_t *mb_param;
     Data_Get_Struct(self, modbus_param_t, mb_param);
 
-    slave = rb_funcall(slave, rb_intern("to_i"), 0);
     start_addr = rb_funcall(start_addr, rb_intern("to_i"), 0);
     data = rb_funcall(data, rb_intern("to_a"), 0);
 
@@ -186,7 +178,7 @@ VALUE mb_mstr_force_multiple_coils(VALUE self, VALUE slave,
         ary++;
     }
 
-    int status = force_multiple_coils(mb_param, FIX2INT(slave), FIX2INT(start_addr), RARRAY_LEN(data), buf);
+    int status = force_multiple_coils(mb_param, FIX2INT(start_addr), RARRAY_LEN(data), buf);
 
     if (status < 0) {
         mb_raise_error(status);
@@ -195,13 +187,11 @@ VALUE mb_mstr_force_multiple_coils(VALUE self, VALUE slave,
     return self;
 }
 
-VALUE mb_mstr_preset_multiple_registers(VALUE self, VALUE slave,
-                                    VALUE start_addr, VALUE data)
+VALUE mb_mstr_preset_multiple_registers(VALUE self, VALUE start_addr, VALUE data)
 {
     modbus_param_t *mb_param;
     Data_Get_Struct(self, modbus_param_t, mb_param);
 
-    slave = rb_funcall(slave, rb_intern("to_i"), 0);
     start_addr = rb_funcall(start_addr, rb_intern("to_i"), 0);
     data = rb_funcall(data, rb_intern("to_a"), 0);
 
@@ -215,7 +205,7 @@ VALUE mb_mstr_preset_multiple_registers(VALUE self, VALUE slave,
         ary++;
     }
 
-    int status = preset_multiple_registers(mb_param, FIX2INT(slave), FIX2INT(start_addr), RARRAY_LEN(data), buf);
+    int status = preset_multiple_registers(mb_param, FIX2INT(start_addr), RARRAY_LEN(data), buf);
 
     if (status < 0) {
         mb_raise_error(status);

data/ext/master.h

@@ -17,20 +17,21 @@ GNU General Public License for more details. */
 extern VALUE mb_mstr_is_closed(VALUE self);
 extern VALUE mb_mstr_connect(VALUE self);
 extern VALUE mb_mstr_close(VALUE self);
-extern VALUE mb_mstr_read_coil_status(VALUE self, VALUE slave, 
+extern VALUE mb_mstr_read_coil_status(VALUE self,  
                                     VALUE start_addr, VALUE nb);
-extern VALUE mb_mstr_read_input_status(VALUE self, VALUE slave,
+extern VALUE mb_mstr_read_input_status(VALUE self,
                                     VALUE start_addr, VALUE nb);
-extern VALUE mb_mstr_read_holding_registers(VALUE self, VALUE slave,
+extern VALUE mb_mstr_read_holding_registers(VALUE self,
                                     VALUE start_addr, VALUE nb);
-extern VALUE mb_mstr_read_input_registers(VALUE self, VALUE slave,
+extern VALUE mb_mstr_read_input_registers(VALUE self,
                                     VALUE start_addr, VALUE nb);
-extern VALUE mb_mstr_force_single_coil(VALUE self, VALUE slave,
+extern VALUE mb_mstr_force_single_coil(VALUE self, 
                                     VALUE coil_addr, VALUE state);
-extern VALUE mb_mstr_preset_single_register(VALUE self, VALUE slave,
+extern VALUE mb_mstr_preset_single_register(VALUE self, 
                                     VALUE reg_addr, VALUE value);
-extern VALUE mb_mstr_force_multiple_coils(VALUE self, VALUE slave, 
+extern VALUE mb_mstr_force_multiple_coils(VALUE self,  
                                     VALUE start_addr, VALUE data);
-extern VALUE mb_mstr_preset_multiple_registers(VALUE self, VALUE slave,
+extern VALUE mb_mstr_preset_multiple_registers(VALUE self,
                                     VALUE start_addr, VALUE data);
+extern void mb_mstr_free(modbus_param_t *mb_param );
 #endif