Home Connect Developer Program

This page does NOT support Internet Explorer. Please use a modern browser like e.g. Google Chrome, Mozilla Firefox or Microsoft Edge.

Programs and Options

Cleaning Robot
Copied link to clipboard

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

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

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

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

Reference Map ID Option
Copied link to clipboard

Key

ConsumerProducts.CleaningRobot.Option.ReferenceMapId

Description

This option defines the used reference map.

Data type

Enumeration

Possible values

  • Temporary map
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.TempMap
  • User-defined map 1
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1
  • User-defined map 2
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2
  • User-defined map 3
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map3

Availability

Please notethat most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

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

Cleaning Mode Option
Copied link to clipboard

Key

ConsumerProducts.CleaningRobot.Option.CleaningMode

Description

This option defines the favoured cleaning mode.

Data type

Enumeration

Possible values

  • Silent mode
    Key: ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent
    Description: For simple cleaning tasks with a very low operating noise and long battery life.
  • Eco mode
    Key: ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Standard
    Description: For normal cleaning tasks with efficient cleaning performance and runtime.
  • Power mode
    Key: ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Power
    Description: Maximum power for demanding everyday cleaning tasks in medium-sized rooms.

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

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

Coffee Machine
Copied link to clipboard

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

Coffee Programs

ConsumerProducts.CoffeeMaker.Program.Beverage.Ristretto

Very concentrated and thus especially aromatic espresso

ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso

The classic: small, strong coffee with hazel crema

ConsumerProducts.CoffeeMaker.Program.Beverage.EspressoDoppio

Coffee Beverage with double filling compared to default espresso

ConsumerProducts.CoffeeMaker.Program.Beverage.Coffee

Large cup of coffee, brewed using espresso as the base

Coffee Milk Mix Programs

ConsumerProducts.CoffeeMaker.Program.Beverage.EspressoMacchiato

Espresso with some milk froth; Italian for 'stained espresso'

ConsumerProducts.CoffeeMaker.Program.Beverage.Cappuccino

One third of each espresso, warm milk and milk froth

ConsumerProducts.CoffeeMaker.Program.Beverage.LatteMacchiato

Specialty with three layers, served in a glass: warm milk at the bottom, espresso in the middle, milk froth on top

ConsumerProducts.CoffeeMaker.Program.Beverage.CaffeLatte

Half coffee, half warm milk; typically served in a bowl

Milk Programs

ConsumerProducts.CoffeeMaker.Program.Beverage.MilkFroth

Frothed milk, e.g. for hot chocolate

ConsumerProducts.CoffeeMaker.Program.Beverage.WarmMilk

Heated (not steamed) milk

Coffee World Programs

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.KleinerBrauner

Austrian coffee speciality: Single espresso with a dash of warm milk

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.GrosserBrauner

Austrian coffee speciality: Double espresso with a dash of warm milk

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Verlaengerter

Austrian coffee speciality: Espresso diluted ("verlängert") with the same quantity of hot water

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.VerlaengerterBraun

Austrian coffee speciality: Verlängerter with a dash of warm milk

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.WienerMelange

Austrian coffee speciality: Half espresso, half milk froth; stronger than a cappuccino

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.FlatWhite

Espresso topped with a specific style of silky frothed milk

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Cortado

Colombian coffee speciality: Ristretto diluted with the same quantity of warm milk

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.CafeCortado

Spanish coffee speciality: Espresso with a dash of warm milk; Spanish for "cut coffee"

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.CafeConLeche

Spanish coffee speciality: Half coffee, half milk froth; with a brown milk froth on top

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.CafeAuLait

French coffee speciality: Caffe latte with a high share of coffee; typically served for breakfast

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Doppio

Italian coffee speciality: Double espresso; prepared with the double amount of ground coffee

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Kaapi

South Indian coffee speciality: Hot milk with two teaspoons of very intense coffee; typically sweetened

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.KoffieVerkeerd

Dutch coffee speciality: Mild caffe latte with more warm milk than coffee; inverted ("verkeerd"), as caffe latte usually has more coffee than milk

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Galao

Portuguese coffee speciality: Very mild caffe latte; typically served in a glass

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Garoto

Portuguese coffee speciality: Half milk froth, half espresso; also referred to as "children's coffee"

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.Americano

American coffee speciality: espresso diluted with two parts of hot water; easier to drink than a classic filter coffee

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.RedEye

American coffee speciality: Coffee plus one espresso; a great wake up call after a late night

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.BlackEye

