From d83c9cc86f13c1f5eaf279af3b4b69f94bc12e13 Mon Sep 17 00:00:00 2001 From: goofoo Date: Fri, 6 Nov 2026 11:03:59 -0500 Subject: [PATCH 1/2] docs: explain how this integration differs from the core one Fixes #138 Co-Authored-By: Claude Opus 5.5 --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index c11f3b9..1880874 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,41 @@ away and marks it as pending until it lands. **WiFi-capable tags deliver over the LAN** when the device has recently announced itself over mDNS, falling back to Bluetooth otherwise. +## This integration and the one built into Home Assistant + +Home Assistant ships its own +[OpenDisplay integration](https://www.home-assistant.io/integrations/opendisplay), +which works out of the box. This repository is a separate custom integration, +installed through HACS, that covers more of what the devices can do. Both use the +domain `opendisplay`, so installing this one replaces the built-in one, and Home +Assistant logs its usual warning about a custom integration that it has not tested. +That warning is expected. + +| | Built into Home Assistant | This integration (HACS) | +|---|---|---| +| `upload_image` action | ✅ | ✅ | +| Temperature, battery and other sensors | Flex boards only | ✅ | +| Button and touch events | Flex boards only | Flex boards only | +| `drawcustom` action | ❌ | ✅ | +| LED, buzzer, melody and NFC actions | ❌ | ✅ | +| Image entity showing the last frame sent | ❌ | ✅ | +| Firmware update entity | ❌ | Flex boards only | +| Installing firmware from Home Assistant | ❌ | Silicon Labs (EFR32BG22) boards only | +| Queued delivery to deep-sleeping tags | ❌ | ✅ | +| Delivery over WiFi | ❌ | ✅ | +| When library updates arrive | With Home Assistant releases | With this integration's releases | + +Compared against Home Assistant's `dev` branch in November 2026. The built-in +integration changes with each Home Assistant release, so check its documentation +for the current state. + +**Use this integration** if you want to compose frames with `drawcustom`, have +battery-powered tags that sleep, or want firmware updates from Home Assistant on a +supported board. + +**Stay with the built-in integration** if sending images with `upload_image` is all +you need and you would rather not manage a custom integration. + ## Installation ### Option 1: HACS (recommended) From 9357fb1c38e3846cd3f889313b33a3c8ee41e22d Mon Sep 17 00:00:00 2001 From: goofoo Date: Mon, 9 Nov 2026 08:00:26 -0500 Subject: [PATCH 2/2] docs: mention the Marketplace that replaces HACS in 2026.11 Co-Authored-By: Claude Opus 5.5 --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1880874..4543510 100644 --- a/README.md +++ b/README.md @@ -59,12 +59,13 @@ announced itself over mDNS, falling back to Bluetooth otherwise. Home Assistant ships its own [OpenDisplay integration](https://www.home-assistant.io/integrations/opendisplay), which works out of the box. This repository is a separate custom integration, -installed through HACS, that covers more of what the devices can do. Both use the +installed through the Marketplace (or HACS before Home Assistant 2026.11), that +covers more of what the devices can do. Both use the domain `opendisplay`, so installing this one replaces the built-in one, and Home Assistant logs its usual warning about a custom integration that it has not tested. That warning is expected. -| | Built into Home Assistant | This integration (HACS) | +| | Built into Home Assistant | This integration (Marketplace) | |---|---|---| | `upload_image` action | ✅ | ✅ | | Temperature, battery and other sensors | Flex boards only | ✅ | @@ -91,7 +92,13 @@ you need and you would rather not manage a custom integration. ## Installation -### Option 1: HACS (recommended) +### Option 1: Marketplace (recommended) +From Home Assistant 2026.11, HACS is built into Home Assistant as the +**Marketplace**, under **Settings**. Existing HACS installs move over on their own +the first time 2026.11 starts, so if you installed this integration through HACS it +keeps updating from the Marketplace. On earlier versions of Home Assistant, install +it through HACS instead. The button below opens the repository in either one. + [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=OpenDisplay&repository=Home_Assistant_Integration) ### Option 2: Manual