Key

BSH.Common.Status.RemoteControlActive

Description

This status indicates whether the allowance for remote controlling is enabled.

Data type

Boolean

Possible values

• true if remote control is activated
• false otherwise

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.RemoteControlActive

Expand source

{
    "data": {
        "key": "BSH.Common.Status.RemoteControlActive",
        "value": true
    }
}

Key

BSH.Common.Status.RemoteControlStartAllowed

Description

This status indicates whether the remote program start is enabled. This can happen due to a programmatic change (only disabling), or manually by the user changing the flag locally on the home appliance, or automatically after a certain duration - usually 24 hours.

Data type

Boolean

Possible values

• true if remote start is activated
• false otherwise

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.RemoteControlStartAllowed

Expand source

{
    "data": {
        "key": "BSH.Common.Status.RemoteControlStartAllowed",
        "value": true
    }
}

Key

BSH.Common.Status.LocalControlActive

Description

This status indicates whether the home appliance is currently manually controlled by the user operating the home appliance, e.g. opening the door or pressing a button. After a few seconds without user intervention this flag is reverted and an appropriate event is sent.

Data type

Boolean

Possible values

• true if the home appliance is currently operated locally
• false otherwise

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.LocalControlActive

Expand source

{
    "data": {
        "key": "BSH.Common.Status.LocalControlActive",
        "value": true
    }
}

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 inactive. It could be switched off or in standby.
• Ready
  Key: BSH.Common.EnumType.OperationState.Ready
  Description: Home appliance is switched on. No program is active.
• Delayed Start
  Key: BSH.Common.EnumType.OperationState.DelayedStart
  Description: A program has been activated but has not started yet.
• Run
  Key: BSH.Common.EnumType.OperationState.Run
  Description: A program is currently active.
• Pause
  Key: BSH.Common.EnumType.OperationState.Pause
  Description: The active program has been paused.
• Action required
  Key: BSH.Common.EnumType.OperationState.ActionRequired
  Description: The active program requires a user interaction.
• Finished
  Key: BSH.Common.EnumType.OperationState.Finished
  Description: The active 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 active program is currently aborting.

Availability

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.OperationState

Expand source

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

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

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.DoorState

Expand source

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

Key

Refrigeration.Common.Status.Door.BottleCooler

Description

