forked from openhab/openhab-addons
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[mystrom] Add support for myStrom Bulb (openhab#9910)
* Add support to myStrom Bulb Add properties to myStrom devices and an action to refresh the properties. Signed-off-by: Frederic Chastagnol <fchastagnol@fredoware.ch> * Fixes according to review comments Signed-off-by: Frederic Chastagnol <fchastagnol@fredoware.ch> * Update bundles/org.openhab.binding.mystrom/README.md Co-authored-by: J-N-K <J-N-K@users.noreply.github.com> * Fixes according to review comments Signed-off-by: Frederic Chastagnol <fchastagnol@fredoware.ch> * Use system color temperature channel type channel type system.color-temperature is used and values mapped from 1-18 to 0-100% Signed-off-by: Frederic Chastagnol <fchastagnol@fredoware.ch> * Better tracking of colour and brightness values Format power state Signed-off-by: Frederic Chastagnol <fchastagnol@fredoware.ch> Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
- Loading branch information
1 parent
d91dc34
commit 5539b7d
Showing
8 changed files
with
656 additions
and
78 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
159 changes: 159 additions & 0 deletions
159
...ng.mystrom/src/main/java/org/openhab/binding/mystrom/internal/AbstractMyStromHandler.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,159 @@ | ||
| /** | ||
| * Copyright (c) 2010-2021 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.mystrom.internal; | ||
|
|
||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_CONNECTED; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_DNS; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_GW; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_IP; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_LAST_REFRESH; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_MAC; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_MASK; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_SSID; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_STATIC; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_TYPE; | ||
| import static org.openhab.binding.mystrom.internal.MyStromBindingConstants.PROPERTY_VERSION; | ||
|
|
||
| import java.text.DateFormat; | ||
| import java.util.Calendar; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.ScheduledFuture; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.jetty.client.HttpClient; | ||
| import org.eclipse.jetty.client.api.ContentResponse; | ||
| import org.eclipse.jetty.client.api.Request; | ||
| import org.eclipse.jetty.client.util.StringContentProvider; | ||
| import org.eclipse.jetty.http.HttpHeader; | ||
| import org.eclipse.jetty.http.HttpMethod; | ||
| import org.eclipse.jetty.http.HttpStatus; | ||
| 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 com.google.gson.Gson; | ||
|
|
||
| /** | ||
| * The {@link AbstractMyStromHandler} is responsible for handling commands, which are | ||
| * sent to one of the channels. | ||
| * | ||
| * @author Frederic Chastagnol - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public abstract class AbstractMyStromHandler extends BaseThingHandler { | ||
| protected static final String COMMUNICATION_ERROR = "Error while communicating to the myStrom plug: "; | ||
| protected static final String HTTP_REQUEST_URL_PREFIX = "http://"; | ||
|
|
||
| protected final HttpClient httpClient; | ||
| protected String hostname = ""; | ||
| protected String mac = ""; | ||
|
|
||
| private @Nullable ScheduledFuture<?> pollingJob; | ||
| protected final Gson gson = new Gson(); | ||
|
|
||
| public AbstractMyStromHandler(Thing thing, HttpClient httpClient) { | ||
| super(thing); | ||
| this.httpClient = httpClient; | ||
| } | ||
|
|
||
| @Override | ||
| public final void initialize() { | ||
| MyStromConfiguration config = getConfigAs(MyStromConfiguration.class); | ||
| this.hostname = HTTP_REQUEST_URL_PREFIX + config.hostname; | ||
|
|
||
| updateStatus(ThingStatus.UNKNOWN); | ||
| scheduler.schedule(this::initializeInternal, 0, TimeUnit.SECONDS); | ||
| } | ||
|
|
||
| @Override | ||
| public final void dispose() { | ||
| ScheduledFuture<?> pollingJob = this.pollingJob; | ||
| if (pollingJob != null) { | ||
| pollingJob.cancel(true); | ||
| this.pollingJob = null; | ||
| } | ||
| super.dispose(); | ||
| } | ||
|
|
||
| private void updateProperties() throws MyStromException { | ||
| String json = sendHttpRequest(HttpMethod.GET, "/api/v1/info", null); | ||
| MyStromDeviceInfo deviceInfo = gson.fromJson(json, MyStromDeviceInfo.class); | ||
| if (deviceInfo == null) { | ||
| throw new MyStromException("Cannot retrieve device info from myStrom device " + getThing().getUID()); | ||
| } | ||
| this.mac = deviceInfo.mac; | ||
| Map<String, String> properties = editProperties(); | ||
| properties.put(PROPERTY_MAC, deviceInfo.mac); | ||
| properties.put(PROPERTY_VERSION, deviceInfo.version); | ||
| properties.put(PROPERTY_TYPE, Long.toString(deviceInfo.type)); | ||
| properties.put(PROPERTY_SSID, deviceInfo.ssid); | ||
| properties.put(PROPERTY_IP, deviceInfo.ip); | ||
| properties.put(PROPERTY_MASK, deviceInfo.mask); | ||
| properties.put(PROPERTY_GW, deviceInfo.gw); | ||
| properties.put(PROPERTY_DNS, deviceInfo.dns); | ||
| properties.put(PROPERTY_STATIC, Boolean.toString(deviceInfo.staticState)); | ||
| properties.put(PROPERTY_CONNECTED, Boolean.toString(deviceInfo.connected)); | ||
| Calendar calendar = Calendar.getInstance(); | ||
| DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM, Locale.getDefault()); | ||
| properties.put(PROPERTY_LAST_REFRESH, formatter.format(calendar.getTime())); | ||
| updateProperties(properties); | ||
| } | ||
|
|
||
| /** | ||
| * Calls the API with the given http method, request path and actual data. | ||
| * | ||
| * @param method the http method to make the call with | ||
| * @param path The path of the API endpoint | ||
| * @param requestData the actual raw data to send in the request body, may be {@code null} | ||
| * @return String contents of the response for the GET request. | ||
| * @throws MyStromException Throws on communication error | ||
| */ | ||
| protected final String sendHttpRequest(HttpMethod method, String path, @Nullable String requestData) | ||
| throws MyStromException { | ||
| String url = hostname + path; | ||
| try { | ||
| Request request = httpClient.newRequest(url).timeout(10, TimeUnit.SECONDS).method(method); | ||
| if (requestData != null) { | ||
| request = request.content(new StringContentProvider(requestData)).header(HttpHeader.CONTENT_TYPE, | ||
| "application/x-www-form-urlencoded"); | ||
| } | ||
| ContentResponse response = request.send(); | ||
| if (response.getStatus() != HttpStatus.OK_200) { | ||
| throw new MyStromException("Error sending HTTP " + method + " request to " + url | ||
| + ". Got response code: " + response.getStatus()); | ||
| } | ||
| return response.getContentAsString(); | ||
| } catch (InterruptedException | TimeoutException | ExecutionException e) { | ||
| throw new MyStromException(COMMUNICATION_ERROR + e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| private void initializeInternal() { | ||
| try { | ||
| updateProperties(); | ||
| updateStatus(ThingStatus.ONLINE); | ||
| MyStromConfiguration config = getConfigAs(MyStromConfiguration.class); | ||
| pollingJob = scheduler.scheduleWithFixedDelay(this::pollDevice, 0, config.refresh, TimeUnit.SECONDS); | ||
| } catch (MyStromException e) { | ||
| updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| protected abstract void pollDevice(); | ||
| } |
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
Oops, something went wrong.