mrbungle64 / node-red-contrib-ecovacs-deebot Goto Github PK

View Code? Open in Web Editor NEW

20.0 5.0 3.0 909 KB

Node-RED node for running Ecovacs Deebot vacuum cleaner robots

License: GNU General Public License v3.0

HTML 52.13% JavaScript 47.87%

node-red-contrib-ecovacs-deebot's Introduction

Ecovacs Deebot node for Node-RED

Node-RED node for running Ecovacs Deebot vacuum cleaner robots.

There's also initial support for some yeedi models (experimental).

This node uses the ecovacs-deebot.js library.

Features

Some noteworthy features are:

Basic cleaning functions (e.g. auto clean, spot area, custom area etc.)
and various other commands (e.g. play sound, reset consumables, relocate position etc.)
Retrieve basic information (e.g. battery level, cleaning log, consumable, cleaning and charging status etc.)
and various extended information (e.g. charging position, current map, network information)
Retrieve information during the cleaning process (e.g. current position and current spot area)
Set basic and advanced settings (e.g. continuous cleaning, do-not-disturb mode, TrueDetect 3D, volume etc.)
Adjustment of vacuum power and water level
Function for loading the current map image

Usage

Ecovacs account

First you have to configure the Ecovacs (or yeedi) account:

"Name" (optional)
"Login" (Ecovacs or yeedi)
"Email / Ecovacs ID" (email or account ID)
"Password"
"Country code" (see here for a list of country codes)

Available nodes

Ecovacs Deebot

Available options:

"Account"
"Name" of the Device
"Device number"
"Connect on startup"
"Retrieve map data object at startup" (experimental)
"Enable output of simple events" (experimental)

Deebot command

Available options:

"Command" (e.g. Start automatic cleaning, Retrieve battery state)
Command specific fields (e.g. Map ID, Spot area ID)

Examples

There are 2 example flows provided by this node:

Basic Flow
Only laser unit models - save map image to file

You can directly import them from the editor using the Import dialog.

Models

Supported models

Deebot OZMO 920/950
Deebot OZMO T8 AIVI
Deebot X1 Turbo

Other models

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

Airbot

Airbot Z1

yeedi

yeedi k650
yeedi 2 hybrid
yeedi vac hybrid
yeedi vac max
yeedi vac 2 pro
yeedi mop station

Note: The lists may not be fully complete

Legacy models (soon to be discontinued)

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.

Installation

The minimum required version is 18.x

This node 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:

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

Known issues

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

Changelog

0.4.13

Bumped minimum required version of Node.js to 18.x
Bumped ecovacs-deebot.js to latest beta version

0.4.12

Bumped ecovacs-deebot.js to latest beta version

0.4.11

Bumped ecovacs-deebot.js to latest alpha version

0.4.10

Bumped ecovacs-deebot.js to latest alpha version
A few changes for AIRBOT Z1 and Z1 Air Quality Monitor

0.4.9

Using library version 0.9.6 (alpha)

0.4.8

Using library version 0.9.5

0.4.7

Using library version 0.9.4
Add some commands for the cleaning station (X1 Omni/Turbo and similar models)

0.4.6

Using library version 0.9.2 (beta)
Fixed cleaning log for N8 series

0.4.5

Added some commands for AIRBOT Z1

0.4.4

Using library version 0.9.1 (alpha)
Fixed cleaning log for T9 based models

0.4.3

Using library version 0.9.0 (beta)
Some minor improvements and fixes

0.4.2

Using library version 0.8.3 (alpha)
Added initial support for yeedi login (experimental)

0.4.1

Using library version 0.8.2
Some minor corrections

0.4.0

Using library version 0.8.1
Added symbols to the command select box
Added some events (e.g. DusterRemind, WaterBoxMoppingType, WaterBoxScrubbingType, CleanCount)
Some further improvements and fixes

0.3.17

Using the latest library version (beta)
Added commands for Auto-Boost Suction and Clean Preference
Corrected some labels for commands in the German version
Some further improvements and fixes

0.3.16

Using library version 0.8.1 (beta)
Some improvements and fixes

0.3.14 - 0.3.15

Using library version 0.8.0 (beta)

0.3.13

Updated dependencies

0.3.9 - 0.3.12

Using library version 0.7.2 (alpha)
Stability improvements
Some minor changes and corrections

0.3.8

Bumped some dependencies (incl. fix for CVE-2022-0155)

0.3.7

Fix the cleaning functions for the Deebot 710 series

