Device Reference

The following sections report the detailed reference of supported devices together with the associated:

  • Commands (that can be sent via the Device API),
  • Notifications (that can be received via the WebSocket API, only), and
  • States (that can be obtained through the Device API).

For each command and notification the corresponding set of parameters and types is reported, if needed. Parameter types are reported in form of Java types, and can be rendered in JSON as usual. Measures, in particular, must be rendered as a number (decimal) followed by a unit of measure (in the standard SI notation).

SingleTemperatureSensor


Commands

Command Parameters Type
getTemperature
deleteGroup groupID Integer
storeGroup groupID Integer
getState

Notifications

Notification Parameters Type
leftGroup groupNumber Integer
newTemperatureValue temperatureValue Measure
joinedGroup groupNumber Integer

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)

Tv


Commands

Command Parameters Type
on
standBy
down
getState
up
set value Object
setChannel channel Integer
decreaseVolume
increaseVolume
off
setVolume volume Integer

Notifications

Notification Parameters Type
changedChannel channelId String
channelStepDown
on
off
changedLevel newLevel Measure
standby
channelStepUp

States

State StateValue RealValue
VolumeLevelState LevelStateValue (Measure)
StandByOnOffState StandByStateValue standBy
OnStateValue on
OffStateValue off
TunerState ChannelStateValue (Measure)

SinglePhaseCurrentMeter


Commands

Command Parameters Type
getElectricCurrentValue
getState

Notifications

Notification Parameters Type
newCurrentValue value Measure

States

State StateValue RealValue
SinglePhaseCurrentState CurrentStateValue (Measure)

SurveillanceCamera


Commands

Command Parameters Type
off
getState
on

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

MultiplePressureSensor


Commands

Command Parameters Type
getState
getPressureFrom sensorURI String

Notifications

Notification Parameters Type
changedPressureAt pressureValue Measure
sensorID String

States

State StateValue RealValue
PressureState PressureStateValue (Measure)

FireSystem


Commands

Command Parameters Type
getState

Buzzer


Commands

Command Parameters Type
on
off
getState

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

ActivePowerMeter


Commands

Command Parameters Type
getState

ZigBeeComponent


Commands

Command Parameters Type
getState

AntiIntrusionSystem


Commands

Command Parameters Type
getState

MultipleFlowSensor


Commands

Command Parameters Type
getState
getFlowRateFrom sensorURI String

Notifications

Notification Parameters Type
changedFlowRateAt sensorID String
flowRateValue Measure

States

State StateValue RealValue
MultipleFlowRateState MultipleFlowRateStateValue (Measure)

WaterConsumptionMeter


Commands

Command Parameters Type
getAmountOfColdWaterInM3
getAmountOfHotWaterInM3
getState

Notifications

Notification Parameters Type
newColdWaterAmountInM3 m3OfColdWater Measure
newHotWaterAmountInM3 m3OfHotWater Measure

States

State StateValue RealValue
WaterMeasurementState ConsumedWaterStateValue (Measure)

GasHeater


Commands

Command Parameters Type
getState

MultiTariffEnergyMeter


Commands

Command Parameters Type
getState

DimmerLamp


Commands

Command Parameters Type
getState
set value Object
stepUp
off
on
stepDown

Notifications

Notification Parameters Type
changedLevel newLevel Measure
off
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on
LightIntensityState LevelStateValue (Measure)

PowerMeter


Commands

Command Parameters Type
getState

Fridge


Commands

Command Parameters Type
startSuperCooling
getEndTime
getRemainingTime
setTemperatureAt temperature Measure
standBy
stopSuperCooling
cool
off
heat
getState
getStartTime
setStartTime endTime Measure
startTime Measure
remainingTime Measure
stopHeatingOrCooling
on
getEventsAndAlerts

Notifications

Notification Parameters Type
changedDesiredTemperatureSetting newTemperatureValue Measure
heat
newEvent event Object
stoppedHeatingOrCooling
newAlert alert Object
newAlertSet alerts Object[]
changedStartTime startTime Measure
changedRemainingTime remainingTime Measure
on
startedSuperCooling
newEventSet events Object[]
off
stoppedSuperCooling
cool
changedEndTime endTime Measure
standby

States

State StateValue RealValue
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
FaultState NoFailureStateValue noFailure
FailureStateValue failure
ProgramState ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
ProgrammedStateValue programmed
EndProgrammedStateValue endProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
StandByOnOffState StandByStateValue standBy
OffStateValue off
OnStateValue on
RunState PauseStateValue pause
RunningStateValue running
IdleStateValue idle

AlarmClock


Commands

Command Parameters Type
getState

GateActuator


Commands

Command Parameters Type
close
getState
open

Notifications

Notification Parameters Type
startedMovement
ceasedMovement
open
close

States

State StateValue RealValue
OpenCloseState CloseStateValue close
OpenStateValue open
MovementState MovingStateValue isMoving
NotMovingStateValue notMoving

FlashingLamp


Commands

Command Parameters Type
off
offFlashing
on
onFlashing
getState

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

EnergyMeteringPowerOutlet


Commands

Command Parameters Type
storeScene sceneNumber Integer
getReactiveEnergyValue
getActiveEnergyValue
storeGroup groupID Integer
off
getState
deleteScene sceneNumber Integer
deleteGroup groupID Integer
on

Notifications

Notification Parameters Type
deletedScene sceneNumber Integer
newReactiveEnergyValue value Measure
storedScene sceneNumber Integer
newActiveEnergyValue value Measure
leftGroup groupNumber Integer
off
on
joinedGroup groupNumber Integer

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off
SinglePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)

SingleTariffEnergyMeter


Commands

Command Parameters Type
getState

AccessControlSystem


Commands

Command Parameters Type
getState

EnergyAndPowerMeter


Commands

Command Parameters Type
getState
getActiveEnergyValue
getReactiveEnergyValue
getActivePower

Notifications

Notification Parameters Type
newActiveEnergyValue value Measure
newActivePowerValue powerValue Measure
newReactiveEnergyValue value Measure

States

State StateValue RealValue
SinglePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)

DoorActuator


Commands

Command Parameters Type
open
getState
close

Notifications

Notification Parameters Type
close
ceasedMovement
open
startedMovement

States

State StateValue RealValue
OpenCloseState OpenStateValue open
CloseStateValue close
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving

PumpController


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
changedFlowRateValue flowRateValue Measure
joinedGroup groupNumber Integer
identifyMe
newTemperatureValue temperatureValue Measure
storedScene sceneNumber Integer
on
leftGroup groupNumber Integer
changedLevel newLevel Measure
stepUp
off
stepDown
deletedScene sceneNumber Integer
newPressureValue pressureValue Measure

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

PowerDelivery


Commands

Command Parameters Type
getState

ThreePhaseVoltageMeter


Commands

Command Parameters Type
getLNVoltageValue phaseID String
getLLVoltageValue phaseID2 String
phaseID1 String
getState

Notifications

Notification Parameters Type
newPhasePhaseVoltageValue value Measure
phaseID String
newPhaseNeutralVoltageValue phaseID String
value Measure

States

State StateValue RealValue
ThreePhaseVoltageState VoltageStateValue (Measure)

PressureSensor


Commands

