public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve javadoc for all addons (#15667)

Browse Source 
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-09-30 21:49:12 +02:00
committed by GitHub
parent 0039e391cd
commit cbf4411034
618 changed files with 1106 additions and 1110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/BridgeMDNSDiscoveryParticipant.java
View File

@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
/**
* The {@link BridgeMDNSDiscoveryParticipant} is responsible for discovering digitalSTROM-Server. It uses the central
* {@link MDNSDiscoveryService}.
* {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

8
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DeviceDiscoveryService.java
View File

@@ -39,7 +39,7 @@ import org.slf4j.LoggerFactory;
* The {@link DeviceDiscoveryService} discovers all digitalSTROM-Devices, of one supported device-color-type. The
* device-color-type has to be given to the {@link #DeviceDiscoveryService(BridgeHandler, ThingTypeUID)} as
* {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at
* {@link DeviceHandler#SUPPORTED_THING_TYPES}.
* {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler#SUPPORTED_THING_TYPES}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
@@ -170,7 +170,8 @@ public class DeviceDiscoveryService extends AbstractDiscoveryService {
}
/**
* Removes the {@link Thing} of the given {@link Device}.
* Removes the {@link org.openhab.core.thing.Thing} of the given
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}.
*
* @param device (must not be null)
*/
@@ -184,7 +185,8 @@ public class DeviceDiscoveryService extends AbstractDiscoveryService {
/**
* Creates a {@link DiscoveryResult} for the given {@link Device}, if the {@link Device} is supported and the
* {@link Device#getOutputMode()} is unequal {@link OutputModeEnum#DISABLED}.
* {@link Device#getOutputMode()} is unequal
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#DISABLED}.
*
* @param device (must not be null)
*/

5
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DiscoveryServiceManager.java
View File

@@ -60,8 +60,9 @@ public class DiscoveryServiceManager
/**
* Creates a new {@link DiscoveryServiceManager} and generates automatically all {@link SceneDiscoveryService}s and
* {@link DeviceDiscoveryService}s for all supported {@link ThingType}s of the {@link DeviceHandler} and
* {@link SceneHandler}.
* {@link org.openhab.binding.digitalstrom.internal.discovery.DeviceDiscoveryService}s for all supported
* {@link org.openhab.core.thing.type.ThingType}s of the
* {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler} and {@link SceneHandler}.
*
* @param bridgeHandler (must not be null)
*/

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/SceneDiscoveryService.java
View File

@@ -38,7 +38,8 @@ import org.slf4j.LoggerFactory;
/**
* The {@link SceneDiscoveryService} discovers all digitalSTROM-scene of one supported scene-type. The scene-type has to
* be given to the {@link #SceneDiscoveryService(BridgeHandler, ThingTypeUID)} as
* {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at {@link SceneHandler#SUPPORTED_THING_TYPES}
* {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID}
* can be found at {@link org.openhab.binding.digitalstrom.internal.handler.SceneHandler#SUPPORTED_THING_TYPES}
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

6
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/ZoneTemperatureControlDiscoveryService.java
View File

@@ -34,8 +34,10 @@ import org.slf4j.LoggerFactory;
/**
* The {@link ZoneTemperatureControlDiscoveryService} discovers all digitalSTROM zones which have temperature control
* configured. The thing-type has to be given to the
* {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as {@link ThingTypeUID}. The supported
* {@link ThingTypeUID} can be found at {@link ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES}
* {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as
* {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID}
* can be found at
* {@link org.openhab.binding.digitalstrom.internal.handler.ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES}
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java
View File

@@ -24,7 +24,8 @@ import com.google.gson.JsonObject;
/**
* The {@link SensorValues} acts as container for the digitalSTROM json-method <i>getSensorValues</i>. So the
* {@link SensorValues} contains all {@link CachedSensorValue}s of a zone.
* {@link SensorValues} contains all
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s of a zone.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

43
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java
View File

@@ -119,7 +119,9 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the refenceZone, if control-mode is {@link ControlModes#ZONE_FOLLOWER}, otherwise null.
* Returns the refenceZone, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#ZONE_FOLLOWER}, otherwise
* null.
*
* @return the referenceZone
*/
@@ -128,7 +130,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlOffset, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlOffset, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlOffset
*/
@@ -137,7 +140,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the manualValue, if control-mode is {@link ControlModes#MANUAL}, otherwise null.
* Returns the manualValue, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#MANUAL}, otherwise null.
*
* @return the manualValue
*/
@@ -146,7 +150,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the emergencyValue, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the emergencyValue, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the emergencyValue
*/
@@ -155,7 +160,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlKp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlKp, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlKp
*/
@@ -164,7 +170,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlTs, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlTs, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlTs
*/
@@ -173,7 +180,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlTi, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlTi, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlTi
*/
@@ -182,7 +190,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlKd, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlKd, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlKd
*/
@@ -191,7 +200,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlImin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlImin, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlImin
*/
@@ -200,7 +210,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlImax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlImax, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlImax
*/
@@ -209,7 +220,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlYmin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlYmin, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlYmin
*/
@@ -218,7 +230,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlYmax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlYmax, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlYmax
*/
@@ -227,7 +240,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlAntiWindUp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlAntiWindUp, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlAntiWindUp
*/
@@ -236,7 +250,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
}
/**
* Returns the ctrlKeepFloorWarm, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
* Returns the ctrlKeepFloorWarm, if control-mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlKeepFloorWarm
*/

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java
View File

@@ -80,7 +80,7 @@ public class TemperatureControlValues extends BaseZoneIdentifier {
}
/**
* @see TemperatureControlStatus#getControlDSUID()
* @see org.openhab.binding.digitalstrom.internal.lib.climate.jsonresponsecontainer.impl.TemperatureControlStatus#getControlDSUID()
* @return the controlDSUID
*/
public String getControlDSUID() {
@@ -88,7 +88,7 @@ public class TemperatureControlValues extends BaseZoneIdentifier {
}
/**
* @see TemperatureControlStatus#getIsConfigured()
* @see org.openhab.binding.digitalstrom.internal.lib.serverconnection.constants.JSONApiResponseKeysEnum#IS_CONFIGURED
* @return the isConfigured
*/
public Boolean getIsConfigured() {

5
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/WeatherSensorData.java
View File

@@ -26,8 +26,9 @@ import com.google.gson.JsonObject;
/**
* The {@link WeatherSensorData} acts as container for the digitalSTROM json-method <i>getSensorValues</i>. The
* {@link WeatherSensorData} contains all {@link CachedSensorValue}s and weather service information of the
* digitalSTROM-server, if a weather service is set.
* {@link WeatherSensorData} contains all
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s and weather service
* information of the digitalSTROM-server, if a weather service is set.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

68
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/config/Config.java
View File

@@ -27,7 +27,7 @@ public class Config {
*/
public static final String DEFAULT_APPLICATION_NAME = "openHAB";
/**
* Defines the used tread pool name to get a thread pool from {@link ThreadPoolManager}.
* Defines the used tread pool name to get a thread pool from {@link org.openhab.core.common.ThreadPoolManager}.
*/
public static final String THREADPOOL_NAME = "digitalSTROM";
@@ -110,7 +110,9 @@ public class Config {
private int totalPowerUpdateInterval = DEFAULT_TOTAL_POWER_UPDATE_INTERVAL;
/**
* Default time to wait between another {@link SensorJob} can be executed on a circuit.
* Default time to wait between another
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
* can be executed on a circuit.
*/
public static final int DEFAULT_SENSOR_READING_WAIT_TIME = 60000;
private int sensorReadingWaitTime = DEFAULT_SENSOR_READING_WAIT_TIME;
@@ -135,11 +137,13 @@ public class Config {
// max sensor reading cyclic to wait
/**
* The default factor to prioritize medium {@link SensorJob}s down.
* The default factor to prioritize medium
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s down.
*/
public static final long DEFAULT_MEDIUM_PRIORITY_FACTOR = 5;
/**
* The default factor to prioritize low {@link SensorJob}s down.
* The default factor to prioritize low
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s down.
*/
public static final long DEFAULT_LOW_PRIORITY_FACTOR = 10;
@@ -147,13 +151,16 @@ public class Config {
private long lowPriorityFactor = DEFAULT_LOW_PRIORITY_FACTOR;
/**
* Defines the event polling interval of the {@link EventListener} in milliseconds.
* Defines the event polling interval of the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener} in milliseconds.
*/
private int eventListenerRefreshinterval = DEFAULT_POLLING_FREQUENCY;
/**
* The default max standby active power for a device. It's needed to set a {@link Device} with output mode
* {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode.
* The default max standby active power for a device. It's needed to set a
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE}
* on if it isen't any more in standby mode.
*/
public static final int DEFAULT_STANDBY_ACTIVE_POWER = 2;
@@ -350,7 +357,8 @@ public class Config {
}
/**
* Sets the SSL-Certificate of the server, will be set automatically by the {@link HttpTransportImpl} if no
* Sets the SSL-Certificate of the server, will be set automatically by the
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.impl.HttpTransportImpl} if no
* SSL-Certification path is set.
*
* @param cert of the digitalSTROM-Server to set
@@ -461,7 +469,9 @@ public class Config {
}
/**
* Returns the time in milliseconds to wait between another {@link SensorJob} can be executed on a circuit.
* Returns the time in milliseconds to wait between another
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
* can be executed on a circuit.
*
* @return the sensor reading wait time in milliseconds
*/
@@ -470,7 +480,9 @@ public class Config {
}
/**
* Sets the time in milliseconds to wait between another {@link SensorJob} can be executed on a circuit.
* Sets the time in milliseconds to wait between another
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
* can be executed on a circuit.
*
* @param sensorReadingWaitTime in milliseconds
*/
@@ -479,7 +491,9 @@ public class Config {
}
/**
* Returns the factor to prioritize medium {@link SensorJob}s in the {@link SensorJobExecutor} down.
* Returns the factor to prioritize medium
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s
* in the {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down.
*
* @return the medium priority factor
*/
@@ -488,7 +502,9 @@ public class Config {
}
/**
* Sets the factor to prioritize medium {@link SensorJob}s in the {@link SensorJobExecutor} down.
* Sets the factor to prioritize medium
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down.
*
* @param mediumPriorityFactor to set
*/
@@ -497,7 +513,9 @@ public class Config {
}
/**
* Returns the factor to prioritize low {@link SensorJob}s in the {@link SensorJobExecutor} down.
* Returns the factor to prioritize low
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down.
*
* @return the low priority factor
*/
@@ -506,7 +524,9 @@ public class Config {
}
/**
* Sets the factor to prioritize low {@link SensorJob}s in the {@link SensorJobExecutor}down.
* Sets the factor to prioritize low
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}down.
*
* @param lowPriorityFactor to set
*/
@@ -515,7 +535,9 @@ public class Config {
}
/**
* Returns the polling interval in milliseconds to poll the {@link Event}s in the {@link EventListener}.
* Returns the polling interval in milliseconds to poll the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}s in the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*
* @return the EventListener refresh interval in milliseconds
*/
@@ -524,7 +546,9 @@ public class Config {
}
/**
* Sets the polling interval in milliseconds to poll the {@link Event}s in the {@link EventListener}.
* Sets the polling interval in milliseconds to poll the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}s in the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*
* @param eventListenerRefreshinterval to set
*/
@@ -533,8 +557,10 @@ public class Config {
}
/**
* Returns the max standby active power for a device. It's needed to set a {@link Device} with output mode
* {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode.
* Returns the max standby active power for a device. It's needed to set a
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE}
* on if it isen't any more in standby mode.
*
* @return the standby active power
*/
@@ -543,8 +569,10 @@ public class Config {
}
/**
* Sets the max standby active power for a device. It's needed to set a {@link Device} with output mode
* {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode.
* Sets the max standby active power for a device. It's needed to set a
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE}
* on if it isen't any more in standby mode.
*
* @param standbyActivePower to set
*/

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventHandler.java
View File

@@ -19,7 +19,8 @@ import org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem;
/**
* The {@link EventHandler} can be implemented to get informed by {@link EventItem}'s through the {@link EventListener}.
* <br>
* For that the {@link #getSupportetEvents()} and {@link #supportsEvent(String)} methods have to be implemented, so that
* For that the {@link #getSupportedEvents()} and
* {@link #supportsEvent(String)} methods have to be implemented, so that
* the {@link EventListener} knows whitch events it has to subscribe at the digitalSTROM-server and which handler has
* to be informed. <br>
* The implementation of the {@link EventHandler} also has to be registered through

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventListener.java
View File

@@ -46,7 +46,8 @@ import com.google.gson.JsonObject;
* {@link EventHandler} needs to be informed of another event-type, you can use the methods
* {@link #addSubscribe(String)} or {@link #addSubscribeEvents(List)} to add more than one event-type. To remove a
* subscribed event you can use the method {@link #removeSubscribe(String, String)}, you also have to change the return
* of the {@link EventHandler} methods {@link EventHandler#getSupportetEvents()} and
* of the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventHandler} methods
* {@link EventHandler#getSupportedEvents()} and
* {@link EventHandler#supportsEvent(String)}.
* <br>
* To start and stop the listening you have to call the methods {@link #start()} and {@link #stop()}.

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java
View File

@@ -33,7 +33,7 @@ public interface EventItem {
String getName();
/**
* Returns {@link HashMap} with the properties fiels of this {@link EventItem}.
* Returns {@link java.util.HashMap} with the properties fiels of this {@link EventItem}.
* The key is an {@link EventResponseEnum} and represents the property name
* and the value is the property value.
*
@@ -42,7 +42,7 @@ public interface EventItem {
Map<EventResponseEnum, String> getProperties();
/**
* Returns {@link HashMap} with the source fields of this {@link EventItem}.
* Returns {@link java.util.HashMap} with the source fields of this {@link EventItem}.
* The key is an {@link EventResponseEnum} and represents the property name
* and the value is the property value.
*

23
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java
View File

@@ -17,15 +17,21 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.devicepar
import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.ChangeableDeviceConfigEnum;
/**
* The {@link DeviceStatusListener} is notified, if a {@link Device} status or configuration has changed, if a scene
* configuration is added to a {@link Device} or if a device has been added or removed. The {@link DeviceStatusListener}
* can be also registered by a {@link Circuit} to get informed by configuration or status changes.
* The {@link DeviceStatusListener} is notified, if a
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} status or configuration has changed,
* if a scene configuration is added to a {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
* or if a device has been added or removed. The {@link DeviceStatusListener}
* can be also registered by a {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Circuit}
* to get informed by configuration or status changes.
* <p>
* By implementation with the id {@link #DEVICE_DISCOVERY} this listener can be used as a device discovery to get
* informed, if a new {@link Device} or {@link Circuit} is added or removed from the digitalSTROM-System.<br>
* informed, if a new {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} or
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Circuit} is added or removed from the
* digitalSTROM-System.<br>
* For that the {@link DeviceStatusListener} has to be registered on the
* {@link DeviceStatusManager#registerDeviceListener(DeviceStatusListener)}. Then the {@link DeviceStatusListener} gets
* informed by the methods {@link #onDeviceAdded(Object)} and {@link #onDeviceRemoved(Object)}.
* {@link org.openhab.binding.digitalstrom.internal.lib.manager.DeviceStatusManager#registerDeviceListener(DeviceStatusListener)}.
* Then the {@link DeviceStatusListener} gets informed by the methods {@link #onDeviceAdded(GeneralDeviceInformation)}
* and {@link #onDeviceRemoved(GeneralDeviceInformation)}.
* </p>
*
* @author Michael Ochel - Initial contribution
@@ -40,8 +46,9 @@ public interface DeviceStatusListener {
static final String DEVICE_DISCOVERY = "DeviceDiscovery";
/**
* This method is called whenever the state of the {@link Device} has changed and passes the new device state as an
* {@link DeviceStateUpdate} object.
* This method is called whenever the state of the
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} has changed and passes the new
* device state as an {@link DeviceStateUpdate} object.
*
* @param deviceStateUpdate new device status
*/

5
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SceneStatusListener.java
View File

@@ -22,8 +22,9 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalSce
* By implementation with the id {@link #SCENE_DISCOVERY} this listener can be used as a scene discovery to get
* informed, if a new {@link InternalScene}s is added or removed from the digitalSTROM-System.<br>
* For that the {@link SceneStatusListener} has to be registered on the
* {@link SceneManager#registerSceneListener(SceneStatusListener)}. Then the {@link SceneStatusListener} gets
* informed by the methods {@link #onSceneAdded(InternalScene)} and {@link #onSceneRemoved(InternalScene)}.
* {@link org.openhab.binding.digitalstrom.internal.lib.manager.SceneManager#registerSceneListener(SceneStatusListener)}.
* Then the {@link SceneStatusListener} gets informed by the methods {@link #onSceneAdded(InternalScene)} and
* {@link #onSceneRemoved(InternalScene)}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SystemStateChangeListener.java
View File

@@ -14,7 +14,9 @@ package org.openhab.binding.digitalstrom.internal.lib.listener;
/**
* The {@link SystemStateChangeListener} can be implemented to get informed by digitalSTROM system state changes. It
* has to be registered by supported classes, e.g. the {@link TemperatureControlManager} or self implemented classes.
* has to be registered by supported classes, e.g. the
* {@link org.openhab.binding.digitalstrom.internal.lib.manager.impl.TemperatureControlManager}
* or self implemented classes.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

24
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java
View File

@@ -30,10 +30,13 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalSce
* The {@link DeviceStatusManager} is responsible for the synchronization between the internal model of the
* digitalSTROM-devices and the real existing digitalSTROM-devices. You can change the state of a device by sending a
* direct command to the devices or by calling a scene. Furthermore the {@link DeviceStatusManager} get informed over
* the {@link SceneManager} by the {@link EventListener} if scenes are called by external sources. All
* the {@link SceneManager} by the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}
* if scenes are called by external sources. All
* configurations of the physically device will be synchronized to the internally managed model and updated as required.
* The {@link DeviceStatusManager} also initializes {@link SensorJob}'s with the {@link SensorJobExecutor} and
* {@link SceneReadingJobExecutor} to update required sensor and scene data.
* The {@link DeviceStatusManager} also initializes {@link SensorJob}'s with the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} to update required
* sensor and scene data.
*
* <p>
* Therefore the {@link DeviceStatusManager} uses the {@link StructureManager} for the internal management of the
@@ -67,14 +70,18 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalSce
public interface DeviceStatusManager extends EventHandler {
/**
* Starts the working process for device synchronization. It also starts the {@link SensorJobExecutor} and the
* {@link SceneReadingJobExecutor} and the {@link SceneManager}.
* Starts the working process for device synchronization. It also starts the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor}
* and the {@link SceneManager}.
*/
void start();
/**
* Stops the working process for device synchronization. It also stops the {@link SensorJobExecutor} and the
* {@link SceneReadingJobExecutor} and the {@link SceneManager}.
* Stops the working process for device synchronization. It also stops the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} and the
* {@link SceneManager}.
*/
void stop();
@@ -119,7 +126,8 @@ public interface DeviceStatusManager extends EventHandler {
void updateSensorData(SensorJob sensorJob, String priority);
/**
* This method adds a {@link SensorJob} with the appropriate priority to the {@link SceneReadingJobExecutor}.
* This method adds a {@link SensorJob} with the appropriate priority to the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor}.
*
* @param device device which will update scene data
* @param deviceStateUpdate scene data to update

17
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/SceneManager.java
View File

@@ -36,8 +36,8 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalSce
* , {@link #callDeviceScene(String, Short)} etc. can be used.
*
* <p>
* If you call the {@link #start()} method an {@link EventListener} will be started to handle scene calls and undos from
* the outside.
* If you call the {@link #start()} method an {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}
* will be started to handle scene calls and undos from the outside.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
@@ -131,7 +131,8 @@ public interface SceneManager extends EventHandler {
void addInternalScene(InternalScene intScene);
/**
* Adds the scene call with the given dSID and sceneId as an echo to ignore them by detecting the {@link EventItem}.
* Adds the scene call with the given dSID and sceneId as an echo to ignore them by detecting the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}.
*
* @param dSID of the {@link Device} that will be ignored
* @param sceneId of the scene that will be ignored
@@ -139,7 +140,8 @@ public interface SceneManager extends EventHandler {
void addEcho(String dSID, short sceneId);
/**
* Adds the scene call with the given internal scene id as an echo to ignore them by detecting the {@link EventItem}
* Adds the scene call with the given internal scene id as an echo to ignore them by detecting the
* {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}
* .
*
* @param internalSceneID to ignore
@@ -167,7 +169,8 @@ public interface SceneManager extends EventHandler {
void generateScenes();
/**
* Will be called from the {@link SceneDiscovery}, if a scene type is generated or is fail.<br>
* Will be called from the {@link org.openhab.binding.digitalstrom.internal.lib.structure.scene.SceneDiscovery},
* if a scene type is generated or is fail.<br>
* For that the scenesGenerated char array has four chars. Each char represents one scene type in the following
* direction:
* <ul>
@@ -191,12 +194,12 @@ public interface SceneManager extends EventHandler {
boolean isDiscoveryRegistrated();
/**
* Starts the {@link EventListener}.
* Starts the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*/
void start();
/**
* Stops the {@link EventListener}.
* Stops the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*/
void stop();

5
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/StructureManagerImpl.java
View File

@@ -71,8 +71,9 @@ public class StructureManagerImpl implements StructureManager {
}
/**
* Query to get all zone and group names. Can be executed with {@link DsAPI#query(String, String)} or
* {@link DsAPI#query2(String, String)}.
* Query to get all zone and group names. Can be executed with
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#query(String, String)} or
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#query2(String, String)}.
*/
public static final String ZONE_GROUP_NAMES = "/apartment/zones/*(ZoneID,name)/groups/*(group,name)";

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/CircuitScheduler.java
View File

@@ -156,7 +156,9 @@ public class CircuitScheduler {
}
/**
* Removes all {@link SensorJob} of a specific {@link Device} with the given {@link DSID}.
* Removes all {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
* of a specific {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with the
* given {@link DSID}.
*
* @param dSID of the device
*/

5
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SceneReadingJobExecutor.java
View File

@@ -19,8 +19,9 @@ import org.slf4j.LoggerFactory;
/**
* The {@link SceneReadingJobExecutor} is the implementation of the {@link AbstractSensorJobExecutor} to execute
* digitalSTROM-Device scene configuration {@link SensorJob}'s e.g. {@link SceneConfigReadingJob} and
* {@link SceneOutputValueReadingJob}.
* digitalSTROM-Device scene configuration {@link SensorJob}'s e.g.
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.SceneConfigReadingJob} and
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.SceneOutputValueReadingJob}.
* <p>
* In addition priorities can be assigned to jobs therefore the {@link SceneReadingJobExecutor} offers the methods
* {@link #addHighPriorityJob(SensorJob)}, {@link #addMediumPriorityJob(SensorJob)} and

11
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SensorJobExecutor.java
View File

@@ -19,15 +19,18 @@ import org.slf4j.LoggerFactory;
/**
* The {@link SensorJobExecutor} is the implementation of the {@link AbstractSensorJobExecutor} to execute
* digitalSTROM-Device {@link SensorJob}'s e.g. {@link DeviceConsumptionSensorJob} and
* {@link DeviceOutputValueSensorJob}.
* digitalSTROM-Device {@link SensorJob}'s e.g.
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceConsumptionSensorJob} and
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceOutputValueSensorJob}.
* <p>
* In addition priorities can be assigned to jobs, but the following list shows the maximum evaluation of a
* {@link SensorJob} per priority.
* </p>
* <ul>
* <li>low priority: read cycles before execution is set in {@link Config}</li>
* <li>medium priority: read cycles before execution is set in {@link Config}</li>
* <li>low priority: read cycles before execution is set in
* {@link org.openhab.binding.digitalstrom.internal.lib.config.Config}</li>
* <li>medium priority: read cycles before execution is set in
* {@link org.openhab.binding.digitalstrom.internal.lib.config.Config}</li>
* <li>high priority: read cycles before execution 0</li>
* </ul>
*

9
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/sensorjob/SensorJob.java
View File

@@ -18,8 +18,10 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.devicepar
/**
* The {@link SensorJob} represents an executable job to read out digitalSTROM-Sensors or device configurations like
* scene values.<br>
* It can be added to an implementation of the {@link AbstractSensorJobExecutor} e.g. {@link SceneReadingJobExecutor} or
* {@link SensorJobExecutor}.
* It can be added to an implementation of the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.AbstractSensorJobExecutor} e.g.
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} or
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
@@ -27,7 +29,8 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.devicepar
public interface SensorJob {
/**
* Returns the dSID of the {@link Device} for which this job is to be created.
* Returns the dSID of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
* for which this job is to be created.
*
* @return dSID from the device
*/

15
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/DsAPI.java
View File

@@ -737,12 +737,17 @@ public interface DsAPI {
boolean setZoneTemperatureControlState(String sessionToken, Integer zoneID, String zoneName, String controlState);
/**
* Sets the wished temperature (control mode = {@link ControlModes#PID_CONTROL}) or control valve value for a
* operation mode, see
* {@link OperationModes}.<br>
* Sets the wished temperature (control mode =
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}) or control
* valve value for a
* operation mode, see {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.OperationModes}.<br>
* To set the values a {@link List} with an object array has to be set as controlVlaues parameter. The 1th field has
* to be a {@link String} for the {@link OperationModes} name and the 2nd field has to be an {@link Integer} for the
* new value. If the control mode is {@link ControlModes#PID_CONTROL} it is the nominal temperature, otherwise it is
* to be a {@link String} for the
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.OperationModes}
* name and the 2nd field has to be an {@link Integer} for the
* new value. If the control mode is
* {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL} it is the
* nominal temperature, otherwise it is
* the control valve value.
*
* @param sessionToken can be null, if a

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java
View File

@@ -67,8 +67,8 @@ import org.slf4j.LoggerFactory;
* </p>
* <p>
* If a {@link ConnectionManager} is given at the constructor, the session-token is not needed by requests and the
* {@link ConnectionListener}, which is registered at the {@link ConnectionManager}, will be automatically informed
* about
* {@link org.openhab.binding.digitalstrom.internal.lib.listener.ConnectionListener}, which is registered at the
* {@link ConnectionManager}, will be automatically informed about
* connection state changes through the {@link #execute(String, int, int)} method.
* </p>
*

9
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/SimpleRequestBuilder.java
View File

@@ -58,7 +58,6 @@ public class SimpleRequestBuilder {
*
* @param interfaceKey must not be null
* @return simpleRequestBuilder with chosen interface
* @throws NullArgumentException if the interfaceKey is null
*/
public static SimpleRequestBuilder buildNewRequest(String interfaceKey) throws IllegalArgumentException {
if (builder == null) {
@@ -75,7 +74,6 @@ public class SimpleRequestBuilder {
* @param requestClassKey must not be null
* @return simpleRequestBuilder with chosen requestClass
* @throws IllegalArgumentException if a requestClass is already chosen
* @throws NullArgumentException if the requestClassKey is null
*/
public static SimpleRequestBuilder buildNewJsonRequest(String requestClassKey) throws IllegalArgumentException {
return buildNewRequest(InterfaceKeys.JSON).addRequestClass(requestClassKey);
@@ -98,7 +96,6 @@ public class SimpleRequestBuilder {
* @param requestClassKey must not be null
* @return simpleRequestBuilder with chosen requestClass
* @throws IllegalArgumentException if a requestClass is already chosen
* @throws NullArgumentException if the requestClassKey is null
*/
public SimpleRequestBuilder addRequestClass(String requestClassKey) throws IllegalArgumentException {
return builder.addRequestClassInt(requestClassKey);
@@ -124,7 +121,6 @@ public class SimpleRequestBuilder {
* @param functionKey must not be null
* @return SimpleRequestBuilder with chosen function
* @throws IllegalArgumentException if a function is already chosen
* @throws NullArgumentException if the functionKey is null
*/
public SimpleRequestBuilder addFunction(String functionKey) throws IllegalArgumentException {
return builder.addFunctionInt(functionKey);
@@ -154,7 +150,6 @@ public class SimpleRequestBuilder {
* @param parameterValue can be null
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
* @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addParameter(String parameterKey, String parameterValue)
throws IllegalArgumentException {
@@ -169,7 +164,6 @@ public class SimpleRequestBuilder {
* @param zoneName
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
* @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultZoneParameter(String sessionToken, Integer zoneID, String zoneName)
throws IllegalArgumentException {
@@ -185,7 +179,6 @@ public class SimpleRequestBuilder {
* @param groupName
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
* @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultGroupParameter(String sessionToken, Short groupID, String groupName)
throws IllegalArgumentException {
@@ -204,7 +197,6 @@ public class SimpleRequestBuilder {
* @param groupName
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
* @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultZoneGroupParameter(String sessionToken, Integer zoneID, String zoneName,
Short groupID, String groupName) throws IllegalArgumentException {
@@ -222,7 +214,6 @@ public class SimpleRequestBuilder {
* @param name
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
* @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultDeviceParameter(String sessionToken, DSID dsid, String dSUID, String name)
throws IllegalArgumentException {

6
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/constants/ExeptionConstants.java
View File

@@ -13,7 +13,11 @@
package org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.constants;
/**
* The {@link ExeptionConstants} contains the {@link SimpleRequestBuilder} exception strings.
* The
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.constants.ExeptionConstants}
* contains the
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.SimpleRequestBuilder}
* exception strings.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/AbstractGeneralDeviceInformations.java
View File

@@ -20,7 +20,7 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.devicepar
import com.google.gson.JsonObject;
/**
* The {@link AbstractGeneralDeviceInformations} is an abstract implementation of {@link GeneralDeviceInformations} and
* The {@link AbstractGeneralDeviceInformations} is an abstract implementation of {@link GeneralDeviceInformation}s and
* can be implement by subclasses which contains the same device informations like dSID and/or mechanismen like the
* {@link DeviceStatusListener}.
*

5
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Circuit.java
View File

@@ -21,8 +21,9 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.devicepar
/**
* The {@link Circuit} represents a circuit of the digitalStrom system. For that all information will be able to get and
* set through the same named getter- and setter-methods. To get informed about status and configuration changes a
* {@link DeviceStatusListener} can be registered. For that and to get the general device informations like the dSID the
* {@link Circuit} implements the {@link GeneralDeviceInformations} interface.
* {@link org.openhab.binding.digitalstrom.internal.lib.listener.DeviceStatusListener} can be registered. For that and
* to get the general device informations like the dSID the {@link Circuit} implements the
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.GeneralDeviceInformation}s interface.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution

19
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java
View File

@@ -130,7 +130,7 @@ public interface Device extends GeneralDeviceInformation {
/**
* Returns the current functional color group of this device.
* For more informations please have a look at {@link FunctionalColorGroupEnum}.
* For more informations please have a look at {@link ApplicationGroup}.
*
* @return current functional color group
*/
@@ -519,7 +519,7 @@ public interface Device extends GeneralDeviceInformation {
/**
* Returns true, if this {@link Device} is a heating device. That means, that the output mode of this {@link Device}
* is one of the following modes {@link OutputModeEnum#PWM} or {@link OutputModeEnum#SWITCH} and the
* {@link FuncNameAndColorGroupEnum} is {@link FuncNameAndColorGroupEnum#HEATING}.
* {@link ApplicationGroup} is {@link ApplicationGroup#HEATING}.
*
* @return true, if it is a heating device
*/
@@ -745,7 +745,9 @@ public interface Device extends GeneralDeviceInformation {
boolean hasPowerSensors();
/**
* Only needed for {@link DeviceConsumptionSensorJob}'s. To set the internal digitalSTROM sensor value please use
* Only needed for
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceConsumptionSensorJob}'s.
* To set the internal digitalSTROM sensor value please use
* {@link #setDsSensorValue(SensorEnum, Integer)}.
*
* @param sensorType of the sensor
@@ -754,12 +756,14 @@ public interface Device extends GeneralDeviceInformation {
void setDeviceSensorDsValueBySensorJob(SensorEnum sensorType, Integer value);
/**
* Enables the internal sensor echo box for {@link EventNames#DEVICE_SENSOR_VALUE} events.
* Enables the internal sensor echo box for
* {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} events.
*/
void enableSensorEchoBox();
/**
* Disables the internal sensor echo box for {@link EventNames#DEVICE_SENSOR_VALUE} events.
* Disables the internal sensor echo box for
* {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} events.
*/
void disableSensorEchoBox();
@@ -771,8 +775,9 @@ public interface Device extends GeneralDeviceInformation {
boolean isSensorEchoBoxEnabled();
/**
* Sets the {@link DeviceSensorValue} through an {@link EventItem} of the type
* {@link EventNames#DEVICE_SENSOR_VALUE}.
* Sets the {@link DeviceSensorValue} through an
* {@link EventItem} of the type
* {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE}.
*
* @param event of the sensor update
*/

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/GeneralDeviceInformation.java
View File

@@ -16,7 +16,7 @@ import org.openhab.binding.digitalstrom.internal.lib.listener.DeviceStatusListen
import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.impl.DSID;
/**
* The {@link GeneralDeviceInformations} interface contains all informations of digitalSTROM devices, which are
* The {@link GeneralDeviceInformation} interface contains all informations of digitalSTROM devices, which are
* identical for all device types. It also contains the methods to implement the mechanism of the
* {@link DeviceStatusListener}.
*

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java
View File

@@ -81,7 +81,9 @@ public interface DeviceStateUpdate {
* <li>For SceneCall-type the value is between 0 and 127.</li>
* <li>For all SceneUndo-types the value is the new output value.</li>
* <li>For all SensorUpdate-types will read the sensor data directly, if the value is 0, otherwise a
* {@link SensorJob} will be added to the {@link SensorJobExecutor}.</li>
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
* will be added to the
* {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}.</li>
* </ul>
*
* @return new state value

12
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java
View File

@@ -18,7 +18,8 @@ import com.google.gson.JsonObject;
/**
* The {@link DeviceBinaryInput} contains all information of a device binary input, e.g. binary input type id (see
* {@link DeviceBinarayInputEnum}, state and so on.
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum},
* state and so on.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
@@ -33,8 +34,11 @@ public class DeviceBinaryInput {
private Short stateValue;
/**
* Creates a new {@link DeviceBinarayInputEnum} through the {@link JsonObject} of the binary inputs at json response
* from digitalSTROM JSON-API or property-tree. Will be automatically added to a {@link DeviceImpl}, if binary
* Creates a new
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum}
* through the {@link JsonObject} of the binary inputs at json response
* from digitalSTROM JSON-API or property-tree. Will be automatically added to a
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.impl.DeviceImpl}, if binary
* inputs exists.
*
* @param jsonObject must not be null
@@ -108,7 +112,7 @@ public class DeviceBinaryInput {
/**
* Returns the input type id of this {@link DeviceBinaryInput}. Available input types see
* {@link DeviceBinarayInputEnum}.
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum}.
*
* @return the inputType
*/

10
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java
View File

@@ -30,9 +30,9 @@ import com.google.gson.JsonObject;
/**
* The {@link DeviceSensorValue} contains all needed information of a device sensor, e.g. the sensor type, to detect
* which kind of sensor it is (see {@link SensorEnum}), the sensor index to read out sensor at the digitalSTROM device
* by calling {@link DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)} and as well as of course the value
* and
* timestamp of the last sensor update.
* by calling
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}
* and as well as of course the value and timestamp of the last sensor update.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
@@ -85,7 +85,7 @@ public class DeviceSensorValue {
/**
* Creates a new {@link DeviceSensorValue} through the properties of a digitalSTROM
* {@link EventNames#DEVICE_SENSOR_VALUE} event.
* {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} event.
*
* @param eventProperties must not be null
*/
@@ -212,7 +212,7 @@ public class DeviceSensorValue {
/**
* Returns the sensor index to read the sensor value out though
* {@link DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}.
* {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}.
*
* @return the sensorIndex
*/

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/util/DSJsonParser.java
View File

@@ -25,7 +25,8 @@ import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
/**
* digitalSTROM JSON Parser class. Externalizes code from {@link DeviceImpl}
* digitalSTROM JSON Parser class. Externalizes code from
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.impl.DeviceImpl}
*
* @author Rouven Schürch - Initial contribution
*

10
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsChannelTypeProvider.java
View File

@@ -48,7 +48,7 @@ import org.osgi.service.component.annotations.Reference;
/**
* The {@link DsChannelTypeProvider} implements the {@link ChannelTypeProvider}
* generates all supported {@link Channel}'s for digitalSTROM.
* generates all supported {@link org.openhab.core.thing.Channel}'s for digitalSTROM.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
@@ -118,8 +118,8 @@ public class DsChannelTypeProvider extends BaseDsI18n implements ChannelTypeProv
* channel type exists for the given {@link ApplicationGroup.Color} and
* {@link OutputModeEnum}.
*
* @param functionalGroup of the {@link Device}
* @param outputMode of the {@link Device}
* @param functionalGroup of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
* @param outputMode of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
* @return the output channel type id or null
*/
public static String getOutputChannelTypeID(ApplicationGroup.Color functionalGroup, OutputModeEnum outputMode,
@@ -541,7 +541,7 @@ public class DsChannelTypeProvider extends BaseDsI18n implements ChannelTypeProv
}
/**
* Returns the {@link ChannelGroupTypeUID} for the given {@link SensorEnum}.
* Returns the {@link ChannelTypeUID} for the given {@link SensorEnum}.
*
* @param sensorType (must not be null)
* @return the channel type uid
@@ -551,7 +551,7 @@ public class DsChannelTypeProvider extends BaseDsI18n implements ChannelTypeProv
}
/**
* Returns the {@link ChannelGroupTypeUID} for the given
* Returns the {@link ChannelTypeUID} for the given
* {@link DeviceBinarayInputEnum}.
*
* @param binaryInputType (must not be null)

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsDeviceThingTypeProvider.java
View File

@@ -44,7 +44,8 @@ import org.slf4j.LoggerFactory;
/**
* The {@link DsDeviceThingTypeProvider} creates the {@link ThingType}'s for the subclasses of the
* {@link GeneralDeviceInformations}. It also adds the {@link ThingTypeUID}'s to the related handlers. So only the
* {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.GeneralDeviceInformation}s.
* It also adds the {@link ThingTypeUID}'s to the related handlers. So only the
* {@link SupportedThingTypes} enum has to be adjusted, if new device types of digitalSTROM should be supported.
* Provided the new digitalSTROM devices uses the same mechanism like now.
*