fix #4: prepare for release

SoftwareSerial.cpp → MCCI_SoftSerial.cpp

@@ -1,8 +1,8 @@
 /*
-  SoftwareSerial.cpp - library for Arduino M0/M0 pro
+  MCCI_SoftSerial.cpp - library for Arduino M0/M0 pro
   Copyright (c) 2016 Arduino Srl. All rights reserved.
   Written by Chiara Ruggeri ([email protected])
-  Portions copyright (c) 2018 MCCI Corporation. All rights reserved.
+  Portions copyright (c) 2018, 2021, 2023 MCCI Corporation. All rights reserved.
   Written by Terry Moore ([email protected])
 
   This library is free software; you can redistribute it and/or
@@ -24,7 +24,7 @@
 
 
 #include <Arduino.h>
-#include <SoftwareSerial.h>
+#include <MCCI_SoftSerial.h>
 #include <variant.h>
 #include <WInterrupts.h>
 

SoftwareSerial.h → MCCI_SoftSerial.h

@@ -1,8 +1,8 @@
 /*
-  SoftwareSerial.cpp - library for Arduino M0/M0 pro
+  MCCI_SoftSerial.cpp - library for Arduino M0/M0 pro
   Copyright (c) 2016 Arduino Srl. All rights reserved.
   Written by Chiara Ruggeri ([email protected])
-  Portions copyright (c) 2018 MCCI Corporation. All rights reserved.
+  Portions copyright (c) 2018, 2021, 2023 MCCI Corporation. All rights reserved.
   Written by Terry Moore ([email protected])
 
   This library is free software; you can redistribute it and/or
@@ -22,8 +22,8 @@
   Enjoy!
 */
 
-#ifndef SoftwareSerial_h
-#define SoftwareSerial_h
+#ifndef _MCCI_SoftSerial_h_
+#define _MCCI_SoftSerial_h_
 
 #include <inttypes.h>
 #include <Stream.h>
@@ -110,5 +110,5 @@ class SoftwareSerial : public Stream
 #undef abs
 #undef round
 
-#endif
+#endif /* _MCCI_SoftSerial_h_ */
 

README.md

@@ -1,16 +1,20 @@
-# SoftwareSerial library for Arduino
+# MCCI_SoftSerial library for Arduino
 
 This directory contains the SoftwareSerial library split out from https://github.com/Arduino-org/Arduino. All relevant history is retained.
 
 We split it out because it needs some TLC to be compatible with our Modbus library (in particular, the APIs didn't match the modern serial port APIs, and it will no longer compile with modern compilers -- see [issue 234](https://github.com/arduino/ArduinoCore-samd/issues/234)).
 
-[![GitHub release](https://img.shields.io/github/release/mcci-catena/SoftwareSerial/all.svg)](https://github.com/mcci-catena/SoftwareSerial/releases/latest) ![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/SoftwareSerial/latest.svg)
+[![GitHub release](https://img.shields.io/github/release/mcci-catena/MCCI_SoftSerial/all.svg)](https://github.com/mcci-catena/MCCI_SoftSerial/releases/latest) ![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/MCCI_SoftSerial/latest.svg)
 
 ## Change Summary
 
-### v1.0.0
+### v3.0.0
 
-This is the version as imported from Arduino.
+The changes are:
+
+- Fixed issue - ```call of overloaded 'begin(int)' is ambiguous```.
+
+- Modify file names to get library added in Library Manager.
 
 ### v2.0.0
 
@@ -27,3 +31,7 @@ The changes:
 - Added `SoftwareSerial::drainRead()` to do what flush() used to do, in case you are not happy with the recommended `while (mySerial.read() >= 0) /* spin */;` work-around.
 
 - Added fix for [issue 234](https://github.com/arduino/ArduinoCore-samd/issues/234).
+
+### v1.0.0
+
+This is the version as imported from Arduino.

library.properties

@@ -1,9 +1,9 @@
-name=SofwareSerial (MCCI version)
-version=2.0.0
+name=MCCI_SoftSerial
+version=3.0.0
 author=Chiara Ruggeri ([email protected])
 maintainer=Terry Moore <[email protected]>
 sentence=Software UART for Arduino
 paragraph=This library allows any pair of pins to be used as a UART implemented by software. The MCCI version incorporates bug fixes and makes it more compatible with the UART and USB serial classes.
 category=Communication
-url=https://github.com/mcci-catena/SoftwareSerial
+url=https://github.com/mcci-catena/MCCI_SoftSerial
 architectures=*