From fbd800aae388cc39022727a75a088909ec183bae Mon Sep 17 00:00:00 2001 From: Jeroen Stroeve Date: Mon, 12 Aug 2024 20:46:31 +0200 Subject: [PATCH] Change to PlatformIO structure --- bitlair_doorduino/.gitignore | 5 ++ bitlair_doorduino/.vscode/extensions.json | 10 ++++ bitlair_doorduino/include/README | 39 ++++++++++++++++ bitlair_doorduino/lib/README | 46 +++++++++++++++++++ bitlair_doorduino/platformio.ini | 19 ++++++++ bitlair_doorduino/{ => src}/Entropy.cpp | 0 bitlair_doorduino/{ => src}/Entropy.h | 0 bitlair_doorduino/{ => src}/OneWire.cpp | 0 bitlair_doorduino/{ => src}/OneWire.h | 0 bitlair_doorduino/{ => src}/ds1961.cpp | 0 bitlair_doorduino/{ => src}/ds1961.h | 0 bitlair_doorduino/{ => src}/klemmenstrook.txt | 0 .../{bitlair_doorduino.ino => src/main.cpp} | 0 bitlair_doorduino/{ => src}/sha1.cpp | 0 bitlair_doorduino/{ => src}/sha1.h | 0 bitlair_doorduino/test/README | 11 +++++ 16 files changed, 130 insertions(+) create mode 100644 bitlair_doorduino/.gitignore create mode 100644 bitlair_doorduino/.vscode/extensions.json create mode 100644 bitlair_doorduino/include/README create mode 100644 bitlair_doorduino/lib/README create mode 100644 bitlair_doorduino/platformio.ini rename bitlair_doorduino/{ => src}/Entropy.cpp (100%) rename bitlair_doorduino/{ => src}/Entropy.h (100%) rename bitlair_doorduino/{ => src}/OneWire.cpp (100%) rename bitlair_doorduino/{ => src}/OneWire.h (100%) rename bitlair_doorduino/{ => src}/ds1961.cpp (100%) rename bitlair_doorduino/{ => src}/ds1961.h (100%) rename bitlair_doorduino/{ => src}/klemmenstrook.txt (100%) rename bitlair_doorduino/{bitlair_doorduino.ino => src/main.cpp} (100%) rename bitlair_doorduino/{ => src}/sha1.cpp (100%) rename bitlair_doorduino/{ => src}/sha1.h (100%) create mode 100644 bitlair_doorduino/test/README diff --git a/bitlair_doorduino/.gitignore b/bitlair_doorduino/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/bitlair_doorduino/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/bitlair_doorduino/.vscode/extensions.json b/bitlair_doorduino/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/bitlair_doorduino/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/bitlair_doorduino/include/README b/bitlair_doorduino/include/README new file mode 100644 index 0000000..45496b1 --- /dev/null +++ b/bitlair_doorduino/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/bitlair_doorduino/lib/README b/bitlair_doorduino/lib/README new file mode 100644 index 0000000..8c9c29c --- /dev/null +++ b/bitlair_doorduino/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 a 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 +#include + +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/bitlair_doorduino/platformio.ini b/bitlair_doorduino/platformio.ini new file mode 100644 index 0000000..e5d0646 --- /dev/null +++ b/bitlair_doorduino/platformio.ini @@ -0,0 +1,19 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:nanoatmega328] +platform = atmelavr +board = nanoatmega328new +framework = arduino + +lib_deps = + laurb9/StepperDriver@^1.3.1 + +monitor_speed = 115200 diff --git a/bitlair_doorduino/Entropy.cpp b/bitlair_doorduino/src/Entropy.cpp similarity index 100% rename from bitlair_doorduino/Entropy.cpp rename to bitlair_doorduino/src/Entropy.cpp diff --git a/bitlair_doorduino/Entropy.h b/bitlair_doorduino/src/Entropy.h similarity index 100% rename from bitlair_doorduino/Entropy.h rename to bitlair_doorduino/src/Entropy.h diff --git a/bitlair_doorduino/OneWire.cpp b/bitlair_doorduino/src/OneWire.cpp similarity index 100% rename from bitlair_doorduino/OneWire.cpp rename to bitlair_doorduino/src/OneWire.cpp diff --git a/bitlair_doorduino/OneWire.h b/bitlair_doorduino/src/OneWire.h similarity index 100% rename from bitlair_doorduino/OneWire.h rename to bitlair_doorduino/src/OneWire.h diff --git a/bitlair_doorduino/ds1961.cpp b/bitlair_doorduino/src/ds1961.cpp similarity index 100% rename from bitlair_doorduino/ds1961.cpp rename to bitlair_doorduino/src/ds1961.cpp diff --git a/bitlair_doorduino/ds1961.h b/bitlair_doorduino/src/ds1961.h similarity index 100% rename from bitlair_doorduino/ds1961.h rename to bitlair_doorduino/src/ds1961.h diff --git a/bitlair_doorduino/klemmenstrook.txt b/bitlair_doorduino/src/klemmenstrook.txt similarity index 100% rename from bitlair_doorduino/klemmenstrook.txt rename to bitlair_doorduino/src/klemmenstrook.txt diff --git a/bitlair_doorduino/bitlair_doorduino.ino b/bitlair_doorduino/src/main.cpp similarity index 100% rename from bitlair_doorduino/bitlair_doorduino.ino rename to bitlair_doorduino/src/main.cpp diff --git a/bitlair_doorduino/sha1.cpp b/bitlair_doorduino/src/sha1.cpp similarity index 100% rename from bitlair_doorduino/sha1.cpp rename to bitlair_doorduino/src/sha1.cpp diff --git a/bitlair_doorduino/sha1.h b/bitlair_doorduino/src/sha1.h similarity index 100% rename from bitlair_doorduino/sha1.h rename to bitlair_doorduino/src/sha1.h diff --git a/bitlair_doorduino/test/README b/bitlair_doorduino/test/README new file mode 100644 index 0000000..e7d1588 --- /dev/null +++ b/bitlair_doorduino/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Unit Testing 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/page/plus/unit-testing.html