Ecovacs Deebot adapter for ioBroker
npm install iobroker.ecovacs-deebot!Logo
!Stable version

!Number of Installations



This adapter uses the ecovacs-deebot.js library.
* Cleaning functions (e.g., auto, area and custom area cleaning) and various other basic functions (e.g., play sound, reset consumables, relocate position)
* Retrieve information (e.g., battery level, cleaning log, consumables status, cleaning and charging status) and various other extended information (e.g., charging position, map-related information)
* Set vacuum power, water level, and other basic adjustments along with various extended settings (e.g., continuous cleaning, do-not-disturb mode, volume, AIVI/TrueDetect 3D)
* Retrieve information of the maps including areas, virtual boundaries, and no-mop-zones, also during the cleaning process (e.g., current position and area)
* Loading the current map image
* Save and recreate full sets of virtual boundaries and no-mop-zones
* Information about the date and time of the last presence for each single area
* Some functionality when returning to the charging station or entering/leaving area
* Save the last used custom area and rerun the saved areas
* Silent approach cleaning and go-to-position functions
* Set individual area names
* Some features (e.g., "Silent approach") are only available for some models (mostly current models)
* and some are still experimental (e.g., "Loading the current map image", handle sets of virtual boundaries)
* The functionality of the adapter is not guaranteed for all models (see below)
The following models I own myself, so they are very widely supported:
* Deebot OZMO 920/950
* Deebot OZMO T8 AIVI
* Deebot X1 Turbo
* Airbot Z1
The following models should work properly or at least partially.
They are either already known to work or are technically similar to these models.
Nevertheless, the functionality may be partially limited.
I try to achieve a wide range of functionality, but decide this case by case depending on complexity and various other criteria.
There is of course no claim to full functionality.
#### Ecovacs Deebot
* Deebot N8 series
* Deebot T8 series
* Deebot T9 series
* Deebot T10 series
* Deebot T20 series
* Deebot X1 series
* Deebot X2 series
#### yeedi
* yeedi k650
* yeedi 2 hybrid
* yeedi vac hybrid
* yeedi vac max
* yeedi vac 2 pro
* yeedi mop station
Note: All these lists may not be fully complete
Legacy models that use XML for data transport (e.g. Deebot OZMO 930, Deebot 900/901) are mostly still working,
but support for these models will be discontinued sooner or later.
Please check this readme for more information.
To use this adapter, you will need to already have ioBroker installed.
The minimum required version of Node.js is 16.x.
This adapter uses the node-canvas library for some map-related functionality
which may require the installation of some additional packages.
The installation of canvas is optional and not necessary for models without map functionality,
but for full functional range please install the following packages.
For Debian-based Linux systems the following commands should be executed:
``bash`
sudo apt-get update
sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
A reboot might be necessary before executing the next command
`bash``
npm install canvas --unsafe-perm=true
For instructions for other systems visit https://www.npmjs.com/package/canvas#compiling
Frequently asked questions can be found here
Information on how to use this adapter can be found here
Information about the states can be found here (English)
and here (German)
* The "move" function varies from model to model, so it's not implemented universally
* The generation of map images is not stable on 32-bit systems
* and it still does not work properly with the Deebot X1 series and other current models
I am in no way affiliated with Ecovacs Robotics Co., Ltd. or yeedi Technology Limited.
MIT License
Copyright (c) 2024 Sascha Hölzel
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.