Skip to content

Stats

onStats

This message can be received:

  • during a cleaning job on each cleaned m²

Only the data object will be described here. To get information about the whole message, please refer to General

The data object contains the following arguments:

  • area: The cleaned area in m²
  • time: The elapsed time since starting this job in seconds
  • cid: Cleaning id
  • start: Datetime, when clean job was started
  • type: The cleaning type

Example response

{
  "area": 36,
  "time": 2063,
  "cid": "111",
  "start": "1297462509",
  "type": "spotArea"
}

reportStats

This message can be received:

  • on the start of a cleaning job
  • on the end (stop) of a cleaning job

Only the data object will be described here. To get information about the whole message, please refer to General

The data object contains the following arguments:

  • cid: Cleaning job id
  • type: Cleaning type

  • stop: {{ no such element: dict object['description'] }}

    Value Description
    0 Job started
    1 Job finished
  • area: The cleaned area in m² 1
  • time: The cleaning time in seconds 1
  • start: datetime, when clean job was started 1
  • content: The map-sub-set (room) ids, which should be cleaned by this job 1

  • stopReason: The stop reason 1

    Value Description
    1 finished normally
    2 stopped manually
    3 finished with warnings (e.g. one room not cleaned as it was blocked)

Example response

{
  "cid": "1319392469",
  "type": "spotArea",
  "stop": 1,
  "mapCount": 15,
  "area": 0,
  "time": 7,
  "start": "1297811709",
  "content": "7,12,11,14",
  "stopReason": 2
}

  1. Only present at the end of the cleaning job. ↩↩↩↩↩