Add AiDot integration documentation#44479
Add AiDot integration documentation#44479s1eedz wants to merge 11 commits intohome-assistant:currentfrom
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation for a new AiDot integration that enables users to control AiDot Wi-Fi lights through Home Assistant.
Changes:
- Added new integration documentation file with front matter, prerequisites, configuration options, data updates, supported devices, troubleshooting, and removal instructions
- Configured for cloud polling with config flow setup and HomeKit support
- Documented support for A19 and BR30 light models
| @@ -0,0 +1,52 @@ | |||
| --- | |||
| title: AiDot | |||
| description: Instructions on integrating AiDot home security with Home Assistant. | |||
There was a problem hiding this comment.
The description mentions "AiDot home security" but the integration is for controlling Wi-Fi lights, as indicated in the content on line 18 and the ha_category of "Light". The description should be corrected to reflect that this is a light control integration, not home security.
|
|
||
| ## Prerequisites | ||
|
|
||
| - To be able to configure your machine in Home Assistant, your machine needs to be added to your account using the official AiDot app first. |
There was a problem hiding this comment.
The text refers to "your machine" but should refer to "your device" or "your lights". "Machine" could refer to appliances like coffee machines or washers, while the AiDot integration is specifically for controlling light bulbs. This should be updated for clarity and consistency with light-related terminology.
| - To be able to configure your machine in Home Assistant, your machine needs to be added to your account using the official AiDot app first. | |
| - To be able to configure your lights in Home Assistant, your lights need to be added to your account using the official AiDot app first. |
| - After successful login, the device list will be pulled from AiDot Cloud first | ||
| - After pulling the list, the integration will pull the latest list from the cloud every 6 hours and process additions and deletions | ||
| - The integration will update its lights by polling the AiDot Bridge every five seconds for new values. |
There was a problem hiding this comment.
The list items in the "Data updates" section are incomplete sentences and lack proper periods. According to the Home Assistant documentation standards, when list items are complete sentences or should be treated as such, they must end with periods. Additionally, "After successful login, the device list will be pulled from AiDot Cloud first" is unclear without context (first compared to what?). Consider revising for clarity and consistency.
| - After successful login, the device list will be pulled from AiDot Cloud first | |
| - After pulling the list, the integration will pull the latest list from the cloud every 6 hours and process additions and deletions | |
| - The integration will update its lights by polling the AiDot Bridge every five seconds for new values. | |
| - After you sign in successfully, the integration retrieves the device list from AiDot Cloud. | |
| - After the initial device list is retrieved, the integration checks the cloud every 6 hours and processes any additions or deletions. | |
| - The integration updates its lights by polling the AiDot Bridge every five seconds for new values. |
| ha_integration_type: integration | ||
| --- | ||
|
|
||
| The [AiDot](https://www.aidot.com/) {% term integration %} allows you to control the Wi-Fi lights with Home Assistant. |
There was a problem hiding this comment.
The introduction section is very brief and lacks a use case description. According to the Home Assistant documentation standards, integration introductions should include both a description of what the integration does and a use case explaining practical benefits. Consider expanding this section to provide context about why users might want to use this integration with Home Assistant.
| The [AiDot](https://www.aidot.com/) {% term integration %} allows you to control the Wi-Fi lights with Home Assistant. | |
| The [AiDot](https://www.aidot.com/) {% term integration %} lets you control supported AiDot Wi-Fi lights in Home Assistant. | |
| Use case: This integration is useful if you want to manage your AiDot lights alongside your other smart home devices, include them in automations, and control your lighting from one place. |
home-assistant
bot
added
the
in-progress
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
home-assistant
bot
added
the
needs-rebase
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.