0.3.6

Using library version 0.7.0
Some smaller improvements

0.3.5

Using library version 0.6.8

0.3.4

Using library version 0.6.7

0.3.3

Using library version 0.6.6

0.3.2

Using library version 0.6.3
Bump minimum required version of Node.js to 12.x

0.3.1

Using library version 0.6.1-beta.7
Add option for GetMaps command whether to include map image
Some fixes and improvements

0.3.0

Using library version 0.6.1-beta.3
Add option to enable retrieving map object on startup
Add GetSchedule command

0.2.9

Using library version 0.6.1-beta.2
Add AdvanceMode command (950 type models)
Add TrueDetect command (experimental)

0.2.8

Using library version 0.6.1-alpha.15
(unclej84) Add example for saving map image to jpg file

0.2.7

(unclej84) Improve loading of commands.js for deebot-command node
(unclej84) Add basic example

0.2.6

(unclej84) Make node compatible with pre-1.3-versions

0.2.5

Using library version 0.6.1-alpha.11
Some minor changes and fixes

0.2.4

Using library version 0.6.1-alpha.9
Add EnableDoNotDisturb and DisableDoNotDisturb commands (950 type models)

0.2.3

(unclej84) Help texts for display in editor sidebar

0.2.2

Some minor fixes and improvements

0.2.1

Device number starts with 1

0.2.0

Initial npm release
- Add a lot of commands and events
- Using library version 0.6.1-alpha.6
- (unclej84) Add Multi-language support
- (unclej84) A lot of improvements for the node editor
- (unclej84) Use credentials for account data

Disclaimer

I am in no way affiliated with Ecovacs Robotics Co., Ltd. or yeedi Technology Limited.

License

GNU GENERAL PUBLIC LICENSE

node-red-contrib-ecovacs-deebot's People

Contributors

Stargazers

Watchers

Forkers

dsgrafiniert unclej84 carlevans719

node-red-contrib-ecovacs-deebot's Issues

CurrentSpotAreaID value = void

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

Hi, using the command "Retrieve spot areas" I don't get any result.

Debugging at the robot while it cleans, I see:

type: "CurrentSpotAreaID"
value: "void"

With which model does the problem occur?

Other model (please fill out the fields below)

Which "other" models are you using?

Yeedi Cube Robot

Which version of the ecovacs-deebot node are you using?

0.4.8

Which version of Node-RED you have installed?

3.1.0

Which version of Node.js are you using?

3.1.0

Anything in the logs that might be useful?

object
type: "CurrentSpotAreaID"
value: "void"


object
type: "Position"
value: object
coords: "wwww,wwww,wwww" //values present but hidden from me with wwww
x: wwww //values present but hidden from me with wwww
y: wwww //values present but hidden from me with wwww
a: wwww //values present but hidden from me with wwww
invalid: false
spotAreaID: "void"
spotAreaName: "unknown"
distanceToChargingStation: 2.7

Additional information

No response

Command "GetLifeSpan_side_brush" returns lifespan of side and main brush for T9

When injecting command GetLifeSpan_side_brush two messages are returned from Ecovacs Deebot node - lifespan of side brush (expected) and lifespan of main brush (unintended)

deebot ozmo 905 doesn't receive command

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

I try to send start spot area cleaning, I see the message from the debug window but the deebot doesn't start.

With which model does the problem occur?

Deebot OZMO 900/905

Which "other" models are you using?

No response

Which version of the ecovacs-deebot node are you using?

0.4.2

Which version of Node-RED you have installed?

3.0.2

Which version of Node.js are you using?

14.x

Anything in the logs that might be useful?

No response

Additional information

No response

TypeError while connected

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

I´m using Node Red 2.2.2 on Docker and installed node-red-contrib-ecovacs-deebot 0.3.13.
I inserted my Ecovacs login and it says "connected", when I add a debug filter behind the ecovacs node, I get this error:
"TypeError: action.toLowerCase is not a function"

But i receive informations like: object type: "BatteryInfo" value: 75 unit: "%"

With which model does the problem occur?

Deebot T8 series

From which source you have installed the adapter?

GitHub

Version of the ecovacs-deebot.js library

0.3.13.

Version of Node.js

Node Read is installed via Docker.

Operating system

Other

Anything in the logs that might be useful?

No response

Additional information

No response

Command "GetCleanState" returns "CleanReport" and twice "ChargeState" (T9)

