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

   1 /**
   2  * Copyright (c) 2010-2020 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.*;
  16
  17 import java.math.BigDecimal;
  18 import java.util.HashMap;
  19 import java.util.Map;
  20 import java.util.concurrent.CompletableFuture;
  21 import java.util.function.BiFunction;
  22 import java.util.function.Consumer;
  23 import java.util.function.Supplier;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.openhab.core.items.GenericItem;
  28 import org.openhab.core.items.Item;
  29 import org.openhab.core.library.items.ColorItem;
  30 import org.openhab.core.library.items.DimmerItem;
  31 import org.openhab.core.library.items.NumberItem;
  32 import org.openhab.core.library.items.SwitchItem;
  33 import org.openhab.core.library.types.DecimalType;
  34 import org.openhab.core.library.types.HSBType;
  35 import org.openhab.core.library.types.OnOffType;
  36 import org.openhab.core.library.types.OpenClosedType;
  37 import org.openhab.core.library.types.PercentType;
  38 import org.openhab.core.types.State;
  39 import org.openhab.core.types.UnDefType;
  40 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
  41 import org.openhab.io.homekit.internal.HomekitCharacteristicType;
  42 import org.openhab.io.homekit.internal.HomekitCommandType;
  43 import org.openhab.io.homekit.internal.HomekitException;
  44 import org.openhab.io.homekit.internal.HomekitTaggedItem;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 import io.github.hapjava.characteristics.Characteristic;
  49 import io.github.hapjava.characteristics.CharacteristicEnum;
  50 import io.github.hapjava.characteristics.ExceptionalConsumer;
  51 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
  52 import io.github.hapjava.characteristics.impl.airquality.NitrogenDioxideDensityCharacteristic;
  53 import io.github.hapjava.characteristics.impl.airquality.OzoneDensityCharacteristic;
  54 import io.github.hapjava.characteristics.impl.airquality.PM10DensityCharacteristic;
  55 import io.github.hapjava.characteristics.impl.airquality.PM25DensityCharacteristic;
  56 import io.github.hapjava.characteristics.impl.airquality.SulphurDioxideDensityCharacteristic;
  57 import io.github.hapjava.characteristics.impl.airquality.VOCDensityCharacteristic;
  58 import io.github.hapjava.characteristics.impl.audio.VolumeCharacteristic;
  59 import io.github.hapjava.characteristics.impl.battery.StatusLowBatteryCharacteristic;
  60 import io.github.hapjava.characteristics.impl.battery.StatusLowBatteryEnum;
  61 import io.github.hapjava.characteristics.impl.carbondioxidesensor.CarbonDioxideLevelCharacteristic;
  62 import io.github.hapjava.characteristics.impl.carbondioxidesensor.CarbonDioxidePeakLevelCharacteristic;
  63 import io.github.hapjava.characteristics.impl.carbonmonoxidesensor.CarbonMonoxideLevelCharacteristic;
  64 import io.github.hapjava.characteristics.impl.carbonmonoxidesensor.CarbonMonoxidePeakLevelCharacteristic;
  65 import io.github.hapjava.characteristics.impl.common.NameCharacteristic;
  66 import io.github.hapjava.characteristics.impl.common.ObstructionDetectedCharacteristic;
  67 import io.github.hapjava.characteristics.impl.common.StatusActiveCharacteristic;
  68 import io.github.hapjava.characteristics.impl.common.StatusFaultCharacteristic;
  69 import io.github.hapjava.characteristics.impl.common.StatusFaultEnum;
  70 import io.github.hapjava.characteristics.impl.common.StatusTamperedCharacteristic;
  71 import io.github.hapjava.characteristics.impl.common.StatusTamperedEnum;
  72 import io.github.hapjava.characteristics.impl.fan.*;
  73 import io.github.hapjava.characteristics.impl.lightbulb.BrightnessCharacteristic;
  74 import io.github.hapjava.characteristics.impl.lightbulb.ColorTemperatureCharacteristic;
  75 import io.github.hapjava.characteristics.impl.lightbulb.HueCharacteristic;
  76 import io.github.hapjava.characteristics.impl.lightbulb.SaturationCharacteristic;
  77 import io.github.hapjava.characteristics.impl.thermostat.CoolingThresholdTemperatureCharacteristic;
  78 import io.github.hapjava.characteristics.impl.thermostat.HeatingThresholdTemperatureCharacteristic;
  79 import io.github.hapjava.characteristics.impl.valve.RemainingDurationCharacteristic;
  80 import io.github.hapjava.characteristics.impl.valve.SetDurationCharacteristic;
  81 import io.github.hapjava.characteristics.impl.windowcovering.CurrentHorizontalTiltAngleCharacteristic;
  82 import io.github.hapjava.characteristics.impl.windowcovering.CurrentVerticalTiltAngleCharacteristic;
  83 import io.github.hapjava.characteristics.impl.windowcovering.HoldPositionCharacteristic;
  84 import io.github.hapjava.characteristics.impl.windowcovering.TargetHorizontalTiltAngleCharacteristic;
  85 import io.github.hapjava.characteristics.impl.windowcovering.TargetVerticalTiltAngleCharacteristic;
  86
  87 /**
  88  * Creates a optional characteristics .
  89  *
  90  * @author Eugen Freiter - Initial contribution
  91  */
  92 @NonNullByDefault
  93 public class HomekitCharacteristicFactory {
  94     private static final Logger logger = LoggerFactory.getLogger(HomekitCharacteristicFactory.class);
  95
  96     // List of optional characteristics and corresponding method to create them.
  97     private final static Map<HomekitCharacteristicType, BiFunction<HomekitTaggedItem, HomekitAccessoryUpdater, Characteristic>> optional = new HashMap<HomekitCharacteristicType, BiFunction<HomekitTaggedItem, HomekitAccessoryUpdater, Characteristic>>() {
  98         {
  99             put(NAME, HomekitCharacteristicFactory::createNameCharacteristic);
 100             put(BATTERY_LOW_STATUS, HomekitCharacteristicFactory::createStatusLowBatteryCharacteristic);
 101             put(FAULT_STATUS, HomekitCharacteristicFactory::createStatusFaultCharacteristic);
 102             put(TAMPERED_STATUS, HomekitCharacteristicFactory::createStatusTamperedCharacteristic);
 103             put(ACTIVE_STATUS, HomekitCharacteristicFactory::createStatusActiveCharacteristic);
 104             put(CARBON_MONOXIDE_LEVEL, HomekitCharacteristicFactory::createCarbonMonoxideLevelCharacteristic);
 105             put(CARBON_MONOXIDE_PEAK_LEVEL, HomekitCharacteristicFactory::createCarbonMonoxidePeakLevelCharacteristic);
 106             put(CARBON_DIOXIDE_LEVEL, HomekitCharacteristicFactory::createCarbonDioxideLevelCharacteristic);
 107             put(CARBON_DIOXIDE_PEAK_LEVEL, HomekitCharacteristicFactory::createCarbonDioxidePeakLevelCharacteristic);
 108             put(HOLD_POSITION, HomekitCharacteristicFactory::createHoldPositionCharacteristic);
 109             put(OBSTRUCTION_STATUS, HomekitCharacteristicFactory::createObstructionDetectedCharacteristic);
 110             put(CURRENT_HORIZONTAL_TILT_ANGLE,
 111                     HomekitCharacteristicFactory::createCurrentHorizontalTiltAngleCharacteristic);
 112             put(CURRENT_VERTICAL_TILT_ANGLE,
 113                     HomekitCharacteristicFactory::createCurrentVerticalTiltAngleCharacteristic);
 114             put(TARGET_HORIZONTAL_TILT_ANGLE,
 115                     HomekitCharacteristicFactory::createTargetHorizontalTiltAngleCharacteristic);
 116             put(TARGET_VERTICAL_TILT_ANGLE, HomekitCharacteristicFactory::createTargetVerticalTiltAngleCharacteristic);
 117             put(HUE, HomekitCharacteristicFactory::createHueCharacteristic);
 118             put(BRIGHTNESS, HomekitCharacteristicFactory::createBrightnessCharacteristic);
 119             put(SATURATION, HomekitCharacteristicFactory::createSaturationCharacteristic);
 120             put(COLOR_TEMPERATURE, HomekitCharacteristicFactory::createColorTemperatureCharacteristic);
 121             put(CURRENT_FAN_STATE, HomekitCharacteristicFactory::createCurrentFanStateCharacteristic);
 122             put(TARGET_FAN_STATE, HomekitCharacteristicFactory::createTargetFanStateCharacteristic);
 123             put(ROTATION_DIRECTION, HomekitCharacteristicFactory::createRotationDirectionCharacteristic);
 124             put(ROTATION_SPEED, HomekitCharacteristicFactory::createRotationSpeedCharacteristic);
 125             put(SWING_MODE, HomekitCharacteristicFactory::createSwingModeCharacteristic);
 126             put(LOCK_CONTROL, HomekitCharacteristicFactory::createLockPhysicalControlsCharacteristic);
 127             put(DURATION, HomekitCharacteristicFactory::createDurationCharacteristic);
 128             put(VOLUME, HomekitCharacteristicFactory::createVolumeCharacteristic);
 129             put(COOLING_THRESHOLD_TEMPERATURE, HomekitCharacteristicFactory::createCoolingThresholdCharacteristic);
 130             put(HEATING_THRESHOLD_TEMPERATURE, HomekitCharacteristicFactory::createHeatingThresholdCharacteristic);
 131             put(REMAINING_DURATION, HomekitCharacteristicFactory::createRemainingDurationCharacteristic);
 132             put(OZONE_DENSITY, HomekitCharacteristicFactory::createOzoneDensityCharacteristic);
 133             put(NITROGEN_DIOXIDE_DENSITY, HomekitCharacteristicFactory::createNitrogenDioxideDensityCharacteristic);
 134             put(SULPHUR_DIOXIDE_DENSITY, HomekitCharacteristicFactory::createSulphurDioxideDensityCharacteristic);
 135             put(PM25_DENSITY, HomekitCharacteristicFactory::createPM25DensityCharacteristic);
 136             put(PM10_DENSITY, HomekitCharacteristicFactory::createPM10DensityCharacteristic);
 137             put(VOC_DENSITY, HomekitCharacteristicFactory::createVOCDensityCharacteristic);
 138         }
 139     };
 140
 141     /**
 142      * create optional HomeKit characteristic
 143      *
 144      * @param item corresponding OH item
 145      * @param updater update to keep OH item and HomeKit characteristic in sync
 146      * @return HomeKit characteristic
 147      */
 148     public static Characteristic createCharacteristic(HomekitTaggedItem item, HomekitAccessoryUpdater updater)
 149             throws HomekitException {
 150         final @Nullable HomekitCharacteristicType type = item.getCharacteristicType();
 151         logger.trace("CreateCharacteristic, type {} item {}", type, item);
 152         if (optional.containsKey(type)) {
 153             return optional.get(type).apply(item, updater);
 154         }
 155         logger.warn("Unsupported optional characteristic. Accessory type {}, characteristic type {}",
 156                 item.getAccessoryType(), type);
 157         throw new HomekitException("Unsupported optional characteristic. Characteristic type \"" + type + "\"");
 158     }
 159
 160     // METHODS TO CREATE SINGLE CHARACTERISTIC FROM OH ITEM
 161
 162     // supporting methods
 163     private static <T extends CharacteristicEnum> CompletableFuture<T> getEnumFromItem(HomekitTaggedItem item,
 164             T offEnum, T onEnum, T defaultEnum) {
 165         final State state = item.getItem().getState();
 166         if (state instanceof OnOffType) {
 167             return CompletableFuture.completedFuture(state.equals(OnOffType.OFF) ? offEnum : onEnum);
 168         } else if (state instanceof OpenClosedType) {
 169             return CompletableFuture.completedFuture(state.equals(OpenClosedType.CLOSED) ? offEnum : onEnum);
 170         } else if (state instanceof DecimalType) {
 171             return CompletableFuture.completedFuture(((DecimalType) state).intValue() == 0 ? offEnum : onEnum);
 172         } else if (state instanceof UnDefType) {
 173             return CompletableFuture.completedFuture(defaultEnum);
 174         }
 175         logger.warn(
 176                 "Item state {} is not supported. Only OnOffType,OpenClosedType and Decimal (0/1) are supported. Ignore item {}",
 177                 state, item.getName());
 178         return CompletableFuture.completedFuture(defaultEnum);
 179     }
 180
 181     private static void setValueFromEnum(HomekitTaggedItem taggedItem, CharacteristicEnum value,
 182             CharacteristicEnum offEnum, CharacteristicEnum onEnum) {
 183         if (taggedItem.getItem() instanceof SwitchItem) {
 184             if (value.equals(offEnum)) {
 185                 ((SwitchItem) taggedItem.getItem()).send(OnOffType.OFF);
 186             } else if (value.equals(onEnum)) {
 187                 ((SwitchItem) taggedItem.getItem()).send(OnOffType.ON);
 188             } else {
 189                 logger.warn("Enum value {} is not supported. Only following values are supported: {},{}", value,
 190                         offEnum, onEnum);
 191             }
 192         } else if (taggedItem.getItem() instanceof NumberItem) {
 193             ((NumberItem) taggedItem.getItem()).send(new DecimalType(value.getCode()));
 194         } else {
 195             logger.warn("Item type {} is not supported. Only Switch and Number item types are supported.",
 196                     taggedItem.getItem().getType());
 197         }
 198     }
 199
 200     private static int getIntFromItem(HomekitTaggedItem taggedItem) {
 201         int value = 0;
 202         final State state = taggedItem.getItem().getState();
 203         if (state instanceof PercentType) {
 204             value = ((PercentType) state).intValue();
 205         } else if (state instanceof DecimalType) {
 206             value = ((DecimalType) state).intValue();
 207         } else if (state instanceof UnDefType) {
 208             logger.debug("Item state {} is UNDEF {}.", state, taggedItem.getName());
 209         } else {
 210             logger.warn(
 211                     "Item state {} is not supported for {}. Only PercentType and DecimalType (0/100) are supported.",
 212                     state, taggedItem.getName());
 213         }
 214         return value;
 215     }
 216
 217     private static Supplier<CompletableFuture<Integer>> getIntSupplier(HomekitTaggedItem taggedItem) {
 218         return () -> CompletableFuture.completedFuture(getIntFromItem(taggedItem));
 219     }
 220
 221     private static ExceptionalConsumer<Integer> setIntConsumer(HomekitTaggedItem taggedItem) {
 222         return (value) -> {
 223             if (taggedItem.getItem() instanceof NumberItem) {
 224                 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
 225             } else {
 226                 logger.warn("Item type {} is not supported for {}. Only NumberItem is supported.",
 227                         taggedItem.getItem().getType(), taggedItem.getName());
 228             }
 229         };
 230     }
 231
 232     private static ExceptionalConsumer<Integer> setPercentConsumer(HomekitTaggedItem taggedItem) {
 233         return (value) -> {
 234             if (taggedItem.getItem() instanceof NumberItem) {
 235                 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
 236             } else if (taggedItem.getItem() instanceof DimmerItem) {
 237                 ((DimmerItem) taggedItem.getItem()).send(new PercentType(value));
 238             } else {
 239                 logger.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
 240                         taggedItem.getItem().getType(), taggedItem.getName());
 241             }
 242         };
 243     }
 244
 245     private static Supplier<CompletableFuture<Double>> getDoubleSupplier(HomekitTaggedItem taggedItem) {
 246         return () -> {
 247             final @Nullable DecimalType value = taggedItem.getItem().getStateAs(DecimalType.class);
 248             return CompletableFuture.completedFuture(value != null ? value.doubleValue() : 0.0);
 249         };
 250     }
 251
 252     private static ExceptionalConsumer<Double> setDoubleConsumer(HomekitTaggedItem taggedItem) {
 253         return (value) -> {
 254             if (taggedItem.getItem() instanceof NumberItem) {
 255                 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
 256             } else {
 257                 logger.warn("Item type {} is not supported for {}. Only Number type is supported.",
 258                         taggedItem.getItem().getType(), taggedItem.getName());
 259             }
 260         };
 261     }
 262
 263     protected static Consumer<HomekitCharacteristicChangeCallback> getSubscriber(HomekitTaggedItem taggedItem,
 264             HomekitCharacteristicType key, HomekitAccessoryUpdater updater) {
 265         return (callback) -> updater.subscribe((GenericItem) taggedItem.getItem(), key.getTag(), callback);
 266     }
 267
 268     protected static Runnable getUnsubscriber(HomekitTaggedItem taggedItem, HomekitCharacteristicType key,
 269             HomekitAccessoryUpdater updater) {
 270         return () -> updater.unsubscribe((GenericItem) taggedItem.getItem(), key.getTag());
 271     }
 272
 273     // create method for characteristic
 274     private static StatusLowBatteryCharacteristic createStatusLowBatteryCharacteristic(HomekitTaggedItem taggedItem,
 275             HomekitAccessoryUpdater updater) {
 276         return new StatusLowBatteryCharacteristic(
 277                 () -> getEnumFromItem(taggedItem, StatusLowBatteryEnum.NORMAL, StatusLowBatteryEnum.LOW,
 278                         StatusLowBatteryEnum.NORMAL),
 279                 getSubscriber(taggedItem, BATTERY_LOW_STATUS, updater),
 280                 getUnsubscriber(taggedItem, BATTERY_LOW_STATUS, updater));
 281     }
 282
 283     private static StatusFaultCharacteristic createStatusFaultCharacteristic(HomekitTaggedItem taggedItem,
 284             HomekitAccessoryUpdater updater) {
 285         return new StatusFaultCharacteristic(
 286                 () -> getEnumFromItem(taggedItem, StatusFaultEnum.NO_FAULT, StatusFaultEnum.GENERAL_FAULT,
 287                         StatusFaultEnum.NO_FAULT),
 288                 getSubscriber(taggedItem, FAULT_STATUS, updater), getUnsubscriber(taggedItem, FAULT_STATUS, updater));
 289     }
 290
 291     private static StatusTamperedCharacteristic createStatusTamperedCharacteristic(HomekitTaggedItem taggedItem,
 292             HomekitAccessoryUpdater updater) {
 293         return new StatusTamperedCharacteristic(
 294                 () -> getEnumFromItem(taggedItem, StatusTamperedEnum.NOT_TAMPERED, StatusTamperedEnum.TAMPERED,
 295                         StatusTamperedEnum.NOT_TAMPERED),
 296                 getSubscriber(taggedItem, TAMPERED_STATUS, updater),
 297                 getUnsubscriber(taggedItem, TAMPERED_STATUS, updater));
 298     }
 299
 300     private static ObstructionDetectedCharacteristic createObstructionDetectedCharacteristic(
 301             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 302         return new ObstructionDetectedCharacteristic(
 303                 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
 304                         || taggedItem.getItem().getState() == OpenClosedType.OPEN),
 305                 getSubscriber(taggedItem, OBSTRUCTION_STATUS, updater),
 306                 getUnsubscriber(taggedItem, OBSTRUCTION_STATUS, updater));
 307     }
 308
 309     private static StatusActiveCharacteristic createStatusActiveCharacteristic(HomekitTaggedItem taggedItem,
 310             HomekitAccessoryUpdater updater) {
 311         return new StatusActiveCharacteristic(
 312                 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
 313                         || taggedItem.getItem().getState() == OpenClosedType.OPEN),
 314                 getSubscriber(taggedItem, ACTIVE_STATUS, updater), getUnsubscriber(taggedItem, ACTIVE_STATUS, updater));
 315     }
 316
 317     private static NameCharacteristic createNameCharacteristic(HomekitTaggedItem taggedItem,
 318             HomekitAccessoryUpdater updater) {
 319         return new NameCharacteristic(() -> {
 320             final State state = taggedItem.getItem().getState();
 321             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
 322         });
 323     }
 324
 325     private static HoldPositionCharacteristic createHoldPositionCharacteristic(HomekitTaggedItem taggedItem,
 326             HomekitAccessoryUpdater updater) {
 327         return new HoldPositionCharacteristic(value -> ((SwitchItem) taggedItem.getItem()).send(OnOffType.from(value)));
 328     }
 329
 330     private static CarbonMonoxideLevelCharacteristic createCarbonMonoxideLevelCharacteristic(
 331             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 332         return new CarbonMonoxideLevelCharacteristic(getDoubleSupplier(taggedItem),
 333                 getSubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater),
 334                 getUnsubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater));
 335     }
 336
 337     private static CarbonMonoxidePeakLevelCharacteristic createCarbonMonoxidePeakLevelCharacteristic(
 338             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 339         return new CarbonMonoxidePeakLevelCharacteristic(getDoubleSupplier(taggedItem),
 340                 getSubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater),
 341                 getUnsubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater));
 342     }
 343
 344     private static CarbonDioxideLevelCharacteristic createCarbonDioxideLevelCharacteristic(HomekitTaggedItem taggedItem,
 345             HomekitAccessoryUpdater updater) {
 346         return new CarbonDioxideLevelCharacteristic(getDoubleSupplier(taggedItem),
 347                 getSubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater),
 348                 getUnsubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater));
 349     }
 350
 351     private static CarbonDioxidePeakLevelCharacteristic createCarbonDioxidePeakLevelCharacteristic(
 352             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 353         return new CarbonDioxidePeakLevelCharacteristic(getDoubleSupplier(taggedItem),
 354                 getSubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater),
 355                 getUnsubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater));
 356     }
 357
 358     private static CurrentHorizontalTiltAngleCharacteristic createCurrentHorizontalTiltAngleCharacteristic(
 359             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 360         return new CurrentHorizontalTiltAngleCharacteristic(getIntSupplier(taggedItem),
 361                 getSubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater),
 362                 getUnsubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater));
 363     }
 364
 365     private static CurrentVerticalTiltAngleCharacteristic createCurrentVerticalTiltAngleCharacteristic(
 366             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 367         return new CurrentVerticalTiltAngleCharacteristic(getIntSupplier(taggedItem),
 368                 getSubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater),
 369                 getUnsubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater));
 370     }
 371
 372     private static TargetHorizontalTiltAngleCharacteristic createTargetHorizontalTiltAngleCharacteristic(
 373             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 374         return new TargetHorizontalTiltAngleCharacteristic(getIntSupplier(taggedItem), setIntConsumer(taggedItem),
 375                 getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
 376                 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
 377     }
 378
 379     private static TargetVerticalTiltAngleCharacteristic createTargetVerticalTiltAngleCharacteristic(
 380             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 381         return new TargetVerticalTiltAngleCharacteristic(getIntSupplier(taggedItem), setIntConsumer(taggedItem),
 382                 getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
 383                 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
 384     }
 385
 386     private static HueCharacteristic createHueCharacteristic(HomekitTaggedItem taggedItem,
 387             HomekitAccessoryUpdater updater) {
 388         return new HueCharacteristic(() -> {
 389             double value = 0.0;
 390             State state = taggedItem.getItem().getState();
 391             if (state instanceof HSBType) {
 392                 value = ((HSBType) state).getHue().doubleValue();
 393             }
 394             return CompletableFuture.completedFuture(value);
 395         }, (hue) -> {
 396             if (taggedItem.getItem() instanceof ColorItem) {
 397                 taggedItem.sendCommandProxy(HomekitCommandType.HUE_COMMAND, new DecimalType(hue));
 398             } else {
 399                 logger.warn("Item type {} is not supported for {}. Only Color type is supported.",
 400                         taggedItem.getItem().getType(), taggedItem.getName());
 401             }
 402         }, getSubscriber(taggedItem, HUE, updater), getUnsubscriber(taggedItem, HUE, updater));
 403     }
 404
 405     private static BrightnessCharacteristic createBrightnessCharacteristic(HomekitTaggedItem taggedItem,
 406             HomekitAccessoryUpdater updater) {
 407         return new BrightnessCharacteristic(() -> {
 408             int value = 0;
 409             final State state = taggedItem.getItem().getState();
 410             if (state instanceof HSBType) {
 411                 value = ((HSBType) state).getBrightness().intValue();
 412             } else if (state instanceof PercentType) {
 413                 value = ((PercentType) state).intValue();
 414             }
 415             return CompletableFuture.completedFuture(value);
 416         }, (brightness) -> {
 417             final Item item = taggedItem.getItem();
 418             if (item instanceof DimmerItem) {
 419                 taggedItem.sendCommandProxy(HomekitCommandType.BRIGHTNESS_COMMAND, new PercentType(brightness));
 420             } else {
 421                 logger.warn("Item type {} is not supported for {}. Only ColorItem and DimmerItem are supported.",
 422                         item.getType(), taggedItem.getName());
 423             }
 424         }, getSubscriber(taggedItem, BRIGHTNESS, updater), getUnsubscriber(taggedItem, BRIGHTNESS, updater));
 425     }
 426
 427     private static SaturationCharacteristic createSaturationCharacteristic(HomekitTaggedItem taggedItem,
 428             HomekitAccessoryUpdater updater) {
 429         return new SaturationCharacteristic(() -> {
 430             double value = 0.0;
 431             State state = taggedItem.getItem().getState();
 432             if (state instanceof HSBType) {
 433                 value = ((HSBType) state).getSaturation().doubleValue();
 434             } else if (state instanceof PercentType) {
 435                 value = ((PercentType) state).doubleValue();
 436             }
 437             return CompletableFuture.completedFuture(value);
 438         }, (saturation) -> {
 439             if (taggedItem.getItem() instanceof ColorItem) {
 440                 taggedItem.sendCommandProxy(HomekitCommandType.SATURATION_COMMAND,
 441                         new PercentType(saturation.intValue()));
 442             } else {
 443                 logger.warn("Item type {} is not supported for {}. Only Color type is supported.",
 444                         taggedItem.getItem().getType(), taggedItem.getName());
 445             }
 446         }, getSubscriber(taggedItem, SATURATION, updater), getUnsubscriber(taggedItem, SATURATION, updater));
 447     }
 448
 449     private static ColorTemperatureCharacteristic createColorTemperatureCharacteristic(HomekitTaggedItem taggedItem,
 450             HomekitAccessoryUpdater updater) {
 451         return new ColorTemperatureCharacteristic(getIntSupplier(taggedItem), setIntConsumer(taggedItem),
 452                 getSubscriber(taggedItem, COLOR_TEMPERATURE, updater),
 453                 getUnsubscriber(taggedItem, COLOR_TEMPERATURE, updater));
 454     }
 455
 456     private static CurrentFanStateCharacteristic createCurrentFanStateCharacteristic(HomekitTaggedItem taggedItem,
 457             HomekitAccessoryUpdater updater) {
 458         return new CurrentFanStateCharacteristic(() -> {
 459             final @Nullable DecimalType value = taggedItem.getItem().getStateAs(DecimalType.class);
 460             @Nullable
 461             CurrentFanStateEnum currentFanStateEnum = value != null ? CurrentFanStateEnum.fromCode(value.intValue())
 462                     : null;
 463             if (currentFanStateEnum == null) {
 464                 currentFanStateEnum = CurrentFanStateEnum.INACTIVE;
 465             }
 466             return CompletableFuture.completedFuture(currentFanStateEnum);
 467         }, getSubscriber(taggedItem, CURRENT_FAN_STATE, updater),
 468                 getUnsubscriber(taggedItem, CURRENT_FAN_STATE, updater));
 469     }
 470
 471     private static TargetFanStateCharacteristic createTargetFanStateCharacteristic(HomekitTaggedItem taggedItem,
 472             HomekitAccessoryUpdater updater) {
 473         return new TargetFanStateCharacteristic(() -> {
 474             final @Nullable DecimalType value = taggedItem.getItem().getStateAs(DecimalType.class);
 475             @Nullable
 476             TargetFanStateEnum targetFanStateEnum = value != null ? TargetFanStateEnum.fromCode(value.intValue())
 477                     : null;
 478             if (targetFanStateEnum == null) {
 479                 targetFanStateEnum = TargetFanStateEnum.AUTO;
 480             }
 481             return CompletableFuture.completedFuture(targetFanStateEnum);
 482         }, (targetState) -> {
 483             if (taggedItem.getItem() instanceof NumberItem) {
 484                 ((NumberItem) taggedItem.getItem()).send(new DecimalType(targetState.getCode()));
 485             } else {
 486                 logger.warn("Item type {} is not supported for {}. Only Number type is supported.",
 487                         taggedItem.getItem().getType(), taggedItem.getName());
 488             }
 489         }, getSubscriber(taggedItem, TARGET_FAN_STATE, updater),
 490                 getUnsubscriber(taggedItem, TARGET_FAN_STATE, updater));
 491     }
 492
 493     private static RotationDirectionCharacteristic createRotationDirectionCharacteristic(HomekitTaggedItem taggedItem,
 494             HomekitAccessoryUpdater updater) {
 495         return new RotationDirectionCharacteristic(
 496                 () -> getEnumFromItem(taggedItem, RotationDirectionEnum.CLOCKWISE,
 497                         RotationDirectionEnum.COUNTER_CLOCKWISE, RotationDirectionEnum.CLOCKWISE),
 498                 (value) -> setValueFromEnum(taggedItem, value, RotationDirectionEnum.CLOCKWISE,
 499                         RotationDirectionEnum.COUNTER_CLOCKWISE),
 500                 getSubscriber(taggedItem, ROTATION_DIRECTION, updater),
 501                 getUnsubscriber(taggedItem, ROTATION_DIRECTION, updater));
 502     }
 503
 504     private static SwingModeCharacteristic createSwingModeCharacteristic(HomekitTaggedItem taggedItem,
 505             HomekitAccessoryUpdater updater) {
 506         return new SwingModeCharacteristic(
 507                 () -> getEnumFromItem(taggedItem, SwingModeEnum.SWING_DISABLED, SwingModeEnum.SWING_ENABLED,
 508                         SwingModeEnum.SWING_DISABLED),
 509                 (value) -> setValueFromEnum(taggedItem, value, SwingModeEnum.SWING_DISABLED,
 510                         SwingModeEnum.SWING_ENABLED),
 511                 getSubscriber(taggedItem, SWING_MODE, updater), getUnsubscriber(taggedItem, SWING_MODE, updater));
 512     }
 513
 514     private static LockPhysicalControlsCharacteristic createLockPhysicalControlsCharacteristic(
 515             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 516         return new LockPhysicalControlsCharacteristic(
 517                 () -> getEnumFromItem(taggedItem, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED,
 518                         LockPhysicalControlsEnum.CONTROL_LOCK_ENABLED, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED),
 519                 (value) -> setValueFromEnum(taggedItem, value, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED,
 520                         LockPhysicalControlsEnum.CONTROL_LOCK_ENABLED),
 521                 getSubscriber(taggedItem, LOCK_CONTROL, updater), getUnsubscriber(taggedItem, LOCK_CONTROL, updater));
 522     }
 523
 524     private static RotationSpeedCharacteristic createRotationSpeedCharacteristic(HomekitTaggedItem item,
 525             HomekitAccessoryUpdater updater) {
 526         return new RotationSpeedCharacteristic(getIntSupplier(item), setPercentConsumer(item),
 527                 getSubscriber(item, ROTATION_SPEED, updater), getUnsubscriber(item, ROTATION_SPEED, updater));
 528     }
 529
 530     private static SetDurationCharacteristic createDurationCharacteristic(HomekitTaggedItem taggedItem,
 531             HomekitAccessoryUpdater updater) {
 532         return new SetDurationCharacteristic(() -> {
 533             int value = getIntFromItem(taggedItem);
 534             final @Nullable Map<String, Object> itemConfiguration = taggedItem.getConfiguration();
 535             if ((value == 0) && (itemConfiguration != null)) { // check for default duration
 536                 final Object duration = itemConfiguration.get(HomekitValveImpl.CONFIG_DEFAULT_DURATION);
 537                 if (duration instanceof BigDecimal) {
 538                     value = ((BigDecimal) duration).intValue();
 539                     if (taggedItem.getItem() instanceof NumberItem) {
 540                         ((NumberItem) taggedItem.getItem()).setState(new DecimalType(value));
 541                     }
 542                 }
 543             }
 544             return CompletableFuture.completedFuture(value);
 545         }, setIntConsumer(taggedItem), getSubscriber(taggedItem, DURATION, updater),
 546                 getUnsubscriber(taggedItem, DURATION, updater));
 547     }
 548
 549     private static RemainingDurationCharacteristic createRemainingDurationCharacteristic(HomekitTaggedItem taggedItem,
 550             HomekitAccessoryUpdater updater) {
 551         return new RemainingDurationCharacteristic(getIntSupplier(taggedItem),
 552                 getSubscriber(taggedItem, REMAINING_DURATION, updater),
 553                 getUnsubscriber(taggedItem, REMAINING_DURATION, updater));
 554     }
 555
 556     private static VolumeCharacteristic createVolumeCharacteristic(HomekitTaggedItem taggedItem,
 557             HomekitAccessoryUpdater updater) {
 558         return new VolumeCharacteristic(getIntSupplier(taggedItem),
 559                 (volume) -> ((NumberItem) taggedItem.getItem()).send(new DecimalType(volume)),
 560                 getSubscriber(taggedItem, DURATION, updater), getUnsubscriber(taggedItem, DURATION, updater));
 561     }
 562
 563     private static CoolingThresholdTemperatureCharacteristic createCoolingThresholdCharacteristic(
 564             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 565         return new CoolingThresholdTemperatureCharacteristic(
 566                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
 567                         CoolingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE),
 568                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
 569                         CoolingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE),
 570                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.STEP,
 571                         CoolingThresholdTemperatureCharacteristic.DEFAULT_STEP),
 572                 getDoubleSupplier(taggedItem), setDoubleConsumer(taggedItem),
 573                 getSubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater),
 574                 getUnsubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater));
 575     }
 576
 577     private static HeatingThresholdTemperatureCharacteristic createHeatingThresholdCharacteristic(
 578             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 579         return new HeatingThresholdTemperatureCharacteristic(
 580                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
 581                         HeatingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE),
 582                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
 583                         HeatingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE),
 584                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.STEP,
 585                         HeatingThresholdTemperatureCharacteristic.DEFAULT_STEP),
 586                 getDoubleSupplier(taggedItem), setDoubleConsumer(taggedItem),
 587                 getSubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater),
 588                 getUnsubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater));
 589     }
 590
 591     private static OzoneDensityCharacteristic createOzoneDensityCharacteristic(final HomekitTaggedItem taggedItem,
 592             HomekitAccessoryUpdater updater) {
 593         return new OzoneDensityCharacteristic(getDoubleSupplier(taggedItem),
 594                 getSubscriber(taggedItem, OZONE_DENSITY, updater), getUnsubscriber(taggedItem, OZONE_DENSITY, updater));
 595     }
 596
 597     private static NitrogenDioxideDensityCharacteristic createNitrogenDioxideDensityCharacteristic(
 598             final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 599         return new NitrogenDioxideDensityCharacteristic(getDoubleSupplier(taggedItem),
 600                 getSubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater),
 601                 getUnsubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater));
 602     }
 603
 604     private static SulphurDioxideDensityCharacteristic createSulphurDioxideDensityCharacteristic(
 605             final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
 606         return new SulphurDioxideDensityCharacteristic(getDoubleSupplier(taggedItem),
 607                 getSubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater),
 608                 getUnsubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater));
 609     }
 610
 611     private static PM25DensityCharacteristic createPM25DensityCharacteristic(final HomekitTaggedItem taggedItem,
 612             HomekitAccessoryUpdater updater) {
 613         return new PM25DensityCharacteristic(getDoubleSupplier(taggedItem),
 614                 getSubscriber(taggedItem, PM25_DENSITY, updater), getUnsubscriber(taggedItem, PM25_DENSITY, updater));
 615     }
 616
 617     private static PM10DensityCharacteristic createPM10DensityCharacteristic(final HomekitTaggedItem taggedItem,
 618             HomekitAccessoryUpdater updater) {
 619         return new PM10DensityCharacteristic(getDoubleSupplier(taggedItem),
 620                 getSubscriber(taggedItem, PM10_DENSITY, updater), getUnsubscriber(taggedItem, PM10_DENSITY, updater));
 621     }
 622
 623     private static VOCDensityCharacteristic createVOCDensityCharacteristic(final HomekitTaggedItem taggedItem,
 624             HomekitAccessoryUpdater updater) {
 625         return new VOCDensityCharacteristic(getDoubleSupplier(taggedItem),
 626                 getSubscriber(taggedItem, VOC_DENSITY, updater), getUnsubscriber(taggedItem, VOC_DENSITY, updater));
 627     }
 628 }