This page does NOT support Internet Explorer. Please use a modern browser like e.g. Google Chrome, Mozilla Firefox or Microsoft Edge.
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.
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 /
{
"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"
}
]
}
}
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 /
{
"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"
}
]
}
}
Key
ConsumerProducts.CleaningRobot.Program.Basic.GoHome
Description
With the Go Home program, you can send the robot back to the charging station.
Example
PUT /
{
"data":{
"key":"ConsumerProducts.CleaningRobot.Program.Basic.GoHome",
"options": [
{
"key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
"value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1"
}
]
}
}
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
{
"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"
]
}
}
]
}
}
Key
ConsumerProducts.CleaningRobot.Option.ReferenceMapId
Description
This option defines the used reference map.
Data type
Enumeration
Possible values
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
{
"data":{
"key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
"value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1"
}
}
Key
ConsumerProducts.CleaningRobot.Option.CleaningMode
Description
This option defines the favoured cleaning mode.
Data type
Enumeration
Possible values
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
{
"data":{
"key":"ConsumerProducts.CleaningRobot.Option.CleaningMode",
"value":"ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent"
}
}
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.
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
ConsumerProducts.CoffeeMaker.Program.Beverage.XLCoffee
Extra large coffee. Simple and flavoursome preparation of large cups, thanks to a special brewing process. Also perfect for the take-away mug.
ConsumerProducts.CoffeeMaker.Program.Beverage.CaffeGrande
The tall Caffè Crema
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
ConsumerProducts.CoffeeMaker.Program.Beverage.MilkFroth
Frothed milk, e.g. for hot chocolate
ConsumerProducts.CoffeeMaker.Program.Beverage.WarmMilk
Heated (not steamed) milk
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.
ConsumerProducts.CoffeeMaker.Program.Beverage.HotWater
Heated water, e.g. for tea; also suited for prewarming cups.
Example
PUT /
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Program.Beverage.Coffee",
"options":[
{
"key":"ConsumerProducts.CoffeeMaker.Option.BeanAmount",
"value":"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Mild"
},
{
"key":"ConsumerProducts.CoffeeMaker.Option.FillQuantity",
"value":120,
"unit":"ml"
}
]
}
}
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
{
"data": {
"key": "ConsumerProducts.CoffeeMaker.Program.Beverage.Coffee",
"options": [
{
"key": "ConsumerProducts.CoffeeMaker.Option.BeanAmount",
"type": "ConsumerProducts.CoffeeMaker.EnumType.BeanAmount",
"constraints": {
"allowedvalues": [
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryMild",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Mild",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.MildPlus",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Normal",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.NormalPlus",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Strong",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.StrongPlus",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryStrong",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryStrongPlus",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.ExtraStrong",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShot",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShotPlus",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShotPlusPlus",
"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.CoffeeGround"
]
}
},
{
"key": "ConsumerProducts.CoffeeMaker.Option.FillQuantity",
"type": "Int",
"unit": "ml",
"constraints": {
"min": 60,
"max": 260,
"stepsize": 20
}
},
{
"key": "ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature",
"type": "ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature",
"constraints": {
"allowedvalues": [
"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.88C",
"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.90C",
"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.92C",
"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.94C",
"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.95C",
"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.96C"
]
}
},
{
"key": "ConsumerProducts.CoffeeMaker.Option.BeanContainerSelection",
"type": "ConsumerProducts.CoffeeMaker.EnumType.BeanContainerSelection",
"constraints": {
"allowedvalues": [
"ConsumerProducts.CoffeeMaker.EnumType.BeanContainerSelection.Right",
"ConsumerProducts.CoffeeMaker.EnumType.BeanContainerSelection.Left"
],
"default": "ConsumerProducts.CoffeeMaker.EnumType.BeanContainerSelection.Right",
"liveupdate": true
}
},
{
"key": "ConsumerProducts.CoffeeMaker.Option.FlowRate",
"type": "ConsumerProducts.CoffeeMaker.EnumType.FlowRate",
"constraints": {
"allowedvalues": [
"ConsumerProducts.CoffeeMaker.EnumType.FlowRate.Normal",
"ConsumerProducts.CoffeeMaker.EnumType.FlowRate.Intense",
"ConsumerProducts.CoffeeMaker.EnumType.FlowRate.IntensePlus"
],
"default": "ConsumerProducts.CoffeeMaker.EnumType.FlowRate.Normal",
"liveupdate": true
}
}
]
}
}
Key
ConsumerProducts.CoffeeMaker.Option.BeanAmount
Description
This option describes the bean amount of a coffee machine program.
Data type
Enumeration
Possible values
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
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.BeanAmount",
"value":"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.Mild"
}
}
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
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.FillQuantity",
"value":240,
"unit":"ml"
}
}
Key
ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature
Description
This option describes the coffee temperature of a coffee machine program.
Data type
Enumeration
Possible values
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
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature",
"value":"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.96C"
}
}
Key
ConsumerProducts.CoffeeMaker.Option.BeanContainerSelection
Description
This option defines the preferred bean container.
Data type
Enumeration
Possible values
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
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.BeanContainerSelection",
"value":"ConsumerProducts.CoffeeMaker.EnumType.BeanContainerSelection.Right"
}
}
Key
ConsumerProducts.CoffeeMaker.Option.FlowRate
Description
This options defines the water-coffee contact time. The duration extends to coffee intensity.
Data type
Enumeration
Possible values
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 /
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.FlowRate",
"value":"ConsumerProducts.CoffeeMaker.EnumType.FlowRate.Intense"
}
}
Key
ConsumerProducts.CoffeeMaker.Option.MultipleBeverages
Description
This options defines if double dispensing is enabled.
Data type
Boolean
Possible values
Example
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.MultipleBeverages",
"value":true
}
}
Key
ConsumerProducts.CoffeeMaker.Option.CoffeeMilkRatio
Description
This options defines the milk amount.
Data type
Enumeration
Possible values
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
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.CoffeeMilkRatio",
"value":"ConsumerProducts.CoffeeMaker.EnumType.CoffeeMilkRatio.55Percent"
}
}
Key
ConsumerProducts.CoffeeMaker.Option.HotWaterTemperature
Description
This options defines the temperature suitable for your type of tea.
Data type
Enumeration
Possible values
Celsius values:
Fahrenheit values:
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
{
"data":{
"key":"ConsumerProducts.CoffeeMaker.Option.HotWaterTemperature",
"value":"ConsumerProducts.CoffeeMaker.EnumType.HotWaterTemperature.90C"
}
}
Program support is currently not planned to be released. Selected and active program can be already requested.
Program support is currently not planned to be released. Selected and active program can be already requested.
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.PreRinse
Rinsing of dishes in cold water without detergent.
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.
Dishcare.Dishwasher.Program.MixedLoad
Recommended for a mixed load with glasses, tableware, pots and pans.
Example
PUT /
{
"data":{
"key":"Dishcare.Dishwasher.Program.Eco50",
"options":[
{
"key":"BSH.Common.Option.StartInRelative",
"value":1800,
"unit":"seconds"
}
]
}
}
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 /
{
"data": {
"key": "Dishcare.Dishwasher.Program.Eco50",
"options": [
{
"key": "Dishcare.Dishwasher.Option.VarioSpeedPlus",
"type": "Boolean",
"constraints": {
"default": false,
"liveupdate": true
}
},
{
"key": "Dishcare.Dishwasher.Option.SilenceOnDemand",
"type": "Boolean",
"constraints": {
"default": false,
"liveupdate": true
}
}
]
}
}
Key
BSH.Common.Option.StartInRelative
Description
This option defines when the program should start in seconds. It can be updated in operation state DelayedStart.
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 /
{
"data":{
"key":"BSH.Common.Option.StartInRelative",
"value":1800,
"unit":"seconds"
}
}
Key
Dishcare.Dishwasher.Option.IntensivZone
Description
This option defines if the cleaning is done with higher spray pressure on the lower basket for very dirty pots and pans.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.IntensivZone",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.BrillianceDry
Description
This option defines if the program sequence is optimized with special drying cycle ensures more shine on glasses and plastic items.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.BrillianceDry",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.VarioSpeedPlus
Description
This option defines if the program run time is reduced by up to 66% with the usual optimum cleaning and drying.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.VarioSpeedPlus",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.SilenceOnDemand
Description
This option defines if the extra silent mode is activated for a selected period of time.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.SilenceOnDemand",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.HalfLoad
Description
This option defines if economical cleaning is enabled for smaller loads which reduces energy and water consumption and also saves time. The utensils can be placed in the upper and lower baskets.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.HalfLoad",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.ExtraDry
Description
This option defines if improved drying for glasses and plasticware is enabled.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.ExtraDry",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.HygienePlus
Description
This option defines if the cleaning is done with increased temperatures which ensures maximum hygienic cleanliness for regular use.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.HygienePlus",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.EcoDry
Description
This option defines if the door is opened automatically for extra energy efficient and effective drying.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.EcoDry",
"value":true
}
}
Key
Dishcare.Dishwasher.Option.ZeoliteDry
Description
This option defines if the program sequence is optimized with special drying cycle ensures improved drying for glasses, plates and plasticware.
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"Dishcare.Dishwasher.Option.ZeoliteDry_",
"value":true
}
}
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.
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 /
{
"data":{
"key":"LaundryCare.Dryer.Program.Mix",
"options":[
{
"key":"LaundryCare.Dryer.Option.DryingTarget",
"value":"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry"
}
]
}
}
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 /
{
"data":{
"key":"LaundryCare.Dryer.Program.TimeCold",
"options":[
{
"key":"BSH.Common.Option.Duration",
"value":1200,
"unit":"seconds"
}
]
}
}
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 /
{
"data":{
"key":"LaundryCare.Dryer.Program.TimeColdFix.TimeCold20"
}
}
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 /
{
"data": {
"key": "LaundryCare.Dryer.Program.Synthetic",
"options": [
{
"key": "LaundryCare.Dryer.Option.DryingTarget",
"type": "LaundryCare.Dryer.EnumType.DryingTarget",
"constraints": {
"allowedvalues": [
"LaundryCare.Dryer.EnumType.DryingTarget.IronDry",
"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry",
"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDryPlus"
]
}
},
{
"key": "BSH.Common.Option.FinishInRelative",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 0,
"max": 86400,
"stepsize": 60,
"default": 0
}
}
]
}
}
GET /
{
"data": {
"key": "LaundryCare.Dryer.Program.TimeCold",
"options": [
{
"key": "BSH.Common.Option.Duration",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 1200,
"max": 12600,
"stepsize": 600,
"default": 1200
}
},
{
"key": "BSH.Common.Option.FinishInRelative",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 0,
"max": 86400,
"stepsize": 60,
"default": 0
}
}
]
}
}
Key
LaundryCare.Dryer.Option.DryingTarget
Description
This options describes the drying target of a dryer program.
Data type
Enumeration
Possible values
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 /
{
"data":{
"key":"LaundryCare.Dryer.Option.DryingTarget",
"value":"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry"
}
}
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.
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.
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.
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:
Example
PUT /
{
"data": {
"key": "Cooking.Common.Program.Hood.Automatic"
}
}
Key
Cooking.Common.Program.Hood.Venting
Description
Example
PUT /
{
"data": {
"key": "Cooking.Common.Program.Hood.Venting",
"options": [
{
"key": "Cooking.Common.Option.Hood.IntensiveLevel",
"value": "Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1"
}
]
}
}
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:
Example
PUT /
{
"data":{
"key":"Cooking.Common.Program.Hood.DelayedShutOff"
}
}
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 /
{
"data": {
"key": "Cooking.Common.Program.Hood.Venting",
"options": [
{
"key": "Cooking.Common.Option.Hood.VentingLevel",
"type": "Cooking.Hood.EnumType.Stage",
"constraints": {
"allowedvalues": [
"Cooking.Hood.EnumType.Stage.FanOff",
"Cooking.Hood.EnumType.Stage.FanStage01",
"Cooking.Hood.EnumType.Stage.FanStage02",
"Cooking.Hood.EnumType.Stage.FanStage03"
]
}
},
{
"key": "Cooking.Common.Option.Hood.IntensiveLevel",
"type": "Cooking.Hood.EnumType.IntensiveStage",
"constraints": {
"allowedvalues": [
"Cooking.Hood.EnumType.IntensiveStage.IntensiveStageOff",
"Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1",
"Cooking.Hood.EnumType.IntensiveStage.IntensiveStage2"
]
}
}
]
}
}
Key
Cooking.Common.Option.Hood.VentingLevel
Description
This option defines the required fan setting.
Data type
Enumeration
Possible values
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 /
{
"data":{
"key":"Cooking.Common.Option.Hood.VentingLevel",
"value":"Cooking.Hood.EnumType.Stage.FanStage02"
}
}
Key
Cooking.Common.Option.Hood.IntensiveLevel
Description
This option defines the intensive setting.
Data type
Enumeration
Possible values
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 /
{
"data":{
"key":"Cooking.Common.Option.Hood.IntensiveLevel",
"value":"Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1"
}
}
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.
Cooking.Oven.Program.HeatingMode.HotAir30Steam
This heating type is suitable for cooking without added liquid for pastries. (Hot air + 30% humidity)
Cooking.Oven.Program.HeatingMode.HotAir60Steam
This heating type is suitable for yeast-risen dough and bread. Also for rising yeast dough and sour dough at low temperature. (Hot air + 60% humidity)
Cooking.Oven.Program.HeatingMode.HotAir80Steam
This heating type is suitable for puff pastry, meat and poultry. (Hot air + 80% humidity)
Cooking.Oven.Program.HeatingMode.HotAir100Steam
This heating type is suitable for steaming vegetables, fish and side dishes. Combination mode for puff pastry, bread and bread rolls. (Hot air + 100% humidity)
Cooking.Oven.Program.HeatingMode.SabbathProgramme
A constant temperature is maintained for a period of 24-74 hours.
Cooking.Oven.Program.Microwave.90Watt
This microwave power setting is suitable for defrosting delicate foods.
Cooking.Oven.Program.Microwave.180Watt
This microwave power setting is suitable for defrosting and continued cooking.
Cooking.Oven.Program.Microwave.360Watt
This microwave power setting is suitable for cooking meat and heating delicate foods.
Cooking.Oven.Program.Microwave.600Watt
This microwave power setting is suitable for heating and cooking food.
Cooking.Oven.Program.Microwave.900Watt
This microwave power setting is suitable for heating beverages.
Cooking.Oven.Program.Microwave.1000Watt
This microwave power setting is suitable for heating beverages.
Cooking.Oven.Program.Microwave.Max
This microwave power setting is suitable for heating beverages.
Example
PUT /
{
"data":{
"key":"Cooking.Oven.Program.HeatingMode.HotAir",
"options":[
{
"key":"Cooking.Oven.Option.SetpointTemperature",
"value":230,
"unit":"°C"
},
{
"key":"BSH.Common.Option.Duration",
"value":1200,
"unit":"seconds"
}
]
}
}
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 /
{
"data": {
"key": "Cooking.Oven.Program.HeatingMode.HotAir",
"options": [
{
"key": "Cooking.Oven.Option.SetpointTemperature",
"type": "Double",
"unit": "°C",
"constraints": {
"min": 30,
"max": 275
}
},
{
"key": "BSH.Common.Option.Duration",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 1,
"max": 86340
}
},
{
"key": "Cooking.Oven.Option.FastPreHeat",
"type": "Boolean"
},
{
"key": "BSH.Common.Option.StartInRelative",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 0,
"max": 86340
}
}
]
}
}
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 /
{
"data":{
"key":"Cooking.Oven.Option.SetpointTemperature",
"value":230,
"unit":"°C"
}
}
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 /
{
"data":{
"key":"BSH.Common.Option.Duration",
"value":1200,
"unit":"seconds"
}
}
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
Example
GET /
{
"data":{
"key":"Cooking.Oven.Option.FastPreHeat",
"value":true
}
}
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.
The following list contains all warming drawer programs, which are supported by the API. Please note that not all programs are supported for a specific warming drawer model. Therefore, we recommend to use the available program interface to check the program availability.
Cooking.Oven.Program.HeatingMode.WarmingDrawer
This heating type is suitable for warming ovenware.
Example
PUT /
{
"data":{
"key":"Cooking.Oven.Program.HeatingMode.WarmingDrawer",
"options":[
{
"key":"Cooking.Oven.Option.WarmingLevel",
"value":"Cooking.Oven.EnumType.WarmingLevel.Medium"
}
]
}
}
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 /
{
"data": {
"key": "Cooking.Oven.Program.HeatingMode.WarmingDrawer",
"options": [
{
"key": "Cooking.Oven.Option.WarmingLevel",
"type": "Cooking.Oven.EnumType.WarmingLevel",
"constraints": {
"allowedvalues": [
"Cooking.Oven.EnumType.WarmingLevel.Low",
"Cooking.Oven.EnumType.WarmingLevel.Medium",
"Cooking.Oven.EnumType.WarmingLevel.High"
],
"default": "Cooking.Oven.EnumType.WarmingLevel.Medium"
}
}
]
}
}
Key
Cooking.Oven.Option.WarmingLevel
Description
This option defines the level of the warming drawer.
Data type
Enumeration
Possible values
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 /
{
"data":{
"key":"Cooking.Oven.Option.WarmingLevel",
"value":"LaundryCare.Washer.EnumType.Temperature.GC30"
}
}
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.Cotton.CottonEco
For cleaning cotton clothing with normal soiling, while optimising energy and water consumption. (Max. load)
LaundryCare.Washer.Program.Cotton.Eco4060
For cleaning of textiles made of cotton, linen and blended fabrics with normal soiling, which according to the care symbol are washable at 40 °C or 60 °C. Textiles can be washed together.
LaundryCare.Washer.Program.Cotton.Colour
For cleaning of hard-wearing textiles made of cotton, linen and blended fabrics. Energy-saving programme. The actual washing temperature may deviate from the set washing temperature. The washing performance meets legal requirements.
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.Mix.NightWash
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)
LaundryCare.Washer.Program.PowerSpeed59
For cleaning lightly to normally soiled laundry (cotton, linen, synthetic and mixed fabric) in less than 60 minutes.
LaundryCare.Washer.Program.Super153045.Super15
For quickly freshening up lightly soiled laundry (cottons, synthetic and mixed fibres) in 15 minutes. (Max. load: 2.0 kg)
LaundryCare.Washer.Program.Super153045.Super1530
For quickly freshening up lightly soiled laundry (cotton, synthetic and mixed fibres) in 15 minutes or 30 minutes.
LaundryCare.Washer.Program.DownDuvet.Duvet
For gentle washing of microfibre throws and blankets, bed covers and pillows stuffed with down or synthetic fibres. Wash large items separately. It is recommended to dose a mild detergent economically.
LaundryCare.Washer.Program.Rinse.RinseSpinDrain
For separately rinsing and spinning your laundry, and pumping out any water remaining in the washing machine. For rinse only, set the spin speed to 0. For spin only, set Rinse Plus to 0/deactivate Rinse Plus. For pumping out only, take both of the steps just mentioned.
LaundryCare.Washer.Program.DrumClean
For cleaning the washing machine drum and the supply and drain hoses.
Example
PUT /
{
"data":{
"key":"LaundryCare.Washer.Program.Cotton",
"options":[
{
"key":"LaundryCare.Washer.Option.Temperature",
"value":"LaundryCare.Washer.EnumType.Temperature.GC30"
},
{
"key":"LaundryCare.Washer.Option.SpinSpeed",
"value":"LaundryCare.Washer.EnumType.SpinSpeed.RPM800"
}
]
}
}
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 /
{
"data": {
"key": "LaundryCare.Washer.Program.Cotton",
"options": [
{
"key": "LaundryCare.Washer.Option.Temperature",
"type": "LaundryCare.Washer.EnumType.Temperature",
"constraints": {
"allowedvalues": [
"LaundryCare.Washer.EnumType.Temperature.Cold",
"LaundryCare.Washer.EnumType.Temperature.GC20",
"LaundryCare.Washer.EnumType.Temperature.GC30",
"LaundryCare.Washer.EnumType.Temperature.GC40",
"LaundryCare.Washer.EnumType.Temperature.GC50",
"LaundryCare.Washer.EnumType.Temperature.GC60",
"LaundryCare.Washer.EnumType.Temperature.GC70",
"LaundryCare.Washer.EnumType.Temperature.GC80",
"LaundryCare.Washer.EnumType.Temperature.GC90"
]
}
},
{
"key": "LaundryCare.Washer.Option.SpinSpeed",
"type": "LaundryCare.Washer.EnumType.SpinSpeed",
"constraints": {
"allowedvalues": [
"LaundryCare.Washer.EnumType.SpinSpeed.RPM400",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM600",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM800",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM1000",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM1200",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM1400"
]
}
},
{
"key": "BSH.Common.Option.FinishInRelative",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 0,
"max": 86400,
"stepsize": 60,
"default": 0
}
},
{
"key": "LaundryCare.Washer.Option.IDos1Active",
"type": "Boolean"
},
{
"key": "LaundryCare.Washer.Option.IDos2Active",
"type": "Boolean"
}
]
}
}
Key
LaundryCare.Washer.Option.Temperature
Description
This option defines the temperature of the washing program.
Data type
Enumeration
Possible values
Typically supported by US/CA appliances:
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 /
{
"data":{
"key":"LaundryCare.Washer.Option.Temperature",
"value":"LaundryCare.Washer.EnumType.Temperature.GC30"
}
}
Key
LaundryCare.Washer.Option.SpinSpeed
Description
This option defines the spin speed of a washer program.
Data type
Enumeration
Possible values
Typically supported by US/CA appliances:
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 /
{
"data":{
"key":"LaundryCare.Washer.Option.SpinSpeed",
"value":"LaundryCare.Washer.EnumType.SpinSpeed.RPM800"
}
}
Key
BSH.Common.Option.FinishInRelative
Description
This option defines when the program should end in seconds. It can be updated in operation state DelayedStart.
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 86400 seconds
Example
GET /
{
"data":{
"key":"BSH.Common.Option.FinishInRelative",
"value":3600,
"unit":"seconds"
}
}
Key
LaundryCare.Washer.Option.IDos1Active
Description
This option defines if the detergent feed is activated / deactivated. (i-Dos content 1)
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"LaundryCare.Washer.Option.IDos1Active",
"value":true
}
}
Key
LaundryCare.Washer.Option.IDos2Active
Description
This option defines if the detergent feed is activated / deactivated. (i-Dos content 2)
Data type
Boolean
Possible values
Example
GET /
{
"data":{
"key":"LaundryCare.Washer.Option.IDos2Active",
"value":true
}
}
Key
LaundryCare.Common.Option.VarioPerfect
Description
This option defines if a cycle saves energy (Eco Perfect) or time (Speed Perfect).
Data type
Enumeration
Possible values
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 /
{
"data":{
"key":"LaundryCare.Common.Option.VarioPerfect",
"value":"LaundryCare.Common.EnumType.VarioPerfect.EcoPerfect"
}
}
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.
In addition, the following washer dryer programs are supported which are a combination of a washer and dryer program.
LaundryCare.WasherDryer.Program.Cotton
For cleaning normally to heavily soiled cotton or linen clothing. Automatic drying at normal temperature.
LaundryCare.WasherDryer.Program.Cotton.Eco4060
For cleaning of textiles made of cotton, linen and blended fabrics with normal soiling, which according to the care symbol are washable at 40 °C or 60 °C. Textiles can be washed together. Automatic drying at normal temperature.
LaundryCare.WasherDryer.Program.Mix
For cleaning of mixed load of cottons and synthetic fabrics.
LaundryCare.WasherDryer.Program.EasyCare
For cleaning easy-care laundry made of synthetic fibres or mixed fabrics, such as polyamide or polyester. Drying at a low temperature for textile care.
LaundryCare.WasherDryer.Program.WashAndDry.60
For fast cleaning and subsequent drying of the laundry in 60 minutes. Maximum of up to 1kg load of light clothing for each washing cycle.
LaundryCare.WasherDryer.Program.WashAndDry.90
For fast cleaning and subsequent drying of light dirty or medium dirty textiles made of cotton or mixed fabric in 90 minutes.
Example
PUT /
{
"data":{
"key":"LaundryCare.WasherDryer.Program.Mix",
"options":[
{
"key":"LaundryCare.Washer.Option.Temperature",
"value":"LaundryCare.Washer.EnumType.Temperature.GC30"
},
{
"key":"LaundryCare.Washer.Option.SpinSpeed",
"value":"LaundryCare.Washer.EnumType.SpinSpeed.RPM800"
},
{
"key":"LaundryCare.Dryer.Option.DryingTarget",
"value":"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry"
}
]
}
}
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 /
{
"data": {
"key": "LaundryCare.Washer.Program.Cotton",
"options": [
{
"key": "LaundryCare.Washer.Option.Temperature",
"type": "LaundryCare.Washer.EnumType.Temperature",
"constraints": {
"allowedvalues": [
"LaundryCare.Washer.EnumType.Temperature.Cold",
"LaundryCare.Washer.EnumType.Temperature.GC20",
"LaundryCare.Washer.EnumType.Temperature.GC30",
"LaundryCare.Washer.EnumType.Temperature.GC40",
"LaundryCare.Washer.EnumType.Temperature.GC50",
"LaundryCare.Washer.EnumType.Temperature.GC60",
"LaundryCare.Washer.EnumType.Temperature.GC70",
"LaundryCare.Washer.EnumType.Temperature.GC80",
"LaundryCare.Washer.EnumType.Temperature.GC90"
]
}
},
{
"key": "LaundryCare.Washer.Option.SpinSpeed",
"type": "LaundryCare.Washer.EnumType.SpinSpeed",
"constraints": {
"allowedvalues": [
"LaundryCare.Washer.EnumType.SpinSpeed.RPM400",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM600",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM800",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM1000",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM1200",
"LaundryCare.Washer.EnumType.SpinSpeed.RPM1400"
]
}
},
{
"key": "BSH.Common.Option.FinishInRelative",
"type": "Int",
"unit": "seconds",
"constraints": {
"min": 0,
"max": 86400,
"stepsize": 60,
"default": 0
}
},
{
"key": "LaundryCare.Washer.Option.IDos1Active",
"type": "Boolean"
},
{
"key": "LaundryCare.Washer.Option.IDos2Active",
"type": "Boolean"
}
]
}
}
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.