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 AudioDTO} contains all the audio properties of the thermostat
  19  * (only applicable to ecobee4).
  20  *
  21  * All read-only except for voiceEngines.
  22  *
  23  * @author Mark Hilbush - Initial contribution
  24  */
  25 public class AudioDTO {
  26
  27     /*
  28      * The volume level for audio playback. This includes volume of the voice assistant. A value between 0 and 100.
  29      */
  30     public Integer playbackVolume;
  31
  32     /*
  33      * Turn microphone (privacy mode) on and off.
  34      */
  35     public Boolean microphoneEnabled;
  36
  37     /*
  38      * The volume level for alerts on the thermostat. A value between 0 and 10, with 0 meaning 'off' - the zero
  39      * value may not be honored by all ecobee versions.
  40      */
  41     public Integer soundAlertVolume;
  42
  43     /*
  44      * The volume level for key presses on the thermostat. A value between 0 and 10, with 0 meaning 'off' - the
  45      * zero value may not be honored by all ecobee versions.
  46      */
  47     public Integer soundTickVolume;
  48
  49     /*
  50      * The list of voice engines compatible with the selected thermostat.
  51      */
  52     public List<VoiceEngineDTO> voiceEngines;
  53 }