Skip to content

Commit 2072016

Browse files
committed
Clarify config options
1 parent b55ccb8 commit 2072016

File tree

1 file changed

+42
-9
lines changed

1 file changed

+42
-9
lines changed

content/components/display/epaper_spi.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,30 @@ display:
2626
it.filled_circle(it.get_width() / 2, it.get_height() / 2, 50, Color::BLACK);
2727
```
2828
29-
## Supported displays
29+
## Supported display controllers
3030
31-
| Model name | Manufacturer | Product Description |
32-
| ---------------------- |--------------|----------------------------------------------------------------------------------------------------------------------------|
33-
| Spectra-E6 | Eink | <https://www.eink.com/brand/detail/Spectra6> |
34-
| Seeed-reTerminal-E1002 | Seeed Studio | <https://www.seeedstudio.com/reTerminal-E1002-p-6533.html> |
35-
| SSD1677 | Solomon | <https://www.solomon-systech.com/product/ssd1677/> |
36-
| Seeed-ee04-mono-4.26 | Seeed Studio | Seeed EE04 board with Waveshare 4.26" mono epaper. <https://www.seeedstudio.com/XIAO-ePaper-Display-Board-EE04-p-6560.html> |
31+
These are the supported controller chips. Using just the chip name as the model will require full configuration with
32+
pins and dimensions specified.
33+
34+
| Chip name | Manufacturer | Product Description |
35+
|------------------------|--------------|------------------------------------------------------------------------------------------------------------------------------|
36+
| Spectra-E6 | Eink | <https://www.eink.com/brand/detail/Spectra6> |
37+
| SSD1677 | Solomon | <https://www.solomon-systech.com/product/ssd1677/> |
38+
39+
## Supported integrated display boards
40+
41+
These models correspond to displays integrated with a microcontroller, and have a full configuration predefined, so at
42+
a minimum only the model name need be configured. Other options can be overridden in the configuration if needed.
43+
44+
45+
| Model name | Manufacturer | Product Description |
46+
| ---------------------- |--------------| ---------------------------------------------------------------------------------------------------------------------------- |
47+
| Seeed-reTerminal-E1002 | Seeed Studio | <https://www.seeedstudio.com/reTerminal-E1002-p-6533.html> |
48+
| Seeed-ee04-mono-4.26 | Seeed Studio | Seeed EE04 board with Waveshare 4.26" mono epaper. <https://www.seeedstudio.com/XIAO-ePaper-Display-Board-EE04-p-6560.html> |
3749
3850
## Configuration variables
3951
40-
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,
52+
When using a model defining an integrated display board most of the configuration such as the pins and dimensions will be set by default,
4153
but can be overridden if needed.
4254
4355
- **model** (**Required**): The model of the ePaper display. See the table above for options (case is not significant).
@@ -47,7 +59,7 @@ but can be overridden if needed.
4759
- **reset_pin** (*Optional*, [Pin Schema](/guides/configuration-types#pin-schema)): The RESET pin, if used.
4860
Make sure you pull this pin high (by connecting it to 3.3V with a resistor) if not connected to a GPIO pin.
4961
- **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
62+
or with separate config keys. For integrated boards with full pre-defined configuration this is optional and will be preset by
5163
the model selected. The dimensions are specified in pixels, and the width and height must be greater than 0.
5264

5365
- **height** (**Required**, int): Specifies height of display.
@@ -71,6 +83,27 @@ but can be overridden if needed.
7183
configuration defines multiple SPI buses. If only a single SPI bus is configured, this is optional.
7284
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.
7385

86+
### Full configuration example
87+
88+
```yaml
89+
display:
90+
- platform: epaper_spi
91+
model: SSD1677
92+
full_update_every: 10
93+
update_interval: 5s
94+
dimensions:
95+
width: 800
96+
height: 480
97+
transform:
98+
mirror_x: true
99+
mirror_y: false
100+
rotation: 90 # Rotate to portrait
101+
cs_pin: GPIOXX
102+
dc_pin: GPIOXX
103+
reset_pin: GPIOXX
104+
busy_pin: { number: GPIOXX, inverted: False, mode: { input: True, pulldown: True } }
105+
```
106+
74107
## See Also
75108

76109
- {{< apiref "epaper_spi/epaper_spi.h" "epaper_spi/epaper_spi.h" >}}

0 commit comments

Comments
 (0)