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.ecobee.internal.dto.thermostat;
  14
  15 import org.openhab.binding.ecobee.internal.enums.EquipmentNotificationType;
  16
  17 /**
  18  * The {@link EquipmentSettingDTO} represents the alert/reminder type which is associated
  19  * with and dependent upon specific equipment controlled by the Thermostat. It is used
  20  * when getting/setting the Thermostat NotificationSettings object. Note: Only the notification
  21  * settings for the equipment/devices currently controlled by the Thermostat are returned during
  22  * GET request, and only those same settings can be updated using the POST request. The type
  23  * corresponds to the Alert.notificationType returned when alerts are also included in the
  24  * selection. See Alert for more information.
  25  *
  26  * @author Mark Hilbush - Initial contribution
  27  */
  28 public class EquipmentSettingDTO {
  29
  30     /*
  31      * The date the filter was last changed for this equipment. String format: YYYY-MM-DD
  32      */
  33     public String filterLastChanged;
  34
  35     /*
  36      * The value representing the life of the filter. This value is expressed in month or hour,
  37      * which is specified in the the filterLifeUnits property.
  38      */
  39     public Integer filterLife;
  40
  41     /*
  42      * The units the filterLife field is measured in. Possible values are: month, hour. month
  43      * has a range of 1 - 12. hour has a range of 100 - 10000.
  44      */
  45     public String filterLifeUnits;
  46
  47     /*
  48      * The date the reminder will be triggered. This is a read-only field and cannot be modified
  49      * through the API. The value is calculated and set by the thermostat.
  50      */
  51     public String remindMeDate;
  52
  53     /*
  54      * Boolean value representing whether or not alerts/reminders are enabled for this
  55      * notification type or not.
  56      */
  57     public Boolean enabled;
  58
  59     /*
  60      * The type of notification. Possible values are: hvac, furnaceFilter, humidifierFilter,
  61      * dehumidifierFilter, ventilator, ac, airFilter, airCleaner, uvLamp
  62      */
  63     public EquipmentNotificationType type;
  64
  65     /*
  66      * Boolean value representing whether or not alerts/reminders should be sent to the
  67      * technician/contractor assoicated with the thermostat.
  68      */
  69     public Boolean remindTechnician;
  70 }