-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Add documentation for Neato switch #1261
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
Conversation
Signed-off-by: Hugo D. (jabesq) <jabesq@gmail.com>
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.
Looks good with some minor changes needed.
footer: true | ||
logo: neato.png | ||
ha_category: Switch | ||
ha_release: 0.3X |
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.
Obvious but needs to be updated to the release in question it's merged into.
switch: | ||
platform: neato | ||
username: USERNAME | ||
password: PASSWORD |
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.
Under this it's recommended to include a overview for the variables.
Example https://home-assistant.io/components/switch.template/
This will automatically add switch for each Botvac Connected that you have. The switch will start a full home cleaning when turn ON and return the robot to base when turn OFF. | ||
|
||
<p class='note'> | ||
The Home Assistant Neato platform has only be tested a Botvac Connected. There is no support for the Botvac D3 Connected and Botvac D5 Connected robots at this time. |
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.
Is the full model name Botvac Connected?
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.
Yes, the full name of the supported robot is Botvac Connected
@@ -14,6 +14,8 @@ ha_release: 0.3X | |||
|
|||
The `neato` switch platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). | |||
|
|||
This will automatically add switch for each Botvac Connected that you have. The switch will start a full home cleaning when turn ON and return the robot to base when turn OFF. |
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.
.. when turn ON.. ..when turn OFF.
Both of these should be turned ON/OFF
Changes looks good but found another one :) |
Description:
Add documentation for Neato Robotics switch, which add control for Botvac Connected robot (https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/)
Pull request in home-assistant (if applicable): home-assistant/core#3935