Command Parameters Type
getState
getPressure

Notifications

Notification Parameters Type
newPressureValue pressureValue Measure

States

State StateValue RealValue
PressureState PressureStateValue (Measure)

PresenceSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
isPresent
notPresent

States

State StateValue RealValue
PresenceState NotPresentState notPresent
PresentStateValue present

Knob


Commands

Command Parameters Type
stepDown
getState
stepUp
set value Object

Notifications

Notification Parameters Type
changedLevel newLevel Measure

States

State StateValue RealValue
LevelState LevelStateValue (Measure)

GasSystem


Commands

Command Parameters Type
getState

Boiler


Commands

Command Parameters Type
on
off
standBy
getRemainingTime
startSuperHeating
getState
stopSuperHeating
getEndTime
getStartTime
setStartTime remainingTime Measure
startTime Measure
endTime Measure
getEventsAndAlerts

Notifications

Notification Parameters Type
off
on
startedSuperHeating
newEventSet events Object[]
changedRemainingTime remainingTime Measure
changedEndTime endTime Measure
newAlertSet alerts Object[]
newAlert alert Object
changedStartTime startTime Measure
newEvent event Object
standby
stoppedSuperHeating

States

State StateValue RealValue
HeatingApplianceState SuperHeatingStateValue superHeating
RunState IdleStateValue idle
PauseStateValue pause
RunningStateValue running
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
ProgramState ProgrammedStateValue programmed
ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
EndProgrammedStateValue endProgrammed
FaultState NoFailureStateValue noFailure
FailureStateValue failure
StandByOnOffState OffStateValue off
StandByStateValue standBy
OnStateValue on

Printer


Commands

Command Parameters Type
getState

TexasInstrumentsComponent


Commands

Command Parameters Type
getState

EliteGateway


Commands

Command Parameters Type
getState

ThreePhaseElectricityMeter


Commands

Command Parameters Type
getState
getFrequency
getLLVoltageValue phaseID1 String
phaseID2 String
getElectricCurrentValue phaseID String
getActivePower phaseID String
getReactivePower phaseID String
getApparentPower phaseID String
getActiveEnergyValue
getLNVoltageValue phaseID String
getPowerFactor
getReactiveEnergyValue

Notifications

Notification Parameters Type
newActivePowerValue phaseID String
value Measure
newReactiveEnergyValue value Measure
newPhasePhaseVoltageValue value Measure
phaseID String
newPowerFactorValue powerFactor Measure
newFrequencyValue frequency Measure
newPhaseNeutralVoltageValue value Measure
phaseID String
newActiveEnergyValue value Measure
newApparentPowerValue value Measure
phaseID String
newCurrentValue phaseID String
value Measure
newReactivePowerValue value Measure
phaseID String

States

State StateValue RealValue
FrequencyMeasurementState FrequencyStateValue (Measure)
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)
SinglePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)
ThreePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
ThreePhaseApparentPowerMeasurementState ApparentPowerStateValue (Measure)
PowerFactorMeasurementState PowerFactorStateValue (Measure)
ThreePhaseVoltageState VoltageStateValue (Measure)
ThreePhaseReactivePowerMeasurementState ReactivePowerStateValue (Measure)
ThreePhaseCurrentState CurrentStateValue (Measure)

AwningActuator


Commands

Command Parameters Type
getState
open
close

Notifications

Notification Parameters Type
startedMovement
open
close
ceasedMovement

States

State StateValue RealValue
OpenCloseState OpenStateValue open
CloseStateValue close
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving

KNXNetIPGateway


Commands

Command Parameters Type
getState

SinglePhaseReactivePowerMeter


Commands

Command Parameters Type
getState
getReactivePower

Notifications

Notification Parameters Type
newReactivePowerValue powerValue Measure

States

State StateValue RealValue
SinglePhaseReactivePowerMeasurementState ReactivePowerStateValue (Measure)

SinglePhaseEnergyMeter


Commands

Command Parameters Type
getActiveEnergyValue
getReactiveEnergyValue
getState

Notifications

Notification Parameters Type
newActiveEnergyValue value Measure
newReactiveEnergyValue value Measure

States

State StateValue RealValue
SinglePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)

Sensor


Commands

Command Parameters Type
getState

HeatingAndCoolingUnit


Commands

Command Parameters Type
off
cool
deleteScene sceneNumber Integer
stepDown
setTemperatureAt temperature Measure
speedDown
set value Object
deleteGroup groupID Integer
speedUp
heat
getState
stepUp
storeScene sceneNumber Integer
on
stopHeatingOrCooling
setSpeed speed Measure
storeGroup groupID Integer

Notifications

Notification Parameters Type
changedLevel newLevel Measure
off
changedSpeed newSpeed Measure
joinedGroup groupNumber Integer
heat
stepUp
on
changedDesiredTemperatureSetting newTemperatureValue Measure
speedDown
leftGroup groupNumber Integer
speedUp
storedScene sceneNumber Integer
stepDown
stoppedHeatingOrCooling
cool
deletedScene sceneNumber Integer

States

State StateValue RealValue
HeatingAndCoolingUnitState OffStateValue off
CoolingStateValue cooling
OnStateValue on
HeatingStateValue heating
AutoRegulationStateValue auto

Interphone


Commands

Command Parameters Type
getState

SingleFlowSensor


Commands

Command Parameters Type
getState
getFlowRate

Notifications

Notification Parameters Type
changedFlowRateValue flowRateValue Measure

States

State StateValue RealValue
FlowRateState FlowRateStateValue (Measure)

SinglePhaseElectricityMeter


Commands

Command Parameters Type
getElectricCurrentValue
getReactivePower
getReactiveEnergyValue
getActivePower
getPhaseNeutralVoltageValue
getActiveEnergyValue
getPowerFactor
getApparentPower
getState
getFrequency

Notifications

Notification Parameters Type
newActivePowerValue powerValue Measure
newCurrentValue value Measure
newReactivePowerValue powerValue Measure
newReactiveEnergyValue value Measure
newPhaseNeutralVoltageValue lnVoltage Measure
newPowerFactorValue powerFactor Measure
newApparentPowerValue powerValue Measure
newActiveEnergyValue value Measure
newFrequencyValue frequency Measure

States

State StateValue RealValue
SinglePhaseApparentPowerMeasurementState ApparentPowerStateValue (Measure)
SinglePhaseVoltageState VoltageStateValue (Measure)
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
SinglePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)
SinglePhaseCurrentState CurrentStateValue (Measure)
FrequencyMeasurementState FrequencyStateValue (Measure)
SinglePhaseReactivePowerMeasurementState ReactivePowerStateValue (Measure)
PowerFactorMeasurementState PowerFactorStateValue (Measure)

SinglePhaseActiveEnergyMeter


Commands

Command Parameters Type
getActiveEnergyValue
getState

Notifications

Notification Parameters Type
newActiveEnergyValue value Measure

States

State StateValue RealValue
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)

Lamp


Commands

Command Parameters Type
off
getState
on

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

TemperatureAndHumiditySensor


Commands

Command Parameters Type
storeGroup groupID Integer
getState
getRelativeHumidity
getTemperature
deleteGroup groupID Integer

Notifications

