Refactor to namespace SoftwareSerial.�Remove example that's unmaintained for a long time.

Author: dok-net

examples/bitpattern/bitpattern.ino

@@ -18,9 +18,9 @@
 #endif
 #endif
 
-SoftwareSerial swSer;
+SoftwareSerial::UART swSer;
 #ifdef ESP8266
-auto logSer = SoftwareSerial(-1, TX);
+auto logSer = SoftwareSerial::UART(-1, TX);
 auto hwSer = Serial;
 #else
 auto logSer = Serial;
@@ -32,14 +32,14 @@ constexpr uint32_t TESTBPS = 115200;
 void setup() {
 	delay(2000);
 #ifdef ESP8266
-	hwSer.begin(TESTBPS, SERIAL_8N1);
+	hwSer.begin(TESTBPS, ::SERIAL_8N1);
 	hwSer.swap();
 #else
-	hwSer.begin(TESTBPS, SERIAL_8N1, D6, D5);
+	hwSer.begin(TESTBPS, ::SERIAL_8N1, D6, D5);
 #endif
 	logSer.begin(115200);
 	logSer.println(PSTR("\nOne Wire Half Duplex Bitpattern and Datarate Test"));
-	swSer.begin(TESTBPS, SWSERIAL_8N1, D6, D5);
+	swSer.begin(TESTBPS, SoftwareSerial::SERIAL_8N1, D6, D5);
 	swSer.enableIntTx(true);
 	logSer.println(PSTR("Tx on swSer"));
 }

examples/loopback/loopback.ino

@@ -47,11 +47,11 @@ constexpr int IUTBITRATE = 19200;
 #endif
 
 #if defined(ESP8266)
-constexpr SoftwareSerialConfig swSerialConfig = SWSERIAL_8E1;
-constexpr SerialConfig hwSerialConfig = SERIAL_8E1;
+constexpr SoftwareSerial::Config swSerialConfig = SoftwareSerial::SERIAL_8E1;
+constexpr SerialConfig hwSerialConfig = ::SERIAL_8E1;
 #elif defined(ESP32)
-constexpr SoftwareSerialConfig swSerialConfig = SWSERIAL_8E1;
-constexpr uint32_t hwSerialConfig = SERIAL_8E1;
+constexpr SoftwareSerial::Config swSerialConfig = SoftwareSerial::SERIAL_8E1;
+constexpr uint32_t hwSerialConfig = ::SERIAL_8E1;
 #else
 constexpr unsigned swSerialConfig = 3;
 #endif
@@ -72,37 +72,37 @@ constexpr int ReportInterval = IUTBITRATE / 8;
 #if defined(ESP8266)
 #if defined(HWLOOPBACK) || defined(HWSOURCESWSINK)
 HardwareSerial& hwSerial(Serial);
-SoftwareSerial serialIUT;
-SoftwareSerial logger;
+SoftwareSerial::UART serialIUT;
+SoftwareSerial::UART logger;
 #elif defined(HWSOURCESINK)
 HardwareSerial& serialIUT(Serial);
-SoftwareSerial logger;
+SoftwareSerial::UART logger;
 #else
-SoftwareSerial serialIUT;
+SoftwareSerial::UART serialIUT;
 HardwareSerial& logger(Serial);
 #endif
 #elif defined(ESP32)
 #if defined(HWLOOPBACK) || defined (HWSOURCESWSINK)
 HardwareSerial& hwSerial(Serial2);
-SoftwareSerial serialIUT;
+SoftwareSerial::UART serialIUT;
 #elif defined(HWSOURCESINK)
 HardwareSerial& serialIUT(Serial2);
 #else
-SoftwareSerial serialIUT;
+SoftwareSerial::UART serialIUT;
 #endif
 HardwareSerial& logger(Serial);
 #else
