-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Update documentation for new local api config flow in Overkiz. #38641
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation for new local api config flow in Overkiz. #38641
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Overkiz integration was updated to clarify the process for enabling and using the Somfy TaHoma Developer Mode with the local API. Instructions now direct users to activate Developer Mode via the "TaHoma by Somfy" app and obtain a token following official guidelines. The configuration section was also revised to replace separate username and password fields with a single token field, reflecting the updated authentication method. No changes were made to code or exported entities; only documentation content and configuration descriptions were modified. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant TaHoma App
participant Home Assistant
User->>TaHoma App: Enable Developer Mode
User->>TaHoma App: Generate Token (following official instructions)
User->>Home Assistant: Enter Token in configuration
Home Assistant->>TaHoma Hub: Authenticate using Token via local API
TaHoma Hub-->>Home Assistant: Grant access for device control
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/overkiz.markdown (1)
83-84
: Streamline wording and remove duplicate link
The two sentences on enabling Developer Mode and fetching the token use the same link twice and can be combined for clarity. Consider merging them into a single sentence:@@ -83,2 +83,1 -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. +To use the local API, 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 and follow the official instructions to generate the token required to connect Home Assistant to your hub using the local API.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/overkiz.markdown
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/overkiz.markdown (1)
90-91
: Updated configuration field is clear and accurate
The addition of the"Token"
field and its description correctly reflects the new authentication flow. No further changes needed here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @iMicknl 👍
Proposed change
Update the documentation to accommodate recent changes in home-assistant/core#143181, where the config flow of the local API is changing.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit