Rename sources to prevent conflicts with other Arduino libraries

Erriez · Aug 4, 2018 · 221b9ca · 221b9ca
1 parent 9e49a0d
commit 221b9ca
Show file tree

Hide file tree

Showing 19 changed files with 45 additions and 49 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -64,11 +64,11 @@ include_directories(
 generate_arduino_library(
         ${PROJECT_NAME}Lib
         SRCS
-            ${LIB_SRC_DIR}/DS3231.cpp
-            ${LIB_SRC_DIR}/DS3231_debug.cpp
+            ${LIB_SRC_DIR}/ErriezDS3231.cpp
+            ${LIB_SRC_DIR}/ErriezDS3231_debug.cpp
         HDRS
-            ${LIB_SRC_DIR}/DS3231.h
-            ${LIB_SRC_DIR}/DS3231_debug.h
+            ${LIB_SRC_DIR}/ErriezDS3231.h
+            ${LIB_SRC_DIR}/ErriezDS3231_debug.h
 )
 
 generate_arduino_library(

diff --git a/README.md b/README.md
@@ -77,7 +77,7 @@ Arduino IDE | Examples | Erriez DS3231 RTC:
 
 ```c++
 #include <Wire.h>
-#include <DS3231.h>
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/AgingOffset/AgingOffset.ino b/examples/AgingOffset/AgingOffset.ino
@@ -33,7 +33,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Set 8-bit signed aging offset value -127...127 for clock speed compensation 0.1ppm per LSB
 #define AGING_OFFSET_VALUE      10

diff --git a/examples/AlarmInterrupt/AlarmInterrupt.ino b/examples/AlarmInterrupt/AlarmInterrupt.ino
@@ -39,7 +39,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Uno, Nano, Mini, other 328-based: pin D2 (INT0) or D3 (INT1)
 // Leonardo: pin D7 (INT4)

diff --git a/examples/AlarmPolling/AlarmPolling.ino b/examples/AlarmPolling/AlarmPolling.ino
@@ -39,7 +39,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/GettingStarted/GettingStarted.ino b/examples/GettingStarted/GettingStarted.ino
@@ -35,7 +35,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/Minimum/Minimum.ino b/examples/Minimum/Minimum.ino
@@ -33,7 +33,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/PrintDiagnostics/PrintDiagnostics.ino b/examples/PrintDiagnostics/PrintDiagnostics.ino
@@ -33,7 +33,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231_debug.h> // ErriezDS3231 debug library
+#include <ErriezDS3231_debug.h>
 
 // Create debug DS3231 RTC object
 DS3231Debug rtc;

diff --git a/examples/ReadTimeInterrupt/ReadTimeInterrupt.ino b/examples/ReadTimeInterrupt/ReadTimeInterrupt.ino
@@ -38,7 +38,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Uno, Nano, Mini, other 328-based: pin D2 (INT0) or D3 (INT1)
 // Leonardo: pin D7 (INT4)

diff --git a/examples/ReadTimePolled/ReadTimePolled.ino b/examples/ReadTimePolled/ReadTimePolled.ino
@@ -33,7 +33,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/SetDateTime/SetDateTime.ino b/examples/SetDateTime/SetDateTime.ino
@@ -33,7 +33,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/Temperature/Temperature.ino b/examples/Temperature/Temperature.ino
@@ -33,7 +33,7 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/examples/Terminal/Terminal.ino b/examples/Terminal/Terminal.ino
@@ -37,8 +37,8 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231_debug.h>   // ErriezDS3231 debug library
-#include <SerialTerminal.h> // ErriezSerialTerminal library
+#include <ErriezDS3231_debug.h>
+#include <ErriezSerialTerminal.h>
 
 // Newline character '\r' or '\n'
 char newlineChar = '\n';

diff --git a/platformio/platformio_build.bat b/platformio/platformio_build.bat
@@ -10,19 +10,16 @@ rem git fetch
 rem git pull
 
 rem Build example(s)
-platformio lib install https://github.com/Erriez/ErriezDS3231.git
-platformio lib install https://github.com/Erriez/ErriezSerialTerminal.git
-platformio lib update
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/AgingOffset/AgingOffset.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/AlarmInterrupt/AlarmInterrupt.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/AlarmPolling/AlarmPolling.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/GettingStarted/GettingStarted.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/Minimum/Minimum.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/PrintDiagnostics/PrintDiagnostics.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/ReadTimeInterrupt/ReadTimeInterrupt.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/ReadTimePolled/ReadTimePolled.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/SetDateTime/SetDateTime.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/Temperature/Temperature.ino
-platformio ci --lib=".piolibdeps/Erriez DS3231 RTC" --lib=".piolibdeps/Erriez Serial Terminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/Terminal/Terminal.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/AgingOffset/AgingOffset.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/AlarmInterrupt/AlarmInterrupt.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/AlarmPolling/AlarmPolling.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/GettingStarted/GettingStarted.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/Minimum/Minimum.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/PrintDiagnostics/PrintDiagnostics.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/ReadTimeInterrupt/ReadTimeInterrupt.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/ReadTimePolled/ReadTimePolled.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/SetDateTime/SetDateTime.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/Temperature/Temperature.ino
+platformio ci --lib=".." --lib="..\..\ErriezSerialTerminal" --board uno --board micro --board d1_mini --board nanoatmega328 --board pro16MHzatmega328 --board pro8MHzatmega328 --board leonardo --board megaatmega2560 --board d1_mini --board nodemcuv2 ../examples/Terminal/Terminal.ino
 
-@pause
+@pause
diff --git a/platformio/src/main.cpp b/platformio/src/main.cpp
@@ -23,17 +23,16 @@
  */
 
 /*!
- * \file GettingStarted.ino
  * \brief DS3231 high accurate RTC getting started example for Arduino
  * \details
- *    Required library: https://github.com/Erriez/ErriezDS3231
- *    Connect the nINT/SQW pin to an Arduino interrupt pin
+ *    Connect the nINT/SQW pin to an Arduino interrupt pin.
+ *    Source: https://github.com/Erriez/ErriezDS3231
  */
 
 #include <Arduino.h>
 #include <Wire.h>
 
-#include <DS3231.h> // ErriezDS3231 library
+#include <ErriezDS3231.h>
 
 // Create DS3231 RTC object
 static DS3231 rtc;

diff --git a/src/DS3231.cpp → src/ErriezDS3231.cpp b/src/DS3231.cpp → src/ErriezDS3231.cpp
@@ -23,7 +23,7 @@
  */
 
 /*!
- * \file DS3231.cpp
+ * \file ErriezDS3231.cpp
  * \brief DS3231 high precision RTC library for Arduino
  * \details
  *      Source:         https://github.com/Erriez/ErriezDS3231
@@ -38,7 +38,7 @@
 
 #include <Wire.h>
 
-#include "DS3231.h"
+#include "ErriezDS3231.h"
 
 // -------------------------------------------------------------------------------------------------
 /*!

diff --git a/src/DS3231.h → src/ErriezDS3231.h b/src/DS3231.h → src/ErriezDS3231.h
@@ -23,15 +23,15 @@
  */
 
 /*!
- * \file DS3231.h
+ * \file ErriezDS3231.h
  * \brief DS3231 high precision RTC library for Arduino
  * \details
  *      Source:         https://github.com/Erriez/ErriezDS3231
  *      Documentation:  https://erriez.github.io/ErriezDS3231
  */
 
-#ifndef DS3231_H_
-#define DS3231_H_
+#ifndef ERRIEZ_DS3231_H_
+#define ERRIEZ_DS3231_H_
 
 #include <stdint.h>
 
@@ -215,4 +215,4 @@ class DS3231
     void writeBuffer(uint8_t reg, void *buffer, uint8_t len);
 };
 
-#endif // DS3231_H_
+#endif // ERRIEZ_DS3231_H_
diff --git a/src/DS3231_debug.cpp → src/ErriezDS3231_debug.cpp b/src/DS3231_debug.cpp → src/ErriezDS3231_debug.cpp
@@ -23,14 +23,14 @@
  */
 
 /*!
- * \file DS3231_debug.cpp
+ * \file ErriezDS3231_debug.cpp
  * \brief DS3231 high precision RTC debug library for Arduino
  * \details
  *      Source:         https://github.com/Erriez/ErriezDS3231
  *      Documentation:  https://erriez.github.io/ErriezDS3231
  */
 
-#include "DS3231_debug.h"
+#include "ErriezDS3231_debug.h"
 
 /*!
  * \brief Register names as string in flash.

diff --git a/src/DS3231_debug.h → src/ErriezDS3231_debug.h b/src/DS3231_debug.h → src/ErriezDS3231_debug.h
@@ -23,19 +23,19 @@
  */
 
 /*!
- * \file DS3231_debug.h
+ * \file ErriezDS3231_debug.h
  * \brief DS3231 high precision RTC debug library for Arduino
  * \details
  *      Source:         https://github.com/Erriez/ErriezDS3231
  *      Documentation:  https://erriez.github.io/ErriezDS3231
  */
 
-#ifndef DS3231_DEBUG_H_
-#define DS3231_DEBUG_H_
+#ifndef ERRIEZ_DS3231_DEBUG_H_
+#define ERRIEZ_DS3231_DEBUG_H_
 
 #include <Arduino.h>
 
-#include "DS3231.h"
+#include "ErriezDS3231.h"
 
 /*!
  * \brief DS3231 RTC debug class.
@@ -55,4 +55,4 @@ class DS3231Debug : public DS3231
     virtual void printDiagnostics(Stream *ser);
 };
 
-#endif // DS3231_DEBUG_H_
+#endif // ERRIEZ_DS3231_DEBUG_H_