Merge branch 'master' into dev

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. ...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Software:**
+ - Platform (esp8266, esp32)
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

src_docs/source/index.rst

@@ -7,7 +7,7 @@ Welcome to GravityMon's documentation!
 ######################################
 
 .. note::
-  This documentation reflects **v1.0**. Last updated 2022-05-08
+  This documentation reflects **v1.0**. Last updated 2022-05-16
 
 * Docs for: `v0.8 <https://mp-se.github.io/gravitymon/v0.8/index.html>`_
 * Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_

src_docs/source/q_and_a.rst

@@ -12,3 +12,20 @@ My device reports a temperature of -273C or -491F
 -------------------------------------------------
 - The DS18B20 temperature sensor cannot be found and this is the default value reported in this case.
 - Check the orienation of the sensor and soldering.
+
+Calibration error (unable to find a valid formula)
+--------------------------------------------------
+If you have issues to get a calibration formula. When a formula has been created the device always tries to validate the formula against the supplied values and if there is a to high deviation on any of the values then the formula will be rejected.
+
+The image here shows such a case, one of the values is out of bounds. 
+
+.. image:: images/qa_1.png
+  :width: 500
+  :alt: Calibration Error
+
+To fix these this you can;
+
+- remove the value from the list (setting the angle to zero will do that)
+- change the advanced setting (Formula max deviation) to a higher value and save the values again. 
+
+In the case above this paramater was changed from 1.6 SG to 4 SG and the formula was accepted. The deviation on this point was just above 3 SG. 

src_docs/source/releases.rst

@@ -3,6 +3,14 @@
 Releases 
 ########
 
+Updates
+=======
+
+Documentation
++++++++++++++
+* Added documentation for Brewpiless as target
+* Added q&a on formula creation and value deviation
+
 v1.0.0
 ======
 

src_docs/source/services.rst

@@ -264,3 +264,11 @@ starting with a ``?``. This string will be added to the URL above when doing the
 .. code-block::
 
    ?token=${token2}&v1=${temp}&v2=${gravity}&v3=${angle}
+
+
+Brewpiless
+++++++++++
+
+If you connect the device to the brewpiless access point there is not way to access the user interface for configuration so it's recommended to connect the device to your normal network. 
+
+The device need to have a name starting with iSpindle, for example `iSpindel000`. Set the URL for one of the http POST targets to `http://ip/gravity` where ip is the ip adress of Brewpiless.