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