Notification Parameters Type
changedRelativeHumidity relativeHumidity Measure
leftGroup groupNumber Integer
joinedGroup groupNumber Integer
newTemperatureValue temperatureValue Measure

States

State StateValue RealValue
HumidityMeasurementState HumidityStateValue (Measure)
TemperatureState TemperatureStateValue (Measure)

HumiditySensor


Commands

Command Parameters Type
getState
getRelativeHumidity

Notifications

Notification Parameters Type
changedRelativeHumidity relativeHumidity Measure

States

State StateValue RealValue
HumidityMeasurementState HumidityStateValue (Measure)

SnapshotCamera


Commands

Command Parameters Type
decreaseColor
getState
decreaseLuminosity
decreaseQuality
decreaseContrast
off
increaseColor
zoomOut
grabPicture
panUp
on
increaseQuality
panDown
increaseContrast
panRight
zoomIn
panLeft
increaseLuminosity

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

HiFi


Commands

Command Parameters Type
down
standBy
next
set value Object
stop
goToTrack trackNumber Integer
on
rew
prev
getState
source source String
setVolume volume Integer
timedOn timeToOff Measure
fwd
setChannel channel Integer
decreaseVolume
play
pause
up
increaseVolume
off

Notifications

Notification Parameters Type
stop
changedTrack trackId String
channelStepDown
on
channelStepUp
changedLevel newLevel Measure
fwd
pause
changedChannel channelId String
play
rew
off
standby
changedSource sourceId String

States

State StateValue RealValue
PlayState ForwardStateValue forward
StopStateValue stop
PauseStateValue pause
RewindStateValue rewind
PlayStateValue playing
TunerState ChannelStateValue (Measure)
VolumeLevelState LevelStateValue (Measure)
SourceSelectionState TunerStateValue tuner
Tape1StateValue tape1
AuxStateValue aux
PhonoStateValue phono
CDStateValue cd
Tape2StateValue tape2
StandByOnOffState OnStateValue on
StandByStateValue standBy
OffStateValue off

AnsweringMachine


Commands

Command Parameters Type
getState

RockerSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
released buttonID String
pressed buttonID String

Phone


Commands

Command Parameters Type
getState

ThreePhaseEnergyMeter


Commands

Command Parameters Type
getActiveEnergyValue phaseID String
getReactiveEnergyValue phaseID String
getState

Notifications

Notification Parameters Type
newActiveEnergyValue phaseID String
value Measure
newReactiveEnergyValue phaseID String
value Measure

States

State StateValue RealValue
ThreePhaseActiveEnergyState ActiveEnergyStateValue (Measure)
ThreePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)

HeatingEnergyMeter


Commands

Command Parameters Type
getHeatingEnergy
getState

Notifications

Notification Parameters Type
newHeatingEnergyValue heatingEnergy Measure

States

State StateValue RealValue
HeatingEnergyMeasurementState HeatingEnergyStateValue (Measure)

ThermostaticRadiatorValve


Commands

Command Parameters Type
getDaySchedule weekDay Integer
getSetpointTemperature
stopHeatingOrCooling
getState
setDailyClimateSchedule daySchedule DailyClimateSchedule
setTemperatureAt temperature Measure
heat
setClimateSchedule dailySchedules DailyClimateSchedule[]
cool

Notifications

Notification Parameters Type
changedDesiredTemperatureSetting newTemperatureValue Measure
heat
cool
changedDailyClimateSchedule daySchedule DailyClimateSchedule
stoppedHeatingOrCooling
changedWeeklyClimateSchedule dailySchedules DailyClimateSchedule[]

States

State StateValue RealValue
ClimateScheduleState ClimateScheduleStateValue (Measure)
TemperatureState TemperatureStateValue (Measure)

Entertainment


Commands

Command Parameters Type
getState

SelfClosingDoorActuator


Commands

Command Parameters Type
getState
open
close
timedOn timeToOff Measure

Notifications

Notification Parameters Type
ceasedMovement
close
startedMovement
open

States

State StateValue RealValue
OpenCloseState OpenStateValue open
CloseStateValue close
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving

WMBusGateway


Commands

Command Parameters Type
getState

AirConditioningSystem


Commands

Command Parameters Type
getState
heat
cool
off
on
setTemperatureAt temperature Measure
stopHeatingOrCooling

Notifications

Notification Parameters Type
stoppedHeatingOrCooling
changedDesiredTemperatureSetting newTemperatureValue Measure
cool
on
off
heat

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

PowerMeteringPowerOutlet


Commands

Command Parameters Type
off
deleteGroup groupID Integer
getState
storeGroup groupID Integer
getActivePower
storeScene sceneNumber Integer
on
deleteScene sceneNumber Integer

Notifications

Notification Parameters Type
storedScene sceneNumber Integer
newActivePowerValue powerValue Measure
off
on
joinedGroup groupNumber Integer
deletedScene sceneNumber Integer
leftGroup groupNumber Integer

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)

ThreePhaseApparentPowerMeter


Commands

Command Parameters Type
getApparentPower phaseID String
getState

Notifications

Notification Parameters Type
newApparentPowerValue phaseID String
value Measure

States

State StateValue RealValue
ThreePhaseApparentPowerMeasurementState ApparentPowerStateValue (Measure)

HueBridge


Commands

Command Parameters Type
startPushLinkAuth
getState
stopPushLinkAuth

Notifications

Notification Parameters Type
activatedPushLinkAuth
deactivatedPushLinkAuth

States

State StateValue RealValue
PushLinkAuthenticationState ActivePushLinkAuthenticationStateValue authenticating
AuthenticatedStateValue authenticated
NeedingAuthenticationStateValue needsAuthentication
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected

DimmerSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
stepDown
changedLevel newLevel Measure
stepUp
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on
LightIntensityState LevelStateValue (Measure)
LevelState LevelStateValue (Measure)

CoffeeMaker


Commands

Command Parameters Type
getState

Communication


Commands

Command Parameters Type
getState

BrownGoods


Commands

Command Parameters Type
getState

SecuritySystem


Commands

Command Parameters Type
getState

RemoteControl


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

ToggleRelay


Commands

Command Parameters Type
getState
toggle

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

MultiTariffThreePhaseEnergyMeter


Commands

Command Parameters Type
getReactiveEnergyValue phaseID String
tariffID String
getState
getActiveEnergyValue tariffID String
phaseID String

Notifications

Notification Parameters Type
newReactiveEnergyValue phaseID String
tariffID String
value Measure
newActiveEnergyValue tariffID String
phaseID String
value Measure

States

State StateValue RealValue
MultiTariffThreePhaseActiveEnergyState MultiTariffActiveEnergyStateValue (Measure)
MultiTariffThreePhaseReactiveEnergyState MultiTariffReactiveEnergyStateValue (Measure)

Control


Commands

Command Parameters Type
getState

CurrentMeter


Commands

Command Parameters Type
getState

SceneSelector


Commands

Command Parameters Type
getState

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

ThreePhaseCurrentMeter


Commands

Command Parameters Type
getState
getElectricCurrentValue phaseID String

Notifications

Notification Parameters Type
newCurrentValue value Measure
phaseID String

States

State StateValue RealValue
ThreePhaseCurrentState CurrentStateValue (Measure)

