Program Progress Changes

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 - 86340 seconds

Example

GET <api_url>/api/homeappliances/<haid>/events


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 - 86340 seconds

Example

GET <api_url>/api/homeappliances/<haid>/events


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 - 100 %

Example

GET <api_url>/api/homeappliances/<haid>/events


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

 

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

Operation State enum

Example

GET <api_url>/api/homeappliances/<haid>/events


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.

Data type

Enumeration

Possible values

EventPresentState enum

Example

GET <api_url>/api/homeappliances/<haid>/events


event: EVENT
data: {"items":[{"key":"BSH.Common.Event.ProgramAborted","timestamp":1479994113,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Confirmed"}]}
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

EventPresentState enum

Example

GET <api_url>/api/homeappliances/<haid>/events


event: EVENT
data: {"items":[{"key":"BSH.Common.Event.ProgramFinished","timestamp":1479994109,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Confirmed"}]}
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

EventPresentState enum

Example

GET <api_url>/api/homeappliances/<haid>/events


event: EVENT
data: {"items":[{"key":"BSH.Common.Event.AlarmClockElapsed","timestamp":1479994107,"level":"hint","handling":"none","value":"BSH.Common.EnumType.EventPresentState.Confirmed"}]}
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

EventPresentState enum

Example

GET <api_url>/api/homeappliances/<haid>/events


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