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.netatmo.internal.handler.capability;
  14
  15 import static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;
  16
  17 import java.time.ZonedDateTime;
  18 import java.util.stream.Collectors;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.openhab.binding.netatmo.internal.api.EnergyApi;
  22 import org.openhab.binding.netatmo.internal.api.NetatmoException;
  23 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.SetpointMode;
  24 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
  25 import org.openhab.binding.netatmo.internal.api.dto.HomeDataModule;
  26 import org.openhab.binding.netatmo.internal.api.dto.HomeDataRoom;
  27 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
  28 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
  29 import org.openhab.binding.netatmo.internal.api.dto.Room;
  30 import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
  31 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  32 import org.openhab.binding.netatmo.internal.providers.NetatmoDescriptionProvider;
  33 import org.openhab.core.thing.ChannelUID;
  34 import org.openhab.core.types.Command;
  35 import org.openhab.core.types.StateOption;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * The {@link EnergyCapability} is the base class for handler able to handle energy features
  41  *
  42  * @author Gaël L'hopital - Initial contribution
  43  *
  44  */
  45 @NonNullByDefault
  46 public class EnergyCapability extends RestCapability<EnergyApi> {
  47     private final Logger logger = LoggerFactory.getLogger(EnergyCapability.class);
  48
  49     private int setPointDefaultDuration = -1;
  50     private final NetatmoDescriptionProvider descriptionProvider;
  51
  52     EnergyCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider) {
  53         super(handler, EnergyApi.class);
  54         this.descriptionProvider = descriptionProvider;
  55     }
  56
  57     @Override
  58     protected void updateHomeData(HomeData homeData) {
  59         NAObjectMap<HomeDataRoom> rooms = homeData.getRooms();
  60         NAObjectMap<HomeDataModule> modules = homeData.getModules();
  61         handler.getActiveChildren().forEach(childHandler -> {
  62             String childId = childHandler.getId();
  63             rooms.getOpt(childId).ifPresentOrElse(roomData -> {
  64                 roomData.setIgnoredForThingUpdate(true);
  65                 childHandler.setNewData(roomData);
  66             }, () -> {
  67                 modules.getOpt(childId).ifPresent(childData -> {
  68                     childData.setIgnoredForThingUpdate(true);
  69                     childHandler.setNewData(childData);
  70                 });
  71                 modules.values().stream().filter(module -> childId.equals(module.getBridge()))
  72                         .forEach(bridgedModule -> {
  73                             childHandler.setNewData(bridgedModule);
  74                         });
  75             });
  76         });
  77         descriptionProvider.setStateOptions(new ChannelUID(thing.getUID(), GROUP_ENERGY, CHANNEL_PLANNING),
  78                 homeData.getThermSchedules().stream().map(p -> new StateOption(p.getId(), p.getName()))
  79                         .collect(Collectors.toList()));
  80         setPointDefaultDuration = homeData.getThermSetpointDefaultDuration();
  81     }
  82
  83     @Override
  84     protected void updateHomeStatus(HomeStatus homeStatus) {
  85         NAObjectMap<Room> rooms = homeStatus.getRooms();
  86         NAObjectMap<HomeStatusModule> modules = homeStatus.getModules();
  87         handler.getActiveChildren().forEach(childHandler -> {
  88             String childId = childHandler.getId();
  89             rooms.getOpt(childId).ifPresentOrElse(roomData -> childHandler.setNewData(roomData), () -> {
  90                 modules.getOpt(childId).ifPresentOrElse(childData -> {
  91                     childHandler.setNewData(childData);
  92                     modules.values().stream().filter(module -> childId.equals(module.getBridge()))
  93                             .forEach(bridgedModule -> {
  94                                 childHandler.setNewData(bridgedModule);
  95                             });
  96
  97                 }, () -> {
  98                     // This module is not present in the homestatus data, so it is considered as unreachable
  99                     HomeStatusModule module = new HomeStatusModule();
 100                     module.setReachable(false);
 101                     childHandler.setNewData(module);
 102                 });
 103             });
 104         });
 105     }
 106
 107     public int getSetpointDefaultDuration() {
 108         return setPointDefaultDuration;
 109     }
 110
 111     public void setRoomThermMode(String roomId, SetpointMode targetMode) {
 112         getApi().ifPresent(api -> {
 113             try {
 114                 api.setThermpoint(handler.getId(), roomId, targetMode,
 115                         targetMode == SetpointMode.MAX ? setpointEndTimeFromNow(setPointDefaultDuration) : 0, 0);
 116                 handler.expireData();
 117             } catch (NetatmoException e) {
 118                 logger.warn("Error setting room thermostat mode '{}' : {}", targetMode, e.getMessage());
 119             }
 120         });
 121     }
 122
 123     public void setRoomThermTemp(String roomId, double temperature, long endtime, SetpointMode mode) {
 124         getApi().ifPresent(api -> {
 125             try {
 126                 api.setThermpoint(handler.getId(), roomId, mode, endtime, temperature);
 127                 handler.expireData();
 128             } catch (NetatmoException e) {
 129                 logger.warn("Error setting room thermostat mode '{}' : {}", mode, e.getMessage());
 130             }
 131         });
 132     }
 133
 134     public void setRoomThermTemp(String roomId, double temperature) {
 135         setRoomThermTemp(roomId, temperature, setpointEndTimeFromNow(setPointDefaultDuration), SetpointMode.MANUAL);
 136     }
 137
 138     @Override
 139     public void handleCommand(String channelName, Command command) {
 140         getApi().ifPresent(api -> {
 141             try {
 142                 switch (channelName) {
 143                     case CHANNEL_PLANNING:
 144                         api.switchSchedule(handler.getId(), command.toString());
 145                         break;
 146                     case CHANNEL_SETPOINT_MODE:
 147                         SetpointMode targetMode = SetpointMode.valueOf(command.toString());
 148                         if (targetMode == SetpointMode.MANUAL) {
 149                             logger.info("Switch to 'Manual' is done by setting a setpoint temp, command ignored");
 150                             return;
 151                         }
 152                         api.setThermMode(handler.getId(), targetMode.apiDescriptor);
 153                         break;
 154                 }
 155                 handler.expireData();
 156             } catch (NetatmoException e) {
 157                 logger.warn("Error handling command '{}' : {}", command, e.getMessage());
 158             } catch (IllegalArgumentException e) {
 159                 logger.warn("Command '{}' sent to channel '{}' is not a valid setpoint mode.", command, channelName);
 160             }
 161         });
 162     }
 163
 164     private static long setpointEndTimeFromNow(int duration_min) {
 165         return ZonedDateTime.now().plusMinutes(duration_min).toEpochSecond();
 166     }
 167 }