Operation State

               

 

Key

BSH.Common.Status.OperationState

Description

This status describes the operation state of the home appliance.

Data type

Enumeration

Possible values

  • Inactive
    Key: BSH.Common.EnumType.OperationState.Inactive
    Description: Home appliance is switched off or in standby.
  • Ready
    Key: BSH.Common.EnumType.OperationState.Ready
    Description: Home appliance is switched on. No program has been activated.
  • Delayed Start
    Key: BSH.Common.EnumType.OperationState.DelayedStart
    Description: A program has been activated but has not been started yet if a delayed start has been configured.
  • Run
    Key: BSH.Common.EnumType.OperationState.Run
    Description: A program is currently activated and runs.
  • Pause
    Key: BSH.Common.EnumType.OperationState.Pause
    Description: An activated program has been paused.
  • Action required
    Key: BSH.Common.EnumType.OperationState.ActionRequired
    Description: The activated program requires a user interaction.
  • Finished
    Key: BSH.Common.EnumType.OperationState.Finished
    Description: The activated program has finished or has been aborted successfully.
  • Error
    Key: BSH.Common.EnumType.OperationState.Error
    Description: The home appliance is in an error state.
  • Aborting
    Key: BSH.Common.EnumType.OperationState.Aborting
    Description: The activated program is currently aborting.

Availability

                 
Inactive      
Ready    
Delayed Start        
Run  
Pause        
Action Required      
Finished    
Error      
Aborting        

Example

GET <api_url>/api/homeappliances/<haid>/status/BSH.Common.Status.OperationState


{
    "data": {
        "key": "BSH.Common.Status.OperationState",
        "value": "BSH.Common.EnumType.OperationState.Inactive"
    }
}