2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.tado.internal.builder;
15 import java.io.IOException;
17 import org.eclipse.jdt.annotation.NonNullByDefault;
18 import org.eclipse.jdt.annotation.Nullable;
19 import org.openhab.binding.tado.internal.TadoBindingConstants.FanLevel;
20 import org.openhab.binding.tado.internal.TadoBindingConstants.FanSpeed;
21 import org.openhab.binding.tado.internal.TadoBindingConstants.HorizontalSwing;
22 import org.openhab.binding.tado.internal.TadoBindingConstants.HvacMode;
23 import org.openhab.binding.tado.internal.TadoBindingConstants.TemperatureUnit;
24 import org.openhab.binding.tado.internal.TadoBindingConstants.VerticalSwing;
25 import org.openhab.binding.tado.internal.TadoBindingConstants.ZoneType;
26 import org.openhab.binding.tado.internal.api.ApiException;
27 import org.openhab.binding.tado.internal.api.model.GenericZoneCapabilities;
28 import org.openhab.binding.tado.internal.api.model.GenericZoneSetting;
29 import org.openhab.binding.tado.internal.api.model.TemperatureObject;
30 import org.openhab.binding.tado.internal.handler.TadoZoneHandler;
33 * Base class for zone settings builder.
35 * @author Dennis Frommknecht - Initial contribution
38 public abstract class ZoneSettingsBuilder {
40 public static ZoneSettingsBuilder of(TadoZoneHandler zoneHandler) {
41 ZoneType zoneType = zoneHandler.getZoneType();
45 return new HeatingZoneSettingsBuilder();
46 case AIR_CONDITIONING:
47 return new AirConditioningZoneSettingsBuilder();
49 return new HotWaterZoneSettingsBuilder();
51 throw new IllegalArgumentException("Zone type " + zoneType + " unknown");
55 protected TemperatureUnit temperatureUnit = TemperatureUnit.CELSIUS;
56 protected @Nullable Float temperature;
57 protected @Nullable HvacMode mode;
58 protected @Nullable Boolean swing;
59 protected @Nullable Boolean light;
60 protected @Nullable FanSpeed fanSpeed;
61 protected @Nullable FanLevel fanLevel;
62 protected @Nullable HorizontalSwing horizontalSwing;
63 protected @Nullable VerticalSwing verticalSwing;
65 public ZoneSettingsBuilder withMode(HvacMode mode) {
70 public ZoneSettingsBuilder withTemperature(Float temperature, TemperatureUnit temperatureUnit) {
71 this.temperature = temperature;
72 this.temperatureUnit = temperatureUnit;
76 public ZoneSettingsBuilder withSwing(boolean swingOn) {
81 public ZoneSettingsBuilder withFanSpeed(FanSpeed fanSpeed) {
82 this.fanSpeed = fanSpeed;
86 public ZoneSettingsBuilder withFanLevel(FanLevel fanLevel) {
87 this.fanLevel = fanLevel;
91 public ZoneSettingsBuilder withHorizontalSwing(HorizontalSwing horizontalSwing) {
92 this.horizontalSwing = horizontalSwing;
96 public ZoneSettingsBuilder withVerticalSwing(VerticalSwing verticalSwing) {
97 this.verticalSwing = verticalSwing;
101 public abstract GenericZoneSetting build(ZoneStateProvider zoneStateProvider, GenericZoneCapabilities capabilities)
102 throws IOException, ApiException;
104 protected TemperatureObject truncateTemperature(TemperatureObject temperature) {
105 TemperatureObject temperatureObject = new TemperatureObject();
106 if (temperatureUnit == TemperatureUnit.FAHRENHEIT) {
107 temperatureObject.setFahrenheit(temperature.getFahrenheit());
109 temperatureObject.setCelsius(temperature.getCelsius());
112 return temperatureObject;
115 protected TemperatureObject buildDefaultTemperatureObject(float temperatureCelsius, float temperatureFahrenheit) {
116 TemperatureObject temperatureObject = new TemperatureObject();
118 if (temperatureUnit == TemperatureUnit.FAHRENHEIT) {
119 temperatureObject.setFahrenheit(temperatureFahrenheit);
121 temperatureObject.setCelsius(temperatureCelsius);
124 return temperatureObject;
127 public ZoneSettingsBuilder withLight(boolean lightOn) {
128 this.light = lightOn;