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

   1 /**
   2  * Copyright (c) 2010-2022 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.daikin.internal;
  14
  15 import java.io.EOFException;
  16 import java.util.HashMap;
  17 import java.util.Map;
  18 import java.util.concurrent.ExecutionException;
  19 import java.util.concurrent.TimeUnit;
  20 import java.util.concurrent.TimeoutException;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.eclipse.jetty.client.HttpClient;
  25 import org.eclipse.jetty.client.api.ContentResponse;
  26 import org.eclipse.jetty.client.api.Request;
  27 import org.eclipse.jetty.http.HttpMethod;
  28 import org.eclipse.jetty.http.HttpStatus;
  29 import org.openhab.binding.daikin.internal.api.BasicInfo;
  30 import org.openhab.binding.daikin.internal.api.ControlInfo;
  31 import org.openhab.binding.daikin.internal.api.EnergyInfoDayAndWeek;
  32 import org.openhab.binding.daikin.internal.api.EnergyInfoYear;
  33 import org.openhab.binding.daikin.internal.api.Enums.SpecialMode;
  34 import org.openhab.binding.daikin.internal.api.SensorInfo;
  35 import org.openhab.binding.daikin.internal.api.airbase.AirbaseBasicInfo;
  36 import org.openhab.binding.daikin.internal.api.airbase.AirbaseControlInfo;
  37 import org.openhab.binding.daikin.internal.api.airbase.AirbaseModelInfo;
  38 import org.openhab.binding.daikin.internal.api.airbase.AirbaseZoneInfo;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * Handles performing the actual HTTP requests for communicating with Daikin air conditioning units.
  44  *
  45  * @author Tim Waterhouse - Initial Contribution
  46  * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
  47  * @author Jimmy Tanagra - Add support for https and Daikin's uuid authentication
  48  *         Implement connection retry
  49  *
  50  */
  51 @NonNullByDefault
  52 public class DaikinWebTargets {
  53     private static final int TIMEOUT_MS = 5000;
  54
  55     private String getBasicInfoUri;
  56     private String setControlInfoUri;
  57     private String getControlInfoUri;
  58     private String getSensorInfoUri;
  59     private String registerUuidUri;
  60     private String getEnergyInfoYearUri;
  61     private String getEnergyInfoWeekUri;
  62     private String setSpecialModeUri;
  63
  64     private String setAirbaseControlInfoUri;
  65     private String getAirbaseControlInfoUri;
  66     private String getAirbaseSensorInfoUri;
  67     private String getAirbaseBasicInfoUri;
  68     private String getAirbaseModelInfoUri;
  69     private String getAirbaseZoneInfoUri;
  70     private String setAirbaseZoneInfoUri;
  71
  72     private @Nullable String uuid;
  73     private final @Nullable HttpClient httpClient;
  74
  75     private Logger logger = LoggerFactory.getLogger(DaikinWebTargets.class);
  76
  77     public DaikinWebTargets(@Nullable HttpClient httpClient, @Nullable String host, @Nullable Boolean secure,
  78             @Nullable String uuid) {
  79         this.httpClient = httpClient;
  80         this.uuid = uuid;
  81
  82         String baseUri = (secure != null && secure.booleanValue() ? "https://" : "http://") + host + "/";
  83         getBasicInfoUri = baseUri + "common/basic_info";
  84         setControlInfoUri = baseUri + "aircon/set_control_info";
  85         getControlInfoUri = baseUri + "aircon/get_control_info";
  86         getSensorInfoUri = baseUri + "aircon/get_sensor_info";
  87         registerUuidUri = baseUri + "common/register_terminal";
  88         getEnergyInfoYearUri = baseUri + "aircon/get_year_power_ex";
  89         getEnergyInfoWeekUri = baseUri + "aircon/get_week_power_ex";
  90         setSpecialModeUri = baseUri + "aircon/set_special_mode";
  91
  92         // Daikin Airbase API
  93         getAirbaseBasicInfoUri = baseUri + "skyfi/common/basic_info";
  94         setAirbaseControlInfoUri = baseUri + "skyfi/aircon/set_control_info";
  95         getAirbaseControlInfoUri = baseUri + "skyfi/aircon/get_control_info";
  96         getAirbaseSensorInfoUri = baseUri + "skyfi/aircon/get_sensor_info";
  97         getAirbaseModelInfoUri = baseUri + "skyfi/aircon/get_model_info";
  98         getAirbaseZoneInfoUri = baseUri + "skyfi/aircon/get_zone_setting";
  99         setAirbaseZoneInfoUri = baseUri + "skyfi/aircon/set_zone_setting";
 100     }
 101
 102     // Standard Daikin API
 103     public BasicInfo getBasicInfo() throws DaikinCommunicationException {
 104         String response = invoke(getBasicInfoUri);
 105         return BasicInfo.parse(response);
 106     }
 107
 108     public ControlInfo getControlInfo() throws DaikinCommunicationException {
 109         String response = invoke(getControlInfoUri);
 110         return ControlInfo.parse(response);
 111     }
 112
 113     public void setControlInfo(ControlInfo info) throws DaikinCommunicationException {
 114         Map<String, String> queryParams = info.getParamString();
 115         invoke(setControlInfoUri, queryParams);
 116     }
 117
 118     public SensorInfo getSensorInfo() throws DaikinCommunicationException {
 119         String response = invoke(getSensorInfoUri);
 120         return SensorInfo.parse(response);
 121     }
 122
 123     public void registerUuid(String key) throws DaikinCommunicationException {
 124         Map<String, String> params = new HashMap<>();
 125         params.put("key", key);
 126         String response = invoke(registerUuidUri, params);
 127         logger.debug("registerUuid result: {}", response);
 128     }
 129
 130     public EnergyInfoYear getEnergyInfoYear() throws DaikinCommunicationException {
 131         String response = invoke(getEnergyInfoYearUri);
 132         return EnergyInfoYear.parse(response);
 133     }
 134
 135     public EnergyInfoDayAndWeek getEnergyInfoDayAndWeek() throws DaikinCommunicationException {
 136         String response = invoke(getEnergyInfoWeekUri);
 137         return EnergyInfoDayAndWeek.parse(response);
 138     }
 139
 140     public void setSpecialMode(SpecialMode specialMode) throws DaikinCommunicationException {
 141         Map<String, String> queryParams = new HashMap<>();
 142         if (specialMode == SpecialMode.NORMAL) {
 143             queryParams.put("set_spmode", "0");
 144         } else {
 145             queryParams.put("set_spmode", "1");
 146             queryParams.put("spmode_kind", Integer.toString(specialMode.getValue()));
 147         }
 148         String response = invoke(setSpecialModeUri, queryParams);
 149     }
 150
 151     public void setStreamerMode(boolean state) throws DaikinCommunicationException {
 152         Map<String, String> queryParams = new HashMap<>();
 153         queryParams.put("en_streamer", state ? "1" : "0");
 154         String response = invoke(setSpecialModeUri, queryParams);
 155     }
 156
 157     // Daikin Airbase API
 158     public AirbaseControlInfo getAirbaseControlInfo() throws DaikinCommunicationException {
 159         String response = invoke(getAirbaseControlInfoUri);
 160         return AirbaseControlInfo.parse(response);
 161     }
 162
 163     public void setAirbaseControlInfo(AirbaseControlInfo info) throws DaikinCommunicationException {
 164         Map<String, String> queryParams = info.getParamString();
 165         invoke(setAirbaseControlInfoUri, queryParams);
 166     }
 167
 168     public SensorInfo getAirbaseSensorInfo() throws DaikinCommunicationException {
 169         String response = invoke(getAirbaseSensorInfoUri);
 170         return SensorInfo.parse(response);
 171     }
 172
 173     public AirbaseBasicInfo getAirbaseBasicInfo() throws DaikinCommunicationException {
 174         String response = invoke(getAirbaseBasicInfoUri);
 175         return AirbaseBasicInfo.parse(response);
 176     }
 177
 178     public AirbaseModelInfo getAirbaseModelInfo() throws DaikinCommunicationException {
 179         String response = invoke(getAirbaseModelInfoUri);
 180         return AirbaseModelInfo.parse(response);
 181     }
 182
 183     public AirbaseZoneInfo getAirbaseZoneInfo() throws DaikinCommunicationException {
 184         String response = invoke(getAirbaseZoneInfoUri);
 185         return AirbaseZoneInfo.parse(response);
 186     }
 187
 188     public void setAirbaseZoneInfo(AirbaseZoneInfo zoneinfo) throws DaikinCommunicationException {
 189         Map<String, String> queryParams = zoneinfo.getParamString();
 190         invoke(setAirbaseZoneInfoUri, queryParams);
 191     }
 192
 193     private String invoke(String uri) throws DaikinCommunicationException {
 194         return invoke(uri, null);
 195     }
 196
 197     private synchronized String invoke(String url, @Nullable Map<String, String> params)
 198             throws DaikinCommunicationException {
 199         int attemptCount = 1;
 200         try {
 201             while (true) {
 202                 try {
 203                     String result = executeUrl(url, params);
 204                     if (attemptCount > 1) {
 205                         logger.debug("HTTP request successful on attempt #{}: {}", attemptCount, url);
 206                     }
 207                     return result;
 208                 } catch (ExecutionException | TimeoutException e) {
 209                     if (attemptCount >= 3) {
 210                         logger.debug("HTTP request failed after {} attempts: {}", attemptCount, url, e);
 211                         Throwable rootCause = getRootCause(e);
 212                         String message = rootCause.getMessage();
 213                         // EOFException message is too verbose/gibberish
 214                         if (message == null || rootCause instanceof EOFException) {
 215                             message = "Connection error";
 216                         }
 217                         throw new DaikinCommunicationException(message);
 218                     }
 219                     logger.debug("HTTP request error on attempt #{}: {} {}", attemptCount, url, e.getMessage());
 220                     Thread.sleep(500 * attemptCount);
 221                     attemptCount++;
 222                 }
 223             }
 224         } catch (InterruptedException e) {
 225             Thread.currentThread().interrupt();
 226             throw new DaikinCommunicationException("Execution interrupted");
 227         }
 228     }
 229
 230     private String executeUrl(String url, @Nullable Map<String, String> params)
 231             throws InterruptedException, TimeoutException, ExecutionException, DaikinCommunicationException {
 232         Request request = httpClient.newRequest(url).method(HttpMethod.GET).timeout(TIMEOUT_MS, TimeUnit.MILLISECONDS);
 233         if (uuid != null) {
 234             request.header("X-Daikin-uuid", uuid);
 235             logger.trace("Header: X-Daikin-uuid: {}", uuid);
 236         }
 237         if (params != null) {
 238             params.forEach((key, value) -> request.param(key, value));
 239         }
 240         logger.trace("Calling url: {}", request.getURI());
 241
 242         ContentResponse response = request.send();
 243
 244         if (response.getStatus() != HttpStatus.OK_200) {
 245             logger.debug("Daikin controller HTTP status: {} - {} {}", response.getStatus(), response.getReason(), url);
 246         }
 247
 248         if (response.getStatus() == HttpStatus.FORBIDDEN_403) {
 249             throw new DaikinCommunicationForbiddenException("Daikin controller access denied. Check uuid/key.");
 250         }
 251
 252         return response.getContentAsString();
 253     }
 254
 255     private Throwable getRootCause(Throwable exception) {
 256         Throwable cause = exception.getCause();
 257         while (cause != null) {
 258             exception = cause;
 259             cause = cause.getCause();
 260         }
 261         return exception;
 262     }
 263 }