|
|
|
|
|
Interfaces for controlling different types of sensors and actuators, such as smoke and motion detectors, dimmers, meters etc.
BinarySensor
The BinarySensor (com.prosyst.mbs.services.hdm.deviceclasses.BinarySensor) represents an abstract sensor with only two possible states (it either detects something or it doesn't). The interface is mapped to many devices with many different purposes: fire, smoke and motion detectors, door and window sensors etc.
Properties
Property |
Meta Data |
|
|---|---|---|
state |
description |
Binary sensor state. Value "true" denotes that something is detected. |
access |
RE |
|
enum |
Detected: "true"; Not Detected: "false" |
|
MultiLevelSensor
The MultiLevelSensor (com.prosyst.mbs.services.hdm.deviceclasses.MultiLevelSensor) represents an abstract sensor. The interface is mapped to devices for measuring temperature, air pressure, humidity etc.
Properties
Property |
Meta Data |
|
|---|---|---|
value |
description |
Current value of the multi-level sensor. |
access |
RE |
|
AlarmSensor
The AlarmSensor (com.prosyst.mbs.services.hdm.deviceclasses.AlarmSensor) represents an abstract sensor which issues alarm notifications.
Properties
Property |
Meta Data |
|
|---|---|---|
alarm
|
description |
Alarm sensor event. |
access |
E |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
getSeverity |
description |
Read the severity according to alarm type. |
IN1 |
The alarm type. |
|
OUT |
The severity. |
|
MotionSensor
The MotionSensor (com.prosyst.mbs.services.hdm.deviceclasses.MotionSensor) represents a sensor for detecting motion with adjustable sensitivity level.
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Motion sensor state. Value true denotes that motion is detected. |
access |
RE |
|
enum |
Motion Detected: "true"; No Motion: "false" |
|
resetPeriod
|
description |
Motion sensor reset period. |
access |
RWE |
|
unit |
seconds |
|
sensitivityLevel
|
description |
Motion sensor sensitivity level. |
access |
RWE |
|
unit |
% |
|
min |
0 |
|
max |
100 |
|
step |
1 |
|
WindSensor
The WindSensor (com.prosyst.mbs.services.hdm.deviceclasses.WindSensor) represents a sensor that measures the speed and the direction of the wind.
Properties
Property |
Meta Data |
|
|---|---|---|
windSpeed
|
description |
The wind speed. |
access |
RE |
|
unit |
m/s |
|
windDirection
|
description |
The wind direction. |
access |
RE |
|
unit |
degrees |
|
min |
0 |
|
max |
360 |
|
step |
1 |
|
Meter
The Meter (com.prosyst.mbs.services.hdm.deviceclasses.Meter) represents a device that measures the amount of consumed energy in the household. The interface can be mapped to:
Properties
Property |
Meta Data |
|
|---|---|---|
current
|
description |
Current measuring. |
access |
RE |
|
total
|
description |
Total measuring. |
access |
RE |
|
Operations
Operation |
Description |
|
|---|---|---|
resetTotal |
description |
Resets total measuring. |
MeterV2
The MeterV2 (com.prosyst.mbs.services.hdm.deviceclasses.MeterV2) represents a more advanced meter that is capable of taking into account different energy price rate.
Properties
Parameter |
Description |
|
|---|---|---|
flow
|
description |
The direction of the energy that is being measured (consumed/produced). |
access |
R |
|
current
|
description |
Eventable property for current measuring. |
access |
RE |
|
total
|
description |
Eventable property for total measuring. |
access |
RE |
|
Operations
Operations |
Meta Data |
|
|---|---|---|
readCurrent
|
description |
Read the current measuring according to specific tariff ID. |
IN1 |
The tariff ID. |
|
OUT |
The current measuring according to the tariff ID. |
|
readTotal
|
description |
Read the total measuring according to specific tariff ID. |
IN1 |
The tariff ID. It must not be specified if the total measuring for all tariffs has to be received. |
|
OUT |
The total measuring according to the tariff ID. |
|
Tariff
The Tariff (com.prosyst.mbs.services.hdm.deviceclasses.Tariff) represents the capability of a device of switching between different price rates.
Properties
Property |
Meta Data |
|
|---|---|---|
currentTariffID
|
description |
Current tariff ID. |
access |
RE |
|
tariffs
|
description |
Information of all supported tariffs. |
access |
RE |
|
BinarySwitch
The BinarySwitch (com.prosyst.mbs.services.hdm.deviceclasses.BinarySwitch) represents an On/Off switch.
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Binary switch state. Value 0 denotes that switch is off. Value 1 denotes that switch is on. |
access |
RE |
|
enum |
Switched Off: "0"; Switched On: "1" |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
turnOn |
description |
Turns on the binary switch. |
turnOff |
description |
Turns off the binary switch. |
toggle |
description |
Toggles the current state of the binary switch. |
MultiLevelSwitch
The MultiLevelSwitch (com.prosyst.mbs.services.hdm.deviceclasses.MultiLevelSwitch) represents an abstract Actuator which supports several states (levels). The interface is mapped to light dimmers.
Properties
Property |
Meta Data |
|
|---|---|---|
step
|
description |
Multi-level switch step. |
access |
RE |
|
level
|
description |
Multi-level switch level. |
access |
RWE |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
stepUp |
description |
Move the level with one step up. |
stepDown |
description |
Move the level with one step down. |
TemperatureActuator
The TemperatureActuator (com.prosyst.mbs.services.hdm.deviceclasses.TemperatureActuator) is an interface for controlling the temperature in a room. The temperature can be changed instantly or can be increased or decreased with a predefined number.
Properties
Parameter |
Description |
|
|---|---|---|
temperature
|
description |
Property used for target temperature. |
access |
RWE |
|
unit |
C |
|
step
|
description |
Property used for target temperature step. |
access |
RWE |
|
unit |
C |
|
min |
0 |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
stepUp |
description |
Increase the target temperature with one temperature step. |
stepDown |
description |
Decrease the target temperature with one temperature step. |
changeTemperature
|
description |
Change the target temperature. |
IN1 |
The target temperature will be changed with this value. If the value is positive, the target temperature will be increased. If the value is negative, the target temperature will be decreased. The unit of the value has to be the same as unit of the target temperature. |
|
DoorActuator
The DoorActuator (com.prosyst.mbs.services.hdm.deviceclasses.DoorActuator) represents an automatic door lock system with capabilities of locking and unlocking the door remotely.
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property used for door state. Value 0 indicates that door is locked. Value 1 indicates that door is unlocked. Value 2 indicates that door is jammed. Value 3 indicates that door is forced open. Value 4 indicates that door is in unspecified state. |
access |
RE |
|
enum |
Locked: "0"; Unlocked: "1"; Jammed: "2"; Forced Open: "3"; Unspecified: "4" |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
lock |
description |
Forces the door actuator to lock the door. |
unlock |
description |
Forces the door actuator to unlock the door. |
Key
The Key (com.prosyst.mbs.services.hdm.deviceclasses.Key) represents the capabilities of an electronic key. The properties of this interface are not accessible. They are used only as placeholders for events.
Properties
Property |
Meta Data |
|
|---|---|---|
mode
|
description |
Property for key mode. Value 0 indicates that key is working in normal mode. Value 1 indicates that key is working in learning mode. |
access |
RWE |
|
enum |
Normal: "0"; Learning: "1" |
|
event.pressed
|
description |
Property used for notification when the key is pressed. Value of the event is always true. |
access |
E |
|
event.released
|
description |
Property used for notification when the key is released. Value of the event is always true. |
access |
E |
|
event.pressed.short
|
description |
Property used for notification when the key is pressed for a short period of time. Value of the event is always true. |
access |
E |
|
event.pressed.long
|
description |
Property used for notification when the key is pressed for a long period of time. Value of the event is always true. |
access |
E |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
press |
description |
Pressing the key. |
release |
description |
Releasing the key. |
pressShort |
description |
Pressing the key for short time. |
pressLong |
description |
Pressing the key for long time. |
SceneActuator
The SceneActuator (com.prosyst.mbs.services.hdm.deviceclasses.SceneActuator) represents a device for starting and stopping scenes.
Properties
Parameter |
Description |
|
|---|---|---|
scenes
|
description |
Property used for the scene IDs. |
access |
RE |
|
Operations
Operation |
Meta Data |
|
|---|---|---|
getScene
|
description |
Get scene. |
IN1 |
Scene ID. |
|
OUT |
Scene raw data. |
|
start
|
description |
Start scene. |
IN1 |
Scene ID. |
|
stop
|
description |
Stop scene. |
IN1 |
Scene ID. |
|
pause
|
description |
Pause scene. |
IN1 |
Scene ID. |
|
add
|
description |
Add scene. |
IN1 |
Scene ID. |
|
IN2 |
Scene raw data. |
|
remove
|
description |
Remove scene. |
IN1 |
Scene ID. |
|
WindowActuator
The WindowActuator (com.prosyst.mbs.services.hdm.deviceclasses.WindowActuator) represents a device for opening and closing windows.
Properties
Property |
Meta Data |
|
|---|---|---|
state
|
description |
Property used for window state. |
access |
RE |
|
enum |
Closed: "0"; Opened: "1"; Jammed: "2"; Forced Open: "3"; Unspecified: "4" |
|
Operations
Parameter |
Description |
|
|---|---|---|
open |
description |
Forces the window actuator to open the window. |
close |
description |
Forces the window actuator to close the window. |
Blinds
The Blinds (com.prosyst.mbs.services.hdm.deviceclasses.Blinds) interface represents a device for controlling the movement and angle of blinds.
Properties
Property |
Meta Data |
|
|---|---|---|
level
|
description |
Property used for blinds level. |
access |
RWE |
|
unit |
% |
|
min |
0 |
|
max |
100 |
|
step |
1 |
|
angle
|
description |
Property used for blinds angle. |
access |
RWE |
|
unit |
degrees |
|
min |
0 |
|
max |
180 |
|
step |
10 |
|
movementState
|
description |
Property used for blinds movement state. Value "0" indicates that blinds are not moving. Value "1" indicates that blinds are moving up. Value "2" indicates that blinds are moving down. |
access |
RE |
|
enum |
Not Moving: "0"; Moving Up: "1"; Moving Down: "2" |
|
Operations
Parameter |
Description |
|
|---|---|---|
startUpMovement |
description |
Forces the blinds to start up movement. |
startDownMovement |
description |
Forces the blinds to start down movement. |
stopMovement |
description |
Stops the movement of the blinds. |