From a01b3b0f982cee6c3e1b030b4696779938bedd67 Mon Sep 17 00:00:00 2001 From: Clement Date: Sat, 24 Jun 2023 17:09:33 +0200 Subject: [PATCH] feat: template --- IOT/.clang-tidy | 7 +++ IOT/.editorconfig | 39 +++++++++++++++ IOT/.gitignore | 12 +++++ IOT/.vscode/extensions.json | 10 ++++ IOT/config.cppcheck | 19 ++++++++ IOT/config.ini | 19 ++++++++ IOT/docs/README.md | 18 +++++++ IOT/envs.ini | 15 ++++++ IOT/include/Program.h | 19 ++++++++ IOT/include/README | 39 +++++++++++++++ IOT/lib/README | 46 ++++++++++++++++++ IOT/platformio.ini | 73 +++++++++++++++++++++++++++++ IOT/scripts/get_additionnal_envs.py | 41 ++++++++++++++++ IOT/secrets.ini.example | 6 +++ IOT/src/Program.cpp | 10 ++++ IOT/src/main.cpp | 11 +++++ IOT/test/README | 11 +++++ 17 files changed, 395 insertions(+) create mode 100644 IOT/.clang-tidy create mode 100644 IOT/.editorconfig create mode 100644 IOT/.gitignore create mode 100644 IOT/.vscode/extensions.json create mode 100644 IOT/config.cppcheck create mode 100644 IOT/config.ini create mode 100644 IOT/docs/README.md create mode 100644 IOT/envs.ini create mode 100644 IOT/include/Program.h create mode 100644 IOT/include/README create mode 100644 IOT/lib/README create mode 100644 IOT/platformio.ini create mode 100644 IOT/scripts/get_additionnal_envs.py create mode 100644 IOT/secrets.ini.example create mode 100644 IOT/src/Program.cpp create mode 100644 IOT/src/main.cpp create mode 100644 IOT/test/README diff --git a/IOT/.clang-tidy b/IOT/.clang-tidy new file mode 100644 index 0000000..790367c --- /dev/null +++ b/IOT/.clang-tidy @@ -0,0 +1,7 @@ +# Clangtidy configuration file (not used until PIO 6) +--- +Checks: 'abseil-*,boost-*,bugprone-*,cert-*,cppcoreguidelines-*,clang-analyzer-*,google-*,hicpp-*,modernize-*,performance-*,portability-*,readability-*,-cppcoreguidelines-avoid-non-const-global-variables,-cppcoreguidelines-owning-memory,-modernize-use-trailing-return-type,-cppcoreguidelines-init-variables' +WarningsAsErrors: false +HeaderFilterRegex: '' +AnalyzeTemporaryDtors: false +FormatStyle: google diff --git a/IOT/.editorconfig b/IOT/.editorconfig new file mode 100644 index 0000000..fdfd862 --- /dev/null +++ b/IOT/.editorconfig @@ -0,0 +1,39 @@ +root = true + +# Base Configuration +[*] +indent_style = tab +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +max_line_length = 120 +end_of_line = lf + +# Yaml Standard +[*.{yaml,yml}] +indent_style = space +indent_size = 2 + +# Markdown Standards +[*.md] +indent_style = space +indent_size = 2 +trim_trailing_whitespace = false + +# Java, Kotlin, Gradle, XML Standards +[*.{java,kt,kts,gradle,xml,pro}] +indent_style = space + + +# C++ Files +[*.{cpp,h,ino}] +indent_style = space + +# PHP files +[*.php] +indent_style = space + +# INI Files +[*.ini] +indent_style = space diff --git a/IOT/.gitignore b/IOT/.gitignore new file mode 100644 index 0000000..53072ca --- /dev/null +++ b/IOT/.gitignore @@ -0,0 +1,12 @@ +# macOS +.DS_Store + +# Platformio specifics +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch + +# Aptatio/Platformio specifics +secrets.ini diff --git a/IOT/.vscode/extensions.json b/IOT/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/IOT/.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/IOT/config.cppcheck b/IOT/config.cppcheck new file mode 100644 index 0000000..77fd7d8 --- /dev/null +++ b/IOT/config.cppcheck @@ -0,0 +1,19 @@ + + + + .cppcheck-build + Unspecified + false + true + false + 10 + + + + + noCopyConstructor + noExplicitConstructor + unusedFunction + noOperatorEq + + diff --git a/IOT/config.ini b/IOT/config.ini new file mode 100644 index 0000000..11e4023 --- /dev/null +++ b/IOT/config.ini @@ -0,0 +1,19 @@ +; Project configuration file + +[config] +; Hardware Serial baud rate +; Also available in the code as `MONITOR_SPEED` +monitor_speed = 115200 + +; Software Config +; note: additionnal flags are added by Platform.io (see total amount in `.vscode/c_cpp_properties.json` in the `defines` section) +; notworthy ones: +; __PLATFORMIO_BUILD_DEBUG__ = debug mode +build_flags = +; DO NOT TOUCH --- START + -D MONITOR_SPEED=${config.monitor_speed} +; DO NOT TOUCH --- END + + -D EXAMPLE_NUMBER=69 + + -D EXAMPLE_STRING=\"Pouet\" diff --git a/IOT/docs/README.md b/IOT/docs/README.md new file mode 100644 index 0000000..9ff0271 --- /dev/null +++ b/IOT/docs/README.md @@ -0,0 +1,18 @@ +# Docs + +Documentation Technique du projet + +## fichiers .puml + +Les fichiers en .puml sont des fichiers UMLs sous forme de code + +Afin d'en avoir le résultat graphique : + +1. Ouvrez un navigateur +2. lancer le lien suivant [https://www.plantuml.com/plantuml/uml/](https://www.plantuml.com/plantuml/uml/) +3. Copiez/Collez le contenu du fichier .puml dans le voite de texte +4. Cliquez sur `Submit` + +ou si vous utilisez `VSCode`: +1. installez l'extensions [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) _jebbs.plantuml_ +2. `ALT+D` lorsque vous êtes dans un fichier .puml diff --git a/IOT/envs.ini b/IOT/envs.ini new file mode 100644 index 0000000..9df4a04 --- /dev/null +++ b/IOT/envs.ini @@ -0,0 +1,15 @@ +; Add additionnal environments in this file + +; Default production environment +[env:prod] + +; Debug environemnt +[env:debug] +build_type = debug + + +; Example additionnal env +; [env:example] +; ; note: keep the `${env.build_flags}` to includes others build flags +; build_flags = ${env.build_flags} +; -D POUET diff --git a/IOT/include/Program.h b/IOT/include/Program.h new file mode 100644 index 0000000..66e4a79 --- /dev/null +++ b/IOT/include/Program.h @@ -0,0 +1,19 @@ +#ifndef PROGRAM_H +#define PROGRAM_H + +#include "Arduino.h" + +class Program { +public: + /** + * Program startup + */ + Program(); + + /** + * Program main loop + */ + void loop(); +}; + +#endif diff --git a/IOT/include/README b/IOT/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/IOT/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/IOT/lib/README b/IOT/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/IOT/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/IOT/platformio.ini b/IOT/platformio.ini new file mode 100644 index 0000000..329b7c7 --- /dev/null +++ b/IOT/platformio.ini @@ -0,0 +1,73 @@ +; PlatformIO Project Configuration File + +; WARNING: Items containing version number MUST be the version NOT A RANGE + +; Additionnal files +; `secrets.ini`: Secret Build Flags that will be ignored in git (content: `[secrets]\nbuild_flags = `) +; `envs.ini`: Build environments +; `config.ini`: Global Configuration File + +; Defaults +[secrets] +build_flags = + +[platformio] +default_envs = debug +extra_configs = + secrets.ini + config.ini + envs.ini + +; Cache folder +build_cache_dir = ./.pio/cache + +[env] +; build Envs +build_flags = ${config.build_flags} ${secrets.build_flags} + +; Add scripts for more functionnalities +; see individual scripts for more informations +extra_scripts = pre:scripts/get_additionnal_envs.py + +; Device Settings (make sure to fix versions where possible!) +platform = espressif8266 +board = d1_mini +framework = arduino + +; Monitoring settings +monitor_speed = ${config.monitor_speed} + +; note: make sure to rebuild after changing it (log2file add a .log file containing the monitor logs) +monitor_filters = esp32_exception_decoder, time, send_on_enter, default ;, log2file + +; Ask the monitor to echo the content written +monitor_echo = yes + +; upload settings +; upload_port = COM1 + +upload_speed = 921600 + +; librairies (make sure to fix versions where possible!) +lib_deps = +; example: +; erropix/ESP32 AnalogWrite@0.2 + +; Checker settings +check_tool = clangtidy, cppcheck + +; Filters for checkers +check_src_filters = + + + + + + + + + -<.pio/> + +; Ask pio to not scan `./.pio` files +check_skip_packages = yes + +; use config files for clangtidy and cppcheck +check_flags = + clangtidy: --config-file=.clang-tidy + cppcheck: --project=config.cppcheck --inline-suppr -i=".pio" diff --git a/IOT/scripts/get_additionnal_envs.py b/IOT/scripts/get_additionnal_envs.py new file mode 100644 index 0000000..0a349fd --- /dev/null +++ b/IOT/scripts/get_additionnal_envs.py @@ -0,0 +1,41 @@ +""" + Add additionnal ENVs to the program + + GIT_COMMIT: the git commit ID + GIT_BRANCH: the current git branch + GIT_TAG: the current git tag or "dev" + + _note: to get the full list of env at build time run: `pio run -t envdump > pouet.log` and look at "BUILD_FLAGS_ +""" + +import subprocess + +Import("env") + +def run_command(command): + """ + run a command on the system + """ + return subprocess.run(command, stdout=subprocess.PIPE, text=True).stdout + +def get_additionnal_envs(): + """ + get the git commit/branch/tag of the project and return them + """ + commit = run_command(["git", "rev-parse", "HEAD"])[:7] + branch = run_command(["git", "rev-parse", "--abbrev-ref", "HEAD"]) + tag = run_command(["git", "tag", "-l", "--points-at", "HEAD"]) + + items = [ + f"-D GIT_COMMIT=\\\"{commit}\\\"", + f"-D GIT_BRANCH=\\\"{branch.strip()}\\\"" + ] + if tag != "": + items.append(f"-D GIT_TAG=\\\"{tag.strip()}\\\"") + else: + items.append("-D GIT_TAG=\\\"dev\\\"") + return items + +env.Append( + BUILD_FLAGS=get_additionnal_envs() +) diff --git a/IOT/secrets.ini.example b/IOT/secrets.ini.example new file mode 100644 index 0000000..90b9782 --- /dev/null +++ b/IOT/secrets.ini.example @@ -0,0 +1,6 @@ +; Add secrets token/logins/etc `secrets.ini` +; Add the sames values as blank in `secrets.ini.example +; To be able to reproduce it + +[secrets] +build_flags = diff --git a/IOT/src/Program.cpp b/IOT/src/Program.cpp new file mode 100644 index 0000000..e412959 --- /dev/null +++ b/IOT/src/Program.cpp @@ -0,0 +1,10 @@ +#include "Program.h" + +Program::Program() { + // Startup + Serial.begin(MONITOR_SPEED); +} + +void Program::loop() { + // Loop +} diff --git a/IOT/src/main.cpp b/IOT/src/main.cpp new file mode 100644 index 0000000..74bf5a7 --- /dev/null +++ b/IOT/src/main.cpp @@ -0,0 +1,11 @@ +#include "Program.h" + +Program* program; + +void setup() { + program = new Program(); +} + +void loop() { + program->loop(); +} diff --git a/IOT/test/README b/IOT/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/IOT/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