Typos a/an (#13876)
This commit is contained in:
@@ -236,7 +236,7 @@ The digitalSTROM-Scenes can be defined with following parameters.
|
||||
| Scene ID or name | sceneID |The call scene ID or scene name, e.g. preset 1 for scene ID 5. Callable scenes are from 0 to 126. | false | false |
|
||||
|
||||
The Scene-Thing-Type _Named-Scene_ and _Group-Scene_ have all parameters.
|
||||
The _Apartment-Scene_ only has the parameters _Scene name_ and _Scene ID_ an the _Zone-Scene_ has all parameters without _Group ID or name_.
|
||||
The _Apartment-Scene_ only has the parameters _Scene name_ and _Scene ID_ and the _Zone-Scene_ has all parameters without _Group ID or name_.
|
||||
|
||||
### Textual configuration examples
|
||||
|
||||
|
||||
@@ -632,7 +632,7 @@ public class BridgeHandler extends BaseBridgeHandler
|
||||
case WRONG_APP_TOKEN:
|
||||
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
|
||||
"User defined Application-Token is wrong. "
|
||||
+ "Please set user name and password to generate an Application-Token or set an valid Application-Token.");
|
||||
+ "Please set user name and password to generate an Application-Token or set a valid Application-Token.");
|
||||
stopServices();
|
||||
return;
|
||||
case WRONG_USER_OR_PASSWORD:
|
||||
|
||||
@@ -30,7 +30,7 @@ public abstract class BaseTemperatureControl extends BaseZoneIdentifier {
|
||||
protected Short controlMode;
|
||||
|
||||
/**
|
||||
* Creates a new {@link BaseTemperatureControl} through the {@link JsonObject} which will be returned by an zone
|
||||
* Creates a new {@link BaseTemperatureControl} through the {@link JsonObject} which will be returned by a zone
|
||||
* call.<br>
|
||||
* Because zone calls do not include a zoneID or zoneName in the json response, the zoneID and zoneName have to
|
||||
* be handed over the constructor.
|
||||
|
||||
@@ -28,7 +28,7 @@ public abstract class BaseZoneIdentifier implements ZoneIdentifier {
|
||||
protected String zoneName;
|
||||
|
||||
/**
|
||||
* Creates a new {@link BaseZoneIdentifier} with an zone id and zone name.
|
||||
* Creates a new {@link BaseZoneIdentifier} with a zone id and zone name.
|
||||
*
|
||||
* @param zoneID must not be null
|
||||
* @param zoneName can be null
|
||||
@@ -39,7 +39,7 @@ public abstract class BaseZoneIdentifier implements ZoneIdentifier {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link BaseZoneIdentifier} through the {@link JsonObject} of the response of an digitalSTROM-API
|
||||
* Creates a new {@link BaseZoneIdentifier} through the {@link JsonObject} of the response of a digitalSTROM-API
|
||||
* apartment call.
|
||||
*
|
||||
* @param jObject must not be null
|
||||
|
||||
@@ -47,7 +47,7 @@ public class AssignedSensors extends BaseZoneIdentifier {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link AssignedSensors} through the {@link JsonObject} which will be returned by an zone call.
|
||||
* Creates a new {@link AssignedSensors} through the {@link JsonObject} which will be returned by a zone call.
|
||||
* Because of zone calls does not include a zoneID or zoneName in the json response, the zoneID and zoneName have to
|
||||
* be handed over the constructor.
|
||||
*
|
||||
|
||||
@@ -50,7 +50,7 @@ public class SensorValues extends BaseSensorValues implements ZoneIdentifier {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link SensorValues} through the {@link JsonObject} which will be returned by an zone call.
|
||||
* Creates a new {@link SensorValues} through the {@link JsonObject} which will be returned by a zone call.
|
||||
* Because of zone calls does not include a zoneID or zoneName in the json response, the zoneID and zoneName have to
|
||||
* be handed over the constructor.
|
||||
*
|
||||
|
||||
@@ -54,7 +54,7 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link TemperatureControlConfig} through the {@link JsonObject} which will be returned by an zone
|
||||
* Creates a new {@link TemperatureControlConfig} through the {@link JsonObject} which will be returned by a zone
|
||||
* call.<br>
|
||||
* Because of zone calls does not include a zoneID or zoneName in the json response, the zoneID and zoneName have to
|
||||
* be handed over the constructor.
|
||||
|
||||
@@ -55,7 +55,7 @@ public class TemperatureControlStatus extends BaseTemperatureControl {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link TemperatureControlStatus} through the {@link JsonObject} which will be returned by an zone
|
||||
* Creates a new {@link TemperatureControlStatus} through the {@link JsonObject} which will be returned by a zone
|
||||
* call.<br>
|
||||
* Because of zone calls does not include a zoneID or zoneName in the json response, the zoneID and zoneName have to
|
||||
* be handed over the constructor.
|
||||
|
||||
@@ -48,7 +48,7 @@ public class TemperatureControlValues extends BaseZoneIdentifier {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link TemperatureControlValues} through the {@link JsonObject} which will be returned by an zone
|
||||
* Creates a new {@link TemperatureControlValues} through the {@link JsonObject} which will be returned by a zone
|
||||
* call.<br>
|
||||
* Because of zone calls does not include a zoneID or zoneName in the json response, the zoneID and zoneName have to
|
||||
* be handed over the constructor.
|
||||
|
||||
@@ -17,7 +17,7 @@ import java.util.Map;
|
||||
import org.openhab.binding.digitalstrom.internal.lib.event.constants.EventResponseEnum;
|
||||
|
||||
/**
|
||||
* The {@link EventItem} represents an event item of an digitalSTROM-Event.
|
||||
* The {@link EventItem} represents an event item of a digitalSTROM-Event.
|
||||
*
|
||||
* @author Alexander Betker
|
||||
* @author Michael Ochel - add getSource()
|
||||
|
||||
@@ -62,7 +62,7 @@ public interface DeviceStatusListener {
|
||||
void onDeviceAdded(GeneralDeviceInformation device);
|
||||
|
||||
/**
|
||||
* This method is called whenever a configuration of an device has changed. What configuration has changed
|
||||
* This method is called whenever a configuration of a device has changed. What configuration has changed
|
||||
* can be see by the given parameter whatConfig to handle the change.<br>
|
||||
* Please have a look at {@link ChangeableDeviceConfigEnum} to see what configuration are changeable.
|
||||
*
|
||||
|
||||
@@ -24,7 +24,7 @@ import org.openhab.binding.digitalstrom.internal.lib.listener.stateenums.Manager
|
||||
public interface ManagerStatusListener {
|
||||
|
||||
/**
|
||||
* This method is called whenever the state of an digitalSTROM-Manager has changed.<br>
|
||||
* This method is called whenever the state of a digitalSTROM-Manager has changed.<br>
|
||||
* For that it passes the {@link ManagerTypes} and the new {@link ManagerStates}.
|
||||
*
|
||||
* @param managerType of the digitalSTROM-Manager
|
||||
|
||||
@@ -28,7 +28,7 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalSce
|
||||
/**
|
||||
* <p>
|
||||
* 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 an device by sending a
|
||||
* 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
|
||||
* configurations of the physically device will be synchronized to the internally managed model and updated as required.
|
||||
|
||||
@@ -110,7 +110,7 @@ public interface StructureManager {
|
||||
Map<Short, List<Device>> getGroupsFromZoneX(int zoneID);
|
||||
|
||||
/**
|
||||
* Returns the reference {@link List} of the {@link Device}'s of an zone-group.
|
||||
* Returns the reference {@link List} of the {@link Device}'s of a zone-group.
|
||||
*
|
||||
* @param zoneID of the zone
|
||||
* @param groupID of the group
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
package org.openhab.binding.digitalstrom.internal.lib.serverconnection;
|
||||
|
||||
/**
|
||||
* The {@link HttpTransport} executes an request to the DigitalSTROM-Server.
|
||||
* The {@link HttpTransport} executes a request to the DigitalSTROM-Server.
|
||||
*
|
||||
* @author Michael Ochel - Initial contribution
|
||||
* @author Matthias Siegele - Initial contribution
|
||||
|
||||
@@ -52,10 +52,10 @@ import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* The {@link HttpTransportImpl} executes an request to the digitalSTROM-Server.
|
||||
* The {@link HttpTransportImpl} executes a request to the digitalSTROM-Server.
|
||||
* <p>
|
||||
* If a {@link Config} is given at the constructor. It sets the SSL-Certificate what is set in
|
||||
* {@link Config#getCert()}. If there is no SSL-Certificate, but an path to an external SSL-Certificate file what is set
|
||||
* {@link Config#getCert()}. If there is no SSL-Certificate, but a path to an external SSL-Certificate file what is set
|
||||
* in {@link Config#getTrustCertPath()} this will be set. If no SSL-Certificate is set in the {@link Config} it will be
|
||||
* red out from the server and set in {@link Config#setCert(String)}.
|
||||
*
|
||||
|
||||
@@ -21,7 +21,7 @@ import com.google.gson.JsonParseException;
|
||||
import com.google.gson.JsonParser;
|
||||
|
||||
/**
|
||||
* The {@link JSONResponseHandler} checks an digitalSTROM-JSON response and can parse it to a {@link JsonObject}.
|
||||
* The {@link JSONResponseHandler} checks a digitalSTROM-JSON response and can parse it to a {@link JsonObject}.
|
||||
*
|
||||
* @author Alexander Betker - Initial contribution
|
||||
* @author Alex Maier - Initial contribution
|
||||
@@ -65,7 +65,7 @@ public class JSONResponseHandler {
|
||||
try {
|
||||
return (JsonObject) JsonParser.parseString(jsonResponse);
|
||||
} catch (JsonParseException e) {
|
||||
LOGGER.error("An JsonParseException occurred by parsing jsonRequest: {}", jsonResponse, e);
|
||||
LOGGER.error("A JsonParseException occurred by parsing jsonRequest: {}", jsonResponse, e);
|
||||
}
|
||||
}
|
||||
return null;
|
||||
|
||||
@@ -163,7 +163,7 @@ public interface Device extends GeneralDeviceInformation {
|
||||
void increase();
|
||||
|
||||
/**
|
||||
* Adds an decrease command as {@link DeviceStateUpdate} to the list of outstanding commands.
|
||||
* Adds a decrease command as {@link DeviceStateUpdate} to the list of outstanding commands.
|
||||
*/
|
||||
void decrease();
|
||||
|
||||
@@ -175,7 +175,7 @@ public interface Device extends GeneralDeviceInformation {
|
||||
int getSlatPosition();
|
||||
|
||||
/**
|
||||
* Adds an set slat position command as {@link DeviceStateUpdate} with the given slat position to the list of
|
||||
* Adds a set slat position command as {@link DeviceStateUpdate} with the given slat position to the list of
|
||||
* outstanding commands.
|
||||
*
|
||||
* @param slatPosition to set
|
||||
@@ -205,7 +205,7 @@ public interface Device extends GeneralDeviceInformation {
|
||||
short getOutputValue();
|
||||
|
||||
/**
|
||||
* Adds an set output value command as {@link DeviceStateUpdate} with the given output value to the list of
|
||||
* Adds a set output value command as {@link DeviceStateUpdate} with the given output value to the list of
|
||||
* outstanding commands.
|
||||
*
|
||||
* @param outputValue to set
|
||||
@@ -427,7 +427,7 @@ public interface Device extends GeneralDeviceInformation {
|
||||
short getAnglePosition();
|
||||
|
||||
/**
|
||||
* Adds an set angle value command as {@link DeviceStateUpdate} with the given angle value to the list of
|
||||
* Adds a set angle value command as {@link DeviceStateUpdate} with the given angle value to the list of
|
||||
* outstanding commands.
|
||||
*
|
||||
* @param angle to set
|
||||
|
||||
@@ -20,7 +20,7 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.devicepar
|
||||
import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.impl.DSUID;
|
||||
|
||||
/**
|
||||
* The {@link CachedMeteringValue} saves the metering value of an digitalSTROM-Circuit.
|
||||
* The {@link CachedMeteringValue} saves the metering value of a digitalSTROM-Circuit.
|
||||
*
|
||||
* @author Alexander Betker - Initial contribution
|
||||
* @author Michael Ochel - add methods getDateAsDate(), getMeteringType() and getMeteringUnit(); add missing java-doc
|
||||
|
||||
@@ -63,7 +63,7 @@ public interface DeviceStateUpdate {
|
||||
static final String UPDATE_SCENE_CONFIG = "sceneConfig";
|
||||
|
||||
// general
|
||||
/** command to refresh the output value of an device. */
|
||||
/** command to refresh the output value of a device. */
|
||||
static final String REFRESH_OUTPUT = "refreshOutput";
|
||||
|
||||
// standard values
|
||||
|
||||
@@ -17,7 +17,7 @@ import org.openhab.binding.digitalstrom.internal.lib.serverconnection.constants.
|
||||
import com.google.gson.JsonObject;
|
||||
|
||||
/**
|
||||
* The {@link DeviceBinaryInput} contains all information of an device binary input, e.g. binary input type id (see
|
||||
* The {@link DeviceBinaryInput} contains all information of a device binary input, e.g. binary input type id (see
|
||||
* {@link DeviceBinarayInputEnum}, state and so on.
|
||||
*
|
||||
* @author Michael Ochel - initial contributer
|
||||
|
||||
@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
|
||||
import com.google.gson.JsonObject;
|
||||
|
||||
/**
|
||||
* The {@link DeviceSensorValue} contains all needed information of an device sensor, e.g. the sensor type, to detect
|
||||
* 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
|
||||
|
||||
@@ -111,7 +111,7 @@ public class DeviceImpl extends AbstractGeneralDeviceInformations implements Dev
|
||||
|
||||
/*
|
||||
* Saves the refresh priorities and reading initialized flag of power sensors as
|
||||
* an matrix. The first array fields are 0 = active power, 1 = output current, 2
|
||||
* a matrix. The first array fields are 0 = active power, 1 = output current, 2
|
||||
* = electric meter, 3 = power consumption and in each field is a string array
|
||||
* with the fields 0 = refresh priority 1 = reading initial flag (true = reading
|
||||
* is initialized, otherwise false)
|
||||
|
||||
@@ -85,8 +85,8 @@ public abstract class BaseDsI18n {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the internationalized text in the language of the {@link Locale} of the given key. If the key an does not
|
||||
* exist at the internationalization of the {@link Locale} the {@link Locale#ENGLISH} will be used. If the key dose
|
||||
* Returns the internationalized text in the language of the {@link Locale} of the given key. If the key does not
|
||||
* exist at the internationalization of the {@link Locale} the {@link Locale#ENGLISH} will be used. If the key does
|
||||
* not exists in {@link Locale#ENGLISH}, too, the key will be returned.
|
||||
*
|
||||
* @param key
|
||||
|
||||
Reference in New Issue
Block a user