-SoftwareSerial serialIUT(14, 12);
+SoftwareSerial::UART serialIUT(14, 12);
 HardwareSerial& logger(Serial);
 #endif
 
 void setup() {
 #if defined(ESP8266)
 #if defined(HWLOOPBACK) || defined(HWSOURCESINK) || defined(HWSOURCESWSINK)
-    Serial.begin(IUTBITRATE, hwSerialConfig, SERIAL_FULL, 1, invert);
+    Serial.begin(IUTBITRATE, hwSerialConfig, ::SERIAL_FULL, 1, invert);
     Serial.swap();
     Serial.setRxBufferSize(2 * BLOCKSIZE);
-    logger.begin(9600, SWSERIAL_8N1, -1, TX);
+    logger.begin(9600, SoftwareSerial::SERIAL_8N1, -1, TX);
 #else
     logger.begin(9600);
 #endif

examples/onewiretest/onewiretest.ino

@@ -10,17 +10,17 @@
 #endif
 #endif
 
-SoftwareSerial swSer1;
-SoftwareSerial swSer2;
+SoftwareSerial::UART swSer1;
+SoftwareSerial::UART swSer2;
 
 void setup() {
 	delay(2000);
 	Serial.begin(115200);
 	Serial.println(PSTR("\nOne Wire Half Duplex Serial Tester"));
-	swSer1.begin(115200, SWSERIAL_8N1, D6, D6, false, 256);
+	swSer1.begin(115200, SoftwareSerial::SERIAL_8N1, D6, D6, false, 256);
 	// high speed half duplex, turn off interrupts during tx
 	swSer1.enableIntTx(false);
-	swSer2.begin(115200, SWSERIAL_8N1, D5, D5, false, 256);
+	swSer2.begin(115200, SoftwareSerial::SERIAL_8N1, D5, D5, false, 256);
 	// high speed half duplex, turn off interrupts during tx
 	swSer2.enableIntTx(false);
 }
@@ -36,7 +36,7 @@ void loop() {
 
 }
 
-void checkSwSerial(SoftwareSerial* ss) {
+void checkSwSerial(SoftwareSerial::UART* ss) {
 	byte ch;
 	while (!Serial.available());
 	ss->enableTx(true);
@@ -45,7 +45,7 @@ void checkSwSerial(SoftwareSerial* ss) {
 		ss->write(ch);
 	}
 	ss->enableTx(false);
-	// wait 1 second for the reply from SOftwareSerial if any
+	// wait 1 second for the reply from SoftwareSerial if any
 	delay(1000);
 	if (ss->available()) {
 		Serial.print(PSTR("\nResult:"));

examples/onreceive/onreceive.ino

@@ -16,7 +16,7 @@
 #define BAUD_RATE 115200
 #define MAX_FRAMEBITS (1 + 8 + 1 + 2)
 
-SoftwareSerial testSerial;
+SoftwareSerial::UART testSerial;
 
 // Becomes set from ISR / IRQ callback function.
 std::atomic<bool> rxPending(false);
@@ -30,7 +30,7 @@ void setup() {
 	Serial.begin(115200);
 	Serial.setDebugOutput(false);
 	Serial.swap();
-	testSerial.begin(BAUD_RATE, SWSERIAL_8N1, RX, TX);
+	testSerial.begin(BAUD_RATE, SoftwareSerial::SERIAL_8N1, RX, TX);
 	// Only half duplex this way, but reliable TX timings for high bps
 	testSerial.enableIntTx(false);
 	testSerial.onReceive(receiveHandler);

examples/repeater/repeater.ino

@@ -37,11 +37,11 @@ constexpr int IUTBITRATE = 19200;
 #endif
 
 #if defined(ESP8266)
-constexpr SoftwareSerialConfig swSerialConfig = SWSERIAL_8E1;
-constexpr SerialConfig hwSerialConfig = SERIAL_8E1;
+constexpr SoftwareSerial::Config swSerialConfig = SoftwareSerial::SERIAL_8E1;
+constexpr SerialConfig hwSerialConfig = ::SERIAL_8E1;
 #elif defined(ESP32)
-constexpr SoftwareSerialConfig swSerialConfig = SWSERIAL_8E1;
-constexpr uint32_t hwSerialConfig = SERIAL_8E1;
+constexpr SoftwareSerial::Config swSerialConfig = SoftwareSerial::SERIAL_8E1;
+constexpr uint32_t hwSerialConfig = ::SERIAL_8E1;
 #else
 constexpr unsigned swSerialConfig = 3;
 #endif
@@ -60,30 +60,30 @@ constexpr int ReportInterval = IUTBITRATE / 8;
 #if defined(ESP8266)
 #if defined(HWLOOPBACK)
 HardwareSerial& repeater(Serial);
-SoftwareSerial logger;
+SoftwareSerial::UART logger;
 #else
-SoftwareSerial repeater;
+SoftwareSerial::UART repeater;
 HardwareSerial& logger(Serial);
 #endif
 #elif defined(ESP32)
 #if defined(HWLOOPBACK)
 HardwareSerial& repeater(Serial2);
 #else
-SoftwareSerial repeater;
+SoftwareSerial::UART repeater;
 #endif
 HardwareSerial& logger(Serial);
 #else
-SoftwareSerial repeater(14, 12);
+SoftwareSerial::UART repeater(14, 12);
 HardwareSerial& logger(Serial);
 #endif
 
 void setup() {
 #if defined(ESP8266)
 #if defined(HWLOOPBACK)
-    repeater.begin(IUTBITRATE, hwSerialConfig, SERIAL_FULL, 1, invert);
+    repeater.begin(IUTBITRATE, hwSerialConfig, ::SERIAL_FULL, 1, invert);
     repeater.swap();
     repeater.setRxBufferSize(2 * BLOCKSIZE);
-    logger.begin(9600, SWSERIAL_8N1, -1, TX);
+    logger.begin(9600, SoftwareSerial::SERIAL_8N1, -1, TX);
 #else
     repeater.begin(IUTBITRATE, swSerialConfig, D7, D8, invert, 4 * BLOCKSIZE);
 #ifdef HALFDUPLEX

examples/servoTester/servoTester.ino

@@ -37,9 +37,9 @@
 
 #ifndef SWAPSERIAL
 auto& usbSerial = Serial;
-SoftwareSerial testSerial;
+SoftwareSerial::UART testSerial;
 #else
-SoftwareSerial usbSerial;
+SoftwareSerial::UART usbSerial;
 auto& testSerial = Serial;
 #endif
 
@@ -51,12 +51,12 @@ void setup() {
     // to the loopback SoftwareSerial adapter gets read before another write is performed.
     // Block writes with a size greater than 1 would usually fail. Do not copy this into your own project without
     // reading the documentation.
-    testSerial.begin(BAUD_RATE, SWSERIAL_8N1, D7, D8, false, 95, 11);
+    testSerial.begin(BAUD_RATE, SoftwareSerial::SERIAL_8N1, D7, D8, false, 95, 11);
 #else
     testSerial.begin(115200);
     testSerial.setDebugOutput(false);
     testSerial.swap();
-    usbSerial.begin(BAUD_RATE, SWSERIAL_8N1, RX, TX, false, 95);
+    usbSerial.begin(BAUD_RATE, SoftwareSerial::SERIAL_8N1, RX, TX, false, 95);
 #endif
 
     usbSerial.println(PSTR("\nSoftware serial test started"));