Update documentation
This commit is contained in:
@ -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
|
||||
============
|
||||
|
||||
|
@ -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">=<</span><span class="n">mdns</span><span class="o">></span><span class="p">,</span><span class="n">device</span><span class="o">=<</span><span class="nb">id</span><span class="o">></span><span class="p">,</span><span class="n">temp</span><span class="o">-</span><span class="nb">format</span><span class="o">=<</span><span class="n">C</span><span class="o">|</span><span class="n">F</span><span class="o">></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>
|
||||
|
@ -2,8 +2,7 @@
|
||||
# Project: GravityMon
|
||||
# Version:
|
||||
# The remainder of this file is compressed using zlib.
|
||||
xڍS<EFBFBD>N<EFBFBD>0<10><>+<EFBFBD>@܂ĕ[y
|
||||
<EFBFBD>J<EFBFBD>E<EFBFBD>Xm<EFBFBD>Mb<EFBFBD><EFBFBD>!<21>z<>7<EFBFBD>=<3D>7<><37>n<EFBFBD><6E>-<2D><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>+o<><6F><EFBFBD>Rz<52><1A><>K<EFBFBD><4B><EFBFBD>EA<45><41><EFBFBD>]<5D>d\<14>s<EFBFBD>L<EFBFBD><4C><EFBFBD>J<EFBFBD>H4<48>^v3p<33>@nMFP<>(M<1C><>p<EFBFBD><70>`<60>j<EFBFBD><6A><EFBFBD><EFBFBD>o/<2F>ɼ<EFBFBD><C9BC><EFBFBD><EFBFBD>q<EFBFBD><71><EFBFBD><EFBFBD>,<2C>hk<68>T<ŵ<14><>j<EFBFBD>jho<68><11>G&j<04>$3u<33>(<EFBFBD>
|
||||
<EFBFBD><EFBFBD>w<1B><15>N<EFBFBD>R h<>@<40><08><><EFBFBD><EFBFBD>{OgY<67>ŶJIڄ<49>㊏}a<><61>C<EFBFBD>r<>{<7B> G-u<><75><EFBFBD><EFBFBD>G}<7D><><EFBFBD>'i]<5D><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>/r2<72><32><EFBFBD><EFBFBD>3<EFBFBD><1A><><EFBFBD>m<EFBFBD><6D>6%jj<6A>?q&<26>\<5C><><EFBFBD>
|
||||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD>0<EFBFBD><EFBFBD>V<EFBFBD><EFBFBD>Ղ<16><><EFBFBD><<3C>up<75>2^i<><03>W<EFBFBD><57>/x<>Ԥ<EFBFBD><D4A4><EFBFBD><0C><>?<3F>ن
|
||||
7b<EFBFBD>~_<>N<EFBFBD>&<26> <20>y<EFBFBD><79>|<7C>jTmH<6D>1ϛw1u<31><12><><EFBFBD>tK T<><54>:<3A>[<5B><><EFBFBD><EFBFBD><EFBFBD>Y<EFBFBD>Z<14><>c<EFBFBD>
|
||||
xڍT<EFBFBD>n<EFBFBD>0<10><>+X4<EFBFBD><EFBFBD><05>cnq<6E><1A><><0B><18>ȕD<C895>"U<>r<EFBFBD>[~<7E><><EFBFBD>/)M<>A<EFBFBD>.<2E><>4;3;<3B>$X<02>)uM<75><4D>7\3B?<3F>2B<1B>J<EFBFBD><19><>"<22>U<>-<2D>n;!<21><>De<>'<27>k<EFBFBD>X]<5D>08K<38><4B><EFBFBD> %<25>s<EFBFBD><73>W<EFBFBD><57>R<EFBFBD><52>{Nh<4E>GI
|
||||
1<EFBFBD><1E>;<19><1D>x,<2C><>e<><65><EFBFBD><EFBFBD><EFBFBD>q<EFBFBD>)<29>ApH+m<>^<5E>2<EFBFBD><32><EFBFBD>)|<10>APpp<10><><EFBFBD>
|
||||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Hϴ<EFBFBD>4<EFBFBD>R<EFBFBD>_<EFBFBD>Ya<EFBFBD><EFBFBD><EFBFBD>Q<EFBFBD>{ U<><55><EFBFBD><EFBFBD><EFBFBD>+<2B><><EFBFBD>K<EFBFBD>6<EFBFBD>p<EFBFBD>p<EFBFBD><70>P\<EFBFBD>
|
||||
<13><1F>C<EFBFBD><43>W<EFBFBD>T)<29>;<3B>ǑW<C791><57><EFBFBD>g<EFBFBD>%<25><><EFBFBD><EFBFBD>ܷ_Ԩ||ͥ#{nO<6E><4F>L<1B>%<25>(<28><>E<EFBFBD>4<EFBFBD>j<EFBFBD><6A><EFBFBD><1F><><EFBFBD><EFBFBD><EFBFBD><12><>[T.<2E><><EFBFBD>7<EFBFBD><37>w><3E><>)>6<><36>B<EFBFBD>[<5B><>b<EFBFBD><01>8<0E>-r<>N<>S<EFBFBD><53>k5<6B>0yw<79>c!<21>4<><34>a<EFBFBD>$<24><><EFBFBD>vG<76><47>3<><33>gP<67><19>d5<><35><03>-J<04>6<EFBFBD><36>X<EFBFBD>=
|
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user