libmodbus4r 0.3.0 → 2.0.0

data/ext/modbus.h

@@ -1,347 +0,0 @@
-/*
- * Copyright © 2001-2009 Stéphane Raimbault <stephane.raimbault@gmail.com>
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser 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 Lesser Public License for more details.
- *
- * You should have received a copy of the GNU Lesser Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#ifndef _MODBUS_H_
-#define _MODBUS_H_
-
-#include <stdint.h>
-#include <termios.h>
-#include <arpa/inet.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#define MODBUS_TCP_DEFAULT_PORT   502
-#define MODBUS_BROADCAST_ADDRESS  255
-
-/* Slave index */
-#define HEADER_LENGTH_RTU           1
-#define PRESET_QUERY_LENGTH_RTU     6
-#define PRESET_RESPONSE_LENGTH_RTU  2
-
-#define HEADER_LENGTH_TCP           7
-#define PRESET_QUERY_LENGTH_TCP    12
-#define PRESET_RESPONSE_LENGTH_TCP  8
-
-#define CHECKSUM_LENGTH_RTU         2
-#define CHECKSUM_LENGTH_TCP         0
-
-/* It's not really the minimal length (the real one is report slave ID
- * in RTU (4 bytes)) but it's a convenient size to use in RTU or TCP
- * communications to read many values or write a single one.
- * Maximum between :
- * - HEADER_LENGTH_TCP (7) + function (1) + address (2) + number (2)
- * - HEADER_LENGTH_RTU (1) + function (1) + address (2) + number (2) + CRC (2)
-*/
-#define MIN_QUERY_LENGTH           12
-
-/* Modbus_Application_Protocol_V1_1b.pdf Chapter 4 Section 1 Page 5:
- *  - RS232 / RS485 ADU = 253 bytes + slave (1 byte) + CRC (2 bytes) = 256 bytes
- *  - TCP MODBUS ADU = 253 bytes + MBAP (7 bytes) = 260 bytes
- */
-#define MAX_PDU_LENGTH            253
-#define MAX_ADU_LENGTH_RTU        256
-#define MAX_ADU_LENGTH_TCP        260
-
-/* Kept for compatibility reasons (deprecated) */
-#define MAX_MESSAGE_LENGTH        260
-
-/* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 1 page 12)
- * Quantity of Coils (2 bytes): 1 to 2000 (0x7D0)
- */
-#define MAX_STATUS               2000
-
-/* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 3 page 15)
- * Quantity of Registers (2 bytes): 1 to 125 (0x7D)
- */
-#define MAX_REGISTERS             125
-
-#define REPORT_SLAVE_ID_LENGTH     75
-
-/* Time out between trames in microsecond */
-#define TIME_OUT_BEGIN_OF_TRAME 500000
-#define TIME_OUT_END_OF_TRAME   500000
-
-#ifndef FALSE
-#define FALSE 0
-#endif
-
-#ifndef TRUE
-#define TRUE 1
-#endif
-
-#ifndef OFF
-#define OFF 0
-#endif
-
-#ifndef ON
-#define ON 1
-#endif
-
-/* Function codes */
-#define FC_READ_COIL_STATUS          0x01  /* discretes inputs */
-#define FC_READ_INPUT_STATUS         0x02  /* discretes outputs */
-#define FC_READ_HOLDING_REGISTERS    0x03
-#define FC_READ_INPUT_REGISTERS      0x04
-#define FC_FORCE_SINGLE_COIL         0x05
-#define FC_PRESET_SINGLE_REGISTER    0x06
-#define FC_READ_EXCEPTION_STATUS     0x07
-#define FC_FORCE_MULTIPLE_COILS      0x0F
-#define FC_PRESET_MULTIPLE_REGISTERS 0x10
-#define FC_REPORT_SLAVE_ID           0x11
-
-/* Protocol exceptions */
-#define ILLEGAL_FUNCTION        -0x01
-#define ILLEGAL_DATA_ADDRESS    -0x02
-#define ILLEGAL_DATA_VALUE      -0x03
-#define SLAVE_DEVICE_FAILURE    -0x04
-#define SERVER_FAILURE          -0x04
-#define ACKNOWLEDGE             -0x05
-#define SLAVE_DEVICE_BUSY       -0x06
-#define SERVER_BUSY             -0x06
-#define NEGATIVE_ACKNOWLEDGE    -0x07
-#define MEMORY_PARITY_ERROR     -0x08
-#define GATEWAY_PROBLEM_PATH    -0x0A
-#define GATEWAY_PROBLEM_TARGET  -0x0B
-
-/* Local */
-#define INVALID_DATA            -0x10
-#define INVALID_CRC             -0x11
-#define INVALID_EXCEPTION_CODE  -0x12
-
-#define SELECT_TIMEOUT          -0x13
-#define SELECT_FAILURE          -0x14
-#define SOCKET_FAILURE          -0x15
-#define CONNECTION_CLOSED       -0x16
-
-/* Internal using */
-#define MSG_LENGTH_UNDEFINED -1
-
-typedef enum { RTU=0, TCP } type_com_t;
-typedef enum { FLUSH_OR_CONNECT_ON_ERROR, NOP_ON_ERROR } error_handling_t;
-
-/* This structure is byte-aligned */
-typedef struct {
-        /* Slave address */
-        int slave;
-        /* Descriptor (tty or socket) */
-        int fd;
-        /* Communication mode: RTU or TCP */
-        type_com_t type_com;
-        /* Flag debug */
-        int debug;
-        /* TCP port */
-        int port;
-        /* Device: "/dev/ttyS0", "/dev/ttyUSB0" or "/dev/tty.USA19*"
-           on Mac OS X for KeySpan USB<->Serial adapters this string
-           had to be made bigger on OS X as the directory+file name
-           was bigger than 19 bytes. Making it 67 bytes for now, but
-           OS X does support 256 byte file names. May become a problem
-           in the future. */
-#ifdef __APPLE_CC__
-        char device[64];
-#else
-        char device[16];
-#endif
-        /* Bauds: 9600, 19200, 57600, 115200, etc */
-        int baud;
-        /* Data bit */
-        uint8_t data_bit;
-        /* Stop bit */
-        uint8_t stop_bit;
-        /* Parity: "even", "odd", "none" */
-        char parity[5];
-        /* In error_treat with TCP, do a reconnect or just dump the error */
-        uint8_t error_handling;
-        /* IP address */
-        char ip[16];
-        /* Save old termios settings */
-        struct termios old_tios;
-} modbus_param_t;
-
-typedef struct {
-        int nb_coil_status;
-        int nb_input_status;
-        int nb_input_registers;
-        int nb_holding_registers;
-        uint8_t *tab_coil_status;
-        uint8_t *tab_input_status;
-        uint16_t *tab_input_registers;
-        uint16_t *tab_holding_registers;
-} modbus_mapping_t;
-
-
-/* All functions used for sending or receiving data return:
-   - the numbers of values (bits or word) if success (0 or more)
-   - less than 0 for exceptions errors
-*/
-
-/* Reads the boolean status of coils and sets the array elements in
-   the destination to TRUE or FALSE */
-int read_coil_status(modbus_param_t *mb_param, int start_addr, int nb,
-                     uint8_t *dest);
-
-/* Same as read_coil_status but reads the slaves input table */
-int read_input_status(modbus_param_t *mb_param, int start_addr, int nb,
-                      uint8_t *dest);
-
-/* Reads the holding registers in a slave and put the data into an
-   array */
-int read_holding_registers(modbus_param_t *mb_param, int start_addr, int nb,
-                           uint16_t *dest);
-
-/* Reads the input registers in a slave and put the data into an
-   array */
-int read_input_registers(modbus_param_t *mb_param, int start_addr, int nb,
-                         uint16_t *dest);
-
-/* Turns ON or OFF a single coil in the slave device */
-int force_single_coil(modbus_param_t *mb_param, int coil_addr, int state);
-
-/* Sets a value in one holding register in the slave device */
-int preset_single_register(modbus_param_t *mb_param, int reg_addr, int value);
-
-/* Sets/resets the coils in the slave from an array in argument */
-int force_multiple_coils(modbus_param_t *mb_param, int start_addr, int nb,
-                         const uint8_t *data);
-
-/* Copies the values in the slave from the array given in argument */
-int preset_multiple_registers(modbus_param_t *mb_param, int start_addr, int nb,
-                              const uint16_t *data);
-
-/* Returns the slave id! */
-int report_slave_id(modbus_param_t *mb_param, uint8_t *dest);
-
-/* Initializes the modbus_param_t structure for RTU.
-   - device: "/dev/ttyS0"
-   - baud:   9600, 19200, 57600, 115200, etc
-   - parity: "even", "odd" or "none"
-   - data_bits: 5, 6, 7, 8
-   - stop_bits: 1, 2
-*/
-void modbus_init_rtu(modbus_param_t *mb_param, const char *device,
-                     int baud, const char *parity, int data_bit,
-                     int stop_bit, int slave);
-
-/* Initializes the modbus_param_t structure for TCP.
-   - ip: "192.168.0.5"
-   - port: 1099
-   - slave: 5
-
-   Set the port to MODBUS_TCP_DEFAULT_PORT to use the default one
-   (502). It's convenient to use a port number greater than or equal
-   to 1024 because it's not necessary to be root to use this port
-   number.
-*/
-void modbus_init_tcp(modbus_param_t *mb_param, const char *ip_address, int port,
-                     int slave);
-
-/* By default, the error handling mode used is CONNECT_ON_ERROR.
-
-   With FLUSH_OR_CONNECT_ON_ERROR, the library will attempt an immediate
-   reconnection which may hang for several seconds if the network to
-   the remote target unit is down.
-
-   With NOP_ON_ERROR, it is expected that the application will
-   check for network error returns and deal with them as necessary.
-
-   This function is only useful in TCP mode.
- */
-void modbus_set_error_handling(modbus_param_t *mb_param, error_handling_t error_handling);
-
-/* Establishes a modbus connexion.
-   Returns 0 on success or -1 on failure. */
-int modbus_connect(modbus_param_t *mb_param);
-
-/* Closes a modbus connection */
-void modbus_close(modbus_param_t *mb_param);
-
-/* Flush the pending request */
-void modbus_flush(modbus_param_t *mb_param);
-
-/* Activates the debug messages */
-void modbus_set_debug(modbus_param_t *mb_param, int boolean);
-
-/**
- * SLAVE/CLIENT FUNCTIONS
- **/
-
-/* Allocates 4 arrays to store coils, input status, input registers and
-   holding registers. The pointers are stored in modbus_mapping structure.
-
-   Returns 0 on success and -1 on failure
- */
-int modbus_mapping_new(modbus_mapping_t *mb_mapping,
-                       int nb_coil_status, int nb_input_status,
-                       int nb_holding_registers, int nb_input_registers);
-
-/* Frees the 4 arrays */
-void modbus_mapping_free(modbus_mapping_t *mb_mapping);
-
-/* Listens for any query from one or many modbus masters in TCP.
-
-   Returns: socket
- */
-int modbus_slave_listen_tcp(modbus_param_t *mb_param, int nb_connection);
-
-/* Waits for a connection */
-int modbus_slave_accept_tcp(modbus_param_t *mb_param, int *socket);
-
-/* Listens for any query from a modbus master in TCP, requires the socket file
-   descriptor etablished with the master device in argument.
-
-   Returns:
-   - 0 on success, or a negative error number if the request fails
-   - query, message received
-   - query_length, length in bytes of the message
-*/
-int modbus_slave_receive(modbus_param_t *mb_param, int sockfd,
-                         uint8_t *query, int *query_length);
-
-/* Manages the received query.
-   Analyses the query and constructs a response.
-
-   If an error occurs, this function construct the response
-   accordingly.
-*/
-void modbus_slave_manage(modbus_param_t *mb_param, const uint8_t *query,
-                         int query_length, modbus_mapping_t *mb_mapping);
-
-
-/**
- * UTILS FUNCTIONS
- **/
-
-/* Sets many input/coil status from a single byte value (all 8 bits of
-   the byte value are set) */
-void set_bits_from_byte(uint8_t *dest, int address, const uint8_t value);
-
-/* Sets many input/coil status from a table of bytes (only the bits
-   between address and address + nb_bits are set) */
-void set_bits_from_bytes(uint8_t *dest, int address, int nb_bits,
-                         const uint8_t *tab_byte);
-
-/* Gets the byte value from many input/coil status.
-   To obtain a full byte, set nb_bits to 8. */
-uint8_t get_byte_from_bits(const uint8_t *src, int address, int nb_bits);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif  /* _MODBUS_H_ */

