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

   1 /**
   2  * Copyright (c) 2010-2024 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.List;
  22 import java.util.Map;
  23 import java.util.concurrent.CompletableFuture;
  24
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.openhab.core.items.GenericItem;
  27 import org.openhab.core.library.types.OnOffType;
  28 import org.openhab.core.library.types.OpenClosedType;
  29 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
  30 import org.openhab.io.homekit.internal.HomekitCharacteristicType;
  31 import org.openhab.io.homekit.internal.HomekitException;
  32 import org.openhab.io.homekit.internal.HomekitSettings;
  33 import org.openhab.io.homekit.internal.HomekitTaggedItem;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 import io.github.hapjava.accessories.HeaterCoolerAccessory;
  38 import io.github.hapjava.characteristics.Characteristic;
  39 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
  40 import io.github.hapjava.characteristics.impl.heatercooler.CurrentHeaterCoolerStateEnum;
  41 import io.github.hapjava.characteristics.impl.heatercooler.TargetHeaterCoolerStateEnum;
  42 import io.github.hapjava.characteristics.impl.thermostat.CurrentTemperatureCharacteristic;
  43 import io.github.hapjava.characteristics.impl.thermostat.TemperatureDisplayUnitCharacteristic;
  44 import io.github.hapjava.services.impl.HeaterCoolerService;
  45
  46 /**
  47  * Implements Heater Cooler
  48  *
  49  * @author Eugen Freiter - Initial contribution
  50  */
  51
  52 public class HomekitHeaterCoolerImpl extends AbstractHomekitAccessoryImpl implements HeaterCoolerAccessory {
  53     private final Logger logger = LoggerFactory.getLogger(HomekitHeaterCoolerImpl.class);
  54     private final BooleanItemReader activeReader;
  55     private final Map<CurrentHeaterCoolerStateEnum, String> currentStateMapping;
  56     private final Map<TargetHeaterCoolerStateEnum, String> targetStateMapping;
  57
  58     private final List<CurrentHeaterCoolerStateEnum> customCurrentStateList = new ArrayList<>();
  59     private final List<TargetHeaterCoolerStateEnum> customTargetStateList = new ArrayList<>();
  60
  61     public HomekitHeaterCoolerImpl(HomekitTaggedItem taggedItem, List<HomekitTaggedItem> mandatoryCharacteristics,
  62             List<Characteristic> mandatoryRawCharacteristics, HomekitAccessoryUpdater updater, HomekitSettings settings)
  63             throws IncompleteAccessoryException {
  64         super(taggedItem, mandatoryCharacteristics, mandatoryRawCharacteristics, updater, settings);
  65         activeReader = new BooleanItemReader(getItem(ACTIVE_STATUS, GenericItem.class)
  66                 .orElseThrow(() -> new IncompleteAccessoryException(ACTIVE_STATUS)), OnOffType.ON, OpenClosedType.OPEN);
  67         currentStateMapping = createMapping(CURRENT_HEATER_COOLER_STATE, CurrentHeaterCoolerStateEnum.class,
  68                 customCurrentStateList);
  69         targetStateMapping = createMapping(TARGET_HEATER_COOLER_STATE, TargetHeaterCoolerStateEnum.class,
  70                 customTargetStateList);
  71     }
  72
  73     @Override
  74     public void init() throws HomekitException {
  75         super.init();
  76         final HeaterCoolerService service = new HeaterCoolerService(this);
  77
  78         var temperatureDisplayUnit = getCharacteristic(TemperatureDisplayUnitCharacteristic.class);
  79         if (temperatureDisplayUnit.isEmpty()) {
  80             service.addOptionalCharacteristic(
  81                     HomekitCharacteristicFactory.createSystemTemperatureDisplayUnitCharacteristic());
  82         }
  83
  84         addService(service);
  85     }
  86
  87     @Override
  88     public CurrentHeaterCoolerStateEnum[] getCurrentHeaterCoolerStateValidValues() {
  89         return customCurrentStateList.isEmpty()
  90                 ? currentStateMapping.keySet().toArray(new CurrentHeaterCoolerStateEnum[0])
  91                 : customCurrentStateList.toArray(new CurrentHeaterCoolerStateEnum[0]);
  92     }
  93
  94     @Override
  95     public TargetHeaterCoolerStateEnum[] getTargetHeaterCoolerStateValidValues() {
  96         return customTargetStateList.isEmpty() ? targetStateMapping.keySet().toArray(new TargetHeaterCoolerStateEnum[0])
  97                 : customTargetStateList.toArray(new TargetHeaterCoolerStateEnum[0]);
  98     }
  99
 100     @Override
 101     public CompletableFuture<Double> getCurrentTemperature() {
 102         final @Nullable Double state = getStateAsTemperature(HomekitCharacteristicType.CURRENT_TEMPERATURE);
 103         return CompletableFuture.completedFuture(state != null ? state
 104                 : getAccessoryConfiguration(HomekitCharacteristicType.CURRENT_TEMPERATURE, HomekitTaggedItem.MIN_VALUE,
 105                         BigDecimal.valueOf(HomekitCharacteristicFactory
 106                                 .convertFromCelsius(CurrentTemperatureCharacteristic.DEFAULT_MIN_VALUE)))
 107                         .doubleValue());
 108     }
 109
 110     @Override
 111     public CompletableFuture<Boolean> isActive() {
 112         return CompletableFuture.completedFuture(activeReader.getValue());
 113     }
 114
 115     @Override
 116     public CompletableFuture<Void> setActive(boolean state) {
 117         activeReader.setValue(state);
 118         return CompletableFuture.completedFuture(null);
 119     }
 120
 121     @Override
 122     public CompletableFuture<CurrentHeaterCoolerStateEnum> getCurrentHeaterCoolerState() {
 123         return CompletableFuture.completedFuture(getKeyFromMapping(CURRENT_HEATER_COOLER_STATE, currentStateMapping,
 124                 CurrentHeaterCoolerStateEnum.INACTIVE));
 125     }
 126
 127     @Override
 128     public CompletableFuture<TargetHeaterCoolerStateEnum> getTargetHeaterCoolerState() {
 129         return CompletableFuture.completedFuture(
 130                 getKeyFromMapping(TARGET_HEATER_COOLER_STATE, targetStateMapping, TargetHeaterCoolerStateEnum.AUTO));
 131     }
 132
 133     @Override
 134     public CompletableFuture<Void> setTargetHeaterCoolerState(TargetHeaterCoolerStateEnum state) {
 135         HomekitCharacteristicFactory.setValueFromEnum(
 136                 getCharacteristic(HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE).get(), state,
 137                 targetStateMapping);
 138         return CompletableFuture.completedFuture(null);
 139     }
 140
 141     @Override
 142     public void subscribeCurrentHeaterCoolerState(HomekitCharacteristicChangeCallback callback) {
 143         subscribe(HomekitCharacteristicType.CURRENT_HEATER_COOLER_STATE, callback);
 144     }
 145
 146     @Override
 147     public void unsubscribeCurrentHeaterCoolerState() {
 148         unsubscribe(HomekitCharacteristicType.CURRENT_HEATER_COOLER_STATE);
 149     }
 150
 151     @Override
 152     public void subscribeTargetHeaterCoolerState(HomekitCharacteristicChangeCallback callback) {
 153         subscribe(HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE, callback);
 154     }
 155
 156     @Override
 157     public void unsubscribeTargetHeaterCoolerState() {
 158         unsubscribe(HomekitCharacteristicType.TARGET_HEATER_COOLER_STATE);
 159     }
 160
 161     @Override
 162     public void subscribeActive(HomekitCharacteristicChangeCallback callback) {
 163         subscribe(ACTIVE_STATUS, callback);
 164     }
 165
 166     @Override
 167     public void unsubscribeActive() {
 168         unsubscribe(ACTIVE_STATUS);
 169     }
 170
 171     @Override
 172     public void subscribeCurrentTemperature(HomekitCharacteristicChangeCallback callback) {
 173         subscribe(HomekitCharacteristicType.CURRENT_TEMPERATURE, callback);
 174     }
 175
 176     @Override
 177     public void unsubscribeCurrentTemperature() {
 178         unsubscribe(HomekitCharacteristicType.CURRENT_TEMPERATURE);
 179     }
 180 }