Update documentation for new local api config flow in Overkiz. (#38641)

This commit is contained in:
Mick Vleeshouwer 2025-04-22 08:44:36 +02:00 committed by GitHub
parent 202bb29d24
commit 4556b33309
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -80,17 +80,15 @@ Password:
### Login to Overkiz (Local API)
To use the local API, you will need to activate the [Somfy TaHoma Developer Mode](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode?tab=readme-ov-file#getting-started) via the Somfy website. Activating this mode will enable a local API on your TaHoma box. Your cloud credentials are required to negotiate a token with the cloud API to authenticate your calls to the local API. This is a one-time setup and the token will be stored in your Home Assistant configuration.
To use the local API, you must enable [Somfy TaHoma Developer Mode](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode?tab=readme-ov-file#getting-started) in the TaHoma by Somfy app. Follow the [official instructions](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode?tab=readme-ov-file#getting-started) to generate a token. This token is required to connect Home Assistant to your hub using the local API.
Scenarios and climate entities are **not** supported via the Somfy TaHoma Developer Mode.
{% configuration_basic %}
"Host":
description: "The hostname or IP address of your Overkiz hub. The hostname is your Gateway PIN + .local:8443 (e.g. 1234-4567-8912.local)."
"Username":
description: "Username for your Overkiz cloud account (account you use in your IoT app)."
Password:
description: "Password for your Overkiz cloud account (account you use in your IoT app)."
"Token":
description: "Token generated by the app used to control your device."
Verify SSL:
description: "Verify the SSL certificate of your hub. This option is available only when connecting via the hostname."
{% endconfiguration_basic %}