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.

Events

Availability Matrix
Copied link to clipboard

The following table lists all supported event types. Please note that the event types PAIRED and DEPAIRED are only supported by the events all interface.

Events

The following table lists all feature-based events.

Example

GET /api/homeappliances/{haid}/events

Program Changes
Copied link to clipboard

Selected Program Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Root.SelectedProgram

Description

This event notifies that the program which is currently selected and shown on the user interface of the home appliance has changed.

Data type

String (Program Key)

Possible values

See Cleaning Robot, Coffee Machine, Cooktop, Cook Processor, Dishwasher, Dryer, Oven, Warming Drawer, Washer, Washer Dryer

Example

GET /api/homeappliances/{haid}/events

Active Program Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Root.ActiveProgram

Description

This event notifies that the program which is currently executed by the home appliance has changed.

Data type

String (Program Key)

Possible values

See Cleaning Robot, Coffee Machine, Cooktop, Cook Processor, Dishwasher, Dryer, Hood, Oven, Warming Drawer, Washer, Washer Dryer

Example

GET /api/homeappliances/{haid}/events

Option Changes
Copied link to clipboard

Oven Setpoint Temperature Change

Cooking
Cleaning
Cooling

Key

Cooking.Oven.Option.SetpointTemperature

Description

This event notifies that the intended temperature of an oven program has changed, e.g. by the user operating the oven locally.

Data type

Double

Possible values

see Setpoint Temperature option

Example

GET /api/homeappliances/{haid}/events

Program Duration Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.Duration

Description

This event notifies that the program duration has changed, e.g. by the user operating the home appliance locally.

Data type

Integer

Possible values

see Duration option

Example

GET /api/homeappliances/{haid}/events

Fast Pre-heat Change

Cooking
Cleaning
Cooling

Key

Cooking.Oven.Option.FastPreHeat

Description

This event notifies that the fast pre-heat option of an oven program has changed, e.g. by the user operating the oven locally.

Data type

Boolean

Possible values

  • true if enabled
  • false otherwise

Example

GET /api/homeappliances/{haid}/events

Warming Level Change

Cooking
Cleaning
Cooling

Key

Cooking.Oven.Option.WarmingLevel

Description

This event notifies that the warming level option of an warming drawer program has changed, e.g. by the user operating the warming drawer locally.

Data type

Enumeration

Possible values

see Warming Level enumeration

Example

GET /api/homeappliances/{haid}/events

Start in Relative Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.StartInRelative

Description

This event notifies that the delayed start of a program has changed, e.g. by the user operating the home appliance locally.

Data type

Integer

Possible values

see Start in Relative option

Example

GET /api/homeappliances/{haid}/events

Washer Temperature Change

Cooking
Cleaning
Cooling

Key

LaundryCare.Washer.Option.Temperature

Description

This event notifies that the temperature of a washer program changed, e.g. by the user operating the washer locally.

Data type

Enumeration

Possible values

see Washer Temperature enumeration

Example

GET /api/homeappliances/{haid}/events

Spin Speed Change

Cooking
Cleaning
Cooling

Key

LaundryCare.Washer.Option.SpinSpeed

Description

This event notifies that the spin speed of a washer program changed, e.g. by the user operating the washer locally.

Data type

Enumeration

Possible values

see Speed Spin enumeration

Example

GET /api/homeappliances/{haid}/events

Finish in Relative Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.StartInRelative

Description

This event notifies that the delayed start of a program has changed, e.g. by the user operating the home appliance locally.

Data type

Integer

Possible values

see Finish in Relative option

Example

GET /api/homeappliances/{haid}/events

Drying Target Change

Cooking
Cleaning
Cooling

Key

LaundryCare.Dryer.Option.DryingTarget

Description

This event notifies that the drying target of a dryer program changed, e.g. by the user operating the washer locally.

Data type

Enumeration

Possible values

see Drying Target enumeration

Example

GET /api/homeappliances/{haid}/events

Bean Amount Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Option.BeanAmount

Description

This event notifies that the bean amount of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.

Data type

Enumeration

Possible values

see Bean Amount enumeration

Example

GET /api/homeappliances/{haid}/events

Fill Quantity Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Option.FillQuantity

Description

This event notifies that the fill quantity of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.

Data type

Integer

