Usage

To get started, you'll need to have already set up an Ecovacs account using your smartphone.

Connecting to your vacuum is performed in two steps:

1. Connect to the HTTP API and retrieve the devices connected to your account
2. Connect to the Ecovacs server to send and receive messages to/from the DEEBOT vacuum

Once the session has started the vacuum will fire a ready event. At this point you can request information from your vacuum or send actions to it.

Example

const ecovacsDeebot = require('ecovacs-deebot');
const EcoVacsAPI = ecovacsDeebot.EcoVacsAPI;
const nodeMachineId = require('node-machine-id');

// The account_id is your Ecovacs ID or email address.
const account_id = "[email protected]";
const password = "a1b2c3d4";

const deviceID = 0; // The first vacuum from your account

// You need to provide a device ID uniquely identifying the
// machine you're using to connect, the country you're in.
// The module exports a countries object which contains a mapping
// between country codes and continent codes.
const countryCode = "de"; // If it doesn't appear to work try "ww", their world-wide catchall.
const device_id = EcoVacsAPI.getDeviceId(nodeMachineId.machineIdSync(), deviceID);
const continent = ecovacsDeebot.countries[countryCode.toUpperCase()].continent.toLowerCase();
// Leave blank or use 'ecovacs.com' for Ecovacs login
// or use 'yeedi.com' for yeedi login (available since version 0.8.3-alpha.2)
const authDomain = '';

let api = new EcoVacsAPI(device_id, countryCode, continent, authDomain);

// The password_hash is an md5 hash of your Ecovacs password.
const password_hash = EcoVacsAPI.md5(password);

// This logs you in through the HTTP API and retrieves the required
// access tokens from the server side. This allows you to requests
// the devices linked to your account to prepare connectivity to your vacuum.
api.connect(account_id, password_hash).then(() => {

    api.devices().then((devices) => {
        console.log("Devices:", JSON.stringify(devices));

        let vacuum = devices[deviceID];
        let vacbot = api.getVacBot(api.uid, EcoVacsAPI.REALM, api.resource, api.user_access_token, vacuum, continent);

        // Once the session has started the bot will fire a 'ready' event.
        // At this point you can request information from your vacuum or send actions to it.
        vacbot.on("ready", (event) => {
            console.log("vacbot ready");

            vacbot.run("BatteryState");
            vacbot.run("GetCleanState");
            vacbot.run("GetChargeState");

            vacbot.on("BatteryInfo", (battery) => {
                console.log("Battery level: " + Math.round(battery));
            });
            vacbot.on('CleanReport', (value) => {
                console.log("Clean status: " + value);
            });
            vacbot.on('ChargeState', (value) => {
                console.log("Charge status: " + value);
            });
        });
        vacbot.connect();
    });
}).catch((e) => {
    console.error("Failure in connecting!");
});

There are shortcut functions available to run actions on your bot.