Previous Topic

Next Topic

Book Contents

Book Index
Home Connect Device Items Mapping

The Home Connect Protocol Adapter provides support for the following Home Connect appliance types:

For each supported appliance type the protocol adapter implements the generic and base device item interface for white goods appliances com.prosyst.mbs.services.da.items.whitegoods.Appliance.

The appliance functionalities/features are represented by the Home Connect REST API which defines a set of components and characteristics.

Home Connect Appliance Programs

For each household appliance that supports the functionality to be programmed, the Home Connect Protocol Adapter implements the Device Item com.prosyst.mbs.services.da.items.whitegoods.ProgramSelector.

The interface provides operation for control, monitoring, accessing the current and target selected program, and listing the available programs.

All supported Home Connect appliance programs in Device Access are represented as instances of the Functional Item bean com.prosyst.mbs.services.da.items.whitegoods.Program. The Program ID is matched by the unique Home Connect Program Key Identifier. For example, ConsumerProducts.CleaningRobot.Program.Cleaning.CleanAll program of the Cleaning Robot appliance type. The program parameters are represented as the Home Connect program options.

Home Connect Options

Option Key

Option Type

Device Item

Device Item Attributes & Additional Details

StartInRelative

Common

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=BSH.Common.Option.StartInRelative
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_DELAYED_START
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Time

Duration

Common

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=BSH.Common.Option.Duration
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_DURATION
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Time

ReferenceMapId

Cleaning Robot

com.prosyst.mbs.services.homeconnect.da.items.MapControl

Additional Notes & Details

Defined as a Functional Item property in the device item interface.

CleaningMode

Cleaning Robot

com.prosyst.mbs.services.homeconnect.da.items.CleaningModeControl

Attributes

  • homeconnect.feature=ConsumerProducts.CleaningRobot.Option.CleaningMode

Additional notes & details

The possible values are listed in the enum Functional Item bean com.prosyst.mbs.services.homeconnect.da.items.CleaningMode

BeanAmount

Coffee Maker

com.prosyst.mbs.services.homeconnect.da.items.BeanAmountControl

Attributes

  • homeconnect.feature=ConsumerProducts.CoffeeMaker.Option.BeanAmount

 

Additional notes & details

The possible values are listed in the enum Functional Item bean com.prosyst.mbs.services.homeconnect.da.items.BeanAmount

FillQuanity

Coffee Maker

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=ConsumerProducts.CoffeeMaker.Option.FillQuantity
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_FILL_LEVEL
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Volume

CoffeeTemperature

Coffee Maker

com.prosyst.mbs.service.homeconnect.da.items.CoffeeTemperatureControl

Attributes

  • homeconnect.feature=ConsumerProducts.CoffeeMaker.Option.CoffeeTemperature

 

Additional notes & details

The possible values are listed in the enum Functional Item bean com.prosyst.mbs.services.homeconnect.da.items.CoffeeTemperature

DryingTarget

Dryer

com.prosyst.mbs.services.homeconnect.da.items.DryingTargetControl

Attributes

  • homeconnect.feature=LaundryCare.Dryer.Option.DryingTarget

 

Additional notes & details

The possible values are listed in the enum Functional Item bean com.prosyst.mbs.services.homeconnect.da.items.DryingTarget

SetpointTemperature

Oven

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=Cooking.Oven.Option.SetpointTemperature
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_HEATING
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Temperature

FastPreHeat

Oven

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=Cooking.Oven.Option.FastPreHeat
  • DetectorAttributes.ATTRIBUTE_DETECTS=Cooking.Oven.Option.FastPreHeat

Temperature

Washer

com.prosyst.mbs.services.da.items.Setpoint

Attributes

 

  • homeconnect.feature=LaundryCare.Washer.Option.Temperature
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_HEATING
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Temperature

SpinSpeed

Washer

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=LaundryCare.Washer.Option.SpinSpeed
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.SPIN_SPEED
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.AngularVelocity

Home Connect Settings

Setting

Device Item/Item Bean

Device Item Attributes & Additional Details

Power State

com.prosyst.mbs.services.da.items.whitegoods.ApplianceState

Additional notes & details

Defined as a Functional Item property in the device item interface com.prosyst.mbs.services.da.items.whitegoods.ApplianceState

Fridge Temperature

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=Refrigeration.FridgeFreezer.Setting.SetpointTemperatureRefrigerator
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Temperature
  • Attributes.ATTRIBUTE_EQUIPMENT=Attributes.EQUIPMENT_FRIDGE
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_COOLING

Freezer Temperature

com.prosyst.mbs.services.da.items.Setpoint