American coffee speciality: Coffee plus two espressos for an extra kick caffeine

ConsumerProducts.CoffeeMaker.Program.CoffeeWorld.DeadEye

American coffee speciality: coffee with three espressos; for the ultimate caffeine kick.

Example

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

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.CoffeeMaker.Program.Beverage.Coffee

Bean Amount Option
Copied link to clipboard

Key

ConsumerProducts.CoffeeMaker.Option.BeanAmount

Description

This option describes the bean amount of a coffee machine program.

Data type

Enumeration

Possible values

  • Very mild
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryMild
  • Mild
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Mild
  • Mild +
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.MildPlus
  • Normal
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Normal
  • Normal +
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.NormalPlus
  • Strong
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Strong
  • Strong +
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.StrongPlus
  • Very strong
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryStrong
  • Very strong +
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryStrongPlus
  • Extra strong
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.ExtraStrong
  • DoubleShot
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShot
  • DoubleShot +
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShotPlus
    Description: Extra strong coffee is ground and brewed in two steps to reduce bitterness
  • DoubleShot ++
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShotPlusPlus
    Description: Extra strong coffee is ground and brewed in two steps to reduce bitterness
  • TripleShot
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.TripleShot
    Description: Extra strong coffee is ground and brewed in three steps, in order to release less bitter substances
  • TripleShot +
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.TripleShotPlus
    Description: Extra strong coffee is ground and brewed in three steps, in order to release less bitter substances
  • Coffee Ground
    Key: ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.CoffeeGround
    Description: Coffee is brewed with ground coffee from the ground coffee drawer

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/ConsumerProducts.CoffeeMaker.Option.BeanAmount

Fill Quantity Option
Copied link to clipboard

Key

ConsumerProducts.CoffeeMaker.Option.FillQuantity

Description

This option describes the fill quantity (in ml) of a coffee machine program.

Data type

Integer

Possible values

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program to get valid constraints (min, max & stepsize).

For example:

FillQuantity (EU / CN) - Built-in Appliance:

FillQuantity (EU / CN) - Stand-alone Appliance:

FillQuantity (US / CA) - Built-in Appliance:

Example

GET /api/homeappliances/{haid}/programs/active/options/ConsumerProducts.CoffeeMaker.Option.FillQuantity

Coffee Temperature Option
Copied link to clipboard

Key

ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature

Description

This option describes the coffee temperature of a coffee machine program.

Data type

Enumeration

Possible values

  • 88 °C
    Key: ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.88C
  • 90 °C
    Key: ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.90C
  • 92 °C
    Key: ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.92C
  • 94 °C
    Key: ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.94C
  • 95 °C
    Key: ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.95C
  • 96 °C
    Key: ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.96C

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature

Cooktop
Copied link to clipboard

Program support is planned to be released in 2022. Selected and active program can be already requested.

Cook Processor
Copied link to clipboard

Program support is planned to be released in 2022. Selected and active program can be already requested.

Dishwasher
Copied link to clipboard

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

Dishcare.Dishwasher.Program.Auto1

Automatically adjusted program sequence: cleaning and drying according to degree of soiling (sensor-optimized) of lightly soiled dishes with optimum consumption.

Dishcare.Dishwasher.Program.Auto2

Automatically adjusted program sequence: cleaning and drying according to degree of soiling (sensor-optimized) of normally soiled dishes with optimum consumption.

Dishcare.Dishwasher.Program.Auto3

Automatically adjusted program sequence: cleaning and drying according to degree of soiling (sensor-optimized) of highly soiled dishes with optimum consumption.

Dishcare.Dishwasher.Program.Eco50

Most economical rinsing program for cleaning and drying of normally soiled dishes for all rinsing situations with reduced water and energy consumption.

Dishcare.Dishwasher.Program.Quick45

Particularly quick cleaning of lightly soiled dishes within approx. half an hour.

Dishcare.Dishwasher.Program.Intensiv70

Special cleaning for highly soiled dishes, particularly for pots and pans.

Dishcare.Dishwasher.Program.Normal65

Cleaning for medium up to highly soiled dishes, particularly for mixed dishes.

Dishcare.Dishwasher.Program.Glas40

Gentle cleaning of sensitive dishes, e.g. high-quality glasses at lower temperatures. The drying phase is extended especially for extra gentle drying.

Dishcare.Dishwasher.Program.GlassCare

