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

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