From 177ce2a217bf8fe47abd1993cf99d4defe6ff711 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B8rgen=20Austvik?= Date: Thu, 8 Dec 2022 21:00:11 +0100 Subject: [PATCH 01/48] [Nanolaef] Visual State Bugfix (#13880) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Nanoleaf Visual State fix Fix the visual state channel name. Also: - Better name (from state to visual state) of the (new) channel - Better logs which has helped us debug the problem - Some more information on when it will work in the README Signed-off-by: Jørgen Austvik --- .../org.openhab.binding.nanoleaf/README.md | 2 ++ .../internal/NanoleafBindingConstants.java | 2 +- .../handler/NanoleafControllerHandler.java | 26 +++++++++++++++---- .../internal/layout/NanoleafLayout.java | 5 ++++ .../nanoleaf/internal/layout/PanelState.java | 16 ++++++++++++ .../resources/OH-INF/i18n/nanoleaf.properties | 4 +-- .../resources/OH-INF/thing/lightpanels.xml | 4 +-- 7 files changed, 49 insertions(+), 10 deletions(-) diff --git a/bundles/org.openhab.binding.nanoleaf/README.md b/bundles/org.openhab.binding.nanoleaf/README.md index c7220da82f6a3..c6226731fedd9 100644 --- a/bundles/org.openhab.binding.nanoleaf/README.md +++ b/bundles/org.openhab.binding.nanoleaf/README.md @@ -110,6 +110,8 @@ Compare the following output with the right picture at the beginning of the arti The state channel shows an image of the panels on the wall. You have to configure things for each panel to get the correct color. Since the colors of the panels can make it difficult to see the panel ids, please use the layout channel where the background color is always white to identify them. +For state to work, you need to set static colors to your panel. +This is because Nanoleaf does not return updates on colors for dynamic effects and animations. ![Image](doc/NanoCanvas_rendered.jpg) diff --git a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/NanoleafBindingConstants.java b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/NanoleafBindingConstants.java index db83c1fd78921..5109d8abce320 100644 --- a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/NanoleafBindingConstants.java +++ b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/NanoleafBindingConstants.java @@ -59,7 +59,7 @@ public class NanoleafBindingConstants { public static final String CHANNEL_SWIPE_EVENT_LEFT = "LEFT"; public static final String CHANNEL_SWIPE_EVENT_RIGHT = "RIGHT"; public static final String CHANNEL_LAYOUT = "layout"; - public static final String CHANNEL_STATE = "state"; + public static final String CHANNEL_VISUAL_STATE = "visualState"; // List of light panel channels public static final String CHANNEL_PANEL_COLOR = "color"; diff --git a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/handler/NanoleafControllerHandler.java b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/handler/NanoleafControllerHandler.java index d37a82f06c714..cd34d655d755d 100644 --- a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/handler/NanoleafControllerHandler.java +++ b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/handler/NanoleafControllerHandler.java @@ -669,7 +669,7 @@ private void updateFromControllerInfo() throws NanoleafException { updateProperties(); updateConfiguration(); updateLayout(controllerInfo.getPanelLayout()); - updateState(controllerInfo.getPanelLayout()); + updateVisualState(controllerInfo.getPanelLayout()); for (NanoleafControllerListener controllerListener : controllerListeners) { controllerListener.onControllerInfoFetched(getThing().getUID(), controllerInfo); @@ -711,16 +711,27 @@ private void updateProperties() { } } - private void updateState(PanelLayout panelLayout) { - ChannelUID stateChannel = new ChannelUID(getThing().getUID(), CHANNEL_STATE); + private void updateVisualState(PanelLayout panelLayout) { + ChannelUID stateChannel = new ChannelUID(getThing().getUID(), CHANNEL_VISUAL_STATE); Bridge bridge = getThing(); List things = bridge.getThings(); + if (things == null) { + logger.trace("No things to get state from!"); + return; + } + try { LayoutSettings settings = new LayoutSettings(false, true, true, true); - byte[] bytes = NanoleafLayout.render(panelLayout, new PanelState(things), settings); + logger.trace("Getting panel state for {} things", things.size()); + PanelState panelState = new PanelState(things); + byte[] bytes = NanoleafLayout.render(panelLayout, panelState, settings); if (bytes.length > 0) { updateState(stateChannel, new RawType(bytes, "image/png")); + logger.trace("Rendered visual state of panel {} in updateState has {} bytes", getThing().getUID(), + bytes.length); + } else { + logger.debug("Visual state of {} failed to produce any image", getThing().getUID()); } previousPanelLayout = panelLayout; @@ -740,7 +751,8 @@ private void updateLayout(PanelLayout panelLayout) { } if (previousPanelLayout.equals(panelLayout)) { - logger.trace("Not rendering panel layout as it is the same as previous rendered panel layout"); + logger.trace("Not rendering panel layout for {} as it is the same as previous rendered panel layout", + getThing().getUID()); return; } @@ -751,6 +763,10 @@ private void updateLayout(PanelLayout panelLayout) { byte[] bytes = NanoleafLayout.render(panelLayout, new PanelState(things), settings); if (bytes.length > 0) { updateState(layoutChannel, new RawType(bytes, "image/png")); + logger.trace("Rendered layout of panel {} in updateState has {} bytes", getThing().getUID(), + bytes.length); + } else { + logger.debug("Layout of {} failed to produce any image", getThing().getUID()); } previousPanelLayout = panelLayout; diff --git a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/NanoleafLayout.java b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/NanoleafLayout.java index 61ceaa5497d72..ebdb4ffe991b9 100644 --- a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/NanoleafLayout.java +++ b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/NanoleafLayout.java @@ -31,6 +31,8 @@ import org.openhab.binding.nanoleaf.internal.model.Layout; import org.openhab.binding.nanoleaf.internal.model.PanelLayout; import org.openhab.binding.nanoleaf.internal.model.PositionDatum; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Renders the Nanoleaf layout to an image. @@ -40,6 +42,7 @@ @NonNullByDefault public class NanoleafLayout { + private static final Logger logger = LoggerFactory.getLogger(NanoleafLayout.class); private static final Color COLOR_BACKGROUND = Color.WHITE; public static byte[] render(PanelLayout panelLayout, PanelState state, LayoutSettings settings) throws IOException { @@ -51,11 +54,13 @@ public static byte[] render(PanelLayout panelLayout, PanelState state, LayoutSet Layout layout = panelLayout.getLayout(); if (layout == null) { + logger.warn("Returning no image as we don't have any layout to render"); return new byte[] {}; } List positionDatums = layout.getPositionData(); if (positionDatums == null) { + logger.warn("Returning no image as we don't have any position datums to render"); return new byte[] {}; } diff --git a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/PanelState.java b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/PanelState.java index fba1804fe85de..02c6a7a947d61 100644 --- a/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/PanelState.java +++ b/bundles/org.openhab.binding.nanoleaf/src/main/java/org/openhab/binding/nanoleaf/internal/layout/PanelState.java @@ -23,6 +23,8 @@ import org.openhab.binding.nanoleaf.internal.handler.NanoleafPanelHandler; import org.openhab.core.library.types.HSBType; import org.openhab.core.thing.Thing; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Stores the state of the panels. @@ -32,6 +34,7 @@ @NonNullByDefault public class PanelState { + private static final Logger logger = LoggerFactory.getLogger(PanelState.class); private final Map panelStates = new HashMap<>(); public PanelState(List panels) { @@ -40,13 +43,26 @@ public PanelState(List panels) { NanoleafPanelHandler panelHandler = (NanoleafPanelHandler) panel.getHandler(); if (panelHandler != null) { HSBType c = panelHandler.getColor(); + + if (c == null) { + logger.trace("Panel {}: Failed to get color", panelId); + } + HSBType color = (c == null) ? HSBType.BLACK : c; panelStates.put(panelId, color); + } else { + logger.trace("Panel {}: Couldn't find handler", panelId); } } } public HSBType getHSBForPanel(Integer panelId) { + if (logger.isTraceEnabled()) { + if (!panelStates.containsKey(panelId)) { + logger.trace("Failed to get color for panel {}, falling back to black", panelId); + } + } + return panelStates.getOrDefault(panelId, HSBType.BLACK); } } diff --git a/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/i18n/nanoleaf.properties b/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/i18n/nanoleaf.properties index a730c5089d690..f1cd2dac08ea7 100644 --- a/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/i18n/nanoleaf.properties +++ b/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/i18n/nanoleaf.properties @@ -40,8 +40,8 @@ channel-type.nanoleaf.swipe.label = Swipe channel-type.nanoleaf.swipe.description = Swipe over the panels channel-type.nanoleaf.layout.label = Layout channel-type.nanoleaf.layout.description = Layout of the panels -channel-type.nanoleaf.state.label = State -channel-type.nanoleaf.state.description = Current state of the panels +channel-type.nanoleaf.state.label = Visual State +channel-type.nanoleaf.state.description = Current visual state of the panels # error messages error.nanoleaf.controller.noIp = IP/host address and/or port are not configured for the controller. diff --git a/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/thing/lightpanels.xml b/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/thing/lightpanels.xml index d5ac6ea23e585..52228fb02bdc0 100644 --- a/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/thing/lightpanels.xml +++ b/bundles/org.openhab.binding.nanoleaf/src/main/resources/OH-INF/thing/lightpanels.xml @@ -19,7 +19,7 @@ - + @@ -115,7 +115,7 @@ @text/channel-type.nanoleaf.layout.description - + Image @text/channel-type.nanoleaf.state.description From 0ffc5257d5262e9e4c6c444dee722035a851c980 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=94=D0=B8=D0=BB=D1=8F=D0=BD=20=D0=9F=D0=B0=D0=BB=D0=B0?= =?UTF-8?q?=D1=83=D0=B7=D0=BE=D0=B2?= Date: Thu, 8 Dec 2022 22:12:49 +0200 Subject: [PATCH 02/48] Typos a/an (#13876) --- .../automation/pidcontroller/internal/LowpassFilter.java | 2 +- .../binding/autelis/internal/handler/AutelisHandler.java | 2 +- .../internal/domain/QueryResultJSONEncoderTest.java | 4 ++-- bundles/org.openhab.binding.deconz/README.md | 2 +- .../deconz/internal/handler/LightThingHandler.java | 2 +- .../binding/deutschebahn/internal/EventAttribute.java | 6 +++--- .../binding/deutschebahn/internal/filter/AndOperator.java | 2 +- .../deutschebahn/internal/filter/FilterParser.java | 4 ++-- .../deutschebahn/internal/filter/FilterScanner.java | 2 +- .../binding/deutschebahn/internal/filter/FilterToken.java | 2 +- .../binding/deutschebahn/internal/filter/OrOperator.java | 2 +- .../internal/filter/TimetableStopPredicate.java | 2 +- .../deutschebahn/internal/timetable/TimetableLoader.java | 6 +++--- .../deutschebahn/internal/timetable/TimetablesV1Impl.java | 2 +- .../deutschebahn/internal/TripLabelAttributeTest.java | 2 +- .../internal/timetable/TimetablesV1ApiStub.java | 2 +- bundles/org.openhab.binding.digitalstrom/README.md | 2 +- .../digitalstrom/internal/handler/BridgeHandler.java | 2 +- .../jsonresponsecontainer/BaseTemperatureControl.java | 2 +- .../climate/jsonresponsecontainer/BaseZoneIdentifier.java | 4 ++-- .../jsonresponsecontainer/impl/AssignedSensors.java | 2 +- .../climate/jsonresponsecontainer/impl/SensorValues.java | 2 +- .../impl/TemperatureControlConfig.java | 2 +- .../impl/TemperatureControlStatus.java | 2 +- .../impl/TemperatureControlValues.java | 2 +- .../digitalstrom/internal/lib/event/types/EventItem.java | 2 +- .../internal/lib/listener/DeviceStatusListener.java | 2 +- .../internal/lib/listener/ManagerStatusListener.java | 2 +- .../internal/lib/manager/DeviceStatusManager.java | 2 +- .../internal/lib/manager/StructureManager.java | 2 +- .../internal/lib/serverconnection/HttpTransport.java | 2 +- .../lib/serverconnection/impl/HttpTransportImpl.java | 4 ++-- .../lib/serverconnection/impl/JSONResponseHandler.java | 4 ++-- .../internal/lib/structure/devices/Device.java | 8 ++++---- .../devices/deviceparameters/CachedMeteringValue.java | 2 +- .../devices/deviceparameters/DeviceStateUpdate.java | 2 +- .../devices/deviceparameters/impl/DeviceBinaryInput.java | 2 +- .../devices/deviceparameters/impl/DeviceSensorValue.java | 2 +- .../internal/lib/structure/devices/impl/DeviceImpl.java | 2 +- .../digitalstrom/internal/providers/BaseDsI18n.java | 4 ++-- .../binding/dsmr/internal/device/cosem/CosemDecimal.java | 4 ++-- .../dsmr/internal/device/cosem/OBISIdentifier.java | 4 ++-- .../internal/discovery/DSMRBridgeDiscoveryService.java | 2 +- .../binding/easee/internal/handler/StatusHandler.java | 2 +- bundles/org.openhab.binding.ecobee/README.md | 2 +- bundles/org.openhab.binding.enigma2/README.md | 2 +- .../enphase/internal/handler/EnvoyBridgeHandler.java | 2 +- .../internal/handler/FroniusSymoInverterHandler.java | 2 +- .../gardena/internal/handler/GardenaDeviceConfig.java | 2 +- .../rest/exceptions/GroupePSACommunicationException.java | 2 +- .../resources/HeosStringPropertyChangeListener.java | 2 +- .../openhab/binding/heos/internal/resources/Telnet.java | 2 +- .../homematic/internal/handler/SimplePortPool.java | 2 +- .../binding/hyperion/internal/protocol/v1/Correction.java | 2 +- .../iaqualink/internal/handler/IAqualinkHandler.java | 2 +- .../internal/logic/BiweeklyPresentableCalendar.java | 2 +- .../binding/icalendar/internal/logic/CommandTagType.java | 2 +- .../binding/insteon/internal/message/MsgFactory.java | 2 +- .../binding/keba/internal/handler/KeContactHandler.java | 2 +- bundles/org.openhab.binding.kodi/README.md | 2 +- .../SecondGenerationDxsEntriesContainerDTO.java | 2 +- .../openhab/binding/lcn/internal/LcnModuleHandler.java | 2 +- .../lgwebos/internal/handler/core/ChannelInfo.java | 2 +- .../binding/linuxinput/internal/LinuxInputHandler.java | 2 +- .../internal/controls/LxControlLeftRightAnalog.java | 2 +- .../internal/controls/LxControlLeftRightDigital.java | 2 +- .../binding/lutron/internal/grxprg/SocketSession.java | 2 +- .../internal/discovery/MagentaTVDiscoveryParticipant.java | 2 +- .../main/java/org/openhab/binding/max/internal/Utils.java | 2 +- .../internal/parser/SystemInfromationBlockParser.java | 2 +- .../internal/parser/SystemParameterBlockParser.java | 2 +- .../internal/parser/SystemStateBlockParser.java | 2 +- bundles/org.openhab.binding.modbus/README.md | 2 +- .../src/main/resources/OH-INF/i18n/modbus.properties | 2 +- .../src/main/resources/OH-INF/thing/thing-data.xml | 2 +- .../binding/mqtt/generic/values/RollershutterValue.java | 2 +- .../mqtt/homeassistant/internal/ComponentChannel.java | 2 +- .../binding/mqtt/homie/internal/homie300/Property.java | 2 +- .../openhab/binding/neeo/internal/models/NeeoAction.java | 2 +- .../binding/neeo/internal/models/NeeoForwardActions.java | 2 +- .../binding/nest/internal/wwn/dto/WWNUpdateRequest.java | 2 +- .../main/resources/OH-INF/i18n/nikohomecontrol.properties | 2 +- .../nobohub/internal/model/WeekProfileRegister.java | 2 +- .../src/main/resources/OH-INF/i18n/omnilink.properties | 2 +- .../src/main/resources/OH-INF/thing/area.xml | 2 +- .../openhab/binding/onewire/internal/device/BAE0910.java | 2 +- .../openhab/binding/onewire/internal/device/DS18x20.java | 2 +- .../openhab/binding/onewire/internal/device/DS1923.java | 2 +- .../openhab/binding/onewire/internal/device/DS2401.java | 2 +- .../openhab/binding/onewire/internal/device/DS2405.java | 2 +- .../binding/onewire/internal/device/DS2406_DS2413.java | 2 +- .../openhab/binding/onewire/internal/device/DS2408.java | 2 +- .../openhab/binding/onewire/internal/device/DS2423.java | 2 +- .../openhab/binding/onewire/internal/device/DS2438.java | 2 +- .../internal/api/OpenSprinklerHttpApiV210.java | 2 +- .../binding/opensprinkler/internal/util/Parse.java | 2 +- .../java/org/openhab/binding/phc/internal/PHCHelper.java | 2 +- .../binding/phc/internal/handler/PHCBridgeHandler.java | 2 +- .../src/main/resources/OH-INF/i18n/phc.properties | 6 +++--- .../src/main/resources/OH-INF/thing/channel-types.xml | 4 ++-- .../src/main/resources/OH-INF/thing/thing-types.xml | 2 +- .../pulseaudio/internal/items/AbstractDeviceConfig.java | 2 +- .../org/openhab/binding/pushover/internal/dto/Sound.java | 2 +- .../org/openhab/binding/pushsafer/internal/dto/Icon.java | 2 +- .../org/openhab/binding/pushsafer/internal/dto/Sound.java | 2 +- .../internal/rego6xx/Rego6xxProtocolException.java | 2 +- bundles/org.openhab.binding.rfxcom/README.md | 2 +- .../src/main/resources/OH-INF/i18n/rfxcom.properties | 2 +- .../src/main/resources/OH-INF/thing/raw.xml | 2 +- .../discovery/RioSystemDeviceDiscoveryService.java | 2 +- .../russound/internal/rio/StatefulHandlerCallback.java | 2 +- bundles/org.openhab.binding.smartmeter/README.md | 2 +- .../openhab/binding/smartmeter/internal/MeterDevice.java | 2 +- .../internal/SmartMeterChannelTypeProvider.java | 2 +- .../java/org/smslib/pduUtils/gsm3040/PduGenerator.java | 2 +- .../binding/spotify/internal/api/SpotifyConnector.java | 2 +- bundles/org.openhab.binding.tacmi/README.md | 4 ++-- .../binding/tacmi/internal/message/DigitalMessage.java | 2 +- .../internal/core/TelldusCoreDeviceController.java | 2 +- .../binding/tplinksmarthome/internal/Connection.java | 2 +- .../binding/velux/internal/VeluxRSBindingConfig.java | 2 +- .../bridge/slip/io/DataInputStreamWithTimeout.java | 2 +- .../binding/velux/internal/things/VeluxGwState.java | 2 +- .../binding/velux/internal/things/VeluxKLFAPI.java | 4 ++-- .../binding/velux/internal/things/VeluxProduct.java | 2 +- .../binding/velux/internal/things/VeluxProductType.java | 2 +- .../vigicrues/internal/dto/vigicrues/CdStationHydro.java | 2 +- .../vigicrues/internal/dto/vigicrues/InfoVigiCru.java | 2 +- .../vigicrues/internal/dto/vigicrues/TerEntVigiCru.java | 2 +- .../vigicrues/internal/dto/vigicrues/TronEntVigiCru.java | 2 +- .../vigicrues/internal/dto/vigicrues/VicANMoinsUn.java | 2 +- .../internal/handler/WolfSmartsetSystemBridgeHandler.java | 2 +- .../internal/handler/WolfSmartsetUnitThingHandler.java | 2 +- .../main/resources/OH-INF/i18n/wolfsmartset.properties | 4 ++-- .../src/main/resources/OH-INF/thing/thing-types.xml | 4 ++-- .../internal/handler/YamahaZoneThingHandler.java | 2 +- .../internal/YamahaReceiverHandlerTest.java | 2 +- .../zway/internal/converter/ZWayDeviceStateConverter.java | 8 ++++---- .../io/neeo/internal/models/NeeoDeviceChannelKind.java | 2 +- .../openhab/io/neeo/internal/models/NeeoDeviceType.java | 4 ++-- 140 files changed, 166 insertions(+), 166 deletions(-) diff --git a/bundles/org.openhab.automation.pidcontroller/src/main/java/org/openhab/automation/pidcontroller/internal/LowpassFilter.java b/bundles/org.openhab.automation.pidcontroller/src/main/java/org/openhab/automation/pidcontroller/internal/LowpassFilter.java index 880573180e0c0..2b4365c84f85b 100644 --- a/bundles/org.openhab.automation.pidcontroller/src/main/java/org/openhab/automation/pidcontroller/internal/LowpassFilter.java +++ b/bundles/org.openhab.automation.pidcontroller/src/main/java/org/openhab/automation/pidcontroller/internal/LowpassFilter.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Realizes an first-order FIR low pass filter. To keep code complexity low, it is implemented as moving average (all + * Realizes a first-order FIR low pass filter. To keep code complexity low, it is implemented as moving average (all * FIR coefficients are set to normalized ones). * * The exponential decaying function is used for the calculation (see https://en.wikipedia.org/wiki/Time_constant). That diff --git a/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java b/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java index ed0cd3353c3b5..8d7b7e62ba0ef 100644 --- a/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java +++ b/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java @@ -84,7 +84,7 @@ public class AutelisHandler extends BaseThingHandler { * Autelis controllers will not update their XML immediately after we change * a value. To compensate we cache previous values for a {@link Channel} * using the item name as a key. After a polling run has been executed we - * only update an channel if the value is different then what's in the + * only update a channel if the value is different then what's in the * cache. This cache is cleared after a fixed time period when commands are * sent. */ diff --git a/bundles/org.openhab.binding.dbquery/src/test/java/org/openhab/binding/dbquery/internal/domain/QueryResultJSONEncoderTest.java b/bundles/org.openhab.binding.dbquery/src/test/java/org/openhab/binding/dbquery/internal/domain/QueryResultJSONEncoderTest.java index a0459cbe0e34b..fdc4fbeba7b97 100644 --- a/bundles/org.openhab.binding.dbquery/src/test/java/org/openhab/binding/dbquery/internal/domain/QueryResultJSONEncoderTest.java +++ b/bundles/org.openhab.binding.dbquery/src/test/java/org/openhab/binding/dbquery/internal/domain/QueryResultJSONEncoderTest.java @@ -70,7 +70,7 @@ void givenQueryResultItsContentIsCorrectlySerializedToJson() { } private void assertReadGivenValuesDecodedFromJson(Map firstRow) { - assertThat(firstRow.get("strValue"), is("an string")); + assertThat(firstRow.get("strValue"), is("a string")); Object doubleValue = firstRow.get("doubleValue"); assertThat(doubleValue, instanceOf(Number.class)); @@ -124,7 +124,7 @@ private QueryResult givenQueryResultWithResults() { private Map givenRowValues() { Map values = new HashMap<>(); - values.put("strValue", "an string"); + values.put("strValue", "a string"); values.put("doubleValue", 2.3d); values.put("intValue", 3); values.put("longValue", Long.MAX_VALUE); diff --git a/bundles/org.openhab.binding.deconz/README.md b/bundles/org.openhab.binding.deconz/README.md index ea5759edbbe64..15e6838f5955d 100644 --- a/bundles/org.openhab.binding.deconz/README.md +++ b/bundles/org.openhab.binding.deconz/README.md @@ -167,7 +167,7 @@ Other devices support |-------------------|--------------------------|:-----------:|---------------------------------------|-------------------------------------------------| | brightness | Dimmer | R/W | Brightness of the light | `dimmablelight`, `colortemperaturelight` | | switch | Switch | R/W | State of an ON/OFF device | `onofflight` | -| color | Color | R/W | Color of an multi-color light | `colorlight`, `extendedcolorlight`, `lightgroup`| +| color | Color | R/W | Color of a multi-color light | `colorlight`, `extendedcolorlight`, `lightgroup`| | color_temperature | Number | R/W | Color temperature in Kelvin. The value range is determined by each individual light | `colortemperaturelight`, `extendedcolorlight`, `lightgroup` | | effect | String | R/W | Effect selection. Allowed commands are set dynamically | `colorlight` | | effectSpeed | Number | W | Effect Speed | `colorlight` | diff --git a/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/handler/LightThingHandler.java b/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/handler/LightThingHandler.java index 3f1d92f958b0e..2156ea4bb7695 100644 --- a/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/handler/LightThingHandler.java +++ b/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/handler/LightThingHandler.java @@ -303,7 +303,7 @@ protected void processStateResponse(DeconzBaseMessage stateResponse) { LightMessage lightMessage = (LightMessage) stateResponse; if (needsPropertyUpdate) { - // if we did not receive an ctmin/ctmax, then we probably don't need it + // if we did not receive a ctmin/ctmax, then we probably don't need it needsPropertyUpdate = false; Integer ctmax = lightMessage.ctmax; diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventAttribute.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventAttribute.java index e7cfb3e50e2a5..81c76a14a17e4 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventAttribute.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventAttribute.java @@ -377,7 +377,7 @@ private static List mapDateToStringList(@Nullable Date value) { } /** - * Returns an single station from an path value (i.e. pipe separated value of stations). + * Returns a single station from a path value (i.e. pipe separated value of stations). * * @param getPath Getter for the path. * @param returnFirst if true the first value will be returned, false will return the last @@ -401,8 +401,8 @@ private static List mapDateToStringList(@Nullable Date value) { } /** - * Returns all intermediate stations from an path. The first or last station will be omitted. The values will be - * separated by an single dash -. + * Returns all intermediate stations from a path. The first or last station will be omitted. The values will be + * separated by a single dash -. * * @param getPath Getter for the path. * @param removeFirst if true the first value will be removed, false will remove the last diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/AndOperator.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/AndOperator.java index abece42503091..ab3fd03bc00ee 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/AndOperator.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/AndOperator.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * A token representing an conjunction. + * A token representing a conjunction. * * @author Sönke Küper - Initial contribution. */ diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterParser.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterParser.java index 6c3350151bafc..27f1eb956410b 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterParser.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterParser.java @@ -134,7 +134,7 @@ public TimetableStopPredicate getResult() throws FilterParserException { } /** - * State while parsing an conjunction. + * State while parsing a conjunction. */ private static final class AndState extends State { @@ -226,7 +226,7 @@ public TimetableStopPredicate getResult() throws FilterParserException { } /** - * State while parsing an Subquery. + * State while parsing a Subquery. */ private static final class SubQueryState extends State { diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterScanner.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterScanner.java index 848b24b2067f8..10f0a76233a88 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterScanner.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterScanner.java @@ -90,7 +90,7 @@ public void finish(int position) { } /** - * State scanning an channel name until the equals-sign. + * State scanning a channel name until the equals-sign. */ private final class ChannelNameState implements State { diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterToken.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterToken.java index 13af0fc52c57d..65b086c3e86cd 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterToken.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterToken.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * A token representing a part of an filter expression. + * A token representing a part of a filter expression. * * @author Sönke Küper - Initial contribution. */ diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/OrOperator.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/OrOperator.java index a53d3784c97b0..060a168a16663 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/OrOperator.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/OrOperator.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * A token representing an disjunction. + * A token representing a disjunction. * * @author Sönke Küper - Initial contribution. */ diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/TimetableStopPredicate.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/TimetableStopPredicate.java index ddb7e555fe92d..e1acd7c6db294 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/TimetableStopPredicate.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/TimetableStopPredicate.java @@ -18,7 +18,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.dto.TimetableStop; /** - * Predicate to match an TimetableStop + * Predicate to match a TimetableStop * * @author Sönke Küper - initial contribution. */ diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetableLoader.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetableLoader.java index 892cb0d76de90..1a6b4f92993ec 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetableLoader.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetableLoader.java @@ -193,7 +193,7 @@ private void updatePlan(final Date currentTime) throws IOException { requestTime.setTime(currentTime); } - // Determine the max. time for which an plan is available + // Determine the max. time for which a plan is available final GregorianCalendar maxRequestTime = new GregorianCalendar(); maxRequestTime.setTime(currentTime); maxRequestTime.set(Calendar.HOUR_OF_DAY, maxRequestTime.get(Calendar.HOUR_OF_DAY) + MAX_ADVANCE_HOUR); @@ -225,7 +225,7 @@ private void updatePlan(final Date currentTime) throws IOException { private void processLoadedPlan(List stops, Date currentTime) { for (final TimetableStop stop : stops) { - // Check if an change for the stop was cached and apply it + // Check if a change for the stop was cached and apply it final TimetableStop change = this.cachedChanges.remove(stop.getId()); if (change != null) { TimetableStopMerger.merge(stop, change); @@ -275,7 +275,7 @@ private List loadChanges(final Date currentTime) throws IOExcepti return Collections.emptyList(); } - // The recent changes are only available for 120 seconds, so if last update is older perform an full update. + // The recent changes are only available for 120 seconds, so if last update is older perform a full update. if (secondsSinceLastUpdate >= MAX_RECENT_CHANGE_UPDATE) { fullChanges = true; } diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1Impl.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1Impl.java index 7e1b585554ac3..2a86ae06c27b4 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1Impl.java +++ b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1Impl.java @@ -101,7 +101,7 @@ public TimetablesV1Impl( // // The results from webservice does not conform to the schema provided. The triplabel-Element (tl) is expected // to occour as - // last Element within an timetableStop (s) element. But it is the first element when requesting the plan. + // last Element within a timetableStop (s) element. But it is the first element when requesting the plan. // When requesting the changes it is the last element, so the schema can't just be corrected. // If written to developer support, but got no response yet, so schema validation is disabled at the moment. diff --git a/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/TripLabelAttributeTest.java b/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/TripLabelAttributeTest.java index 9c1dce651c05f..ffa1d3b839a31 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/TripLabelAttributeTest.java +++ b/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/TripLabelAttributeTest.java @@ -48,7 +48,7 @@ private void doTestTripAttribute( // assertThat(attribute.getValue(new TripLabel()), is(nullValue())); assertThat(attribute.getState(new TripLabel()), is(nullValue())); - // Create an trip label and set the attribute value. + // Create a trip label and set the attribute value. final TripLabel labelWithValueSet = new TripLabel(); setValue.accept(labelWithValueSet); diff --git a/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ApiStub.java b/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ApiStub.java index 0f03138104440..6efe262e79d2b 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ApiStub.java +++ b/bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ApiStub.java @@ -20,7 +20,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.dto.Timetable; /** - * Stub Implementation of {@link TimetablesV1Api}, that may return an preconfigured Timetable or + * Stub Implementation of {@link TimetablesV1Api}, that may return a preconfigured Timetable or * throws an {@link IOException} if not data has been set. * * @author Sönke Küper - initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/README.md b/bundles/org.openhab.binding.digitalstrom/README.md index 4e35584c24a11..1448e90ef05ea 100644 --- a/bundles/org.openhab.binding.digitalstrom/README.md +++ b/bundles/org.openhab.binding.digitalstrom/README.md @@ -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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/handler/BridgeHandler.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/handler/BridgeHandler.java index 8992f19f3effc..b48731622ea5e 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/handler/BridgeHandler.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/handler/BridgeHandler.java @@ -632,7 +632,7 @@ public void onConnectionStateChange(String newConnectionState, String reason) { 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: diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseTemperatureControl.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseTemperatureControl.java index 3b93c6ab1ecb1..d29595c58f737 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseTemperatureControl.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseTemperatureControl.java @@ -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.
* 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. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseZoneIdentifier.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseZoneIdentifier.java index 94c7c2060697b..6a270d12dfecd 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseZoneIdentifier.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/BaseZoneIdentifier.java @@ -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 BaseZoneIdentifier(Integer zoneID, String zoneName) { } /** - * 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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/AssignedSensors.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/AssignedSensors.java index c7b5da322a215..67da01168d476 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/AssignedSensors.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/AssignedSensors.java @@ -47,7 +47,7 @@ public AssignedSensors(JsonObject jObject) { } /** - * 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. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java index 1360bd0cff462..4ca22a16d78b7 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java @@ -50,7 +50,7 @@ public SensorValues(JsonObject jObject) { } /** - * 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. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java index d35df54aa2b25..1567d703b8fc5 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java @@ -54,7 +54,7 @@ public TemperatureControlConfig(JsonObject jObject) { } /** - * 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.
* 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. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlStatus.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlStatus.java index abbbd299c7ca2..6831f68977d4a 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlStatus.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlStatus.java @@ -55,7 +55,7 @@ public TemperatureControlStatus(JsonObject jObject) { } /** - * 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.
* 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. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java index 175bbc63e62d0..d23c955b364ce 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java @@ -48,7 +48,7 @@ public TemperatureControlValues(JsonObject jObject) { } /** - * 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.
* 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. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java index 717fc8d673563..d83067f70b70a 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java @@ -17,7 +17,7 @@ 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() diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java index 732a833d814d7..d9f89f84ff356 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java @@ -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.
* Please have a look at {@link ChangeableDeviceConfigEnum} to see what configuration are changeable. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/ManagerStatusListener.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/ManagerStatusListener.java index 10bacbaadd897..dac68d54e5e00 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/ManagerStatusListener.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/ManagerStatusListener.java @@ -24,7 +24,7 @@ public interface ManagerStatusListener { /** - * This method is called whenever the state of an digitalSTROM-Manager has changed.
+ * This method is called whenever the state of a digitalSTROM-Manager has changed.
* For that it passes the {@link ManagerTypes} and the new {@link ManagerStates}. * * @param managerType of the digitalSTROM-Manager diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java index 737869f1cb21f..06566556b1255 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java @@ -28,7 +28,7 @@ /** *

* 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. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/StructureManager.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/StructureManager.java index 1408621467d37..9dcab1ee8d6c0 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/StructureManager.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/StructureManager.java @@ -110,7 +110,7 @@ public interface StructureManager { Map> 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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/HttpTransport.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/HttpTransport.java index 2d7352981b420..455cfc440af94 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/HttpTransport.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/HttpTransport.java @@ -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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java index 9ce829ac2b1f4..11a4d71b97e0c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java @@ -52,10 +52,10 @@ import org.slf4j.LoggerFactory; /** - * The {@link HttpTransportImpl} executes an request to the digitalSTROM-Server. + * The {@link HttpTransportImpl} executes a request to the digitalSTROM-Server. *

* 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)}. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/JSONResponseHandler.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/JSONResponseHandler.java index b78e32649b5c3..aa734a79c602a 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/JSONResponseHandler.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/JSONResponseHandler.java @@ -21,7 +21,7 @@ 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 static JsonObject toJsonObject(String jsonResponse) { 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; diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java index c85b42b7a4f8d..8ee4e833ff7f1 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java @@ -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 @@ void setSensorDataRefreshPriority(String powerConsumptionRefreshPriority, String 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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/CachedMeteringValue.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/CachedMeteringValue.java index 15b406a22b67a..0815fc8abf30c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/CachedMeteringValue.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/CachedMeteringValue.java @@ -20,7 +20,7 @@ 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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java index 04f8fddea056f..e13d7a1a9212a 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java @@ -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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java index 8b4e045c77464..ecc98469b306e 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java @@ -17,7 +17,7 @@ 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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java index 73060a3f1e3f7..0767e5bb5d8b8 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java @@ -28,7 +28,7 @@ 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 diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/impl/DeviceImpl.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/impl/DeviceImpl.java index 1e331473182af..85195e7c1430d 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/impl/DeviceImpl.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/impl/DeviceImpl.java @@ -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) diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/BaseDsI18n.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/BaseDsI18n.java index 25ef00a187c1a..6723aa34ae386 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/BaseDsI18n.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/BaseDsI18n.java @@ -85,8 +85,8 @@ protected void unsetTranslationProvider(TranslationProvider translationProvider) } /** - * 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 diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemDecimal.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemDecimal.java index 11d1ceb9c905e..9366609de33e9 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemDecimal.java +++ b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemDecimal.java @@ -18,7 +18,7 @@ import org.openhab.core.library.types.DecimalType; /** - * CosemInteger represents an decimal value + * CosemInteger represents a decimal value * * @author M. Volaart - Initial contribution * @author Hilbrand Bouwkamp - Combined Integer and Double because {@link DecimalType} handles both @@ -44,7 +44,7 @@ public CosemDecimal(String ohChannelId) { } /** - * Parses a String value (that represents an decimal) to a {@link DecimalType} object. + * Parses a String value (that represents a decimal) to a {@link DecimalType} object. * * @param cosemValue the value to parse * @return {@link DecimalType} representing the value of the cosem value diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/OBISIdentifier.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/OBISIdentifier.java index 8dc57e9183570..4ac4dfc07ee33 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/OBISIdentifier.java +++ b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/OBISIdentifier.java @@ -235,7 +235,7 @@ public int hashCode() { } /** - * Returns an reduced OBIS Identifier. + * Returns a reduced OBIS Identifier. * * @return reduced OBIS Identifier */ @@ -244,7 +244,7 @@ public OBISIdentifier getReducedOBISIdentifier() { } /** - * Returns an reduced OBIS Identifier with group E set to null (.i.e. not applicable) + * Returns a reduced OBIS Identifier with group E set to null (.i.e. not applicable) * * @return reduced OBIS Identifier */ diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRBridgeDiscoveryService.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRBridgeDiscoveryService.java index 5cd6345fb04e1..1406014f1ad76 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRBridgeDiscoveryService.java +++ b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRBridgeDiscoveryService.java @@ -62,7 +62,7 @@ * If a telegram is received with at least 1 Cosem Object a bridge is assumed available and a Thing is added (regardless * if there were problems receiving the telegram) and the discovery is stopped. * - * If there are communication problems the service will give an warning and give up + * If there are communication problems the service will give a warning and give up * * @author M. Volaart - Initial contribution * @author Hilbrand Bouwkamp - Refactored code to detect meters during actual discovery phase. diff --git a/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/handler/StatusHandler.java b/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/handler/StatusHandler.java index c68da39615aa3..211cf6e1e3172 100644 --- a/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/handler/StatusHandler.java +++ b/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/handler/StatusHandler.java @@ -17,7 +17,7 @@ import org.openhab.core.thing.ThingStatusDetail; /** - * functional interface to provide an function to update status of a thing or bridge. + * functional interface to provide a function to update status of a thing or bridge. * * @author Alexander Friese - initial contribution */ diff --git a/bundles/org.openhab.binding.ecobee/README.md b/bundles/org.openhab.binding.ecobee/README.md index de7d461625ba2..871fbb86dd38c 100644 --- a/bundles/org.openhab.binding.ecobee/README.md +++ b/bundles/org.openhab.binding.ecobee/README.md @@ -1176,7 +1176,7 @@ Switch SetTemperatureHold "Set Temperature Hold [%s]" Number:Temperature UserCool "User Selected Heat [%.1f %unit%]" Number:Temperature UserHeat "User Selected Cool [%.1f %unit%]" String UserClimateRef "User Climate Ref [%s]" -String SendMessage "Send an Message [%s]" +String SendMessage "Send a Message [%s]" String AcknowledgeAlert "Acknowledge An Alert [%s]" Switch GetAlerts "Get All Alerts [%s]" Switch GetEvents "Get All Events [%s]" diff --git a/bundles/org.openhab.binding.enigma2/README.md b/bundles/org.openhab.binding.enigma2/README.md index 154d857588952..2992c67e739b3 100644 --- a/bundles/org.openhab.binding.enigma2/README.md +++ b/bundles/org.openhab.binding.enigma2/README.md @@ -324,7 +324,7 @@ actions.sendQuestion("Say hello?") ### sendQuestion(text, timeout) -Sends an question message to the device with will be shown on the TV screen. +Sends a question message to the device with will be shown on the TV screen. The answer is provided to the "answer"-channel. Parameters: diff --git a/bundles/org.openhab.binding.enphase/src/main/java/org/openhab/binding/enphase/internal/handler/EnvoyBridgeHandler.java b/bundles/org.openhab.binding.enphase/src/main/java/org/openhab/binding/enphase/internal/handler/EnvoyBridgeHandler.java index cecc5d2577bea..17cfae6030744 100644 --- a/bundles/org.openhab.binding.enphase/src/main/java/org/openhab/binding/enphase/internal/handler/EnvoyBridgeHandler.java +++ b/bundles/org.openhab.binding.enphase/src/main/java/org/openhab/binding/enphase/internal/handler/EnvoyBridgeHandler.java @@ -398,7 +398,7 @@ public void dispose() { } /** - * @return Returns true if the bridge is online and not has an configuration pending. + * @return Returns true if the bridge is online and not has a configuration pending. */ public boolean isOnline() { return getThing().getStatus() == ThingStatus.ONLINE; diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusSymoInverterHandler.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusSymoInverterHandler.java index 1b8b328aba48b..71c6fd6389178 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusSymoInverterHandler.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusSymoInverterHandler.java @@ -163,7 +163,7 @@ protected State getValue(String channelId) { * get flow data for a specific inverter. * * @param number The inverter object of the given index - * @return an PowerFlowRealtimeInverter object. + * @return a PowerFlowRealtimeInverter object. */ private PowerFlowRealtimeInverter getInverter(final String number) { return powerFlowResponse.getBody().getData().getInverters().get(number); diff --git a/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/handler/GardenaDeviceConfig.java b/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/handler/GardenaDeviceConfig.java index 281e9f0860ab2..399b487a5769a 100644 --- a/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/handler/GardenaDeviceConfig.java +++ b/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/handler/GardenaDeviceConfig.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link GardenaDeviceConfig} class represents the configuration for a device connected to an Gardena account. + * The {@link GardenaDeviceConfig} class represents the configuration for a device connected to a Gardena account. * * @author Gerhard Riegler - Initial contribution */ diff --git a/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/rest/exceptions/GroupePSACommunicationException.java b/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/rest/exceptions/GroupePSACommunicationException.java index 8ea05e487a569..6c551ff538ccb 100644 --- a/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/rest/exceptions/GroupePSACommunicationException.java +++ b/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/rest/exceptions/GroupePSACommunicationException.java @@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * An exception that occurred while communicating with an groupepsa or an groupepsa bridge + * An exception that occurred while communicating with a groupepsa or a groupepsa bridge * * @author Arjan Mels - Initial contribution */ diff --git a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java index 86393e62087a9..a5e54b8ee530e 100644 --- a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java +++ b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java @@ -21,7 +21,7 @@ /** * The {@Link HeosStringPropertyChangeListener} provides the possibility - * to add a listener to an String and get informed about the new value. + * to add a listener to a String and get informed about the new value. * * @author Johannes Einig - Initial contribution */ diff --git a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java index a19f852d0e9d9..3b157ed720e9c 100644 --- a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java +++ b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java @@ -37,7 +37,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link Telnet} is an Telnet Client which handles the connection + * The {@link Telnet} is a Telnet Client which handles the connection * to a network via the Telnet interface * * @author Johannes Einig - Initial contribution diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/handler/SimplePortPool.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/handler/SimplePortPool.java index fc501403b5aaf..466bb19033eef 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/handler/SimplePortPool.java +++ b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/handler/SimplePortPool.java @@ -27,7 +27,7 @@ public class SimplePortPool { private List availablePorts = new ArrayList<>(); /** - * Adds the specified port to the pool an mark it as in use. + * Adds the specified port to the pool and mark it as in use. */ public void setInUse(int port) { PortInfo portInfo = new PortInfo(); diff --git a/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/protocol/v1/Correction.java b/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/protocol/v1/Correction.java index 1c0f024094480..32c9159a8fd54 100644 --- a/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/protocol/v1/Correction.java +++ b/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/protocol/v1/Correction.java @@ -17,7 +17,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link Correction} is a POJO for an color correction on the Hyperion server. + * The {@link Correction} is a POJO for a color correction on the Hyperion server. * * @author Daniel Walters - Initial contribution */ diff --git a/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/handler/IAqualinkHandler.java b/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/handler/IAqualinkHandler.java index d2ae0dc51b5bd..ad0f9c2791b5a 100644 --- a/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/handler/IAqualinkHandler.java +++ b/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/handler/IAqualinkHandler.java @@ -416,7 +416,7 @@ private void pollController() { } /** - * Update an channels state only if the value of the channel has changed since our last poll. + * Update a channel state only if the value of the channel has changed since our last poll. * * @param name * @param value diff --git a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/BiweeklyPresentableCalendar.java b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/BiweeklyPresentableCalendar.java index 02d64bbdf5e0b..4deff64fd95f3 100644 --- a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/BiweeklyPresentableCalendar.java +++ b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/BiweeklyPresentableCalendar.java @@ -375,7 +375,7 @@ private DateIterator getRecurredEventDateIterator(VEvent vEvent) { } /** - * Checks whether an counter event blocks an event with given uid and start. + * Checks whether a counter event blocks an event with given uid and start. * * @param startInstant The start of the event. * @param eventUid The uid of the event. diff --git a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java index d4a35318d9d08..dd598d5b9859b 100644 --- a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java +++ b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * An type enumerator to indicate whether a Command Tag is of type BEGIN or END; as in the following examples: + * A type enumerator to indicate whether a Command Tag is of type BEGIN or END; as in the following examples: * * BEGIN:: * END:: diff --git a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/MsgFactory.java b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/MsgFactory.java index 9029fd65859c6..aaa3be7c5119c 100644 --- a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/MsgFactory.java +++ b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/MsgFactory.java @@ -22,7 +22,7 @@ /** * This class takes data coming from the serial port and turns it - * into an message. For that, it has to figure out the length of the + * into a message. For that, it has to figure out the length of the * message from the header, and read enough bytes until it hits the * message boundary. The code is tricky, partly because the Insteon protocol is. * Most of the time the command code (second byte) is enough to determine the length diff --git a/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/handler/KeContactHandler.java b/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/handler/KeContactHandler.java index 54867b0d879b9..08406fe9cbe56 100644 --- a/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/handler/KeContactHandler.java +++ b/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/handler/KeContactHandler.java @@ -182,7 +182,7 @@ private void pollingRunnable() { if (!isKebaReachable()) { logger.debug("isKebaReachable() timed out after '{}' milliseconds", System.currentTimeMillis() - stamp); updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, - "An timeout occurred while polling the charging station"); + "A timeout occurred while polling the charging station"); } else { ByteBuffer response = cache.get(CACHE_REPORT_1); if (response == null) { diff --git a/bundles/org.openhab.binding.kodi/README.md b/bundles/org.openhab.binding.kodi/README.md index 220347702c239..60ce5b4e84ae6 100644 --- a/bundles/org.openhab.binding.kodi/README.md +++ b/bundles/org.openhab.binding.kodi/README.md @@ -1,6 +1,6 @@ # Kodi Binding -[Kodi](https://kodi.tv) (formerly known as XBMC) is an free and open source (GPL) software media center for playing videos, music, pictures, games, and more. +[Kodi](https://kodi.tv) (formerly known as XBMC) is a free and open source (GPL) software media center for playing videos, music, pictures, games, and more. Kodi runs on Linux, OS X, BSD, Windows, iOS, and Android. It allows users to play and view most videos, music, podcasts, and other digital media files from local and network storage media and the internet. diff --git a/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java b/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java index 702e3d154636a..879e5ef3bbdda 100644 --- a/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java +++ b/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java @@ -15,7 +15,7 @@ import java.util.List; /** - * The {@link SecondGenerationDxsEntriesContainer} class defines an Container, which is + * The {@link SecondGenerationDxsEntriesContainer} class defines a Container, which is * used in the second generation part of the binding. * * @author Örjan Backsell - Initial contribution Piko1020, Piko New Generation diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java index 25a53beea1ab0..e9a95dd88477d 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java @@ -365,7 +365,7 @@ public void updateFirmwareVersionProperty(String firmwareVersion) { } /** - * Invoked when an trigger for this LCN module should be fired to openHAB. + * Invoked when a trigger for this LCN module should be fired to openHAB. * * @param channelGroup the Channel to update * @param channelId the ID within the Channel to update diff --git a/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/handler/core/ChannelInfo.java b/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/handler/core/ChannelInfo.java index eb1f7a8eb6dce..d3868ad7e7eb0 100644 --- a/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/handler/core/ChannelInfo.java +++ b/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/handler/core/ChannelInfo.java @@ -35,7 +35,7 @@ /** * {@link ChannelInfo} is a value object to describe a channel on WebOSTV. - * The id value is mandatory when starting an channel. The channelName is a human readable friendly name, which is not + * The id value is mandatory when starting a channel. The channelName is a human readable friendly name, which is not * further interpreted by the TV. * * @author Hyun Kook Khang - Connect SDK initial contribution diff --git a/bundles/org.openhab.binding.linuxinput/src/main/java/org/openhab/binding/linuxinput/internal/LinuxInputHandler.java b/bundles/org.openhab.binding.linuxinput/src/main/java/org/openhab/binding/linuxinput/internal/LinuxInputHandler.java index 7f8e40c893fb4..ede2656b89a8b 100644 --- a/bundles/org.openhab.binding.linuxinput/src/main/java/org/openhab/binding/linuxinput/internal/LinuxInputHandler.java +++ b/bundles/org.openhab.binding.linuxinput/src/main/java/org/openhab/binding/linuxinput/internal/LinuxInputHandler.java @@ -149,7 +149,7 @@ void handleEventsInThread() throws IOException { @Nullable EvdevDevice currentDevice = device; if (currentDevice == null) { - throw new IOException("trying to handle events without an device"); + throw new IOException("trying to handle events without a device"); } SelectionKey evdevReady = currentDevice.register(selector); diff --git a/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightAnalog.java b/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightAnalog.java index 6065f54c92f11..b959130b5eb8d 100644 --- a/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightAnalog.java +++ b/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightAnalog.java @@ -15,7 +15,7 @@ import org.openhab.binding.loxone.internal.types.LxUuid; /** - * An LeftRightAnalog type of control on Loxone Miniserver. + * A LeftRightAnalog type of control on Loxone Miniserver. *

* According to Loxone API documentation, LeftRightAnalog control is a virtual input that is analog and has an input * type diff --git a/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightDigital.java b/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightDigital.java index a7925eaa77f2c..b5b442a10a188 100644 --- a/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightDigital.java +++ b/bundles/org.openhab.binding.loxone/src/main/java/org/openhab/binding/loxone/internal/controls/LxControlLeftRightDigital.java @@ -15,7 +15,7 @@ import org.openhab.binding.loxone.internal.types.LxUuid; /** - * An LeftRightDigital type of control on Loxone Miniserver. + * A LeftRightDigital type of control on Loxone Miniserver. *

* According to Loxone API documentation, LeftRightDigital control is a virtual input that is digital and has an input * type left-right buttons. It has no states and can only accept commands. Only left/right (which are actually equal to diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/SocketSession.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/SocketSession.java index b3c1e0ab5f26f..b7b61fc4e77bb 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/SocketSession.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/SocketSession.java @@ -31,7 +31,7 @@ import org.slf4j.LoggerFactory; /** - * Represents a restartable socket connection to the underlying telnet session with an GRX-PRG/GRX-CI-PRG. Commands can + * Represents a restartable socket connection to the underlying telnet session with a GRX-PRG/GRX-CI-PRG. Commands can * be sent via {@link #sendCommand(String)} and responses will be received on the {@link SocketSessionCallback} * * @author Tim Roberts - Initial contribution diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/discovery/MagentaTVDiscoveryParticipant.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/discovery/MagentaTVDiscoveryParticipant.java index a7379379d5083..0e999f5a90f94 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/discovery/MagentaTVDiscoveryParticipant.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/discovery/MagentaTVDiscoveryParticipant.java @@ -63,7 +63,7 @@ public Set getSupportedThingTypeUIDs() { ThingUID uid = getThingUID(device); if (uid != null) { - logger.debug("Discovered an MagentaTV Media Receiver {}, UDN: {}, Model {}.{}", + logger.debug("Discovered a MagentaTV Media Receiver {}, UDN: {}, Model {}.{}", device.getDetails().getFriendlyName(), device.getIdentity().getUdn().getIdentifierString(), modelName, device.getDetails().getModelDetails().getModelNumber()); diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java index 8f8a69fe2e29c..c42409964dd5b 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java @@ -69,7 +69,7 @@ public static final String toHex(boolean[] bits) { } /** - * Converts an Java signed byte into its general (unsigned) value as being + * Converts a Java signed byte into its general (unsigned) value as being * used in other programming languages and platforms. * * @param b diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemInfromationBlockParser.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemInfromationBlockParser.java index 65bb1ebcf5aff..ad83510e8a114 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemInfromationBlockParser.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemInfromationBlockParser.java @@ -17,7 +17,7 @@ import org.openhab.core.io.transport.modbus.ModbusRegisterArray; /** - * Parses inverter modbus data into an SystemB Information lock + * Parses inverter modbus data into a SystemB Information lock * * @author Paul Frank - Initial contribution * diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemParameterBlockParser.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemParameterBlockParser.java index 6fbb15825dab5..4ea4f7898c231 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemParameterBlockParser.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemParameterBlockParser.java @@ -17,7 +17,7 @@ import org.openhab.core.io.transport.modbus.ModbusRegisterArray; /** - * Parses inverter modbus data into an System Parameter Block + * Parses inverter modbus data into a System Parameter Block * * @author Paul Frank - Initial contribution * diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemStateBlockParser.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemStateBlockParser.java index 6571fdbc6ed46..53ea57a31f849 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemStateBlockParser.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/parser/SystemStateBlockParser.java @@ -17,7 +17,7 @@ import org.openhab.core.io.transport.modbus.ModbusRegisterArray; /** - * Parses inverter modbus data into an System State Block + * Parses inverter modbus data into a System State Block * * @author Paul Frank - Initial contribution * diff --git a/bundles/org.openhab.binding.modbus/README.md b/bundles/org.openhab.binding.modbus/README.md index cd967d5f51c8e..7cbc606efb3e5 100644 --- a/bundles/org.openhab.binding.modbus/README.md +++ b/bundles/org.openhab.binding.modbus/README.md @@ -9,7 +9,7 @@ The binding can act as * Modbus TCP Client (that is, as modbus master), querying data from Modbus TCP servers (that is, modbus slaves) * Modbus serial master, querying data from modbus serial slaves -The Modbus binding polls the slave data with an configurable poll period. +The Modbus binding polls the slave data with a configurable poll period. openHAB commands are translated to write requests. The binding has the following extensions: diff --git a/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/i18n/modbus.properties b/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/i18n/modbus.properties index 038370585910e..bee8c2ea995ad 100644 --- a/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/i18n/modbus.properties +++ b/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/i18n/modbus.properties @@ -44,7 +44,7 @@ thing-type.config.modbus.data.writeMaxTries.description = Number of tries when w thing-type.config.modbus.data.writeMultipleEvenWithSingleRegisterOrCoil.label = Write Multiple Even with Single Register or Coil thing-type.config.modbus.data.writeMultipleEvenWithSingleRegisterOrCoil.description = Whether single register / coil of data is written using FC16 ("Write Multiple Holding Registers") / FC15 ("Write Multiple Coils"), respectively.

If false, FC6/FC5 are used with single register and single coil, respectively. thing-type.config.modbus.data.writeStart.label = Write Address -thing-type.config.modbus.data.writeStart.description = Start address of the first holding register or coil in the write. Use empty for read-only things.
Use zero based address, e.g. in place of 400001 (first holding register), use the address 0. This address is passed to data frame as is.
One can write individual bits of an register using X.Y format where X is the register and Y is the bit (0 refers to least significant bit). +thing-type.config.modbus.data.writeStart.description = Start address of the first holding register or coil in the write. Use empty for read-only things.
Use zero based address, e.g. in place of 400001 (first holding register), use the address 0. This address is passed to data frame as is.
One can write individual bits of a register using X.Y format where X is the register and Y is the bit (0 refers to least significant bit). thing-type.config.modbus.data.writeTransform.label = Write Transform thing-type.config.modbus.data.writeTransform.description = Transformation to apply to received commands.

Use "default" to communicate that no transformation is done and value should be passed as is.
Use SERVICENAME(ARG) or SERVICENAME:ARG to use transformation service.
Any other value than the above types will be interpreted as static text, in which case the actual content of the command
You can chain many transformations with ∩, for example SERVICE1:ARG1∩SERVICE2:ARG2 value is ignored. thing-type.config.modbus.data.writeType.label = Write Type diff --git a/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/thing/thing-data.xml b/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/thing/thing-data.xml index 0de4849a6b378..f063aa846b30d 100644 --- a/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/thing/thing-data.xml +++ b/bundles/org.openhab.binding.modbus/src/main/resources/OH-INF/thing/thing-data.xml @@ -82,7 +82,7 @@ Use zero based address, e.g. in place of 400001 (first holding register), use the address 0. This address is passed to data frame as is. -
One can write individual bits of an register using X.Y format where X is the register and Y is the bit (0 refers to least significant bit). +
One can write individual bits of a register using X.Y format where X is the register and Y is the bit (0 refers to least significant bit). ]]>
diff --git a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/values/RollershutterValue.java b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/values/RollershutterValue.java index b8f37e05ce88b..501dbb557f705 100644 --- a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/values/RollershutterValue.java +++ b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/values/RollershutterValue.java @@ -24,7 +24,7 @@ import org.openhab.core.types.Command; /** - * Implements an rollershutter value. + * Implements a rollershutter value. *

* The stop, up and down strings have multiple purposes. * For one if those strings are received via MQTT they are recognised as corresponding commands diff --git a/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/ComponentChannel.java b/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/ComponentChannel.java index 5e603b8432178..74313bff3cc47 100644 --- a/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/ComponentChannel.java +++ b/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/ComponentChannel.java @@ -96,7 +96,7 @@ public ChannelState getState() { public CompletableFuture<@Nullable Void> start(MqttBrokerConnection connection, ScheduledExecutorService scheduler, int timeout) { - // Make sure we set the callback again which might have been nulled during an stop + // Make sure we set the callback again which might have been nulled during a stop channelState.setChannelStateUpdateListener(this.channelStateUpdateListener); return channelState.start(connection, scheduler, timeout); diff --git a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java index 016ecfc227d09..6d6775f59f415 100644 --- a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java +++ b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java @@ -291,7 +291,7 @@ public void createChannelFromAttribute() { f.completeExceptionally(new IllegalStateException("Attributes not yet received!")); return f; } - // Make sure we set the callback again which might have been nulled during an stop + // Make sure we set the callback again which might have been nulled during a stop channelState.setChannelStateUpdateListener(this.callback); return channelState.start(connection, scheduler, timeout); } diff --git a/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoAction.java b/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoAction.java index 7ee1019040bf2..94a0c8d5ff737 100644 --- a/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoAction.java +++ b/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoAction.java @@ -18,7 +18,7 @@ import com.google.gson.annotations.SerializedName; /** - * The model representing an forward actions result (serialize/deserialize json use only). + * The model representing a forward actions result (serialize/deserialize json use only). * * @author Tim Roberts - Initial contribution * diff --git a/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoForwardActions.java b/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoForwardActions.java index 987b81e597953..ddfd15d86c75d 100644 --- a/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoForwardActions.java +++ b/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/models/NeeoForwardActions.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The model representing an forward actions request (serialize/deserialize json use only). + * The model representing a forward actions request (serialize/deserialize json use only). * * @author Tim Roberts - Initial contribution */ diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/wwn/dto/WWNUpdateRequest.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/wwn/dto/WWNUpdateRequest.java index 915c0c613dc2e..03b1e3fd02899 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/wwn/dto/WWNUpdateRequest.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/wwn/dto/WWNUpdateRequest.java @@ -16,7 +16,7 @@ import java.util.Map; /** - * Contains the data needed to do an WWN update request back to Nest. + * Contains the data needed to do a WWN update request back to Nest. * * @author David Bennett - Initial contribution */ diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/resources/OH-INF/i18n/nikohomecontrol.properties b/bundles/org.openhab.binding.nikohomecontrol/src/main/resources/OH-INF/i18n/nikohomecontrol.properties index 7c1f12cd35349..8ae3b792126c1 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/resources/OH-INF/i18n/nikohomecontrol.properties +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/resources/OH-INF/i18n/nikohomecontrol.properties @@ -119,7 +119,7 @@ offline.configuration-error.actionRemoved = Action has been removed from control offline.configuration-error.energyMeterId = Configured energy meter ID does not match an energy meter in controller offline.configuration-error.energyMeterRemoved = Energy meter has been removed from controller -offline.configuration-error.thermostatId = Configured thermostat ID does not match an thermostat in controller +offline.configuration-error.thermostatId = Configured thermostat ID does not match a thermostat in controller offline.configuration-error.thermostatRemoved = Thermostat has been removed from controller offline.configuration-error.invalid-bridge-handler = Invalid bridge handler diff --git a/bundles/org.openhab.binding.nobohub/src/main/java/org/openhab/binding/nobohub/internal/model/WeekProfileRegister.java b/bundles/org.openhab.binding.nobohub/src/main/java/org/openhab/binding/nobohub/internal/model/WeekProfileRegister.java index b8cc4df700ab3..1b1fc693f4917 100644 --- a/bundles/org.openhab.binding.nobohub/src/main/java/org/openhab/binding/nobohub/internal/model/WeekProfileRegister.java +++ b/bundles/org.openhab.binding.nobohub/src/main/java/org/openhab/binding/nobohub/internal/model/WeekProfileRegister.java @@ -32,7 +32,7 @@ public final class WeekProfileRegister { private @NotNull Map register = new HashMap(); /** - * Stores a new week profile in the register. If an week profile exists with the same id, that value is overwritten. + * Stores a new week profile in the register. If a week profile exists with the same id, that value is overwritten. * * @param profile The week profile to store. */ diff --git a/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/i18n/omnilink.properties b/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/i18n/omnilink.properties index d96696757d46c..72c9c55e2564c 100644 --- a/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/i18n/omnilink.properties +++ b/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/i18n/omnilink.properties @@ -40,7 +40,7 @@ thing-type.omnilink.humidity_sensor.description = A humidity sensor configured i thing-type.omnilink.lock.label = Lock thing-type.omnilink.lock.description = An access control reader lock configured in the controller. thing-type.omnilink.lumina_area.label = Lumina Area -thing-type.omnilink.lumina_area.description = An Lumina area configured in the controller. +thing-type.omnilink.lumina_area.description = A Lumina area configured in the controller. thing-type.omnilink.output.label = Voltage Output thing-type.omnilink.output.description = A voltage output configured in the controller. thing-type.omnilink.output.channel.switch.label = Voltage Output Switch diff --git a/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/area.xml b/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/area.xml index 021e2fd5b89c7..45ef59d0fd60e 100644 --- a/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/area.xml +++ b/bundles/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/area.xml @@ -46,7 +46,7 @@ - An Lumina area configured in the controller. + A Lumina area configured in the controller. diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/BAE0910.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/BAE0910.java index 7e4348083f233..847f82269eeb4 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/BAE0910.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/BAE0910.java @@ -40,7 +40,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link BAE0910} class defines an BAE0910 device + * The {@link BAE0910} class defines a BAE0910 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS18x20.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS18x20.java index f09e81cc06948..72888a6aa913a 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS18x20.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS18x20.java @@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link DS18x20} class defines an DS18x20 or DS1822 device + * The {@link DS18x20} class defines a DS18x20 or DS1822 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS1923.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS1923.java index 30ca59ff1ed7a..83a5b49ad6a0d 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS1923.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS1923.java @@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link DS1923} class defines an DS1923 device + * The {@link DS1923} class defines a DS1923 device * * @author Jan N. Klug - Initial contribution * @author Michał Wójcik - Adapted to DS1923 diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2401.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2401.java index bcb1aa0ddffec..616ebbd80cd86 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2401.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2401.java @@ -19,7 +19,7 @@ import org.openhab.binding.onewire.internal.handler.OwserverBridgeHandler; /** - * The {@link DS2401} class defines an DS2401 (iButton) device + * The {@link DS2401} class defines a DS2401 (iButton) device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2405.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2405.java index 040df27706726..3b60389ea4eb3 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2405.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2405.java @@ -20,7 +20,7 @@ import org.openhab.binding.onewire.internal.owserver.OwserverDeviceParameter; /** - * The {@link DS2405} class defines an DS2405 device + * The {@link DS2405} class defines a DS2405 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2406_DS2413.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2406_DS2413.java index 534489357869d..9037b85ea496f 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2406_DS2413.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2406_DS2413.java @@ -20,7 +20,7 @@ import org.openhab.binding.onewire.internal.owserver.OwserverDeviceParameter; /** - * The {@link DS2406_DS2413} class defines an DS2406 or DS2413 device + * The {@link DS2406_DS2413} class defines a DS2406 or DS2413 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2408.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2408.java index c36c66080be65..1396b0567daaa 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2408.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2408.java @@ -20,7 +20,7 @@ import org.openhab.binding.onewire.internal.owserver.OwserverDeviceParameter; /** - * The {@link DS2408} class defines an DS2408 device + * The {@link DS2408} class defines a DS2408 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2423.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2423.java index f37b40a2b24b0..e8bc7a21df223 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2423.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2423.java @@ -27,7 +27,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link DS2423} class defines an DS2423 device + * The {@link DS2423} class defines a DS2423 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2438.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2438.java index e003e933957c8..95b9fd2e5047c 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2438.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/device/DS2438.java @@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link DS2438} class defines an DS2438 device + * The {@link DS2438} class defines a DS2438 device * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java index 49eb8e79a106a..f10812083c448 100644 --- a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java +++ b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java @@ -164,7 +164,7 @@ protected void resultParser(String returnContent) throws GeneralApiException { switch (returnCode) { case -1: throw new UnknownApiException( - "The OpenSprinkler API returnd an result that was not parseable: " + returnContent); + "The OpenSprinkler API returnd a result that was not parseable: " + returnContent); case 1: return; case 2: diff --git a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/util/Parse.java b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/util/Parse.java index eebd9f3e575d9..9895d9ae80345 100644 --- a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/util/Parse.java +++ b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/util/Parse.java @@ -112,7 +112,7 @@ public static List jsonIntArray(String jsonData, String keyName) { } /** - * Parses an String array from a JSON string given its key name. + * Parses a String array from a JSON string given its key name. * * @param jsonData The JSON formatted string to parse from. * @param keyName The name of the object array to search through. diff --git a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java index e91dbd4b7b492..298957781aa4b 100644 --- a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java +++ b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java @@ -44,7 +44,7 @@ public static ThingUID getThingUIDreverse(ThingTypeUID thingTypeUID, byte module } /** - * Convert the byte b into an binary String + * Convert the byte b into a binary String * * @param b * @return diff --git a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/handler/PHCBridgeHandler.java b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/handler/PHCBridgeHandler.java index bede8a6563c0f..d2e60b428699c 100644 --- a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/handler/PHCBridgeHandler.java +++ b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/handler/PHCBridgeHandler.java @@ -438,7 +438,7 @@ private void sendQueueObject(QueueObject qo) { amOutputState[qo.getModuleAddress() & 0x1F] = -1; } else if (PHCBindingConstants.CHANNELS_DIM.equals(qo.getModuleType())) { // state ist the same for every dim level except zero/off -> inizialize state - // with 0x0F after sending an command. + // with 0x0F after sending a command. dmOutputState[qo.getModuleAddress() & 0x1F] |= (0x0F << (qo.getChannel() * 4)); } diff --git a/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/i18n/phc.properties b/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/i18n/phc.properties index c7c4edd8764e1..c6e76ede82e85 100644 --- a/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/i18n/phc.properties +++ b/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/i18n/phc.properties @@ -12,7 +12,7 @@ thing-type.phc.DIM.description = Thing for a dimmer module (DM). thing-type.phc.EM.label = PHC EM thing-type.phc.EM.description = Thing for an input/switch module (EM). thing-type.phc.JRM.label = PHC JRM -thing-type.phc.JRM.description = Thing for an shutter module (JRM). +thing-type.phc.JRM.description = Thing for a shutter module (JRM). thing-type.phc.bridge.label = PHC Bridge thing-type.phc.bridge.description = The serial bridge to the PHC modules. Max 32 modules per model group(thing type) per Bridge, equates one STM. @@ -63,6 +63,6 @@ channel-type.phc.dim-channel.description = Channel for a DIM module. channel-type.phc.em-channel.label = PHC EM Channel channel-type.phc.em-channel.description = Channel from an EM module. channel-type.phc.jrm-channel.label = PHC JRM Channel -channel-type.phc.jrm-channel.description = Channel to an JRM module. +channel-type.phc.jrm-channel.description = Channel to a JRM module. channel-type.phc.jrmTime-channel.label = JRM-time Channel -channel-type.phc.jrmTime-channel.description = The Time in seconds for an JRM channel. +channel-type.phc.jrmTime-channel.description = The Time in seconds for a JRM channel. diff --git a/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/channel-types.xml b/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/channel-types.xml index 6c6cf128b6c74..990b5e66e7b4e 100644 --- a/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/channel-types.xml +++ b/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/channel-types.xml @@ -90,13 +90,13 @@ Rollershutter - Channel to an JRM module. + Channel to a JRM module. Number - The Time in seconds for an JRM channel. + The Time in seconds for a JRM channel. diff --git a/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/thing-types.xml index c0de447653961..020161b41298a 100644 --- a/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.phc/src/main/resources/OH-INF/thing/thing-types.xml @@ -69,7 +69,7 @@ - Thing for an shutter module (JRM). + Thing for a shutter module (JRM). diff --git a/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/items/AbstractDeviceConfig.java b/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/items/AbstractDeviceConfig.java index 493293147ae28..7ed72b86075e8 100644 --- a/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/items/AbstractDeviceConfig.java +++ b/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/items/AbstractDeviceConfig.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Abstract root class for all items in an pulseaudio server. Every item in a + * Abstract root class for all items in a pulseaudio server. Every item in a * pulseaudio server has a name and a unique id which can be inherited by this * class. * diff --git a/bundles/org.openhab.binding.pushover/src/main/java/org/openhab/binding/pushover/internal/dto/Sound.java b/bundles/org.openhab.binding.pushover/src/main/java/org/openhab/binding/pushover/internal/dto/Sound.java index e5815b6ec9a82..b92bcc26fb442 100644 --- a/bundles/org.openhab.binding.pushover/src/main/java/org/openhab/binding/pushover/internal/dto/Sound.java +++ b/bundles/org.openhab.binding.pushover/src/main/java/org/openhab/binding/pushover/internal/dto/Sound.java @@ -16,7 +16,7 @@ import org.openhab.core.config.core.ParameterOption; /** - * The {@link Sound} is the Java class used to map the JSON response to an Pushover API request.. + * The {@link Sound} is the Java class used to map the JSON response to a Pushover API request.. * * @author Christoph Weitkamp - Initial contribution */ diff --git a/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Icon.java b/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Icon.java index 4773543d34907..a40d3b94d7c4f 100644 --- a/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Icon.java +++ b/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Icon.java @@ -16,7 +16,7 @@ import org.openhab.core.config.core.ParameterOption; /** - * The {@link Icons} is the Java class used to map the JSON response to an Pushsafer API request.. + * The {@link Icons} is the Java class used to map the JSON response to a Pushsafer API request.. * * @author Kevin Siml - Initial contribution, forked from Christoph Weitkamp */ diff --git a/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Sound.java b/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Sound.java index d6f7342d93b2c..31d76c2fd11d5 100644 --- a/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Sound.java +++ b/bundles/org.openhab.binding.pushsafer/src/main/java/org/openhab/binding/pushsafer/internal/dto/Sound.java @@ -16,7 +16,7 @@ import org.openhab.core.config.core.ParameterOption; /** - * The {@link Sound} is the Java class used to map the JSON response to an Pushsafer API request. + * The {@link Sound} is the Java class used to map the JSON response to a Pushsafer API request. * * @author Kevin Siml - Initial contribution, forked from Christoph Weitkamp */ diff --git a/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/rego6xx/Rego6xxProtocolException.java b/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/rego6xx/Rego6xxProtocolException.java index 5204316da865d..3c266e9fad634 100644 --- a/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/rego6xx/Rego6xxProtocolException.java +++ b/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/rego6xx/Rego6xxProtocolException.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link Rego6xxProtocolException} is responsible for holding information about an Rego6xx protocol error. + * The {@link Rego6xxProtocolException} is responsible for holding information about a Rego6xx protocol error. * * @author Boris Krivonog - Initial contribution */ diff --git a/bundles/org.openhab.binding.rfxcom/README.md b/bundles/org.openhab.binding.rfxcom/README.md index 8cc9863804646..92974b32abe9c 100644 --- a/bundles/org.openhab.binding.rfxcom/README.md +++ b/bundles/org.openhab.binding.rfxcom/README.md @@ -978,7 +978,7 @@ using them to configure a raw thing item. information. * closedPulses - Closed Pulses - * Pulses to send for an CLOSED command. Space delimited pulse lengths + * Pulses to send for a CLOSED command. Space delimited pulse lengths in usec. Must be an even number of pulse lengths, with a maximum of 142 total pulses. Max pulse length is 65535. Pulses of value 0 will be transmitted as 10000. See the RFXtfx user guide for more diff --git a/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/i18n/rfxcom.properties b/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/i18n/rfxcom.properties index 83ce9eba54119..718e0c03c3630 100644 --- a/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/i18n/rfxcom.properties +++ b/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/i18n/rfxcom.properties @@ -223,7 +223,7 @@ thing-type.config.rfxcom.rain.subType.option.RAIN5 = WS2300 thing-type.config.rfxcom.rain.subType.option.RAIN6 = La Crosse TX5 thing-type.config.rfxcom.rain.subType.option.RAIN9 = TFA 30.3233.1 thing-type.config.rfxcom.raw.closedPulses.label = Closed Pulses -thing-type.config.rfxcom.raw.closedPulses.description = Pulses to send for an CLOSED command. Space delimited pulse lengths in usec. Must be an even number of pulse lengths, with a maximum of 142 total pulses. Max pulse length is 65535. Pulses of value 0 will be transmitted as 10000. See the RFXtfx user guide for more information. +thing-type.config.rfxcom.raw.closedPulses.description = Pulses to send for a CLOSED command. Space delimited pulse lengths in usec. Must be an even number of pulse lengths, with a maximum of 142 total pulses. Max pulse length is 65535. Pulses of value 0 will be transmitted as 10000. See the RFXtfx user guide for more information. thing-type.config.rfxcom.raw.deviceId.description = Received raw message cannot provide a device ID, so to receive raw messages the device id must be RAW. For transmit-only things, use any device id. thing-type.config.rfxcom.raw.offPulses.label = Off Pulses thing-type.config.rfxcom.raw.offPulses.description = Pulses to send for an OFF command. Space delimited pulse lengths in usec. Must be an even number of pulse lengths, with a maximum of 142 total pulses. Max pulse length is 65535. Pulses of value 0 will be transmitted as 10000. See the RFXtfx user guide for more information. diff --git a/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/thing/raw.xml b/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/thing/raw.xml index 157005717be44..950da40e740e7 100644 --- a/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/thing/raw.xml +++ b/bundles/org.openhab.binding.rfxcom/src/main/resources/OH-INF/thing/raw.xml @@ -63,7 +63,7 @@ - Pulses to send for an CLOSED command. Space delimited pulse lengths in usec. Must be an even number of + Pulses to send for a CLOSED command. Space delimited pulse lengths in usec. Must be an even number of pulse lengths, with a maximum of 142 total pulses. Max pulse length is 65535. Pulses of value 0 will be transmitted as 10000. See the RFXtfx user guide for more information. diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/discovery/RioSystemDeviceDiscoveryService.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/discovery/RioSystemDeviceDiscoveryService.java index 9cf21c93ed51e..302d39dbdcc18 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/discovery/RioSystemDeviceDiscoveryService.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/discovery/RioSystemDeviceDiscoveryService.java @@ -247,7 +247,7 @@ private void discoverZones(ThingUID controllerUID, int c) { final String r = listener.getResponse(); final Matcher m = respPattern.matcher(r); if (m.matches() && m.groupCount() >= groupNum) { - logger.debug("Message '{}' returned an valid response: {}", message, r); + logger.debug("Message '{}' returned a valid response: {}", message, r); return m.group(groupNum); } logger.debug("Message '{}' returned an invalid response: {}", message, r); diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/StatefulHandlerCallback.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/StatefulHandlerCallback.java index 205de39aa9bfe..1fdfad1fc389d 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/StatefulHandlerCallback.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/StatefulHandlerCallback.java @@ -24,7 +24,7 @@ /** * Defines an implementation of {@link RioHandlerCallback} that will remember the last state - * for an channelId and suppress the callback if the state hasn't changed + * for a channelId and suppress the callback if the state hasn't changed * * @author Tim Roberts - Initial contribution */ diff --git a/bundles/org.openhab.binding.smartmeter/README.md b/bundles/org.openhab.binding.smartmeter/README.md index 8f5e310e70bb0..46025054f0dec 100644 --- a/bundles/org.openhab.binding.smartmeter/README.md +++ b/bundles/org.openhab.binding.smartmeter/README.md @@ -14,7 +14,7 @@ Discovery is not available, as the binding only reads from serial ports. ## Thing Configuration -The smartmeter thing requires the serial port where the meter device is connected and optionally an refresh interval. +The smartmeter thing requires the serial port where the meter device is connected and optionally a refresh interval. | Parameter | Name | Description | Required | Default | |-----------|------|-------------|----------|---------| diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java index 3c43ba40df9e8..d7b89ad33b361 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java @@ -151,7 +151,7 @@ public Collection getObisCodes() { } /** - * Read values from this device an store them locally against their OBIS code. + * Read values from this device a store them locally against their OBIS code. * * If there is an error in reading, it will be retried {@value #NUMBER_OF_RETRIES} times. The retry will be delayed * by {@code period} seconds. diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/SmartMeterChannelTypeProvider.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/SmartMeterChannelTypeProvider.java index 3175a18852e44..b09eb89c9a483 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/SmartMeterChannelTypeProvider.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/SmartMeterChannelTypeProvider.java @@ -64,7 +64,7 @@ public Collection getChannelTypes(@Nullable Locale locale) { @Override public void errorOccurred(Throwable e) { - // Nothing to do if there is an reading error... + // Nothing to do if there is a reading error... } @Override diff --git a/bundles/org.openhab.binding.smsmodem/src/3rdparty/java/org/smslib/pduUtils/gsm3040/PduGenerator.java b/bundles/org.openhab.binding.smsmodem/src/3rdparty/java/org/smslib/pduUtils/gsm3040/PduGenerator.java index 77453acf2e8fe..2db3dad18a19d 100644 --- a/bundles/org.openhab.binding.smsmodem/src/3rdparty/java/org/smslib/pduUtils/gsm3040/PduGenerator.java +++ b/bundles/org.openhab.binding.smsmodem/src/3rdparty/java/org/smslib/pduUtils/gsm3040/PduGenerator.java @@ -130,7 +130,7 @@ protected void writeBCDAddress(String address, int addressType, int addressLengt // ADDRESS TYPE this.baos.write(addressType); // ADDRESS NUMBERS - // if address.length is not even, pad the string an with F at the end + // if address.length is not even, pad the string with an F at the end String myaddress = address; if (myaddress.length() % 2 == 1) { myaddress = myaddress + "F"; diff --git a/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyConnector.java b/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyConnector.java index bb435609802bc..8ee0f3ea20d3a 100644 --- a/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyConnector.java +++ b/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyConnector.java @@ -166,7 +166,7 @@ public CompletableFuture call() { /** * Processes the response of the Spotify Web Api call and handles the HTTP status codes. The method returns true * if the response indicates a successful and false if the call should be retried. If there were other problems - * a Spotify exception is thrown indicating no retry should be done an the user should be informed. + * a Spotify exception is thrown indicating no retry should be done and the user should be informed. * * @param response the response given by the Spotify Web Api * @return true if the response indicated a successful call, false if the call should be retried diff --git a/bundles/org.openhab.binding.tacmi/README.md b/bundles/org.openhab.binding.tacmi/README.md index 89485195d1552..cfcbfd90b9ea1 100644 --- a/bundles/org.openhab.binding.tacmi/README.md +++ b/bundles/org.openhab.binding.tacmi/README.md @@ -86,7 +86,7 @@ The bridge could be used for multiple C.M.I. devices. * TA C.M.I. CoE Connection - Thing This thing reflects a connection to a node behind a specific C.M.I.. -This node could be every CAN-Capable device from TA which allows to define an CAN-Input. +This node could be every CAN-Capable device from TA which allows to define a CAN-Input. ## Discovery @@ -114,7 +114,7 @@ This thing doesn't need a bridge. Multiple of these things for different C.M.I.' The _TA C.M.I. CoE Connection_ has to be manually configured. -This thing reflects a connection to a node behind a specific C.M.I.. This node could be every CAN-Capable device from TA which allows to define an CAN-Input. +This thing reflects a connection to a node behind a specific C.M.I.. This node could be every CAN-Capable device from TA which allows to define a CAN-Input. | Parameter Label | Parameter ID | Description | Accepted values | |-------------------------|-----------------|---------------------------------------------------------------------------------------------------------------|------------------------| diff --git a/bundles/org.openhab.binding.tacmi/src/main/java/org/openhab/binding/tacmi/internal/message/DigitalMessage.java b/bundles/org.openhab.binding.tacmi/src/main/java/org/openhab/binding/tacmi/internal/message/DigitalMessage.java index 04f0782df6b8c..6e88795fda0fb 100644 --- a/bundles/org.openhab.binding.tacmi/src/main/java/org/openhab/binding/tacmi/internal/message/DigitalMessage.java +++ b/bundles/org.openhab.binding.tacmi/src/main/java/org/openhab/binding/tacmi/internal/message/DigitalMessage.java @@ -16,7 +16,7 @@ /** * This class can be used to decode the digital values received in a messag and - * also to create a new DigitalMessage used to send ON/OFF to an digital CAN + * also to create a new DigitalMessage used to send ON/OFF to a digital CAN * Input port * * @author Timo Wendt - Initial contribution diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/core/TelldusCoreDeviceController.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/core/TelldusCoreDeviceController.java index d0bd741a80fa6..65dd593675ac4 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/core/TelldusCoreDeviceController.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/core/TelldusCoreDeviceController.java @@ -241,7 +241,7 @@ private void checkLastAndWait(long resendInterval) { /** * This class is a worker which execute the commands sent to the TelldusCoreDeviceController. * This enables separation between Telldus Core and openHAB for preventing latency on the bus. - * The Tellstick have an send pace of 4 Hz which is far slower then the bus itself. + * The Tellstick have a send pace of 4 Hz which is far slower then the bus itself. * * @author Elias Gabrielsson * diff --git a/bundles/org.openhab.binding.tplinksmarthome/src/main/java/org/openhab/binding/tplinksmarthome/internal/Connection.java b/bundles/org.openhab.binding.tplinksmarthome/src/main/java/org/openhab/binding/tplinksmarthome/internal/Connection.java index 1421e34c73d16..2717e5d0e09a5 100644 --- a/bundles/org.openhab.binding.tplinksmarthome/src/main/java/org/openhab/binding/tplinksmarthome/internal/Connection.java +++ b/bundles/org.openhab.binding.tplinksmarthome/src/main/java/org/openhab/binding/tplinksmarthome/internal/Connection.java @@ -27,7 +27,7 @@ * This class acts as and interface to the physical device. * * @author Christian Fischer - Initial contribution - * @author Hilbrand Bouwkamp - Reorganized code an put connection in single class + * @author Hilbrand Bouwkamp - Reorganized code and put connection in single class */ @NonNullByDefault public class Connection { diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/VeluxRSBindingConfig.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/VeluxRSBindingConfig.java index 01ddb9674717f..bc72e5aa791d8 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/VeluxRSBindingConfig.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/VeluxRSBindingConfig.java @@ -137,7 +137,7 @@ public VeluxRSBindingConfig(VeluxItemType bindingItemType, String channelValue) } /** - * Returns the next shutter level for an DOWN command w/ adjusting the actual position. + * Returns the next shutter level for a DOWN command w/ adjusting the actual position. * * @return rollershutterLevel of type Integer with next position after DOWN command. */ diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/io/DataInputStreamWithTimeout.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/io/DataInputStreamWithTimeout.java index 0edfcb7ebbb14..157a92d0fd922 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/io/DataInputStreamWithTimeout.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/io/DataInputStreamWithTimeout.java @@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory; /** - * This is an wrapper around {@link java.io.InputStream} to support socket receive operations. + * This is a wrapper around {@link java.io.InputStream} to support socket receive operations. * * It implements a secondary polling thread to asynchronously read bytes from the socket input stream into a buffer. And * it parses the bytes into SLIP messages, which are placed on a message queue. Callers can access the SLIP messages in diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxGwState.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxGwState.java index eec31bdae6e3d..b751263a1c9aa 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxGwState.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxGwState.java @@ -112,7 +112,7 @@ public enum VeluxGatewaySubState { private int stateValue; private String stateDescription; - // Reverse-lookup map for getting a VeluxGatewayState from an TypeId + // Reverse-lookup map for getting a VeluxGatewayState from a TypeId private static final Map LOOKUPTYPEID2ENUM = Stream .of(VeluxGatewaySubState.values()) .collect(Collectors.toMap(VeluxGatewaySubState::getStateValue, Function.identity())); diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxKLFAPI.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxKLFAPI.java index aac38ec3d28c5..5960c635a2cea 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxKLFAPI.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxKLFAPI.java @@ -47,7 +47,7 @@ public class VeluxKLFAPI { // Constants /** - * System table index parameter - an be a number from 0 to 203. + * System table index parameter - a number from 0 to 203. * * See KLF200 @@ -318,7 +318,7 @@ public enum Command { private CommandNumber command; private String description; - // Reverse-lookup map for getting a Command from an TypeId + // Reverse-lookup map for getting a Command from a TypeId private static final Map LOOKUPTYPEID2ENUM = Stream.of(Command.values()) .collect(Collectors.toMap(Command::getShort, Function.identity())); diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java index d4dfa3bd4f07b..32f99d5f04f49 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java @@ -88,7 +88,7 @@ private ProductState(int value) { } /** - * Create an ProductState from an integer seed value. + * Create a ProductState from an integer seed value. * * @param value the seed value. * @return the ProductState. diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductType.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductType.java index 7a047ecbff9da..2b87ba03359dc 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductType.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductType.java @@ -83,7 +83,7 @@ public static enum ActuatorType { private String description; private VeluxProductType typeClass; - // Reverse-lookup map for getting an ActuatorType from an TypeId + // Reverse-lookup map for getting an ActuatorType from a TypeId private static final Map LOOKUPTYPEID2ENUM = Stream.of(ActuatorType.values()) .collect(Collectors.toMap(ActuatorType::getNodeType, Function.identity())); diff --git a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/CdStationHydro.java b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/CdStationHydro.java index 2a8bc377300be..5f2b45fb65598 100644 --- a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/CdStationHydro.java +++ b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/CdStationHydro.java @@ -23,7 +23,7 @@ /** * The {@link CdStationHydro} is the Java class used to map the JSON - * response to an vigicrue api endpoint request. + * response to a vigicrue api endpoint request. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/InfoVigiCru.java b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/InfoVigiCru.java index 2d03feefac732..f8fecf16afab9 100644 --- a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/InfoVigiCru.java +++ b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/InfoVigiCru.java @@ -16,7 +16,7 @@ /** * The {@link InfoVigiCru} is the Java class used to map the JSON - * response to an vigicrue api endpoint request. + * response to a vigicrue api endpoint request. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TerEntVigiCru.java b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TerEntVigiCru.java index b9c99bfa8006b..6396e81edfc59 100644 --- a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TerEntVigiCru.java +++ b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TerEntVigiCru.java @@ -18,7 +18,7 @@ /** * The {@link TerEntVigiCru} is the Java class used to map the JSON - * response to an vigicrue api endpoint request. + * response to a vigicrue api endpoint request. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TronEntVigiCru.java b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TronEntVigiCru.java index 5602ad4e49f78..b9732a676002d 100644 --- a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TronEntVigiCru.java +++ b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/TronEntVigiCru.java @@ -19,7 +19,7 @@ /** * The {@link TronEntVigiCru} is the Java class used to map the JSON - * response to an vigicrue api endpoint request. + * response to a vigicrue api endpoint request. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/VicANMoinsUn.java b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/VicANMoinsUn.java index 08709dd931808..d45602ab3f256 100644 --- a/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/VicANMoinsUn.java +++ b/bundles/org.openhab.binding.vigicrues/src/main/java/org/openhab/binding/vigicrues/internal/dto/vigicrues/VicANMoinsUn.java @@ -16,7 +16,7 @@ /** * The {@link VicANMoinsUn} is the Java class used to map the JSON - * response to an vigicrue api endpoint request. + * response to a vigicrue api endpoint request. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetSystemBridgeHandler.java b/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetSystemBridgeHandler.java index c96d70ccd8dbc..90dd3488132a6 100644 --- a/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetSystemBridgeHandler.java +++ b/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetSystemBridgeHandler.java @@ -46,7 +46,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link WolfSmartsetSystemBridgeHandler} is the handler for an WolfSmartset system. + * The {@link WolfSmartsetSystemBridgeHandler} is the handler for a WolfSmartset system. * * @author Bo Biene - Initial contribution */ diff --git a/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetUnitThingHandler.java b/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetUnitThingHandler.java index 5a80787dfcc72..5729e007de6fd 100644 --- a/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetUnitThingHandler.java +++ b/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/handler/WolfSmartsetUnitThingHandler.java @@ -43,7 +43,7 @@ /** * The {@link WolfSmartsetUnitThingHandler} is responsible for updating the channels associated - * with an WolfSmartset unit. + * with a WolfSmartset unit. * * @author Bo Biene - Initial contribution */ diff --git a/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/i18n/wolfsmartset.properties b/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/i18n/wolfsmartset.properties index b42be5e09a58f..6ecd18ed95b13 100644 --- a/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/i18n/wolfsmartset.properties +++ b/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/i18n/wolfsmartset.properties @@ -8,9 +8,9 @@ binding.wolfsmartset.description = This is the binding for WolfSmartset smart sy thing-type.wolfsmartset.account.label = WolfSmartset Account thing-type.wolfsmartset.account.description = Represents an account at WolfSmartset thing-type.wolfsmartset.system.label = WolfSmartset System -thing-type.wolfsmartset.system.description = An WolfSmartset system +thing-type.wolfsmartset.system.description = A WolfSmartset system thing-type.wolfsmartset.unit.label = WolfSmartset Unit -thing-type.wolfsmartset.unit.description = An WolfSmartset remote unit +thing-type.wolfsmartset.unit.description = A WolfSmartset remote unit # thing types config diff --git a/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/thing/thing-types.xml index c24778e554186..4c3f7a0d40462 100644 --- a/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.wolfsmartset/src/main/resources/OH-INF/thing/thing-types.xml @@ -17,7 +17,7 @@ - An WolfSmartset system + A WolfSmartset system systemId @@ -28,7 +28,7 @@ - An WolfSmartset remote unit + A WolfSmartset remote unit unitId diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/handler/YamahaZoneThingHandler.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/handler/YamahaZoneThingHandler.java index a08b3033f0b70..e54425c783311 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/handler/YamahaZoneThingHandler.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/handler/YamahaZoneThingHandler.java @@ -81,7 +81,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link YamahaZoneThingHandler} is managing one zone of an Yamaha AVR. + * The {@link YamahaZoneThingHandler} is managing one zone of a Yamaha AVR. * It has a state consisting of the zone, the current input ID, {@link ZoneControlState} * and some more state objects and uses the zone control protocol * class {@link ZoneControlXML}, {@link InputWithPlayControlXML} and {@link InputWithNavigationControlXML} diff --git a/bundles/org.openhab.binding.yamahareceiver/src/test/java/org/openhab/binding/yamahareceiver/internal/YamahaReceiverHandlerTest.java b/bundles/org.openhab.binding.yamahareceiver/src/test/java/org/openhab/binding/yamahareceiver/internal/YamahaReceiverHandlerTest.java index dcb332431f521..be5b6bb435f1c 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/test/java/org/openhab/binding/yamahareceiver/internal/YamahaReceiverHandlerTest.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/test/java/org/openhab/binding/yamahareceiver/internal/YamahaReceiverHandlerTest.java @@ -88,7 +88,7 @@ protected void onSetUp() throws Exception { public void afterInitializeBridgeShouldBeOnline() throws InterruptedException { // when subject.initialize(); - // internally there is an timer, let's allow it to execute + // internally there is a timer, let's allow it to execute Thread.sleep(200); // then diff --git a/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/converter/ZWayDeviceStateConverter.java b/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/converter/ZWayDeviceStateConverter.java index 38c167987b4b9..ec2324b1e1997 100644 --- a/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/converter/ZWayDeviceStateConverter.java +++ b/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/converter/ZWayDeviceStateConverter.java @@ -84,7 +84,7 @@ public static State toState(Device device, Channel channel) { } /** - * Transforms an value in an openHAB type. + * Transforms a value in an openHAB type. * * @param multilevel sensor value * @return transformed openHAB state @@ -104,7 +104,7 @@ private static State getPercentState(String multilevelValue) { } /** - * Transforms an value in an openHAB type. + * Transforms a value in an openHAB type. * * @param binary switch value * @return transformed openHAB state @@ -121,7 +121,7 @@ private static State getBinaryState(String binarySwitchState) { } /** - * Transforms an value in an openHAB type. + * Transforms a value in an openHAB type. * - ON to OPEN * - OFF to CLOSED * @@ -140,7 +140,7 @@ private static State getDoorlockState(String binarySensorState) { } /** - * Transforms an value in an openHAB type. + * Transforms a value in an openHAB type. * * @param Z-Way color value * @return transformed openHAB state diff --git a/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceChannelKind.java b/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceChannelKind.java index d0c3f4093704f..7778c3cd34c9d 100644 --- a/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceChannelKind.java +++ b/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceChannelKind.java @@ -26,7 +26,7 @@ public enum NeeoDeviceChannelKind { /** Represents an item */ ITEM("item"), - /** Represents an trigger item */ + /** Represents a trigger item */ TRIGGER("trigger"); /** The text value of the enum */ diff --git a/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceType.java b/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceType.java index 45293595f5a6c..4131533d3224a 100644 --- a/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceType.java +++ b/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/models/NeeoDeviceType.java @@ -30,11 +30,11 @@ */ @NonNullByDefault public class NeeoDeviceType { - /** Represents an device that should be excluded */ + /** Represents a device that should be excluded */ public static final NeeoDeviceType EXCLUDE = new NeeoDeviceType(""); /** Represents an accessory device (spelled the way NEEO spells it) */ public static final NeeoDeviceType ACCESSOIRE = new NeeoDeviceType("ACCESSOIRE"); - /** Represents an light device */ + /** Represents a light device */ static final NeeoDeviceType LIGHT = new NeeoDeviceType("LIGHT"); /** Represents the propery way to spell accessory! */ From 3c236b31034881c58a9cb9436da49466d322b29d Mon Sep 17 00:00:00 2001 From: Hawkinzw <4316127+Hawkinzw@users.noreply.github.com> Date: Thu, 8 Dec 2022 14:17:45 -0600 Subject: [PATCH 03/48] [insteon] Binding Documentation: Updated I/O Linc Section (#13811) * Update I/O Linc Documentation The I/O Linc has a feature to match or invert the status of the contact with its control messages. The binding was written expecting the messages to be inverted. This is the opposite of how insteon recommends setting up the garage kit, and not described well by the original "Note" at the bottom of the section. Updated the instructions to specify the input is OFF when linking, and changed the note to better describe what happens if you don't. All based off of my own experience with the sensor: https://community.openhab.org/t/insteon-io-linc-garage-door-contact-slow-update/141469 --- bundles/org.openhab.binding.insteon/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/bundles/org.openhab.binding.insteon/README.md b/bundles/org.openhab.binding.insteon/README.md index eb818ee7b68d2..2fff1020acc8b 100644 --- a/bundles/org.openhab.binding.insteon/README.md +++ b/bundles/org.openhab.binding.insteon/README.md @@ -489,7 +489,12 @@ and create a file "lock.map" in the transforms directory with these entries: ### I/O Linc (garage door openers) The I/O Linc devices are really two devices in one: a relay and a contact. -Link the modem both ways, as responder and controller using the set buttons as described in the instructions. +To control the relay, link the modem as a controller using the set buttons as described in the instructions. +To get the status of the contact, the modem must also be linked as a responder to the I/O Linc. +The I/O Linc has a feature to invert the contact or match the contact when it sends commands to any linked responders. +This is based on the status of the contact when it is linked, and was intended for controlling other devices with the contact. +The binding expects the contact to be inverted to work properly. +Ensure the contact is OFF (status LED is dark/garage door open) when linking the modem as a responder to the I/O Linc in order for it to function properly. Add this map into your transforms directory as "contact.map": @@ -517,9 +522,10 @@ To make it visible in the GUI, put this into your sitemap file: For safety reasons, only close the garage door if you have visual contact to make sure there is no obstruction! The use of automated rules for closing garage doors is dangerous. -> NOTE: If the I/O Linc returns the wrong value when the device is polled (For example you open the garage door and the state correctly shows OPEN, but during polling it shows CLOSED), you probably linked the device with the PLM or hub when the door was in the wrong position. -You need unlink and then link again with the door in the opposite position. -Please see the Insteon I/O Linc documentation for further details. +> NOTE: If the I/O Linc contact status appears delayed, or returns the wrong value when the sensor changes states, the contact was likely ON (status LED lit) when the modem was linked as a responder. +Examples of this behavior would include: The status remaining CLOSED for up to 3 minutes after the door is opened, or the status remains OPEN for up to three minutes after the garage is opened and immediately closed again. +To resolve this behavior the I/O Linc will need to be unlinked and then re-linked to the modem with the contact OFF (stats LED off). +That would be with the door open when using the Insteon garage kit. ### Keypads From 0e68936663b14a4d0330d4b6c0d2778b0dabfdf0 Mon Sep 17 00:00:00 2001 From: Jerome Luckenbach Date: Thu, 8 Dec 2022 21:36:05 +0100 Subject: [PATCH 04/48] [Documentation] Markdown improvements f to m (#13866) Signed-off-by: Jerome Luckenbach --- .../README.md | 86 +-- .../org.openhab.binding.flicbutton/README.md | 25 +- .../org.openhab.binding.fmiweather/README.md | 11 +- .../README.md | 2 - bundles/org.openhab.binding.foobot/README.md | 7 +- bundles/org.openhab.binding.freebox/README.md | 14 +- bundles/org.openhab.binding.fronius/README.md | 20 +- .../README.md | 61 +- .../org.openhab.binding.ftpupload/README.md | 24 +- bundles/org.openhab.binding.gardena/README.md | 30 +- bundles/org.openhab.binding.gce/README.md | 36 +- .../README.md | 11 +- .../org.openhab.binding.globalcache/README.md | 54 +- .../org.openhab.binding.goecharger/README.md | 10 +- bundles/org.openhab.binding.gpio/README.md | 25 +- .../org.openhab.binding.gpstracker/README.md | 122 ++-- bundles/org.openhab.binding.gree/README.md | 29 +- .../org.openhab.binding.groheondus/README.md | 8 +- .../org.openhab.binding.groupepsa/README.md | 12 +- .../org.openhab.binding.guntamatic/README.md | 564 +++++++++--------- .../README.md | 12 +- .../org.openhab.binding.harmonyhub/README.md | 79 +-- .../README.md | 2 +- .../README.md | 12 +- .../org.openhab.binding.hdanywhere/README.md | 6 +- .../org.openhab.binding.hdpowerview/README.md | 50 +- bundles/org.openhab.binding.helios/README.md | 12 +- .../README.md | 10 +- bundles/org.openhab.binding.heos/README.md | 117 ++-- .../org.openhab.binding.herzborg/README.md | 8 +- .../org.openhab.binding.homeconnect/README.md | 220 ++++--- .../org.openhab.binding.homematic/README.md | 81 +-- .../org.openhab.binding.homewizard/README.md | 7 +- .../org.openhab.binding.hpprinter/README.md | 28 +- bundles/org.openhab.binding.http/README.md | 24 +- .../xtend_examples.md | 21 +- bundles/org.openhab.binding.hue/README.md | 35 +- .../org.openhab.binding.hydrawise/README.md | 42 +- .../org.openhab.binding.hyperion/README.md | 28 +- .../org.openhab.binding.iammeter/README.md | 10 +- .../org.openhab.binding.iaqualink/README.md | 19 +- .../org.openhab.binding.icalendar/README.md | 42 +- bundles/org.openhab.binding.icloud/README.md | 2 +- bundles/org.openhab.binding.ihc/README.md | 22 +- .../README.md | 47 +- bundles/org.openhab.binding.insteon/README.md | 354 +++++------ bundles/org.openhab.binding.intesis/README.md | 15 +- .../org.openhab.binding.ipcamera/README.md | 211 ++++--- .../org.openhab.binding.ipobserver/README.md | 2 +- bundles/org.openhab.binding.irobot/README.md | 29 +- bundles/org.openhab.binding.irtrans/README.md | 32 +- bundles/org.openhab.binding.ism8/README.md | 230 +++---- .../org.openhab.binding.jablotron/README.md | 22 +- bundles/org.openhab.binding.jeelink/README.md | 61 +- .../org.openhab.binding.jellyfin/README.md | 29 +- .../org.openhab.binding.juicenet/README.md | 12 +- .../README.md | 34 +- bundles/org.openhab.binding.keba/README.md | 157 ++--- bundles/org.openhab.binding.km200/README.md | 14 +- bundles/org.openhab.binding.knx/README.md | 43 +- bundles/org.openhab.binding.kodi/README.md | 21 +- .../org.openhab.binding.konnected/README.md | 33 +- .../README.md | 98 ++- bundles/org.openhab.binding.kvv/README.md | 2 +- .../README.md | 32 +- bundles/org.openhab.binding.lcn/README.md | 156 ++--- .../org.openhab.binding.leapmotion/README.md | 4 +- .../org.openhab.binding.lghombot/README.md | 7 +- bundles/org.openhab.binding.lgwebos/README.md | 44 +- bundles/org.openhab.binding.lifx/README.md | 49 +- bundles/org.openhab.binding.linky/README.md | 28 +- .../org.openhab.binding.linuxinput/README.md | 25 +- bundles/org.openhab.binding.lirc/README.md | 15 +- .../README.md | 16 +- .../org.openhab.binding.logreader/README.md | 38 +- bundles/org.openhab.binding.loxone/README.md | 181 +++--- .../README.md | 24 +- bundles/org.openhab.binding.lutron/README.md | 249 ++++---- bundles/org.openhab.binding.luxom/README.md | 46 +- .../README.md | 30 +- .../org.openhab.binding.magentatv/README.md | 52 +- bundles/org.openhab.binding.mail/README.md | 24 +- bundles/org.openhab.binding.max/README.md | 16 +- bundles/org.openhab.binding.mcd/README.md | 32 +- .../org.openhab.binding.mcp23017/README.md | 20 +- bundles/org.openhab.binding.meater/README.md | 25 +- .../org.openhab.binding.mecmeter/README.md | 13 +- .../org.openhab.binding.melcloud/README.md | 30 +- .../org.openhab.binding.mercedesme/README.md | 93 ++- .../org.openhab.binding.meteoalerte/README.md | 7 +- .../org.openhab.binding.meteoblue/README.md | 20 +- .../org.openhab.binding.meteostick/README.md | 87 ++- bundles/org.openhab.binding.miele/README.md | 12 +- .../org.openhab.binding.mielecloud/README.md | 9 +- bundles/org.openhab.binding.mihome/README.md | 209 +++---- .../org.openhab.binding.miio/README.base.md | 77 ++- .../org.openhab.binding.mikrotik/README.md | 82 ++- bundles/org.openhab.binding.milight/README.md | 121 ++-- .../org.openhab.binding.millheat/README.md | 38 +- .../org.openhab.binding.minecraft/README.md | 7 +- .../org.openhab.binding.modbus.e3dc/README.md | 84 ++- .../README.md | 447 +++++++------- .../org.openhab.binding.modbus.sbc/README.md | 6 +- .../README.md | 106 ++-- .../README.md | 21 +- .../DEVELOPERS.md | 16 +- .../README.md | 22 +- .../org.openhab.binding.modbus/DEVELOPERS.md | 41 +- bundles/org.openhab.binding.modbus/README.md | 159 +++-- .../README.md | 22 +- bundles/org.openhab.binding.mpd/README.md | 20 +- .../README.md | 80 +-- .../README.md | 173 +++--- .../xtend_examples.md | 44 +- .../README.md | 18 +- .../org.openhab.binding.mqtt.homie/README.md | 10 +- bundles/org.openhab.binding.mqtt/README.md | 64 +- .../xtend_examples.md | 15 +- bundles/org.openhab.binding.mybmw/README.md | 402 ++++++------- bundles/org.openhab.binding.mycroft/README.md | 13 +- bundles/org.openhab.binding.myq/README.md | 6 +- bundles/org.openhab.binding.mystrom/README.md | 9 +- 122 files changed, 3505 insertions(+), 3677 deletions(-) diff --git a/bundles/org.openhab.binding.fineoffsetweatherstation/README.md b/bundles/org.openhab.binding.fineoffsetweatherstation/README.md index 79838bbd2a67e..fd38714763e09 100644 --- a/bundles/org.openhab.binding.fineoffsetweatherstation/README.md +++ b/bundles/org.openhab.binding.fineoffsetweatherstation/README.md @@ -4,16 +4,16 @@ This binding is for weather stations manufactured by [Fine Offset](http://www.fo These weather stations are white labeled products which are re-branded by many distribution companies around the world. Some of these brands are e.g.: -* Aercus -* Ambient Weather -* Ecowitt -* ELV -* Froggit -* Misol -* Pantech -* Sainlogic -* Steinberg Systems -* Waldbeck Halley +- Aercus +- Ambient Weather +- Ecowitt +- ELV +- Froggit +- Misol +- Pantech +- Sainlogic +- Steinberg Systems +- Waldbeck Halley Here is a product picture of how this Weather Station looks like: @@ -23,31 +23,31 @@ This binding works offline by [implementing the wire protocol](https://osswww.ec ## Discussion -If you have any issues or feedback, please feel free to [get in touch via the community forum](https://community.openhab.org/t/fine-offset-weather-station-binding-discussion/134167) +If you have any issues or feedback, please feel free to [get in touch via the community forum](https://community.openhab.org/t/fine-offset-weather-station-binding-discussion/134167) ## Supported Things - `weatherstation`: A Fine Offset gateway device with the ThingTypeUID `fineoffsetweatherstation:weatherstation` which supports the [wire protocol](https://osswww.ecowitt.net/uploads/20220407/WN1900%20GW1000,1100%20WH2680,2650%20telenet%20v1.6.4.pdf) e.g.: - - HP2550 - - HP3500 - - GW1000 - - GW1001 - - GW1002 - - GW1003 - - GW1100 - - GW2001 - - WN1900 - - WN1910 - - WH2350 - - WH2600 - - WH2610 - - WH2620 - - WH2650 (tested) - - WH2680 - - WH2900 - - WH2950 - - WS980 ELV (tested) - - WittBoy (tested) + - HP2550 + - HP3500 + - GW1000 + - GW1001 + - GW1002 + - GW1003 + - GW1100 + - GW2001 + - WN1900 + - WN1910 + - WH2350 + - WH2600 + - WH2610 + - WH2620 + - WH2650 (tested) + - WH2680 + - WH2900 + - WH2950 + - WS980 ELV (tested) + - WittBoy (tested) - `sensor`: A Fine Offset sensor which is connected to the bridge with the ThingTypeUID `fineoffsetweatherstation:sensor`. Since the gateway collects all the sensor data and harmonizes them, the sensor thing itself will only hold information about the signal and battery status. This is a list of sensors supported by the protocol: @@ -75,7 +75,7 @@ In this case you have to configure a service to which the data is sent. Please try if here the [IPObserver binding](https://www.openhab.org/addons/bindings/ipobserver/) offers an alternative. Known weather stations not compatible with this binding: - - [WH3000](https://community.openhab.org/t/fine-offset-weather-station-binding-beta-and-discussion/134167/52?u=andy2003) +- [WH3000](https://community.openhab.org/t/fine-offset-weather-station-binding-beta-and-discussion/134167/52?u=andy2003) ## Discovery @@ -262,13 +262,13 @@ Valid sensors: | sensor-co2-co2 | Number:Dimensionless | R | CO2 | | sensor-co2-co2-24-hour-average | Number:Dimensionless | R | CO2 24 Hour Average | | leaf-wetness-channel-1 | Number:Dimensionless | R | Leaf Moisture Channel 1 | -| leaf-wetness-channel-2 | Number:Dimensionless | R | Leaf Moisture Channel 2 | -| leaf-wetness-channel-3 | Number:Dimensionless | R | Leaf Moisture Channel 3 | -| leaf-wetness-channel-4 | Number:Dimensionless | R | Leaf Moisture Channel 4 | -| leaf-wetness-channel-5 | Number:Dimensionless | R | Leaf Moisture Channel 5 | -| leaf-wetness-channel-6 | Number:Dimensionless | R | Leaf Moisture Channel 6 | -| leaf-wetness-channel-7 | Number:Dimensionless | R | Leaf Moisture Channel 7 | -| leaf-wetness-channel-8 | Number:Dimensionless | R | Leaf Moisture Channel 8 | +| leaf-wetness-channel-2 | Number:Dimensionless | R | Leaf Moisture Channel 2 | +| leaf-wetness-channel-3 | Number:Dimensionless | R | Leaf Moisture Channel 3 | +| leaf-wetness-channel-4 | Number:Dimensionless | R | Leaf Moisture Channel 4 | +| leaf-wetness-channel-5 | Number:Dimensionless | R | Leaf Moisture Channel 5 | +| leaf-wetness-channel-6 | Number:Dimensionless | R | Leaf Moisture Channel 6 | +| leaf-wetness-channel-7 | Number:Dimensionless | R | Leaf Moisture Channel 7 | +| leaf-wetness-channel-8 | Number:Dimensionless | R | Leaf Moisture Channel 8 | | piezo-rain-rate | Number:VolumetricFlowRate | R | Piezo - Rainfall Rate | | piezo-rain-event | Number:Length | R | Piezo - Amount of Rainfall At the last Rain | | piezo-rain-hour | Number:Length | R | Piezo - Rainfall Current Hour | @@ -295,7 +295,7 @@ This is an example configuration for the WH2650 gateway _weatherstation.things_: -```xtend +```java Bridge fineoffsetweatherstation:gateway:3906700515 "Weather station" [ ip="192.168.1.42", port="45000", @@ -303,14 +303,14 @@ Bridge fineoffsetweatherstation:gateway:3906700515 "Weather station" [ pollingInterval="16", protocol="DEFAULT" ] { - Thing sensor WH25 "WH25" [sensor="WH25"] - Thing sensor WH65 "WH65" [sensor="WH65"] + Thing sensor WH25 "WH25" [sensor="WH25"] + Thing sensor WH65 "WH65" [sensor="WH65"] } ``` _weatherstation.items_: -```xtend +```java Group WH25 "WH25" ["Sensor"] Number SignalWH25 "Signal WH25" (WH25) ["Measurement", "Level"] { channel="fineoffsetweatherstation:sensor:3906700515:WH25:signal" } Switch BatteryStatusWH25 "Low Battery WH25" (WH25) ["Energy", "LowBattery"] { channel="fineoffsetweatherstation:sensor:3906700515:WH25:lowBattery" } diff --git a/bundles/org.openhab.binding.flicbutton/README.md b/bundles/org.openhab.binding.flicbutton/README.md index 87e81dfdf2d6d..36416cbef591f 100644 --- a/bundles/org.openhab.binding.flicbutton/README.md +++ b/bundles/org.openhab.binding.flicbutton/README.md @@ -1,4 +1,4 @@ -# Flic Button Binding +# Flic Button Binding openHAB binding for using [Flic Buttons](https://flic.io/) with a [fliclib-linux-hci](https://github.com/50ButtonsEach/fliclib-linux-hci) bridge. @@ -20,8 +20,8 @@ After buttons are initially added to flicd, an internet connection is not requir ## Discovery -* There is no automatic discovery for flicd-bridge available. -* After flicd-bridge is (manually) configured, buttons will be automatically discovered via background discovery as soon +- There is no automatic discovery for flicd-bridge available. +- After flicd-bridge is (manually) configured, buttons will be automatically discovered via background discovery as soon as they're added with [simpleclient](https://github.com/50ButtonsEach/fliclib-linux-hci). If they're already attached to the flicd-bridge before configuring this binding, they can be discovered by triggering an @@ -33,14 +33,14 @@ active scan. Example for textual configuration: -``` +```java Bridge flicbutton:flicd-bridge:mybridge ``` The default host is localhost:5551 (this should be sufficient if flicd is running with default settings on the same server as openHAB). If your flicd service is running somewhere else, specify it like this: -``` +```java Bridge flicbutton:flicd-bridge:mybridge [ hostname="", port=] ``` @@ -52,7 +52,7 @@ For the button, the only config parameter is the MAC address. Normally, no textual configuration is necessary as buttons are auto discovered as soon as the bridge is configured. If you want to use textual configuration anyway, you can do it like this: -``` +```java Bridge flicbutton:flicd-bridge:mybridge [ hostname="", port=] { Thing button myflic1 "" [address =""] Thing button myflic2 "" [address =""] @@ -70,11 +70,12 @@ You're free to choose any label you like for your button. | rawbutton | [System Trigger Channel](https://www.openhab.org/docs/developer/bindings/thing-xml.html#system-trigger-channel-types) `system.rawbutton` | Depends on the [Trigger Profile](https://www.openhab.org/docs/configuration/items.html#profiles) used | Raw Button channel that triggers `PRESSED` and `RELEASED` events, allows to use openHAB profiles or own implementations via rules to detect e.g. double clicks, long presses etc. | | button | [System Trigger Channel](https://www.openhab.org/docs/developer/bindings/thing-xml.html#system-trigger-channel-types) `system.button` | Depends on the [Trigger Profile](https://www.openhab.org/docs/configuration/items.html#profiles) used | Button channel that is using Flic's implementation for detecting long, short or double clicks. Triggers `SHORT_PRESSED`,`DOUBLE_PRESSED` and `LONG_PRESSED` events. | | battery-level | [System State Channel](https://www.openhab.org/docs/developer/bindings/thing-xml.html#system-state-channel-types) `system.battery-level` | Number | Represents the battery level as a percentage (0-100%). + ## Example ### Initial setup -1. Setup and run flicd as described in [fliclib-linux-hci](https://github.com/50ButtonsEach/fliclib-linux-hci). +1. Setup and run flicd as described in [fliclib-linux-hci](https://github.com/50ButtonsEach/fliclib-linux-hci). Please consider that you need a separate Bluetooth adapter. Shared usage with other Bluetooth services (e.g. Bluez) is not possible. 1. Connect your buttons to flicd using the simpleclient as described in @@ -92,16 +93,16 @@ You're free to choose any label you like for your button. demo.things: -``` +```java Bridge flicbutton:flicd-bridge:local-flicd { - Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"] - Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"] + Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"] + Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"] } ``` demo.items: -``` +```java Dimmer Light_LivingRoom { channel="milight:rgbLed:milight2:4:ledbrightness", channel="flicbutton:button:local-flicd:flic_livingroom:rawbutton" [profile="rawbutton-toggle-switch"], channel="flicbutton:button:local-flicd:flic_kitchen:rawbutton" [profile="rawbutton-toggle-switch"] } // We have a combined kitchen / livingroom, so we control the living room lights with switches from the living room and from the kitchen Switch Light_Kitchen { channel="hue:group:1:kitchen-bulbs:switch", channel="flicbutton:button:local-flicd:flic_kitchen:rawbutton" [profile="rawbutton-toggle-switch"] } ``` @@ -111,7 +112,7 @@ Switch Light_Kitchen { channel="hue:group:1:kitchen-bulbs:switch", channel="f It's also possible to setup [Rules](https://www.openhab.org/docs/configuration/rules-dsl.html). The following rules help to initially test your setup as they'll trigger log messages on incoming events. -``` +```java rule "Button rule using the button channel" when diff --git a/bundles/org.openhab.binding.fmiweather/README.md b/bundles/org.openhab.binding.fmiweather/README.md index 96eecf08d8d85..c4c55701e829c 100644 --- a/bundles/org.openhab.binding.fmiweather/README.md +++ b/bundles/org.openhab.binding.fmiweather/README.md @@ -1,6 +1,6 @@ # FMI Weather Binding -This binding integrates to [the Finnish Meteorological Institute (FMI) Open Data API](https://en.ilmatieteenlaitos.fi/open-data). +This binding integrates to [the Finnish Meteorological Institute (FMI) Open Data API](https://en.ilmatieteenlaitos.fi/open-data). Binding provides access to weather observations from FMI weather stations and [HIRLAM weather forecast model](https://en.ilmatieteenlaitos.fi/weather-forecast-models) forecasts. Forecast covers all of Europe, see previous link for more information. @@ -34,7 +34,6 @@ The binding automatically discovers weather stations and forecasts for nearby pl | --------- | ---- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | `fmisid` | text | ✓ | FMI Station ID. You can FMISID of see all weathers stations at [FMI web site](https://en.ilmatieteenlaitos.fi/observation-stations?p_p_id=stationlistingportlet_WAR_fmiwwwweatherportlets&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&p_p_col_id=column-4&p_p_col_count=1&_stationlistingportlet_WAR_fmiwwwweatherportlets_stationGroup=WEATHER#station-listing) | `"852678"` for Espoo Nuuksio station | - ### `forecast` thing configuration | Parameter | Type | Required | Description | Example | @@ -107,7 +106,7 @@ Please use the [Units Of Measurement](https://www.openhab.org/docs/concepts/unit `fmi.things`: -``` +```java Thing fmiweather:observation:station_Helsinki_Kumpula "Helsinki Kumpula Observation" [fmisid="101004"] Thing fmiweather:forecast:forecast_Paris "Paris Forecast" [location="48.864716, 2.349014"] ``` @@ -144,7 +143,7 @@ for channel in observation['value']['channels']: '"{label} [{unit}]" {{ channel="{channel_id}" }}').format(**locals())) --> -``` +```java DateTime HelsinkiObservationTime "Observation Time [%1$tY-%1$tm-%1$tdT%1$tH:%1$tM:%1$tS]"