[DWDPollenflug] Small code improvments (openhab#7395)

* [DWDPollenflug] Small refactoring and improvements * [DWDPollenflug] Added DiscoveryService Signed-off-by: Johannes DerOetzi Ott <info@johannes-ott.net>
J-N-K · Jul 14, 2020 · 6b3aad5 · 6b3aad5
1 parent a80874d
commit 6b3aad5
Show file tree

Hide file tree

Showing 9 changed files with 94 additions and 17 deletions.
diff --git a/bundles/org.openhab.binding.dwdpollenflug/README.md b/bundles/org.openhab.binding.dwdpollenflug/README.md
@@ -11,17 +11,22 @@ https://isabel.dwd.de/DE/leistungen/gefahrenindizespollen/gefahrenindexpollen.ht
 This binding supports a bridge thing (`bridge`), which polls the dataset for Germany in an adjustable interval. 
 And it supports a region thing (`region`), representing the data for all pollen types of a region or partregion.
 
+## Discovery
+
+This binding adds a default `bridge` thing to the Inbox. 
+This can be used for `region` things you may add manually.
+
 ## Thing Configuration
 
 ### Bridge
 
-| Property  | Default | Required | Description |
+| Parameter | Default | Required | Description |
 | --------- | :-----: | :------: | ------------------------------------------------------------------------------------ |
 | `refresh` | 30 | no | Define the interval for polling the data from DWD in minutes. Minimum is 15 minutes. |
 
 ### Region
 
-| Property  | Default | Required | Description |
+| Parameter | Default | Required | Description |
 | ---------- | :-----: | :------: | -------------------------------------------------------------------------------------------------------- |
 | `regionID` | - | yes | In PaperUI just select the region you want to display data for. For files-configuration see table below. |
 

diff --git a/...c/main/java/org/openhab/binding/dwdpollenflug/internal/DWDPollenflugBindingConstants.java b/...c/main/java/org/openhab/binding/dwdpollenflug/internal/DWDPollenflugBindingConstants.java
@@ -12,6 +12,11 @@
  */
 package org.openhab.binding.dwdpollenflug.internal;
 
+import java.util.Collections;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.smarthome.core.thing.ThingTypeUID;
 
@@ -28,10 +33,20 @@ public class DWDPollenflugBindingConstants {
 
  // bridge
  public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, "bridge");
+ public static final String DWD = "dwd";
+ public static final String BRIDGE_LABEL = "DWD Pollen Count Index (Bridge)";
 
  // List of all Thing Type UIDs
  public static final ThingTypeUID THING_TYPE_REGION = new ThingTypeUID(BINDING_ID, "region");
 
+ // @formatter:off
+ public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = 
+ Collections.unmodifiableSet(Stream
+ .of(THING_TYPE_BRIDGE, THING_TYPE_REGION)
+ .collect(Collectors.toSet())
+ );
+ // @formatter:on
+
  // Channels of pollen groups
  public static final String CHANNEL_TODAY = "today";
  public static final String CHANNEL_TOMORROW = "tomorrow";

diff --git a/...src/main/java/org/openhab/binding/dwdpollenflug/internal/DWDPollenflugHandlerFactory.java b/...src/main/java/org/openhab/binding/dwdpollenflug/internal/DWDPollenflugHandlerFactory.java
@@ -14,11 +14,6 @@
 
 import static org.openhab.binding.dwdpollenflug.internal.DWDPollenflugBindingConstants.*;
 
-import java.util.Collections;
-import java.util.Set;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.jetty.client.HttpClient;
@@ -44,10 +39,6 @@
 @NonNullByDefault
 @Component(configurationPid = "binding.dwdpollenflug", service = ThingHandlerFactory.class)
 public class DWDPollenflugHandlerFactory extends BaseThingHandlerFactory {
-
- private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Collections
- .unmodifiableSet(Stream.of(THING_TYPE_BRIDGE, THING_TYPE_REGION).collect(Collectors.toSet()));
-
  private final HttpClient httpClient;
 
  @Activate

diff --git a/...a/org/openhab/binding/dwdpollenflug/internal/discovery/DWDPollenflugDiscoveryService.java b/...a/org/openhab/binding/dwdpollenflug/internal/discovery/DWDPollenflugDiscoveryService.java
@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2010-2020 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.dwdpollenflug.internal.discovery;
+
+import static org.openhab.binding.dwdpollenflug.internal.DWDPollenflugBindingConstants.*;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.smarthome.config.discovery.AbstractDiscoveryService;
+import org.eclipse.smarthome.config.discovery.DiscoveryResult;
+import org.eclipse.smarthome.config.discovery.DiscoveryResultBuilder;
+import org.eclipse.smarthome.config.discovery.DiscoveryService;
+import org.eclipse.smarthome.core.thing.ThingUID;
+import org.osgi.service.component.annotations.Component;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The {@link DWDPollenflugDiscoveryService} create a default bridge thing.
+ *
+ * @author Johannes Ott - Initial contribution
+ */
+@NonNullByDefault
+@Component(service = DiscoveryService.class, immediate = true, configurationPid = "discovery.dwdpollenflug")
+public class DWDPollenflugDiscoveryService extends AbstractDiscoveryService {
+ private static final ThingUID BRIDGE_THING_UID = new ThingUID(THING_TYPE_BRIDGE, DWD);
+ private static final int DISCOVER_TIMEOUT_SECONDS = 2;
+
+ private final Logger logger = LoggerFactory.getLogger(DWDPollenflugDiscoveryService.class);
+
+ public DWDPollenflugDiscoveryService() throws IllegalArgumentException {
+ super(SUPPORTED_THING_TYPES_UIDS, DISCOVER_TIMEOUT_SECONDS, true);
+ }
+
+ @Override
+ protected void startScan() {
+ logger.debug("Manual DWDPollenflug discovery scan.");
+ addBridge();
+ }
+
+ @Override
+ protected void startBackgroundDiscovery() {
+ logger.debug("Background DWDPollenflug discovery scan.");
+ addBridge();
+ }
+
+ private void addBridge() {
+ // @formatter:off
+ DiscoveryResult bridge = DiscoveryResultBuilder
+ .create(BRIDGE_THING_UID)
+ .withLabel(BRIDGE_LABEL)
+ .build();
+ // @formatter:on
+
+ thingDiscovered(bridge);
+ }
+}
diff --git a/...n/java/org/openhab/binding/dwdpollenflug/internal/handler/DWDPollenflugBridgeHandler.java b/...n/java/org/openhab/binding/dwdpollenflug/internal/handler/DWDPollenflugBridgeHandler.java
@@ -86,8 +86,8 @@ public void initialize() {
  bridgeConfig = getConfigAs(DWDPollenflugBridgeConfiguration.class);
 
  if (bridgeConfig.isValid()) {
+ updateStatus(ThingStatus.UNKNOWN);
  startPolling();
- updateStatus(ThingStatus.ONLINE);
  } else {
  updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
  "Refresh interval has to be at least 15 minutes.");

diff --git a/...n/java/org/openhab/binding/dwdpollenflug/internal/handler/DWDPollenflugRegionHandler.java b/...n/java/org/openhab/binding/dwdpollenflug/internal/handler/DWDPollenflugRegionHandler.java
@@ -62,7 +62,7 @@ public void initialize() {
  }
  }
 
- private synchronized @Nullable DWDPollenflugBridgeHandler getBridgeHandler() {
+ private @Nullable DWDPollenflugBridgeHandler getBridgeHandler() {
  Bridge bridge = getBridge();
  if (bridge != null) {
  ThingHandler handler = bridge.getHandler();

diff --git a/...openhab.binding.dwdpollenflug/src/main/resources/ESH-INF/i18n/dwdpollenflug_de.properties b/...openhab.binding.dwdpollenflug/src/main/resources/ESH-INF/i18n/dwdpollenflug_de.properties
@@ -3,15 +3,15 @@ binding.dwdpollenflug.name = DWD Pollenflugindex
 binding.dwdpollenflug.description = Binding um den Pollenflugindex des deutschen Wetterdienstes anzuzeigen
 
 #bridge
-thing-type.dwdpollenflug.bridge.label = DWD Pollenflugindex - Bridge
+thing-type.dwdpollenflug.bridge.label = DWD Pollenflugindex (Bridge)
 thing-type.dwdpollenflug.bridge.description = Bridge um den Pollenflugindex des DWDs abzurufen.
 
 #bridge config
 thing-type.config.dwdpollenflug.bridge.refresh.label = Aktualisierungsinterval
 thing-type.config.dwdpollenflug.bridge.refresh.description = Zeit zwischen zwei API-Anfragen in Minuten. Minimum 15 Minuten.
 
 #thing types
-thing-type.dwdpollenflug.region.label = DWD Pollenflugindex Region
+thing-type.dwdpollenflug.region.label = DWD Pollenflugindex (Region)
 thing-type.dwdpollenflug.region.description = Pollenflugindex f\u00FCr eine bestimmte Region oder Teilregion
 thing-type.dwdpollenflug.region.group.updates.label = Aktualisierung
 thing-type.dwdpollenflug.region.group.updates.description = Informationen zur Aktualisierung

diff --git a/bundles/org.openhab.binding.dwdpollenflug/src/main/resources/ESH-INF/thing/bridge.xml b/bundles/org.openhab.binding.dwdpollenflug/src/main/resources/ESH-INF/thing/bridge.xml
@@ -5,7 +5,7 @@
  xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
 
  <bridge-type id="bridge">
- <label>DWD Pollen Count Index - Bridge</label>
+ <label>DWD Pollen Count Index (Bridge)</label>
  <description>Bridge for accessing pollen count index data of the DWD</description>
 
  <channel-groups>

diff --git a/bundles/org.openhab.binding.dwdpollenflug/src/main/resources/ESH-INF/thing/region.xml b/bundles/org.openhab.binding.dwdpollenflug/src/main/resources/ESH-INF/thing/region.xml
@@ -9,7 +9,7 @@
  <bridge-type-ref id="bridge" />
  </supported-bridge-type-refs>
 
- <label>DWD Pollen Count Index - Region</label>
+ <label>DWD Pollen Count Index (Region)</label>
  <description>Pollen count index for a region or partregion</description>
 
  <channel-groups>