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.shelly.internal;
  14
  15 import static org.openhab.binding.shelly.internal.discovery.ShellyThingCreator.*;
  16
  17 import java.util.Set;
  18
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.openhab.core.thing.ThingTypeUID;
  21
  22 /**
  23  * The {@link ShellyBindingConstants} class defines common constants, which are
  24  * used across the whole binding.
  25  *
  26  * @author Markus Michels - Initial contribution
  27  */
  28 @NonNullByDefault
  29 public class ShellyBindingConstants {
  30
  31     public static final String VENDOR = "Shelly";
  32     public static final String BINDING_ID = "shelly";
  33     public static final String SYSTEM_ID = "system";
  34
  35     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_SHELLY1, //
  36             THING_TYPE_SHELLY1L, //
  37             THING_TYPE_SHELLY1PM, //
  38             THING_TYPE_SHELLYEM, //
  39             THING_TYPE_SHELLY3EM, //
  40             THING_TYPE_SHELLY2_RELAY, //
  41             THING_TYPE_SHELLY2_ROLLER, //
  42             THING_TYPE_SHELLY25_RELAY, //
  43             THING_TYPE_SHELLY25_ROLLER, //
  44             THING_TYPE_SHELLY4PRO, //
  45             THING_TYPE_SHELLYPLUG, //
  46             THING_TYPE_SHELLYPLUGS, //
  47             THING_TYPE_SHELLYPLUGU1, //
  48             THING_TYPE_SHELLYUNI, //
  49             THING_TYPE_SHELLYDIMMER, //
  50             THING_TYPE_SHELLYDIMMER2, //
  51             THING_TYPE_SHELLYIX3, //
  52             THING_TYPE_SHELLYBULB, //
  53             THING_TYPE_SHELLYDUO, //
  54             THING_TYPE_SHELLYVINTAGE, //
  55             THING_TYPE_SHELLYDUORGBW, //
  56             THING_TYPE_SHELLYRGBW2_COLOR, //
  57             THING_TYPE_SHELLYRGBW2_WHITE, //
  58             THING_TYPE_SHELLYHT, //
  59             THING_TYPE_SHELLYTRV, //
  60             THING_TYPE_SHELLYSENSE, //
  61             THING_TYPE_SHELLYEYE, //
  62             THING_TYPE_SHELLYSMOKE, //
  63             THING_TYPE_SHELLYGAS, //
  64             THING_TYPE_SHELLYFLOOD, //
  65             THING_TYPE_SHELLYDOORWIN, //
  66             THING_TYPE_SHELLYDOORWIN2, //
  67             THING_TYPE_SHELLYBUTTON1, //
  68             THING_TYPE_SHELLYBUTTON2, //
  69             THING_TYPE_SHELLMOTION, //
  70             THING_TYPE_SHELLYPLUS1, //
  71             THING_TYPE_SHELLYPLUS1PM, //
  72             THING_TYPE_SHELLYPLUS2PM_RELAY, //
  73             THING_TYPE_SHELLYPLUS2PM_ROLLER, //
  74             THING_TYPE_SHELLYPRO1, //
  75             THING_TYPE_SHELLYPRO1PM, //
  76             THING_TYPE_SHELLYPRO2_RELAY, //
  77             THING_TYPE_SHELLYPRO2PM_RELAY, //
  78             THING_TYPE_SHELLYPRO2PM_ROLLER, //
  79             THING_TYPE_SHELLYPRO3, //
  80             THING_TYPE_SHELLYPRO3EM, //
  81             THING_TYPE_SHELLYPRO4PM, //
  82             THING_TYPE_SHELLYPLUSI4, //
  83             THING_TYPE_SHELLYPLUSI4DC, //
  84             THING_TYPE_SHELLYPLUSHT, //
  85             THING_TYPE_SHELLYPLUSSMOKE, //
  86             THING_TYPE_SHELLYPLUSPLUGS, //
  87             THING_TYPE_SHELLYPLUSPLUGUS, //
  88             THING_TYPE_SHELLYBLUBUTTON, //
  89             THING_TYPE_SHELLYBLUDW, //
  90             THING_TYPE_SHELLYPROTECTED, //
  91             THING_TYPE_SHELLYUNKNOWN);
  92
  93     // Thing Configuration Properties
  94     public static final String CONFIG_DEVICEIP = "deviceIp";
  95     public static final String CONFIG_DEVICEADDRESS = "deviceAddress";
  96     public static final String CONFIG_HTTP_USERID = "userId";
  97     public static final String CONFIG_HTTP_PASSWORD = "password";
  98     public static final String CONFIG_UPDATE_INTERVAL = "updateInterval";
  99
 100     public static final String PROPERTY_SERVICE_NAME = "serviceName";
 101     public static final String PROPERTY_DEV_NAME = "deviceName";
 102     public static final String PROPERTY_DEV_TYPE = "deviceType";
 103     public static final String PROPERTY_DEV_MODE = "deviceMode";
 104     public static final String PROPERTY_DEV_GEN = "deviceGeneration";
 105     public static final String PROPERTY_GW_DEVICE = "gatewayDevice";
 106     public static final String PROPERTY_HWREV = "deviceHwRev";
 107     public static final String PROPERTY_HWBATCH = "deviceHwBatch";
 108     public static final String PROPERTY_UPDATE_PERIOD = "devUpdatePeriod";
 109     public static final String PROPERTY_NUM_RELAYS = "numberRelays";
 110     public static final String PROPERTY_NUM_ROLLERS = "numberRollers";
 111     public static final String PROPERTY_NUM_METER = "numberMeters";
 112     public static final String PROPERTY_LAST_ACTIVE = "lastActive";
 113     public static final String PROPERTY_WIFI_NETW = "wifiNetwork";
 114     public static final String PROPERTY_UPDATE_STATUS = "updateStatus";
 115     public static final String PROPERTY_UPDATE_AVAILABLE = "updateAvailable";
 116     public static final String PROPERTY_UPDATE_CURR_VERS = "updateCurrentVersion";
 117     public static final String PROPERTY_UPDATE_NEW_VERS = "updateNewVersion";
 118     public static final String PROPERTY_COAP_DESCR = "coapDeviceDescr";
 119     public static final String PROPERTY_COAP_VERSION = "coapVersion";
 120     public static final String PROPERTY_COIOTAUTO = "coiotAutoEnable";
 121
 122     // Relay
 123     public static final String CHANNEL_GROUP_RELAY_CONTROL = "relay";
 124     public static final String CHANNEL_OUTPUT_NAME = "outputName";
 125     public static final String CHANNEL_OUTPUT = "output";
 126     public static final String CHANNEL_INPUT = "input";
 127     public static final String CHANNEL_INPUT1 = "input1";
 128     public static final String CHANNEL_INPUT2 = "input2";
 129     public static final String CHANNEL_BRIGHTNESS = "brightness";
 130
 131     public static final String CHANNEL_TIMER_AUTOON = "autoOn";
 132     public static final String CHANNEL_TIMER_AUTOOFF = "autoOff";
 133     public static final String CHANNEL_TIMER_ACTIVE = "timerActive";
 134
 135     // Roller
 136     public static final String CHANNEL_GROUP_ROL_CONTROL = "roller";
 137     public static final String CHANNEL_ROL_CONTROL_CONTROL = "control";
 138     public static final String CHANNEL_ROL_CONTROL_POS = "rollerpos";
 139     public static final String CHANNEL_ROL_CONTROL_FAV = "rollerFav";
 140     public static final String CHANNEL_ROL_CONTROL_TIMER = "timer";
 141     public static final String CHANNEL_ROL_CONTROL_STATE = "state";
 142     public static final String CHANNEL_ROL_CONTROL_STOPR = "stopReason";
 143     public static final String CHANNEL_ROL_CONTROL_SAFETY = "safety";
 144
 145     // Dimmer
 146     public static final String CHANNEL_GROUP_DIMMER_CONTROL = CHANNEL_GROUP_RELAY_CONTROL;
 147
 148     // Power meter
 149     public static final String CHANNEL_GROUP_METER = "meter";
 150     public static final String CHANNEL_METER_CURRENTWATTS = "currentWatts";
 151     public static final String CHANNEL_METER_LASTMIN = "lastPower";
 152     public static final String CHANNEL_METER_LASTMIN1 = CHANNEL_METER_LASTMIN + "1";
 153     public static final String CHANNEL_METER_TOTALKWH = "totalKWH";
 154     public static final String CHANNEL_EMETER_TOTALRET = "returnedKWH";
 155     public static final String CHANNEL_EMETER_REACTWATTS = "reactiveWatts";
 156     public static final String CHANNEL_EMETER_VOLTAGE = "voltage";
 157     public static final String CHANNEL_EMETER_CURRENT = "current";
 158     public static final String CHANNEL_EMETER_PFACTOR = "powerFactor";
 159     public static final String CHANNEL_EMETER_RESETTOTAL = "resetTotals";
 160
 161     public static final String CHANNEL_GROUP_SENSOR = "sensors";
 162     public static final String CHANNEL_SENSOR_TEMP = "temperature";
 163     public static final String CHANNEL_SENSOR_HUM = "humidity";
 164     public static final String CHANNEL_SENSOR_LUX = "lux";
 165     public static final String CHANNEL_SENSOR_PPM = "ppm";
 166     public static final String CHANNEL_SENSOR_VOLTAGE = "voltage";
 167     public static final String CHANNEL_SENSOR_ILLUM = "illumination";
 168     public static final String CHANNEL_SENSOR_VIBRATION = "vibration";
 169     public static final String CHANNEL_SENSOR_TILT = "tilt";
 170     public static final String CHANNEL_SENSOR_FLOOD = "flood";
 171     public static final String CHANNEL_SENSOR_SMOKE = "smoke";
 172     public static final String CHANNEL_SENSOR_MUTE = "mute";
 173     public static final String CHANNEL_SENSOR_STATE = "state";
 174     public static final String CHANNEL_SENSOR_OPEN = "open";
 175     public static final String CHANNEL_SENSOR_VALVE = "valve";
 176     public static final String CHANNEL_SENSOR_SSTATE = "status"; // Shelly Gas
 177     public static final String CHANNEL_SENSOR_MOTION_ACT = "motionActive";
 178     public static final String CHANNEL_SENSOR_MOTION = "motion";
 179     public static final String CHANNEL_SENSOR_MOTION_TS = "motionTimestamp";
 180     public static final String CHANNEL_SENSOR_SLEEPTIME = "sensorSleepTime";
 181     public static final String CHANNEL_SENSOR_ALARM_STATE = "alarmState";
 182     public static final String CHANNEL_SENSOR_ERROR = "lastError";
 183
 184     // TRV
 185     public static final String CHANNEL_CONTROL_SETTEMP = "targetTemp";
 186     public static final String CHANNEL_CONTROL_POSITION = "position";
 187     public static final String CHANNEL_CONTROL_MODE = "mode";
 188     public static final String CHANNEL_CONTROL_BCONTROL = "boost";
 189     public static final String CHANNEL_CONTROL_BTIMER = "boostTimer";
 190     public static final String CHANNEL_CONTROL_SCHEDULE = "schedule";
 191     public static final String CHANNEL_CONTROL_PROFILE = "selectedProfile";
 192
 193     // External sensors for Shelly1/1PM
 194     public static final String CHANNEL_ESENSOR_TEMP1 = CHANNEL_SENSOR_TEMP + "1";
 195     public static final String CHANNEL_ESENSOR_TEMP2 = CHANNEL_SENSOR_TEMP + "2";
 196     public static final String CHANNEL_ESENSOR_TEMP3 = CHANNEL_SENSOR_TEMP + "3";
 197     public static final String CHANNEL_ESENSOR_TEMP4 = CHANNEL_SENSOR_TEMP + "4";
 198     public static final String CHANNEL_ESENSOR_TEMP5 = CHANNEL_SENSOR_TEMP + "5";
 199     public static final String CHANNEL_ESENSOR_HUMIDITY = CHANNEL_SENSOR_HUM;
 200     public static final String CHANNEL_ESENSOR_VOLTAGE = CHANNEL_SENSOR_VOLTAGE;
 201     public static final String CHANNEL_ESENSOR_DIGITALINPUT = "digitalInput";
 202     public static final String CHANNEL_ESENSOR_ANALOGINPUT = "analogInput";
 203     public static final String CHANNEL_ESENSOR_INPUT = "input";
 204     public static final String CHANNEL_ESENSOR_INPUT1 = CHANNEL_ESENSOR_INPUT + "1";
 205
 206     public static final String CHANNEL_GROUP_CONTROL = "control";
 207     public static final String CHANNEL_SENSE_KEY = "key";
 208
 209     public static final String CHANNEL_GROUP_BATTERY = "battery";
 210     public static final String CHANNEL_SENSOR_BAT_LEVEL = "batteryLevel";
 211     public static final String CHANNEL_SENSOR_BAT_LOW = "lowBattery";
 212
 213     public static final String CHANNEL_GROUP_LIGHT_CONTROL = "control";
 214     public static final String CHANNEL_LIGHT_COLOR_MODE = "mode";
 215     public static final String CHANNEL_LIGHT_POWER = "power";
 216     public static final String CHANNEL_LIGHT_DEFSTATE = "defaultState";
 217     public static final String CHANNEL_GROUP_LIGHT_CHANNEL = "channel";
 218
 219     // Bulb/RGBW2 in color mode
 220     public static final String CHANNEL_GROUP_COLOR_CONTROL = "color";
 221     public static final String CHANNEL_COLOR_PICKER = "hsb";
 222     public static final String CHANNEL_COLOR_FULL = "full";
 223     public static final String CHANNEL_COLOR_RED = "red";
 224     public static final String CHANNEL_COLOR_GREEN = "green";
 225     public static final String CHANNEL_COLOR_BLUE = "blue";
 226     public static final String CHANNEL_COLOR_WHITE = "white";
 227     public static final String CHANNEL_COLOR_GAIN = "gain";
 228     public static final String CHANNEL_COLOR_EFFECT = "effect";
 229
 230     // Bulb/RGBW2/Dup in White Mode
 231     public static final String CHANNEL_GROUP_WHITE_CONTROL = "white";
 232     public static final String CHANNEL_COLOR_TEMP = "temperature";
 233
 234     // Device Status
 235     public static final String CHANNEL_GROUP_DEV_STATUS = "device";
 236     public static final String CHANNEL_DEVST_NAME = "deviceName";
 237     public static final String CHANNEL_DEVST_GATEWAY = "gatewayDevice";
 238     public static final String CHANNEL_DEVST_UPTIME = "uptime";
 239     public static final String CHANNEL_DEVST_HEARTBEAT = "heartBeat";
 240     public static final String CHANNEL_DEVST_RSSI = "wifiSignal";
 241     public static final String CHANNEL_DEVST_ITEMP = "internalTemp";
 242     public static final String CHANNEL_DEVST_WAKEUP = "wakeupReason";
 243     public static final String CHANNEL_DEVST_ALARM = "alarm";
 244     public static final String CHANNEL_DEVST_ACCUWATTS = "accumulatedWatts";
 245     public static final String CHANNEL_DEVST_ACCUTOTAL = "accumulatedWTotal";
 246     public static final String CHANNEL_DEVST_ACCURETURNED = "accumulatedReturned";
 247     public static final String CHANNEL_DEVST_CHARGER = "charger";
 248     public static final String CHANNEL_DEVST_UPDATE = "updateAvailable";
 249     public static final String CHANNEL_DEVST_SELFTTEST = "selfTest";
 250     public static final String CHANNEL_DEVST_VOLTAGE = "supplyVoltage";
 251     public static final String CHANNEL_DEVST_CALIBRATED = "calibrated";
 252
 253     public static final String CHANNEL_LED_STATUS_DISABLE = "statusLed";
 254     public static final String CHANNEL_LED_POWER_DISABLE = "powerLed";
 255     // Button/xi3
 256     public static final String CHANNEL_GROUP_STATUS = "status";
 257     public static final String CHANNEL_STATUS_EVENTTYPE = "lastEvent";
 258     public static final String CHANNEL_STATUS_EVENTTYPE1 = CHANNEL_STATUS_EVENTTYPE + "1";
 259     public static final String CHANNEL_STATUS_EVENTTYPE2 = CHANNEL_STATUS_EVENTTYPE + "2";
 260     public static final String CHANNEL_STATUS_EVENTCOUNT = "eventCount";
 261     public static final String CHANNEL_STATUS_EVENTCOUNT1 = CHANNEL_STATUS_EVENTCOUNT + "1";
 262     public static final String CHANNEL_STATUS_EVENTCOUNT2 = CHANNEL_STATUS_EVENTCOUNT + "2";
 263
 264     // General
 265     public static final String CHANNEL_LAST_UPDATE = "lastUpdate";
 266     public static final String CHANNEL_EVENT_TRIGGER = "event";
 267     public static final String CHANNEL_BUTTON_TRIGGER = "button";
 268     public static final String CHANNEL_BUTTON_TRIGGER1 = CHANNEL_BUTTON_TRIGGER + "1";
 269     public static final String CHANNEL_BUTTON_TRIGGER2 = CHANNEL_BUTTON_TRIGGER + "2";
 270
 271     public static final String SERVICE_TYPE = "_http._tcp.local.";
 272     public static final String SHELLY_API_MIN_FWVERSION = "v1.8.2";
 273     public static final String SHELLY_API_MIN_FWCOIOT = "v1.6";// v1.6.0+
 274     public static final String SHELLY_API_FWCOIOT2 = "v1.8";// CoAP 2 with FW 1.8+
 275     public static final String SHELLY_API_FW_110 = "v1.10"; // FW 1.10 or newer detected, activates some add feature
 276     public static final String SHELLY2_API_MIN_FWVERSION = "v0.10.2"; // Gen 2 minimum FW
 277
 278     // Alarm types/messages
 279     public static final String ALARM_TYPE_NONE = "NONE";
 280     public static final String ALARM_TYPE_RESTARTED = "RESTARTED";
 281     public static final String ALARM_TYPE_OVERTEMP = "OVERTEMP";
 282     public static final String ALARM_TYPE_OVERPOWER = "OVERPOWER";
 283     public static final String ALARM_TYPE_OVERLOAD = "OVERLOAD";
 284     public static final String ALARM_TYPE_LOADERR = "LOAD_ERROR";
 285     public static final String ALARM_TYPE_SENSOR_ERROR = "SENSOR_ERROR";
 286     public static final String ALARM_TYPE_LOW_BATTERY = "LOW_BATTERY";
 287     public static final String ALARM_TYPE_VALVE_ERROR = "VALVE_ERROR";
 288     public static final String EVENT_TYPE_VIBRATION = "VIBRATION";
 289
 290     // Event types
 291     public static final String EVENT_TYPE_RELAY = "relay";
 292     public static final String EVENT_TYPE_ROLLER = "roller";
 293     public static final String EVENT_TYPE_LIGHT = "light";
 294     public static final String EVENT_TYPE_SENSORDATA = "report";
 295
 296     // URI for the EventServlet
 297     public static final String SHELLY1_CALLBACK_URI = "/shelly/event";
 298     public static final String SHELLY2_CALLBACK_URI = "/shelly/wsevent";
 299
 300     public static final int DIM_STEPSIZE = 5;
 301
 302     // Formatting: Number of scaling digits
 303     public static final int DIGITS_NONE = 0;
 304     public static final int DIGITS_WATT = 2;
 305     public static final int DIGITS_KWH = 3;
 306     public static final int DIGITS_VOLT = 1;
 307     public static final int DIGITS_AMPERE = 3;
 308     public static final int DIGITS_TEMP = 1;
 309     public static final int DIGITS_LUX = 0;
 310     public static final int DIGITS_PERCENT = 1;
 311
 312     public static final int SHELLY_API_TIMEOUT_MS = 15000;
 313     public static final int UPDATE_STATUS_INTERVAL_SECONDS = 3; // check for updates every x sec
 314     public static final int UPDATE_SKIP_COUNT = 20; // update every x triggers or when a key was pressed
 315     public static final int UPDATE_MIN_DELAY = 15;// update every x triggers or when a key was pressed
 316     public static final int UPDATE_SETTINGS_INTERVAL_SECONDS = 60; // check for updates every x sec
 317     public static final int HEALTH_CHECK_INTERVAL_SEC = 300; // Health check interval, 5min
 318     public static final int VIBRATION_FILTER_SEC = 5; // Absore duplicate vibration events for xx sec
 319
 320     public static final String BUNDLE_RESOURCE_SNIPLETS = "sniplets"; // where to find code sniplets in the bundle
 321     public static final String BUNDLE_RESOURCE_SCRIPTS = "scripts"; // where to find scrips in the bundle
 322 }