Skip to content
Merged
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
30 changes: 18 additions & 12 deletions content/components/display/epaper_spi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,34 @@ better integration with ESPHome's async architecture.
The communication method uses 4-wire [SPI](#spi), so you need to have an `spi:` section in your
configuration.

The driver supports a number of displays and there are also specific configurations for ESP32 boards with integrated displays.
For those boards the predefined configuration will set the correct pins and dimensions for the display.

```yaml
display:
- platform: epaper_spi
cs_pin: GPIOXX
dc_pin: GPIOXX
busy_pin: GPIOXX
reset_pin: GPIOXX
model: 7.3in-spectra-e6
model: Seeed-reTerminal-E1002
lambda: |-
it.filled_circle(it.get_width() / 2, it.get_height() / 2, 50, Color::BLACK);
```

## Configuration variables
## Supported displays

- **cs_pin** (**Required**, [Pin Schema](#config-pin_schema)): The CS pin.
- **dc_pin** (**Required**, [Pin Schema](#config-pin_schema)): The DC pin.
- **model** (**Required**): The model of the ePaper display. Currently supported:
| Model name | Manufacturer | Product Description |
|------------------------|--------------|------------------------------------------------------------|
| Spectra-E6 | Eink | <https://www.eink.com/brand/detail/Spectra6> |
| Seeed-reTerminal-E1002 | Seeed Studio | <https://www.seeedstudio.com/reTerminal-E1002-p-6533.html> |

## Configuration variables

- `7.3in-spectra-e6` - 7.3" Spectra E6 6-color display (800×480 pixels)
When using a model defining an integrated ESP32 display board most of the configuration such as the pins and dimensions will be set by default,
but can be overridden if needed.

- **busy_pin** (*Optional*, [Pin Schema](#config-pin_schema)): The BUSY pin. Defaults to not connected.
- **reset_pin** (*Optional*, [Pin Schema](#config-pin_schema)): The RESET pin. Defaults to not connected.
- **model** (**Required**): The model of the ePaper display. See the table above for options.
- **cs_pin** (**Required**, [Pin Schema](#config-pin_schema)): The CS pin. Predefined for integrated boards.
- **dc_pin** (**Required**, [Pin Schema](#config-pin_schema)): The DC pin. Predefined for integrated boards.
- **busy_pin** (*Optional*, [Pin Schema](#config-pin_schema)): The BUSY pin, if used.
- **reset_pin** (*Optional*, [Pin Schema](#config-pin_schema)): The RESET pin, if used.
Make sure you pull this pin high (by connecting it to 3.3V with a resistor) if not connected to a GPIO pin.

- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in `lambda:` will be rotated
Expand Down
2 changes: 1 addition & 1 deletion content/components/display/mipi_spi.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ boards and chips, but the driver is also designed to be customisable in YAML for
## Supported boards and driver chips

The driver supports a number of display driver chips, and can be configured for custom displays. As well as support for
driver chips, there are also specific configurations for several ESP32 boards with integrated displays. For tbose boards
driver chips, there are also specific configurations for several ESP32 boards with integrated displays. For those boards
the predefined configuration will set the correct pins and dimensions for the display.

For custom displays, the driver can be configured with the correct pins and dimensions, and the driver chip can be
Expand Down