Possible values

see Fill Quantity option

Example

GET /api/homeappliances/{haid}/events

Coffee Temperature Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature

Description

This event notifies that the coffee temperature of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.

Data type

Enumeration

Possible values

see Coffee Temperature enumeration

Example

GET /api/homeappliances/{haid}/events

Bean Container Selection Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Option.BeanContainerSelection

Description

This event notifies that the bean container selection of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.

Data type

Enumeration

Possible values

see Bean Container Selection enumeration

Example

GET /api/homeappliances/{haid}/events

Flow Rate Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Option.FlowRate

Description

This event notifies that the flow rate of a coffee machine program has changed, e.g. by the user operating the coffee machine locally.

Data type

Enumeration

Possible values

see Flow Rate enumeration

Example

GET /api/homeappliances/{haid}/events

Fan Setting Change

Cooking
Cleaning
Cooling

Key

Cooking.Common.Option.Hood.VentingLevel

Description

This event notifies that the fan setting of a hood program has changed, e.g. by the user operating the hood locally.

Data type

Enumeration

Possible values

see Fan Setting enumeration

Example

GET /api/homeappliances/{haid}/events

Intensive Setting Change

Cooking
Cleaning
Cooling

Key

Cooking.Common.Option.Hood.IntensiveLevel

Description

This event notifies that the intensive setting of a hood program has changed, e.g. by the user operating the hood locally.

Data type

Enumeration

Possible values

see Intensive Setting enumeration

Example

GET /api/homeappliances/{haid}/events

Reference Map ID Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Option.ReferenceMapId

Description

This event notifies that the reference map id of a cleaning robot program has changed.

Data type

Enumeration

Possible values

see Reference Map ID enumeration

Example

GET /api/homeappliances/{haid}/events

Cleaning Mode Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Option.CleaningMode

Description

This event notifies that the cleaning mode of a cleaning robot program has changed.

Data type

Enumeration

Possible values

see Cleaning Mode enumeration

Example

GET /api/homeappliances/{haid}/events

Program Progress Changes
Copied link to clipboard

Elapsed Program Time Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.ElapsedProgramTime

Description

This event notifies several times per minute during an active program about the elapsed time after the program has been started.

Data type

Integer

Possible values

0 to 86340 seconds

Example

GET /api/homeappliances/{haid}/events

Remaining Program Time Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.RemainingProgramTime

Description

This event notifies several times per minute during an active program about the remaining time until the program will finish.

Data type

Integer

Possible values

0 to 86340 seconds

Example

GET /api/homeappliances/{haid}/events

Program Progress Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Option.ProgramProgress

Description

This event notifies of any change of the program progress during an active program until the program will finish.

Data type

Integer

Possible values

0 to 100 %

Example

GET /api/homeappliances/{haid}/events

Process Phase Change

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Option.ProcessPhase

Description

This event notifies of any change of the process phase during an active program until the program will finish.

Data type

Enumeration

Possible values

  • Moving to destination
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.MovingToTarget
  • Cleaning
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.Cleaning
  • Searching for charging station
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.SearchingBaseStation
  • Moving to charging station
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.MovingToHome
  • Charging
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.ChargingBreak
  • Map confirmation
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.MapValidationByUser
  • Exploring
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.Exploring
  • Localizing
    Key: ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.Localizing

Example

GET /api/homeappliances/{haid}/events

Operation State Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Status.OperationState

Description

This event notifies that the operation state of the home appliance changed.

Data type

Enumeration

Possible values

see Operation State enumeration

Example

GET /api/homeappliances/{haid}/events

Program Progress Events
Copied link to clipboard

Program Aborted

Cooking
Cleaning
Cooling

Key

BSH.Common.Event.ProgramAborted

Description

This event is triggered by the home appliance each time when a program is successfully cancelled. Please note that this event is not supported by all programs.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Program Finished

Cooking
Cleaning
Cooling

Key

BSH.Common.Event.ProgramFinished

Description

This event is triggered by the home appliance each time when a program run is finished successfully.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Alarm Clock Elapsed

Cooking
Cleaning
Cooling

Key

BSH.Common.Event.AlarmClockElapsed

Description

This event is triggered when the alarm clock of the home appliance has elapsed.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Pre-heat Finished

