Skip to content
Sascha edited this page Mar 7, 2023 · 33 revisions

Simple events

Vacuum status

Name Description Support
BatteryInfo Battery level (%) Should work with all models
ChargeState Charging status Should work with all models
CleanReport Cleaning status Should work with all models
DustCaseInfo Indicates if the dust case is installed Works only with a few models (e.g. OZMO 930)
RelocationState Relocation status Should work with most 950 type models
SleepStatus Indicates if the device is in sleeping mode Should work with most models
WaterBoxInfo Indicates if the water box is installed Should work with most models with mopping system

Vacuum settings

Name Description Support
CleanSpeed Vacuum power level Should work with most models that have different vacuum power levels
ContinuousCleaningEnabled Indicates if continuous cleaning mode is enabled Should work with some models (tested on Deebot 901 and OZMO 930)
DoNotDisturbEnabled Indicates if do-not-disturb mode is enabled Should work with some models (tested on Deebot 901 and OZMO 930)
VoiceReportDisabled Indicates if voice report is disabled Should work with some models (untested)
WaterLevel Mopping water amount Should work with most models with mopping system

Cleaning log and summary

Name Description Support
CleanLog JSON data of the last 20 cleanings Should work with all models
CleanLog_lastImageTimestamp Timestamp of last cleaning image Should work with all models with mapping functionality
CleanLog_lastImageUrl URL of last cleaning image Should work with all models with mapping functionality
CleanLog_lastSquareMeters Cleaned area of the last cleaning Should work with all models
CleanLog_lastTimestamp Timestamp of the last cleaning Should work with all models
CleanLog_lastTotalTimeString Date and time of the last cleaning Should work with all models
CleanSum_totalNumber Total number of cleanings Should work with all models
CleanSum_totalSeconds Total time in seconds Should work with all models
CleanSum_totalSquareMeters Total square meters Should work with all models

Life span

Name Description Support
LifeSpan_filter Filter lifespan Should work with all models
LifeSpan_main_brush Main brush lifespan Should work with all models that have a main brush
LifeSpan_side_brush Side brush lifespan Should work with all models

Map data

For further information also check this article

Name
Maps
MapSpotAreas
MapSpotAreaInfo
MapVirtualBoundaries
MapVirtualBoundaryInfo

Position data

Name Description Support
DeebotPosition Current position where the bot is located (x, y, angle *)
DeebotPositionCurrentSpotAreaID Current spot area ID where the bot is located
ChargePosition Last charging position (x, y, angle *)

*) angle: 0 = facing right, 90 = facing upwards, 180/-180 = facing left, -90 = facing downwards

Other map, position and area data

Name
CurrentMapIndex
CurrentMapMID
CurrentMapName
LastUsedAreaValues
DeebotPositionIsInvalid

Network

Name
NetInfoIP
NetInfoMAC
NetInfoWifiSignal
NetInfoWifiSSID

Errors

For a full dictionary of error codes see here

Name
ErrorCode
Error

Combined events

LifeSpan

{
  "filter": 65.44,
  "side_brush": 70.56,
  "main_brush": 90.72
}

Position

{
  "coords": "81,373,89",
  "x": 81,
  "y": 373,
  "a": 89,
  "invalid": false,
  "spotAreaID": "0"
}

*) a = angle: 0 = facing right, 90 = facing upwards, 180/-180 = facing left, -90 = facing downwards

ChargingPosition

{
  "coords": "81,373,-90",
  "x": 81,
  "y": 373,
  "a": 89
}

LastCleanLogs

{
  "timestamp": 1620579088,
  "squareMeters": 38,
  "totalTime": 1623,
  "totalTimeFormatted": "0h 27m 03s",
  "imageUrl": "https://portal-eu.ecouser.net/api/lg/image/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx@xxxxxxxxx@xxxx"
}

CleanSum

{
  "totalSquareMeters": 3129,
  "totalSeconds": 162139,
  "totalNumber": 389
}

MoppingSystemInfo

{
  "cleanStatus": "pause",
  "waterInfo": {
    "enabled": false,
    "level": 4
  }
}

NetworkInfo

{
  "ip": "192.168.179.x",
  "mac": "XX:XX:XX:XX:XX:XX",
  "wifiSSID": "SomeRandomWiFiSSID",
  "wifiSignal": "-52"
}

LastError

{
  "error": "NoDustBox: Dust Bin Not installed",
  "code": "110"
}

Schedule

[
    {
        "sid": "16162855470839",
        "cleanCmd":
        {
            "type": "auto"
        },
        "enabled": false,
        "weekdays":
        {
            "Mon": false,
            "Tue": false,
            "Wed": false,
            "Thu": false,
            "Fri": false,
            "Sat": true,
            "Sun": false
        },
        "hour": 17,
        "minute": 30,
        "mapID": "1855832123"
    },
    {
        "sid": "16162855470841",
        "cleanCmd":
        {
            "type": "spotArea",
            "spotAreas": "7,3"
        },
        "enabled": true,
        "weekdays":
        {
            "Mon": false,
            "Tue": false,
            "Wed": false,
            "Thu": false,
            "Fri": false,
            "Sat": true,
            "Sun": true
        },
        "hour": 15,
        "minute": 00,
        "mapID": "1855832123"
    }
]