From 0d24e1a82d58c0ecc067a5e22d00c7076652ef34 Mon Sep 17 00:00:00 2001 From: Nicu Hodos Date: Wed, 4 Nov 2020 22:12:38 +0100 Subject: [PATCH] migrate gateway to PlatformIO --- gateway/.gitignore | 5 +++ gateway/include/README | 39 ++++++++++++++++++++ gateway/lib/README | 46 ++++++++++++++++++++++++ gateway/platformio.ini | 19 ++++++++++ gateway/{gateway.ino => src/gateway.cpp} | 6 +++- gateway/test/README | 11 ++++++ 6 files changed, 125 insertions(+), 1 deletion(-) create mode 100644 gateway/.gitignore create mode 100644 gateway/include/README create mode 100644 gateway/lib/README create mode 100644 gateway/platformio.ini rename gateway/{gateway.ino => src/gateway.cpp} (95%) create mode 100644 gateway/test/README diff --git a/gateway/.gitignore b/gateway/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/gateway/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/gateway/include/README b/gateway/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/gateway/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/gateway/lib/README b/gateway/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/gateway/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/gateway/platformio.ini b/gateway/platformio.ini new file mode 100644 index 0000000..5b594f5 --- /dev/null +++ b/gateway/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:pro16MHzatmega328] +platform = atmelavr +board = pro16MHzatmega328 +framework = arduino +lib_deps = + sui77/rc-switch@^2.6.3 + bblanchon/ArduinoJson@6.16.1 + adafruit/Adafruit Unified Sensor@^1.1.4 + adafruit/DHT sensor library@1.3.10 diff --git a/gateway/gateway.ino b/gateway/src/gateway.cpp similarity index 95% rename from gateway/gateway.ino rename to gateway/src/gateway.cpp index 5cea8a8..f0bdb6d 100644 --- a/gateway/gateway.ino +++ b/gateway/src/gateway.cpp @@ -1,4 +1,4 @@ -#include "Arduino.h" +#include #include #include #include @@ -17,6 +17,10 @@ unsigned long lastReadTime = -READ_INTERVAL(10); RCSwitch mySwitch = RCSwitch(); DHT dht = DHT(DHT11_PIN, DHT11); +void readRcSwitch(JsonDocument& jsonDoc); +void readCommand(); +void readDht(JsonDocument& jsonDoc); + void setup() { pinMode(LED_BUILTIN, OUTPUT); pinMode(RESET_PIN, INPUT_PULLUP); diff --git a/gateway/test/README b/gateway/test/README new file mode 100644 index 0000000..b94d089 --- /dev/null +++ b/gateway/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