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

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.shelly.internal.provider;
  14
  15 import static org.openhab.binding.shelly.internal.ShellyBindingConstants.*;
  16 import static org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.SHELLY_API_INVTEMP;
  17 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
  18
  19 import java.util.ArrayList;
  20 import java.util.HashMap;
  21 import java.util.HashSet;
  22 import java.util.LinkedHashMap;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Optional;
  26 import java.util.Set;
  27 import java.util.concurrent.CopyOnWriteArrayList;
  28
  29 import javax.measure.Unit;
  30
  31 import org.eclipse.jdt.annotation.NonNullByDefault;
  32 import org.eclipse.jdt.annotation.Nullable;
  33 import org.openhab.binding.shelly.internal.api.ShellyDeviceProfile;
  34 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyInputState;
  35 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyRollerStatus;
  36 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsDimmer;
  37 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsEMeter;
  38 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsGlobal;
  39 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsMeter;
  40 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRelay;
  41 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRgbwLight;
  42 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsStatus;
  43 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyShortLightStatus;
  44 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusLightChannel;
  45 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor;
  46 import org.openhab.binding.shelly.internal.handler.ShellyThingInterface;
  47 import org.openhab.core.thing.Channel;
  48 import org.openhab.core.thing.ChannelUID;
  49 import org.openhab.core.thing.Thing;
  50 import org.openhab.core.thing.binding.builder.ChannelBuilder;
  51 import org.openhab.core.thing.type.ChannelKind;
  52 import org.openhab.core.thing.type.ChannelTypeUID;
  53 import org.openhab.core.types.StateOption;
  54 import org.osgi.service.component.annotations.Activate;
  55 import org.osgi.service.component.annotations.Component;
  56 import org.osgi.service.component.annotations.Reference;
  57
  58 /**
  59  * The {@link #CHANNEL_DEFINITIONS} defines channel information for dynamically created channels. Those will be
  60  * added on the first thing status update
  61  *
  62  * @author Markus Michels - Initial contribution
  63  */
  64 @NonNullByDefault
  65 @Component(service = ShellyChannelDefinitions.class)
  66 public class ShellyChannelDefinitions {
  67
  68     public static final String ITEMT_STRING = "String";
  69     public static final String ITEMT_NUMBER = "Number";
  70     public static final String ITEMT_SWITCH = "Switch";
  71     public static final String ITEMT_CONTACT = "Contact";
  72     public static final String ITEMT_ROLLER = "Rollershutter";
  73     public static final String ITEMT_DIMMER = "Dimmer";
  74     public static final String ITEMT_LOCATION = "Location";
  75     public static final String ITEMT_DATETIME = "DateTime";
  76     public static final String ITEMT_TEMP = "Number:Temperature";
  77     public static final String ITEMT_LUX = "Number:Illuminance";
  78     public static final String ITEMT_POWER = "Number:Power";
  79     public static final String ITEMT_ENERGY = "Number:Energy";
  80     public static final String ITEMT_VOLT = "Number:ElectricPotential";
  81     public static final String ITEMT_AMP = "Number:ElectricCurrent";
  82     public static final String ITEMT_ANGLE = "Number:Angle";
  83     public static final String ITEMT_DISTANCE = "Number:Length";
  84     public static final String ITEMT_SPEED = "Number:Speed";
  85     public static final String ITEMT_VOLUME = "Number:Volume";
  86     public static final String ITEMT_TIME = "Number:Time";
  87     public static final String ITEMT_PERCENT = "Number:Dimensionless";
  88
  89     // shortcuts to avoid line breaks (make code more readable)
  90     private static final String CHGR_DEVST = CHANNEL_GROUP_DEV_STATUS;
  91     private static final String CHGR_RELAY = CHANNEL_GROUP_RELAY_CONTROL;
  92     private static final String CHGR_ROLLER = CHANNEL_GROUP_ROL_CONTROL;
  93     private static final String CHGR_LIGHT = CHANNEL_GROUP_LIGHT_CONTROL;
  94     private static final String CHGR_LIGHTCH = CHANNEL_GROUP_LIGHT_CHANNEL;
  95     private static final String CHGR_STATUS = CHANNEL_GROUP_STATUS;
  96     private static final String CHGR_METER = CHANNEL_GROUP_METER;
  97     private static final String CHGR_SENSOR = CHANNEL_GROUP_SENSOR;
  98     private static final String CHGR_CONTROL = CHANNEL_GROUP_CONTROL;
  99     private static final String CHGR_BAT = CHANNEL_GROUP_BATTERY;
 100
 101     public static final String PREFIX_GROUP = "group-type." + BINDING_ID + ".";
 102     public static final String PREFIX_CHANNEL = "channel-type." + BINDING_ID + ".";
 103
 104     public class OptionEntry {
 105         public ChannelTypeUID uid;
 106         public String key;
 107         public String value;
 108
 109         public OptionEntry(ChannelTypeUID uid, String key, String value) {
 110             this.uid = uid;
 111             this.key = key;
 112             this.value = value;
 113         }
 114     }
 115
 116     private final CopyOnWriteArrayList<OptionEntry> stateOptions = new CopyOnWriteArrayList<>();
 117
 118     private static final ChannelMap CHANNEL_DEFINITIONS = new ChannelMap();
 119
 120     @Activate
 121     public ShellyChannelDefinitions(@Reference ShellyTranslationProvider translationProvider) {
 122         ShellyTranslationProvider m = translationProvider;
 123
 124         // Device
 125         CHANNEL_DEFINITIONS
 126                 // Device
 127                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_NAME, "deviceName", ITEMT_STRING))
 128                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_GATEWAY, "gatewayDevice", ITEMT_STRING))
 129                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ITEMP, "deviceTemp", ITEMT_TEMP))
 130                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_WAKEUP, "sensorWakeup", ITEMT_STRING))
 131                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ACCUWATTS, "meterAccuWatts", ITEMT_POWER))
 132                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ACCUTOTAL, "meterAccuTotal", ITEMT_ENERGY))
 133                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ACCURETURNED, "meterAccuReturned", ITEMT_ENERGY))
 134                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_RESETTOTAL, "meterResetTotals", ITEMT_SWITCH))
 135                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_VOLTAGE, "supplyVoltage", ITEMT_VOLT))
 136                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_CHARGER, "charger", ITEMT_SWITCH))
 137                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_LED_STATUS_DISABLE, "ledStatusDisable", ITEMT_SWITCH))
 138                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_LED_POWER_DISABLE, "ledPowerDisable", ITEMT_SWITCH))
 139                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_SELFTTEST, "selfTest", ITEMT_STRING))
 140                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_UPTIME, "uptime", ITEMT_NUMBER))
 141                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_HEARTBEAT, "heartBeat", ITEMT_DATETIME))
 142                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_UPDATE, "updateAvailable", ITEMT_SWITCH))
 143                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_CALIBRATED, "calibrated", ITEMT_SWITCH))
 144
 145                 // Relay
 146                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_OUTPUT_NAME, "outputName", ITEMT_STRING))
 147                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_OUTPUT, "system:power", ITEMT_SWITCH))
 148                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
 149                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_BUTTON_TRIGGER, "system:button", ITEMT_STRING))
 150                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
 151                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
 152                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_TIMER_AUTOON, "timerAutoOn", ITEMT_TIME))
 153                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_TIMER_AUTOOFF, "timerAutoOff", ITEMT_TIME))
 154                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_TIMER_ACTIVE, "timerActive", ITEMT_SWITCH))
 155
 156                 // Dimmer
 157                 .add(new ShellyChannel(m, CHANNEL_GROUP_DIMMER_CONTROL, CHANNEL_BRIGHTNESS, "dimmerBrightness",
 158                         ITEMT_DIMMER))
 159
 160                 // Roller
 161                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_CONTROL, "rollerShutter", ITEMT_ROLLER))
 162                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_POS, "rollerPosition", ITEMT_DIMMER))
 163                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_FAV, "rollerFavorite", ITEMT_NUMBER))
 164                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STATE, "rollerState", ITEMT_STRING))
 165                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STOPR, "rollerStop", ITEMT_STRING))
 166                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_SAFETY, "rollerSafety", ITEMT_SWITCH))
 167                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
 168                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
 169                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
 170                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_EVENT_TRIGGER, "system:button", "system:button"))
 171
 172                 // Bulb/Duo/Vintage
 173                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
 174                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_BUTTON_TRIGGER, "system:button", ITEMT_STRING))
 175                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
 176                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
 177                 .add(new ShellyChannel(m, CHANNEL_GROUP_WHITE_CONTROL, CHANNEL_BRIGHTNESS, "whiteBrightness",
 178                         ITEMT_DIMMER))
 179                 .add(new ShellyChannel(m, CHANNEL_GROUP_WHITE_CONTROL, CHANNEL_COLOR_TEMP, "whiteTemp", ITEMT_DIMMER))
 180
 181                 // RGBW2-color
 182                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_LIGHT_POWER, "system:power", ITEMT_SWITCH))
 183                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_TIMER_AUTOON, "timerAutoOn", ITEMT_TIME))
 184                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_TIMER_AUTOOFF, "timerAutoOff", ITEMT_TIME))
 185                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_TIMER_ACTIVE, "timerActive", ITEMT_SWITCH))
 186                 // RGBW2-white
 187                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_BRIGHTNESS, "whiteBrightness", ITEMT_DIMMER))
 188                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_TIMER_AUTOON, "timerAutoOn", ITEMT_TIME))
 189                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_TIMER_AUTOOFF, "timerAutoOff", ITEMT_TIME))
 190                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_TIMER_ACTIVE, "timerActive", ITEMT_SWITCH))
 191
 192                 // Power Meter
 193                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_METER_CURRENTWATTS, "meterWatts", ITEMT_POWER))
 194                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_METER_TOTALKWH, "meterTotal", ITEMT_ENERGY))
 195                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_METER_LASTMIN1, "lastPower1", ITEMT_POWER))
 196                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_LAST_UPDATE, "lastUpdate", ITEMT_DATETIME))
 197
 198                 // EMeter
 199                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_TOTALRET, "meterReturned", ITEMT_ENERGY))
 200                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_REACTWATTS, "meterReactive", ITEMT_POWER))
 201                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_VOLTAGE, "meterVoltage", ITEMT_VOLT))
 202                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_CURRENT, "meterCurrent", ITEMT_AMP))
 203                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_PFACTOR, "meterPowerFactor", ITEMT_NUMBER))
 204                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_RESETTOTAL, "meterResetTotals", ITEMT_SWITCH))
 205
 206                 // Sensors
 207                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_TEMP, "sensorTemp", ITEMT_TEMP))
 208                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_HUM, "sensorHumidity", ITEMT_PERCENT))
 209                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_LUX, "sensorLux", ITEMT_LUX))
 210                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_ILLUM, "sensorIllumination", ITEMT_STRING))
 211                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_VOLTAGE, "sensorADC", ITEMT_VOLT))
 212                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_STATE, "sensorContact", ITEMT_CONTACT))
 213                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_SSTATE, "sensorState", ITEMT_STRING))
 214                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_TILT, "sensorTilt", ITEMT_ANGLE))
 215                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MOTION, "sensorMotion", ITEMT_SWITCH))
 216                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MOTION_TS, "motionTimestamp", ITEMT_DATETIME))
 217                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MOTION_ACT, "motionActive", ITEMT_SWITCH))
 218                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_VIBRATION, "sensorVibration", ITEMT_SWITCH))
 219                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_FLOOD, "sensorFlood", ITEMT_SWITCH))
 220                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_SMOKE, "sensorSmoke", ITEMT_SWITCH))
 221                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MUTE, "sensorMute", ITEMT_SWITCH))
 222                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_PPM, "sensorPPM", ITEMT_NUMBER))
 223                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_VALVE, "sensorValve", ITEMT_STRING))
 224                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_ALARM_STATE, "alarmState", ITEMT_STRING))
 225                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_ERROR, "sensorError", ITEMT_STRING))
 226                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_LAST_UPDATE, "lastUpdate", ITEMT_DATETIME))
 227                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_SLEEPTIME, "sensorSleepTime", ITEMT_NUMBER))
 228                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSE_KEY, "senseKey", ITEMT_STRING)) // Sense
 229
 230                 // Button/ix3
 231                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
 232                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
 233                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
 234                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_BUTTON_TRIGGER, "system:button", ITEMT_STRING))
 235                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_LAST_UPDATE, "lastUpdate", ITEMT_DATETIME))
 236
 237                 // Addon with external sensors
 238                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP1, "sensorExtTemp", ITEMT_TEMP))
 239                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP2, "sensorExtTemp", ITEMT_TEMP))
 240                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP3, "sensorExtTemp", ITEMT_TEMP))
 241                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_HUMIDITY, "sensorExtHum", ITEMT_PERCENT))
 242                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_VOLTAGE, "sensorExtVolt", ITEMT_VOLT))
 243                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_INPUT1, "sensorContact", ITEMT_CONTACT))
 244                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_DIGITALINPUT, "sensorExtDigitalInput",
 245                         ITEMT_SWITCH))
 246                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_ANALOGINPUT, "sensorExtAnalogInput",
 247                         ITEMT_PERCENT))
 248
 249                 // Battery
 250                 .add(new ShellyChannel(m, CHGR_BAT, CHANNEL_SENSOR_BAT_LEVEL, "system:battery-level", ITEMT_PERCENT))
 251                 .add(new ShellyChannel(m, CHGR_BAT, CHANNEL_SENSOR_BAT_LOW, "system:low-battery", ITEMT_SWITCH))
 252
 253                 // TRV
 254                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_POSITION, "sensorPosition", ITEMT_DIMMER))
 255                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_MODE, "controlMode", ITEMT_STRING))
 256                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_PROFILE, "controlProfile", ITEMT_STRING))
 257                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_SETTEMP, "targetTemp", ITEMT_TEMP))
 258                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_BCONTROL, "boostControl", ITEMT_SWITCH))
 259                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_BTIMER, "boostTimer", ITEMT_TIME))
 260                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_SCHEDULE, "controlSchedule", ITEMT_SWITCH));
 261     }
 262
 263     public static @Nullable ShellyChannel getDefinition(String channelName) throws IllegalArgumentException {
 264         String group = substringBefore(channelName, "#");
 265         String channel = substringAfter(channelName, "#");
 266
 267         if (group.contains(CHANNEL_GROUP_METER)) {
 268             group = CHANNEL_GROUP_METER; // map meter1..n to meter
 269         } else if (group.contains(CHANNEL_GROUP_RELAY_CONTROL)) {
 270             group = CHANNEL_GROUP_RELAY_CONTROL; // map meter1..n to meter
 271         } else if (group.contains(CHANNEL_GROUP_LIGHT_CHANNEL)) {
 272             group = CHANNEL_GROUP_LIGHT_CHANNEL;
 273         } else if (group.contains(CHANNEL_GROUP_STATUS)) {
 274             group = CHANNEL_GROUP_STATUS; // map status1..n to meter
 275         }
 276
 277         if (channel.startsWith(CHANNEL_INPUT)) {
 278             channel = CHANNEL_INPUT;
 279         } else if (channel.startsWith(CHANNEL_BUTTON_TRIGGER)) {
 280             channel = CHANNEL_BUTTON_TRIGGER;
 281         } else if (channel.startsWith(CHANNEL_STATUS_EVENTTYPE)) {
 282             channel = CHANNEL_STATUS_EVENTTYPE;
 283         } else if (channel.startsWith(CHANNEL_STATUS_EVENTCOUNT)) {
 284             channel = CHANNEL_STATUS_EVENTCOUNT;
 285         }
 286
 287         String channelId = group + "#" + channel;
 288         return CHANNEL_DEFINITIONS.get(channelId);
 289     }
 290
 291     /**
 292      * Auto-create relay channels depending on relay type/mode
 293      *
 294      * @return {@code ArrayList<Channel>} of channels to be added to the thing
 295      */
 296     public static Map<String, Channel> createDeviceChannels(final Thing thing, final ShellyDeviceProfile profile,
 297             final ShellySettingsStatus status) {
 298         Map<String, Channel> add = new LinkedHashMap<>();
 299
 300         addChannel(thing, add, profile.settings.name != null, CHGR_DEVST, CHANNEL_DEVST_NAME);
 301         addChannel(thing, add, !profile.gateway.isEmpty() || profile.isBlu, CHGR_DEVST, CHANNEL_DEVST_GATEWAY);
 302
 303         if (!profile.isSensor && !profile.isIX
 304                 && ((status.temperature != null && getDouble(status.temperature) != SHELLY_API_INVTEMP)
 305                         || (status.tmp != null && getDouble(status.tmp.tC) != SHELLY_API_INVTEMP))) {
 306             // Only some devices report the internal device temp
 307             boolean hasTemp = !profile.isLight
 308                     && (status.temperature != null || (status.tmp != null && !profile.isSensor));
 309             if (hasTemp && profile.isGen2 && (profile.numMeters > 0 && !profile.hasRelays)) // Shely Plus PM Mini
 310             {
 311                 hasTemp = false;
 312             }
 313             addChannel(thing, add, hasTemp, CHGR_DEVST, CHANNEL_DEVST_ITEMP);
 314         }
 315         addChannel(thing, add, profile.settings.sleepTime != null, CHGR_SENSOR, CHANNEL_SENSOR_SLEEPTIME);
 316
 317         // If device has more than 1 meter the channel accumulatedWatts receives the accumulated value
 318         boolean accuChannel = profile.numMeters > 1 && !profile.isRoller && !profile.isRGBW2;
 319         addChannel(thing, add, accuChannel, CHGR_DEVST, CHANNEL_DEVST_ACCUWATTS);
 320         addChannel(thing, add, accuChannel, CHGR_DEVST, CHANNEL_DEVST_ACCUTOTAL);
 321         addChannel(thing, add, accuChannel && (status.emeters != null), CHGR_DEVST, CHANNEL_DEVST_ACCURETURNED);
 322         addChannel(thing, add, profile.is3EM, CHGR_DEVST, CHANNEL_DEVST_RESETTOTAL); // 3EM
 323         addChannel(thing, add, status.voltage != null || profile.settings.supplyVoltage != null, CHGR_DEVST,
 324                 CHANNEL_DEVST_VOLTAGE);
 325         addChannel(thing, add,
 326                 profile.status.uptime != null && (!profile.hasBattery || profile.isMotion || profile.isTRV), CHGR_DEVST,
 327                 CHANNEL_DEVST_UPTIME);
 328         addChannel(thing, add, true, CHGR_DEVST, CHANNEL_DEVST_UPDATE);
 329         addChannel(thing, add, true, CHGR_DEVST, CHANNEL_DEVST_HEARTBEAT);
 330         addChannel(thing, add, profile.settings.ledPowerDisable != null, CHGR_DEVST, CHANNEL_LED_POWER_DISABLE);
 331         addChannel(thing, add, profile.settings.ledStatusDisable != null, CHGR_DEVST, CHANNEL_LED_STATUS_DISABLE); // WiFi
 332         addChannel(thing, add, profile.settings.calibrated != null, CHGR_DEVST, CHANNEL_DEVST_CALIBRATED);
 333
 334         return add;
 335     }
 336
 337     /**
 338      * Auto-create relay channels depending on relay type/mode
 339      *
 340      * @return {@code ArrayList<Channel>} of channels to be added to the thing
 341      */
 342     public static Map<String, Channel> createRelayChannels(final Thing thing, final ShellyDeviceProfile profile,
 343             final ShellySettingsRelay rstatus, int idx) {
 344         Map<String, Channel> add = new LinkedHashMap<>();
 345         String group = profile.getControlGroup(idx);
 346
 347         if (profile.settings.relays != null) {
 348             ShellySettingsRelay rs = profile.settings.relays.get(idx);
 349             addChannel(thing, add, rs.ison != null, group, CHANNEL_OUTPUT);
 350             addChannel(thing, add, rs.name != null, group, CHANNEL_OUTPUT_NAME);
 351
 352             boolean timer = rs.hasTimer != null || rstatus.hasTimer != null; // Dimmer 1/2 have
 353             addChannel(thing, add, timer, group, CHANNEL_TIMER_ACTIVE);
 354             addChannel(thing, add, rs.autoOn != null, group, CHANNEL_TIMER_AUTOON);
 355             addChannel(thing, add, rs.autoOff != null, group, CHANNEL_TIMER_AUTOOFF);
 356         }
 357
 358         // Shelly 1/1PM and Plus 1/1PM Addon
 359         boolean addon = profile.settings.extSwitch != null && profile.settings.extSwitch.input0 != null
 360                 && idx == getInteger(profile.settings.extSwitch.input0.relayNum);
 361         if (addon) {
 362             addChannel(thing, add, addon, CHGR_SENSOR,
 363                     CHANNEL_ESENSOR_INPUT + (profile.settings.extSwitch.input0.relayNum + 1));
 364         }
 365         if (profile.status.extTemperature != null) {
 366             addChannel(thing, add, profile.status.extTemperature.sensor1 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP1);
 367             addChannel(thing, add, profile.status.extTemperature.sensor2 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP2);
 368             addChannel(thing, add, profile.status.extTemperature.sensor3 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP3);
 369             addChannel(thing, add, profile.status.extTemperature.sensor4 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP4);
 370             addChannel(thing, add, profile.status.extTemperature.sensor5 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP5);
 371         }
 372         addChannel(thing, add, profile.status.extHumidity != null && profile.status.extHumidity.sensor1 != null,
 373                 CHGR_SENSOR, CHANNEL_ESENSOR_HUMIDITY);
 374         addChannel(thing, add, profile.status.extVoltage != null, CHGR_SENSOR, CHANNEL_ESENSOR_VOLTAGE);
 375         addChannel(thing, add, profile.status.extDigitalInput != null, CHGR_SENSOR, CHANNEL_ESENSOR_DIGITALINPUT);
 376         addChannel(thing, add, profile.status.extAnalogInput != null, CHGR_SENSOR, CHANNEL_ESENSOR_ANALOGINPUT);
 377
 378         return add;
 379     }
 380
 381     public static Map<String, Channel> createDimmerChannels(final Thing thing, final ShellyDeviceProfile profile,
 382             final ShellySettingsStatus dstatus, int idx) {
 383         Map<String, Channel> add = new LinkedHashMap<>();
 384         String group = profile.getControlGroup(idx);
 385
 386         // Shelly Dimmer has an additional brightness channel
 387         addChannel(thing, add, profile.isDimmer, group, CHANNEL_BRIGHTNESS);
 388
 389         if (profile.settings.dimmers != null) {
 390             ShellySettingsDimmer ds = profile.settings.dimmers.get(idx);
 391             addChannel(thing, add, ds.name != null, group, CHANNEL_OUTPUT_NAME);
 392             addChannel(thing, add, ds.autoOn != null, group, CHANNEL_TIMER_AUTOON);
 393             addChannel(thing, add, ds.autoOff != null, group, CHANNEL_TIMER_AUTOOFF);
 394             ShellyShortLightStatus dss = dstatus.dimmers.get(idx);
 395             addChannel(thing, add, dss != null && dss.hasTimer != null, group, CHANNEL_TIMER_ACTIVE);
 396         }
 397         return add;
 398     }
 399
 400     public static Map<String, Channel> createLightChannels(final Thing thing, final ShellyDeviceProfile profile,
 401             final ShellyStatusLightChannel status, int idx) {
 402         Map<String, Channel> add = new LinkedHashMap<>();
 403         String group = profile.getControlGroup(idx);
 404
 405         if (profile.settings.lights != null) {
 406             ShellySettingsRgbwLight light = profile.settings.lights.get(idx);
 407             String whiteGroup = profile.isRGBW2 ? group : CHANNEL_GROUP_WHITE_CONTROL;
 408             // Create power channel in color mode and brightness channel in white mode
 409             addChannel(thing, add, profile.inColor, group, CHANNEL_LIGHT_POWER);
 410             addChannel(thing, add, light.autoOn != null, group, CHANNEL_TIMER_AUTOON);
 411             addChannel(thing, add, light.autoOff != null, group, CHANNEL_TIMER_AUTOOFF);
 412             addChannel(thing, add, status.hasTimer != null, group, CHANNEL_TIMER_ACTIVE);
 413             addChannel(thing, add, light.brightness != null, whiteGroup, CHANNEL_BRIGHTNESS);
 414             addChannel(thing, add, light.temp != null, whiteGroup, CHANNEL_COLOR_TEMP);
 415         }
 416
 417         return add;
 418     }
 419
 420     public static Map<String, Channel> createInputChannels(final Thing thing, final ShellyDeviceProfile profile,
 421             final ShellySettingsStatus status) {
 422         Map<String, Channel> add = new LinkedHashMap<>();
 423         if (status.inputs != null) {
 424             // Create channels per input. For devices with more than 1 input (Dimmer, 1L) multiple channel sets are
 425             // created by adding the index to the channel name
 426             for (int i = 0; i < profile.numInputs; i++) {
 427                 String group = profile.getInputGroup(i);
 428                 String suffix = profile.getInputSuffix(i); // multi ? String.valueOf(i + 1) : "";
 429                 addChannel(thing, add, !profile.isButton, group, CHANNEL_INPUT + suffix);
 430                 addChannel(thing, add, true, group,
 431                         (!profile.isRoller ? CHANNEL_BUTTON_TRIGGER + suffix : CHANNEL_EVENT_TRIGGER));
 432                 if (profile.inButtonMode(i)) {
 433                     ShellyInputState input = status.inputs.get(i);
 434                     addChannel(thing, add, input.event != null, group, CHANNEL_STATUS_EVENTTYPE + suffix);
 435                     addChannel(thing, add, input.eventCount != null, group, CHANNEL_STATUS_EVENTCOUNT + suffix);
 436                 }
 437             }
 438         } else if (status.input != null) {
 439             // old RGBW2 firmware
 440             String group = profile.getInputGroup(0);
 441             addChannel(thing, add, true, group, CHANNEL_INPUT);
 442             addChannel(thing, add, true, group, CHANNEL_BUTTON_TRIGGER);
 443         }
 444         return add;
 445     }
 446
 447     public static Map<String, Channel> createRollerChannels(Thing thing, final ShellyRollerStatus roller) {
 448         Map<String, Channel> add = new LinkedHashMap<>();
 449         addChannel(thing, add, true, CHGR_ROLLER, CHANNEL_ROL_CONTROL_CONTROL);
 450         addChannel(thing, add, true, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STATE);
 451         addChannel(thing, add, true, CHGR_ROLLER, CHANNEL_EVENT_TRIGGER);
 452         addChannel(thing, add, roller.currentPos != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_POS);
 453         addChannel(thing, add, roller.stopReason != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STOPR);
 454         addChannel(thing, add, roller.safetySwitch != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_SAFETY);
 455
 456         ShellyThingInterface handler = (ShellyThingInterface) thing.getHandler();
 457         if (handler != null) {
 458             ShellySettingsGlobal settings = handler.getProfile().settings;
 459             if (getBool(settings.favoritesEnabled) && settings.favorites != null) {
 460                 addChannel(thing, add, roller.currentPos != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_FAV);
 461             }
 462         }
 463         return add;
 464     }
 465
 466     public static Map<String, Channel> createMeterChannels(Thing thing, final ShellySettingsMeter meter, String group) {
 467         Map<String, Channel> newChannels = new LinkedHashMap<>();
 468         addChannel(thing, newChannels, meter.power != null, group, CHANNEL_METER_CURRENTWATTS);
 469         addChannel(thing, newChannels, meter.total != null, group, CHANNEL_METER_TOTALKWH);
 470         addChannel(thing, newChannels, meter.counters != null && meter.counters[0] != null, group,
 471                 CHANNEL_METER_LASTMIN1);
 472         addChannel(thing, newChannels, meter.timestamp != null, group, CHANNEL_LAST_UPDATE);
 473         return newChannels;
 474     }
 475
 476     public static Map<String, Channel> createEMeterChannels(final Thing thing, final ShellyDeviceProfile profile,
 477             final ShellySettingsEMeter emeter, String group) {
 478         Map<String, Channel> newChannels = new LinkedHashMap<>();
 479         addChannel(thing, newChannels, emeter.power != null, group, CHANNEL_METER_CURRENTWATTS);
 480         addChannel(thing, newChannels, emeter.total != null, group, CHANNEL_METER_TOTALKWH);
 481         addChannel(thing, newChannels, emeter.totalReturned != null, group, CHANNEL_EMETER_TOTALRET);
 482         addChannel(thing, newChannels, emeter.reactive != null, group, CHANNEL_EMETER_REACTWATTS);
 483         addChannel(thing, newChannels, emeter.voltage != null, group, CHANNEL_EMETER_VOLTAGE);
 484         addChannel(thing, newChannels, emeter.current != null, group, CHANNEL_EMETER_CURRENT);
 485         addChannel(thing, newChannels, emeter.pf != null, group, CHANNEL_EMETER_PFACTOR); // EM has no PF. but power
 486         addChannel(thing, newChannels, true, group, CHANNEL_LAST_UPDATE);
 487         ShellyThingInterface handler = (ShellyThingInterface) thing.getHandler();
 488         if (handler != null) {
 489             addChannel(thing, newChannels, handler.getProfile().isEM50, group, CHANNEL_DEVST_RESETTOTAL); // 3EM
 490         }
 491         return newChannels;
 492     }
 493
 494     public static Map<String, Channel> createSensorChannels(final Thing thing, final ShellyDeviceProfile profile,
 495             final ShellyStatusSensor sdata) {
 496         Map<String, Channel> newChannels = new LinkedHashMap<>();
 497
 498         // Sensor data
 499         addChannel(thing, newChannels, sdata.tmp != null || sdata.thermostats != null, CHANNEL_GROUP_SENSOR,
 500                 CHANNEL_SENSOR_TEMP);
 501         addChannel(thing, newChannels, sdata.hum != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_HUM);
 502         addChannel(thing, newChannels, sdata.lux != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_LUX);
 503         addChannel(thing, newChannels, sdata.lux != null && sdata.lux.illumination != null, CHANNEL_GROUP_SENSOR,
 504                 CHANNEL_SENSOR_ILLUM);
 505         addChannel(thing, newChannels, sdata.flood != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_FLOOD);
 506         addChannel(thing, newChannels, sdata.smoke != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_SMOKE);
 507         addChannel(thing, newChannels, sdata.mute != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MUTE);
 508         addChannel(thing, newChannels, profile.settings.externalPower != null || sdata.charger != null, CHGR_DEVST,
 509                 CHANNEL_DEVST_CHARGER);
 510         addChannel(thing, newChannels, sdata.motion != null || (sdata.sensor != null && sdata.sensor.motion != null),
 511                 CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION);
 512         if (sdata.sensor != null) { // DW, Sense or Motion
 513             addChannel(thing, newChannels, sdata.sensor.state != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE); // DW/DW2
 514             addChannel(thing, newChannels, sdata.sensor.motionActive != null, CHANNEL_GROUP_SENSOR, // Motion
 515                     CHANNEL_SENSOR_MOTION_ACT);
 516             addChannel(thing, newChannels, sdata.sensor.motionTimestamp != null, CHANNEL_GROUP_SENSOR, // Motion
 517                     CHANNEL_SENSOR_MOTION_TS);
 518             addChannel(thing, newChannels, sdata.sensor.vibration != null, CHANNEL_GROUP_SENSOR,
 519                     CHANNEL_SENSOR_VIBRATION);
 520         }
 521         // Create tilt for DW/DW2, for BLU DW create channel even tilt is currently not reported
 522         if (sdata.accel != null || (profile.isBlu && sdata.lux != null)) {
 523             addChannel(thing, newChannels, sdata.accel.tilt != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TILT);
 524         }
 525
 526         // Gas
 527         if (sdata.gasSensor != null) {
 528             addChannel(thing, newChannels, sdata.gasSensor.selfTestState != null, CHGR_DEVST, CHANNEL_DEVST_SELFTTEST);
 529             addChannel(thing, newChannels, sdata.gasSensor.sensorState != null, CHANNEL_GROUP_SENSOR,
 530                     CHANNEL_SENSOR_SSTATE);
 531             addChannel(thing, newChannels, sdata.concentration != null && sdata.concentration.ppm != null,
 532                     CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_PPM);
 533             addChannel(thing, newChannels, sdata.valves != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VALVE);
 534             addChannel(thing, newChannels, sdata.gasSensor.sensorState != null, CHANNEL_GROUP_SENSOR,
 535                     CHANNEL_SENSOR_ALARM_STATE);
 536         }
 537
 538         // Sense
 539         addChannel(thing, newChannels, profile.isSense, CHANNEL_GROUP_SENSOR, CHANNEL_SENSE_KEY);
 540
 541         // UNI
 542         addChannel(thing, newChannels, sdata.adcs != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VOLTAGE);
 543
 544         // TRV
 545         if (profile.isTRV) {
 546             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SETTEMP);
 547             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BCONTROL);
 548             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BTIMER);
 549             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_POSITION);
 550             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_MODE);
 551             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_PROFILE);
 552             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SCHEDULE);
 553             addChannel(thing, newChannels, true, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE);
 554         }
 555
 556         // Battery
 557         if (sdata.bat != null) {
 558             addChannel(thing, newChannels, sdata.bat.value != null, CHANNEL_GROUP_BATTERY, CHANNEL_SENSOR_BAT_LEVEL);
 559             addChannel(thing, newChannels, sdata.bat.value != null, CHANNEL_GROUP_BATTERY, CHANNEL_SENSOR_BAT_LOW);
 560         }
 561
 562         addChannel(thing, newChannels, sdata.sensorError != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_ERROR);
 563         addChannel(thing, newChannels, sdata.actReasons != null, CHGR_DEVST, CHANNEL_DEVST_WAKEUP);
 564         addChannel(thing, newChannels, true, profile.isButton ? CHANNEL_GROUP_STATUS : CHANNEL_GROUP_SENSOR,
 565                 CHANNEL_LAST_UPDATE);
 566         return newChannels;
 567     }
 568
 569     public ChannelTypeUID getChannelTypeUID(String channelId) {
 570         ShellyChannel channelDef = getDefinition(channelId);
 571         if (channelDef != null) {
 572             return new ChannelTypeUID(BINDING_ID, channelDef.typeId);
 573         }
 574         throw new IllegalArgumentException("Invalid channelId:" + channelId);
 575     }
 576
 577     private static void addChannel(Thing thing, Map<String, Channel> newChannels, boolean supported, String group,
 578             String channelName) throws IllegalArgumentException {
 579         if (supported) {
 580             String channelId = group + "#" + channelName;
 581             ChannelUID channelUID = new ChannelUID(thing.getUID(), channelId);
 582             ShellyChannel channelDef = getDefinition(channelId);
 583             if (channelDef != null) {
 584                 ChannelTypeUID channelTypeUID = channelDef.typeId.contains("system:")
 585                         ? new ChannelTypeUID(channelDef.typeId)
 586                         : new ChannelTypeUID(BINDING_ID, channelDef.typeId);
 587                 ChannelBuilder builder;
 588                 if ("system:button".equalsIgnoreCase(channelDef.typeId)) {
 589                     builder = ChannelBuilder.create(channelUID, null).withKind(ChannelKind.TRIGGER);
 590                 } else {
 591                     builder = ChannelBuilder.create(channelUID, channelDef.itemType);
 592                 }
 593                 if (!channelDef.label.isEmpty()) {
 594                     char grseq = lastChar(group);
 595                     char chseq = lastChar(channelName);
 596                     char sequence = isDigit(chseq) ? chseq : grseq;
 597                     String label = !isDigit(sequence) ? channelDef.label : channelDef.label + " " + sequence;
 598                     builder.withLabel(label);
 599                 }
 600                 if (!channelDef.description.isEmpty()) {
 601                     builder.withDescription(channelDef.description);
 602                 }
 603                 newChannels.put(channelId, builder.withType(channelTypeUID).build());
 604             }
 605         }
 606     }
 607
 608     public List<StateOption> getStateOptions(ChannelTypeUID uid) {
 609         List<StateOption> options = new ArrayList<>();
 610         for (OptionEntry oe : stateOptions) {
 611             if (oe.uid.equals(uid)) {
 612                 options.add(new StateOption(oe.key, oe.value));
 613             }
 614         }
 615         return options;
 616     }
 617
 618     public void addStateOption(String channelId, String key, String value) {
 619         ChannelTypeUID uid = getChannelTypeUID(channelId);
 620         stateOptions.addIfAbsent(new OptionEntry(uid, key, value));
 621     }
 622
 623     public void clearStateOptions(String channelId) {
 624         ChannelTypeUID uid = getChannelTypeUID(channelId);
 625         for (OptionEntry oe : stateOptions) {
 626             if (oe.uid.equals(uid)) {
 627                 stateOptions.remove(oe);
 628             }
 629         }
 630     }
 631
 632     public class ShellyChannel {
 633         private final ShellyTranslationProvider messages;
 634         public String group = "";
 635         public String groupLabel = "";
 636         public String groupDescription = "";
 637
 638         public String channel = "";
 639         public String label = "";
 640         public String description = "";
 641         public String itemType = "";
 642         public String typeId = "";
 643         public String category = "";
 644         public Set<String> tags = new HashSet<>();
 645         public @Nullable Unit<?> unit;
 646         public Optional<Integer> min = Optional.empty();
 647         public Optional<Integer> max = Optional.empty();
 648         public Optional<Integer> step = Optional.empty();
 649         public Optional<String> pattern = Optional.empty();
 650
 651         public ShellyChannel(ShellyTranslationProvider messages, String group, String channel, String typeId,
 652                 String itemType, String... category) {
 653             this.messages = messages;
 654             this.group = group;
 655             this.channel = channel;
 656             this.itemType = itemType;
 657             this.typeId = typeId;
 658
 659             groupLabel = getText(PREFIX_GROUP + group + ".label");
 660             if (groupLabel.contains(PREFIX_GROUP)) {
 661                 groupLabel = "";
 662             }
 663             groupDescription = getText(PREFIX_GROUP + group + ".description");
 664             if (groupDescription.contains(PREFIX_GROUP)) {
 665                 groupDescription = "";
 666             }
 667             label = getText(PREFIX_CHANNEL + typeId.replace(':', '.') + ".label");
 668             if (label.contains(PREFIX_CHANNEL)) {
 669                 label = "";
 670             }
 671             description = getText(PREFIX_CHANNEL + typeId + ".description");
 672             if (description.contains(PREFIX_CHANNEL)) {
 673                 description = "";
 674             }
 675         }
 676
 677         public String getChanneId() {
 678             return group + "#" + channel;
 679         }
 680
 681         public String getGroupLabel() {
 682             return getGroupAttribute("group");
 683         }
 684
 685         public String getGroupDescription() {
 686             return getGroupAttribute("group");
 687         }
 688
 689         public String getLabel() {
 690             return getChannelAttribute("label");
 691         }
 692
 693         public String getDescription() {
 694             return getChannelAttribute("description");
 695         }
 696
 697         public boolean getAdvanced() {
 698             String attr = getChannelAttribute("advanced");
 699             return attr.isEmpty() ? false : Boolean.valueOf(attr);
 700         }
 701
 702         public boolean getReadyOnly() {
 703             String attr = getChannelAttribute("readOnly");
 704             return attr.isEmpty() ? false : Boolean.valueOf(attr);
 705         }
 706
 707         public String getCategory() {
 708             return getChannelAttribute("category");
 709         }
 710
 711         public String getMin() {
 712             return getChannelAttribute("min");
 713         }
 714
 715         public String getMax() {
 716             return getChannelAttribute("max");
 717         }
 718
 719         public String getStep() {
 720             return getChannelAttribute("step");
 721         }
 722
 723         public String getPattern() {
 724             return getChannelAttribute("pattern");
 725         }
 726
 727         public String getGroupAttribute(String attribute) {
 728             String key = PREFIX_GROUP + group + "." + attribute;
 729             String value = messages.getText(key);
 730             return !value.equals(key) ? value : "";
 731         }
 732
 733         public String getChannelAttribute(String attribute) {
 734             String key = PREFIX_CHANNEL + channel + "." + attribute;
 735             String value = messages.getText(key);
 736             return !value.equals(key) ? value : "";
 737         }
 738
 739         private String getText(String key) {
 740             return messages.get(key);
 741         }
 742     }
 743
 744     public static class ChannelMap {
 745         private final Map<String, ShellyChannel> map = new HashMap<>();
 746
 747         private ChannelMap add(ShellyChannel def) {
 748             map.put(def.getChanneId(), def);
 749             return this;
 750         }
 751
 752         public ShellyChannel get(String channelName) throws IllegalArgumentException {
 753             ShellyChannel def = null;
 754             if (channelName.contains("#")) {
 755                 def = map.get(channelName);
 756                 if (def != null) {
 757                     return def;
 758                 }
 759             }
 760             for (HashMap.Entry<String, ShellyChannel> entry : map.entrySet()) {
 761                 if (entry.getValue().channel.contains("#" + channelName)) {
 762                     def = entry.getValue();
 763                     break;
 764                 }
 765             }
 766
 767             if (def == null) {
 768                 throw new IllegalArgumentException("Channel definition for " + channelName + " not found!");
 769             }
 770
 771             return def;
 772         }
 773     }
 774 }