Attributes

  • homeconnect.feature=Refrigeration.FridgeFreezer.Setting.SetpointTemperatureFreezer
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Temperature
  • Attributes.ATTRIBUTE_EQUIPMENT=Attributes.EQUIPMENT_FREEZER
  • SetpointAttributes.ATTRIBUTE_TYPE=SetpointAttributes.TYPE_COOLING

Fridge Super Mode

com.prosyst.mbs.services.da.items.Switch

Attributes

  • homeconnect.feature=Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator
  • Attributes.OPERATES=Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator

Freezer Super Mode

com.prosyst.mbs.services.da.items.Switch

Attributes

  • homeconnect.feature=Refrigeration.FridgeFreezer.Setting.SuperModeFreezer
  • Attributes.OPERATES=Refrigeration.FridgeFreezer.Setting.SuperModeFreezer

Current Map

com.prosyst.mbs.services.homeconnect.da.items.MapControl

Additional notes & details

Defined as a Functional Item property in the device item interface.

Names Of Maps

com.prosyst.mbs.services.homeconnect.da.items.MapControl

Additional notes & details

Defined as a Functional Item property in the device item interface.

HomeConnect States

State

Device Item/Item Bean

Device Item Attributes & Additional Details

RemoteControlActive

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=BSH.Common.Status.RemoteControlActive
  • DetectorAttributes.ATTRIBUTE_DETECTS=DetectorAttributes.DETECTS_REMOTE_OPERATION_ALLOWED

RemoteControlStartAllowed

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=BSH.Common.Status.RemoteControlStartAllowed
  • DetectorAttributes.ATTRIBUTE_DETECTS=DetectorAttributes.DETECTS_REMOTE_START_ALLOWED

LocalControlActive

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=BSH.Common.Status.LocalControlActive
  • DetectorAttributes.ATTRIBUTE_DETECTS=DetectorAttributes.DETECTS_LOCAL_CONTROL

OperationState

com.prosyst.mbs.services.da.items.whitegoods.ApplianceState

Additional notes & details

Defined as a Functional Item property in the device item interface com.prosyst.mbs.services.da.items.whitegoods.ApplianceState

DoorState

com.prosyst.mbs.services.da.items.Detector

Attributes for OPEN door state

  • homeconnect.feature=BSH.Common.Status.DoorState.Open
  • Attributes.ATTRIBUTE_EQUIPMENT=Attributes.EQUIPMENT_DOOR
  • DetectorAttributes.ATTRIBUTE_DETECTS=DetectorAttributes.DETECTS_OPEN

Attributes for LOCKED door state

  • homeconnect.feature=BSH.Common.Status.DoorState.Locked
  • Attributes.ATTRIBUTE_EQUIPMENT=Attributes.EQUIPMENT_DOOR
  • DetectorAttributes.ATTRIBUTE_DETECTS=DetectorAttributes.DETECTS_LOCKED

BatteryLevel

com.prosyst.mbs.services.da.items.Sensor

Attributes

  • homeconnect.feature=BSH.Common.Status.BatteryLevel
  • Attributes.ATTRIBUTE_CHARACTERISTIC=Attributes.CHARACTERISTIC_INTERNAL
  • Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Dimensionless

BatteryChargingState

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=BSH.Common.Status.BatteryChargingState
  • DetectorAttributes.ATTRIBUTE_DETECTS=BSH.Common.EnumType.BatteryChargingState.Charging

ChargingConnection

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=BSH.Common.Status.ChargingConnection
  • DetectorAttributes.ATTRIBUTE_DETECTS=BSH.Common.EnumType.ChargingConnection.Connected

LastSelectedMap

com.prosyst.mbs.services.homeconnect.da.items.MapControl

Additional notes & details

Defined as a FI property in the device item interface

DustBoxInserted

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=ConsumerProducts.CleaningRobot.Status.DustBoxInserted
  • DetectorAttributes.ATTRIBUTE_DETECTS=ConsumerProducts.CleaningRobot.Status.DustBoxInserted

Lost

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=ConsumerProducts.CleaningRobot.Status.Lost
  • DetectorAttributes.ATTRIBUTE_DETECTS=ConsumerProducts.CleaningRobot.Status.Lost

Lifted

com.prosyst.mbs.services.da.items.Detector

Attributes

  • homeconnect.feature=ConsumerProducts.CleaningRobot.Status.Lifted
  • DetectorAttributes.ATTRIBUTE_DETECTS=ConsumerProducts.CleaningRobot.Status.Lifted

Home Connect Events

The full list of supported Home Connect event keys can be found in the link to the Home Connect Developer API.