EchelonIlon100Gateway


Commands

Command Parameters Type
getState

Hotplate


Commands

Command Parameters Type
getEndTime
on
getStartTime
off
standBy
getEventsAndAlerts
getRemainingTime
getState
setStartTime startTime Measure
endTime Measure
remainingTime Measure

Notifications

Notification Parameters Type
newEvent event Object
newAlert alert Object
newAlertSet alerts Object[]
standby
changedRemainingTime remainingTime Measure
changedEndTime endTime Measure
changedStartTime startTime Measure
newEventSet events Object[]
off
on

States

State StateValue RealValue
FaultState NoFailureStateValue noFailure
FailureStateValue failure
ProgramState EndProgrammedStateValue endProgrammed
ProgrammedStateValue programmed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
RunState PauseStateValue pause
RunningStateValue running
IdleStateValue idle
ConnectionState DisconnectedStateValue disconnected
ConnectedStateValue connected
StandByOnOffState StandByStateValue standBy
OnStateValue on
OffStateValue off

SinglePhaseApparentPowerMeter


Commands

Command Parameters Type
getApparentPower
getState

Notifications

Notification Parameters Type
newApparentPowerValue powerValue Measure

States

State StateValue RealValue
SinglePhaseApparentPowerMeasurementState ApparentPowerStateValue (Measure)

Cooker


Commands

Command Parameters Type
getStartTime
setStartTime remainingTime Measure
endTime Measure
startTime Measure
getState
getEventsAndAlerts
getRemainingTime
on
getEndTime
off
standBy

Notifications

Notification Parameters Type
newAlertSet alerts Object[]
changedEndTime endTime Measure
off
newEvent event Object
on
newAlert alert Object
newEventSet events Object[]
standby
changedStartTime startTime Measure
changedRemainingTime remainingTime Measure

States

State StateValue RealValue
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
ProgramState ProgramInterruptedStateValue programInterrupted
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
NotProgrammedStateValue notProgrammed
ProgrammedStateValue programmed
EndProgrammedStateValue endProgrammed
StandByOnOffState OnStateValue on
OffStateValue off
StandByStateValue standBy
RunState IdleStateValue idle
PauseStateValue pause
RunningStateValue running
FaultState NoFailureStateValue noFailure
FailureStateValue failure

BTicinoComponent


Commands

Command Parameters Type
getState

EnOceanComponent


Commands

Command Parameters Type
getState

DimmableLight


Commands

Command Parameters Type
off
on
storeScene sceneNumber Integer
set value Object
stepDown
deleteGroup groupID Integer
getState
stepUp
storeGroup groupID Integer
deleteScene sceneNumber Integer

Notifications

Notification Parameters Type
joinedGroup groupNumber Integer
deletedScene sceneNumber Integer
changedLevel newLevel Measure
leftGroup groupNumber Integer
storedScene sceneNumber Integer
on
off

States

State StateValue RealValue
LightIntensityState LevelStateValue (Measure)
OnOffState OffStateValue off
OnStateValue on

Appliances


Commands

Command Parameters Type
getState

Heater


Commands

Command Parameters Type
getState

ShadeController


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
joinedGroup groupNumber Integer
off
storedScene sceneNumber Integer
identifyMe
leftGroup groupNumber Integer
changedLevel newLevel Measure
deletedScene sceneNumber Integer

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

DeepFreezer


Commands

Command Parameters Type
getEventsAndAlerts
getRemainingTime
off
stopSuperFreezing
getStartTime
startSuperFreezing
getEndTime
getState
setStartTime startTime Measure
remainingTime Measure
endTime Measure
standBy
on

Notifications

Notification Parameters Type
newAlert alert Object
changedRemainingTime remainingTime Measure
changedStartTime startTime Measure
stoppedSuperFreezing
on
newEventSet events Object[]
standby
changedEndTime endTime Measure
newEvent event Object
off
newAlertSet alerts Object[]
startedSuperFreezing

States

State StateValue RealValue
StandByOnOffState StandByStateValue standBy
OffStateValue off
OnStateValue on
ConnectionState DisconnectedStateValue disconnected
ConnectedStateValue connected
FreezingApplianceState SuperFreezingStateValue superFreezing
ProgramState ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
ProgrammedStateValue programmed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
EndProgrammedStateValue endProgrammed
FaultState NoFailureStateValue noFailure
FailureStateValue failure
RunState PauseStateValue pause
IdleStateValue idle
RunningStateValue running

Thermostat


Commands

Command Parameters Type
getSetpointTemperature
cool
heat
getState
stopHeatingOrCooling
setTemperatureAt temperature Measure

Notifications

Notification Parameters Type
heat
stoppedHeatingOrCooling
cool
changedDesiredTemperatureSetting newTemperatureValue Measure

StepShutterActuator


Commands

Command Parameters Type
stepDown
up
stepUp
rest
getState
down

Notifications

Notification Parameters Type
movingUp
resting
restingUp
movingDown
restingDown

States

State StateValue RealValue
ShutterState LoweringStateValue lowering
DownTripleStateValue down
RestTripleStateValue rest
UpTripleStateValue up
RaisingStateValue raising

Fax


Commands

Command Parameters Type
getState

ZWaveComponent


Commands

Command Parameters Type
getState

MicrowaveOven


Commands

Command Parameters Type
off
stop
start
getEventsAndAlerts
getStartTime
startSuperHeating
standBy
getEndTime
setStartTime endTime Measure
startTime Measure
remainingTime Measure
getRemainingTime
stopSuperHeating
getState
on
pause

Notifications

Notification Parameters Type
standby
newEventSet events Object[]
emittingMicrowaves
stop
on
start
newAlert alert Object
changedRemainingTime remainingTime Measure
off
changedStartTime startTime Measure
stoppedSuperHeating
newAlertSet alerts Object[]
notEmittingMicrowaves
pause
changedEndTime endTime Measure
startedSuperHeating
newEvent event Object

States

State StateValue RealValue
HeatingApplianceState SuperHeatingStateValue superHeating
RunState IdleStateValue idle
RunningStateValue running
PauseStateValue pause
FaultState NoFailureStateValue noFailure
FailureStateValue failure
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
ProgramState ProgrammedStateValue programmed
EndProgrammedStateValue endProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
NotProgrammedStateValue notProgrammed
ProgramInterruptedStateValue programInterrupted
MicrowaveEmissionState EmittingMicrowavesStateValue emittingMicrowaves
NotEmittingMicrowavesStateValue notEmittingMicrowaves
StandByOnOffState OnStateValue on
OffStateValue off
StandByStateValue standBy

eZ430Chronos


Commands

Command Parameters Type
display msg String
play
stop
getState

Notifications

Notification Parameters Type
new3DAccelerationValue accX Double
accZ Double
accY Double
pressed buttonID String
released buttonID String

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

Oven


Commands

Command Parameters Type
stop
getEndTime
standBy
getStartTime
on
off
setStartTime startTime Measure
endTime Measure
remainingTime Measure
pause
start
startSuperHeating
stopSuperHeating
getRemainingTime
getEventsAndAlerts
getState

Notifications

