diff --git a/README.md b/README.md index 88b71fc..d44ebd2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@  Simple [RTSP](https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol) server. -Easy configuration through the web interface. Stable. +Easy configuration through the web interface. Flashing this software on a esp32cam module will make it a **RTSP streaming camera** server. This allows CCTV systems and applications like **VLC** to connect directly to the ESP32CAM camera stream. @@ -24,6 +24,7 @@ This software provides a **configuration web server**, that can be used to: - Select the board type, - Select the image size, - Select the frame rate, +- Select number of frame buffers - Select the JPEG quality The software provides contains also a mDNS server to be easily discoverable on the local network. @@ -80,17 +81,15 @@ There are to flavours to do this; using the command line or the graphical interf ### Using the command line -First the source code and SPIFF partition (data) has to be compiled. Type: +First the source code has to be compiled. Type: ``` pio run -pio run buildfs ``` -When finished, the SPIFF partition and software have to be uploaded. +When finished, firmware has to be uploaded. Make sure the ESP32-CAM is in download mode (see previous section) and type: ``` pio run -t upload - pio run -t uploadfs ``` When done remove the jumper when using a FTDI adapter or press the reset button on the ESP32-CAM. @@ -101,11 +100,9 @@ To monitor the output, start a terminal using: ### Using Visual studio -Open the project in a new window. Run the following tasks using the ```Terminal -> Run Task``` or CTRL+ALT+T command in the menu. Make sure the ESP32-CAM is in download mode during the uploads. +Open the project in a new window. Run the following tasks using the ```Terminal -> Run Task``` or CTRL+ALT+T command in the menu (or use the icons below on the toolbar). Make sure the ESP32-CAM is in download mode during the uploads. -- PlatformIO: Build Filesystem Image (esp32cam) - PlatformIO: Build (esp32cam) -- PlatformIO: Upload Filesystem Image (esp32cam) - PlatformIO: Upload (esp32cam) To monitor the behavior run the task, run: @@ -113,7 +110,7 @@ To monitor the behavior run the task, run: ## Setting up the ESP32CAM-RTSP After the programming of the ESP32, there is no configuration present. This needs to be added. -To connect initially to the device open the WiFi connections and select the WiFi network / accesspoint called **ESP32CAM-RTSP**. +To connect initially to the device open the WiFi connections and select the WiFi network / access point called **ESP32CAM-RTSP**. Initially there is no password present. After connecting, the browser should automatically open the status page. @@ -151,6 +148,14 @@ This link can be opened with for example [VLC](https://www.videolan.org/vlc/). :warning: **Please be aware that there is no password present on the stream!** +## Issues observed + +### Power +Make sure the power is 5 volts and stable. + +### PSRAM +Some esp32cam modules have additional ram on the board. This allows to use this ram as frame buffer. + ## Credits esp32cam-ready depends on PlatformIO, Bootstap5 and Micro-RTSP by Kevin Hester. diff --git a/data/index.html b/data/index.html deleted file mode 100644 index 8fc65f5..0000000 --- a/data/index.html +++ /dev/null @@ -1,82 +0,0 @@ - - - -
- - - -The configuration has been changed. It is recommended to restart the device
-This can be done by pressing the restart button below
- -CPU model: {{ChipModel}}
-CPU speed: {{CpuFreqMHz}}Mhz
-Mac address: {{MacAddress}}
-IPv4 address: {{IpV4}}
-IPv6 address: {{IpV6}}
- -Camera type: {{CameraType}}
-Frame size: {{FrameSize}}
-Frame rate: {{FrameDuration}} ms ({{FrameFrequency}} f/s)
-JPEG quality: {{JpegQuality}} (0-100)
- {{#CameraInitialized}} -Uptime: {{Uptime}}
-Free heap: {{FreeHeap}}b
-Max free block: {{MaxAllocHeap}}b
-The configuration has been changed.
+It is recommended to restart the device.
+ +Not connected to an access point. Please configure!
+Connected to the access point
+Camera was initialized successfully!
+Failed to initialize the camera!
+Result: {{CameraInitResultText}} ({{CameraInitResult}})
+Please check hardware or correct the camera settings and restart.
+The device is currently restarting. Please stand by...
+The device is restarting.
In some cases, the device requires a hard reset (power cycle).
The configuration has been changed.
It is recommended to restart the device.
Not connected to an access point. Please configure!
Connected to the access point
Camera was initialized successfully!
Failed to initialize the camera!
Result: {{CameraInitResultText}} ({{CameraInitResult}})
Please check hardware or correct the camera settings and restart.
The device is restarting.
In some cases, the device requires a hard reset (power cycle).