Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions content/components/display/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,39 @@ RGB displays use red, green, and blue, while grayscale displays may use white.

{{< anchor "display-pages" >}}

{{< anchor "display-power-save-mode" >}}

### Display power save mode

On many displays you can partially turn off the display to save a significant amount of power and avoid wearing it out by having it enter sleep mode. Note that
not all display components support sleeping mode or have it implemented yet. Check the corresponding display component documentation.

**display.sleep**: Puts the display on power saving mode.

```yaml
lvgl:
on_idle:
timeout: 30s
then:
- light.turn_off: display_backlight
- lvgl.pause:
- delay: 5s # wait for display backlight to fade out for a nice effect
- display.sleep: my_display
```

**display.wakeup**: Wakes up the display from power saving mode

```yaml
touchscreen:
- on_release:
- if:
condition:
- lvgl.is_paused:
then:
- light.turn_on: display_backlight
- display.wakeup: my_display
```

### Display Pages

Certain display types also allow you to show "pages". With pages you can create drawing lambdas
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/epaper_spi.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ but can be overridden if needed.
to use multiple SPI buses.
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ili9xxx.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,10 @@ display:
invert_colors: true
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/inkplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,10 @@ display:
number: 5
```

### Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

### See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/lcd_display.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,10 @@ binary_sensor:
id(mydisplay).no_backlight();
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/max7219.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,10 @@ Please see [Formatted Text](/components/display#display-printf) for a quick intr
> [Creative Commons BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/deed.de) and modified
> for this documentation.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/max7219digit.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,10 @@ display a single character. So not very space efficient. The format of the comma
Please see [Formatted Text](/components/display#display-printf) for a quick introduction into the `printf` formatting rules and
[Displaying Time](/components/display#display-strftime) for an introduction into the `strftime` time formatting.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/mipi_dsi.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,10 @@ be able to be dimmed using a {{< docref "/components/light/monochromatic" >}} wi

A touchscreen, if present, must be configured separately. See the {{< docref "/components/touchscreen" >}} documentation for more information.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/mipi_rgb.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@ display:

```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) are supported for this display type.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/mipi_spi.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,10 @@ their brightness can be set using the `brightness` option. This may also be cont

A touchscreen, if present, must be configured separately. See the {{< docref "/components/touchscreen" >}} documentation for more information.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) are supported for this display type.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/nextion.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,10 @@ the example below illustrates:
Note that the first one requires a custom protocol to be included in the Nextion display's HMI code/configuration. See
the individual components (linked below) for more detail.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/pcd8544.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ To use a backlight LIGHT pin needs to be connected to ground. If connected to GP
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.
- **contrast** (*Optional*, int): Set screen contrast (0-255). Defaults to `0x7f`.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/pvvx_mithermometer.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,10 @@ display:
time_id: homeassistant_time
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/qspi_dbi.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,10 @@ touchscreen:
mirror_y: true
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) are not supported for this display type since it is deprecated. Move to {{< docref "mipi_spi" >}} for support

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/rpi_dpi_rgb.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,10 @@ display:
- 1 #b5
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
5 changes: 5 additions & 0 deletions content/components/display/sdl.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ Linux instructions above. See <https://learn.microsoft.com/en-us/windows/wsl/ins

The `esphome run yourfile.yaml` command will compile and automatically run the build file on the `host` platform.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented for this display component
since it is more intended for design/testing.

## See Also

- [SDL touchscreen](/components/touchscreen/sdl#sdl_touchscreen)
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ssd1306.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ display:

- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ssd1322.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ display:
- **pages** (*Optional*, list): Show pages instead of a single lambda. See [Display Pages](/components/display#display-pages).
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ssd1325.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ display:
The last argument of the `Color` constructor is the intensity of the white element; it is a percentage
(value of range 0 to 1). It may be defined by another variable so it is adjustable in code.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ssd1327.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,10 @@ display:
The last argument of the `Color` constructor is the intensity of the white element; it is a percentage
(value of range 0 to 1). It may be defined by another variable so it is adjustable in code.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ssd1331.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ display:
it.image(0, 0, id(my_image));
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/ssd1351.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ display:
it.image(0, 0, id(my_image));
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/st7567.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ display:
it.print(0, 0, id(my_font), "Hello World!");
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/st7701s.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,10 @@ display:
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) are not supported for this display component since it is deprecated. Migrate to {{< docref "mipi_rgb" >}} for support.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/st7735.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ display:
- INITR_18BLACKTAB
- INITR_18REDTAB

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- [SPI Bus](/components/spi)
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/st7789v.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@ display:
}
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/st7920.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ display:
- **pages** (*Optional*, list): Show pages instead of a single lambda. See [Display Pages](/components/display#display-pages).
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/tm1621.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ Also we have five function to display or not some unites:
- V on the first line and A on the second line : `display_voltage(bool)`
- kW/h on the first line and W on the second line : `display_kwh(bool)`

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/tm1637.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,10 @@ The last displays Dio pin shares the Clk pin of the first display.

{{< img src="tm1637_3plus_devices.png" alt="Image" caption="Three TM1637 displays on 3 control lines" width="50.0%" class="align-center" >}}

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/tm1638.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,10 @@ binary_sensor:
- output.turn_off: TM1638Led2
```

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down
4 changes: 4 additions & 0 deletions content/components/display/waveshare_epaper.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ lambda: |-

- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.

## Sleep/Wakeup support

[Sleep / Wakeup actions](/components/display#display-power-save-mode) (`display.sleep` / `display.wakeup`) not implemented yet for this display component.

## See Also

- {{< docref "index/" >}}
Expand Down