Inform user that enabling HomeWizard API is not required when using v2 capable API #36884
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a documentation update for the HomeWizard Energy integration, specifically adding a firmware version-specific tip for the Wi-Fi P1 Meter. The new note clarifies that users with firmware version 6 or higher can skip enabling the local API due to a different authentication method, providing more precise setup guidance for users of this device. Changes
Note: No changes were made to exported or public entities in this update. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/homewizard.markdown (1)
39-41: Consider including information about the upcoming batteryBased on the PR objectives, this change applies to both the P1 Meter and an upcoming battery product. Consider expanding the tip to mention both devices.
Here's a suggested expansion:
{% tip %} -If your Wi-Fi P1 Meter is running firmware version 6 or higher, you can skip this step. This version uses a different authentication method that doesn't require enabling the local API. +If your Wi-Fi P1 Meter is running firmware version 6 or higher, or if you're using the HomeWizard Battery, you can skip this step. These devices use a different authentication method that doesn't require enabling the local API. {% endtip %}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/homewizard.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/homewizard.markdown (1)
39-41: Well-placed and clear documentation updateThe tip is appropriately placed in the "Enable the API" section and clearly explains when users can skip this step. The explanation about the different authentication method helps users understand why this exception exists.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…2 capable API
Proposed change
The HomeWizard P1 Meter and the coming battery are using a different authorization method, which is nicely handled by the config flow. The user does not have to turn on the API for this flow.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit