Installation and configuration

[stefxx]

DESCRIPTION

This Plugin is designed to work with the Neato Botvac Connected Robot Vacuums. This includes the Botvac Connected, Botvac D3 Connected, Botvac D4 Connected, Botvac D5 Connected, Botvac D6 Connected and Botvac D7 Connected. It supports multiple robots, as long as they are registered on the same Neato account.

REQUIREMENTS

• This Plugin is for HS4 only. It works with both Windows and Linux versions
• Windows: .NET Framework 4.7.2 or later
• Linux: mono 5.18 or later
• A valid Neato account with the robot(s) properly registered

INSTALLATION

There are no additional software requirements. Start by selecting “Add” from the “Plugins” menu:

Search for “Neato” and click on the “Neato Botvac” found:

Click “INSTALL” from the popup shown above, and the plugin will complete the installation:


CONFIGURATION

After installation and starting the Plugin, go to the configuration page. They are four tabs:

• Setup: For a first setup, execute the four steps in the order shown. For step one, a new window will open and you need to enter your Neato account credentials. On the next page, you will need to “Authorize” the Plugin to use your account. When the confirmation page is shown, please close the window. Step 2, 3 and 4 do not require any additional steps and when successful, authorization key, access tokens and robot name(s) will be shown below the buttons.

• Robots: After successful setup, your robots will be listed here.

• Settings: Advanced Plugin settings. Normally, there is no need to change any of those and any change of those settings might negatively impact the functionality of the Plugin.

• Replace: This is an experimental feature. When we replace your robot, here you can attempt to re-use your existing HS4 devices, so impact to events, scripts, HSTouch etc. will be limited.

TROUBLESHOOTING

If anything doesn’t work, you can try one the following:

• Stop and restart the Plugin. Any changes in the Robot or Neato API configuration should be detected and the Plugin will be updated with the new information.
• If that fails, go to the Setup page. Try to “Refresh robot list”.
• If that fails, try to “Generate security token”.
• If that fails, start by “Authorize Plugin” again (see instructions above, Configuration, Setup)
• If that fails, go to Settings and select “Refresh all Neato devices”. This will re-create all Neato devices, but keeps the original device reference ID's.
• Alternatively to "Refresh all Neato Devices", go to Settings and select “Remove all Neato devices”. Then go back to Setup and select “Refresh robot list”. This will re-create all required HomeSeer devices. New reference ID's will be assigned, so this might impact events, scripts, HStouch or other places were the devices are referenced by their reference ID.
• If all fails, remove all Neato devices (see above), stop the Plugin, and remove “Config/Neato.ini”. Then start the Plugin and start the configuration over.

NOTES

• The Plugin is tested extensively with a Botvac Connected with firmware 2.2.0 and a Botvac D7 Connected with firmware 4.5.3-189. All other Botvac Connected robots are supported but as I don’t own them, support might be more difficult and new features specific for those devices might take longer to support.
• Not all features are supported on all models. Where possible, only supported features will show as options in the Plugin devices.
• If your registration on the Neato Robot or Neato website changes (for instance, re-registration of the Robot or sometimes also a firmware update), that might trigger a change of the security key used by this Plugin. A restart of the Plugin should resolve any issues caused by this security key change.