A cycle for lightly soiled dishes which is ideal for temperature sensitive dishes or silverware. It is especially helpful to reduce a cloudy or etched appearance on glasses.

Dishcare.Dishwasher.Program.NightWash

Particularly gentle cleaning and drying of normally soiled dishes.

Dishcare.Dishwasher.Program.Quick65

Particularly quick cleaning of normally soiled dishes.

Dishcare.Dishwasher.Program.Normal45

Recommended for daily, regular or typical use to completely wash a full load of normally soiled dishes.

Dishcare.Dishwasher.Program.Intensiv45

Intensive and economical program for heavily soiled dishes, pots, glasses.

Dishcare.Dishwasher.Program.AutoHalfLoad

Reduced water consumption when washing small, lightly soiled loads.

Dishcare.Dishwasher.Program.IntensivPower

Special cleaning for dishes with heavy or burnt-in soiling, particularly for pots and pans.

Dishcare.Dishwasher.Program.MagicDaily

Time-optimised with intensive cleaning and drying for daily use.

Dishcare.Dishwasher.Program.Super60

Maximum cleaning and drying performance for highly soiled dishes.

Dishcare.Dishwasher.Program.Kurz60

Time-optimised, for normally soiled dishes.

Dishcare.Dishwasher.Program.ExpressSparkle65

Special cleaning for dishes with very heavy and burnt-in soiling, particularly for pots and pans.

Dishcare.Dishwasher.Program.MachineCare

Machine cleaning cycle. Without dishes, using machine cleaning detergent.

Dishcare.Dishwasher.Program.SteamFresh

Rinsing and hygienic drying.

Dishcare.Dishwasher.Program.MaximumCleaning

Special cleaning for heavily soiled, greasy dishes, particularly for pots and pans.

Example

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

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/Dishcare.Dishwasher.Program.Eco50

Start in Relative Option
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.StartInRelative

Description

If this option is set, the program will be activated but not started until the defined time span elapses.

Please note that this option can't be used in a program selection command. This is only supported by the program start command.

Data type

Integer

Possible values

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program to get valid constraints (min, max & stepsize).

For example: 0 to 86340 seconds

Example

GET /api/homeappliances/{haid}/programs/active/options/BSH.Common.Option.StartInRelative

Dryer
Copied link to clipboard

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

Automatic Programs

LaundryCare.Dryer.Program.Cotton

Standard drying program for cotton or linen textiles which do not require sensitive temperatures. Different drying targets can be chosen. (Max. load)

LaundryCare.Dryer.Program.Synthetic

Standard program for synthetic textiles which do not require sensitive temperatures. Different drying targets can be chosen. (Max. load: max. 3,5 kg)

LaundryCare.Dryer.Program.Mix

Program for mixed cotton and synthetic textiles which do not require sensitive temperatures. A perfect drying result for ironing is possible and at the same time, wrinkles are avoided. (Max. load: 3,0 kg)

LaundryCare.Dryer.Program.Blankets

Special program for drying blankets (two medium size) or bed covers (one big) with synthetic filling. It is designed to ensure a proper final drying degree without moisture in textiles with filling layers. (Max. load: 2.5 kg)

LaundryCare.Dryer.Program.BusinessShirts

Special program dedicated for shirts/blouses. It minimises wrinkles to accomplish a perfect ironing result. (Max. load: 1,5 kg)

LaundryCare.Dryer.Program.DownFeathers

Special program for drying down-filled items like jackets, sleeping bags, blankets, pillows, etc. This program is designed to ensure a proper final drying degree without leaving residual moisture in textiles with filling layers and at the same time, fluffing up the feathers with warm air. (Max. load: 1.5 kg)

LaundryCare.Dryer.Program.Hygiene

Special program developed to dry textiles with higher temperature as cotton program. It is targeted for hard wearing fabrics to enhance the temperature at a level to provide highest hygiene requirements. (Max. load: 4.0 kg)

LaundryCare.Dryer.Program.Jeans

Special program for drying jeans items, adjusting the drying time with a special final phase to dry double- seams. (Max. load: 6,0 kg)

LaundryCare.Dryer.Program.Outdoor

Special program for drying weatherproof and functional outdoor clothing with a membrane coating and water-repellent fabrics. The drying process keeps the features of the textiles intact by using sensitive temperatures. (Max. load: 1.5 - 2 kg, depending on model)

LaundryCare.Dryer.Program.SyntheticRefresh

