Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
GitHub Action 2022-07-02 07:53:25 +00:00
parent fa7e8c0ce7
commit fbdb365db7
5 changed files with 29 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/_sources/index.rst.txt
View File

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

18
docs/_sources/services.rst.txt
View File

@ -280,11 +280,13 @@ BrewBlox
To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template
for this target. for this target.
This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic name and after the first `:` this is the json playload. This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic
name and after the first `:` this is the json playload. Text within the brackets will be used as the unit for the value and degC is displayed as °C. You can add other parameters under the data section
in the json document if you need other values as well.
.. code-block:: .. code-block::
brewcast/history:{"key":"${mdns}","data":{"Temperature": ${temp-c},"Battery":${battery},"Tilt":${angle},"Rssi":${rssi},"Gravity":${gravity-sg}}}| brewcast/history:{"key":"${mdns}","data":{"Temperature[degC]": ${temp-c},"Temperature[degF]": ${temp-f},"Battery[V]":${battery},"Tilt[deg]":${angle},"Rssi[dBm]":${rssi},"SG":${gravity-sg},"Plato":${gravity-plato}}}|
The json message on the mqtt topic would look like this: The json message on the mqtt topic would look like this:
@ -294,10 +296,12 @@ The json message on the mqtt topic would look like this:
{ {
"key": "gravitymon", "key": "gravitymon",
"data": { "data": {
"Temperature": 27, "Temperature[degC]": 27,
"Battery": 4.99, "Temperature[degF]": 80,
"Tilt": 88.86, "Battery[V]": 4.1,
"Rssi": -51, "Tilt[deg]": 25,
"Gravity": 1.1173 "Rssi[dBm]": -78,
"SG": 1,
"Plato": 0
} }
} }

2
docs/index.html
View File

@ -201,7 +201,7 @@
<h1>Welcome to GravityMon’s documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline"></a></h1> <h1>Welcome to GravityMon’s documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-07-01</p> <p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-07-02</p>
</div> </div>
<ul class="simple"> <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> <li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.8/index.html">v0.8</a></p></li>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

22
docs/services.html
View File

@ -399,19 +399,23 @@ starting with a <code class="docutils literal notranslate"><span class="pre">?</
<h2>BrewBlox<a class="headerlink" href="#brewblox" title="Permalink to this headline"></a></h2> <h2>BrewBlox<a class="headerlink" href="#brewblox" title="Permalink to this headline"></a></h2>
<p>To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template <p>To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template
for this target.</p> for this target.</p>
<p>This format template will post the expected json document on the topic, dont forget the <cite>|</cite> character at the end of the line which is needed to parse the payload. The first to words are the topic name and after the first <cite>:</cite> this is the json playload.</p> <p>This format template will post the expected json document on the topic, dont forget the <cite>|</cite> character at the end of the line which is needed to parse the payload. The first to words are the topic
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>brewcast/history:{"key":"${mdns}","data":{"Temperature": ${temp-c},"Battery":${battery},"Tilt":${angle},"Rssi":${rssi},"Gravity":${gravity-sg}}}| name and after the first <cite>:</cite> this is the json playload. Text within the brackets will be used as the unit for the value and degC is displayed as °C. You can add other parameters under the data section
in the json document if you need other values as well.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>brewcast/history:{"key":"${mdns}","data":{"Temperature[degC]": ${temp-c},"Temperature[degF]": ${temp-f},"Battery[V]":${battery},"Tilt[deg]":${angle},"Rssi[dBm]":${rssi},"SG":${gravity-sg},"Plato":${gravity-plato}}}|
</pre></div> </pre></div>
</div> </div>
<p>The json message on the mqtt topic would look like this:</p> <p>The json message on the mqtt topic would look like this:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span> <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gravitymon"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gravitymon"</span><span class="p">,</span><span class="w"></span>
<span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"Temperature"</span><span class="p">:</span><span class="w"> </span><span class="mi">27</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"Temperature[degC]"</span><span class="p">:</span><span class="w"> </span><span class="mi">27</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"Battery"</span><span class="p">:</span><span class="w"> </span><span class="mf">4.99</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"Temperature[degF]"</span><span class="p">:</span><span class="w"> </span><span class="mi">80</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"Tilt"</span><span class="p">:</span><span class="w"> </span><span class="mf">88.86</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"Battery[V]"</span><span class="p">:</span><span class="w"> </span><span class="mf">4.1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"Rssi"</span><span class="p">:</span><span class="w"> </span><span class="mi">-51</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"Tilt[deg]"</span><span class="p">:</span><span class="w"> </span><span class="mi">25</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"Gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.1173</span><span class="w"></span> <span class="w"> </span><span class="nt">"Rssi[dBm]"</span><span class="p">:</span><span class="w"> </span><span class="mi">-78</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"SG"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"Plato"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"></span>
<span class="w"> </span><span class="p">}</span><span class="w"></span> <span class="w"> </span><span class="p">}</span><span class="w"></span>
<span class="p">}</span><span class="w"></span> <span class="p">}</span><span class="w"></span>
</pre></div> </pre></div>