Update documentation

This commit is contained in:
GitHub Action 2022-05-15 08:05:53 +00:00
parent ae5ac9e0a5
commit fe0de4251d
7 changed files with 42 additions and 6 deletions

View File

@ -7,7 +7,7 @@ Welcome to GravityMon's documentation!
######################################
.. note::
This documentation reflects **v1.0**. Last updated 2022-05-08
This documentation reflects **v1.0**. Last updated 2022-05-15
* Docs for: `v0.8 <https://mp-se.github.io/gravitymon/v0.8/index.html>`_
* Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_

View File

@ -3,6 +3,13 @@
Releases
########
Updates
=======
Documentation
+++++++++++++
* Added documentation for Brewpiless as target
v1.0.0
======

View File

@ -264,3 +264,11 @@ starting with a ``?``. This string will be added to the URL above when doing the
.. code-block::
?token=${token2}&v1=${temp}&v2=${gravity}&v3=${angle}
Brewpiless
++++++++++
If you connect the device to the brewpiless access point there is not way to access the user interface for configuration so it's recommended to connect the device to your normal network.
The device need to have a name starting with iSpindle, for example `iSpindel000`. Set the URL for one of the http POST targets to `http://ip/gravity` where ip is the ip adress of Brewpiless.

View File

@ -207,7 +207,7 @@
<h1>Welcome to GravityMons documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline">#</a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-08</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-15</p>
</div>
<ul class="simple">
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.8/index.html">v0.8</a></p></li>
@ -323,6 +323,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#updates">Updates</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>
@ -373,6 +374,7 @@ the following libraries and without these this would have been much more difficu
<li class="toctree-l2"><a class="reference internal" href="services.html#brewspy">Brewspy</a></li>
<li class="toctree-l2"><a class="reference internal" href="services.html#thingspeak">Thingspeak</a></li>
<li class="toctree-l2"><a class="reference internal" href="services.html#blynk-io">Blynk.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="services.html#brewpiless">Brewpiless</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Configuration</a><ul>

View File

@ -205,11 +205,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-0-0">
<h2>v1.0.0<a class="headerlink" href="#v1-0-0" title="Permalink to this headline">#</a></h2>
<div class="section" id="updates">
<h2>Updates<a class="headerlink" href="#updates" title="Permalink to this headline">#</a></h2>
<div class="section" id="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">#</a></h3>
<ul class="simple">
<li><p>Added documentation for Brewpiless as target</p></li>
</ul>
</div>
</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="id2">
<h3>Documentation<a class="headerlink" href="#id2" 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>
<li><p>Documentation on brewfather has been updated to adress SG/Plato conversion</p></li>
@ -435,8 +444,12 @@ 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-0-0">v1.0.0</a><ul>
<li><a class="reference internal" href="#updates">Updates</a><ul>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li><a class="reference internal" href="#id2">Documentation</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li>

File diff suppressed because one or more lines are too long

View File

@ -396,6 +396,11 @@ starting with a <code class="docutils literal notranslate"><span class="pre">?</
</pre></div>
</div>
</div>
<div class="section" id="brewpiless">
<h2>Brewpiless<a class="headerlink" href="#brewpiless" title="Permalink to this headline">#</a></h2>
<p>If you connect the device to the brewpiless access point there is not way to access the user interface for configuration so its recommended to connect the device to your normal network.</p>
<p>The device need to have a name starting with iSpindle, for example <cite>iSpindel000</cite>. Set the URL for one of the http POST targets to <cite>http://ip/gravity</cite> where ip is the ip adress of Brewpiless.</p>
</div>
</div>
</article>
@ -464,6 +469,7 @@ starting with a <code class="docutils literal notranslate"><span class="pre">?</
<li><a class="reference internal" href="#brewspy">Brewspy</a></li>
<li><a class="reference internal" href="#thingspeak">Thingspeak</a></li>
<li><a class="reference internal" href="#blynk-io">Blynk.io</a></li>
<li><a class="reference internal" href="#brewpiless">Brewpiless</a></li>
</ul>
</li>
</ul>