v1.0.12

vishnumaiea · vishnumaiea · commit b8167c02fc2f · 2024-01-28T15:53:59.000+05:30
diff --git a/.vscode/arduino.json b/.vscode/arduino.json
@@ -1,6 +1,5 @@
 {
-    "board": "esp32:esp32:esp32doit-devkit-v1",
-    "sketch": "examples\\RS485Passthrough\\RS485Passthrough.ino",
-    "configuration": "FlashFreq=80,UploadSpeed=921600,DebugLevel=none,EraseFlash=none",
+    "board": "arduino:avr:uno",
+    "sketch": "examples\\RS485_Sender\\RS485_Sender.ino",
     "port": "COM24"
 }
diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1 @@
+{}
diff --git a/Changes.md b/Changes.md
@@ -0,0 +1,11 @@
+
+#
+### **+05:30 03:04:59 PM 28-01-2024, Sunday**
+
+  * Added fix for SoftwareSerial port not supporting custom serial frame configuration on AVR platform.
+  * Added `ARDUINO_ARCH_AVR` platform check.
+  * Added Changes.md file.
+  * Updated API.md.
+  * Updated Readme.md.
+  * New version 🆕 `v1.0.12`
+
diff --git a/README.adoc b/README.adoc
@@ -1,17 +1,37 @@
 :repository-owner: CIRCUITSTATE
 :repository-name: CSE_ArduinoRS485
-:repository-version: 1.0.11
+:repository-version: 1.0.12
 
 = {repository-name} Library for Arduino =
 
 This Arduino library allows you to send and receive data using the **RS-485** interface standard. Supported by all Arduino-compatible boards such as ESP32, STM32, RP2040, AVR, SAMD, ESP8266, etc. You can use both hardware and software serial ports for communication. This library supports the Maxim Integrated **MAX485** and equivalent transceivers.
 
+== Installation ==
+
+This library is available from the official **Arduino Library Manager**. Open the Arduino IDE, search for **{repository-name}** and install the latest version of the library.
+
+Additionally, you can download the latest release package from the GitHub repository and install it manually. To do so, open the Arduino IDE, go to **Sketch > Include Library > Add .ZIP Library...** and select the downloaded file.
+
+Another method is to clone the GitHub repository directly into your **libraries** folder. The development branch will have the latest features, bug fixes and other changes. To do so, navigate to your **libraries** folder (usually located at **Documents/Arduino/libraries** on Windows and **~/Documents/Arduino/libraries** on macOS) and execute the following command:
+
+[source,bash]
+----
+git clone https://github.com/CIRCUITSTATE/CSE_ArduinoRS485.git
+----
+
+== Examples ==
 Three examples are included with this library:
 
   * **RS485_Sender** - Sends data to a connected receiver.
   * **RS485_Receiver** - Receives data from a connected sender.
   * **RS485_Passthrough** - Sends and receives data between the RS-485 port and the default serial port.
 
+== API Reference ==
+
+You can find the complete API reference for this library at link:docs/api.md[API.md].
+
+== Reference ==
+
 This library is a fork of the **ArduinoRS485** library by Arduino, and is maintained by **CIRCUITSTATE Electronics**.
 
 * https://github.com/arduino-libraries/ArduinoRS485[ArduinoRS485 Library by Arduino]
diff --git a/docs/api.md b/docs/api.md
@@ -1,6 +1,6 @@
 # CSE_ArduinoRS485 library
 
-Version 1.0.11, +05:30 03:54:10 PM 30-10-2023, Monday
+Version 1.0.12, +05:30 03:16:49 PM 28-01-2024, Sunday, Monday
 
 ### Index
 
@@ -48,7 +48,7 @@ RS485Class RS485 (auto serial, int dePin, int rePin, int txPin);
 
 ### `begin()`
 
