From 79ece3fcaa9ef68500392f12d5ebacc20e41c2f2 Mon Sep 17 00:00:00 2001
From: Jonas Niesner <jonas.niesner@gmail.com>
Date: Thu, 13 Mar 2025 17:57:13 +0100
Subject: [PATCH] Add ESP firmware

---
 ESP_firmware/include/README | 37 +++++++++++++++++++++++++++++
 ESP_firmware/lib/README     | 46 +++++++++++++++++++++++++++++++++++++
 ESP_firmware/platformio.ini |  4 ++++
 ESP_firmware/src/main.cpp   | 12 ++++++++++
 ESP_firmware/test/README    | 11 +++++++++
 5 files changed, 110 insertions(+)
 create mode 100644 ESP_firmware/include/README
 create mode 100644 ESP_firmware/lib/README
 create mode 100644 ESP_firmware/platformio.ini
 create mode 100644 ESP_firmware/src/main.cpp
 create mode 100644 ESP_firmware/test/README

diff --git a/ESP_firmware/include/README b/ESP_firmware/include/README
new file mode 100644
index 0000000..49819c0
--- /dev/null
+++ b/ESP_firmware/include/README
@@ -0,0 +1,37 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the convention is to give header files names that end with `.h'.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
diff --git a/ESP_firmware/lib/README b/ESP_firmware/lib/README
new file mode 100644
index 0000000..9379397
--- /dev/null
+++ b/ESP_firmware/lib/README
@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into the executable file.
+
+The source code of each library should be placed in a separate directory
+("lib/your_library_name/[Code]").
+
+For example, see the structure of the following example libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+Example contents of `src/main.c` using Foo and Bar:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+The PlatformIO Library Dependency Finder will find automatically dependent
+libraries by scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html
diff --git a/ESP_firmware/platformio.ini b/ESP_firmware/platformio.ini
new file mode 100644
index 0000000..968d14f
--- /dev/null
+++ b/ESP_firmware/platformio.ini
@@ -0,0 +1,4 @@
+[env:esp_hgd6]
+platform = espressif8266
+board = esp07
+framework = arduino
diff --git a/ESP_firmware/src/main.cpp b/ESP_firmware/src/main.cpp
new file mode 100644
index 0000000..c3644f0
--- /dev/null
+++ b/ESP_firmware/src/main.cpp
@@ -0,0 +1,12 @@
+#include <Arduino.h>
+
+void setup() {
+  pinMode(LED_BUILTIN, OUTPUT);
+}
+
+void loop() {
+  digitalWrite(LED_BUILTIN, HIGH);
+  delay(1000);
+  digitalWrite(LED_BUILTIN, LOW);
+  delay(1000);
+}
\ No newline at end of file
diff --git a/ESP_firmware/test/README b/ESP_firmware/test/README
new file mode 100644
index 0000000..9b1e87b
--- /dev/null
+++ b/ESP_firmware/test/README
@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Test Runner and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html