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

4
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanBindingConstants.java
View File

@@ -35,7 +35,7 @@ import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.type.ChannelTypeUID;
/**
* The {@link EnOceanBinding} class defines common constants, which are
* The {@link EnOceanBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Daniel Weber - Initial contribution
@@ -221,7 +221,7 @@ public class EnOceanBindingConstants {
public static final String CHANNEL_EXHAUSTAIRFANAIRFLOWRATE = "exhaustAirFanAirFlowRate";
public static final String CHANNEL_SUPPLYFANSPEED = "supplyFanSpeed";
public static final String CHANNEL_EXHAUSTFANSPEED = "exhaustFanSpeed";
public final static String CHANNEL_DAYNIGHTMODESTATE = "dayNightModeState";
public static final String CHANNEL_DAYNIGHTMODESTATE = "dayNightModeState";
public static final Map<String, EnOceanChannelDescription> CHANNELID2CHANNELDESCRIPTION = Map.ofEntries(
Map.entry(CHANNEL_GENERAL_SWITCHING,

4
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanChannelDescription.java
View File

@@ -34,7 +34,7 @@ public class EnOceanChannelDescription {
* Ctor for an EnOceanChannelDescription
*
* @param channelTypeUID ChannelTypeUID of channel
* @param acceptedItemType AcceptedItemType of channel like Switch, Dimmer or null if we accept everything
* @param itemType ItemType of channel like Switch, Dimmer or null if we accept everything
*/
public EnOceanChannelDescription(ChannelTypeUID channelTypeUID, String itemType) {
this(channelTypeUID, itemType, "", true, true);
@@ -44,7 +44,7 @@ public class EnOceanChannelDescription {
* Ctor for an EnOceanChannelDescription with detailed information
*
* @param channelTypeUID ChannelTypeUID of channel
* @param acceptedItemType ItemType of channel like Switch, Dimmer
* @param itemType ItemType of channel like Switch, Dimmer
* @param label of created channel
* @param isStateChannel otherwise created channel is a trigger channel
* @param autoCreate create channel during thing initialization, otherwise channel is created

1
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09.java
View File

@@ -146,7 +146,6 @@ public abstract class A5_09 extends _4BSMessage {
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
if (CHANNEL_CO.equals(channelId)) {
return EEPHelper.calculateState(getUnscaledCOValue(), getScaledCOMin(), getScaledCOMax(),
getUnscaledCOMin(), getUnscaledCOMax(), Units.PARTS_PER_MILLION);

1
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_05.java
View File

@@ -76,7 +76,6 @@ public class A5_09_05 extends A5_09 {
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
if (CHANNEL_VOC.equals(channelId)) {
double scaledVOC = getUnscaledVOCValue() * getScalingFactor();
return new QuantityType<>(scaledVOC, Units.PARTS_PER_BILLION);

1
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0C.java
View File

@@ -51,7 +51,6 @@ public class A5_09_0C extends A5_09_05 {
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
if (CHANNEL_VOC.equals(channelId)) {
double scaledVOC = getUnscaledVOCValue() * getScalingFactor();
if (getBit(getDB0(), 2)) {

1
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0D.java
View File

@@ -42,7 +42,6 @@ public class A5_09_0D extends A5_09 {
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
if (CHANNEL_TVOC.equals(channelId)) {
return EEPHelper.calculateState(getDB2Value(), 0, 100, 0, 200, Units.PERCENT);
}

2
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_10/A5_10.java
View File

@@ -111,9 +111,7 @@ public abstract class A5_10 extends _4BSMessage {
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, @Nullable State> getCurrentStateFunc, Configuration config) {
switch (channelId) {
case CHANNEL_BATTERY_VOLTAGE:
return getSupplyVoltage();

2
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_38/A5_38_08_Dimming.java
View File

@@ -35,8 +35,10 @@ import org.openhab.core.types.UnDefType;
/**
* This class tries to combine the classic EEP A5-38-08 CMD 0x02 dimming with the Eltako interpretation of this EEP.
* It is doing it by channel config parameter "eltakoDimmer". The differences are:
* <ul>
* <li>Dimming value 0-100%: standard 0-255, Eltako 0-100</li>
* <li>Store value: standard DB0.1, Eltako DB0.2</li>
* </ul>
*
* @author Daniel Weber - Initial contribution
*/

1
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/EEPHelper.java
View File

@@ -83,7 +83,6 @@ public abstract class EEPHelper {
public static State calculateState(int unscaledValue, double scaledMin, double scaledMax, double unscaledMin,
double unscaledMax, Unit<?> unit) {
if (!validateUnscaledValue(unscaledValue, unscaledMin, unscaledMax)) {
return UnDefType.UNDEF;
}

6
bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/handler/EnOceanBridgeHandler.java
View File

@@ -66,8 +66,10 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by {@link EnOceanActuatorHandler} and
* transferring received ESP3Packages to {@link EnOceanSensorHandler}.
* The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by
* {@link org.openhab.binding.enocean.internal.handler.EnOceanActuatorHandler} and
* transferring received ESP3Packages to
* {@link org.openhab.binding.enocean.internal.handler.EnOceanSensorHandler}.
*
* @author Daniel Weber - Initial contribution
*/