From 04a94ede5466792afdef3da416dff842f9c4253c Mon Sep 17 00:00:00 2001 From: Owen Date: Wed, 9 Mar 2022 12:27:37 +0100 Subject: [PATCH] [ci skip] Add link to common issues in discussions --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a2e8ce2..4077f76 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ But expanded with: * Over The Air firmware updates * Lots of minor fixes and tweaks, documentation etc. -And 'reduced' by removing the Face Recognition features +And 'reduced' by removing the Face Recognition features * **If you want to try the Face Recognition features** please use the [`3.x` maintenance branch](https://github.com/easytarget/esp32-cam-webserver/tree/3.x), which still recieves bugfixes, but is not receiving any further development. * They were a demo, only worked in low resolution modes, did not preserve the face database between power cycles, and were of little use in real-world applications. * There are other (specialised) sketches for the ESP-CAM that do use face recognitioni more effectively, if this is your thing :-) @@ -33,7 +33,7 @@ I have four [AI-THINKER ESP32-CAM](https://github.com/raphaelbs/esp32-cam-ai-thi https://github.com/raphaelbs/esp32-cam-ai-thinker * The AI thinker wiki can be quite informative, when run through an online translator and read sensibly: https://wiki.ai-thinker.com/esp32-cam -* Default pinouts are also included for WRover Kit, ESP Eye and M5Stack esp32 camera modules. +* Default pinouts are also included for WRover Kit, ESP Eye and M5Stack esp32 camera modules. I do not have any of these boards, so they are untested by me. Please [let me know](https://github.com/easytarget/esp32-cam-webserver/issues) if you find issues or have a board not [in the list](./camera_pins.h). ## Troubleshooting: @@ -48,7 +48,11 @@ The ESP itself is susceptible to the usual list of WiFi problems, not helped by A basic limitation of the sketch is that it can can only support one stream at a time. If you try to connect to a cam that is already streaming (or attempting to stream) you will get no response and, eventually, a timeout. The stream itself is a [MJPEG stream](https://en.wikipedia.org/wiki/Motion_JPEG), which relies on the client (the web browser) to hold the connection open and request each new frame in turn via javascript. This can cause errors when browsers run into Javascript or caching problem, fail to request new frames or refuse to close the connection. * You can check the `/dump` page of the cam to see if it currently reports the camera as streaming or not. -The existing [issues list](https://github.com/easytarget/esp32-cam-webserver/issues?q=is%3Aissue) on Github is a good place to start if you have a specific issue not covered above. +A lot of common issues with this sketch are discussed and covered in the discussion forums: + +https://github.com/easytarget/esp32-cam-webserver/discussions/categories/common-issues + +The existing [issues list](https://github.com/easytarget/esp32-cam-webserver/issues?q=is%3Aissue) on Github is a good place to start if you have a specific issue not covered above or in the forums. Note that I do not respond to any Private Messages (via github, hackaday, or wherever) for support. @@ -74,7 +78,7 @@ Is pretty simple, You just need jumper wires, no soldering really required, see Download the latest release of the sketch from https://github.com/easytarget/esp32-cam-webserver/releases/latest - You can get the latest stable development release by cloning / downloading the `master` branch of the repo. -This will give you an archive file with the Version number in it, eg.`esp32-cam-webserver-3.0.zip`. Tou need to unpack this into your Arduino sketch folder, and then you need to rename the folder you just extracted to remove the version number, eg.`esp32-cam-webserver-3.0` becomes `esp32-cam-webserver`. +This will give you an archive file with the Version number in it, eg.`esp32-cam-webserver-4.0.zip`. You need to unpack this into your Arduino sketch folder, and then you need to **rename the folder you extracted to remove the version number**, eg.`esp32-cam-webserver-4.0` becomes `esp32-cam-webserver`. Once you have done that you can open the sketch in the IDE by going to the `esp32-cam-webserver` sketch folder and selecting `esp32-cam-webserver.ino`. @@ -84,7 +88,7 @@ By default the sketch assumes you have an AI-THINKER board, it creates an Access To make a permanent config with your home wifi settings, different defaults or a different board; copy (or rename) the file `myconfig.sample.h` in the sketch folder to `myconfig.h` and edit that, all the usable defaults are in that file. Because this is your private copy of the config it will not get overwritten if you update the main sketch! -### Programming +### Programming Assuming you are using the latest Espressif Arduino core the `ESP32 Dev Module` board will appear in the ESP32 Arduino section of the boards list. Select this (do not use the `AI-THINKER` entry listed in the boiards menu, it is not OTA compatible, and will caus the module to crash and reboot rather than updating if you use it. ![IDE board config](Docs/ota-board-selection.png) @@ -107,7 +111,7 @@ Go to the URL given in the serial output, the web UI should appear with the sett The WiFi details can be stored in an (optional) header file to allow easier code development, and a camera name for the UI title can be configured. The lamp and status LED's are optional, and the lamp uses a exponential scale for brightness so that the control has some finess. -All of the face recognition code has been removed as of V4.0; this reduces the code size enough to allow OTA programming while improving compile and programming times. +All of the face recognition code has been removed as of V4.0; this reduces the code size enough to allow OTA programming while improving compile and programming times. The compressed and binary encoded HTML used in the example has been unpacked to raw text, this makes it much easier to access and modify the Javascript and UI elements. Given the relatively small size of the index page there is very little benefit from compressing it. @@ -141,15 +145,10 @@ Contributions are welcome; please see the [Contribution guidelines](CONTRIBUTING Time allowing; my Current plan is: -V4 -* Remove face recognition entirely; - * **Done**, see the `NoFace` branch :sunglasses: - * Not optional, this is a code and maintenance nightmare. V3 can be maintained on a branch for those who need it. +V4 * Investigate using SD card to capture images -* Implement OTA and a better network stack for remembering multiple AP's, auto-config etc. - * **Basic OTA is Done**, see the `NoFace` branch. +* Implement a better network stack for remembering multiple AP's, auto-config etc. * Advanced (web upload) OTA might be nice to have if possible - * For the Network setup I want to implement https://github.com/Hieromon/AutoConnect * UI Skinning/Theming * OSD * Temperature/humidity/pressure sensor support (bme20,dht11)