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-01-13 20:17:28 +00:00
parent 1ef3e9172d
commit 88fe078cce
4 changed files with 55 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/_sources/configuration.rst.txt
View File

@ -99,19 +99,19 @@ Push Settings
* **HTTP URL 1:**
Endpoint to send data via http. Format used is standard iSpindle format (see format section).
Endpoint to send data via http. Format used Format used :ref:`data-formats-ispindle`
* **HTTP URL 2:**
Endpoint to send data via http. Format used is standard iSpindle format (see format section).
Endpoint to send data via http. Format used :ref:`data-formats-ispindle`
* **Brewfather URL:**
Endpoint to send data via http to brewfather. Format used is defined by brewfather (see format section).
Endpoint to send data via http to brewfather. Format used :ref:`data-formats-brewfather`
* **Influx DB v2 URL:**
Endpoint to send data via http to InfluxDB. For format (see format section).
Endpoint to send data via http to InfluxDB. Format used :ref:`data-formats-influxdb2`
* **Influx DB v2 Organisation:**
@ -127,7 +127,7 @@ Push Settings
* **MQTT server:**
IP or name of server to send data to.
IP or name of server to send data to. Format used :ref:`data-formats-ispindle`
* **MQTT Topic:**
@ -151,7 +151,8 @@ Gravity Settings
* **Gravity formula:**
Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. Is updated if the calibration function is used.
Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. You can also use
the feature to create the formula by supplying the raw data. See :ref:`create-formula`
* **Temperature correct gravity:**
@ -253,6 +254,10 @@ Other parameters are the same as in the configuration guide.
"influxdb2-org": "Qwerty",
"influxdb2-bucket": "Qwerty",
"influxdb2-auth": "Qwerty",
"mqtt-push": "192.168.1.50",
"mqtt-topic": "Qwerty",
"mqtt-user": "Qwerty",
"mqtt-pass": "Qwerty",
"sleep-interval": 30,
"voltage-factor": 1.59,
"gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436",
@ -373,6 +378,10 @@ Used to update push settings via an HTTP POST command. Payload is in JSON format
"influxdb2-org": "Qwerty",
"influxdb2-bucket": "Qwerty",
"influxdb2-auth": "Qwerty"
"mqtt-push": "192.168.1.50",
"mqtt-topic": "Qwerty",
"mqtt-user": "Qwerty",
"mqtt-pass": "Qwerty",
}
@ -480,7 +489,11 @@ present or the API call will fail.
"influxdb2-push": "",
"influxdb2-org": "",
"influxdb2-bucket": "",
"influxdb2-auth": ""
"influxdb2-auth": "",
"mqtt-push": "192.168.1.50",
"mqtt-topic": "Qwerty",
"mqtt-user": "Qwerty",
"mqtt-pass": "Qwerty"
}
set_config( url, json )
@ -521,6 +534,8 @@ present or the API call will fail.
Data Formats
############
.. _data-formats-ispindle:
iSpindle format
===============
@ -547,6 +562,8 @@ This is the format used for standard http posts.
}
.. _data-formats-brewfather:
Brewfather format
=================
@ -564,6 +581,8 @@ This is the format for Brewfather
}
.. _data-formats-influxdb2:
Influx DB v2
============

35
docs/configuration.html
View File

