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).

PresenceSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
notPresent
isPresent

States

State StateValue RealValue
PresenceState PresentStateValue present
NotPresentState notPresent

WMBusGateway


Commands

Command Parameters Type
getState

Hotplate


Commands

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

Notifications

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

States

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

MeteringPowerOutlet


Commands

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

Notifications

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

States

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

HeatingAndCoolingUnit


Commands

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

Notifications

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

States

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

KNXNetIPGateway


Commands

Command Parameters Type
getState

LampHolder


Commands

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

Notifications

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

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

SimpleLamp


Commands

Command Parameters Type
off
getState
on

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

DoorActuator


Commands

Command Parameters Type
open
close
getState

Notifications

Notification Parameters Type
open
ceasedMovement
startedMovement
close

States

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

SinglePhaseReactivePowerMeter


Commands

Command Parameters Type
getReactivePower
getState

Notifications

Notification Parameters Type
newReactivePowerValue powerValue Measure

States

State StateValue RealValue
SinglePhaseReactivePowerMeasurementState ReactivePowerStateValue (Measure)
PowerStateValue (Measure)

SinglePhaseVoltageMeter


Commands

Command Parameters Type
getState
getPhaseNeutralVoltageValue

Notifications

Notification Parameters Type
newPhaseNeutralVoltageValue lnVoltage Measure

States

State StateValue RealValue
SinglePhaseVoltageState VoltageStateValue (Measure)

FrequencyMeter


Commands

Command Parameters Type
getState
getFrequency

Notifications

Notification Parameters Type
newFrequencyValue frequency Measure

States

State StateValue RealValue
FrequencyMeasurementState FrequencyStateValue (Measure)

ShadeActuator


Commands

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

Notifications

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

States

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

EnergyMeteringPowerOutlet


Commands

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

Notifications

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

States

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

NetworkComponent


Commands

Command Parameters Type
getState

AttentiveWasteBin


Commands

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

Notifications

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

States

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

QuadSensor


Commands

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

Notifications

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

States

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

PowerFactorMeter


Commands

Command Parameters Type
getState
getPowerFactor

Notifications

Notification Parameters Type
newPowerFactorValue powerFactor Measure

States

State StateValue RealValue
PowerFactorMeasurementState PowerFactorStateValue (Measure)

PowerMeteringPowerOutlet


Commands

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

Notifications

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

States

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

Co2Sensor


Commands

Command Parameters Type
getState
getCo2Concentration

Notifications

Notification Parameters Type
changedCo2Concentration co2Concentration Measure

States

State StateValue RealValue
Co2MeasurementState Co2MeasurementStateValue (Measure)

PlugwiseGateway


Commands

Command Parameters Type
getState

Ventilator


Commands

Command Parameters Type
on
speedUp
setSpeed speed Measure
getState
off
speedDown

Notifications

Notification Parameters Type
speedDown
speedUp
changedSpeed newSpeed Measure
off
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

OnOffLightSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

ThreePhaseVoltageMeter


Commands

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

Notifications

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

States

State StateValue RealValue
ThreePhaseVoltageState VoltageStateValue (Measure)

PumpController


Commands

Command Parameters Type
getState

Notifications

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

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

HeatingEnergyMeter


Commands

Command Parameters Type
getState
getHeatingEnergy

Notifications

Notification Parameters Type
newHeatingEnergyValue heatingEnergy Measure

States

State StateValue RealValue
EnergyMeasurementState EnergyStateValue (Measure)

ElectricityMeter


Commands

Command Parameters Type
getState

HumiditySensor


Commands

Command Parameters Type
getRelativeHumidity
getState

Notifications

Notification Parameters Type
changedRelativeHumidity relativeHumidity Measure

States

State StateValue RealValue
HumidityMeasurementState HumidityStateValue (Measure)

CardiacPulseMeter


Commands

Command Parameters Type
getState
getPulseFrequency

Notifications

Notification Parameters Type
newPulseFrequencyValue frequency Measure

States

State StateValue RealValue
PulseFrequencyMeasurementState FrequencyStateValue (Measure)

Lighting


Commands

Command Parameters Type
getState

Phone


Commands

Command Parameters Type
getState

DeepFreezer


Commands

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

Notifications

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

States

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

MultiplePressureSensor


Commands

Command Parameters Type
getState
getPressureFrom sensorURI String

Notifications

