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.io.homekit.internal.accessories;
  14
  15 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.ACTIVE_STATUS;
  16 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.CURRENT_HEATER_COOLER_STATE;
  17 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE;
  18
  19 import java.math.BigDecimal;
  20 import java.util.ArrayList;
  21 import java.util.EnumMap;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Optional;
  25 import java.util.concurrent.CompletableFuture;
  26
  27 import org.eclipse.jdt.annotation.Nullable;
  28 import org.openhab.core.items.GenericItem;
  29 import org.openhab.core.library.items.StringItem;
  30 import org.openhab.core.library.types.OnOffType;
  31 import org.openhab.core.library.types.OpenClosedType;
  32 import org.openhab.core.library.types.StringType;
  33 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
  34 import org.openhab.io.homekit.internal.HomekitCharacteristicType;
  35 import org.openhab.io.homekit.internal.HomekitSettings;
  36 import org.openhab.io.homekit.internal.HomekitTaggedItem;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 import io.github.hapjava.accessories.HeaterCoolerAccessory;
  41 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
  42 import io.github.hapjava.characteristics.impl.heatercooler.CurrentHeaterCoolerStateEnum;
  43 import io.github.hapjava.characteristics.impl.heatercooler.TargetHeaterCoolerStateEnum;
  44 import io.github.hapjava.characteristics.impl.thermostat.CurrentTemperatureCharacteristic;
  45 import io.github.hapjava.characteristics.impl.thermostat.TemperatureDisplayUnitCharacteristic;
  46 import io.github.hapjava.characteristics.impl.thermostat.TemperatureDisplayUnitEnum;
  47 import io.github.hapjava.services.impl.HeaterCoolerService;
  48
  49 /**
  50  * Implements Heater Cooler
  51  *
  52  * @author Eugen Freiter - Initial contribution
  53  */
  54
  55 public class HomekitHeaterCoolerImpl extends AbstractHomekitAccessoryImpl implements HeaterCoolerAccessory {
  56     private final Logger logger = LoggerFactory.getLogger(HomekitHeaterCoolerImpl.class);
  57     private final BooleanItemReader activeReader;
  58     private final Map<CurrentHeaterCoolerStateEnum, String> currentStateMapping = new EnumMap<CurrentHeaterCoolerStateEnum, String>(
  59             CurrentHeaterCoolerStateEnum.class) {
  60         {
  61             put(CurrentHeaterCoolerStateEnum.INACTIVE, "INACTIVE");
  62             put(CurrentHeaterCoolerStateEnum.IDLE, "IDLE");
  63             put(CurrentHeaterCoolerStateEnum.HEATING, "HEATING");
  64             put(CurrentHeaterCoolerStateEnum.COOLING, "COOLING");
  65         }
  66     };
  67     private final Map<TargetHeaterCoolerStateEnum, String> targetStateMapping = new EnumMap<TargetHeaterCoolerStateEnum, String>(
  68             TargetHeaterCoolerStateEnum.class) {
  69         {
  70             put(TargetHeaterCoolerStateEnum.AUTO, "AUTO");
  71             put(TargetHeaterCoolerStateEnum.HEAT, "HEAT");
  72             put(TargetHeaterCoolerStateEnum.COOL, "COOL");
  73         }
  74     };
  75
  76     private final List<CurrentHeaterCoolerStateEnum> customCurrentStateList = new ArrayList<>();
  77     private final List<TargetHeaterCoolerStateEnum> customTargetStateList = new ArrayList<>();
  78
  79     public HomekitHeaterCoolerImpl(HomekitTaggedItem taggedItem, List<HomekitTaggedItem> mandatoryCharacteristics,
  80             HomekitAccessoryUpdater updater, HomekitSettings settings) throws IncompleteAccessoryException {
  81         super(taggedItem, mandatoryCharacteristics, updater, settings);
  82         activeReader = new BooleanItemReader(getItem(ACTIVE_STATUS, GenericItem.class)
  83                 .orElseThrow(() -> new IncompleteAccessoryException(ACTIVE_STATUS)), OnOffType.ON, OpenClosedType.OPEN);
  84         updateMapping(CURRENT_HEATER_COOLER_STATE, currentStateMapping, customCurrentStateList);
  85         updateMapping(TARGET_HEATER_COOLER_STATE, targetStateMapping, customTargetStateList);
  86         final HeaterCoolerService service = new HeaterCoolerService(this);
  87         service.addOptionalCharacteristic(new TemperatureDisplayUnitCharacteristic(this::getTemperatureDisplayUnit,
  88                 this::setTemperatureDisplayUnit, this::subscribeTemperatureDisplayUnit,
  89                 this::unsubscribeTemperatureDisplayUnit));
  90         getServices().add(service);
  91     }
  92
  93     @Override
  94     public CurrentHeaterCoolerStateEnum[] getCurrentHeaterCoolerStateValidValues() {
  95         return customCurrentStateList.isEmpty()
  96                 ? currentStateMapping.keySet().toArray(new CurrentHeaterCoolerStateEnum[0])
  97                 : customCurrentStateList.toArray(new CurrentHeaterCoolerStateEnum[0]);
  98     }
  99
 100     @Override
 101     public TargetHeaterCoolerStateEnum[] getTargetHeaterCoolerStateValidValues() {
 102         return customTargetStateList.isEmpty() ? targetStateMapping.keySet().toArray(new TargetHeaterCoolerStateEnum[0])
 103                 : customTargetStateList.toArray(new TargetHeaterCoolerStateEnum[0]);
 104     }
 105
 106     @Override
 107     public CompletableFuture<Double> getCurrentTemperature() {
 108         final @Nullable Double state = getStateAsTemperature(HomekitCharacteristicType.CURRENT_TEMPERATURE);
 109         return CompletableFuture.completedFuture(state != null ? state
 110                 : getAccessoryConfiguration(HomekitCharacteristicType.CURRENT_TEMPERATURE, HomekitTaggedItem.MIN_VALUE,
 111                         BigDecimal.valueOf(HomekitCharacteristicFactory
 112                                 .convertFromCelsius(CurrentTemperatureCharacteristic.DEFAULT_MIN_VALUE)))
 113                         .doubleValue());
 114     }
 115
 116     @Override
 117     public CompletableFuture<Boolean> isActive() {
 118         return CompletableFuture.completedFuture(activeReader.getValue());
 119     }
 120
 121     @Override
 122     public CompletableFuture<Void> setActive(boolean state) {
 123         activeReader.setValue(state);
 124         return CompletableFuture.completedFuture(null);
 125     }
 126
 127     @Override
 128     public CompletableFuture<CurrentHeaterCoolerStateEnum> getCurrentHeaterCoolerState() {
 129         return CompletableFuture.completedFuture(getKeyFromMapping(CURRENT_HEATER_COOLER_STATE, currentStateMapping,
 130                 CurrentHeaterCoolerStateEnum.INACTIVE));
 131     }
 132
 133     @Override
 134     public CompletableFuture<TargetHeaterCoolerStateEnum> getTargetHeaterCoolerState() {
 135         return CompletableFuture.completedFuture(
 136                 getKeyFromMapping(TARGET_HEATER_COOLER_STATE, targetStateMapping, TargetHeaterCoolerStateEnum.AUTO));
 137     }
 138
 139     @Override
 140     public CompletableFuture<Void> setTargetHeaterCoolerState(TargetHeaterCoolerStateEnum state) {
 141         final Optional<HomekitTaggedItem> characteristic = getCharacteristic(
 142                 HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE);
 143         if (characteristic.isPresent()) {
 144             ((StringItem) characteristic.get().getItem()).send(new StringType(targetStateMapping.get(state)));
 145         } else {
 146             logger.warn("Missing mandatory characteristic {}",
 147                     HomekitCharacteristicType.TARGET_HEATING_COOLING_STATE.getTag());
 148         }
 149         return CompletableFuture.completedFuture(null);
 150     }
 151
 152     public CompletableFuture<TemperatureDisplayUnitEnum> getTemperatureDisplayUnit() {
 153         return CompletableFuture
 154                 .completedFuture(HomekitCharacteristicFactory.useFahrenheit() ? TemperatureDisplayUnitEnum.FAHRENHEIT
 155                         : TemperatureDisplayUnitEnum.CELSIUS);
 156     }
 157
 158     public void setTemperatureDisplayUnit(TemperatureDisplayUnitEnum value) {
 159         // temperature unit set globally via binding setting and cannot be changed at item level.
 160         // this method is intentionally empty.
 161     }
 162
 163     @Override
 164     public void subscribeCurrentHeaterCoolerState(HomekitCharacteristicChangeCallback callback) {
 165         subscribe(HomekitCharacteristicType.CURRENT_HEATER_COOLER_STATE, callback);
 166     }
 167
 168     @Override
 169     public void unsubscribeCurrentHeaterCoolerState() {
 170         unsubscribe(HomekitCharacteristicType.CURRENT_HEATER_COOLER_STATE);
 171     }
 172
 173     @Override
 174     public void subscribeTargetHeaterCoolerState(HomekitCharacteristicChangeCallback callback) {
 175         subscribe(HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE, callback);
 176     }
 177
 178     @Override
 179     public void unsubscribeTargetHeaterCoolerState() {
 180         unsubscribe(HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE);
 181     }
 182
 183     @Override
 184     public void subscribeActive(HomekitCharacteristicChangeCallback callback) {
 185         subscribe(ACTIVE_STATUS, callback);
 186     }
 187
 188     @Override
 189     public void unsubscribeActive() {
 190         unsubscribe(ACTIVE_STATUS);
 191     }
 192
 193     @Override
 194     public void subscribeCurrentTemperature(HomekitCharacteristicChangeCallback callback) {
 195         subscribe(HomekitCharacteristicType.CURRENT_TEMPERATURE, callback);
 196     }
 197
 198     @Override
 199     public void unsubscribeCurrentTemperature() {
 200         unsubscribe(HomekitCharacteristicType.CURRENT_TEMPERATURE);
 201     }
 202
 203     public void subscribeTemperatureDisplayUnit(HomekitCharacteristicChangeCallback callback) {
 204         // temperature unit set globally via binding setting and cannot be changed at item level.
 205         // this method is intentionally empty
 206     }
 207
 208     public void unsubscribeTemperatureDisplayUnit() {
 209         // temperature unit set globally via binding setting and cannot be changed at item level.
 210         // this method is intentionally empty
 211     }
 212 }