2 * Copyright (c) 2010-2022 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.io.homekit.internal.accessories;
15 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.*;
17 import java.math.BigDecimal;
18 import java.math.RoundingMode;
19 import java.util.HashMap;
21 import java.util.concurrent.CompletableFuture;
22 import java.util.function.BiFunction;
23 import java.util.function.Consumer;
24 import java.util.function.Supplier;
26 import javax.measure.Quantity;
27 import javax.measure.Unit;
29 import org.eclipse.jdt.annotation.NonNullByDefault;
30 import org.eclipse.jdt.annotation.Nullable;
31 import org.openhab.core.items.GenericItem;
32 import org.openhab.core.items.Item;
33 import org.openhab.core.library.items.ColorItem;
34 import org.openhab.core.library.items.DimmerItem;
35 import org.openhab.core.library.items.NumberItem;
36 import org.openhab.core.library.items.SwitchItem;
37 import org.openhab.core.library.types.DecimalType;
38 import org.openhab.core.library.types.HSBType;
39 import org.openhab.core.library.types.OnOffType;
40 import org.openhab.core.library.types.OpenClosedType;
41 import org.openhab.core.library.types.PercentType;
42 import org.openhab.core.library.types.QuantityType;
43 import org.openhab.core.library.unit.ImperialUnits;
44 import org.openhab.core.library.unit.SIUnits;
45 import org.openhab.core.types.State;
46 import org.openhab.core.types.UnDefType;
47 import org.openhab.io.homekit.Homekit;
48 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
49 import org.openhab.io.homekit.internal.HomekitCharacteristicType;
50 import org.openhab.io.homekit.internal.HomekitCommandType;
51 import org.openhab.io.homekit.internal.HomekitException;
52 import org.openhab.io.homekit.internal.HomekitImpl;
53 import org.openhab.io.homekit.internal.HomekitTaggedItem;
54 import org.osgi.framework.FrameworkUtil;
55 import org.slf4j.Logger;
56 import org.slf4j.LoggerFactory;
58 import io.github.hapjava.characteristics.Characteristic;
59 import io.github.hapjava.characteristics.CharacteristicEnum;
60 import io.github.hapjava.characteristics.ExceptionalConsumer;
61 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
62 import io.github.hapjava.characteristics.impl.airquality.NitrogenDioxideDensityCharacteristic;
63 import io.github.hapjava.characteristics.impl.airquality.OzoneDensityCharacteristic;
64 import io.github.hapjava.characteristics.impl.airquality.PM10DensityCharacteristic;
65 import io.github.hapjava.characteristics.impl.airquality.PM25DensityCharacteristic;
66 import io.github.hapjava.characteristics.impl.airquality.SulphurDioxideDensityCharacteristic;
67 import io.github.hapjava.characteristics.impl.airquality.VOCDensityCharacteristic;
68 import io.github.hapjava.characteristics.impl.audio.VolumeCharacteristic;
69 import io.github.hapjava.characteristics.impl.battery.StatusLowBatteryCharacteristic;
70 import io.github.hapjava.characteristics.impl.battery.StatusLowBatteryEnum;
71 import io.github.hapjava.characteristics.impl.carbondioxidesensor.CarbonDioxideLevelCharacteristic;
72 import io.github.hapjava.characteristics.impl.carbondioxidesensor.CarbonDioxidePeakLevelCharacteristic;
73 import io.github.hapjava.characteristics.impl.carbonmonoxidesensor.CarbonMonoxideLevelCharacteristic;
74 import io.github.hapjava.characteristics.impl.carbonmonoxidesensor.CarbonMonoxidePeakLevelCharacteristic;
75 import io.github.hapjava.characteristics.impl.common.NameCharacteristic;
76 import io.github.hapjava.characteristics.impl.common.ObstructionDetectedCharacteristic;
77 import io.github.hapjava.characteristics.impl.common.StatusActiveCharacteristic;
78 import io.github.hapjava.characteristics.impl.common.StatusFaultCharacteristic;
79 import io.github.hapjava.characteristics.impl.common.StatusFaultEnum;
80 import io.github.hapjava.characteristics.impl.common.StatusTamperedCharacteristic;
81 import io.github.hapjava.characteristics.impl.common.StatusTamperedEnum;
82 import io.github.hapjava.characteristics.impl.fan.CurrentFanStateCharacteristic;
83 import io.github.hapjava.characteristics.impl.fan.CurrentFanStateEnum;
84 import io.github.hapjava.characteristics.impl.fan.LockPhysicalControlsCharacteristic;
85 import io.github.hapjava.characteristics.impl.fan.LockPhysicalControlsEnum;
86 import io.github.hapjava.characteristics.impl.fan.RotationDirectionCharacteristic;
87 import io.github.hapjava.characteristics.impl.fan.RotationDirectionEnum;
88 import io.github.hapjava.characteristics.impl.fan.RotationSpeedCharacteristic;
89 import io.github.hapjava.characteristics.impl.fan.SwingModeCharacteristic;
90 import io.github.hapjava.characteristics.impl.fan.SwingModeEnum;
91 import io.github.hapjava.characteristics.impl.fan.TargetFanStateCharacteristic;
92 import io.github.hapjava.characteristics.impl.fan.TargetFanStateEnum;
93 import io.github.hapjava.characteristics.impl.lightbulb.BrightnessCharacteristic;
94 import io.github.hapjava.characteristics.impl.lightbulb.ColorTemperatureCharacteristic;
95 import io.github.hapjava.characteristics.impl.lightbulb.HueCharacteristic;
96 import io.github.hapjava.characteristics.impl.lightbulb.SaturationCharacteristic;
97 import io.github.hapjava.characteristics.impl.thermostat.CoolingThresholdTemperatureCharacteristic;
98 import io.github.hapjava.characteristics.impl.thermostat.HeatingThresholdTemperatureCharacteristic;
99 import io.github.hapjava.characteristics.impl.valve.RemainingDurationCharacteristic;
100 import io.github.hapjava.characteristics.impl.valve.SetDurationCharacteristic;
101 import io.github.hapjava.characteristics.impl.windowcovering.CurrentHorizontalTiltAngleCharacteristic;
102 import io.github.hapjava.characteristics.impl.windowcovering.CurrentVerticalTiltAngleCharacteristic;
103 import io.github.hapjava.characteristics.impl.windowcovering.HoldPositionCharacteristic;
104 import io.github.hapjava.characteristics.impl.windowcovering.TargetHorizontalTiltAngleCharacteristic;
105 import io.github.hapjava.characteristics.impl.windowcovering.TargetVerticalTiltAngleCharacteristic;
106 import tech.units.indriya.unit.UnitDimension;
109 * Creates a optional characteristics .
111 * @author Eugen Freiter - Initial contribution
114 public class HomekitCharacteristicFactory {
115 private static final Logger logger = LoggerFactory.getLogger(HomekitCharacteristicFactory.class);
117 // List of optional characteristics and corresponding method to create them.
118 private final static Map<HomekitCharacteristicType, BiFunction<HomekitTaggedItem, HomekitAccessoryUpdater, Characteristic>> optional = new HashMap<HomekitCharacteristicType, BiFunction<HomekitTaggedItem, HomekitAccessoryUpdater, Characteristic>>() {
120 put(NAME, HomekitCharacteristicFactory::createNameCharacteristic);
121 put(BATTERY_LOW_STATUS, HomekitCharacteristicFactory::createStatusLowBatteryCharacteristic);
122 put(FAULT_STATUS, HomekitCharacteristicFactory::createStatusFaultCharacteristic);
123 put(TAMPERED_STATUS, HomekitCharacteristicFactory::createStatusTamperedCharacteristic);
124 put(ACTIVE_STATUS, HomekitCharacteristicFactory::createStatusActiveCharacteristic);
125 put(CARBON_MONOXIDE_LEVEL, HomekitCharacteristicFactory::createCarbonMonoxideLevelCharacteristic);
126 put(CARBON_MONOXIDE_PEAK_LEVEL, HomekitCharacteristicFactory::createCarbonMonoxidePeakLevelCharacteristic);
127 put(CARBON_DIOXIDE_LEVEL, HomekitCharacteristicFactory::createCarbonDioxideLevelCharacteristic);
128 put(CARBON_DIOXIDE_PEAK_LEVEL, HomekitCharacteristicFactory::createCarbonDioxidePeakLevelCharacteristic);
129 put(HOLD_POSITION, HomekitCharacteristicFactory::createHoldPositionCharacteristic);
130 put(OBSTRUCTION_STATUS, HomekitCharacteristicFactory::createObstructionDetectedCharacteristic);
131 put(CURRENT_HORIZONTAL_TILT_ANGLE,
132 HomekitCharacteristicFactory::createCurrentHorizontalTiltAngleCharacteristic);
133 put(CURRENT_VERTICAL_TILT_ANGLE,
134 HomekitCharacteristicFactory::createCurrentVerticalTiltAngleCharacteristic);
135 put(TARGET_HORIZONTAL_TILT_ANGLE,
136 HomekitCharacteristicFactory::createTargetHorizontalTiltAngleCharacteristic);
137 put(TARGET_VERTICAL_TILT_ANGLE, HomekitCharacteristicFactory::createTargetVerticalTiltAngleCharacteristic);
138 put(HUE, HomekitCharacteristicFactory::createHueCharacteristic);
139 put(BRIGHTNESS, HomekitCharacteristicFactory::createBrightnessCharacteristic);
140 put(SATURATION, HomekitCharacteristicFactory::createSaturationCharacteristic);
141 put(COLOR_TEMPERATURE, HomekitCharacteristicFactory::createColorTemperatureCharacteristic);
142 put(CURRENT_FAN_STATE, HomekitCharacteristicFactory::createCurrentFanStateCharacteristic);
143 put(TARGET_FAN_STATE, HomekitCharacteristicFactory::createTargetFanStateCharacteristic);
144 put(ROTATION_DIRECTION, HomekitCharacteristicFactory::createRotationDirectionCharacteristic);
145 put(ROTATION_SPEED, HomekitCharacteristicFactory::createRotationSpeedCharacteristic);
146 put(SWING_MODE, HomekitCharacteristicFactory::createSwingModeCharacteristic);
147 put(LOCK_CONTROL, HomekitCharacteristicFactory::createLockPhysicalControlsCharacteristic);
148 put(DURATION, HomekitCharacteristicFactory::createDurationCharacteristic);
149 put(VOLUME, HomekitCharacteristicFactory::createVolumeCharacteristic);
150 put(COOLING_THRESHOLD_TEMPERATURE, HomekitCharacteristicFactory::createCoolingThresholdCharacteristic);
151 put(HEATING_THRESHOLD_TEMPERATURE, HomekitCharacteristicFactory::createHeatingThresholdCharacteristic);
152 put(REMAINING_DURATION, HomekitCharacteristicFactory::createRemainingDurationCharacteristic);
153 put(OZONE_DENSITY, HomekitCharacteristicFactory::createOzoneDensityCharacteristic);
154 put(NITROGEN_DIOXIDE_DENSITY, HomekitCharacteristicFactory::createNitrogenDioxideDensityCharacteristic);
155 put(SULPHUR_DIOXIDE_DENSITY, HomekitCharacteristicFactory::createSulphurDioxideDensityCharacteristic);
156 put(PM25_DENSITY, HomekitCharacteristicFactory::createPM25DensityCharacteristic);
157 put(PM10_DENSITY, HomekitCharacteristicFactory::createPM10DensityCharacteristic);
158 put(VOC_DENSITY, HomekitCharacteristicFactory::createVOCDensityCharacteristic);
163 * create optional HomeKit characteristic
165 * @param item corresponding OH item
166 * @param updater update to keep OH item and HomeKit characteristic in sync
167 * @return HomeKit characteristic
169 public static Characteristic createCharacteristic(HomekitTaggedItem item, HomekitAccessoryUpdater updater)
170 throws HomekitException {
171 final @Nullable HomekitCharacteristicType type = item.getCharacteristicType();
172 logger.trace("CreateCharacteristic, type {} item {}", type, item);
173 if (optional.containsKey(type)) {
174 return optional.get(type).apply(item, updater);
176 logger.warn("Unsupported optional characteristic. Accessory type {}, characteristic type {}",
177 item.getAccessoryType(), type);
178 throw new HomekitException("Unsupported optional characteristic. Characteristic type \"" + type + "\"");
181 // METHODS TO CREATE SINGLE CHARACTERISTIC FROM OH ITEM
183 // supporting methods
185 public static boolean useFahrenheit() {
186 return FrameworkUtil.getBundle(HomekitImpl.class).getBundleContext()
187 .getServiceReference(Homekit.class.getName()).getProperty("useFahrenheitTemperature") == Boolean.TRUE;
190 private static <T extends CharacteristicEnum> CompletableFuture<T> getEnumFromItem(HomekitTaggedItem item,
191 T offEnum, T onEnum, T defaultEnum) {
192 final State state = item.getItem().getState();
193 if (state instanceof OnOffType) {
194 return CompletableFuture
195 .completedFuture(state.equals(item.isInverted() ? OnOffType.ON : OnOffType.OFF) ? offEnum : onEnum);
196 } else if (state instanceof OpenClosedType) {
197 return CompletableFuture.completedFuture(
198 state.equals(item.isInverted() ? OpenClosedType.OPEN : OpenClosedType.CLOSED) ? offEnum : onEnum);
199 } else if (state instanceof DecimalType) {
200 return CompletableFuture.completedFuture(((DecimalType) state).intValue() == 0 ? offEnum : onEnum);
201 } else if (state instanceof UnDefType) {
202 return CompletableFuture.completedFuture(defaultEnum);
205 "Item state {} is not supported. Only OnOffType,OpenClosedType and Decimal (0/1) are supported. Ignore item {}",
206 state, item.getName());
207 return CompletableFuture.completedFuture(defaultEnum);
210 private static void setValueFromEnum(HomekitTaggedItem taggedItem, CharacteristicEnum value,
211 CharacteristicEnum offEnum, CharacteristicEnum onEnum) {
212 if (taggedItem.getItem() instanceof SwitchItem) {
213 if (value.equals(offEnum)) {
214 ((SwitchItem) taggedItem.getItem()).send(taggedItem.isInverted() ? OnOffType.ON : OnOffType.OFF);
215 } else if (value.equals(onEnum)) {
216 ((SwitchItem) taggedItem.getItem()).send(taggedItem.isInverted() ? OnOffType.OFF : OnOffType.ON);
218 logger.warn("Enum value {} is not supported. Only following values are supported: {},{}", value,
221 } else if (taggedItem.getItem() instanceof NumberItem) {
222 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value.getCode()));
224 logger.warn("Item type {} is not supported. Only Switch and Number item types are supported.",
225 taggedItem.getItem().getType());
229 private static int getIntFromItem(HomekitTaggedItem taggedItem, int defaultValue) {
230 int value = defaultValue;
231 final State state = taggedItem.getItem().getState();
232 if (state instanceof PercentType) {
233 value = ((PercentType) state).intValue();
234 } else if (state instanceof DecimalType) {
235 value = ((DecimalType) state).intValue();
236 } else if (state instanceof UnDefType) {
237 logger.debug("Item state {} is UNDEF {}. Returning default value {}", state, taggedItem.getName(),
241 "Item state {} is not supported for {}. Only PercentType and DecimalType (0/100) are supported.",
242 state, taggedItem.getName());
247 /** special method for tilts. it converts percentage to angle */
248 private static int getAngleFromItem(HomekitTaggedItem taggedItem, int defaultValue) {
249 int value = defaultValue;
250 final State state = taggedItem.getItem().getState();
251 if (state instanceof PercentType) {
252 value = (int) ((((PercentType) state).intValue() * 90.0) / 50.0 - 90.0);
254 value = getIntFromItem(taggedItem, defaultValue);
259 private static <T extends Quantity<T>> double convertAndRound(double value, Unit<T> from, Unit<T> to) {
260 double rawValue = from.equals(to) ? value : from.getConverterTo(to).convert(value);
261 return new BigDecimal(rawValue).setScale(1, RoundingMode.HALF_UP).doubleValue();
264 public static @Nullable Double stateAsTemperature(@Nullable State state) {
265 if (state == null || state instanceof UnDefType) {
269 if (state instanceof QuantityType<?>) {
270 final QuantityType<?> qt = (QuantityType<?>) state;
271 if (qt.getDimension().equals(UnitDimension.TEMPERATURE)) {
272 return qt.toUnit(SIUnits.CELSIUS).doubleValue();
276 return convertToCelsius(state.as(DecimalType.class).doubleValue());
279 public static double convertToCelsius(double degrees) {
280 return convertAndRound(degrees, useFahrenheit() ? ImperialUnits.FAHRENHEIT : SIUnits.CELSIUS, SIUnits.CELSIUS);
283 public static double convertFromCelsius(double degrees) {
284 return convertAndRound(degrees, SIUnits.CELSIUS, useFahrenheit() ? ImperialUnits.FAHRENHEIT : SIUnits.CELSIUS);
287 private static Supplier<CompletableFuture<Integer>> getAngleSupplier(HomekitTaggedItem taggedItem,
289 return () -> CompletableFuture.completedFuture(getAngleFromItem(taggedItem, defaultValue));
292 private static Supplier<CompletableFuture<Integer>> getIntSupplier(HomekitTaggedItem taggedItem, int defaultValue) {
293 return () -> CompletableFuture.completedFuture(getIntFromItem(taggedItem, defaultValue));
296 private static ExceptionalConsumer<Integer> setIntConsumer(HomekitTaggedItem taggedItem) {
298 if (taggedItem.getItem() instanceof NumberItem) {
299 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
301 logger.warn("Item type {} is not supported for {}. Only NumberItem is supported.",
302 taggedItem.getItem().getType(), taggedItem.getName());
307 private static ExceptionalConsumer<Integer> setPercentConsumer(HomekitTaggedItem taggedItem) {
309 if (taggedItem.getItem() instanceof NumberItem) {
310 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
311 } else if (taggedItem.getItem() instanceof DimmerItem) {
312 ((DimmerItem) taggedItem.getItem()).send(new PercentType(value));
314 logger.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
315 taggedItem.getItem().getType(), taggedItem.getName());
320 private static ExceptionalConsumer<Integer> setAngleConsumer(HomekitTaggedItem taggedItem) {
322 if (taggedItem.getItem() instanceof NumberItem) {
323 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
324 } else if (taggedItem.getItem() instanceof DimmerItem) {
325 value = (int) (value * 50.0 / 90.0 + 50.0);
326 ((DimmerItem) taggedItem.getItem()).send(new PercentType(value));
328 logger.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
329 taggedItem.getItem().getType(), taggedItem.getName());
334 private static Supplier<CompletableFuture<Double>> getDoubleSupplier(HomekitTaggedItem taggedItem,
335 double defaultValue) {
337 final @Nullable DecimalType value = taggedItem.getItem().getStateAs(DecimalType.class);
338 return CompletableFuture.completedFuture(value != null ? value.doubleValue() : defaultValue);
342 private static ExceptionalConsumer<Double> setDoubleConsumer(HomekitTaggedItem taggedItem) {
344 if (taggedItem.getItem() instanceof NumberItem) {
345 ((NumberItem) taggedItem.getItem()).send(new DecimalType(value));
347 logger.warn("Item type {} is not supported for {}. Only Number type is supported.",
348 taggedItem.getItem().getType(), taggedItem.getName());
353 private static Supplier<CompletableFuture<Double>> getTemperatureSupplier(HomekitTaggedItem taggedItem,
354 double defaultValue) {
356 final @Nullable Double value = stateAsTemperature(taggedItem.getItem().getState());
357 return CompletableFuture.completedFuture(value != null ? value : defaultValue);
361 private static ExceptionalConsumer<Double> setTemperatureConsumer(HomekitTaggedItem taggedItem) {
363 if (taggedItem.getItem() instanceof NumberItem) {
364 ((NumberItem) taggedItem.getItem()).send(new DecimalType(convertFromCelsius(value)));
366 logger.warn("Item type {} is not supported for {}. Only Number type is supported.",
367 taggedItem.getItem().getType(), taggedItem.getName());
372 protected static Consumer<HomekitCharacteristicChangeCallback> getSubscriber(HomekitTaggedItem taggedItem,
373 HomekitCharacteristicType key, HomekitAccessoryUpdater updater) {
374 return (callback) -> updater.subscribe((GenericItem) taggedItem.getItem(), key.getTag(), callback);
377 protected static Runnable getUnsubscriber(HomekitTaggedItem taggedItem, HomekitCharacteristicType key,
378 HomekitAccessoryUpdater updater) {
379 return () -> updater.unsubscribe((GenericItem) taggedItem.getItem(), key.getTag());
382 // create method for characteristic
383 private static StatusLowBatteryCharacteristic createStatusLowBatteryCharacteristic(HomekitTaggedItem taggedItem,
384 HomekitAccessoryUpdater updater) {
385 return new StatusLowBatteryCharacteristic(
386 () -> getEnumFromItem(taggedItem, StatusLowBatteryEnum.NORMAL, StatusLowBatteryEnum.LOW,
387 StatusLowBatteryEnum.NORMAL),
388 getSubscriber(taggedItem, BATTERY_LOW_STATUS, updater),
389 getUnsubscriber(taggedItem, BATTERY_LOW_STATUS, updater));
392 private static StatusFaultCharacteristic createStatusFaultCharacteristic(HomekitTaggedItem taggedItem,
393 HomekitAccessoryUpdater updater) {
394 return new StatusFaultCharacteristic(
395 () -> getEnumFromItem(taggedItem, StatusFaultEnum.NO_FAULT, StatusFaultEnum.GENERAL_FAULT,
396 StatusFaultEnum.NO_FAULT),
397 getSubscriber(taggedItem, FAULT_STATUS, updater), getUnsubscriber(taggedItem, FAULT_STATUS, updater));
400 private static StatusTamperedCharacteristic createStatusTamperedCharacteristic(HomekitTaggedItem taggedItem,
401 HomekitAccessoryUpdater updater) {
402 return new StatusTamperedCharacteristic(
403 () -> getEnumFromItem(taggedItem, StatusTamperedEnum.NOT_TAMPERED, StatusTamperedEnum.TAMPERED,
404 StatusTamperedEnum.NOT_TAMPERED),
405 getSubscriber(taggedItem, TAMPERED_STATUS, updater),
406 getUnsubscriber(taggedItem, TAMPERED_STATUS, updater));
409 private static ObstructionDetectedCharacteristic createObstructionDetectedCharacteristic(
410 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
411 return new ObstructionDetectedCharacteristic(
412 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
413 || taggedItem.getItem().getState() == OpenClosedType.OPEN),
414 getSubscriber(taggedItem, OBSTRUCTION_STATUS, updater),
415 getUnsubscriber(taggedItem, OBSTRUCTION_STATUS, updater));
418 private static StatusActiveCharacteristic createStatusActiveCharacteristic(HomekitTaggedItem taggedItem,
419 HomekitAccessoryUpdater updater) {
420 return new StatusActiveCharacteristic(
421 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
422 || taggedItem.getItem().getState() == OpenClosedType.OPEN),
423 getSubscriber(taggedItem, ACTIVE_STATUS, updater), getUnsubscriber(taggedItem, ACTIVE_STATUS, updater));
426 private static NameCharacteristic createNameCharacteristic(HomekitTaggedItem taggedItem,
427 HomekitAccessoryUpdater updater) {
428 return new NameCharacteristic(() -> {
429 final State state = taggedItem.getItem().getState();
430 return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
434 private static HoldPositionCharacteristic createHoldPositionCharacteristic(HomekitTaggedItem taggedItem,
435 HomekitAccessoryUpdater updater) {
436 return new HoldPositionCharacteristic(value -> ((SwitchItem) taggedItem.getItem()).send(OnOffType.from(value)));
439 private static CarbonMonoxideLevelCharacteristic createCarbonMonoxideLevelCharacteristic(
440 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
441 return new CarbonMonoxideLevelCharacteristic(
442 getDoubleSupplier(taggedItem,
443 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
444 CarbonMonoxideLevelCharacteristic.DEFAULT_MIN_VALUE)),
445 getSubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater),
446 getUnsubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater));
449 private static CarbonMonoxidePeakLevelCharacteristic createCarbonMonoxidePeakLevelCharacteristic(
450 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
451 return new CarbonMonoxidePeakLevelCharacteristic(
452 getDoubleSupplier(taggedItem,
453 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
454 CarbonMonoxidePeakLevelCharacteristic.DEFAULT_MIN_VALUE)),
455 getSubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater),
456 getUnsubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater));
459 private static CarbonDioxideLevelCharacteristic createCarbonDioxideLevelCharacteristic(HomekitTaggedItem taggedItem,
460 HomekitAccessoryUpdater updater) {
461 return new CarbonDioxideLevelCharacteristic(
462 getDoubleSupplier(taggedItem,
463 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
464 CarbonDioxideLevelCharacteristic.DEFAULT_MIN_VALUE)),
465 getSubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater),
466 getUnsubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater));
469 private static CarbonDioxidePeakLevelCharacteristic createCarbonDioxidePeakLevelCharacteristic(
470 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
471 return new CarbonDioxidePeakLevelCharacteristic(
472 getDoubleSupplier(taggedItem,
473 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
474 CarbonDioxidePeakLevelCharacteristic.DEFAULT_MIN_VALUE)),
475 getSubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater),
476 getUnsubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater));
479 private static CurrentHorizontalTiltAngleCharacteristic createCurrentHorizontalTiltAngleCharacteristic(
480 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
481 return new CurrentHorizontalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
482 getSubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater),
483 getUnsubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater));
486 private static CurrentVerticalTiltAngleCharacteristic createCurrentVerticalTiltAngleCharacteristic(
487 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
488 return new CurrentVerticalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
489 getSubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater),
490 getUnsubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater));
493 private static TargetHorizontalTiltAngleCharacteristic createTargetHorizontalTiltAngleCharacteristic(
494 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
495 return new TargetHorizontalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
496 setAngleConsumer(taggedItem), getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
497 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
500 private static TargetVerticalTiltAngleCharacteristic createTargetVerticalTiltAngleCharacteristic(
501 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
502 return new TargetVerticalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0), setAngleConsumer(taggedItem),
503 getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
504 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
507 private static HueCharacteristic createHueCharacteristic(HomekitTaggedItem taggedItem,
508 HomekitAccessoryUpdater updater) {
509 return new HueCharacteristic(() -> {
511 State state = taggedItem.getItem().getState();
512 if (state instanceof HSBType) {
513 value = ((HSBType) state).getHue().doubleValue();
515 return CompletableFuture.completedFuture(value);
517 if (taggedItem.getItem() instanceof ColorItem) {
518 taggedItem.sendCommandProxy(HomekitCommandType.HUE_COMMAND, new DecimalType(hue));
520 logger.warn("Item type {} is not supported for {}. Only Color type is supported.",
521 taggedItem.getItem().getType(), taggedItem.getName());
523 }, getSubscriber(taggedItem, HUE, updater), getUnsubscriber(taggedItem, HUE, updater));
526 private static BrightnessCharacteristic createBrightnessCharacteristic(HomekitTaggedItem taggedItem,
527 HomekitAccessoryUpdater updater) {
528 return new BrightnessCharacteristic(() -> {
530 final State state = taggedItem.getItem().getState();
531 if (state instanceof HSBType) {
532 value = ((HSBType) state).getBrightness().intValue();
533 } else if (state instanceof PercentType) {
534 value = ((PercentType) state).intValue();
536 return CompletableFuture.completedFuture(value);
538 final Item item = taggedItem.getItem();
539 if (item instanceof DimmerItem) {
540 taggedItem.sendCommandProxy(HomekitCommandType.BRIGHTNESS_COMMAND, new PercentType(brightness));
542 logger.warn("Item type {} is not supported for {}. Only ColorItem and DimmerItem are supported.",
543 item.getType(), taggedItem.getName());
545 }, getSubscriber(taggedItem, BRIGHTNESS, updater), getUnsubscriber(taggedItem, BRIGHTNESS, updater));
548 private static SaturationCharacteristic createSaturationCharacteristic(HomekitTaggedItem taggedItem,
549 HomekitAccessoryUpdater updater) {
550 return new SaturationCharacteristic(() -> {
552 State state = taggedItem.getItem().getState();
553 if (state instanceof HSBType) {
554 value = ((HSBType) state).getSaturation().doubleValue();
555 } else if (state instanceof PercentType) {
556 value = ((PercentType) state).doubleValue();
558 return CompletableFuture.completedFuture(value);
560 if (taggedItem.getItem() instanceof ColorItem) {
561 taggedItem.sendCommandProxy(HomekitCommandType.SATURATION_COMMAND,
562 new PercentType(saturation.intValue()));
564 logger.warn("Item type {} is not supported for {}. Only Color type is supported.",
565 taggedItem.getItem().getType(), taggedItem.getName());
567 }, getSubscriber(taggedItem, SATURATION, updater), getUnsubscriber(taggedItem, SATURATION, updater));
570 private static ColorTemperatureCharacteristic createColorTemperatureCharacteristic(HomekitTaggedItem taggedItem,
571 HomekitAccessoryUpdater updater) {
572 int minValue = taggedItem.getConfigurationAsInt(HomekitTaggedItem.MIN_VALUE,
573 ColorTemperatureCharacteristic.DEFAULT_MIN_VALUE);
574 return new ColorTemperatureCharacteristic(minValue,
575 taggedItem.getConfigurationAsInt(HomekitTaggedItem.MAX_VALUE,
576 ColorTemperatureCharacteristic.DEFAULT_MAX_VALUE),
577 getIntSupplier(taggedItem, minValue), setIntConsumer(taggedItem),
578 getSubscriber(taggedItem, COLOR_TEMPERATURE, updater),
579 getUnsubscriber(taggedItem, COLOR_TEMPERATURE, updater));
582 private static CurrentFanStateCharacteristic createCurrentFanStateCharacteristic(HomekitTaggedItem taggedItem,
583 HomekitAccessoryUpdater updater) {
584 return new CurrentFanStateCharacteristic(() -> {
585 final @Nullable DecimalType value = taggedItem.getItem().getStateAs(DecimalType.class);
587 CurrentFanStateEnum currentFanStateEnum = value != null ? CurrentFanStateEnum.fromCode(value.intValue())
589 if (currentFanStateEnum == null) {
590 currentFanStateEnum = CurrentFanStateEnum.INACTIVE;
592 return CompletableFuture.completedFuture(currentFanStateEnum);
593 }, getSubscriber(taggedItem, CURRENT_FAN_STATE, updater),
594 getUnsubscriber(taggedItem, CURRENT_FAN_STATE, updater));
597 private static TargetFanStateCharacteristic createTargetFanStateCharacteristic(HomekitTaggedItem taggedItem,
598 HomekitAccessoryUpdater updater) {
599 return new TargetFanStateCharacteristic(() -> {
600 final @Nullable DecimalType value = taggedItem.getItem().getStateAs(DecimalType.class);
602 TargetFanStateEnum targetFanStateEnum = value != null ? TargetFanStateEnum.fromCode(value.intValue())
604 if (targetFanStateEnum == null) {
605 targetFanStateEnum = TargetFanStateEnum.AUTO;
607 return CompletableFuture.completedFuture(targetFanStateEnum);
608 }, (targetState) -> {
609 if (taggedItem.getItem() instanceof NumberItem) {
610 ((NumberItem) taggedItem.getItem()).send(new DecimalType(targetState.getCode()));
612 logger.warn("Item type {} is not supported for {}. Only Number type is supported.",
613 taggedItem.getItem().getType(), taggedItem.getName());
615 }, getSubscriber(taggedItem, TARGET_FAN_STATE, updater),
616 getUnsubscriber(taggedItem, TARGET_FAN_STATE, updater));
619 private static RotationDirectionCharacteristic createRotationDirectionCharacteristic(HomekitTaggedItem taggedItem,
620 HomekitAccessoryUpdater updater) {
621 return new RotationDirectionCharacteristic(
622 () -> getEnumFromItem(taggedItem, RotationDirectionEnum.CLOCKWISE,
623 RotationDirectionEnum.COUNTER_CLOCKWISE, RotationDirectionEnum.CLOCKWISE),
624 (value) -> setValueFromEnum(taggedItem, value, RotationDirectionEnum.CLOCKWISE,
625 RotationDirectionEnum.COUNTER_CLOCKWISE),
626 getSubscriber(taggedItem, ROTATION_DIRECTION, updater),
627 getUnsubscriber(taggedItem, ROTATION_DIRECTION, updater));
630 private static SwingModeCharacteristic createSwingModeCharacteristic(HomekitTaggedItem taggedItem,
631 HomekitAccessoryUpdater updater) {
632 return new SwingModeCharacteristic(
633 () -> getEnumFromItem(taggedItem, SwingModeEnum.SWING_DISABLED, SwingModeEnum.SWING_ENABLED,
634 SwingModeEnum.SWING_DISABLED),
635 (value) -> setValueFromEnum(taggedItem, value, SwingModeEnum.SWING_DISABLED,
636 SwingModeEnum.SWING_ENABLED),
637 getSubscriber(taggedItem, SWING_MODE, updater), getUnsubscriber(taggedItem, SWING_MODE, updater));
640 private static LockPhysicalControlsCharacteristic createLockPhysicalControlsCharacteristic(
641 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
642 return new LockPhysicalControlsCharacteristic(
643 () -> getEnumFromItem(taggedItem, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED,
644 LockPhysicalControlsEnum.CONTROL_LOCK_ENABLED, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED),
645 (value) -> setValueFromEnum(taggedItem, value, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED,
646 LockPhysicalControlsEnum.CONTROL_LOCK_ENABLED),
647 getSubscriber(taggedItem, LOCK_CONTROL, updater), getUnsubscriber(taggedItem, LOCK_CONTROL, updater));
650 private static RotationSpeedCharacteristic createRotationSpeedCharacteristic(HomekitTaggedItem item,
651 HomekitAccessoryUpdater updater) {
652 return new RotationSpeedCharacteristic(getIntSupplier(item, 0), setPercentConsumer(item),
653 getSubscriber(item, ROTATION_SPEED, updater), getUnsubscriber(item, ROTATION_SPEED, updater));
656 private static SetDurationCharacteristic createDurationCharacteristic(HomekitTaggedItem taggedItem,
657 HomekitAccessoryUpdater updater) {
658 return new SetDurationCharacteristic(() -> {
659 int value = getIntFromItem(taggedItem, 0);
660 final @Nullable Map<String, Object> itemConfiguration = taggedItem.getConfiguration();
661 if ((value == 0) && (itemConfiguration != null)) { // check for default duration
662 final Object duration = itemConfiguration.get(HomekitValveImpl.CONFIG_DEFAULT_DURATION);
663 if (duration instanceof BigDecimal) {
664 value = ((BigDecimal) duration).intValue();
665 if (taggedItem.getItem() instanceof NumberItem) {
666 ((NumberItem) taggedItem.getItem()).setState(new DecimalType(value));
670 return CompletableFuture.completedFuture(value);
671 }, setIntConsumer(taggedItem), getSubscriber(taggedItem, DURATION, updater),
672 getUnsubscriber(taggedItem, DURATION, updater));
675 private static RemainingDurationCharacteristic createRemainingDurationCharacteristic(HomekitTaggedItem taggedItem,
676 HomekitAccessoryUpdater updater) {
677 return new RemainingDurationCharacteristic(getIntSupplier(taggedItem, 0),
678 getSubscriber(taggedItem, REMAINING_DURATION, updater),
679 getUnsubscriber(taggedItem, REMAINING_DURATION, updater));
682 private static VolumeCharacteristic createVolumeCharacteristic(HomekitTaggedItem taggedItem,
683 HomekitAccessoryUpdater updater) {
684 return new VolumeCharacteristic(getIntSupplier(taggedItem, 0),
685 (volume) -> ((NumberItem) taggedItem.getItem()).send(new DecimalType(volume)),
686 getSubscriber(taggedItem, DURATION, updater), getUnsubscriber(taggedItem, DURATION, updater));
689 private static CoolingThresholdTemperatureCharacteristic createCoolingThresholdCharacteristic(
690 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
691 return new CoolingThresholdTemperatureCharacteristic(
692 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
693 CoolingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE),
694 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
695 CoolingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE),
696 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.STEP,
697 CoolingThresholdTemperatureCharacteristic.DEFAULT_STEP),
698 getTemperatureSupplier(taggedItem,
699 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
700 CoolingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE)),
701 setTemperatureConsumer(taggedItem), getSubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater),
702 getUnsubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater));
705 private static HeatingThresholdTemperatureCharacteristic createHeatingThresholdCharacteristic(
706 HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
707 return new HeatingThresholdTemperatureCharacteristic(
708 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
709 HeatingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE),
710 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
711 HeatingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE),
712 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.STEP,
713 HeatingThresholdTemperatureCharacteristic.DEFAULT_STEP),
714 getTemperatureSupplier(taggedItem,
715 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
716 HeatingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE)),
717 setTemperatureConsumer(taggedItem), getSubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater),
718 getUnsubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater));
721 private static OzoneDensityCharacteristic createOzoneDensityCharacteristic(final HomekitTaggedItem taggedItem,
722 HomekitAccessoryUpdater updater) {
723 return new OzoneDensityCharacteristic(
724 getDoubleSupplier(taggedItem,
725 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
726 OzoneDensityCharacteristic.DEFAULT_MIN_VALUE)),
727 getSubscriber(taggedItem, OZONE_DENSITY, updater), getUnsubscriber(taggedItem, OZONE_DENSITY, updater));
730 private static NitrogenDioxideDensityCharacteristic createNitrogenDioxideDensityCharacteristic(
731 final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
732 return new NitrogenDioxideDensityCharacteristic(
733 getDoubleSupplier(taggedItem,
734 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
735 NitrogenDioxideDensityCharacteristic.DEFAULT_MIN_VALUE)),
736 getSubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater),
737 getUnsubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater));
740 private static SulphurDioxideDensityCharacteristic createSulphurDioxideDensityCharacteristic(
741 final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
742 return new SulphurDioxideDensityCharacteristic(
743 getDoubleSupplier(taggedItem,
744 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
745 SulphurDioxideDensityCharacteristic.DEFAULT_MIN_VALUE)),
746 getSubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater),
747 getUnsubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater));
750 private static PM25DensityCharacteristic createPM25DensityCharacteristic(final HomekitTaggedItem taggedItem,
751 HomekitAccessoryUpdater updater) {
752 return new PM25DensityCharacteristic(
753 getDoubleSupplier(taggedItem,
754 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
755 PM25DensityCharacteristic.DEFAULT_MIN_VALUE)),
756 getSubscriber(taggedItem, PM25_DENSITY, updater), getUnsubscriber(taggedItem, PM25_DENSITY, updater));
759 private static PM10DensityCharacteristic createPM10DensityCharacteristic(final HomekitTaggedItem taggedItem,
760 HomekitAccessoryUpdater updater) {
761 return new PM10DensityCharacteristic(
762 getDoubleSupplier(taggedItem,
763 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
764 PM10DensityCharacteristic.DEFAULT_MIN_VALUE)),
765 getSubscriber(taggedItem, PM10_DENSITY, updater), getUnsubscriber(taggedItem, PM10_DENSITY, updater));
768 private static VOCDensityCharacteristic createVOCDensityCharacteristic(final HomekitTaggedItem taggedItem,
769 HomekitAccessoryUpdater updater) {
770 return new VOCDensityCharacteristic(
771 getDoubleSupplier(taggedItem,
772 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
773 VOCDensityCharacteristic.DEFAULT_MIN_VALUE)),
774 getSubscriber(taggedItem, VOC_DENSITY, updater), getUnsubscriber(taggedItem, VOC_DENSITY, updater));