2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.shelly.internal.discovery;
15 import static org.openhab.binding.shelly.internal.ShellyBindingConstants.BINDING_ID;
16 import static org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.*;
17 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
19 import java.util.LinkedHashMap;
22 import org.eclipse.jdt.annotation.NonNullByDefault;
23 import org.openhab.core.thing.ThingTypeUID;
24 import org.openhab.core.thing.ThingUID;
27 * The {@link ShellyThingCreator} maps the device id into the thing type id
29 * @author Markus Michels - Initial contribution
32 public class ShellyThingCreator {
34 public static final String SHELLYDT_1 = "SHSW-1";
35 public static final String SHELLYDT_1PM = "SHSW-PM";
36 public static final String SHELLYDT_1L = "SHSW-L";
37 public static final String SHELLYDT_SHPLG = "SHPLG-1";
38 public static final String SHELLYDT_SHPLG_S = "SHPLG-S";
39 public static final String SHELLYDT_SHPLG_U1 = "SHPLG-U1";
40 public static final String SHELLYDT_SHELLY2 = "SHSW-21";
41 public static final String SHELLYDT_SHELLY25 = "SHSW-25";
42 public static final String SHELLYDT_SHPRO = "SHSW-44";
43 public static final String SHELLYDT_EM = "SHEM";
44 public static final String SHELLYDT_3EM = "SHEM-3";
45 public static final String SHELLYDT_HT = "SHHT-1";
46 public static final String SHELLYDT_DW = "SHDW-1";
47 public static final String SHELLYDT_DW2 = "SHDW-2";
48 public static final String SHELLYDT_SENSE = "SHSEN-1";
49 public static final String SHELLYDT_MOTION = "SHMOS-01";
50 public static final String SHELLYDT_MOTION2 = "SHMOS-02";
51 public static final String SHELLYDT_GAS = "SHGS-1";
52 public static final String SHELLYDT_DIMMER = "SHDM-1";
53 public static final String SHELLYDT_DIMMER2 = "SHDM-2";
54 public static final String SHELLYDT_IX3 = "SHIX3-1";
55 public static final String SHELLYDT_BULB = "SHBLB-1";
56 public static final String SHELLYDT_DUO = "SHBDUO-1";
57 public static final String SHELLYDT_DUORGBW = "SHCB-1";
58 public static final String SHELLYDT_VINTAGE = "SHVIN-1";
59 public static final String SHELLYDT_RGBW2 = "SHRGBW2";
60 public static final String SHELLYDT_BUTTON1 = "SHBTN-1";
61 public static final String SHELLYDT_BUTTON2 = "SHBTN-2";
62 public static final String SHELLYDT_UNI = "SHUNI-1";
63 public static final String SHELLYDT_TRV = "SHTRV-01";
66 public static final String SHELLYDT_PLUS1 = "SNSW-001X16EU";
67 public static final String SHELLYDT_PLUS1PM = "SNSW-001P16EU";
68 public static final String SHELLYDT_PLUS1UL = "SNSW-001X15UL";
69 public static final String SHELLYDT_PLUS1PMUL = "SNSW-001P15UL";
70 public static final String SHELLYDT_PLUS2PM_RELAY = "SNSW-002P16EU-relay";
71 public static final String SHELLYDT_PLUS2PM_ROLLER = "SNSW-002P16EU-roller";
72 public static final String SHELLYDT_PLUS2PM_RELAY_2 = "SNSW-102P16EU-relay";
73 public static final String SHELLYDT_PLUS2PM_ROLLER_2 = "SNSW-102P16EU-roller";
74 public static final String SHELLYDT_PLUSPLUGS = "SNPL-00112EU";
75 public static final String SHELLYDT_PLUSPLUGIT = "SNPL-00110IT";
76 public static final String SHELLYDT_PLUSPLUGUK = "SNPL-00112UK";
77 public static final String SHELLYDT_PLUSPLUGUS = "SNPL-00116US";
78 public static final String SHELLYDT_PLUSI4 = "SNSN-0024X";
79 public static final String SHELLYDT_PLUSI4DC = "SNSN-0D24X";
80 public static final String SHELLYDT_PLUSHT = "SNSN-0013A";
81 public static final String SHELLYDT_PLUSSMOKE = "SNSN-0031Z";
82 public static final String SHELLYDT_PLUSDIMMERUS = "SNDM-0013US";
83 public static final String SHELLYDT_PLUSWALLDISPLAY = "SAWD-0A1XX10EU1";
86 public static final String SHELLYDT_PRO1 = "SPSW-001XE16EU";
87 public static final String SHELLYDT_PRO1_2 = "SPSW-101XE16EU";
88 public static final String SHELLYDT_PRO1_3 = "SPSW-201XE16EU";
89 public static final String SHELLYDT_PRO1PM = "SPSW-001PE16EU";
90 public static final String SHELLYDT_PRO1PM_2 = "SPSW-101PE16EU";
91 public static final String SHELLYDT_PRO1PM_3 = "SPSW-201PE16EU";
92 public static final String SHELLYDT_PRO2_RELAY = "SPSW-002XE16EU-relay";
93 public static final String SHELLYDT_PRO2_RELAY_2 = "SPSW-102XE16EU-relay";
94 public static final String SHELLYDT_PRO2_RELAY_3 = "SPSW-202XE16EU-relay";
95 public static final String SHELLYDT_PRO2PM_RELAY = "SPSW-002PE16EU-relay";
96 public static final String SHELLYDT_PRO2PM_ROLLER = "SPSW-002PE16EU-roller";
97 public static final String SHELLYDT_PRO2PM_RELAY_2 = "SPSW-102PE16EU-relay";
98 public static final String SHELLYDT_PRO2PM_ROLLER_2 = "SPSW-102PE16EU-roller";
99 public static final String SHELLYDT_PRO2PM_RELAY_3 = "SPSW-202PE16EU-relay";
100 public static final String SHELLYDT_PRO2PM_ROLLER_3 = "SPSW-202PE16EU-roller";
101 public static final String SHELLYDT_PRO3 = "SPSW-003XE16EU";
102 public static final String SHELLYDT_PRO3EM = "SPEM-003CEBEU";
103 public static final String SHELLYDT_PRO4PM = "SPSW-004PE16EU";
104 public static final String SHELLYDT_PRO4PM_2 = "SPSW-104PE16EU";
107 public static final String SHELLYDT_BLUBUTTON = "SBBT";
108 public static final String SHELLYDT_BLUDW = "SBDW";
111 public static final String THING_TYPE_SHELLY1_STR = "shelly1";
112 public static final String THING_TYPE_SHELLY1L_STR = "shelly1l";
113 public static final String THING_TYPE_SHELLY1PM_STR = "shelly1pm";
114 public static final String THING_TYPE_SHELLYEM_STR = "shellyem";
115 public static final String THING_TYPE_SHELLY3EM_STR = "shellyem3"; // bad: misspelled product name, it's 3EM
116 public static final String THING_TYPE_SHELLY2_PREFIX = "shellyswitch";
117 public static final String THING_TYPE_SHELLY2_RELAY_STR = "shelly2-relay";
118 public static final String THING_TYPE_SHELLY2_ROLLER_STR = "shelly2-roller";
119 public static final String THING_TYPE_SHELLY25_PREFIX = "shellyswitch25";
120 public static final String THING_TYPE_SHELLY25_RELAY_STR = "shelly25-relay";
121 public static final String THING_TYPE_SHELLY25_ROLLER_STR = "shelly25-roller";
122 public static final String THING_TYPE_SHELLY4PRO_STR = "shelly4pro";
123 public static final String THING_TYPE_SHELLYPLUG_STR = "shellyplug";
124 public static final String THING_TYPE_SHELLYPLUGS_STR = "shellyplugs";
125 public static final String THING_TYPE_SHELLYPLUGU1_STR = "shellyplugu1"; // Shely Plug US
126 public static final String THING_TYPE_SHELLYDIMMER_STR = "shellydimmer";
127 public static final String THING_TYPE_SHELLYDIMMER2_STR = "shellydimmer2";
128 public static final String THING_TYPE_SHELLYIX3_STR = "shellyix3";
129 public static final String THING_TYPE_SHELLYBULB_STR = "shellybulb";
130 public static final String THING_TYPE_SHELLYDUO_STR = "shellybulbduo";
131 public static final String THING_TYPE_SHELLYVINTAGE_STR = "shellyvintage";
132 public static final String THING_TYPE_SHELLYRGBW2_PREFIX = "shellyrgbw2";
133 public static final String THING_TYPE_SHELLYRGBW2_COLOR_STR = THING_TYPE_SHELLYRGBW2_PREFIX + "-color";
134 public static final String THING_TYPE_SHELLYRGBW2_WHITE_STR = THING_TYPE_SHELLYRGBW2_PREFIX + "-white";
135 public static final String THING_TYPE_SHELLYDUORGBW_STR = "shellycolorbulb";
136 public static final String THING_TYPE_SHELLYHT_STR = "shellyht";
137 public static final String THING_TYPE_SHELLYSMOKE_STR = "shellysmoke";
138 public static final String THING_TYPE_SHELLYGAS_STR = "shellygas";
139 public static final String THING_TYPE_SHELLYFLOOD_STR = "shellyflood";
140 public static final String THING_TYPE_SHELLYDOORWIN_STR = "shellydw";
141 public static final String THING_TYPE_SHELLYDOORWIN2_STR = "shellydw2";
142 public static final String THING_TYPE_SHELLYEYE_STR = "shellyseye";
143 public static final String THING_TYPE_SHELLYSENSE_STR = "shellysense";
144 public static final String THING_TYPE_SHELLYTRV_STR = "shellytrv";
145 public static final String THING_TYPE_SHELLYMOTION_STR = "shellymotion";
146 public static final String THING_TYPE_SHELLYMOTION2_STR = "shellymotion2";
147 public static final String THING_TYPE_SHELLYBUTTON1_STR = "shellybutton1";
148 public static final String THING_TYPE_SHELLYBUTTON2_STR = "shellybutton2";
149 public static final String THING_TYPE_SHELLYUNI_STR = "shellyuni";
151 // Shelly Plus Seriens
152 public static final String THING_TYPE_SHELLYPLUS1_STR = "shellyplus1";
153 public static final String THING_TYPE_SHELLYPLUS1PM_STR = "shellyplus1pm";
154 public static final String THING_TYPE_SHELLYPLUS2PM_RELAY_STR = "shellyplus2pm-relay";
155 public static final String THING_TYPE_SHELLYPLUS2PM_ROLLER_STR = "shellyplus2pm-roller";
156 public static final String THING_TYPE_SHELLYPLUSI4_STR = "shellyplusi4";
157 public static final String THING_TYPE_SHELLYPLUSI4DC_STR = "shellyplusi4dc";
158 public static final String THING_TYPE_SHELLYPLUSHT_STR = "shellyplusht";
159 public static final String THING_TYPE_SHELLYPLUSSMOKE_STR = "shellyplussmoke";
160 public static final String THING_TYPE_SHELLYPLUSPLUGS_STR = "shellyplusplug";
161 public static final String THING_TYPE_SHELLYPLUSPLUGUS_STR = "shellyplusplugus";
162 public static final String THING_TYPE_SHELLYPLUSDIMMERUS_STR = "shellypluswdus";
163 public static final String THING_TYPE_SHELLYPLUSWALLDISPLAY_STR = "shellywalldisplay";
166 public static final String THING_TYPE_SHELLYPRO1_STR = "shellypro1";
167 public static final String THING_TYPE_SHELLYPRO1PM_STR = "shellypro1pm";
168 public static final String THING_TYPE_SHELLYPRO2_RELAY_STR = "shellypro2-relay";
169 public static final String THING_TYPE_SHELLYPRO2PM_RELAY_STR = "shellypro2pm-relay";
170 public static final String THING_TYPE_SHELLYPRO2PM_ROLLER_STR = "shellypro2pm-roller";
171 public static final String THING_TYPE_SHELLYPRO3_STR = "shellypro3";
172 public static final String THING_TYPE_SHELLYPRO3EM_STR = "shellypro3em";
173 public static final String THING_TYPE_SHELLYPRO4PM_STR = "shellypro4pm";
176 public static final String THING_TYPE_SHELLYBLU_PREFIX = "shellyblu";
177 public static final String THING_TYPE_SHELLYBLUBUTTON_STR = THING_TYPE_SHELLYBLU_PREFIX + "button";
178 public static final String THING_TYPE_SHELLYBLUDW_STR = THING_TYPE_SHELLYBLU_PREFIX + "dw";
180 // Password protected or unknown device
181 public static final String THING_TYPE_SHELLYPROTECTED_STR = "shellydevice";
182 public static final String THING_TYPE_SHELLYUNKNOWN_STR = "shellyunknown";
184 // List of all Thing Type UIDs
185 public static final ThingTypeUID THING_TYPE_SHELLY1 = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLY1_STR);
186 public static final ThingTypeUID THING_TYPE_SHELLY1L = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLY1L_STR);
187 public static final ThingTypeUID THING_TYPE_SHELLY1PM = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLY1PM_STR);
188 public static final ThingTypeUID THING_TYPE_SHELLYEM = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYEM_STR);
189 public static final ThingTypeUID THING_TYPE_SHELLY3EM = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLY3EM_STR);
190 public static final ThingTypeUID THING_TYPE_SHELLY2_RELAY = new ThingTypeUID(BINDING_ID,
191 THING_TYPE_SHELLY2_RELAY_STR);
192 public static final ThingTypeUID THING_TYPE_SHELLY2_ROLLER = new ThingTypeUID(BINDING_ID,
193 THING_TYPE_SHELLY2_ROLLER_STR);
194 public static final ThingTypeUID THING_TYPE_SHELLY25_RELAY = new ThingTypeUID(BINDING_ID,
195 THING_TYPE_SHELLY25_RELAY_STR);
196 public static final ThingTypeUID THING_TYPE_SHELLY25_ROLLER = new ThingTypeUID(BINDING_ID,
197 THING_TYPE_SHELLY25_ROLLER_STR);
198 public static final ThingTypeUID THING_TYPE_SHELLY4PRO = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLY4PRO_STR);
199 public static final ThingTypeUID THING_TYPE_SHELLYPLUG = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYPLUG_STR);
200 public static final ThingTypeUID THING_TYPE_SHELLYPLUGS = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYPLUGS_STR);
201 public static final ThingTypeUID THING_TYPE_SHELLYPLUGU1 = new ThingTypeUID(BINDING_ID,
202 THING_TYPE_SHELLYPLUGU1_STR);
203 public static final ThingTypeUID THING_TYPE_SHELLYUNI = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYUNI_STR);
204 public static final ThingTypeUID THING_TYPE_SHELLYDIMMER = new ThingTypeUID(BINDING_ID,
205 THING_TYPE_SHELLYDIMMER_STR);
206 public static final ThingTypeUID THING_TYPE_SHELLYDIMMER2 = new ThingTypeUID(BINDING_ID,
207 THING_TYPE_SHELLYDIMMER2_STR);
208 public static final ThingTypeUID THING_TYPE_SHELLYIX3 = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYIX3_STR);
209 public static final ThingTypeUID THING_TYPE_SHELLYBULB = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYBULB_STR);
210 public static final ThingTypeUID THING_TYPE_SHELLYDUO = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYDUO_STR);
211 public static final ThingTypeUID THING_TYPE_SHELLYVINTAGE = new ThingTypeUID(BINDING_ID,
212 THING_TYPE_SHELLYVINTAGE_STR);
213 public static final ThingTypeUID THING_TYPE_SHELLYDUORGBW = new ThingTypeUID(BINDING_ID,
214 THING_TYPE_SHELLYDUORGBW_STR);
215 public static final ThingTypeUID THING_TYPE_SHELLYHT = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYHT_STR);
216 public static final ThingTypeUID THING_TYPE_SHELLYSENSE = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYSENSE_STR);
217 public static final ThingTypeUID THING_TYPE_SHELLYSMOKE = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYSMOKE_STR);
218 public static final ThingTypeUID THING_TYPE_SHELLYGAS = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYGAS_STR);
219 public static final ThingTypeUID THING_TYPE_SHELLYFLOOD = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYFLOOD_STR);
220 public static final ThingTypeUID THING_TYPE_SHELLYDOORWIN = new ThingTypeUID(BINDING_ID,
221 THING_TYPE_SHELLYDOORWIN_STR);
222 public static final ThingTypeUID THING_TYPE_SHELLYDOORWIN2 = new ThingTypeUID(BINDING_ID,
223 THING_TYPE_SHELLYDOORWIN2_STR);
224 public static final ThingTypeUID THING_TYPE_SHELLYTRV = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYTRV_STR);
225 public static final ThingTypeUID THING_TYPE_SHELLYBUTTON1 = new ThingTypeUID(BINDING_ID,
226 THING_TYPE_SHELLYBUTTON1_STR);
227 public static final ThingTypeUID THING_TYPE_SHELLYBUTTON2 = new ThingTypeUID(BINDING_ID,
228 THING_TYPE_SHELLYBUTTON2_STR);
229 public static final ThingTypeUID THING_TYPE_SHELLYEYE = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYEYE_STR);
230 public static final ThingTypeUID THING_TYPE_SHELLMOTION = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYMOTION_STR);
231 public static final ThingTypeUID THING_TYPE_SHELLYRGBW2_COLOR = new ThingTypeUID(BINDING_ID,
232 THING_TYPE_SHELLYRGBW2_COLOR_STR);
233 public static final ThingTypeUID THING_TYPE_SHELLYRGBW2_WHITE = new ThingTypeUID(BINDING_ID,
234 THING_TYPE_SHELLYRGBW2_WHITE_STR);
235 public static final ThingTypeUID THING_TYPE_SHELLYPROTECTED = new ThingTypeUID(BINDING_ID,
236 THING_TYPE_SHELLYPROTECTED_STR);
237 public static final ThingTypeUID THING_TYPE_SHELLYUNKNOWN = new ThingTypeUID(BINDING_ID,
238 THING_TYPE_SHELLYUNKNOWN_STR);
241 public static final ThingTypeUID THING_TYPE_SHELLYPLUS1 = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYPLUS1_STR);
242 public static final ThingTypeUID THING_TYPE_SHELLYPLUS1PM = new ThingTypeUID(BINDING_ID,
243 THING_TYPE_SHELLYPLUS1PM_STR);
244 public static final ThingTypeUID THING_TYPE_SHELLYPLUS2PM_RELAY = new ThingTypeUID(BINDING_ID,
245 THING_TYPE_SHELLYPLUS2PM_RELAY_STR);
246 public static final ThingTypeUID THING_TYPE_SHELLYPLUS2PM_ROLLER = new ThingTypeUID(BINDING_ID,
247 THING_TYPE_SHELLYPLUS2PM_ROLLER_STR);
248 public static final ThingTypeUID THING_TYPE_SHELLYPLUSI4 = new ThingTypeUID(BINDING_ID,
249 THING_TYPE_SHELLYPLUSI4_STR);
250 public static final ThingTypeUID THING_TYPE_SHELLYPLUSI4DC = new ThingTypeUID(BINDING_ID,
251 THING_TYPE_SHELLYPLUSI4DC_STR);
252 public static final ThingTypeUID THING_TYPE_SHELLYPLUSHT = new ThingTypeUID(BINDING_ID,
253 THING_TYPE_SHELLYPLUSHT_STR);
254 public static final ThingTypeUID THING_TYPE_SHELLYPLUSSMOKE = new ThingTypeUID(BINDING_ID,
255 THING_TYPE_SHELLYPLUSSMOKE_STR);
256 public static final ThingTypeUID THING_TYPE_SHELLYPLUSPLUGS = new ThingTypeUID(BINDING_ID,
257 THING_TYPE_SHELLYPLUSPLUGS_STR);
258 public static final ThingTypeUID THING_TYPE_SHELLYPLUSPLUGUS = new ThingTypeUID(BINDING_ID,
259 THING_TYPE_SHELLYPLUSPLUGUS_STR);
260 public static final ThingTypeUID THING_TYPE_SHELLYPLUSDIMMERUS = new ThingTypeUID(BINDING_ID,
261 THING_TYPE_SHELLYPLUSDIMMERUS_STR);
262 public static final ThingTypeUID THING_TYPE_SHELLYPLUSWALLDISPLAY = new ThingTypeUID(BINDING_ID,
263 THING_TYPE_SHELLYPLUSWALLDISPLAY_STR);
266 public static final ThingTypeUID THING_TYPE_SHELLYPRO1 = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYPRO1_STR);
267 public static final ThingTypeUID THING_TYPE_SHELLYPRO1PM = new ThingTypeUID(BINDING_ID,
268 THING_TYPE_SHELLYPRO1PM_STR);
269 public static final ThingTypeUID THING_TYPE_SHELLYPRO2_RELAY = new ThingTypeUID(BINDING_ID,
270 THING_TYPE_SHELLYPRO2_RELAY_STR);
271 public static final ThingTypeUID THING_TYPE_SHELLYPRO2PM_RELAY = new ThingTypeUID(BINDING_ID,
272 THING_TYPE_SHELLYPRO2PM_RELAY_STR);
273 public static final ThingTypeUID THING_TYPE_SHELLYPRO2PM_ROLLER = new ThingTypeUID(BINDING_ID,
274 THING_TYPE_SHELLYPRO2PM_ROLLER_STR);
275 public static final ThingTypeUID THING_TYPE_SHELLYPRO3 = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYPRO3_STR);
276 public static final ThingTypeUID THING_TYPE_SHELLYPRO3EM = new ThingTypeUID(BINDING_ID,
277 THING_TYPE_SHELLYPRO3EM_STR);
278 public static final ThingTypeUID THING_TYPE_SHELLYPRO4PM = new ThingTypeUID(BINDING_ID,
279 THING_TYPE_SHELLYPRO4PM_STR);
282 public static final ThingTypeUID THING_TYPE_SHELLYBLUBUTTON = new ThingTypeUID(BINDING_ID,
283 THING_TYPE_SHELLYBLUBUTTON_STR);
284 public static final ThingTypeUID THING_TYPE_SHELLYBLUDW = new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYBLUDW_STR);
286 private static final Map<String, String> THING_TYPE_MAPPING = new LinkedHashMap<>();
288 // mapping by device type id
289 THING_TYPE_MAPPING.put(SHELLYDT_1PM, THING_TYPE_SHELLY1PM_STR);
290 THING_TYPE_MAPPING.put(SHELLYDT_1L, THING_TYPE_SHELLY1L_STR);
291 THING_TYPE_MAPPING.put(SHELLYDT_1, THING_TYPE_SHELLY1_STR);
292 THING_TYPE_MAPPING.put(SHELLYDT_3EM, THING_TYPE_SHELLY3EM_STR);
293 THING_TYPE_MAPPING.put(SHELLYDT_EM, THING_TYPE_SHELLYEM_STR);
294 THING_TYPE_MAPPING.put(SHELLYDT_SHPLG_S, THING_TYPE_SHELLYPLUGS_STR);
295 THING_TYPE_MAPPING.put(SHELLYDT_SHPLG_U1, THING_TYPE_SHELLYPLUGU1_STR);
296 THING_TYPE_MAPPING.put(SHELLYDT_GAS, THING_TYPE_SHELLYGAS_STR);
297 THING_TYPE_MAPPING.put(SHELLYDT_DW, THING_TYPE_SHELLYDOORWIN_STR);
298 THING_TYPE_MAPPING.put(SHELLYDT_DW2, THING_TYPE_SHELLYDOORWIN2_STR);
299 THING_TYPE_MAPPING.put(SHELLYDT_DUO, THING_TYPE_SHELLYDUO_STR);
300 THING_TYPE_MAPPING.put(SHELLYDT_DUORGBW, THING_TYPE_SHELLYDUORGBW_STR);
301 THING_TYPE_MAPPING.put(SHELLYDT_BULB, THING_TYPE_SHELLYBULB_STR);
302 THING_TYPE_MAPPING.put(SHELLYDT_VINTAGE, THING_TYPE_SHELLYVINTAGE_STR);
303 THING_TYPE_MAPPING.put(SHELLYDT_DIMMER, THING_TYPE_SHELLYDIMMER_STR);
304 THING_TYPE_MAPPING.put(SHELLYDT_DIMMER2, THING_TYPE_SHELLYDIMMER2_STR);
305 THING_TYPE_MAPPING.put(SHELLYDT_IX3, THING_TYPE_SHELLYIX3_STR);
306 THING_TYPE_MAPPING.put(SHELLYDT_BUTTON1, THING_TYPE_SHELLYBUTTON1_STR);
307 THING_TYPE_MAPPING.put(SHELLYDT_BUTTON2, THING_TYPE_SHELLYBUTTON2_STR);
308 THING_TYPE_MAPPING.put(SHELLYDT_UNI, THING_TYPE_SHELLYUNI_STR);
309 THING_TYPE_MAPPING.put(SHELLYDT_HT, THING_TYPE_SHELLYHT_STR);
310 THING_TYPE_MAPPING.put(SHELLYDT_TRV, THING_TYPE_SHELLYTRV_STR);
311 THING_TYPE_MAPPING.put(SHELLYDT_MOTION, THING_TYPE_SHELLYMOTION_STR);
314 THING_TYPE_MAPPING.put(SHELLYDT_PLUS1, THING_TYPE_SHELLYPLUS1_STR);
315 THING_TYPE_MAPPING.put(SHELLYDT_PLUS1PM, THING_TYPE_SHELLYPLUS1PM_STR);
316 THING_TYPE_MAPPING.put(SHELLYDT_PLUS1UL, THING_TYPE_SHELLYPLUS1_STR);
317 THING_TYPE_MAPPING.put(SHELLYDT_PLUS1PMUL, THING_TYPE_SHELLYPLUS1PM_STR);
318 THING_TYPE_MAPPING.put(SHELLYDT_PLUS2PM_RELAY, THING_TYPE_SHELLYPLUS2PM_RELAY_STR);
319 THING_TYPE_MAPPING.put(SHELLYDT_PLUS2PM_ROLLER, THING_TYPE_SHELLYPLUS2PM_ROLLER_STR);
320 THING_TYPE_MAPPING.put(SHELLYDT_PLUS2PM_RELAY_2, THING_TYPE_SHELLYPLUS2PM_RELAY_STR);
321 THING_TYPE_MAPPING.put(SHELLYDT_PLUS2PM_ROLLER_2, THING_TYPE_SHELLYPLUS2PM_ROLLER_STR);
322 THING_TYPE_MAPPING.put(SHELLYDT_PLUSPLUGS, THING_TYPE_SHELLYPLUSPLUGS_STR);
323 THING_TYPE_MAPPING.put(SHELLYDT_PLUSPLUGIT, THING_TYPE_SHELLYPLUSPLUGS_STR);
324 THING_TYPE_MAPPING.put(SHELLYDT_PLUSPLUGUK, THING_TYPE_SHELLYPLUSPLUGS_STR);
325 THING_TYPE_MAPPING.put(SHELLYDT_PLUSPLUGUS, THING_TYPE_SHELLYPLUSPLUGUS_STR);
326 THING_TYPE_MAPPING.put(SHELLYDT_PLUSI4DC, THING_TYPE_SHELLYPLUSI4DC_STR);
327 THING_TYPE_MAPPING.put(SHELLYDT_PLUSI4, THING_TYPE_SHELLYPLUSI4_STR);
328 THING_TYPE_MAPPING.put(SHELLYDT_PLUSHT, THING_TYPE_SHELLYPLUSHT_STR);
329 THING_TYPE_MAPPING.put(SHELLYDT_PLUSSMOKE, THING_TYPE_SHELLYPLUSSMOKE_STR);
330 THING_TYPE_MAPPING.put(SHELLYDT_PLUSDIMMERUS, THING_TYPE_SHELLYPLUSDIMMERUS_STR);
333 THING_TYPE_MAPPING.put(SHELLYDT_PRO1, THING_TYPE_SHELLYPRO1_STR);
334 THING_TYPE_MAPPING.put(SHELLYDT_PRO1_2, THING_TYPE_SHELLYPRO1_STR);
335 THING_TYPE_MAPPING.put(SHELLYDT_PRO1_3, THING_TYPE_SHELLYPRO1_STR);
336 THING_TYPE_MAPPING.put(SHELLYDT_PRO1PM, THING_TYPE_SHELLYPRO1PM_STR);
337 THING_TYPE_MAPPING.put(SHELLYDT_PRO1PM_2, THING_TYPE_SHELLYPRO1PM_STR);
338 THING_TYPE_MAPPING.put(SHELLYDT_PRO1PM_3, THING_TYPE_SHELLYPRO1PM_STR);
339 THING_TYPE_MAPPING.put(SHELLYDT_PRO2_RELAY, THING_TYPE_SHELLYPRO2_RELAY_STR);
340 THING_TYPE_MAPPING.put(SHELLYDT_PRO2_RELAY_2, THING_TYPE_SHELLYPRO2_RELAY_STR);
341 THING_TYPE_MAPPING.put(SHELLYDT_PRO2_RELAY_3, THING_TYPE_SHELLYPRO2_RELAY_STR);
342 THING_TYPE_MAPPING.put(SHELLYDT_PRO2PM_RELAY, THING_TYPE_SHELLYPRO2PM_RELAY_STR);
343 THING_TYPE_MAPPING.put(SHELLYDT_PRO2PM_RELAY_2, THING_TYPE_SHELLYPRO2PM_RELAY_STR);
344 THING_TYPE_MAPPING.put(SHELLYDT_PRO2PM_RELAY_3, THING_TYPE_SHELLYPRO2PM_RELAY_STR);
345 THING_TYPE_MAPPING.put(SHELLYDT_PRO2PM_ROLLER, THING_TYPE_SHELLYPRO2PM_ROLLER_STR);
346 THING_TYPE_MAPPING.put(SHELLYDT_PRO2PM_ROLLER_2, THING_TYPE_SHELLYPRO2PM_ROLLER_STR);
347 THING_TYPE_MAPPING.put(SHELLYDT_PRO2PM_ROLLER_3, THING_TYPE_SHELLYPRO2PM_ROLLER_STR);
348 THING_TYPE_MAPPING.put(SHELLYDT_PRO3, THING_TYPE_SHELLYPRO3_STR);
349 THING_TYPE_MAPPING.put(SHELLYDT_PRO3EM, THING_TYPE_SHELLYPRO3EM_STR);
350 THING_TYPE_MAPPING.put(SHELLYDT_PRO4PM, THING_TYPE_SHELLYPRO4PM_STR);
351 THING_TYPE_MAPPING.put(SHELLYDT_PRO4PM_2, THING_TYPE_SHELLYPRO4PM_STR);
354 THING_TYPE_MAPPING.put(SHELLYDT_BLUBUTTON, THING_TYPE_SHELLYBLUBUTTON_STR);
355 THING_TYPE_MAPPING.put(SHELLYDT_BLUDW, THING_TYPE_SHELLYBLUDW_STR);
358 THING_TYPE_MAPPING.put(SHELLYDT_PLUSWALLDISPLAY, THING_TYPE_SHELLYPLUSWALLDISPLAY_STR);
360 // mapping by thing type
361 THING_TYPE_MAPPING.put(THING_TYPE_SHELLY1_STR, THING_TYPE_SHELLY1_STR);
362 THING_TYPE_MAPPING.put(THING_TYPE_SHELLY1PM_STR, THING_TYPE_SHELLY1PM_STR);
363 THING_TYPE_MAPPING.put(THING_TYPE_SHELLY1L_STR, THING_TYPE_SHELLY1L_STR);
364 THING_TYPE_MAPPING.put(THING_TYPE_SHELLY3EM_STR, THING_TYPE_SHELLY3EM_STR);
365 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYEM_STR, THING_TYPE_SHELLYEM_STR);
366 THING_TYPE_MAPPING.put(THING_TYPE_SHELLY4PRO_STR, THING_TYPE_SHELLY4PRO_STR);
367 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDIMMER2_STR, THING_TYPE_SHELLYDIMMER2_STR);
368 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDIMMER_STR, THING_TYPE_SHELLYDIMMER_STR);
369 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYIX3_STR, THING_TYPE_SHELLYIX3_STR);
370 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDUORGBW_STR, THING_TYPE_SHELLYDUORGBW_STR);
371 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDUO_STR, THING_TYPE_SHELLYDUO_STR);
372 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYVINTAGE_STR, THING_TYPE_SHELLYVINTAGE_STR);
373 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYBULB_STR, THING_TYPE_SHELLYBULB_STR);
374 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDUO_STR, THING_TYPE_SHELLYDUO_STR);
375 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYHT_STR, THING_TYPE_SHELLYHT_STR);
376 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYSMOKE_STR, THING_TYPE_SHELLYSMOKE_STR);
377 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYGAS_STR, THING_TYPE_SHELLYGAS_STR);
378 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYFLOOD_STR, THING_TYPE_SHELLYFLOOD_STR);
379 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYTRV_STR, THING_TYPE_SHELLYTRV_STR);
380 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDOORWIN_STR, THING_TYPE_SHELLYDOORWIN_STR);
381 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYDOORWIN2_STR, THING_TYPE_SHELLYDOORWIN2_STR);
382 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYSENSE_STR, THING_TYPE_SHELLYSENSE_STR);
383 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYEYE_STR, THING_TYPE_SHELLYEYE_STR);
384 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYBUTTON1_STR, THING_TYPE_SHELLYBUTTON1_STR);
385 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYBUTTON2_STR, THING_TYPE_SHELLYBUTTON2_STR);
386 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYUNI_STR, THING_TYPE_SHELLYUNI_STR);
387 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYMOTION2_STR, THING_TYPE_SHELLYMOTION_STR);
389 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS1PM_STR, THING_TYPE_SHELLYPLUS1PM_STR);
390 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS1_STR, THING_TYPE_SHELLYPLUS1_STR);
391 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS1PM_STR, THING_TYPE_SHELLYPLUS1PM_STR);
392 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS2PM_RELAY_STR, THING_TYPE_SHELLYPLUS2PM_RELAY_STR);
393 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS2PM_ROLLER_STR, THING_TYPE_SHELLYPLUS2PM_ROLLER_STR);
394 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS2PM_RELAY_STR, THING_TYPE_SHELLYPLUS2PM_RELAY_STR);
395 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUS2PM_ROLLER_STR, THING_TYPE_SHELLYPLUS2PM_ROLLER_STR);
396 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSPLUGS_STR, THING_TYPE_SHELLYPLUSPLUGS_STR);
397 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSPLUGUS_STR, THING_TYPE_SHELLYPLUSPLUGUS_STR);
398 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSI4DC_STR, THING_TYPE_SHELLYPLUSI4DC_STR);
399 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSI4_STR, THING_TYPE_SHELLYPLUSI4_STR);
400 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSHT_STR, THING_TYPE_SHELLYPLUSHT_STR);
401 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSSMOKE_STR, THING_TYPE_SHELLYPLUSSMOKE_STR);
402 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSDIMMERUS_STR, THING_TYPE_SHELLYPLUSDIMMERUS_STR);
403 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPLUSWALLDISPLAY_STR, THING_TYPE_SHELLYPLUSWALLDISPLAY_STR);
405 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO1_STR, THING_TYPE_SHELLYPRO1_STR);
406 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO1PM_STR, THING_TYPE_SHELLYPRO1PM_STR);
407 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO2PM_RELAY_STR, THING_TYPE_SHELLYPRO2PM_RELAY_STR);
408 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO2PM_ROLLER_STR, THING_TYPE_SHELLYPRO2PM_ROLLER_STR);
409 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO2_RELAY_STR, THING_TYPE_SHELLYPRO2_RELAY_STR);
410 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO3EM_STR, THING_TYPE_SHELLYPRO3EM_STR);
411 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO3_STR, THING_TYPE_SHELLYPRO3_STR);
412 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPRO4PM_STR, THING_TYPE_SHELLYPRO4PM_STR);
414 THING_TYPE_MAPPING.put(THING_TYPE_SHELLYPROTECTED_STR, THING_TYPE_SHELLYPROTECTED_STR);
417 public static ThingUID getThingUID(String serviceName, String deviceType, String mode, boolean unknown) {
418 String devid = substringAfterLast(serviceName, "-");
419 if (devid.isEmpty()) {
420 throw new IllegalArgumentException("serviceName has improper format: " + serviceName);
422 return new ThingUID(!unknown ? getThingTypeUID(serviceName, deviceType, mode)
423 : getThingTypeUID(THING_TYPE_SHELLYPROTECTED_STR + "-" + devid, deviceType, mode), devid);
426 public static ThingTypeUID getThingTypeUID(String serviceName, String deviceType, String mode) {
427 return new ThingTypeUID(BINDING_ID, getThingType(serviceName, deviceType, mode));
430 public static ThingTypeUID getUnknownTTUID() {
431 return new ThingTypeUID(BINDING_ID, THING_TYPE_SHELLYPROTECTED_STR);
434 public static String getThingType(String hostname, String deviceType, String mode) {
435 if (THING_TYPE_SHELLYPROTECTED_STR.equals(hostname)) {
436 return THING_TYPE_SHELLYPROTECTED_STR;
438 String name = hostname.toLowerCase();
439 String type = substringBefore(name, "-").toLowerCase();
440 String devid = substringAfterLast(name, "-");
441 if (devid.isEmpty() || type.isEmpty()) {
442 throw new IllegalArgumentException("Invalid device name format: " + hostname);
445 // First check for special handling
446 if (name.startsWith(THING_TYPE_SHELLY25_PREFIX)) { // Shelly v2.5
447 return mode.equals(SHELLY_MODE_RELAY) ? THING_TYPE_SHELLY25_RELAY_STR : THING_TYPE_SHELLY25_ROLLER_STR;
449 if (name.startsWith(THING_TYPE_SHELLY2_PREFIX)) { // Shelly v2
450 return mode.equals(SHELLY_MODE_RELAY) ? THING_TYPE_SHELLY2_RELAY_STR : THING_TYPE_SHELLY2_ROLLER_STR;
452 if (name.startsWith(THING_TYPE_SHELLYPLUG_STR)) {
453 // shellyplug-s needs to be mapped to shellyplugs to follow the schema
454 // for the thing types: <thing type>-<mode>
455 if (name.startsWith(THING_TYPE_SHELLYPLUGS_STR) || name.contains("-s")) {
456 return THING_TYPE_SHELLYPLUGS_STR;
458 if (name.startsWith(THING_TYPE_SHELLYPLUGU1_STR)) {
459 return THING_TYPE_SHELLYPLUGU1_STR;
461 return THING_TYPE_SHELLYPLUG_STR;
463 if (name.startsWith(THING_TYPE_SHELLYRGBW2_PREFIX)) {
464 return mode.equals(SHELLY_MODE_COLOR) ? THING_TYPE_SHELLYRGBW2_COLOR_STR : THING_TYPE_SHELLYRGBW2_WHITE_STR;
466 if (name.startsWith(THING_TYPE_SHELLYMOTION_STR)) {
467 // depending on firmware release the Motion advertises under shellymotion-xxx or shellymotionsensor-xxxx
468 return THING_TYPE_SHELLYMOTION_STR;
471 // Check general mapping
472 if (!deviceType.isEmpty()) {
473 String res = THING_TYPE_MAPPING.get(deviceType); // by device type
478 String dt = mode.equals(SHELLY_MODE_RELAY) || mode.equals(SHELLY_MODE_ROLLER) ? deviceType + "-" + mode
480 res = THING_TYPE_MAPPING.get(dt); // <DT>-relay / <DT>-roller
486 String res = THING_TYPE_MAPPING.get(type);
490 return THING_TYPE_SHELLYUNKNOWN_STR;