Go Back   HomeSeer Message Board > 3rd Party Plug-Ins/Scripts > Plug-ins by Author > Click Here for List of Author Forums > stefxx Plug-Ins

stefxx Plug-Ins Plug-Ins by stefxx

Closed Thread
Thread Tools Display Modes
Old April 17th, 2018, 04:14 PM
stefxx's Avatar
stefxx stefxx is offline
Seer Master
Join Date: Sep 2008
Location: Netherlands
Posts: 673
Neato Botvac Robot Vacuums


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

  • This plugin is for HS3 or HS3PRO. It works with both Windows and Linux versions
  • .NET Framework 4.5 or later, or mono 4.x needs to be installed on your Homeseer machine
  • A valid Neato account with the robot(s) properly registered


There are no additional software requirements. The plug-in can be installed from the HS3 updater, and can be found under the section “Robotics”.


After installation and starting the plug-in, go to the configuration page. They are three 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, please “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, a authorization key, access tokens and robot name(s) will be shown next to the buttons.
  • Robots: After successful setup, your robots will be listed here.
  • Settings: Details plug-in settings. Normally, there is no need to change any of those and change of settings might negatively impact the functionality of the plug-in.


If anything doesn’t work, you can try one the following:
  • Go to the Setup page. Try to “Refresh robot list”.
  • If that fails, try to “Generate security token”.
  • If that fails, start by “Authorize plgin” again (see instructions above, Configuration, Setup)
  • When you experience issues with (one of) the HomeSeer Neato devices, go to Settings and select “Remove all Neato devices”. Then go back to Setup and select “Refresh robot list”. This will regenerate all required HomeSeer devices. Note that this might impact events, scripts, HStouch or other places were the devices are referenced.
  • If all fails, remove all Neato devices (see above), stop the Plug-in, and remove “Config/Neato.ini”. Then start the Plug-in and start the configuration over.

  • The plug-in has been tested with a Botvac Connected with firmware 2.2.0 and a Botvac D7 Connected with firmware 4.1.0-653.
  • The plug-in also supports the Botvac D3 Connected and Botvac D5 Connected, but as I do not own these devices please let me know if something doesn't work as expected.
  • Not all features are supported on all models. Where possible, only supported features will show as options in the Plug-in devices.

Last edited by stefxx; May 2nd, 2018 at 04:59 AM.
Old April 27th, 2018, 10:59 AM
stefxx's Avatar
stefxx stefxx is offline
Seer Master
Join Date: Sep 2008
Location: Netherlands
Posts: 673

Some screenshots of the Neat plug-in. Note that not all devices and/or options are available on all models, and can even be different between firmware versions!

Main devices, that holds the current status, alerts, errors and actions. Also cleaning options can be defined here:
Name:  neato.jpg
Views: 85
Size:  75.8 KB
Based on the capabilities of your robot, a few cleaning options can be set:
- Modifier (not in the above screenshot): The cleaning frequency, Normal or Double. Currently only used for SpotCleaning.
- Mode: Eco (quieter, longer cleaning run) or Turbo (super powered cleaning with maximum pickup)
- NavigationMode: Normal, Extra care (gentle navigation) or Deep. Extra care: https://support.neatorobotics.com/hc...re-Navigation-. Deep: I couldn't find any documentation on Deep, but based on a test, it will take a lot longer to clean. Note that Deep also requires Turbo Mode.
- Selecting "Last", resets the option to what has been used during the last cleaning session.

Setting devices. Some devices have more, others have less or no options to configure. The plugin only shows options compatible with your device:
Name:  settings.jpg
Views: 85
Size:  27.3 KB

Map devices. You can go back 20 maps (if available and supported by your device) and see cleaning properties, statistics and other info, next the the map itself. If you click on the map, it will display the map in a separate window. Maps are also downloaded to the html/NeatoMaps directory for easy access (in HSTouch or other applications).
Name:  maps.jpg
Views: 85
Size:  78.6 KB

Config. Here you allow the plugin access to your Neato account, and it shows all the robots discovered:
Name:  robots.jpg
Views: 85
Size:  38.2 KB

Last edited by stefxx; May 21st, 2018 at 08:43 AM.
Old May 10th, 2018, 05:20 AM
stefxx's Avatar
stefxx stefxx is offline
Seer Master
Join Date: Sep 2008
Location: Netherlands
Posts: 673
Release notes

Release, 10-06-2018
- Fixed crash when robot is not responding during initial setup
- Improved connection with Neato cloud and better handling of errors
- Differentiate between Offline (-1) and Robot offline (-2) in Status device
- Display connection errors in log now optional (default=off)
- Optionally log to file (instead of eventlog)
- Check and report if another version of Newtonsoft.Json.dll is found

Release, 17-05-2018
- Added "Active" indicator for each robot on the config page
- Moved map images to a unique directory for each robot (html/NeatoMaps/#serial)
- Fixed invalid Map #0 from selection
- Fixed map retrieval after cleaning session
- Fixed NavigationMode setting
- Fixed several Linux related issues

Release, 11-05-2018
- Added quick selection of available maps
- Changed LastUpdate of Map devices to reflect actual end-time
- Added Pause before Dock for devices that cannot Dock without Pause first
- Fixed crash when unknown robot error is returned from API

Release, 27-04-2018
- Added Maps (and map history) including statistics
- Added (much) better icons all devices
- Added more descriptive alert and error messages (firmware 3.x and up)
- Moved settings to a new root device
- Removed "Map" button on devices that do not support virtual no-go lines
- Several minor fixes

Release, 24-04-2018
- Added Mode, Modifier, NavigationMode, SpotWidth and SpotHeight
- Added Persistent Map cleaning
- Fixed DirtbinAlertReminder, FilterChangeReminder and BrushChangeReminder
- Added Token Refresh (security)
- Stability improvements

Release, 20-04-2018
- Fixed bin/Bin Linux dll issue
- Fixed crash at startup with Botvac Connected
- Stability improvements

Release, 17-04-2018
- Initial version

Last edited by stefxx; June 10th, 2018 at 04:22 PM.
Closed Thread


Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is On

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Neato connect series is now open for "hacking" Elmstrom HomeSeer General Discussion Area 35 April 18th, 2018 06:19 AM
How well do self cleaning robot vacuums actually work? NeverDie Off Topic 57 December 29th, 2016 02:06 AM
Robot insects Uncle Michael Off Topic 2 August 15th, 2014 11:01 AM
Robot Vac Anyone Seen? Xjk UK/Europe 6 July 16th, 2004 06:06 PM
New Robot Vac out... madigan General Home Automation Hardware Discussion 5 September 18th, 2002 03:58 AM

All times are GMT -4. The time now is 12:28 PM.

Copyright HomeSeer Technologies, LLC