diff --git a/.gitignore b/.gitignore index 89cc49c..bb00960 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .pio +.vscode/* .vscode/.browse.c_cpp.db* .vscode/c_cpp_properties.json .vscode/launch.json diff --git a/convert_sysincludes.py b/convert_sysincludes.py new file mode 100644 index 0000000..d2ad583 --- /dev/null +++ b/convert_sysincludes.py @@ -0,0 +1,17 @@ +from pathlib import Path +Import("env" ,"projenv") + +platform = env.PioPlatform() +FRAMEWORK_DIR = Path(platform.get_package_dir("framework-arduinoespressif32")) +framework_includes = list() +filtered_cpppath = list() +# apply these changes to current working env, the project env and the global env +for e in (env, projenv, DefaultEnvironment()): + for p in e["CPPPATH"]: + # is the current include path inside the framework directory? + if FRAMEWORK_DIR in Path(p).parents: + framework_includes.append(p) + else: + filtered_cpppath.append(p) + e.Replace(CPPPATH=filtered_cpppath) + e.Append(CCFLAGS=[("-isystem", p) for p in framework_includes]) \ No newline at end of file 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 new file mode 100644 index 0000000..3e41bd4 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,47 @@ +; 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 + +[platformio] +default_envs = esp32dev + +[common] +lib_deps_builtin = + Wire + BluetoothSerial +lib_deps_external = + https://git.gogacoder.com/gogacoder/GyverBME280.git @ ~1.5.0 + https://git.gogacoder.com/gogacoder/MPU6050.git @ ~1.0.0 + https://git.gogacoder.com/gogacoder/I2Cdev.git @ ~1.0.1 + https://github.com/GyverLibs/StringUtils @ 1.2.6 + https://github.com/GyverLibs/GSON.git @ 1.1.5 + https://github.com/tomstewart89/BasicLinearAlgebra.git @ 4.3 + https://github.com/GyverLibs/mString.git @ 1.7 + https://github.com/GyverLibs/GyverPID @ 3.3 + + +[env:esp32dev] +platform = espressif32 +board = esp32dev +framework = arduino +lib_deps = ${common.lib_deps_external} +monitor_speed = 115200 +board_build.partitions = huge_app.csv +build_src_flags = + -std=c++2a + -Wall + -Wextra + -Werror=all + -Wno-error=pedantic + -Wpedantic + -O2 +build_flags = -DCORE_DEBUG_LEVEL=4 +check_tool = pvs-studio +check_flags = pvs-studio: --analysis-mode=4 --exclude-path=.pio/libdeps --lic-file=~/.config/PVS-Studio/PVS-Studio.lic +extra_scripts = post:convert_sysincludes.py \ No newline at end of file diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ 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