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

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