2 * Copyright (c) 2010-2021 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.avmfritz.internal.handler;
15 import static org.openhab.binding.avmfritz.internal.AVMFritzBindingConstants.*;
16 import static org.openhab.binding.avmfritz.internal.dto.HeatingModel.*;
18 import java.math.BigDecimal;
19 import java.time.Instant;
20 import java.time.ZoneId;
21 import java.time.ZonedDateTime;
24 import javax.measure.quantity.Temperature;
26 import org.eclipse.jdt.annotation.NonNullByDefault;
27 import org.eclipse.jdt.annotation.Nullable;
28 import org.openhab.binding.avmfritz.internal.config.AVMFritzDeviceConfiguration;
29 import org.openhab.binding.avmfritz.internal.dto.AVMFritzBaseModel;
30 import org.openhab.binding.avmfritz.internal.dto.AlertModel;
31 import org.openhab.binding.avmfritz.internal.dto.BatteryModel;
32 import org.openhab.binding.avmfritz.internal.dto.ColorControlModel;
33 import org.openhab.binding.avmfritz.internal.dto.DeviceModel;
34 import org.openhab.binding.avmfritz.internal.dto.HeatingModel;
35 import org.openhab.binding.avmfritz.internal.dto.HeatingModel.NextChangeModel;
36 import org.openhab.binding.avmfritz.internal.dto.HumidityModel;
37 import org.openhab.binding.avmfritz.internal.dto.LevelControlModel;
38 import org.openhab.binding.avmfritz.internal.dto.PowerMeterModel;
39 import org.openhab.binding.avmfritz.internal.dto.SimpleOnOffModel;
40 import org.openhab.binding.avmfritz.internal.dto.SwitchModel;
41 import org.openhab.binding.avmfritz.internal.dto.TemperatureModel;
42 import org.openhab.binding.avmfritz.internal.hardware.FritzAhaStatusListener;
43 import org.openhab.binding.avmfritz.internal.hardware.FritzAhaWebInterface;
44 import org.openhab.binding.avmfritz.internal.hardware.callbacks.FritzAhaSetBlindTargetCallback.BlindCommand;
45 import org.openhab.core.config.core.Configuration;
46 import org.openhab.core.library.types.DateTimeType;
47 import org.openhab.core.library.types.DecimalType;
48 import org.openhab.core.library.types.HSBType;
49 import org.openhab.core.library.types.IncreaseDecreaseType;
50 import org.openhab.core.library.types.OnOffType;
51 import org.openhab.core.library.types.OpenClosedType;
52 import org.openhab.core.library.types.PercentType;
53 import org.openhab.core.library.types.QuantityType;
54 import org.openhab.core.library.types.StopMoveType;
55 import org.openhab.core.library.types.StringType;
56 import org.openhab.core.library.types.UpDownType;
57 import org.openhab.core.library.unit.SIUnits;
58 import org.openhab.core.library.unit.Units;
59 import org.openhab.core.thing.Bridge;
60 import org.openhab.core.thing.Channel;
61 import org.openhab.core.thing.ChannelUID;
62 import org.openhab.core.thing.DefaultSystemChannelTypeProvider;
63 import org.openhab.core.thing.Thing;
64 import org.openhab.core.thing.ThingStatus;
65 import org.openhab.core.thing.ThingStatusDetail;
66 import org.openhab.core.thing.ThingUID;
67 import org.openhab.core.thing.binding.BaseThingHandler;
68 import org.openhab.core.thing.binding.BridgeHandler;
69 import org.openhab.core.thing.binding.ThingHandlerCallback;
70 import org.openhab.core.thing.type.ChannelTypeUID;
71 import org.openhab.core.types.Command;
72 import org.openhab.core.types.RefreshType;
73 import org.openhab.core.types.State;
74 import org.openhab.core.types.UnDefType;
75 import org.slf4j.Logger;
76 import org.slf4j.LoggerFactory;
79 * Abstract handler for a FRITZ! thing. Handles commands, which are sent to one of the channels.
81 * @author Robert Bausdorf - Initial contribution
82 * @author Christoph Weitkamp - Added support for AVM FRITZ!DECT 300 and Comet DECT
83 * @author Christoph Weitkamp - Added support for groups
84 * @author Ulrich Mertin - Added support for HAN-FUN blinds
87 public abstract class AVMFritzBaseThingHandler extends BaseThingHandler implements FritzAhaStatusListener {
89 private final Logger logger = LoggerFactory.getLogger(AVMFritzBaseThingHandler.class);
92 * keeps track of the current state for handling of increase/decrease
94 private @Nullable AVMFritzBaseModel state;
95 private @Nullable String identifier;
100 * @param thing Thing object representing a FRITZ! device
102 public AVMFritzBaseThingHandler(Thing thing) {
107 public void initialize() {
108 final AVMFritzDeviceConfiguration config = getConfigAs(AVMFritzDeviceConfiguration.class);
109 final String newIdentifier = config.ain;
110 if (newIdentifier == null || newIdentifier.isBlank()) {
111 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
112 "The 'ain' parameter must be configured.");
114 this.identifier = newIdentifier;
115 updateStatus(ThingStatus.UNKNOWN);
120 public void onDeviceAdded(AVMFritzBaseModel device) {
125 public void onDeviceUpdated(ThingUID thingUID, AVMFritzBaseModel device) {
126 if (thing.getUID().equals(thingUID)) {
127 logger.debug("Update thing '{}' with device model: {}", thingUID, device);
128 if (device.getPresent() == 1) {
129 updateStatus(ThingStatus.ONLINE);
131 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.NONE, "Device not present");
135 updateProperties(device, editProperties());
137 if (device.isPowermeter()) {
138 updatePowermeter(device.getPowermeter());
140 if (device.isSwitchableOutlet()) {
141 updateSwitchableOutlet(device.getSwitch());
143 if (device.isHeatingThermostat()) {
144 updateHeatingThermostat(device.getHkr());
146 if (device.isHANFUNUnit() && device.isHANFUNOnOff()) {
147 updateSimpleOnOffUnit(device.getSimpleOnOffUnit());
149 if (device instanceof DeviceModel) {
150 DeviceModel deviceModel = (DeviceModel) device;
151 if (deviceModel.isTemperatureSensor()) {
152 updateTemperatureSensor(deviceModel.getTemperature());
154 if (deviceModel.isHumiditySensor()) {
155 updateHumiditySensor(deviceModel.getHumidity());
157 if (deviceModel.isHANFUNAlarmSensor()) {
158 updateHANFUNAlarmSensor(deviceModel.getAlert());
160 if (deviceModel.isHANFUNBlinds()) {
161 updateLevelControl(deviceModel.getLevelControlModel());
163 if (deviceModel.isColorLight()) {
164 updateColorLight(deviceModel.getColorControlModel(), deviceModel.getLevelControlModel());
165 } else if (deviceModel.isDimmableLight()) {
166 updateDimmableLight(deviceModel.getLevelControlModel());
172 private void updateHANFUNAlarmSensor(@Nullable AlertModel alertModel) {
173 if (alertModel != null) {
174 updateThingChannelState(CHANNEL_CONTACT_STATE,
175 AlertModel.ON.equals(alertModel.getState()) ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
179 protected void updateTemperatureSensor(@Nullable TemperatureModel temperatureModel) {
180 if (temperatureModel != null) {
181 updateThingChannelState(CHANNEL_TEMPERATURE,
182 new QuantityType<>(temperatureModel.getCelsius(), SIUnits.CELSIUS));
183 updateThingChannelConfiguration(CHANNEL_TEMPERATURE, CONFIG_CHANNEL_TEMP_OFFSET,
184 temperatureModel.getOffset());
188 protected void updateHumiditySensor(@Nullable HumidityModel humidityModel) {
189 if (humidityModel != null) {
190 updateThingChannelState(CHANNEL_HUMIDITY,
191 new QuantityType<>(humidityModel.getRelativeHumidity(), Units.PERCENT));
195 protected void updateLevelControl(@Nullable LevelControlModel levelControlModel) {
196 if (levelControlModel != null) {
197 updateThingChannelState(CHANNEL_ROLLERSHUTTER, new PercentType(levelControlModel.getLevelPercentage()));
201 private void updateDimmableLight(@Nullable LevelControlModel levelControlModel) {
202 if (levelControlModel != null) {
203 updateThingChannelState(CHANNEL_BRIGHTNESS, new PercentType(levelControlModel.getLevelPercentage()));
207 private void updateColorLight(@Nullable ColorControlModel colorControlModel,
208 @Nullable LevelControlModel levelControlModel) {
209 if (colorControlModel != null && levelControlModel != null) {
210 DecimalType hue = new DecimalType(colorControlModel.hue);
211 PercentType saturation = new PercentType(colorControlModel.saturation);
212 PercentType brightness = new PercentType(levelControlModel.getLevelPercentage());
213 updateThingChannelState(CHANNEL_COLOR, new HSBType(hue, saturation, brightness));
214 updateThingChannelState(CHANNEL_BRIGHTNESS, brightness);
218 private void updateHeatingThermostat(@Nullable HeatingModel heatingModel) {
219 if (heatingModel != null) {
220 updateThingChannelState(CHANNEL_MODE, new StringType(heatingModel.getMode()));
221 updateThingChannelState(CHANNEL_LOCKED,
222 BigDecimal.ZERO.equals(heatingModel.getLock()) ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
223 updateThingChannelState(CHANNEL_DEVICE_LOCKED,
224 BigDecimal.ZERO.equals(heatingModel.getDevicelock()) ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
225 updateThingChannelState(CHANNEL_ACTUALTEMP,
226 new QuantityType<>(toCelsius(heatingModel.getTist()), SIUnits.CELSIUS));
227 updateThingChannelState(CHANNEL_SETTEMP,
228 new QuantityType<>(toCelsius(heatingModel.getTsoll()), SIUnits.CELSIUS));
229 updateThingChannelState(CHANNEL_ECOTEMP,
230 new QuantityType<>(toCelsius(heatingModel.getAbsenk()), SIUnits.CELSIUS));
231 updateThingChannelState(CHANNEL_COMFORTTEMP,
232 new QuantityType<>(toCelsius(heatingModel.getKomfort()), SIUnits.CELSIUS));
233 updateThingChannelState(CHANNEL_RADIATOR_MODE, new StringType(heatingModel.getRadiatorMode()));
234 NextChangeModel nextChange = heatingModel.getNextchange();
235 if (nextChange != null) {
236 int endPeriod = nextChange.getEndperiod();
237 updateThingChannelState(CHANNEL_NEXT_CHANGE, endPeriod == 0 ? UnDefType.UNDEF
239 ZonedDateTime.ofInstant(Instant.ofEpochSecond(endPeriod), ZoneId.systemDefault())));
240 BigDecimal nextTemperature = nextChange.getTchange();
241 updateThingChannelState(CHANNEL_NEXTTEMP, TEMP_FRITZ_UNDEFINED.equals(nextTemperature) ? UnDefType.UNDEF
242 : new QuantityType<>(toCelsius(nextTemperature), SIUnits.CELSIUS));
244 updateBattery(heatingModel);
248 protected void updateBattery(BatteryModel batteryModel) {
249 BigDecimal batteryLevel = batteryModel.getBattery();
250 updateThingChannelState(CHANNEL_BATTERY,
251 batteryLevel == null ? UnDefType.UNDEF : new DecimalType(batteryLevel));
252 BigDecimal lowBattery = batteryModel.getBatterylow();
253 if (lowBattery == null) {
254 updateThingChannelState(CHANNEL_BATTERY_LOW, UnDefType.UNDEF);
256 updateThingChannelState(CHANNEL_BATTERY_LOW, OnOffType.from(BatteryModel.BATTERY_ON.equals(lowBattery)));
260 private void updateSimpleOnOffUnit(@Nullable SimpleOnOffModel simpleOnOffUnit) {
261 if (simpleOnOffUnit != null) {
262 updateThingChannelState(CHANNEL_ON_OFF, OnOffType.from(simpleOnOffUnit.state));
266 private void updateSwitchableOutlet(@Nullable SwitchModel switchModel) {
267 if (switchModel != null) {
268 updateThingChannelState(CHANNEL_MODE, new StringType(switchModel.getMode()));
269 updateThingChannelState(CHANNEL_LOCKED,
270 BigDecimal.ZERO.equals(switchModel.getLock()) ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
271 updateThingChannelState(CHANNEL_DEVICE_LOCKED,
272 BigDecimal.ZERO.equals(switchModel.getDevicelock()) ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
273 BigDecimal state = switchModel.getState();
275 updateThingChannelState(CHANNEL_OUTLET, UnDefType.UNDEF);
277 updateThingChannelState(CHANNEL_OUTLET, OnOffType.from(SwitchModel.ON.equals(state)));
282 private void updatePowermeter(@Nullable PowerMeterModel powerMeterModel) {
283 if (powerMeterModel != null) {
284 updateThingChannelState(CHANNEL_ENERGY, new QuantityType<>(powerMeterModel.getEnergy(), Units.WATT_HOUR));
285 updateThingChannelState(CHANNEL_POWER, new QuantityType<>(powerMeterModel.getPower(), Units.WATT));
286 updateThingChannelState(CHANNEL_VOLTAGE, new QuantityType<>(powerMeterModel.getVoltage(), Units.VOLT));
291 * Updates thing properties.
293 * @param device the {@link AVMFritzBaseModel}
294 * @param editProperties map of existing properties
296 protected void updateProperties(AVMFritzBaseModel device, Map<String, String> editProperties) {
297 editProperties.put(Thing.PROPERTY_FIRMWARE_VERSION, device.getFirmwareVersion());
298 updateProperties(editProperties);
302 * Updates thing channels and creates dynamic channels if missing.
304 * @param channelId ID of the channel to be updated.
305 * @param state State to be set.
307 protected void updateThingChannelState(String channelId, State state) {
308 Channel channel = thing.getChannel(channelId);
309 if (channel != null) {
310 updateState(channel.getUID(), state);
312 logger.debug("Channel '{}' in thing '{}' does not exist, recreating thing.", channelId, thing.getUID());
313 createChannel(channelId);
318 * Creates a {@link ChannelTypeUID} from the given channel id.
320 * @param channelId ID of the channel type UID to be created.
321 * @return the channel type UID
323 private ChannelTypeUID createChannelTypeUID(String channelId) {
324 int pos = channelId.indexOf(ChannelUID.CHANNEL_GROUP_SEPARATOR);
325 String id = pos > -1 ? channelId.substring(pos + 1) : channelId;
326 return CHANNEL_BATTERY.equals(id) ? DefaultSystemChannelTypeProvider.SYSTEM_CHANNEL_BATTERY_LEVEL.getUID()
327 : new ChannelTypeUID(BINDING_ID, id);
331 * Creates new channels for the thing.
333 * @param channelId ID of the channel to be created.
335 private void createChannel(String channelId) {
336 ThingHandlerCallback callback = getCallback();
337 if (callback != null) {
338 ChannelUID channelUID = new ChannelUID(thing.getUID(), channelId);
339 ChannelTypeUID channelTypeUID = createChannelTypeUID(channelId);
340 Channel channel = callback.createChannelBuilder(channelUID, channelTypeUID).build();
341 updateThing(editThing().withoutChannel(channelUID).withChannel(channel).build());
346 * Updates thing channel configurations.
348 * @param channelId ID of the channel which configuration to be updated.
349 * @param configId ID of the configuration to be updated.
350 * @param value Value to be set.
352 protected void updateThingChannelConfiguration(String channelId, String configId, Object value) {
353 Channel channel = thing.getChannel(channelId);
354 if (channel != null) {
355 Configuration editConfig = channel.getConfiguration();
356 editConfig.put(configId, value);
361 public void onDeviceGone(ThingUID thingUID) {
362 if (thing.getUID().equals(thingUID)) {
363 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.GONE, "Device not present in response");
368 public void handleCommand(ChannelUID channelUID, Command command) {
369 String channelId = channelUID.getIdWithoutGroup();
370 logger.debug("Handle command '{}' for channel {}", command, channelId);
371 if (command == RefreshType.REFRESH) {
372 handleRefreshCommand();
375 FritzAhaWebInterface fritzBox = getWebInterface();
376 if (fritzBox == null) {
377 logger.debug("Cannot handle command '{}' because connection is missing", command);
380 String ain = getIdentifier();
382 logger.debug("Cannot handle command '{}' because AIN is missing", command);
388 case CHANNEL_DEVICE_LOCKED:
389 case CHANNEL_TEMPERATURE:
390 case CHANNEL_HUMIDITY:
393 case CHANNEL_VOLTAGE:
394 case CHANNEL_ACTUALTEMP:
395 case CHANNEL_ECOTEMP:
396 case CHANNEL_COMFORTTEMP:
397 case CHANNEL_NEXT_CHANGE:
398 case CHANNEL_NEXTTEMP:
399 case CHANNEL_BATTERY:
400 case CHANNEL_BATTERY_LOW:
401 case CHANNEL_CONTACT_STATE:
402 case CHANNEL_LAST_CHANGE:
403 logger.debug("Channel {} is a read-only channel and cannot handle command '{}'", channelId, command);
407 if (command instanceof OnOffType) {
408 fritzBox.setSwitch(ain, OnOffType.ON.equals(command));
412 case CHANNEL_BRIGHTNESS:
413 BigDecimal brightness = null;
414 if (command instanceof HSBType) {
415 HSBType hsbType = (HSBType) command;
416 brightness = hsbType.getBrightness().toBigDecimal();
417 fritzBox.setHueAndSaturation(ain, hsbType.getHue().intValue(), hsbType.getSaturation().intValue(),
419 } else if (command instanceof PercentType) {
420 brightness = ((PercentType) command).toBigDecimal();
422 if (brightness != null) {
423 fritzBox.setLevelPercentage(ain, brightness);
426 case CHANNEL_SETTEMP:
427 BigDecimal temperature = null;
428 if (command instanceof DecimalType) {
429 temperature = normalizeCelsius(((DecimalType) command).toBigDecimal());
430 } else if (command instanceof QuantityType) {
431 @SuppressWarnings("unchecked")
432 QuantityType<Temperature> convertedCommand = ((QuantityType<Temperature>) command)
433 .toUnit(SIUnits.CELSIUS);
434 if (convertedCommand != null) {
435 temperature = normalizeCelsius(convertedCommand.toBigDecimal());
437 logger.warn("Unable to convert unit from '{}' to '{}'. Skipping command.",
438 ((QuantityType<?>) command).getUnit(), SIUnits.CELSIUS);
440 } else if (command instanceof IncreaseDecreaseType) {
441 temperature = state.getHkr().getTsoll();
442 if (IncreaseDecreaseType.INCREASE.equals(command)) {
443 temperature.add(BigDecimal.ONE);
445 temperature.subtract(BigDecimal.ONE);
447 } else if (command instanceof OnOffType) {
448 temperature = OnOffType.ON.equals(command) ? TEMP_FRITZ_ON : TEMP_FRITZ_OFF;
450 if (temperature != null) {
451 fritzBox.setSetTemp(ain, fromCelsius(temperature));
452 HeatingModel heatingModel = state.getHkr();
453 heatingModel.setTsoll(temperature);
454 updateState(CHANNEL_RADIATOR_MODE, new StringType(heatingModel.getRadiatorMode()));
457 case CHANNEL_RADIATOR_MODE:
458 BigDecimal targetTemperature = null;
459 if (command instanceof StringType) {
460 switch (command.toString()) {
462 targetTemperature = TEMP_FRITZ_ON;
465 targetTemperature = TEMP_FRITZ_OFF;
468 targetTemperature = state.getHkr().getKomfort();
471 targetTemperature = state.getHkr().getAbsenk();
474 targetTemperature = TEMP_FRITZ_MAX;
477 case MODE_WINDOW_OPEN:
478 logger.debug("Command '{}' is a read-only command for channel {}.", command, channelId);
481 if (targetTemperature != null) {
482 fritzBox.setSetTemp(ain, targetTemperature);
483 state.getHkr().setTsoll(targetTemperature);
484 updateState(CHANNEL_SETTEMP, new QuantityType<>(toCelsius(targetTemperature), SIUnits.CELSIUS));
488 case CHANNEL_ROLLERSHUTTER:
489 if (command instanceof StopMoveType) {
490 StopMoveType rollershutterCommand = (StopMoveType) command;
491 if (StopMoveType.STOP.equals(rollershutterCommand)) {
492 fritzBox.setBlind(ain, BlindCommand.STOP);
494 logger.debug("Received unknown rollershutter StopMove command MOVE");
496 } else if (command instanceof UpDownType) {
497 UpDownType rollershutterCommand = (UpDownType) command;
498 if (UpDownType.UP.equals(rollershutterCommand)) {
499 fritzBox.setBlind(ain, BlindCommand.OPEN);
501 fritzBox.setBlind(ain, BlindCommand.CLOSE);
503 } else if (command instanceof PercentType) {
504 BigDecimal levelPercentage = ((PercentType) command).toBigDecimal();
505 fritzBox.setLevelPercentage(ain, levelPercentage);
507 logger.debug("Received unknown rollershutter command type '{}'", command.toString());
511 logger.debug("Received unknown channel {}", channelId);
517 * Handles a command for a given action.
522 protected void handleAction(String action, long duration) {
523 FritzAhaWebInterface fritzBox = getWebInterface();
524 if (fritzBox == null) {
525 logger.debug("Cannot handle action '{}' because connection is missing", action);
528 String ain = getIdentifier();
530 logger.debug("Cannot handle action '{}' because AIN is missing", action);
533 if (duration < 0 || 86400 < duration) {
534 throw new IllegalArgumentException("Duration must not be less than zero or greater than 86400");
538 fritzBox.setBoostMode(ain,
539 duration > 0 ? ZonedDateTime.now().plusSeconds(duration).toEpochSecond() : 0);
541 case MODE_WINDOW_OPEN:
542 fritzBox.setWindowOpenMode(ain,
543 duration > 0 ? ZonedDateTime.now().plusSeconds(duration).toEpochSecond() : 0);
546 logger.debug("Received unknown action '{}'", action);
552 * Provides the web interface object.
554 * @return The web interface object
556 private @Nullable FritzAhaWebInterface getWebInterface() {
557 Bridge bridge = getBridge();
558 if (bridge != null) {
559 BridgeHandler handler = bridge.getHandler();
560 if (handler instanceof AVMFritzBaseBridgeHandler) {
561 return ((AVMFritzBaseBridgeHandler) handler).getWebInterface();
568 * Handles a refresh command.
570 private void handleRefreshCommand() {
571 Bridge bridge = getBridge();
572 if (bridge != null) {
573 BridgeHandler handler = bridge.getHandler();
574 if (handler instanceof AVMFritzBaseBridgeHandler) {
575 ((AVMFritzBaseBridgeHandler) handler).handleRefreshCommand();
585 public @Nullable String getIdentifier() {