Cleaning Robot Programs

The following list contains all cleaning robot programs, which are supported by the API. Please note that not all programs are supported for a specific cleaning robot model. Therefore, we recommend to use the available program interface to check the program availability.

 

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.

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.

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.

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

The following list contains all options which are supported by the API. Please note that not all options are supported by a program. Therefore, we recommend to use the program constraints endpoint to check the option availability.

 

Example

GET /api/homeappliances/{haid}/programs/available/ConsumerProducts.CleaningRobot.Program.Cleaning.CleanMap


{
    "data": {
        "key": "ConsumerProducts.CleaningRobot.Program.Cleaning.CleanMap",
        "options": [
            {
                "key": "ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
                "type": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps",
                "constraints": {
                    "allowedvalues": [
                        "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.TempMap",
                        "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1",
                        "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2",
                        "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map3"
                    ]
                }
            },
            {
                "key": "ConsumerProducts.CleaningRobot.Option.CleaningMode",
                "type": "ConsumerProducts.CleaningRobot.EnumType.CleaningModes",
                "constraints": {
                    "allowedvalues": [
                        "ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent",
                        "ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Power",
                        "ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Standard"
                    ]
                }
            }
        ]
    }
}