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-10 13:36:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

fixed formating

Browse Source
This commit is contained in:
CaCO3
2023-09-16 23:14:50 +02:00
parent cf78e98fab
commit 0287bfbd84
6 changed files with 42 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Influx-DB.md
View File

@@ -1,4 +1,5 @@
# Influx DB
The device also supports direct sending of data to an Influx DB.
:bangbang: Only Influx DB 1 is supported!
!!! Warning
Only Influx DB 1 is supported!

26
docs/Installation.md
View File

@@ -23,7 +23,8 @@ For first time flashing the firmware a USB -> UART connector is needed. Later fi
### Power supply
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.
**:bangbang: Attention:** in several internet forums there are problems reported, in case the ESP32-CAM is only supplied with 3.3V.
!!! Warning
In several internet forums there are problems reported, in case the ESP32-CAM is only supplied with 3.3V.
### Housing
A small 3D-printable example for a very small case can be found in Thingiverse here: [https://www.thingiverse.com/thing:4571627](https://www.thingiverse.com/thing:4571627)
@@ -31,7 +32,8 @@ A small 3D-printable example for a very small case can be found in Thingiverse h
![](img/main.jpg){: style="width:200px"}
![](img/size.png){: style="width:200px"}
**:bangbang: Attention**: the focus of the OV2640 needs to be adjusted, as it is normally set from ~40cm to infinity. In order to get an image that is big enough, it needs to be changed to about 10cm. Therefore the sealing glue on the objective ring needs to be removed with a scalpel or sharp knife. Afterwards the objective can be rotated clockwise until the image is sharp again.
!!! Warning
The focus of the OV2640 needs to be adjusted, as it is normally set from ~40cm to infinity. In order to get an image that is big enough, it needs to be changed to about 10cm. Therefore the sealing glue on the objective ring needs to be removed with a scalpel or sharp knife. Afterwards the objective can be rotated clockwise until the image is sharp again.
![](img/focus_adjustment.jpg){: style="width:200px"}
@@ -75,7 +77,8 @@ Get the [Flash Download Tool](https://www.espressif.com/en/support/download/othe
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.
:bangbang: **Attention**: 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.
!!! Warning
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.
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:
@@ -133,7 +136,8 @@ This initial setup needs only to be done **once** as further updates (Firmware a
- Set the corresponding SSID and password
- The other parameters are optional
**Note:** 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 `wlan.ini` file is excluded from this and is hidden from external access to protect the password.
!!! Note
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 `wlan.ini` file is excluded from this and is hidden from external access to protect the password.
After this, you can insert the SD card into the ESP32 board and start it.
@@ -163,12 +167,12 @@ If not, the ESP32 switches to a special mode. In this mode, it provides a Wifi A
Enter your SSID and password.
**Note:** Only basic settings are supported. If you need advanced configuration (fixed ip, ...), you need to use the manual setup as documented above.
!!! Note
Only basic settings are supported. If you need advanced configuration (fixed ip, ...), you need to use the manual setup as documented above.
**:bangbang: Attention:**
- Carefully check your wifi settings. To change them later on, you need to take out the SD card and edit the `wlan.ini` manually (or delete it and start again).
- The information is transferred without encryption!
!!! Warning
- Carefully check your wifi settings. To change them later on, you need to take out the SD card and edit the `wlan.ini` manually (or delete it and start again).
- The information is transferred without encryption!
Finish the step by pushing `Write wlan.ini`
@@ -179,8 +183,8 @@ If not, the ESP32 switches to a special mode. In this mode, it provides a Wifi A
![](img/setup-reboot.png)
**:bangbang: Warning:**
It will take up to 3 minutes. Afterwards you can find your device in the local network. Check your router for the IP. You can find it also in the USB Console output.
!!! Warning
It will take up to 3 minutes. Afterwards you can find your device in the local network. Check your router for the IP. You can find it also in the USB Console output.

3
docs/Integration-Home-Assistant.md
View File

@@ -8,9 +8,6 @@ There are 3 ways to get the data into your Home Assistant:
The first one is the easier way if you already have MQTT in use.
## Using MQTT (Automatically Setup Entities using Home Assistant MQTT Discovery)
:bangbang: This feature will be available with the next release!
Starting with Version `>12.0.1`, AI-on-the-edge-devices support Home Assistant Discovery.
1. Check [here](https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery) to learn more about it and how to enable it in Homeassistant.

22
docs/MQTT-API.md
View File

@@ -63,7 +63,9 @@ Depending on device configuration (`Settings` --> `Configuration` --> section `G
#### ctrl/flow_start
Trigger a flow start by publishing to this topic.
+ Payload:
__Payload:__
- any character, length > 0
#### ctrl/set_prevalue
@@ -72,14 +74,16 @@ Trigger a flow start by publishing to this topic.
This feature is available since version [15.2.0](https://github.com/jomjol/AI-on-the-edge-device/releases/tag/v15.2.0).
Set the last valid value (previous value) to given value or the actual RAW value. Payload needs to be provided in JSON notation.
+ Payload:
- Set to given value (value >= 0): `{"numbersname": "main", "value": 12345.67890}`
* `"numbersname":`Provide name of number sequence, e.g. `"main"`
* `"value":` provide the value to be set
- Set to actual RAW value (value < 0, a valid RAW value is mandatory): `{"numbersname": "main", "value": -1}`
* `"numbersname":` Provide name of number sequence, e.g. `"main"`
* `"value":` Provide any negative number
__Payload:__
- Set to given value (value >= 0): `{"numbersname": "<NUMBERSNAME>", "value": <VALUE>}`
* `"numbersname":`Provide name of number sequence, e.g. `"main"`
* `"value":` provide the value to be set, eg. `12345.67890`
- Set to actual RAW value (value < 0, a valid RAW value is mandatory): `{"numbersname": "<NUMBERSNAME>", "value": -1}`
* `"numbersname":` Provide name of number sequence, e.g. `"main"`
* `"value":` Provide any negative number
#### GPIO/GPIO{PinNumber}
Depending on device configuration (`Settings` --> `Configuration` --> section `GPIO`)

20
docs/Neural-Network-Types.md
View File

@@ -23,14 +23,13 @@ There are two **types of neural networks**:
No setting of the type in the firmware is necessary. The type can detect by the output structure automatically.
**:bangbang: Attention:**
* It is very important to choose the right network type (digits or analog pointers).
Technically a wrong network will work and create output, but that would be totally arbitrary
* Not all type of pointers are trained in all networks.
* For the 11 classes digits network there many different types of digits trained. The reason is, that you 1) only need 20-30 training images and 2) the data collection is ongoing much longer
* For the continuous and 100 classes network especially for the digits, there are only a few types of digits trained up to now
* Therefore sometimes for the digits it is more effective to choose the simpler 11 classes network type (= default).
!!! Warning
* It is very important to choose the right network type (digits or analog pointers).
Technically a wrong network will work and create output, but that would be totally arbitrary
* Not all type of pointers are trained in all networks.
* For the 11 classes digits network there many different types of digits trained. The reason is, that you 1) only need 20-30 training images and 2) the data collection is ongoing much longer
* For the continuous and 100 classes network especially for the digits, there are only a few types of digits trained up to now
* Therefore sometimes for the digits it is more effective to choose the simpler 11 classes network type (= default).
## Naming convention
@@ -109,8 +108,6 @@ The digit type is a classical classification network, with 11 classes representi
| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| ![](img/dig-class11/examp-dig1.jpg) | ![](img/dig-class11/examp-dig2.jpg) | ![](img/dig-class11/examp-dig3.jpg) | ![](img/dig-class11/examp-dig4.jpg) | ![](img/dig-class11/examp-dig13.jpg) | ![](img/dig-class11/examp-dig12.jpg) | ![](img/dig-class11/examp-dig9.jpg) |
| ![](img/dig-class11/examp-dig5.jpg) | ![](img/dig-class11/examp-dig6.jpg) | ![](img/dig-class11/examp-dig7.jpg) | ![](img/dig-class11/examp-dig8.jpg) | ![](img/dig-class11/examp-dig11.jpg) | ![](img/dig-class11/examp-dig10.jpg) | |
| | | | | | | |
#### Training data needs
@@ -142,8 +139,7 @@ This type of network tries to overcome the problem, that there are intermediate
| | | | |
| ---------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ---- |
| [[img/dig-cont/dig-cont_1.jpg) | [[img/dig-cont/dig-cont_2a.jpg) [[img/dig-cont/dig-cont_2b.jpg) | [[img/dig-cont/dig-cont_3a.jpg) [[img/dig-cont/dig-cont_3b.jpg) [[img/dig-cont/dig-cont_3c.jpg) | |
| | | | |
| ![](img/dig-cont/dig-cont_1.jpg) | ![](img/dig-cont/dig-cont_2a.jpg) ![](img/dig-cont/dig-cont_2b.jpg) | ![](img/dig-cont/dig-cont_3a.jpg) ![](img/dig-cont/dig-cont_3b.jpg) ![](img/dig-cont/dig-cont_3c.jpg) | |

6
docs/ota.md
View File

@@ -23,7 +23,8 @@ Go to the menu `System --> OTA Update` and follow the instructions there. After
### Update from version older than `v12.0.0`
If you update from an version older than 12.0.1, you should firstly update to version 12.0.1. Background are not fully backward compatible changes in the `config.ini`, that are taken care of in this version.
:bangbang: **Make sure to read the instructions below carefully!**
!!! Warning
Make sure to read the instructions below carefully!
1. Backup your configuration (use the `System -> Backup/Restore` page)!
@@ -41,7 +42,8 @@ If you update from an version older than 12.0.1, you should firstly update to ve
7. Make sure it starts to do the digitalization (check the Error field on the overview page). If it does not start a round within a minute, restart the device.
:bangbang: **If the system is working now without any issues, please open the configuration editor once and save the `config.ini`. This will update the file to the newest content**:bangbang:
!!! note
If the system is working now without any issues, please open the configuration editor once and save the `config.ini`. This will update the file to the newest content.
Now you can safely update to the newest version.