v1.0.10

* Updated library info.
* Updated docs.

Author: vishnumaiea

.codespellrc

@@ -1,25 +1,22 @@
 :repository-owner: CIRCUITSTATE
 :repository-name: CSE_ArduinoRS485
-:repository-version: 1.0.9
+:repository-version: 1.0.10
 
 = {repository-name} Library for Arduino =
 
-image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"]
-image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"]
-image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"]
-
-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. This library supports the Maxim Integrated MAX485 and equivalent chipsets.
+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.
 
 Three examples are included with this library:
 
-  * **RS485_Sender** - Sends data to a receiver.
-  * **RS485_Receiver** - Receives data from a sender.
+  * **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.
 
-This library is a fork of the ArduinoRS485 library by Arduino, and is maintained by **CIRCUITSTATE**.
+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]
 * https://www.arduino.cc/reference/en/libraries/arduinors485/[ArduinoRS485 documentation by Arduino]
 * https://www.circuitstate.com/tutorials/what-is-rs-485-how-to-use-max485-with-arduino-for-reliable-long-distance-serial-communication/[RS-485 tutorial by CIRCUITSTATE]
 * https://www.circuitstate.com/pinouts/max485-cd4069-rs-485-module-with-auto-data-direction-control-pinout-diagram-and-pin-reference/[MAX485+CD4069 Module Pinout by CIRCUITSTATE]
+* https://www.circuitstate.com/tutorials/what-is-modbus-communication-protocol-and-how-to-implement-modbus-rtu-with-arduino/[Modbus RTU tutorial by CIRCUITSTATE]
 

README.adoc

@@ -1,61 +1,73 @@
-# Arduino RS485 library
+# CSE_ArduinoRS485 library
 
 ## Methods
 
