Merge pull request #8 from ArthFink/af/ha-open-thread-doku

af/ha open thread doku

Author: ArthFink

README.md

@@ -8,24 +8,22 @@ The build process ensures the most up-to-date OpenThread firmware for nRF52840 b
 
 - **UART Version**: `ot-cli-ftd-UART.hex`
 - **USB Version**: `ot-cli-ftd-USB.hex`
+- **USB Radio Co-Processo**: `ot-rcp-USB.hex`
 
-The firmware is uploaded as artifacts that you can download directly from the **Actions** tab.
+Firmware is published as part of [bi-monthly releases](https://github.com/ArthFink/nrf52840-OpenThread/releases), which include precompiled binaries for different use cases supported versions.
 
 ## How to Download the Firmware
 
-1. Go to the [**Actions tab**](../../actions) of this repository.
-2. Select the latest workflow run for the `Build OpenThread nRF52840 Examples` workflow.
-3. Scroll down to the **Artifacts** section at the bottom of the workflow page.
-4. Click on the `ot-nrf528xx-binaries` artifact to download a ZIP file containing:
-   - `ot-cli-ftd-UART.hex`
-   - `ot-cli-ftd-USB.hex`
-   - Corresponding ELF files.
-
+1. Go to the [Releases page](https://github.com/ArthFink/nrf52840-OpenThread/releases).
+2. Select the most recent release (release 07/2025 known good).
+3. Download the appropriate firmware file for your device and use case from the Assets section.
+   - For use with OpenThread Border Router, a Radio Co-Processor (RPC) image is required.
+   
 ## How to Flash the Firmware
 
 ### USB Version
 
-To flash the USB version (`ot-cli-ftd-USB.hex`), you can use either the **nRF Connect for Desktop** application or the **nrfjprog** command-line tool. Follow the steps below based on your preferred method:
+To flash the USB version (`ot-rcp-USB.hex`), you can use either the **nRF Connect for Desktop** application or the **nrfjprog** command-line tool. Follow the steps below based on your preferred method:
 
 #### Using nRF Connect for Desktop
 
@@ -35,7 +33,7 @@ To flash the USB version (`ot-cli-ftd-USB.hex`), you can use either the **nRF Co
    - Insert the dongle into a USB port on your computer.
    - Hold down the reset button while inserting the dongle until the LED blinks rapidly. This indicates the device is in program mode.
 4. In the Programmer Tool, select the detected nRF52840 dongle from the device list.
-5. Click **Add file** and choose the `ot-cli-ftd-USB.hex` file.
+5. Click **Add file** and choose the `ot-rcp-USB.hex` file.
 6. Ensure the **Erase & Write** option is selected.
 7. Click **Write** to flash the firmware onto the dongle.
 
@@ -50,7 +48,7 @@ If you prefer using the command-line tool, **nrfjprog** (part of the [nRF Comman
 2. Flash the USB firmware:
    - Use the following command:
      ```bash
-     nrfjprog --program ot-cli-ftd-USB.hex --sectorerase --reset
+     nrfjprog --program ot-rcp-USB.hex--sectorerase --reset
      ```
 
 3. Verify the flashing process:
@@ -66,6 +64,10 @@ Once you have downloaded the firmware, you can flash it onto your nRF52840 devic
 nrfjprog -f nrf52 --chiperase --program ot-cli-ftd-UART.hex --reset
 ```
 
+## Home Assistant 
+
+👉 For Home Assistant setup instructions, check out [homeassisten-setup-otbr.md](./homeassisten-setup-otbr.md).
+
 ## License
 
 This repository and the OpenThread firmware are licensed under the [BSD 3-Clause License](LICENSE).

homeassisten-setup-otbr.md

@@ -0,0 +1,52 @@
+## Home Assistant Thread Setup Guide
+
+Once the firmware is flashed to your nRF52840 dongle, follow these steps to set up OpenThread in Home Assistant.
+
+### 1. Install OpenThread Border Router Add-on
+
+Go to **Settings > Add-ons > Add-on Store**, and install the **OpenThread Border Router** add-on.
+
+#### Configuration
+
+- **Device**: /dev/serial/by-id/usb-Nordic_Semiconductor_nRF528xx_OpenThread_Device_XXXXXXXXXXXX-if00  
+  *(Note: Device path may differ depending on your system)*
+- **Baudrate**: 460800
+- **Hardware flow control**: on
+- **Automatically flash firmware**: off
+- **Log level**: default:warn
+- **OTBR firewall**: on
+- **NAT64**: off
+
+After starting the add-on, check the logs. You should see:
+
+```
+[20:57:37] INFO: Successfully sent discovery information to Home Assistant.
+s6-rc: info: service otbr-agent-rest-discovery successfully started
+s6-rc: info: service legacy-services: starting
+s6-rc: info: service legacy-services successfully started 
+```
+### 2. Add Thread Integration
+
+- Go to **Settings > Devices & Services**
+- Click **"+ Add Integration"** and select **Thread**
+- Click the gear icon ⚙️ next to the `ha-thread-xxxx` network
+- Select **Preferred network**
+
+### 3. Sync Thread Credentials to Mobile
+
+In the **Home Assistant Companion App** (as described in [this guide](https://www.home-assistant.io/integrations/thread/#case-1-making-home-assistant-your-first-thread-network)):
+
+- Go to **Settings > Companion App > Troubleshooting**
+- Tap **Sync Thread credentials**
+
+- If you skip this step, your phone won’t be aware of the Thread network and Border Router, which means it won’t be able to commission or control Thread devices—even if the network itself is working properly.
+
+### 4. Add Matter Server and Pair Devices
+
+- Add the **Matter Server** integration
+- Pair your Matter-compatible device using the Companion App
+
+### Resources
+
+- [Thread Integration Documentation](https://www.home-assistant.io/integrations/thread/)
+- [Making Home Assistant Your First Thread Network](https://www.home-assistant.io/integrations/thread/#case-1-making-home-assistant-your-first-thread-network)