This page does NOT support Internet Explorer. Please use a modern browser like e.g. Google Chrome, Mozilla Firefox or Microsoft Edge.
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.
The following table lists all feature-based events.
Example
GET /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Root.SelectedProgram", "timestamp":1479476432, "level":"hint", "handling":"none", "value":"Cooking.Oven.Program.HeatingMode.TopBottomHeating"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 See Cleaning Robot, Coffee Machine, Cooktop, Cook Processor, Dishwasher, Dryer, Oven, Warming Drawer, Washer, Washer Dryer
Example
GET /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Root.SelectedProgram", "timestamp":1479476432, "level":"hint", "handling":"none", "value":"Cooking.Oven.Program.HeatingMode.TopBottomHeating"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Root.ActiveProgram", "timestamp":1479476432, "level":"hint", "handling":"none", "value":"Cooking.Oven.Program.HeatingMode.TopBottomHeating"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.SetpointTemperature", "timestamp":1479477178, "level":"hint", "handling":"none", "value":240, "unit":"°C"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.Duration","timestamp":1479477686,"level":"hint","handling":"none","value":1260,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.FastPreHeat", "timestamp":1479477178, "level":"hint", "handling":"none", "value":false}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.StartInRelative", "timestamp":1479477686, "level":"hint", "handling":"none", "value":60, "unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.Temperature", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Washer.EnumType.Temperature.GC30"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.SpinSpeed", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Washer.EnumType.SpinSpeed.RPM800"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"LaundryCare.Dryer.Option.DryingTarget", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.BeanAmount", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.VeryStrong"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.FillQuantity", "timestamp":1479477686, "level":"hint", "handling":"none", "value":50, "unit":"ml"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
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 /
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.CoffeeTemperature.96C"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"Cooking.Common.Option.Hood.VentingLevel", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"Cooking.Hood.EnumType.Stage.FanStage01"}]}
id: BOSCH-HCS08HOD1-F8C8A6821081GB
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 /
event: NOTIFY
data: {"items":[{"key":"Cooking.Common.Option.Hood.IntensiveLevel", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"Cooking.Hood.EnumType.IntensiveStage.IntensiveStage1"}]}
id: BOSCH-HCS08HOD1-F8C8A6821081GB
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 /
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Option.CleaningMode", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CleaningRobot.EnumType.CleaningModes.Silent"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
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 /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.ElapsedProgramTime","timestamp":1479994067,"level":"hint","handling":"none","value":21,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.RemainingProgramTime","timestamp":1479994067,"level":"hint","handling":"none","value":39,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.ProgramProgress","timestamp":1479994067,"level":"hint","handling":"none","value":35,"unit":"%"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Option.ProcessPhase","timestamp":1479994067,"level":"hint","handling":"none","value":"ConsumerProducts.CleaningRobot.EnumType.ProcessPhase.Cleaning"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
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 /
event: STATUS
data: {"items":[{"key":"BSH.Common.Status.OperationState","timestamp":1479994046,"level":"hint","handling":"none","value":"BSH.Common.EnumType.OperationState.Run"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: EVENT
data: {"items":[{"key":"BSH.Common.Event.ProgramAborted","timestamp":1479994113,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: EVENT
data: {"items":[{"key":"BSH.Common.Event.ProgramFinished","timestamp":1479994109,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: EVENT
data: {"items":[{"key":"BSH.Common.Event.AlarmClockElapsed","timestamp":1479994107,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: EVENT
data: {"items":[{"key":"Cooking.Oven.Event.PreheatFinished","timestamp":1479994087,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: NOTIFY
data: {"items":[{"key":"BSH.Common.Setting.PowerState","timestamp":1479996080,"level":"hint","handling":"none","value":"BSH.Common.EnumType.PowerState.On"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: STATUS
data: {"items":[{"key":"BSH.Common.Status.RemoteControlActive","timestamp":1479996081,"level":"hint","handling":"none","value":true}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: STATUS
data: {"items":[{"key":"BSH.Common.Status.RemoteControlStartAllowed","timestamp":1479996083,"level":"hint","handling":"none","value":true}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: STATUS
data: {"items":[{"key":"BSH.Common.Status.LocalControlActive","timestamp":1479996096,"level":"hint","handling":"none","value":false}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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
Example
GET /
event: STATUS
data: {"items":[{"key":"BSH.Common.Status.DoorState","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403
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 /
event: EVENT
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Event.BeanContainerEmpty","timestamp":1479994113,"level":"warning","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
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 /
event: EVENT
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Event.WaterTankEmpty","timestamp":1479994113,"level":"warning","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
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 /
event: EVENT
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Event.DripTrayFull","timestamp":1479994113,"level":"warning","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A
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 /
event: EVENT
data: {"items":[{"key":"Refrigeration.FridgeFreezer.Event.DoorAlarmFreezer","timestamp":1479994113,"level":"alert","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: SIEMENS-HCS05FRF1-RGC84HF40PZ157
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 /
event: EVENT
data: {"items":[{"key":"Refrigeration.FridgeFreezer.Event.DoorAlarmRefrigerator","timestamp":1479994113,"level":"alert","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: SIEMENS-HCS05FRF1-RGC84HF40PZ157
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 /
event: EVENT
data: {"items":[{"key":"Refrigeration.FridgeFreezer.Event.TemperatureAlarmFreezer","timestamp":1479994113,"level":"alert","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: SIEMENS-HCS05FRF1-RGC84HF40PZ157
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 /
event: EVENT
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Event.EmptyDustBoxAndCleanFilter","timestamp":1479994113,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
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 /
event: EVENT
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Event.RobotIsStuck","timestamp":1479994113,"level":"alert","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
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 /
event: EVENT
data: {"items":[{"key":"ConsumerProducts.CleaningRobot.Event.DockingStationNotFound","timestamp":1479994113,"level":"warning","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS09CLR1-7F930F92ADWW03
Possible values
Availability