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.

Settings

Power State
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

BSH.Common.Setting.PowerState

Description

This setting describes the current power state of the home appliance.

Data type

Enumeration

Possible values

  • Off
    Key: BSH.Common.EnumType.PowerState.Off
    Description: The home appliance switched to off state but can be switched on by writing the value BSH.Common.EnumType.PowerState.On to this setting.
  • On
    Key: BSH.Common.EnumType.PowerState.On
    Description: The home appliance switched to on state. You can switch it off by writing the value BSH.Common.EnumType.PowerState.Off or BSH.Common.EnumType.PowerState.Standby depending on what is supported by the appliance.
  • Stand-by
    Key: BSH.Common.EnumType.PowerState.Standby
    Description: The home appliance went to standby mode. You can switch it on or off by changing the value of this setting appropriately.

Availability

Example

GET /api/homeappliances/{haid}/settings/BSH.Common.Setting.PowerState

Temperature Unit
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • Off
    Key: BSH.Common.EnumType.TemperatureUnit.Celsius
    Description: °C
  • On
    Key: BSH.Common.EnumType.TemperatureUnit.Fahrenheit
    Description: °F

Availability

Example

GET /api/homeappliances/{haid}/settings/BSH.Common.Setting.TemperatureUnit

Liquid Volume Unit
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • FluidOunces
    Key: BSH.Common.EnumType.LiquidVolumeUnit.FluidOunces
    Description: fl.ounces
  • MilliLiter
    Key: BSH.Common.EnumType.LiquidVolumeUnit.MilliLiter
    Description: ml

Availability

Example

GET /api/homeappliances/{haid}/settings/BSH.Common.Setting.LiquidVolumeUnit

Setpoint Temperature Refrigerator
Copied link to clipboard

Cooking
Cleaning
Cooling

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

GET /api/homeappliances/{haid}/settings/Refrigeration.FridgeFreezer.Setting.SetpointTemperatureRefrigerator

Setpoint Temperature Freezer
Copied link to clipboard

Cooking
Cleaning
Cooling

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

GET /api/homeappliances/{haid}/settings/Refrigeration.FridgeFreezer.Setting.SetpointTemperatureFreezer

Setpoint Temperature Bottle Cooler
Copied link to clipboard

Cooking
Cleaning
Cooling

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

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.BottleCooler.SetpointTemperature

Setpoint Temperature Chiller
Copied link to clipboard

Cooking
Cleaning
Cooling

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

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.ChillerCommon.SetpointTemperature

Setpoint Temperature Wine Compartment
Copied link to clipboard

Cooking
Cleaning
Cooling

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

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.WineCompartment.SetpointTemperature

Super Mode Refrigerator
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator

Super Mode Freezer
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Refrigeration.FridgeFreezer.Setting.SuperModeFreezer

Eco Mode
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.EcoMode

Sabbath Mode
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

Refrigeration.Common.Setting.SabbathMode

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

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.SabbathMode

Vacation Mode
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.VacationMode

Fresh Mode
Copied link to clipboard

Cooking
Cleaning
Cooling

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

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Refrigeration.Common.Setting.FreshMode

Current Map
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Setting.CurrentMap

Description

This setting describes the currently selected map of the cleaning robot.

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

Example

GET /api/homeappliances/{haid}/settings/ConsumerProducts.CleaningRobot.Setting.CurrentMap

Names of Maps
Copied link to clipboard

Cooking
Cleaning
Cooling

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 /api/homeappliances/{haid}/settings/ConsumerProducts.CleaningRobot.Setting.NameOfMap1

Functional Light
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

Cooking.Common.Setting.Lighting

Description

This setting describes the functional light state of hoods.

Data type

Boolean

Possible values

  • true if on
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/Cooking.Common.Setting.Lighting

Functional Light Brightness
Copied link to clipboard

Cooking
Cleaning
Cooling

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 /api/homeappliances/{haid}/settings/Cooking.Common.Setting.LightingBrightness

Ambient Light
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

BSH.Common.Setting.AmbientLightEnabled

Description

This setting describes the ambient light state of hoods.

Data type

Boolean

Possible values

  • true if on
  • false otherwise

Example

GET /api/homeappliances/{haid}/settings/BSH.Common.Setting.AmbientLightEnabled

Ambient Light Brightness
Copied link to clipboard

Cooking
Cleaning
Cooling

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 /api/homeappliances/{haid}/settings/BSH.Common.Setting.AmbientLightBrightness

Ambient Light Color
Copied link to clipboard

Cooking
Cleaning
Cooling

Key

BSH.Common.Setting.AmbientLightColor

Description

This setting describes the color state of the ambient light.

Data type

Enumeration

Possible values

  • Custom Color
    Key: BSH.Common.EnumType.AmbientLightColor.CustomColor
  • Color 1 .. 99
    Key: BSH.Common.EnumType.AmbientLightColor.Color[1 .. 99]

Availability

Example

GET /api/homeappliances/{haid}/settings/BSH.Common.Setting.AmbientLightColor

Ambient Light Custom Color
Copied link to clipboard

Cooking
Cleaning
Cooling

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 /api/homeappliances/{haid}/settings/BSH.Common.Setting.AmbientLightCustomColor