Using command "GetCleanState" results in three replies from the robot - once "CleanReport" (expected) and twice "ChargeState".
Can "ChargeState" somehow be filtered out? Is this similar for other models?

Map ID

The question

Hello!
How can I find out the Map ID?

Which model do you own?

None

Additional information

No response

T30 Omni - New Device

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

Hallo,

hier nochmal ein Issue, damit es richtig zugeordnet wird (ich habe ein Ticket im iobroker Adapter eröffnet). Hier wurde es ja bereits gefixt. Nochmal DANKE !!!

In Nodered funktionieren die Befehle nicht (keiner).

With which model does the problem occur?

Other model (please fill out the fields below)

Which "other" models are you using?

Deebot Omni T30

Which version of the ecovacs-deebot node are you using?

0.4.12

Which version of Node-RED you have installed?

v5.2.1

Which version of Node.js are you using?

v18.19.0

Anything in the logs that might be useful?

No response

Additional information

No response

Example flow(s) / explanation for usage would be helpful

It would be nice to have some kind of example flow or some description of how to use in the README or somewhere else (WIKI or examples folder or similar)

Support Get/SetCleaningPreference of your underlying js lib

The feature request

I have seen that your js lib supports GetCleaningPreference/SetCleaningPreference but I cannot find it in the node red addin.
Is it supported / can you add it?

thanks
Michael

Which model do you own?

Other model

Which "other" models are you using?

T20 omni

Which version of the Ecovacs Deebot node are you using?

0.4.8

Additional information

No response

Command "GetLifeSpan" does not return anything on T9

When injecting command GetLifeSpan into Ecovacs Deebot node no message is send on output

Get the Room Name of the current location

Discussed in #45

^{Originally posted by N7-Shepard January 24, 2022}
Is there a possibility to retrieve the room name of the current location of the Deebot?
So, you set names on areas and to get the current position of the deebot, in which room it is, would be necessary to handle for example the events of motion detectors.

Cheers
Ben

Command node - injection with msg.payload

According to the code the command node also accepts commands and arg via msg.payload, msg.arg or/and msg.arg2.

When adding the node without command selected the input is used for passing command and args to Deebot node but it shows invalid argument (red triangle) in the node editor of node-red. The input command is executed correctly.

When adding the node with command the input is ignored and the selected command is always used.

Maybe the order of checks in the deebot-command.js should be switched (first check for msg and then fallback to command) or an additional value in commands drop-down for command input via msg.
Injecting a command via msg would make it much more flexible.

Support for Goat Devices?

The question

This are basically two questions together:

Is there a possibility to find the Device Number of a specific device? E.g. a example query which gives back all possible devices? Visible in the app?

The second question is: Is there basic support (planned) for Goat G1 devices? Maybe I just failed to find the corret Device Number when testing.

Which model do you own?

Other model

Additional information

No response

[FR] Command "Resume"

Currently commands for Clean, Pause and Stop are available but not for Resume - should be made available.

"TypeError: The "command" argument must be of type string. Received undefined"

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

I cannot operate on the "Ecovacs Deebot" node because any attempt to initialize the connection would fail with the error "TypeError: The "command" argument must be of type string. Received undefined" .
The same happens when using the example flows.

I tried to pass msg.payload both with the Deebot Command node and with a simple input node (of course with a string payload containing just "Connect").

With which model does the problem occur?

Deebot T9 series

Which "other" models are you using?

No response

Which version of the ecovacs-deebot node are you using?

0.4.6

Which version of Node-RED you have installed?

3.0.2

Which version of Node.js are you using?

19.6.1

Anything in the logs that might be useful?

No response

Additional information

No response

Data occur multiple times -> +1 each connect

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

Hi,

I think I am using this NodeRed Flow the wrong way:

I wanted to create a trigger which connects, do a little 10s delay and then disconnect (the easiest way to get all data without the need to know if the deebot is connected or not). This should be done every minute. This works in general, but by doing so every message from the Deebot occurs one more time. So, after doing Connect/Disconnect for 3 times e.g. "BatteryInfo" appears 3 times(and every other entry)

This wouldnt be a issue if this only happens in the debug screen. But i will get a syslog message:

| (node:461) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 CurrentCustomAreaValues listeners added to [EcovacsXMPP_XML]. Use emitter.setMaxListeners() to increase limit

If i just Connect + get Data it works fine. But how should I know if the Deebot is still connected? -> so again, I think I am using this the wrong way

With which model does the problem occur?

Deebot OZMO 930