@ -282,22 +282,22 @@ you are collecting angle/tilt for calibration. If this is unchecked the device w
<ul>
<li><p><strong>HTTP URL 1:</strong></p>
<blockquote>
<div><p>Endpoint to send data via http. Format used is standard iSpindle format (see format section).</p>
<div><p>Endpoint to send data via http. Format used Format used <a class="reference internal" href="#data-formats-ispindle"><span class="std std-ref">iSpindle format</span></a></p>
</div></blockquote>
</li>
<li><p><strong>HTTP URL 2:</strong></p>
<blockquote>
<div><p>Endpoint to send data via http. Format used is standard iSpindle format (see format section).</p>
<div><p>Endpoint to send data via http. Format used <a class="reference internal" href="#data-formats-ispindle"><span class="std std-ref">iSpindle format</span></a></p>
</div></blockquote>
</li>
<li><p><strong>Brewfather URL:</strong></p>
<blockquote>
<div><p>Endpoint to send data via http to brewfather. Format used is defined by brewfather (see format section).</p>
<div><p>Endpoint to send data via http to brewfather. Format used <a class="reference internal" href="#data-formats-brewfather"><span class="std std-ref">Brewfather format</span></a></p>
</div></blockquote>
</li>
<li><p><strong>Influx DB v2 URL:</strong></p>
<blockquote>
<div><p>Endpoint to send data via http to InfluxDB. For format (see format section).</p>
<div><p>Endpoint to send data via http to InfluxDB. Format used <a class="reference internal" href="#data-formats-influxdb2"><span class="std std-ref">Influx DB v2</span></a></p>
</div></blockquote>
</li>
<li><p><strong>Influx DB v2 Organisation:</strong></p>
@ -317,7 +317,7 @@ you are collecting angle/tilt for calibration. If this is unchecked the device w
</li>
<li><p><strong>MQTT server:</strong></p>
<blockquote>
<div><p>IP or name of server to send data to.</p>
<div><p>IP or name of server to send data to. Format used <a class="reference internal" href="#data-formats-ispindle"><span class="std std-ref">iSpindle format</span></a></p>
</div></blockquote>
</li>
<li><p><strong>MQTT Topic:</strong></p>
@ -343,7 +343,8 @@ you are collecting angle/tilt for calibration. If this is unchecked the device w
<ul>
<li><p><strong>Gravity formula:</strong></p>
<blockquote>
<div><p>Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. Is updated if the calibration function is used.</p>
<div><p>Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. You can also use
the feature to create the formula by supplying the raw data. See <a class="reference internal" href="#create-formula"><span class="std std-ref">Create formula</span></a></p>
</div></blockquote>
</li>
<li><p><strong>Temperature correct gravity:</strong></p>
@ -430,6 +431,10 @@ code the update will be done during startup.</p>
<span class="w"> </span><span class="nt">"influxdb2-org"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"influxdb2-bucket"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"influxdb2-auth"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-push"</span><span class="p">:</span><span class="w"> </span><span class="s2">"192.168.1.50"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-user"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-pass"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"sleep-interval"</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"voltage-factor"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.59</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity-formula"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436"</span><span class="p">,</span><span class="w"></span>
@ -536,7 +541,11 @@ code the update will be done during startup.</p>
<span class="w"> </span><span class="nt">"influxdb2-push"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.1.50:8086"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"influxdb2-org"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"influxdb2-bucket"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"influxdb2-auth"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="w"></span>
<span class="w"> </span><span class="nt">"influxdb2-auth"</span><span class="p">:</span><span class="w"> </span><span class="nt">"Qwerty"</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-push"</span><span class="p">:</span><span class="w"> </span><span class="s2">"192.168.1.50"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-user"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"mqtt-pass"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
@ -636,7 +645,11 @@ present or the API call will fail.</p>
<span class="s2">"influxdb2-push"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"influxdb2-org"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"influxdb2-bucket"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"influxdb2-auth"</span><span class="p">:</span> <span class="s2">""</span>
<span class="s2">"influxdb2-auth"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"mqtt-push"</span><span class="p">:</span> <span class="s2">"192.168.1.50"</span><span class="p">,</span>
<span class="s2">"mqtt-topic"</span><span class="p">:</span> <span class="s2">"Qwerty"</span><span class="p">,</span>
<span class="s2">"mqtt-user"</span><span class="p">:</span> <span class="s2">"Qwerty"</span><span class="p">,</span>
<span class="s2">"mqtt-pass"</span><span class="p">:</span> <span class="s2">"Qwerty"</span>
<span class="p">}</span>
<span class="n">set_config</span><span class="p">(</span> <span class="n">url</span><span class="p">,</span> <span class="n">json</span> <span class="p">)</span>
@ -677,7 +690,7 @@ present or the API call will fail.</p>
<div class="section" id="data-formats">
<span id="id4"></span><h1>Data Formats<a class="headerlink" href="#data-formats" title="Permalink to this headline"></a></h1>
<div class="section" id="ispindle-format">
<h2>iSpindle format<a class="headerlink" href="#ispindle-format" title="Permalink to this headline"></a></h2>
<span id="data-formats-ispindle"></span><h2>iSpindle format<a class="headerlink" href="#ispindle-format" title="Permalink to this headline"></a></h2>
<p>This is the format used for standard http posts.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">corr-gravity</span></code> is an extended parameter containing a temperature corrected gravity reading.</p></li>
@ -701,7 +714,7 @@ present or the API call will fail.</p>
</div>
</div>
<div class="section" id="brewfather-format">
<h2>Brewfather format<a class="headerlink" href="#brewfather-format" title="Permalink to this headline"></a></h2>
<span id="data-formats-brewfather"></span><h2>Brewfather format<a class="headerlink" href="#brewfather-format" title="Permalink to this headline"></a></h2>
<p>This is the format for Brewfather</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"gravmon"</span><span class="p">,</span><span class="w"></span>
@ -715,7 +728,7 @@ present or the API call will fail.</p>
</div>
</div>
<div class="section" id="influx-db-v2">
<h2>Influx DB v2<a class="headerlink" href="#influx-db-v2" title="Permalink to this headline"></a></h2>
<span id="data-formats-influxdb2"></span><h2>Influx DB v2<a class="headerlink" href="#influx-db-v2" title="Permalink to this headline"></a></h2>
<p>This is the format for InfluxDB v2</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">measurement</span><span class="p">,</span><span class="n">host</span><span class="o">=&lt;</span><span class="n">mdns</span><span class="o">&gt;</span><span class="p">,</span><span class="n">device</span><span class="o">=&lt;</span><span class="nb">id</span><span class="o">&gt;</span><span class="p">,</span><span class="n">temp</span><span class="o">-</span><span class="nb">format</span><span class="o">=&lt;</span><span class="n">C</span><span class="o">|</span><span class="n">F</span><span class="o">&gt;</span><span class="p">,</span><span class="n">gravity</span><span class="o">-</span><span class="nb">format</span><span class="o">=</span><span class="n">SG</span><span class="p">,</span><span class="n">gravity</span><span class="o">=</span><span class="mf">1.0004</span><span class="p">,</span><span class="n">corr</span><span class="o">-</span><span class="n">gravity</span><span class="o">=</span><span class="mf">1.0004</span><span class="p">,</span><span class="n">angle</span><span class="o">=</span><span class="mf">45.45</span><span class="p">,</span><span class="n">temp</span><span class="o">=</span><span class="mf">20.1</span><span class="p">,</span><span class="n">battery</span><span class="o">=</span><span class="mf">3.96</span><span class="p">,</span><span class="n">rssi</span><span class="o">=-</span><span class="mi">18</span>
</pre></div>

