]> git.basschouten.com Git - openhab-addons.git/blob
3d52d23c9dcd444e14878fcf8a8e4c58686f2eab
[openhab-addons.git] /
1 /**
2  * Copyright (c) 2010-2024 Contributors to the openHAB project
3  *
4  * See the NOTICE file(s) distributed with this work for additional
5  * information.
6  *
7  * This program and the accompanying materials are made available under the
8  * terms of the Eclipse Public License 2.0 which is available at
9  * http://www.eclipse.org/legal/epl-2.0
10  *
11  * SPDX-License-Identifier: EPL-2.0
12  */
13 package org.openhab.io.homekit.internal.accessories;
14
15 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.*;
16
17 import java.math.BigDecimal;
18 import java.math.RoundingMode;
19 import java.util.ArrayList;
20 import java.util.EnumMap;
21 import java.util.HashMap;
22 import java.util.List;
23 import java.util.Map;
24 import java.util.Objects;
25 import java.util.concurrent.CompletableFuture;
26 import java.util.function.BiFunction;
27 import java.util.function.Consumer;
28 import java.util.function.Supplier;
29
30 import javax.measure.Quantity;
31 import javax.measure.Unit;
32 import javax.measure.quantity.Temperature;
33
34 import org.eclipse.jdt.annotation.NonNullByDefault;
35 import org.eclipse.jdt.annotation.Nullable;
36 import org.openhab.core.items.GenericItem;
37 import org.openhab.core.items.Item;
38 import org.openhab.core.library.items.ColorItem;
39 import org.openhab.core.library.items.DimmerItem;
40 import org.openhab.core.library.items.NumberItem;
41 import org.openhab.core.library.items.RollershutterItem;
42 import org.openhab.core.library.items.StringItem;
43 import org.openhab.core.library.items.SwitchItem;
44 import org.openhab.core.library.types.DecimalType;
45 import org.openhab.core.library.types.HSBType;
46 import org.openhab.core.library.types.IncreaseDecreaseType;
47 import org.openhab.core.library.types.OnOffType;
48 import org.openhab.core.library.types.OpenClosedType;
49 import org.openhab.core.library.types.PercentType;
50 import org.openhab.core.library.types.QuantityType;
51 import org.openhab.core.library.types.StopMoveType;
52 import org.openhab.core.library.types.StringType;
53 import org.openhab.core.library.unit.ImperialUnits;
54 import org.openhab.core.library.unit.SIUnits;
55 import org.openhab.core.library.unit.Units;
56 import org.openhab.core.types.State;
57 import org.openhab.core.types.UnDefType;
58 import org.openhab.io.homekit.Homekit;
59 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
60 import org.openhab.io.homekit.internal.HomekitCharacteristicType;
61 import org.openhab.io.homekit.internal.HomekitCommandType;
62 import org.openhab.io.homekit.internal.HomekitException;
63 import org.openhab.io.homekit.internal.HomekitImpl;
64 import org.openhab.io.homekit.internal.HomekitTaggedItem;
65 import org.osgi.framework.FrameworkUtil;
66 import org.slf4j.Logger;
67 import org.slf4j.LoggerFactory;
68
69 import io.github.hapjava.characteristics.Characteristic;
70 import io.github.hapjava.characteristics.CharacteristicEnum;
71 import io.github.hapjava.characteristics.ExceptionalConsumer;
72 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
73 import io.github.hapjava.characteristics.impl.accessoryinformation.FirmwareRevisionCharacteristic;
74 import io.github.hapjava.characteristics.impl.accessoryinformation.HardwareRevisionCharacteristic;
75 import io.github.hapjava.characteristics.impl.accessoryinformation.IdentifyCharacteristic;
76 import io.github.hapjava.characteristics.impl.accessoryinformation.ManufacturerCharacteristic;
77 import io.github.hapjava.characteristics.impl.accessoryinformation.ModelCharacteristic;
78 import io.github.hapjava.characteristics.impl.accessoryinformation.SerialNumberCharacteristic;
79 import io.github.hapjava.characteristics.impl.airquality.NitrogenDioxideDensityCharacteristic;
80 import io.github.hapjava.characteristics.impl.airquality.OzoneDensityCharacteristic;
81 import io.github.hapjava.characteristics.impl.airquality.PM10DensityCharacteristic;
82 import io.github.hapjava.characteristics.impl.airquality.PM25DensityCharacteristic;
83 import io.github.hapjava.characteristics.impl.airquality.SulphurDioxideDensityCharacteristic;
84 import io.github.hapjava.characteristics.impl.airquality.VOCDensityCharacteristic;
85 import io.github.hapjava.characteristics.impl.audio.MuteCharacteristic;
86 import io.github.hapjava.characteristics.impl.audio.VolumeCharacteristic;
87 import io.github.hapjava.characteristics.impl.battery.StatusLowBatteryCharacteristic;
88 import io.github.hapjava.characteristics.impl.battery.StatusLowBatteryEnum;
89 import io.github.hapjava.characteristics.impl.carbondioxidesensor.CarbonDioxideLevelCharacteristic;
90 import io.github.hapjava.characteristics.impl.carbondioxidesensor.CarbonDioxidePeakLevelCharacteristic;
91 import io.github.hapjava.characteristics.impl.carbonmonoxidesensor.CarbonMonoxideLevelCharacteristic;
92 import io.github.hapjava.characteristics.impl.carbonmonoxidesensor.CarbonMonoxidePeakLevelCharacteristic;
93 import io.github.hapjava.characteristics.impl.common.ActiveCharacteristic;
94 import io.github.hapjava.characteristics.impl.common.ActiveEnum;
95 import io.github.hapjava.characteristics.impl.common.ActiveIdentifierCharacteristic;
96 import io.github.hapjava.characteristics.impl.common.ConfiguredNameCharacteristic;
97 import io.github.hapjava.characteristics.impl.common.IdentifierCharacteristic;
98 import io.github.hapjava.characteristics.impl.common.IsConfiguredCharacteristic;
99 import io.github.hapjava.characteristics.impl.common.IsConfiguredEnum;
100 import io.github.hapjava.characteristics.impl.common.NameCharacteristic;
101 import io.github.hapjava.characteristics.impl.common.ObstructionDetectedCharacteristic;
102 import io.github.hapjava.characteristics.impl.common.ProgrammableSwitchEnum;
103 import io.github.hapjava.characteristics.impl.common.ProgrammableSwitchEventCharacteristic;
104 import io.github.hapjava.characteristics.impl.common.StatusActiveCharacteristic;
105 import io.github.hapjava.characteristics.impl.common.StatusFaultCharacteristic;
106 import io.github.hapjava.characteristics.impl.common.StatusFaultEnum;
107 import io.github.hapjava.characteristics.impl.common.StatusTamperedCharacteristic;
108 import io.github.hapjava.characteristics.impl.common.StatusTamperedEnum;
109 import io.github.hapjava.characteristics.impl.fan.CurrentFanStateCharacteristic;
110 import io.github.hapjava.characteristics.impl.fan.CurrentFanStateEnum;
111 import io.github.hapjava.characteristics.impl.fan.LockPhysicalControlsCharacteristic;
112 import io.github.hapjava.characteristics.impl.fan.LockPhysicalControlsEnum;
113 import io.github.hapjava.characteristics.impl.fan.RotationDirectionCharacteristic;
114 import io.github.hapjava.characteristics.impl.fan.RotationDirectionEnum;
115 import io.github.hapjava.characteristics.impl.fan.RotationSpeedCharacteristic;
116 import io.github.hapjava.characteristics.impl.fan.SwingModeCharacteristic;
117 import io.github.hapjava.characteristics.impl.fan.SwingModeEnum;
118 import io.github.hapjava.characteristics.impl.fan.TargetFanStateCharacteristic;
119 import io.github.hapjava.characteristics.impl.fan.TargetFanStateEnum;
120 import io.github.hapjava.characteristics.impl.filtermaintenance.FilterLifeLevelCharacteristic;
121 import io.github.hapjava.characteristics.impl.filtermaintenance.ResetFilterIndicationCharacteristic;
122 import io.github.hapjava.characteristics.impl.garagedoor.CurrentDoorStateCharacteristic;
123 import io.github.hapjava.characteristics.impl.garagedoor.CurrentDoorStateEnum;
124 import io.github.hapjava.characteristics.impl.garagedoor.TargetDoorStateCharacteristic;
125 import io.github.hapjava.characteristics.impl.garagedoor.TargetDoorStateEnum;
126 import io.github.hapjava.characteristics.impl.humiditysensor.CurrentRelativeHumidityCharacteristic;
127 import io.github.hapjava.characteristics.impl.humiditysensor.TargetRelativeHumidityCharacteristic;
128 import io.github.hapjava.characteristics.impl.inputsource.CurrentVisibilityStateCharacteristic;
129 import io.github.hapjava.characteristics.impl.inputsource.CurrentVisibilityStateEnum;
130 import io.github.hapjava.characteristics.impl.inputsource.InputDeviceTypeCharacteristic;
131 import io.github.hapjava.characteristics.impl.inputsource.InputDeviceTypeEnum;
132 import io.github.hapjava.characteristics.impl.inputsource.InputSourceTypeCharacteristic;
133 import io.github.hapjava.characteristics.impl.inputsource.InputSourceTypeEnum;
134 import io.github.hapjava.characteristics.impl.inputsource.TargetVisibilityStateCharacteristic;
135 import io.github.hapjava.characteristics.impl.inputsource.TargetVisibilityStateEnum;
136 import io.github.hapjava.characteristics.impl.lightbulb.BrightnessCharacteristic;
137 import io.github.hapjava.characteristics.impl.lightbulb.ColorTemperatureCharacteristic;
138 import io.github.hapjava.characteristics.impl.lightbulb.HueCharacteristic;
139 import io.github.hapjava.characteristics.impl.lightbulb.SaturationCharacteristic;
140 import io.github.hapjava.characteristics.impl.slat.CurrentTiltAngleCharacteristic;
141 import io.github.hapjava.characteristics.impl.slat.TargetTiltAngleCharacteristic;
142 import io.github.hapjava.characteristics.impl.television.ClosedCaptionsCharacteristic;
143 import io.github.hapjava.characteristics.impl.television.ClosedCaptionsEnum;
144 import io.github.hapjava.characteristics.impl.television.CurrentMediaStateCharacteristic;
145 import io.github.hapjava.characteristics.impl.television.CurrentMediaStateEnum;
146 import io.github.hapjava.characteristics.impl.television.PictureModeCharacteristic;
147 import io.github.hapjava.characteristics.impl.television.PictureModeEnum;
148 import io.github.hapjava.characteristics.impl.television.PowerModeCharacteristic;
149 import io.github.hapjava.characteristics.impl.television.PowerModeEnum;
150 import io.github.hapjava.characteristics.impl.television.RemoteKeyCharacteristic;
151 import io.github.hapjava.characteristics.impl.television.RemoteKeyEnum;
152 import io.github.hapjava.characteristics.impl.television.SleepDiscoveryModeCharacteristic;
153 import io.github.hapjava.characteristics.impl.television.SleepDiscoveryModeEnum;
154 import io.github.hapjava.characteristics.impl.television.TargetMediaStateCharacteristic;
155 import io.github.hapjava.characteristics.impl.television.TargetMediaStateEnum;
156 import io.github.hapjava.characteristics.impl.televisionspeaker.VolumeControlTypeCharacteristic;
157 import io.github.hapjava.characteristics.impl.televisionspeaker.VolumeControlTypeEnum;
158 import io.github.hapjava.characteristics.impl.televisionspeaker.VolumeSelectorCharacteristic;
159 import io.github.hapjava.characteristics.impl.televisionspeaker.VolumeSelectorEnum;
160 import io.github.hapjava.characteristics.impl.thermostat.CoolingThresholdTemperatureCharacteristic;
161 import io.github.hapjava.characteristics.impl.thermostat.CurrentHeatingCoolingStateCharacteristic;
162 import io.github.hapjava.characteristics.impl.thermostat.CurrentHeatingCoolingStateEnum;
163 import io.github.hapjava.characteristics.impl.thermostat.CurrentTemperatureCharacteristic;
164 import io.github.hapjava.characteristics.impl.thermostat.HeatingThresholdTemperatureCharacteristic;
165 import io.github.hapjava.characteristics.impl.thermostat.TargetHeatingCoolingStateCharacteristic;
166 import io.github.hapjava.characteristics.impl.thermostat.TargetHeatingCoolingStateEnum;
167 import io.github.hapjava.characteristics.impl.thermostat.TargetTemperatureCharacteristic;
168 import io.github.hapjava.characteristics.impl.thermostat.TemperatureDisplayUnitCharacteristic;
169 import io.github.hapjava.characteristics.impl.thermostat.TemperatureDisplayUnitEnum;
170 import io.github.hapjava.characteristics.impl.valve.RemainingDurationCharacteristic;
171 import io.github.hapjava.characteristics.impl.valve.SetDurationCharacteristic;
172 import io.github.hapjava.characteristics.impl.windowcovering.CurrentHorizontalTiltAngleCharacteristic;
173 import io.github.hapjava.characteristics.impl.windowcovering.CurrentVerticalTiltAngleCharacteristic;
174 import io.github.hapjava.characteristics.impl.windowcovering.HoldPositionCharacteristic;
175 import io.github.hapjava.characteristics.impl.windowcovering.TargetHorizontalTiltAngleCharacteristic;
176 import io.github.hapjava.characteristics.impl.windowcovering.TargetVerticalTiltAngleCharacteristic;
177
178 /**
179  * Creates an optional characteristics .
180  *
181  * @author Eugen Freiter - Initial contribution
182  */
183 @NonNullByDefault
184 public class HomekitCharacteristicFactory {
185     private static final Logger LOGGER = LoggerFactory.getLogger(HomekitCharacteristicFactory.class);
186
187     // List of optional characteristics and corresponding method to create them.
188     private static final Map<HomekitCharacteristicType, BiFunction<HomekitTaggedItem, HomekitAccessoryUpdater, Characteristic>> OPTIONAL = new HashMap<>() {
189         {
190             put(ACTIVE, HomekitCharacteristicFactory::createActiveCharacteristic);
191             put(ACTIVE_IDENTIFIER, HomekitCharacteristicFactory::createActiveIdentifierCharacteristic);
192             put(ACTIVE_STATUS, HomekitCharacteristicFactory::createStatusActiveCharacteristic);
193             put(BATTERY_LOW_STATUS, HomekitCharacteristicFactory::createStatusLowBatteryCharacteristic);
194             put(BRIGHTNESS, HomekitCharacteristicFactory::createBrightnessCharacteristic);
195             put(CARBON_DIOXIDE_LEVEL, HomekitCharacteristicFactory::createCarbonDioxideLevelCharacteristic);
196             put(CARBON_DIOXIDE_PEAK_LEVEL, HomekitCharacteristicFactory::createCarbonDioxidePeakLevelCharacteristic);
197             put(CARBON_MONOXIDE_LEVEL, HomekitCharacteristicFactory::createCarbonMonoxideLevelCharacteristic);
198             put(CARBON_MONOXIDE_PEAK_LEVEL, HomekitCharacteristicFactory::createCarbonMonoxidePeakLevelCharacteristic);
199             put(CLOSED_CAPTIONS, HomekitCharacteristicFactory::createClosedCaptionsCharacteristic);
200             put(COLOR_TEMPERATURE, HomekitCharacteristicFactory::createColorTemperatureCharacteristic);
201             put(CONFIGURED, HomekitCharacteristicFactory::createIsConfiguredCharacteristic);
202             put(CONFIGURED_NAME, HomekitCharacteristicFactory::createConfiguredNameCharacteristic);
203             put(COOLING_THRESHOLD_TEMPERATURE, HomekitCharacteristicFactory::createCoolingThresholdCharacteristic);
204             put(CURRENT_DOOR_STATE, HomekitCharacteristicFactory::createCurrentDoorStateCharacteristic);
205             put(CURRENT_HEATING_COOLING_STATE,
206                     HomekitCharacteristicFactory::createCurrentHeatingCoolingStateCharacteristic);
207             put(CURRENT_FAN_STATE, HomekitCharacteristicFactory::createCurrentFanStateCharacteristic);
208             put(CURRENT_HORIZONTAL_TILT_ANGLE,
209                     HomekitCharacteristicFactory::createCurrentHorizontalTiltAngleCharacteristic);
210             put(CURRENT_MEDIA_STATE, HomekitCharacteristicFactory::createCurrentMediaStateCharacteristic);
211             put(CURRENT_TILT_ANGLE, HomekitCharacteristicFactory::createCurrentTiltAngleCharacteristic);
212             put(CURRENT_VERTICAL_TILT_ANGLE,
213                     HomekitCharacteristicFactory::createCurrentVerticalTiltAngleCharacteristic);
214             put(CURRENT_VISIBILITY, HomekitCharacteristicFactory::createCurrentVisibilityStateCharacteristic);
215             put(CURRENT_TEMPERATURE, HomekitCharacteristicFactory::createCurrentTemperatureCharacteristic);
216             put(DURATION, HomekitCharacteristicFactory::createDurationCharacteristic);
217             put(FAULT_STATUS, HomekitCharacteristicFactory::createStatusFaultCharacteristic);
218             put(FIRMWARE_REVISION, HomekitCharacteristicFactory::createFirmwareRevisionCharacteristic);
219             put(FILTER_LIFE_LEVEL, HomekitCharacteristicFactory::createFilterLifeLevelCharacteristic);
220             put(FILTER_RESET_INDICATION, HomekitCharacteristicFactory::createFilterResetCharacteristic);
221             put(HARDWARE_REVISION, HomekitCharacteristicFactory::createHardwareRevisionCharacteristic);
222             put(HEATING_THRESHOLD_TEMPERATURE, HomekitCharacteristicFactory::createHeatingThresholdCharacteristic);
223             put(HOLD_POSITION, HomekitCharacteristicFactory::createHoldPositionCharacteristic);
224             put(HUE, HomekitCharacteristicFactory::createHueCharacteristic);
225             put(IDENTIFIER, HomekitCharacteristicFactory::createIdentifierCharacteristic);
226             put(IDENTIFY, HomekitCharacteristicFactory::createIdentifyCharacteristic);
227             put(INPUT_DEVICE_TYPE, HomekitCharacteristicFactory::createInputDeviceTypeCharacteristic);
228             put(INPUT_SOURCE_TYPE, HomekitCharacteristicFactory::createInputSourceTypeCharacteristic);
229             put(LOCK_CONTROL, HomekitCharacteristicFactory::createLockPhysicalControlsCharacteristic);
230             put(MANUFACTURER, HomekitCharacteristicFactory::createManufacturerCharacteristic);
231             put(MODEL, HomekitCharacteristicFactory::createModelCharacteristic);
232             put(MUTE, HomekitCharacteristicFactory::createMuteCharacteristic);
233             put(NAME, HomekitCharacteristicFactory::createNameCharacteristic);
234             put(NITROGEN_DIOXIDE_DENSITY, HomekitCharacteristicFactory::createNitrogenDioxideDensityCharacteristic);
235             put(OBSTRUCTION_STATUS, HomekitCharacteristicFactory::createObstructionDetectedCharacteristic);
236             put(OZONE_DENSITY, HomekitCharacteristicFactory::createOzoneDensityCharacteristic);
237             put(PICTURE_MODE, HomekitCharacteristicFactory::createPictureModeCharacteristic);
238             put(PM10_DENSITY, HomekitCharacteristicFactory::createPM10DensityCharacteristic);
239             put(PM25_DENSITY, HomekitCharacteristicFactory::createPM25DensityCharacteristic);
240             put(POWER_MODE, HomekitCharacteristicFactory::createPowerModeCharacteristic);
241             put(PROGRAMMABLE_SWITCH_EVENT, HomekitCharacteristicFactory::createProgrammableSwitchEventCharacteristic);
242             put(REMAINING_DURATION, HomekitCharacteristicFactory::createRemainingDurationCharacteristic);
243             put(REMOTE_KEY, HomekitCharacteristicFactory::createRemoteKeyCharacteristic);
244             put(RELATIVE_HUMIDITY, HomekitCharacteristicFactory::createRelativeHumidityCharacteristic);
245             put(ROTATION_DIRECTION, HomekitCharacteristicFactory::createRotationDirectionCharacteristic);
246             put(ROTATION_SPEED, HomekitCharacteristicFactory::createRotationSpeedCharacteristic);
247             put(SATURATION, HomekitCharacteristicFactory::createSaturationCharacteristic);
248             put(SERIAL_NUMBER, HomekitCharacteristicFactory::createSerialNumberCharacteristic);
249             put(SLEEP_DISCOVERY_MODE, HomekitCharacteristicFactory::createSleepDiscoveryModeCharacteristic);
250             put(SULPHUR_DIOXIDE_DENSITY, HomekitCharacteristicFactory::createSulphurDioxideDensityCharacteristic);
251             put(SWING_MODE, HomekitCharacteristicFactory::createSwingModeCharacteristic);
252             put(TAMPERED_STATUS, HomekitCharacteristicFactory::createStatusTamperedCharacteristic);
253             put(TARGET_DOOR_STATE, HomekitCharacteristicFactory::createTargetDoorStateCharacteristic);
254             put(TARGET_FAN_STATE, HomekitCharacteristicFactory::createTargetFanStateCharacteristic);
255             put(TARGET_HEATING_COOLING_STATE,
256                     HomekitCharacteristicFactory::createTargetHeatingCoolingStateCharacteristic);
257             put(TARGET_HORIZONTAL_TILT_ANGLE,
258                     HomekitCharacteristicFactory::createTargetHorizontalTiltAngleCharacteristic);
259             put(TARGET_MEDIA_STATE, HomekitCharacteristicFactory::createTargetMediaStateCharacteristic);
260             put(TARGET_RELATIVE_HUMIDITY, HomekitCharacteristicFactory::createTargetRelativeHumidityCharacteristic);
261             put(TARGET_TEMPERATURE, HomekitCharacteristicFactory::createTargetTemperatureCharacteristic);
262             put(TARGET_TILT_ANGLE, HomekitCharacteristicFactory::createTargetTiltAngleCharacteristic);
263             put(TARGET_VERTICAL_TILT_ANGLE, HomekitCharacteristicFactory::createTargetVerticalTiltAngleCharacteristic);
264             put(TARGET_VISIBILITY_STATE, HomekitCharacteristicFactory::createTargetVisibilityStateCharacteristic);
265             put(TEMPERATURE_UNIT, HomekitCharacteristicFactory::createTemperatureDisplayUnitCharacteristic);
266             put(VOC_DENSITY, HomekitCharacteristicFactory::createVOCDensityCharacteristic);
267             put(VOLUME, HomekitCharacteristicFactory::createVolumeCharacteristic);
268             put(VOLUME_CONTROL_TYPE, HomekitCharacteristicFactory::createVolumeControlTypeCharacteristic);
269             put(VOLUME_SELECTOR, HomekitCharacteristicFactory::createVolumeSelectorCharacteristic);
270         }
271     };
272
273     public static @Nullable Characteristic createNullableCharacteristic(HomekitTaggedItem item,
274             HomekitAccessoryUpdater updater) {
275         final @Nullable HomekitCharacteristicType type = item.getCharacteristicType();
276         LOGGER.trace("Create characteristic {}", item);
277         if (OPTIONAL.containsKey(type)) {
278             return OPTIONAL.get(type).apply(item, updater);
279         }
280         return null;
281     }
282
283     /**
284      * Create HomeKit characteristic
285      *
286      * @param item corresponding OH item
287      * @param updater update to keep OH item and HomeKit characteristic in sync
288      * @return HomeKit characteristic
289      */
290     public static Characteristic createCharacteristic(HomekitTaggedItem item, HomekitAccessoryUpdater updater)
291             throws HomekitException {
292         Characteristic characteristic = createNullableCharacteristic(item, updater);
293         if (characteristic != null) {
294             return characteristic;
295         }
296         final @Nullable HomekitCharacteristicType type = item.getCharacteristicType();
297         LOGGER.warn("Unsupported optional characteristic from item {}. Accessory type {}, characteristic type {}",
298                 item.getName(), item.getAccessoryType(), type.getTag());
299         throw new HomekitException(
300                 "Unsupported optional characteristic. Characteristic type \"" + type.getTag() + "\"");
301     }
302
303     /**
304      * Create an EnumMap for a particular CharacteristicEnum.
305      * 
306      * By default, the map will simply be from the Enum value to the string version of its value.
307      * If the item is a Number item, though, the values will the be underlying integer code
308      * for the item, as a String.
309      * Then the item's metadata will be inspected, applying any custom mappings.
310      * Finally, if customEnumList is supplied, it will be filled out with those mappings
311      * that are actually referenced in the metadata.
312      * 
313      * @param item
314      * @param klazz The HAP-Java Enum for the characteristic.
315      * @param customEnumList Optional output list of which enums are explicitly mentioned.
316      * @param inverted Default-invert the 0/1 values of the HAP enum when linked to a Switch or Contact item.
317      *            This is set by the addon when creating mappings for specific characteristics where the 0 and 1
318      *            values for the enum do not map naturally to 0/OFF/CLOSED and 1/ON/OPEN of openHAB items.
319      *            Note that this is separate from the inverted item-level metadata configuration, which can be
320      *            thought of independently as applying on top of this setting. It essentially "multiplies" out,
321      *            but can also be thought of as simply swapping whichever value OFF/CLOSED and ON/OPEN are
322      *            associated with, which has already been set.
323      * @return
324      */
325     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
326             Class<T> klazz, @Nullable List<T> customEnumList, boolean inverted) {
327         EnumMap<T, String> map = new EnumMap(klazz);
328         var dataTypes = item.getBaseItem().getAcceptedDataTypes();
329         boolean switchType = dataTypes.contains(OnOffType.class);
330         boolean contactType = dataTypes.contains(OpenClosedType.class);
331         boolean percentType = dataTypes.contains(PercentType.class);
332         boolean numberType = dataTypes.contains(DecimalType.class) || percentType || switchType || contactType;
333
334         if (item.isInverted()) {
335             inverted = !inverted;
336         }
337         String onValue = switchType ? OnOffType.ON.toString() : OpenClosedType.OPEN.toString();
338         String offValue = switchType ? OnOffType.OFF.toString() : OpenClosedType.CLOSED.toString();
339
340         for (var k : klazz.getEnumConstants()) {
341             if (numberType) {
342                 int code = k.getCode();
343                 if ((switchType || contactType) && code == 0) {
344                     map.put(k, inverted ? onValue : offValue);
345                 } else if ((switchType || contactType) && code == 1) {
346                     map.put(k, inverted ? offValue : onValue);
347                 } else if (percentType && code == 0) {
348                     map.put(k, "OFF");
349                 } else if (percentType && code == 1) {
350                     map.put(k, "ON");
351                 } else {
352                     map.put(k, Integer.toString(code));
353                 }
354             } else {
355                 map.put(k, k.toString());
356             }
357         }
358         var configuration = item.getConfiguration();
359         if (configuration != null) {
360             map.forEach((k, current_value) -> {
361                 final Object newValue = configuration.get(k.toString());
362                 if (newValue instanceof String || newValue instanceof Number) {
363                     map.put(k, newValue.toString());
364                     if (customEnumList != null) {
365                         customEnumList.add(k);
366                     }
367                 }
368             });
369         }
370         if (customEnumList != null && customEnumList.isEmpty()) {
371             customEnumList.addAll(map.keySet());
372         }
373         LOGGER.debug("Created {} mapping for item {} ({}): {}", klazz.getSimpleName(), item.getName(),
374                 item.getBaseItem().getClass().getSimpleName(), map);
375         return map;
376     }
377
378     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
379             Class<T> klazz) {
380         return createMapping(item, klazz, null, false);
381     }
382
383     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
384             Class<T> klazz, @Nullable List<T> customEnumList) {
385         return createMapping(item, klazz, customEnumList, false);
386     }
387
388     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
389             Class<T> klazz, boolean inverted) {
390         return createMapping(item, klazz, null, inverted);
391     }
392
393     /**
394      * Takes item state as value and retrieves the key for that value from mapping.
395      * E.g. used to map StringItem value to HomeKit Enum
396      *
397      * @param item item
398      * @param mapping mapping
399      * @param defaultValue default value if nothing found in mapping
400      * @param <T> type of the result derived from
401      * @return key for the value
402      */
403     public static <T> T getKeyFromMapping(HomekitTaggedItem item, State state, Map<T, String> mapping, T defaultValue) {
404         LOGGER.trace("getKeyFromMapping: characteristic {}, state {}, mapping {}", item.getAccessoryType().getTag(),
405                 state, mapping);
406
407         String value;
408         if (state instanceof UnDefType) {
409             return defaultValue;
410         } else if (state instanceof StringType || state instanceof OnOffType || state instanceof OpenClosedType) {
411             value = state.toString();
412         } else if (state.getClass().equals(PercentType.class)) {
413             // We specifically want PercentType, but _not_ HSBType, so don't use instanceof
414             value = state.as(OnOffType.class).toString();
415         } else if (state.getClass().equals(DecimalType.class)) {
416             // We specifically want DecimalType, but _not_ PercentType or HSBType, so don't use instanceof
417             value = Integer.toString(((DecimalType) state).intValue());
418         } else {
419             LOGGER.warn(
420                     "Wrong value type {} ({}) for {} characteristic of the item {}. Expected StringItem, NumberItem, or SwitchItem.",
421                     state.toString(), state.getClass().getSimpleName(), item.getAccessoryType().getTag(),
422                     item.getName());
423             return defaultValue;
424         }
425
426         return mapping.entrySet().stream().filter(entry -> value.equalsIgnoreCase(entry.getValue())).findAny()
427                 .map(Map.Entry::getKey).orElseGet(() -> {
428                     LOGGER.warn(
429                             "Wrong value {} for {} characteristic of the item {}. Expected one of following {}. Returning {}.",
430                             state.toString(), item.getAccessoryType().getTag(), item.getName(), mapping.values(),
431                             defaultValue);
432                     return defaultValue;
433                 });
434     }
435
436     // supporting methods
437
438     public static boolean useFahrenheit() {
439         return Boolean.TRUE.equals(FrameworkUtil.getBundle(HomekitImpl.class).getBundleContext()
440                 .getServiceReference(Homekit.class.getName()).getProperty("useFahrenheitTemperature"));
441     }
442
443     public static TemperatureDisplayUnitCharacteristic createSystemTemperatureDisplayUnitCharacteristic() {
444         return new TemperatureDisplayUnitCharacteristic(() -> CompletableFuture
445                 .completedFuture(HomekitCharacteristicFactory.useFahrenheit() ? TemperatureDisplayUnitEnum.FAHRENHEIT
446                         : TemperatureDisplayUnitEnum.CELSIUS),
447                 (value) -> {
448                 }, (cb) -> {
449                 }, () -> {
450                 });
451     }
452
453     public static Unit<Temperature> getSystemTemperatureUnit() {
454         return useFahrenheit() ? ImperialUnits.FAHRENHEIT : SIUnits.CELSIUS;
455     }
456
457     private static <T extends CharacteristicEnum> CompletableFuture<T> getEnumFromItem(HomekitTaggedItem item,
458             Map<T, String> mapping, T defaultValue) {
459         return CompletableFuture
460                 .completedFuture(getKeyFromMapping(item, item.getItem().getState(), mapping, defaultValue));
461     }
462
463     public static <T extends Enum<T>> void setValueFromEnum(HomekitTaggedItem taggedItem, T value, Map<T, String> map) {
464         if (taggedItem.getBaseItem() instanceof NumberItem) {
465             taggedItem.send(new DecimalType(Objects.requireNonNull(map.get(value))));
466         } else if (taggedItem.getBaseItem() instanceof SwitchItem) {
467             taggedItem.send(OnOffType.from(Objects.requireNonNull(map.get(value))));
468         } else {
469             taggedItem.send(new StringType(map.get(value)));
470         }
471     }
472
473     private static int getIntFromItem(HomekitTaggedItem taggedItem, int defaultValue) {
474         int value = defaultValue;
475         final State state = taggedItem.getItem().getState();
476         if (state instanceof PercentType stateAsPercentType) {
477             value = stateAsPercentType.intValue();
478         } else if (state instanceof DecimalType stateAsDecimalType) {
479             value = stateAsDecimalType.intValue();
480         } else if (state instanceof UnDefType) {
481             LOGGER.debug("Item state {} is UNDEF {}. Returning default value {}", state, taggedItem.getName(),
482                     defaultValue);
483         } else {
484             LOGGER.warn(
485                     "Item state {} is not supported for {}. Only PercentType and DecimalType (0/100) are supported.",
486                     state, taggedItem.getName());
487         }
488         return value;
489     }
490
491     /** special method for tilts. it converts percentage to angle */
492     private static int getAngleFromItem(HomekitTaggedItem taggedItem, int defaultValue) {
493         int value = defaultValue;
494         final State state = taggedItem.getItem().getState();
495         if (state instanceof PercentType stateAsPercentType) {
496             value = (int) ((stateAsPercentType.intValue() * 90.0) / 50.0 - 90.0);
497         } else {
498             value = getIntFromItem(taggedItem, defaultValue);
499         }
500         return value;
501     }
502
503     private static <T extends Quantity<T>> double convertAndRound(double value, Unit<T> from, Unit<T> to) {
504         double rawValue = from.equals(to) ? value : from.getConverterTo(to).convert(value);
505         return new BigDecimal(rawValue).setScale(1, RoundingMode.HALF_UP).doubleValue();
506     }
507
508     public static @Nullable Double stateAsTemperature(@Nullable State state) {
509         if (state == null || state instanceof UnDefType) {
510             return null;
511         }
512
513         if (state instanceof QuantityType<?> qt) {
514             if (qt.getDimension().equals(SIUnits.CELSIUS.getDimension())) {
515                 return qt.toUnit(SIUnits.CELSIUS).doubleValue();
516             }
517         }
518
519         return convertToCelsius(state.as(DecimalType.class).doubleValue());
520     }
521
522     public static double convertToCelsius(double degrees) {
523         return convertAndRound(degrees, getSystemTemperatureUnit(), SIUnits.CELSIUS);
524     }
525
526     public static double convertFromCelsius(double degrees) {
527         return convertAndRound(degrees, SIUnits.CELSIUS, getSystemTemperatureUnit());
528     }
529
530     public static double getTemperatureStep(HomekitTaggedItem taggedItem, double defaultValue) {
531         return taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.STEP,
532                 new QuantityType(defaultValue, SIUnits.CELSIUS), true).doubleValue();
533     }
534
535     private static Supplier<CompletableFuture<Integer>> getAngleSupplier(HomekitTaggedItem taggedItem,
536             int defaultValue) {
537         return () -> CompletableFuture.completedFuture(getAngleFromItem(taggedItem, defaultValue));
538     }
539
540     private static Supplier<CompletableFuture<Integer>> getIntSupplier(HomekitTaggedItem taggedItem, int defaultValue) {
541         return () -> CompletableFuture.completedFuture(getIntFromItem(taggedItem, defaultValue));
542     }
543
544     private static ExceptionalConsumer<Integer> setIntConsumer(HomekitTaggedItem taggedItem) {
545         return (value) -> {
546             if (taggedItem.getBaseItem() instanceof NumberItem) {
547                 taggedItem.send(new DecimalType(value));
548             } else {
549                 LOGGER.warn("Item type {} is not supported for {}. Only NumberItem is supported.",
550                         taggedItem.getBaseItem().getType(), taggedItem.getName());
551             }
552         };
553     }
554
555     private static ExceptionalConsumer<Integer> setPercentConsumer(HomekitTaggedItem taggedItem) {
556         return (value) -> {
557             if (taggedItem.getBaseItem() instanceof NumberItem) {
558                 taggedItem.send(new DecimalType(value));
559             } else if (taggedItem.getBaseItem() instanceof DimmerItem) {
560                 taggedItem.send(new PercentType(value));
561             } else {
562                 LOGGER.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
563                         taggedItem.getBaseItem().getType(), taggedItem.getName());
564             }
565         };
566     }
567
568     private static ExceptionalConsumer<Integer> setAngleConsumer(HomekitTaggedItem taggedItem) {
569         return (value) -> {
570             if (taggedItem.getBaseItem() instanceof NumberItem) {
571                 taggedItem.send(new DecimalType(value));
572             } else if (taggedItem.getBaseItem() instanceof DimmerItem) {
573                 value = (int) (value * 50.0 / 90.0 + 50.0);
574                 taggedItem.send(new PercentType(value));
575             } else {
576                 LOGGER.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
577                         taggedItem.getBaseItem().getType(), taggedItem.getName());
578             }
579         };
580     }
581
582     private static Supplier<CompletableFuture<Double>> getDoubleSupplier(HomekitTaggedItem taggedItem,
583             double defaultValue) {
584         return () -> {
585             final State state = taggedItem.getItem().getState();
586             double value = defaultValue;
587             if (state instanceof PercentType stateAsPercentType) {
588                 value = stateAsPercentType.doubleValue();
589             } else if (state instanceof DecimalType stateAsDecimalType) {
590                 value = stateAsDecimalType.doubleValue();
591             } else if (state instanceof QuantityType stateAsQuantityType) {
592                 value = stateAsQuantityType.doubleValue();
593             }
594             return CompletableFuture.completedFuture(value);
595         };
596     }
597
598     private static ExceptionalConsumer<Double> setDoubleConsumer(HomekitTaggedItem taggedItem) {
599         return (value) -> {
600             if (taggedItem.getBaseItem() instanceof NumberItem) {
601                 taggedItem.send(new DecimalType(value.doubleValue()));
602             } else if (taggedItem.getBaseItem() instanceof DimmerItem) {
603                 taggedItem.send(new PercentType(value.intValue()));
604             } else {
605                 LOGGER.warn("Item type {} is not supported for {}. Only Number and Dimmer type are supported.",
606                         taggedItem.getBaseItem().getType(), taggedItem.getName());
607             }
608         };
609     }
610
611     private static Supplier<CompletableFuture<Double>> getTemperatureSupplier(HomekitTaggedItem taggedItem,
612             double defaultValue) {
613         return () -> {
614             final @Nullable Double value = stateAsTemperature(taggedItem.getItem().getState());
615             return CompletableFuture.completedFuture(value != null ? value : defaultValue);
616         };
617     }
618
619     private static ExceptionalConsumer<Double> setTemperatureConsumer(HomekitTaggedItem taggedItem) {
620         return (value) -> {
621             Item baseItem = taggedItem.getBaseItem();
622             if (baseItem instanceof NumberItem baseAsNumberItem) {
623                 if (baseAsNumberItem.getUnit() != null) {
624                     taggedItem.send(new QuantityType(value, SIUnits.CELSIUS));
625                 } else {
626                     taggedItem.send(new DecimalType(convertFromCelsius(value)));
627                 }
628             } else {
629                 LOGGER.warn("Item type {} is not supported for {}. Only Number type is supported.",
630                         taggedItem.getBaseItem().getType(), taggedItem.getName());
631             }
632         };
633     }
634
635     protected static Consumer<HomekitCharacteristicChangeCallback> getSubscriber(HomekitTaggedItem taggedItem,
636             HomekitCharacteristicType key, HomekitAccessoryUpdater updater) {
637         return (callback) -> updater.subscribe((GenericItem) taggedItem.getItem(), key.getTag(), callback);
638     }
639
640     protected static Runnable getUnsubscriber(HomekitTaggedItem taggedItem, HomekitCharacteristicType key,
641             HomekitAccessoryUpdater updater) {
642         return () -> updater.unsubscribe((GenericItem) taggedItem.getItem(), key.getTag());
643     }
644
645     // METHODS TO CREATE SINGLE CHARACTERISTIC FROM OPENHAB ITEM
646
647     private static ActiveCharacteristic createActiveCharacteristic(HomekitTaggedItem taggedItem,
648             HomekitAccessoryUpdater updater) {
649         var map = createMapping(taggedItem, ActiveEnum.class, false);
650         return new ActiveCharacteristic(() -> getEnumFromItem(taggedItem, map, ActiveEnum.INACTIVE),
651                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, ACTIVE, updater),
652                 getUnsubscriber(taggedItem, ACTIVE, updater));
653     }
654
655     private static ActiveIdentifierCharacteristic createActiveIdentifierCharacteristic(HomekitTaggedItem taggedItem,
656             HomekitAccessoryUpdater updater) {
657         return new ActiveIdentifierCharacteristic(getIntSupplier(taggedItem, 1), setIntConsumer(taggedItem),
658                 getSubscriber(taggedItem, ACTIVE_IDENTIFIER, updater),
659                 getUnsubscriber(taggedItem, ACTIVE_IDENTIFIER, updater));
660     }
661
662     private static BrightnessCharacteristic createBrightnessCharacteristic(HomekitTaggedItem taggedItem,
663             HomekitAccessoryUpdater updater) {
664         return new BrightnessCharacteristic(() -> {
665             int value = 0;
666             final State state = taggedItem.getItem().getState();
667             if (state instanceof HSBType stateAsHSBType) {
668                 value = stateAsHSBType.getBrightness().intValue();
669             } else if (state instanceof PercentType stateAsPercentType) {
670                 value = stateAsPercentType.intValue();
671             }
672             return CompletableFuture.completedFuture(value);
673         }, (brightness) -> {
674             if (taggedItem.getBaseItem() instanceof DimmerItem) {
675                 taggedItem.sendCommandProxy(HomekitCommandType.BRIGHTNESS_COMMAND, new PercentType(brightness));
676             } else {
677                 LOGGER.warn("Item type {} is not supported for {}. Only ColorItem and DimmerItem are supported.",
678                         taggedItem.getBaseItem().getType(), taggedItem.getName());
679             }
680         }, getSubscriber(taggedItem, BRIGHTNESS, updater), getUnsubscriber(taggedItem, BRIGHTNESS, updater));
681     }
682
683     private static CarbonDioxideLevelCharacteristic createCarbonDioxideLevelCharacteristic(HomekitTaggedItem taggedItem,
684             HomekitAccessoryUpdater updater) {
685         return new CarbonDioxideLevelCharacteristic(
686                 getDoubleSupplier(taggedItem,
687                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
688                                 CarbonDioxideLevelCharacteristic.DEFAULT_MIN_VALUE)),
689                 getSubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater),
690                 getUnsubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater));
691     }
692
693     private static CarbonDioxidePeakLevelCharacteristic createCarbonDioxidePeakLevelCharacteristic(
694             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
695         return new CarbonDioxidePeakLevelCharacteristic(
696                 getDoubleSupplier(taggedItem,
697                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
698                                 CarbonDioxidePeakLevelCharacteristic.DEFAULT_MIN_VALUE)),
699                 getSubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater),
700                 getUnsubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater));
701     }
702
703     private static CarbonMonoxideLevelCharacteristic createCarbonMonoxideLevelCharacteristic(
704             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
705         return new CarbonMonoxideLevelCharacteristic(
706                 getDoubleSupplier(taggedItem,
707                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
708                                 CarbonMonoxideLevelCharacteristic.DEFAULT_MIN_VALUE)),
709                 getSubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater),
710                 getUnsubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater));
711     }
712
713     private static CarbonMonoxidePeakLevelCharacteristic createCarbonMonoxidePeakLevelCharacteristic(
714             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
715         return new CarbonMonoxidePeakLevelCharacteristic(
716                 getDoubleSupplier(taggedItem,
717                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
718                                 CarbonMonoxidePeakLevelCharacteristic.DEFAULT_MIN_VALUE)),
719                 getSubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater),
720                 getUnsubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater));
721     }
722
723     private static ClosedCaptionsCharacteristic createClosedCaptionsCharacteristic(HomekitTaggedItem taggedItem,
724             HomekitAccessoryUpdater updater) {
725         var map = createMapping(taggedItem, ClosedCaptionsEnum.class);
726         return new ClosedCaptionsCharacteristic(() -> getEnumFromItem(taggedItem, map, ClosedCaptionsEnum.DISABLED),
727                 (value) -> setValueFromEnum(taggedItem, value, map),
728                 getSubscriber(taggedItem, CLOSED_CAPTIONS, updater),
729                 getUnsubscriber(taggedItem, CLOSED_CAPTIONS, updater));
730     }
731
732     private static ColorTemperatureCharacteristic createColorTemperatureCharacteristic(HomekitTaggedItem taggedItem,
733             HomekitAccessoryUpdater updater) {
734         final boolean inverted = taggedItem.isInverted();
735
736         int minValue = taggedItem
737                 .getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
738                         new QuantityType(ColorTemperatureCharacteristic.DEFAULT_MIN_VALUE, Units.MIRED), false)
739                 .intValue();
740         int maxValue = taggedItem
741                 .getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
742                         new QuantityType(ColorTemperatureCharacteristic.DEFAULT_MAX_VALUE, Units.MIRED), false)
743                 .intValue();
744
745         // It's common to swap these if you're providing in Kelvin instead of mired
746         if (minValue > maxValue) {
747             int temp = minValue;
748             minValue = maxValue;
749             maxValue = temp;
750         }
751
752         final int finalMinValue = minValue;
753         final int range = maxValue - minValue;
754
755         return new ColorTemperatureCharacteristic(minValue, maxValue, () -> {
756             int value = finalMinValue;
757             final State state = taggedItem.getItem().getState();
758             if (state instanceof QuantityType<?> qt) {
759                 // Number:Temperature
760                 qt = qt.toInvertibleUnit(Units.MIRED);
761                 if (qt == null) {
762                     LOGGER.warn("Item {}'s state '{}' is not convertible to mireds.", taggedItem.getName(), state);
763                 } else {
764                     value = qt.intValue();
765                 }
766             } else if (state instanceof PercentType stateAsPercentType) {
767                 double percent = stateAsPercentType.doubleValue();
768                 // invert so that 0% == coolest
769                 if (inverted) {
770                     percent = 100.0 - percent;
771                 }
772
773                 // Dimmer
774                 // scale to the originally configured range
775                 value = (int) (percent * range / 100) + finalMinValue;
776             } else if (state instanceof DecimalType stateAsDecimalType) {
777                 value = stateAsDecimalType.intValue();
778             }
779             return CompletableFuture.completedFuture(value);
780         }, (value) -> {
781             if (taggedItem.getBaseItem() instanceof DimmerItem) {
782                 // scale to a percent
783                 double percent = (((double) value) - finalMinValue) * 100 / range;
784                 if (inverted) {
785                     percent = 100.0 - percent;
786                 }
787                 taggedItem.send(new PercentType(BigDecimal.valueOf(percent)));
788             } else if (taggedItem.getBaseItem() instanceof NumberItem) {
789                 taggedItem.send(new QuantityType(value, Units.MIRED));
790             }
791         }, getSubscriber(taggedItem, COLOR_TEMPERATURE, updater),
792                 getUnsubscriber(taggedItem, COLOR_TEMPERATURE, updater));
793     }
794
795     private static ConfiguredNameCharacteristic createConfiguredNameCharacteristic(HomekitTaggedItem taggedItem,
796             HomekitAccessoryUpdater updater) {
797         return new ConfiguredNameCharacteristic(() -> {
798             final State state = taggedItem.getItem().getState();
799             return CompletableFuture
800                     .completedFuture(state instanceof UnDefType ? taggedItem.getName() : state.toString());
801         }, (value) -> ((StringItem) taggedItem.getItem()).send(new StringType(value)),
802                 getSubscriber(taggedItem, CONFIGURED_NAME, updater),
803                 getUnsubscriber(taggedItem, CONFIGURED_NAME, updater));
804     }
805
806     private static CoolingThresholdTemperatureCharacteristic createCoolingThresholdCharacteristic(
807             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
808         double minValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
809                 Objects.requireNonNull(
810                         new QuantityType(CoolingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
811                                 .toUnit(getSystemTemperatureUnit())),
812                 false).toUnit(SIUnits.CELSIUS).doubleValue();
813         double maxValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
814                 Objects.requireNonNull(
815                         new QuantityType(CoolingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
816                                 .toUnit(getSystemTemperatureUnit())),
817                 false).toUnit(SIUnits.CELSIUS).doubleValue();
818         double step = taggedItem
819                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
820                         Objects.requireNonNull(new QuantityType(CoolingThresholdTemperatureCharacteristic.DEFAULT_STEP,
821                                 SIUnits.CELSIUS).toUnit(getSystemTemperatureUnit())),
822                         true)
823                 .toUnit(SIUnits.CELSIUS).doubleValue();
824         return new CoolingThresholdTemperatureCharacteristic(minValue, maxValue, step,
825                 getTemperatureSupplier(taggedItem, minValue), setTemperatureConsumer(taggedItem),
826                 getSubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater),
827                 getUnsubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater));
828     }
829
830     private static CurrentDoorStateCharacteristic createCurrentDoorStateCharacteristic(HomekitTaggedItem taggedItem,
831             HomekitAccessoryUpdater updater) {
832         List<CurrentDoorStateEnum> validValues = new ArrayList<>();
833         var map = createMapping(taggedItem, CurrentDoorStateEnum.class, validValues);
834         return new CurrentDoorStateCharacteristic(() -> getEnumFromItem(taggedItem, map, CurrentDoorStateEnum.CLOSED),
835                 getSubscriber(taggedItem, CURRENT_DOOR_STATE, updater),
836                 getUnsubscriber(taggedItem, CURRENT_DOOR_STATE, updater));
837     }
838
839     private static CurrentHeatingCoolingStateCharacteristic createCurrentHeatingCoolingStateCharacteristic(
840             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
841         List<CurrentHeatingCoolingStateEnum> validValues = new ArrayList<>();
842         var map = createMapping(taggedItem, CurrentHeatingCoolingStateEnum.class, validValues);
843         return new CurrentHeatingCoolingStateCharacteristic(validValues.toArray(new CurrentHeatingCoolingStateEnum[0]),
844                 () -> getEnumFromItem(taggedItem, map, CurrentHeatingCoolingStateEnum.OFF),
845                 getSubscriber(taggedItem, CURRENT_HEATING_COOLING_STATE, updater),
846                 getUnsubscriber(taggedItem, CURRENT_HEATING_COOLING_STATE, updater));
847     }
848
849     private static CurrentFanStateCharacteristic createCurrentFanStateCharacteristic(HomekitTaggedItem taggedItem,
850             HomekitAccessoryUpdater updater) {
851         var map = createMapping(taggedItem, CurrentFanStateEnum.class);
852         return new CurrentFanStateCharacteristic(() -> getEnumFromItem(taggedItem, map, CurrentFanStateEnum.INACTIVE),
853                 getSubscriber(taggedItem, CURRENT_FAN_STATE, updater),
854                 getUnsubscriber(taggedItem, CURRENT_FAN_STATE, updater));
855     }
856
857     private static CurrentHorizontalTiltAngleCharacteristic createCurrentHorizontalTiltAngleCharacteristic(
858             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
859         return new CurrentHorizontalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
860                 getSubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater),
861                 getUnsubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater));
862     }
863
864     private static CurrentMediaStateCharacteristic createCurrentMediaStateCharacteristic(HomekitTaggedItem taggedItem,
865             HomekitAccessoryUpdater updater) {
866         var map = createMapping(taggedItem, CurrentMediaStateEnum.class);
867         return new CurrentMediaStateCharacteristic(
868                 () -> getEnumFromItem(taggedItem, map, CurrentMediaStateEnum.UNKNOWN),
869                 getSubscriber(taggedItem, CURRENT_MEDIA_STATE, updater),
870                 getUnsubscriber(taggedItem, CURRENT_MEDIA_STATE, updater));
871     }
872
873     private static CurrentTemperatureCharacteristic createCurrentTemperatureCharacteristic(HomekitTaggedItem taggedItem,
874             HomekitAccessoryUpdater updater) {
875         double minValue = taggedItem
876                 .getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
877                         Objects.requireNonNull(
878                                 new QuantityType(CurrentTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
879                                         .toUnit(getSystemTemperatureUnit())),
880                         false)
881                 .toUnit(SIUnits.CELSIUS).doubleValue();
882         double maxValue = taggedItem
883                 .getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
884                         Objects.requireNonNull(
885                                 new QuantityType(CurrentTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
886                                         .toUnit(getSystemTemperatureUnit())),
887                         false)
888                 .toUnit(SIUnits.CELSIUS).doubleValue();
889         double step = taggedItem
890                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
891                         Objects.requireNonNull(
892                                 new QuantityType(CurrentTemperatureCharacteristic.DEFAULT_STEP, SIUnits.CELSIUS)
893                                         .toUnit(getSystemTemperatureUnit())),
894                         true)
895                 .toUnit(SIUnits.CELSIUS).doubleValue();
896         return new CurrentTemperatureCharacteristic(minValue, maxValue, step,
897                 getTemperatureSupplier(taggedItem, minValue), getSubscriber(taggedItem, TARGET_TEMPERATURE, updater),
898                 getUnsubscriber(taggedItem, TARGET_TEMPERATURE, updater));
899     }
900
901     private static CurrentTiltAngleCharacteristic createCurrentTiltAngleCharacteristic(HomekitTaggedItem taggedItem,
902             HomekitAccessoryUpdater updater) {
903         return new CurrentTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
904                 getSubscriber(taggedItem, CURRENT_TILT_ANGLE, updater),
905                 getUnsubscriber(taggedItem, CURRENT_TILT_ANGLE, updater));
906     }
907
908     private static CurrentVerticalTiltAngleCharacteristic createCurrentVerticalTiltAngleCharacteristic(
909             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
910         return new CurrentVerticalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
911                 getSubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater),
912                 getUnsubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater));
913     }
914
915     private static CurrentVisibilityStateCharacteristic createCurrentVisibilityStateCharacteristic(
916             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
917         var map = createMapping(taggedItem, CurrentVisibilityStateEnum.class, true);
918         return new CurrentVisibilityStateCharacteristic(
919                 () -> getEnumFromItem(taggedItem, map, CurrentVisibilityStateEnum.HIDDEN),
920                 getSubscriber(taggedItem, CURRENT_VISIBILITY, updater),
921                 getUnsubscriber(taggedItem, CURRENT_VISIBILITY, updater));
922     }
923
924     private static SetDurationCharacteristic createDurationCharacteristic(HomekitTaggedItem taggedItem,
925             HomekitAccessoryUpdater updater) {
926         return new SetDurationCharacteristic(() -> {
927             int value = getIntFromItem(taggedItem, 0);
928             final @Nullable Map<String, Object> itemConfiguration = taggedItem.getConfiguration();
929             if ((value == 0) && (itemConfiguration != null)) { // check for default duration
930                 final Object duration = itemConfiguration.get(HomekitValveImpl.CONFIG_DEFAULT_DURATION);
931                 if (duration instanceof BigDecimal durationAsBigDecimal) {
932                     value = durationAsBigDecimal.intValue();
933                     if (taggedItem.getItem() instanceof NumberItem taggedNumberItem) {
934                         taggedNumberItem.setState(new DecimalType(value));
935                     }
936                 }
937             }
938             return CompletableFuture.completedFuture(value);
939         }, setIntConsumer(taggedItem), getSubscriber(taggedItem, DURATION, updater),
940                 getUnsubscriber(taggedItem, DURATION, updater));
941     }
942
943     private static FilterLifeLevelCharacteristic createFilterLifeLevelCharacteristic(HomekitTaggedItem taggedItem,
944             HomekitAccessoryUpdater updater) {
945         return new FilterLifeLevelCharacteristic(getDoubleSupplier(taggedItem, 0),
946                 getSubscriber(taggedItem, FILTER_LIFE_LEVEL, updater),
947                 getUnsubscriber(taggedItem, FILTER_LIFE_LEVEL, updater));
948     }
949
950     private static ResetFilterIndicationCharacteristic createFilterResetCharacteristic(HomekitTaggedItem taggedItem,
951             HomekitAccessoryUpdater updater) {
952         return new ResetFilterIndicationCharacteristic(
953                 (value) -> ((SwitchItem) taggedItem.getBaseItem()).send(OnOffType.ON));
954     }
955
956     private static FirmwareRevisionCharacteristic createFirmwareRevisionCharacteristic(HomekitTaggedItem taggedItem,
957             HomekitAccessoryUpdater updater) {
958         return new FirmwareRevisionCharacteristic(() -> {
959             final State state = taggedItem.getItem().getState();
960             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
961         });
962     }
963
964     private static HardwareRevisionCharacteristic createHardwareRevisionCharacteristic(HomekitTaggedItem taggedItem,
965             HomekitAccessoryUpdater updater) {
966         return new HardwareRevisionCharacteristic(() -> {
967             final State state = taggedItem.getItem().getState();
968             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
969         });
970     }
971
972     private static HeatingThresholdTemperatureCharacteristic createHeatingThresholdCharacteristic(
973             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
974         double minValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
975                 Objects.requireNonNull(
976                         new QuantityType(HeatingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
977                                 .toUnit(getSystemTemperatureUnit())),
978                 false).toUnit(SIUnits.CELSIUS).doubleValue();
979         double maxValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
980                 Objects.requireNonNull(
981                         new QuantityType(HeatingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
982                                 .toUnit(getSystemTemperatureUnit())),
983                 false).toUnit(SIUnits.CELSIUS).doubleValue();
984         double step = taggedItem
985                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
986                         Objects.requireNonNull(new QuantityType(HeatingThresholdTemperatureCharacteristic.DEFAULT_STEP,
987                                 SIUnits.CELSIUS).toUnit(getSystemTemperatureUnit())),
988                         true)
989                 .toUnit(SIUnits.CELSIUS).doubleValue();
990         return new HeatingThresholdTemperatureCharacteristic(minValue, maxValue, step,
991                 getTemperatureSupplier(taggedItem, minValue), setTemperatureConsumer(taggedItem),
992                 getSubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater),
993                 getUnsubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater));
994     }
995
996     private static HoldPositionCharacteristic createHoldPositionCharacteristic(HomekitTaggedItem taggedItem,
997             HomekitAccessoryUpdater updater) {
998         final Item item = taggedItem.getBaseItem();
999         if (!(item instanceof SwitchItem || item instanceof RollershutterItem)) {
1000             LOGGER.warn(
1001                     "Item {} cannot be used for the HoldPosition characteristic; only SwitchItem and RollershutterItem are supported. Hold requests will be ignored.",
1002                     item.getName());
1003         }
1004
1005         return new HoldPositionCharacteristic(value -> {
1006             if (!value) {
1007                 return;
1008             }
1009
1010             if (item instanceof SwitchItem switchItem) {
1011                 switchItem.send(OnOffType.ON);
1012             } else if (item instanceof RollershutterItem rollershutterItem) {
1013                 rollershutterItem.send(StopMoveType.STOP);
1014             }
1015         });
1016     }
1017
1018     private static HueCharacteristic createHueCharacteristic(HomekitTaggedItem taggedItem,
1019             HomekitAccessoryUpdater updater) {
1020         return new HueCharacteristic(() -> {
1021             double value = 0.0;
1022             State state = taggedItem.getItem().getState();
1023             if (state instanceof HSBType stateAsHSBType) {
1024                 value = stateAsHSBType.getHue().doubleValue();
1025             }
1026             return CompletableFuture.completedFuture(value);
1027         }, (hue) -> {
1028             if (taggedItem.getBaseItem() instanceof ColorItem) {
1029                 taggedItem.sendCommandProxy(HomekitCommandType.HUE_COMMAND, new DecimalType(hue));
1030             } else {
1031                 LOGGER.warn("Item type {} is not supported for {}. Only Color type is supported.",
1032                         taggedItem.getBaseItem().getType(), taggedItem.getName());
1033             }
1034         }, getSubscriber(taggedItem, HUE, updater), getUnsubscriber(taggedItem, HUE, updater));
1035     }
1036
1037     private static IdentifierCharacteristic createIdentifierCharacteristic(HomekitTaggedItem taggedItem,
1038             HomekitAccessoryUpdater updater) {
1039         return new IdentifierCharacteristic(getIntSupplier(taggedItem, 1));
1040     }
1041
1042     private static IdentifyCharacteristic createIdentifyCharacteristic(HomekitTaggedItem taggedItem,
1043             HomekitAccessoryUpdater updater) {
1044         return new IdentifyCharacteristic((value) -> ((SwitchItem) taggedItem.getBaseItem()).send(OnOffType.ON));
1045     }
1046
1047     private static InputDeviceTypeCharacteristic createInputDeviceTypeCharacteristic(HomekitTaggedItem taggedItem,
1048             HomekitAccessoryUpdater updater) {
1049         var map = createMapping(taggedItem, InputDeviceTypeEnum.class);
1050         return new InputDeviceTypeCharacteristic(() -> getEnumFromItem(taggedItem, map, InputDeviceTypeEnum.OTHER),
1051                 getSubscriber(taggedItem, INPUT_DEVICE_TYPE, updater),
1052                 getUnsubscriber(taggedItem, INPUT_DEVICE_TYPE, updater));
1053     }
1054
1055     private static InputSourceTypeCharacteristic createInputSourceTypeCharacteristic(HomekitTaggedItem taggedItem,
1056             HomekitAccessoryUpdater updater) {
1057         var map = createMapping(taggedItem, InputSourceTypeEnum.class);
1058         return new InputSourceTypeCharacteristic(() -> getEnumFromItem(taggedItem, map, InputSourceTypeEnum.OTHER),
1059                 getSubscriber(taggedItem, INPUT_SOURCE_TYPE, updater),
1060                 getUnsubscriber(taggedItem, INPUT_SOURCE_TYPE, updater));
1061     }
1062
1063     private static IsConfiguredCharacteristic createIsConfiguredCharacteristic(HomekitTaggedItem taggedItem,
1064             HomekitAccessoryUpdater updater) {
1065         var map = createMapping(taggedItem, IsConfiguredEnum.class);
1066         return new IsConfiguredCharacteristic(() -> getEnumFromItem(taggedItem, map, IsConfiguredEnum.NOT_CONFIGURED),
1067                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, CONFIGURED, updater),
1068                 getUnsubscriber(taggedItem, CONFIGURED, updater));
1069     }
1070
1071     private static LockPhysicalControlsCharacteristic createLockPhysicalControlsCharacteristic(
1072             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1073         var map = createMapping(taggedItem, LockPhysicalControlsEnum.class);
1074         return new LockPhysicalControlsCharacteristic(
1075                 () -> getEnumFromItem(taggedItem, map, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED),
1076                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, LOCK_CONTROL, updater),
1077                 getUnsubscriber(taggedItem, LOCK_CONTROL, updater));
1078     }
1079
1080     private static ManufacturerCharacteristic createManufacturerCharacteristic(HomekitTaggedItem taggedItem,
1081             HomekitAccessoryUpdater updater) {
1082         return new ManufacturerCharacteristic(() -> {
1083             final State state = taggedItem.getItem().getState();
1084             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1085         });
1086     }
1087
1088     private static ModelCharacteristic createModelCharacteristic(HomekitTaggedItem taggedItem,
1089             HomekitAccessoryUpdater updater) {
1090         return new ModelCharacteristic(() -> {
1091             final State state = taggedItem.getItem().getState();
1092             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1093         });
1094     }
1095
1096     private static MuteCharacteristic createMuteCharacteristic(HomekitTaggedItem taggedItem,
1097             HomekitAccessoryUpdater updater) {
1098         BooleanItemReader muteReader = new BooleanItemReader(taggedItem.getItem(),
1099                 OnOffType.from(!taggedItem.isInverted()),
1100                 taggedItem.isInverted() ? OpenClosedType.CLOSED : OpenClosedType.OPEN);
1101         return new MuteCharacteristic(() -> CompletableFuture.completedFuture(muteReader.getValue()),
1102                 (value) -> taggedItem.send(OnOffType.from(value)), getSubscriber(taggedItem, MUTE, updater),
1103                 getUnsubscriber(taggedItem, MUTE, updater));
1104     }
1105
1106     private static NameCharacteristic createNameCharacteristic(HomekitTaggedItem taggedItem,
1107             HomekitAccessoryUpdater updater) {
1108         return new NameCharacteristic(() -> {
1109             final State state = taggedItem.getItem().getState();
1110             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1111         });
1112     }
1113
1114     private static NitrogenDioxideDensityCharacteristic createNitrogenDioxideDensityCharacteristic(
1115             final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1116         return new NitrogenDioxideDensityCharacteristic(
1117                 getDoubleSupplier(taggedItem,
1118                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1119                                 NitrogenDioxideDensityCharacteristic.DEFAULT_MIN_VALUE)),
1120                 getSubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater),
1121                 getUnsubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater));
1122     }
1123
1124     private static ObstructionDetectedCharacteristic createObstructionDetectedCharacteristic(
1125             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1126         return new ObstructionDetectedCharacteristic(
1127                 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
1128                         || taggedItem.getItem().getState() == OpenClosedType.OPEN),
1129                 getSubscriber(taggedItem, OBSTRUCTION_STATUS, updater),
1130                 getUnsubscriber(taggedItem, OBSTRUCTION_STATUS, updater));
1131     }
1132
1133     private static OzoneDensityCharacteristic createOzoneDensityCharacteristic(final HomekitTaggedItem taggedItem,
1134             HomekitAccessoryUpdater updater) {
1135         return new OzoneDensityCharacteristic(
1136                 getDoubleSupplier(taggedItem,
1137                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1138                                 OzoneDensityCharacteristic.DEFAULT_MIN_VALUE)),
1139                 getSubscriber(taggedItem, OZONE_DENSITY, updater), getUnsubscriber(taggedItem, OZONE_DENSITY, updater));
1140     }
1141
1142     private static PM10DensityCharacteristic createPM10DensityCharacteristic(final HomekitTaggedItem taggedItem,
1143             HomekitAccessoryUpdater updater) {
1144         return new PM10DensityCharacteristic(
1145                 getDoubleSupplier(taggedItem,
1146                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1147                                 PM10DensityCharacteristic.DEFAULT_MIN_VALUE)),
1148                 getSubscriber(taggedItem, PM10_DENSITY, updater), getUnsubscriber(taggedItem, PM10_DENSITY, updater));
1149     }
1150
1151     private static PM25DensityCharacteristic createPM25DensityCharacteristic(final HomekitTaggedItem taggedItem,
1152             HomekitAccessoryUpdater updater) {
1153         return new PM25DensityCharacteristic(
1154                 getDoubleSupplier(taggedItem,
1155                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1156                                 PM25DensityCharacteristic.DEFAULT_MIN_VALUE)),
1157                 getSubscriber(taggedItem, PM25_DENSITY, updater), getUnsubscriber(taggedItem, PM25_DENSITY, updater));
1158     }
1159
1160     private static CurrentRelativeHumidityCharacteristic createRelativeHumidityCharacteristic(
1161             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1162         return new CurrentRelativeHumidityCharacteristic(getDoubleSupplier(taggedItem, 0.0),
1163                 getSubscriber(taggedItem, RELATIVE_HUMIDITY, updater),
1164                 getUnsubscriber(taggedItem, RELATIVE_HUMIDITY, updater));
1165     }
1166
1167     private static PictureModeCharacteristic createPictureModeCharacteristic(HomekitTaggedItem taggedItem,
1168             HomekitAccessoryUpdater updater) {
1169         var map = createMapping(taggedItem, PictureModeEnum.class);
1170         return new PictureModeCharacteristic(() -> getEnumFromItem(taggedItem, map, PictureModeEnum.OTHER),
1171                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, PICTURE_MODE, updater),
1172                 getUnsubscriber(taggedItem, PICTURE_MODE, updater));
1173     }
1174
1175     private static PowerModeCharacteristic createPowerModeCharacteristic(HomekitTaggedItem taggedItem,
1176             HomekitAccessoryUpdater updater) {
1177         var map = createMapping(taggedItem, PowerModeEnum.class, true);
1178         return new PowerModeCharacteristic((value) -> setValueFromEnum(taggedItem, value, map));
1179     }
1180
1181     // this characteristic is unique in a few ways, so we can't use the "normal" helpers:
1182     // * you don't return a "current" value, just the value of the most recent event
1183     // * NULL/invalid values are very much expected, and should silently _not_ trigger an event
1184     // * every update to the item should trigger an event, not just changes
1185
1186     private static ProgrammableSwitchEventCharacteristic createProgrammableSwitchEventCharacteristic(
1187             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1188         // have to build the map custom, since SINGLE_PRESS starts at 0
1189         Map<ProgrammableSwitchEnum, String> map = new EnumMap(ProgrammableSwitchEnum.class);
1190         List<ProgrammableSwitchEnum> validValues = new ArrayList<>();
1191
1192         if (taggedItem.getBaseItem().getAcceptedDataTypes().contains(OnOffType.class)) {
1193             map.put(ProgrammableSwitchEnum.SINGLE_PRESS, OnOffType.ON.toString());
1194             validValues.add(ProgrammableSwitchEnum.SINGLE_PRESS);
1195         } else if (taggedItem.getBaseItem().getAcceptedDataTypes().contains(OpenClosedType.class)) {
1196             map.put(ProgrammableSwitchEnum.SINGLE_PRESS, OpenClosedType.OPEN.toString());
1197             validValues.add(ProgrammableSwitchEnum.SINGLE_PRESS);
1198         } else {
1199             map = createMapping(taggedItem, ProgrammableSwitchEnum.class, validValues, false);
1200         }
1201
1202         var helper = new ProgrammableSwitchEventCharacteristicHelper(taggedItem, updater, map);
1203
1204         return new ProgrammableSwitchEventCharacteristic(validValues.toArray(new ProgrammableSwitchEnum[0]),
1205                 helper::getValue, helper::subscribe, getUnsubscriber(taggedItem, PROGRAMMABLE_SWITCH_EVENT, updater));
1206     }
1207
1208     private static class ProgrammableSwitchEventCharacteristicHelper {
1209         private @Nullable ProgrammableSwitchEnum lastValue = null;
1210         private final HomekitTaggedItem taggedItem;
1211         private final Map<ProgrammableSwitchEnum, String> map;
1212         private final HomekitAccessoryUpdater updater;
1213
1214         ProgrammableSwitchEventCharacteristicHelper(HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater,
1215                 Map<ProgrammableSwitchEnum, String> map) {
1216             this.taggedItem = taggedItem;
1217             this.map = map;
1218             this.updater = updater;
1219         }
1220
1221         public CompletableFuture<ProgrammableSwitchEnum> getValue() {
1222             return CompletableFuture.completedFuture(lastValue);
1223         }
1224
1225         public void subscribe(HomekitCharacteristicChangeCallback cb) {
1226             updater.subscribeToUpdates((GenericItem) taggedItem.getItem(), PROGRAMMABLE_SWITCH_EVENT.getTag(),
1227                     state -> {
1228                         // perform inversion here, so logic below only needs to deal with the
1229                         // canonical style
1230                         if (state instanceof OnOffType && taggedItem.isInverted()) {
1231                             if (state.equals(OnOffType.ON)) {
1232                                 state = OnOffType.OFF;
1233                             } else {
1234                                 state = OnOffType.ON;
1235                             }
1236                         } else if (state instanceof OpenClosedType && taggedItem.isInverted()) {
1237                             if (state.equals(OpenClosedType.OPEN)) {
1238                                 state = OpenClosedType.CLOSED;
1239                             } else {
1240                                 state = OpenClosedType.OPEN;
1241                             }
1242                         }
1243                         // if "not pressed", don't send an event
1244                         if (state instanceof UnDefType || (state instanceof OnOffType && state.equals(OnOffType.OFF))
1245                                 || (state instanceof OpenClosedType && state.equals(OpenClosedType.CLOSED))) {
1246                             lastValue = null;
1247                             return;
1248                         }
1249                         lastValue = getKeyFromMapping(taggedItem, state, map, ProgrammableSwitchEnum.SINGLE_PRESS);
1250                         cb.changed();
1251                     });
1252         }
1253     }
1254
1255     private static RemainingDurationCharacteristic createRemainingDurationCharacteristic(HomekitTaggedItem taggedItem,
1256             HomekitAccessoryUpdater updater) {
1257         return new RemainingDurationCharacteristic(getIntSupplier(taggedItem, 0),
1258                 getSubscriber(taggedItem, REMAINING_DURATION, updater),
1259                 getUnsubscriber(taggedItem, REMAINING_DURATION, updater));
1260     }
1261
1262     private static RemoteKeyCharacteristic createRemoteKeyCharacteristic(HomekitTaggedItem taggedItem,
1263             HomekitAccessoryUpdater updater) {
1264         var map = createMapping(taggedItem, RemoteKeyEnum.class);
1265         return new RemoteKeyCharacteristic((value) -> setValueFromEnum(taggedItem, value, map));
1266     }
1267
1268     private static RotationDirectionCharacteristic createRotationDirectionCharacteristic(HomekitTaggedItem taggedItem,
1269             HomekitAccessoryUpdater updater) {
1270         var map = createMapping(taggedItem, RotationDirectionEnum.class);
1271         return new RotationDirectionCharacteristic(
1272                 () -> getEnumFromItem(taggedItem, map, RotationDirectionEnum.CLOCKWISE),
1273                 (value) -> setValueFromEnum(taggedItem, value, map),
1274                 getSubscriber(taggedItem, ROTATION_DIRECTION, updater),
1275                 getUnsubscriber(taggedItem, ROTATION_DIRECTION, updater));
1276     }
1277
1278     private static RotationSpeedCharacteristic createRotationSpeedCharacteristic(HomekitTaggedItem item,
1279             HomekitAccessoryUpdater updater) {
1280         return new RotationSpeedCharacteristic(
1281                 item.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1282                         RotationSpeedCharacteristic.DEFAULT_MIN_VALUE),
1283                 item.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
1284                         RotationSpeedCharacteristic.DEFAULT_MAX_VALUE),
1285                 item.getConfigurationAsDouble(HomekitTaggedItem.STEP, RotationSpeedCharacteristic.DEFAULT_STEP),
1286                 getDoubleSupplier(item, 0), setDoubleConsumer(item), getSubscriber(item, ROTATION_SPEED, updater),
1287                 getUnsubscriber(item, ROTATION_SPEED, updater));
1288     }
1289
1290     private static SaturationCharacteristic createSaturationCharacteristic(HomekitTaggedItem taggedItem,
1291             HomekitAccessoryUpdater updater) {
1292         return new SaturationCharacteristic(() -> {
1293             double value = 0.0;
1294             State state = taggedItem.getItem().getState();
1295             if (state instanceof HSBType stateAsHSBType) {
1296                 value = stateAsHSBType.getSaturation().doubleValue();
1297             } else if (state instanceof PercentType stateAsPercentType) {
1298                 value = stateAsPercentType.doubleValue();
1299             }
1300             return CompletableFuture.completedFuture(value);
1301         }, (saturation) -> {
1302             if (taggedItem.getBaseItem() instanceof ColorItem) {
1303                 taggedItem.sendCommandProxy(HomekitCommandType.SATURATION_COMMAND,
1304                         new PercentType(saturation.intValue()));
1305             } else {
1306                 LOGGER.warn("Item type {} is not supported for {}. Only Color type is supported.",
1307                         taggedItem.getBaseItem().getType(), taggedItem.getName());
1308             }
1309         }, getSubscriber(taggedItem, SATURATION, updater), getUnsubscriber(taggedItem, SATURATION, updater));
1310     }
1311
1312     private static SerialNumberCharacteristic createSerialNumberCharacteristic(HomekitTaggedItem taggedItem,
1313             HomekitAccessoryUpdater updater) {
1314         return new SerialNumberCharacteristic(() -> {
1315             final State state = taggedItem.getItem().getState();
1316             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1317         });
1318     }
1319
1320     private static SleepDiscoveryModeCharacteristic createSleepDiscoveryModeCharacteristic(HomekitTaggedItem taggedItem,
1321             HomekitAccessoryUpdater updater) {
1322         var map = createMapping(taggedItem, SleepDiscoveryModeEnum.class);
1323         return new SleepDiscoveryModeCharacteristic(
1324                 () -> getEnumFromItem(taggedItem, map, SleepDiscoveryModeEnum.ALWAYS_DISCOVERABLE),
1325                 getSubscriber(taggedItem, SLEEP_DISCOVERY_MODE, updater),
1326                 getUnsubscriber(taggedItem, SLEEP_DISCOVERY_MODE, updater));
1327     }
1328
1329     private static StatusActiveCharacteristic createStatusActiveCharacteristic(HomekitTaggedItem taggedItem,
1330             HomekitAccessoryUpdater updater) {
1331         return new StatusActiveCharacteristic(
1332                 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
1333                         || taggedItem.getItem().getState() == OpenClosedType.OPEN),
1334                 getSubscriber(taggedItem, ACTIVE_STATUS, updater), getUnsubscriber(taggedItem, ACTIVE_STATUS, updater));
1335     }
1336
1337     private static StatusFaultCharacteristic createStatusFaultCharacteristic(HomekitTaggedItem taggedItem,
1338             HomekitAccessoryUpdater updater) {
1339         var map = createMapping(taggedItem, StatusFaultEnum.class);
1340         return new StatusFaultCharacteristic(() -> getEnumFromItem(taggedItem, map, StatusFaultEnum.NO_FAULT),
1341                 getSubscriber(taggedItem, FAULT_STATUS, updater), getUnsubscriber(taggedItem, FAULT_STATUS, updater));
1342     }
1343
1344     private static StatusLowBatteryCharacteristic createStatusLowBatteryCharacteristic(HomekitTaggedItem taggedItem,
1345             HomekitAccessoryUpdater updater) {
1346         BigDecimal lowThreshold = taggedItem.getConfiguration(HomekitTaggedItem.BATTERY_LOW_THRESHOLD,
1347                 BigDecimal.valueOf(20));
1348         BooleanItemReader lowBatteryReader = new BooleanItemReader(taggedItem.getItem(),
1349                 OnOffType.from(!taggedItem.isInverted()),
1350                 taggedItem.isInverted() ? OpenClosedType.CLOSED : OpenClosedType.OPEN, lowThreshold, true);
1351         return new StatusLowBatteryCharacteristic(
1352                 () -> CompletableFuture.completedFuture(
1353                         lowBatteryReader.getValue() ? StatusLowBatteryEnum.LOW : StatusLowBatteryEnum.NORMAL),
1354                 getSubscriber(taggedItem, BATTERY_LOW_STATUS, updater),
1355                 getUnsubscriber(taggedItem, BATTERY_LOW_STATUS, updater));
1356     }
1357
1358     private static StatusTamperedCharacteristic createStatusTamperedCharacteristic(HomekitTaggedItem taggedItem,
1359             HomekitAccessoryUpdater updater) {
1360         var map = createMapping(taggedItem, StatusTamperedEnum.class);
1361         return new StatusTamperedCharacteristic(() -> getEnumFromItem(taggedItem, map, StatusTamperedEnum.NOT_TAMPERED),
1362                 getSubscriber(taggedItem, TAMPERED_STATUS, updater),
1363                 getUnsubscriber(taggedItem, TAMPERED_STATUS, updater));
1364     }
1365
1366     private static SulphurDioxideDensityCharacteristic createSulphurDioxideDensityCharacteristic(
1367             final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1368         return new SulphurDioxideDensityCharacteristic(
1369                 getDoubleSupplier(taggedItem,
1370                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1371                                 SulphurDioxideDensityCharacteristic.DEFAULT_MIN_VALUE)),
1372                 getSubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater),
1373                 getUnsubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater));
1374     }
1375
1376     private static SwingModeCharacteristic createSwingModeCharacteristic(HomekitTaggedItem taggedItem,
1377             HomekitAccessoryUpdater updater) {
1378         var map = createMapping(taggedItem, SwingModeEnum.class);
1379         return new SwingModeCharacteristic(() -> getEnumFromItem(taggedItem, map, SwingModeEnum.SWING_DISABLED),
1380                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, SWING_MODE, updater),
1381                 getUnsubscriber(taggedItem, SWING_MODE, updater));
1382     }
1383
1384     private static TargetDoorStateCharacteristic createTargetDoorStateCharacteristic(HomekitTaggedItem taggedItem,
1385             HomekitAccessoryUpdater updater) {
1386         List<TargetDoorStateEnum> validValues = new ArrayList<>();
1387         var map = createMapping(taggedItem, TargetDoorStateEnum.class, validValues);
1388         return new TargetDoorStateCharacteristic(() -> getEnumFromItem(taggedItem, map, TargetDoorStateEnum.CLOSED),
1389                 (targetState) -> setValueFromEnum(taggedItem, targetState, map),
1390                 getSubscriber(taggedItem, TARGET_DOOR_STATE, updater),
1391                 getUnsubscriber(taggedItem, TARGET_DOOR_STATE, updater));
1392     }
1393
1394     private static TargetFanStateCharacteristic createTargetFanStateCharacteristic(HomekitTaggedItem taggedItem,
1395             HomekitAccessoryUpdater updater) {
1396         var map = createMapping(taggedItem, TargetFanStateEnum.class);
1397         return new TargetFanStateCharacteristic(() -> getEnumFromItem(taggedItem, map, TargetFanStateEnum.AUTO),
1398                 (targetState) -> setValueFromEnum(taggedItem, targetState, map),
1399                 getSubscriber(taggedItem, TARGET_FAN_STATE, updater),
1400                 getUnsubscriber(taggedItem, TARGET_FAN_STATE, updater));
1401     }
1402
1403     private static TargetHeatingCoolingStateCharacteristic createTargetHeatingCoolingStateCharacteristic(
1404             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1405         List<TargetHeatingCoolingStateEnum> validValues = new ArrayList<>();
1406         var map = createMapping(taggedItem, TargetHeatingCoolingStateEnum.class, validValues);
1407         return new TargetHeatingCoolingStateCharacteristic(validValues.toArray(new TargetHeatingCoolingStateEnum[0]),
1408                 () -> getEnumFromItem(taggedItem, map, TargetHeatingCoolingStateEnum.OFF),
1409                 (value) -> setValueFromEnum(taggedItem, value, map),
1410                 getSubscriber(taggedItem, TARGET_HEATING_COOLING_STATE, updater),
1411                 getUnsubscriber(taggedItem, TARGET_HEATING_COOLING_STATE, updater));
1412     }
1413
1414     private static TargetHorizontalTiltAngleCharacteristic createTargetHorizontalTiltAngleCharacteristic(
1415             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1416         return new TargetHorizontalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
1417                 setAngleConsumer(taggedItem), getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
1418                 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
1419     }
1420
1421     private static TargetMediaStateCharacteristic createTargetMediaStateCharacteristic(HomekitTaggedItem taggedItem,
1422             HomekitAccessoryUpdater updater) {
1423         var map = createMapping(taggedItem, TargetMediaStateEnum.class);
1424         return new TargetMediaStateCharacteristic(() -> getEnumFromItem(taggedItem, map, TargetMediaStateEnum.STOP),
1425                 (value) -> setValueFromEnum(taggedItem, value, map),
1426                 getSubscriber(taggedItem, TARGET_MEDIA_STATE, updater),
1427                 getUnsubscriber(taggedItem, TARGET_MEDIA_STATE, updater));
1428     }
1429
1430     private static TargetRelativeHumidityCharacteristic createTargetRelativeHumidityCharacteristic(
1431             HomekitTaggedItem item, HomekitAccessoryUpdater updater) {
1432         return new TargetRelativeHumidityCharacteristic(getDoubleSupplier(item, 0), setDoubleConsumer(item),
1433                 getSubscriber(item, TARGET_RELATIVE_HUMIDITY, updater),
1434                 getUnsubscriber(item, TARGET_RELATIVE_HUMIDITY, updater));
1435     }
1436
1437     private static TargetTemperatureCharacteristic createTargetTemperatureCharacteristic(HomekitTaggedItem taggedItem,
1438             HomekitAccessoryUpdater updater) {
1439         double minValue = taggedItem
1440                 .getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
1441                         Objects.requireNonNull(
1442                                 new QuantityType(TargetTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
1443                                         .toUnit(getSystemTemperatureUnit())),
1444                         false)
1445                 .toUnit(SIUnits.CELSIUS).doubleValue();
1446         double maxValue = taggedItem
1447                 .getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
1448                         Objects.requireNonNull(
1449                                 new QuantityType(TargetTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
1450                                         .toUnit(getSystemTemperatureUnit())),
1451                         false)
1452                 .toUnit(SIUnits.CELSIUS).doubleValue();
1453         double step = taggedItem
1454                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
1455                         Objects.requireNonNull(
1456                                 new QuantityType(TargetTemperatureCharacteristic.DEFAULT_STEP, SIUnits.CELSIUS)
1457                                         .toUnit(getSystemTemperatureUnit())),
1458                         true)
1459                 .toUnit(SIUnits.CELSIUS).doubleValue();
1460         return new TargetTemperatureCharacteristic(minValue, maxValue, step,
1461                 getTemperatureSupplier(taggedItem, minValue), setTemperatureConsumer(taggedItem),
1462                 getSubscriber(taggedItem, TARGET_TEMPERATURE, updater),
1463                 getUnsubscriber(taggedItem, TARGET_TEMPERATURE, updater));
1464     }
1465
1466     private static TargetTiltAngleCharacteristic createTargetTiltAngleCharacteristic(HomekitTaggedItem taggedItem,
1467             HomekitAccessoryUpdater updater) {
1468         return new TargetTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0), setAngleConsumer(taggedItem),
1469                 getSubscriber(taggedItem, TARGET_TILT_ANGLE, updater),
1470                 getUnsubscriber(taggedItem, TARGET_TILT_ANGLE, updater));
1471     }
1472
1473     private static TargetVerticalTiltAngleCharacteristic createTargetVerticalTiltAngleCharacteristic(
1474             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1475         return new TargetVerticalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0), setAngleConsumer(taggedItem),
1476                 getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
1477                 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
1478     }
1479
1480     private static TargetVisibilityStateCharacteristic createTargetVisibilityStateCharacteristic(
1481             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1482         var map = createMapping(taggedItem, TargetVisibilityStateEnum.class, true);
1483         return new TargetVisibilityStateCharacteristic(
1484                 () -> getEnumFromItem(taggedItem, map, TargetVisibilityStateEnum.HIDDEN),
1485                 (value) -> setValueFromEnum(taggedItem, value, map),
1486                 getSubscriber(taggedItem, TARGET_VISIBILITY_STATE, updater),
1487                 getUnsubscriber(taggedItem, TARGET_VISIBILITY_STATE, updater));
1488     }
1489
1490     private static TemperatureDisplayUnitCharacteristic createTemperatureDisplayUnitCharacteristic(
1491             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1492         var map = createMapping(taggedItem, TemperatureDisplayUnitEnum.class, true);
1493         return new TemperatureDisplayUnitCharacteristic(
1494                 () -> getEnumFromItem(taggedItem, map,
1495                         useFahrenheit() ? TemperatureDisplayUnitEnum.FAHRENHEIT : TemperatureDisplayUnitEnum.CELSIUS),
1496                 (value) -> setValueFromEnum(taggedItem, value, map),
1497                 getSubscriber(taggedItem, TEMPERATURE_UNIT, updater),
1498                 getUnsubscriber(taggedItem, TEMPERATURE_UNIT, updater));
1499     }
1500
1501     private static VOCDensityCharacteristic createVOCDensityCharacteristic(final HomekitTaggedItem taggedItem,
1502             HomekitAccessoryUpdater updater) {
1503         return new VOCDensityCharacteristic(
1504                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1505                         VOCDensityCharacteristic.DEFAULT_MIN_VALUE),
1506                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
1507                         VOCDensityCharacteristic.DEFAULT_MAX_VALUE),
1508                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.STEP, VOCDensityCharacteristic.DEFAULT_STEP),
1509                 getDoubleSupplier(taggedItem,
1510                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1511                                 VOCDensityCharacteristic.DEFAULT_MIN_VALUE)),
1512                 getSubscriber(taggedItem, VOC_DENSITY, updater), getUnsubscriber(taggedItem, VOC_DENSITY, updater));
1513     }
1514
1515     private static VolumeCharacteristic createVolumeCharacteristic(HomekitTaggedItem taggedItem,
1516             HomekitAccessoryUpdater updater) {
1517         return new VolumeCharacteristic(getIntSupplier(taggedItem, 0),
1518                 (volume) -> ((NumberItem) taggedItem.getItem()).send(new DecimalType(volume)),
1519                 getSubscriber(taggedItem, DURATION, updater), getUnsubscriber(taggedItem, DURATION, updater));
1520     }
1521
1522     private static VolumeSelectorCharacteristic createVolumeSelectorCharacteristic(HomekitTaggedItem taggedItem,
1523             HomekitAccessoryUpdater updater) {
1524         if (taggedItem.getItem() instanceof DimmerItem) {
1525             return new VolumeSelectorCharacteristic((value) -> taggedItem
1526                     .send(value.equals(VolumeSelectorEnum.INCREMENT) ? IncreaseDecreaseType.INCREASE
1527                             : IncreaseDecreaseType.DECREASE));
1528         } else {
1529             var map = createMapping(taggedItem, VolumeSelectorEnum.class);
1530             return new VolumeSelectorCharacteristic((value) -> setValueFromEnum(taggedItem, value, map));
1531         }
1532     }
1533
1534     private static VolumeControlTypeCharacteristic createVolumeControlTypeCharacteristic(HomekitTaggedItem taggedItem,
1535             HomekitAccessoryUpdater updater) {
1536         var map = createMapping(taggedItem, VolumeControlTypeEnum.class);
1537         return new VolumeControlTypeCharacteristic(() -> getEnumFromItem(taggedItem, map, VolumeControlTypeEnum.NONE),
1538                 getSubscriber(taggedItem, VOLUME_CONTROL_TYPE, updater),
1539                 getUnsubscriber(taggedItem, VOLUME_CONTROL_TYPE, updater));
1540     }
1541 }