No announcement yet.

Neato Botvac Robot Vacuums

This topic is closed.
This is a sticky topic.
  • Filter
  • Time
  • Show
Clear All
new posts

  • 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 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.

    • This plug-in is for HS3 or HS3PRO. It works with both Windows and Linux versions
    • Windows: .NET Framework 4.5 or later
    • Linux: mono 4.x or later
    • 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, you will need to “Authorize” the plug-in 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: Advanced plug-in settings. Normally, there is no need to change any of those and any change of those settings might negatively impact the functionality of the plug-in.

    If anything doesn’t work, you can try one the following:
    • Stop and restart the plug-in. Any changes in the Robot or Neato API configuration should be detected and the plug-in 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 plug-in” again (see instructions above, Configuration, Setup)
    • If that fails, go to Settings and select “Refresh all Neato devices” (available in version and above). That 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 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.4.0-72.
    • 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.
    • If your registration on the Neato Robot or Neato website changes (for instance, re-registration of the Robot), that might trigger a change of the security key used by this plug-in. A restart of the plug-in should resolve any issues caused by this security key change.
    Last edited by stefxx; May 2nd, 2018, 03:59 AM.

  • #2

    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:
    Click image for larger version  Name:	neato.jpg Views:	1 Size:	75.8 KB ID:	1196708
    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: 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:
    Click image for larger version  Name:	settings.jpg Views:	1 Size:	27.3 KB ID:	1196709

    Map devices. You can go back 20 maps (if available and supported by your device) and see cleaning properties, statistics, and other info, including 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).
    Click image for larger version  Name:	maps.jpg Views:	1 Size:	78.6 KB ID:	1196710

    Config. Here you allow the plugin access to your Neato account, and it shows all the robots discovered:
    Click image for larger version  Name:	robots.jpg Views:	1 Size:	38.2 KB ID:	1196711
    Last edited by stefxx; September 6th, 2018, 01:57 AM.


    • #3
      Release notes

      Release, 02-11-2019
      - Reformatted Secret Key in config pages (new models use 256 key length)
      - Added support for Imperial units

      Release, 23-06-2019
      - Added preferences support for robotSounds (supported models only)

      Release, 02-04-2019
      - Fixed device images
      - Fixed Parent/Child device relationship
      - Added Robot replace function

      Release, 18-03-2019
      - Fixed 404 error when secret_key changed (for instance, due to a re-registration of same Robot)
      - Added confirmation to "Remove all Neato devices"
      - Added "Refresh all Neato devices" as additional troubleshooting option

      Release, 29-01-2019
      - Improved error messaging during connection failures
      - Added multiple persistent map and zone support (supported models only)

      Release, 04-01-2019
      - Fixed errors when non-supported devices are registered on a Neato account
      - Fixed Eco/Turbo/Deep options (due to firmware change) for D7 and possibly other affected models (new installs only)

      Release, 07-12-2018
      - Added support for the Neato D4 connected and D6 connected
      - Fix for Map cleaning (due to firmware change) for D7 and possibly other affected models

      Release, 02-09-2018
      - Fixed the "Active" indicator on the config page

      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; November 5th, 2019, 11:20 AM.