Update documentation
This commit is contained in:
GitHub Action
@ -37,6 +37,26 @@ In the platformio config there are 3 targets defined
|
||||
The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the serial port can cause corruption and crashes.
|
||||
So only enable enough debugging to troubleshoot your changes.
|
||||
|
||||
Serial debugging on battery
|
||||
===========================
|
||||
|
||||
.. image:: images/serial.png
|
||||
:width: 600
|
||||
:alt: Serial output
|
||||
|
||||
On the ESP32 builds the serial output can be written to UART0 which is connected to the RX/TX pins on the chip. This way the serial output can be viewed
|
||||
without a connection to the USB port, convinient when running the device on battery power. In order to get this to work you need to compile the sofware
|
||||
with the option **DUSE_SERIAL_PINS** and attach as USB to TTL cable to the correct pins.
|
||||
|
||||
You connect the USB to TTL cable that you connect the TX, RX and GND pins. **Dont connect the power pin** if you are powering the device from USB or Battery.
|
||||
|
||||
.. image:: images/usb-ttl.jpg
|
||||
:width: 300
|
||||
:alt: USB to TTL cable
|
||||
|
||||
.. image:: images/serial_esp32c3.jpg
|
||||
:width: 300
|
||||
:alt: Serial output ESP32c3
|
||||
|
||||
Source structure
|
||||
================
|
||||
@ -92,4 +112,6 @@ This is a list of C++ defines that is used to enable/disable functions in the co
|
||||
- Password to the SSID
|
||||
* - CFG_APPVER
|
||||
- Defines the version of the compiled software
|
||||
* - USE_SERIAL_PINS
|
||||
- Will send the serial console to the TX/RX pins on an ESP32 target so that debugging can be done when on battery
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ One of the following conditions will place the device in ``configuration mode``:
|
||||
- Gyro has not been calibrated
|
||||
- Sleep mode has been disabled in the web interface
|
||||
- Placed in horizontal mode 85-90 degrees
|
||||
- Charger connected >4.15V
|
||||
- Charger connected >4.15V (or the value that is configured)
|
||||
|
||||
|
||||
Status
|
||||
@ -39,7 +39,7 @@ connection. It will show 0 if data has not been collected yet.
|
||||
|
||||
The button `view error log` will show the last error messages on the device. This can be useful for checking errors without
|
||||
the need to connect to the serial port or to check what errors has occurred while in `gravity mode`. From v1.1 it will also detect
|
||||
any abnormal restarts or crashes and record these in the logfile.
|
||||
any abnormal restarts or crashes and record these in the logfile (this applies to esp8266 only).
|
||||
|
||||
|
||||
Configuration
|
||||
|
||||
@ -7,53 +7,14 @@ Welcome to GravityMon
|
||||
#####################
|
||||
|
||||
.. note::
|
||||
This documentation reflects **v1.2 - beta 1**. Last updated 2022-10-22
|
||||
|
||||
User interface overview
|
||||
-----------------------
|
||||
|
||||
This animation shows how the user interface is structured, it reflects an older version but the structure is the same.
|
||||
|
||||
.. image:: images/gravitymon.gif
|
||||
:width: 800
|
||||
:alt: User Inteface Walkthrough
|
||||
|
||||
.. _main_features:
|
||||
|
||||
Main features
|
||||
-------------
|
||||
|
||||
* Support either an ESP8266-d1-mini, ESP32-mini, ESP32S2-mini or ESP32C3-mini board (see :ref:`hardware`)
|
||||
* Operates in two modes gravity monitoring and configuration mode
|
||||
* Gravity mode is comparable to how the iSpindle works when collecting data
|
||||
* Configuration mode has a modern HTML5 based web UI. No need to start the access point to change settings
|
||||
* Offloading some of the functionality to run in the web browser, this allows for more advanced features.
|
||||
* REST API to enable scripted configuration
|
||||
* Send data to multiple endpoints and services at once (2xHTTP POST, HTTP GET, MQTT, INFLUXDB2)
|
||||
* Directly test all endpoints from user interface with feedback to simplify troubleshooting
|
||||
* Complete format customization for all endpoints using templates (don't really need to change the software to support new services)
|
||||
* Setup guides for how to send data to many popular services. Currently 10+ are documented
|
||||
* Automatic temperature adjustment of gravity (just tick a checkbox)
|
||||
* OTA support from webserver
|
||||
* Firmware update via web interface
|
||||
* Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity and let GravityMon creates a 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 all endpoints (no certificate validation due to limitations on esp8266).
|
||||
* Built in performance measurements (used to optimize code)
|
||||
* Storage mode when placed on cap (indefinite sleep)
|
||||
* Customize various hardware parameters to optimize device functionality.
|
||||
|
||||
For a complete breakdown see the :ref:`functionality`
|
||||
|
||||
.. note::
|
||||
If you are missing some feature, please reach out on `Github <https://github.com/mp-se/gravitymon/discussions>`_ or `homebrewtalk.com <https://www.homebrewtalk.com/threads/replacement-firmware-for-ispindel-gravitymon.698058/>`_
|
||||
This documentation reflects **v1.2 - beta 1**. Last updated 2022-11-04
|
||||
|
||||
What is GravityMon?
|
||||
--------------------
|
||||
|
||||
GravityMon is used to measure gravity and temperature during fermentation of beer and report the progress. The graph below is
|
||||
an example on how the fermentation process can be tracked. The graph has been rendered using Fermentrack.
|
||||
GravityMon is a electronic hydrometer software that can be used to measure gravity and temperature during fermentation of beer and report the progress to a number of external
|
||||
services. Is uses a gyro to measure the gravity since there is a correlation between gravity an the density of the fluid. Based on the density the hydrometer will float at a different angle.
|
||||
The graph below is an example on how the fermentation process can be tracked. The graph has been rendered using Fermentrack.
|
||||
|
||||
.. image:: images/fermentation.png
|
||||
:width: 500
|
||||
@ -61,10 +22,11 @@ an example on how the fermentation process can be tracked. The graph has been re
|
||||
|
||||
GravityMon is a replacement firmware for the iSpindle and uses the same hardware configuration and is 100% compatible. It
|
||||
implements a lot of the features that has been requested in the original iSpindle project but never implemented for
|
||||
various reasons. Here is a list of :ref:`main_features`.
|
||||
various reasons.
|
||||
|
||||
From v0.9 the firmware also supports a iSpindle built using an ESP32 d1 mini (pin compatible with esp8266). Currently this is an experimental
|
||||
version but since it has more memory and processing capacity it could support more functions. See :ref:`hardware`.
|
||||
The firmware also supports a iSpindle built using an ESP32 which is pin compatible with esp8266, currently there are 3 options that are
|
||||
supported ESP32-D1 mini, ESP32-C3 mini and ESP32-S2 mini. See :ref:`hardware`. The more modern hardware will allow better support for SSL and
|
||||
other memory intensive functions.
|
||||
|
||||
I started GravityMon because I like to create software and wanted to do some microcontroller programming. I had done a few
|
||||
projects based on esp8266 and also started to brew beer so this combination was quite natural.
|
||||
@ -82,13 +44,14 @@ The github repository can be found here; `GravityMon on Github <https://github.c
|
||||
|
||||
I have tested this software on 40+ brews with good results.
|
||||
|
||||
User interface overview
|
||||
-----------------------
|
||||
|
||||
Documentation for older versions
|
||||
--------------------------------
|
||||
|
||||
* 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>`_
|
||||
This animation shows how the features of the user interface. It's for an older version but the main features are the same.
|
||||
|
||||
.. image:: images/gravitymon.gif
|
||||
:width: 800
|
||||
:alt: User Inteface Walkthrough
|
||||
|
||||
Software architecture
|
||||
---------------------
|
||||
@ -174,13 +137,12 @@ the following libraries and without these this would have been much more difficu
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
intro
|
||||
releases
|
||||
functionality
|
||||
intro
|
||||
installation
|
||||
configuration
|
||||
troubleshooting
|
||||
q_and_a
|
||||
releases
|
||||
hardware
|
||||
formula
|
||||
services
|
||||
advanced
|
||||
@ -188,8 +150,9 @@ the following libraries and without these this would have been much more difficu
|
||||
data
|
||||
compiling
|
||||
contributing
|
||||
hardware
|
||||
license
|
||||
troubleshooting
|
||||
q_and_a
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
@ -113,23 +113,6 @@ Serial Monitoring
|
||||
To check output from the device (logs) there are several tools out there. I found this simple tool in the Windows Store called ``Serial Port Monitoring``.
|
||||
Just select a baud rate of 115200, 8N1.
|
||||
|
||||
.. image:: images/serial.png
|
||||
:width: 600
|
||||
:alt: Serial output
|
||||
|
||||
On the build for ESP32C3 and ESP32S2 the serial output is written to UART0 which is connected to the RX/TX pins on the chip. This way the serial output can be viewed
|
||||
without a connection to the USB port, convinient when running the device on battery power.
|
||||
|
||||
You need a USB to TTL cable that you connect the TX, RX and GND pins. **Dont connect the power pin** if you are powering the device from USB or Battery.
|
||||
|
||||
.. image:: images/usb-ttl.jpg
|
||||
:width: 300
|
||||
:alt: USB to TTL cable
|
||||
|
||||
.. image:: images/serial_esp32c3.jpg
|
||||
:width: 300
|
||||
:alt: Serial output ESP32c3
|
||||
|
||||
.. _setup_wifi:
|
||||
|
||||
Configuring WIFI
|
||||
|
||||
@ -3,19 +3,15 @@
|
||||
Releases
|
||||
########
|
||||
|
||||
v1.2.0 - beta2
|
||||
==============
|
||||
|
||||
Features
|
||||
++++++++
|
||||
* Added support for the ESP32 S2 mini board
|
||||
|
||||
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 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.
|
||||
|
||||
Issues adressed
|
||||
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="services.html">Service Integration</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -238,6 +238,16 @@
|
||||
So only enable enough debugging to troubleshoot your changes.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="serial-debugging-on-battery">
|
||||
<h2>Serial debugging on battery<a class="headerlink" href="#serial-debugging-on-battery" title="Permalink to this headline">¶</a></h2>
|
||||
<a class="reference internal image-reference" href="_images/serial.png"><img alt="Serial output" src="_images/serial.png" style="width: 600px;"/></a>
|
||||
<p>On the ESP32 builds the serial output can be written to UART0 which is connected to the RX/TX pins on the chip. This way the serial output can be viewed
|
||||
without a connection to the USB port, convinient when running the device on battery power. In order to get this to work you need to compile the sofware
|
||||
with the option <strong>DUSE_SERIAL_PINS</strong> and attach as USB to TTL cable to the correct pins.</p>
|
||||
<p>You connect the USB to TTL cable that you connect the TX, RX and GND pins. <strong>Dont connect the power pin</strong> if you are powering the device from USB or Battery.</p>
|
||||
<a class="reference internal image-reference" href="_images/usb-ttl.jpg"><img alt="USB to TTL cable" src="_images/usb-ttl.jpg" style="width: 300px;"/></a>
|
||||
<a class="reference internal image-reference" href="_images/serial_esp32c3.jpg"><img alt="Serial output ESP32c3" src="_images/serial_esp32c3.jpg" style="width: 300px;"/></a>
|
||||
</div>
|
||||
<div class="section" id="source-structure">
|
||||
<h2>Source structure<a class="headerlink" href="#source-structure" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="table-wrapper"><table class="colwidths-given docutils align-default" id="id2">
|
||||
@ -321,6 +331,9 @@ So only enable enough debugging to troubleshoot your changes.</p>
|
||||
<tr class="row-even"><td><p>CFG_APPVER</p></td>
|
||||
<td><p>Defines the version of the compiled software</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>USE_SERIAL_PINS</p></td>
|
||||
<td><p>Will send the serial console to the TX/RX pins on an ESP32 target so that debugging can be done when on battery</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
@ -377,6 +390,7 @@ So only enable enough debugging to troubleshoot your changes.</p>
|
||||
<li><a class="reference internal" href="#tools">Tools</a></li>
|
||||
<li><a class="reference internal" href="#code-formatting">Code Formatting</a></li>
|
||||
<li><a class="reference internal" href="#targets">Targets</a></li>
|
||||
<li><a class="reference internal" href="#serial-debugging-on-battery">Serial debugging on battery</a></li>
|
||||
<li><a class="reference internal" href="#source-structure">Source structure</a></li>
|
||||
<li><a class="reference internal" href="#options">Options</a></li>
|
||||
</ul>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Troubleshooting" href="troubleshooting.html" /><link rel="prev" title="Installation" href="installation.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="Releases" href="releases.html" /><link rel="prev" title="Installation" href="installation.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Configuration - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -209,7 +209,7 @@
|
||||
<li><p>Gyro has not been calibrated</p></li>
|
||||
<li><p>Sleep mode has been disabled in the web interface</p></li>
|
||||
<li><p>Placed in horizontal mode 85-90 degrees</p></li>
|
||||
<li><p>Charger connected >4.15V</p></li>
|
||||
<li><p>Charger connected >4.15V (or the value that is configured)</p></li>
|
||||
</ul>
|
||||
<div class="section" id="status">
|
||||
<h2>Status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h2>
|
||||
@ -228,7 +228,7 @@ connection. It will show 0 if data has not been collected yet.</p>
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The button <cite>view error log</cite> will show the last error messages on the device. This can be useful for checking errors without
|
||||
the need to connect to the serial port or to check what errors has occurred while in <cite>gravity mode</cite>. From v1.1 it will also detect
|
||||
any abnormal restarts or crashes and record these in the logfile.</p>
|
||||
any abnormal restarts or crashes and record these in the logfile (this applies to esp8266 only).</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
@ -491,12 +491,12 @@ accept data every 15 min.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="troubleshooting.html">
|
||||
<a class="next-page" href="releases.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Troubleshooting</div>
|
||||
<div class="title">Releases</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Hardware" href="hardware.html" /><link rel="prev" title="Compiling the software" href="compiling.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="Licence" href="license.html" /><link rel="prev" title="Compiling the software" href="compiling.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Contributing - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Contributing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -233,12 +233,12 @@ that this approach works fine.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="hardware.html">
|
||||
<a class="next-page" href="license.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Hardware</div>
|
||||
<div class="title">Licence</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Service Integration" href="services.html" /><link rel="prev" title="Q & A" href="q_and_a.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="Service Integration" href="services.html" /><link rel="prev" title="Hardware" href="hardware.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Create formula - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -235,14 +235,14 @@ use the graph on the calibration page to identify angles that is probably not co
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="q_and_a.html">
|
||||
<a class="prev-page" href="hardware.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Q & A</div>
|
||||
<div class="title">Hardware</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Installation" href="installation.html" /><link rel="prev" title="Releases" href="releases.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="Getting started" href="intro.html" /><link rel="prev" title="Welcome to GravityMon" href="index.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Functionality - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -354,23 +354,23 @@ temperature would reduce the total runtime with 25%. Sending data over http take
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="installation.html">
|
||||
<a class="next-page" href="intro.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Installation</div>
|
||||
<div class="title">Getting started</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="releases.html">
|
||||
<a class="prev-page" href="index.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Releases</div>
|
||||
<div class="title">Home</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@ -158,13 +158,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -172,8 +171,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Licence" href="license.html" /><link rel="prev" title="Contributing" href="contributing.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="Create formula" href="formula.html" /><link rel="prev" title="Releases" href="releases.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Hardware - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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 current current-page"><a class="current reference internal" href="#">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -277,23 +277,23 @@ I mounted the iSPINDLE PCB v4.0 just under the cap. The lower red circle shows t
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="license.html">
|
||||
<a class="next-page" href="formula.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Licence</div>
|
||||
<div class="title">Create formula</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="contributing.html">
|
||||
<a class="prev-page" href="releases.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Contributing</div>
|
||||
<div class="title">Releases</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
147
docs/index.html
147
docs/index.html
@ -2,7 +2,7 @@
|
||||
<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="Getting started" href="intro.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="Functionality" href="functionality.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -205,53 +205,20 @@
|
||||
<h1>Welcome to GravityMon<a class="headerlink" href="#welcome-to-gravitymon" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This documentation reflects <strong>v1.2 - beta 1</strong>. Last updated 2022-10-22</p>
|
||||
</div>
|
||||
<div class="section" id="user-interface-overview">
|
||||
<h2>User interface overview<a class="headerlink" href="#user-interface-overview" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This animation shows how the user interface is structured, it reflects an older version but the structure is the same.</p>
|
||||
<a class="reference internal image-reference" href="_images/gravitymon.gif"><img alt="User Inteface Walkthrough" src="_images/gravitymon.gif" style="width: 800px;"/></a>
|
||||
</div>
|
||||
<div class="section" id="main-features">
|
||||
<span id="id1"></span><h2>Main features<a class="headerlink" href="#main-features" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Support either an ESP8266-d1-mini, ESP32-mini, ESP32S2-mini or ESP32C3-mini board (see <a class="reference internal" href="hardware.html#hardware"><span class="std std-ref">Hardware</span></a>)</p></li>
|
||||
<li><p>Operates in two modes gravity monitoring and configuration mode</p></li>
|
||||
<li><p>Gravity mode is comparable to how the iSpindle works when collecting data</p></li>
|
||||
<li><p>Configuration mode has a modern HTML5 based web UI. No need to start the access point to change settings</p></li>
|
||||
<li><p>Offloading some of the functionality to run in the web browser, this allows for more advanced features.</p></li>
|
||||
<li><p>REST API to enable scripted configuration</p></li>
|
||||
<li><p>Send data to multiple endpoints and services at once (2xHTTP POST, HTTP GET, MQTT, INFLUXDB2)</p></li>
|
||||
<li><p>Directly test all endpoints from user interface with feedback to simplify troubleshooting</p></li>
|
||||
<li><p>Complete format customization for all endpoints using templates (don’t really need to change the software to support new services)</p></li>
|
||||
<li><p>Setup guides for how to send data to many popular services. Currently 10+ are documented</p></li>
|
||||
<li><p>Automatic temperature adjustment of gravity (just tick a checkbox)</p></li>
|
||||
<li><p>OTA support from webserver</p></li>
|
||||
<li><p>Firmware update via web interface</p></li>
|
||||
<li><p>Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity and let GravityMon creates a formula</p></li>
|
||||
<li><p>Visual graph showing how formula will be interpreted based on entered values</p></li>
|
||||
<li><p>Using the temperature sensor in gyro instead of DS18B20 (faster)</p></li>
|
||||
<li><p>SSL support in all endpoints (no certificate validation due to limitations on esp8266).</p></li>
|
||||
<li><p>Built in performance measurements (used to optimize code)</p></li>
|
||||
<li><p>Storage mode when placed on cap (indefinite sleep)</p></li>
|
||||
<li><p>Customize various hardware parameters to optimize device functionality.</p></li>
|
||||
</ul>
|
||||
<p>For a complete breakdown see the <a class="reference internal" href="functionality.html#functionality"><span class="std std-ref">Functionality</span></a></p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>If you are missing some feature, please reach out on <a class="reference external" href="https://github.com/mp-se/gravitymon/discussions">Github</a> or <a class="reference external" href="https://www.homebrewtalk.com/threads/replacement-firmware-for-ispindel-gravitymon.698058/">homebrewtalk.com</a></p>
|
||||
</div>
|
||||
<p>This documentation reflects <strong>v1.2 - beta 1</strong>. Last updated 2022-11-04</p>
|
||||
</div>
|
||||
<div class="section" id="what-is-gravitymon">
|
||||
<h2>What is GravityMon?<a class="headerlink" href="#what-is-gravitymon" title="Permalink to this headline">¶</a></h2>
|
||||
<p>GravityMon is used to measure gravity and temperature during fermentation of beer and report the progress. The graph below is
|
||||
an example on how the fermentation process can be tracked. The graph has been rendered using Fermentrack.</p>
|
||||
<p>GravityMon is a electronic hydrometer software that can be used to measure gravity and temperature during fermentation of beer and report the progress to a number of external
|
||||
services. Is uses a gyro to measure the gravity since there is a correlation between gravity an the density of the fluid. Based on the density the hydrometer will float at a different angle.
|
||||
The graph below is an example on how the fermentation process can be tracked. The graph has been rendered using Fermentrack.</p>
|
||||
<a class="reference internal image-reference" href="_images/fermentation.png"><img alt="Example fermentation" src="_images/fermentation.png" style="width: 500px;"/></a>
|
||||
<p>GravityMon is a replacement firmware for the iSpindle and uses the same hardware configuration and is 100% compatible. It
|
||||
implements a lot of the features that has been requested in the original iSpindle project but never implemented for
|
||||
various reasons. Here is a list of <a class="reference internal" href="#main-features"><span class="std std-ref">Main features</span></a>.</p>
|
||||
<p>From v0.9 the firmware also supports a iSpindle built using an ESP32 d1 mini (pin compatible with esp8266). Currently this is an experimental
|
||||
version but since it has more memory and processing capacity it could support more functions. See <a class="reference internal" href="hardware.html#hardware"><span class="std std-ref">Hardware</span></a>.</p>
|
||||
various reasons.</p>
|
||||
<p>The firmware also supports a iSpindle built using an ESP32 which is pin compatible with esp8266, currently there are 3 options that are
|
||||
supported ESP32-D1 mini, ESP32-C3 mini and ESP32-S2 mini. See <a class="reference internal" href="hardware.html#hardware"><span class="std std-ref">Hardware</span></a>. The more modern hardware will allow better support for SSL and
|
||||
other memory intensive functions.</p>
|
||||
<p>I started GravityMon because I like to create software and wanted to do some microcontroller programming. I had done a few
|
||||
projects based on esp8266 and also started to brew beer so this combination was quite natural.</p>
|
||||
<p>The hardware design comes from the fantastic iSpindle project so that is not covered in this documentation. For more
|
||||
@ -265,12 +232,10 @@ try my best to fix issues that might occur.</p>
|
||||
<p>I have tested this software on 40+ brews with good results.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="documentation-for-older-versions">
|
||||
<h2>Documentation for older versions<a class="headerlink" href="#documentation-for-older-versions" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v1.0/index.html">v1.0</a></p></li>
|
||||
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.9/index.html">v0.9</a></p></li>
|
||||
</ul>
|
||||
<div class="section" id="user-interface-overview">
|
||||
<h2>User interface overview<a class="headerlink" href="#user-interface-overview" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This animation shows how the features of the user interface. It’s for an older version but the main features are the same.</p>
|
||||
<a class="reference internal image-reference" href="_images/gravitymon.gif"><img alt="User Inteface Walkthrough" src="_images/gravitymon.gif" style="width: 800px;"/></a>
|
||||
</div>
|
||||
<div class="section" id="software-architecture">
|
||||
<h2>Software architecture<a class="headerlink" href="#software-architecture" title="Permalink to this headline">¶</a></h2>
|
||||
@ -335,6 +300,12 @@ the following libraries and without these this would have been much more difficu
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="functionality.html#the-main-features">The main features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="functionality.html#battery-life">Battery life</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="functionality.html#performance">Performance</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="intro.html#step-1-flash-the-device">Step 1 - Flash the device</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="intro.html#step-2-setup-wifi">Step 2 - Setup WIFI</a></li>
|
||||
@ -342,27 +313,6 @@ the following libraries and without these this would have been much more difficu
|
||||
<li class="toctree-l2"><a class="reference internal" href="intro.html#step-4-completed">Step 4 - Completed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0-beta2">v1.2.0 - beta2</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0-beta1">v1.2.0 - beta1</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-1">v1.1.1</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-0">v1.1.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0">v1.0.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-9-0">v0.9.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-8-0">v0.8.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-1">v0.7.1</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-0">v0.7.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-6-0">v0.6.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-5-0">v0.5.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-4-0">v0.4.0</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="functionality.html#the-main-features">The main features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="functionality.html#battery-life">Battery life</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="functionality.html#performance">Performance</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation.html#brewflasher">Brewflasher</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation.html#esptool-esp8266">Esptool (esp8266)</a></li>
|
||||
@ -378,16 +328,24 @@ the following libraries and without these this would have been much more difficu
|
||||
<li class="toctree-l2"><a class="reference internal" href="configuration.html#id1">Configuration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#log-errors">Log errors</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0-beta1">v1.2.0 - beta1</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-1">v1.1.1</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-0">v1.1.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0">v1.0.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-9-0">v0.9.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-8-0">v0.8.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-1">v0.7.1</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-0">v0.7.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-6-0">v0.6.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-5-0">v0.5.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-4-0">v0.4.0</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#my-device-is-no-going-in-to-sleep-after-fully-charged">My device is no going in to sleep after fully charged</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#my-device-reports-a-temperature-of-273c-or-491f">My device reports a temperature of -273C or -491F</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#calibration-error-unable-to-find-a-valid-formula">Calibration error (unable to find a valid formula)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#user-interface-does-not-render-correctly">User interface does not render correctly</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#data-is-not-populated-in-the-fields">Data is not populated in the fields</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hardware.html#ispindle-based-on-esp8266">iSpindle based on esp8266</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hardware.html#ispindle-based-on-esp32">iSpindle based on esp32</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hardware.html#adding-a-reed-magnetic-reset-switch">Adding a reed (magnetic) reset switch</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li>
|
||||
@ -438,6 +396,7 @@ the following libraries and without these this would have been much more difficu
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiling.html#tools">Tools</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiling.html#code-formatting">Code Formatting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiling.html#targets">Targets</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiling.html#serial-debugging-on-battery">Serial debugging on battery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiling.html#source-structure">Source structure</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiling.html#options">Options</a></li>
|
||||
</ul>
|
||||
@ -446,13 +405,19 @@ the following libraries and without these this would have been much more difficu
|
||||
<li class="toctree-l2"><a class="reference internal" href="contributing.html#design-goals">Design goals</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hardware.html#ispindle-based-on-esp8266">iSpindle based on esp8266</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hardware.html#ispindle-based-on-esp32">iSpindle based on esp32</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hardware.html#adding-a-reed-magnetic-reset-switch">Adding a reed (magnetic) reset switch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#log-errors">Log errors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#my-device-is-no-going-in-to-sleep-after-fully-charged">My device is no going in to sleep after fully charged</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#my-device-reports-a-temperature-of-273c-or-491f">My device reports a temperature of -273C or -491F</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#calibration-error-unable-to-find-a-valid-formula">Calibration error (unable to find a valid formula)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#user-interface-does-not-render-correctly">User interface does not render correctly</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#data-is-not-populated-in-the-fields">Data is not populated in the fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
@ -471,12 +436,12 @@ the following libraries and without these this would have been much more difficu
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="intro.html">
|
||||
<a class="next-page" href="functionality.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Getting started</div>
|
||||
<div class="title">Functionality</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
@ -504,10 +469,8 @@ the following libraries and without these this would have been much more difficu
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Welcome to GravityMon</a><ul>
|
||||
<li><a class="reference internal" href="#user-interface-overview">User interface overview</a></li>
|
||||
<li><a class="reference internal" href="#main-features">Main features</a></li>
|
||||
<li><a class="reference internal" href="#what-is-gravitymon">What is GravityMon?</a></li>
|
||||
<li><a class="reference internal" href="#documentation-for-older-versions">Documentation for older versions</a></li>
|
||||
<li><a class="reference internal" href="#user-interface-overview">User interface overview</a></li>
|
||||
<li><a class="reference internal" href="#software-architecture">Software architecture</a></li>
|
||||
<li><a class="reference internal" href="#credits-to">Credits to</a><ul>
|
||||
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Configuration" href="configuration.html" /><link rel="prev" title="Functionality" href="functionality.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="Configuration" href="configuration.html" /><link rel="prev" title="Getting started" href="intro.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Installation - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -285,12 +285,6 @@ browser and select the firmware.bin file that corresponds to the version you wan
|
||||
<span id="id3"></span><h2>Serial Monitoring<a class="headerlink" href="#serial-monitoring" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To check output from the device (logs) there are several tools out there. I found this simple tool in the Windows Store called <code class="docutils literal notranslate"><span class="pre">Serial</span> <span class="pre">Port</span> <span class="pre">Monitoring</span></code>.
|
||||
Just select a baud rate of 115200, 8N1.</p>
|
||||
<a class="reference internal image-reference" href="_images/serial.png"><img alt="Serial output" src="_images/serial.png" style="width: 600px;"/></a>
|
||||
<p>On the build for ESP32C3 and ESP32S2 the serial output is written to UART0 which is connected to the RX/TX pins on the chip. This way the serial output can be viewed
|
||||
without a connection to the USB port, convinient when running the device on battery power.</p>
|
||||
<p>You need a USB to TTL cable that you connect the TX, RX and GND pins. <strong>Dont connect the power pin</strong> if you are powering the device from USB or Battery.</p>
|
||||
<a class="reference internal image-reference" href="_images/usb-ttl.jpg"><img alt="USB to TTL cable" src="_images/usb-ttl.jpg" style="width: 300px;"/></a>
|
||||
<a class="reference internal image-reference" href="_images/serial_esp32c3.jpg"><img alt="Serial output ESP32c3" src="_images/serial_esp32c3.jpg" style="width: 300px;"/></a>
|
||||
</div>
|
||||
<div class="section" id="configuring-wifi">
|
||||
<span id="setup-wifi"></span><h2>Configuring WIFI<a class="headerlink" href="#configuring-wifi" title="Permalink to this headline">¶</a></h2>
|
||||
@ -337,14 +331,14 @@ with finding the network name you can try the following:</p>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="functionality.html">
|
||||
<a class="prev-page" href="intro.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Functionality</div>
|
||||
<div class="title">Getting started</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Releases" href="releases.html" /><link rel="prev" title="Welcome to GravityMon" href="index.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="Installation" href="installation.html" /><link rel="prev" title="Functionality" href="functionality.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Getting started - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -268,23 +268,23 @@ Its recommended to attach the device to power when you have it in <cite>configur
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="releases.html">
|
||||
<a class="next-page" href="installation.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Releases</div>
|
||||
<div class="title">Installation</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="index.html">
|
||||
<a class="prev-page" href="functionality.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Home</div>
|
||||
<div class="title">Functionality</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="prev" title="Hardware" href="hardware.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="Troubleshooting" href="troubleshooting.html" /><link rel="prev" title="Contributing" href="contributing.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Licence - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -227,15 +227,23 @@ SOFTWARE.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
<a class="prev-page" href="hardware.html">
|
||||
<a class="next-page" href="troubleshooting.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Troubleshooting</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="contributing.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Hardware</div>
|
||||
<div class="title">Contributing</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
@ -2,7 +2,7 @@
|
||||
<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="Create formula" href="formula.html" /><link rel="prev" title="Troubleshooting" href="troubleshooting.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="prev" title="Troubleshooting" href="troubleshooting.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Q & A - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -251,15 +251,7 @@ device can access: <a class="reference external" href="https://code.jquery.com">
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="formula.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Create formula</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
<a class="prev-page" href="troubleshooting.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Functionality" href="functionality.html" /><link rel="prev" title="Getting started" href="intro.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="Hardware" href="hardware.html" /><link rel="prev" title="Configuration" href="configuration.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Releases - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -203,21 +203,16 @@
|
||||
<article role="main">
|
||||
<div class="section" id="releases">
|
||||
<span id="id1"></span><h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="v1-2-0-beta2">
|
||||
<h2>v1.2.0 - beta2<a class="headerlink" href="#v1-2-0-beta2" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="v1-2-0-beta1">
|
||||
<h2>v1.2.0 - beta1<a class="headerlink" href="#v1-2-0-beta1" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Changes to 1.2.0 only affect the ESP32 hardware, the ESP8266 is the same as for v1.1.1</p></li>
|
||||
</ul>
|
||||
<div class="section" id="features">
|
||||
<h3>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Added support for the ESP32 S2 mini board</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="v1-2-0-beta1">
|
||||
<h2>v1.2.0 - beta1<a class="headerlink" href="#v1-2-0-beta1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id2">
|
||||
<h3>Features<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Added support for the ESP32 C3 mini board</p></li>
|
||||
<li><p>Added support for the ESP32 S2 mini board</p></li>
|
||||
<li><p>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.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
@ -243,8 +238,8 @@
|
||||
</div>
|
||||
<div class="section" id="v1-1-0">
|
||||
<h2>v1.1.0<a class="headerlink" href="#v1-1-0" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id3">
|
||||
<h3>Features<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id2">
|
||||
<h3>Features<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Added information to error log about abnormal resets (for instance crashes) to detect and fix those</p></li>
|
||||
<li><p>Changed storage mode so that the device will go into deep sleep until reset (sleep forever)</p></li>
|
||||
@ -294,8 +289,8 @@
|
||||
<li><p>User can now edit the voltage level that forces the device into config mode (device detects charging)</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id3">
|
||||
<h3>Documentation<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Added documentation for Brewpiless as target</p></li>
|
||||
<li><p>Added documentation for BVrewblox as target</p></li>
|
||||
@ -319,8 +314,8 @@
|
||||
</div>
|
||||
<div class="section" id="v1-0-0">
|
||||
<h2>v1.0.0<a class="headerlink" href="#v1-0-0" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3>Documentation<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id4">
|
||||
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Update documentation to match v1.0</p></li>
|
||||
<li><p>Installation instructions updated on how to find the device after wifi has been configured.</p></li>
|
||||
@ -329,8 +324,8 @@
|
||||
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h3>User interface<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id5">
|
||||
<h3>User interface<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Upgraded to bootstrap v5.1 for web pages.</p></li>
|
||||
<li><p>Added button on index page to direct to github issues.</p></li>
|
||||
@ -341,8 +336,8 @@
|
||||
<li><p>Added function on format page so that it’s easy to copy a format template from the docs (simplify service integration).</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3>Features<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id6">
|
||||
<h3>Features<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Added advanced setting to ignore angles that are lower than water. This is disabled by default.</p></li>
|
||||
<li><p>Added support for MPU6500 (standard is MPU6050).</p></li>
|
||||
@ -359,8 +354,8 @@
|
||||
<li><p>Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing battery life</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h3>Issues addressed<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id7">
|
||||
<h3>Issues addressed<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>BUG: Fixed issue in formula calculation in case there were a gap in the data series</p></li>
|
||||
<li><p>BUG: Field name for wifi strength changed from “rssi” to “RSSI”</p></li>
|
||||
@ -494,23 +489,23 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="functionality.html">
|
||||
<a class="next-page" href="hardware.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Functionality</div>
|
||||
<div class="title">Hardware</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="intro.html">
|
||||
<a class="prev-page" href="configuration.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Getting started</div>
|
||||
<div class="title">Configuration</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
@ -537,31 +532,27 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Releases</a><ul>
|
||||
<li><a class="reference internal" href="#v1-2-0-beta2">v1.2.0 - beta2</a><ul>
|
||||
<li><a class="reference internal" href="#features">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#v1-2-0-beta1">v1.2.0 - beta1</a><ul>
|
||||
<li><a class="reference internal" href="#id2">Features</a></li>
|
||||
<li><a class="reference internal" href="#features">Features</a></li>
|
||||
<li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li>
|
||||
<li><a class="reference internal" href="#documentation">Documentation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#v1-1-1">v1.1.1</a></li>
|
||||
<li><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
|
||||
<li><a class="reference internal" href="#id3">Features</a></li>
|
||||
<li><a class="reference internal" href="#id2">Features</a></li>
|
||||
<li><a class="reference internal" href="#known-issues-not-yet-fixed">Known issues, not yet fixed</a></li>
|
||||
<li><a class="reference internal" href="#issues-addressed">Issues addressed</a></li>
|
||||
<li><a class="reference internal" href="#user-interface">User interface</a></li>
|
||||
<li><a class="reference internal" href="#id4">Documentation</a></li>
|
||||
<li><a class="reference internal" href="#id3">Documentation</a></li>
|
||||
<li><a class="reference internal" href="#other">Other</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
|
||||
<li><a class="reference internal" href="#id5">Documentation</a></li>
|
||||
<li><a class="reference internal" href="#id6">User interface</a></li>
|
||||
<li><a class="reference internal" href="#id7">Features</a></li>
|
||||
<li><a class="reference internal" href="#id8">Issues addressed</a></li>
|
||||
<li><a class="reference internal" href="#id4">Documentation</a></li>
|
||||
<li><a class="reference internal" href="#id5">User interface</a></li>
|
||||
<li><a class="reference internal" href="#id6">Features</a></li>
|
||||
<li><a class="reference internal" href="#id7">Issues addressed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>
|
||||
|
||||
@ -157,13 +157,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -171,8 +170,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Service Integration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<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="Q & A" href="q_and_a.html" /><link rel="prev" title="Configuration" href="configuration.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="Q & A" href="q_and_a.html" /><link rel="prev" title="Licence" href="license.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Troubleshooting - GravityMon v1.2.0</title>
|
||||
@ -159,13 +159,12 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="functionality.html">Functionality</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</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="advanced.html">Advanced Configuration</a></li>
|
||||
@ -173,8 +172,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</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="hardware.html">Hardware</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -280,14 +280,14 @@ to memory leaks.</p>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="configuration.html">
|
||||
<a class="prev-page" href="license.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Configuration</div>
|
||||
<div class="title">Licence</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
0
docs/v1.0/.nojekyll
Normal file
0
docs/v1.0/.nojekyll
Normal file
Reference in New Issue
Block a user