This status describes the state of the door of the bottle cooler. A change of that status is triggered by the user operating the home appliance locally (i.e. opening/closing 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.

Availability

Example

GET /api/homeappliances/{haId}/status/Refrigeration.Common.Status.Door.BottleCooler

Expand source

{
    "data": {
        "key": "Refrigeration.Common.Status.Door.BottleCooler",
        "value": "BSH.Common.EnumType.DoorState.Open"
    }
}

Key

Refrigeration.Common.Status.Door.ChillerCommon

Refrigeration.Common.Status.Door.Chiller

Refrigeration.Common.Status.Door.ChillerLeft

Refrigeration.Common.Status.Door.ChillerRight

Description

This status describes the state of the door of the freshness compartment. A change of that status is triggered by the user operating the home appliance locally (i.e. opening/closing 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.

Availability

Example

GET /api/homeappliances/{haId}/status/Refrigeration.Common.Status.Door.ChillerCommon

Expand source

{
    "data": {
        "key": "Refrigeration.Common.Status.Door.ChillerCommon",
        "value": "BSH.Common.EnumType.DoorState.Open"
    }
}

Key

Refrigeration.Common.Status.Door.FlexCompartment

Description

This status describes the state of the door of the flex compartment. A change of that status is triggered by the user operating the home appliance locally (i.e. opening/closing 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.

Availability

Example

GET /api/homeappliances/{haId}/status/Refrigeration.Common.Status.Door.FlexCompartment

Expand source

{
    "data": {
        "key": "Refrigeration.Common.Status.Door.FlexCompartment",
        "value": "BSH.Common.EnumType.DoorState.Open"
    }
}

Key

Refrigeration.Common.Status.Door.Freezer

Description

This status describes the state of the door of the freezer compartment. A change of that status is triggered by the user operating the home appliance locally (i.e. opening/closing 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.

Availability

Example

GET /api/homeappliances/{haId}/status/Refrigeration.Common.Status.Door.Freezer

Expand source

{
    "data": {
        "key": "Refrigeration.Common.Status.Door.Freezer",
        "value": "BSH.Common.EnumType.DoorState.Open"
    }
}

Key

Refrigeration.Common.Status.Door.Refrigerator

Refrigeration.Common.Status.Door.Refrigerator2

Refrigeration.Common.Status.Door.Refrigerator3

Description

This status describes the state of the door of the refrigerator compartment. A change of that status is triggered by the user operating the home appliance locally (i.e. opening/closing 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.

Availability

Example

GET /api/homeappliances/{haId}/status/Refrigeration.Common.Status.Door.Refrigerator

Expand source

{
    "data": {
        "key": "Refrigeration.Common.Status.Door.Refrigerator",
        "value": "BSH.Common.EnumType.DoorState.Open"
    }
}

Key

Refrigeration.Common.Status.Door.WineCompartment

Description

This status describes the state of the door of the wine compartment. A change of that status is triggered by the user operating the home appliance locally (i.e. opening/closing 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.

Availability

Example

GET /api/homeappliances/{haId}/status/Refrigeration.Common.Status.Door.WineCompartment

Expand source

{
    "data": {
        "key": "Refrigeration.Common.Status.Door.WineCompartment",
        "value": "BSH.Common.EnumType.DoorState.Open"
    }
}

Key

ConsumerProducts.CoffeeMaker.Status.BeverageCounterCoffee ConsumerProducts.CoffeeMaker.Status.BeverageCounterPowderCoffee ConsumerProducts.CoffeeMaker.Status.BeverageCounterHotWater ConsumerProducts.CoffeeMaker.Status.BeverageCounterHotWaterCups ConsumerProducts.CoffeeMaker.Status.BeverageCounterHotMilk ConsumerProducts.CoffeeMaker.Status.BeverageCounterFrothyMilk ConsumerProducts.CoffeeMaker.Status.BeverageCounterMilk ConsumerProducts.CoffeeMaker.Status.BeverageCounterCoffeeAndMilk ConsumerProducts.CoffeeMaker.Status.BeverageCounterRistrettoEspresso

Description

Each status describes the number of prepared cups. One exeception is BeverageCounterHotWater which describes the quantity of heated water in ml. Please note that not each status is supported by all coffee machines.

Data type

Integer

Example

GET /api/homeappliances/{haId}/status/ConsumerProducts.CoffeeMaker.Status.BeverageCounterCoffee

Expand source

{
    "data": {
        "key": "ConsumerProducts.CoffeeMaker.Status.BeverageCounterCoffee",
        "value": 35
    }
}

GET /api/homeappliances/{haId}/status/ConsumerProducts.CoffeeMaker.Status.BeverageCounterHotWater

Expand source

{
    "data": {
        "key": "ConsumerProducts.CoffeeMaker.Status.BeverageCounterHotWater",
        "value": 717,
        "unit": "ml"
    }
}

Key

BSH.Common.Status.BatteryLevel

Description

This status describes the level of the battery.

Data type

Float

Possible values

0 - 100 %

Example

GET /api/homeappliances/{haId}/settings/BSH.Common.Status.BatteryLevel

Expand source

{
    "data": {
        "key": "BSH.Common.Status.BatteryLevel",
        "value": 67,
        "unit": "%"
    }
}

Key

BSH.Common.Status.BatteryChargingState

Description

This status describes the charging state of the home appliance.

Data type

Enumeration

Possible values

• Discharging
  Key: BSH.Common.EnumType.BatteryChargingState.Discharging
• Charging
  Key: BSH.Common.EnumType.BatteryChargingState.Charging

Availability

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.BatteryChargingState

Expand source

{
    "data": {
        "key": "BSH.Common.Status.BatteryChargingState",
        "value": "BSH.Common.EnumType.BatteryChargingState.Charging"
    }
}

Key

BSH.Common.Status.ChargingConnection

Description

This status describes the charging connection of the home appliance.

Data type

Enumeration

Possible values

• Disconnected
  Key: BSH.Common.EnumType.ChargingConnection.Disconnected
  Description: Appliance is not connected to docking station.
• Connected
  Key: BSH.Common.EnumType.ChargingConnection.Connected
  Description: Appliance is connected to docking station.

Availability

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.ChargingConnection

Expand source

{
    "data": {
        "key": "BSH.Common.Status.ChargingConnection",
        "value": "BSH.Common.EnumType.ChargingConnection.Connected"
    }
}

Key

BSH.Common.Status.Video.CameraState

Description

This status describes the camera state of the home appliance. Please note that this status is only returned by home appliances which are equipped with a streaming camera.

Data type

Enumeration

Possible values

• Disabled
  Key: BSH.Common.EnumType.Video.CameraState.Disabled
• Sleeping
  Key: BSH.Common.EnumType.Video.CameraState.Sleeping
• Ready
  Key: BSH.Common.EnumType.Video.CameraState.Ready
• StreamingLocal
  Key: BSH.Common.EnumType.Video.CameraState.StreamingLocal
• StreamingCloud
  Key: BSH.Common.EnumType.Video.CameraState.StreamingCloud
• StreamingLocalAndCloud
  Key: BSH.Common.EnumType.Video.CameraState.StreamingLocalAndCloud
• Error
  Key: BSH.Common.EnumType.Video.CameraState.Error

Availability

Example

GET /api/homeappliances/{haId}/status/BSH.Common.Status.Video.CameraState

Expand source

{
    "data": {
        "key": "BSH.Common.Status.Video.CameraState",
        "value": "BSH.Common.EnumType.Video.CameraState.StreamingCloud"
    }
}

Key

ConsumerProducts.CleaningRobot.Status.LastSelectedMap

Description

This status describes the last selected map of the cleaning robot.

Data type

Enumeration

Possible values

• Temporary map
  Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.TempMap
• User-defined map 1
  Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1
• User-defined map 2
  Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2
• User-defined map 3
  Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map3

Availability

Example

GET /api/homeappliances/{haId}/status/ConsumerProducts.CleaningRobot.Status.LastSelectedMap

Expand source

{
    "data": {
        "key": "ConsumerProducts.CleaningRobot.Status.LastSelectedMap",
        "value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2"
    }
}

Key

ConsumerProducts.CleaningRobot.Status.DustBoxInserted

Description

This status describes if the dust box is inserted.

Data type

Boolean

Possible values

• true if the dust box is inserted
• false otherwise

Example

GET /api/homeappliances/{haId}/settings/ConsumerProducts.CleaningRobot.Status.DustBoxInserted

Expand source

{
    "data": {
        "key": "ConsumerProducts.CleaningRobot.Status.DustBoxInserted",
        "value": true
    }
}

Key

ConsumerProducts.CleaningRobot.Status.Lost

Description

This status describes if the cleaning robot is lost.

Data type

Boolean

Possible values

• true if the cleaning robot is lost
• false otherwise

Example

GET /api/homeappliances/{haId}/settings/ConsumerProducts.CleaningRobot.Status.Lost

Expand source

{
    "data": {
        "key": "ConsumerProducts.CleaningRobot.Status.Lost",
        "value": false
    }
}

Key

ConsumerProducts.CleaningRobot.Status.Lifted

Description

This status describes if the cleaning robot is lifted.

Data type

Boolean

Possible values

• true if the cleaning robot is lifted
• false otherwise

Example

GET /api/homeappliances/{haId}/settings/ConsumerProducts.CleaningRobot.Status.Lifted

Expand source

{
    "data": {
        "key": "ConsumerProducts.CleaningRobot.Status.Lifted",
        "value": false
    }
}