Steam program for drying and smoothing out the wrinkles of easy-care fabrics such as shirts/blouses. Remove fabrics immediately after the program has been finished and hang them up to prevent wrinkles. (Max. load: 1.5 kg)

LaundryCare.Dryer.Program.Towels

Special program dedicated for drying towels, adjusted for different textiles like cotton, terry, etc. Possible prolongation of program for drying very thick items or in order to achieve very low final residual moisture. (Max. load: 6.0 kg)

LaundryCare.Dryer.Program.Delicates

Special program designed to treat delicate textiles like washable underwear made of velvet or lycra. The drying process keeps the features of textiles intact by using sensitive temperatures. (Max. load: 2.0 kg)

LaundryCare.Dryer.Program.Super40

Special program optimised for drying small loads containing thin items made of synthetic fibres, light cotton or mixed fabrics which do not require sensitive temperatures. (Max. load: 1.0 - 2.0 kg, depending on model)

LaundryCare.Dryer.Program.Shirts15

Special program developed for drying max. five shirts which do not require low temperatures. (Max. load: 1.5 kg)

LaundryCare.Dryer.Program.Pillow

Special program for drying down filled textiles like jackets, sleeping bags, blankets, pillows, etc. This program is designed to ensure a proper final drying degree without leaving residual moisture in textiles with filling layers and at the same time, fluffing up the feathers with warm air. (Max. load: 1.5 -2.5 kg, depending on model)

LaundryCare.Dryer.Program.AntiShrink

This program is designed for pre-drying small loads of cotton or linen fabrics and easy-care textiles which are still damp. Creases in textiles will be reduced. Textiles are not completely dried after the cycle.

Example

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

Time Programs with Variable Duration

LaundryCare.Dryer.Program.MyTime.MyDryingTime

The program Duration and temperature can be adjusted individually. For drying different fabrics (cotton, synthetic fibres and mixed fabrics) in one drying process.

LaundryCare.Dryer.Program.TimeCold

The timed programme has been developed to 'loosen up' all kinds of dry textiles except wool and silk at room temperature. It can also be used to air-out items that have been worn only for a short period of time. This programme offers the possibility to loosen up the clothing after having hung on the clothesline. The time can be set individually in this function. (Max. load: 3.0 kg)

LaundryCare.Dryer.Program.TimeWarm

The timed programme has been developed to refine the drying result of small delicate loads or separate items like multi-layered, sensitive fabrics. If you use a basket (see special accessories) this programme is also suitable for drying single wool textiles, sport shoes and plush toys. Depending on the residual moisture and type of laundry, it may be necessary to run the cycle more than once. The time can be set individually in this function. (Max. load: 3 kg)

LaundryCare.Dryer.Program.InBasket

Special program dedicated for drying woollen items (suitable also for shoes and soft toys). Items need to be put into the drying basket. The drying process keeps the features of textiles intact by using sensitive temperatures and no mechanical treatment. (Max. load: 1.5 kg)

Example

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

Time Programs with Fixed Duration

LaundryCare.Dryer.Program.TimeColdFix.TimeCold20

Timed program (20 min.) developed to loosen up all kinds of dry textiles except wool and silk using room temperature. As well as designed to air-out items that have been worn only for a short period of time. (Max. load: 3.0 kg)

LaundryCare.Dryer.Program.TimeColdFix.TimeCold30

Timed program (30 min.) developed to loosen up all kinds of dry textiles except wool and silk using room temperature. As well as designed to air-out items that have been worn only for a short period of time. (Max. load: 3.0 kg)

LaundryCare.Dryer.Program.TimeColdFix.TimeCold60

Timed program (60 min.) developed to loosen up all kinds of dry textiles except wool and silk using room temperature. As well as designed to air-out items that have been worn only for a short period of time. (Max. load: 3.0 kg)

LaundryCare.Dryer.Program.TimeWarmFix.TimeWarm30

Timed program (30 min.) developed to refine the drying result of small delicate loads or separate items like multi-layered, sensitive fabrics. If you use a basket (see special accessories) this program is also suitable for drying single wool textiles, sport shoes and plush toys. Depending on the residual moisture and type of laundry, it may be necessary to run the cycle more than once. (Max. load: 3.0 kg)

LaundryCare.Dryer.Program.TimeWarmFix.TimeWarm40

