Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs and pre-commit formatting

Browse Source
This commit is contained in:
Magnus 2022-12-05 19:56:16 +01:00
parent b3a4266da1
commit e75a31ebb7
4 changed files with 15 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/templating.cpp
View File

@ -136,7 +136,8 @@ void TemplatingEngine::initialize(float angle, float gravitySG,
} }
// the useDefaultTemplate param is there to support unit tests. // the useDefaultTemplate param is there to support unit tests.
const char* TemplatingEngine::create(TemplatingEngine::Templates idx, bool useDefaultTemplate) { const char* TemplatingEngine::create(TemplatingEngine::Templates idx,
bool useDefaultTemplate) {
String fname; String fname;
_baseTemplate.reserve(600); _baseTemplate.reserve(600);

3
src/templating.hpp
View File

@ -200,7 +200,8 @@ class TemplatingEngine {
} }
void initialize(float angle, float gravitySG, float corrGravitySG, void initialize(float angle, float gravitySG, float corrGravitySG,
float tempC, float runTime); float tempC, float runTime);
const char *create(TemplatingEngine::Templates idx, bool useDefaultTemplate = false); const char *create(TemplatingEngine::Templates idx,
bool useDefaultTemplate = false);
}; };
#endif // SRC_TEMPLATING_HPP_ #endif // SRC_TEMPLATING_HPP_

2
src_docs/source/index.rst
View File

@ -7,7 +7,7 @@ Welcome to GravityMon
##################### #####################
.. note:: .. note::
This documentation reflects **v1.2 - beta 2**. Last updated 2022-11-19 This documentation reflects **v1.2.0**. Last updated 2022-12-05
What is GravityMon? What is GravityMon?
-------------------- --------------------

30
src_docs/source/releases.rst
View File

@ -3,40 +3,30 @@
Releases Releases
######## ########
v1.2.0 - beta2 v1.2.0
============== ======
Features Features
++++++++ ++++++++
* Added function to calcualate voltage factor based on measured value. * Added function to calcualate voltage factor based on measured value.
* Updated battery estimation for the various esp32 boards. * Updated battery estimation for the various esp32 boards.
* Added support for the ESP32 lite board which is used in the Floaty Hydrometer variant. * Added support for the ESP32 lite board which is used in the Floaty Hydrometer variant.
Documentation
+++++++++++++
* Added section about the Floaty hardware.
v1.2.0 - beta1
==============
* Changes to 1.2.0 only affect the ESP32 hardware, the ESP8266 is the same as for v1.1.1
Features
++++++++
* Added support for the ESP32 C3 mini board * Added support for the ESP32 C3 mini board
* Added support for the ESP32 S2 mini board * Added support for the ESP32 S2 mini board
* Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power. * Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power.
* Merged in unit tests and api tests into this project
Documentation
+++++++++++++
* Added section about the Floaty hardware
* Fixed schema errors in hardware section and linked PCB options
* Updated hardware section with options for ESP32 boards
* Updated installation instructions.
Issues adressed Issues adressed
++++++++++++++++ ++++++++++++++++
* BUG: The first portion of a format template was lost when doing conversion. * BUG: The first portion of a format template was lost when doing conversion.
Documentation
+++++++++++++
* Updated hardware section with options for ESP32 boards
* Updated installation instructions.
v1.1.1 v1.1.1
====== ======
* BUG: The text before the first variable was missed in the conversion of a format template. * BUG: The text before the first variable was missed in the conversion of a format template.