Notification Parameters Type
newEventSet events Object[]
changedEndTime endTime Measure
newAlert alert Object
changedStartTime startTime Measure
newAlertSet alerts Object[]
startedSuperHeating
on
stoppedSuperHeating
start
changedRemainingTime remainingTime Measure
standby
pause
off
newEvent event Object
stop

States

State StateValue RealValue
ProgramState ProgrammedStateValue programmed
EndProgrammedStateValue endProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
NotProgrammedStateValue notProgrammed
ProgramInterruptedStateValue programInterrupted
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
StandByOnOffState StandByStateValue standBy
OnStateValue on
OffStateValue off
RunState IdleStateValue idle
RunningStateValue running
PauseStateValue pause
HeatingApplianceState SuperHeatingStateValue superHeating
FaultState NoFailureStateValue noFailure
FailureStateValue failure

ShutterButton


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
pressedDown
pressedUp

States

State StateValue RealValue
UpDownRestState UpTripleStateValue up
RestTripleStateValue rest
DownTripleStateValue down

CompositeThermostat


Commands

Command Parameters Type
setTemperatureAt temperature Measure
stopHeatingOrCooling
storeScene sceneNumber Integer
deleteGroup groupID Integer
deleteScene sceneNumber Integer
getOccupancy
storeGroup groupID Integer
heat
cool
getTemperature
getState
getSetpointTemperature

Notifications

Notification Parameters Type
leftGroup groupNumber Integer
speedDown
changedDesiredTemperatureSetting newTemperatureValue Measure
speedUp
changedRelativeHumidity relativeHumidity Measure
heat
changedSpeed newSpeed Measure
stoppedHeatingOrCooling
joinedGroup groupNumber Integer
cool

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

MovementAndTemperatureSensor


Commands

Command Parameters Type
getTemperature
storeGroup groupID Integer
deleteGroup groupID Integer
getState

Notifications

Notification Parameters Type
leftGroup groupNumber Integer
startedMovement
joinedGroup groupNumber Integer
newTemperatureValue temperatureValue Measure
ceasedMovement

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving

OccupancySensor


Commands

Command Parameters Type
getState
storeGroup groupID Integer
deleteGroup groupID Integer
getOccupancy

Notifications

Notification Parameters Type
notPresent
isPresent

States

State StateValue RealValue
OccupancyState FreeStateValue noPersonInside
OccupiedStateValue personInside

Radio


Commands

Command Parameters Type
setChannel channel Integer
decreaseVolume
off
set value Object
setVolume volume Integer
increaseVolume
standBy
up
down
on
getState

Notifications

Notification Parameters Type
off
changedChannel channelId String
on
channelStepUp
standby
changedLevel newLevel Measure
channelStepDown

States

State StateValue RealValue
VolumeLevelState LevelStateValue (Measure)
TunerState ChannelStateValue (Measure)
StandByOnOffState OnStateValue on
StandByStateValue standBy
OffStateValue off

SimpleLamp


Commands

Command Parameters Type
getState
off
on

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

Button


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
released
pressed

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

WindowSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
close
open

States

State StateValue RealValue
OpenCloseState CloseStateValue close
OpenStateValue open

TripleSensor


Commands

Command Parameters Type
deleteGroup groupID Integer
getTemperature
storeGroup groupID Integer
getLuminance
getState

Notifications

Notification Parameters Type
leftGroup groupNumber Integer
joinedGroup groupNumber Integer
ceasedMovement
newLuminosityValue luminosityValue Measure
newTemperatureValue temperatureValue Measure
startedMovement

States

State StateValue RealValue
LightIntensityState LevelStateValue (Measure)
TemperatureState TemperatureStateValue (Measure)
MovementState MovingStateValue isMoving
NotMovingStateValue notMoving

OnOffSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

Actuator


Commands

Command Parameters Type
getState

ElectricityMeter


Commands

Command Parameters Type
getState

EnOceanGateway


Commands

Command Parameters Type
getState
teachIn
smartTeachIn
explicitTeachIn teachInData ExplicitTeachInData

Notifications

Notification Parameters Type
activatedTeachIn
deactivatedTeachIn

States

State StateValue RealValue
TeachInState IdleStateValue idle
TeachingInStateValue teachingIn

LevelControllableOutput


Commands

Command Parameters Type
stepUp
off
storeGroup groupID Integer
set value Object
getState
deleteGroup groupID Integer
deleteScene sceneNumber Integer
storeScene sceneNumber Integer
on
stepDown

Notifications

Notification Parameters Type
off
on
storedScene sceneNumber Integer
leftGroup groupNumber Integer
changedLevel newLevel Measure
deletedScene sceneNumber Integer
joinedGroup groupNumber Integer

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off
LevelState LevelStateValue (Measure)

PowerFactorMeter


Commands

Command Parameters Type
getState
getPowerFactor

Notifications

Notification Parameters Type
newPowerFactorValue powerFactor Measure

States

State StateValue RealValue
PowerFactorMeasurementState PowerFactorStateValue (Measure)

MainsPowerOutlet


Commands

Command Parameters Type
storeGroup groupID Integer
storeScene sceneNumber Integer
on
deleteScene sceneNumber Integer
off
getState
deleteGroup groupID Integer

Notifications

Notification Parameters Type
leftGroup groupNumber Integer
joinedGroup groupNumber Integer
off
deletedScene sceneNumber Integer
on
storedScene sceneNumber Integer

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

ThreePhaseReactivePowerMeter


Commands

Command Parameters Type
getReactivePower phaseID String
getState

Notifications

Notification Parameters Type
newReactivePowerValue phaseID String
value Measure

States

State StateValue RealValue
ThreePhaseReactivePowerMeasurementState ReactivePowerStateValue (Measure)

LightSensor


Commands

Command Parameters Type
getState
getLuminance
deleteGroup groupID Integer
storeGroup groupID Integer

Notifications

Notification Parameters Type
joinedGroup groupNumber Integer
newLuminosityValue luminosityValue Measure
leftGroup groupNumber Integer

States

State StateValue RealValue
LightIntensityState LevelStateValue (Measure)

HousePlants


Commands

Command Parameters Type
getState

FlowSensor


Commands

Command Parameters Type
getState

OnOffLight


Commands

Command Parameters Type
on
storeGroup groupID Integer
off
storeScene sceneNumber Integer
deleteScene sceneNumber Integer
deleteGroup groupID Integer
getState

Notifications

Notification Parameters Type
joinedGroup groupNumber Integer
leftGroup groupNumber Integer
deletedScene sceneNumber Integer
off
on
storedScene sceneNumber Integer

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

EliteComponent


Commands

Command Parameters Type
getState

KNXNetIPComponent


Commands

Command Parameters Type
getState

Computer


Commands

Command Parameters Type
getState

FrequencyMeter


Commands

Command Parameters Type
getState
getFrequency

Notifications

Notification Parameters Type
newFrequencyValue frequency Measure

States

State StateValue RealValue
FrequencyMeasurementState FrequencyStateValue (Measure)

Dishwasher


Commands

Command Parameters Type
getEventsAndAlerts
standBy
setStartTime startTime Measure
remainingTime Measure
endTime Measure
off
getState
stop
getRemainingTime
start
getEndTime
getStartTime
pause
on

Notifications