Notification Parameters Type
changedPressureAt sensorID String
pressureValue Measure

States

State StateValue RealValue
PressureState PressureStateValue (Measure)

NetatmoComponent


Commands

Command Parameters Type
getState

AwningActuator


Commands

Command Parameters Type
close
open
getState

Notifications

Notification Parameters Type
open
close
startedMovement
ceasedMovement

States

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

SelfClosingDoorActuator


Commands

Command Parameters Type
close
open
timedOn timeToOff Measure
getState

Notifications

Notification Parameters Type
ceasedMovement
open
startedMovement
close

States

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

EnergyAndPowerMeteringLevelControllableOutput


Commands

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

Notifications

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

States

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

SinglePhaseEnergyMeter


Commands

Command Parameters Type
getActiveEnergyValue
getState
getReactiveEnergyValue

Notifications

Notification Parameters Type
newReactiveEnergyValue value Measure
newActiveEnergyValue value Measure

States

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

Radio


Commands

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

Notifications

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

States

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

DimmableLight


Commands

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

Notifications

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

States

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

SinglePhaseActivePowerMeter


Commands

Command Parameters Type
getState
getActivePower

Notifications

Notification Parameters Type
newActivePowerValue powerValue Measure

States

State StateValue RealValue
SinglePhaseActivePowerMeasurementState ActivePowerStateValue (Measure)
PowerStateValue (Measure)

Cooker


Commands

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

Notifications

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

States

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

BrownGoods


Commands

Command Parameters Type
getState

KonnexComponent


Commands

Command Parameters Type
getState

ElectricalOven


Commands

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

Notifications

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

States

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

Meter


Commands

Command Parameters Type
getState

OnOffLight


Commands

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

Notifications

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

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

ActivePowerMeter


Commands

Command Parameters Type
getState

PowerDelivery


Commands

Command Parameters Type
getState

NetatmoGateway


Commands

Command Parameters Type
getState

PowerMeteringLevelControllableOutput


Commands

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

Notifications

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

States

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

EnOceanComponent


Commands

Command Parameters Type
getState

BluetoothAdapter


Commands

Command Parameters Type
startDiscovery
stopDiscovery
getState

Notifications

Notification Parameters Type
discoveredDevice discoveredDeviceRSSI int
discoveredDeviceMac String
discoveredDeviceName String
deactivatedDiscovery
activatedDiscovery

States

State StateValue RealValue
DiscoveryState ActiveDiscoveryStateValue searching
IdleStateValue idle

RockerSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
released buttonID String
pressed buttonID String

MultipleFlowSensor


Commands

Command Parameters Type
getFlowRateFrom sensorURI String
getState

Notifications

Notification Parameters Type
changedFlowRateAt flowRateValue Measure
sensorID String

States

State StateValue RealValue
MultipleFlowRateState MultipleFlowRateStateValue (Measure)

WindowSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
close
open

States

State StateValue RealValue
OpenCloseState OpenStateValue open
CloseStateValue close

SingleTariffEnergyMeter


Commands

Command Parameters Type
getState

ShadeController


Commands

Command Parameters Type
getState

Notifications

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

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

Dishwasher


Commands

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

Notifications

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

States

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

MainsPowerOutlet


Commands

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

Notifications

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

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

Control


Commands

Command Parameters Type
getState

PressureSensor


Commands

Command Parameters Type
getState
getPressure

Notifications

Notification Parameters Type
newPressureValue pressureValue Measure

States

State StateValue RealValue
PressureState PressureStateValue (Measure)

WirelessPhone


Commands

Command Parameters Type
getState

Boiler


Commands

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

Notifications

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

States

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

Computer


Commands

Command Parameters Type
getState

ThreePhaseReactivePowerMeter


Commands

Command Parameters Type
getReactivePower phaseID String
getState

Notifications

Notification Parameters Type
newReactivePowerValue value Measure
phaseID String

States

State StateValue RealValue
ThreePhaseReactivePowerMeasurementState PowerStateValue (Measure)
ReactivePowerStateValue (Measure)

ColorDimmerSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
stepUp
stepDown
changedLevel newLevel Measure
off
on

States

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

OnOffSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
on

Switch


Commands

Command Parameters Type
getState

ModbusComponent


Commands

Command Parameters Type
getState

GasHeater


Commands

Command Parameters Type
getState

HueManager


Commands

