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.radiothermostat.internal;
  14
  15 import java.util.Collections;
  16 import java.util.Set;
  17
  18 import javax.measure.Unit;
  19 import javax.measure.quantity.Dimensionless;
  20 import javax.measure.quantity.Temperature;
  21 import javax.measure.quantity.Time;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.openhab.core.library.unit.ImperialUnits;
  25 import org.openhab.core.library.unit.Units;
  26 import org.openhab.core.thing.ThingTypeUID;
  27
  28 /**
  29  * The {@link RadioThermostatBinding} class defines common constants, which are
  30  * used across the whole binding.
  31  *
  32  * @author Michael Lobstein - Initial contribution
  33  */
  34 @NonNullByDefault
  35 public class RadioThermostatBindingConstants {
  36
  37     public static final String BINDING_ID = "radiothermostat";
  38     public static final String LOCAL = "local";
  39     public static final String PROPERTY_IP = "hostName";
  40     public static final String PROPERTY_ISCT80 = "isCT80";
  41     public static final String JSON_TIME = "{\"day\":%s,\"hour\":%s,\"minute\":%s}";
  42     public static final String JSON_PMA = "{\"line\":1,\"message\":\"%s\"}";
  43     public static final String BLANK = "";
  44
  45     public static final String KEY_ERROR = "error";
  46
  47     // List of JSON resources
  48     public static final String DEFAULT_RESOURCE = "tstat";
  49     public static final String RUNTIME_RESOURCE = "tstat/datalog";
  50     public static final String HUMIDITY_RESOURCE = "tstat/humidity";
  51     public static final String REMOTE_TEMP_RESOURCE = "tstat/remote_temp";
  52     public static final String TIME_RESOURCE = "tstat/time";
  53     public static final String HEAT_PROGRAM_RESOURCE = "tstat/program/heat";
  54     public static final String COOL_PROGRAM_RESOURCE = "tstat/program/cool";
  55     public static final String PMA_RESOURCE = "tstat/pma";
  56
  57     // List of all Thing Type UIDs
  58     public static final ThingTypeUID THING_TYPE_RTHERM = new ThingTypeUID(BINDING_ID, "rtherm");
  59
  60     // List of all Channel id's
  61     public static final String TEMPERATURE = "temperature";
  62     public static final String HUMIDITY = "humidity";
  63     public static final String MODE = "mode";
  64     public static final String FAN_MODE = "fan_mode";
  65     public static final String PROGRAM_MODE = "program_mode";
  66     public static final String SET_POINT = "set_point";
  67     public static final String OVERRIDE = "override";
  68     public static final String HOLD = "hold";
  69     public static final String STATUS = "status";
  70     public static final String FAN_STATUS = "fan_status";
  71     public static final String DAY = "day";
  72     public static final String HOUR = "hour";
  73     public static final String MINUTE = "minute";
  74     public static final String DATE_STAMP = "dt_stamp";
  75     public static final String TODAY_HEAT_RUNTIME = "today_heat_runtime";
  76     public static final String TODAY_COOL_RUNTIME = "today_cool_runtime";
  77     public static final String YESTERDAY_HEAT_RUNTIME = "yesterday_heat_runtime";
  78     public static final String YESTERDAY_COOL_RUNTIME = "yesterday_cool_runtime";
  79     public static final String REMOTE_TEMP = "remote_temp";
  80     public static final String MESSAGE = "message";
  81
  82     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Collections.singleton(THING_TYPE_RTHERM);
  83
  84     public static final Set<String> SUPPORTED_CHANNEL_IDS = Set.of(TEMPERATURE, HUMIDITY, MODE, FAN_MODE, PROGRAM_MODE,
  85             SET_POINT, OVERRIDE, HOLD, STATUS, FAN_STATUS, DAY, HOUR, MINUTE, DATE_STAMP, TODAY_HEAT_RUNTIME,
  86             TODAY_COOL_RUNTIME, YESTERDAY_HEAT_RUNTIME, YESTERDAY_COOL_RUNTIME, REMOTE_TEMP, MESSAGE);
  87
  88     public static final Set<String> NO_UPDATE_CHANNEL_IDS = Set.of(REMOTE_TEMP, MESSAGE);
  89
  90     // Units of measurement of the data delivered by the API
  91     public static final Unit<Temperature> API_TEMPERATURE_UNIT = ImperialUnits.FAHRENHEIT;
  92     public static final Unit<Dimensionless> API_HUMIDITY_UNIT = Units.PERCENT;
  93     public static final Unit<Time> API_MINUTES_UNIT = Units.MINUTE;
  94 }