Skip to content

Commit cc22991

Browse files
committed
Add dimensions option
1 parent a9e5a4a commit cc22991

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

content/components/display/epaper_spi.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ with improved state management and non-blocking operation. This component implem
1212
queue-based state machine that eliminates blocking waits for the busy pin and provides
1313
better integration with ESPHome's async architecture.
1414

15-
The communication method uses 4-wire [SPI](/components/spi), so you need to have an `spi:` section in your
15+
The communication method uses [SPI](/components/spi), so you need to have an `spi:` section in your
1616
configuration.
1717

1818
The driver supports a number of displays and there are also specific configurations for ESP32 boards with integrated displays.
@@ -46,10 +46,16 @@ but can be overridden if needed.
4646
- **busy_pin** (*Optional*, [Pin Schema](/guides/configuration-types#pin-schema)): The BUSY pin, if used.
4747
- **reset_pin** (*Optional*, [Pin Schema](/guides/configuration-types#pin-schema)): The RESET pin, if used.
4848
Make sure you pull this pin high (by connecting it to 3.3V with a resistor) if not connected to a GPIO pin.
49+
- **dimensions** (**Required**, dict): Dimensions of the screen, specified either as *width* **x** *height* (e.g `320x240` )
50+
or with separate config keys. For models with full pre-defined configuration this is optional and will be preset by
51+
the model selected. The dimensions are specified in pixels, and the width and height must be greater than 0.
4952

50-
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in `lambda:` will be rotated
53+
- **height** (**Required**, int): Specifies height of display.
54+
- **width** (**Required**, int): Specifies width of display.
55+
56+
- **rotation** (*Optional*, int): Set the rotation of the display. Everything you draw in `lambda:` will be rotated
5157
by this option. One of `0°` (default), `90°`, `180°`, `270°`.
52-
- **transform** (*Optional*): If `rotation` is not sufficient, use this to transform the display. Options are:
58+
- **transform** (*Optional*, dict): If `rotation` is not sufficient, use this to transform the display. Options are:
5359
- **mirror_x** (**Required**, boolean): If true, mirror the x axis.
5460
- **mirror_y** (**Required**, boolean): If true, mirror the y axis.
5561

@@ -61,8 +67,8 @@ but can be overridden if needed.
6167
use `never` to only manually update the screen via `component.update`.
6268
- **full_update_every** (*Optional*, int): On screens that support partial updates, this sets the number of updates
6369
before a full update is forced. Defaults to `1` which will make every update a full update.
64-
- **spi_id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID of the [SPI Component](/components/spi) if you want
65-
to use multiple SPI buses.
70+
- **spi_id** (*Optional*, [ID](/guides/configuration-types#id)): Required to specify the ID of the [SPI Component](/components/spi) if your
71+
configuration defines multiple SPI buses. If only a single SPI bus is configured, this is optional.
6672
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.
6773

6874
## See Also

0 commit comments

Comments
 (0)