]> git.basschouten.com Git - openhab-addons.git/blob
851d0ac330464133735bc197fafd449cfbb79156
[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         @Nullable
340         T offEnumValue = null, onEnumValue = null;
341
342         for (var k : klazz.getEnumConstants()) {
343             if (numberType) {
344                 int code = k.getCode();
345                 if ((switchType || contactType) && code == 0) {
346                     map.put(k, inverted ? onValue : offValue);
347                     offEnumValue = k;
348                 } else if ((switchType || contactType) && code == 1) {
349                     map.put(k, inverted ? offValue : onValue);
350                     onEnumValue = k;
351                 } else if (percentType && code == 0) {
352                     map.put(k, "OFF");
353                 } else if (percentType && code == 1) {
354                     map.put(k, "ON");
355                 } else {
356                     map.put(k, Integer.toString(code));
357                 }
358             } else {
359                 map.put(k, k.toString());
360             }
361         }
362         var configuration = item.getConfiguration();
363         if (configuration != null) {
364             map.forEach((k, current_value) -> {
365                 final Object newValue = configuration.get(k.toString());
366                 if (newValue instanceof String || newValue instanceof Number) {
367                     map.put(k, newValue.toString());
368                     if (customEnumList != null) {
369                         customEnumList.add(k);
370                     }
371                 }
372             });
373         }
374         if (customEnumList != null && customEnumList.isEmpty()) {
375             if (switchType || contactType) {
376                 // Switches and Contacts automatically filter the valid values to the first two
377                 customEnumList.add(Objects.requireNonNull(offEnumValue));
378                 customEnumList.add(Objects.requireNonNull(onEnumValue));
379             } else {
380                 customEnumList.addAll(map.keySet());
381             }
382         }
383         LOGGER.debug("Created {} mapping for item {} ({}): {}", klazz.getSimpleName(), item.getName(),
384                 item.getBaseItem().getClass().getSimpleName(), map);
385         return map;
386     }
387
388     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
389             Class<T> klazz) {
390         return createMapping(item, klazz, null, false);
391     }
392
393     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
394             Class<T> klazz, @Nullable List<T> customEnumList) {
395         return createMapping(item, klazz, customEnumList, false);
396     }
397
398     public static <T extends Enum<T> & CharacteristicEnum> Map<T, String> createMapping(HomekitTaggedItem item,
399             Class<T> klazz, boolean inverted) {
400         return createMapping(item, klazz, null, inverted);
401     }
402
403     /**
404      * Takes item state as value and retrieves the key for that value from mapping.
405      * E.g. used to map StringItem value to HomeKit Enum
406      *
407      * @param item item
408      * @param mapping mapping
409      * @param defaultValue default value if nothing found in mapping
410      * @param <T> type of the result derived from
411      * @return key for the value
412      */
413     public static <T> T getKeyFromMapping(HomekitTaggedItem item, State state, Map<T, String> mapping, T defaultValue) {
414         LOGGER.trace("getKeyFromMapping: characteristic {}, state {}, mapping {}", item.getAccessoryType().getTag(),
415                 state, mapping);
416
417         String value;
418         if (state instanceof UnDefType) {
419             return defaultValue;
420         } else if (state instanceof StringType || state instanceof OnOffType || state instanceof OpenClosedType) {
421             value = state.toString();
422         } else if (state.getClass().equals(PercentType.class)) {
423             // We specifically want PercentType, but _not_ HSBType, so don't use instanceof
424             value = state.as(OnOffType.class).toString();
425         } else if (state.getClass().equals(DecimalType.class)) {
426             // We specifically want DecimalType, but _not_ PercentType or HSBType, so don't use instanceof
427             value = Integer.toString(((DecimalType) state).intValue());
428         } else {
429             LOGGER.warn(
430                     "Wrong value type {} ({}) for {} characteristic of the item {}. Expected StringItem, NumberItem, or SwitchItem.",
431                     state.toString(), state.getClass().getSimpleName(), item.getAccessoryType().getTag(),
432                     item.getName());
433             return defaultValue;
434         }
435
436         return mapping.entrySet().stream().filter(entry -> value.equalsIgnoreCase(entry.getValue())).findAny()
437                 .map(Map.Entry::getKey).orElseGet(() -> {
438                     LOGGER.warn(
439                             "Wrong value {} for {} characteristic of the item {}. Expected one of following {}. Returning {}.",
440                             state.toString(), item.getAccessoryType().getTag(), item.getName(), mapping.values(),
441                             defaultValue);
442                     return defaultValue;
443                 });
444     }
445
446     // supporting methods
447
448     public static boolean useFahrenheit() {
449         return Boolean.TRUE.equals(FrameworkUtil.getBundle(HomekitImpl.class).getBundleContext()
450                 .getServiceReference(Homekit.class.getName()).getProperty("useFahrenheitTemperature"));
451     }
452
453     public static TemperatureDisplayUnitCharacteristic createSystemTemperatureDisplayUnitCharacteristic() {
454         return new TemperatureDisplayUnitCharacteristic(() -> CompletableFuture
455                 .completedFuture(HomekitCharacteristicFactory.useFahrenheit() ? TemperatureDisplayUnitEnum.FAHRENHEIT
456                         : TemperatureDisplayUnitEnum.CELSIUS),
457                 (value) -> {
458                 }, (cb) -> {
459                 }, () -> {
460                 });
461     }
462
463     public static Unit<Temperature> getSystemTemperatureUnit() {
464         return useFahrenheit() ? ImperialUnits.FAHRENHEIT : SIUnits.CELSIUS;
465     }
466
467     private static <T extends CharacteristicEnum> CompletableFuture<T> getEnumFromItem(HomekitTaggedItem item,
468             Map<T, String> mapping, T defaultValue) {
469         return CompletableFuture
470                 .completedFuture(getKeyFromMapping(item, item.getItem().getState(), mapping, defaultValue));
471     }
472
473     public static <T extends Enum<T>> void setValueFromEnum(HomekitTaggedItem taggedItem, T value, Map<T, String> map) {
474         if (taggedItem.getBaseItem() instanceof NumberItem) {
475             taggedItem.send(new DecimalType(Objects.requireNonNull(map.get(value))));
476         } else if (taggedItem.getBaseItem() instanceof SwitchItem) {
477             taggedItem.send(OnOffType.from(Objects.requireNonNull(map.get(value))));
478         } else {
479             taggedItem.send(new StringType(map.get(value)));
480         }
481     }
482
483     private static int getIntFromItem(HomekitTaggedItem taggedItem, int defaultValue) {
484         int value = defaultValue;
485         final State state = taggedItem.getItem().getState();
486         if (state instanceof PercentType stateAsPercentType) {
487             value = stateAsPercentType.intValue();
488         } else if (state instanceof DecimalType stateAsDecimalType) {
489             value = stateAsDecimalType.intValue();
490         } else if (state instanceof UnDefType) {
491             LOGGER.debug("Item state {} is UNDEF {}. Returning default value {}", state, taggedItem.getName(),
492                     defaultValue);
493         } else {
494             LOGGER.warn(
495                     "Item state {} is not supported for {}. Only PercentType and DecimalType (0/100) are supported.",
496                     state, taggedItem.getName());
497         }
498         return value;
499     }
500
501     /** special method for tilts. it converts percentage to angle */
502     private static int getAngleFromItem(HomekitTaggedItem taggedItem, int defaultValue) {
503         int value = defaultValue;
504         final State state = taggedItem.getItem().getState();
505         if (state instanceof PercentType stateAsPercentType) {
506             value = (int) ((stateAsPercentType.intValue() * 90.0) / 50.0 - 90.0);
507         } else {
508             value = getIntFromItem(taggedItem, defaultValue);
509         }
510         return value;
511     }
512
513     private static <T extends Quantity<T>> double convertAndRound(double value, Unit<T> from, Unit<T> to) {
514         double rawValue = from.equals(to) ? value : from.getConverterTo(to).convert(value);
515         return new BigDecimal(rawValue).setScale(1, RoundingMode.HALF_UP).doubleValue();
516     }
517
518     public static @Nullable Double stateAsTemperature(@Nullable State state) {
519         if (state == null || state instanceof UnDefType) {
520             return null;
521         }
522
523         if (state instanceof QuantityType<?> qt) {
524             if (qt.getDimension().equals(SIUnits.CELSIUS.getDimension())) {
525                 return qt.toUnit(SIUnits.CELSIUS).doubleValue();
526             }
527         }
528
529         return convertToCelsius(state.as(DecimalType.class).doubleValue());
530     }
531
532     public static double convertToCelsius(double degrees) {
533         return convertAndRound(degrees, getSystemTemperatureUnit(), SIUnits.CELSIUS);
534     }
535
536     public static double convertFromCelsius(double degrees) {
537         return convertAndRound(degrees, SIUnits.CELSIUS, getSystemTemperatureUnit());
538     }
539
540     public static double getTemperatureStep(HomekitTaggedItem taggedItem, double defaultValue) {
541         return taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.STEP,
542                 new QuantityType(defaultValue, SIUnits.CELSIUS), true).doubleValue();
543     }
544
545     private static Supplier<CompletableFuture<Integer>> getAngleSupplier(HomekitTaggedItem taggedItem,
546             int defaultValue) {
547         return () -> CompletableFuture.completedFuture(getAngleFromItem(taggedItem, defaultValue));
548     }
549
550     private static Supplier<CompletableFuture<Integer>> getIntSupplier(HomekitTaggedItem taggedItem, int defaultValue) {
551         return () -> CompletableFuture.completedFuture(getIntFromItem(taggedItem, defaultValue));
552     }
553
554     private static ExceptionalConsumer<Integer> setIntConsumer(HomekitTaggedItem taggedItem) {
555         return (value) -> {
556             if (taggedItem.getBaseItem() instanceof NumberItem) {
557                 taggedItem.send(new DecimalType(value));
558             } else {
559                 LOGGER.warn("Item type {} is not supported for {}. Only NumberItem is supported.",
560                         taggedItem.getBaseItem().getType(), taggedItem.getName());
561             }
562         };
563     }
564
565     private static ExceptionalConsumer<Integer> setPercentConsumer(HomekitTaggedItem taggedItem) {
566         return (value) -> {
567             if (taggedItem.getBaseItem() instanceof NumberItem) {
568                 taggedItem.send(new DecimalType(value));
569             } else if (taggedItem.getBaseItem() instanceof DimmerItem) {
570                 taggedItem.send(new PercentType(value));
571             } else {
572                 LOGGER.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
573                         taggedItem.getBaseItem().getType(), taggedItem.getName());
574             }
575         };
576     }
577
578     private static ExceptionalConsumer<Integer> setAngleConsumer(HomekitTaggedItem taggedItem) {
579         return (value) -> {
580             if (taggedItem.getBaseItem() instanceof NumberItem) {
581                 taggedItem.send(new DecimalType(value));
582             } else if (taggedItem.getBaseItem() instanceof DimmerItem) {
583                 value = (int) (value * 50.0 / 90.0 + 50.0);
584                 taggedItem.send(new PercentType(value));
585             } else {
586                 LOGGER.warn("Item type {} is not supported for {}. Only DimmerItem and NumberItem are supported.",
587                         taggedItem.getBaseItem().getType(), taggedItem.getName());
588             }
589         };
590     }
591
592     private static Supplier<CompletableFuture<Double>> getDoubleSupplier(HomekitTaggedItem taggedItem,
593             double defaultValue) {
594         return () -> {
595             final State state = taggedItem.getItem().getState();
596             double value = defaultValue;
597             if (state instanceof PercentType stateAsPercentType) {
598                 value = stateAsPercentType.doubleValue();
599             } else if (state instanceof DecimalType stateAsDecimalType) {
600                 value = stateAsDecimalType.doubleValue();
601             } else if (state instanceof QuantityType stateAsQuantityType) {
602                 value = stateAsQuantityType.doubleValue();
603             }
604             return CompletableFuture.completedFuture(value);
605         };
606     }
607
608     private static ExceptionalConsumer<Double> setDoubleConsumer(HomekitTaggedItem taggedItem) {
609         return (value) -> {
610             if (taggedItem.getBaseItem() instanceof NumberItem) {
611                 taggedItem.send(new DecimalType(value.doubleValue()));
612             } else if (taggedItem.getBaseItem() instanceof DimmerItem) {
613                 taggedItem.send(new PercentType(value.intValue()));
614             } else {
615                 LOGGER.warn("Item type {} is not supported for {}. Only Number and Dimmer type are supported.",
616                         taggedItem.getBaseItem().getType(), taggedItem.getName());
617             }
618         };
619     }
620
621     private static Supplier<CompletableFuture<Double>> getTemperatureSupplier(HomekitTaggedItem taggedItem,
622             double defaultValue) {
623         return () -> {
624             final @Nullable Double value = stateAsTemperature(taggedItem.getItem().getState());
625             return CompletableFuture.completedFuture(value != null ? value : defaultValue);
626         };
627     }
628
629     private static ExceptionalConsumer<Double> setTemperatureConsumer(HomekitTaggedItem taggedItem) {
630         return (value) -> {
631             Item baseItem = taggedItem.getBaseItem();
632             if (baseItem instanceof NumberItem baseAsNumberItem) {
633                 if (baseAsNumberItem.getUnit() != null) {
634                     taggedItem.send(new QuantityType(value, SIUnits.CELSIUS));
635                 } else {
636                     taggedItem.send(new DecimalType(convertFromCelsius(value)));
637                 }
638             } else {
639                 LOGGER.warn("Item type {} is not supported for {}. Only Number type is supported.",
640                         taggedItem.getBaseItem().getType(), taggedItem.getName());
641             }
642         };
643     }
644
645     protected static Consumer<HomekitCharacteristicChangeCallback> getSubscriber(HomekitTaggedItem taggedItem,
646             HomekitCharacteristicType key, HomekitAccessoryUpdater updater) {
647         return (callback) -> updater.subscribe((GenericItem) taggedItem.getItem(), key.getTag(), callback);
648     }
649
650     protected static Runnable getUnsubscriber(HomekitTaggedItem taggedItem, HomekitCharacteristicType key,
651             HomekitAccessoryUpdater updater) {
652         return () -> updater.unsubscribe((GenericItem) taggedItem.getItem(), key.getTag());
653     }
654
655     // METHODS TO CREATE SINGLE CHARACTERISTIC FROM OPENHAB ITEM
656
657     private static ActiveCharacteristic createActiveCharacteristic(HomekitTaggedItem taggedItem,
658             HomekitAccessoryUpdater updater) {
659         var map = createMapping(taggedItem, ActiveEnum.class, false);
660         return new ActiveCharacteristic(() -> getEnumFromItem(taggedItem, map, ActiveEnum.INACTIVE),
661                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, ACTIVE, updater),
662                 getUnsubscriber(taggedItem, ACTIVE, updater));
663     }
664
665     private static ActiveIdentifierCharacteristic createActiveIdentifierCharacteristic(HomekitTaggedItem taggedItem,
666             HomekitAccessoryUpdater updater) {
667         return new ActiveIdentifierCharacteristic(getIntSupplier(taggedItem, 1), setIntConsumer(taggedItem),
668                 getSubscriber(taggedItem, ACTIVE_IDENTIFIER, updater),
669                 getUnsubscriber(taggedItem, ACTIVE_IDENTIFIER, updater));
670     }
671
672     private static BrightnessCharacteristic createBrightnessCharacteristic(HomekitTaggedItem taggedItem,
673             HomekitAccessoryUpdater updater) {
674         return new BrightnessCharacteristic(() -> {
675             int value = 0;
676             final State state = taggedItem.getItem().getState();
677             if (state instanceof HSBType stateAsHSBType) {
678                 value = stateAsHSBType.getBrightness().intValue();
679             } else if (state instanceof PercentType stateAsPercentType) {
680                 value = stateAsPercentType.intValue();
681             }
682             return CompletableFuture.completedFuture(value);
683         }, (brightness) -> {
684             if (taggedItem.getBaseItem() instanceof DimmerItem) {
685                 taggedItem.sendCommandProxy(HomekitCommandType.BRIGHTNESS_COMMAND, new PercentType(brightness));
686             } else {
687                 LOGGER.warn("Item type {} is not supported for {}. Only ColorItem and DimmerItem are supported.",
688                         taggedItem.getBaseItem().getType(), taggedItem.getName());
689             }
690         }, getSubscriber(taggedItem, BRIGHTNESS, updater), getUnsubscriber(taggedItem, BRIGHTNESS, updater));
691     }
692
693     private static CarbonDioxideLevelCharacteristic createCarbonDioxideLevelCharacteristic(HomekitTaggedItem taggedItem,
694             HomekitAccessoryUpdater updater) {
695         return new CarbonDioxideLevelCharacteristic(
696                 getDoubleSupplier(taggedItem,
697                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
698                                 CarbonDioxideLevelCharacteristic.DEFAULT_MIN_VALUE)),
699                 getSubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater),
700                 getUnsubscriber(taggedItem, CARBON_MONOXIDE_LEVEL, updater));
701     }
702
703     private static CarbonDioxidePeakLevelCharacteristic createCarbonDioxidePeakLevelCharacteristic(
704             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
705         return new CarbonDioxidePeakLevelCharacteristic(
706                 getDoubleSupplier(taggedItem,
707                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
708                                 CarbonDioxidePeakLevelCharacteristic.DEFAULT_MIN_VALUE)),
709                 getSubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater),
710                 getUnsubscriber(taggedItem, CARBON_MONOXIDE_PEAK_LEVEL, updater));
711     }
712
713     private static CarbonMonoxideLevelCharacteristic createCarbonMonoxideLevelCharacteristic(
714             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
715         return new CarbonMonoxideLevelCharacteristic(
716                 getDoubleSupplier(taggedItem,
717                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
718                                 CarbonMonoxideLevelCharacteristic.DEFAULT_MIN_VALUE)),
719                 getSubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater),
720                 getUnsubscriber(taggedItem, CARBON_DIOXIDE_LEVEL, updater));
721     }
722
723     private static CarbonMonoxidePeakLevelCharacteristic createCarbonMonoxidePeakLevelCharacteristic(
724             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
725         return new CarbonMonoxidePeakLevelCharacteristic(
726                 getDoubleSupplier(taggedItem,
727                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
728                                 CarbonMonoxidePeakLevelCharacteristic.DEFAULT_MIN_VALUE)),
729                 getSubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater),
730                 getUnsubscriber(taggedItem, CARBON_DIOXIDE_PEAK_LEVEL, updater));
731     }
732
733     private static ClosedCaptionsCharacteristic createClosedCaptionsCharacteristic(HomekitTaggedItem taggedItem,
734             HomekitAccessoryUpdater updater) {
735         var map = createMapping(taggedItem, ClosedCaptionsEnum.class);
736         return new ClosedCaptionsCharacteristic(() -> getEnumFromItem(taggedItem, map, ClosedCaptionsEnum.DISABLED),
737                 (value) -> setValueFromEnum(taggedItem, value, map),
738                 getSubscriber(taggedItem, CLOSED_CAPTIONS, updater),
739                 getUnsubscriber(taggedItem, CLOSED_CAPTIONS, updater));
740     }
741
742     private static ColorTemperatureCharacteristic createColorTemperatureCharacteristic(HomekitTaggedItem taggedItem,
743             HomekitAccessoryUpdater updater) {
744         final boolean inverted = taggedItem.isInverted();
745
746         int minValue = taggedItem
747                 .getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
748                         new QuantityType(ColorTemperatureCharacteristic.DEFAULT_MIN_VALUE, Units.MIRED), false)
749                 .intValue();
750         int maxValue = taggedItem
751                 .getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
752                         new QuantityType(ColorTemperatureCharacteristic.DEFAULT_MAX_VALUE, Units.MIRED), false)
753                 .intValue();
754
755         // It's common to swap these if you're providing in Kelvin instead of mired
756         if (minValue > maxValue) {
757             int temp = minValue;
758             minValue = maxValue;
759             maxValue = temp;
760         }
761
762         final int finalMinValue = minValue;
763         final int range = maxValue - minValue;
764
765         return new ColorTemperatureCharacteristic(minValue, maxValue, () -> {
766             int value = finalMinValue;
767             final State state = taggedItem.getItem().getState();
768             if (state instanceof QuantityType<?> qt) {
769                 // Number:Temperature
770                 qt = qt.toInvertibleUnit(Units.MIRED);
771                 if (qt == null) {
772                     LOGGER.warn("Item {}'s state '{}' is not convertible to mireds.", taggedItem.getName(), state);
773                 } else {
774                     value = qt.intValue();
775                 }
776             } else if (state instanceof PercentType stateAsPercentType) {
777                 double percent = stateAsPercentType.doubleValue();
778                 // invert so that 0% == coolest
779                 if (inverted) {
780                     percent = 100.0 - percent;
781                 }
782
783                 // Dimmer
784                 // scale to the originally configured range
785                 value = (int) (percent * range / 100) + finalMinValue;
786             } else if (state instanceof DecimalType stateAsDecimalType) {
787                 value = stateAsDecimalType.intValue();
788             }
789             return CompletableFuture.completedFuture(value);
790         }, (value) -> {
791             if (taggedItem.getBaseItem() instanceof DimmerItem) {
792                 // scale to a percent
793                 double percent = (((double) value) - finalMinValue) * 100 / range;
794                 if (inverted) {
795                     percent = 100.0 - percent;
796                 }
797                 taggedItem.send(new PercentType(BigDecimal.valueOf(percent)));
798             } else if (taggedItem.getBaseItem() instanceof NumberItem) {
799                 taggedItem.send(new QuantityType(value, Units.MIRED));
800             }
801         }, getSubscriber(taggedItem, COLOR_TEMPERATURE, updater),
802                 getUnsubscriber(taggedItem, COLOR_TEMPERATURE, updater));
803     }
804
805     private static ConfiguredNameCharacteristic createConfiguredNameCharacteristic(HomekitTaggedItem taggedItem,
806             HomekitAccessoryUpdater updater) {
807         return new ConfiguredNameCharacteristic(() -> {
808             final State state = taggedItem.getItem().getState();
809             return CompletableFuture
810                     .completedFuture(state instanceof UnDefType ? taggedItem.getName() : state.toString());
811         }, (value) -> ((StringItem) taggedItem.getItem()).send(new StringType(value)),
812                 getSubscriber(taggedItem, CONFIGURED_NAME, updater),
813                 getUnsubscriber(taggedItem, CONFIGURED_NAME, updater));
814     }
815
816     private static CoolingThresholdTemperatureCharacteristic createCoolingThresholdCharacteristic(
817             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
818         double minValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
819                 Objects.requireNonNull(
820                         new QuantityType(CoolingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
821                                 .toUnit(getSystemTemperatureUnit())),
822                 false).toUnit(SIUnits.CELSIUS).doubleValue();
823         double maxValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
824                 Objects.requireNonNull(
825                         new QuantityType(CoolingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
826                                 .toUnit(getSystemTemperatureUnit())),
827                 false).toUnit(SIUnits.CELSIUS).doubleValue();
828         double step = taggedItem
829                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
830                         Objects.requireNonNull(new QuantityType(CoolingThresholdTemperatureCharacteristic.DEFAULT_STEP,
831                                 SIUnits.CELSIUS).toUnit(getSystemTemperatureUnit())),
832                         true)
833                 .toUnit(SIUnits.CELSIUS).doubleValue();
834         return new CoolingThresholdTemperatureCharacteristic(minValue, maxValue, step,
835                 getTemperatureSupplier(taggedItem, minValue), setTemperatureConsumer(taggedItem),
836                 getSubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater),
837                 getUnsubscriber(taggedItem, COOLING_THRESHOLD_TEMPERATURE, updater));
838     }
839
840     private static CurrentDoorStateCharacteristic createCurrentDoorStateCharacteristic(HomekitTaggedItem taggedItem,
841             HomekitAccessoryUpdater updater) {
842         List<CurrentDoorStateEnum> validValues = new ArrayList<>();
843         var map = createMapping(taggedItem, CurrentDoorStateEnum.class, validValues);
844         return new CurrentDoorStateCharacteristic(() -> getEnumFromItem(taggedItem, map, CurrentDoorStateEnum.CLOSED),
845                 getSubscriber(taggedItem, CURRENT_DOOR_STATE, updater),
846                 getUnsubscriber(taggedItem, CURRENT_DOOR_STATE, updater));
847     }
848
849     private static CurrentHeatingCoolingStateCharacteristic createCurrentHeatingCoolingStateCharacteristic(
850             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
851         List<CurrentHeatingCoolingStateEnum> validValues = new ArrayList<>();
852         var map = createMapping(taggedItem, CurrentHeatingCoolingStateEnum.class, validValues);
853         return new CurrentHeatingCoolingStateCharacteristic(validValues.toArray(new CurrentHeatingCoolingStateEnum[0]),
854                 () -> getEnumFromItem(taggedItem, map, CurrentHeatingCoolingStateEnum.OFF),
855                 getSubscriber(taggedItem, CURRENT_HEATING_COOLING_STATE, updater),
856                 getUnsubscriber(taggedItem, CURRENT_HEATING_COOLING_STATE, updater));
857     }
858
859     private static CurrentFanStateCharacteristic createCurrentFanStateCharacteristic(HomekitTaggedItem taggedItem,
860             HomekitAccessoryUpdater updater) {
861         var map = createMapping(taggedItem, CurrentFanStateEnum.class);
862         return new CurrentFanStateCharacteristic(() -> getEnumFromItem(taggedItem, map, CurrentFanStateEnum.INACTIVE),
863                 getSubscriber(taggedItem, CURRENT_FAN_STATE, updater),
864                 getUnsubscriber(taggedItem, CURRENT_FAN_STATE, updater));
865     }
866
867     private static CurrentHorizontalTiltAngleCharacteristic createCurrentHorizontalTiltAngleCharacteristic(
868             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
869         return new CurrentHorizontalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
870                 getSubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater),
871                 getUnsubscriber(taggedItem, CURRENT_HORIZONTAL_TILT_ANGLE, updater));
872     }
873
874     private static CurrentMediaStateCharacteristic createCurrentMediaStateCharacteristic(HomekitTaggedItem taggedItem,
875             HomekitAccessoryUpdater updater) {
876         var map = createMapping(taggedItem, CurrentMediaStateEnum.class);
877         return new CurrentMediaStateCharacteristic(
878                 () -> getEnumFromItem(taggedItem, map, CurrentMediaStateEnum.UNKNOWN),
879                 getSubscriber(taggedItem, CURRENT_MEDIA_STATE, updater),
880                 getUnsubscriber(taggedItem, CURRENT_MEDIA_STATE, updater));
881     }
882
883     private static CurrentTemperatureCharacteristic createCurrentTemperatureCharacteristic(HomekitTaggedItem taggedItem,
884             HomekitAccessoryUpdater updater) {
885         double minValue = taggedItem
886                 .getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
887                         Objects.requireNonNull(
888                                 new QuantityType(CurrentTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
889                                         .toUnit(getSystemTemperatureUnit())),
890                         false)
891                 .toUnit(SIUnits.CELSIUS).doubleValue();
892         double maxValue = taggedItem
893                 .getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
894                         Objects.requireNonNull(
895                                 new QuantityType(CurrentTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
896                                         .toUnit(getSystemTemperatureUnit())),
897                         false)
898                 .toUnit(SIUnits.CELSIUS).doubleValue();
899         double step = taggedItem
900                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
901                         Objects.requireNonNull(
902                                 new QuantityType(CurrentTemperatureCharacteristic.DEFAULT_STEP, SIUnits.CELSIUS)
903                                         .toUnit(getSystemTemperatureUnit())),
904                         true)
905                 .toUnit(SIUnits.CELSIUS).doubleValue();
906         return new CurrentTemperatureCharacteristic(minValue, maxValue, step,
907                 getTemperatureSupplier(taggedItem, minValue), getSubscriber(taggedItem, TARGET_TEMPERATURE, updater),
908                 getUnsubscriber(taggedItem, TARGET_TEMPERATURE, updater));
909     }
910
911     private static CurrentTiltAngleCharacteristic createCurrentTiltAngleCharacteristic(HomekitTaggedItem taggedItem,
912             HomekitAccessoryUpdater updater) {
913         return new CurrentTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
914                 getSubscriber(taggedItem, CURRENT_TILT_ANGLE, updater),
915                 getUnsubscriber(taggedItem, CURRENT_TILT_ANGLE, updater));
916     }
917
918     private static CurrentVerticalTiltAngleCharacteristic createCurrentVerticalTiltAngleCharacteristic(
919             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
920         return new CurrentVerticalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
921                 getSubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater),
922                 getUnsubscriber(taggedItem, CURRENT_VERTICAL_TILT_ANGLE, updater));
923     }
924
925     private static CurrentVisibilityStateCharacteristic createCurrentVisibilityStateCharacteristic(
926             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
927         var map = createMapping(taggedItem, CurrentVisibilityStateEnum.class, true);
928         return new CurrentVisibilityStateCharacteristic(
929                 () -> getEnumFromItem(taggedItem, map, CurrentVisibilityStateEnum.HIDDEN),
930                 getSubscriber(taggedItem, CURRENT_VISIBILITY, updater),
931                 getUnsubscriber(taggedItem, CURRENT_VISIBILITY, updater));
932     }
933
934     private static SetDurationCharacteristic createDurationCharacteristic(HomekitTaggedItem taggedItem,
935             HomekitAccessoryUpdater updater) {
936         return new SetDurationCharacteristic(() -> {
937             int value = getIntFromItem(taggedItem, 0);
938             final @Nullable Map<String, Object> itemConfiguration = taggedItem.getConfiguration();
939             if ((value == 0) && (itemConfiguration != null)) { // check for default duration
940                 final Object duration = itemConfiguration.get(HomekitValveImpl.CONFIG_DEFAULT_DURATION);
941                 if (duration instanceof BigDecimal durationAsBigDecimal) {
942                     value = durationAsBigDecimal.intValue();
943                     if (taggedItem.getItem() instanceof NumberItem taggedNumberItem) {
944                         taggedNumberItem.setState(new DecimalType(value));
945                     }
946                 }
947             }
948             return CompletableFuture.completedFuture(value);
949         }, setIntConsumer(taggedItem), getSubscriber(taggedItem, DURATION, updater),
950                 getUnsubscriber(taggedItem, DURATION, updater));
951     }
952
953     private static FilterLifeLevelCharacteristic createFilterLifeLevelCharacteristic(HomekitTaggedItem taggedItem,
954             HomekitAccessoryUpdater updater) {
955         return new FilterLifeLevelCharacteristic(getDoubleSupplier(taggedItem, 0),
956                 getSubscriber(taggedItem, FILTER_LIFE_LEVEL, updater),
957                 getUnsubscriber(taggedItem, FILTER_LIFE_LEVEL, updater));
958     }
959
960     private static ResetFilterIndicationCharacteristic createFilterResetCharacteristic(HomekitTaggedItem taggedItem,
961             HomekitAccessoryUpdater updater) {
962         return new ResetFilterIndicationCharacteristic(
963                 (value) -> ((SwitchItem) taggedItem.getBaseItem()).send(OnOffType.ON));
964     }
965
966     private static FirmwareRevisionCharacteristic createFirmwareRevisionCharacteristic(HomekitTaggedItem taggedItem,
967             HomekitAccessoryUpdater updater) {
968         return new FirmwareRevisionCharacteristic(() -> {
969             final State state = taggedItem.getItem().getState();
970             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
971         });
972     }
973
974     private static HardwareRevisionCharacteristic createHardwareRevisionCharacteristic(HomekitTaggedItem taggedItem,
975             HomekitAccessoryUpdater updater) {
976         return new HardwareRevisionCharacteristic(() -> {
977             final State state = taggedItem.getItem().getState();
978             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
979         });
980     }
981
982     private static HeatingThresholdTemperatureCharacteristic createHeatingThresholdCharacteristic(
983             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
984         double minValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
985                 Objects.requireNonNull(
986                         new QuantityType(HeatingThresholdTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
987                                 .toUnit(getSystemTemperatureUnit())),
988                 false).toUnit(SIUnits.CELSIUS).doubleValue();
989         double maxValue = taggedItem.getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
990                 Objects.requireNonNull(
991                         new QuantityType(HeatingThresholdTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
992                                 .toUnit(getSystemTemperatureUnit())),
993                 false).toUnit(SIUnits.CELSIUS).doubleValue();
994         double step = taggedItem
995                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
996                         Objects.requireNonNull(new QuantityType(HeatingThresholdTemperatureCharacteristic.DEFAULT_STEP,
997                                 SIUnits.CELSIUS).toUnit(getSystemTemperatureUnit())),
998                         true)
999                 .toUnit(SIUnits.CELSIUS).doubleValue();
1000         return new HeatingThresholdTemperatureCharacteristic(minValue, maxValue, step,
1001                 getTemperatureSupplier(taggedItem, minValue), setTemperatureConsumer(taggedItem),
1002                 getSubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater),
1003                 getUnsubscriber(taggedItem, HEATING_THRESHOLD_TEMPERATURE, updater));
1004     }
1005
1006     private static HoldPositionCharacteristic createHoldPositionCharacteristic(HomekitTaggedItem taggedItem,
1007             HomekitAccessoryUpdater updater) {
1008         final Item item = taggedItem.getBaseItem();
1009         if (!(item instanceof SwitchItem || item instanceof RollershutterItem)) {
1010             LOGGER.warn(
1011                     "Item {} cannot be used for the HoldPosition characteristic; only SwitchItem and RollershutterItem are supported. Hold requests will be ignored.",
1012                     item.getName());
1013         }
1014
1015         return new HoldPositionCharacteristic(value -> {
1016             if (!value) {
1017                 return;
1018             }
1019
1020             if (item instanceof SwitchItem switchItem) {
1021                 switchItem.send(OnOffType.ON);
1022             } else if (item instanceof RollershutterItem rollershutterItem) {
1023                 rollershutterItem.send(StopMoveType.STOP);
1024             }
1025         });
1026     }
1027
1028     private static HueCharacteristic createHueCharacteristic(HomekitTaggedItem taggedItem,
1029             HomekitAccessoryUpdater updater) {
1030         return new HueCharacteristic(() -> {
1031             double value = 0.0;
1032             State state = taggedItem.getItem().getState();
1033             if (state instanceof HSBType stateAsHSBType) {
1034                 value = stateAsHSBType.getHue().doubleValue();
1035             }
1036             return CompletableFuture.completedFuture(value);
1037         }, (hue) -> {
1038             if (taggedItem.getBaseItem() instanceof ColorItem) {
1039                 taggedItem.sendCommandProxy(HomekitCommandType.HUE_COMMAND, new DecimalType(hue));
1040             } else {
1041                 LOGGER.warn("Item type {} is not supported for {}. Only Color type is supported.",
1042                         taggedItem.getBaseItem().getType(), taggedItem.getName());
1043             }
1044         }, getSubscriber(taggedItem, HUE, updater), getUnsubscriber(taggedItem, HUE, updater));
1045     }
1046
1047     private static IdentifierCharacteristic createIdentifierCharacteristic(HomekitTaggedItem taggedItem,
1048             HomekitAccessoryUpdater updater) {
1049         return new IdentifierCharacteristic(getIntSupplier(taggedItem, 1));
1050     }
1051
1052     private static IdentifyCharacteristic createIdentifyCharacteristic(HomekitTaggedItem taggedItem,
1053             HomekitAccessoryUpdater updater) {
1054         return new IdentifyCharacteristic((value) -> ((SwitchItem) taggedItem.getBaseItem()).send(OnOffType.ON));
1055     }
1056
1057     private static InputDeviceTypeCharacteristic createInputDeviceTypeCharacteristic(HomekitTaggedItem taggedItem,
1058             HomekitAccessoryUpdater updater) {
1059         var map = createMapping(taggedItem, InputDeviceTypeEnum.class);
1060         return new InputDeviceTypeCharacteristic(() -> getEnumFromItem(taggedItem, map, InputDeviceTypeEnum.OTHER),
1061                 getSubscriber(taggedItem, INPUT_DEVICE_TYPE, updater),
1062                 getUnsubscriber(taggedItem, INPUT_DEVICE_TYPE, updater));
1063     }
1064
1065     private static InputSourceTypeCharacteristic createInputSourceTypeCharacteristic(HomekitTaggedItem taggedItem,
1066             HomekitAccessoryUpdater updater) {
1067         var map = createMapping(taggedItem, InputSourceTypeEnum.class);
1068         return new InputSourceTypeCharacteristic(() -> getEnumFromItem(taggedItem, map, InputSourceTypeEnum.OTHER),
1069                 getSubscriber(taggedItem, INPUT_SOURCE_TYPE, updater),
1070                 getUnsubscriber(taggedItem, INPUT_SOURCE_TYPE, updater));
1071     }
1072
1073     private static IsConfiguredCharacteristic createIsConfiguredCharacteristic(HomekitTaggedItem taggedItem,
1074             HomekitAccessoryUpdater updater) {
1075         var map = createMapping(taggedItem, IsConfiguredEnum.class);
1076         return new IsConfiguredCharacteristic(() -> getEnumFromItem(taggedItem, map, IsConfiguredEnum.NOT_CONFIGURED),
1077                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, CONFIGURED, updater),
1078                 getUnsubscriber(taggedItem, CONFIGURED, updater));
1079     }
1080
1081     private static LockPhysicalControlsCharacteristic createLockPhysicalControlsCharacteristic(
1082             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1083         var map = createMapping(taggedItem, LockPhysicalControlsEnum.class);
1084         return new LockPhysicalControlsCharacteristic(
1085                 () -> getEnumFromItem(taggedItem, map, LockPhysicalControlsEnum.CONTROL_LOCK_DISABLED),
1086                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, LOCK_CONTROL, updater),
1087                 getUnsubscriber(taggedItem, LOCK_CONTROL, updater));
1088     }
1089
1090     private static ManufacturerCharacteristic createManufacturerCharacteristic(HomekitTaggedItem taggedItem,
1091             HomekitAccessoryUpdater updater) {
1092         return new ManufacturerCharacteristic(() -> {
1093             final State state = taggedItem.getItem().getState();
1094             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1095         });
1096     }
1097
1098     private static ModelCharacteristic createModelCharacteristic(HomekitTaggedItem taggedItem,
1099             HomekitAccessoryUpdater updater) {
1100         return new ModelCharacteristic(() -> {
1101             final State state = taggedItem.getItem().getState();
1102             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1103         });
1104     }
1105
1106     private static MuteCharacteristic createMuteCharacteristic(HomekitTaggedItem taggedItem,
1107             HomekitAccessoryUpdater updater) {
1108         BooleanItemReader muteReader = new BooleanItemReader(taggedItem.getItem(),
1109                 OnOffType.from(!taggedItem.isInverted()),
1110                 taggedItem.isInverted() ? OpenClosedType.CLOSED : OpenClosedType.OPEN);
1111         return new MuteCharacteristic(() -> CompletableFuture.completedFuture(muteReader.getValue()),
1112                 (value) -> taggedItem.send(OnOffType.from(value)), getSubscriber(taggedItem, MUTE, updater),
1113                 getUnsubscriber(taggedItem, MUTE, updater));
1114     }
1115
1116     private static NameCharacteristic createNameCharacteristic(HomekitTaggedItem taggedItem,
1117             HomekitAccessoryUpdater updater) {
1118         return new NameCharacteristic(() -> {
1119             final State state = taggedItem.getItem().getState();
1120             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1121         });
1122     }
1123
1124     private static NitrogenDioxideDensityCharacteristic createNitrogenDioxideDensityCharacteristic(
1125             final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1126         return new NitrogenDioxideDensityCharacteristic(
1127                 getDoubleSupplier(taggedItem,
1128                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1129                                 NitrogenDioxideDensityCharacteristic.DEFAULT_MIN_VALUE)),
1130                 getSubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater),
1131                 getUnsubscriber(taggedItem, NITROGEN_DIOXIDE_DENSITY, updater));
1132     }
1133
1134     private static ObstructionDetectedCharacteristic createObstructionDetectedCharacteristic(
1135             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1136         return new ObstructionDetectedCharacteristic(
1137                 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
1138                         || taggedItem.getItem().getState() == OpenClosedType.OPEN),
1139                 getSubscriber(taggedItem, OBSTRUCTION_STATUS, updater),
1140                 getUnsubscriber(taggedItem, OBSTRUCTION_STATUS, updater));
1141     }
1142
1143     private static OzoneDensityCharacteristic createOzoneDensityCharacteristic(final HomekitTaggedItem taggedItem,
1144             HomekitAccessoryUpdater updater) {
1145         return new OzoneDensityCharacteristic(
1146                 getDoubleSupplier(taggedItem,
1147                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1148                                 OzoneDensityCharacteristic.DEFAULT_MIN_VALUE)),
1149                 getSubscriber(taggedItem, OZONE_DENSITY, updater), getUnsubscriber(taggedItem, OZONE_DENSITY, updater));
1150     }
1151
1152     private static PM10DensityCharacteristic createPM10DensityCharacteristic(final HomekitTaggedItem taggedItem,
1153             HomekitAccessoryUpdater updater) {
1154         return new PM10DensityCharacteristic(
1155                 getDoubleSupplier(taggedItem,
1156                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1157                                 PM10DensityCharacteristic.DEFAULT_MIN_VALUE)),
1158                 getSubscriber(taggedItem, PM10_DENSITY, updater), getUnsubscriber(taggedItem, PM10_DENSITY, updater));
1159     }
1160
1161     private static PM25DensityCharacteristic createPM25DensityCharacteristic(final HomekitTaggedItem taggedItem,
1162             HomekitAccessoryUpdater updater) {
1163         return new PM25DensityCharacteristic(
1164                 getDoubleSupplier(taggedItem,
1165                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1166                                 PM25DensityCharacteristic.DEFAULT_MIN_VALUE)),
1167                 getSubscriber(taggedItem, PM25_DENSITY, updater), getUnsubscriber(taggedItem, PM25_DENSITY, updater));
1168     }
1169
1170     private static CurrentRelativeHumidityCharacteristic createRelativeHumidityCharacteristic(
1171             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1172         return new CurrentRelativeHumidityCharacteristic(getDoubleSupplier(taggedItem, 0.0),
1173                 getSubscriber(taggedItem, RELATIVE_HUMIDITY, updater),
1174                 getUnsubscriber(taggedItem, RELATIVE_HUMIDITY, updater));
1175     }
1176
1177     private static PictureModeCharacteristic createPictureModeCharacteristic(HomekitTaggedItem taggedItem,
1178             HomekitAccessoryUpdater updater) {
1179         var map = createMapping(taggedItem, PictureModeEnum.class);
1180         return new PictureModeCharacteristic(() -> getEnumFromItem(taggedItem, map, PictureModeEnum.OTHER),
1181                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, PICTURE_MODE, updater),
1182                 getUnsubscriber(taggedItem, PICTURE_MODE, updater));
1183     }
1184
1185     private static PowerModeCharacteristic createPowerModeCharacteristic(HomekitTaggedItem taggedItem,
1186             HomekitAccessoryUpdater updater) {
1187         var map = createMapping(taggedItem, PowerModeEnum.class, true);
1188         return new PowerModeCharacteristic((value) -> setValueFromEnum(taggedItem, value, map));
1189     }
1190
1191     // this characteristic is unique in a few ways, so we can't use the "normal" helpers:
1192     // * you don't return a "current" value, just the value of the most recent event
1193     // * NULL/invalid values are very much expected, and should silently _not_ trigger an event
1194     // * every update to the item should trigger an event, not just changes
1195
1196     private static ProgrammableSwitchEventCharacteristic createProgrammableSwitchEventCharacteristic(
1197             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1198         // have to build the map custom, since SINGLE_PRESS starts at 0
1199         Map<ProgrammableSwitchEnum, String> map = new EnumMap(ProgrammableSwitchEnum.class);
1200         List<ProgrammableSwitchEnum> validValues = new ArrayList<>();
1201
1202         if (taggedItem.getBaseItem().getAcceptedDataTypes().contains(OnOffType.class)) {
1203             map.put(ProgrammableSwitchEnum.SINGLE_PRESS, OnOffType.ON.toString());
1204             validValues.add(ProgrammableSwitchEnum.SINGLE_PRESS);
1205         } else if (taggedItem.getBaseItem().getAcceptedDataTypes().contains(OpenClosedType.class)) {
1206             map.put(ProgrammableSwitchEnum.SINGLE_PRESS, OpenClosedType.OPEN.toString());
1207             validValues.add(ProgrammableSwitchEnum.SINGLE_PRESS);
1208         } else {
1209             map = createMapping(taggedItem, ProgrammableSwitchEnum.class, validValues, false);
1210         }
1211
1212         var helper = new ProgrammableSwitchEventCharacteristicHelper(taggedItem, updater, map);
1213
1214         return new ProgrammableSwitchEventCharacteristic(validValues.toArray(new ProgrammableSwitchEnum[0]),
1215                 helper::getValue, helper::subscribe, getUnsubscriber(taggedItem, PROGRAMMABLE_SWITCH_EVENT, updater));
1216     }
1217
1218     private static class ProgrammableSwitchEventCharacteristicHelper {
1219         private @Nullable ProgrammableSwitchEnum lastValue = null;
1220         private final HomekitTaggedItem taggedItem;
1221         private final Map<ProgrammableSwitchEnum, String> map;
1222         private final HomekitAccessoryUpdater updater;
1223
1224         ProgrammableSwitchEventCharacteristicHelper(HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater,
1225                 Map<ProgrammableSwitchEnum, String> map) {
1226             this.taggedItem = taggedItem;
1227             this.map = map;
1228             this.updater = updater;
1229         }
1230
1231         public CompletableFuture<ProgrammableSwitchEnum> getValue() {
1232             return CompletableFuture.completedFuture(lastValue);
1233         }
1234
1235         public void subscribe(HomekitCharacteristicChangeCallback cb) {
1236             updater.subscribeToUpdates((GenericItem) taggedItem.getItem(), PROGRAMMABLE_SWITCH_EVENT.getTag(),
1237                     state -> {
1238                         // perform inversion here, so logic below only needs to deal with the
1239                         // canonical style
1240                         if (state instanceof OnOffType && taggedItem.isInverted()) {
1241                             if (state.equals(OnOffType.ON)) {
1242                                 state = OnOffType.OFF;
1243                             } else {
1244                                 state = OnOffType.ON;
1245                             }
1246                         } else if (state instanceof OpenClosedType && taggedItem.isInverted()) {
1247                             if (state.equals(OpenClosedType.OPEN)) {
1248                                 state = OpenClosedType.CLOSED;
1249                             } else {
1250                                 state = OpenClosedType.OPEN;
1251                             }
1252                         }
1253                         // if "not pressed", don't send an event
1254                         if (state instanceof UnDefType || (state instanceof OnOffType && state.equals(OnOffType.OFF))
1255                                 || (state instanceof OpenClosedType && state.equals(OpenClosedType.CLOSED))) {
1256                             lastValue = null;
1257                             return;
1258                         }
1259                         lastValue = getKeyFromMapping(taggedItem, state, map, ProgrammableSwitchEnum.SINGLE_PRESS);
1260                         cb.changed();
1261                     });
1262         }
1263     }
1264
1265     private static RemainingDurationCharacteristic createRemainingDurationCharacteristic(HomekitTaggedItem taggedItem,
1266             HomekitAccessoryUpdater updater) {
1267         return new RemainingDurationCharacteristic(getIntSupplier(taggedItem, 0),
1268                 getSubscriber(taggedItem, REMAINING_DURATION, updater),
1269                 getUnsubscriber(taggedItem, REMAINING_DURATION, updater));
1270     }
1271
1272     private static RemoteKeyCharacteristic createRemoteKeyCharacteristic(HomekitTaggedItem taggedItem,
1273             HomekitAccessoryUpdater updater) {
1274         var map = createMapping(taggedItem, RemoteKeyEnum.class);
1275         return new RemoteKeyCharacteristic((value) -> setValueFromEnum(taggedItem, value, map));
1276     }
1277
1278     private static RotationDirectionCharacteristic createRotationDirectionCharacteristic(HomekitTaggedItem taggedItem,
1279             HomekitAccessoryUpdater updater) {
1280         var map = createMapping(taggedItem, RotationDirectionEnum.class);
1281         return new RotationDirectionCharacteristic(
1282                 () -> getEnumFromItem(taggedItem, map, RotationDirectionEnum.CLOCKWISE),
1283                 (value) -> setValueFromEnum(taggedItem, value, map),
1284                 getSubscriber(taggedItem, ROTATION_DIRECTION, updater),
1285                 getUnsubscriber(taggedItem, ROTATION_DIRECTION, updater));
1286     }
1287
1288     private static RotationSpeedCharacteristic createRotationSpeedCharacteristic(HomekitTaggedItem item,
1289             HomekitAccessoryUpdater updater) {
1290         return new RotationSpeedCharacteristic(
1291                 item.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1292                         RotationSpeedCharacteristic.DEFAULT_MIN_VALUE),
1293                 item.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
1294                         RotationSpeedCharacteristic.DEFAULT_MAX_VALUE),
1295                 item.getConfigurationAsDouble(HomekitTaggedItem.STEP, RotationSpeedCharacteristic.DEFAULT_STEP),
1296                 getDoubleSupplier(item, 0), setDoubleConsumer(item), getSubscriber(item, ROTATION_SPEED, updater),
1297                 getUnsubscriber(item, ROTATION_SPEED, updater));
1298     }
1299
1300     private static SaturationCharacteristic createSaturationCharacteristic(HomekitTaggedItem taggedItem,
1301             HomekitAccessoryUpdater updater) {
1302         return new SaturationCharacteristic(() -> {
1303             double value = 0.0;
1304             State state = taggedItem.getItem().getState();
1305             if (state instanceof HSBType stateAsHSBType) {
1306                 value = stateAsHSBType.getSaturation().doubleValue();
1307             } else if (state instanceof PercentType stateAsPercentType) {
1308                 value = stateAsPercentType.doubleValue();
1309             }
1310             return CompletableFuture.completedFuture(value);
1311         }, (saturation) -> {
1312             if (taggedItem.getBaseItem() instanceof ColorItem) {
1313                 taggedItem.sendCommandProxy(HomekitCommandType.SATURATION_COMMAND,
1314                         new PercentType(saturation.intValue()));
1315             } else {
1316                 LOGGER.warn("Item type {} is not supported for {}. Only Color type is supported.",
1317                         taggedItem.getBaseItem().getType(), taggedItem.getName());
1318             }
1319         }, getSubscriber(taggedItem, SATURATION, updater), getUnsubscriber(taggedItem, SATURATION, updater));
1320     }
1321
1322     private static SerialNumberCharacteristic createSerialNumberCharacteristic(HomekitTaggedItem taggedItem,
1323             HomekitAccessoryUpdater updater) {
1324         return new SerialNumberCharacteristic(() -> {
1325             final State state = taggedItem.getItem().getState();
1326             return CompletableFuture.completedFuture(state instanceof UnDefType ? "" : state.toString());
1327         });
1328     }
1329
1330     private static SleepDiscoveryModeCharacteristic createSleepDiscoveryModeCharacteristic(HomekitTaggedItem taggedItem,
1331             HomekitAccessoryUpdater updater) {
1332         var map = createMapping(taggedItem, SleepDiscoveryModeEnum.class);
1333         return new SleepDiscoveryModeCharacteristic(
1334                 () -> getEnumFromItem(taggedItem, map, SleepDiscoveryModeEnum.ALWAYS_DISCOVERABLE),
1335                 getSubscriber(taggedItem, SLEEP_DISCOVERY_MODE, updater),
1336                 getUnsubscriber(taggedItem, SLEEP_DISCOVERY_MODE, updater));
1337     }
1338
1339     private static StatusActiveCharacteristic createStatusActiveCharacteristic(HomekitTaggedItem taggedItem,
1340             HomekitAccessoryUpdater updater) {
1341         return new StatusActiveCharacteristic(
1342                 () -> CompletableFuture.completedFuture(taggedItem.getItem().getState() == OnOffType.ON
1343                         || taggedItem.getItem().getState() == OpenClosedType.OPEN),
1344                 getSubscriber(taggedItem, ACTIVE_STATUS, updater), getUnsubscriber(taggedItem, ACTIVE_STATUS, updater));
1345     }
1346
1347     private static StatusFaultCharacteristic createStatusFaultCharacteristic(HomekitTaggedItem taggedItem,
1348             HomekitAccessoryUpdater updater) {
1349         var map = createMapping(taggedItem, StatusFaultEnum.class);
1350         return new StatusFaultCharacteristic(() -> getEnumFromItem(taggedItem, map, StatusFaultEnum.NO_FAULT),
1351                 getSubscriber(taggedItem, FAULT_STATUS, updater), getUnsubscriber(taggedItem, FAULT_STATUS, updater));
1352     }
1353
1354     private static StatusLowBatteryCharacteristic createStatusLowBatteryCharacteristic(HomekitTaggedItem taggedItem,
1355             HomekitAccessoryUpdater updater) {
1356         BigDecimal lowThreshold = taggedItem.getConfiguration(HomekitTaggedItem.BATTERY_LOW_THRESHOLD,
1357                 BigDecimal.valueOf(20));
1358         BooleanItemReader lowBatteryReader = new BooleanItemReader(taggedItem.getItem(),
1359                 OnOffType.from(!taggedItem.isInverted()),
1360                 taggedItem.isInverted() ? OpenClosedType.CLOSED : OpenClosedType.OPEN, lowThreshold, true);
1361         return new StatusLowBatteryCharacteristic(
1362                 () -> CompletableFuture.completedFuture(
1363                         lowBatteryReader.getValue() ? StatusLowBatteryEnum.LOW : StatusLowBatteryEnum.NORMAL),
1364                 getSubscriber(taggedItem, BATTERY_LOW_STATUS, updater),
1365                 getUnsubscriber(taggedItem, BATTERY_LOW_STATUS, updater));
1366     }
1367
1368     private static StatusTamperedCharacteristic createStatusTamperedCharacteristic(HomekitTaggedItem taggedItem,
1369             HomekitAccessoryUpdater updater) {
1370         var map = createMapping(taggedItem, StatusTamperedEnum.class);
1371         return new StatusTamperedCharacteristic(() -> getEnumFromItem(taggedItem, map, StatusTamperedEnum.NOT_TAMPERED),
1372                 getSubscriber(taggedItem, TAMPERED_STATUS, updater),
1373                 getUnsubscriber(taggedItem, TAMPERED_STATUS, updater));
1374     }
1375
1376     private static SulphurDioxideDensityCharacteristic createSulphurDioxideDensityCharacteristic(
1377             final HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1378         return new SulphurDioxideDensityCharacteristic(
1379                 getDoubleSupplier(taggedItem,
1380                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1381                                 SulphurDioxideDensityCharacteristic.DEFAULT_MIN_VALUE)),
1382                 getSubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater),
1383                 getUnsubscriber(taggedItem, SULPHUR_DIOXIDE_DENSITY, updater));
1384     }
1385
1386     private static SwingModeCharacteristic createSwingModeCharacteristic(HomekitTaggedItem taggedItem,
1387             HomekitAccessoryUpdater updater) {
1388         var map = createMapping(taggedItem, SwingModeEnum.class);
1389         return new SwingModeCharacteristic(() -> getEnumFromItem(taggedItem, map, SwingModeEnum.SWING_DISABLED),
1390                 (value) -> setValueFromEnum(taggedItem, value, map), getSubscriber(taggedItem, SWING_MODE, updater),
1391                 getUnsubscriber(taggedItem, SWING_MODE, updater));
1392     }
1393
1394     private static TargetDoorStateCharacteristic createTargetDoorStateCharacteristic(HomekitTaggedItem taggedItem,
1395             HomekitAccessoryUpdater updater) {
1396         List<TargetDoorStateEnum> validValues = new ArrayList<>();
1397         var map = createMapping(taggedItem, TargetDoorStateEnum.class, validValues);
1398         return new TargetDoorStateCharacteristic(() -> getEnumFromItem(taggedItem, map, TargetDoorStateEnum.CLOSED),
1399                 (targetState) -> setValueFromEnum(taggedItem, targetState, map),
1400                 getSubscriber(taggedItem, TARGET_DOOR_STATE, updater),
1401                 getUnsubscriber(taggedItem, TARGET_DOOR_STATE, updater));
1402     }
1403
1404     private static TargetFanStateCharacteristic createTargetFanStateCharacteristic(HomekitTaggedItem taggedItem,
1405             HomekitAccessoryUpdater updater) {
1406         var map = createMapping(taggedItem, TargetFanStateEnum.class);
1407         return new TargetFanStateCharacteristic(() -> getEnumFromItem(taggedItem, map, TargetFanStateEnum.AUTO),
1408                 (targetState) -> setValueFromEnum(taggedItem, targetState, map),
1409                 getSubscriber(taggedItem, TARGET_FAN_STATE, updater),
1410                 getUnsubscriber(taggedItem, TARGET_FAN_STATE, updater));
1411     }
1412
1413     private static TargetHeatingCoolingStateCharacteristic createTargetHeatingCoolingStateCharacteristic(
1414             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1415         List<TargetHeatingCoolingStateEnum> validValues = new ArrayList<>();
1416         var map = createMapping(taggedItem, TargetHeatingCoolingStateEnum.class, validValues);
1417         return new TargetHeatingCoolingStateCharacteristic(validValues.toArray(new TargetHeatingCoolingStateEnum[0]),
1418                 () -> getEnumFromItem(taggedItem, map, TargetHeatingCoolingStateEnum.OFF),
1419                 (value) -> setValueFromEnum(taggedItem, value, map),
1420                 getSubscriber(taggedItem, TARGET_HEATING_COOLING_STATE, updater),
1421                 getUnsubscriber(taggedItem, TARGET_HEATING_COOLING_STATE, updater));
1422     }
1423
1424     private static TargetHorizontalTiltAngleCharacteristic createTargetHorizontalTiltAngleCharacteristic(
1425             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1426         return new TargetHorizontalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0),
1427                 setAngleConsumer(taggedItem), getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
1428                 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
1429     }
1430
1431     private static TargetMediaStateCharacteristic createTargetMediaStateCharacteristic(HomekitTaggedItem taggedItem,
1432             HomekitAccessoryUpdater updater) {
1433         var map = createMapping(taggedItem, TargetMediaStateEnum.class);
1434         return new TargetMediaStateCharacteristic(() -> getEnumFromItem(taggedItem, map, TargetMediaStateEnum.STOP),
1435                 (value) -> setValueFromEnum(taggedItem, value, map),
1436                 getSubscriber(taggedItem, TARGET_MEDIA_STATE, updater),
1437                 getUnsubscriber(taggedItem, TARGET_MEDIA_STATE, updater));
1438     }
1439
1440     private static TargetRelativeHumidityCharacteristic createTargetRelativeHumidityCharacteristic(
1441             HomekitTaggedItem item, HomekitAccessoryUpdater updater) {
1442         return new TargetRelativeHumidityCharacteristic(getDoubleSupplier(item, 0), setDoubleConsumer(item),
1443                 getSubscriber(item, TARGET_RELATIVE_HUMIDITY, updater),
1444                 getUnsubscriber(item, TARGET_RELATIVE_HUMIDITY, updater));
1445     }
1446
1447     private static TargetTemperatureCharacteristic createTargetTemperatureCharacteristic(HomekitTaggedItem taggedItem,
1448             HomekitAccessoryUpdater updater) {
1449         double minValue = taggedItem
1450                 .getConfigurationAsQuantity(HomekitTaggedItem.MIN_VALUE,
1451                         Objects.requireNonNull(
1452                                 new QuantityType(TargetTemperatureCharacteristic.DEFAULT_MIN_VALUE, SIUnits.CELSIUS)
1453                                         .toUnit(getSystemTemperatureUnit())),
1454                         false)
1455                 .toUnit(SIUnits.CELSIUS).doubleValue();
1456         double maxValue = taggedItem
1457                 .getConfigurationAsQuantity(HomekitTaggedItem.MAX_VALUE,
1458                         Objects.requireNonNull(
1459                                 new QuantityType(TargetTemperatureCharacteristic.DEFAULT_MAX_VALUE, SIUnits.CELSIUS)
1460                                         .toUnit(getSystemTemperatureUnit())),
1461                         false)
1462                 .toUnit(SIUnits.CELSIUS).doubleValue();
1463         double step = taggedItem
1464                 .getConfigurationAsQuantity(HomekitTaggedItem.STEP,
1465                         Objects.requireNonNull(
1466                                 new QuantityType(TargetTemperatureCharacteristic.DEFAULT_STEP, SIUnits.CELSIUS)
1467                                         .toUnit(getSystemTemperatureUnit())),
1468                         true)
1469                 .toUnit(SIUnits.CELSIUS).doubleValue();
1470         return new TargetTemperatureCharacteristic(minValue, maxValue, step,
1471                 getTemperatureSupplier(taggedItem, minValue), setTemperatureConsumer(taggedItem),
1472                 getSubscriber(taggedItem, TARGET_TEMPERATURE, updater),
1473                 getUnsubscriber(taggedItem, TARGET_TEMPERATURE, updater));
1474     }
1475
1476     private static TargetTiltAngleCharacteristic createTargetTiltAngleCharacteristic(HomekitTaggedItem taggedItem,
1477             HomekitAccessoryUpdater updater) {
1478         return new TargetTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0), setAngleConsumer(taggedItem),
1479                 getSubscriber(taggedItem, TARGET_TILT_ANGLE, updater),
1480                 getUnsubscriber(taggedItem, TARGET_TILT_ANGLE, updater));
1481     }
1482
1483     private static TargetVerticalTiltAngleCharacteristic createTargetVerticalTiltAngleCharacteristic(
1484             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1485         return new TargetVerticalTiltAngleCharacteristic(getAngleSupplier(taggedItem, 0), setAngleConsumer(taggedItem),
1486                 getSubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater),
1487                 getUnsubscriber(taggedItem, TARGET_HORIZONTAL_TILT_ANGLE, updater));
1488     }
1489
1490     private static TargetVisibilityStateCharacteristic createTargetVisibilityStateCharacteristic(
1491             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1492         var map = createMapping(taggedItem, TargetVisibilityStateEnum.class, true);
1493         return new TargetVisibilityStateCharacteristic(
1494                 () -> getEnumFromItem(taggedItem, map, TargetVisibilityStateEnum.HIDDEN),
1495                 (value) -> setValueFromEnum(taggedItem, value, map),
1496                 getSubscriber(taggedItem, TARGET_VISIBILITY_STATE, updater),
1497                 getUnsubscriber(taggedItem, TARGET_VISIBILITY_STATE, updater));
1498     }
1499
1500     private static TemperatureDisplayUnitCharacteristic createTemperatureDisplayUnitCharacteristic(
1501             HomekitTaggedItem taggedItem, HomekitAccessoryUpdater updater) {
1502         var map = createMapping(taggedItem, TemperatureDisplayUnitEnum.class, true);
1503         return new TemperatureDisplayUnitCharacteristic(
1504                 () -> getEnumFromItem(taggedItem, map,
1505                         useFahrenheit() ? TemperatureDisplayUnitEnum.FAHRENHEIT : TemperatureDisplayUnitEnum.CELSIUS),
1506                 (value) -> setValueFromEnum(taggedItem, value, map),
1507                 getSubscriber(taggedItem, TEMPERATURE_UNIT, updater),
1508                 getUnsubscriber(taggedItem, TEMPERATURE_UNIT, updater));
1509     }
1510
1511     private static VOCDensityCharacteristic createVOCDensityCharacteristic(final HomekitTaggedItem taggedItem,
1512             HomekitAccessoryUpdater updater) {
1513         return new VOCDensityCharacteristic(
1514                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1515                         VOCDensityCharacteristic.DEFAULT_MIN_VALUE),
1516                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MAX_VALUE,
1517                         VOCDensityCharacteristic.DEFAULT_MAX_VALUE),
1518                 taggedItem.getConfigurationAsDouble(HomekitTaggedItem.STEP, VOCDensityCharacteristic.DEFAULT_STEP),
1519                 getDoubleSupplier(taggedItem,
1520                         taggedItem.getConfigurationAsDouble(HomekitTaggedItem.MIN_VALUE,
1521                                 VOCDensityCharacteristic.DEFAULT_MIN_VALUE)),
1522                 getSubscriber(taggedItem, VOC_DENSITY, updater), getUnsubscriber(taggedItem, VOC_DENSITY, updater));
1523     }
1524
1525     private static VolumeCharacteristic createVolumeCharacteristic(HomekitTaggedItem taggedItem,
1526             HomekitAccessoryUpdater updater) {
1527         return new VolumeCharacteristic(getIntSupplier(taggedItem, 0),
1528                 (volume) -> ((NumberItem) taggedItem.getItem()).send(new DecimalType(volume)),
1529                 getSubscriber(taggedItem, DURATION, updater), getUnsubscriber(taggedItem, DURATION, updater));
1530     }
1531
1532     private static VolumeSelectorCharacteristic createVolumeSelectorCharacteristic(HomekitTaggedItem taggedItem,
1533             HomekitAccessoryUpdater updater) {
1534         if (taggedItem.getItem() instanceof DimmerItem) {
1535             return new VolumeSelectorCharacteristic((value) -> taggedItem
1536                     .send(value.equals(VolumeSelectorEnum.INCREMENT) ? IncreaseDecreaseType.INCREASE
1537                             : IncreaseDecreaseType.DECREASE));
1538         } else {
1539             var map = createMapping(taggedItem, VolumeSelectorEnum.class);
1540             return new VolumeSelectorCharacteristic((value) -> setValueFromEnum(taggedItem, value, map));
1541         }
1542     }
1543
1544     private static VolumeControlTypeCharacteristic createVolumeControlTypeCharacteristic(HomekitTaggedItem taggedItem,
1545             HomekitAccessoryUpdater updater) {
1546         var map = createMapping(taggedItem, VolumeControlTypeEnum.class);
1547         return new VolumeControlTypeCharacteristic(() -> getEnumFromItem(taggedItem, map, VolumeControlTypeEnum.NONE),
1548                 getSubscriber(taggedItem, VOLUME_CONTROL_TYPE, updater),
1549                 getUnsubscriber(taggedItem, VOLUME_CONTROL_TYPE, updater));
1550     }
1551 }