Add `esp32_camera_web_server:` usage docs (#1595)

This commit is contained in:
Kamil Trzciński 2021-11-10 01:10:13 +01:00 committed by GitHub
parent 1867f0c618
commit c6478725dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 0 deletions

View File

@ -0,0 +1,38 @@
ESP32 Camera Web Server Component
=================================
.. seo::
:description: Instructions for setting up the ESP32 Camera Web Server in ESPHome
:image: camera.png
The ``esp32_camera_web_server`` component allows you to use expose web server of
ESP32-based camera boards in ESPHome that directly can be integrated into external
surveillance or PVR software.
At a given time only one stream can be served, but multiple snapshots. The stream
or snapshot can be accessed via `http://<ip>:<port>/`.
.. code-block:: yaml
# Example configuration entry
esp32_camera_web_server:
- port: 8080
mode: stream
- port: 8081
mode: snapshot
Configuration variables:
------------------------
- **port** (**Required**, string): The serving port.
- **mode** (**Required**, string): The operation mode.
One of these values:
- ``snapshot``
- ``stream``
See Also
--------
- :apiref:`esp32_camera_web_server/esp32_camera_web_server.h`
- :ghedit:`Edit`

View File

@ -578,6 +578,7 @@ Misc Components
ESP32 Ethernet, components/ethernet, ethernet.svg
ESP32 Camera, components/esp32_camera, camera.svg
ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg
Stepper, components/stepper/index, stepper.svg
Servo, components/servo, servo.svg