diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 0000000..790367c --- /dev/null +++ b/.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/.editorconfig b/.editorconfig new file mode 100644 index 0000000..fdfd862 --- /dev/null +++ b/.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/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0c55c9a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Fonctionnement + +## Labels + +- `Type/Amélioration`: Issue/PR lié à une amélioration d'une fonctionalité +- `Type/Bug`: Issue/PR lié à un bug présent dans le logiciel a corriger +- `Type/Documentation`: Issue/PR lié à un changement dans la documentation technique et/ou le design UI/UX +- `Type/Fonctionnalité`: Issue/PR lié à une nouvelle fonctionnalité +- `Type/Sécurité`: Issue/PR lié a la sécurité du logiciel +- `Type/Tests`: Issue/PR lié a des tests + +- `Status/Besoin d'infos`: Feedback nécessaire pour avancer +- `Status/Bloqué`: Issue/PR bloqué par quelque chose + +- `Tech/Logiciel`: issue ou PR qui est liée a du logiciel (Code) +- `Tech/Mécatronique`:Issue qui est dans le hard (Éléctronique, Mécanique) + +- `Priorité/Critique`: issue critique dans l'usage du logiciel +- `Priorité/Haute`: issue importante +- `Priorité/Moyenne`: issue moyenement importante +- `Priorité/Basse`: Issue non/peu importante + +- `Revue/Confirmé`: Issue validé qui est à faire +- `Revue/Dupliqué`: Issue fermé car elle est déjà éxistante +- `Revue/Invalide`: Issue invalide (raison en commentaire) +- `Revue/Non Corrigable`: Issue non corrigable (raison en commentaire) + +## Workflow d'un issue + +- Ajout d'une issue +- trie selon le type de l'issue avec les labels +- Affectassion a un milestone si possible +- travail sur l'issue +- fermeture de l'issue avec une liaison avec un commit/PR si relié + +## Branches/Tags + +_Basé sur `Git Flow` mais en plus simplifié_ + +- `branch/master`: Branche principal qui contient le code mergé final et fonctionnel +- `branch/blablabla`: Branche liée a une **Pull Request** qui contient du code non stable selon l'avancement +- `tags/*.*.*`: Chaque tag est sa version et doit Respecter le format `semver` alias `MAJOR.MINOR.PATCH` toute les versions en dessous de `1.0.0` seront considéré comme non-stable + +## Commits/PR + +_basé sur `Conventional Commits` mais en plus simplifié_ + +Globalement c'est recommendé d'utiliser sa pour **TOUT** les commits _mais_ au minimum a utiliser pour nommer la **PR** pour garder la branche principal clean + +architecture: `prefix: description` +trois partis pour un commit/pr: +- prefix + - `feat`: grosso modo c'est le label `fonctionnalité` + - `fix`: c'est le label `bug` ou un amélioration de perfs + - `docs`: Changement au niveau de la documentation technique + - `chore`: Changement autre (dépendances, CI/CD) +- `description`: texte en anglais commencant par un verbe indiquant ce qui a été fait (ex: `allow`,`send`, `change`, etc) diff --git a/README.md b/README.md new file mode 100644 index 0000000..6b89f3e --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Nom du projet + +Description du projet + +_note: voir le fichier SETUP.md pour setup le template dans un nouveau repo_ + +## Getting Started + +### Installation + +Description sur la façon dont on installe le logiciel/lib + +### Usage + +Description rapide de l'usage du logiciel + +## Règles de contributions + +Voir le fichier CONTRIBUTING.md diff --git a/config.cppcheck b/config.cppcheck new file mode 100644 index 0000000..77fd7d8 --- /dev/null +++ b/config.cppcheck @@ -0,0 +1,19 @@ + + + + .cppcheck-build + Unspecified + false + true + false + 10 + + + + + noCopyConstructor + noExplicitConstructor + unusedFunction + noOperatorEq + + diff --git a/config.ini b/config.ini new file mode 100644 index 0000000..11e4023 --- /dev/null +++ b/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/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9ff0271 --- /dev/null +++ b/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/envs.ini b/envs.ini new file mode 100644 index 0000000..9df4a04 --- /dev/null +++ b/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/include/Program.h b/include/Program.h new file mode 100644 index 0000000..66e4a79 --- /dev/null +++ b/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/include/README.md b/include/README.md new file mode 100644 index 0000000..e142f15 --- /dev/null +++ b/include/README.md @@ -0,0 +1,4 @@ + +Dossier pour les fichiers `headers` de CPP + +en savoir plus: https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README.md b/lib/README.md new file mode 100644 index 0000000..2d18ac9 --- /dev/null +++ b/lib/README.md @@ -0,0 +1,27 @@ +# Librairies maisons utilisé pour ce projet + +Architecture fichiers: +``` +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json voir: https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.cpp + |- Program.cpp +``` + +En savoir plus: https://docs.platformio.org/en/latest/librarymanager/quickstart.html diff --git a/platformio.ini b/platformio.ini index 4fa4a6d..329b7c7 100644 --- a/platformio.ini +++ b/platformio.ini @@ -1,14 +1,73 @@ ; 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:d1_mini] +; 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/scripts/get_additionnal_envs.py b/scripts/get_additionnal_envs.py new file mode 100644 index 0000000..0a349fd --- /dev/null +++ b/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/secrets.ini.example b/secrets.ini.example new file mode 100644 index 0000000..90b9782 --- /dev/null +++ b/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/src/Program.cpp b/src/Program.cpp new file mode 100644 index 0000000..e412959 --- /dev/null +++ b/src/Program.cpp @@ -0,0 +1,10 @@ +#include "Program.h" + +Program::Program() { + // Startup + Serial.begin(MONITOR_SPEED); +} + +void Program::loop() { + // Loop +} diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..ff37eaa --- /dev/null +++ b/src/README.md @@ -0,0 +1,3 @@ +# Code source du projet + +En savoir plus: https://docs.platformio.org/en/latest/core/quickstart.html diff --git a/src/main.cpp b/src/main.cpp index cb9fbba..74bf5a7 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,18 +1,11 @@ -#include +#include "Program.h" -// put function declarations here: -int myFunction(int, int); +Program* program; void setup() { - // put your setup code here, to run once: - int result = myFunction(2, 3); + program = new Program(); } void loop() { - // put your main code here, to run repeatedly: + program->loop(); } - -// put function definitions here: -int myFunction(int x, int y) { - return x + y; -} \ No newline at end of file diff --git a/test/README.md b/test/README.md new file mode 100644 index 0000000..7fa0127 --- /dev/null +++ b/test/README.md @@ -0,0 +1,4 @@ + +# Fichiers de tests unitaire de PlatformIO + +En savoir plus: https://docs.platformio.org/page/plus/unit-testing.html