2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.shelly.internal.handler;
15 import static org.openhab.binding.shelly.internal.ShellyBindingConstants.*;
16 import static org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.*;
17 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
19 import org.eclipse.jdt.annotation.NonNullByDefault;
20 import org.eclipse.jdt.annotation.Nullable;
21 import org.openhab.binding.shelly.internal.api.ShellyApiException;
22 import org.openhab.binding.shelly.internal.api.ShellyDeviceProfile;
23 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO;
24 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyRollerStatus;
25 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsDimmer;
26 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsEMeter;
27 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsMeter;
28 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRelay;
29 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsStatus;
30 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyShortLightStatus;
31 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor;
32 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyADC;
33 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtTemperature.ShellyShortTemp;
34 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyThermnostat;
35 import org.openhab.binding.shelly.internal.provider.ShellyChannelDefinitions;
36 import org.openhab.core.library.types.OnOffType;
37 import org.openhab.core.library.types.StringType;
38 import org.openhab.core.library.unit.ImperialUnits;
39 import org.openhab.core.library.unit.SIUnits;
40 import org.openhab.core.library.unit.Units;
41 import org.openhab.core.types.UnDefType;
43 import com.google.gson.Gson;
46 * The{@link ShellyComponents} implements updates for supplemental components
47 * Meter will be used by Relay + Light; Sensor is part of H&T, Flood, Door Window, Sense
49 * @author Markus Michels - Initial contribution
52 public class ShellyComponents {
55 * Update device status
57 * @param th Thing Handler instance
58 * @param profile ShellyDeviceProfile
60 public static boolean updateDeviceStatus(ShellyThingInterface thingHandler, ShellySettingsStatus status) {
61 ShellyDeviceProfile profile = thingHandler.getProfile();
63 if (!profile.gateway.isEmpty()) {
64 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_GATEWAY, getStringType(profile.gateway));
66 if (!thingHandler.areChannelsCreated()) {
67 thingHandler.updateChannelDefinitions(ShellyChannelDefinitions.createDeviceChannels(thingHandler.getThing(),
68 thingHandler.getProfile(), status));
71 if (getLong(status.uptime) > 10) {
72 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_UPTIME,
73 toQuantityType((double) getLong(status.uptime), DIGITS_NONE, Units.SECOND));
76 Integer rssi = getInteger(status.wifiSta.rssi);
77 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_RSSI, mapSignalStrength(rssi));
78 if (status.tmp != null && getBool(status.tmp.isValid) && !thingHandler.getProfile().isSensor
79 && status.tmp.tC != SHELLY_API_INVTEMP) {
80 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ITEMP,
81 toQuantityType(getDouble(status.tmp.tC), DIGITS_NONE, SIUnits.CELSIUS));
82 } else if (status.temperature != null && status.temperature != SHELLY_API_INVTEMP) {
83 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ITEMP,
84 toQuantityType(getDouble(status.temperature), DIGITS_NONE, SIUnits.CELSIUS));
86 thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_SLEEPTIME,
87 toQuantityType(getInteger(status.sleepTime), Units.SECOND));
89 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_UPDATE, getOnOff(status.hasUpdate));
91 if (profile.settings.calibrated != null) {
92 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_CALIBRATED,
93 getOnOff(profile.settings.calibrated));
96 return false; // device status never triggers update
99 public static boolean updateRelay(ShellyBaseHandler thingHandler, ShellySettingsStatus status, int id) {
100 ShellyDeviceProfile profile = thingHandler.getProfile();
101 ShellySettingsRelay relay = status.relays.get(id);
102 ShellySettingsRelay rsettings;
103 if (profile.settings.relays != null) {
104 rsettings = profile.settings.relays.get(id);
106 throw new IllegalArgumentException("No relay settings");
109 boolean updated = false;
110 if (relay.isValid == null || relay.isValid) {
111 String groupName = profile.getControlGroup(id);
112 updated |= thingHandler.updateChannel(groupName, CHANNEL_OUTPUT_NAME, getStringType(rsettings.name));
114 if (getBool(relay.overpower)) {
115 thingHandler.postEvent(ALARM_TYPE_OVERPOWER, false);
118 updated |= thingHandler.updateChannel(groupName, CHANNEL_OUTPUT, getOnOff(relay.ison));
119 updated |= thingHandler.updateChannel(groupName, CHANNEL_TIMER_ACTIVE, getOnOff(relay.hasTimer));
120 if (status.extSwitch != null) {
121 if (status.extSwitch.input0 != null) {
122 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_ESENSOR_INPUT1,
123 getOpenClosed(getInteger(status.extSwitch.input0.input) == 1));
126 if (status.extTemperature != null) {
127 // Shelly 1/1PM support up to 3 external sensors
128 // for whatever reason those are not represented as an array, but 3 elements
129 updated |= updateTempChannel(status.extTemperature.sensor1, thingHandler, CHANNEL_ESENSOR_TEMP1);
130 updated |= updateTempChannel(status.extTemperature.sensor2, thingHandler, CHANNEL_ESENSOR_TEMP2);
131 updated |= updateTempChannel(status.extTemperature.sensor3, thingHandler, CHANNEL_ESENSOR_TEMP3);
132 updated |= updateTempChannel(status.extTemperature.sensor4, thingHandler, CHANNEL_ESENSOR_TEMP4);
133 updated |= updateTempChannel(status.extTemperature.sensor5, thingHandler, CHANNEL_ESENSOR_TEMP5);
135 if ((status.extHumidity != null) && (status.extHumidity.sensor1 != null)) {
136 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_ESENSOR_HUMIDITY,
137 toQuantityType(getDouble(status.extHumidity.sensor1.hum), DIGITS_PERCENT, Units.PERCENT));
139 if ((status.extVoltage != null) && (status.extVoltage.sensor1 != null)) {
140 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_ESENSOR_VOLTAGE,
141 toQuantityType(getDouble(status.extVoltage.sensor1.voltage), 4, Units.VOLT));
143 if ((status.extDigitalInput != null) && (status.extDigitalInput.sensor1 != null)) {
144 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_ESENSOR_DIGITALINPUT,
145 getOnOff(status.extDigitalInput.sensor1.state));
147 if ((status.extAnalogInput != null) && (status.extAnalogInput.sensor1 != null)) {
148 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_ESENSOR_ANALOGINPUT, toQuantityType(
149 getDouble(status.extAnalogInput.sensor1.percent), DIGITS_PERCENT, Units.PERCENT));
152 // Update Auto-ON/OFF timer
153 updated |= thingHandler.updateChannel(groupName, CHANNEL_TIMER_AUTOON,
154 toQuantityType(getDouble(rsettings.autoOn), Units.SECOND));
155 updated |= thingHandler.updateChannel(groupName, CHANNEL_TIMER_AUTOOFF,
156 toQuantityType(getDouble(rsettings.autoOff), Units.SECOND));
161 public static boolean updateRoller(ShellyBaseHandler thingHandler, ShellyRollerStatus control, int id)
162 throws ShellyApiException {
163 ShellyDeviceProfile profile = thingHandler.getProfile();
164 boolean updated = false;
165 if (getBool(control.isValid)) {
166 String groupName = profile.getControlGroup(id);
167 if (control.name != null) {
168 updated |= thingHandler.updateChannel(groupName, CHANNEL_OUTPUT_NAME, getStringType(control.name));
171 String state = getString(control.state);
174 case SHELLY_ALWD_ROLLER_TURN_OPEN:
175 pos = SHELLY_MAX_ROLLER_POS;
177 case SHELLY_ALWD_ROLLER_TURN_CLOSE:
178 pos = SHELLY_MIN_ROLLER_POS;
180 case SHELLY_ALWD_ROLLER_TURN_STOP:
181 if (control.currentPos != null) {
182 // only valid in stop state
183 pos = Math.max(SHELLY_MIN_ROLLER_POS, Math.min(control.currentPos, SHELLY_MAX_ROLLER_POS));
188 thingHandler.logger.debug("{}: Update roller position to {}/{}, state={}", thingHandler.thingName, pos,
189 SHELLY_MAX_ROLLER_POS - pos, state);
190 updated |= thingHandler.updateChannel(groupName, CHANNEL_ROL_CONTROL_CONTROL,
191 toQuantityType((double) (SHELLY_MAX_ROLLER_POS - pos), Units.PERCENT));
192 updated |= thingHandler.updateChannel(groupName, CHANNEL_ROL_CONTROL_POS,
193 toQuantityType((double) pos, Units.PERCENT));
196 updated |= thingHandler.updateChannel(groupName, CHANNEL_ROL_CONTROL_STATE, new StringType(state));
197 updated |= thingHandler.updateChannel(groupName, CHANNEL_ROL_CONTROL_STOPR,
198 getStringType(control.stopReason));
199 updated |= thingHandler.updateChannel(groupName, CHANNEL_ROL_CONTROL_SAFETY,
200 getOnOff(control.safetySwitch));
206 * Update Meter channel
208 * @param th Thing Handler instance
209 * @param profile ShellyDeviceProfile
210 * @param status Last ShellySettingsStatus
212 public static boolean updateMeters(ShellyThingInterface thingHandler, ShellySettingsStatus status) {
213 ShellyDeviceProfile profile = thingHandler.getProfile();
215 double accumulatedWatts = 0.0;
216 double accumulatedTotal = 0.0;
217 double accumulatedReturned = 0.0;
219 boolean updated = false;
220 // Devices without power meters get no updates
222 // Roler+RGBW2 have multiple meters -> aggregate consumption to the functional device
223 // Meter and EMeter have a different set of channels
224 if (status.meters != null || status.emeters != null) {
225 if (!profile.isRoller && !profile.isRGBW2) {
226 // In Relay mode we map eacher meter to the matching channel group
228 if (!profile.isEMeter) {
229 for (ShellySettingsMeter meter : status.meters) {
230 if (m >= profile.numMeters) {
231 // Shelly1: reports status.meters[0].is_valid = true, but even doesn't have a meter
232 meter.isValid = false;
234 if (getBool(meter.isValid) || profile.isLight) { // RGBW2-white doesn't report valid flag
235 // correctly in white mode
236 String groupName = profile.getMeterGroup(m);
237 if (!thingHandler.areChannelsCreated()) {
238 // skip for Shelly Bulb: JSON has a meter, but values don't get updated
239 if (!profile.isBulb) {
240 thingHandler.updateChannelDefinitions(ShellyChannelDefinitions
241 .createMeterChannels(thingHandler.getThing(), meter, groupName));
245 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_CURRENTWATTS,
246 toQuantityType(getDouble(meter.power), DIGITS_WATT, Units.WATT));
247 accumulatedWatts += getDouble(meter.power);
249 // convert Watt/Min to kw/h
250 if (meter.total != null) {
251 double kwh = getDouble(meter.total) / 1000 / 60;
252 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_TOTALKWH,
253 toQuantityType(kwh, DIGITS_KWH, Units.KILOWATT_HOUR));
254 accumulatedTotal += kwh;
256 if (meter.counters != null) {
257 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_LASTMIN1,
258 toQuantityType(getDouble(meter.counters[0]), DIGITS_WATT, Units.WATT));
260 if (meter.timestamp != null) {
261 thingHandler.updateChannel(groupName, CHANNEL_LAST_UPDATE,
262 getTimestamp(getString(profile.settings.timezone), meter.timestamp));
268 for (ShellySettingsEMeter emeter : status.emeters) {
269 if (getBool(emeter.isValid)) {
270 String groupName = profile.getMeterGroup(m);
271 if (!thingHandler.areChannelsCreated()) {
272 thingHandler.updateChannelDefinitions(ShellyChannelDefinitions
273 .createEMeterChannels(thingHandler.getThing(), profile, emeter, groupName));
276 // convert Watt/h to KW/h
277 double total = getDouble(emeter.total) / 1000;
278 double totalReturned = getDouble(emeter.totalReturned) / 1000;
279 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_CURRENTWATTS,
280 toQuantityType(getDouble(emeter.power), DIGITS_WATT, Units.WATT));
281 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_TOTALKWH,
282 toQuantityType(total, DIGITS_KWH, Units.KILOWATT_HOUR));
283 updated |= thingHandler.updateChannel(groupName, CHANNEL_EMETER_TOTALRET,
284 toQuantityType(totalReturned, DIGITS_KWH, Units.KILOWATT_HOUR));
285 updated |= thingHandler.updateChannel(groupName, CHANNEL_EMETER_REACTWATTS,
286 toQuantityType(getDouble(emeter.reactive), DIGITS_WATT, Units.WATT));
287 updated |= thingHandler.updateChannel(groupName, CHANNEL_EMETER_VOLTAGE,
288 toQuantityType(getDouble(emeter.voltage), DIGITS_VOLT, Units.VOLT));
289 updated |= thingHandler.updateChannel(groupName, CHANNEL_EMETER_CURRENT,
290 toQuantityType(getDouble(emeter.current), DIGITS_AMPERE, Units.AMPERE));
291 updated |= thingHandler.updateChannel(groupName, CHANNEL_EMETER_PFACTOR,
292 toQuantityType(computePF(emeter), Units.PERCENT));
294 accumulatedWatts += getDouble(emeter.power);
295 accumulatedTotal += total;
296 accumulatedReturned += totalReturned;
298 thingHandler.updateChannel(groupName, CHANNEL_LAST_UPDATE, getTimestamp());
305 // In Roller Mode we accumulate all meters to a single set of meters
306 double currentWatts = 0.0;
307 double totalWatts = 0.0;
308 double lastMin1 = 0.0;
310 String groupName = CHANNEL_GROUP_METER;
312 if (!thingHandler.areChannelsCreated()) {
313 ShellySettingsMeter m = status.meters.get(0);
314 if (getBool(m.isValid)) {
315 // Create channels for 1 Meter
316 thingHandler.updateChannelDefinitions(
317 ShellyChannelDefinitions.createMeterChannels(thingHandler.getThing(), m, groupName));
321 for (ShellySettingsMeter meter : status.meters) {
322 if (getBool(meter.isValid)) {
323 currentWatts += getDouble(meter.power);
324 totalWatts += getDouble(meter.total);
325 if (meter.counters != null) {
326 lastMin1 += getDouble(meter.counters[0]);
328 if (getLong(meter.timestamp) > timestamp) {
329 timestamp = getLong(meter.timestamp); // newest one
334 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_LASTMIN1,
335 toQuantityType(getDouble(lastMin1), DIGITS_WATT, Units.WATT));
337 // convert totalWatts into kw/h
338 totalWatts = totalWatts / (60.0 * 1000.0);
339 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_CURRENTWATTS,
340 toQuantityType(currentWatts, DIGITS_WATT, Units.WATT));
341 updated |= thingHandler.updateChannel(groupName, CHANNEL_METER_TOTALKWH,
342 toQuantityType(totalWatts, DIGITS_KWH, Units.KILOWATT_HOUR));
344 if (updated && timestamp > 0) {
345 thingHandler.updateChannel(groupName, CHANNEL_LAST_UPDATE,
346 getTimestamp(getString(profile.settings.timezone), timestamp));
350 if (!profile.isRoller && !profile.isRGBW2) {
351 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ACCUWATTS, toQuantityType(
352 status.totalPower != null ? status.totalPower : accumulatedWatts, DIGITS_WATT, Units.WATT));
353 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ACCUTOTAL,
354 toQuantityType(status.totalCurrent != null ? status.totalCurrent / 1000 : accumulatedTotal,
355 DIGITS_KWH, Units.KILOWATT_HOUR));
356 thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ACCURETURNED,
357 toQuantityType(status.totalReturned != null ? status.totalReturned / 1000 : accumulatedReturned,
358 DIGITS_KWH, Units.KILOWATT_HOUR));
365 private static Double computePF(ShellySettingsEMeter emeter) {
366 if (emeter.pf != null) { // EM3
367 return emeter.pf; // take device value
370 // EM: compute from provided values
371 if (emeter.reactive != null && Math.abs(emeter.power) + Math.abs(emeter.reactive) > 1.5) {
372 return emeter.power / Math.sqrt(emeter.power * emeter.power + emeter.reactive * emeter.reactive);
378 * Update Sensor channel
380 * @param th Thing Handler instance
381 * @param profile ShellyDeviceProfile
382 * @param status Last ShellySettingsStatus
384 * @throws ShellyApiException
386 public static boolean updateSensors(ShellyThingInterface thingHandler, ShellySettingsStatus status)
387 throws ShellyApiException {
388 ShellyDeviceProfile profile = thingHandler.getProfile();
390 boolean updated = false;
391 if (profile.isSensor || profile.hasBattery) {
392 ShellyStatusSensor sdata = thingHandler.getApi().getSensorStatus();
393 if (!thingHandler.areChannelsCreated()) {
394 thingHandler.updateChannelDefinitions(
395 ShellyChannelDefinitions.createSensorChannels(thingHandler.getThing(), profile, sdata));
398 updated |= thingHandler.updateWakeupReason(sdata.actReasons);
400 if ((sdata.sensor != null) && sdata.sensor.isValid) {
401 // Shelly DW: “sensor”:{“state”:“open”, “is_valid”:true},
402 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE,
403 getOpenClosed(getString(sdata.sensor.state).equalsIgnoreCase(SHELLY_API_DWSTATE_OPEN)));
404 String sensorError = sdata.sensorError;
405 boolean changed = thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_ERROR,
406 getStringType(sensorError));
407 if (changed && !"0".equals(sensorError)) {
408 thingHandler.postEvent(getString(sdata.sensorError), true);
412 if (sdata.tmp != null && getBool(sdata.tmp.isValid)) {
413 Double temp = getString(sdata.tmp.units).toUpperCase().equals(SHELLY_TEMP_CELSIUS)
414 ? getDouble(sdata.tmp.tC)
415 : getDouble(sdata.tmp.tF);
416 updated |= updateTempChannel(thingHandler, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TEMP,
417 temp.doubleValue(), getString(sdata.tmp.units));
418 } else if (status.thermostats != null) {
420 if (profile.settings.thermostats != null) {
421 ShellyThermnostat ps = profile.settings.thermostats.get(0);
422 ShellyThermnostat t = status.thermostats.get(0);
423 int bminutes = getInteger(t.boostMinutes) >= 0 ? getInteger(t.boostMinutes)
424 : getInteger(ps.boostMinutes);
425 updated |= thingHandler.updateChannel(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BCONTROL,
426 getOnOff(getInteger(t.boostMinutes) > 0));
427 updated |= thingHandler.updateChannel(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BTIMER,
428 toQuantityType((double) bminutes, DIGITS_NONE, Units.MINUTE));
429 updated |= thingHandler.updateChannel(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_MODE, getStringType(
430 getBool(t.targetTemp.enabled) ? SHELLY_TRV_MODE_AUTO : SHELLY_TRV_MODE_MANUAL));
432 int pid = getBool(t.schedule) ? getInteger(t.profile) : 0;
433 updated |= thingHandler.updateChannel(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SCHEDULE,
434 getOnOff(t.schedule));
435 updated |= thingHandler.updateChannel(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_PROFILE,
436 getStringType(profile.getValueProfile(0, pid)));
438 updated |= updateTempChannel(thingHandler, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TEMP,
439 t.tmp.value, t.tmp.units);
440 updated |= updateTempChannel(thingHandler, CHANNEL_GROUP_SENSOR, CHANNEL_CONTROL_SETTEMP,
441 t.targetTemp.value, t.targetTemp.unit);
444 updated |= thingHandler.updateChannel(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_POSITION,
445 t.pos != -1 ? toQuantityType(t.pos, DIGITS_NONE, Units.PERCENT) : UnDefType.UNDEF);
446 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE,
447 getOpenClosed(getDouble(t.pos) > 0));
452 if (sdata.hum != null) {
453 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_HUM,
454 toQuantityType(getDouble(sdata.hum.value), DIGITS_PERCENT, Units.PERCENT));
456 if ((sdata.lux != null) && getBool(sdata.lux.isValid)) {
457 // “lux”:{“value”:30, “illumination”: “dark”, “is_valid”:true},
458 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_LUX,
459 toQuantityType(getDouble(sdata.lux.value), DIGITS_LUX, Units.LUX));
460 if (sdata.lux.illumination != null) {
461 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_ILLUM,
462 getStringType(sdata.lux.illumination));
465 if (sdata.accel != null) {
466 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TILT,
467 toQuantityType(getDouble(sdata.accel.tilt.doubleValue()), DIGITS_NONE, Units.DEGREE_ANGLE));
469 if (sdata.flood != null) {
470 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_FLOOD,
471 getOnOff(sdata.flood));
473 if (sdata.smoke != null) {
474 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_SMOKE,
475 getOnOff(sdata.smoke));
477 if (sdata.mute != null) {
478 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MUTE, getOnOff(sdata.mute));
481 if (sdata.gasSensor != null) {
482 updated |= thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_SELFTTEST,
483 getStringType(sdata.gasSensor.selfTestState));
484 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_ALARM_STATE,
485 getStringType(sdata.gasSensor.alarmState));
486 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_SSTATE,
487 getStringType(sdata.gasSensor.sensorState));
489 if ((sdata.concentration != null) && sdata.concentration.isValid) {
490 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_PPM, toQuantityType(
491 getInteger(sdata.concentration.ppm).doubleValue(), DIGITS_NONE, Units.PARTS_PER_MILLION));
493 if ((sdata.adcs != null) && (!sdata.adcs.isEmpty())) {
494 ShellyADC adc = sdata.adcs.get(0);
495 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VOLTAGE,
496 toQuantityType(getDouble(adc.voltage), 2, Units.VOLT));
499 boolean charger = (getInteger(profile.settings.externalPower) == 1) || getBool(sdata.charger);
500 if ((profile.settings.externalPower != null) || (sdata.charger != null)) {
501 updated |= thingHandler.updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_CHARGER,
504 if (sdata.bat != null) { // no update for Sense
505 updated |= thingHandler.updateChannel(CHANNEL_GROUP_BATTERY, CHANNEL_SENSOR_BAT_LEVEL,
506 toQuantityType(getDouble(sdata.bat.value), 0, Units.PERCENT));
508 int lowBattery = thingHandler.getThingConfig().lowBattery;
509 boolean changed = thingHandler.updateChannel(CHANNEL_GROUP_BATTERY, CHANNEL_SENSOR_BAT_LOW,
510 getOnOff(!charger && getDouble(sdata.bat.value) < lowBattery));
512 if (!charger && changed && getDouble(sdata.bat.value) < lowBattery) {
513 thingHandler.postEvent(ALARM_TYPE_LOW_BATTERY, false);
517 if (sdata.motion != null) { // Shelly Sense
518 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION,
519 getOnOff(sdata.motion));
521 if (sdata.sensor != null) { // Shelly Motion
522 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION_ACT,
523 getOnOff(sdata.sensor.motionActive));
524 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION,
525 getOnOff(sdata.sensor.motion));
526 long timestamp = getLong(sdata.sensor.motionTimestamp);
527 if (timestamp != 0) {
528 updated |= thingHandler.updateChannel(CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION_TS,
529 getTimestamp(getString(profile.settings.timezone), timestamp));
533 updated |= thingHandler.updateInputs(status);
536 thingHandler.updateChannel(profile.getControlGroup(0), CHANNEL_LAST_UPDATE, getTimestamp());
542 public static boolean updateDimmers(ShellyThingInterface thingHandler, ShellySettingsStatus orgStatus)
543 throws ShellyApiException {
544 boolean updated = false;
545 ShellyDeviceProfile profile = thingHandler.getProfile();
546 if (profile.isDimmer) {
547 // We need to fixup the returned Json: The dimmer returns light[] element, which is ok, but it doesn't have
548 // the same structure as lights[] from Bulb,RGBW2 and Duo. The tag gets replaced by dimmers[] so that Gson
549 // maps to a different structure (ShellyShortLight).
550 Gson gson = new Gson();
551 ShellySettingsStatus dstatus = !profile.isGen2
552 ? fromJson(gson, Shelly1ApiJsonDTO.fixDimmerJson(orgStatus.json), ShellySettingsStatus.class)
556 for (ShellyShortLightStatus dimmer : dstatus.dimmers) {
558 String groupName = profile.numRelays <= 1 ? CHANNEL_GROUP_DIMMER_CONTROL
559 : CHANNEL_GROUP_DIMMER_CONTROL + r.toString();
561 if (!thingHandler.areChannelsCreated()) {
562 thingHandler.updateChannelDefinitions(ShellyChannelDefinitions
563 .createDimmerChannels(thingHandler.getThing(), profile, dstatus, l));
566 ShellySettingsDimmer ds = profile.settings.dimmers.get(l);
567 if (ds.name != null) {
568 updated |= thingHandler.updateChannel(groupName, CHANNEL_OUTPUT_NAME, getStringType(ds.name));
571 // On a status update we map a dimmer.ison = false to brightness 0 rather than the device's brightness
572 // and send an OFF status to the same channel.
573 // When the device's brightness is > 0 we send the new value to the channel and an ON command
575 updated |= thingHandler.updateChannel(groupName, CHANNEL_BRIGHTNESS + "$Switch", OnOffType.ON);
576 updated |= thingHandler.updateChannel(groupName, CHANNEL_BRIGHTNESS + "$Value",
577 toQuantityType((double) getInteger(dimmer.brightness), DIGITS_NONE, Units.PERCENT));
579 updated |= thingHandler.updateChannel(groupName, CHANNEL_BRIGHTNESS + "$Switch", OnOffType.OFF);
580 updated |= thingHandler.updateChannel(groupName, CHANNEL_BRIGHTNESS + "$Value",
581 toQuantityType(0.0, DIGITS_NONE, Units.PERCENT));
584 if (profile.settings.dimmers != null) {
585 ShellySettingsDimmer dsettings = profile.settings.dimmers.get(l);
586 if (dsettings != null) {
587 updated |= thingHandler.updateChannel(groupName, CHANNEL_TIMER_AUTOON,
588 toQuantityType(getDouble(dsettings.autoOn), Units.SECOND));
589 updated |= thingHandler.updateChannel(groupName, CHANNEL_TIMER_AUTOOFF,
590 toQuantityType(getDouble(dsettings.autoOff), Units.SECOND));
600 public static boolean updateTempChannel(@Nullable ShellyShortTemp sensor, ShellyThingInterface thingHandler,
602 return sensor != null ? updateTempChannel(thingHandler, CHANNEL_GROUP_SENSOR, channel, sensor.tC, "") : false;
605 public static boolean updateTempChannel(ShellyThingInterface thingHandler, String group, String channel,
606 @Nullable Double temp, @Nullable String unit) {
607 if (temp == null || temp == SHELLY_API_INVTEMP) {
610 return thingHandler.updateChannel(group, channel,
611 toQuantityType(convertToC(temp, unit), DIGITS_TEMP, SIUnits.CELSIUS));
614 private static Double convertToC(@Nullable Double temp, @Nullable String unit) {
615 if (temp == null || temp == SHELLY_API_INVTEMP) {
616 return SHELLY_API_INVTEMP;
618 if (SHELLY_TEMP_FAHRENHEIT.equalsIgnoreCase(getString(unit))) {
619 // convert Fahrenheit to Celsius
620 return ImperialUnits.FAHRENHEIT.getConverterTo(SIUnits.CELSIUS).convert(temp).doubleValue();