ESP8266 ESP32 compatible

library.properties

@@ -1,9 +1,9 @@
 name=ArduinoModbus
-version=1.0.6
+version=1.0.72
 author=Arduino
 maintainer=Arduino <info@arduino.cc>
 sentence=Use Modbus equipment with your Arduino.
-paragraph=Using TCP or RS485 shields, like the MKR 485 Shield. This library depends on the ArduinoRS485 library.
+paragraph=Using TCP or RS485 shields, like the MKR 485 Shield and ESP32/ESP8266. This library depends on the ArduinoRS485 library.
 category=Communication
 url=https://www.arduino.cc/en/ArduinoModbus/ArduinoModbus
 architectures=*

src/ArduinoModbus.h

@@ -20,6 +20,8 @@
 #ifndef _ARDUINO_MODBUS_H_INCLUDED
 #define _ARDUINO_MODBUS_H_INCLUDED
 
+#include "ModbusASCIIClient.h"
+
 #include "ModbusRTUClient.h"
 #include "ModbusRTUServer.h"
 

src/ModbusASCIIClient.cpp

@@ -0,0 +1,60 @@
+/*
+  This file is part of the ArduinoModbus library.
+  Copyright (c) 2018 Arduino SA. All rights reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library 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 General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#include <errno.h>
+
+extern "C" {
+#include "libmodbus/modbus.h"
+#include "libmodbus/modbus-ascii.h"
+}
+
+#include "ModbusASCIIClient.h"
+
+ModbusASCIIClientClass::ModbusASCIIClientClass() :
+  ModbusClient(1000)
+{
+}
+
+ModbusASCIIClientClass::ModbusASCIIClientClass(RS485Class& rs485) :
+  ModbusClient(1000),  _rs485(&rs485)
+{
+}
+
+ModbusASCIIClientClass::~ModbusASCIIClientClass()
+{
+}
+
+int ModbusASCIIClientClass::begin(unsigned long baudrate, RS485_SER_CONF_TYPE config)
+{
+  modbus_t* mb = modbus_new_ascii(_rs485, baudrate, config);
+
+  if (!ModbusClient::begin(mb, 0x00)) {
+    return 0;
+  }
+
+  return 1;
+}
+
+int ModbusASCIIClientClass::begin(RS485Class& rs485, unsigned long baudrate, RS485_SER_CONF_TYPE config)
+{
+  _rs485 = &rs485;
+  return begin(baudrate, config);
+}
+
+ModbusASCIIClientClass ModbusASCIIClient;

src/ModbusASCIIClient.h

@@ -0,0 +1,49 @@
+/*
+  This file is part of the ArduinoModbus library.
+  Copyright (c) 2018 Arduino SA. All rights reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library 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 General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef _MODBUS_ASCII_CLIENT_H_INCLUDED
+#define _MODBUS_ASCII_CLIENT_H_INCLUDED
+
+#include "ModbusClient.h"
+#include <ArduinoRS485.h>
+
+class ModbusASCIIClientClass : public ModbusClient {
+public:
+  ModbusASCIIClientClass();
+  ModbusASCIIClientClass(RS485Class& rs485);
+  virtual ~ModbusASCIIClientClass();
+
+  /**
+   * Start the Modbus RTU client with the specified parameters
+   *
+   * @param baudrate Baud rate to use
+   * @param config serial config. to use defaults to SERIAL_8N1
+   *
+   * Return 1 on success, 0 on failure
+   */
+  int begin(unsigned long baudrate, RS485_SER_CONF_TYPE config = SERIAL_8N1);
+  int begin(RS485Class& rs485, unsigned long baudrate, RS485_SER_CONF_TYPE config = SERIAL_8N1);
+
+private:
+  RS485Class* _rs485 = &RS485;
+};
+
+extern ModbusASCIIClientClass ModbusASCIIClient;
+
+#endif

src/ModbusRTUClient.cpp

@@ -40,7 +40,7 @@ ModbusRTUClientClass::~ModbusRTUClientClass()
 {
 }
 
-int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config)
+int ModbusRTUClientClass::begin(unsigned long baudrate, RS485_SER_CONF_TYPE config)
 {
   modbus_t* mb = modbus_new_rtu(_rs485, baudrate, config);
 
@@ -51,7 +51,7 @@ int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config)
   return 1;
 }
 
