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

Example

GET /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 to 86340 seconds

Example

GET /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 to 100 %

Example

GET /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

 

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


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

Operation State enumeration

Example

GET /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