Command Parameters Type
startDiscovery
stopDiscovery
getState

Notifications

Notification Parameters Type
activatedDiscovery
deactivatedDiscovery

States

State StateValue RealValue
DiscoveryState ActiveDiscoveryStateValue searching
IdleStateValue idle

WhiteGoods


Commands

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

Notifications

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

States

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

ModbusGateway


Commands

Command Parameters Type
getState

LevelControlSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
stepDown
changedLevel newLevel Measure
off
on
stepUp

States

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

Actuator


Commands

Command Parameters Type
getState

FloodSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
SensingState DetectedStateValue detected
NotDetectedStateValue notDetected

ColorDimmableLight


Commands

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

Notifications

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

States

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

Pump


Commands

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

Notifications

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

States

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

BTicinoGateway


Commands

Command Parameters Type
getState

HeatEnergyCalculator


Commands

Command Parameters Type
getState
getTemperatureFrom sensorURI String
getFlowRate
getSubstanceVolumeFrom sensorID String
getEnergyValue sensorID String
getPowerValue

Notifications

Notification Parameters Type
newEnergyValue sensorID String
value Measure
newPowerValue value Measure
newWaterVolumeAmount sensorID String
waterVolume Measure
changedTemperatureAt sensorID String
temperatureValue Measure
changedFlowRateValue flowRateValue Measure

States

State StateValue RealValue
MultipleWaterVolumeMeasurementState MultipleWaterVolumeStateValue (Measure)
FlowRateState FlowRateStateValue (Measure)
MultipleTemperatureState MultipleTemperatureStateValue (Measure)
MultipleEnergyMeasurementState EnergyStateValue (Measure)
PowerMeasurementState PowerStateValue (Measure)

LightSensor


Commands

Command Parameters Type
getState
deleteGroup groupID Integer
storeGroup groupID Integer
getLuminance

Notifications

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

States

State StateValue RealValue
LightIntensityState LevelStateValue (Measure)

ZigBeeGateway


Commands

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

Notifications

Notification Parameters Type
open
close

States

State StateValue RealValue
NetworkManagementState OpenStateValue open
CloseStateValue close

Entertainment


Commands

Command Parameters Type
getState

Controllable


Commands

Command Parameters Type
getState

Thermostat


Commands

Command Parameters Type
stopHeatingOrCooling
cool
setTemperatureAt temperature Measure
getState
heat
getSetpointTemperature

Notifications

Notification Parameters Type
heat
cool
changedDesiredTemperatureSetting newTemperatureValue Measure
stoppedHeatingOrCooling

SingleTemperatureSensor


Commands

Command Parameters Type
getState
storeGroup groupID Integer
deleteGroup groupID Integer
getTemperature

Notifications

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

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)

SnapshotCamera


Commands

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

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

HiFi


Commands

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

Notifications

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

States

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

ToggleRelay


Commands

Command Parameters Type
getState
toggle

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

PlugwiseComponent


Commands

Command Parameters Type
getState

EnergyMeter


Commands

Command Parameters Type
getState

Interphone


Commands

Command Parameters Type
getState

EliteGateway


Commands

Command Parameters Type
getState

Printer


Commands

Command Parameters Type
getState

SinglePhaseApparentPowerMeter


Commands

Command Parameters Type
getState
getApparentPower

Notifications

Notification Parameters Type
newApparentPowerValue powerValue Measure

States

State StateValue RealValue
SinglePhaseApparentPowerMeasurementState ApparentPowerStateValue (Measure)
PowerStateValue (Measure)

HueComponent


Commands

Command Parameters Type
getState

Buzzer


Commands

Command Parameters Type
on
getState
off

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

Fan


Commands

Command Parameters Type
getState

RemoteControl


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

LevelControllableOutput


Commands

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

Notifications

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

States

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

FillLevelSensor


Commands

Command Parameters Type
getState
getFillLevel

Notifications

Notification Parameters Type
changedLevel newLevel Measure

States

State StateValue RealValue
FillLevelState LevelStateValue (Measure)

GasMeter


Commands

Command Parameters Type
getState
getM3GasConsumed

Notifications

Notification Parameters Type
newConsumedM3GasValue consumedGasCubeMeters Measure

States

State StateValue RealValue
GasMeasurementState GasStateValue (Measure)

PhMeter


Commands

Command Parameters Type
getPhValue
getState

Notifications