Timed program (40 min.) developed to refine the drying result of small delicate loads or separate items like multi-layered, sensitive fabrics. If you use a basket (see special accessories) this program is also suitable for drying single wool textiles, sport shoes and plush toys. Depending on the residual moisture and type of laundry, it may be necessary to run the cycle more than once. (Max. load: 3 kg)

LaundryCare.Dryer.Program.TimeWarmFix.TimeWarm60

Timed program (60 min.) developed to refine the drying result of small delicate loads or separate items like multi-layered, sensitive fabrics. If you use a basket (see special accessories) this program is also suitable for drying single wool textiles, sport shoes and plush toys. Depending on the residual moisture and type of laundry, it may be necessary to run the cycle more than once. (Max. load: 3.0 kg)

LaundryCare.Dryer.Program.Dessous

Timed program designed to treat delicate textiles made of synthetic fibres, cotton or blended items like underwear loads. The drying process keeps the features of textiles intact by using sensitive temperatures. (Max. load: 1.0 kg)

Example

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

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/LaundryCare.Dryer.Program.Synthetic

GET /api/homeappliances/{haid}/programs/available/LaundryCare.Dryer.Program.TimeCold

Drying Target Option
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

LaundryCare.Dryer.Option.DryingTarget

Description

This options describes the drying target of a dryer program.

Data type

Enumeration

Possible values

  • Iron Dry
    Key: LaundryCare.Dryer.EnumType.DryingTarget.IronDry
    Description: The dryer will stop drying if the clothes are iron dry.
  • Cupboard Dry
    Key: LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry
    Description: The dryer will stop drying if the clothes are cupboard dry.
  • CupboardDry Plus
    Key: LaundryCare.Dryer.EnumType.DryingTarget.CupboardDryPlus
    Description: The dryer will stop drying if the clothes are absolutely dry.

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/LaundryCare.Dryer.Option.DryingTarget

Freezer
Copied link to clipboard

There are no programs available for Freezers. Please view the Status (Door state), Settings and Events section for further possibilities to integrate the Freezer using the Home Connect API.

Fridge Freezer
Copied link to clipboard

There are no programs available for Fridge Freezers. Please view the Status (Door state), Settings and Events section for further possibilities to integrate the Fridge Freezer using the Home Connect API.

Hood
Copied link to clipboard

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

Automatic Mode

Key

Cooking.Common.Program.Hood.Automatic

Description

In automatic mode, a sensor in the extractor hood detects the intensity of the cooking and roasting fumes. Depending on the sensor setting, the fan automatically switches to another fan setting. If you monitor the home appliance, you will receive the following additional events:

  • Cooking.Common.Option.Hood.VentingLevel
  • Cooking.Common.Option.Hood.IntensiveLevel
  • BSH.Common.Option.ElapsedProgramTime

Example

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

Fan Setting

Key

Cooking.Common.Program.Hood.Venting

Description

Manual program which allows the user to select fan setting or intensive setting. If you monitor the home appliance, you will receive the following events:
  • BSH.Common.Option.ElapsedProgramTime

Example

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

Fan Run-on

Key

Cooking.Common.Program.Hood.DelayedShutOff

Description

The fan run-on ensures that remaining odours will be eliminated after cooking. Afterwards the fan switches off automatically. If you monitor the home appliance, you will receive the following events:

  • BSH.Common.Option.Duration
  • BSH.Common.Option.ElapsedProgramTime
  • BSH.Common.Option.ProgramProgress
  • BSH.Common.Event.ProgramFinished

Example

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

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/Cooking.Common.Program.Hood.Venting

Venting Level Option
Copied link to clipboard

Key

Cooking.Common.Option.Hood.VentingLevel

Description

This option defines the required fan setting.

Data type

Enumeration

Possible values

  • Fan off
    Key: Cooking.Hood.EnumType.Stage.FanOff
  • Fan stage 1
    Key: Cooking.Hood.EnumType.Stage.FanStage01
  • Fan stage 2
    Key: Cooking.Hood.EnumType.Stage.FanStage02
  • Fan stage 3
    Key: Cooking.Hood.EnumType.Stage.FanStage03
  • Fan stage 4
    Key: Cooking.Hood.EnumType.Stage.FanStage04
  • Fan stage 5
    Key: Cooking.Hood.EnumType.Stage.FanStage05

Availability

Please notethat most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/Cooking.Common.Option.Hood.VentingLevel

Intensive Level Option
Copied link to clipboard

Key

Cooking.Common.Option.Hood.IntensiveLevel

Description

This option defines the intensive setting.

Data type

