Appliances

The Appliance – com.prosyst.mbs.services.da.items.whitegoods.Appliance, represents an appliance known by different names like white goods, major appliance and domestic appliance. The Appliance provides basic control and monitoring functionality. All settings and options are implemented with extra items. For example:

program selector
temperature configuration
power level

The Appliance state is represented by com.prosyst.mbs.services.da.items.whitegoods.ApplianceState. It is the appliance condition view. The transition from one state to another can be automatically done or can be an operation result. The possible appliance states are:

ApplianceState.OFF – the appliance has been turned off.
ApplianceState.STANDBY – the appliance is in standby mode. Normally, the appliance goes in this state after a given timeout.
ApplianceState.IDLE – the appliance is turned on, but it is not ready to operate. Normally, it requires an additional configuration to become ready for start
ApplianceState.READY – the appliance is configured and ready for start.
ApplianceState.DELAYED_START – the appliance delayed start has been configured. Some conditions like delay time, tariff etc., have to be satisfied to effectively start the appliance.
ApplianceState.STARTED – the appliance activity has been started.
ApplianceState.ACTION_REQUIRED – the appliance activity requires an user interaction to continue.
ApplianceState.PAUSED – the appliance activity has been paused.
ApplianceState.STOPPING – the appliance activity is stopping.
ApplianceState.FINISHED – the appliance activity has finished.
ApplianceState.FAILED – the appliance activity has failed.
ApplianceState.STOPPED – the appliance activity has been stopped.
ApplianceState.UNKNOWN – the appliance state is not known.

Property	Access	Property Class	Description
state	RE	`ApplianceState`	Property for the appliance state. It's the appliance condition view. The transition from one state to another can be automatically done or can be an operation result.
phase	RE	`String`	Property for the appliance phase. It's the current stage of the appliance activity. Usually, the value is vendor specific.
disabledOperations	RE	`Set<String>`	Property for the disabled operations. The property can be any combination of one of the following operations: on off start stop pause

Property

Access

Property Class

Description

state

ApplianceState

Property for the appliance state. It's the appliance condition view. The transition from one state to another can be automatically done or can be an operation result.

phase

String

Property for the appliance phase. It's the current stage of the appliance activity. Usually, the value is vendor specific.

disabledOperations

Set<String>

Property for the disabled operations. The property can be any combination of one of the following operations:

on
off
start
stop
pause

Operation	Parameters	Description
on	N/A	Turns on the apliance. Normally, this operation is executed when the appliance is in `ApplianceState.OFF` or `ApplianceState.STANDBY` state. It can be result in different states. For example: `ApplianceState.IDLE` - the appliance is turned on, but has to be configured. `ApplianceState.READY` - the appliance is turned on and ready to be started. `AllpianceState.STARTED` - the appliance is turned on and has been automatically started.
off	N/A	Turns off the appliance. Normally, this operation is executed when the appliance is not in `ApplianceState.Off` state.
start	N/A	Starts or resumes the appliance activity. Normally, the start operation is executed when the appliance is in `ApplianceState.READY` state. The resume operation is executed when the appliance is in `ApplianceState.PAUSED` state. It can be result in different states. For example: `AllianceState.STARTED` - the application has been started. `ApplianceState.DELAYED_START` - the appliance delayed start has been configured.
stop	N/A	Stops the appliance activity. Normally, this operation is executed if the appliance is started. `ApplianceState.STOPPING` is an intermediate state before the final `ApplianceState.STOPPED` state.
pause	N/A	Pauses the appliance activity. Normally, this operation is executed if the appliance is started. It can result in `ApplianceState.PAUSED` state. Operation "start" can be used to resume the appliance activity.