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.tado.internal.builder;
  14
  15 import static org.openhab.binding.tado.internal.api.TadoApiTypeUtils.temperature;
  16
  17 import java.io.IOException;
  18
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.openhab.binding.tado.internal.TadoBindingConstants.FanLevel;
  21 import org.openhab.binding.tado.internal.TadoBindingConstants.FanSpeed;
  22 import org.openhab.binding.tado.internal.TadoBindingConstants.HorizontalSwing;
  23 import org.openhab.binding.tado.internal.TadoBindingConstants.HvacMode;
  24 import org.openhab.binding.tado.internal.TadoBindingConstants.VerticalSwing;
  25 import org.openhab.binding.tado.internal.api.ApiException;
  26 import org.openhab.binding.tado.internal.api.model.GenericZoneCapabilities;
  27 import org.openhab.binding.tado.internal.api.model.GenericZoneSetting;
  28 import org.openhab.binding.tado.internal.api.model.HotWaterCapabilities;
  29 import org.openhab.binding.tado.internal.api.model.HotWaterZoneSetting;
  30 import org.openhab.binding.tado.internal.api.model.Power;
  31 import org.openhab.binding.tado.internal.api.model.TadoSystemType;
  32 import org.openhab.binding.tado.internal.api.model.TemperatureObject;
  33
  34 /**
  35  * Builder for incremental creation of hot water zone settings.
  36  *
  37  * @author Dennis Frommknecht - Initial contribution
  38  */
  39 @NonNullByDefault
  40 public class HotWaterZoneSettingsBuilder extends ZoneSettingsBuilder {
  41     private static final float DEFAULT_TEMPERATURE_C = 50.0f;
  42     private static final float DEFAULT_TEMPERATURE_F = 122.0f;
  43
  44     @Override
  45     public ZoneSettingsBuilder withSwing(boolean swingOn) {
  46         throw new IllegalArgumentException("Hot Water zones don't support SWING");
  47     }
  48
  49     @Override
  50     public ZoneSettingsBuilder withLight(boolean lightOn) {
  51         throw new IllegalArgumentException("Hot Water zones don't support LIGHT");
  52     }
  53
  54     @Override
  55     public ZoneSettingsBuilder withFanSpeed(FanSpeed fanSpeed) {
  56         throw new IllegalArgumentException("Hot Water zones don't support FAN SPEED");
  57     }
  58
  59     @Override
  60     public ZoneSettingsBuilder withFanLevel(FanLevel fanLevel) {
  61         throw new IllegalArgumentException("Hot Water zones don't support FAN LEVEL");
  62     }
  63
  64     @Override
  65     public ZoneSettingsBuilder withHorizontalSwing(HorizontalSwing horizontalSwing) {
  66         throw new IllegalArgumentException("Hot Water zones don't support HORIZONTAL SWING");
  67     }
  68
  69     @Override
  70     public ZoneSettingsBuilder withVerticalSwing(VerticalSwing verticalSwing) {
  71         throw new IllegalArgumentException("Hot Water zones don't support VERTICAL SWING");
  72     }
  73
  74     @Override
  75     public GenericZoneSetting build(ZoneStateProvider zoneStateProvider, GenericZoneCapabilities capabilities)
  76             throws IOException, ApiException {
  77         if (mode == HvacMode.OFF) {
  78             return hotWaterSetting(false);
  79         }
  80
  81         HotWaterZoneSetting setting = hotWaterSetting(true);
  82
  83         Float temperature = this.temperature;
  84         if (temperature != null) {
  85             setting.setTemperature(temperature(temperature, temperatureUnit));
  86         }
  87
  88         addMissingSettingParts(setting, zoneStateProvider, (HotWaterCapabilities) capabilities);
  89
  90         return setting;
  91     }
  92
  93     private void addMissingSettingParts(HotWaterZoneSetting setting, ZoneStateProvider zoneStateProvider,
  94             HotWaterCapabilities capabilities) throws IOException, ApiException {
  95         if (capabilities.isCanSetTemperature() && setting.getTemperature() == null) {
  96             TemperatureObject temperatureObject = getCurrentOrDefaultTemperature(zoneStateProvider);
  97             setting.setTemperature(temperatureObject);
  98         }
  99     }
 100
 101     private TemperatureObject getCurrentOrDefaultTemperature(ZoneStateProvider zoneStateProvider)
 102             throws IOException, ApiException {
 103         HotWaterZoneSetting zoneSetting = (HotWaterZoneSetting) zoneStateProvider.getZoneState().getSetting();
 104
 105         if (zoneSetting != null && zoneSetting.getTemperature() != null) {
 106             return truncateTemperature(zoneSetting.getTemperature());
 107         }
 108
 109         return buildDefaultTemperatureObject(DEFAULT_TEMPERATURE_C, DEFAULT_TEMPERATURE_F);
 110     }
 111
 112     private HotWaterZoneSetting hotWaterSetting(boolean powerOn) {
 113         HotWaterZoneSetting setting = new HotWaterZoneSetting();
 114         setting.setType(TadoSystemType.HOT_WATER);
 115         setting.setPower(powerOn ? Power.ON : Power.OFF);
 116         return setting;
 117     }
 118 }