Enumeration

Possible values

  • Intensive stage off
    Key: Cooking.Hood.EnumType.IntensiveStage.IntensiveStageOff
  • Intensive stage 1
    Key: Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1
  • Intensive stage 2
    Key: Cooking.Hood.EnumType.IntensiveStage.IntensiveStage2

Availability

Please notethat most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/Cooking.Common.Option.Hood.IntensiveLevel

Oven
Copied link to clipboard

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

Cooking.Oven.Program.HeatingMode.PreHeating

This heating type can be used to pre-heat the oven. It starts up a hot air program with the fast pre-heat option. Please note that the setpoint temperature has to be equal or higher than 100 °C or 212 °F otherwise the fast pre-heat option is not activated. In addition we suggest to use a duration of at least 10 minutes (better more) in order to continue pre-heating until the user has finished the preparations. To get notified when pre-heating is finished, monitor events on the home appliance and filter for the event with the key Cooking.Oven.Event.PreheatFinished. Upon reception you can inform the user that s/he can insert the meal.

Cooking.Oven.Program.HeatingMode.HotAir

This heating type is suitable for baking on one or several levels.

Cooking.Oven.Program.HeatingMode.HotAirEco

This heating type is suitable for energy-optimised cooking of selected dishes on one level without preheating.

Cooking.Oven.Program.HeatingMode.HotAirGrilling

This heating type is suitable for roasting poultry, whole fish and larger pieces of meat.

Cooking.Oven.Program.HeatingMode.TopBottomHeating

This heating type is suitable for traditional baking and roasting on one level.

Cooking.Oven.Program.HeatingMode.TopBottomHeatingEco

This heating type is suitable for energy-optimised cooking of selected dishes on one level without preheating.

Cooking.Oven.Program.HeatingMode.BottomHeating

This heating type is suitable for cooking in a bain-marie and for the final baking stage.

Cooking.Oven.Program.HeatingMode.PizzaSetting

This heating type is suitable for preparing pizza.

Cooking.Oven.Program.HeatingMode.SlowCook

This heating type is suitable for gentle and slow cooking.

Cooking.Oven.Program.HeatingMode.IntensiveHeat

This heating type is suitable for dishes with a crispy base. The heat is emitted from above and more intensively from below.

Cooking.Oven.Program.HeatingMode.KeepWarm

The heating type is suitable for keeping cooked dishes warm.

Cooking.Oven.Program.HeatingMode.PreheatOvenware

This heating type is suitable for warming ovenware.

Cooking.Oven.Program.HeatingMode.FrozenHeatupSpecial

This heating type is suitable for the fast preparation of frozen products at level 1.

Cooking.Oven.Program.HeatingMode.Desiccation

This heating type is suitable for drying herbs, fruit and vegetables.

Cooking.Oven.Program.HeatingMode.Defrost

This heating type is suitable for the gentle defrosting of frozen meals.

Cooking.Oven.Program.HeatingMode.Proof

In Proof, the oven uses the upper and lower elements to maintain a low temperature to proof bread or other yeast doughs.

Example

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

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/Cooking.Oven.Program.HeatingMode.HotAir

Setpoint Temperature Option
Copied link to clipboard

Key

Cooking.Oven.Option.SetpointTemperature

Description

This option defines the target cavity temperature, which will be hold by the oven.

Data type

Double

Possible values

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program to get valid constraints (min, max & stepsize).

For example: 30 to 250 °C or 150 to 480 °F

Example

GET /api/homeappliances/{haid}/programs/active/options/Cooking.Oven.Option.SetpointTemperature

Duration Option
Copied link to clipboard

Key

BSH.Common.Option.Duration

Description

This option defines the run-time of the program. Afterwards the appliance is stopped.

Data type

Integer

Possible values

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program to get valid constraints (min, max & stepsize).

For example: 1 to 86340 seconds

Example

GET /api/homeappliances/{haid}/programs/active/options/BSH.Common.Option.Duration

Fast Pre-heat Option
Copied link to clipboard

Key

Cooking.Oven.Option.FastPreHeat

Description

This option defines if the cooking compartment is heated up quickly. Please note that the setpoint temperature has to be equal or higher than 100 °C or 212 °F otherwise the fast pre-heat option is not activated. In addition we suggest to use a duration of at least 10 minutes (better more) in order to continue pre-heating until the user has finished the preparations. To get notified when pre-heating is finished, monitor events on the home appliance and filter for the event with the key Cooking.Oven.Event.PreheatFinished. Upon reception you can inform the user that s/he can insert the meal.

