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.digitalstrom.internal.lib.climate;
  14
  15 /**
  16  * The {@link TemperatureControlSensorTransmitter} can be implement by subclasses to implement a
  17  * transmitter which can be used to push the target temperature or control value to a digitalSTROM zone.
  18  *
  19  * @author Michael Ochel - Initial contribution
  20  * @author Matthias Siegele - Initial contribution
  21  */
  22 public interface TemperatureControlSensorTransmitter {
  23
  24     /**
  25      * Maximal temperature, which can be set as target temperature in digitalSTROM.
  26      */
  27     static float MAX_TEMP = 50f;
  28
  29     /**
  30      * Minimal temperature, which can be set as target temperature in digitalSTROM.
  31      */
  32     static float MIN_TEMP = -43.15f;
  33
  34     /**
  35      * Maximal control value, which can be set as target temperature in digitalSTROM.
  36      */
  37     static float MAX_CONTROLL_VALUE = 100f;
  38
  39     /**
  40      * Minimal control value, which can be set as target temperature in digitalSTROM.
  41      */
  42     static float MIN_CONTROLL_VALUE = 0f;
  43
  44     /**
  45      * Pushes a new target temperature to a digitalSTROM zone.
  46      *
  47      * @param zoneID (must not be null)
  48      * @param newValue (must not be null)
  49      * @return true, if the push was successfully
  50      */
  51     boolean pushTargetTemperature(Integer zoneID, Float newValue);
  52
  53     /**
  54      * Pushes a new control value to a digitalSTROM zone.
  55      *
  56      * @param zoneID (must not be null)
  57      * @param newValue (must not be null)
  58      * @return true, if the push was successfully
  59      */
  60     boolean pushControlValue(Integer zoneID, Float newValue);
  61 }