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 import java.util.List;
  16
  17 /**
  18  * The {@link ClimateDTO} maps to the thermostat's Climate object.
  19  *
  20  * @see <a href="https://www.ecobee.com/home/developer/api/documentation/v1/objects/Climate.shtml">Climate</a>
  21  *
  22  * @author Mark Hilbush - Initial contribution
  23  */
  24 public class ClimateDTO {
  25
  26     /*
  27      * The unique climate name. The name may be changed without affecting the
  28      * program integrity so long as uniqueness is maintained.
  29      */
  30     public String name;
  31
  32     /*
  33      * The unique climate identifier. Changing the identifier is not possible
  34      * and it is generated on the server for each climate. If this value is
  35      * not supplied a new climate will be created. For the default climates
  36      * and existing user created climates the climateRef should be
  37      * supplied - see note above.
  38      */
  39     public String climateRef;
  40
  41     /*
  42      * A flag indicating whether the property is occupied by persons during this climate
  43      */
  44     public Boolean isOccupied;
  45
  46     /*
  47      * A flag indicating whether ecobee optimized climate settings are used by this climate.
  48      */
  49     public Boolean isOptimized;
  50
  51     /*
  52      * The cooling fan mode. Default: on. Values: auto, on.
  53      */
  54     public String coolFan;
  55
  56     /*
  57      * The heating fan mode. Default: on. Values: auto, on.
  58      */
  59     public String heatFan;
  60
  61     /*
  62      * The ventilator mode. Default: off. Values: auto, minontime, on, off.
  63      */
  64     public String vent;
  65
  66     /*
  67      * The minimum time, in minutes, to run the ventilator each hour.
  68      */
  69     public Integer ventilatorMinOnTime;
  70
  71     /*
  72      * The climate owner. Default: system. Values: adHoc, demandResponse, quickSave,
  73      * sensorAction, switchOccupancy, system, template, user.
  74      */
  75     public String owner;
  76
  77     /*
  78      * The type of climate. Default: program. Values: calendarEvent, program.
  79      */
  80     public String type;
  81
  82     /*
  83      * The integer conversion of the HEX color value used to display this
  84      * climate on the thermostat and on the web portal.
  85      */
  86     public Integer colour;
  87
  88     /*
  89      * The cool temperature for this climate.
  90      */
  91     public Integer coolTemp;
  92
  93     /*
  94      * The heat temperature for this climate.
  95      */
  96     public Integer heatTemp;
  97
  98     /*
  99      * The list of sensors in use for the specific climate. The sensors listed here
 100      * are used for temperature averaging within that climate. Only the sensorId
 101      * and name are listed in the climate.
 102      */
 103     public List<RemoteSensorDTO> sensors;
 104 }