git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.radiothermostat.internal.communication;
  14
  15 import static org.eclipse.jetty.http.HttpMethod.GET;
  16 import static org.eclipse.jetty.http.HttpStatus.OK_200;
  17 import static org.openhab.binding.radiothermostat.internal.RadioThermostatBindingConstants.*;
  18
  19 import java.util.List;
  20 import java.util.concurrent.CopyOnWriteArrayList;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.concurrent.TimeUnit;
  23 import java.util.concurrent.TimeoutException;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.eclipse.jetty.client.HttpClient;
  28 import org.eclipse.jetty.client.api.ContentResponse;
  29 import org.eclipse.jetty.client.api.Request;
  30 import org.eclipse.jetty.client.api.Result;
  31 import org.eclipse.jetty.client.util.BufferingResponseListener;
  32 import org.eclipse.jetty.client.util.StringContentProvider;
  33 import org.eclipse.jetty.http.HttpHeader;
  34 import org.openhab.binding.radiothermostat.internal.RadioThermostatHttpException;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * Class for communicating with the RadioThermostat web interface
  40  *
  41  * @author Michael Lobstein - Initial contribution
  42  */
  43 @NonNullByDefault
  44 public class RadioThermostatConnector {
  45     private final Logger logger = LoggerFactory.getLogger(RadioThermostatConnector.class);
  46
  47     private static final String URL = "http://%s/%s";
  48
  49     private final HttpClient httpClient;
  50     private final List<RadioThermostatEventListener> listeners = new CopyOnWriteArrayList<>();
  51
  52     private String hostName = BLANK;
  53
  54     public RadioThermostatConnector(HttpClient httpClient) {
  55         this.httpClient = httpClient;
  56     }
  57
  58     public void setThermostatHostName(String hostName) {
  59         this.hostName = hostName;
  60     }
  61
  62     /**
  63      * Add a listener to the list of listeners to be notified with events
  64      *
  65      * @param listener the listener
  66      */
  67     public void addEventListener(RadioThermostatEventListener listener) {
  68         listeners.add(listener);
  69     }
  70
  71     /**
  72      * Remove a listener from the list of listeners to be notified with events
  73      *
  74      * @param listener the listener
  75      */
  76     public void removeEventListener(RadioThermostatEventListener listener) {
  77         listeners.remove(listener);
  78     }
  79
  80     /**
  81      * Send an asynchronous http call to the thermostat, the response will be send to the
  82      * event listeners as a RadioThermostat event when it is finally received
  83      *
  84      * @param resouce the url of the json resource on the thermostat
  85      */
  86     public void getAsyncThermostatData(String resource) {
  87         httpClient.newRequest(buildRequestURL(resource)).method(GET).timeout(30, TimeUnit.SECONDS)
  88                 .send(new BufferingResponseListener() {
  89                     @Override
  90                     public void onComplete(@Nullable Result result) {
  91                         if (result != null && !result.isFailed()) {
  92                             dispatchKeyValue(resource, getContentAsString());
  93                         } else {
  94                             dispatchKeyValue(KEY_ERROR, BLANK);
  95                         }
  96                     }
  97                 });
  98     }
  99
 100     /**
 101      * Sends a command to the thermostat
 102      *
 103      * @param the JSON attribute key for the value to be updated
 104      * @param the value to be updated in the thermostat
 105      * @param the end point URI to use for the command
 106      * @return the JSON response string from the thermostat
 107      */
 108     public String sendCommand(String cmdKey, @Nullable String cmdVal, String resource) {
 109         return sendCommand(cmdKey, cmdVal, null, resource);
 110     }
 111
 112     /**
 113      * Sends a command to the thermostat
 114      *
 115      * @param the JSON attribute key for the value to be updated
 116      * @param the value to be updated in the thermostat
 117      * @param JSON string to send directly to the thermostat instead of a key/value pair
 118      * @param the end point URI to use for the command
 119      * @return the JSON response string from the thermostat
 120      */
 121     public String sendCommand(@Nullable String cmdKey, @Nullable String cmdVal, @Nullable String cmdJson,
 122             String resource) {
 123         // if we got a cmdJson string send that, otherwise build the json from the key and val params
 124         String postJson = cmdJson != null ? cmdJson : "{\"" + cmdKey + "\":" + cmdVal + "}";
 125
 126         try {
 127             Request request = httpClient.POST(buildRequestURL(resource));
 128             request.header(HttpHeader.ACCEPT, "text/plain");
 129             request.header(HttpHeader.CONTENT_TYPE, "text/plain");
 130             request.content(new StringContentProvider(postJson), "application/json");
 131             logger.trace("Sending POST request to '{}', data: {}", resource, postJson);
 132
 133             ContentResponse contentResponse = request.send();
 134
 135             if (contentResponse.getStatus() != OK_200) {
 136                 throw new RadioThermostatHttpException(
 137                         "Thermostat HTTP response code was: " + contentResponse.getStatus());
 138             }
 139
 140             logger.trace("Response: {}", contentResponse.getContentAsString());
 141             return contentResponse.getContentAsString();
 142         } catch (RadioThermostatHttpException | InterruptedException | TimeoutException | ExecutionException e) {
 143             logger.debug("Error executing thermostat command: {}, {}", postJson, e.getMessage());
 144             return BLANK;
 145         }
 146     }
 147
 148     /**
 149      * Build request URL from configuration data
 150      *
 151      * @return a valid URL for the thermostat's JSON interface
 152      */
 153     private String buildRequestURL(String resource) {
 154         return String.format(URL, hostName, resource);
 155     }
 156
 157     /**
 158      * Dispatch an event (key, value) to the event listeners
 159      *
 160      * @param key the key
 161      * @param value the value
 162      */
 163     private void dispatchKeyValue(String key, String value) {
 164         RadioThermostatEvent event = new RadioThermostatEvent(this, key, value);
 165         for (RadioThermostatEventListener listener : listeners) {
 166             listener.onNewMessageEvent(event);
 167         }
 168     }
 169 }