Updated docs for beta3

src_docs/source/api.rst

@@ -65,6 +65,8 @@ Other parameters are the same as in the configuration guide.
       "angle": 90.93,
       "gravity": 1.105,
       "battery": 0.04,
+      "app-ver": "0.1.0",
+      "app-build": "build",
       "platform": "esp8266",
       "runtime-average": 3.12
    }
@@ -83,6 +85,8 @@ Retrive the current device status via an HTTP GET command. Payload is in JSON fo
 
 * ``temp-format`` can be either ``C`` or ``F``
 * ``platform`` can be either ``esp8266`` or ``esp32``
+* ``temp-c`` will be set to -273 C if there is no temp sensor
+* ``angle`` will be set to 0 if no valid angle is found and -1 if there is no gyro
 
 Other parameters are the same as in the configuration guide.
 
@@ -102,6 +106,7 @@ Other parameters are the same as in the configuration guide.
       "token2": "token2",
       "rssi": -56,
       "app-ver": "0.0.0",
+      "app-build": "gitrev",
       "mdns": "gravmon",
       "sleep-interval": 30,
       "platform": "esp8266",
@@ -156,18 +161,19 @@ Used for adjusting some internal constants and other advanced settings. Should b
 
    {
       "gyro-read-count": 50,
-      "tempsensor-resolution": 9,
       "gyro-moving-threashold": 500,
-      "formula-max-deviation": 1.6,
+      "formula-max-deviation": 3.0,
       "wifi-portal-timeout": 120,
       "wifi-connect-timeout": 20,
+      "push-timeout": 10,
       "formula-calibration-temp": 20,
-      "ignore-low-angles": false,
       "int-http1": 0,
       "int-http2": 0,
       "int-http3": 0,
       "int-influx": 0,
-      "int-mqtt": 0
+      "int-mqtt": 0,
+      "tempsensor-resolution": 9,
+      "ignore-low-angles": false
    }
 
 POST: /api/config/advanced
@@ -354,7 +360,7 @@ Calling the API's from Python
 =============================
 
 Here is some example code for how to access the API's from a python script. Keys should always be 
-present or the API call will fail.
+present or the API call will fail. You only need to include the parameters you want to change. 
 
 The requests package converts the json to standard form post format. 
 

src_docs/source/configuration.rst

@@ -317,6 +317,10 @@ data and of the deviation on any point is bigger the formula will be rejected.
 
 If this option is checked any angles below that of SG 1 will be discarded as invalid and never sent to any server. Default = off.
 
+* **Gravity calibration temp**
+
+This option allows you to set the correction temperature used in the automatic temperature gravity adjustment formula. Standard is 20C. 
+
 * **DS18B20 Resolution:**
 
 Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C, 12 bits will give an accuracy of 0.0625C but will also 

src_docs/source/hardware.rst

@@ -43,3 +43,22 @@ Schema for esp32 build
 .. image:: images/schema_esp32.png
   :width: 700
   :alt: Schema esp32
+
+Modifying with reed switch
+--------------------------
+
+A reed switch is a switch that reacts to magnetic fields. The ones I have tested are normally open and close in proximity to 
+a magnet. 
+
+.. image:: images/reed.jpg
+  :width: 400
+  :alt: Reed switch
+
+If this is connected to the reset button a magnet can be used to trigger a reset of the device. The image below shows how 
+I mounted the iSPINDLE PCB v4.0 just under the cap. The lower red circle shows the reset connection point for the reed switch.
+
+.. image:: images/reed_build.jpg
+  :width: 400
+  :alt: Reed build
+
+

src_docs/source/index.rst

@@ -7,7 +7,7 @@ Welcome to GravityMon's documentation!
 ######################################
 
 .. note::
-  This documentation reflects **v1.1 BETA 2**. Last updated 2022-07-23
+  This documentation reflects **v1.1 BETA 3**. Last updated 2022-08-02
 
 * Docs for: `v1.0 <https://mp-se.github.io/gravitymon/v1.0/index.html>`_
 * Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_
@@ -55,15 +55,16 @@ Main features:
 * Modern web based UI when in configuration mode. No need to start the access point changing settings.
 * REST API to enable scripted configuration
 * Send data to multiple endpoints and services at once
+* Directly test all endpoints from user interface to simplify troubleshooting
+* Complete format customization for all endpoints using templates
 * Setup guides for how to send data to many popular services. Currently 8+ are documented.
 * Automatic temperature adjustment of gravity reading
 * OTA support from webserver
-* Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity and 
-  let GravityMon create the formula. 
+* Firmware update via web interface
+* Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity and let GravityMon create the formula. 
 * Visual graph showing how formula will be interpreted based on entered values
 * Using the temperature sensor in gyro instead of DS18B20 (faster)
 * SSL support in standard HTTP and MQTT connections.
-* Option to customize data posted to endpoints using template from the UI.
 * Built in performance measurements (used to optimise code)
 
 For a complete breakdown see the :ref:`functionallity`