Deployed 30a7f82 with MkDocs version: 1.6.1

Demo-Mode/index.html

@@ -465,16 +465,16 @@
 </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#recording">1.2 
+<a class="md-nav__link" href="#collecting-images-of-your-device">1.2 
 <span class="md-ellipsis">
-      Recording
+      Collecting images of your device
     </span>
 </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#installation">1.3 
+<a class="md-nav__link" href="#use-prepared-images">1.3 
 <span class="md-ellipsis">
-      Installation
+      Use prepared images
     </span>
 </a>
 </li>
@@ -736,16 +736,16 @@
 </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#recording">1.2 
+<a class="md-nav__link" href="#collecting-images-of-your-device">1.2 
 <span class="md-ellipsis">
-      Recording
+      Collecting images of your device
     </span>
 </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#installation">1.3 
+<a class="md-nav__link" href="#use-prepared-images">1.3 
 <span class="md-ellipsis">
-      Installation
+      Use prepared images
     </span>
 </a>
 </li>
@@ -803,7 +803,7 @@
 <div class="md-content" data-md-component="content">
 <article class="md-content__inner md-typeset">
 <h1 id="demo-mode"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Demo Mode</h1>
-<p>For Demo and Testing Purpose, the device can use pre-recorded images.</p>
+<p>For Demo and Testing Purpose, the device can use pre-recorded raw images.</p>
 <p>You need to enable it in the configuration (<code>TakeImage &gt; Demo</code>) and also provide the needed files on the SD card.</p>
 <p>For each round one image gets used, starting with the first image for the first round.</p>
 <p>For the reference image and the alignment also the first image gets used.</p>
@@ -825,39 +825,43 @@
 </code></pre></div>
 </li>
 </ul>
