Update documentation

mp-se · Aug 9, 2024 · fbfd71a · fbfd71a
1 parent 5b0417c
commit fbfd71a
Show file tree

Hide file tree

Showing 48 changed files with 847 additions and 141 deletions.
diff --git a/docs/_images/ui-device-hardware.png b/docs/_images/ui-device-hardware.png
diff --git a/docs/_images/ui-device-hardware1.png b/docs/_images/ui-device-hardware1.png
diff --git a/docs/_images/ui-device-settings.png b/docs/_images/ui-device-settings.png
diff --git a/docs/_images/ui-device-settings1.png b/docs/_images/ui-device-settings1.png
diff --git a/docs/_images/ui-device-wifi.png b/docs/_images/ui-device-wifi.png
diff --git a/docs/_images/ui-device-wifi1.png b/docs/_images/ui-device-wifi1.png
diff --git a/docs/_images/ui-gravity-analysis.png b/docs/_images/ui-gravity-analysis.png
diff --git a/docs/_images/ui-gravity-formula.png b/docs/_images/ui-gravity-formula.png
diff --git a/docs/_images/ui-gravity-settings.png b/docs/_images/ui-gravity-settings.png
diff --git a/docs/_images/ui-home.png b/docs/_images/ui-home.png
diff --git a/docs/_images/ui-home1.png b/docs/_images/ui-home1.png
diff --git a/docs/_images/ui-other-about.png b/docs/_images/ui-other-about.png
diff --git a/docs/_images/ui-other-backup.png b/docs/_images/ui-other-backup.png
diff --git a/docs/_images/ui-other-firmware.png b/docs/_images/ui-other-firmware.png
diff --git a/docs/_images/ui-other-logs.png b/docs/_images/ui-other-logs.png
diff --git a/docs/_images/ui-other-serial.png b/docs/_images/ui-other-serial.png
diff --git a/docs/_images/ui-other-tools.png b/docs/_images/ui-other-tools.png
diff --git a/docs/_images/ui-push-ble.png b/docs/_images/ui-push-ble.png
diff --git a/docs/_images/ui-push-get.png b/docs/_images/ui-push-get.png
diff --git a/docs/_images/ui-push-influx.png b/docs/_images/ui-push-influx.png
diff --git a/docs/_images/ui-push-mqtt.png b/docs/_images/ui-push-mqtt.png
diff --git a/docs/_images/ui-push-post.png b/docs/_images/ui-push-post.png
diff --git a/docs/_images/ui-push-settings.png b/docs/_images/ui-push-settings.png
diff --git a/docs/_images/ui-push-settings1.png b/docs/_images/ui-push-settings1.png
diff --git a/docs/_sources/configuration.rst.txt b/docs/_sources/configuration.rst.txt
@@ -526,7 +526,6 @@ Push - Bluetooth
   - **TILT iBeacon**: Standard tilt data transmission. Data: Gravity and Temperature   
   - **TILT PRO iBeacon**: Higher accuracy tilt data transmission. Data: Gravity and Temperature   
   - **GM iBeacon**: Higher accuracy. Data: Gravity, Temperature, ID, Angle
-  - **GM SERVICE**: Client can read standard iSpindle JSON payload, require connection with device.
   - **GM EDDYSTONE**: Beacon format that requires active scanning by the client. Data: Gravity, ID, Temperature and Angle 
 
 Other

