diff --git a/src_docs/source/backlog.rst b/src_docs/source/backlog.rst index 50e94db..c0c646f 100644 --- a/src_docs/source/backlog.rst +++ b/src_docs/source/backlog.rst @@ -1,13 +1,18 @@ Backlog of changes ################## +This is a list of potential ideas to implemnt in the software. + Documentation ------------- - Write contribution instructions +- Example project for creating integrations and instructions Code -------------- +---- - Support for plato - Use pre-commit for validating check-in +- Show indicated battery life based on interval (check if its feasable) +- Use brewflasher for flashing diff --git a/src_docs/source/images/software_design.png b/src_docs/source/images/software_design.png new file mode 100644 index 0000000..6731274 Binary files /dev/null and b/src_docs/source/images/software_design.png differ diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index b61cb97..15de2ce 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -23,6 +23,9 @@ The hardware design comes from the fantastic iSpindle project so that is not cov My approach to this software is a little different from that the original ispindle firmware. The github repository can be found here; `GravityMon on Github `_ + + + .. note:: This software is in the early stages even though its more than one year old so if you find issues, please open a ticket on github. @@ -30,29 +33,36 @@ be found here; `GravityMon on Github `_ I dont take responsibility for any errors that can cause problems with the use. I have tested v0.4 on 5+ brews over the last 6 months without any issues. - The main differences: --------------------- -* Operates in two modes ``gravity monitoring`` and ``configuration mode`` -* Send data to multiple endpoints when pushing data. -* Automatic temperature adjustment of gravity reading -* OTA support from local webserver -* Build in function to create gravity formulas - -There are also a experimental features such as: - +* Operates in two modes gravity monitoring and configuration mode (simplify calibration) +* Modern web based UI for configuration (in config mode) +* REST API +* Send data to multiple endpoints when pushing data (2xhttp, brewfather, influxdb v2, mqtt supported) +* Automatic temperature adjustment of gravity reading +* OTA support from local webserver +* Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity. +* Visual graph showing how formula will be interpreted * Using the temperature sensor in gyro instead of DS18B20 (faster) -* Performance measurements (used to optimise code) +* Built in performance measurements (used to optimise code) For a complete breakdown see the :ref:`functionallity` +This is a simple overview of the different components that the software contains. The green ones are only active during `configuration mode` in +order to save battery. + +.. image:: images/software_design.png + :width: 600 + :alt: Software design + + Credits to ---------- Ideas to some of these functions have been picked up from disucssions in the iSpindle forums. This software uses the following libraries and without these this would have been much more difficult to acheive: -* https://github.com/jrowberg/i2cdevlib.git +* https://github.com/jrowberg/i2cdevlib This library contains the basic code to interact with the gyro + many more chips. diff --git a/src_docs/source/sofware_overview.drawio b/src_docs/source/sofware_overview.drawio new file mode 100644 index 0000000..dea3f70 --- /dev/null +++ b/src_docs/source/sofware_overview.drawio @@ -0,0 +1 @@ +7VpRb6M4EP41kfYetgoYCHls0na7uq3U22TV7dPJgSHxLcGRMU3SX38GDAFMknZL6vR0LxEeG2O+b+absUMPjZebLwyvFnfUh7Bn9v1ND131THOILPGbGra5wUDWILfMGfGlbWeYkGeQxr60JsSHuDaQUxpysqobPRpF4PGaDTNG1/VhAQ3rT13hOSiGiYdD1fpAfL7Ira452NlvgcwXxZMNZ5j3LHExWL5JvMA+XVdM6LqHxoxSnl8tN2MIU/AKXPL7bvb0lgtjEPGX3BDebQa3z8nj3xMy/OFux7M/J78+IznNEw4T+cZytXxbQMBoEvmQztLvodF6QThMVthLe9eCdGFb8GUoWoa4xCGZR+I6hECsaiRnB8Zhs3fdRomGcCOgS+BsK4bIG2yJX+FBRXu9o2PgSNuiQoVduBCWLjAvp96hJC4kUK8AzXROC5qP40V2q9ENgoZRh7AMrgqEJVpVCK2TQai63X0SL7LgFj9TzObA4wOgGsdBDUgYjmlIWXYvCoLA9Dxhjzmjv6DS4zszx3a6gdoaNKBu8VbDbIHaOZmzHvdViPzLVCpFywtxHBOvjiRsCP+ZXl/0naL9mHr2hY2QbF9tpKtnjW2lcQ+MiFcBJm3548FXdLeBsVgiTZgHx7xI5aLq1m3CIG0MQszJU30ZbfjLJ9xTIhZYUo3cOtVOM1jy5cu7qsLcmMhxGj6DGhPxLByUiTJ3KF/79z0EKR5yO53eZ+sz+6LHCVNRmjFxNU+vRgzWgchuwNS+r1EQJpurUTpfy613f02nivuJaON1h6uHaEQjaMSzNDV0M41cIlL3pTQvie+nD2lVirpAdxD6TiP0jWFL6LeprHuq0LcUYr9sGX2bqhaQewKVNKT1yKxhn5vMDl4gs0LyJrJJGV/QOY1weL2zNnxyN+YbpSuJ/z/A+VaWyTgR2bLGTofaaufjcu05MM5pJ+rF4vom1F0dIAso2fZntSGTYdHc5cKsVSRDDeRYOskZaiWnwsdjte98yNkjce9DjqFFn/ax0z/CTlmB1qvPg7WnDkb7WilFeil9nRoWlO5ofKwQ3E5pLBjg6lYlM9+QUGMWNLQGc/k6/+fBPQBpDUxTb2B+AHpMnfTYSum+xCT69IdC2gfcKCGrvlFCSPdGST07ncJyBQzzhIHomEAUCyS6xb4DJJtbTv1IGq4C5QTYUwqievKCV6uQeCKaaKRDjDoUleII5XhO3rP7kYR+7l8YhmHUSDXfeDRYDKFBEMNJDuuKt6+Q/gCzjPeW47hPHo0CQubihiX14cSS5tvg+labpLnmDDknOmK3tJ/9FE5U4eT79WQqLJf3X/eR8p/mxLa0c+J8pJrrdzZDXUqq9VJJ1XtmMVTjDLCf5bsb8fvARKi00v4NzyA8Ejh7/z1gEJNnPMvmS4FfpWKfvZs96tlXhyJIfpUgb+6V+aVK0gH33Rtv/QsRv3a9Hnlb5iqSYn3SssZ4h8Sm/lshEluqodXKRdFSlkSxGJT29Wfp5x7ATq2oGNygtXB3PBdmQTeK6rjnluXMlsqDBKRjsDuArlmpWy2fO7wzdKYC3TirARLWXpF/wJ2mgvrQ1o26+p/cO2w1zwJ8/ZtTU92cnkAtzgJs/fqCVH35XsmLPjwRgaiSPCFeuaajFspv/yDjeFF1/JOMgEZcFtqiCumEObORVM22MHFbmDNfz5xo7r7tzIuk3Rey6Ppf \ No newline at end of file