|
|
|
|
|
Interfaces that allow you to perform administration tasks on various kinds of devices: checking their battery level and connection quality, resetting them, putting them to sleep etc.
NetworkController
NetworkController (com.prosyst.mbs.services.hdm.deviceclasses.NetworkController) is an interface for controlling a network controller.
A network controller (also called network coordinator) is a device which provides access to a home protocol network and allows you to add and remove devices from it.
Properties
Property |
Meta Data |
|
|---|---|---|
mode |
description |
The network controller mode. |
access |
RWE |
|
NetworkControllerExt
NetworkControllerExt (com.prosyst.mbs.services.hdm.deviceclasses.NetworkControllerExt) is an interface for controlling a more advanced type of network controller.
Properties
Parameter |
Description |
|
|---|---|---|
mode
|
description |
The network controller mode. Value 1 indicates normal mode. Value 2 indicates pairing mode. Value 3 indicates removing mode. |
access |
RWE |
|
enum |
Normal: 1; Pairing: 2; Removing: 3 |
|
modeRemainingTime
|
description |
The network controller mode remaining time. Value -1 indicates infinite remaining time. |
access |
RE |
|
unit |
ms |
|
min |
-1 |
|
Operations
Property |
Meta Data |
|
|---|---|---|
getModeDuration |
description |
Get the network controller mode duration. Value 0 indicates infinite duration. Value -1 indicates that the mode has no duration. |
IN1 |
The requested mode. Normal model has value 1. Pairing mode has value 2. Removing mode has value 3. |
|
OUT |
The mode duration in milliseconds. |
|
setModeDuration
|
description |
Set the network controller mode duration. |
IN1 |
The requested mode. Normal mode has value 1. Pairing mode has value 2. Removing mode has value 3. |
|
IN2 |
The new duration of the network controller mode in milliseconds. Duration 0 indicates infinite duration. Duration -1 indicates that the mode has no duration. |
|
reset |
description |
Reset the network controller. |
BatteryLevel
BatteryLevel (com.prosyst.mbs.services.hdm.deviceclasses.BatteryLevel) provides information about the battery level of a device.
Properties
Property |
Meta Data |
|
|---|---|---|
batteryLevel
|
description |
Current battery level. |
access |
RE |
|
unit |
% |
|
min |
0 |
|
max |
100 |
|
step |
1 |
|
lowBattery
|
description |
Indicates if the battery is low. Value true denotes low battery. |
access |
RE |
|
enum |
Low Battery: true; No Low Battery: false |
|
QualityOfService
QualityOfService (com.prosyst.mbs.services.hdm.deviceclasses.QualityOfService) provides information about the quality of the connection to the device.
Properties
Property |
Meta Data |
|
|---|---|---|
lastCommunicationTime |
description |
The last communication time with the device. |
access |
RE |
|
linkQuality
|
description |
The link quality to the device. |
access |
RE |
|
unit |
% |
|
min |
0 |
|
max |
100 |
|
rssi
|
description |
Current value of the received signal strength indicator. |
access |
RE |
|
unit |
dBm |
|
Reset
Reset (com.prosyst.mbs.services.hdm.deviceclasses.Reset) represents the capability of a device to reset itself.
Properties
Property |
Meta Data |
|
|---|---|---|
reset |
description |
Performs a factory reset on the home device. The device will not be removed from HDM. |
Identifier
Identifier (com.prosyst.mbs.services.hdm.deviceclasses.Identifier) represents the capability of a device to identify itself (for example by a light or sound signal), so it can be found among other similar devices.
Operations
Property |
Meta Data |
|
|---|---|---|
identify |
description |
Identifies the physical device. |
StandBy
StandBy (com.prosyst.mbs.services.hdm.deviceclasses.StandBy) represents the capability of a device (usually a sensor) to save energy by becoming unresponsive for a certain period of time.
Properties
Property |
Meta Data |
|
|---|---|---|
mode |
description |
Property for stand-by mode. Value true indicates that mode is stand-by. |
access |
RE |
|
enum |
StandBy: true; Not StandBy: false |
|
WakeUp
WakeUp (com.prosyst.mbs.services.hdm.deviceclasses.WakeUp) represents a more advanced type of a standby sensor.
Properties
Property |
Meta Data |
|
|---|---|---|
awake |
description |
Property used for notification when the sensor is awake. The value of this property is always true. |
access |
E |
|
wakeUpInterval
|
description |
Wake up interval. |
access |
RWE |
|
unit |
ms |
|
min |
0 |
|
Operations
Property |
Meta Data |
|
|---|---|---|
goToSleep |
description |
Forces the sensor to go back to sleep. |