-int ModbusRTUClientClass::begin(RS485Class& rs485, unsigned long baudrate, uint16_t config)
+int ModbusRTUClientClass::begin(RS485Class& rs485, unsigned long baudrate, RS485_SER_CONF_TYPE config)
 {
   _rs485 = &rs485;
   return begin(baudrate, config);

src/ModbusRTUClient.h

@@ -37,8 +37,8 @@ class ModbusRTUClientClass : public ModbusClient {
    *
    * Return 1 on success, 0 on failure
    */
-  int begin(unsigned long baudrate, uint16_t config = SERIAL_8N1);
-  int begin(RS485Class& rs485, unsigned long baudrate, uint16_t config = SERIAL_8N1);
+  int begin(unsigned long baudrate, RS485_SER_CONF_TYPE config = SERIAL_8N1);
+  int begin(RS485Class& rs485, unsigned long baudrate, RS485_SER_CONF_TYPE config = SERIAL_8N1);
 
 private:
   RS485Class* _rs485 = &RS485;

src/ModbusRTUServer.cpp

@@ -38,7 +38,7 @@ ModbusRTUServerClass::~ModbusRTUServerClass()
 {
 }
 
-int ModbusRTUServerClass::begin(int id, unsigned long baudrate, uint16_t config)
+int ModbusRTUServerClass::begin(int id, unsigned long baudrate, RS485_SER_CONF_TYPE config)
 {
   modbus_t* mb = modbus_new_rtu(_rs485, baudrate, config);
 
@@ -51,7 +51,7 @@ int ModbusRTUServerClass::begin(int id, unsigned long baudrate, uint16_t config)
   return 1;
 }
 
-int ModbusRTUServerClass::begin(RS485Class& rs485, int id, unsigned long baudrate, uint16_t config)
+int ModbusRTUServerClass::begin(RS485Class& rs485, int id, unsigned long baudrate, RS485_SER_CONF_TYPE config)
 {
   _rs485 = &rs485;
   return begin(id, baudrate, config);

src/ModbusRTUServer.h

@@ -38,8 +38,8 @@ class ModbusRTUServerClass : public ModbusServer {
    *
    * Return 1 on success, 0 on failure
    */
-  int begin(int id, unsigned long baudrate, uint16_t config = SERIAL_8N1);
-  int begin(RS485Class& rs485, int id, unsigned long baudrate, uint16_t config = SERIAL_8N1);
+  int begin(int id, unsigned long baudrate, RS485_SER_CONF_TYPE config = SERIAL_8N1);
+  int begin(RS485Class& rs485, int id, unsigned long baudrate, RS485_SER_CONF_TYPE config = SERIAL_8N1);
 
   /**
    * Poll interface for requests

src/libmodbus/modbus-ascii-private.h

@@ -0,0 +1,85 @@
+/*
+ * Copyright © 2001-2011 Stéphane Raimbault <stephane.raimbault@gmail.com>
+ * Copyright © 2018 Arduino SA. All rights reserved.
+ *
+ * SPDX-License-Identifier: LGPL-2.1+
+ */
+
+#ifndef MODBUS_ASCII_PRIVATE_H
+#define MODBUS_ASCII_PRIVATE_H
+
+#ifndef _MSC_VER
+#include <stdint.h>
+#else
+#include "stdint.h"
+#endif
+
+#if defined(_WIN32)
+#include <windows.h>
+#elif defined(ARDUINO)
+#include <ArduinoRS485.h>
+#else
+#include <termios.h>
+#endif
+
+#define _MODBUS_ASCII_HEADER_LENGTH      1
+#define _MODBUS_ASCII_PRESET_REQ_LENGTH  6
+#define _MODBUS_ASCII_PRESET_RSP_LENGTH  2
+
+#define _MODBUS_ASCII_CHECKSUM_LENGTH    1
+
+#if defined(_WIN32)
+#if !defined(ENOTSUP)
+#define ENOTSUP WSAEOPNOTSUPP
+#endif
+
+/* WIN32: struct containing serial handle and a receive buffer */
+#define PY_BUF_SIZE 512
+struct win32_ser {
+    /* File handle */
+    HANDLE fd;
+    /* Receive buffer */
+    uint8_t buf[PY_BUF_SIZE];
+    /* Received chars */
+    DWORD n_bytes;
+};
+#endif /* _WIN32 */
+
+typedef struct _modbus_ascii {
+#if defined(ARDUINO)
+    unsigned long baud;
+    RS485_SER_CONF_TYPE config;
+    RS485Class* rs485;
+#else
+    /* Device: "/dev/ttyS0", "/dev/ttyUSB0" or "/dev/tty.USA19*" on Mac OS X. */
+    char *device;
+    /* Bauds: 9600, 19200, 57600, 115200, etc */
+    int baud;
+    /* Data bit */
+    uint8_t data_bit;
+    /* Stop bit */
+    uint8_t stop_bit;
+    /* Parity: 'N', 'O', 'E' */
+    char parity;
+#if defined(_WIN32)
+    struct win32_ser w_ser;
+    DCB old_dcb;
+#else
+    /* Save old termios settings */
+    struct termios old_tios;
+#endif
+#if HAVE_DECL_TIOCSRS485
+    int serial_mode;
+#endif
+#if HAVE_DECL_TIOCM_RTS
+    int rts;
+    int rts_delay;
+    int onebyte_time;
+    void (*set_rts) (modbus_t *ctx, int on);
+#endif
+#endif
+    /* To handle many slaves on the same link */
+    int confirmation_to_ignore;
+} modbus_ascii_t;
+
+#endif /* MODBUS_ASCII_PRIVATE_H */

src/libmodbus/modbus-ascii.h

@@ -0,0 +1,48 @@
+/*
+ * Copyright © 2001-2011 Stéphane Raimbault <stephane.raimbault@gmail.com>
+ * Copyright © 2018 Arduino SA. All rights reserved.
+ *
+ * SPDX-License-Identifier: LGPL-2.1+
+ */
+
+#ifndef MODBUS_ASCII_H
+#define MODBUS_ASCII_H
+
+#include "modbus.h"
+
+MODBUS_BEGIN_DECLS
+
+/* 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
+ */
+#define MODBUS_ASCII_MAX_ADU_LENGTH  256
+
+#ifdef ARDUINO
+class RS485Class;
+MODBUS_API modbus_t* modbus_new_ascii(RS485Class *rs485, unsigned long baud, RS485_SER_CONF_TYPE config);
+#else
+MODBUS_API modbus_t* modbus_new_ascii(const char *device, int baud, char parity,
+                                    int data_bit, int stop_bit);
+
+#define MODBUS_ASCII_RS232 0
+#define MODBUS_ASCII_RS485 1
+
+MODBUS_API int modbus_ascii_set_serial_mode(modbus_t *ctx, int mode);
+MODBUS_API int modbus_ascii_get_serial_mode(modbus_t *ctx);
+
+#define MODBUS_ASCII_RTS_NONE   0
+#define MODBUS_ASCII_RTS_UP     1
+#define MODBUS_ASCII_RTS_DOWN   2
+
+MODBUS_API int modbus_ascii_set_rts(modbus_t *ctx, int mode);
+MODBUS_API int modbus_ascii_get_rts(modbus_t *ctx);
+
+MODBUS_API int modbus_ascii_set_custom_rts(modbus_t *ctx, void (*set_rts) (modbus_t *ctx, int on));
+
+MODBUS_API int modbus_ascii_set_rts_delay(modbus_t *ctx, int us);
+MODBUS_API int modbus_ascii_get_rts_delay(modbus_t *ctx);
+#endif
+
+MODBUS_END_DECLS
+
+#endif /* MODBUS_ASCII_H */

src/libmodbus/modbus-private.h

@@ -53,9 +53,11 @@ MODBUS_BEGIN_DECLS
 #define _RESPONSE_TIMEOUT    500000
 #define _BYTE_TIMEOUT        500000
 
-typedef enum {
-    _MODBUS_BACKEND_TYPE_RTU=0,
-    _MODBUS_BACKEND_TYPE_TCP
+typedef enum
+{
+    _MODBUS_BACKEND_TYPE_RTU = 0,
+    _MODBUS_BACKEND_TYPE_TCP,
+    _MODBUS_BACKEND_TYPE_ASCII
 } modbus_backend_type_t;
 
 /*

src/libmodbus/modbus-rtu-private.h

@@ -48,7 +48,7 @@ struct win32_ser {
 typedef struct _modbus_rtu {
 #if defined(ARDUINO)
     unsigned long baud;
-    uint16_t config;
+    RS485_SER_CONF_TYPE config;
     RS485Class* rs485;
 #else
     /* Device: "/dev/ttyS0", "/dev/ttyUSB0" or "/dev/tty.USA19*" on Mac OS X. */

src/libmodbus/modbus-rtu.cpp

@@ -1330,7 +1330,7 @@ const modbus_backend_t _modbus_rtu_backend = {
 };
 
 #ifdef ARDUINO
-modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, uint16_t config)
+modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, RS485_SER_CONF_TYPE config)
 #else
 modbus_t* modbus_new_rtu(const char *device,
                          int baud, char parity, int data_bit,

src/libmodbus/modbus-rtu.h

@@ -19,7 +19,7 @@ MODBUS_BEGIN_DECLS
 
 #ifdef ARDUINO
 class RS485Class;
-MODBUS_API modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, uint16_t config);
+MODBUS_API modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, RS485_SER_CONF_TYPE config);
 #else
 MODBUS_API modbus_t* modbus_new_rtu(const char *device, int baud, char parity,
                                     int data_bit, int stop_bit);

src/libmodbus/modbus.h

@@ -58,6 +58,17 @@ MODBUS_BEGIN_DECLS
 #define ON 1
 #endif
 
+/* ESP8266 / ESP32 compatibility */
+#ifndef RS485_SER_CONF_TYPE
+    #if defined(ESP8266)
+    #define RS485_SER_CONF_TYPE SerialConfig
+    #elif defined(ESP32)
+    #define RS485_SER_CONF_TYPE uint32_t
+    #else
+    #define RS485_SER_CONF_TYPE uint16_t
+    #endif
+#endif
+
 /* Modbus function codes */
 #define MODBUS_FC_READ_COILS                0x01
 #define MODBUS_FC_READ_DISCRETE_INPUTS      0x02