Cooking
Cleaning
Cooling

Key

Cooking.Oven.Event.PreheatFinished

Description

This event is triggered when program option 'FastPreheat' is active and the preheating phase is finished.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Home Appliance State Changes
Copied link to clipboard

Power State Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Setting.PowerState

Description

This event notifies that the current power state of the home appliance has changed.

Data type

Enumeration

Possible values

see Power State enumeration

Example

GET /api/homeappliances/{haid}/events

Remote Control Activation Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Status.RemoteControlActive

Description

This event notifies that the allowance for remote controlling has changed. This can happen due to a programmatic change (only disabling), or manually by the user changing the flag locally on the home appliance.

Data type

Boolean

Possible values

  • true if remote control has been activated
  • false otherwise

Example

GET /api/homeappliances/{haid}/events

Remote Start Allowance Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Status.RemoteControlStartAllowed

Description

This event notifies that the allowance for the remote program start has changed. This can happen due to a programmatic change (only disabling), or manually by the user changing the flag locally on the home appliance, or automatic after a certain duration - usually 24 hours.

Data type

Boolean

Possible values

  • true if remote start has been activated
  • false otherwise

Example

GET /api/homeappliances/{haid}/events

Local Control Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Status.LocalControlActive

Description

This event notifies that the home appliance is manually controlled by the user operating the home appliance, e.g. opening the door or pressing a button. After a few seconds without user intervention this flag is reverted and an appropriate event is sent.

Data type

Boolean

Possible values

  • true if the home appliance has been operated locally
  • false otherwise

Example

GET /api/homeappliances/{haid}/events

Door State Change

Cooking
Cleaning
Cooling

Key

BSH.Common.Status.DoorState

Description

This event notifies that the state of the door of the home appliance has changed. This event is either triggered by the user operating the home appliance locally (i.e. opening/closing door) or automatically by the home appliance (i.e. locking the door).

Data type

Enumeration

Possible values

see DoorState enumeration

Example

GET /api/homeappliances/{haid}/events

Home Appliance Events
Copied link to clipboard

Bean Container Empty Event

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Event.BeanContainerEmpty

Description

This event is triggered by the home appliance each time when the bean container is empty.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Water Tank Empty Event

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Event.WaterTankEmpty

Description

This event is triggered by the home appliance each time when the water tank is empty.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Drip Tray Full Event

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CoffeeMaker.Event.DripTrayFull

Description

This event is triggered by the home appliance each time when the drip tray is full.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Door Alarm Freezer Event

Cooking
Cleaning
Cooling

Key

Refrigeration.FridgeFreezer.Event.DoorAlarmFreezer

Description

This event is triggered by the home appliance each time when the freezer door was left open too long.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Door Alarm Refrigerator Event

Cooking
Cleaning
Cooling

Key

Refrigeration.FridgeFreezer.Event.DoorAlarmRefrigerator

Description

This event is triggered by the home appliance each time when the refrigerator door was left open too long.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Temperature Alarm Freezer Event

Cooking
Cleaning
Cooling

Key

Refrigeration.FridgeFreezer.Event.TemperatureAlarmFreezer

Description

This event is triggered by the home appliance each time when the freezer temperature is too high.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Empty Dust Box And Clean Filter Event

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Event.EmptyDustBoxAndCleanFilter

Description

This event is triggered by the home appliance each time when the user has to empty the dust box and clean the filter.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Cleaning Robot Is Stuck Event

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Event.RobotIsStuck

Description

This event is triggered by the home appliance each time when it is stuck and isn't able to continue its run.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Docking Station Not Found Event

Cooking
Cleaning
Cooling

Key

ConsumerProducts.CleaningRobot.Event.DockingStationNotFound

Description

This event is triggered by the home appliance each time when it wasn't able to find the charging station.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haid}/events

Event Present State Enumeration
Copied link to clipboard

Cooking
Cleaning
Cooling

Possible values

  • Event is present
    Key: BSH.Common.EnumType.EventPresentState.Present
    Description: The event occurred and is present.
  • Event is off
    Key: BSH.Common.EnumType.EventPresentState.Off
    Description: The event is off.
  • Event confirmed
    Key: BSH.Common.EnumType.EventPresentState.Confirmed
    Description: The event has been confirmed by the user.

Availability