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

Expand source

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

Selected Program Change

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

Expand source

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

Active Program Change

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

Expand source

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

Start in Relative Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.StartInRelative", "timestamp":1479477686, "level":"hint", "handling":"none", "value":60, "unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Finish in Relative Change

Key

BSH.Common.Option.FinishInRelative

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

Expand source

event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.FinishInRelative", "timestamp":1479477686, "level":"hint", "handling":"none", "value":2400, "unit":"seconds"}]}
id: BOSCH-HCS04DYR1-7F930F92AD1403

Program Duration Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.Duration","timestamp":1479477686,"level":"hint","handling":"none","value":1260,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Oven Setpoint Temperature Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.SetpointTemperature", "timestamp":1479477178, "level":"hint", "handling":"none", "value":240, "unit":"°C"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Fast Pre-heat Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.FastPreHeat", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Warming Level Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"Cooking.Oven.Option.WarmingLevel", "timestamp":1479477178, "level":"hint", "handling":"none", "value":"Cooking.Oven.EnumType.WarmingLevel.Medium"}]}
id: BOSCH-HCS08WRM1-7F930F92AD1403

Intensive Zone Change

Key

Dishcare.Dishwasher.Option.IntensivZone

Description

This event notifies that the intensive zone option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.IntensivZone", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Brilliance Dry Change

Key

Dishcare.Dishwasher.Option.BrillianceDry

Description

This event notifies that the brilliance dry option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.BrillianceDry", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

VarioSpeed Plus Change

Key

Dishcare.Dishwasher.Option.VarioSpeedPlus

Description

This event notifies that the VarioSpeed Plus option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.VarioSpeedPlus", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Silence on Demand Change

Key

Dishcare.Dishwasher.Option.SilenceOnDemand

Description

This event notifies that the silence on demand option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.SilenceOnDemand", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Half Load Change

Key

Dishcare.Dishwasher.Option.HalfLoad

Description

This event notifies that the half load option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.HalfLoad", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Extra Dry Change

Key

Dishcare.Dishwasher.Option.ExtraDry

Description

This event notifies that the extra dry option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.ExtraDry", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Hygiene Plus Change

Key

Dishcare.Dishwasher.Option.HygienePlus

Description

This event notifies that the Hygiene Plus option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.HygienePlus", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Eco Dry Change

Key

Dishcare.Dishwasher.Option.EcoDry

Description

This event notifies that the Eco Dry option of a dishwasher program has changed, e.g. by the user operating the dishwasher locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"Dishcare.Dishwasher.Option.EcoDry", "timestamp":1479477178, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Washer Temperature Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.Temperature", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Washer.EnumType.Temperature.GC30"}]}
id: BOSCH-HCS03WCH1-7F930F92AD1403

Spin Speed Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.SpinSpeed", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Washer.EnumType.SpinSpeed.RPM800"}]}
id: BOSCH-HCS03WCH1-7F930F92AD1403

i-Dos Content 1 Active Change

Key

LaundryCare.Washer.Option.IDos1Active

Description

This event notifies that the i-Dos content 1 active of a washer program changed, e.g. by the user operating the washer locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.IDos1Active", "timestamp":1479477686, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS03WCH1-7F930F92AD1403

i-Dos Content 2 Active Change

Key

LaundryCare.Washer.Option.IDos2Active

Description

This event notifies that the i-Dos content 2 active of a washer program changed, e.g. by the user operating the washer locally.

Data type

Boolean

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"LaundryCare.Washer.Option.IDos2Active", "timestamp":1479477686, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS03WCH1-7F930F92AD1403

Drying Target Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"LaundryCare.Dryer.Option.DryingTarget", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"LaundryCare.Dryer.EnumType.DryingTarget.CupboardDry"}]}
id: BOSCH-HCS04DYR1-7F930F92AD1403

Bean Amount Change

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

Expand source

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

Fill Quantity Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.FillQuantity", "timestamp":1479477686, "level":"hint", "handling":"none", "value":50, "unit":"ml"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A

Coffee Temperature Change

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

Expand source

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

Bean Container Selection Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.BeanContainerSelection", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.BeanContainerSelection.Right"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A

Flow Rate Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.FlowRate", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.FlowRate.Intense"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A

Multiple Beverages Change

Key

ConsumerProducts.CoffeeMaker.Option.MultipleBeverages

Description

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

Data type

Enumeration

Possible values

• true if enabled
• false otherwise

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.MultipleBeverages", "timestamp":1479477686, "level":"hint", "handling":"none", "value":true}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A

Hot Water Temperature Rate Change

Key

ConsumerProducts.CoffeeMaker.Option.HotWaterTemperature

Description

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

Data type

Enumeration

Possible values

see Hot Water Temperature enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: NOTIFY
data: {"items":[{"key":"ConsumerProducts.CoffeeMaker.Option.HotWaterTemperature", "timestamp":1479477686, "level":"hint", "handling":"none", "value":"ConsumerProducts.CoffeeMaker.EnumType.HotWaterTemperature.90C"}]}
id: BOSCH-HCS06COM1-F8C8A682108B2A

Fan Setting Change

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

Expand source

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

Intensive Setting Change

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

Expand source

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

Reference Map ID Change

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

Expand source

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

Cleaning Mode Change

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

Expand source

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

