txPin to txEnablePin, direct to txEnableDirect #266

emelianov · emelianov · commit 0bc538d1eb43 · 2023-04-01T09:07:05.000+05:00
diff --git a/documentation/API.md b/documentation/API.md
@@ -47,12 +47,12 @@ bool removeIreg(uint16_t offset, uint16_t numregs = 1);
 ### Modbus RTU Specific API
 
 ```c
-bool begin(SoftwareSerial* port, int16_t txPin=-1, bool direct=true);
-bool begin(HardwareSerial* port, int16_t txPin=-1, bool direct=true);
+bool begin(SoftwareSerial* port, int16_t txEnablePin=-1, bool txEnableDirect=true);
+bool begin(HardwareSerial* port, int16_t txEnablePin=-1, bool txEnableDirect=true);
 bool begin(Stream* port);
 ```
 
-Assing Serial port. txPin controls transmit enable for MAX-485. Pass direct=false if txPin uses inverse logic.
+Assing Serial port. txEnablePin controls transmit enable for MAX-485. Pass txEnableDirect=false if txEnablePin uses inverse logic.
 
 ```c
 void setBaudrte(uint32 baud);
diff --git a/examples/RTU/README.MD b/examples/RTU/README.MD
@@ -11,16 +11,16 @@ This example introduces how to use the library for ModbusRTU (typicaly over RS-4
 ## Modbus RTU Specific API
 
 ```c
-bool begin(SoftwareSerial* port, int16_t txPin=-1, bool direct=true);
-bool begin(HardwareSerial* port, int16_t txPin=-1, bool direct=true);
+bool begin(SoftwareSerial* port, int16_t txEnablePin=-1, bool txEnableDirect=true);
+bool begin(HardwareSerial* port, int16_t txEnablePin=-1, bool txEnableDirect=true);
 bool begin(Stream* port);
 ```
 
 - `port`    Pointer to Serial port
-- `txPin`   RX/TX control pin. Not assigned (assume auto RX/TX) by default
-- `direct`  Direct (true, default) or inverse (false) RX/TX pin control.
+- `txEnablePin`   RX/TX control pin. Not assigned (assume auto RX/TX) by default
+- `txEnableDirect`  Direct (true, default) or inverse (false) RX/TX pin control.
 
-Assign Serial port. txPin controls transmit enable for MAX-485.
+Assign Serial port. txEnablePin controls transmit enable for MAX-485.
 
 ```c
 void setBaudrate(uint32 baud);
diff --git a/src/ModbusRTU.cpp b/src/ModbusRTU.cpp
@@ -109,17 +109,17 @@ void ModbusRTUTemplate::setInterFrameTime(uint32_t t_us) {
     _t = t_us;
 }
 
