/* * Copyright © 2001-2010 Stéphane Raimbault * * 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 . */ #ifndef _MODBUS_H_ #define _MODBUS_H_ #ifdef HAVE_INTTYPES_H #include #endif #ifdef HAVE_STDINT_H #include #endif #include #if defined(__FreeBSD__ ) && __FreeBSD__ < 5 #include #endif #include #include #include #include #ifdef __cplusplus # define MODBUS_BEGIN_DECLS extern "C" { # define MODBUS_END_DECLS } #else # define MODBUS_BEGIN_DECLS # define MODBUS_END_DECLS #endif MODBUS_BEGIN_DECLS #ifndef FALSE #define FALSE 0 #endif #ifndef TRUE #define TRUE 1 #endif #ifndef OFF #define OFF 0 #endif #ifndef ON #define ON 1 #endif #define MODBUS_TCP_DEFAULT_PORT 502 #define MODBUS_BROADCAST_ADDRESS 0 #define MODBUS_TCP_SLAVE 0xFF /* 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 MODBUS_MAX_ADU_LENGTH_RTU 256 #define MODBUS_MAX_ADU_LENGTH_TCP 260 /* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 1 page 12) * Quantity of Coils (2 bytes): 1 to 2000 (0x7D0) */ #define MODBUS_MAX_BITS 2000 /* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 3 page 15) * Quantity of Registers (2 bytes): 1 to 125 (0x7D) */ #define MODBUS_MAX_REGISTERS 125 /* Random number to avoid errno conflicts */ #define MODBUS_ENOBASE 112345678 /* Protocol exceptions */ enum { MODBUS_EXCEPTION_ILLEGAL_FUNCTION = 0x01, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE, MODBUS_EXCEPTION_ACKNOWLEDGE, MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY, MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE, MODBUS_EXCEPTION_MEMORY_PARITY, MODBUS_EXCEPTION_NOT_DEFINED, MODBUS_EXCEPTION_GATEWAY_PATH, MODBUS_EXCEPTION_GATEWAY_TARGET, MODBUS_EXCEPTION_MAX }; #define EMBXILFUN (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_FUNCTION) #define EMBXILADD (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS) #define EMBXILVAL (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE) #define EMBXSFAIL (MODBUS_ENOBASE + MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE) #define EMBXACK (MODBUS_ENOBASE + MODBUS_EXCEPTION_ACKNOWLEDGE) #define EMBXSBUSY (MODBUS_ENOBASE + MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY) #define EMBXNACK (MODBUS_ENOBASE + MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE) #define EMBXMEMPAR (MODBUS_ENOBASE + MODBUS_EXCEPTION_MEMORY_PARITY) #define EMBXGPATH (MODBUS_ENOBASE + MODBUS_EXCEPTION_GATEWAY_PATH) #define EMBXGTAR (MODBUS_ENOBASE + MODBUS_EXCEPTION_GATEWAY_TARGET) /* Native libmodbus error codes */ #define EMBBADCRC (EMBXGTAR + 1) #define EMBBADDATA (EMBXGTAR + 2) #define EMBBADEXC (EMBXGTAR + 3) #define EMBUNKEXC (EMBXGTAR + 4) #define EMBMDATA (EMBXGTAR + 5) /* The major version, (1, if %LIBMODBUS_VERSION is 1.2.3) */ #define LIBMODBUS_VERSION_MAJOR (@LIBMODBUS_VERSION_MAJOR@) /* The minor version (2, if %LIBMODBUS_VERSION is 1.2.3) */ #define LIBMODBUS_VERSION_MINOR (@LIBMODBUS_VERSION_MINOR@) /* The micro version (3, if %LIBMODBUS_VERSION is 1.2.3) */ #define LIBMODBUS_VERSION_MICRO (@LIBMODBUS_VERSION_MICRO@) /* The full version, like 1.2.3 */ #define LIBMODBUS_VERSION @LIBMODBUS_VERSION@ /* The full version, in string form (suited for string concatenation) */ #define LIBMODBUS_VERSION_STRING "@LIBMODBUS_VERSION@" /* Numerically encoded version, like 0x010203 */ #define LIBMODBUS_VERSION_HEX ((LIBMODBUS_MAJOR_VERSION << 24) | \ (LIBMODBUS_MINOR_VERSION << 16) | \ (LIBMODBUS_MICRO_VERSION << 8)) /* Evaluates to True if the version is greater than @major, @minor and @micro */ #define LIBMODBUS_VERSION_CHECK(major,minor,micro) \ (LIBMODBUS_VERSION_MAJOR > (major) || \ (LIBMODBUS_VERSION_MAJOR == (major) && \ LIBMODBUS_VERSION_MINOR > (minor)) || \ (LIBMODBUS_VERSION_MAJOR == (major) && \ LIBMODBUS_VERSION_MINOR == (minor) && \ LIBMODBUS_VERSION_MICRO >= (micro))) extern const unsigned int libmodbus_version_major; extern const unsigned int libmodbus_version_minor; extern const unsigned int libmodbus_version_micro; typedef struct _modbus modbus_t; typedef struct { int nb_bits; int nb_input_bits; int nb_input_registers; int nb_registers; uint8_t *tab_bits; uint8_t *tab_input_bits; uint16_t *tab_input_registers; uint16_t *tab_registers; } modbus_mapping_t; modbus_t* modbus_new_rtu(const char *device, int baud, char parity, int data_bit, int stop_bit, int slave); int modbus_set_slave(modbus_t* ctx, int slave); modbus_t* modbus_new_tcp(const char *ip_address, int port); int modbus_set_error_recovery(modbus_t *ctx, int enabled); void modbus_get_timeout_begin(modbus_t *ctx, struct timeval *timeout); void modbus_set_timeout_begin(modbus_t *ctx, const struct timeval *timeout); void modbus_get_timeout_end(modbus_t *ctx, struct timeval *timeout); void modbus_set_timeout_end(modbus_t *ctx, const struct timeval *timeout); int modbus_connect(modbus_t *ctx); void modbus_close(modbus_t *ctx); void modbus_free(modbus_t *ctx); int modbus_flush(modbus_t *ctx); void modbus_set_debug(modbus_t *ctx, int boolean); const char *modbus_strerror(int errnum); int modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest); int modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest); int modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest); int modbus_read_input_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest); int modbus_write_bit(modbus_t *ctx, int coil_addr, int state); int modbus_write_register(modbus_t *ctx, int reg_addr, int value); int modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *data); int modbus_write_registers(modbus_t *ctx, int addr, int nb, const uint16_t *data); int modbus_report_slave_id(modbus_t *ctx, uint8_t *dest); modbus_mapping_t* modbus_mapping_new(int nb_coil_status, int nb_input_status, int nb_holding_registers, int nb_input_registers); void modbus_mapping_free(modbus_mapping_t *mb_mapping); int modbus_listen(modbus_t *ctx, int nb_connection); int modbus_accept(modbus_t *ctx, int *socket); int modbus_receive(modbus_t *ctx, int sockfd, uint8_t *req); int modbus_reply(modbus_t *ctx, const uint8_t *req, int req_length, modbus_mapping_t *mb_mapping); /** * UTILS FUNCTIONS **/ #define MODBUS_GET_HIGH_BYTE(data) ((data >> 8) & 0xFF) #define MODBUS_GET_LOW_BYTE(data) (data & 0xFF) void modbus_set_bits_from_byte(uint8_t *dest, int address, const uint8_t value); void modbus_set_bits_from_bytes(uint8_t *dest, int address, unsigned int nb_bits, const uint8_t *tab_byte); uint8_t modbus_get_byte_from_bits(const uint8_t *src, int address, unsigned int nb_bits); float modbus_get_float(const uint16_t *src); void modbus_set_float(float real, uint16_t *dest); MODBUS_END_DECLS #endif /* _MODBUS_H_ */