data/ext/modbus4r.c

@@ -1,115 +0,0 @@
-/* libmodbus4r - binding use libmodbus for 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. */
-
-#include "modbus4r.h" 
-#include "errors.h"
-#include "master.h"
-#include "slave.h"
-#include "tcp_master.h"
-#include "rtu_master.h"
-#include "tcp_slave.h"
-#include "rtu_slave.h"
-
-VALUE mModBus, cMaster, cTCPMaster, cRTUMaster, cSlave, 
-        cTCPSlave, cRTUSlave;
-
-void Init__modbus4r()
-{
-    mModBus = rb_define_module("ModBus");
-    /* Master */
-    cMaster = rb_define_class_under(mModBus, "Master", rb_cObject);
-    rb_define_method(cMaster, "closed?", mb_mstr_is_closed, 0);
-    rb_define_method(cMaster, "connect", mb_mstr_connect, 0);
-    rb_define_method(cMaster, "close", mb_mstr_close, 0);
-    rb_define_method(cMaster, "read_coil_status", 
-                    mb_mstr_read_coil_status, 2);
-    rb_define_method(cMaster, "read_input_status",
-                    mb_mstr_read_input_status, 2);
-    rb_define_method(cMaster, "read_holding_registers", 
-                    mb_mstr_read_holding_registers, 2);
-    rb_define_method(cMaster, "read_input_registers", 
-                    mb_mstr_read_input_registers, 2);
-    rb_define_method(cMaster, "force_single_coil", 
-                    mb_mstr_force_single_coil, 2);
-    rb_define_method(cMaster, "preset_single_register", 
-                    mb_mstr_preset_single_register, 2);
-    rb_define_method(cMaster, "force_multiple_coils", 
-                    mb_mstr_force_multiple_coils, 2);
-    rb_define_method(cMaster, "preset_multiple_registers", 
-                    mb_mstr_preset_multiple_registers, 2);
-
-    /* TCPMaster */
-    cTCPMaster = rb_define_class_under(mModBus, "TCPMaster", cMaster);
-    rb_define_singleton_method(cTCPMaster, "new", mb_tcp_mstr_new, 3);
-
-    /* RTUMaster */
-    cRTUMaster = rb_define_class_under(mModBus, "RTUMaster", cMaster);
-    rb_define_singleton_method(cRTUMaster, "new", mb_rtu_mstr_new, 6);
-
-    /* Slave */
-    cSlave = rb_define_class_under(mModBus, "Slave", rb_cObject);
-    rb_define_method(cSlave, "stoped?", mb_sl_is_stoped, 0);
-    rb_define_method(cSlave, "coil_status", 
-                                mb_sl_get_coil_status, 0);
-    rb_define_method(cSlave, "coil_status=", 
-                                mb_sl_set_coil_status, 1);
-    rb_define_method(cSlave, "input_status", 
-                                mb_sl_get_input_status, 0);
-    rb_define_method(cSlave, "input_status=", 
-                                mb_sl_set_input_status, 1);
-    rb_define_method(cSlave, "holding_registers", 
-                                mb_sl_get_holding_registers, 0);
-    rb_define_method(cSlave, "holding_registers=", 
-                                mb_sl_set_holding_registers, 1);
-    rb_define_method(cSlave, "input_registers", 
-                                mb_sl_get_input_registers, 0);
-    rb_define_method(cSlave, "input_registers=", 
-                                mb_sl_set_input_registers, 1);
-    rb_define_method(cSlave, "join", mb_sl_join, 0);
-    /* TCPSlave */
-    cTCPSlave = rb_define_class_under(mModBus, "TCPSlave", cSlave);
-    rb_define_singleton_method(cTCPSlave, "new", mb_tcp_sl_new, 3);
-    rb_define_method(cTCPSlave, "start", mb_tcp_sl_start, 0);
-    rb_define_method(cTCPSlave, "stop", mb_tcp_sl_stop, 0);
-
-     /* RTUSlave */
-    cRTUSlave = rb_define_class_under(mModBus, "RTUSlave", cSlave);
-    rb_define_singleton_method(cRTUSlave, "new", mb_rtu_sl_new, 6);
-    rb_define_method(cRTUSlave, "start", mb_rtu_sl_start, 0);
-    rb_define_method(cRTUSlave, "stop", mb_rtu_sl_stop, 0);
-
-    /* Errors */
-    mErrors = rb_define_module_under(mModBus, "Errors");
-    eModBusError = rb_define_class_under(mErrors, "ModBusError", 
-                                        rb_eStandardError);
-    eIllegalFunction = rb_define_class_under(mErrors, "IllegalFunction",
-                                        eModBusError);
-    eIllegalDataAddress = rb_define_class_under(mErrors, "IllegalDataAddress",
-                                        eModBusError);
-    eIllegalDataValue = rb_define_class_under(mErrors, "IllegalDataValue",
-                                        eModBusError);
-    eSlaveDeviceFailure = rb_define_class_under(mErrors, "SlaveDeviceFailure",
-                                        eModBusError);
-    eAcknowledge = rb_define_class_under(mErrors, "Acknowledge",
-                                        eModBusError);
-    eSlaveDeviceBusy = rb_define_class_under(mErrors, "SlaveDeviceBusy",
-                                        eModBusError);
-    eNegativeAcknowledge = rb_define_class_under(mErrors, "NegativeAcknowledge",
-                                        eModBusError);
-    eMemoryParityError = rb_define_class_under(mErrors, "MemoryParityError",
-                                        eModBusError);
-    eGatewayProblemPath = rb_define_class_under(mErrors, "GatewayProblemPath", 
-                                        eModBusError);
-    eGatewayProblemTarget = rb_define_class_under(mErrors, "GatewayProblemTarget",
-                                        eModBusError);
-}