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.dto.thermostat;
  14
  15 /**
  16  * The {@link EventDTO} represents a scheduled thermostat
  17  * program change. All events have a start and end time during which the
  18  * thermostat runtime settings will be modified. Events may not be directly
  19  * modified, various Functions provide the capability to modify the calendar
  20  * events and to modify the program. The event list is sorted with events
  21  * ordered by whether they are currently running and the internal priority
  22  * of each event. It is safe to take the first event which is running and
  23  * show it as the currently running event. When the resume function is used,
  24  * events are removed in the order they are listed here.
  25  *
  26  * @author Mark Hilbush - Initial contribution
  27  */
  28 public class EventDTO {
  29     /*
  30      * The type of event. Values: hold, demandResponse, sensor, switchOccupancy,
  31      * vacation, quickSave, today, autoAway, autoHome
  32      */
  33     public String type;
  34
  35     /*
  36      * The unique event name.
  37      */
  38     public String name;
  39
  40     /*
  41      * Whether the event is currently active or not.
  42      */
  43     public Boolean running;
  44
  45     /*
  46      * The event start date in thermostat local time.
  47      */
  48     public String startDate;
  49
  50     /*
  51      * The event start time in thermostat local time.
  52      */
  53     public String startTime;
  54
  55     /*
  56      * The event end date in thermostat local time.
  57      */
  58     public String endDate;
  59
  60     /*
  61      * The event end time in thermostat local time.
  62      */
  63     public String endTime;
  64
  65     /*
  66      * Whether there are persons occupying the property during the event.
  67      */
  68     public Boolean isOccupied;
  69
  70     /*
  71      * Whether cooling will be turned off during the event.
  72      */
  73     public Boolean isCoolOff;
  74
  75     /*
  76      * Whether heating will be turned off during the event.
  77      */
  78     public Boolean isHeatOff;
  79
  80     /*
  81      * The cooling absolute temperature to set.
  82      */
  83     public Integer coolHoldTemp;
  84
  85     /*
  86      * The heating absolute temperature to set.
  87      */
  88     public Integer heatHoldTemp;
  89
  90     /*
  91      * The fan mode during the event. Values: auto, on Default: based on current climate and hvac mode.
  92      */
  93     public String fan;
  94
  95     /*
  96      * The ventilator mode during the vent. Values: auto, minontime, on, off.
  97      */
  98     public String vent;
  99
 100     /*
 101      * The minimum amount of time the ventilator equipment must stay on on each duty cycle.
 102      */
 103     public Integer ventilatorMinOnTime;
 104
 105     /*
 106      * Whether this event is mandatory or the end user can cancel it.
 107      */
 108     public Boolean isOptional;
 109
 110     /*
 111      * Whether the event is using a relative temperature setting to the currently
 112      * active program climate. See the Note at the bottom of this page for more information.
 113      */
 114     public Boolean isTemperatureRelative;
 115
 116     /*
 117      * The relative cool temperature adjustment.
 118      */
 119     public Integer coolRelativeTemp;
 120
 121     /*
 122      * The relative heat temperature adjustment.
 123      */
 124     public Integer heatRelativeTemp;
 125
 126     /*
 127      * Whether the event uses absolute temperatures to set the values. Default:
 128      * true for DRs. See the Note at the bottom of this page for more information.
 129      */
 130     public Boolean isTemperatureAbsolute;
 131
 132     /*
 133      * Indicates the % scheduled runtime during a Demand Response event. Valid range
 134      * is 0 - 100%. Default = 100, indicates no change to schedule.
 135      */
 136     public Integer dutyCyclePercentage;
 137
 138     /*
 139      * The minimum number of minutes to run the fan each hour. Range: 0-60, Default: 0
 140      */
 141     public Integer fanMinOnTime;
 142
 143     /*
 144      * True if this calendar event was created because of the occupied sensor.
 145      */
 146     public Boolean occupiedSensorActive;
 147
 148     /*
 149      * True if this calendar event was created because of the occupied sensor.
 150      */
 151     public Boolean unoccupiedSensorActive;
 152
 153     /*
 154      * Unsupported. Future feature.
 155      */
 156     public Integer drRampUpTemp;
 157
 158     /*
 159      * Unsupported. Future feature.
 160      */
 161     public Integer drRampUpTime;
 162
 163     /*
 164      * Unique identifier set by the server to link one or more events and alerts together.
 165      */
 166     public String linkRef;
 167
 168     /*
 169      * Used for display purposes to indicate what climate (if any) is being used for the hold.
 170      */
 171     public String holdClimateRef;
 172 }