Notification Parameters Type
changedRemainingTime remainingTime Measure
stop
start
off
newAlert alert Object
on
pause
changedStartTime startTime Measure
standby
newAlertSet alerts Object[]
newEvent event Object
newEventSet events Object[]
changedEndTime endTime Measure

States

State StateValue RealValue
RunState RunningStateValue running
IdleStateValue idle
PauseStateValue pause
ConnectionState DisconnectedStateValue disconnected
ConnectedStateValue connected
ProgramState EndProgrammedStateValue endProgrammed
ProgramInterruptedStateValue programInterrupted
ProgrammedStateValue programmed
NotProgrammedStateValue notProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
StandByOnOffState OnStateValue on
StandByStateValue standBy
OffStateValue off
FaultState FailureStateValue failure
NoFailureStateValue noFailure

SinglePhaseVoltageMeter


Commands

Command Parameters Type
getState
getPhaseNeutralVoltageValue

Notifications

Notification Parameters Type
newPhaseNeutralVoltageValue lnVoltage Measure

States

State StateValue RealValue
SinglePhaseVoltageState VoltageStateValue (Measure)

HeatingSystem


Commands

Command Parameters Type
getState

MeteringPowerOutlet


Commands

Command Parameters Type
getActiveEnergyValue
getPowerFactor
getState
getActivePower
deleteGroup groupID Integer
getReactiveEnergyValue
deleteScene sceneNumber Integer
on
storeGroup groupID Integer
storeScene sceneNumber Integer
off

Notifications

Notification Parameters Type
newPowerFactorValue powerFactor Measure
joinedGroup groupNumber Integer
off
storedScene sceneNumber Integer
newReactiveEnergyValue value Measure
leftGroup groupNumber Integer
newActiveEnergyValue value Measure
on
deletedScene sceneNumber Integer
newActivePowerValue powerValue Measure

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
PowerFactorMeasurementState PowerFactorStateValue (Measure)
SinglePhaseReactiveEnergyState ReactiveEnergyStateValue (Measure)

Acoustic


Commands

Command Parameters Type
getState

VoltageMeter


Commands

Command Parameters Type
getState

InfraredSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
detected
notDetected

States

State StateValue RealValue
SensingState DetectedStateValue detected
NotDetectedStateValue notDetected

LampHolder


Commands

Command Parameters Type
storeScene sceneNumber Integer
storeGroup groupID Integer
on
deleteGroup groupID Integer
deleteScene sceneNumber Integer
off
getState

Notifications

Notification Parameters Type
deletedScene sceneNumber Integer
leftGroup groupNumber Integer
off
joinedGroup groupNumber Integer
storedScene sceneNumber Integer
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

EnergyAndPowerMeteringLevelControllableOutput


Commands

Command Parameters Type
getActivePower
on
storeScene sceneNumber Integer
getActiveEnergyValue
getState
set value Object
off
deleteGroup groupID Integer
stepUp
stepDown
deleteScene sceneNumber Integer
storeGroup groupID Integer

Notifications

Notification Parameters Type
newActiveEnergyValue value Measure
on
deletedScene sceneNumber Integer
leftGroup groupNumber Integer
joinedGroup groupNumber Integer
newActivePowerValue powerValue Measure
storedScene sceneNumber Integer
changedLevel newLevel Measure
off

States

State StateValue RealValue
LevelState LevelStateValue (Measure)
OnOffState OnStateValue on
OffStateValue off
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
SinglePhaseActiveEnergyState ActiveEnergyStateValue (Measure)

OnOffOutput


Commands

Command Parameters Type
storeScene sceneNumber Integer
getState
deleteGroup groupID Integer
storeGroup groupID Integer
off
on
deleteScene sceneNumber Integer

Notifications

Notification Parameters Type
storedScene sceneNumber Integer
joinedGroup groupNumber Integer
on
off
deletedScene sceneNumber Integer
leftGroup groupNumber Integer

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

Pump


Commands

Command Parameters Type
getState
storeScene sceneNumber Integer
on
stepUp
stepDown
storeGroup groupID Integer
getFlowRate
getPressure
deleteGroup groupID Integer
deleteScene sceneNumber Integer
getTemperature
set value Object
off

Notifications

Notification Parameters Type
newPressureValue pressureValue Measure
storedScene sceneNumber Integer
changedFlowRateValue flowRateValue Measure
changedLevel newLevel Measure
on
joinedGroup groupNumber Integer
deletedScene sceneNumber Integer
off
leftGroup groupNumber Integer
newTemperatureValue temperatureValue Measure

States

State StateValue RealValue
FlowRateState FlowRateStateValue (Measure)
OnOffState OnStateValue on
OffStateValue off
TemperatureState TemperatureStateValue (Measure)
PressureState PressureStateValue (Measure)

OnOffLightSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
on

SingleScenarioControl


Commands

Command Parameters Type
on
off
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

WindowActuator


Commands

Command Parameters Type
getState
close
open

Notifications

Notification Parameters Type
close
ceasedMovement
startedMovement
open

States

State StateValue RealValue
MovementState MovingStateValue isMoving
NotMovingStateValue notMoving
OpenCloseState CloseStateValue close
OpenStateValue open

Stove


Commands

Command Parameters Type
getEndTime
on
getRemainingTime
getState
getStartTime
off
getEventsAndAlerts
standBy
setStartTime remainingTime Measure
startTime Measure
endTime Measure

Notifications

Notification Parameters Type
newAlert alert Object
newEvent event Object
off
newEventSet events Object[]
changedEndTime endTime Measure
changedStartTime startTime Measure
standby
on
newAlertSet alerts Object[]
changedRemainingTime remainingTime Measure

States

State StateValue RealValue
HeatingApplianceState SuperHeatingStateValue superHeating
ProgramState EndProgrammedStateValue endProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
ProgrammedStateValue programmed
StandByOnOffState OffStateValue off
StandByStateValue standBy
OnStateValue on
FaultState NoFailureStateValue noFailure
FailureStateValue failure
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
RunState IdleStateValue idle
RunningStateValue running
PauseStateValue pause

EchelonNetworkComponent


Commands

Command Parameters Type
getState

KonnexGateway


Commands

Command Parameters Type
getState

BTicinoGateway


Commands

Command Parameters Type
getState

KonnexComponent


Commands

Command Parameters Type
getState

WhiteGoods


Commands

Command Parameters Type
getStartTime
on
setStartTime remainingTime Measure
endTime Measure
startTime Measure
getEventsAndAlerts
off
getState
getEndTime
standBy
getRemainingTime

Notifications

Notification Parameters Type
standby
changedRemainingTime remainingTime Measure
changedEndTime endTime Measure
changedStartTime startTime Measure
newAlert alert Object
newEventSet events Object[]
off
on
newAlertSet alerts Object[]
newEvent event Object

States

State StateValue RealValue
FaultState FailureStateValue failure
NoFailureStateValue noFailure
ProgramState EndProgrammedStateValue endProgrammed
ProgrammedStateValue programmed
ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
StandByOnOffState OnStateValue on
StandByStateValue standBy
OffStateValue off
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
RunState RunningStateValue running
IdleStateValue idle
PauseStateValue pause

ThermostatTemperatureSensor


Commands

