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