-<h2 id="recording"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Recording</h2>
-<p>To record real images of a meter, you have to periodically fetch <code>http://&lt;IP&gt;/img_tmp/raw.jpg</code>.</p>
-<p>To automate this, you can use the following shell script (Linux only):
-<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a href="#__codelineno-1-1" id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="ch">#!/bin/bash</span>
-</span><span id="__span-1-2"><a href="#__codelineno-1-2" id="__codelineno-1-2" name="__codelineno-1-2"></a>
-</span><span id="__span-1-3"><a href="#__codelineno-1-3" id="__codelineno-1-3" name="__codelineno-1-3"></a><span class="k">while</span><span class="w"> </span><span class="o">[[</span><span class="w"> </span><span class="nb">true</span><span class="w"> </span><span class="o">]]</span><span class="p">;</span><span class="w"> </span><span class="k">do</span>
-</span><span id="__span-1-4"><a href="#__codelineno-1-4" id="__codelineno-1-4" name="__codelineno-1-4"></a><span class="w">    </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"fetching value..."</span>
-</span><span id="__span-1-5"><a href="#__codelineno-1-5" id="__codelineno-1-5" name="__codelineno-1-5"></a><span class="w">    </span>wget<span class="w"> </span>-q<span class="w"> </span>http://192.168.1.151/value<span class="w"> </span>-O<span class="w"> </span>value.txt
-</span><span id="__span-1-6"><a href="#__codelineno-1-6" id="__codelineno-1-6" name="__codelineno-1-6"></a>
-</span><span id="__span-1-7"><a href="#__codelineno-1-7" id="__codelineno-1-7" name="__codelineno-1-7"></a><span class="w">    </span><span class="nv">value</span><span class="o">=</span><span class="sb">`</span>cat<span class="w"> </span>value.txt<span class="sb">`</span>
-</span><span id="__span-1-8"><a href="#__codelineno-1-8" id="__codelineno-1-8" name="__codelineno-1-8"></a><span class="w">    </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Value: </span><span class="nv">$value</span><span class="s2">"</span>
-</span><span id="__span-1-9"><a href="#__codelineno-1-9" id="__codelineno-1-9" name="__codelineno-1-9"></a>
-</span><span id="__span-1-10"><a href="#__codelineno-1-10" id="__codelineno-1-10" name="__codelineno-1-10"></a><span class="w">    </span><span class="nv">diff</span><span class="o">=</span><span class="sb">`</span>diff<span class="w"> </span>value.txt<span class="w"> </span>value_previous.txt<span class="sb">`</span>
-</span><span id="__span-1-11"><a href="#__codelineno-1-11" id="__codelineno-1-11" name="__codelineno-1-11"></a><span class="w">    </span><span class="nv">changed</span><span class="o">=</span><span class="nv">$?</span>
-</span><span id="__span-1-12"><a href="#__codelineno-1-12" id="__codelineno-1-12" name="__codelineno-1-12"></a><span class="w">    </span><span class="c1">#echo "Diff: $diff"</span>
-</span><span id="__span-1-13"><a href="#__codelineno-1-13" id="__codelineno-1-13" name="__codelineno-1-13"></a>
-</span><span id="__span-1-14"><a href="#__codelineno-1-14" id="__codelineno-1-14" name="__codelineno-1-14"></a><span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="o">[[</span><span class="w"> </span><span class="nv">$changed</span><span class="w"> </span>-ne<span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="o">]]</span><span class="p">;</span><span class="w"> </span><span class="k">then</span>
-</span><span id="__span-1-15"><a href="#__codelineno-1-15" id="__codelineno-1-15" name="__codelineno-1-15"></a><span class="w">        </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Value changed:"</span>
-</span><span id="__span-1-16"><a href="#__codelineno-1-16" id="__codelineno-1-16" name="__codelineno-1-16"></a><span class="w">        </span><span class="nb">echo</span><span class="w"> </span><span class="nv">$diff</span>
-</span><span id="__span-1-17"><a href="#__codelineno-1-17" id="__codelineno-1-17" name="__codelineno-1-17"></a><span class="w">        </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"fetching image..."</span>
-</span><span id="__span-1-18"><a href="#__codelineno-1-18" id="__codelineno-1-18" name="__codelineno-1-18"></a><span class="w">        </span>wget<span class="w"> </span>-q<span class="w"> </span>http://192.168.1.151/img_tmp/raw.jpg<span class="w"> </span>-O<span class="w"> </span><span class="nv">$value</span>.jpg
-</span><span id="__span-1-19"><a href="#__codelineno-1-19" id="__codelineno-1-19" name="__codelineno-1-19"></a><span class="w">    </span><span class="k">else</span>
-</span><span id="__span-1-20"><a href="#__codelineno-1-20" id="__codelineno-1-20" name="__codelineno-1-20"></a><span class="w">        </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Value did not change, skipping image fetching!"</span>
-</span><span id="__span-1-21"><a href="#__codelineno-1-21" id="__codelineno-1-21" name="__codelineno-1-21"></a><span class="w">    </span><span class="k">fi</span>
-</span><span id="__span-1-22"><a href="#__codelineno-1-22" id="__codelineno-1-22" name="__codelineno-1-22"></a>
-</span><span id="__span-1-23"><a href="#__codelineno-1-23" id="__codelineno-1-23" name="__codelineno-1-23"></a><span class="w">    </span>cp<span class="w"> </span>value.txt<span class="w"> </span>value_previous.txt
-</span><span id="__span-1-24"><a href="#__codelineno-1-24" id="__codelineno-1-24" name="__codelineno-1-24"></a>
-</span><span id="__span-1-25"><a href="#__codelineno-1-25" id="__codelineno-1-25" name="__codelineno-1-25"></a><span class="w">    </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"waiting 60s..."</span>
-</span><span id="__span-1-26"><a href="#__codelineno-1-26" id="__codelineno-1-26" name="__codelineno-1-26"></a><span class="w">    </span>sleep<span class="w"> </span><span class="m">60</span>
-</span><span id="__span-1-27"><a href="#__codelineno-1-27" id="__codelineno-1-27" name="__codelineno-1-27"></a><span class="k">done</span>
-</span></code></pre></div></p>
-<h2 id="installation"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3</span> Installation</h2>
-<p>Just install the zip file using the OTA Update functionality.</p>
+<h2 id="collecting-images-of-your-device"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Collecting images of your device</h2>
+<p>There are several ways to collect images from your device:
+1. Use the <code>RawImagesLocation</code> parameter to store them directly onto your SD card, see <a href="Parameters/#parameter-rawimageslocation">Parameter <code>RawImagesLocation</code></a>
+1. Use the Webhook to send the raw image on each round to a dedicated server, see <a href="Webhook">Webhook</a> resp. <a href="Parameters/#parameter-uploadimg">Parameter <code>UploadImg</code></a>.
+1. Another option is to pull the images periodically from <code>http://&lt;IP&gt;/img_tmp/raw.jpg</code>. Eg. with an external service. Below is a (Linux)-Bash script to do it:</p>
+<div class="language-text highlight"><pre><span></span><code>    ```bash
+    #!/bin/bash
+
+    while [[ true ]]; do
+        echo "fetching value..."
+        wget -q http://192.168.1.151/value -O value.txt
+
+        value=`cat value.txt`
+        echo "Value: $value"
+
+        diff=`diff value.txt value_previous.txt`
+        changed=$?
+        #echo "Diff: $diff"
+
+        if [[ $changed -ne 0 ]]; then
+            echo "Value changed:"
+            echo $diff
+            echo "fetching image..."
+            wget -q http://192.168.1.151/img_tmp/raw.jpg -O $value.jpg
+        else
+            echo "Value did not change, skipping image fetching!"
+        fi
+
+        cp value.txt value_previous.txt
+
+        echo "waiting 60s..."
+        sleep 60
+    done
+    ```
+</code></pre></div>
+<h2 id="use-prepared-images"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3</span> Use prepared images</h2>
+<p>See the selection below with prepared images.</p>
 <h2 id="how-does-it-work"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4</span> How does it work</h2>
 <p>The Demo Mode tries to interfere as less as possible with the normal behavior. Whenever a Cam framebuffer gets taken (<code>esp_camera_fb_get()</code>), it replaces the framebuffer with the image from the SD card.</p>
 <h2 id="example-data-of-a-water-meter"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5</span> Example Data of a Water Meter</h2>