Command Parameters Type
getState
deleteGroup groupID Integer
stopHeatingOrCooling
setTemperatureAt temperature Measure
getTemperature
storeGroup groupID Integer
cool
getSetpointTemperature
heat

Notifications

Notification Parameters Type
newTemperatureValue temperatureValue Measure
cool
joinedGroup groupNumber Integer
leftGroup groupNumber Integer
changedDesiredTemperatureSetting newTemperatureValue Measure
heat
stoppedHeatingOrCooling

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)
MultipleTemperatureState MultipleTemperatureStateValue (Measure)

HVACSystem


Commands

Command Parameters Type
getState

ModbusComponent


Commands

Command Parameters Type
getState

ColorDimmerSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
stepDown
stepUp
off
changedLevel newLevel Measure

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off
LightIntensityState LevelStateValue (Measure)
LevelState LevelStateValue (Measure)

MultipleTemperatureSensor


Commands

Command Parameters Type
deleteGroup groupID Integer
getState
getTemperatureFrom sensorURI String
storeGroup groupID Integer

Notifications

Notification Parameters Type
changedTemperatureAt temperatureValue Measure
sensorID String
leftGroup groupNumber Integer
joinedGroup groupNumber Integer

States

State StateValue RealValue
MultipleTemperatureState MultipleTemperatureStateValue (Measure)

MovementSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
startedMovement
ceasedMovement

States

State StateValue RealValue
MovementState MovingStateValue isMoving
NotMovingStateValue notMoving

ShadeActuator


Commands

Command Parameters Type
off
on
storeScene sceneNumber Integer
stepUp
stepDown
getState
deleteScene sceneNumber Integer
storeGroup groupID Integer
deleteGroup groupID Integer
set value Object

Notifications

Notification Parameters Type
joinedGroup groupNumber Integer
deletedScene sceneNumber Integer
startedMovement
on
ceasedMovement
changedLevel newLevel Measure
leftGroup groupNumber Integer
off
storedScene sceneNumber Integer

States

State StateValue RealValue
ShadeState ShadeStateValue (Measure)
MovementState MovingStateValue isMoving
NotMovingStateValue notMoving

SinglePhaseActivePowerMeter


Commands

Command Parameters Type
getState
getActivePower

Notifications

Notification Parameters Type
newActivePowerValue powerValue Measure

States

State StateValue RealValue
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)

GasSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
SensingState NotDetectedStateValue notDetected
DetectedStateValue detected

PresenceAndMovementSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
startedMovement
isPresent
notPresent
ceasedMovement

States

State StateValue RealValue
PresenceState PresentStateValue present
NotPresentState notPresent
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving

Siren


Commands

Command Parameters Type
off
on
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

EnergyMeter


Commands

Command Parameters Type
getState

GasCooker


Commands

Command Parameters Type
getEventsAndAlerts
off
on
getEndTime
setStartTime endTime Measure
startTime Measure
remainingTime Measure
getState
standBy
disableGas
getRemainingTime
getStartTime

Notifications

Notification Parameters Type
on
newAlert alert Object
changedStartTime startTime Measure
changedEndTime endTime Measure
changedRemainingTime remainingTime Measure
newEvent event Object
off
newAlertSet alerts Object[]
newEventSet events Object[]
standby

States

State StateValue RealValue
StandByOnOffState OffStateValue off
OnStateValue on
StandByStateValue standBy
RunState IdleStateValue idle
RunningStateValue running
PauseStateValue pause
ProgramState ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
ProgrammedStateValue programmed
NotProgrammedStateValue notProgrammed
ProgramInterruptedStateValue programInterrupted
EndProgrammedStateValue endProgrammed
FaultState NoFailureStateValue noFailure
FailureStateValue failure
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected

ApparentPowerMeter


Commands

Command Parameters Type
getState

Dvd


Commands

Command Parameters Type
getState
decreaseVolume
standBy
fwd
on
off
goToTrack trackNumber Integer
next
increaseVolume
prev
pause
rew
stop
play
setVolume volume Integer

Notifications

Notification Parameters Type
standby
changedLevel newLevel Measure
stop
play
on
changedTrack trackId String
fwd
rew
off
pause

States

State StateValue RealValue
PlayState RewindStateValue rewind
StopStateValue stop
ForwardStateValue forward
PauseStateValue pause
PlayStateValue playing
VolumeLevelState LevelStateValue (Measure)
StandByOnOffState OffStateValue off
StandByStateValue standBy
OnStateValue on

ReactivePowerMeter


Commands

Command Parameters Type
getState

HueManager


Commands

Command Parameters Type
startDiscovery
stopDiscovery
getState

Notifications

Notification Parameters Type
activatedDiscovery
deactivatedDiscovery

States

State StateValue RealValue
DiscoveryState IdleStateValue idle
ActiveDiscoveryStateValue searching

Fan


Commands

Command Parameters Type
getState

WirelessPhone


Commands

Command Parameters Type
getState

LevelControlSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
changedLevel newLevel Measure
stepUp
stepDown
on

States

State StateValue RealValue
LevelState LevelStateValue (Measure)
OnOffState OffStateValue off
OnStateValue on

Switch


Commands

Command Parameters Type
getState

ElectricalOven


Commands

Command Parameters Type
getStartTime
on
getRemainingTime
standBy
getEventsAndAlerts
setStartTime startTime Measure
endTime Measure
remainingTime Measure
stop
getEndTime
stopSuperHeating
startSuperHeating
getState
start
off
pause

Notifications

Notification Parameters Type
changedEndTime endTime Measure
newEventSet events Object[]
changedStartTime startTime Measure
pause
newAlertSet alerts Object[]
start
changedRemainingTime remainingTime Measure
standby
on
startedSuperHeating
newEvent event Object
stop
newAlert alert Object
stoppedSuperHeating
off

States

State StateValue RealValue
StandByOnOffState OnStateValue on
OffStateValue off
StandByStateValue standBy
ProgramState ProgramInterruptedStateValue programInterrupted
EndProgrammedStateValue endProgrammed
NotProgrammedStateValue notProgrammed
ProgrammedStateValue programmed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
RunState PauseStateValue pause
RunningStateValue running
IdleStateValue idle
HeatingApplianceState SuperHeatingStateValue superHeating
FaultState FailureStateValue failure
NoFailureStateValue noFailure
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected

FloodSystem


Commands

Command Parameters Type
getState

QuadSensor


Commands

Command Parameters Type
getState
getRelativeHumidity
storeGroup groupID Integer
getTemperature
getLuminance
deleteGroup groupID Integer

Notifications

Notification Parameters Type
leftGroup groupNumber Integer
newLuminosityValue luminosityValue Measure
startedMovement
changedRelativeHumidity relativeHumidity Measure
joinedGroup groupNumber Integer
ceasedMovement
newTemperatureValue temperatureValue Measure

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving
LightIntensityState LevelStateValue (Measure)
HumidityMeasurementState HumidityStateValue (Measure)

ZWaveGateway


Commands

Command Parameters Type
associate
getState
disassociate

Notifications

Notification Parameters Type
associating
disassociating
idle

PelletHeater


Commands

Command Parameters Type
off
standBy
on
getState

Notifications

Notification Parameters Type
on
heat
standby
firingUp
off
cool

States

