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(handler -> {
  62             HomeDataRoom roomData = rooms.get(handler.getId());
  63             if (roomData != null) {
  64                 roomData.setIgnoredForThingUpdate(true);
  65                 handler.setNewData(roomData);
  66             }
  67             HomeDataModule moduleData = modules.get(handler.getId());
  68             if (moduleData != null) {
  69                 moduleData.setIgnoredForThingUpdate(true);
  70                 handler.setNewData(moduleData);
  71             }
  72         });
  73         descriptionProvider.setStateOptions(new ChannelUID(thing.getUID(), GROUP_ENERGY, CHANNEL_PLANNING),
  74                 homeData.getThermSchedules().stream().map(p -> new StateOption(p.getId(), p.getName()))
  75                         .collect(Collectors.toList()));
  76         setPointDefaultDuration = homeData.getThermSetpointDefaultDuration();
  77     }
  78
  79     @Override
  80     protected void updateHomeStatus(HomeStatus homeStatus) {
  81         NAObjectMap<Room> rooms = homeStatus.getRooms();
  82         NAObjectMap<HomeStatusModule> modules = homeStatus.getModules();
  83         handler.getActiveChildren().forEach(handler -> {
  84             Room roomData = rooms.get(handler.getId());
  85             if (roomData != null) {
  86                 handler.setNewData(roomData);
  87             }
  88             HomeStatusModule data = modules.get(handler.getId());
  89             if (data != null) {
  90                 handler.setNewData(data);
  91             }
  92         });
  93     }
  94
  95     public int getSetpointDefaultDuration() {
  96         return setPointDefaultDuration;
  97     }
  98
  99     public void setRoomThermMode(String roomId, SetpointMode targetMode) {
 100         getApi().ifPresent(api -> {
 101             try {
 102                 api.setThermpoint(handler.getId(), roomId, targetMode,
 103                         targetMode == SetpointMode.MAX ? setpointEndTimeFromNow(setPointDefaultDuration) : 0, 0);
 104                 handler.expireData();
 105             } catch (NetatmoException e) {
 106                 logger.warn("Error setting room thermostat mode '{}' : {}", targetMode, e.getMessage());
 107             }
 108         });
 109     }
 110
 111     public void setRoomThermTemp(String roomId, double temperature, long endtime, SetpointMode mode) {
 112         getApi().ifPresent(api -> {
 113             try {
 114                 api.setThermpoint(handler.getId(), roomId, mode, endtime, temperature);
 115                 handler.expireData();
 116             } catch (NetatmoException e) {
 117                 logger.warn("Error setting room thermostat mode '{}' : {}", mode, e.getMessage());
 118             }
 119         });
 120     }
 121
 122     public void setRoomThermTemp(String roomId, double temperature) {
 123         setRoomThermTemp(roomId, temperature, setpointEndTimeFromNow(setPointDefaultDuration), SetpointMode.MANUAL);
 124     }
 125
 126     @Override
 127     public void handleCommand(String channelName, Command command) {
 128         getApi().ifPresent(api -> {
 129             try {
 130                 switch (channelName) {
 131                     case CHANNEL_PLANNING:
 132                         api.switchSchedule(handler.getId(), command.toString());
 133                         break;
 134                     case CHANNEL_SETPOINT_MODE:
 135                         SetpointMode targetMode = SetpointMode.valueOf(command.toString());
 136                         if (targetMode == SetpointMode.MANUAL) {
 137                             logger.info("Switch to 'Manual' is done by setting a setpoint temp, command ignored");
 138                             return;
 139                         }
 140                         api.setThermMode(handler.getId(), targetMode.apiDescriptor);
 141                         break;
 142                 }
 143                 handler.expireData();
 144             } catch (NetatmoException e) {
 145                 logger.warn("Error handling command '{}' : {}", command, e.getMessage());
 146             } catch (IllegalArgumentException e) {
 147                 logger.warn("Command '{}' sent to channel '{}' is not a valid setpoint mode.", command, channelName);
 148             }
 149         });
 150     }
 151
 152     private static long setpointEndTimeFromNow(int duration_min) {
 153         return ZonedDateTime.now().plusMinutes(duration_min).toEpochSecond();
 154     }
 155 }