bootsrap classes refactor

sblantipodi · sblantipodi · commit 6e5c77c3df2d · 2020-04-20T18:57:15.000+02:00
diff --git a/arduino_bootstrapper/core/BootstrapManager.cpp b/arduino_bootstrapper/core/BootstrapManager.cpp
@@ -1,3 +1,22 @@
+/*
+  BoostrapManager.cpp - Main file for bootstrapping arduino projects
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include "BootstrapManager.h"
 
 
diff --git a/arduino_bootstrapper/core/BootstrapManager.h b/arduino_bootstrapper/core/BootstrapManager.h
@@ -1,3 +1,22 @@
+/*
+  BoostrapManager.cpp - Main header for bootstrapping arduino projects
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #ifndef _DPSOFTWARE_BOOTSTRAP_MANAGER_H
 #define _DPSOFTWARE_BOOTSTRAP_MANAGER_H
 
diff --git a/arduino_bootstrapper/core/Helpers.cpp b/arduino_bootstrapper/core/Helpers.cpp
@@ -1,3 +1,22 @@
+/*
+  Helpers.cpp - Helper classes
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include "Helpers.h"
 
 
diff --git a/arduino_bootstrapper/core/Helpers.h b/arduino_bootstrapper/core/Helpers.h
@@ -1,3 +1,22 @@
+/*
+  Helpers.h - Helper classes
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #ifndef _DPSOFTWARE_HELPERS_UTILS_H
 #define _DPSOFTWARE_HELPERS_UTILS_H
 
diff --git a/arduino_bootstrapper/core/QueueManager.cpp b/arduino_bootstrapper/core/QueueManager.cpp
@@ -1,3 +1,22 @@
+/*
+  QueueManager.cpp - Managing MQTT queue
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include "QueueManager.h"
 
 WiFiClient espClient;
diff --git a/arduino_bootstrapper/core/QueueManager.h b/arduino_bootstrapper/core/QueueManager.h
@@ -1,3 +1,22 @@
+/*
+  QueueManager.h - Managing MQTT queue
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #ifndef _DPSOFTWARE_QUEUE_MANAGER_H
 #define _DPSOFTWARE_QUEUE_MANAGER_H
 
diff --git a/arduino_bootstrapper/core/WifiManager.cpp b/arduino_bootstrapper/core/WifiManager.cpp
@@ -1,3 +1,22 @@
+/*
+  WifiManager.cpp - Managing WiFi and OTA
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include "WifiManager.h"
 
 
diff --git a/arduino_bootstrapper/core/WifiManager.h b/arduino_bootstrapper/core/WifiManager.h
@@ -6,6 +6,25 @@
 #include <ESP8266mDNS.h>
 #include <WiFiUdp.h>
 #include <ArduinoOTA.h>
+/*
+  WifiManager.h - Managing Wifi and OTA
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include <SPI.h>
 #include <Wire.h>
 #include <Adafruit_SSD1306.h>
diff --git a/include/ChangeName.h b/include/ChangeName.h
@@ -1,3 +1,22 @@
+/*
+  ChangeName.h - Main header
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include <SPI.h>
 #include <Wire.h>
 #include <Adafruit_GFX.h>
diff --git a/include/Configuration.h b/include/Configuration.h
@@ -1,3 +1,22 @@
+/*
+  Configuration.h - Config header
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #ifndef _DPSOFTWARE_CONFIG_H
 #define _DPSOFTWARE_CONFIG_H
 
diff --git a/include/Secrets.h b/include/Secrets.h
@@ -1,3 +1,22 @@
+/*
+  Secrets.h - Store your secrets here
+  
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #ifndef _DPSOFTWARE_SECRETS_H
 #define _DPSOFTWARE_SECRETS_H
 
diff --git a/src/ChangeName.cpp b/src/ChangeName.cpp
@@ -1,11 +1,27 @@
 /*
- * Arduino Bootstrapper
- * DPsoftware (Davide Perini)
- * 
- * Utility classes for bootstrapping arduino projects with Wifi management, OTA upload management, memory management, MQTT and queue management.
- * 
- * MIT license
- */
+  ChangeName.cpp - Main Arduino File - Utility classes for bootstrapping arduino projects with Wifi management, 
+  OTA upload management, memory management, MQTT and queue management.
+
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
+#include "Configuration.h"
+
+// Initialize the display
+Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RESET); 
 #include "ChangeName.h"
 
 void setup() {
diff --git a/src/Configuration.cpp b/src/Configuration.cpp
@@ -1,3 +1,22 @@
+/*
+  ChangeName.cpp - Configuration impl
+
+  Copyright (C) 2020  Davide Perini
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy of 
+  this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+  copies of the Software, and to permit persons to whom the Software is 
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in 
+  all copies or substantial portions of the Software.
+  
+  You should have received a copy of the MIT License along with this program.  
+  If not, see <https://opensource.org/licenses/MIT/>.
+*/
+
 #include "Configuration.h"
 
 // Initialize the display