Notification Parameters Type
newPhValue value Measure

States

State StateValue RealValue
PhMeasurementState PhStateValue (Measure)

EchelonIlon100Gateway


Commands

Command Parameters Type
getState

CoffeeMaker


Commands

Command Parameters Type
getState

MovementSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
ceasedMovement
startedMovement

States

State StateValue RealValue
MovementState NotMovingStateValue notMoving
MovingStateValue isMoving

Sensor


Commands

Command Parameters Type
getState

Clock


Commands

Command Parameters Type
getState

SingleScenarioControl


Commands

Command Parameters Type
on
off
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

SingleFlowSensor


Commands

Command Parameters Type
getState
getFlowRate

Notifications

Notification Parameters Type
changedFlowRateValue flowRateValue Measure

States

State StateValue RealValue
FlowRateState FlowRateStateValue (Measure)

BTicinoComponent


Commands

Command Parameters Type
getState

TemperatureAndHumiditySensor


Commands

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

Notifications

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

States

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

AirConditioningSystem


Commands

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

Notifications

Notification Parameters Type
off
changedDesiredTemperatureSetting newTemperatureValue Measure
cool
heat
on
stoppedHeatingOrCooling

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

Lamp


Commands

Command Parameters Type
getState
on
off

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

SinglePhaseActiveEnergyMeter


Commands

Command Parameters Type
getActiveEnergyValue
getState

Notifications

Notification Parameters Type
newActiveEnergyValue value Measure

States

State StateValue RealValue
SinglePhaseActiveEnergyState EnergyStateValue (Measure)
ActiveEnergyStateValue (Measure)

eZ430Chronos


Commands

Command Parameters Type
stop
display msg String
play
getState

Notifications

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

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

GateActuator


Commands

Command Parameters Type
open
getState
close

Notifications

Notification Parameters Type
close
open
startedMovement
ceasedMovement

States

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

SurveillanceCamera


Commands

Command Parameters Type
off
getState
on

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

TripleSensor


Commands

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

Notifications

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

States

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

ApparentPowerMeter


Commands

Command Parameters Type
getState

AnsweringMachine


Commands

Command Parameters Type
getState

Appliances


Commands

Command Parameters Type
getState

EliteComponent


Commands

Command Parameters Type
getState

ReactivePowerMeter


Commands

Command Parameters Type
getState

MovementAndTemperatureSensor


Commands

Command Parameters Type
deleteGroup groupID Integer
storeGroup groupID Integer
getState
getTemperature

Notifications

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

States

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

Stove


Commands

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

Notifications

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

States

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

Fridge


Commands

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

Notifications

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

States

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

Dvd


Commands

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

Notifications

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

States

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

StepShutterActuator


Commands

Command Parameters Type
stepDown
rest
up
stepUp
getState
down

Notifications

Notification Parameters Type
restingUp
movingUp
resting
movingDown
restingDown

States

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

KonnexGateway


Commands

Command Parameters Type
getState

TexasInstrumentsComponent


Commands

Command Parameters Type
getState

Oven


Commands

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

Notifications

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

States

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

WMBusComponent


Commands

Command Parameters Type
getState

MultiTariffThreePhaseEnergyMeter


Commands

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

Notifications

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

States

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

MultipleTemperatureSensor


Commands

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

Notifications

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

States

State StateValue RealValue
MultipleTemperatureState MultipleTemperatureStateValue (Measure)

ThreePhaseApparentPowerMeter


Commands

Command Parameters Type
getState
getApparentPower phaseID String

Notifications

Notification Parameters Type
newApparentPowerValue value Measure
phaseID String

States

State StateValue RealValue
ThreePhaseApparentPowerMeasurementState ApparentPowerStateValue (Measure)
PowerStateValue (Measure)

HealthTemperatureSensor


Commands

Command Parameters Type
storeGroup groupID Integer
deleteGroup groupID Integer
getTemperature
getState

Notifications

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

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)

ThreePhaseEnergyMeter


Commands

Command Parameters Type
getReactiveEnergyValue phaseID String
getActiveEnergyValue phaseID String
getState

Notifications

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

States

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

ShutterActuator


Commands

Command Parameters Type
up
getState
down
rest

Notifications

Notification Parameters Type
movingDown
restingUp
restingDown
movingUp
resting

States

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

FlashingLamp


Commands

Command Parameters Type
off
offFlashing
on
getState
onFlashing

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

