2 * Copyright (c) 2010-2022 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.api1;
15 import java.util.ArrayList;
16 import java.util.List;
18 import org.eclipse.jdt.annotation.Nullable;
19 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyMotionSettings;
20 import org.openhab.core.thing.CommonTriggerEvents;
22 import com.google.gson.annotations.SerializedName;
25 * The {@link Shelly1ApiJsonDTO} is used for the JSon/GSon mapping
27 * @author Markus Michels - Initial contribution
29 public class Shelly1ApiJsonDTO {
30 public static final String SHELLY_NULL_URL = "null";
31 public static final String SHELLY_URL_DEVINFO = "/shelly";
32 public static final String SHELLY_URL_STATUS = "/status";
33 public static final String SHELLY_URL_SETTINGS = "/settings";
34 public static final String SHELLY_URL_SETTINGS_AP = "/settings/ap";
35 public static final String SHELLY_URL_SETTINGS_STA = "/settings/sta";
36 public static final String SHELLY_URL_SETTINGS_LOGIN = "/settings/sta";
37 public static final String SHELLY_URL_SETTINGS_CLOUD = "/settings/cloud";
38 public static final String SHELLY_URL_LIST_IR = "/ir/list";
39 public static final String SHELLY_URL_SEND_IR = "/ir/emit";
40 public static final String SHELLY_URL_RESTART = "/reboot";
42 public static final String SHELLY_URL_SETTINGS_RELAY = "/settings/relay";
43 public static final String SHELLY_URL_STATUS_RELEAY = "/status/relay";
44 public static final String SHELLY_URL_CONTROL_RELEAY = "/relay";
46 public static final String SHELLY_URL_SETTINGS_EMETER = "/settings/emeter";
47 public static final String SHELLY_URL_STATUS_EMETER = "/emeter";
48 public static final String SHELLY_URL_DATA_EMETER = "/emeter/{0}/em_data.csv";
50 public static final String SHELLY_URL_CONTROL_ROLLER = "/roller";
51 public static final String SHELLY_URL_SETTINGS_ROLLER = "/settings/roller";
53 public static final String SHELLY_URL_SETTINGS_LIGHT = "/settings/light";
54 public static final String SHELLY_URL_STATUS_LIGHT = "/light";
55 public static final String SHELLY_URL_CONTROL_LIGHT = "/light";
57 public static final String SHELLY_URL_SETTINGS_DIMMER = "/settings/light";
60 public static final String SHELLY_WAKEUPT_SENSOR = "SENSOR"; // new sensordata
61 public static final String SHELLY_WAKEUPT_PERIODIC = "PERIODIC"; // periodic wakeup
62 public static final String SHELLY_WAKEUPT_BUTTON = "BUTTON"; // button pressed
63 public static final String SHELLY_WAKEUPT_POWERON = "POWERON"; // device powered up
64 public static final String SHELLY_WAKEUPT_EXT_POWER = "EXT_POWER"; // charger connected
65 public static final String SHELLY_WAKEUPT_UNKNOWN = "UNKNOWN"; // other event
68 // Action URLs according to the device type
70 public static final String SHELLY_EVENTURL_SUFFIX = "_url";
73 public static final String SHELLY_EVENT_BTN_ON = "btn_on";
74 public static final String SHELLY_EVENT_BTN_OFF = "btn_off";
75 public static final String SHELLY_EVENT_OUT_ON = "out_on";
76 public static final String SHELLY_EVENT_OUT_OFF = "out_off";
77 public static final String SHELLY_EVENT_SHORTPUSH = "shortpush";
78 public static final String SHELLY_EVENT_LONGPUSH = "longpush";
80 public static final String SHELLY_EVENT_DOUBLE_SHORTPUSH = "double_shortpush";
81 public static final String SHELLY_EVENT_TRIPLE_SHORTPUSH = "triple_shortpush";
82 public static final String SHELLY_EVENT_SHORT_LONGTPUSH = "shortpush_longpush";
83 public static final String SHELLY_EVENT_LONG_SHORTPUSH = "longpush_shortpush";
86 public static final String SHELLY_EVENT_BTN1_ON = "btn1_on";
87 public static final String SHELLY_EVENT_BTN1_OFF = "btn1_off";
88 public static final String SHELLY_EVENT_BTN2_ON = "btn2_on";
89 public static final String SHELLY_EVENT_BTN2_OFF = "btn2_off";
90 public static final String SHELLY_EVENT_SHORTPUSH1 = "btn1_shortpush";
91 public static final String SHELLY_EVENT_LONGPUSH1 = "btn1_longpush";
92 public static final String SHELLY_EVENT_SHORTPUSH2 = "btn2_shortpush";
93 public static final String SHELLY_EVENT_LONGPUSH2 = "btn2_longpush";
96 public static final String SHELLY_EVENT_ROLLER_OPEN = "roller_open";
97 public static final String SHELLY_EVENT_ROLLER_CLOSE = "roller_close";
98 public static final String SHELLY_EVENT_ROLLER_STOP = "roller_stop";
99 public static final String SHELLY_EVENT_ROLLER_CALIB = "roller_calibrating";
102 public static final String SHELLY_RSTATE_OPEN = "open";
103 public static final String SHELLY_RSTATE_STOP = "stop";
104 public static final String SHELLY_RSTATE_CLOSE = "close";
107 public static final String SHELLY_EVENT_SENSORREPORT = "report";
108 public static final String SHELLY_EVENT_DARK = "dark";
109 public static final String SHELLY_EVENT_TWILIGHT = "twilight";
110 public static final String SHELLY_EVENT_BRIGHT = "bright";
111 public static final String SHELLY_EVENT_FLOOD_DETECTED = "flood_detected";
112 public static final String SHELLY_EVENT_FLOOD_GONE = "flood_gone";
113 public static final String SHELLY_EVENT_VIBRATION = "vibration"; // DW 1.6.5+
114 public static final String SHELLY_EVENT_OPEN = "open"; // DW 1.6.5+
115 public static final String SHELLY_EVENT_CLOSE = "close"; // DW 1.6.5+
116 public static final String SHELLY_EVENT_TEMP_OVER = "temp_over"; // FW 1.7
117 public static final String SHELLY_EVENT_TEMP_UNDER = "temp_under"; // FW 1.7
120 public static final String SHELLY_EVENT_ALARM_MILD = "alarm_mild"; // DW 1.7+
121 public static final String SHELLY_EVENT_ALARM_HEAVY = "alarm_heavy"; // DW 1.7+
122 public static final String SHELLY_EVENT_ALARM_OFF = "alarm_off"; // DW 1.7+
127 public static final double SHELLY_API_INVTEMP = -999.0;
129 public static final String SHELLY_BTNT_MOMENTARY = "momentary";
130 public static final String SHELLY_BTNT_MOM_ON_RELEASE = "momentary_on_release";
131 public static final String SHELLY_BTNT_ONE_BUTTON = "one_button";
132 public static final String SHELLY_BTNT_TWO_BUTTON = "dual_button";
133 public static final String SHELLY_BTNT_TOGGLE = "toggle";
134 public static final String SHELLY_BTNT_EDGE = "edge";
135 public static final String SHELLY_BTNT_DETACHED = "detached";
137 public static final String SHELLY_STATE_LAST = "last";
138 public static final String SHELLY_STATE_STOP = "stop";
140 public static final String SHELLY_INP_MODE_OPENCLOSE = "openclose";
141 public static final String SHELLY_INP_MODE_ONEBUTTON = "onebutton";
143 public static final String SHELLY_OBSTMODE_DISABLED = "disabled";
144 public static final String SHELLY_SAFETYM_WHILEOPENING = "while_opening";
146 public static final String SHELLY_ALWD_TRIGGER_NONE = "none";
147 public static final String SHELLY_ALWD_ROLLER_TURN_OPEN = "open";
148 public static final String SHELLY_ALWD_ROLLER_TURN_CLOSE = "close";
149 public static final String SHELLY_ALWD_ROLLER_TURN_STOP = "stop";
152 public static final String SHELLY_APIERR_UNAUTHORIZED = "Unauthorized";
153 public static final String SHELLY_APIERR_TIMEOUT = "Timeout";
154 public static final String SHELLY_APIERR_NOT_CALIBRATED = "Not calibrated!";
156 // API device types / properties
157 public static final String SHELLY_CLASS_RELAY = "relay"; // Relay: relay mode
158 public static final String SHELLY_CLASS_ROLLER = "roller"; // Relay: roller mode
159 public static final String SHELLY_CLASS_LIGHT = "light"; // Bulb: color mode
160 public static final String SHELLY_CLASS_EMETER = "emeter"; // EM/EM3: emeter
162 public static final String SHELLY_API_ON = "on";
163 public static final String SHELLY_API_OFF = "off";
164 public static final String SHELLY_API_TRUE = "true";
165 public static final String SHELLY_API_FALSE = "false";
167 public static final String SHELLY_API_MODE = "mode";
168 public static final String SHELLY_MODE_RELAY = "relay"; // Relay: relay mode
169 public static final String SHELLY_MODE_ROLLER = "roller"; // Relay: roller mode
170 public static final String SHELLY_MODE_COLOR = "color"; // Bulb/RGBW2: color mode
171 public static final String SHELLY_MODE_WHITE = "white"; // Bulb/RGBW2: white mode
173 public static final String SHELLY_LED_STATUS_DISABLE = "led_status_disable";
174 public static final String SHELLY_LED_POWER_DISABLE = "led_power_disable";
176 public static final String SHELLY_API_STOPR_NORMAL = "normal";
177 public static final String SHELLY_API_STOPR_SAFETYSW = "safety_switch";
178 public static final String SHELLY_API_STOPR_OBSTACLE = "obstacle";
179 public static final String SHELLY_API_STOPR_OVERPOWER = "overpower";
181 public static final String SHELLY_TIMER_AUTOON = "auto_on";
182 public static final String SHELLY_TIMER_AUTOOFF = "auto_off";
183 public static final String SHELLY_TIMER_ACTIVE = "has_timer";
185 public static final String SHELLY_LIGHT_TURN = "turn";
186 public static final String SHELLY_LIGHT_DEFSTATE = "def_state";
187 public static final String SHELLY_LIGHTTIMER = "timer";
189 public static final String SHELLY_COLOR_RED = "red";
190 public static final String SHELLY_COLOR_BLUE = "blue";
191 public static final String SHELLY_COLOR_GREEN = "green";
192 public static final String SHELLY_COLOR_YELLOW = "yellow";
193 public static final String SHELLY_COLOR_WHITE = "white";
194 public static final String SHELLY_COLOR_GAIN = "gain";
195 public static final String SHELLY_COLOR_BRIGHTNESS = "brightness";
196 public static final String SHELLY_COLOR_TEMP = "temp";
197 public static final String SHELLY_COLOR_EFFECT = "effect";
199 public static final int SHELLY_MIN_ROLLER_POS = 0;
200 public static final int SHELLY_MAX_ROLLER_POS = 100;
201 public static final int SHELLY_MIN_BRIGHTNESS = 0;
202 public static final int SHELLY_MAX_BRIGHTNESS = 100;
203 public static final int SHELLY_MIN_GAIN = 0;
204 public static final int SHELLY_MAX_GAIN = 100;
205 public static final int SHELLY_MIN_COLOR = 0;
206 public static final int SHELLY_MAX_COLOR = 255;
207 public static final int SHELLY_DIM_STEPSIZE = 10;
209 // color temperature: 3000 = warm, 4750 = white, 6565 = cold; gain: 0..100
210 public static final int MIN_COLOR_TEMP_BULB = 3000;
211 public static final int MAX_COLOR_TEMP_BULB = 6500;
212 public static final int MIN_COLOR_TEMP_DUO = 2700;
213 public static final int MAX_COLOR_TEMP_DUO = 6500;
214 public static final int COLOR_TEMP_RANGE_BULB = MAX_COLOR_TEMP_DUO - MIN_COLOR_TEMP_DUO;
215 public static final int COLOR_TEMP_RANGE_DUO = MAX_COLOR_TEMP_DUO - MIN_COLOR_TEMP_DUO;
216 public static final double MIN_BRIGHTNESS = 0.0;
217 public static final double MAX_BRIGHTNESS = 100.0;
218 public static final double SATURATION_FACTOR = 2.55;
219 public static final double GAIN_FACTOR = SHELLY_MAX_GAIN / 100;
220 public static final double BRIGHTNESS_FACTOR = SHELLY_MAX_BRIGHTNESS / 100;
223 public static final String SHELLY_API_ILLUM_DARK = "dark";
224 public static final String SHELLY_API_ILLUM_TWILIGHT = "twilight";
225 public static final String SHELLY_API_ILLUM_BRIGHT = "bright";
226 public static final String SHELLY_API_DWSTATE_OPEN = "open";
227 public static final String SHELLY_API_DWSTATE_CLOSE = "close";
230 public static final String SHELLY_IR_CODET_STORED = "stored";
231 public static final String SHELLY_IR_CODET_PRONTO = "pronto";
232 public static final String SHELLY_IR_CODET_PRONTO_HEX = "pronto_hex";
235 public static final int SHELLY_MIN_EFFECT = 0;
236 public static final int SHELLY_MAX_EFFECT = 6;
239 public static final String SHELLY_BTNEVENT_1SHORTPUSH = "S";
240 public static final String SHELLY_BTNEVENT_2SHORTPUSH = "SS";
241 public static final String SHELLY_BTNEVENT_3SHORTPUSH = "SSS";
242 public static final String SHELLY_BTNEVENT_LONGPUSH = "L";
243 public static final String SHELLY_BTNEVENT_SHORTLONGPUSH = "SL";
244 public static final String SHELLY_BTNEVENT_LONGSHORTPUSH = "LS";
246 public static final String SHELLY_TEMP_CELSIUS = "C";
247 public static final String SHELLY_TEMP_FAHRENHEIT = "F";
250 public static final int SHELLY_MOTION_SLEEPTIME_OFFSET = 3; // we need to substract and offset
253 public static final int SHELLY_TRV_MIN_TEMP = 5; // < 5: means: lowest (valve fully closed)
254 public static final int SHELLY_TRV_MAX_TEMP = 30; // > 30: means: highest (valve fully open)
256 public static final String SHELLY_TRV_MODE_MANUAL = "manual";
257 public static final String SHELLY_TRV_MODE_AUTO = "automatic";
259 // CoIoT Multicast setting
260 public static final String SHELLY_COIOT_MCAST = "mcast";
262 public static class ShellySettingsDevice {
265 public String hostname;
270 public Integer longid;
272 @SerializedName("num_outputs")
273 public Integer numOutputs;
274 @SerializedName("num_meters")
275 public Integer numMeters;
276 @SerializedName("num_emeters")
277 public Integer numEMeters;
278 @SerializedName("num_rollers")
279 public Integer numRollers;
282 public static class ShellySettingsWiFiAp {
283 public Boolean enabled;
286 public Boolean rangeExtender; // Gen2 only
289 public static class ShellySettingsWiFiNetwork {
290 public Boolean enabled;
294 @SerializedName("ipv4_method")
295 public String ipv4Method;
302 public static class ShellySettingsMqtt {
303 public Boolean enable;
304 public String server;
306 @SerializedName("reconnect_timeout_max")
307 public Double reconnectTimeoutMax;
308 @SerializedName("reconnect_timeout_min")
309 public Double reconnectTimeoutMin;
310 @SerializedName("clean_session")
311 public Boolean cleanSession;
312 @SerializedName("keep_alive")
313 public Integer keepAlive;
314 @SerializedName("will_topic")
315 public String willTopic;
316 @SerializedName("will_message")
317 public String willMessage;
318 @SerializedName("max_qos")
319 public Integer maxQOS;
320 public Boolean retain;
321 @SerializedName("update_period")
322 public Integer updatePeriod;
325 public static class ShellySettingsCoiot { // FW 1.6+
326 @SerializedName("update_period")
327 public Integer updatePeriod;
328 public Boolean enabled; // Motion 1.0.7: Coap can be disabled
329 public String peer; // if set the device uses singlecast CoAP, mcast=set back to Multicast
332 public static class ShellyStatusMqtt {
333 public Boolean connected;
336 public static class ShellySettingsSntp {
337 public String server;
338 public Boolean enabled;
341 public static class ShellySettingsLogin {
342 public Boolean enabled;
343 public Boolean unprotected;
344 public String username;
345 public String password;
348 public static class ShellySettingsBuildInfo {
349 @SerializedName("build_id")
350 public String buildId;
351 @SerializedName("build_timestamp")
352 public String buildTimestamp;
353 @SerializedName("build_version")
354 public String buildVersion;
357 public static class ShellyStatusCloud {
358 public Boolean enabled;
359 public Boolean connected;
362 public static class ShellySettingsHwInfo {
363 @SerializedName("hw_revision")
364 public String hwRevision;
365 @SerializedName("batch_id")
366 public Integer batchId;
369 public static class ShellySettingsScheduleRules {
372 public static class ShellySettingsRelay {
374 @SerializedName("default_state")
375 public String defaultState; // Accepted values: off, on, last, switch
376 @SerializedName("btn_type")
377 public String btnType; // Accepted values: momentary, toggle, edge, detached - // see SHELLY_BTNT_xxx
378 @SerializedName("btn1_type") // Shelly 1L
379 public String btnType1;
380 @SerializedName("btn2_type") // Shelly 1L
381 public String btnType2;
382 @SerializedName("has_timer")
383 public Boolean hasTimer; // Whether a timer is currently armed for this channel
384 @SerializedName("auto_on")
385 public Double autoOn; // Automatic flip back timer, seconds. Will engage after turning Shelly1 OFF.
386 @SerializedName("auto_off")
387 public Double autoOff; // Automatic flip back timer, seconds. Will engage after turning Shelly1 ON.
388 @SerializedName("btn_on_url")
389 public String btnOnUrl; // input is activated
390 @SerializedName("btnOffUrl")
391 public String btnOffUrl; // input is deactivated
392 @SerializedName("out_on_url")
393 public String outOnUrl; // output is activated
394 @SerializedName("out_off_url")
395 public String outOffUrl; // output is deactivated
396 @SerializedName("roller_open_url")
397 public String rollerOpenUrl; // to access when roller reaches open position
398 @SerializedName("roller_close_url")
399 public String rollerCloseUrl; // to access when roller reaches close position
400 @SerializedName("roller_stop_url")
401 public String rollerStopUrl; // to access when roller stopped
402 @SerializedName("longpush_url")
403 public String pushLongUrl; // to access when roller stopped
404 @SerializedName("shortpush_url")
405 public String pushShortUrl; // to access when roller stopped
407 // Status information
409 public Boolean overpower;
410 @SerializedName("is_valid")
411 public Boolean isValid;
414 public static class ShellySettingsDimmer {
415 public String name; // unique name of the device
416 public Boolean ison; // true: output is ON
417 @SerializedName("default_state")
418 public String defaultState; // Accepted values: off, on, last, switch
419 @SerializedName("auto_on")
420 public Double autoOn; // Automatic flip back timer, seconds. Will engage after turning Shelly1 OFF.
421 @SerializedName("auto_off")
422 public Double autoOff; // Automatic flip back timer, seconds. Will engage after turning Shelly1 ON.
423 @SerializedName("btn1_on_url")
424 public String btn1OnUrl; // URL to access when SW input is activated
425 @SerializedName("btn1_off_url")
426 public String btn1OffUrl; // URL to access when SW input is deactivated
427 @SerializedName("btn2_on_url")
428 public String btn2OnUrl; // URL to access when SW input is activated
429 @SerializedName("btn2_off_url")
430 public String btn2OoffUrl; // URL to access when SW input is deactivated
431 @SerializedName("out_on_url")
432 public String outOnUrl; // URL to access when output is activated
433 @SerializedName("out_off_url")
434 public String outOffUrl; // URL to access when output is deactivated
435 @SerializedName("longpush_url")
436 public String pushLongUrl; // long push button event
437 @SerializedName("shortpush_url")
438 public String pushShortUrl; // short push button event
439 @SerializedName("btn_type")
440 public String btnType; // Accepted values: momentary, toggle, edge, detached - // see SHELLY_BTNT_xxx
441 @SerializedName("btn1_type")
442 public String btnType1; // Accepted values: momentary, toggle, edge, detached - // see SHELLY_BTNT_xxx
443 @SerializedName("btn2_type")
444 public String btnType2; // Accepted values: momentary, toggle, edge, detached - // see SHELLY_BTNT_xxx
445 @SerializedName("swap_inputs")
446 public Integer swapInputs; // 0=no
449 public static class ShellySettingsRoller {
450 public Double maxtime;
451 @SerializedName("maxtime_open")
452 public Double maxtimeOpen;
453 @SerializedName("maxtime_close")
454 public Double maxtimeClose;
455 @SerializedName("default_state")
456 public String defaultState; // see SHELLY_STATE_xxx
458 @SerializedName("swap_inputs")
459 public Boolean swapInputs;
460 @SerializedName("input_mode")
461 public String inputMode; // see SHELLY_INP_MODE_OPENCLOSE
462 @SerializedName("button_type")
463 public String buttonType; // // see SHELLY_BTNT_xxx
464 @SerializedName("btn_Reverse")
465 public Integer btnReverse;
468 @SerializedName("is_valid")
469 public Boolean isValid;
470 @SerializedName("safety_switch")
471 public Boolean safetySwitch;
472 @SerializedName("obstacle_mode")
473 public String obstaclMode; // SHELLY_OBSTMODE_
474 @SerializedName("obstacle_action")
475 public String obstacleAction; // see SHELLY_STATE_xxx
476 @SerializedName("obstacle_power")
477 public Integer obstaclePower;
478 @SerializedName("obstacle_delay")
479 public Integer obstacleDelay;
480 @SerializedName("safety_mode")
481 public String safetyMode; // see SHELLY_SAFETYM_xxx
482 @SerializedName("safety_action")
483 public String safetyAction; // see SHELLY_STATE_xxx
484 @SerializedName("safety_allowed_on_trigger")
485 public String safetyAllowedOnTrigger; // see SHELLY_ALWD_TRIGGER_xxx
486 @SerializedName("off_power")
487 public Integer offPower;
488 public Boolean positioning;
491 public static class ShellySettingsRgbwLight {
493 public Boolean ison; // true: output is ON
494 public Integer brightness;
496 public Integer transition;
497 @SerializedName("default_state")
498 public String defaultState;
499 @SerializedName("auto_on")
500 public Double autoOn; // Automatic flip back timer, seconds. Will engage after turning Shelly1 OFF.
501 @SerializedName("auto_off")
502 public Double autoOff; // Automatic flip back timer, seconds. Will engage after turning Shelly1 ON.
503 public Boolean schedule;
504 @SerializedName("btn_type")
505 public String btnType; // Accepted values: momentary, toggle, edge, detached - // see SHELLY_BTNT_xxx
506 @SerializedName("btn_reverse")
507 public Integer btnReverse; // Accepted values: momentary, toggle, edge, detached - // see SHELLY_BTNT_xxx
508 @SerializedName("out_on_url")
509 public String outOnUrl; // output is activated
510 @SerializedName("out_off_url")
511 public String outOffUrl; // output is deactivated
514 public static class ShellyFavPos { // FW 1.9.2+ in roller mode
519 public static class ShellyInputState {
520 public Integer input;
524 @SerializedName("event_cnt")
525 public Integer eventCount;
528 public static class ShellySettingsMeter {
529 @SerializedName("is_valid")
530 public Boolean isValid;
532 public Double[] counters = { 0.0, 0.0, 0.0 };
534 public Long timestamp;
537 public static class ShellySettingsEMeter { // ShellyEM meter
538 @SerializedName("is_valid")
539 public Boolean isValid; // Whether the associated meter is functioning properly
540 public Double power; // Instantaneous power, Watts
541 public Double reactive; // Instantaneous reactive power, Watts
542 public Double voltage; // RMS voltage, Volts
543 public Double total; // Total consumed energy, Wh
544 @SerializedName("total_returned")
545 public Double totalReturned; // Total returned energy, Wh
547 public Double pf; // 3EM
548 public Double current; // 3EM
551 public static class ShellySettingsUpdate {
552 public String status;
553 @SerializedName("has_update")
554 public Boolean hasUpdate;
555 @SerializedName("new_version")
556 public String newVersion;
557 @SerializedName("old_version")
558 public String oldVersion;
559 @SerializedName("beta_version")
560 public String betaVersion;
563 public static class ShellySettingsGlobal {
564 // https://shelly-api-docs.shelly.cloud/#shelly1pm-settings
565 public ShellySettingsDevice device = new ShellySettingsDevice();
566 @SerializedName("wifi_ap")
567 public ShellySettingsWiFiAp wifiAp = new ShellySettingsWiFiAp();
568 @SerializedName("wifi_sta")
569 public ShellySettingsWiFiNetwork wifiSta = new ShellySettingsWiFiNetwork();
570 @SerializedName("wifi_sta1")
571 public ShellySettingsWiFiNetwork wifiSta1 = new ShellySettingsWiFiNetwork();
572 @SerializedName("wifirecovery_reboot_enabled")
573 public Boolean wifiRecoveryReboot; // FW 1.10+
574 @SerializedName("ap_roaming")
575 public ShellyApRoaming apRoaming; // FW 1.10+
577 public ShellySettingsMqtt mqtt = new ShellySettingsMqtt();
578 public ShellySettingsSntp sntp = new ShellySettingsSntp();
579 public ShellySettingsCoiot coiot = new ShellySettingsCoiot();
580 public ShellySettingsLogin login = new ShellySettingsLogin();
581 @SerializedName("pin_code")
582 public String pinCode;
583 @SerializedName("coiot_execute_enable")
584 public Boolean coiotExecuteEnable;
586 public Boolean discoverable; // FW 1.6+
588 @SerializedName("build_info")
589 public ShellySettingsBuildInfo buildInfo = new ShellySettingsBuildInfo();
590 public ShellyStatusCloud cloud = new ShellyStatusCloud();
591 @SerializedName("sleep_mode")
592 public ShellySensorSleepMode sleepMode; // FW 1.6
593 @SerializedName("external_power")
594 public Integer externalPower; // H&T FW 1.6, seems to be the same like charger for the Sense
595 @SerializedName("debug_enable") // FW 1.10+
596 public Boolean debugEnable;
598 public String timezone;
601 public Boolean tzautodetect;
604 public ShellySettingsHwInfo hwinfo;
606 @SerializedName("max_power")
607 public Double maxPower;
608 public Boolean calibrated;
610 public Double voltage; // AC voltage for Shelly 2.5
611 @SerializedName("supply_voltage")
612 public Long supplyVoltage; // Shelly 1PM/1L: 0=110V, 1=220V
614 public @Nullable ArrayList<ShellySettingsRelay> relays;
615 public @Nullable ArrayList<ShellySettingsInput> inputs; // ix3
616 public @Nullable ArrayList<ShellySettingsDimmer> dimmers;
617 public @Nullable ArrayList<ShellySettingsRoller> rollers;
618 public @Nullable ArrayList<ShellySettingsRgbwLight> lights;
619 public @Nullable ArrayList<ShellySettingsEMeter> emeters;
620 public @Nullable ArrayList<ShellyThermnostat> thermostats; // TRV
621 @SerializedName("ext_temperature")
622 public ShellyStatusSensor.ShellyExtTemperature extTemperature; // Shelly 1/1PM: sensor values
623 @SerializedName("ext_humidity")
624 public ShellyStatusSensor.ShellyExtHumidity extHumidity; // Shelly 1/1PM: sensor values
626 @SerializedName("temperature_units")
627 public String temperatureUnits = "C"; // Either'C'or'F'
629 @SerializedName("led_status_disable")
630 public Boolean ledStatusDisable; // PlugS only Disable LED indication for network
632 @SerializedName("led_power_disable")
633 public Boolean ledPowerDisable; // PlugS only Disable LED indication for network
635 @SerializedName("light_sensor")
636 public String lightSensor; // Sense: sensor type
637 @SerializedName("rain_sensor")
638 public Boolean rainSensor; // Flood: true=in rain mode
640 // FW 1.5.7: Door Window
641 @SerializedName("dark_treshold")
642 public Integer darkTreshold; // Illumination definition for "dark" in lux
643 @SerializedName("twilight_treshold")
644 public Integer twiLightTreshold; // Illumination definition for "twilight" in lux
645 @SerializedName("dark_url")
646 public String darkUrl; // URL to report to when luminance <= dark_threshold
647 @SerializedName("twilight_url")
648 public String twiLightUrl; // URL reports when luminance > dark_threshold AND luminance <=
649 @SerializedName("close_url")
650 public String closeUrl; // URL reports when DW contact is closed FW 1.6.5+
651 @SerializedName("vibration_url")
652 public String vibrationUrl; // URL reports when DW detects vibration FW 1.6.5+
655 @SerializedName("set_volume")
656 public Integer volume; // Speaker volume for alarm
657 @SerializedName("alarm_off_url")
658 public String alarmOffUrl; // URL reports when alarm went off
659 @SerializedName("alarm_mild_url")
660 public String alarmMidUrl; // URL reports middle alarm
661 @SerializedName("alarm_heavy_url")
662 public String alarmHeavyfUrl; // URL reports heavy alarm
664 // Roller with FW 1.9.2+
665 @SerializedName("favorites_enabled")
666 public Boolean favoritesEnabled = false;
667 public ArrayList<ShellyFavPos> favorites;
670 public ShellyMotionSettings motion;
671 @SerializedName("tamper_sensitivity")
672 public Integer tamperSensitivity;
673 @SerializedName("dark_threshold")
674 public Integer darkThreshold;
675 @SerializedName("twilight_threshold")
676 public Integer twilightThreshold;
678 @SerializedName("sleep_time") // Shelly Motion
679 public Integer sleepTime;
682 public Boolean ethernet;
683 public Boolean bluetooth;
686 public static class ShellySettingsAttributes {
687 @SerializedName("device_type")
688 public String deviceType; // Device model identifier
689 @SerializedName("device_mac")
690 public String deviceMac; // MAC address of the device in hexadecimal
691 @SerializedName("wifi_ap")
692 public String wifiAp; // WiFi access poInteger configuration, see /settings/ap for details
693 @SerializedName("wifi_sta")
694 public String wifiSta; // WiFi client configuration. See /settings/sta for details
695 public String login; // credentials used for HTTP Basic authentication for the REST interface. If
696 // enabled is true clients must include an Authorization: Basic ... HTTP header with valid
697 // credentials when performing TP requests.
698 public String name; // unique name of the device.
699 public String fw; // current FW version
702 public static class ShellyActionsStats {
703 public Integer skipped;
706 public static class ShellySettingsStatus {
707 public String name; // FW 1.8: Symbolic Device name is configurable
709 @SerializedName("wifi_sta")
710 public ShellySettingsWiFiNetwork wifiSta = new ShellySettingsWiFiNetwork(); // WiFi client configuration. See
711 // /settings/sta for details
712 public ShellyStatusCloud cloud = new ShellyStatusCloud();
713 public ShellyStatusMqtt mqtt = new ShellyStatusMqtt();
716 public Integer serial = -1;
717 @SerializedName("has_update")
718 public Boolean hasUpdate;
720 public Boolean discoverable; // FW 1.6+
721 @SerializedName("cfg_changed_cnt")
722 public Integer cfgChangedCount; // FW 1.8
723 @SerializedName("actions_stats")
724 public ShellyActionsStats astats;
726 public ArrayList<ShellySettingsRelay> relays;
727 public Double voltage; // Shelly 2.5
728 public Integer input; // RGBW2 has no JSON array
729 public ArrayList<ShellyInputState> inputs;
730 public ArrayList<ShellyShortLightStatus> dimmers;
731 public ArrayList<ShellyRollerStatus> rollers;
732 public ArrayList<ShellySettingsLight> lights;
733 public ArrayList<ShellySettingsMeter> meters;
734 public ArrayList<ShellySettingsEMeter> emeters;
735 @SerializedName("ext_temperature")
736 public ShellyStatusSensor.ShellyExtTemperature extTemperature; // Shelly 1/1PM: sensor values
737 @SerializedName("ext_humidity")
738 public ShellyStatusSensor.ShellyExtHumidity extHumidity; // Shelly 1/1PM: sensor values
740 // Internal device temp
741 public ShellySensorTmp tmp = new ShellySensorTmp(); // Shelly 1PM
742 public Double temperature; // Shelly 2.5
743 public Boolean overtemperature;
745 // Shelly Dimmer only
746 public Boolean loaderror;
747 public Boolean overload;
750 public Boolean calibrated;
751 public ArrayList<ShellyThermnostat> thermostats;
753 public ShellySettingsUpdate update = new ShellySettingsUpdate();
754 @SerializedName("ram_total")
755 public Long ramTotal;
756 @SerializedName("ram_free")
758 @SerializedName("fs_size")
760 @SerializedName("fs_free")
764 @SerializedName("sleep_time") // Shelly Motion
765 public Integer sleepTime;
770 public static class ShellySettingsInput {
771 @SerializedName("btn_type")
772 public String btnType;
775 public static class ShellyControlRelay {
776 // https://shelly-api-docs.shelly.cloud/#shelly1-1pm-settings-relay-0
777 @SerializedName("is_valid")
778 public Boolean isValid;
779 @SerializedName("has_timer")
780 public Boolean hasTimer; // Whether a timer is currently armed for this channel
781 @SerializedName("timer_remaining")
782 public Integer timerRemaining; // FW 1.6+
783 public Boolean overpower; // Shelly1PM only if maximum allowed power was exceeded
785 public String turn; // Accepted values are on and off. This will turn ON/OFF the respective output
786 // channel when request is sent .
787 public Integer timer; // A one-shot flip-back timer in seconds.
790 public static class ShellyShortStatusRelay {
791 public String name; // FW 1.8+: Channel could now have a logical name
792 @SerializedName("is_valid")
793 public Boolean isValid;
794 public Boolean ison; // Whether output channel is on or off
795 @SerializedName("has_timer")
796 public Boolean hasTimer; // Whether a timer is currently armed for this channel
797 @SerializedName("timer_remaining")
798 public Integer timerRemaining;
799 public Boolean overpower; // Shelly1PM only if maximum allowed power was exceeded
800 public Double temperature; // Internal device temperature
801 public Boolean overtemperature; // Device over heated
804 public static class ShellyShortLightStatus {
805 public Boolean ison; // Whether output channel is on or off
806 public String mode; // color or white - valid only for Bulb and RGBW2 even Dimmer returns it also
807 public Integer brightness; // brightness: 0.100%
808 @SerializedName("has_timer")
809 public Boolean hasTimer;
812 public static class ShellyStatusRelay {
813 public String name; // FW 1.8: Symbolic channel name is configurable
815 @SerializedName("wifi_sta")
816 public ShellySettingsWiFiNetwork wifiSta; // WiFi status
817 public ShellySettingsCoiot coiot; // Firmware 1.6+
818 public Integer serial;
819 public String mac; // MAC
820 public ArrayList<ShellyShortStatusRelay> relays; // relay status
821 public ArrayList<ShellySettingsMeter> meters; // current meter value
822 public ArrayList<ShellyInputState> inputs; // Firmware 1.5.6+
824 @SerializedName("ext_temperature")
825 public ShellyStatusSensor.ShellyExtTemperature extTemperature; // Shelly 1/1PM: sensor values
826 @SerializedName("ext_humidity")
827 public ShellyStatusSensor.ShellyExtHumidity extHumidity; // Shelly 1/1PM: sensor values
829 public Double temperature; // device temp acc. on the selected temp unit
830 public ShellySensorTmp tmp;
833 public static class ShellyStatusDimmer {
834 @SerializedName("wifi_sta")
835 public ShellySettingsWiFiNetwork wifiSta; // WiFi status
836 public ArrayList<ShellyShortLightStatus> lights; // relay status
837 public ArrayList<ShellySettingsMeter> meters; // current meter value
839 public ShellySensorTmp tmp;
840 public Boolean overtemperature;
842 public Boolean loaderror;
843 public Boolean overload;
846 public static class ShellyRollerStatus {
847 public String name; // FW 1.8: Symbolic name is configurable
849 @SerializedName("roller_pos")
850 public Integer rollerPos; // number Desired position in percent
851 public Integer duration; // If specified, the motor will move for this period in seconds. If missing, the
852 // value of maxtime in /settings/roller/N will be used.
853 public String state; // One of stop, open, close
854 public Double power; // Current power consumption in Watts
855 @SerializedName("is_valid")
856 public Boolean isValid; // If the power meter functions properly
857 @SerializedName("safety_switch")
858 public Boolean safetySwitch; // Whether the safety input is currently triggered
859 public Boolean overtemperature;
860 @SerializedName("stop_reason")
861 public String stopReason; // Last cause for stopping: normal, safety_switch, obstacle
862 @SerializedName("last_direction")
863 public String lastDirection; // Last direction of motion, open or close
864 public Boolean calibrating;
865 public Boolean positioning; // true when calibration was performed
866 @SerializedName("current_pos")
867 public Integer currentPos; // current position 0..100, 100=open
870 public static class ShellyOtaCheckResult {
871 public String status;
874 public static class ShellyApRoaming {
875 public Boolean enabled;
876 public Integer threshold;
879 public static class ShellySensorSleepMode {
880 public Integer period;
885 public class ShellyThermnostat {
886 public class ShellyThermTargetTemp {
887 public Boolean enabled;
892 public class ShellyThermTemp {
895 @SerializedName("is_valid")
896 public Boolean isValid;
900 @SerializedName("target_t")
901 public ShellyThermTargetTemp targetTemp;
902 public Boolean schedule;
903 @SerializedName("schedule_profile")
904 public Integer profile;
905 @SerializedName("schedule_profile_names")
906 public String[] profileNames;
907 public ShellyThermTemp tmp;
908 @SerializedName("boost_minutes")
909 public Integer boostMinutes;
912 public static class ShellySensorTmp {
913 public Double value; // Temperature in configured unites
914 public String units; // 'C' or 'F'
915 public Double tC; // temperature in deg C
916 public Double tF; // temperature in deg F
917 @SerializedName("is_valid")
918 public Boolean isValid; // whether the internal sensor is operating properly
921 public static class ShellyStatusSensor {
922 // https://shelly-api-docs.shelly.cloud/#h-amp-t-settings
924 public static class ShellySensorHum {
925 public Double value; // relative humidity in %
928 public static class ShellySensorBat {
929 public Double value; // estimated remaining battery capacity in %
930 public Double voltage; // battery voltage
933 // Door/Window sensor
934 public static class ShellySensorState {
935 @SerializedName("is_valid")
936 public Boolean isValid; // whether the internal sensor is operating properly
937 public String state; // Shelly Door/Window
940 public Boolean motion;
941 public Boolean vibration;
942 @SerializedName("timestamp")
943 public Long motionTimestamp;
944 @SerializedName("active")
945 public Boolean motionActive;
948 public static class ShellySensorLux {
949 @SerializedName("is_valid")
950 public Boolean isValid; // whether the internal sensor is operating properly
953 public String illumination;
956 public static class ShellySensorAccel {
957 public Integer tilt; // Tilt in °
958 public Integer vibration; // Whether vibration is detected
961 public static class ShellyMotionSettings {
962 public Integer sensitivity;
963 @SerializedName("blind_time_minutes")
964 public Integer blindTimeMinutes;
965 @SerializedName("pulse_count")
966 public Integer pulseCount;
967 @SerializedName("operating_mode")
968 public Integer operatingMode;
969 public Boolean enabled;
972 public static class ShellyExtTemperature {
973 public static class ShellyShortTemp {
974 public String hwID; // e.g. "2882379497020381",
975 public Double tC; // temperature in deg C
976 public Double tF; // temperature in deg F
979 // Shelly 1/1PM have up to 3 sensors
980 // for whatever reasons it's not an array, but 3 independent elements
982 public ShellyShortTemp sensor1;
984 public ShellyShortTemp sensor2;
986 public ShellyShortTemp sensor3;
989 public static class ShellyExtHumidity {
990 public static class ShellyShortHum {
991 public Double hum; // Humidity reading of sensor 0, percent
994 // Shelly 1/1PM have up to 3 sensors
995 // for whatever reasons it's not an array, but 3 independent elements
997 public ShellyShortHum sensor1;
1000 public static class ShellyADC {
1001 public Double voltage;
1004 public ShellySensorTmp tmp;
1005 public ShellySensorHum hum;
1006 public ShellySensorLux lux;
1007 public ShellySensorAccel accel;
1008 public ShellySensorBat bat;
1009 @SerializedName("sensor")
1010 public ShellySensorState sensor;
1011 public Boolean smoke; // SHelly Smoke
1012 public Boolean flood; // Shelly Flood: true = flood condition detected
1013 @SerializedName("rain_sensor")
1014 public Boolean rainSensor; // Shelly Flood: true=in rain mode
1016 public Boolean motion; // Shelly Sense: true=motion detected
1017 public Boolean charger; // Shelly Sense, TRV: true=charger connected
1019 @SerializedName("act_reasons")
1020 public List<Object> actReasons; // HT/Smoke/Flood: list of reasons which woke up the device
1022 @SerializedName("sensor_error")
1023 public String sensorError; // 1.5.7: Only displayed in case of error
1025 // FW 1.7: Shelly Gas
1026 @SerializedName("gas_sensor")
1027 public ShellyStatusGasSensor gasSensor;
1028 @SerializedName("concentration")
1029 public ShellyStatusGasConcentration concentration;
1030 public ArrayList<ShellyStatusValve> valves;
1033 @SerializedName("connect_retries")
1034 public Integer connectRetries;
1035 public ArrayList<ShellyInputState> inputs; // Firmware 1.5.6+
1037 // Shelly UNI FW 1.9+
1038 public ArrayList<ShellyADC> adcs;
1041 public Boolean calibrated;
1042 public ArrayList<ShellyThermnostat> thermostats;
1045 public static class ShellySettingsSmoke {
1046 @SerializedName("temperature_units")
1047 public String temperatureUnits; // Either 'C' or 'F'
1048 @SerializedName("temperature_threshold")
1049 public Integer temperatureThreshold; // Temperature delta (in configured degree units) which triggers an update
1050 @SerializedName("sleep_mode_period")
1051 public Integer sleepModePeriod; // Periodic update period in hours, between 1 and 24
1055 // "gas_sensor":{"sensor_state":"normal","self_test_state":"not_completed","alarm_state":"none"},
1056 // "concentration":{"ppm":0,"is_valid":true},
1057 public static class ShellyStatusGasSensor {
1058 @SerializedName("sensor_state")
1059 public String sensorState;
1060 @SerializedName("self_test_state")
1061 public String selfTestState;
1062 @SerializedName("alarm_state")
1063 public String alarmState;
1066 public static class ShellyStatusGasConcentration {
1068 @SerializedName("is_valid")
1069 public Boolean isValid;
1072 public static class ShellyStatusValve {
1073 public String state; // closed/opened/not_connected/failure/closing/opening/checking
1076 public static class ShellySettingsLight {
1077 public Integer red; // red brightness, 0..255, applies in mode="color"
1078 public Integer green; // green brightness, 0..255, applies in mode="color"
1079 public Integer blue; // blue brightness, 0..255, applies in mode="color"
1080 public Integer white; // white brightness, 0..255, applies in mode="color"
1081 public Integer gain; // gain for all channels, 0..100, applies in mode="color"
1082 public Integer temp; // color temperature in K, 3000..6500, applies in mode="white"
1083 public Integer brightness; // brightness, 0..100, applies in mode="white"
1084 public Integer effect; // Currently applied effect, description: 0: Off, 1: Meteor Shower, 2: Gradual
1085 // Change, 3: Breath,
1086 // 4: Flash, 5: On/Off Gradual, 6: Red/Green Change
1087 @SerializedName("default_state")
1088 public String defaultState; // one of on, off or last
1089 @SerializedName("auto_on")
1090 public Double autoOn; // see above
1091 @SerializedName("auto_off")
1092 public Double autoOff; // see above
1094 public Integer dcpower; // RGW2:Set to true for 24 V power supply, false for 12 V
1098 public Boolean ison;
1101 public static class ShellySettingsNightMode { // FW1.5.7+
1102 public Integer enabled;
1103 @SerializedName("start_time")
1104 public String startTime;
1105 @SerializedName("end_time")
1106 public String endTime;
1107 public Integer brightness;
1110 public static class ShellyStatusLightChannel {
1111 public Boolean ison;
1112 public Double power;
1113 public Boolean overpower;
1114 @SerializedName("has_timer")
1115 public Boolean hasTimer;
1116 @SerializedName("timer_started")
1117 public Integer timerStarted;
1118 @SerializedName("timer_duration")
1119 public Integer timerDuration;
1120 @SerializedName("timer_remaining")
1121 public Integer timerRemaining;
1123 public Integer red; // red brightness, 0..255, applies in mode="color"
1124 public Integer green; // green brightness, 0..255, applies in mode="color"
1125 public Integer blue; // blue brightness, 0..255, applies in mode="color"
1126 public Integer white; // white brightness, 0..255, applies in mode="color"
1127 public Integer gain; // gain for all channels, 0..100, applies in mode="color"
1128 public Integer temp; // color temperature in K, 3000..6500, applies in mode="white"
1129 public Integer brightness; // brightness, 0..100, applies in mode="white"
1130 public Integer effect; // Currently applied effect, description: 0: Off, 1: Meteor Shower, 2: Gradual
1131 // Change, 3: Breath,
1134 public static class ShellyStatusLight {
1135 public Boolean ison; // Whether output channel is on or off
1136 public Integer input;
1138 public ArrayList<ShellyStatusLightChannel> lights;
1139 public ArrayList<ShellySettingsMeter> meters;
1142 public static class ShellySenseKeyCode {
1143 String id; // ID of the stored IR code into Shelly Sense.
1144 String name; // Short description or name of the stored IR code.
1147 public static class ShellySendKeyList {
1148 @SerializedName("key_codes")
1149 public ArrayList<ShellySenseKeyCode> keyCodes;
1153 * Shelly Dimmer returns light[]. However, the structure doesn't match the lights[] of a Bulb/RGBW2.
1154 * The tag lights[] will be replaced with dimmers[] so this could be mapped to a different Gson structure.
1155 * The function requires that it's only called when the device is a dimmer - on get settings and get status
1157 * @param json Input Json as received by the API
1158 * @return Modified Json
1160 public static String fixDimmerJson(String json) {
1161 return !json.contains("\"lights\":[") ? json
1162 : json.replaceFirst(java.util.regex.Pattern.quote("\"lights\":["), "\"dimmers\":[");
1166 * Convert Shelly Button events into OH button states
1168 * @param eventType S/SS/SSS or L
1169 * @return OH button states
1171 public static String mapButtonEvent(String eventType) {
1172 // decode different codings
1174 // S/SS/SSS/L: CoAP for Button and xi3
1175 // shortpush/double_shortpush/triple_shortpush/longpush: REST
1176 switch (eventType) {
1178 return CommonTriggerEvents.RELEASED;
1180 case SHELLY_BTNEVENT_1SHORTPUSH:
1181 case SHELLY_EVENT_SHORTPUSH:
1182 return CommonTriggerEvents.SHORT_PRESSED;
1183 case SHELLY_BTNEVENT_2SHORTPUSH:
1184 case SHELLY_EVENT_DOUBLE_SHORTPUSH:
1185 return CommonTriggerEvents.DOUBLE_PRESSED;
1186 case SHELLY_BTNEVENT_3SHORTPUSH:
1187 case SHELLY_EVENT_TRIPLE_SHORTPUSH:
1188 return "TRIPLE_PRESSED";
1190 case SHELLY_BTNEVENT_LONGPUSH:
1191 case SHELLY_EVENT_LONGPUSH:
1192 return CommonTriggerEvents.LONG_PRESSED;
1193 case SHELLY_BTNEVENT_SHORTLONGPUSH:
1194 case SHELLY_EVENT_SHORT_LONGTPUSH:
1195 return "SHORT_LONG_PRESSED";
1196 case SHELLY_BTNEVENT_LONGSHORTPUSH:
1197 case SHELLY_EVENT_LONG_SHORTPUSH:
1198 return "LONG_SHORT_PRESSED";