]> git.basschouten.com Git - openhab-addons.git/blob
ed7d9eecf772470f16bb0a36ed1ad51c7e94f0d5
[openhab-addons.git] /
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 ShellyCHANNEL_DEFINITIONSDTO} 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:ElectricPotential";
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_ITEMP, "deviceTemp", ITEMT_TEMP))
129                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_WAKEUP, "sensorWakeup", ITEMT_STRING))
130                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ACCUWATTS, "meterAccuWatts", ITEMT_POWER))
131                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ACCUTOTAL, "meterAccuTotal", ITEMT_POWER))
132                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_ACCURETURNED, "meterAccuReturned", ITEMT_POWER))
133                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_VOLTAGE, "supplyVoltage", ITEMT_VOLT))
134                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_CHARGER, "charger", ITEMT_SWITCH))
135                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_LED_STATUS_DISABLE, "ledStatusDisable", ITEMT_SWITCH))
136                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_LED_POWER_DISABLE, "ledPowerDisable", ITEMT_SWITCH))
137                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_SELFTTEST, "selfTest", ITEMT_STRING))
138                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_UPTIME, "uptime", ITEMT_NUMBER))
139                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_HEARTBEAT, "heartBeat", ITEMT_DATETIME))
140                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_UPDATE, "updateAvailable", ITEMT_SWITCH))
141                 .add(new ShellyChannel(m, CHGR_DEVST, CHANNEL_DEVST_CALIBRATED, "calibrated", ITEMT_SWITCH))
142
143                 // Relay
144                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_OUTPUT_NAME, "outputName", ITEMT_STRING))
145                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_OUTPUT, "system:power", ITEMT_SWITCH))
146                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
147                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_BUTTON_TRIGGER, "system:button", ITEMT_STRING))
148                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
149                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
150                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_TIMER_AUTOON, "timerAutoOn", ITEMT_TIME))
151                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_TIMER_AUTOOFF, "timerAutoOff", ITEMT_TIME))
152                 .add(new ShellyChannel(m, CHGR_RELAY, CHANNEL_TIMER_ACTIVE, "timerActive", ITEMT_SWITCH))
153
154                 // Dimmer
155                 .add(new ShellyChannel(m, CHANNEL_GROUP_DIMMER_CONTROL, CHANNEL_BRIGHTNESS, "dimmerBrightness",
156                         ITEMT_DIMMER))
157
158                 // Roller
159                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_CONTROL, "rollerShutter", ITEMT_ROLLER))
160                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_POS, "rollerPosition", ITEMT_DIMMER))
161                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_FAV, "rollerFavorite", ITEMT_NUMBER))
162                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STATE, "rollerState", ITEMT_STRING))
163                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STOPR, "rollerStop", ITEMT_STRING))
164                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_ROL_CONTROL_SAFETY, "rollerSafety", ITEMT_SWITCH))
165                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
166                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
167                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
168                 .add(new ShellyChannel(m, CHGR_ROLLER, CHANNEL_EVENT_TRIGGER, "system:button", "system:button"))
169
170                 // Bulb/Duo/Vintage
171                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
172                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_BUTTON_TRIGGER, "system:button", ITEMT_STRING))
173                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
174                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
175                 .add(new ShellyChannel(m, CHANNEL_GROUP_WHITE_CONTROL, CHANNEL_BRIGHTNESS, "whiteBrightness",
176                         ITEMT_DIMMER))
177                 .add(new ShellyChannel(m, CHANNEL_GROUP_WHITE_CONTROL, CHANNEL_COLOR_TEMP, "whiteTemp", ITEMT_DIMMER))
178
179                 // RGBW2-color
180                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_LIGHT_POWER, "system:power", ITEMT_SWITCH))
181                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_TIMER_AUTOON, "timerAutoOn", ITEMT_TIME))
182                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_TIMER_AUTOOFF, "timerAutoOff", ITEMT_TIME))
183                 .add(new ShellyChannel(m, CHGR_LIGHT, CHANNEL_TIMER_ACTIVE, "timerActive", ITEMT_SWITCH))
184                 // RGBW2-white
185                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_BRIGHTNESS, "whiteBrightness", ITEMT_DIMMER))
186                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_TIMER_AUTOON, "timerAutoOn", ITEMT_TIME))
187                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_TIMER_AUTOOFF, "timerAutoOff", ITEMT_TIME))
188                 .add(new ShellyChannel(m, CHGR_LIGHTCH, CHANNEL_TIMER_ACTIVE, "timerActive", ITEMT_SWITCH))
189
190                 // Power Meter
191                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_METER_CURRENTWATTS, "meterWatts", ITEMT_POWER))
192                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_METER_TOTALKWH, "meterTotal", ITEMT_ENERGY))
193                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_METER_LASTMIN1, "lastPower1", ITEMT_ENERGY))
194                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_LAST_UPDATE, "lastUpdate", ITEMT_DATETIME))
195
196                 // EMeter
197                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_TOTALRET, "meterReturned", ITEMT_ENERGY))
198                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_REACTWATTS, "meterReactive", ITEMT_POWER))
199                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_VOLTAGE, "meterVoltage", ITEMT_VOLT))
200                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_CURRENT, "meterCurrent", ITEMT_AMP))
201                 .add(new ShellyChannel(m, CHGR_METER, CHANNEL_EMETER_PFACTOR, "meterPowerFactor", ITEMT_NUMBER))
202
203                 // Sensors
204                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_TEMP, "sensorTemp", ITEMT_TEMP))
205                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_HUM, "sensorHumidity", ITEMT_PERCENT))
206                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_LUX, "sensorLux", ITEMT_LUX))
207                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_ILLUM, "sensorIllumination", ITEMT_STRING))
208                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_VOLTAGE, "sensorADC", ITEMT_VOLT))
209                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_STATE, "sensorContact", ITEMT_CONTACT))
210                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_SSTATE, "sensorState", ITEMT_STRING))
211                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_TILT, "sensorTilt", ITEMT_ANGLE))
212                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MOTION, "sensorMotion", ITEMT_SWITCH))
213                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MOTION_TS, "motionTimestamp", ITEMT_DATETIME))
214                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_MOTION_ACT, "motionActive", ITEMT_SWITCH))
215                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_VIBRATION, "vibration", ITEMT_SWITCH))
216                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_FLOOD, "sensorFlood", ITEMT_SWITCH))
217                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_SMOKE, "sensorSmoke", ITEMT_SWITCH))
218                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_PPM, "sensorPPM", ITEMT_NUMBER))
219                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_VALVE, "sensorValve", ITEMT_STRING))
220                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_ALARM_STATE, "alarmState", ITEMT_STRING))
221                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_ERROR, "sensorError", ITEMT_STRING))
222                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_LAST_UPDATE, "lastUpdate", ITEMT_DATETIME))
223                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSOR_SLEEPTIME, "sensorSleepTime", ITEMT_NUMBER))
224                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_SENSE_KEY, "senseKey", ITEMT_STRING)) // Sense
225
226                 // Button/ix3
227                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_INPUT, "inputState", ITEMT_SWITCH))
228                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_STATUS_EVENTTYPE, "lastEvent", ITEMT_STRING))
229                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_STATUS_EVENTCOUNT, "eventCount", ITEMT_NUMBER))
230                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_BUTTON_TRIGGER, "system:button", ITEMT_STRING))
231                 .add(new ShellyChannel(m, CHGR_STATUS, CHANNEL_LAST_UPDATE, "lastUpdate", ITEMT_DATETIME))
232
233                 // Addon with external sensors
234                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP1, "sensorExtTemp", ITEMT_TEMP))
235                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP2, "sensorExtTemp", ITEMT_TEMP))
236                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP3, "sensorExtTemp", ITEMT_TEMP))
237                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_HUMIDITY, "sensorExtHum", ITEMT_PERCENT))
238                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_VOLTAGE, "sensorExtVolt", ITEMT_VOLT))
239                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_INPUT1, "sensorContact", ITEMT_CONTACT))
240                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_DIGITALINPUT, "sensorExtDigitalInput",
241                         ITEMT_SWITCH))
242                 .add(new ShellyChannel(m, CHGR_SENSOR, CHANNEL_ESENSOR_ANALOGINPUT, "sensorExtAnalogInput",
243                         ITEMT_PERCENT))
244
245                 // Battery
246                 .add(new ShellyChannel(m, CHGR_BAT, CHANNEL_SENSOR_BAT_LEVEL, "system:battery-level", ITEMT_PERCENT))
247                 .add(new ShellyChannel(m, CHGR_BAT, CHANNEL_SENSOR_BAT_LOW, "system:low-battery", ITEMT_SWITCH))
248
249                 // TRV
250                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_POSITION, "sensorPosition", ITEMT_DIMMER))
251                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_MODE, "controlMode", ITEMT_STRING))
252                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_PROFILE, "controlProfile", ITEMT_STRING))
253                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_SETTEMP, "targetTemp", ITEMT_TEMP))
254                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_BCONTROL, "boostControl", ITEMT_SWITCH))
255                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_BTIMER, "boostTimer", ITEMT_TIME))
256                 .add(new ShellyChannel(m, CHGR_CONTROL, CHANNEL_CONTROL_SCHEDULE, "controlSchedule", ITEMT_SWITCH));
257     }
258
259     public static @Nullable ShellyChannel getDefinition(String channelName) throws IllegalArgumentException {
260         String group = substringBefore(channelName, "#");
261         String channel = substringAfter(channelName, "#");
262
263         if (group.contains(CHANNEL_GROUP_METER)) {
264             group = CHANNEL_GROUP_METER; // map meter1..n to meter
265         } else if (group.contains(CHANNEL_GROUP_RELAY_CONTROL)) {
266             group = CHANNEL_GROUP_RELAY_CONTROL; // map meter1..n to meter
267         } else if (group.contains(CHANNEL_GROUP_LIGHT_CHANNEL)) {
268             group = CHANNEL_GROUP_LIGHT_CHANNEL;
269         } else if (group.contains(CHANNEL_GROUP_STATUS)) {
270             group = CHANNEL_GROUP_STATUS; // map status1..n to meter
271         }
272
273         if (channel.startsWith(CHANNEL_INPUT)) {
274             channel = CHANNEL_INPUT;
275         } else if (channel.startsWith(CHANNEL_BUTTON_TRIGGER)) {
276             channel = CHANNEL_BUTTON_TRIGGER;
277         } else if (channel.startsWith(CHANNEL_STATUS_EVENTTYPE)) {
278             channel = CHANNEL_STATUS_EVENTTYPE;
279         } else if (channel.startsWith(CHANNEL_STATUS_EVENTCOUNT)) {
280             channel = CHANNEL_STATUS_EVENTCOUNT;
281         }
282
283         String channelId = group + "#" + channel;
284         return CHANNEL_DEFINITIONS.get(channelId);
285     }
286
287     /**
288      * Auto-create relay channels depending on relay type/mode
289      *
290      * @return ArrayList<Channel> of channels to be added to the thing
291      */
292     public static Map<String, Channel> createDeviceChannels(final Thing thing, final ShellyDeviceProfile profile,
293             final ShellySettingsStatus status) {
294         Map<String, Channel> add = new LinkedHashMap<>();
295
296         addChannel(thing, add, profile.settings.name != null, CHGR_DEVST, CHANNEL_DEVST_NAME);
297
298         if (!profile.isSensor && !profile.isIX && status.temperature != null
299                 && status.temperature != SHELLY_API_INVTEMP) {
300             // Only some devices report the internal device temp
301             addChannel(thing, add, status.tmp != null || status.temperature != null, CHGR_DEVST, CHANNEL_DEVST_ITEMP);
302         }
303         addChannel(thing, add, profile.settings.sleepTime != null, CHGR_SENSOR, CHANNEL_SENSOR_SLEEPTIME);
304
305         // If device has more than 1 meter the channel accumulatedWatts receives the accumulated value
306         boolean accuChannel = (((status.meters != null) && (status.meters.size() > 1) && !profile.isRoller
307                 && !profile.isRGBW2) || ((status.emeters != null && status.emeters.size() > 1)));
308         addChannel(thing, add, accuChannel, CHGR_DEVST, CHANNEL_DEVST_ACCUWATTS);
309         addChannel(thing, add, accuChannel, CHGR_DEVST, CHANNEL_DEVST_ACCUTOTAL);
310         addChannel(thing, add, accuChannel && (status.emeters != null), CHGR_DEVST, CHANNEL_DEVST_ACCURETURNED);
311         addChannel(thing, add, status.voltage != null || profile.settings.supplyVoltage != null, CHGR_DEVST,
312                 CHANNEL_DEVST_VOLTAGE);
313         addChannel(thing, add,
314                 profile.status.uptime != null && (!profile.hasBattery || profile.isMotion || profile.isTRV), CHGR_DEVST,
315                 CHANNEL_DEVST_UPTIME);
316         addChannel(thing, add, true, CHGR_DEVST, CHANNEL_DEVST_UPDATE);
317         addChannel(thing, add, true, CHGR_DEVST, CHANNEL_DEVST_HEARTBEAT);
318         addChannel(thing, add, profile.settings.ledPowerDisable != null, CHGR_DEVST, CHANNEL_LED_POWER_DISABLE);
319         addChannel(thing, add, profile.settings.ledStatusDisable != null, CHGR_DEVST, CHANNEL_LED_STATUS_DISABLE); // WiFi
320         addChannel(thing, add, profile.settings.calibrated != null, CHGR_DEVST, CHANNEL_DEVST_CALIBRATED);
321
322         return add;
323     }
324
325     /**
326      * Auto-create relay channels depending on relay type/mode
327      *
328      * @return ArrayList<Channel> of channels to be added to the thing
329      */
330     public static Map<String, Channel> createRelayChannels(final Thing thing, final ShellyDeviceProfile profile,
331             final ShellySettingsRelay rstatus, int idx) {
332         Map<String, Channel> add = new LinkedHashMap<>();
333         String group = profile.getControlGroup(idx);
334
335         if (profile.settings.relays != null) {
336             ShellySettingsRelay rs = profile.settings.relays.get(idx);
337             addChannel(thing, add, rs.ison != null, group, CHANNEL_OUTPUT);
338             addChannel(thing, add, rs.name != null, group, CHANNEL_OUTPUT_NAME);
339
340             boolean timer = rs.hasTimer != null || rstatus.hasTimer != null; // Dimmer 1/2 have
341             addChannel(thing, add, timer, group, CHANNEL_TIMER_ACTIVE);
342             addChannel(thing, add, rs.autoOn != null, group, CHANNEL_TIMER_AUTOON);
343             addChannel(thing, add, rs.autoOff != null, group, CHANNEL_TIMER_AUTOOFF);
344         }
345
346         // Shelly 1/1PM and Plus 1/1PM Addon
347         if (profile.settings.extSwitch != null && profile.settings.extSwitch.input0 != null
348                 && idx == getInteger(profile.settings.extSwitch.input0.relayNum)) {
349             addChannel(thing, add, true, CHGR_SENSOR, CHANNEL_ESENSOR_INPUT + (idx + 1));
350         }
351         if (profile.status.extTemperature != null) {
352             addChannel(thing, add, profile.status.extTemperature.sensor1 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP1);
353             addChannel(thing, add, profile.status.extTemperature.sensor2 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP2);
354             addChannel(thing, add, profile.status.extTemperature.sensor3 != null, CHGR_SENSOR, CHANNEL_ESENSOR_TEMP3);
355         }
356         addChannel(thing, add, profile.status.extHumidity != null, CHGR_SENSOR, CHANNEL_ESENSOR_HUMIDITY);
357         addChannel(thing, add, profile.status.extVoltage != null, CHGR_SENSOR, CHANNEL_ESENSOR_VOLTAGE);
358         addChannel(thing, add, profile.status.extDigitalInput != null, CHGR_SENSOR, CHANNEL_ESENSOR_DIGITALINPUT);
359         addChannel(thing, add, profile.status.extAnalogInput != null, CHGR_SENSOR, CHANNEL_ESENSOR_ANALOGINPUT);
360
361         return add;
362     }
363
364     public static Map<String, Channel> createDimmerChannels(final Thing thing, final ShellyDeviceProfile profile,
365             final ShellySettingsStatus dstatus, int idx) {
366         Map<String, Channel> add = new LinkedHashMap<>();
367         String group = profile.getControlGroup(idx);
368
369         // Shelly Dimmer has an additional brightness channel
370         addChannel(thing, add, profile.isDimmer, group, CHANNEL_BRIGHTNESS);
371
372         if (profile.settings.dimmers != null) {
373             ShellySettingsDimmer ds = profile.settings.dimmers.get(idx);
374             addChannel(thing, add, ds.autoOn != null, group, CHANNEL_TIMER_AUTOON);
375             addChannel(thing, add, ds.autoOff != null, group, CHANNEL_TIMER_AUTOOFF);
376             ShellyShortLightStatus dss = dstatus.dimmers.get(idx);
377             addChannel(thing, add, dss != null && dss.hasTimer != null, group, CHANNEL_TIMER_ACTIVE);
378         }
379         return add;
380     }
381
382     public static Map<String, Channel> createLightChannels(final Thing thing, final ShellyDeviceProfile profile,
383             final ShellyStatusLightChannel status, int idx) {
384         Map<String, Channel> add = new LinkedHashMap<>();
385         String group = profile.getControlGroup(idx);
386
387         if (profile.settings.lights != null) {
388             ShellySettingsRgbwLight light = profile.settings.lights.get(idx);
389             String whiteGroup = profile.isRGBW2 ? group : CHANNEL_GROUP_WHITE_CONTROL;
390             // Create power channel in color mode and brightness channel in white mode
391             addChannel(thing, add, profile.inColor, group, CHANNEL_LIGHT_POWER);
392             addChannel(thing, add, light.autoOn != null, group, CHANNEL_TIMER_AUTOON);
393             addChannel(thing, add, light.autoOff != null, group, CHANNEL_TIMER_AUTOOFF);
394             addChannel(thing, add, status.hasTimer != null, group, CHANNEL_TIMER_ACTIVE);
395             addChannel(thing, add, light.brightness != null, whiteGroup, CHANNEL_BRIGHTNESS);
396             addChannel(thing, add, light.temp != null, whiteGroup, CHANNEL_COLOR_TEMP);
397         }
398
399         return add;
400     }
401
402     public static Map<String, Channel> createInputChannels(final Thing thing, final ShellyDeviceProfile profile,
403             final ShellySettingsStatus status) {
404         Map<String, Channel> add = new LinkedHashMap<>();
405         if (status.inputs != null) {
406             // Create channels per input. For devices with more than 1 input (Dimmer, 1L) multiple channel sets are
407             // created by adding the index to the channel name
408             for (int i = 0; i < profile.numInputs; i++) {
409                 String group = profile.getInputGroup(i);
410                 String suffix = profile.getInputSuffix(i); // multi ? String.valueOf(i + 1) : "";
411                 addChannel(thing, add, true, group, CHANNEL_INPUT + suffix);
412                 addChannel(thing, add, true, group,
413                         (!profile.isRoller ? CHANNEL_BUTTON_TRIGGER + suffix : CHANNEL_EVENT_TRIGGER));
414                 if (profile.inButtonMode(i)) {
415                     ShellyInputState input = status.inputs.get(i);
416                     addChannel(thing, add, input.event != null, group, CHANNEL_STATUS_EVENTTYPE + suffix);
417                     addChannel(thing, add, input.eventCount != null, group, CHANNEL_STATUS_EVENTCOUNT + suffix);
418                 }
419             }
420         } else if (status.input != null) {
421             // old RGBW2 firmware
422             String group = profile.getInputGroup(0);
423             addChannel(thing, add, true, group, CHANNEL_INPUT);
424             addChannel(thing, add, true, group, CHANNEL_BUTTON_TRIGGER);
425         }
426         return add;
427     }
428
429     public static Map<String, Channel> createRollerChannels(Thing thing, final ShellyRollerStatus roller) {
430         Map<String, Channel> add = new LinkedHashMap<>();
431         addChannel(thing, add, true, CHGR_ROLLER, CHANNEL_ROL_CONTROL_CONTROL);
432         addChannel(thing, add, true, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STATE);
433         addChannel(thing, add, true, CHGR_ROLLER, CHANNEL_EVENT_TRIGGER);
434         addChannel(thing, add, roller.currentPos != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_POS);
435         addChannel(thing, add, roller.stopReason != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_STOPR);
436         addChannel(thing, add, roller.safetySwitch != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_SAFETY);
437
438         ShellyThingInterface handler = (ShellyThingInterface) thing.getHandler();
439         if (handler != null) {
440             ShellySettingsGlobal settings = handler.getProfile().settings;
441             if (getBool(settings.favoritesEnabled) && settings.favorites != null) {
442                 addChannel(thing, add, roller.currentPos != null, CHGR_ROLLER, CHANNEL_ROL_CONTROL_FAV);
443             }
444         }
445         return add;
446     }
447
448     public static Map<String, Channel> createMeterChannels(Thing thing, final ShellySettingsMeter meter, String group) {
449         Map<String, Channel> newChannels = new LinkedHashMap<>();
450         addChannel(thing, newChannels, meter.power != null, group, CHANNEL_METER_CURRENTWATTS);
451         addChannel(thing, newChannels, meter.total != null, group, CHANNEL_METER_TOTALKWH);
452         addChannel(thing, newChannels, meter.counters != null && meter.counters[0] != null, group,
453                 CHANNEL_METER_LASTMIN1);
454         addChannel(thing, newChannels, meter.timestamp != null, group, CHANNEL_LAST_UPDATE);
455         return newChannels;
456     }
457
458     public static Map<String, Channel> createEMeterChannels(final Thing thing, final ShellySettingsEMeter emeter,
459             String group) {
460         Map<String, Channel> newChannels = new LinkedHashMap<>();
461         addChannel(thing, newChannels, emeter.power != null, group, CHANNEL_METER_CURRENTWATTS);
462         addChannel(thing, newChannels, emeter.total != null, group, CHANNEL_METER_TOTALKWH);
463         addChannel(thing, newChannels, emeter.totalReturned != null, group, CHANNEL_EMETER_TOTALRET);
464         addChannel(thing, newChannels, emeter.reactive != null, group, CHANNEL_EMETER_REACTWATTS);
465         addChannel(thing, newChannels, emeter.voltage != null, group, CHANNEL_EMETER_VOLTAGE);
466         addChannel(thing, newChannels, emeter.current != null, group, CHANNEL_EMETER_CURRENT);
467         addChannel(thing, newChannels, emeter.pf != null, group, CHANNEL_EMETER_PFACTOR); // EM has no PF. but power
468
469         addChannel(thing, newChannels, true, group, CHANNEL_LAST_UPDATE);
470         return newChannels;
471     }
472
473     public static Map<String, Channel> createSensorChannels(final Thing thing, final ShellyDeviceProfile profile,
474             final ShellyStatusSensor sdata) {
475         Map<String, Channel> newChannels = new LinkedHashMap<>();
476
477         // Sensor data
478         addChannel(thing, newChannels, sdata.tmp != null || sdata.thermostats != null, CHANNEL_GROUP_SENSOR,
479                 CHANNEL_SENSOR_TEMP);
480         addChannel(thing, newChannels, sdata.hum != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_HUM);
481         addChannel(thing, newChannels, sdata.lux != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_LUX);
482         addChannel(thing, newChannels, sdata.lux != null && sdata.lux.illumination != null, CHANNEL_GROUP_SENSOR,
483                 CHANNEL_SENSOR_ILLUM);
484         addChannel(thing, newChannels, sdata.flood != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_FLOOD);
485         addChannel(thing, newChannels, sdata.smoke != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_FLOOD);
486         addChannel(thing, newChannels, profile.settings.externalPower != null || sdata.charger != null, CHGR_DEVST,
487                 CHANNEL_DEVST_CHARGER);
488         addChannel(thing, newChannels, sdata.motion != null || (sdata.sensor != null && sdata.sensor.motion != null),
489                 CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_MOTION);
490         if (sdata.sensor != null) { // DW, Sense or Motion
491             addChannel(thing, newChannels, sdata.sensor.state != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE); // DW/DW2
492             addChannel(thing, newChannels, sdata.sensor.motionActive != null, CHANNEL_GROUP_SENSOR, // Motion
493                     CHANNEL_SENSOR_MOTION_ACT);
494             addChannel(thing, newChannels, sdata.sensor.motionTimestamp != null, CHANNEL_GROUP_SENSOR, // Motion
495                     CHANNEL_SENSOR_MOTION_TS);
496             addChannel(thing, newChannels, sdata.sensor.vibration != null, CHANNEL_GROUP_SENSOR,
497                     CHANNEL_SENSOR_VIBRATION);
498         }
499         if (sdata.accel != null) { // DW2
500             addChannel(thing, newChannels, sdata.accel.tilt != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_TILT);
501         }
502
503         // Gas
504         if (sdata.gasSensor != null) {
505             addChannel(thing, newChannels, sdata.gasSensor.selfTestState != null, CHGR_DEVST, CHANNEL_DEVST_SELFTTEST);
506             addChannel(thing, newChannels, sdata.gasSensor.sensorState != null, CHANNEL_GROUP_SENSOR,
507                     CHANNEL_SENSOR_SSTATE);
508             addChannel(thing, newChannels, sdata.concentration != null && sdata.concentration.ppm != null,
509                     CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_PPM);
510             addChannel(thing, newChannels, sdata.valves != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VALVE);
511             addChannel(thing, newChannels, sdata.gasSensor.sensorState != null, CHANNEL_GROUP_SENSOR,
512                     CHANNEL_SENSOR_ALARM_STATE);
513         }
514
515         // Sense
516         addChannel(thing, newChannels, profile.isSense, CHANNEL_GROUP_SENSOR, CHANNEL_SENSE_KEY);
517
518         // UNI
519         addChannel(thing, newChannels, sdata.adcs != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_VOLTAGE);
520
521         // TRV
522         if (profile.isTRV) {
523             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SETTEMP);
524             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BCONTROL);
525             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_BTIMER);
526             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_POSITION);
527             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_MODE);
528             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_PROFILE);
529             addChannel(thing, newChannels, true, CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_SCHEDULE);
530             addChannel(thing, newChannels, true, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_STATE);
531         }
532
533         // Battery
534         if (sdata.bat != null) {
535             addChannel(thing, newChannels, sdata.bat.value != null, CHANNEL_GROUP_BATTERY, CHANNEL_SENSOR_BAT_LEVEL);
536             addChannel(thing, newChannels, sdata.bat.value != null, CHANNEL_GROUP_BATTERY, CHANNEL_SENSOR_BAT_LOW);
537         }
538
539         addChannel(thing, newChannels, sdata.sensorError != null, CHANNEL_GROUP_SENSOR, CHANNEL_SENSOR_ERROR);
540         addChannel(thing, newChannels, sdata.actReasons != null, CHGR_DEVST, CHANNEL_DEVST_WAKEUP);
541         addChannel(thing, newChannels, true, profile.isButton ? CHANNEL_GROUP_STATUS : CHANNEL_GROUP_SENSOR,
542                 CHANNEL_LAST_UPDATE);
543         return newChannels;
544     }
545
546     public ChannelTypeUID getChannelTypeUID(String channelId) {
547         ShellyChannel channelDef = getDefinition(channelId);
548         if (channelDef != null) {
549             return new ChannelTypeUID(BINDING_ID, channelDef.typeId);
550         }
551         throw new IllegalArgumentException("Invalid channelId:" + channelId);
552     }
553
554     private static void addChannel(Thing thing, Map<String, Channel> newChannels, boolean supported, String group,
555             String channelName) throws IllegalArgumentException {
556         if (supported) {
557             String channelId = group + "#" + channelName;
558             ChannelUID channelUID = new ChannelUID(thing.getUID(), channelId);
559             ShellyChannel channelDef = getDefinition(channelId);
560             if (channelDef != null) {
561                 ChannelTypeUID channelTypeUID = channelDef.typeId.contains("system:")
562                         ? new ChannelTypeUID(channelDef.typeId)
563                         : new ChannelTypeUID(BINDING_ID, channelDef.typeId);
564                 ChannelBuilder builder;
565                 if (channelDef.typeId.equalsIgnoreCase("system:button")) {
566                     builder = ChannelBuilder.create(channelUID, null).withKind(ChannelKind.TRIGGER);
567                 } else {
568                     builder = ChannelBuilder.create(channelUID, channelDef.itemType);
569                 }
570                 if (!channelDef.label.isEmpty()) {
571                     char grseq = lastChar(group);
572                     char chseq = lastChar(channelName);
573                     char sequence = isDigit(chseq) ? chseq : grseq;
574                     String label = !isDigit(sequence) ? channelDef.label : channelDef.label + " " + sequence;
575                     builder.withLabel(label);
576                 }
577                 if (!channelDef.description.isEmpty()) {
578                     builder.withDescription(channelDef.description);
579                 }
580                 newChannels.put(channelId, builder.withType(channelTypeUID).build());
581             }
582         }
583     }
584
585     public List<StateOption> getStateOptions(ChannelTypeUID uid) {
586         List<StateOption> options = new ArrayList<>();
587         for (OptionEntry oe : stateOptions) {
588             if (oe.uid.equals(uid)) {
589                 options.add(new StateOption(oe.key, oe.value));
590             }
591         }
592         return options;
593     }
594
595     public void addStateOption(String channelId, String key, String value) {
596         ChannelTypeUID uid = getChannelTypeUID(channelId);
597         stateOptions.addIfAbsent(new OptionEntry(uid, key, value));
598     }
599
600     public void clearStateOptions(String channelId) {
601         ChannelTypeUID uid = getChannelTypeUID(channelId);
602         for (OptionEntry oe : stateOptions) {
603             if (oe.uid.equals(uid)) {
604                 stateOptions.remove(oe);
605             }
606         }
607     }
608
609     public class ShellyChannel {
610         private final ShellyTranslationProvider messages;
611         public String group = "";
612         public String groupLabel = "";
613         public String groupDescription = "";
614
615         public String channel = "";
616         public String label = "";
617         public String description = "";
618         public String itemType = "";
619         public String typeId = "";
620         public String category = "";
621         public Set<String> tags = new HashSet<>();
622         public @Nullable Unit<?> unit;
623         public Optional<Integer> min = Optional.empty();
624         public Optional<Integer> max = Optional.empty();
625         public Optional<Integer> step = Optional.empty();
626         public Optional<String> pattern = Optional.empty();
627
628         public ShellyChannel(ShellyTranslationProvider messages, String group, String channel, String typeId,
629                 String itemType, String... category) {
630             this.messages = messages;
631             this.group = group;
632             this.channel = channel;
633             this.itemType = itemType;
634             this.typeId = typeId;
635
636             groupLabel = getText(PREFIX_GROUP + group + ".label");
637             if (groupLabel.contains(PREFIX_GROUP)) {
638                 groupLabel = "";
639             }
640             groupDescription = getText(PREFIX_GROUP + group + ".description");
641             if (groupDescription.contains(PREFIX_GROUP)) {
642                 groupDescription = "";
643             }
644             label = getText(PREFIX_CHANNEL + typeId.replace(':', '.') + ".label");
645             if (label.contains(PREFIX_CHANNEL)) {
646                 label = "";
647             }
648             description = getText(PREFIX_CHANNEL + typeId + ".description");
649             if (description.contains(PREFIX_CHANNEL)) {
650                 description = "";
651             }
652         }
653
654         public String getChanneId() {
655             return group + "#" + channel;
656         }
657
658         public String getGroupLabel() {
659             return getGroupAttribute("group");
660         }
661
662         public String getGroupDescription() {
663             return getGroupAttribute("group");
664         }
665
666         public String getLabel() {
667             return getChannelAttribute("label");
668         }
669
670         public String getDescription() {
671             return getChannelAttribute("description");
672         }
673
674         public boolean getAdvanced() {
675             String attr = getChannelAttribute("advanced");
676             return attr.isEmpty() ? false : Boolean.valueOf(attr);
677         }
678
679         public boolean getReadyOnly() {
680             String attr = getChannelAttribute("readOnly");
681             return attr.isEmpty() ? false : Boolean.valueOf(attr);
682         }
683
684         public String getCategory() {
685             return getChannelAttribute("category");
686         }
687
688         public String getMin() {
689             return getChannelAttribute("min");
690         }
691
692         public String getMax() {
693             return getChannelAttribute("max");
694         }
695
696         public String getStep() {
697             return getChannelAttribute("step");
698         }
699
700         public String getPattern() {
701             return getChannelAttribute("pattern");
702         }
703
704         public String getGroupAttribute(String attribute) {
705             String key = PREFIX_GROUP + group + "." + attribute;
706             String value = messages.getText(key);
707             return !value.equals(key) ? value : "";
708         }
709
710         public String getChannelAttribute(String attribute) {
711             String key = PREFIX_CHANNEL + channel + "." + attribute;
712             String value = messages.getText(key);
713             return !value.equals(key) ? value : "";
714         }
715
716         private String getText(String key) {
717             return messages.get(key);
718         }
719     }
720
721     public static class ChannelMap {
722         private final Map<String, ShellyChannel> map = new HashMap<>();
723
724         private ChannelMap add(ShellyChannel def) {
725             map.put(def.getChanneId(), def);
726             return this;
727         }
728
729         public ShellyChannel get(String channelName) throws IllegalArgumentException {
730             ShellyChannel def = null;
731             if (channelName.contains("#")) {
732                 def = map.get(channelName);
733                 if (def != null) {
734                     return def;
735                 }
736             }
737             for (HashMap.Entry<String, ShellyChannel> entry : map.entrySet()) {
738                 if (entry.getValue().channel.contains("#" + channelName)) {
739                     def = entry.getValue();
740                     break;
741                 }
742             }
743
744             if (def == null) {
745                 throw new IllegalArgumentException("Channel definition for " + channelName + " not found!");
746             }
747
748             return def;
749         }
750     }
751 }