HueBridge


Commands

Command Parameters Type
stopPushLinkAuth
startPushLinkAuth
getState

Notifications

Notification Parameters Type
activatedPushLinkAuth
deactivatedPushLinkAuth

States

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

EchelonNetworkComponent


Commands

Command Parameters Type
getState

WaterConsumptionMeter


Commands

Command Parameters Type
getAmountOfHotWaterInM3
getAmountOfColdWaterInM3
getState

Notifications

Notification Parameters Type
newHotWaterAmountInM3 m3OfHotWater Measure
newColdWaterAmountInM3 m3OfColdWater Measure

States

State StateValue RealValue
WaterMeasurementState ConsumedWaterStateValue (Measure)

KNXNetIPComponent


Commands

Command Parameters Type
getState

SmartWasteBin


Commands

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

Notifications

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

States

State StateValue RealValue
TemperatureState TemperatureStateValue (Measure)
FillLevelState LevelStateValue (Measure)

MicrowaveOven


Commands

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

Notifications

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

States

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

GasCooker


Commands

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

Notifications

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

States

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

LocalizationTag


Commands

Command Parameters Type
getState
getXYZLocation

Notifications

Notification Parameters Type
new3DLocationValue x Measure
y Measure
z Measure

States

State StateValue RealValue
XYZLocationState XYZLocationStateValue (Measure)

SceneSelector


Commands

Command Parameters Type
getState

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

ZigBeeComponent


Commands

Command Parameters Type
getState

ElectricalCooker


Commands

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

Notifications

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

States

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

CompositeThermostat


Commands

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

Notifications

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

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

OxyMeter


Commands

Command Parameters Type
getOxygenSaturationValue
getState

Notifications

Notification Parameters Type
newOxygenSaturationValue value Measure

States

State StateValue RealValue
OxygenSaturationMeasurementState OxygenSaturationStateValue (Measure)

PresenceAndMovementSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
isPresent
startedMovement
ceasedMovement
notPresent

States

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

GasoilHeater


Commands

Command Parameters Type
getState

Heater


Commands

Command Parameters Type
getState

Tv


Commands

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

Notifications

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

States

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

ThermostaticRadiatorValve


Commands

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

Notifications

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

States

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

ThermostatTemperatureSensor


Commands

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

Notifications

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

States

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

BluetoothComponent


Commands

Command Parameters Type
getState

ZWaveGateway


Commands

Command Parameters Type
associate
disassociate
getState

Notifications

Notification Parameters Type
disassociating
idle
associating

Wearable


Commands

Command Parameters Type
getState

ISMBUwbGateway


Commands

Command Parameters Type
getState

DimmerLamp


Commands

Command Parameters Type
set value Object
stepDown
off
stepUp
getState
on

Notifications

Notification Parameters Type
on
off
changedLevel newLevel Measure

States

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

AlarmClock


Commands

Command Parameters Type
getState

Acoustic


Commands

Command Parameters Type
getState

Fax


Commands

Command Parameters Type
getState

EnOceanGateway


Commands

Command Parameters Type
explicitTeachIn teachInData ExplicitTeachInData
smartTeachIn
getState
teachIn

Notifications

Notification Parameters Type
activatedTeachIn
deactivatedTeachIn

States

State StateValue RealValue
TeachInState IdleStateValue idle
TeachingInStateValue teachingIn

ShutterButton


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
pressedUp
pressedDown

States

State StateValue RealValue
UpDownRestState UpTripleStateValue up
DownTripleStateValue down
RestTripleStateValue rest

SmokeSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
off
on

States

State StateValue RealValue
SensingState DetectedStateValue detected
NotDetectedStateValue notDetected

Communication


Commands

Command Parameters Type
getState

TemperatureSensor


Commands

Command Parameters Type
getState

CC2650SensorTag


Commands

Command Parameters Type
getLuminance
getState
getTemperatureFrom sensorURI String
getPressure
on
getRelativeHumidity
off

Notifications

Notification Parameters Type
new3DGyroscopeValue gyroY Measure
gyroX Measure
gyroZ Measure
new3DAccelerationValue accZ Measure
accY Measure
accX Measure
released buttonID String
pressed buttonID String
changedTemperatureAt temperatureValue Measure
sensorID String
new3DMagnetometerValue magZ Measure
magY Measure
magX Measure
changedRelativeHumidity relativeHumidity Measure
newLuminosityValue luminosityValue Measure
newPressureValue pressureValue Measure

