forked from openhab/openhab-addons
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[HomeWizard] Add support for Energy Socket and Watermeter products (o…
…penhab#13495) Also-by: Leo Siepel <[email protected]> Signed-off-by: Daniël van Os <[email protected]>
- Loading branch information
1 parent
1280ee1
commit 93afc0e
Showing
13 changed files
with
789 additions
and
132 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
...wizard/src/main/java/org/openhab/binding/homewizard/internal/HomeWizardDeviceHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /** | ||
| * Copyright (c) 2010-2024 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.homewizard.internal; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.concurrent.ScheduledFuture; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.openhab.core.io.net.http.HttpUtil; | ||
| import org.openhab.core.thing.Thing; | ||
| import org.openhab.core.thing.ThingStatus; | ||
| import org.openhab.core.thing.ThingStatusDetail; | ||
| import org.openhab.core.thing.binding.BaseThingHandler; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.google.gson.FieldNamingPolicy; | ||
| import com.google.gson.Gson; | ||
| import com.google.gson.GsonBuilder; | ||
|
|
||
| /** | ||
| * The {@link HomeWizardDeviceHandler} is a base class for all | ||
| * HomeWizard devices. It provides configuration and polling of | ||
| * data from a device. It also processes common data. | ||
| * | ||
| * @author Daniël van Os - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public abstract class HomeWizardDeviceHandler extends BaseThingHandler { | ||
|
|
||
| protected final Logger logger = LoggerFactory.getLogger(HomeWizardDeviceHandler.class); | ||
| protected final Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) | ||
| .create(); | ||
|
|
||
| private HomeWizardConfiguration config = new HomeWizardConfiguration(); | ||
| private @Nullable ScheduledFuture<?> pollingJob; | ||
|
|
||
| protected String apiURL = ""; | ||
|
|
||
| /** | ||
| * Constructor | ||
| * | ||
| * @param thing The thing to handle | ||
| */ | ||
| public HomeWizardDeviceHandler(Thing thing) { | ||
| super(thing); | ||
| } | ||
|
|
||
| /** | ||
| * If a host has been specified start polling it | ||
| */ | ||
| @Override | ||
| public void initialize() { | ||
| config = getConfigAs(HomeWizardConfiguration.class); | ||
| if (configure()) { | ||
| pollingJob = scheduler.scheduleWithFixedDelay(this::pollingCode, 0, config.refreshDelay, TimeUnit.SECONDS); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check the current configuration | ||
| * | ||
| * @return true if the configuration is ok to start polling, false otherwise | ||
| */ | ||
| private boolean configure() { | ||
| if (config.ipAddress.trim().isEmpty()) { | ||
| updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, | ||
| "Missing ipAddress/host configuration"); | ||
| return false; | ||
| } else { | ||
| updateStatus(ThingStatus.UNKNOWN); | ||
| apiURL = String.format("http://%s/api/v1/", config.ipAddress.trim()); | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * dispose: stop the poller | ||
| */ | ||
| @Override | ||
| public void dispose() { | ||
| var job = pollingJob; | ||
| if (job != null) { | ||
| job.cancel(true); | ||
| } | ||
| pollingJob = null; | ||
| } | ||
|
|
||
| /** | ||
| * Device specific handling of the returned data payload. | ||
| * | ||
| * @param payload The data parsed from the data Json file | ||
| */ | ||
| abstract protected void handleDataPayload(DataPayload payload); | ||
|
|
||
| /** | ||
| * | ||
| */ | ||
| protected void pollData() { | ||
| final String dataResult; | ||
|
|
||
| try { | ||
| dataResult = HttpUtil.executeUrl("GET", apiURL + "data", 30000); | ||
| } catch (IOException e) { | ||
| updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, | ||
| String.format("Unable to query device data: %s", e.getMessage())); | ||
| return; | ||
| } | ||
|
|
||
| if (dataResult.trim().isEmpty()) { | ||
| updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, "Device returned empty data"); | ||
| return; | ||
| } | ||
|
|
||
| DataPayload dataPayload = gson.fromJson(dataResult, DataPayload.class); | ||
| if (dataPayload == null) { | ||
| updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, | ||
| "Unable to parse data response from device"); | ||
| return; | ||
| } | ||
|
|
||
| if ("".equals(dataPayload.getWifiSsid())) { | ||
| updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, "Results from API are empty"); | ||
| return; | ||
| } | ||
|
|
||
| updateStatus(ThingStatus.ONLINE); | ||
| handleDataPayload(dataPayload); | ||
| } | ||
|
|
||
| /** | ||
| * The actual polling loop | ||
| */ | ||
| protected void pollingCode() { | ||
| pollData(); | ||
| } | ||
| } |
Oops, something went wrong.