-Initializes the RS485 object. The baudrate can be left empty to make it `0`. This will prevent the serial port from being initialized by the RS485 library. You have to then manually initialize the serial port before calling any RS485 library function. If the baudrate is non-zero, the user can also specify the UART configuration, for example `SERIAL_8N1`. It is also possible to set pre and post delays in milliseconds for each communication.
+Initializes the RS485 object. The baudrate can be left empty to make it `0`. This will prevent the serial port from being initialized by the RS485 library. You have to then manually initialize the serial port before calling any RS485 library functions. If the baudrate is non-zero, the user can also specify the UART configuration, for example `SERIAL_8N1`. Custom UART configurations are not supported by all platforms, especially when using Software Serial ports. Currently, custom UART frame configurations are ignored when using software serial ports on the AVR platform. It is also possible to set pre and post delays in milliseconds for each communication.
 
 #### Syntax 
 
diff --git a/examples/RS485_Receiver/RS485_Receiver.ino b/examples/RS485_Receiver/RS485_Receiver.ino
@@ -12,14 +12,12 @@
 #include <CSE_ArduinoRS485.h>
 
 // Declare the RS485 interface here with a hardware serial port.
-RS485Class RS485 (Serial1, 2, 3, 4); // DE, RE, TX
+// RS485Class RS485 (Serial1, 2, 3, 4); // DE, RE, TX
 
-/* // If you want to use a software serial port, declare it here,
+// If you want to use a software serial port, declare it here,
 // comment out the previous declaration, and uncomment this section.
-#include <SoftwareSerial.h>
-
-SoftwareSerial mySerial (10, 11); // RX, TX
-RS485Class RS485 (mySerial, 2, 3, 4); // DE, RE, TX */
+SoftwareSerial Serial1 (10, 11); // RX, TX
+RS485Class RS485 (Serial1, 2, 3, 4); // DE, RE, TX
 
 void setup() {
   Serial.begin (9600);
diff --git a/examples/RS485_Sender/RS485_Sender.ino b/examples/RS485_Sender/RS485_Sender.ino
@@ -14,14 +14,12 @@
 int counter = 0;
 
 // Declare the RS485 interface here with a hardware serial port.
-RS485Class RS485 (Serial1, 2, 3, 4); // DE, RE, TX
+// RS485Class RS485 (Serial1, 2, 3, 4); // DE, RE, TX
 
-/* // If you want to use a software serial port, declare it here,
+// If you want to use a software serial port, declare it here,
 // comment out the previous declaration, and uncomment this section.
-#include <SoftwareSerial.h>
-
-SoftwareSerial mySerial (10, 11); // RX, TX
-RS485Class RS485 (mySerial, 2, 3, 4); // DE, RE, TX */
+SoftwareSerial Serial1 (10, 11); // RX, TX
+RS485Class RS485 (Serial1, 2, 3, 4); // DE, RE, TX
 
 void setup() {
   // Initialize the RS485 interface
diff --git a/keywords.txt b/keywords.txt
@@ -18,6 +18,7 @@ peek  KEYWORD2
 read  KEYWORD2
 flush KEYWORD2
 write KEYWORD2
+available KEYWORD2
 
 beginTransmission KEYWORD2
 endTransmission KEYWORD2
diff --git a/library.json b/library.json
@@ -13,7 +13,7 @@
         "url": "https://github.com/CIRCUITSTATE",
         "maintainer": true
     },
-    "version": "1.0.11",
+    "version": "1.0.12",
     "license": "LGPL-2.1",
     "frameworks": "arduino",
     "platforms": "*"
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=CSE_ArduinoRS485
-version=1.0.11
+version=1.0.12
 author=CIRCUITSTATE
 maintainer=CIRCUITSTATE <@circuitstate>
 sentence=Allows sending and receiving data through the RS-485 interface, using any Arduino-compatible boards.
diff --git a/src/CSE_RS485.cpp b/src/CSE_RS485.cpp
@@ -20,8 +20,8 @@
 */
 //===================================================================================//
 
-// Version: 1.0.11
-// Last modified: +05:30 15:51:51 PM 30-10-2023, Monday
+// Version: 1.0.12
+// Last modified: +05:30 15:08:03 PM 28-01-2024, Sunday
 // Source: https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
 
 //===================================================================================//
@@ -152,8 +152,14 @@ void RS485Class:: begin (unsigned long baudrate, uint16_t config, int predelay,
     #if defined(ARDUINO_OPTA)
       auto _opta_uart = static_cast<UART *> (_serial);
       _opta_uart->begin (_baudrate, _config, true);
+    #elif defined(SOFTWARE_SERIAL_REQUIRED)
+      #if defined(ARDUINO_ARCH_AVR)
+        _serial->begin (_baudrate); // AVR software serial doesn't support config
+      #else
+        _serial->begin (_baudrate, _config);
+      #endif
     #else
-      _serial->begin (_baudrate, _config);
+      _serial->begin (_baudrate, _config);  // Default
     #endif
   }
 }