Which "other" models are you using?

No response

Which version of the ecovacs-deebot node are you using?

0.4.8

Which version of Node-RED you have installed?

0.3.2

Which version of Node.js are you using?

16.2

Anything in the logs that might be useful?

No response

Additional information

Raspberry 3B

Issues connecting to account

Just set this node up
When trying to connect to my deebot account i get this error:

Node status just shows red square underneath.

Anything im missing to connect?

Cannot read properties of undefined (reading 'toLowerCase')

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

Stop Cleaning command doesn't work e produce this log on debug screen:

msg : error
"TypeError: Cannot read properties of undefined (reading 'toLowerCase')"

Enrico

With which model does the problem occur?

Deebot N8 series

Which "other" models are you using?

No response

Which version of the ecovacs-deebot node are you using?

0.4.8

Which version of Node-RED you have installed?

3.1.0

Which version of Node.js are you using?

Anything in the logs that might be useful?

No response

Additional information

No response

values mean exactly

The question

Hello!

Is there a list of what the values mean exactly?
I would like to query and the Bleutel in the station is full.
Can you do that too?

Which model do you own?

None

Additional information

No response

Node-Red crashes when the internet connection is lost

Is there an existing issue for this?

I have searched the existing issues and no issue is describing my issue

The problem

Node-Red crashes after about 1min if the internet connection is lost.
This only happens if the Deebot-Node was connected to the server in the first place.

With which model does the problem occur?

Deebot T8 series

Which "other" models are you using?

No response

Which version of the ecovacs-deebot node are you using?

0.3.8

Which version of Node-RED you have installed?

1.2.9

Which version of Node.js are you using?

14.16.0

Anything in the logs that might be useful?

Jan 29 05:33:46 CCU daemon.err node-red: 29 Jan 05:33:46 - [red] Uncaught Exception:
Jan 29 05:33:46 CCU daemon.err node-red: 29 Jan 05:33:46 - Error: read ECONNRESET
Jan 29 05:33:46 CCU daemon.err node-red:     at TLSWrap.onStreamRead (internal/stream_base_commons.js:209:20)
Jan 29 05:33:47 CCU daemon.err node-red: Node-RED exited with non-zero exit status 1

Additional information

No response

Bild der Karte abrufen

Hallo Sascha,

gerne stelle ich meine Frage nochmal hier.
Wie erwähnt ist es mir nicht möglich eine Ausgabe im Debug node zu erhalten wenn ich den inject im ecovacs node starte.
Alles andere funktioniert bei mir einwandfrei.
Ich habe Node Red mit der Version 1.3.5 parallel zu Openhabian v3.1.0 und Openhab3 auf meinem RPI 4 (4GB) installiert.
Der anzusprechende Roboter ist der Ozmo 950 mit der v1.8.2, deinen Adapter habe ich ebenfalls auf 0.3.0 erneuert.
Vielleicht habe ich etwas übersehen, aber auch mit dem Beispiel flow (get mapimage) funktioniert es nicht.

VG
Tom

"CleanSum" summary contains null for "totalTime" and "totalTimeFormatted" (T9)

When running command GetCleanSum 4 messages are returned - totalSquareMeters, totalSeconds, totalNumber and a summary. The summary contains the correct values from the other 3 messages but totalTime and totalTimeFormatted are null.

Command "GetCleanLogs" returns empty message (T9)

When running GetCleanLogs two messages are returned - CleanLog with array[0] and LastCleanLogs with an object of null values:

{"type":"LastCleanLogs","value":{"timestamp":null,"squareMeters":null,"totalTime":null,"totalTimeFormatted":null,"imageUrl":null}}

Make Node compatible with Pre-1.3-Versions

It is possible to get Node-Red version with RED.settings.version. If version >1.3 use resources as currently implemented, otherwise provide custom HTTP Admin endpoint (done in serialport node / documentation here )
This is just a To-Do for milestone 1.0 - will have a look into it the next days.

Ecovacs Deebot Node returning error on Connect command

When injecting Deebot command node with command Connect into Ecovacs Deebot node the Ecovacs Deebot node throws error TypeError: action.toLowerCase is not a function

Commands "GetWaterLevel" and "GetWaterBoxInfo" have same output (T9)

Using commands "GetWaterLevel" and "GetWaterBoxInfo" results in two replies from the robot. Both return "WaterBoxInfo" and "WaterLevel". Is this similar for other models? Possibly one command could be removed if the output cannot be filtered to just get the requested information