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

   1 /**
   2  * Copyright (c) 2010-2022 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.binding.plugwiseha.internal.handler;
  14
  15 import static org.openhab.binding.plugwiseha.internal.PlugwiseHABindingConstants.*;
  16 import static org.openhab.core.thing.ThingStatus.*;
  17 import static org.openhab.core.thing.ThingStatusDetail.BRIDGE_OFFLINE;
  18 import static org.openhab.core.thing.ThingStatusDetail.COMMUNICATION_ERROR;
  19 import static org.openhab.core.thing.ThingStatusDetail.CONFIGURATION_ERROR;
  20
  21 import java.util.Map;
  22 import java.util.Optional;
  23
  24 import javax.measure.Unit;
  25 import javax.measure.quantity.Temperature;
  26
  27 import org.eclipse.jdt.annotation.NonNullByDefault;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.openhab.binding.plugwiseha.internal.PlugwiseHABindingConstants;
  30 import org.openhab.binding.plugwiseha.internal.api.exception.PlugwiseHAException;
  31 import org.openhab.binding.plugwiseha.internal.api.model.PlugwiseHAController;
  32 import org.openhab.binding.plugwiseha.internal.api.model.dto.Location;
  33 import org.openhab.binding.plugwiseha.internal.config.PlugwiseHAThingConfig;
  34 import org.openhab.core.library.types.OnOffType;
  35 import org.openhab.core.library.types.QuantityType;
  36 import org.openhab.core.library.types.StringType;
  37 import org.openhab.core.library.unit.ImperialUnits;
  38 import org.openhab.core.library.unit.SIUnits;
  39 import org.openhab.core.thing.ChannelUID;
  40 import org.openhab.core.thing.Thing;
  41 import org.openhab.core.thing.ThingTypeUID;
  42 import org.openhab.core.types.Command;
  43 import org.openhab.core.types.State;
  44 import org.openhab.core.types.UnDefType;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * The {@link PlugwiseHAZoneHandler} class is responsible for handling commands
  50  * and status updates for the Plugwise Home Automation zones/locations.
  51  * Extends @{link PlugwiseHABaseHandler}
  52  *
  53  * @author Bas van Wetten - Initial contribution
  54  * @author Leo Siepel - finish initial contribution
  55  *
  56  */
  57
  58 @NonNullByDefault
  59 public class PlugwiseHAZoneHandler extends PlugwiseHABaseHandler<Location, PlugwiseHAThingConfig> {
  60
  61     private @Nullable Location location;
  62     private final Logger logger = LoggerFactory.getLogger(PlugwiseHAZoneHandler.class);
  63
  64     // Constructor
  65
  66     public PlugwiseHAZoneHandler(Thing thing) {
  67         super(thing);
  68     }
  69
  70     public static boolean supportsThingType(ThingTypeUID thingTypeUID) {
  71         return PlugwiseHABindingConstants.THING_TYPE_ZONE.equals(thingTypeUID);
  72     }
  73
  74     // Overrides
  75
  76     @Override
  77     protected synchronized void initialize(PlugwiseHAThingConfig config, PlugwiseHABridgeHandler bridgeHandler) {
  78         if (thing.getStatus() == INITIALIZING) {
  79             logger.debug("Initializing Plugwise Home Automation zone handler with config = {}", config);
  80             if (!config.isValid()) {
  81                 updateStatus(OFFLINE, CONFIGURATION_ERROR,
  82                         "Invalid configuration for Plugwise Home Automation zone handler.");
  83                 return;
  84             }
  85
  86             try {
  87                 PlugwiseHAController controller = bridgeHandler.getController();
  88                 if (controller != null) {
  89                     this.location = getEntity(controller, true);
  90                     if (this.location != null) {
  91                         setLocationProperties();
  92                         updateStatus(ONLINE);
  93                     } else {
  94                         updateStatus(OFFLINE);
  95                     }
  96                 } else {
  97                     updateStatus(OFFLINE, BRIDGE_OFFLINE);
  98                 }
  99             } catch (PlugwiseHAException e) {
 100                 updateStatus(OFFLINE, COMMUNICATION_ERROR, e.getMessage());
 101             }
 102         }
 103     }
 104
 105     @Override
 106     protected @Nullable Location getEntity(PlugwiseHAController controller, Boolean forceRefresh)
 107             throws PlugwiseHAException {
 108         PlugwiseHAThingConfig config = getPlugwiseThingConfig();
 109         Location location = controller.getLocation(config.getId(), forceRefresh);
 110
 111         return location;
 112     }
 113
 114     @Override
 115     protected void handleCommand(Location entity, ChannelUID channelUID, Command command) throws PlugwiseHAException {
 116         String channelID = channelUID.getIdWithoutGroup();
 117         PlugwiseHABridgeHandler bridge = this.getPlugwiseHABridge();
 118         if (bridge != null) {
 119             PlugwiseHAController controller = bridge.getController();
 120             if (controller != null) {
 121                 switch (channelID) {
 122                     case ZONE_SETPOINT_CHANNEL:
 123                         if (command instanceof QuantityType) {
 124                             Unit<Temperature> unit = entity.getSetpointTemperatureUnit().orElse(UNIT_CELSIUS)
 125                                     .equals(UNIT_CELSIUS) ? SIUnits.CELSIUS : ImperialUnits.FAHRENHEIT;
 126                             QuantityType<?> state = ((QuantityType<?>) command).toUnit(unit);
 127                             if (state != null) {
 128                                 try {
 129                                     controller.setLocationThermostat(entity, state.doubleValue());
 130                                 } catch (PlugwiseHAException e) {
 131                                     logger.warn("Unable to update setpoint for zone '{}': {} -> {}", entity.getName(),
 132                                             entity.getSetpointTemperature().orElse(null), state.doubleValue());
 133                                 }
 134                             }
 135                         }
 136                         break;
 137                     case ZONE_PREHEAT_CHANNEL:
 138                         if (command instanceof OnOffType) {
 139                             try {
 140                                 controller.setPreHeating(entity, command == OnOffType.ON);
 141                             } catch (PlugwiseHAException e) {
 142                                 logger.warn("Unable to switch zone pre heating {} for zone '{}'", (State) command,
 143                                         entity.getName());
 144                             }
 145                         }
 146                         break;
 147                     default:
 148                         logger.warn("Ignoring unsupported command = {} for channel = {}", command, channelUID);
 149                 }
 150             }
 151         }
 152     }
 153
 154     private State getDefaultState(String channelID) {
 155         State state = UnDefType.NULL;
 156         switch (channelID) {
 157             case ZONE_PREHEAT_CHANNEL:
 158             case ZONE_PRESETSCENE_CHANNEL:
 159             case ZONE_SETPOINT_CHANNEL:
 160             case ZONE_TEMPERATURE_CHANNEL:
 161                 state = UnDefType.NULL;
 162                 break;
 163         }
 164         return state;
 165     }
 166
 167     @Override
 168     protected void refreshChannel(Location entity, ChannelUID channelUID) {
 169         String channelID = channelUID.getIdWithoutGroup();
 170         State state = getDefaultState(channelID);
 171
 172         switch (channelID) {
 173             case ZONE_PREHEAT_CHANNEL:
 174                 Optional<Boolean> preHeatState = entity.getPreHeatState();
 175                 if (preHeatState.isPresent()) {
 176                     state = OnOffType.from(preHeatState.get());
 177                 }
 178                 break;
 179             case ZONE_PRESETSCENE_CHANNEL:
 180                 state = new StringType(entity.getPreset());
 181                 break;
 182             case ZONE_SETPOINT_CHANNEL:
 183                 if (entity.getSetpointTemperature().isPresent()) {
 184                     Unit<Temperature> unit = entity.getSetpointTemperatureUnit().orElse(UNIT_CELSIUS)
 185                             .equals(UNIT_CELSIUS) ? SIUnits.CELSIUS : ImperialUnits.FAHRENHEIT;
 186                     state = new QuantityType<Temperature>(entity.getSetpointTemperature().get(), unit);
 187                 }
 188                 break;
 189             case ZONE_TEMPERATURE_CHANNEL:
 190                 if (entity.getTemperature().isPresent()) {
 191                     Unit<Temperature> unit = entity.getTemperatureUnit().orElse(UNIT_CELSIUS).equals(UNIT_CELSIUS)
 192                             ? SIUnits.CELSIUS
 193                             : ImperialUnits.FAHRENHEIT;
 194                     state = new QuantityType<Temperature>(entity.getTemperature().get(), unit);
 195                 }
 196                 break;
 197             default:
 198                 break;
 199         }
 200
 201         if (state != UnDefType.NULL) {
 202             updateState(channelID, state);
 203         }
 204     }
 205
 206     protected void setLocationProperties() {
 207         if (this.location != null) {
 208             Map<String, String> properties = editProperties();
 209
 210             Location localLocation = this.location;
 211             if (localLocation != null) {
 212                 properties.put(PlugwiseHABindingConstants.LOCATION_PROPERTY_DESCRIPTION,
 213                         localLocation.getDescription());
 214                 properties.put(PlugwiseHABindingConstants.LOCATION_PROPERTY_TYPE, localLocation.getType());
 215                 properties.put(PlugwiseHABindingConstants.LOCATION_PROPERTY_FUNCTIONALITIES,
 216                         String.join(", ", localLocation.getActuatorFunctionalities().keySet()));
 217             }
 218
 219             updateProperties(properties);
 220         }
 221     }
 222 }