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

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