Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-07 20:16:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 7c38213 with MkDocs version: 1.4.2

Browse Source
This commit is contained in:
github-actions[bot]
2023-02-03 19:36:11 +00:00
parent 87dc03453b
commit 5b63831461
41 changed files with 272 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
Installation/index.html
View File

@@ -77,11 +77,11 @@
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#3-sd-card">3. SD-Card</a>
<li class="toctree-l2"><a class="reference internal" href="#3-sd-card">3. SD Card</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#manual-setup-with-a-sd-card-reader-on-a-pc">Manual Setup with a SD-Card-Reader on a PC</a>
<li class="toctree-l3"><a class="reference internal" href="#manual-setup-with-an-sd-card-reader-on-a-pc">Manual Setup with an SD Card Reader on a PC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#remote-setup-using-the-built-in-access-point">Remote Setup using the built-in Access Point</a>
</li>
@@ -134,7 +134,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../Configuration/">Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Watermeters</a>
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Water Meters</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../collect-new-images/">Collect images to improve the models</a>
</li>
@@ -182,12 +182,12 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../outdated--Integrated-Functions/">Integrated Functions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../outdated--Gasmeter-Log-Downloader/">Gasmeter Log-Downloader</a>
<li class="toctree-l1"><a class="reference internal" href="../outdated--Gasmeter-Log-Downloader/">Gas Meter Log Downloader</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../outdated--Migrate-Old-Config-To-New-Config/">Migration from water-meter „old“ to water-meter “AI-on-the-edge-device”</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Asorted Pages</span></p>
<p class="caption"><span class="caption-text">Assorted Pages</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Graphical-Configuration/">Graphical Configuration</a>
</li>
@@ -222,7 +222,7 @@
<ol>
<li>Get the right hardware and wire it up</li>
<li>Flash the firmware onto the ESP32</li>
<li>Write the data to the SD-Card</li>
<li>Write the data to the SD card</li>
<li>Start it</li>
</ol>
<p>For point 2 and 3 we provide multiple ways to do it. Pick the one that looks the easiest for you!</p>
@@ -230,15 +230,15 @@
<h3 id="esp32-cam">ESP32-CAM</h3>
<ul>
<li>OV2640 camera module</li>
<li>Micro SD-Card slot </li>
<li>Micro SD card slot </li>
<li>4 or 8 MB PSRAM. </li>
</ul>
<p>It can be easily found on the typical internet stores, searching for ESP32-CAM for less than 10 EUR.
How ever since the hardware is cheap and coming from China, you unluckily could pick a malfunction device. See <a href="../Hardware-Compatibility">Hardware Compatibility</a> for further advice! </p>
How ever since the hardware is cheap and coming from China, you unluckily could pick a malfunctioning device. See <a href="../Hardware-Compatibility">Hardware Compatibility</a> for further advice! </p>
<h3 id="usb-uart-interface">USB-&gt;UART interface</h3>
<p>For first time flashing the firmware a USB -&gt; UART connector is needed. Later firmware upgrades than can be flashed via OTA.</p>
<h3 id="power-supply">Power supply</h3>
<p>For power supply a 5V source is needed. Most easily this can be done via an USB power supply. The power supply should support minimum 500mA. For buffering current peaks some users reported to use a large elco condensator like a 2200uF between ground and VCC.</p>
<p>For power supply a 5V source is needed. Most easily this can be done via a USB power supply. The power supply should support minimum 500mA. For buffering current peaks some users reported to use a large electrolytic capacitor like a 2200uF between ground and VCC.</p>
<p><strong>‼️ Attention:</strong> in several internet forums there are problems reported, in case the ESP32-CAM is only supplied with 3.3V.</p>
<h3 id="housing">Housing</h3>
<p>A small 3D-printable example for a very small case can be found in Thingiverse here: <a href="https://www.thingiverse.com/thing:4571627">https://www.thingiverse.com/thing:4571627</a></p>
@@ -251,7 +251,7 @@ How ever since the hardware is cheap and coming from China, you unluckily could
<p>A example for wiring can be found here:</p>
<p><img alt="" src="../img/wiring.png" /></p>
<p><img alt="" src="../img/progammer_manual.jpg" /></p>
<p>It is also possible to use external LEDs for the illumination instead of the internal flash LED. This is described here: [[External-LED]]</p>
<p>It is also possible to use external LEDs for the illumination instead of the internal flash LED. This is described <a href="../External-LED">here</a></p>
<h2 id="2-firmware">2. Firmware</h2>
<h3 id="web-installer">Web Installer</h3>
<p>There is a Web Installer available which will work right out of the web browser Edge and Chrome.
@@ -263,7 +263,7 @@ You can access it with the following link: <a href="https://jomjol.github.io/AI-
<p>Grab the firmware from the</p>
<ul>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases page</a> (Stable, tested versions), or the</li>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling">Automatically build development branch</a> (experimental, untested versions). Please have a look on <a href="../rolling-installation">Living on the Edge</a>] first!</li>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling">Automatically build development branch</a> (experimental, untested versions). Please have a look on <a href="../rolling-installation">Living on the Edge</a> first!</li>
</ul>
<p>You need:</p>
<ul>
@@ -274,7 +274,7 @@ You can access it with the following link: <a href="https://jomjol.github.io/AI-
<h4 id="flashing-using-the-flash-tool-from-espressif-gui">Flashing using the Flash Tool from Espressif (GUI)</h4>
<p>Get the <a href="https://www.espressif.com/en/support/download/other-tools">Flash Download Tool</a> from Espressif.</p>
<p>Download and extract the Flash tool, after starting choose "Developer Mode", then "ESP32-DownloadTool" and you are in the setup of the flashing tool. Connect the ESP32-CAM with the USB-UART connection and identify the COM-Port. </p>
<p>‼️ <strong>Attention</strong>: if you reflashing the code again, it is strongly recommended to erase the flash memory before flashing the firmware. Especially if you used OTA in between, which might cause remaining information on the flash, to still boot from an old image in the OTA-area, which is not erased by a normal flash.</p>
<p>‼️ <strong>Attention</strong>: if you are re-flashing the code again, it is strongly recommended to erase the flash memory before flashing the firmware. Especially if you used OTA in between, which might cause remaining information on the flash, to still boot from an old image in the OTA-area, which is not erased by a normal flash.</p>
<p>But your ESP32 in bootloader mode and push start, then it will identify the board and you can configure the bin-configuration according to the following table:</p>
<table>
<thead>
@@ -304,45 +304,45 @@ You can access it with the following link: <a href="https://jomjol.github.io/AI-
Here you need to install the esptool:</p>
<pre><code>pip install esptool
</code></pre>
<p>Then connect the ESP32 with the USB-UART connector to the system, put it in bootmode and with the following command you can erase the flash and flash bootloader, partitions and firmware in two steps:</p>
<p>Then connect the ESP32 with the USB-UART connector to the system, put it in boot mode and with the following command you can erase the flash and flash bootloader, partitions and firmware in two steps:</p>
<pre><code>esptool erase_flash
esptool write_flash 0x01000 bootloader.bin 0x08000 partitions.bin 0x10000 firmware.bin
</code></pre>
<ul>
<li>Maybe you need to specify the COM-port if it is not detected by default.</li>
<li>If the erase command throws the error <code>A fatal error occurred: ESP32 ROM does not support function erase_flash.</code>, your <code>esptool</code> might be too old, see https://techoverflow.net/2022/02/08/how-to-fix-esp32-a-fatal-error-occurred-esp32-rom-does-not-support-function-erase_flash/</li>
<li>If the erase command throws the error <code>A fatal error occurred: ESP32 ROM does not support function erase_flash.</code>, your <code>esptool</code> might be too old, see <a href="https://techoverflow.net/2022/02/08/how-to-fix-esp32-a-fatal-error-occurred-esp32-rom-does-not-support-function-erase_flash/">https://techoverflow.net/2022/02/08/how-to-fix-esp32-a-fatal-error-occurred-esp32-rom-does-not-support-function-erase_flash/</a></li>
</ul>
<p>With some Python installations this may not work and you’ll receive an error, try <code>python -m pip install esptool</code> or <code>pip3 install esptool</code></p>
<p>Further recommendations can be found on the <a href="https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html">espressif webpage</a></p>
<h2 id="3-sd-card">3. SD-Card</h2>
<p>The software expects a SD-Card prepared with certain directory and file structure in order to work properly.
SD-Card most top directory should look like this:</p>
<p>With some Python installations this may not work and you’ll receive an error, try <code>python -m pip install esptool</code> or <code>pip3 install esptool</code>.</p>
<p>Further recommendations can be found on the <a href="https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html">espressif webpage</a>.</p>
<h2 id="3-sd-card">3. SD Card</h2>
<p>The software expects an SD card prepared with certain directory and file structure in order to work properly.
SD card most top directory should look like this:</p>
<p><img alt="" src="../sd-card-content.png" /> </p>
<p>This initial setup needs only to be done <strong>once</strong> as further updates (Firmware as well as SD-Card content) are possible with the <a href="../ota/">Over-The-Air Update</a> mechanism.</p>
<p>This initial setup needs only to be done <strong>once</strong> as further updates (Firmware as well as SD card content) are possible with the <a href="../ota/">Over-The-Air Update</a> mechanism.</p>
<h4 id="notes">Notes</h4>
<ul>
<li>Due to the limited availability of GPIOs (OV2640, Flash-Light, PSRAM &amp; SD-Card) the communication mode to the SD card is limited to 1-line SD-Mode. It showed up, that this results in problems with very large SD-Cards (64GB, sometimes 32 GB) and some no name low cost SD-cards.</li>
<li>Due to the limited availability of GPIOs (OV2640, Flash-Light, PSRAM &amp; SD card) the communication mode to the SD card is limited to 1-line SD-Mode. It showed up, that this results in problems with very large SD-Cards (64GB, sometimes 32 GB) and some no name low cost SD-cards.</li>
<li>There must be no partition table on the SD-card (no GPT, but only MBR for the single partition)</li>
<li>Following setting are necessary for formating the SD-card: <strong>SINGLE PARTITION, MBR, FAT32 - 32K. NOT exFAT</strong></li>
<li>Following setting are necessary for formatting the SD-card: <strong>SINGLE PARTITION, MBR, FAT32 - 32K. NOT exFAT</strong></li>
<li>Some ESP32 devices share their SD-card and/or camera GPIOs with the pins for TX and RX. If you see errors like “Failed to connect” then your chip is probably not entering the bootloader properly. Remove the respective modules temporarily to free the GPIOs for flashing. You may find more information about troubleshooting on the <a href="https://docs.espressif.com/projects/esptool/en/latest/esp8266/troubleshooting.html">homepage of Espressif</a>.</li>
</ul>
<p><strong>The ESP32 indicates problems with the SD card during startup with a fast, endless blinking.</strong>
<strong>In this case, please try another SD card.</strong> </p>
<h3 id="manual-setup-with-a-sd-card-reader-on-a-pc">Manual Setup with a SD-Card-Reader on a PC</h3>
<h3 id="manual-setup-with-an-sd-card-reader-on-a-pc">Manual Setup with an SD Card Reader on a PC</h3>
<ol>
<li>Take the <code>AI-on-the-edge-device__manual-setup__*.zip</code> from the <a href="https://github.com/jomjol/AI-on-the-edge-device/releases">Release</a> page.</li>
<li>Open it and extract the <code>sd-card.zip</code>.</li>
<li>Open it and extract all files onto onto your SD-Card.</li>
<li>On the SD-Card, open the <code>wlan.ini</code> file and configure it as needed:<ul>
<li>Open it and extract all files onto onto your SD card.</li>
<li>On the SD card, open the <code>wlan.ini</code> file and configure it as needed:<ul>
<li>Set the corresponding SSID and password</li>
<li>The other parameters are optional</li>
</ul>
</li>
</ol>
<p><strong>Note:</strong> The device provides a File Server which can be used to show, edit or delete the files on the SD-Card. For security reasons, the <code>wlan.ini</code> file is excluded from this and is hidden from external access to protect the password.</p>
<p>After this, you can insert the SD-Card into the ESP32 board and start it.</p>
<p><strong>Note:</strong> The device provides a File Server which can be used to show, edit or delete the files on the SD card. For security reasons, the <code>wlan.ini</code> file is excluded from this and is hidden from external access to protect the password.</p>
<p>After this, you can insert the SD card into the ESP32 board and start it.</p>
<h3 id="remote-setup-using-the-built-in-access-point">Remote Setup using the built-in Access Point</h3>
<p>On startup of the ESP32, it checks if the <code>wlan.ini</code> or the <code>config/config.ini</code> are available on the SD-Card.
<p>On startup of the ESP32, it checks if the <code>wlan.ini</code> or the <code>config/config.ini</code> are available on the SD card.
If not, the ESP32 switches to a special mode. In this mode, it provides a Wifi Access Point which can be used to add the missing <code>wlan.ini</code> or the <code>config/config.ini</code> file.</p>
<ol>
<li>Take the <code>AI-on-the-edge-device__remote-setup__*.zip</code> from the <a href="https://github.com/jomjol/AI-on-the-edge-device/releases">Release</a> page.</li>
@@ -352,21 +352,21 @@ If not, the ESP32 switches to a special mode. In this mode, it provides a Wifi A
<p>The device has the following fixed IP: <a href="http://192.168.4.1">http://192.168.4.1</a>.</p>
</li>
<li>
<p>Upload initial configuration to sd-card</p>
<p>Upload initial configuration to SD card</p>
<p><img alt="" src="../img/setup-config.png" /></p>
<p>Use the <code>select file</code> and <code>upload</code> button to start the upload.
A warning will show up if you have choosen a possible wrong file (without default configuration).</p>
A warning will show up if you have chosen a possible wrong file (without default configuration).</p>
</li>
<li>
<p>Store WLAN acces information.</p>
<p>Store WLAN access information.</p>
<p>After the upload, a new page will be shown:</p>
<p><img alt="" src="../img/setup-wlan.png" /></p>
<p>Enter your SSID and password.</p>
<p><strong>Note:</strong> Only basic settings are supported. If you need advanced configuration (fixed ip, ...), you need to use the manual setup as documented above.</p>
<p><strong>‼️ Attention:</strong></p>
<ul>
<li>Carefully check your wifi settings. To change them later on, you need to take out the sd-card and edit the <code>wlan.ini</code> manually (or delete it and start again).</li>
<li>The informations are transfered without encryption!</li>
<li>Carefully check your wifi settings. To change them later on, you need to take out the SD card and edit the <code>wlan.ini</code> manually (or delete it and start again).</li>
<li>The information is transferred without encryption!</li>
</ul>
<p>Finish the step by pushing <code>Write wlan.ini</code></p>
</li>
@@ -379,7 +379,7 @@ It will take up to 3 minutes. Afterwards you can find your device in the local n
</li>
</ol>
<h2 id="4-initial-startup">4. Initial Startup</h2>
<p>After the firmware is flashed and the SD-Card is setup properly, you can start it.
<p>After the firmware is flashed and the SD card is setup properly, you can start it.
After power on the connection status is indicated by 3x blinking of the red on board LED.</p>
<p>WLAN-Status indication:</p>
<ul>