Merge pull request #343 from lucaoliano/pio

Refactor DTS to follow the PlatformIO standard structure
technyon · May 11, 2024 · a6cb6c1 · a6cb6c1
2 parents 2fb5304 + 93ebf00
commit a6cb6c1
Show file tree

Hide file tree

Showing 54 changed files with 132 additions and 45 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,6 @@ build
 cmake-build-debug
 cmake-build-release
 cmake-build-release-s3
+.pio
+.vscode
+.project
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -42,34 +42,34 @@ include_directories(${PROJECT_NAME}
 )
 
 set(SRCFILES
-        Config.h
-        NukiDeviceId.cpp
-        CharBuffer.cpp
-        Network.cpp
-        MqttReceiver.h
-        NetworkLock.cpp
-        NetworkOpener.cpp
-        networkDevices/NetworkDevice.h
-        networkDevices/NetworkDevice.cpp
-        networkDevices/WifiDevice.cpp
-        networkDevices/W5500Device.cpp
-        networkDevices/EthLan8720Device.cpp
-        networkDevices/ClientSyncW5500.cpp
-        networkDevices/espMqttClientW5500.cpp
-        networkDevices/IPConfiguration.cpp
-        LockActionResult.h
-        QueryCommand.h
-        NukiWrapper.cpp
-        NukiOpenerWrapper.cpp
-        MqttTopics.h
-        Ota.cpp
-        WebCfgServerConstants.h
-        WebCfgServer.cpp
-        PresenceDetection.cpp
-        PreferencesKeys.h
-        Gpio.cpp
-        Logger.cpp
-        RestartReason.h
+        src/Config.h
+        src/NukiDeviceId.cpp
+        src/CharBuffer.cpp
+        src/Network.cpp
+        src/MqttReceiver.h
+        src/NetworkLock.cpp
+        src/NetworkOpener.cpp
+        src/networkDevices/NetworkDevice.h
+        src/networkDevices/NetworkDevice.cpp
+        src/networkDevices/WifiDevice.cpp
+        src/networkDevices/W5500Device.cpp
+        src/networkDevices/EthLan8720Device.cpp
+        src/networkDevices/ClientSyncW5500.cpp
+        src/networkDevices/espMqttClientW5500.cpp
+        src/networkDevices/IPConfiguration.cpp
+        src/LockActionResult.h
+        src/QueryCommand.h
+        src/NukiWrapper.cpp
+        src/NukiOpenerWrapper.cpp
+        src/MqttTopics.h
+        src/Ota.cpp
+        src/WebCfgServerConstants.h
+        src/WebCfgServer.cpp
+        src/PresenceDetection.cpp
+        src/PreferencesKeys.h
+        src/Gpio.cpp
+        src/Logger.cpp
+        src/RestartReason.h
 #        include/RTOS.h
         lib/WiFiManager/WiFiManager.cpp
         lib/WiFiManager/wm_consts_en.h
@@ -114,7 +114,7 @@ file(GLOB_RECURSE SRCFILESREC
 )
 
 add_executable(${PROJECT_NAME}
-        main.cpp
+        src/main.cpp
         ${SRCFILES}
         ${SRCFILESREC}
         )

diff --git a/Docker/Dockerfile b/Docker/Dockerfile
@@ -14,14 +14,10 @@ RUN cd ~/arduino* && \
 
 RUN git clone --recurse-submodules https://github.com/technyon/Arduino-CMake-Toolchain.git ~/Arduino-CMake-Toolchain
 
-COPY icon /usr/src/nuki_hub/icon
-COPY include /usr/src/nuki_hub/include
+COPY src /usr/src/nuki_hub/src
 COPY lib /usr/src/nuki_hub/lib
-COPY networkDevices /usr/src/nuki_hub/networkDevices
+COPY include /usr/src/nuki_hub/include
 COPY CMakeLists.txt /usr/src/nuki_hub
-COPY index.html /usr/src/nuki_hub
-COPY *.h /usr/src/nuki_hub/
-COPY *.cpp /usr/src/nuki_hub/
 
 RUN mkdir -p /usr/src/nuki_hub/build
 

diff --git a/include/README b/include/README
@@ -0,0 +1,39 @@
+
+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 usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+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/lib/README b/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 executable file.
+
+The source code of each library should be placed in an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, 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
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html
diff --git a/platformio.ini b/platformio.ini
@@ -10,7 +10,6 @@
 
 [platformio]
 default_envs = esp32dev
-src_dir = .
 
 [env]
 platform = espressif32
@@ -34,18 +33,11 @@ build_flags =
 ;	-DDEBUG_NUKI_HEX_DATA
 ;	-DDEBUG_NUKI_READABLE_DATA
 lib_deps = 
-	https://github.com/technyon/nuki_ble.git
-	bertmelis/espMqttClient@1.6.0
-	bblanchon/ArduinoJson@7.0.4
+
 monitor_speed = 115200
 monitor_filters = 
 	esp32_exception_decoder
 	time
-build_src_filter = 
-	-<*>
-	+<*.cpp>
-	+<*.h>
-	+<networkDevices>
 
 [env:esp32dev]
 board = esp32dev

diff --git a/CharBuffer.cpp → src/CharBuffer.cpp b/CharBuffer.cpp → src/CharBuffer.cpp
diff --git a/CharBuffer.h → src/CharBuffer.h b/CharBuffer.h → src/CharBuffer.h
diff --git a/Config.h → src/Config.h b/Config.h → src/Config.h
diff --git a/Gpio.cpp → src/Gpio.cpp b/Gpio.cpp → src/Gpio.cpp
@@ -5,7 +5,7 @@
 #include "Logger.h"
 #include "PreferencesKeys.h"
 #include "RestartReason.h"
-#include "lib/gpio2go/src/Gpio2Go.h"
+#include "../lib/gpio2go/src/Gpio2Go.h"
 
 Gpio* Gpio::_inst = nullptr;
 unsigned long Gpio::_debounceTs = 0;

diff --git a/Gpio.h → src/Gpio.h b/Gpio.h → src/Gpio.h
diff --git a/LockActionResult.h → src/LockActionResult.h b/LockActionResult.h → src/LockActionResult.h
diff --git a/Logger.cpp → src/Logger.cpp b/Logger.cpp → src/Logger.cpp
diff --git a/Logger.h → src/Logger.h b/Logger.h → src/Logger.h
diff --git a/MqttReceiver.h → src/MqttReceiver.h b/MqttReceiver.h → src/MqttReceiver.h
diff --git a/MqttTopics.h → src/MqttTopics.h b/MqttTopics.h → src/MqttTopics.h
diff --git a/Network.cpp → src/Network.cpp b/Network.cpp → src/Network.cpp
diff --git a/Network.h → src/Network.h b/Network.h → src/Network.h
diff --git a/NetworkLock.cpp → src/NetworkLock.cpp b/NetworkLock.cpp → src/NetworkLock.cpp
diff --git a/NetworkLock.h → src/NetworkLock.h b/NetworkLock.h → src/NetworkLock.h
diff --git a/NetworkOpener.cpp → src/NetworkOpener.cpp b/NetworkOpener.cpp → src/NetworkOpener.cpp
diff --git a/NetworkOpener.h → src/NetworkOpener.h b/NetworkOpener.h → src/NetworkOpener.h
diff --git a/NukiDeviceId.cpp → src/NukiDeviceId.cpp b/NukiDeviceId.cpp → src/NukiDeviceId.cpp
diff --git a/NukiDeviceId.h → src/NukiDeviceId.h b/NukiDeviceId.h → src/NukiDeviceId.h
diff --git a/NukiOpenerWrapper.cpp → src/NukiOpenerWrapper.cpp b/NukiOpenerWrapper.cpp → src/NukiOpenerWrapper.cpp
diff --git a/NukiOpenerWrapper.h → src/NukiOpenerWrapper.h b/NukiOpenerWrapper.h → src/NukiOpenerWrapper.h
diff --git a/NukiWrapper.cpp → src/NukiWrapper.cpp b/NukiWrapper.cpp → src/NukiWrapper.cpp
diff --git a/NukiWrapper.h → src/NukiWrapper.h b/NukiWrapper.h → src/NukiWrapper.h
diff --git a/Ota.cpp → src/Ota.cpp b/Ota.cpp → src/Ota.cpp
diff --git a/Ota.h → src/Ota.h b/Ota.h → src/Ota.h
diff --git a/PreferencesKeys.h → src/PreferencesKeys.h b/PreferencesKeys.h → src/PreferencesKeys.h
diff --git a/PresenceDetection.cpp → src/PresenceDetection.cpp b/PresenceDetection.cpp → src/PresenceDetection.cpp
diff --git a/PresenceDetection.h → src/PresenceDetection.h b/PresenceDetection.h → src/PresenceDetection.h
diff --git a/QueryCommand.h → src/QueryCommand.h b/QueryCommand.h → src/QueryCommand.h
diff --git a/RestartReason.h → src/RestartReason.h b/RestartReason.h → src/RestartReason.h
diff --git a/WebCfgServer.cpp → src/WebCfgServer.cpp b/WebCfgServer.cpp → src/WebCfgServer.cpp
diff --git a/WebCfgServer.h → src/WebCfgServer.h b/WebCfgServer.h → src/WebCfgServer.h
diff --git a/WebCfgServerConstants.h → src/WebCfgServerConstants.h b/WebCfgServerConstants.h → src/WebCfgServerConstants.h
diff --git a/main.cpp → src/main.cpp b/main.cpp → src/main.cpp
diff --git a/networkDevices/ClientSyncW5500.cpp → src/networkDevices/ClientSyncW5500.cpp b/networkDevices/ClientSyncW5500.cpp → src/networkDevices/ClientSyncW5500.cpp
diff --git a/networkDevices/ClientSyncW5500.h → src/networkDevices/ClientSyncW5500.h b/networkDevices/ClientSyncW5500.h → src/networkDevices/ClientSyncW5500.h
diff --git a/networkDevices/EthLan8720Device.cpp → src/networkDevices/EthLan8720Device.cpp b/networkDevices/EthLan8720Device.cpp → src/networkDevices/EthLan8720Device.cpp
diff --git a/networkDevices/EthLan8720Device.h → src/networkDevices/EthLan8720Device.h b/networkDevices/EthLan8720Device.h → src/networkDevices/EthLan8720Device.h
diff --git a/networkDevices/IPConfiguration.cpp → src/networkDevices/IPConfiguration.cpp b/networkDevices/IPConfiguration.cpp → src/networkDevices/IPConfiguration.cpp
diff --git a/networkDevices/IPConfiguration.h → src/networkDevices/IPConfiguration.h b/networkDevices/IPConfiguration.h → src/networkDevices/IPConfiguration.h
diff --git a/networkDevices/NetworkDevice.cpp → src/networkDevices/NetworkDevice.cpp b/networkDevices/NetworkDevice.cpp → src/networkDevices/NetworkDevice.cpp
diff --git a/networkDevices/NetworkDevice.h → src/networkDevices/NetworkDevice.h b/networkDevices/NetworkDevice.h → src/networkDevices/NetworkDevice.h
diff --git a/networkDevices/W5500Device.cpp → src/networkDevices/W5500Device.cpp b/networkDevices/W5500Device.cpp → src/networkDevices/W5500Device.cpp
diff --git a/networkDevices/W5500Device.h → src/networkDevices/W5500Device.h b/networkDevices/W5500Device.h → src/networkDevices/W5500Device.h
diff --git a/networkDevices/WifiDevice.cpp → src/networkDevices/WifiDevice.cpp b/networkDevices/WifiDevice.cpp → src/networkDevices/WifiDevice.cpp
diff --git a/networkDevices/WifiDevice.h → src/networkDevices/WifiDevice.h b/networkDevices/WifiDevice.h → src/networkDevices/WifiDevice.h
diff --git a/networkDevices/espMqttClientW5500.cpp → src/networkDevices/espMqttClientW5500.cpp b/networkDevices/espMqttClientW5500.cpp → src/networkDevices/espMqttClientW5500.cpp
diff --git a/networkDevices/espMqttClientW5500.h → src/networkDevices/espMqttClientW5500.h b/networkDevices/espMqttClientW5500.h → src/networkDevices/espMqttClientW5500.h
diff --git a/test/README b/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