diff --git a/docs/_sources/gateway.rst.txt b/docs/_sources/gateway.rst.txt
@@ -0,0 +1,209 @@
+.. _gateway:
+
+Gateway
+#######
+
+.. note::
+
+  This documentation reflects **v0.4.0 beta 1**. Last updated 2024-08-02
+
+GravityMon Gateway is an separate project that can act as a proxy between your GravityMon devices and services. It can:
+
+* Receive the new GravityMon 2.0 BLE formats and transform these to HTTP Post/Get, InfluxDB or MQTT requests
+* Receive data via direct WiFi connection (Direct connection between the device and the gateway) and relay this data to defined endpoints. 
+
+Hardware 
+========
+
+The main supported hardware is ESP32s3 PRO with a TFT 
+
+* `Lolin ESP32s3 PRO <https://www.wemos.cc/en/latest/s3/s3_pro.html>`_ 
+* `Lolin TFT <https://www.wemos.cc/en/latest/d1_mini_shield/tft_2_4.html>`_ 
+* Cable to connect the display with the ESP
+
+There is also a build for the ESP32 PRO (Tiltbridge Hardware setup) but that does not support the new BLE formats since that board does not have BLE 5 support.
+
+* `Releases for GravityMon Gateway <https://github.com/mp-se/gravitymon-gateway/releases>`_ 
+
+Most of the UI is copied from GravityMon with a few alterations so the documentation here will only point out the differences.
+
+.. note::
+
+  GravityMon Gateway does not support the TILT options, if you want to use these I recommend Tiltbridge that has a lot of good 
+  features for that. The main reason is that these formats have very little data and would require a lot of work to make the gateway
+  add the missing information. Tiltbridge already has this support built in so it makes little sense to replicate that work.
+
+
+Home page 
+=========
+
+URL: (http://gravmon-gw.local)
+
+.. image:: images/gw/ui-home.png
+  :width: 800
+  :alt: Home page
+
+The main page shows the device settings as well as the latest readings from connected devices. 
+
+
+Device 
+======
+
+Device - Settings
++++++++++++++++++
+
+.. image:: images/gw/ui-device-settings.png
+  :width: 800
+  :alt: Device Settings
+
+* **MDNS:** 
+
+  This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (<name>.local). 
+  The limitation is 63 chars but using long names might break endpoints that data is sent to if they have other limitations. 
+
+* **Temperature format:** 
+
+  Choose between Celsius and Fahrenheit when displaying temperature. 
+
+* **Gravity format:**
+
+  Gravity format can be either `SG` or `Plato`. The device will use SG Internally and convert to Plato when displaying or sending data.
+
+* **Dark Mode:**
+
+  Switches the UI between light and dark mode. You can also use the toggle on the menubar for that.
+
+* **Factory default**
+
+  This function will reset all settings to factory default. Use with caution!
+
+* **Restart**
+
+  Restarts the device, similar to pressing the reset button
+
+
+Device - Hardware
++++++++++++++++++
+
+.. image:: images/gw/ui-device-hardware.png
+  :width: 800
+  :alt: Device Hardware
+
+* **Scan mode:**
+
+  Determine if the BLE scan will be done in active or passive mode. 
+
+* **Scan time:**
+
+  Time the BLE scan cycle. Don't use too long time since this will impact the updates on readings and display.
+
+* **Time zone:**
+
+  Select the timezone so that date / time will be correcly displayed. This is not an extensive list of all timezones so let me know if you are missing one. 
+
+
+Device - WIFI
++++++++++++++
+
+.. image:: images/gw/ui-device-wifi.png
+  :width: 800
+  :alt: Device WIFI
+
+Most of these settings are the same as for GravityMon with the following expections.
+
+* **Direct SSID:**
+
+  Name of the SSID that GravityMon devices will use in Wifi Direct mode.
+
+* **Direct Password:**
+
+  Enter the SSID password. 
+
+* **Generate:**
+
+  Will create an SSID and Password
+
+
+Push targets
+============
+
+Push - Settings
++++++++++++++++
+
+.. image:: images/gw/ui-push-settings.png
+  :width: 800
+  :alt: Push Settings
+
+* **Token:**
+
+  If the incoming payload does not contain the token this value will be added to the outgoing payload.
+
+* **Push timeout:** 
+
+  How long the device will wait for a connection accept from the remote service.
+
+* **Push minium resend time:** 
+
+  This the minimum time before an update can be sent. Some remote services do not want to have updates too often. 
+
+Push - HTTP Post
+++++++++++++++++
+
+See GravityMon configuration.
+
+
+Push - HTTP Get
++++++++++++++++
+
+See GravityMon configuration.
+
+
+Push - InfluxDB v2
+++++++++++++++++++
+
+See GravityMon configuration.
+
+
+Push - MQTT
++++++++++++
+
+See GravityMon configuration.
+
+
+Other
+=====
+
+Other - Serial
+++++++++++++++
+
+See GravityMon configuration.
+
+
+Other - Backup
+++++++++++++++
+
+See GravityMon configuration.
+
+
+Other - Firmware
+++++++++++++++++
+
+See GravityMon configuration.
+
+
+Other - Support
++++++++++++++++
+
+See GravityMon configuration.
+
+
+Other - Tools
++++++++++++++
+
+See GravityMon configuration.
+
+
+Other - About
++++++++++++++
+
+Shows information about the software
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -7,7 +7,7 @@ Welcome to GravityMon
 #####################
 
 .. note::
-  This documentation reflects **v2.0.0 beta 1**. Last updated 2024-07-13
+  This documentation reflects **v2.0.0 beta 2**. Last updated 2024-07-13
 
   Link to `previous documentation here <https://mp-se.github.io/gravitymon/v1.4/>`_ 
 
@@ -138,6 +138,7 @@ the following libraries and without these this would have been much more difficu
    hardware
    services
    data
+   gateway
    compiling
    contributing
    license

diff --git a/docs/_sources/releases.rst.txt b/docs/_sources/releases.rst.txt
@@ -3,6 +3,19 @@
 Releases 
 ########
 
+v2.0.0-beta2
+============
+
+Issues adressed
++++++++++++++++
+* Force gravity mode toggle on main page does not reflect the real state of the flag when other views have been used.
+* Updated user interface with project name and device name for easier identification.
+* Removed BLE GravityMon Service option since this is not really performing well.
+
+Known Issues
+++++++++++++
+* RGB led on ESP32S3 does not work due to bug in Arduino for ESP32 (Manually edit the pins_arduino.h for esp32s3 will fix the issue, #define RGB_BUILTIN LED_BUILTIN+SOC_GPIO_PIN_COUNT)
+
 v2.0.0-beta1
 ============
 
@@ -13,12 +26,6 @@ Issues adressed
 * Added WIFI Direct Connect option with GravityMon Gateway, I hope this will help with wifi connection issues in my steel fermenter and force a connect to the designated AP. Wifi Direct will send the data via http 
   to the Gateway and then forward this to the correct endpoint. 
 
-Known Issues
-++++++++++++
-* Wire (Gyro communication), does not work properly on ESP32C3 boards, timeout error. Problem resides in esp-idf framework. 
-  https://github.com/espressif/arduino-esp32/issues/8056
-* RGB led on ESP32S3 does not work due to bug in Arduino for ESP32 (Manually edit the pins_arduino.h for esp32s3 will fix the issue, #define RGB_BUILTIN LED_BUILTIN+SOC_GPIO_PIN_COUNT)
-
 New Features
 ++++++++++++
 * Added option for wifi direct when in gravity mode, wifi direct allows direct access to device without going through AP. This feature is inteded to be used with the gravitymon gateway.

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.0.0-beta1',
+    VERSION: '2.0.0-beta2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/compiling.html b/docs/compiling.html
@@ -2,10 +2,10 @@
 <html class="no-js">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
-    <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Data Formats" href="data.html" />
+    <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Gateway" href="gateway.html" />
 
     <meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
-        <title>Compiling the software - GravityMon v2.0.0-beta1</title>
+        <title>Compiling the software - GravityMon v2.0.0</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">GravityMon v2.0.0-beta1</div></a>
+      <a href="index.html"><div class="brand">GravityMon v2.0.0</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">GravityMon v2.0.0-beta1</span>
+  <span class="sidebar-brand-text">GravityMon v2.0.0</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@@ -168,6 +168,7 @@
 <li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
 <li class="toctree-l1"><a class="reference internal" href="services.html">Service Integration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="gateway.html">Gateway</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Compiling the software</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
@@ -365,14 +366,14 @@ <h2>Options<a class="headerlink" href="#options" title="Permalink to this headli
               </div>
               <svg><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="data.html">
+          <a class="prev-page" href="gateway.html">
               <svg><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">Data Formats</div>
+                <div class="title">Gateway</div>
 
               </div>
             </a>

diff --git a/docs/configuration.html b/docs/configuration.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Format Templates" href="format-template.html" /><link rel="prev" title="Software Installation" href="installation.html" />
 
     <meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
-        <title>Configuration - GravityMon v2.0.0-beta1</title>
+        <title>Configuration - GravityMon v2.0.0</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">GravityMon v2.0.0-beta1</div></a>
+      <a href="index.html"><div class="brand">GravityMon v2.0.0</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">GravityMon v2.0.0-beta1</span>
+  <span class="sidebar-brand-text">GravityMon v2.0.0</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@@ -168,6 +168,7 @@
 <li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
 <li class="toctree-l1"><a class="reference internal" href="services.html">Service Integration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="gateway.html">Gateway</a></li>
 <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
@@ -599,7 +600,6 @@ <h3>Push - Bluetooth<a class="headerlink" href="#push-bluetooth" title="Permalin
 <li><p><strong>TILT iBeacon</strong>: Standard tilt data transmission. Data: Gravity and Temperature</p></li>
 <li><p><strong>TILT PRO iBeacon</strong>: Higher accuracy tilt data transmission. Data: Gravity and Temperature</p></li>
 <li><p><strong>GM iBeacon</strong>: Higher accuracy. Data: Gravity, Temperature, ID, Angle</p></li>
-<li><p><strong>GM SERVICE</strong>: Client can read standard iSpindle JSON payload, require connection with device.</p></li>
 <li><p><strong>GM EDDYSTONE</strong>: Beacon format that requires active scanning by the client. Data: Gravity, ID, Temperature and Angle</p></li>
 </ul>
 </li>