Data type

Boolean

Possible values

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/programs/active/options/Cooking.Oven.Option.FastPreHeat

Refrigerator
Copied link to clipboard

There are no programs available for refrigerator. Please view the Status (Door state), Settings and Events section for further possibilities to integrate the refrigerator using the Home Connect API.

Warming Drawer
Copied link to clipboard

Program support is planned to be released in 2021. Selected and active program can be already requested.

Washer
Copied link to clipboard

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

LaundryCare.Washer.Program.Cotton

For cleaning cotton or linen clothing with normal to heavy soiling. (Max. load. If Speed Perfect function is selected: 5 kg).

LaundryCare.Washer.Program.EasyCare

For washing easy-care laundry made from synthetic or mixed fibres, such as polyamide and polyester. (Max. load: 4.0 kg).

LaundryCare.Washer.Program.Mix

For cleaning different fabrics (cottons, synthetic and mixed fibres) in the same laundry load. Suitable for laundry with light to normal soiling. (Max. load: 4.0 kg).

LaundryCare.Washer.Program.DelicatesSilk

For cleaning delicate fabrics such as silk, satin and viscose. Reduced spin for optimal fabric care. It is recommended to use a mild detergent. (Max. load: 2.0 kg).

LaundryCare.Washer.Program.Wool

For gentle washing of items made from wool, such as cashmere and sheep's wool. Reduced drum movement to prevent felting and shrinking. Particularly gentle, can be used in place of hand-washing. It is recommended to use a detergent specifically for woollens. (Max. load: 2.0 kg)

LaundryCare.Washer.Program.Sensitive

Optimised programme for allergy sufferers. Washes cotton and linen items. Effectively removes pollen and other allergens. (Max. load: 7 kg; if Speed Perfect function selected: 5 kg)

LaundryCare.Washer.Program.Auto30

For cleaning different fabrics (cottons, synthetic fibres) in the same laundry load. The programme automatically detects the type of fabric and the degree of soiling. The washing time, volume of water and spin profile are adjusted accordingly. (Max. load: 3.5 kg)

LaundryCare.Washer.Program.Auto40

For cleaning different fabrics (cottons, synthetic fibres) in the same laundry load. The programme automatically detects the type of fabric and the degree of soiling. The washing time, volume of water and spin profile are adjusted accordingly. (Max. load: 6.0 kg)

LaundryCare.Washer.Program.Auto60

For cleaning different fabrics (cottons, synthetic fibres) in the same laundry load. The programme automatically detects the type of fabric and the degree of soiling. The washing time, volume of water and spin profile are adjusted accordingly. (Max. load: 6.0 kg)

LaundryCare.Washer.Program.Chiffon

For cleaning delicate items made from chiffon. Reduced spin for optimal fabric care. It is recommended to use a mild detergent. (Max. load: 2.0 kg)

LaundryCare.Washer.Program.Curtains

For cleaning heavy and light curtains or blinds. Reduced spin for preventing wrinkles. It is recommended to use a special detergent. (Max. load: 3.5 kg)

LaundryCare.Washer.Program.DarkWash

For gentle washing of dark-coloured laundry, such as jeans. Turn garments inside-out before washing. Reduced spin for preventing colour fade. We recommend the use of a liquid detergent. (Max. load: 3.5 kg)

LaundryCare.Washer.Program.Dessous

For gentle washing of delicate items made from velvet, lace, Lycra, silk or satin. We recommend the use of a mild detergent. (Max. load: 1.0 kg)

LaundryCare.Washer.Program.Monsoon

For cleaning rain-soaked fabrics made from cotton, synthetic fibres and mixed fabrics. Reliably removes dust and sand. Reduces any remaining moisture thanks to a special spinning cycle.

LaundryCare.Washer.Program.Outdoor

For gentle washing of water-repellent and breathable fabrics. It is recommended to use a mild liquid detergent. Do not use softener. (Max. load: 2.0 kg)

LaundryCare.Washer.Program.PlushToy

Optimised programme for washing plush toys. Not suitable for plush toys with leather applications. It is recommended to use a mild detergent (Max. load: 1.5 kg)

LaundryCare.Washer.Program.ShirtsBlouses

For washing blouses and shirts made from cotton, linen or synthetic fabric. Reduced spin for preventing wrinkles. (Max. load: 2.0 kg)