@@ -316,7 +322,18 @@ void RS485Class:: sendBreak (unsigned int duration) {
 
     // Serial port will be reinitialized only if the baudrate is greater than 0.
     if (_baudrate > 0) {
-      _serial->begin (_baudrate, _config);
+      #if defined(ARDUINO_OPTA)
+        auto _opta_uart = static_cast<UART *> (_serial);
+        _opta_uart->begin (_baudrate, _config, true);
+      #elif defined(SOFTWARE_SERIAL_REQUIRED)
+        #if defined(ARDUINO_ARCH_AVR)
+          _serial->begin (_baudrate); // AVR software serial doesn't support config
+        #else
+          _serial->begin (_baudrate, _config);
+        #endif
+      #else
+        _serial->begin (_baudrate, _config);  // Default
+      #endif
     }
   }
 }
@@ -339,7 +356,18 @@ void RS485Class:: sendBreakMicroseconds (unsigned int duration) {
 
     // Serial port will be reinitialized only if the baudrate is greater than 0.
     if (_baudrate > 0) {
-      _serial->begin (_baudrate, _config);
+      #if defined(ARDUINO_OPTA)
+        auto _opta_uart = static_cast<UART *> (_serial);
+        _opta_uart->begin (_baudrate, _config, true);
+      #elif defined(SOFTWARE_SERIAL_REQUIRED)
+        #if defined(ARDUINO_ARCH_AVR)
+          _serial->begin (_baudrate); // AVR software serial doesn't support config
+        #else
+          _serial->begin (_baudrate, _config);
+        #endif
+      #else
+        _serial->begin (_baudrate, _config);  // Default
+      #endif
     }
   }
 }
diff --git a/src/CSE_RS485.h b/src/CSE_RS485.h
@@ -20,8 +20,8 @@
 */
 //===================================================================================//
 
-// Version: 1.0.11
-// Last modified: +05:30 15:51:43 PM 30-10-2023, Monday
+// Version: 1.0.12
+// Last modified: +05:30 15:03:34 PM 28-01-2024, Sunday
 // Source: https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
 
 //===================================================================================//
@@ -39,10 +39,11 @@
 #define RS485_DEFAULT_POST_DELAY    50  // In microseconds
 
 // You can expand the software serial support here.
-// SoftwareSerial is required by board like Arduino Uno and Nano which don't have a
+// SoftwareSerial is required by boards like Arduino Uno and Nano which don't have a
 // dedicated secondary hardware serial port.
-#define SOFTWARE_SERIAL_REQUIRED defined(__AVR__) || defined(ESP8266)
+#define SOFTWARE_SERIAL_REQUIRED defined(__AVR__) || defined(ARDUINO_ARCH_AVR) || defined(ESP8266) 
 
+// The SoftwareSerial is loaded automatically when required.
 #if SOFTWARE_SERIAL_REQUIRED
   #include <SoftwareSerial.h>
 #endif

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`		`- "board": "esp32:esp32:esp32doit-devkit-v1",`
`3`		`- "sketch": "examples\\RS485Passthrough\\RS485Passthrough.ino",`
`4`		`- "configuration": "FlashFreq=80,UploadSpeed=921600,DebugLevel=none,EraseFlash=none",`
	`2`	`+ "board": "arduino:avr:uno",`
	`3`	`+ "sketch": "examples\\RS485_Sender\\RS485_Sender.ino",`
`5`	`4`	`"port": "COM24"`
`6`	`5`	`}`