From ebe47c7079af6b3e68a11efb40f9ea35bba141cf Mon Sep 17 00:00:00 2001 From: c0ffeeca7 Date: Tue, 27 Jan 2026 09:23:11 +0100 Subject: [PATCH 1/5] OTBR: rename add-on to app --- openthread_border_router/DOCS.md | 28 +++++++++---------- openthread_border_router/README.md | 8 +++--- openthread_border_router/config.yaml | 4 +-- .../rootfs/etc/s6-overlay/scripts/banner.sh | 14 +++++----- .../scripts/otbr-agent-configure.sh | 2 +- 5 files changed, 28 insertions(+), 28 deletions(-) diff --git a/openthread_border_router/DOCS.md b/openthread_border_router/DOCS.md index 4769efe4a..e84ad8c2d 100644 --- a/openthread_border_router/DOCS.md +++ b/openthread_border_router/DOCS.md @@ -1,14 +1,14 @@ -# Home Assistant Add-on: OpenThread Border Router +# Home Assistant App: OpenThread Border Router ## Installation -Follow these steps to get the add-on installed on your system: +Follow these steps to get the app (formerly knowon as add-on) installed on your system: -1. Navigate in your Home Assistant frontend to **Settings** -> **Add-ons, Backup & Supervisor** -> **Add-on Store**. -2. Click on the top right menu and "Repository" -3. Add "https://github.com/home-assistant/addons" to add the "Home Assistant Add-on Repository for Development" repository. -4. Find the "OpenThread Border Router" add-on and click it. -5. Click on the "INSTALL" button. +1. Navigate in your Home Assistant frontend to **Settings** > **Apps** > **App store**. +2. Select the top right menu and **Repository**. +3. Add "https://github.com/home-assistant/addons" to add the **Home Assistant App Repository for Development** repository. +4. Find the **OpenThread Border Router** app and select it. +5. Select the **Install** button. ## How to use @@ -18,7 +18,7 @@ RCP firmware: - Home Assistant SkyConnect/Connect ZBT-1 - Home Assistant Connect ZBT-2 -These devices are all capable to run OpenThread and will be flashed with the correct +These devices are all capable to run OpenThread and will be flashed with the correct firmware by Home Assistant Core. If you are using Home Assistant Yellow, choose `/dev/ttyAMA1` as device. @@ -34,14 +34,14 @@ RCP firmware for the nRF52840 Dongle. Once the firmware is loaded follow the following steps: -1. Select the correct `device` in the add-on configuration tab and press `Save`. -2. Start the add-on. +1. Select the correct `device` in the app configuration tab and press `Save`. +2. Start the app. ### OpenThread Border Router -This add-on makes your Home Assistant installation an OpenThread Border Router +This app makes your Home Assistant installation an OpenThread Border Router (OTBR). The border router can be used to comission Matter devices which connect -through Thread. Home Assistant Core will automatically detect this add-on and +through Thread. Home Assistant Core will automatically detect this app and create a new integration named "Open Thread Border Router". With Home Assistant Core 2023.3 and newer the OTBR will get configured automatically. The Thread integration allows to inspect the network configuration. @@ -50,7 +50,7 @@ integration allows to inspect the network configuration. There is also a web interface provided by the OTBR. However, the web interface has caveats (e.g. forming a network does not generate an off-mesh -routable IPv6 prefix which causes changing IPv6 addressing on first add-on +routable IPv6 prefix which causes changing IPv6 addressing on first app restart). It is still possible to enable the web interface for debugging purpose. Make sure to expose both the Web UI port and REST API port (the latter needs to be on port 8081) on the host interface. To do so, click on @@ -59,7 +59,7 @@ and 8081 in the OpenThread REST API port field). ## Configuration -Add-on configuration: +App configuration: | Configuration | Description | |--------------------|--------------------------------------------------------| diff --git a/openthread_border_router/README.md b/openthread_border_router/README.md index 2bfd79cfa..3fb1076da 100644 --- a/openthread_border_router/README.md +++ b/openthread_border_router/README.md @@ -1,7 +1,7 @@ -# Home Assistant Add-on: OpenThread Border Router Add-on +# Home Assistant App: OpenThread Border Router App -OpenThread Border Router add-on. The add-on uses the upstream OpenThread -Border Router implementation and wraps it as an add-on for Home Assistant. +OpenThread Border Router app (formerly known as add-on). The app uses the upstream OpenThread +Border Router implementation and wraps it as an app for Home Assistant. **NOTE:** This requires a supported 802.15.4 capable radio with OpenThread RCP firmware. If you are using [Home Assistant Yellow](https://www.home-assistant.io/yellow/) or [Home Assistant Connect ZBT-1](https://www.home-assistant.io/connectzbt1/) (previously called SkyConnect) then @@ -12,7 +12,7 @@ the correct firmware is automatically installed. ## About -This add-on allows you to form or join a Thread network and make Home Assistant +This app allows you to form or join a Thread network and make Home Assistant a Thread Border Router. [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg diff --git a/openthread_border_router/config.yaml b/openthread_border_router/config.yaml index 481f3d79d..02a1dade5 100644 --- a/openthread_border_router/config.yaml +++ b/openthread_border_router/config.yaml @@ -2,7 +2,7 @@ version: 2.15.3 slug: openthread_border_router name: OpenThread Border Router -description: OpenThread Border Router add-on +description: OpenThread Border Router app url: >- https://github.com/home-assistant/addons/tree/master/openthread_border_router arch: @@ -13,7 +13,7 @@ gpio: true hassio_api: true discovery: - otbr -# IPC is only used within the Add-on +# IPC is only used within the app host_ipc: false host_network: true host_uts: true diff --git a/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh b/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh index 074dc4179..5079b8c89 100755 --- a/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh +++ b/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh @@ -1,25 +1,25 @@ #!/usr/bin/with-contenv bashio # shellcheck shell=bash # ============================================================================== -# Home Assistant Community Add-on: Base Images -# Displays a simple add-on banner on startup +# Home Assistant Community App: Base Images +# Displays a simple app banner on startup # ============================================================================== if bashio::supervisor.ping; then bashio::log.blue \ '-----------------------------------------------------------' - bashio::log.blue " Add-on: $(bashio::addon.name)" + bashio::log.blue " App: $(bashio::addon.name)" bashio::log.blue " $(bashio::addon.description)" bashio::log.blue \ '-----------------------------------------------------------' - bashio::log.blue " Add-on version: $(bashio::addon.version)" + bashio::log.blue " App version: $(bashio::addon.version)" if bashio::var.true "$(bashio::addon.update_available)"; then - bashio::log.magenta ' There is an update available for this add-on!' + bashio::log.magenta ' There is an update available for this app!' bashio::log.magenta \ - " Latest add-on version: $(bashio::addon.version_latest)" + " Latest app version: $(bashio::addon.version_latest)" bashio::log.magenta ' Please consider upgrading as soon as possible.' else - bashio::log.green ' You are running the latest version of this add-on.' + bashio::log.green ' You are running the latest version of this app.' fi bashio::log.blue " System: $(bashio::info.operating_system)" \ diff --git a/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh b/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh index d8f96785e..e52e7e994 100755 --- a/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh +++ b/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh @@ -1,7 +1,7 @@ #!/usr/bin/with-contenv bashio # shellcheck shell=bash # ============================================================================== -# Configure OTBR depending on add-on settings +# Configure OTBR depending on app settings # ============================================================================== if bashio::config.true 'nat64'; then From 24bbc8c8f98b020b0130423207489eb563cd2dc7 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 28 Jan 2026 10:23:09 +0100 Subject: [PATCH 2/5] update UI string --- openthread_border_router/DOCS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openthread_border_router/DOCS.md b/openthread_border_router/DOCS.md index e84ad8c2d..2866015a1 100644 --- a/openthread_border_router/DOCS.md +++ b/openthread_border_router/DOCS.md @@ -4,7 +4,7 @@ Follow these steps to get the app (formerly knowon as add-on) installed on your system: -1. Navigate in your Home Assistant frontend to **Settings** > **Apps** > **App store**. +1. In Home Assistant, go to **Settings** > **Apps** > **Install app**. 2. Select the top right menu and **Repository**. 3. Add "https://github.com/home-assistant/addons" to add the **Home Assistant App Repository for Development** repository. 4. Find the **OpenThread Border Router** app and select it. From 081fdab10f3b452adc4205b7679776ad362d9a62 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 29 Jan 2026 14:36:16 +0100 Subject: [PATCH 3/5] revert changes to rootfs --- .../rootfs/etc/s6-overlay/scripts/banner.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh b/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh index 5079b8c89..074dc4179 100755 --- a/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh +++ b/openthread_border_router/rootfs/etc/s6-overlay/scripts/banner.sh @@ -1,25 +1,25 @@ #!/usr/bin/with-contenv bashio # shellcheck shell=bash # ============================================================================== -# Home Assistant Community App: Base Images -# Displays a simple app banner on startup +# Home Assistant Community Add-on: Base Images +# Displays a simple add-on banner on startup # ============================================================================== if bashio::supervisor.ping; then bashio::log.blue \ '-----------------------------------------------------------' - bashio::log.blue " App: $(bashio::addon.name)" + bashio::log.blue " Add-on: $(bashio::addon.name)" bashio::log.blue " $(bashio::addon.description)" bashio::log.blue \ '-----------------------------------------------------------' - bashio::log.blue " App version: $(bashio::addon.version)" + bashio::log.blue " Add-on version: $(bashio::addon.version)" if bashio::var.true "$(bashio::addon.update_available)"; then - bashio::log.magenta ' There is an update available for this app!' + bashio::log.magenta ' There is an update available for this add-on!' bashio::log.magenta \ - " Latest app version: $(bashio::addon.version_latest)" + " Latest add-on version: $(bashio::addon.version_latest)" bashio::log.magenta ' Please consider upgrading as soon as possible.' else - bashio::log.green ' You are running the latest version of this app.' + bashio::log.green ' You are running the latest version of this add-on.' fi bashio::log.blue " System: $(bashio::info.operating_system)" \ From 663af4e996104238550e8bffad90b46aaf682809 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 29 Jan 2026 14:36:41 +0100 Subject: [PATCH 4/5] Update openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh --- .../rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh b/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh index e52e7e994..d8f96785e 100755 --- a/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh +++ b/openthread_border_router/rootfs/etc/s6-overlay/scripts/otbr-agent-configure.sh @@ -1,7 +1,7 @@ #!/usr/bin/with-contenv bashio # shellcheck shell=bash # ============================================================================== -# Configure OTBR depending on app settings +# Configure OTBR depending on add-on settings # ============================================================================== if bashio::config.true 'nat64'; then From 0fcd0bd07fa4740cd24905d428fed5c20349aae2 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 29 Jan 2026 14:45:51 +0100 Subject: [PATCH 5/5] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jan Čermák --- openthread_border_router/config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openthread_border_router/config.yaml b/openthread_border_router/config.yaml index 02a1dade5..481f3d79d 100644 --- a/openthread_border_router/config.yaml +++ b/openthread_border_router/config.yaml @@ -2,7 +2,7 @@ version: 2.15.3 slug: openthread_border_router name: OpenThread Border Router -description: OpenThread Border Router app +description: OpenThread Border Router add-on url: >- https://github.com/home-assistant/addons/tree/master/openthread_border_router arch: @@ -13,7 +13,7 @@ gpio: true hassio_api: true discovery: - otbr -# IPC is only used within the app +# IPC is only used within the Add-on host_ipc: false host_network: true host_uts: true