9
docs/objects.inv
View File

@ -2,8 +2,7 @@
# Project: GravityMon
# Version:
# The remainder of this file is compressed using zlib.
xÚŤSËNĂ0Ľű+Ś@Ü‚Ä•[y
‰JĄEâXmťMbáŘ!Ţză7ř=ľ7ÎĂn‹č-™ť™ťµ˝+oĘäÜRz•Á“KľňĐEAĄâ×]Ýd\ s´L<C2B4>˛’JęH4€^v3p¨@nMFPă(MśôpëŁ`…jßéôěo/ťÉĽ©<C4BD>¤Ńq” ŕă,<2C>hkĐT<ŵ­šjąjhoŽďG&jÂ$3uŮ(Ř ľŰwľđNŔR hŐ@öő­Łó{OgYŁĹ¶JIÚ„ˇăŠŹ}a‡ÄCër×{Ç G-uŠź±´G}ĎÇí'i]Ľ€ńŠĘÝ/r2üˇ†µ3žýóőmąă6%jjç?q&–\ç˝Ë ńľé<C4BE>0ĺîV‹ťŐ‚űÁž<‡upč2^iŇ“W›¤/xúÔ¤ŤÂî ‚ę?˛Ů†
7b¤~_‚N—&ë Żyćç|ÂjTmHë1Ď›w1uČ‘ÝÁtK Tň<54>:ż[ĽđÉě‘Y„Z±Âcý
¶őäč¸í:&M•řu<˘Ńţ
˙?ëł–
x<EFBFBD><EFBFBD>Tֻn<EFBFBD>0¼כ+X4ט<34><05>cnq׃ְ‰ פ¬ָ•D”"U’rג[~£¿׳/)MךAֺ.×›4;3;»$X<02>)uM¬ד7\3B?‘2B׳J²ך÷"¬U£-˜n;!…ֺDe<>'<27>k<EFBFBD>X]¹08K©‡י %ֺs§קW<D7A7>צR•¨{Nh•GI
1־<1E>;פבx,¨<>eן־ז˜סq”)˜ApH+m<>^ֲ2ר²ן)|<10>APppװאל
ץ<EFBFBD>§“<EFBFBD>Hֿ´´4רR<EFBFBD>_ˆYa³™ֹQ<EFBFBD>{ Uֹ‏•—׳+¬¶<C2AC>Kמ6הp½p±<70>P\ג
±¨C<C2A8>×WלT)…;¦ַ‘Wג<57><D792>g״%סװ‎‚<E2808E>·_װ¨||ֽ¥#{nO<6E>ֵLג%<25>(‎ֽEג4שjאא<D790>´תףצ<D7A3>ֿם[T.¬א<C2AC>7±־w>»¶)>6<>‘Bת[«״b»´8צ-r<>N<>Sזִk5¿0yw₪c!ׂ4ן‎aֵ$ױ<>ָvG׳ר3ץ¯gP<67>ׂd5<>ה¹- J‹6¥<36>Xה= 9uֺ’‘‎b÷u:±ג’>}<7D>'·»ma krEִֶַ%װwP£ח†‡†צ<1D>ֽ<>Fח<46>׃_ִt*

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long