Skip to content

Lidl auriol docs #4733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 68 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
19b0474
Create store_yaml.rst
gabest11 Nov 7, 2024
a4527bc
Merge branch 'esphome:current' into current
gabest11 Mar 5, 2025
e71f32b
Delete components/store_yaml.rst
gabest11 Mar 5, 2025
476e513
Update remote_receiver.rst
gabest11 Mar 5, 2025
403005e
Update remote_transmitter.rst
gabest11 Mar 5, 2025
db63749
Update remote_receiver.rst
gabest11 Mar 5, 2025
c8d7637
Update remote_transmitter.rst
gabest11 Mar 5, 2025
84ad013
Update remote_receiver.rst
gabest11 Mar 5, 2025
8103ba9
Update remote_receiver.rst
gabest11 Mar 7, 2025
70269f0
Update remote_receiver.rst
gabest11 Mar 7, 2025
9aa522b
Update remote_receiver.rst
gabest11 Mar 11, 2025
bbe8484
Update remote_transmitter.rst
gabest11 Mar 11, 2025
b6969ee
Update remote_receiver.rst
gabest11 Mar 11, 2025
93c6aab
Update remote_transmitter.rst
gabest11 Mar 11, 2025
4fc7ecd
Update remote_receiver.rst
gabest11 Mar 14, 2025
4568496
Update remote_receiver.rst
gabest11 Mar 14, 2025
33d1abd
Update remote_transmitter.rst
gabest11 Mar 14, 2025
f408782
Merge branch 'current' into lidl_auriol
nagyrobi Mar 14, 2025
34d6bd2
Update remote_receiver.rst
gabest11 Mar 14, 2025
0261e58
Update remote_receiver.rst
gabest11 Mar 16, 2025
9167062
undo remote_transmitter changes
gabest11 Mar 16, 2025
de763df
Update remote_receiver.rst
gabest11 Mar 30, 2025
026bcc2
Bump version to 2025.6.0-dev
jesserockz May 13, 2025
1e8c20c
Merge branch 'beta' into next
jesserockz May 14, 2025
d397329
Merge branch 'beta' into next
jesserockz May 14, 2025
0798548
Update max7219digit.rst (#4164)
nielsnl68 May 14, 2025
9e031ae
Sensor docs Required -> Optional (#4912)
jesserockz May 15, 2025
2c8adb5
Schema 2025 5 (#4918)
glmnet May 18, 2025
5330038
Merge branch 'current' into next
jesserockz May 18, 2025
2c332c6
Merge branch 'beta' into next
jesserockz May 19, 2025
5dc078a
Merge branch 'beta' into next
jesserockz May 19, 2025
2a29827
Merge branch 'beta' into next
jesserockz May 20, 2025
e5546b0
Merge branch 'beta' into next
jesserockz May 21, 2025
131e725
Merge branch 'current' into next
jesserockz May 21, 2025
527a70b
Merge branch 'current' into next
jesserockz May 22, 2025
90e6c1d
CUBIC CM1106 Single Beam NDIR CO2 Sensor Module (#4697)
andrewjswan May 22, 2025
526b15a
[lvgl] update buffer_size docs (#4914)
clydebarrow May 22, 2025
3c4a5b6
[lvgl] Add content styling to tabview (#4916)
clydebarrow May 22, 2025
bc6e416
[usb_uart] Document USB Host mode UART (#4724)
clydebarrow May 22, 2025
4399820
[modbus_controller] Add assumed_state to switch (#4933)
gotnone May 23, 2025
c035634
[esp32] Add c5, c6 and p4 to docs (#4943)
swoboda1337 May 26, 2025
243ddea
add docs for key support (#4756)
ssieb May 27, 2025
0ca06a5
Merge branch 'current' into next
jesserockz May 27, 2025
add5306
Merge branch 'current' into next
jesserockz May 27, 2025
fa90688
Add es8388 DAC to docs (#4947)
P4uLT May 28, 2025
4e3cdd1
[online_image] support HTTP caching (#4906)
candrews May 28, 2025
81b749b
Create store_yaml.rst
gabest11 Nov 7, 2024
4a99426
Delete components/store_yaml.rst
gabest11 Mar 5, 2025
63d2a41
Update remote_receiver.rst
gabest11 Mar 5, 2025
d369166
Update remote_transmitter.rst
gabest11 Mar 5, 2025
76d8fbc
Update remote_receiver.rst
gabest11 Mar 5, 2025
9e427af
Update remote_transmitter.rst
gabest11 Mar 5, 2025
3669e58
Update remote_receiver.rst
gabest11 Mar 5, 2025
f5ea0ce
Update remote_receiver.rst
gabest11 Mar 7, 2025
1cb4b19
Update remote_receiver.rst
gabest11 Mar 7, 2025
f625298
Update remote_receiver.rst
gabest11 Mar 11, 2025
b299f46
Update remote_transmitter.rst
gabest11 Mar 11, 2025
3f4b4b6
Update remote_receiver.rst
gabest11 Mar 11, 2025
eb3a0f4
Update remote_transmitter.rst
gabest11 Mar 11, 2025
9f2007d
Update remote_receiver.rst
gabest11 Mar 14, 2025
e528e36
Update remote_receiver.rst
gabest11 Mar 14, 2025
e374a53
Update remote_transmitter.rst
gabest11 Mar 14, 2025
2cc9bd9
Update remote_receiver.rst
gabest11 Mar 14, 2025
22b128a
Update remote_receiver.rst
gabest11 Mar 16, 2025
48615e7
undo remote_transmitter changes
gabest11 Mar 16, 2025
eee8bc7
Update remote_receiver.rst
gabest11 Mar 30, 2025
8b4e56f
Merge branch 'lidl_auriol' of https://github.com/gabest11/esphome-doc…
gabest11 May 28, 2025
1584434
Merge branch 'esphome:current' into lidl_auriol
gabest11 May 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doxygen
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 2025.5.0
PROJECT_NUMBER = 2025.6.0-dev

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ESPHOME_PATH = ../esphome
ESPHOME_REF = 2025.5.1
ESPHOME_REF = dev
PAGEFIND_VERSION=1.1.1
PAGEFIND=pagefind
NET_PAGEFIND=../pagefindbin/pagefind
Expand Down
2 changes: 1 addition & 1 deletion _static/version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2025.5.1
2025.6.0-dev
142 changes: 142 additions & 0 deletions components/audio_dac/es8388.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
ES8388
======

.. seo::
:description: Instructions for using ESPHome's es8388 audio DAC platform to play media from your devices and to configure microphone inputs.
:image: es8388.svg
:keywords: ES8388, Audio, DAC, I2S, ESP32

The ``es8388`` component allows your ESPHome devices to use the es8388 low power audio codec (`datasheet <http://www.everest-semi.com/pdf/ES8388%20DS.pdf>`__)
This allows the playback of audio through two channel high performance audio DAC output via the microcontroller from a range of sources via :doc:`/components/speaker/index` or
:doc:`/components/media_player/index` .

It also allows your ESPHome devices to use the ``es8388`` high performance two channel audio ADC.

This allows attached microphones to be used as a microphone input via :doc:`/components/microphone/i2s_audio`.

The :ref:`I²C bus <i2c>` is required in your configuration as this is used to communicate with the es8388.

Audio DAC
---------

.. code-block:: yaml

# Example configuration entry
audio_dac:
- platform: es8388

Configuration variables:
************************
- **address** (*Optional*, int): The I²C address of the driver. Defaults to ``0x10``.
- **i2c_id** (*Optional*): The ID of the :ref:`I²C bus <i2c>` the ES8388 is connected to.
- All other options from :ref:`Audio DAC <config-audio_dac>`.


Select
------

The ``es8388`` select allows you to control the ``dac output`` and the ``adc input_mic`` of your :doc:`es8388`.

.. code-block:: yaml

select:
- platform: es8388
es8388_id: es8388_parent
dac_output:
name: "DAC Output"
adc_input_mic:
name: "ADC Input MIC"

Configuration variables:
************************

- **es8388_id** (*Optional*, :ref:`config-id`): Manually specify the ID for the :doc:`es8388` component.
- **dac_output** (*Optional*): Control the DAC Audio output.

- ``LINE1`` (default)
- ``LINE2``
- ``BOTH``

All options from :ref:`Select <config-select>`.

- **adc_input_mic** (*Optional*): Control the ADC Mic Input.

- ``LINE1`` (default)
- ``LINE2``
- ``DIFFERENCE``

All options from :ref:`Select <config-select>`.


Automations
-----------

All :ref:`Audio DAC Automations <automations-audio_dac>` are supported by this platform.


Configuration Examples
----------------------

**ESP32 Audio Kit**:

.. code-block:: yaml

i2c:
sda: GPIO33
scl: GPIO32
frequency: 100kHz
id: bus_a

audio_dac:
- platform: es8388
id: es8388_dac

select:
- platform: es8388
es8388_id: es8388_dac
dac_output:
name: "DAC Output"
adc_input_mic:
name: "ADC Input MIC"

i2s_audio:
id: i2s_output
i2s_lrclk_pin: GPIO25
i2s_bclk_pin: GPIO27
i2s_mclk_pin: GPIO0

speaker:
- platform: i2s_audio
i2s_audio_id: i2s_output
sample_rate: 48000
id: speaker_id
i2s_dout_pin: GPIO26
bits_per_sample: 32bit
dac_type: external
channel: stereo
buffer_duration: 100ms
audio_dac: es8388_dac

microphone:
- platform: i2s_audio
i2s_din_pin: GPIO35
id: mic1
adc_type: external
pdm: false
sample_rate: 16000
bits_per_sample: 16bit

switch:
- platform: gpio
pin: GPIO21
id: mute_switch
name: "AMP Switch"
restore_mode: ALWAYS_ON

See Also
--------

- :doc:`index`
- :apiref:`es8388/es8388.h`
- :apiref:`audio_dac/audio_dac.h`
- :ghedit:`Edit`
42 changes: 42 additions & 0 deletions components/display/max7219digit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,48 @@ Configuration variables:
- **chip_lines_style** (*Optional*): How are the lines in Multiline Mode connected? Possible values are ``zigzag`` and ``snake``. Defaults to ``snake``
- **flip_x** (*Optional*, boolean): Flip the horizontal axis on the screen. Defaults to ``false``.

.. _display-max7219digit_actions:

Actions
-------
The following actions are replicas of the LAMBDA functions shown in the next section.

.. _display-max7219digit_actions_invert_on_off>:

`MAX7219.invert_on` & `MAX7219.invert_off` Action
=================================================

This action ``MAX7219.invert_on`` will invert the display. So background pixels are on and texts pixels are
off. ``MAX7219.invert_off`` sets the display back to normal. The background pixels are only set at the next update, the pixels drawn in
the various function like print, line, etc. are directly influenced by the invert command.

.. _display-max7219digit_actions_turn_on_off:

`MAX7219.turn_on` & `MAX7219.turn_off` Action
=============================================

The display can be switched on and off "dynamically" with the actions `MAX7219.turn_on` & `MAX7219.turn_off`.


.. _display-max7219digit_actions_reverse_off:

`MAX7219.reverse_on` & `MAX7219.reverse_off` Action
===================================================

With this actions you can reverse the display direction from left to right to right to left.


.. _display-max7219digit_actions_intensity:

`MAX7219.intensity` Action
===========================

The intensity of the screen can be set "dynamically" within the lambda code with the following command: it.intensity(``0`` .. ``15``).

- **intensity** (int): The intensity with which the MAX7219 should drive the outputs. Range is
from ``0``, least intense to ``15`` the brightest. Defaults to ``15``.


.. _display-max7219digit_lambda:

Rendering Lambda
Expand Down
10 changes: 5 additions & 5 deletions components/esp32.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ Configuration variables:
- **flash_size** (*Optional*, string): The amount of flash memory available on the ESP32 board/module. One of ``2MB``,
``4MB``, ``8MB``, ``16MB`` or ``32MB``. Defaults to ``4MB``. **Warning: specifying a size larger than that available
on your board will cause the ESP32 to fail to boot.**
- **cpu_frequency** (*Optional*, string): The CPU frequency to use. One of ``40MHz``, ``80MHz``, ``160MHz`` or ``240MHz``. Defaults to
``160MHz``. Not all values are available for all chips.
- **cpu_frequency** (*Optional*, string): The CPU frequency to use. One of ``40MHz``, ``80MHz``, ``160MHz``, ``240MHz``,
``360MHz`` or ``400MHz``. Defaults to ``160MHz``. Not all values are available for all chips.
- **partitions** (*Optional*, filename): The name of (optionally including the path to) the file containing the
partitioning scheme to be used. When not specified, partitions are automatically generated based on ``flash_size``.
- **variant** (*Optional*, string): The variant of the ESP32 that is used on this board. One of ``esp32``,
``esp32s2``, ``esp32s3``, ``esp32c3`` and ``esp32h2``. Defaults to the variant that is detected from the board; if
a board that's unknown to ESPHome is used, this option is mandatory.
``esp32s2``, ``esp32s3``, ``esp32c2``, ``esp32c3``, ``esp32c5``, ``esp32c6``, ``esp32h2`` and ``esp32p4``. Defaults
to the variant that is detected from the board; if a board that's unknown to ESPHome is used, this option is mandatory.
- **framework** (*Optional*): Options for the underlying framework used by ESPHome. See :ref:`esp32-arduino_framework`
and :ref:`esp32-espidf_framework`.

Expand Down Expand Up @@ -73,7 +73,7 @@ ESP-IDF framework
-----------------

This is an alternative base framework for ESP32 chips; it is recommended for variants of the ESP32 like ESP32S2,
ESP32S3, ESP32C3 and single-core ESP32 chips.
ESP32S3, ESP32P4 and single-core ESP32 chips.

.. code-block:: yaml

Expand Down
4 changes: 4 additions & 0 deletions components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ Hardware Peripheral Interfaces/Busses
OpenTherm, components/opentherm, opentherm.png
SPI Bus, components/spi, spi.svg
UART, components/uart, uart.svg
USB Host, components/usb_host, usb.svg
USB UART, components/usb_uart, usb.svg

I/O Expanders/Multiplexers
--------------------------
Expand Down Expand Up @@ -218,6 +220,7 @@ Air Quality
AGS10, components/sensor/ags10, ags10.jpg, Volatile Organic Compound Sensor
AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Radon, CO2, Volatile organics
CCS811, components/sensor/ccs811, ccs811.jpg, CO2 & Volatile organics
CM1106, components/sensor/cm1106, cm1106.png, CO2
EE895, components/sensor/ee895, EE895.png, CO2 & Temperature & Pressure
ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality
GCJA5, components/sensor/gcja5, gcja5.svg, Particulate
Expand Down Expand Up @@ -651,6 +654,7 @@ Audio DAC Components
AIC3204, components/audio_dac/aic3204, aic3204.svg
ES8156, components/audio_dac/es8156, es8156.svg
ES8311, components/audio_dac/es8311, es8311.svg
ES8388, components/audio_dac/es8388, es8388.svg

Button Components
-----------------
Expand Down
20 changes: 20 additions & 0 deletions components/logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,27 @@ Default UART GPIO Pins
- N/A
- N/A
- 18/19
* - ESP32-C5
- TX: 10, RX: 11
- N/A
- Undefined
- N/A
- N/A
- 13/14
* - ESP32-C6
- TX: 16, RX: 17
- N/A
- Undefined
- N/A
- N/A
- 12/13
* - ESP32-P4
- TX: 37, RX: 38
- N/A
- TX: 10, RX: 11
- N/A
- N/A
- 24/25
* - ESP32-S2
- TX: 43, RX: 44
- N/A
Expand Down Expand Up @@ -155,9 +169,15 @@ the original ESP32 or ESP8266) continue to use USB-to-serial bridge ICs for comm
* - ESP32-C3
- ``USB_CDC``
- ``USB_SERIAL_JTAG``
* - ESP32-C5
- ``USB_CDC``
- ``USB_SERIAL_JTAG``
* - ESP32-C6
- ``USB_CDC``
- ``USB_SERIAL_JTAG``
* - ESP32-P4
- ``USB_CDC``
- ``USB_SERIAL_JTAG``
* - ESP32-S2
- ``USB_CDC``
- ``USB_CDC``
Expand Down
6 changes: 4 additions & 2 deletions components/lvgl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The following configuration variables apply to the main ``lvgl`` component, in o

- **resume_on_input** (*Optional*, boolean): If LVGL is paused and the user interacts with the screen, resume the activity of LVGL. Defaults to ``true``. "Interacts" means to release a touch or button, or rotate an encoder.
- **color_depth** (*Optional*, string): The color depth at which the contents are generated. Currently only ``16`` is supported (RGB565, 2 bytes/pixel), which is the default value.
- **buffer_size** (*Optional*, percentage): The percentage of screen size to allocate buffer memory. Default is ``100%`` (or ``1.0``). For devices without PSRAM, the recommended value is ``25%``.
- **buffer_size** (*Optional*, percentage): The percentage of screen size to allocate buffer memory. If unconfigured, the default is ``100%`` with runtime fallback to ``12%`` if a full size buffer allocation fails. For devices without PSRAM, the recommended value is ``25%``.
- **draw_rounding** (*Optional*, int): An optional value to use for rounding draw areas to a specified boundary. Defaults to 2. Useful for displays that require draw windows to be on specified boundaries (usually powers of 2.)
- **log_level** (*Optional*, string): Set the logger level specifically for the messages of the LVGL library: ``TRACE``, ``INFO``, ``WARN``, ``ERROR``, ``USER``, ``NONE``. Defaults to ``WARN``.
- **byte_order** (*Optional*, int16): The byte order of the data LVGL outputs; either ``big_endian`` or ``little_endian``. Defaults to ``big_endian``.
Expand Down Expand Up @@ -202,7 +202,9 @@ Choosing a buffer size
The ``buffer_size`` option is a percentage of the display size. For example, if you have a 320x240 display, the buffer size is ``320 * 240 * 2`` bytes (for RGB565) = ``153600`` bytes. If you set the buffer size to ``50%``,
then the buffer will be ``76800`` bytes. If you set it to ``25%``, then the buffer will be ``38400`` bytes. The default value is ``100%``.

When using larger displays on devices with limited RAM (i.e. no PSRAM), you may need to reduce the buffer size to avoid running out of RAM.
When using larger displays on devices with limited RAM (i.e. no PSRAM), you may want to reduce the buffer size to avoid running out of RAM.
If not specified, the buffer size will be 100%, but a fallback
at runtime to 12% will be attempted if a full size buffer fails. If a specific buffer size is set, the fallback will not be attempted.
A failure to allocate a buffer will result in an error message in the log and the LVGL component being marked "Failed".

Generally speaking a larger buffer will provide better performance, but the effect of reducing the buffer size from 100% is not as bad as you might think. The LVGL library is designed to be efficient and will only redraw the parts of the screen that have changed.
Expand Down
1 change: 1 addition & 0 deletions components/lvgl/widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1799,6 +1799,7 @@ The tabs are indexed (zero-based) in the order they appear in the configuration
- **widgets** (**Required**, list): A list of :doc:`/components/lvgl/widgets` to be drawn on the tab, as children.
- **tab_style** (*Optional*): Style settings for the tabs.
- **items** (*Optional*, dict): Settings for the items *part*, the buttons all use the text and typical background style properties except translations and transformations.
- **content_style** (*Optional*): Style settings for the content area.

**Actions:**

Expand Down
22 changes: 22 additions & 0 deletions components/online_image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,28 @@ Automations

- **on_download_finished** (*Optional*, :ref:`Automation <automation>`): An automation to perform when the image has been successfully downloaded.

The variable ``cached`` is a boolean available in :ref:`lambdas <config-lambda>` that indicates cache status:
- ``true`` if the image was loaded from cache (cache hit).
- ``false`` if the image was freshly downloaded (cache miss).

Caching follows standard HTTP mechanisms (see `HTTP caching <https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching>`_), utilizing the ``Last-Modified`` and ``ETag`` headers.

For example:

.. code-block:: yaml

online_image:
- url: "https://upload.wikimedia.org/wikipedia/commons/thumb/4/47/PNG_transparency_demonstration_1.png/280px-PNG_transparency_demonstration_1.png"
format: png
id: my_online_image
on_download_finished:
lambda: |-
if (cached) {
ESP_LOGD("online_image", "Cache hit: using cached image");
} else {
ESP_LOGD("online_image", "Cache miss: fresh download");
}

A good example for that is to update the display component after the download succeeded.

- **on_error** (*Optional*, :ref:`Automation <automation>`): An automation to perform when an error happened during download or decode.
Expand Down
Loading