|
|
|
|
|
Interfaces for controlling domestic household appliances such as fridges, dishwashers, washing machines etc.
WhiteGoodAppliance
The WhiteGoodAppliance (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.WhiteGoodAppliance) interface represents the common capabilities of all white goods.
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Waiting to Start: 4; Running: 5; Paused: 6; End: 7; Failure: 8; Abort: 9; Idle: 10; Rinse Hold: 11; Service: 12; Super Freezing: 13; Super Cooling: 14; Stop and Go: 39; Off: 144; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
StartStopActuator
A StartStopActuator (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.StartStopActuator) represents the capability for starting and stopping the program cycle of different types of appliances. It provides you with unified methods for controlling objects from the following interfaces: CoffeeSystem, Dishwasher, Freezer, FridgeFreezer, Hob, Hood, Oven, TunbleDryers, WasherDrier and WashingMashine
Operations
Property |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
LightingActuator
The LightingActuator (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.LightingActuator) interface represents the capability of turning on and off the built-in lighting. It provides you with unified methods for controlling objects from the following interfaces: CoffeeSystem, Hood and WineStorage.
Properties
Property |
Meta Data |
|
|---|---|---|
lightingStatus
|
description |
Property name for the current lighting status of the appliance. |
access |
RE |
|
enum |
Lighting On: true; Lighting Off: false |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
startLighting |
description |
Turns the build-in light of the appliance on |
stopLighting |
description |
Turns the build-in light of the appliance off. |
TemperatureSensor
The TemperatureSensor (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.TemperatureSensor) interface represents a temperature sensor in a major appliance. It provides you with unified methods for controlling objects from the following interfaces: Freezer, Fridge and WineStorage.
Properties
Property |
Meta Data |
|
|---|---|---|
currentTemperature |
description |
Property name for the current temperature of the appliance. |
|
access |
RE |
|
unit |
C |
targetTemperature |
description |
Property name for the target temperature of the appliance. |
|
access |
RE |
|
unit |
C |
CoffeeSystem
An interface for controlling coffee systems (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.CoffeeSystem).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Running: 5; End: 7; Failure: 8; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
lightingStatus
|
description |
Property name for the current lighting status of the appliance. |
access |
RE |
|
enum |
Lighting On: true; Lighting Off: false |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
startLighting |
description |
Turns the build-in light of the appliance on |
stopLighting |
description |
Turns the build-in light of the appliance off. |
Dishwasher
An interface for controlling dishwashers (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.Dishwasher).
Properties
Property |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop
|
description |
Sends a command for stopping the appliance. |
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Waiting to Start: 4; Running: 5; Paused: 6; End: 7; Failure: 8; Abort: 9; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
duration
|
description |
Property name for the current duration of the selected program of the appliance. |
access |
RE |
|
unit |
min |
|
startTime
|
description |
Property name for the selected start time of the appliance. |
access |
RE |
|
unit |
min |
|
Operations
Operations |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
Fridge
An interface for controlling fridges (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.Fridge).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Running: 5; Failure: 8; Idle: 10; Service: 12; Super Cooling: 14; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
currentTemperature
|
description |
Property name for the current temperature of the appliance. |
access |
RE |
|
unit |
C |
|
targetTemperature
|
description |
Property name for the target temperature of the appliance. |
access |
RE |
|
unit |
C |
|
|
|
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
startSuperCooling |
description |
Starts the super cooling function of the Fridge appliance. |
stopSuperCooling |
description |
Stops the super cooling function of the Fridge appliance. |
Freezer
An interface for controlling freezers (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.Freezer)
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Running: 5; Failure: 8; Idle: 10; Service: 12; Super Freezing: 13; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
currentTemperature
|
description |
Property name for the current temperature of the appliance. |
access |
RE |
|
unit |
C |
|
targetTemperature
|
description |
Property name for the target temperature of the appliance. |
access |
RE |
|
unit |
C |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
startSuperFreezing |
description |
This operation should start the super freezing function of the Freezer appliance. |
stopSuperFreezing |
description |
This operation should stop the super freezing function of the Freezer appliance. |
FridgeFreezer
The FridgeFreezer (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.FridgeFreezer) represents the common capabilities of fridges and freezers. Each Home Device with a FridgeFreezer Device Class Object connected to it has also two child devices which have the Fridge and a Freezer objects.
Properties
Property |
Meta Data |
|
|---|---|---|
state |
description |
Property name for the appliance's current state. |
|
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 5; Running: 5; End: 7; Failure: 8; Idle: 10; Service: 12; Locked: 145 |
permittedOperationNames |
description |
Property name for permitted operations which are supported at any time. |
|
access |
RE |
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
Hob
The Hob (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.Hob) interface represents a cooking hob. The hob's plates are controlled via a separate interface: HobPlate and each Home Device with a Hob Device Class Object connected to it has also a child devices with HobPlate objects.
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Running: 5; End: 7; Failure: 8; Service: 12; Stop and Go: 39; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
plateNumbers
|
description |
Property name for plates number property of the appliance. |
access |
RE |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
HobPlate
An interface for controlling hob plates (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.HobPlate).
Properties
Property |
Meta Data |
|
|---|---|---|
level
|
description |
Property name for the level of this Hob Plate. |
access |
RE |
|
plateIndex
|
description |
Property name for the plate index of this Hob Plate. |
access |
RE |
|
duration
|
description |
Property name for the remaining time for this Hob Plate. |
access |
RE |
|
unit |
min |
|
startTime
|
description |
Property name for the selected start time of the Hob Plate. |
access |
RE |
|
unit |
min |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
stop |
description |
Sends a command for stopping the appliance. |
Oven
An interface for controlling cooking ovens (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.Oven).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Waiting to Start: 4; Running: 5; Paused: 6; End: 7; Failure: 8; Abort: 9; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
duration
|
description |
Property name for the current duration of the selected program of the appliance. |
access |
RE |
|
unit |
min |
|
startTime
|
description |
Property name for the selected start time of the appliance. |
access |
RE |
|
unit |
min |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
Hood
An interface for controlling range hoods (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.Hood).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Running: 5; End: 7; Failure: 8; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
duration
|
description |
Property name for the current duration of the selected program of the appliance. |
access |
RE |
|
unit |
min |
|
lightingStatus
|
description |
Property name for the current lighting status of the appliance. |
access |
RE |
|
enum |
Lighting On: true; Lighting Off: false |
|
startTime
|
description |
Property name for the selected start time of the appliance. |
access |
RE |
|
unit |
min |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
startLighting |
description |
Turns the build-in light of the appliance on. |
stopLighting |
description |
Turns the build-in light of the appliance off. |
TumbleDryer
An interface for controlling tumble dryers (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.TumbleDryer).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Waiting to Start: 4; Running: 5; Paused: 6; End: 7; Failure: 8; Abort: 9; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
duration
|
description |
Property name for the current duration of the selected program of the appliance. |
access |
RE |
|
unit |
min |
|
startTime
|
description |
Property name for the selected start time of the appliance. |
access |
RE |
|
unit |
min |
|
Operations
Property |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
WasherDryer
An interface for controlling washer dryers (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.WasherDryer).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Waiting to Start: 4; Running: 5; Paused: 6; End: 7; Failure: 8; Abort: 9; Rinse Hold: 11; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
duration
|
description |
Property name for the current duration of the selected program of the appliance. |
access |
RE |
|
unit |
min |
|
startTime
|
description |
Property name for the selected start time of the appliance. |
access |
RE |
|
unit |
min |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
WashingMachine
An interface for controlling washing machines (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.WashingMachine).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Stand-By: 2; Programmed: 3; Waiting to Start: 4; Running: 5; Paused: 6; End: 7; Failure: 8; Abort: 9; Rinse Hold: 11; Service: 12; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
programId
|
description |
Property name for the currently selected program on the appliance. |
access |
RE |
|
phase
|
description |
Property name for the current phase of a running program on the appliance. |
access |
RE |
|
duration
|
description |
Property name for the current duration of the selected program of the appliance. |
access |
RE |
|
unit |
min |
|
startTime
|
description |
Property name for the selected start time of the appliance. |
access |
RE |
|
unit |
min |
|
Operations
Operations |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
WineStorage
An interface for controlling wine storage appliances (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.WineStorage).
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property name for the appliance's current state. |
access |
RE |
|
enum |
Unknown: 0; Off: 1; Running: 5; Failure: 8; Idle: 10; Service: 12; Super Cooling: 14; Locked: 145 |
|
permittedOperationNames
|
description |
Property name for permitted operations which are supported at any time. |
access |
RE |
|
currentTemperature
|
description |
Property name for the current temperature of the appliance. |
access |
RE |
|
unit |
C |
|
targetTemperature
|
description |
Property name for the target temperature of the appliance. |
access |
RE |
|
unit |
C |
|
Operations
Operations |
Meta Data |
|
|---|---|---|
start |
description |
Sends a command for starting the appliance. |
stop |
description |
Sends a command for stopping the appliance. |
startSuperCooling |
description |
This operation should start the super cooling function of the Wine Storage appliance. |
stopSuperCooling |
description |
This operation should stop the super cooling function of the Wine Storage appliance. |
AlarmIndicator
The AlarmIndicator (com.prosyst.mbs.services.hdm.deviceclasses.whitegoods.AlarmIndicator) interface represents the capability of receiving alarm events from appliances. It has one property: an AlarmInfo object with code and severity.
Properties
Property |
Meta Data |
|
|---|---|---|
alarm |
description |
Alarm sensor event. |
access |
E |
|