-bool ModbusRTUTemplate::begin(Stream* port, int16_t txPin, bool direct) {
+bool ModbusRTUTemplate::begin(Stream* port, int16_t txEnablePin, bool txEnableDirect) {
     _port = port;
     _t = 1750UL;
 #if defined(MODBUSRTU_FLUSH_DELAY)
 	_t1 = charSendTime(0);
 #endif
-    if (txPin >= 0) {
-	    _txPin = txPin;
-		_direct = direct;
-        pinMode(_txPin, OUTPUT);
-        digitalWrite(_txPin, _direct?LOW:HIGH);
+    if (txEnablePin >= 0) {
+	    _txEnablePin = txEnablePin;
+		_direct = txEnableDirect;
+        pinMode(_txEnablePin, OUTPUT);
+        digitalWrite(_txEnablePin, _direct?LOW:HIGH);
     }
     return true;
 }
@@ -134,18 +134,18 @@ bool ModbusRTUTemplate::rawSend(uint8_t slaveId, uint8_t* frame, uint8_t len) {
 	Serial.println();
 #endif
 #if defined(MODBUSRTU_REDE)
-	if (_txPin >= 0 || _rxPin >= 0) {
-    	if (_txPin >= 0)
-        	digitalWrite(_txPin, _direct?HIGH:LOW);
+	if (_txEnablePin >= 0 || _rxPin >= 0) {
+    	if (_txEnablePin >= 0)
+        	digitalWrite(_txEnablePin, _direct?HIGH:LOW);
 		if (_rxPin >= 0)
         	digitalWrite(_rxPin, _direct?HIGH:LOW);
 #if !defined(ESP32)
         delayMicroseconds(MODBUSRTU_REDE_SWITCH_US);
 #endif
 	}
 #else
-    if (_txPin >= 0) {
-        digitalWrite(_txPin, _direct?HIGH:LOW);
+    if (_txEnablePin >= 0) {
+        digitalWrite(_txEnablePin, _direct?HIGH:LOW);
 #if !defined(ESP32)
         delayMicroseconds(MODBUSRTU_REDE_SWITCH_US);
 #endif
@@ -160,21 +160,21 @@ bool ModbusRTUTemplate::rawSend(uint8_t slaveId, uint8_t* frame, uint8_t len) {
     _port->write(newCrc & 0xFF);//Send CRC
     _port->flush();
 #if defined(MODBUSRTU_REDE)
-	if (_txPin >= 0 || _rxPin >= 0) {
+	if (_txEnablePin >= 0 || _rxPin >= 0) {
 #if defined(MODBUSRTU_FLUSH_DELAY)
 		delayMicroseconds(_t1 * MODBUSRTU_FLUSH_DELAY);
 #endif
-    	if (_txPin >= 0)
-        	digitalWrite(_txPin, _direct?LOW:HIGH);
+    	if (_txEnablePin >= 0)
+        	digitalWrite(_txEnablePin, _direct?LOW:HIGH);
 		if (_rxPin >= 0)
         	digitalWrite(_rxPin, _direct?LOW:HIGH);
 	}
 #else
-    if (_txPin >= 0) {
+    if (_txEnablePin >= 0) {
 #if defined(MODBUSRTU_FLUSH_DELAY)
 		delayMicroseconds(_t1 * MODBUSRTU_FLUSH_DELAY);
 #endif
-        digitalWrite(_txPin, _direct?LOW:HIGH);
+        digitalWrite(_txEnablePin, _direct?LOW:HIGH);
 	}
 #endif
     return true;
diff --git a/src/ModbusRTU.h b/src/ModbusRTU.h
@@ -11,11 +11,11 @@
 class ModbusRTUTemplate : public Modbus {
     protected:
         Stream* _port;
-        int16_t   _txPin = -1;
+        int16_t   _txEnablePin = -1;
 #if defined(MODBUSRTU_REDE)
         int16_t   _rxPin = -1;
 #endif
-		bool _direct = true;	// Transmit control logic (true=direct, false=inverse)
+		bool _direct = true;	// Transmit control logic (true=txEnableDirect, false=inverse)
 		uint32_t _t;	// inter-frame delay in uS
 #if defined(MODBUSRTU_FLUSH_DELAY)
 		uint32_t _t1;	// char send time
@@ -47,12 +47,12 @@ class ModbusRTUTemplate : public Modbus {
 		void setInterFrameTime(uint32_t t_us);
 		uint32_t charSendTime(uint32_t baud, uint8_t char_bits = 11);
 		template <class T>
-		bool begin(T* port, int16_t txPin = -1, bool direct = true);
+		bool begin(T* port, int16_t txEnablePin = -1, bool txEnableDirect = true);
 #if defined(MODBUSRTU_REDE)
 		template <class T>
-		bool begin(T* port, int16_t txPin, int16_t rxPin, bool direct);
+		bool begin(T* port, int16_t txEnablePin, int16_t rxEnablePin, bool txEnableDirect);
 #endif
-		bool begin(Stream* port, int16_t txPin = -1, bool direct = true);
+		bool begin(Stream* port, int16_t txEnablePin = -1, bool txEnableDirect = true);
         void task();
 		void client() { isMaster = true; };
 		inline void master() {client();}
@@ -64,7 +64,7 @@ class ModbusRTUTemplate : public Modbus {
 };
 
 template <class T>
-bool ModbusRTUTemplate::begin(T* port, int16_t txPin, bool direct) {
+bool ModbusRTUTemplate::begin(T* port, int16_t txEnablePin, bool txEnableDirect) {
     uint32_t baud = 0;
     #if defined(ESP32) || defined(ESP8266) // baudRate() only available with ESP32+ESP8266
     baud = port->baudRate();
@@ -76,20 +76,20 @@ bool ModbusRTUTemplate::begin(T* port, int16_t txPin, bool direct) {
 	_t1 = charSendTime(baud);
 #endif
     _port = port;
-    if (txPin >= 0) {
-	    _txPin = txPin;
-		_direct = direct;
-        pinMode(_txPin, OUTPUT);
-        digitalWrite(_txPin, _direct?LOW:HIGH);
+    if (txEnablePin >= 0) {
+	    _txEnablePin = txEnablePin;
+		_direct = txEnableDirect;
+        pinMode(_txEnablePin, OUTPUT);
+        digitalWrite(_txEnablePin, _direct?LOW:HIGH);
     }
     return true;
 }
 #if defined(MODBUSRTU_REDE)
 template <class T>
-bool ModbusRTUTemplate::begin(T* port, int16_t txPin, int16_t rxPin, bool direct) {
-	begin(port, txPin, direct);
-	if (rxPin > 0) {
-		_rxPin = rxPin;
+bool ModbusRTUTemplate::begin(T* port, int16_t txEnablePin, int16_t rxEnablePin, bool txEnableDirect) {
+	begin(port, txEnablePin, txEnableDirect);
+	if (rxEnablePin > 0) {
+		_rxPin = rxEnablePin;
         pinMode(_rxPin, OUTPUT);
         digitalWrite(_rxPin, _direct?LOW:HIGH);
 	}