State StateValue RealValue
HeaterState CoolingStateValue cooling
FireUpStateValue firingUp
HeatingStateValue heating
StandByOnOffState StandByStateValue standBy
OnStateValue on
OffStateValue off

WMBusComponent


Commands

Command Parameters Type
getState

TemperatureSensor


Commands

Command Parameters Type
getState

VentilatingSystem


Commands

Command Parameters Type
getState

NetworkComponent


Commands

Command Parameters Type
getState

PowerMeteringLevelControllableOutput


Commands

Command Parameters Type
getActivePower
deleteScene sceneNumber Integer
getState
storeScene sceneNumber Integer
stepDown
set value Object
stepUp
deleteGroup groupID Integer
off
storeGroup groupID Integer
on

Notifications

Notification Parameters Type
joinedGroup groupNumber Integer
on
off
changedLevel newLevel Measure
newActivePowerValue powerValue Measure
leftGroup groupNumber Integer
storedScene sceneNumber Integer
deletedScene sceneNumber Integer

States

State StateValue RealValue
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
OnOffState OffStateValue off
OnStateValue on
LevelState LevelStateValue (Measure)

GasMeter


Commands

Command Parameters Type
getState
getM3GasConsumed

Notifications

Notification Parameters Type
newConsumedM3GasValue consumedGasCubeMeters Measure

States

State StateValue RealValue
GasMeasurementState GasStateValue (Measure)

ZigBeeGateway


Commands

Command Parameters Type
installAppliance applianceId String
getState
openNetwork
deleteAppliance applianceId String
closeNetwork

Notifications

Notification Parameters Type
close
open

States

State StateValue RealValue
NetworkManagementState CloseStateValue close
OpenStateValue open

ElectricalSystem


Commands

Command Parameters Type
getState

Lighting


Commands

Command Parameters Type
getState

GasoilHeater


Commands

Command Parameters Type
getState

DoorSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
open
close

States

State StateValue RealValue
OpenCloseState OpenStateValue open
CloseStateValue close

MultiTariffSinglePhaseEnergyMeter


Commands

Command Parameters Type
getActiveEnergyValue tariffID String
getState
getReactiveEnergyValue tariffID String

Notifications

Notification Parameters Type
newReactiveEnergyValue value Measure
tariffID String
newActiveEnergyValue tariffID String
value Measure

States

State StateValue RealValue
MultiTariffSinglePhaseActiveEnergyState MultiTariffActiveEnergyStateValue (Measure)
MultiTariffSinglePhaseReactiveEnergyState MultiTariffReactiveEnergyStateValue (Measure)

TexasInstrumentsGateway


Commands

Command Parameters Type
getState

Ventilator


Commands

Command Parameters Type
on
setSpeed speed Measure
speedUp
getState
off
speedDown

Notifications

Notification Parameters Type
on
changedSpeed newSpeed Measure
speedUp
off
speedDown

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

SmokeSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
SensingState DetectedStateValue detected
NotDetectedStateValue notDetected

ColorDimmableLight


Commands

Command Parameters Type
storeGroup groupID Integer
deleteGroup groupID Integer
on
set value Object
setColorRGB colorRGB RGBColor
stepUp
stepDown
storeScene sceneNumber Integer
setColorHSB colorHSB HSBColor
off
deleteScene sceneNumber Integer
getState

Notifications

Notification Parameters Type
storedScene sceneNumber Integer
leftGroup groupNumber Integer
deletedScene sceneNumber Integer
changedLevel newLevel Measure
on
joinedGroup groupNumber Integer
off
changedColorRGB colorRGB RGBColor
changedColorHSB colorHSB HSBColor

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on
LightIntensityState LevelStateValue (Measure)
ColorState

ElectricalCooker


Commands

Command Parameters Type
getRemainingTime
getEventsAndAlerts
standBy
getState
getEndTime
on
getStartTime
off
setStartTime remainingTime Measure
startTime Measure
endTime Measure

Notifications

Notification Parameters Type
newAlertSet alerts Object[]
newEventSet events Object[]
changedEndTime endTime Measure
changedRemainingTime remainingTime Measure
standby
newEvent event Object
off
changedStartTime startTime Measure
newAlert alert Object
on

States

State StateValue RealValue
ProgramState ProgramInterruptedStateValue programInterrupted
NotProgrammedStateValue notProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
ProgrammedStateValue programmed
EndProgrammedStateValue endProgrammed
StandByOnOffState StandByStateValue standBy
OnStateValue on
OffStateValue off
FaultState FailureStateValue failure
NoFailureStateValue noFailure
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
RunState RunningStateValue running
PauseStateValue pause
IdleStateValue idle

ModbusGateway


Commands

Command Parameters Type
getState

Co2Sensor


Commands

Command Parameters Type
getState
getCo2Concentration

Notifications

Notification Parameters Type
changedCo2Concentration co2Concentration Measure

States

State StateValue RealValue
Co2MeasurementState Co2MeasurementStateValue (Measure)

HueComponent


Commands

Command Parameters Type
getState

Controllable


Commands

Command Parameters Type
getState

WashingMachine


Commands

Command Parameters Type
pause
stop
getEventsAndAlerts
start
getState
on
getStartTime
getEndTime
standBy
getRemainingTime
off
setStartTime startTime Measure
endTime Measure
remainingTime Measure

Notifications

Notification Parameters Type
on
changedEndTime endTime Measure
newEventSet events Object[]
stoppedHeatingCycle
off
newEvent event Object
stoppedWashOrRinseCycle
changedStartTime startTime Measure
newAlert alert Object
startedHeatingCycle
newAlertSet alerts Object[]
changedRemainingTime remainingTime Measure
startedWashOrRinseCycle
stop
pause
standby
start

States

State StateValue RealValue
FaultState FailureStateValue failure
NoFailureStateValue noFailure
ProgramState NotProgrammedStateValue notProgrammed
ProgrammedStateValue programmed
EndProgrammedStateValue endProgrammed
ProgrammedAndWaitingToStartStateValue programmedAndWaitingToStart
ProgramInterruptedStateValue programInterrupted
WashingApplianceState HeatingStateValue heating
WashRinseStateValue washOrRinse
RinseHoldStateValue rinseHold
RunState PauseStateValue pause
RunningStateValue running
IdleStateValue idle
ConnectionState ConnectedStateValue connected
DisconnectedStateValue disconnected
StandByOnOffState StandByStateValue standBy
OffStateValue off
OnStateValue on

Clock


Commands

Command Parameters Type
getState

ShutterActuator


Commands

Command Parameters Type
up
getState
rest
down

Notifications

Notification Parameters Type
restingDown
movingUp
restingUp
movingDown
resting

States

State StateValue RealValue
ShutterState RaisingStateValue raising
LoweringStateValue lowering
DownTripleStateValue down
RestTripleStateValue rest
UpTripleStateValue up

ThreePhaseActivePowerMeter


Commands

Command Parameters Type
getActivePower phaseID String
getState

Notifications

Notification Parameters Type
newActivePowerValue phaseID String
value Measure

States

State StateValue RealValue
ThreePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)

Meter


Commands

Command Parameters Type
getState

FloodSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
SensingState NotDetectedStateValue notDetected
DetectedStateValue detected