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

   1 /**
   2  * Copyright (c) 2010-2020 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.ecobee.action;
  14
  15 import java.util.Date;
  16 import java.util.Map;
  17
  18 import javax.measure.quantity.Temperature;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.openhab.core.library.types.QuantityType;
  23
  24 /**
  25  * The {@link IEcobeeActions} defines the interface for all thing actions supported by the binding.
  26  * These methods, parameters, and return types are explained in {@link EcobeeActions}.
  27  *
  28  * @author Mark Hilbush - Initial contribution
  29  */
  30 @NonNullByDefault
  31 public interface IEcobeeActions {
  32
  33     public Boolean acknowledge(@Nullable String ackRef, @Nullable String ackType, @Nullable Boolean remindMeLater);
  34
  35     public Boolean controlPlug(@Nullable String plugName, @Nullable String plugState, @Nullable Date startDateTime,
  36             @Nullable Date endDateTime, @Nullable String holdType, @Nullable Number holdHours);
  37
  38     public Boolean sendMessage(@Nullable String text);
  39
  40     public Boolean createVacation(@Nullable String name, @Nullable QuantityType<Temperature> coolHoldTemp,
  41             @Nullable QuantityType<Temperature> heatHoldTemp, @Nullable Date startDateTime, @Nullable Date endDateTime,
  42             @Nullable String fan, @Nullable Number fanMinOnTime);
  43
  44     public Boolean deleteVacation(@Nullable String name);
  45
  46     public Boolean resetPreferences();
  47
  48     public Boolean resumeProgram(@Nullable Boolean resumeAll);
  49
  50     public Boolean setHold(@Nullable QuantityType<Temperature> coolHoldTemp,
  51             @Nullable QuantityType<Temperature> heatHoldTemp);
  52
  53     public Boolean setHold(@Nullable QuantityType<Temperature> coolHoldTemp,
  54             @Nullable QuantityType<Temperature> heatHoldTemp, @Nullable Number holdHours);
  55
  56     public Boolean setHold(@Nullable String holdClimateRef);
  57
  58     public Boolean setHold(@Nullable String holdClimateRef, @Nullable Number holdHours);
  59
  60     public Boolean setHold(@Nullable QuantityType<Temperature> coolHoldTemp,
  61             @Nullable QuantityType<Temperature> heatHoldTemp, @Nullable String holdClimateRef,
  62             @Nullable Date startDateTime, @Nullable Date endDateTime, @Nullable String holdType,
  63             @Nullable Number holdHours);
  64
  65     public Boolean setHold(@Nullable Map<String, Object> params, @Nullable String holdType, @Nullable Number holdHours,
  66             @Nullable Date startDateTime, @Nullable Date endDateTime);
  67
  68     public Boolean setOccupied(@Nullable Boolean occupied, @Nullable Date startDateTime, @Nullable Date endDateTime,
  69             @Nullable String holdType, @Nullable Number holdHours);
  70
  71     public Boolean updateSensor(@Nullable String name, @Nullable String deviceId, @Nullable String sensorId);
  72
  73     public @Nullable String getAlerts();
  74
  75     public @Nullable String getEvents();
  76
  77     public @Nullable String getClimates();
  78 }