States

State StateValue RealValue
TridimensionalGyroscopeState GyroscopeStateValue (Measure)
LightIntensityState LevelStateValue (Measure)
MultipleTemperatureState MultipleTemperatureStateValue (Measure)
HumidityMeasurementState HumidityStateValue (Measure)
TridimensionalAccelerationState AccelerationStateValue (Measure)
TridimensionalMagnetometerState MagnetometerStateValue (Measure)
MultipleOnOffState OffStateValue off
OnStateValue on
PressureState PressureStateValue (Measure)

CC2650IRSensor


Commands

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

Notifications

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

States

State StateValue RealValue
MultipleTemperatureState MultipleTemperatureStateValue (Measure)

Siren


Commands

Command Parameters Type
on
getState
off

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
OnOffState OffStateValue off
OnStateValue on

CC2650HumiditySensor


Commands

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

Notifications

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

States

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

PelletHeater


Commands

Command Parameters Type
getState
standBy
on
off

Notifications

Notification Parameters Type
off
cool
heat
standby
firingUp
on

States

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

Knob


Commands

Command Parameters Type
set value Object
getState
stepDown
stepUp

Notifications

Notification Parameters Type
changedLevel newLevel Measure

States

State StateValue RealValue
LevelState LevelStateValue (Measure)

SinglePhaseElectricityMeter


Commands

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

Notifications

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

States

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

SinglePhaseCurrentMeter


Commands

Command Parameters Type
getElectricCurrentValue
getState

Notifications

Notification Parameters Type
newCurrentValue value Measure

States

State StateValue RealValue
SinglePhaseCurrentState CurrentStateValue (Measure)

CurrentMeter


Commands

Command Parameters Type
getState

InfraredSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
notDetected
detected

States

State StateValue RealValue
SensingState DetectedStateValue detected
NotDetectedStateValue notDetected

ZWaveComponent


Commands

Command Parameters Type
getState

ISMBUwbLocalizationComponent


Commands

Command Parameters Type
getState

FlowSensor


Commands

Command Parameters Type
getState

WindowActuator


Commands

Command Parameters Type
getState
open
close

Notifications

Notification Parameters Type
ceasedMovement
startedMovement
close
open

States

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

VoltageMeter


Commands

Command Parameters Type
getState

OccupancySensor


Commands

Command Parameters Type
getOccupancy
getState
storeGroup groupID Integer
deleteGroup groupID Integer

Notifications

Notification Parameters Type
isPresent
notPresent

States

State StateValue RealValue
OccupancyState FreeStateValue noPersonInside
OccupiedStateValue personInside

DoorSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
open
close

States

State StateValue RealValue
OpenCloseState CloseStateValue close
OpenStateValue open

OnOffOutput


Commands

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

Notifications

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

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

TexasInstrumentsGateway


Commands

Command Parameters Type
getState

EnergyAndPowerMeter


Commands

Command Parameters Type
getActiveEnergyValue
getActivePower
getState
getReactiveEnergyValue

Notifications

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

States

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

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)
PowerStateValue (Measure)

MultiTariffEnergyMeter


Commands

Command Parameters Type
getState

ThreePhaseCurrentMeter


Commands

Command Parameters Type
getElectricCurrentValue phaseID String
getState

Notifications

Notification Parameters Type
newCurrentValue value Measure
phaseID String

States

State StateValue RealValue
ThreePhaseCurrentState CurrentStateValue (Measure)

Button


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
released
pressed

States

State StateValue RealValue
OnOffState OnStateValue on
OffStateValue off

MultiTariffSinglePhaseEnergyMeter


Commands

Command Parameters Type
getReactiveEnergyValue tariffID String
getActiveEnergyValue tariffID String
getState

Notifications

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

States

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

ThreePhaseElectricityMeter


Commands

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

Notifications

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

States

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

GasSensor


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off

States

State StateValue RealValue
SensingState DetectedStateValue detected
NotDetectedStateValue notDetected

DimmerSwitch


Commands

Command Parameters Type
getState

Notifications

Notification Parameters Type
on
off
stepUp
stepDown
changedLevel newLevel Measure

States

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

WashingMachine


Commands

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

Notifications

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

States

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

PowerMeter


Commands

Command Parameters Type
getState