Programs and Options - Cleaning Robot

Clean All

Key

ConsumerProducts.CleaningRobot.Program.Cleaning.CleanAll

Description

With the Clean All program, the robot cleans all accessible rooms one after the other. When you start the this cleaning programm, the robot will explore its immediate surroundings and create a temporary map. It will then start systematically cleaning the area it has explored.

Options

  • Reference Map ID
  • Cleaning Mode

Example

PUT /api/homeappliances/{haid}/programs/active


{
    "data":{
        "key":"ConsumerProducts.CleaningRobot.Program.Cleaning.CleanAll",
        "options": [
           {
            "key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
            "value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.TempMap"
           },
           {
            "key":"ConsumerProducts.CleaningRobot.Option.CleaningMode",
            "value":"ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent"
           }
        ]
    }
}

 

Clean Map

Key

ConsumerProducts.CleaningRobot.Program.Cleaning.CleanMap

Description

With the Clean Map programm, the robot moves over and cleans the map of your house in a fixed cleaning pattern. You will need to create and confirm this map using the Home Connect app via the robot first.

Options

  • Reference Map ID
  • Cleaning Mode

Example

PUT /api/homeappliances/{haid}/programs/active


{
    "data":{
        "key":"ConsumerProducts.CleaningRobot.Program.Cleaning.CleanMap",
        "options": [
           {
            "key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
            "value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1"
           },
           {
            "key":"ConsumerProducts.CleaningRobot.Option.CleaningMode",
            "value":"ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent"
           }
        ]
    }
}

 

Go Home

Key

ConsumerProducts.CleaningRobot.Program.Basic.GoHome

Description

With the Go Home program, you can send the robot back to the charging station.

Options

  • Reference Map ID

Example

PUT /api/homeappliances/{haid}/programs/active


{
    "data":{
        "key":"ConsumerProducts.CleaningRobot.Program.Basic.GoHome",
        "options": [
           {
            "key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
            "value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1"
           }
        ]
    }
}

 

Options

Reference Map ID

Key

ConsumerProducts.CleaningRobot.Option.ReferenceMapId

Description

This option defines the used reference map.

Data type

Enumeration

Possible values

see Reference Map ID enumeration

Example

GET /api/homeappliances/{haid}/programs/active/options/ConsumerProducts.CleaningRobot.Option.ReferenceMapId


{
    "data":{
        "key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
        "value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1"
    }
}

 

Cleaning Mode

Key

ConsumerProducts.CleaningRobot.Option.CleaningMode

Description

This option defines the favoured cleaning mode.

Data type

Enumeration

Possible values

see Cleaning Mode enumeration

Example

GET /api/homeappliances/{haid}/programs/active/options/ConsumerProducts.CleaningRobot.Option.CleaningMode


{
    "data":{
        "key":"ConsumerProducts.CleaningRobot.Option.CleaningMode",
        "value":"ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent"
    }
}