Availability Matrix of Events

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.

Type Data present Comment
KEEP-ALIVE   Periodic keep-alive message (interval: every 55 seconds)
STATUS X Status changes (e.g. 'DoorState')
EVENT X Event (e.g. 'Preheat finished')
NOTIFY X Value changes
DISCONNECTED   Connection to home appliance lost or not possible
CONNECTED   Connection to home appliance re-established
PAIRED   New home appliance was added to HC account, this appliance can be directly monitored with an open event stream
DEPAIRED   Existing home appliance was removed, monitoring of this appliance is no longer possible

 

Events

The following table lists all feature-based events.

Feature Key Event Type                    
BSH.Common.Root.SelectedProgram NOTIFY    
BSH.Common.Root.ActiveProgram NOTIFY  
Cooking.Oven.Option.SetpointTemperature NOTIFY                  
BSH.Common.Option.Duration NOTIFY                
Cooking.Oven.Option.FastPreHeat NOTIFY                
BSH.Common.Option.StartInRelative NOTIFY                
LaundryCare.Washer.Option.Temperature NOTIFY                
LaundryCare.Washer.Option.SpinSpeed NOTIFY                
LaundryCare.Dryer.Option.DryingTarget NOTIFY                
ConsumerProducts.CoffeeMaker.Option.BeanAmount NOTIFY                  
ConsumerProducts.CoffeeMaker.Option.FillQuantity NOTIFY                  
ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature NOTIFY                  
Cooking.Common.Option.Hood.VentingLevel NOTIFY                  
Cooking.Common.Option.Hood.IntensiveLevel NOTIFY                  
ConsumerProducts.CleaningRobot.Option.ReferenceMapId NOTIFY                  
ConsumerProducts.CleaningRobot.Option.CleaningMode NOTIFY                  
BSH.Common.Option.ElapsedProgramTime NOTIFY              
BSH.Common.Option.RemainingProgramTime NOTIFY      
BSH.Common.Option.ProgramProgress NOTIFY      
ConsumerProducts.CleaningRobot.Option.ProcessPhase NOTIFY                  
BSH.Common.Setting.PowerState NOTIFY
Refrigeration.FridgeFreezer.Setting.SetpointTemperatureFreezer NOTIFY                  
Refrigeration.FridgeFreezer.Setting.SetpointTemperatureRefrigerator NOTIFY                  
Refrigeration.FridgeFreezer.Setting.SuperModeFreezer NOTIFY                  
Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator NOTIFY                  
ConsumerProducts.CleaningRobot.Setting.CurrentMap NOTIFY                  
ConsumerProducts.CleaningRobot.Setting.NameOfMap1 NOTIFY                  
ConsumerProducts.CleaningRobot.Setting.NameOfMap2 NOTIFY                  
ConsumerProducts.CleaningRobot.Setting.NameOfMap3 NOTIFY                  
ConsumerProducts.CleaningRobot.Setting.NameOfMap4 NOTIFY                  
ConsumerProducts.CleaningRobot.Setting.NameOfMap5 NOTIFY                  
BSH.Common.Status.RemoteControlActive STATUS      
BSH.Common.Status.RemoteControlStartAllowed STATUS      
BSH.Common.Status.LocalControlActive STATUS      
BSH.Common.Status.OperationState STATUS  
BSH.Common.Status.DoorState STATUS        
BSH.Common.Status.BatteryLevel STATUS                  
BSH.Common.Status.BatteryChargingState STATUS                  
BSH.Common.Status.ChargingConnection STATUS                  
BSH.Common.Status.Video.CameraState STATUS                  
ConsumerProducts.CleaningRobot.Status.LastSelectedMap STATUS                  
ConsumerProducts.CleaningRobot.Status.DustBoxInserted STATUS                  
ConsumerProducts.CleaningRobot.Status.Lost STATUS                  
ConsumerProducts.CleaningRobot.Status.Lifted STATUS                  
BSH.Common.Event.ProgramAborted EVENT                
BSH.Common.Event.ProgramFinished EVENT    
BSH.Common.Event.AlarmClockElapsed EVENT                
Cooking.Oven.Event.PreheatFinished EVENT                
ConsumerProducts.CoffeeMaker.Event.BeanContainerEmpty EVENT                  
ConsumerProducts.CoffeeMaker.Event.WaterTankEmpty EVENT                  
ConsumerProducts.CoffeeMaker.Event.DripTrayFull EVENT                  
Refrigeration.FridgeFreezer.Event.DoorAlarmFreezer EVENT                  
Refrigeration.FridgeFreezer.Event.DoorAlarmRefrigerator EVENT                  
Refrigeration.FridgeFreezer.Event.TemperatureAlarmFreezer EVENT                  
ConsumerProducts.CleaningRobot.Event.EmptyDustBoxAndCleanFilter EVENT                  
ConsumerProducts.CleaningRobot.Event.RobotIsStuck EVENT                  
ConsumerProducts.CleaningRobot.Event.DockingStationNotFound EVENT                  

 

Example

GET /api/homeappliances/{haid}/events


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