Update documentation
This commit is contained in:
GitHub Action
parent
8f2278ef03
commit
f860578a83
@ -61,7 +61,7 @@ Here is an image of where I added the resistor for the voltage divider.
|
||||
ESP32s2 mini
|
||||
++++++++++++
|
||||
|
||||
Work in progress...
|
||||
This is model is now fully supported by gravitymon. Same setup as for ESP32C3 mini.
|
||||
|
||||
ESP32 d1 mini
|
||||
+++++++++++++
|
||||
|
||||
@ -3,11 +3,11 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to GravityMon's documentation!
|
||||
######################################
|
||||
Welcome to GravityMon
|
||||
#####################
|
||||
|
||||
.. note::
|
||||
This documentation reflects **v1.2 - beta 1**. Last updated 2022-10-15
|
||||
This documentation reflects **v1.2 - beta 1**. Last updated 2022-10-22
|
||||
|
||||
User interface overview
|
||||
-----------------------
|
||||
@ -23,7 +23,7 @@ This animation shows how the user interface is structured, it reflects an older
|
||||
Main features
|
||||
-------------
|
||||
|
||||
* Support either an ESP8266-d1-mini, ESP32-mini or ESP32C3-mini board (see :ref:`hardware`)
|
||||
* 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
|
||||
|
||||
@ -3,11 +3,13 @@
|
||||
Installation
|
||||
------------
|
||||
|
||||
You have these 3 options for flashing this firmware.
|
||||
You have these 5 options for flashing this firmware.
|
||||
|
||||
* Brewflasher via USB serial
|
||||
* Brewflasher WEB via USB serial
|
||||
* Esptool via USB serial
|
||||
* iSpindel web interface
|
||||
* iSpindel web interface (only ESP8266)
|
||||
* Build from source and flash via VSCode + Platformio
|
||||
|
||||
Brewflasher
|
||||
===========
|
||||
@ -16,6 +18,13 @@ The preferred option for flashing GravityMon is using BrewFlasher, its a tools t
|
||||
on both Windows and Mac. You can download the latest version from here: `Brewflasher <https://www.brewflasher.com/>`_ there is also a web based version
|
||||
available here `Brewflasher WEB <https://web.brewflasher.com/>`_.
|
||||
|
||||
In order to flash an C3 board you will need Brewflasher 1.5 or newer.
|
||||
|
||||
.. note::
|
||||
The S2 and C3 chips might need to be put in flash mode before flashing can be done. Hold the button on the opposite side from the RST button,
|
||||
press the RST button and release it before the first button you pressed. This should force the chip into download mode. If you connect a serial
|
||||
terminal it should say "waiting for download".
|
||||
|
||||
.. image:: images/brewflasher.png
|
||||
:width: 600
|
||||
:alt: Serial output
|
||||
@ -108,7 +117,7 @@ Just select a baud rate of 115200, 8N1.
|
||||
:width: 600
|
||||
:alt: Serial output
|
||||
|
||||
On the build for esp32c3 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
|
||||
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.
|
||||
|
||||
@ -3,6 +3,13 @@
|
||||
Releases
|
||||
########
|
||||
|
||||
v1.2.0 - beta2
|
||||
==============
|
||||
|
||||
Features
|
||||
++++++++
|
||||
* Added support for the ESP32 S2 mini board
|
||||
|
||||
v1.2.0 - beta1
|
||||
==============
|
||||
|
||||
|
||||
BIN
docs/_static/gravitymon_logo.png
vendored
Normal file
BIN
docs/_static/gravitymon_logo.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 171 KiB |
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="REST API" href="api.html" /><link rel="prev" title="Service Integration" href="services.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Advanced Configuration - GravityMon 1.2.0 documentation</title>
|
||||
<title>Advanced Configuration - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Data Formats" href="data.html" /><link rel="prev" title="Advanced Configuration" href="advanced.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>REST API - GravityMon 1.2.0 documentation</title>
|
||||
<title>REST API - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Data Formats" href="data.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Compiling the software - GravityMon 1.2.0 documentation</title>
|
||||
<title>Compiling the software - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Troubleshooting" href="troubleshooting.html" /><link rel="prev" title="Installation" href="installation.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Configuration - GravityMon 1.2.0 documentation</title>
|
||||
<title>Configuration - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Hardware" href="hardware.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 1.2.0 documentation</title>
|
||||
<title>Contributing - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Compiling the software" href="compiling.html" /><link rel="prev" title="REST API" href="api.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Data Formats - GravityMon 1.2.0 documentation</title>
|
||||
<title>Data Formats - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Service Integration" href="services.html" /><link rel="prev" title="Q & A" href="q_and_a.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Create formula - GravityMon 1.2.0 documentation</title>
|
||||
<title>Create formula - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="installation.html" /><link rel="prev" title="Releases" href="releases.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Functionality - GravityMon 1.2.0 documentation</title>
|
||||
<title>Functionality - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/><title>Index - GravityMon 1.2.0 documentation</title>
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/><title>Index - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -122,7 +122,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -142,10 +142,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Licence" href="license.html" /><link rel="prev" title="Contributing" href="contributing.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Hardware - GravityMon 1.2.0 documentation</title>
|
||||
<title>Hardware - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
@ -239,7 +242,7 @@ need to adjust the voltage factor so the battery reading is correct.</p>
|
||||
</div>
|
||||
<div class="section" id="esp32s2-mini">
|
||||
<h3>ESP32s2 mini<a class="headerlink" href="#esp32s2-mini" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Work in progress…</p>
|
||||
<p>This is model is now fully supported by gravitymon. Same setup as for ESP32C3 mini.</p>
|
||||
</div>
|
||||
<div class="section" id="esp32-d1-mini">
|
||||
<h3>ESP32 d1 mini<a class="headerlink" href="#esp32-d1-mini" title="Permalink to this headline">¶</a></h3>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Getting started" href="intro.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>GravityMon 1.2.0 documentation</title>
|
||||
<title>GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="#"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="#"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="#">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
@ -198,11 +201,11 @@
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<div class="section" id="welcome-to-gravitymon-s-documentation">
|
||||
<h1>Welcome to GravityMon’s documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="welcome-to-gravitymon">
|
||||
<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-15</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>
|
||||
@ -212,7 +215,7 @@
|
||||
<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 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>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>
|
||||
@ -340,6 +343,7 @@ the following libraries and without these this would have been much more difficu
|
||||
</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>
|
||||
@ -499,7 +503,7 @@ the following libraries and without these this would have been much more difficu
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Welcome to GravityMon’s documentation!</a><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>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Configuration" href="configuration.html" /><link rel="prev" title="Functionality" href="functionality.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Installation - GravityMon 1.2.0 documentation</title>
|
||||
<title>Installation - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
@ -200,17 +203,26 @@
|
||||
<article role="main">
|
||||
<div class="section" id="installation">
|
||||
<span id="id1"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>You have these 3 options for flashing this firmware.</p>
|
||||
<p>You have these 5 options for flashing this firmware.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Brewflasher via USB serial</p></li>
|
||||
<li><p>Brewflasher WEB via USB serial</p></li>
|
||||
<li><p>Esptool via USB serial</p></li>
|
||||
<li><p>iSpindel web interface</p></li>
|
||||
<li><p>iSpindel web interface (only ESP8266)</p></li>
|
||||
<li><p>Build from source and flash via VSCode + Platformio</p></li>
|
||||
</ul>
|
||||
<div class="section" id="brewflasher">
|
||||
<h2>Brewflasher<a class="headerlink" href="#brewflasher" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The preferred option for flashing GravityMon is using BrewFlasher, its a tools that support many brewing related firmwares for ESP8266 and ESP32. This works
|
||||
on both Windows and Mac. You can download the latest version from here: <a class="reference external" href="https://www.brewflasher.com/">Brewflasher</a> there is also a web based version
|
||||
available here <a class="reference external" href="https://web.brewflasher.com/">Brewflasher WEB</a>.</p>
|
||||
<p>In order to flash an C3 board you will need Brewflasher 1.5 or newer.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The S2 and C3 chips might need to be put in flash mode before flashing can be done. Hold the button on the opposite side from the RST button,
|
||||
press the RST button and release it before the first button you pressed. This should force the chip into download mode. If you connect a serial
|
||||
terminal it should say “waiting for download”.</p>
|
||||
</div>
|
||||
<a class="reference internal image-reference" href="_images/brewflasher.png"><img alt="Serial output" src="_images/brewflasher.png" style="width: 600px;"/></a>
|
||||
<div class="section" id="binaries">
|
||||
<h3>Binaries<a class="headerlink" href="#binaries" title="Permalink to this headline">¶</a></h3>
|
||||
@ -274,7 +286,7 @@ browser and select the firmware.bin file that corresponds to the version you wan
|
||||
<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 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
|
||||
<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>
|
||||
|
||||
@ -2,10 +2,10 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Releases" href="releases.html" /><link rel="prev" title="Welcome to GravityMon’s documentation!" 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="Releases" href="releases.html" /><link rel="prev" title="Welcome to GravityMon" href="index.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Getting started - GravityMon 1.2.0 documentation</title>
|
||||
<title>Getting started - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Hardware" href="hardware.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Licence - GravityMon 1.2.0 documentation</title>
|
||||
<title>Licence - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Create formula" href="formula.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 1.2.0 documentation</title>
|
||||
<title>Q & A - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Functionality" href="functionality.html" /><link rel="prev" title="Getting started" href="intro.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Releases - GravityMon 1.2.0 documentation</title>
|
||||
<title>Releases - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
@ -200,11 +203,20 @@
|
||||
<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-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="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="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>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>
|
||||
@ -231,8 +243,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="id2">
|
||||
<h3>Features<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id3">
|
||||
<h3>Features<a class="headerlink" href="#id3" 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>
|
||||
@ -282,8 +294,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="id3">
|
||||
<h3>Documentation<a class="headerlink" href="#id3" 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>Added documentation for Brewpiless as target</p></li>
|
||||
<li><p>Added documentation for BVrewblox as target</p></li>
|
||||
@ -307,8 +319,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="id4">
|
||||
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id5">
|
||||
<h3>Documentation<a class="headerlink" href="#id5" 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>
|
||||
@ -317,8 +329,8 @@
|
||||
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id5">
|
||||
<h3>User interface<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id6">
|
||||
<h3>User interface<a class="headerlink" href="#id6" 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>
|
||||
@ -329,8 +341,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="id6">
|
||||
<h3>Features<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id7">
|
||||
<h3>Features<a class="headerlink" href="#id7" 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>
|
||||
@ -347,8 +359,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="id7">
|
||||
<h3>Issues addressed<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id8">
|
||||
<h3>Issues addressed<a class="headerlink" href="#id8" 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>
|
||||
@ -525,27 +537,31 @@ 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-beta1">v1.2.0 - beta1</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="#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="#id2">Features</a></li>
|
||||
<li><a class="reference internal" href="#id3">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="#id3">Documentation</a></li>
|
||||
<li><a class="reference internal" href="#id4">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="#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>
|
||||
<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>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<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="#" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/><title>Search - GravityMon 1.2.0 documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/><title>Search - GravityMon v1.2.0</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=fade93df149f7c5fedb3ff897f799dc7d283b420" />
|
||||
@ -121,7 +121,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -141,10 +141,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="#" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Advanced Configuration" href="advanced.html" /><link rel="prev" title="Create formula" href="formula.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Service Integration - GravityMon 1.2.0 documentation</title>
|
||||
<title>Service Integration - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Q & A" href="q_and_a.html" /><link rel="prev" title="Configuration" href="configuration.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Troubleshooting - GravityMon 1.2.0 documentation</title>
|
||||
<title>Troubleshooting - GravityMon v1.2.0</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon v1.2.0</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,10 +143,13 @@
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
||||
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon v1.2.0</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user