Skip to content

Map

getCachedMapInfo

Command to get information about all maps.

Request

Only the name and the payload arguments will be described. General information can be found under Command General.

  • Name: getCachedMapInfo
  • Payload arguments: None

Response

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

The data object contains the following arguments:

  • info: A list of map objects

    • mid: Map id
    • index: internal index
    • using: 1 means currently used map. Otherwise 0
    • built: 1 means map is built; Complete clean was done and bot returned successfully to charging station
    • name: Name of map set by the user

Example response

{
  "enable": 1,
  "info": [
    {
      "mid": "199390082",
      "index": 0,
      "status": 1,
      "using": 1,
      "built": 1,
      "name": "Erdgeschoss"
    },
    {
      "mid": "722607162",
      "index": 3,
      "status": 0,
      "using": 0,
      "built": 0,
      "name": ""
    }
  ]
}

getMapSubSet

Command to get map subset information.

Request

Only the name and the payload arguments will be described. General information can be found under Command General.

  • Name: getMapSubSet

  • Payload arguments:

    • mid: Map id

    • type: The type of map set

      Value Description
      ar Rooms
      vw Virtual walls
      mw No mopping zones
    • mssid: Map subset id 1
    • msid: Map set id

Example payload

{
  "mid": "199390082",
  "msid": "8",
  "type": "ar",
  "mssid": "17"
}

Response

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

The data object contains the following arguments:

  • mid: Map id

  • type: The type of map set

    Value Description
    ar Rooms
    vw Virtual walls
    mw No mopping zones
  • mssid: Map subset id 1
  • value: List of coordinates
  • subtype: Room type 1
  • connections: Connections to other rooms 1

Example response

{
  "type": "ar",
  "mssid": "12",
  "value": "-2700,-7450;-2700,-6750;-2550,-6650;...",
  "subtype": "12",
  "connections": "17,14,10,11,13,7",
  "mid": "199390082"
}

clearMap

Clear/reset the map

Request

Only the name and the payload arguments will be described. General information can be found under Command General.

  • Name: clearMap

  • Payload arguments:

    • mid: Map id

    • type: Which type should be cleared

      Value Description
      all All types will be cleared. In other words the complete map is cleared.

Example payload

{
    "mid": "353140366",
    "type": "all"
}

Response

No specific response expected, as this is a executing command. General information about responses can be found under rest.

  1. Only present when type = ar ↩↩↩↩