Styled the markdown after linting

This commit is contained in:
Rene Zeldenthuis
2022-10-16 21:42:27 +02:00
parent 09ffba96d7
commit bb617221a3

View File

@@ -11,6 +11,7 @@ It is also possible to to stream directly to a server using [ffmpeg](https://ffm
This makes the module a camera server allowing recording and the stream can be stored on a disk and replayed later. This makes the module a camera server allowing recording and the stream can be stored on a disk and replayed later.
This software supports the following ESP32-CAM (and alike) modules: This software supports the following ESP32-CAM (and alike) modules:
- ESP32CAM - ESP32CAM
- AI THINKER - AI THINKER
- TTGO T-CAM - TTGO T-CAM
@@ -20,6 +21,7 @@ This software supports the following ESP32-CAM (and alike) modules:
![ESP32CAM module](assets/ESP32-CAM.jpg) ![ESP32CAM module](assets/ESP32-CAM.jpg)
This software provides a **configuration web server**, that can be used to: This software provides a **configuration web server**, that can be used to:
- Provide information about the state of the device, wifi connection and camera, - Provide information about the state of the device, wifi connection and camera,
- Set the WiFi parameters, - Set the WiFi parameters,
- Set the timeout for connecting to the access point, - Set the timeout for connecting to the access point,
@@ -40,29 +42,35 @@ It advertises HTTP (port 80) and RTSP (port 554)
- [**PlatformIO**](https://platformio.org/) software (free download) - [**PlatformIO**](https://platformio.org/) software (free download)
## Installing and running PlatformIO ## Installing and running PlatformIO
PlatformIO is available for all major operating systems: Windows, Linux and MacOS. It is also provided as a plugin to [Visual Studio Code](https://visualstudio.microsoft.com). PlatformIO is available for all major operating systems: Windows, Linux and MacOS. It is also provided as a plugin to [Visual Studio Code](https://visualstudio.microsoft.com).
More information can be found at: [https://docs.platformio.org/en/latest/installation.html](https://docs.platformio.org/en/latest/installation.html) below the basics. More information can be found at: [https://docs.platformio.org/en/latest/installation.html](https://docs.platformio.org/en/latest/installation.html) below the basics.
### Debian based systems command-line install ### Debian based systems command-line install
Install platformIO Install platformIO
```
```sh
sudo apt-get install python-pip sudo apt-get install python-pip
sudo pip install platformio sudo pip install platformio
pio upgrade pio upgrade
``` ```
### Windows, Linux and MacOS ### Windows, Linux and MacOS
Install [**Visual Studio code**](https://code.visualstudio.com) and install the PlatformIO plugin. Install [**Visual Studio code**](https://code.visualstudio.com) and install the PlatformIO plugin.
For command line usage Python and PlatformIO-Core is sufficient. For command line usage Python and PlatformIO-Core is sufficient.
## Putting the ESP32-CAM in download mode ## Putting the ESP32-CAM in download mode
### ESP32-CAM-MB ### ESP32-CAM-MB
When using the ESP32-CAM-MB board, press and hold the GP0 button on the ESP32-CAM-MB board. When using the ESP32-CAM-MB board, press and hold the GP0 button on the ESP32-CAM-MB board.
Then press short the reset button (on the inside) on the ESP32-CAM board and release the GP0 button. Then press short the reset button (on the inside) on the ESP32-CAM board and release the GP0 button.
This will put the ESP32-CAM board in download mode. This will put the ESP32-CAM board in download mode.
### FTDI adapter ### FTDI adapter
When using an FTDI adapter, make sure the adapter is set to 3.3 volt before connecting. Use the wiring schema below. When using an FTDI adapter, make sure the adapter is set to 3.3 volt before connecting. Use the wiring schema below.
![ESP FTDI wiring](assets/ESP32CAM-to-FTDI.png) ![ESP FTDI wiring](assets/ESP32CAM-to-FTDI.png)
@@ -73,11 +81,13 @@ After programming remove the wire to tge GPIO0 pin to exit the download mode.
Open a command line or terminal window and clone this repository from GitHub. Open a command line or terminal window and clone this repository from GitHub.
``` ```sh
git clone https://github.com/rzeldent/esp32cam-rtsp.git git clone https://github.com/rzeldent/esp32cam-rtsp.git
``` ```
go into the folder go into the folder
```
```sh
cd esp32cam-rtsp cd esp32cam-rtsp
``` ```
@@ -88,19 +98,22 @@ I recommend to use VIsual Studio Code as it is free to use and offers more insig
### Using the command line ### Using the command line
First the source code has to be compiled. Type: First the source code has to be compiled. Type:
```
```sh
pio run pio run
``` ```
When finished, firmware has to be uploaded. When finished, firmware has to be uploaded.
Make sure the ESP32-CAM is in download mode (see previous section) and type: Make sure the ESP32-CAM is in download mode (see previous section) and type:
```
```sh
pio run -t upload pio run -t upload
``` ```
When done remove the jumper when using a FTDI adapter or press the reset button on the ESP32-CAM. When done remove the jumper when using a FTDI adapter or press the reset button on the ESP32-CAM.
To monitor the output, start a terminal using: To monitor the output, start a terminal using:
```
```sh
pio device monitor pio device monitor
``` ```
@@ -111,10 +124,10 @@ Open the project in a new window. Run the following tasks using the ```Terminal
- PlatformIO: Build (esp32cam) - PlatformIO: Build (esp32cam)
- PlatformIO: Upload (esp32cam) - PlatformIO: Upload (esp32cam)
To monitor the behavior run the task, run: To monitor the behavior run the task, run: ```PlatformIO: Monitor (esp32cam)```
- PlatformIO: Monitor (esp32cam)
## Setting up the ESP32CAM-RTSP ## Setting up the ESP32CAM-RTSP
After the programming of the ESP32, there is no configuration present. This needs to be added. 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 / access point 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. Initially there is no password present.
@@ -128,6 +141,7 @@ This link brings up the configuration screen when connecting fot the first time.
![Configuration screen](assets/Configuration.png) ![Configuration screen](assets/Configuration.png)
Configure at least: Configure at least:
- The access point to connect to. No dropdown is present to show available networks! - The access point to connect to. No dropdown is present to show available networks!
- A password for accessing the Access point (AP) when starting. (required) - A password for accessing the Access point (AP) when starting. (required)
- Type of the ESP32-CAM board - Type of the ESP32-CAM board
@@ -137,6 +151,7 @@ Here it is possible to reboot the device so the settings take effect.
It is also possible to restart manually by pressing the reset button. It is also possible to restart manually by pressing the reset button.
## Connecting to the configuration ## Connecting to the configuration
After the initial configuration and the device is connected to an access point, the device can be configured over http. After the initial configuration and the device is connected to an access point, the device can be configured over http.
When a connection is made to [http://esp32cam-rtsp](http://esp32cam-rtsp) the status screen is shown. When a connection is made to [http://esp32cam-rtsp](http://esp32cam-rtsp) the status screen is shown.
@@ -149,12 +164,14 @@ Clicking on the ```change configuration``` button will open the configuration. I
If this happens, for the user enter 'admin' and for the password the value that has been configured as the Access Point password. If this happens, for the user enter 'admin' and for the password the value that has been configured as the Access Point password.
## Connecting to the RTSP stream ## Connecting to the RTSP stream
RTSP stream is available at: [rtsp://esp32cam-rtsp.local:554/mjpeg/1](rtsp://esp32cam-rtsp.local:554/mjpeg/1). RTSP stream is available at: [rtsp://esp32cam-rtsp.local:554/mjpeg/1](rtsp://esp32cam-rtsp.local:554/mjpeg/1).
This link can be opened with for example [VLC](https://www.videolan.org/vlc/). 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!** :warning: **Please be aware that there is no password present on the stream!**
## Issues / Nice to know ## Issues / Nice to know
- The red LED on the back of the device indicates the device is not connected. - The red LED on the back of the device indicates the device is not connected.
- Sometimes after configuration a reboot is required. - Sometimes after configuration a reboot is required.
If the error screen is shown that it is unable to make a connection, first try to reboot the device, If the error screen is shown that it is unable to make a connection, first try to reboot the device,
@@ -165,24 +182,28 @@ This link can be opened with for example [VLC](https://www.videolan.org/vlc/).
- When the password is lost, a fix is to completely erase the ESP32 using the ```pio run -t erase``` command. - When the password is lost, a fix is to completely erase the ESP32 using the ```pio run -t erase``` command.
This will reset the device including configuration. This will reset the device including configuration.
If using the esptool, you can do this using ```esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash```. If using the esptool, you can do this using ```esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash```.
However, after erasing, reflashing of the firmware is required. However, after erasing, re-flashing of the firmware is required.
- When finished configuring for the first time and the access point is entered, disconnect from the wireless network provided by the device. - When finished configuring for the first time and the access point is entered, disconnect from the wireless network provided by the device.
This should reset the device and connect to the access point. This should reset the device and connect to the access point.
Resetting is also a good alternative... Resetting is also a good alternative...
### Power ### Power
Make sure the power is 5 volts and stable, although the ESP32 is a 3.3V module, this voltage is created on the board. Make sure the power is 5 volts and stable, although the ESP32 is a 3.3V module, this voltage is created on the board.
If not stable, it has been reported that restarts occur when starting up (probably when power is required for WiFi). If not stable, it has been reported that restarts occur when starting up (probably when power is required for WiFi).
The software disables the brown out protection so there is some margin in the voltage. The software disables the brown out protection so there is some margin in the voltage.
### PSRAM ### PSRAM
Some esp32cam modules have additional ram on the board. This allows to use this ram as frame buffer. Some esp32cam modules have additional ram on the board. This allows to use this ram as frame buffer.
Detecting and using this special RAM is handled automatically. Detecting and using this special RAM is handled automatically.
The availability of PSRAM can be seen in the HTML status overview. The availability of PSRAM can be seen in the HTML status overview.
### Camera modules ### Camera modules
Be careful when connecting the camera module. Be careful when connecting the camera module.
Make sure it is connected the right way around (Camera pointing away from the board) and the ribbon cable inserted to the end before locking it. Make sure it is connected the right way around (Camera pointing away from the board) and the ribbon cable inserted to the end before locking it.
## Credits ## Credits
esp32cam-ready depends on PlatformIO, Bootstrap5 and Micro-RTSP by Kevin Hester. esp32cam-ready depends on PlatformIO, Bootstrap5 and Micro-RTSP by Kevin Hester.