Update documentation
This commit is contained in:
GitHub Action
@ -4,8 +4,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="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||||
<title>Functionallity - GravityMon 0.6.0 documentation</title>
|
||||
<meta name="generator" content="sphinx-4.4.0, furo 2022.01.02"/>
|
||||
<title>Functionallity - GravityMon 0.7.0 documentation</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/styles/furo-extensions.css?digest=fade93df149f7c5fedb3ff897f799dc7d283b420" />
|
||||
@ -122,7 +122,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">GravityMon 0.6.0 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">GravityMon 0.7.0 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -145,7 +145,7 @@
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">GravityMon 0.6.0 documentation</span>
|
||||
<span class="sidebar-brand-text">GravityMon 0.7.0 documentation</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">
|
||||
@ -160,6 +160,7 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Functionallity</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">Setting up device</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#format-editor">Format editor</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#create-formula">Create formula</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#rest-api">REST API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#data-formats">Data Formats</a></li>
|
||||
@ -195,27 +196,51 @@
|
||||
<article role="main">
|
||||
<div class="section" id="functionallity">
|
||||
<span id="id1"></span><h1>Functionallity<a class="headerlink" href="#functionallity" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="the-main-differences">
|
||||
<h2>The main differences<a class="headerlink" href="#the-main-differences" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="the-main-features">
|
||||
<h2>The main features<a class="headerlink" href="#the-main-features" title="Permalink to this headline">¶</a></h2>
|
||||
<ul>
|
||||
<li><p><strong>Operates in two modes gravity monitoring and configuration mode</strong></p>
|
||||
<p>In <code class="docutils literal notranslate"><span class="pre">gravity</span> <span class="pre">monitoring</span></code> mode it behaves just like the iSpindle, it wakes up at regular intervals, measures angle/tile, temperature, calculates gravity and pushes the data to defined endpoints.</p>
|
||||
<p>In <code class="docutils literal notranslate"><span class="pre">configuration</span> <span class="pre">mode</span></code> the device is always active and the webserver is active. Here you can view the angle/tilt values, change configuration options and more. When in this mode you can also interact with the device
|
||||
<p>In <code class="docutils literal notranslate"><span class="pre">gravity</span> <span class="pre">monitoring</span></code> mode it behaves just like the iSpindle, it wakes up at regular intervals, measures
|
||||
angle/tile, temperature, calculates gravity and pushes the data to defined endpoints.</p>
|
||||
<p>In <code class="docutils literal notranslate"><span class="pre">configuration</span> <span class="pre">mode</span></code> the device is always active and the webserver is active. Here you can view the
|
||||
angle/tilt values, change configuration options and more. When in this mode you can also interact with the device
|
||||
via an REST API so data can be pushed to the device via scripts (see API section for more information).</p>
|
||||
<p>You can force the device into <code class="docutils literal notranslate"><span class="pre">configuration</span> <span class="pre">mode</span></code> while measuring gravity. This is useful when calibrating the device so you don’t needs to wait for the device to wake up and push the data. The entire calibration
|
||||
<p>You can force the device into <code class="docutils literal notranslate"><span class="pre">configuration</span> <span class="pre">mode</span></code> while measuring gravity. This is useful when calibrating
|
||||
the device so you don’t needs to wait for the device to wake up and push the data. The entire calibration
|
||||
sequence can be handled via the web interface without need for additional software tools.</p>
|
||||
<p>See the <a class="reference internal" href="configuration.html#setting-up-device"><span class="std std-ref">Setting up device</span></a> section for more information on how to trigger the configuration mode.</p>
|
||||
</li>
|
||||
<li><p><strong>Can send data to multiple endpoints at once</strong></p>
|
||||
<p>The original iSpindle can only have one destination, this software will push data to all defined endpoints so in theory you can use them all. However this will consume a lot of battery power so use only as many as needed.</p>
|
||||
<p>Currently the device supports the following endpoints: http (2 different), influxdb2 and Brewfather</p>
|
||||
<p>The original iSpindle can only have one destination, this software will push data to all defined endpoints so
|
||||
in theory you can use them all. However this will consume more battery power so use only as many as needed.</p>
|
||||
<p>Currently the device supports the following endpoints: http (2 different), influxdb2, Brewfather and MQTT.</p>
|
||||
<p>If you want additional targets please raise a feature request in the github repo.</p>
|
||||
</li>
|
||||
<li><p><strong>Build in function to create gravity formulas, so no need for using other tools for this part</strong></p>
|
||||
<p>Another big difference is that this software can create the gravity formula in the device, just enter the angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p>
|
||||
<li><p><strong>Create gravity formulas on the device</strong></p>
|
||||
<p>Another big difference is that this software can create the gravity formula in the device, just enter the
|
||||
angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This feature needs more testing to be validated.</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><strong>Customize the data format beeing sent to push targets</strong></p>
|
||||
<p>In order to make it easier to support more targets there is a built in format editor that can be used to
|
||||
customize the data that is to be sent. This way you can easily adapt the software to new targets without coding.
|
||||
If you have a good template please share it on the girhub repository and I will add it to the documentation
|
||||
for other users to enjoy. See the <a class="reference internal" href="configuration.html#format-editor"><span class="std std-ref">Format editor</span></a> for more information.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This feature needs more testing to be validated.</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><strong>Automatic temperature adjustment of gravity reading</strong></p>
|
||||
<p>If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula.</p>
|
||||
<p>If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice
|
||||
feature that can correct the gravity as a second step making this independant of the formula.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="admonition note">
|
||||
@ -272,7 +297,12 @@ be 0.5-1.0C higher.</p>
|
||||
</div>
|
||||
<div class="section" id="battery-life">
|
||||
<h2>Battery life<a class="headerlink" href="#battery-life" title="Permalink to this headline">¶</a></h2>
|
||||
<p>I’m currently measuring battery life of v0.5 but previous versions have been able to measure gravity for a 2-3 weeks without issues (Using 900 seconds as interval).</p>
|
||||
<p>I’m currently measuring battery life of v0.5 but previous versions have been able to measure gravity for
|
||||
a 2-3 weeks without issues (Using 900 seconds as interval).</p>
|
||||
<p>I had a device running with an sleep interval of only 30s with ok wifi connection. The device lasted
|
||||
12 days which i think is excellent considering the short sleep interval. From what I have discovered
|
||||
it’s the WIFI connection that has the most impact on the battery life. In a perfect scenario it
|
||||
can take around 400ms but can in some cases take up to 8 seconds.</p>
|
||||
<p><em>More on this topics once my tests are done</em></p>
|
||||
</div>
|
||||
<div class="section" id="performance">
|
||||
@ -334,7 +364,7 @@ temperature would reduce the total runtime with 25%. Sending data over http take
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Functionallity</a><ul>
|
||||
<li><a class="reference internal" href="#the-main-differences">The main differences</a></li>
|
||||
<li><a class="reference internal" href="#the-main-features">The main features</a></li>
|
||||
<li><a class="reference internal" href="#other-features">Other features</a></li>
|
||||
<li><a class="reference internal" href="#experimental-features">Experimental features</a></li>
|
||||
<li><a class="reference internal" href="#battery-life">Battery life</a></li>
|
||||
|
||||
Reference in New Issue
Block a user