This page does NOT support Internet Explorer. Please use a modern browser like e.g. Google Chrome, Mozilla Firefox or Microsoft Edge.
Key
BSH.Common.Setting.PowerState
Description
This setting describes the current power state of the home appliance.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.PowerState",
"value": "BSH.Common.EnumType.PowerState.On",
"type": "BSH.Common.EnumType.PowerState",
"constraints": {
"allowedvalues": [
"BSH.Common.EnumType.PowerState.On",
"BSH.Common.EnumType.PowerState.Standby"
],
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.TemperatureUnit
Description
This setting describes the temperature unit of the home appliance. Please note that this setting isn't supported by all appliances. If the feature isn't returned then it can be assumed that the appliance is set to Celsius.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.TemperatureUnit",
"value": "BSH.Common.EnumType.TemperatureUnit.Celsius",
"type": "BSH.Common.EnumType.TemperatureUnit",
"constraints": {
"allowedvalues": [
"BSH.Common.EnumType.TemperatureUnit.Celsius",
"BSH.Common.EnumType.TemperatureUnit.Fahrenheit"
],
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.LiquidVolumeUnit
Description
This setting describes the liquid volume unit of the home appliance. Please note that this setting isn't supported by all appliances. If the feature isn't returned then it can be assumed that the appliance is set to MiliLiter.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.LiquidVolumeUnit",
"value": "BSH.Common.EnumType.LiquidVolumeUnit.MilliLiter",
"type": "BSH.Common.EnumType.LiquidVolumeUnit",
"constraints": {
"allowedvalues": [
"BSH.Common.EnumType.LiquidVolumeUnit.FluidOunces",
"BSH.Common.EnumType.LiquidVolumeUnit.MilliLiter"
],
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.ChildLock
Description
This setting describes the child lock state of the home appliance.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.ChildLock",
"value": false,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.AlarmClock
Description
The setting can be used to set the alarm clock.
Data type
Integer
Possible values
0 to 38340 seconds
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.AlarmClock",
"constraints": {
"access": "readWrite"
},
"unit": "seconds",
"type": "Int",
"value": 0
}
}
Key
ConsumerProducts.CoffeeMaker.Setting.CupWarmer
Description
The setting can be used to enable the cup warmer. Please note that this feature is not supported by all coffee machines.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "ConsumerProducts.CoffeeMaker.Setting.CupWarmer",
"value": false,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.FridgeFreezer.Setting.SetpointTemperatureRefrigerator
Description
Setting for the desired temperature in the refrigerator
Data type
Double
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: 2 to 8 °C or 39 to 44 °F
Example
{
"data": {
"key": "Refrigeration.FridgeFreezer.Setting.SetpointTemperatureRefrigerator",
"value": 8,
"unit": "°C",
"type": "Double",
"constraints": {
"min": 2,
"max": 8,
"access": "readWrite"
}
}
}
Key
Refrigeration.FridgeFreezer.Setting.SetpointTemperatureFreezer
Description
Setting for the desired temperature in the freezer
Data type
Double
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: -24 to -16 °C or -10 to 3 °F
Example
{
"data": {
"key": "Refrigeration.FridgeFreezer.Setting.SetpointTemperatureFreezer",
"value": -24,
"unit": "°C",
"type": "Double",
"constraints": {
"min": -24,
"max": -16,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.BottleCooler.SetpointTemperature
Description
Setting for the desired temperature in the bottle cooler
Data type
Double
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: -1 to 3 °C or 28 to 46 °F
Example
{
"data": {
"key": "Refrigeration.Common.Setting.BottleCooler.SetpointTemperature",
"value": 2,
"unit": "°C",
"type": "Double",
"constraints": {
"min": -1,
"max": 3,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.ChillerLeft.SetpointTemperature
Refrigeration.Common.Setting.ChillerCommon.SetpointTemperature
Refrigeration.Common.Setting.ChillerRight.SetpointTemperature
Description
Setting for the desired temperature in the freshness compartment (left, common or right)
Data type
Double
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: -1 to 3 °C or 30 to 37 °F
Example
{
"data": {
"key": "Refrigeration.Common.Setting.ChillerCommon.SetpointTemperature",
"value": 2,
"unit": "°C",
"type": "Double",
"constraints": {
"min": -1,
"max": 3,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.WineCompartment.SetpointTemperature
Refrigeration.Common.Setting.WineCompartment2.SetpointTemperature
Refrigeration.Common.Setting.WineCompartment3.SetpointTemperature
Description
Setting for the desired temperature in the wine compartment (top, middle or bottom)
Data type
Double
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: 5 to 20 °C or 41 to 68 °F
Example
{
"data": {
"key": "Refrigeration.Common.Setting.WineCompartment.SetpointTemperature",
"value": 11,
"unit": "°C",
"type": "Double",
"constraints": {
"min": 5,
"max": 20,
"access": "readWrite"
}
}
}
Key
Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator
Description
The setting has no impact on setpoint temperatures but will make the refrigeratorcompartment cool to the lowest possible temperature until it is disabled by the manually by the customer or by the HA because of a timeout.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.FridgeFreezer.Setting.SuperModeFreezer
Description
This setting has no impact on setpoint temperatures but will make the freezer compartment cool to the lowest possible temperature until it is disabled by the manually by the customer or by the home appliance because of a timeout.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.FridgeFreezer.Setting.SuperModeFreezer",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.EcoMode
Description
Higher temperatures in the appliance mean that less cooling capacity is required and the appliance runs in an eco-friendly setting.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.EcoMode",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Cooking.Oven.Setting.SabbathMode (for ovens)
Refrigeration.Common.Setting.SabbathMode (for cooling appliances)
Description
In Sabbath Mode, various functions (e.g. lighting, acoustic signals) are deactivated to ensure that practising Jews are also able to use the appliance on the Sabbath.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.SabbathMode",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.VacationMode
Description
If you will be away for an extended period, you can switch to the eco-friendly Vacation Mode in the appliance. The refrigerator temperature switches to +14°C. No food may be stored in the refrigerator during this period. The temperature in the freezer is maintained according to the setting.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.VacationMode",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.FreshMode
Description
The Fresh Mode ensures that food keeps for a longer period. The appliance sets the following temperatures automatically: refrigerator 2°C. The freezer remains unchanged.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.FreshMode",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Dispenser.Enabled
Description
You can switch the ice water dispenser on and off.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Dispenser.Enabled",
"value": true,
"type": "Boolean",
"constraints": {
"default": false,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Door.AssistantFridge Refrigeration.Common.Setting.Door.AssistantFreezer
Description
Enables/disables the Automatic Door Opening Refrigerator / Freezer Compartment
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Door.AssistantFridge",
"value": true,
"type": "Boolean",
"constraints": {
"default": true,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Door.AssistantForceFridge Refrigeration.Common.Setting.Door.AssistantForceFreezer
Description
This setting describes the level of pressure required to activate automatic door opening.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Door.AssistantForceFridge",
"value": "Refrigeration.Common.EnumType.Door.AssistantForce.MiddleForce",
"type": "Refrigeration.Common.EnumType.Door.AssistantForce",
"constraints": {
"allowedvalues": [
"Refrigeration.Common.EnumType.Door.AssistantForce.LowForce",
"Refrigeration.Common.EnumType.Door.AssistantForce.MiddleForce",
"Refrigeration.Common.EnumType.Door.AssistantForce.HighForce"
],
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Door.AssistantTimeoutFridge Refrigeration.Common.Setting.Door.AssistantTimeoutFreezer
Description
This setting describes the time frame for door assistant.
Data type
Integer
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Door.AssistantTimeoutFridge",
"value": 0,
"unit": "seconds",
"type": "Int",
"constraints": {
"default": 0,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Door.AssistantTriggerFridge Refrigeration.Common.Setting.Door.AssistantTriggerFreezer
Description
This setting describes the way to activate automatic door openings.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Door.AssistantTriggerFridge",
"value": "Refrigeration.Common.EnumType.Door.AssistantTrigger.Push",
"type": "Refrigeration.Common.EnumType.Door.AssistantTrigger",
"constraints": {
"allowedvalues": [
"Refrigeration.Common.EnumType.Door.AssistantTrigger.Push",
"Refrigeration.Common.EnumType.Door.AssistantTrigger.Pull",
"Refrigeration.Common.EnumType.Door.AssistantTrigger.PushPull"
],
"default": "Refrigeration.Common.EnumType.Door.AssistantTrigger.Push",
"access": "readWrite"
}
}
}
Key
ConsumerProducts.CleaningRobot.Setting.CurrentMap
Description
This setting describes the currently selected map of the cleaning robot.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "ConsumerProducts.CleaningRobot.Setting.CurrentMap",
"value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1",
"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"
],
"access": "readWrite"
}
}
}
Key
ConsumerProducts.CleaningRobot.Setting.NameOfMap1
ConsumerProducts.CleaningRobot.Setting.NameOfMap2
ConsumerProducts.CleaningRobot.Setting.NameOfMap3
Description
This setting describes the name of the user-defined map (1 - 3).
Data type
String
Example
GET /
{
"data": {
"key": "ConsumerProducts.CleaningRobot.Setting.NameOfMap1",
"value": "1st floor",
"type": "String",
"constraints": {
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Light.External.Brightness
Refrigeration.Common.Setting.Light.Internal.Brightness
Description
This setting describes the external / internal light state of cooling devices.
Data type
Double
Possible values
0 - 100%
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Light.External.Brightness",
"value": 70,
"unit": "%",
"type": "Double",
"constraints": {
"min": 0,
"max": 100,
"access": "readWrite"
}
}
}
Key
Refrigeration.Common.Setting.Light.External.Power
Refrigeration.Common.Setting.Light.Internal.Power
Description
This setting describes the external / interal light state of cooling devices.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Refrigeration.Common.Setting.Light.External.Power",
"value": true,
"type": "Boolean"
}
}
Key
Cooking.Common.Setting.Lighting
Description
This setting describes the functional light state of hoods.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "Cooking.Common.Setting.Lighting",
"value": true,
"type": "Boolean"
}
}
Key
Cooking.Common.Setting.LightingBrightness
Description
This setting describes the brightness state of the functional light.
Data type
Double
Possible values
10 - 100%
Example
GET /
{
"data": {
"key": "Cooking.Common.Setting.LightingBrightness",
"value": 70,
"unit": "%",
"type": "Double",
"constraints": {
"min": 10,
"max": 100,
"access": "readWrite"
}
}
}
Key
Cooking.Hood.Setting.ColorTemperaturePercent
Description
This setting describes the color temperature of the functional light in percent (warm light: 0 %, cold light: 100 %). If the ColorTemperature setting is supported, then it must to be set to custom otherwise this setting can't be used.
Data type
Double
Possible values
0 - 100%
Example
GET /
{
"data": {
"key": "Cooking.Hood.Setting.ColorTemperaturePercent",
"value": 70,
"unit": "%",
"type": "Double",
"constraints": {
"min": 0,
"max": 100,
"access": "readWrite"
}
}
}
Key
Cooking.Hood.Setting.ColorTemperature
Description
This setting describes the color temperature of the functional light (warm light: 0 %, cold light: 100 %). If the setting is set to custom, then ColorTemperaturePercent setting can be used to set color temperature in percents (warm light: 0 %, cold light: 100 %).
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.ColorTemperature",
"value": "Cooking.Hood.EnumType.ColorTemperature.warmToNeutral",
"type": "BSH.Common.EnumType.ColorTemperature",
"constraints": {
"allowedvalues": [
"Cooking.Hood.EnumType.ColorTemperature.custom",
"Cooking.Hood.EnumType.ColorTemperature.warm",
"Cooking.Hood.EnumType.ColorTemperature.warmToNeutral",
"Cooking.Hood.EnumType.ColorTemperature.neutral",
"Cooking.Hood.EnumType.ColorTemperature.neutralToCold",
"Cooking.Hood.EnumType.ColorTemperature.cold"
],
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.AmbientLightEnabled
Description
This setting describes the ambient light state of hoods.
Data type
Boolean
Possible values
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.AmbientLightEnabled",
"value": true,
"type": "Boolean"
}
}
Key
BSH.Common.Setting.AmbientLightBrightness
Description
This setting describes the brightness state of the ambient light. Please note that the brightness can't be set if the ambient light color is set to CustomColor.
Data type
Double
Possible values
10 - 100%
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.AmbientLightBrightness",
"value": 70,
"unit": "%",
"type": "Double",
"constraints": {
"min": 10,
"max": 100,
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.AmbientLightColor
Description
This setting describes the color state of the ambient light.
Data type
Enumeration
Possible values
Availability
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.AmbientLightColor",
"value": "BSH.Common.EnumType.AmbientLightColor.Color43",
"type": "BSH.Common.EnumType.AmbientLightColor",
"constraints": {
"allowedvalues": [
"BSH.Common.EnumType.AmbientLightColor.CustomColor",
"BSH.Common.EnumType.AmbientLightColor.Color1",
"BSH.Common.EnumType.AmbientLightColor.Color2",
..
"BSH.Common.EnumType.AmbientLightColor.Color99"
],
"access": "readWrite"
}
}
}
Key
BSH.Common.Setting.AmbientLightCustomColor
Description
This setting describes the brightness state of the ambient light. Please note that the custom color can be only set if the ambient light color is set to CustomColor.
Data type
String
Example
GET /
{
"data": {
"key": "BSH.Common.Setting.AmbientLightCustomColor",
"value": "#4a88f8",
"type": "String",
"constraints": {
"access": "readWrite"
}
}
}
Key
LaundryCare.Washer.Setting.IDos1BaseLevel
Description
This setting describes the basis dosing volume for i-Dos content 1.
Data type
Integer
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: 5 to 200 ml
Example
GET /
{
"data": {
"key": "LaundryCare.Washer.Setting.IDos1BaseLevel",
"value": 97,
"unit": "ml",
"type": "Int",
"constraints": {
"min": 5,
"max": 200,
"stepsize": 1,
"default": 36,
"access": "readWrite"
}
}
}
Key
LaundryCare.Washer.Setting.IDos2BaseLevel
Description
This setting describes the basis dosing volume for i-Dos content 2.
Data type
Integer
Possible values
Please note that there is no common value range for all appliances. The value range can be always requested by using the get specific setting endpoint.
For example: 5 to 200 ml
Example
GET /
{
"data": {
"key": "LaundryCare.Washer.Setting.IDos2BaseLevel",
"value": 97,
"unit": "ml",
"type": "Int",
"constraints": {
"min": 5,
"max": 200,
"stepsize": 1,
"default": 75,
"access": "readWrite"
}
}
}