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.ecobee.internal.function;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17
  18 /**
  19  * The resume program function removes the currently running event providing the event
  20  * is not a mandatory demand response event. The top active event is removed from the
  21  * stack and the thermostat resumes its program, or enters the next event in the stack
  22  * if one exists. This function may need to be called multiple times in order to resume all
  23  * events. Sending 3 resume functions in a row will resume the thermostat to its program
  24  * in all instances. Note that vacation events cannot be resumed, you must delete the
  25  * vacation event using the DeleteVacationFunction.
  26  *
  27  * @author John Cocula - Initial contribution
  28  * @author Mark Hilbush - Adapt for OH2/3
  29  */
  30 @NonNullByDefault
  31 public final class ResumeProgramFunction extends AbstractFunction {
  32
  33     public ResumeProgramFunction(@Nullable Boolean resumeAll) {
  34         super("resumeProgram");
  35         if (resumeAll != null) {
  36             params.put("resumeAll", resumeAll);
  37         }
  38     }
  39 }