From bba8538d5878a366729d343d6e4da562c52c2c98 Mon Sep 17 00:00:00 2001 From: Eelco Date: Thu, 13 Nov 2025 18:55:35 +0100 Subject: [PATCH 1/3] docs: add Homey integration documentation and configuration guide Add comprehensive documentation for Homey smart home platform integration including: - Configuration setup instructions with address and API token requirements - Entity management for lights, switches, and buttons with Homey-specific options - Scene handling documentation for Flows and Moods with prefix indicators - API configuration section with authentication details - Future roadmap note about dedicated Homey Add-on availability --- docs/getting-started/configuration.md | 8 +++++ docs/web-interface.md | 48 ++++++++++++++++++++++++++- 2 files changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index cc4e8df..1208ecb 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -53,5 +53,13 @@ The following is a walkthrough of what to enter: the beginning and ":8123" (change to your port) at the end. - **OpenHAB token** - The access token used to authenticate to OpenHAB. +- **Homey (optional)** + - **Homey address** - The IP address or local mDNS name of your Homey instance (e.g., 192.168.1.100 or homey.local) + - **Homey token** - The API key used to authenticate to Homey. To obtain an API key, follow [Homey's API key guide](https://support.homey.app/hc/en-us/articles/8178797067292-Getting-started-with-API-Keys). + +:::info +A dedicated Homey Add-on will be available in the future on the Homey App Store. +::: + 3. Congrats you have finished the initial setup and you can now use NSPanel Manager. 4. If you are willing to learn more about the Web interface, please read [this](./../web-interface). diff --git a/docs/web-interface.md b/docs/web-interface.md index 0cbe718..eb55f0a 100644 --- a/docs/web-interface.md +++ b/docs/web-interface.md @@ -124,9 +124,11 @@ The entities/scenes that are assigned to each slot in the page can also be moved ### Scenes -You can choose to use scenes from Home Assistant or OpenHAB though these scenes will not be able to be saved on the fly. +You can choose to use scenes from Home Assistant, OpenHAB, or Homey though these scenes will not be able to be saved on the fly. This is something that the NSPanel Manager scenes can perform internally but NSPanel Manager scenes will only manage states of lights. +When using Homey, you can add Flows and Moods as scenes. Homey Flows will appear prefixed with **[F]** and Moods will appear prefixed with **[M]** in the NSPanelManager scenes list. + The NSPanel Manager scenes are easy enough to use. Simply create a scene in the room page and they will be available in the "Scenes"-list for the room on all NSPanels. @@ -228,6 +230,41 @@ An NSPM button entity is controlled by the NSPanel Manager itself. This button e +#### Configure Homey lights + +When adding/editing a Homey light entity you get multiple options of characteristics of the light. + +- **Name** - The displayed name on the NSPanel and web interface. +- **Homey item