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 RemoteSensorDTO} represents a sensor connected to the thermostat.
  19  * The remote sensor data will only show computed occupancy, as does the thermostat.
  20  * Definition - For a given sensor, computed occupancy means a sensor is occupied
  21  * if any motion was detected in the past 30 minutes. RemoteSensor data changes
  22  * trigger the runtimeRevision to be updated. The data updates are sent at an
  23  * interval of 3 mins maximum. This means that you should not poll quicker
  24  * than once every 3 mins for revision changes.
  25  *
  26  * @author Mark Hilbush - Initial contribution
  27  */
  28 public class RemoteSensorDTO {
  29     /*
  30      * The unique sensor identifier. It is composed of deviceName + deviceId
  31      * separated by colons, for example: rs:100
  32      */
  33     public String id;
  34
  35     /*
  36      * The user assigned sensor name.
  37      */
  38     public String name;
  39
  40     /*
  41      * The type of sensor. Values: thermostat, ecobee3_remote_sensor,
  42      * monitor_sensor, control_sensor.
  43      */
  44     public String type;
  45
  46     /*
  47      * The unique 4-digit alphanumeric sensor code. For ecobee3 remote
  48      * sensors this corresponds to the code found on the back of the physical sensor.
  49      */
  50     public String code;
  51
  52     /*
  53      * This flag indicates whether the remote sensor is currently in use
  54      * by a comfort setting. See Climate for more information.
  55      */
  56     public Boolean inUse;
  57
  58     /*
  59      * The list of remoteSensorCapability objects for the remote sensor.
  60      */
  61     public List<RemoteSensorCapabilityDTO> capability;
  62 }