mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-06-26 10:34:54 +02:00
Add esp-adf docs
This commit is contained in:
parent
a863e431b7
commit
edd298e0b4
42
components/esp_adf.rst
Normal file
42
components/esp_adf.rst
Normal file
|
@ -0,0 +1,42 @@
|
|||
ESP-ADF
|
||||
=======
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for including ESP-ADF in ESPHome.
|
||||
:image: esp-adf.svg
|
||||
|
||||
`ESP-ADF <https://github.com/espressif/esp-adf>`__ is Espressif's Audio Development Framework.
|
||||
|
||||
ESPHome can leverage this framework to provide a number of features:
|
||||
|
||||
- VAD (Voice Activity Detection) for the :doc:`voice_assistant`
|
||||
- :doc:`Microphone </components/microphone/esp_adf>` for certain boards.
|
||||
- :doc:`Speaker </components/speaker/esp_adf>` for certain boards.
|
||||
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
esp_adf:
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **board** (Optional, string): Manually specify the esp-adf board to use.
|
||||
Defaults to the ``board`` from the :doc:`/components/esp32`.
|
||||
|
||||
.. _esp_adf-boards:
|
||||
|
||||
For the ``microphone`` and ``speaker``, the following boards are supported:
|
||||
|
||||
- ``esp32s3box`` - ESP32 S3 Box
|
||||
- ``esp32s3boxlite`` - ESP32 S3 Box Lite
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/esp32`
|
||||
- :doc:`/components/microphone/esp_adf`
|
||||
- :doc:`/components/speaker/esp_adf`
|
||||
- :doc:`/components/voice_assistant`
|
||||
- :ghedit:`Edit`
|
26
components/microphone/esp_adf.rst
Normal file
26
components/microphone/esp_adf.rst
Normal file
|
@ -0,0 +1,26 @@
|
|||
ESP-ADF Microphone
|
||||
==================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for settings up ESP-ADF supported board microphones in ESPHome.
|
||||
:image: esp-adf.svg
|
||||
|
||||
The ``esp_adf`` microphone platform allows automatic configuration of the microphone input
|
||||
on ESP-ADF supported boards.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
microphone:
|
||||
- platform: esp_adf
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **id** (Optional, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`ESP-ADF </components/esp_adf>`
|
||||
- :doc:`ESP-ADF Speaker </components/speaker/esp_adf>`
|
||||
- :ghedit:`Edit`
|
26
components/speaker/esp_adf.rst
Normal file
26
components/speaker/esp_adf.rst
Normal file
|
@ -0,0 +1,26 @@
|
|||
ESP-ADF Speaker
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for settings up ESP-ADF supported board speakers in ESPHome.
|
||||
:image: esp-adf.svg
|
||||
|
||||
The ``esp_adf`` speaker platform allows automatic configuration of the speaker output
|
||||
on :ref:`ESP-ADF supported boards <esp_adf-boards>`.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
speaker:
|
||||
- platform: esp_adf
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **id** (Optional, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`ESP-ADF </components/esp_adf>`
|
||||
- :doc:`ESP-ADF Microphone </components/microphone/esp_adf>`
|
||||
- :ghedit:`Edit`
|
1
images/esp-adf.svg
Normal file
1
images/esp-adf.svg
Normal file
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 132 25"><path d="M5 0h122a5 5 0 0 1 5 5v15a5 5 0 0 1-5 5H5a5 5 0 0 1-5-5V5a5 5 0 0 1 5-5z" style="fill:#000"/><g aria-label="ESP-ADF" style="font-weight:900;font-size:25px;font-family:Montserrat;letter-spacing:1.1px;fill:#fffffc"><path d="M11.825 10h7.8v4.25h-7.8zm.4 6.55h8.75V21H6.425V3.5H20.65v4.45h-8.425zM30.875 21.4q-2.2 0-4.25-.5t-3.375-1.3l1.9-4.3q1.25.725 2.775 1.175 1.55.425 3 .425.85 0 1.325-.1.5-.125.725-.325.225-.225.225-.525 0-.475-.525-.75t-1.4-.45q-.85-.2-1.875-.4-1.025-.225-2.075-.575-1.025-.35-1.9-.925-.85-.575-1.375-1.5-.525-.95-.525-2.35 0-1.625.9-2.95.925-1.35 2.725-2.15 1.825-.8 4.525-.8 1.775 0 3.5.375t3.1 1.15L36.5 8.9q-1.3-.65-2.525-.975-1.2-.325-2.35-.325-.85 0-1.35.15t-.725.4q-.2.25-.2.55 0 .45.525.725.525.25 1.375.425.875.175 1.9.375 1.05.2 2.075.55 1.025.35 1.875.925.875.575 1.4 1.5t.525 2.3q0 1.6-.925 2.95-.9 1.325-2.7 2.15-1.8.8-4.525.8zM41.875 21V3.5H50.3q2.45 0 4.225.8 1.8.8 2.775 2.3.975 1.475.975 3.5t-.975 3.5-2.775 2.3q-1.775.8-4.225.8h-5.15l2.625-2.525V21zm5.9-6.175L45.15 12.15h4.775q1.225 0 1.8-.55.6-.55.6-1.5t-.6-1.5q-.575-.55-1.8-.55H45.15l2.625-2.675zM61 15.9v-4.25h7.5v4.25zM69.5 21l7.65-17.5h5.8L90.6 21h-6.1L78.85 6.3h2.3L75.5 21zm4.55-3.05 1.5-4.25h8.05l1.5 4.25zM92.65 21V3.5h8.625q2.925 0 5.15 1.075 2.225 1.05 3.475 3t1.25 4.65q0 2.725-1.25 4.7-1.25 1.95-3.475 3.025Q104.2 21 101.275 21zm5.9-4.6h2.475q1.25 0 2.175-.475.95-.475 1.475-1.4.525-.95.525-2.3 0-1.325-.525-2.25t-1.475-1.4q-.925-.475-2.175-.475H98.55zM119.9 10.95h7.7v4.45h-7.7zm.4 10.05h-5.9V3.5h14.225v4.45H120.3z"/></g></svg>
|
After Width: | Height: | Size: 1.6 KiB |
|
@ -756,6 +756,7 @@ Microphone Components
|
|||
|
||||
Microphone Core, components/microphone/index, microphone.svg, dark-invert
|
||||
I2S Microphone, components/microphone/i2s_audio, i2s_audio.svg
|
||||
ESP-ADF Microphone, components/microphone/esp_adf, esp-adf.svg
|
||||
|
||||
Speaker Components
|
||||
------------------
|
||||
|
@ -764,6 +765,7 @@ Speaker Components
|
|||
|
||||
Speaker Core, components/speaker/index, speaker.svg, dark-invert
|
||||
I2S Speaker, components/speaker/i2s_audio, i2s_audio.svg
|
||||
ESP-ADF Speaker, components/speaker/esp_adf, esp-adf.svg
|
||||
|
||||
Time Components
|
||||
---------------
|
||||
|
@ -825,6 +827,7 @@ Miscellaneous Components
|
|||
ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg, dark-invert
|
||||
|
||||
I²S Audio, components/i2s_audio, i2s_audio.svg
|
||||
ESP-ADF, components/esp_adf, esp-adf.svg
|
||||
|
||||
Stepper, components/stepper/index, stepper.svg
|
||||
Servo, components/servo, servo.svg
|
||||
|
|
Loading…
Reference in New Issue
Block a user