From 5ee36054cfb148a34d2de801e337ec3b067c6cdd Mon Sep 17 00:00:00 2001 From: Nicu Hodos Date: Tue, 3 Nov 2020 08:29:03 +0100 Subject: [PATCH] add all platformio files --- .gitignore | 5 ++++ include/README | 39 +++++++++++++++++++++++++ lib/README | 46 ++++++++++++++++++++++++++++++ platformio.ini | 4 ++- esp_clock.ino => src/esp_clock.cpp | 0 README => test/README | 0 6 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 include/README create mode 100644 lib/README rename esp_clock.ino => src/esp_clock.cpp (100%) rename README => test/README (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ 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 new file mode 100644 index 0000000..6debab1 --- /dev/null +++ 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 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/platformio.ini b/platformio.ini index a14e1cb..cf9ef84 100644 --- a/platformio.ini +++ b/platformio.ini @@ -16,5 +16,7 @@ lib_deps = arduino-libraries/NTPClient@^3.1.0 adafruit/Adafruit LED Backpack Library@^1.1.8 adafruit/Adafruit BusIO@^1.6.0 -;upload_port = 192.168.178.62 + jchristensen/Timezone@^1.2.4 +;upload_port = 192.168.5.191 +upload_port = /dev/ttyUSB0 ;upload_protocol = espota diff --git a/esp_clock.ino b/src/esp_clock.cpp similarity index 100% rename from esp_clock.ino rename to src/esp_clock.cpp diff --git a/README b/test/README similarity index 100% rename from README rename to test/README