Door State

               

 

Key

BSH.Common.Status.DoorState

Description

This status describes the state of the door of the home appliance. A change of that status 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

  • Door open
    Key: BSH.Common.EnumType.DoorState.Open
    Description: The door of the home appliance is open.
  • Door closed
    Key: BSH.Common.EnumType.DoorState.Closed
    Description: The door of the home appliance is closed but not locked.
  • Door locked
    Key: BSH.Common.EnumType.DoorState.Locked
    Description: The door of the home appliance is locked.

Availability

                 
Open      
Closed      
Locked            

Example

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


{
    "data": {
        "key": "BSH.Common.Status.DoorState",
        "value": "BSH.Common.EnumType.DoorState.Locked"
    }
}