States (EN)

Remarks

• The majority of the states depend on the model. The highest probability that the state will be created and filled to the full extent is with the fully supported models.
• In the adapter settings you can activate several states (but not all) - if they are not available for the model by default.
• States, which are available for each model are displayed bold
• Channels and their States, which are created dynamically (e.g. depending on the areas of the map) are displayed in italics.

cleaninglog

• If the channel cleaninglog is not available, it can be activated via the setting "Display various cleaninglog values (cleaninglog)" (up to version 1.4.4)
• The "lastCleaning..." states are only available on models with laser or camera navigation

ID	description
last20Logs	The data of the last 20 cleanings in JSON format
lastCleaningDate	Date and time of the last cleaning
lastCleaningMapImageURL	URL to the map of the last cleaning
lastCleaningTimestamp	Unix timestamp of the last cleaning
lastSquareMeters	Cleaned area during the last cleaning (m2)
lastTotalSeconds	Total time of the last cleaning (seconds)
lastTotalTimeString	Duration of the last cleaning (hh:mm:ss)
totalNumber	Total number of cleanings
totalSeconds	Duration of cleaning in seconds
totalSquareMeters	Cleaned area (m2)
totalTime	Duration of cleaning (hh:mm:ss)

cleaninglog.current

ID	description
cleanType	Current clean type
cleanedArea	Current cleaned area (m²)
cleanedSeconds	Current cleaning time (seconds)
cleanedTime	Current cleaning time

consumable

ID	description
filter	Remaining duration for the filter (%)
filter_reset	Reset filter
main_brush	Remaining duration for the main brush (%)
main_brush_reset	Reset main brush
side_brush	Remaining duration for the side brush (%)
side_brush_reset	Reset side brush
unit_care	Remaining duration for "other components" (%)
unit_care_reset	Reset "other components"

control

ID	description
charge	Return to the charging station
clean	Start automatic cleaning
cleanSpeed	Cleaning power
cleanSpeed_reset	Reset cleanSpeed for all spot areas
cleanSpeed_standard	cleanSpeed for spot areas if no other value is set
customArea	Start user-defined cleaning for the specified area (coordinates x1,y1,x2,y2)
customArea_cleanings	Number cleanings for the specified area
edge	Start edge cleaning (not available for laser-navigated models)
pause	Pauses the cleaning
playIamHere	Play "I am here"
playSound	Play a sound
relocate	Change the location
resume	Resume the cleaning
spot	Start spot cleaning (not available for laser-navigated models)
spotArea	Start area cleaning for the specified area(s) (comma-separated)
spotArea_[spotAreaID]	Start area cleaning for this area
spotArea_cleanings	Number cleanings for the specified area(s)
stop	Stop the cleaning
waterLevel	Water flow rate
waterLevel_reset	Reset 'waterLevel' for all spot areas
waterLevel_standard	waterLevel for spot areas if no other value is set

control.extended

ID	description
continuousCleaning	Continuous cleaning mode on/off
doNotDisturb	Do not disturb mode on/off
goToPosition	Go to position function
pauseBeforeDockingChargingStation	Pause once before docking charging station
pauseBeforeDockingIfWaterboxInstalled	Pause always before docking if waterbox is installed
pauseWhenEnteringSpotArea	Pause when entering the specified spot area
pauseWhenLeavingSpotArea	Pause when leving the specified spot area

control.move

ID	description
backward	Move backward
forward	Move forward
left	Move left
right	Move right
stop	Stop

history

ID	description
dateOfLastStartCharging	Date and time of the last charge start
dateOfLastStateChange	Date and time of the last state change
timestampOfLastStartCharging	Unix timestamp of the last charge start
timestampOfLastStateChange	Unix timestamp of the last state change

info

Some of the states have been moved to the subfolders library (*) and network (**) with version 1.2.0

ID	description
battery	Remaining battery (%)
canvasModuleIsInstalled *	Indicates if the canvas module is installed
chargestatus	The charge status
cleanstatus	The clean status
communicationProtocol *	Indicates if the MQTT or XMPP protocol is used
connection	The connection status
debugMessage *	Debug message
deviceClass *	The Ecovacs device class
deviceImageURL *	URL to an image for the Deebot model
deviceIs950type *	Indicates if the device a 950 type model
deviceModel	The name of the Deebot model
deviceName	The nick name of the device
deviceStatus *	The device status
error	Error message
errorCode	Error code
firmwareVersion	Firmware version
ip **	IP address of the device
mac **	MAC address of the device
sleepStatus	Indicates if the device is in sleep mode
version	The version of the adapter and the version the library
waterbox	Indicates if the waterbox is installed
wifiSSID **	The WiFi SSID
wifiSignal **	The signal strength (RSSI)

map

ID	description
chargePosition
currentMapIndex
currentMapMID
currentMapName
deebotDistanceToChargePosition
deebotPosition
deebotPositionCurrentSpotAreaID
deebotPositionCurrentSpotAreaName
deebotPositionIsInvalid
deebotPosition_angle
deebotPosition_x
deebotPosition_y
lastUsedCustomAreaValues
lastUsedCustomAreaValues_rerun
lastUsedCustomAreaValues_save
relocationState

map.savedCustomAreas

ID	description
customArea_[timestamp]

map.[MapID]

ID	description
loadMapImage
map64
mapDeactivationTimestamp
mapID
mapIsAvailable
mapName
saveVirtualBoundarySet

map.[MapID].spotAreas.[spotAreaID]

ID	description
cleanSpeed
cleanSpotArea
spotAreaBoundaries
spotAreaDeactivationTimestamp
spotAreaID
spotAreaIsAvailable
spotAreaName
waterLevel

map.[MapID].virtualBoundaries.[virtualBoundaryID]

ID	description
deleteVirtualBoundary
saveVirtualBoundary
virtualBoundaryCoordinates
virtualBoundaryID
virtualBoundaryType

Various channels in map.[MapMID]

This channels are only available for 950 type models (see info.deviceIs950type)

In each of these channels, buttons are available for restoring and to rerun the saved area cleanings.

Channel	description
savedBoundaries	Created by map.[MapID].virtualBoundaries.[VirtualBoundaryID].saveVirtualBoundary
savedBoundarySets	Created by map.[MapID].saveVirtualBoundarySet
savedCustomAreas	Created by map.lastUsedCustomAreaValues_save
savedSpotAreas	Created by map.currentSpotAreaValues_save