Skip to content

Commit 072a25d

Browse files
committed
docs: Add opendisplay documentation and update readme
1 parent df07b08 commit 072a25d

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ headless browser or other server component required running.
1616
- **WYSIWYG Lovelace editor** - drag, resize, and configure widgets on a
1717
server-rendered SVG preview that matches your device's exact pixel dimensions
1818
- **Pull and push delivery** - devices can fetch the image on their own
19-
schedule (Kindle, OpenDisplay) or have HA push it via webhook (TRMNL)
19+
schedule (Kindle), or have HA push it via webhook (TRMNL) or an automation
20+
(OpenDisplay)
2021
- **E-ink optimization** - optional post-processing pipeline: autocontrast,
2122
sharpness, contrast adjustment, and grayscale quantization (2/4/16/256
2223
levels with Floyd-Steinberg dithering)
@@ -239,15 +240,16 @@ You can add multiple TRMNL webhook targets per dashboard entry via
239240

240241
### OpenDisplay
241242

242-
[OpenDisplay](https://opendisplay.org/) fetches images from Home Assistant's
243-
Media Browser. The integration registers a **Media Source** platform that
244-
exposes each dashboard entry as a media item, so OpenDisplay can pull the
245-
latest rendered PNG without any additional configuration.
243+
[OpenDisplay](https://opendisplay.org/) devices cannot fetch images
244+
themselves - Home Assistant must push (upload) the rendered PNG to them via
245+
an automation. The integration registers a **Media Source** platform that
246+
exposes each dashboard entry as a media item
247+
(`media-source://eink_dashboard/<entry_id>`), which you pass to the
248+
`opendisplay.upload_image` service.
246249

247-
In the OpenDisplay app, point it at your Home Assistant instance and select
248-
the dashboard entry from the Media Browser. OpenDisplay will refresh the image
249-
on its own schedule, respecting the ETag so it only re-renders the display
250-
when the image has actually changed.
250+
See [Setting up OpenDisplay for image push](docs/opendisplay.md) for the
251+
full automation, including how to detect when a battery-powered display
252+
wakes up so the push arrives while it's reachable.
251253

252254
## License
253255

0 commit comments

Comments
 (0)