+### Index
+
+* [begin()](#begin)
+* [end()](#end)
+* [available()](#available)
+* [peek()](#peek)
+* [read()](#read)
+* [write()](#write)
+* [flush()](#flush)
+* [beginTransmission()](#begintransmission)
+* [endTransmission()](#endtransmission)
+* [receive()](#receive)
+* [noReceive()](#noreceive)
+* [sendBreak()](#sendbreak)
+* [sendBreakMicroseconds()](#sendbreakmicroseconds)
+* [setPins()](#setpins)
+* [setdelays()](#setdelays)
+
 ### `RS485Class()`
 
-Creates a new CSE_ArduinoRS485 object. If you are using a hardware serial port, you can simply send its name as a parameter. If you are using software serial, you must include the SoftwareSerial library first and create a new object of that type. Then send the name of the object as a parameter.
+Creates a new `RS485Class` object. If you are using a hardware serial port, you can simply send its name as a parameter. If you are using software serial, you must include the SoftwareSerial library first and create a new object of that type. Then send the name of the object as a parameter.
 
+Currently, software serial is supported only on AVR (Arduino Uno, Nano, etc.) and ESP8266 boards. The macro `SOFTWARE_SERIAL_REQUIRED` is used to check if a software serial port to be used. You can update the board support by adding the board name to the macro in the `CSE_RS485.h` file. 
 #### Syntax 
 
 ```cpp
-RS485Class RS485 (serial, dePin, rePin, txPin);
+RS485Class RS485 (auto serial, int dePin, int rePin, int txPin);
 ```
 
 #### Parameters
 
-* _serial_: Name of the serial port to use. Can be hardware serial or software serial.
+* _serial_: Name of the serial port to use. Can be hardware serial (`HardwareSerial`) or software serial (`SoftwareSerial`).
 * _dePin_: Drive enable pin.
 * _rePin_: Receive enable pin. Optional. Default: -1.
 * _txPin_: Serial transmit pin (used to send break signals). Optional. Default: -1.
 
 ### `begin()`
 
-Initializes the RS485 object communication speed. The baudrate can be left empty to make it 0. This will prevent the serial port from being initialized by the RS485 library. But then you have to manually initialize the serial port before calling any RS485 library function.
+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.
 
 #### Syntax 
 
+There are 5 overloads of this function:
+
 ```cpp
+RS485.begin()
 RS485.begin (baudrate)
+RS485.begin (unsigned long baudrate, uint16_t config)
+RS485.begin (unsigned long baudrate, int predelay, int postdelay)
+RS485.begin (unsigned long baudrate, uint16_t config, int predelay, int postdelay)
 ```
 
 #### Parameters
 
-* _baudrate_: communication speed in bits per second (baud).
+* _baudrate_: Communication speed in bits per second (baud). Optional. Default: 0. If 0, the serial port will not be initialized.
+* _config_: Serial port configuration. Example, `SERIAL_8N1`.
+* _predelay_: Delay in milliseconds before sending data. Optional. Default: 0.
+* _postdelay_: Delay in milliseconds after sending data. Optional. Default: 0.
 
 #### Returns
 
 None.
 
-#### See also
-
-* [end()](#end)
-* [available()](#available)
-* [peek()](#peek)
-* [read()](#read)
-* [write()](#write)
-* [flush()](#flush)
-* [beginTransmission()](#begintransmission)
-* [endTransmission()](#endtransmission)
-* [receive()](#receive)
-* [noReceive()](#noreceive)
-* [sendBreak()](#sendbreak)
-* [sendBreakMicroseconds()](#sendbreakmicroseconds)
-* [setPins()](#setpins)
-
 ### `end()`
 
-Disables RS485 communication. This will close the serial port and reset the DE and RE pins to INPUT mode.
+Disables RS485 communication. This will close the serial port and reset the DE and RE pins to INPUT mode. The serial port will be closed regardless of whether it was initialized by the RS485 library or not.
 
 #### Syntax 
 
@@ -73,7 +85,7 @@ None.
 
 ### `available()`
 
-Get the number of bytes (characters) available for reading from the RS485 port. This is data that already arrived and is stored in the serial receive buffer.
+Returns the number of bytes (characters) available for reading from the RS485 port. This is data that already arrived and is stored in the serial receive buffer.
 
 #### Syntax 
 
@@ -87,11 +99,11 @@ None.
 
 #### Returns
 
-The number of bytes available to read.
+* _int_: The number of bytes available to read.
 
 ### `peek()`
 
-Returns the next byte (character) of the incoming serial data without removing it from the internal serial buffer. That is, successive calls to peek() will return the same character, as will the next call to read().
+Returns the next byte (character) of the incoming serial data without removing it from the internal serial buffer. That is, successive calls to `peek()` will return the same character, as will the next call to `read()`. The original Arduino serial `peek()` function returns an `int` type. So this library also does the same.
 
 #### Syntax 
 
@@ -105,11 +117,11 @@ None.
 
 #### Returns
 
-The first byte of incoming serial data available or -1 if no data is available. 
+* _int_: The first byte of incoming serial data available or -1 if no data is available. 
 
 ### `read()`
 
-Reads incoming serial data.
+Returns a single byte from the serial read buffer. Return -1 if no data is available. Each read operation will remove the byte from the buffer.
 
 #### Syntax 
 
@@ -123,7 +135,7 @@ None.
 
 #### Returns
 
-The first byte of incoming serial data available or -1 if no data is available. 
+* _int_: The first byte of incoming serial data available or -1 if no data is available. 
 
 ### `write()`
 
@@ -141,7 +153,7 @@ RS485.write (uint8_t b)
 
 #### Returns
 
-The number of bytes written.
+* _size_t_: The number of bytes written.
 
 ### `flush()`
 
@@ -163,7 +175,9 @@ None.
 
 ### `beginTransmission()`
 
-Enables RS-485 transmission. This will assert the DE pin and the RE pin is not modified (since DE has priority over RE).
+Starts RS-485 transmission. This will assert the DE pin and wait for a pre-delay if it is set. The DE pin has priority over the RE pin. That means, if both DE and RE are actively asserted, the transceiver will be in transmission mode.
+
+You must call this function before any write operations.
 
 #### Syntax 
 
@@ -181,7 +195,7 @@ None.
 
 ### `endTransmission()`
 
-Disables RS-485 transmission. This deasserts the DE pin and the RE pin is not modified (since DE has priority over RE).
+Ends the RS-485 transmission. This deasserts the DE pin and the RE pin is not modified (since DE has priority over RE). If the post-delay is non-zero, the function wait for the specified duration before deasserting the DE pin.
 
 #### Syntax 
 
@@ -199,7 +213,7 @@ None.
 
 ### `receive()`
 
-Enables reception. This asserts the RE pin. The state of the DE pins should be set to LOW before calling this function.
+Puts the transceiver in receive mode by asserting the RE pin. If the DE pin is currently being asserted, this has no effect, because DE has precedence over RE. Call the `endTransmission()` function to deassert the DE pin to free the bus.
 
 #### Syntax 
 
@@ -217,7 +231,7 @@ None.
 
 ### `noReceive()`
 
-Disables reception. This deasserts the RE pin. If the DE pin is also deasserted (LOW), then the transceiver enters a high-impedance state.
+Puts the transceiver in a no receive mode by deasserting the RE pin. If the DE pin is also deasserted, then the transceiver is in a high impedance state.
 
 #### Syntax 
 
@@ -235,7 +249,7 @@ None.
 
 ### `sendBreak()`
 
-Sends a serial break signal for the specified duration in milliseconds. This function will only work if the TX pin is specified in the constructor. The serial port will be reinitialized only if the baudrate is greater than 0.
+Sends a serial break signal for the specified duration in milliseconds. This is done by closing the serial port, holding the TX pin of the serial port LOW for a specified duration in milliseconds, and then reinitializing the serial port. If the TX pins is not set, this function has no effect. The serial port will be reinitialized only if the baudrate is greater than 0. If the baudrate is 0, then you have to manually initialize the serial port in your main code, just after calling this function.
 
 #### Syntax 
 
@@ -253,7 +267,7 @@ None.
 
 ### `sendBreakMicroseconds()`
 
-Sends a serial break signal for the specified duration in microseconds. This function will only work if the TX pin is specified in the constructor. The serial port will be reinitialized only if the baudrate is greater than 0.
+Same as `sendBreak()` but the duration is specified in microseconds.
 
 #### Syntax 
 
@@ -281,9 +295,27 @@ RS485.setPins (int dePin, int rePin, int txPin)
 
 #### Parameters
 
-* _dePin_: drive output enable pin.
-* _rePin_: receiver output enable pin.
-* _txPin_: transmission pin (used to send break signals).
+* _dePin_: Drive output enable pin.
+* _rePin_: Receiver output enable pin.
+* _txPin_: Transmission pin (used to send break signals).
+
+#### Returns
+
+None.
+### `setDelays()`
+
+Sets the pre and post delays in milliseconds.
+
+#### Syntax 
+
+```cpp
+RS485.setDelays (int predelay, int postdelay)
+```
+
+#### Parameters
+
+* _predelay_: The delay before sending data.
+* _postdelay_: The delay after sending data.
 
 #### Returns
 

docs/api.md

@@ -26,6 +26,7 @@ noReceive KEYWORD2
 sendBreak KEYWORD2
 sendBreakMicroseconds KEYWORD2
 setPins KEYWORD2
+setDelays KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

keywords.txt

@@ -13,7 +13,7 @@
         "url": "https://github.com/CIRCUITSTATE",
         "maintainer": true
     },
-    "version": "1.0.9",
+    "version": "1.0.10",
     "license": "LGPL-2.1",
     "frameworks": "arduino",
     "platforms": "*"

library.json

@@ -1,9 +1,9 @@
 name=CSE_ArduinoRS485
-version=1.0.9
+version=1.0.10
 author=CIRCUITSTATE
 maintainer=CIRCUITSTATE <@circuitstate>
 sentence=Allows sending and receiving data through the RS-485 interface, using any Arduino-compatible boards.
-paragraph=This library supports the Maxim Integrated MAX485 and equivalent chipsets. You can use both hardware serial and software serial ports for communication.
+paragraph=This library supports the Maxim Integrated MAX485 and equivalent RS485 transceivers. You can use both hardware and software serial ports for communication.
 category=Communication
 url=https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
 architectures=*

library.properties

@@ -20,8 +20,8 @@
 */
 //===================================================================================//
 
-// Version: 1.0.9
-// Last modified: +05:30 20:37:44 PM 25-07-2023, Tuesday
+// Version: 1.0.10
+// Last modified: +05:30 12:57:59 PM 04-10-2023, Wednesday
 // Source: https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
 
 //===================================================================================//

src/CSE_RS485.cpp

@@ -20,8 +20,8 @@
 */
 //===================================================================================//
 
-// Version: 1.0.9
-// Last modified: +05:30 20:37:40 PM 25-07-2023, Tuesday
+// Version: 1.0.10
+// Last modified: +05:30 12:57:53 PM 04-10-2023, Wednesday
 // Source: https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
 
 //===================================================================================//
@@ -87,7 +87,6 @@ class RS485Class : public Stream {
     void sendBreakMicroseconds (unsigned int duration);
 
     void setPins (int dePin, int rePin = -1, int txPin = -1);
-
     void setDelays (int predelay, int postdelay);
 
   private: