git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2024 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 /**
  14  * The {@link Shelly1CoIoTVersion1} implements the parsing for CoIoT version 1
  15  *
  16  * @author Markus Michels - Initial contribution
  17  */
  18 package org.openhab.binding.shelly.internal.api1;
  19
  20 import static org.openhab.binding.shelly.internal.ShellyBindingConstants.*;
  21 import static org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.*;
  22 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
  23
  24 import java.util.List;
  25 import java.util.Map;
  26
  27 import org.eclipse.jdt.annotation.NonNullByDefault;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.openhab.binding.shelly.internal.api1.Shelly1CoapJSonDTO.CoIotDescrBlk;
  30 import org.openhab.binding.shelly.internal.api1.Shelly1CoapJSonDTO.CoIotDescrSen;
  31 import org.openhab.binding.shelly.internal.api1.Shelly1CoapJSonDTO.CoIotSensor;
  32 import org.openhab.binding.shelly.internal.handler.ShellyColorUtils;
  33 import org.openhab.binding.shelly.internal.handler.ShellyThingInterface;
  34 import org.openhab.core.library.types.OnOffType;
  35 import org.openhab.core.library.types.OpenClosedType;
  36 import org.openhab.core.library.unit.SIUnits;
  37 import org.openhab.core.library.unit.Units;
  38 import org.openhab.core.types.State;
  39 import org.openhab.core.types.UnDefType;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 /**
  44  * The {@link Shelly1CoIoTVersion1} implements the parsing for CoIoT version 2
  45  *
  46  * @author Markus Michels - Initial contribution
  47  */
  48 @NonNullByDefault
  49 public class Shelly1CoIoTVersion2 extends Shelly1CoIoTProtocol implements Shelly1CoIoTInterface {
  50     private final Logger logger = LoggerFactory.getLogger(Shelly1CoIoTVersion2.class);
  51     private int lastCfgCount = -1;
  52
  53     public Shelly1CoIoTVersion2(String thingName, ShellyThingInterface thingHandler, Map<String, CoIotDescrBlk> blkMap,
  54             Map<String, CoIotDescrSen> sensorMap) {
  55         super(thingName, thingHandler, blkMap, sensorMap);
  56     }
  57
  58     @Override
  59     public int getVersion() {
  60         return Shelly1CoapJSonDTO.COIOT_VERSION_2;
  61     }
  62
  63     /**
  64      * Process CoIoT status update message. If a status update is received, but the device description has not been
  65      * received yet a GET is send to query device description.
  66      *
  67      * @param sensorUpdates Complete list of sensor updates
  68      * @param sen The specific sensor update to handle
  69      * @param updates Resulting updates (new updates will be added to input list)
  70      */
  71     @Override
  72     public boolean handleStatusUpdate(List<CoIotSensor> sensorUpdates, CoIotDescrSen sen, int serial, CoIotSensor s,
  73             Map<String, State> updates, ShellyColorUtils col) {
  74         // first check the base implementation
  75         if (super.handleStatusUpdate(sensorUpdates, sen, s, updates, col)) {
  76             // process by the base class
  77             return true;
  78         }
  79
  80         // Process status information and convert into channel updates
  81         // Integer rIndex = Integer.parseInt(sen.links) + 1;
  82         int rIndex = getIdFromBlk(sen);
  83         String rGroup = getProfile().numRelays <= 1 ? CHANNEL_GROUP_RELAY_CONTROL
  84                 : CHANNEL_GROUP_RELAY_CONTROL + rIndex;
  85         String mGroup = profile.numMeters <= 1 ? CHANNEL_GROUP_METER
  86                 : CHANNEL_GROUP_METER + (profile.isEMeter ? getIdFromBlk(sen) : rIndex);
  87
  88         boolean processed = true;
  89         double value = getDouble(s.value);
  90         String reason = "";
  91
  92         if (profile.isTRV) {
  93             // Special handling for TRV, because it uses duplicate ID values with different meanings
  94             switch (sen.id) {
  95                 case "3101": // current temp
  96                     if (value != SHELLY_API_INVTEMP) {
  97                         updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TEMP,
  98                                 toQuantityType(value, DIGITS_TEMP, SIUnits.CELSIUS));
  99                     }
 100                     break;
 101                 case "3103": // target temp in C. 4/31, 999=unknown
 102                     updateChannel(updates, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SETTEMP,
 103                             toQuantityType(value, DIGITS_TEMP, SIUnits.CELSIUS));
 104                     break;
 105                 case "3116": // S, valveError, 0/1
 106                     if (s.value == 1) {
 107                         thingHandler.postEvent(ALARM_TYPE_VALVE_ERROR, false);
 108                     }
 109                     break;
 110                 case "3117": // S, mode, 0-5 (0=disabled)
 111                     value = getDouble(s.value).intValue();
 112                     updateChannel(updates, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_PROFILE,
 113                             getStringType(profile.getValueProfile(0, (int) value)));
 114                     updateChannel(updates, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SCHEDULE, getOnOff(value > 0));
 115                     break;
 116                 case "3118": // Valve state
 117                     updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE,
 118                             value != 0 ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
 119                     break;
 120                 case "3121": // valvePos, Type=S, Range=0/100;
 121                     boolean updated = updateChannel(updates, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_POSITION,
 122                             s.value != -1 ? toQuantityType(getDouble(s.value), 0, Units.PERCENT) : UnDefType.UNDEF);
 123                     if (updated && s.value >= 0 && s.value != thingHandler.getChannelDouble(CHANNEL_GROUP_CONTROL,
 124                             CHANNEL_CONTROL_POSITION)) {
 125                         logger.debug("{}: Valve position changed, force update", thingName);
 126                         thingHandler.requestUpdates(1, false);
 127                     }
 128                     break;
 129                 case "3122": // boost mode, Type=S, Range=0/1
 130                     updateChannel(updates, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BCONTROL, getOnOff(value > 0));
 131                     break;
 132                 default:
 133                     processed = false;
 134             }
 135         } else {
 136             processed = false;
 137         }
 138
 139         if (processed) {
 140             return true;
 141         }
 142
 143         processed = true;
 144         switch (sen.id) {
 145             case "6": // 3EM: neutralCurrent
 146                 break;
 147
 148             case "3106": // L, luminosity, lux, U32, -1
 149             case "3110": // S, luminosityLevel, dark/twilight/bright, "unknown"=unknown
 150             case "3111": // B, battery, 0-100%, unknown -1
 151             case "3112": // S, charger, 0/1
 152             case "3115": // S, sensorError, 0/1
 153                 // processed by base handler
 154                 break;
 155
 156             case "6109": // P, overpowerValue, W, U32
 157             case "9101":
 158                 // Relay: S, mode, relay/roller or
 159                 // Dimmer: S, mode, color/white
 160                 // skip, could check against thing mode...
 161                 break;
 162
 163             case "1101": // relay_0: output, 0/1
 164             case "1201": // relay_1: output, 0/1
 165             case "1301": // relay_2: output, 0/1
 166             case "1401": // relay_3: output, 0/1
 167                 updatePower(profile, updates, rIndex, sen, s, sensorUpdates);
 168                 break;
 169             case "1102": // roler_0: S, roller, open/close/stop -> roller state
 170                 updateChannel(updates, CHANNEL_GROUP_ROL_CONTROL, CHANNEL_ROL_CONTROL_STATE, getStringType(s.valueStr));
 171                 break;
 172             case "1103": // roller_0: S, rollerPos, 0-100, unknown -1
 173                 int pos = Math.max(SHELLY_MIN_ROLLER_POS, Math.min((int) value, SHELLY_MAX_ROLLER_POS));
 174                 logger.debug("{}: CoAP update roller position: control={}, position={}", thingName,
 175                         SHELLY_MAX_ROLLER_POS - pos, pos);
 176                 updateChannel(updates, CHANNEL_GROUP_ROL_CONTROL, CHANNEL_ROL_CONTROL_CONTROL,
 177                         toQuantityType((double) (SHELLY_MAX_ROLLER_POS - pos), Units.PERCENT));
 178                 updateChannel(updates, CHANNEL_GROUP_ROL_CONTROL, CHANNEL_ROL_CONTROL_POS,
 179                         toQuantityType((double) pos, Units.PERCENT));
 180                 break;
 181             case "1105": // Gas: S, valve, closed/opened/not_connected/failure/closing/opening/checking or unknown
 182                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VALVE, getStringType(s.valueStr));
 183                 break;
 184
 185             case "2101": // Input_0: S, input, 0/1
 186             case "2201": // Input_1: S, input, 0/1
 187             case "2301": // Input_2: S, input, 0/1
 188             case "2401": // Input_3: S, input, 0/1
 189                 handleInput(sen, s, rGroup, updates);
 190                 break;
 191             case "2102": // Input_0: EV, inputEvent, S/SS/SSS/L
 192             case "2202": // Input_1: EV, inputEvent
 193             case "2302": // Input_2: EV, inputEvent
 194             case "2402": // Input_3: EV, inputEvent
 195                 handleInputEvent(sen, getString(s.valueStr), -1, serial, updates);
 196                 break;
 197             case "2103": // EVC, inputEventCnt, U16
 198             case "2203": // EVC, inputEventCnt, U16
 199             case "2303": // EVC, inputEventCnt, U16
 200             case "2403": // EVC, inputEventCnt, U16
 201                 handleInputEvent(sen, "", getInteger((int) s.value), serial, updates);
 202                 break;
 203             case "3101": // sensor_0: T, extTemp, C, -55/125; unknown 999
 204             case "3201": // sensor_1: T, extTemp, C, -55/125; unknown 999
 205             case "3301": // sensor_2: T, extTemp, C, -55/125; unknown 999
 206                 int idx = getExtTempId(sen.id);
 207                 if (idx >= 0 && value != SHELLY_API_INVTEMP) {
 208                     // H&T, Fllod, DW only have 1 channel, 1/1PM with Addon have up to to 3 sensors
 209                     String channel = profile.isSensor ? CHANNEL_SENSOR_TEMP : CHANNEL_SENSOR_TEMP + idx;
 210                     // Some devices report values = -999 or 99 during fw update
 211                     updateChannel(updates, CHANNEL_GROUP_SENSOR, channel,
 212                             toQuantityType(value, DIGITS_TEMP, SIUnits.CELSIUS));
 213                 } else {
 214                     logger.debug("{}: Unable to get extSensorId {} from {}/{}", thingName, sen.id, sen.type, sen.desc);
 215                 }
 216                 break;
 217             case "3104": // T, deviceTemp, Celsius -40/300; 999=unknown
 218                 if ("targetTemp".equalsIgnoreCase(sen.desc)) {
 219                     break; // target temp in F-> ignore
 220                 }
 221                 // sensor_0: T, internalTemp, F, 39/88, unknown 999
 222                 updateChannel(updates, CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ITEMP,
 223                         toQuantityType(value, DIGITS_NONE, SIUnits.CELSIUS));
 224                 break;
 225             case "3102": // sensor_0: T, extTemp, F, -67/257, unknown 999
 226             case "3202": // sensor_1: T, extTemp, F, -67/257, unknown 999
 227             case "3302": // sensor_2: T, extTemp, F, -67/257, unknown 999
 228             case "3105": // T, deviceTemp, Fahrenheit -40/572
 229                 // skip, we use only C
 230                 break;
 231
 232             case "3107": // C, Gas concentration, U16
 233                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_PPM, getDecimal(s.value));
 234                 break;
 235             case "3108": // DW: S, dwIsOpened, 0/1, -1=unknown
 236                 if (value != -1) {
 237                     updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE,
 238                             value != 0 ? OpenClosedType.OPEN : OpenClosedType.CLOSED);
 239                 } else {
 240                     logger.debug("{}: Sensor error reported, check device, battery and installation", thingName);
 241                 }
 242                 break;
 243             case "3109": // S, tilt, 0-180deg, -1
 244                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TILT,
 245                         toQuantityType(s.value, DIGITS_NONE, Units.DEGREE_ANGLE));
 246                 break;
 247             case "3113": // S, sensorOp, warmup/normal/fault
 248                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_SSTATE, getStringType(s.valueStr));
 249                 break;
 250             case "3114": // S, selfTest, not_completed/completed/running/pending
 251                 updateChannel(updates, CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_SELFTTEST, getStringType(s.valueStr));
 252                 break;
 253             case "3117": // S, extInput, 0/1
 254                 handleInput(sen, s, rGroup, updates);
 255                 break;
 256             case "3118":
 257                 updateChannel(updates, mGroup, CHANNEL_SENSOR_VOLTAGE,
 258                         toQuantityType(getDouble(s.value), 2, Units.VOLT));
 259                 break;
 260
 261             case "4101": // relay_0/light_0: P, power, W
 262             case "4201": // relay_1/light_1: P, power, W
 263             case "4301": // relay_2/light_2: P, power, W
 264             case "4401": // relay_3/light_3: P, power, W
 265             case "4105": // emeter_0: P, power, W
 266             case "4205": // emeter_1: P, power, W
 267             case "4305": // emeter_2: P, power, W
 268             case "4102": // roller_0: P, rollerPower, W, 0-2300, unknown -1
 269             case "4202": // roller_1: P, rollerPower, W, 0-2300, unknown -1
 270                 updateChannel(updates, mGroup, CHANNEL_METER_CURRENTWATTS,
 271                         toQuantityType(s.value, DIGITS_WATT, Units.WATT));
 272                 if (!profile.isRGBW2 && !profile.isRoller) {
 273                     // only for regular, not-aggregated meters
 274                     updateChannel(updates, mGroup, CHANNEL_LAST_UPDATE, getTimestamp());
 275                 }
 276                 break;
 277
 278             case "4103": // relay_0: E, energy, Wmin, U32
 279             case "4203": // relay_1: E, energy, Wmin, U32
 280             case "4303": // relay_2: E, energy, Wmin, U32
 281             case "4403": // relay_3: E, energy, Wmin, U32
 282             case "4104": // roller_0: E, rollerEnergy, Wmin, U32, -1
 283             case "4204": // roller_0: E, rollerEnergy, Wmin, U32, -1
 284             case "4106": // emeter_0: E, energy, Wh, U32
 285             case "4206": // emeter_1: E, energy, Wh, U32
 286             case "4306": // emeter_2: E, energy, Wh, U32
 287                 double total = profile.isEMeter ? s.value / 1000 : s.value / 60 / 1000;
 288                 updateChannel(updates, mGroup, CHANNEL_METER_TOTALKWH,
 289                         toQuantityType(total, DIGITS_KWH, Units.KILOWATT_HOUR));
 290                 break;
 291
 292             case "4107": // emeter_0: E, energyReturned, Wh, U32, -1
 293             case "4207": // emeter_1: E, energyReturned, Wh, U32, -1
 294             case "4307": // emeter_2: E, energyReturned, Wh, U32, -1
 295                 updateChannel(updates, mGroup, CHANNEL_EMETER_TOTALRET,
 296                         toQuantityType(getDouble(s.value) / 1000, DIGITS_KWH, Units.KILOWATT_HOUR));
 297                 break;
 298
 299             case "4108": // emeter_0: V, voltage, 0-265V, U32, -1
 300             case "4208": // emeter_1: V, voltage, 0-265V, U32, -1
 301             case "4308": // emeter_2: V, voltage, 0-265V, U32, -1
 302                 updateChannel(updates, mGroup, CHANNEL_EMETER_VOLTAGE,
 303                         toQuantityType(getDouble(s.value), DIGITS_VOLT, Units.VOLT));
 304                 break;
 305
 306             case "4109": // emeter_0: A, current, 0/120A, -1
 307             case "4209": // emeter_1: A, current, 0/120A, -1
 308             case "4309": // emeter_2: A, current, 0/120A, -1
 309                 updateChannel(updates, rGroup, CHANNEL_EMETER_CURRENT,
 310                         toQuantityType(getDouble(s.value), DIGITS_VOLT, Units.AMPERE));
 311                 break;
 312
 313             case "4110": // emeter_0: S, powerFactor, 0/1, -1
 314             case "4210": // emeter_1: S, powerFactor, 0/1, -1
 315             case "4310": // emeter_2: S, powerFactor, 0/1, -1
 316                 updateChannel(updates, rGroup, CHANNEL_EMETER_PFACTOR, getDecimal(s.value));
 317                 break;
 318
 319             case "5101": // {"I":5101,"T":"S","D":"brightness","R":"0/100","L":1},
 320             case "5102": // {"I":5102,"T":"S","D":"gain","R":"0/100","L":1},
 321             case "5103": // {"I":5103,"T":"S","D":"colorTemp","U":"K","R":"3000/6500","L":1},
 322             case "5105": // {"I":5105,"T":"S","D":"red","R":"0/255","L":1},
 323             case "5106": // {"I":5106,"T":"S","D":"green","R":"0/255","L":1},
 324             case "5107": // {"I":5107,"T":"S","D":"blue","R":"0/255","L":1},
 325             case "5108": // {"I":5108,"T":"S","D":"white","R":"0/255","L":1},
 326                 // already covered by base handler
 327                 break;
 328
 329             case "6101": // A, overtemp, 0/1
 330                 if (s.value == 1) {
 331                     thingHandler.postEvent(ALARM_TYPE_OVERTEMP, true);
 332                 }
 333                 break;
 334             case "6102": // relay_0: A, overpower, 0/1
 335             case "6202": // relay_1: A, overpower, 0/1
 336             case "6302": // relay_2: A, overpower, 0/1
 337             case "6402": // relay_3: A, overpower, 0/1
 338                 if (s.value == 1) {
 339                     thingHandler.postEvent(ALARM_TYPE_OVERPOWER, true);
 340                 }
 341                 break;
 342             case "6104": // relay_0: A, loadError, 0/1
 343             case "6204": // relay_1: A, loadError, 0/1
 344             case "6304": // relay_2: A, loadError, 0/1
 345             case "6404": // relay_3: A, loadError, 0/1
 346                 if (s.value == 1) {
 347                     thingHandler.postEvent(ALARM_TYPE_LOADERR, true);
 348                 }
 349                 break;
 350             case "6103": // roller_0: A, rollerStopReason, normal/safety_switch/obstacle/overpower
 351                 reason = getString(s.valueStr);
 352                 updateChannel(updates, CHANNEL_GROUP_ROL_CONTROL, CHANNEL_ROL_CONTROL_STOPR, getStringType(reason));
 353                 if (!reason.isEmpty() && !reason.equalsIgnoreCase(SHELLY_API_STOPR_NORMAL)) {
 354                     thingHandler.postEvent("ROLLER_" + reason.toUpperCase(), true);
 355                 }
 356             case "6106": // A, flood, 0/1, -1
 357                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_FLOOD, OnOffType.from(value == 1));
 358                 break;
 359
 360             case "6107": // A, motion, 0/1, -1
 361                 // {"I":6107,"T":"A","D":"motion","R":["0/1","-1"],"L":1},
 362                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION, OnOffType.from(value == 1));
 363                 break;
 364             case "3119": // Motion timestamp (timestamp os GMT, not adapted to the adapted timezone)
 365                 // {"I":3119,"T":"S","D":"timestamp","U":"s","R":["U32","-1"],"L":1},
 366                 if (s.value != 0) {
 367                     updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION_TS,
 368                             getTimestamp(getString("GMT"), (long) s.value));
 369                 }
 370                 break;
 371             case "3120": // motionActive (timestamp os GMT, not adapted to the adapted timezone)
 372                 // {"I":3120,"T":"S","D":"motionActive","R":["0/1","-1"],"L":1},
 373                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION_ACT,
 374                         getTimestamp("GMT", (long) s.value));
 375                 break;
 376
 377             case "6108": // A, gas, none/mild/heavy/test or unknown
 378                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_ALARM_STATE, getStringType(s.valueStr));
 379                 break;
 380             case "6110": // A, vibration, 0/1, -1=unknown
 381                 updateChannel(updates, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VIBRATION, OnOffType.from(s.value == 1));
 382                 if (s.value == 1) {
 383                     // post event
 384                     thingHandler.triggerChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ALARM, EVENT_TYPE_VIBRATION);
 385                 }
 386                 break;
 387             case "9102": // EV, wakeupEvent, battery/button/periodic/poweron/sensor/ext_power, "unknown"=unknown
 388                 if (!s.valueArray.isEmpty()) {
 389                     thingHandler.updateWakeupReason(s.valueArray);
 390                     lastWakeup = (String) s.valueArray.get(0);
 391                 }
 392                 break;
 393             case "9103": // EVC, cfgChanged, U16
 394                 if (lastCfgCount == -1 || lastCfgCount != s.value) {
 395                     thingHandler.requestUpdates(1, true); // refresh config
 396                 }
 397                 lastCfgCount = (int) s.value;
 398                 break;
 399
 400             default:
 401                 processed = false;
 402         }
 403         return processed;
 404     }
 405
 406     @Override
 407     public CoIotDescrSen fixDescription(@Nullable CoIotDescrSen sen, Map<String, CoIotDescrBlk> blkMap) {
 408         return super.fixDescription(sen, blkMap);
 409     }
 410
 411     private static final String ID_4101_DESCR = "{ \"I\":4101, \"T\":\"P\", \"D\":\"power\",  \"U\": \"W\",    \"R\":\"0/3500\", \"L\": 1}";
 412     private static final String ID_4103_DESCR = "{ \"I\":4103, \"T\":\"E\", \"D\":\"energy\", \"U\": \"Wmin\", \"R\":\"U32\", \"L\": 1}";
 413
 414     @Override
 415     public void completeMissingSensorDefinition(Map<String, CoIotDescrSen> sensorMap) {
 416         if (profile.isDuo && profile.inColor) {
 417             addSensor(sensorMap, "4101", ID_4101_DESCR);
 418             addSensor(sensorMap, "4103", ID_4103_DESCR);
 419         }
 420         super.completeMissingSensorDefinition(sensorMap);
 421     }
 422 }