search

gilmrt / Domoticz-Botvac-Plugin

Domoticz Plugin for Botvac (Neato) Vacuum
2 stars 2 forks source link

readme

Domoticz-Botvac-Plugin

Domoticz Plugin for Botvac (Neato) Vacuum

This plugin uses the pybotvac library 0.0.19 or later

How it works

Plugin provides: Status, Control and schedule status devices

Status: show current status in readable layout of switch. Status updates by polls (interval) and when you click Control device (for instant status change)

Control: for sending commands

Schedule: for enable or disbled sheduled cleans

Installation

Before installation plugin check the python3, python3-dev, pip3 is installed for Domoticz plugin system:

sudo apt-get update && sudo apt-get install python3 python3-dev pip3

Install Botvac plugin dependencies:

sudo pip3 install pybotvac urllib3 requests

Then go to plugins folder and clone repository:

cd domoticz/plugins
git clone https://github.com/gilmrt/Domoticz-Botvac-Plugin.git

Only for Botvac D5 owners

If you use persistent map for cleaning, please add this step so the cleaning will the map (Map is not detected by the pybotvac before Botvac D7 version)

git checkout BotvacD5

Restart the Domoticz service

sudo service domoticz restart

Now go to Setup -> Hardware in your Domoticz interface and add type with name Botvac Vacuum.

Field Information
Neato email Neato email account
Neato password Neato password
Botvac vacuum name The name of your Botvac vacuum
Debug When set to true the plugin shows additional information in the Domoticz log
Update interval In seconds, this determines with which interval the plugin polls the status of Vacuum. Minimun 10s. Default 60s

After clicking on the Add button the new devices are available in Setup -> Devices.

How to update plugin

cd domoticz/plugins/Domoticz-Botvac-Plugin
git pull

Restart the Domoticz service

sudo service domoticz restart

OPTIONAL: Update pybotvac

pip3 install --upgrade pybotvac

or update to selected version using:

pip3 install --upgrade pybotvac==0.0.19

Screenshots

Create a Neato account if not already done

Create a Neato account if not already done at neatorobotics.com Then go to your account or Use the Neato mobile app

Custom Icons

You can add dedicated custom icons in Domoticz by loading icons.zip in Settings/Custom Icons/Add
INFO : I removed the automatic icons insertion due to a bug in Python Plugin in Domiticz which failed when plugin restart to create icons again causing error (seen in error logs)