Elapsed Program Time Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.ElapsedProgramTime","timestamp":1479994067,"level":"hint","handling":"none","value":21,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Remaining Program Time Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.RemainingProgramTime","timestamp":1479994067,"level":"hint","handling":"none","value":39,"unit":"seconds"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Program Progress Change

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

Expand source

event: NOTIFY
data: {"items":[{"key":"BSH.Common.Option.ProgramProgress","timestamp":1479994067,"level":"hint","handling":"none","value":35,"unit":"%"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Process Phase Change

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

Expand source

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

Operation State Change

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

Expand source

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

Program Aborted

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

Expand source

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

Program Finished

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

Expand source

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

Alarm Clock Elapsed

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

Expand source

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

Pre-heat Finished

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

Expand source

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

Regular Pre-heat Finished

Key

Cooking.Oven.Event.RegularPreheatFinished

Description

This event is triggered when program option FastPreheat is not active and the preheating phase is finished. Please note that the option is not supported by all ovens.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: EVENT
data: {"items":[{"key":"Cooking.Oven.Event.RegularPreheatFinished","timestamp":1479994087,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Power State Change

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

Expand source

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

Remote Control Activation Change

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

Expand source

event: STATUS
data: {"items":[{"key":"BSH.Common.Status.RemoteControlActive","timestamp":1479996081,"level":"hint","handling":"none","value":true}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Remote Start Allowance Change

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

Expand source

event: STATUS
data: {"items":[{"key":"BSH.Common.Status.RemoteControlStartAllowed","timestamp":1479996083,"level":"hint","handling":"none","value":true}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Local Control Change

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

Expand source

event: STATUS
data: {"items":[{"key":"BSH.Common.Status.LocalControlActive","timestamp":1479996096,"level":"hint","handling":"none","value":false}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Door State Change

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 Door State enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

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

Door State Bottle Cooler Change

Key

Refrigeration.Common.Status.Door.BottleCooler

Description

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

Data type

Enumeration

Possible values

see Door State Bottle Cooler enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: STATUS
data: {"items":[{"key":"Refrigeration.Common.Status.Door.BottleCooler","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Door State Chiller Change

Key

Refrigeration.Common.Status.Door.ChillerCommon Refrigeration.Common.Status.Door.Chiller Refrigeration.Common.Status.Door.ChillerLeft Refrigeration.Common.Status.Door.ChillerRight

Description

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

Data type

Enumeration

Possible values

see Door State Refrigerator enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: STATUS
data: {"items":[{"key":"Refrigeration.Common.Status.Door.ChillerCommon","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Door State Flex Compartment Change

Key

Refrigeration.Common.Status.Door.FlexCompartment

Description

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

Data type

Enumeration

Possible values

see Door State Flex Compartment enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: STATUS
data: {"items":[{"key":"Refrigeration.Common.Status.Door.FlexCompartment","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Door State Freezer Change

Key

Refrigeration.Common.Status.Door.Freezer

Description

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

Data type

Enumeration

Possible values

see Door State Freezer enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: STATUS
data: {"items":[{"key":"Refrigeration.Common.Status.Door.Freezer","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Door State Refrigerator Change

Key

Refrigeration.Common.Status.Door.Refrigerator Refrigeration.Common.Status.Door.Refrigerator2 Refrigeration.Common.Status.Door.Refrigerator3

Description

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

Data type

Enumeration

Possible values

see Door State Refrigerator enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: STATUS
data: {"items":[{"key":"Refrigeration.Common.Status.Door.Refrigerator","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Door State Wine Compartment Change

Key

Refrigeration.Common.Status.Door.WineCompartment

Description

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

Data type

Enumeration

Possible values

see Door State Wine Compartment enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: STATUS
data: {"items":[{"key":"Refrigeration.Common.Status.Door.WineCompartment","timestamp":1479996077,"level":"hint","handling":"none","value":"BSH.Common.EnumType.DoorState.Open"}]}
id: BOSCH-HCS01OVN1-7F930F92AD1403

Salt Nearly Empty Event

Key

Dishcare.Dishwasher.Event.SaltNearlyEmpty

Description

This event is triggered by the home appliance each time when the salt supply is running low.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: EVENT
data: {"items":[{"key":"Dishcare.Dishwasher.Event.SaltNearlyEmpty","timestamp":1479994113,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Rinse Aid Nearly Empty Event

Key

Dishcare.Dishwasher.Event.RinseAidNearlyEmpty

Description

This event is triggered by the home appliance each time when the rinse aid supply is running low.

Data type

Enumeration

Possible values

see EventPresentState enumeration

Example

GET /api/homeappliances/{haId}/events

Expand source

event: EVENT
data: {"items":[{"key":"Dishcare.Dishwasher.Event.RinseAidNearlyEmpty","timestamp":1479994113,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Present"}]}
id: BOSCH-HCS02DWH1-7F930F92AD1403

Bean Container Empty Event

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

Expand source

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

Water Tank Empty Event

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

Expand source

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

Drip Tray Full Event

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

Expand source

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

Door Alarm Freezer Event

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

Expand source

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

Door Alarm Refrigerator Event

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

Expand source

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

Temperature Alarm Freezer Event

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

Expand source

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

Empty Dust Box And Clean Filter Event