Home Connect Developer Program

This page does NOT support Internet Explorer. Please use a modern browser like e.g. Google Chrome, Mozilla Firefox or Microsoft Edge.

States

Remote Control Activation State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Remote Start Allowance State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Local Control State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Operation State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Door State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Battery Level
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Battery Charging State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Charging Connection
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Camera State
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Last Selected Map
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Dust Box Inserted
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Lost
Copied link to clipboard

Cooking
Cleaning
Cooling

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

Lifted
Copied link to clipboard

Cooking
Cleaning
Cooling

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