Installation

npm

npm install ecovacs-deebot

GitHub

git clone https://github.com/mrbungle64/ecovacs-deebot.js.git
cd ecovacs-deebot.js
npm install

Dependencies

This library uses the node-canvas library for some map-related functionality which may require the installation of some additional packages. This 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:

sudo apt-get update
sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

Installation for canvas on alpine based systems (e.g. Node-RED docker container):

apk add --no-cache build-base g++ cairo-dev jpeg-dev pango-dev giflib-dev

A reboot might be necessary before executing the next command

npm install canvas --unsafe-perm=true

For instructions for other systems visit https://www.npmjs.com/package/canvas#compiling

Afterwards you can install the library with

npm install ecovacs-deebot

If you want to install this library explicitly without canvas you can install it with

npm install ecovacs-deebot --no-optional

The minimum required version of Node.js is 14.x. It is recommended to use version 16.x or 18.x