LaundryCare.Washer.Program.SportFitness

For gentle washing of sports- and leisurewear made from microfibre, fleece or synthetic fabric. Reduced spin for preventing wrinkles. (Max. load: 2.0 kg)

LaundryCare.Washer.Program.Towels

For hygienic washing of bathroom items, such as towels and dressing gowns. Adjusted spin for optimal washing results and a particularly soft feel. (Max. load: 3.5 kg)

LaundryCare.Washer.Program.WaterProof

For gentle washing of water-repellent and breathable fabrics followed by waterproofing (requires additional waterproofing agent). Before starting, remove any remaining softener from the detergent dispenser drawer. It is recommended to use a mild liquid detergent. Do not use softener. (Max. load: 1.0 kg)

Example

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

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/LaundryCare.Washer.Program.Cotton

Temperature Option
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

LaundryCare.Washer.Option.Temperature

Description

This option defines the temperature of the washing program.

Data type

Enumeration

Possible values

  • Cold
    Key: LaundryCare.Washer.EnumType.Temperature.Cold
    Description: Cold water
  • 20 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC20
    Description: Optimal for 20 °C washable clothes
  • 30 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC30
    Description: Optimal for 30 °C washable clothes
  • 40 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC40
    Description: Optimal for 40 °C washable clothes
  • 50 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC50
    Description: Optimal for 50 °C washable clothes
  • 60 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC60
    Description: Optimal for 60 °C washable clothes
  • 70 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC70
    Description: Optimal for 70 °C washable clothes
  • 80 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC80
    Description: Optimal for 80 °C washable clothes
  • 90 °C clothes
    Key: LaundryCare.Washer.EnumType.Temperature.GC90
    Description: Optimal for 90 °C washable clothes

Typically supported by US/CA appliances:

  • Cold Key: LaundryCare.Washer.EnumType.Temperature.UlCold
    Description: Optimal for cold washable clothes
  • Warm Key: LaundryCare.Washer.EnumType.Temperature.UlWarm
    Description: Optimal for warm washable clothes
  • Hot Key: LaundryCare.Washer.EnumType.Temperature.UlHot
    Description: Optimal for hot washable clothes
  • Extra hot Key: LaundryCare.Washer.EnumType.Temperature.UlExtraHot
    Description: Optimal for extra hot washable clothes

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/LaundryCare.Washer.Option.Temperature

Spin Speed Option
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

LaundryCare.Washer.Option.SpinSpeed

Description

This option defines the spin speed of a washer program.

Data type

Enumeration

Possible values

  • No spinning
    Key: LaundryCare.Washer.EnumType.SpinSpeed.Off
    Description: The washer will not spin.
  • 400 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM400
    Description: The washer will spin with 400 rpm.
  • 600 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM600
    Description: The washer will spin with 600 rpm.
  • 800 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM800
    Description: The washer will spin with 800 rpm.
  • 1000 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM1000
    Description: The washer will spin with 1000 rpm.
  • 1200 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM1200
    Description: The washer will spin with 1200 rpm.
  • 1400 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM1400
    Description: The washer will spin with 1400 rpm.
  • 1600 rpm
    Key: LaundryCare.Washer.EnumType.SpinSpeed.RPM1600
    Description: The washer will spin with 1600 rpm.

Typically supported by US/CA appliances:

  • No spinning Key: LaundryCare.Washer.EnumType.SpinSpeed.UlOff
    Description: The washer will not spin.
  • Low Key: LaundryCare.Washer.EnumType.SpinSpeed.UlLow
    Description: The washer will spin with low spin speed.
  • Medium Key: LaundryCare.Washer.EnumType.SpinSpeed.UlMedium
    Description: The washer will spin with average spin speed.
  • High Key: LaundryCare.Washer.EnumType.SpinSpeed.UlHigh
    Description: The washer will spin with high spin speed.

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

Example

GET /api/homeappliances/{haid}/programs/active/options/LaundryCare.Washer.Option.SpinSpeed

Washer Dryer
Copied link to clipboard

Typically, washer and dryer programs are supported by a washer dryer. Please note that not all programs are supported for a specific washer dryer model. Therefore, we recommend to use the available program interface to check the program availability.

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/LaundryCare.Washer.Program.Cotton

Wine Cooler
Copied link to clipboard

There are no programs available for Wine Coolers. Please view the Status (Door state), Settings and Events section for further possibilities to integrate the Wine Cooler using the Home Connect API.