From 1478430f03386391b1af133eb135e63ce7796ccc Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Fri, 7 Jan 2022 13:38:37 +0100 Subject: [PATCH] Merged precommit branch --- docs/_sources/compiling.rst.txt | 11 +++++++ docs/_sources/functionallity.rst.txt | 2 ++ docs/compiling.html | 11 +++++++ docs/configuration.html | 1 + docs/contributing.html | 1 + docs/functionallity.html | 9 ++++-- docs/index.html | 1 + docs/installation.html | 1 + docs/searchindex.js | 2 +- platformio.ini | 4 +-- src/helper.cpp | 8 ++--- src/helper.hpp | 2 +- src/main.cpp | 45 +++++++++++----------------- src_docs/source/compiling.rst | 11 +++++++ src_docs/source/functionallity.rst | 2 ++ 15 files changed, 72 insertions(+), 39 deletions(-) diff --git a/docs/_sources/compiling.rst.txt b/docs/_sources/compiling.rst.txt index 1ee7874..6ebf6cf 100644 --- a/docs/_sources/compiling.rst.txt +++ b/docs/_sources/compiling.rst.txt @@ -10,6 +10,17 @@ I use the following tools in order to build and manage the software: * Git for Windows * VSCode plugin: Minify (used to minimise the html files) +Code Formatting +=============== +I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in **.pre-commit-config.yaml** + +https://www.pre-commit.com + +.. note:: + + There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu. + + Targets ======= In the repository there are 3 targets defined diff --git a/docs/_sources/functionallity.rst.txt b/docs/_sources/functionallity.rst.txt index bc54196..e72dbec 100644 --- a/docs/_sources/functionallity.rst.txt +++ b/docs/_sources/functionallity.rst.txt @@ -60,6 +60,8 @@ Experimental features * Use the temperature sensor in the gyro instead of DS18B20 This works fine when the device has time to cool down between measurements and it saves a few milliseconds (reduced battery consumption). My testing shows that this is quite accurate. + There is lots of battery power to save, reading the temp sensor takes almost as long as the gyro. This could reduce the run time by 40-50% and probly extend battery life with the same. + However more testing is required. Might add this as an option in the UI. .. note:: diff --git a/docs/compiling.html b/docs/compiling.html index 0330bdb..51e526e 100644 --- a/docs/compiling.html +++ b/docs/compiling.html @@ -39,11 +39,13 @@