2 * Copyright (c) 2010-2021 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.somfytahoma.internal;
15 import java.util.Arrays;
16 import java.util.HashMap;
17 import java.util.HashSet;
21 import org.eclipse.jdt.annotation.NonNullByDefault;
22 import org.openhab.core.thing.ThingTypeUID;
25 * The {@link SomfyTahomaBindingConstants} class defines common constants, which are
26 * used across the whole binding.
28 * @author Ondrej Pecta - Initial contribution
29 * @author Laurent Garnier - Other portals integration
32 public class SomfyTahomaBindingConstants {
34 public static final String BINDING_ID = "somfytahoma";
38 public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, "bridge");
41 public static final ThingTypeUID THING_TYPE_GATEWAY = new ThingTypeUID(BINDING_ID, "gateway");
44 public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER = new ThingTypeUID(BINDING_ID, "rollershutter");
46 // Silent Roller Shutter
47 public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER_SILENT = new ThingTypeUID(BINDING_ID,
48 "rollershutter_silent");
51 public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER_UNO = new ThingTypeUID(BINDING_ID, "rollershutter_uno");
54 public static final ThingTypeUID THING_TYPE_SCREEN = new ThingTypeUID(BINDING_ID, "screen");
57 public static final ThingTypeUID THING_TYPE_VENETIANBLIND = new ThingTypeUID(BINDING_ID, "venetianblind");
60 public static final ThingTypeUID THING_TYPE_EXTERIORSCREEN = new ThingTypeUID(BINDING_ID, "exteriorscreen");
62 // Exterior Venetian Blind
63 public static final ThingTypeUID THING_TYPE_EXTERIORVENETIANBLIND = new ThingTypeUID(BINDING_ID,
64 "exteriorvenetianblind");
67 public static final ThingTypeUID THING_TYPE_GARAGEDOOR = new ThingTypeUID(BINDING_ID, "garagedoor");
70 public static final ThingTypeUID THING_TYPE_AWNING = new ThingTypeUID(BINDING_ID, "awning");
73 public static final ThingTypeUID THING_TYPE_ACTIONGROUP = new ThingTypeUID(BINDING_ID, "actiongroup");
76 public static final ThingTypeUID THING_TYPE_ONOFF = new ThingTypeUID(BINDING_ID, "onoff");
79 public static final ThingTypeUID THING_TYPE_LIGHT = new ThingTypeUID(BINDING_ID, "light");
82 public static final ThingTypeUID THING_TYPE_DIMMER_LIGHT = new ThingTypeUID(BINDING_ID, "dimmerlight");
85 public static final ThingTypeUID THING_TYPE_LIGHTSENSOR = new ThingTypeUID(BINDING_ID, "lightsensor");
88 public static final ThingTypeUID THING_TYPE_SMOKESENSOR = new ThingTypeUID(BINDING_ID, "smokesensor");
91 public static final ThingTypeUID THING_TYPE_CONTACTSENSOR = new ThingTypeUID(BINDING_ID, "contactsensor");
94 public static final ThingTypeUID THING_TYPE_OCCUPANCYSENSOR = new ThingTypeUID(BINDING_ID, "occupancysensor");
97 public static final ThingTypeUID THING_TYPE_WATERSENSOR = new ThingTypeUID(BINDING_ID, "watersensor");
100 public static final ThingTypeUID THING_TYPE_HUMIDITYSENSOR = new ThingTypeUID(BINDING_ID, "humiditysensor");
103 public static final ThingTypeUID THING_TYPE_WINDOW = new ThingTypeUID(BINDING_ID, "window");
106 public static final ThingTypeUID THING_TYPE_INTERNAL_ALARM = new ThingTypeUID(BINDING_ID, "internalalarm");
107 public static final ThingTypeUID THING_TYPE_EXTERNAL_ALARM = new ThingTypeUID(BINDING_ID, "externalalarm");
108 public static final ThingTypeUID THING_TYPE_MYFOX_ALARM = new ThingTypeUID(BINDING_ID, "myfoxalarm");
111 public static final ThingTypeUID THING_TYPE_POD = new ThingTypeUID(BINDING_ID, "pod");
114 public static final ThingTypeUID THING_TYPE_VALVE_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID,
115 "valveheatingsystem");
116 public static final ThingTypeUID THING_TYPE_ZWAVE_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID, "heatingsystem");
117 public static final ThingTypeUID THING_TYPE_ONOFF_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID,
118 "onoffheatingsystem");
119 public static final ThingTypeUID THING_TYPE_EXTERIOR_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID,
120 "exteriorheatingsystem");
123 public static final ThingTypeUID THING_TYPE_DOOR_LOCK = new ThingTypeUID(BINDING_ID, "doorlock");
126 public static final ThingTypeUID THING_TYPE_PERGOLA = new ThingTypeUID(BINDING_ID, "pergola");
128 // Bioclimatic Pergola
129 public static final ThingTypeUID THING_TYPE_BIOCLIMATIC_PERGOLA = new ThingTypeUID(BINDING_ID,
130 "bioclimaticpergola");
133 public static final ThingTypeUID THING_TYPE_WINDOW_HANDLE = new ThingTypeUID(BINDING_ID, "windowhandle");
135 // Temperature sensor
136 public static final ThingTypeUID THING_TYPE_TEMPERATURESENSOR = new ThingTypeUID(BINDING_ID, "temperaturesensor");
139 public static final ThingTypeUID THING_TYPE_GATE = new ThingTypeUID(BINDING_ID, "gate");
142 public static final ThingTypeUID THING_TYPE_CURTAIN = new ThingTypeUID(BINDING_ID, "curtain");
144 // Electricity sensor
145 public static final ThingTypeUID THING_TYPE_ELECTRICITYSENSOR = new ThingTypeUID(BINDING_ID, "electricitysensor");
148 public static final ThingTypeUID THING_TYPE_DOCK = new ThingTypeUID(BINDING_ID, "dock");
151 public static final ThingTypeUID THING_TYPE_SIREN = new ThingTypeUID(BINDING_ID, "siren");
153 // Adjustable slats roller shutter
154 public static final ThingTypeUID THING_TYPE_ADJUSTABLE_SLATS_ROLLERSHUTTER = new ThingTypeUID(BINDING_ID,
155 "adjustableslatsrollershutter");
158 public static final ThingTypeUID THING_TYPE_MYFOX_CAMERA = new ThingTypeUID(BINDING_ID, "myfoxcamera");
161 public static final ThingTypeUID THING_TYPE_THERMOSTAT = new ThingTypeUID(BINDING_ID, "thermostat");
163 // List of all Channel ids
164 public static final String RSSI = "rssi";
167 public static final String STATUS = "status";
168 public static final String SCENARIOS = "scenarios";
170 // Roller shutter, Awning, Screen, Blind, Garage door, Window, Curtain
171 public static final String CONTROL = "control";
173 // Adjustable slats roller shutter
174 public static final String ROCKER = "rocker";
176 // Silent roller shutter
177 public static final String CONTROL_SILENT = "control_silent";
179 // Bioclimatic Pergola
180 public static final String SLATS = "slats";
181 public static final String PERGOLA_COMMAND = "pergola_command";
183 // Blind, Bioclimatic Pergola
184 public static final String ORIENTATION = "orientation";
187 public static final String CLOSURE_AND_ORIENTATION = "closure_orientation";
190 public static final String EXECUTE_ACTION = "execute_action";
193 public static final String SWITCH = "switch";
196 public static final String LIGHT_INTENSITY = "light_intensity";
199 public static final String LOCK = "lock";
200 public static final String OPEN = "open";
202 // Smoke sensor, Occupancy sensor, Contact sensor, Water sensor
203 public static final String CONTACT = "contact";
204 public static final String SENSOR_DEFECT = "sensor_defect";
207 public static final String HUMIDITY = "humidity";
210 public static final String ALARM_CHECK = "alarm_check";
211 public static final String RADIO_BATTERY = "radio_battery";
212 public static final String SENSOR_BATTERY = "sensor_battery";
215 public static final String LUMINANCE = "luminance";
217 // Temperature sensor
218 public static final String TEMPERATURE = "temperature";
221 public static final String ALARM_COMMAND = "alarm_command";
222 public static final String ALARM_STATE = "alarm_state";
223 public static final String TARGET_ALARM_STATE = "target_alarm_state";
224 public static final String INTRUSION_CONTROL = "intrusion_control";
225 public static final String INTRUSION_STATE = "intrusion_state";
228 public static final String CYCLIC_BUTTON = "cyclic_button";
229 public static final String LIGHTING_LED_POD_MODE = "lighting_led_pod_mode";
232 public static final String TARGET_TEMPERATURE = "target_temperature";
233 public static final String CURRENT_TEMPERATURE = "current_temperature";
234 public static final String CURRENT_STATE = "current_state";
235 public static final String BATTERY_LEVEL = "battery_level";
236 public static final String TARGET_HEATING_LEVEL = "target_heating_level";
237 public static final String HEATING_LEVEL = "heating_level";
240 public static final String HEATING_MODE = "heating_mode";
241 public static final String DEROGATION_ACTIVATION = "derogation_activation";
243 // Thermostat & Valve Heating system
244 public static final String DEROGATED_TARGET_TEMPERATURE = "derogated_target_temperature";
245 public static final String DEROGATION_HEATING_MODE = "derogation_heating_mode";
247 // Valve heating system
248 public static final String CURRENT_HEATING_MODE = "current_heating_mode";
249 public static final String OPEN_CLOSED_VALVE = "open_closed_valve";
250 public static final String OPERATING_MODE = "operating_mode";
253 public static final String HANDLE_STATE = "handle_state";
256 public static final String GATE_STATE = "gate_state";
257 public static final String GATE_COMMAND = "gate_command";
258 public static final String GATE_POSITION = "gate_position";
261 public static final String ENERGY_CONSUMPTION = "energy_consumption";
264 public static final String BATTERY_STATUS = "battery_status";
265 public static final String SIREN_STATUS = "siren_status";
266 public static final String SHORT_BIP = "short_beep";
267 public static final String LONG_BIP = "long_beep";
270 public static final String MEMORIZED_VOLUME = "memorized_volume";
271 public static final String ONOFF_STATE = "onoff";
272 public static final String BATTERY = "battery";
275 public static final String MYFOX_ALARM_COMMAND = "myfox_alarm_command";
277 // Myfox Alarm & Camera
278 public static final String CLOUD_STATUS = "cloud_status";
281 public static final String SHUTTER = "shutter";
284 public static final String TAHOMA_PORTAL = "www.tahomalink.com";
285 public static final String API_BASE_URL = "/enduser-mobile-web/enduserAPI/";
286 public static final String EVENTS_URL = "events/";
287 public static final String SETUP_URL = "setup/";
288 public static final String GATEWAYS_URL = SETUP_URL + "gateways/";
289 public static final String DEVICES_URL = SETUP_URL + "devices/";
290 public static final String REFRESH_URL = DEVICES_URL + "states/refresh";
291 public static final String EXEC_URL = "exec/";
292 public static final String DELETE_URL = EXEC_URL + "current/setup/";
293 public static final String TAHOMA_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36";
294 public static final int TAHOMA_TIMEOUT = 5;
295 public static final String UNAUTHORIZED = "Not logged in";
296 public static final int TYPE_NONE = 0;
297 public static final int TYPE_PERCENT = 1;
298 public static final int TYPE_DECIMAL = 2;
299 public static final int TYPE_STRING = 3;
300 public static final int TYPE_BOOLEAN = 6;
301 public static final String UNAVAILABLE = "unavailable";
302 public static final String AUTHENTICATION_CHALLENGE = "HTTP protocol violation: Authentication challenge without WWW-Authenticate header";
303 public static final String TOO_MANY_REQUESTS = "Too many requests, try again later";
304 public static final int SUSPEND_TIME = 120;
305 public static final int RECONCILIATION_TIME = 600;
308 public static final String COMMAND_MY = "my";
309 public static final String COMMAND_SET_CLOSURE = "setClosure";
310 public static final String COMMAND_SET_CLOSURE_ORIENTATION = "setClosureAndOrientation";
311 public static final String COMMAND_SET_DEPLOYMENT = "setDeployment";
312 public static final String COMMAND_SET_ORIENTATION = "setOrientation";
313 public static final String COMMAND_SET_CLOSURESPEED = "setClosureAndLinearSpeed";
314 public static final String COMMAND_SET_HEATINGLEVEL = "setHeatingLevel";
315 public static final String COMMAND_SET_PEDESTRIANPOSITION = "setPedestrianPosition";
316 public static final String COMMAND_SET_ROCKERPOSITION = "setRockerPosition";
317 public static final String COMMAND_SET_DEROGATION = "setDerogation";
318 public static final String COMMAND_UP = "up";
319 public static final String COMMAND_DOWN = "down";
320 public static final String COMMAND_OPEN = "open";
321 public static final String COMMAND_CLOSE = "close";
322 public static final String COMMAND_OPEN_SLATS = "openSlats";
323 public static final String COMMAND_CLOSE_SLATS = "closeSlats";
324 public static final String COMMAND_STOP = "stop";
325 public static final String COMMAND_OFF = "off";
326 public static final String COMMAND_CHECK_TRIGGER = "checkEventTrigger";
329 public static final String NAME_STATE = "core:NameState";
330 public static final String RSSI_LEVEL_STATE = "core:RSSILevelState";
331 public static final String STATUS_STATE = "core:StatusState";
332 public static final String ENERGY_CONSUMPTION_STATE = "core:ElectricEnergyConsumptionState";
333 public static final String CYCLIC_BUTTON_STATE = "core:CyclicButtonState";
334 public static final String BATTERY_STATUS_STATE = "internal:BatteryStatusState";
335 public static final String SLATE_ORIENTATION_STATE = "core:SlateOrientationState";
336 public static final String CLOSURE_OR_ROCKER_STATE = "core:ClosureOrRockerPositionState";
337 public static final String MYFOX_SHUTTER_STATUS_STATE = "myfox:ShutterStatusState";
338 public static final String TARGET_CLOSURE_STATE = "core:TargetClosureState";
339 public static final String WATER_DETECTION_STATE = "core:WaterDetectionState";
340 public static final String CLOUD_DEVICE_STATUS_STATE = "core:CloudDeviceStatusState";
341 public static final String BATTERY_LEVEL_STATE = "core:BatteryLevelState";
342 public static final String SIREN_STATUS_STATE = "internal:SirenStatusState";
343 public static final String TARGET_TEMPERATURE_STATE = "core:TargetTemperatureState";
344 public static final String TARGET_ROOM_TEMPERATURE_STATE = "core:TargetRoomTemperatureState";
345 public static final String SMOKE_STATE = "core:SmokeState";
346 public static final String SENSOR_DEFECT_STATE = "core:SensorDefectState";
347 public static final String RADIO_PART_BATTERY_STATE = "io:MaintenanceRadioPartBatteryState";
348 public static final String SENSOR_PART_BATTERY_STATE = "io:MaintenanceSensorPartBatteryState";
349 public static final String ZWAVE_SET_POINT_TYPE_STATE = "zwave:SetPointTypeState";
351 // supported uiClasses
352 public static final String CLASS_ROLLER_SHUTTER = "RollerShutter";
353 public static final String CLASS_SCREEN = "Screen";
354 public static final String CLASS_VENETIAN_BLIND = "VenetianBlind";
355 public static final String CLASS_EXTERIOR_SCREEN = "ExteriorScreen";
356 public static final String CLASS_EXTERIOR_VENETIAN_BLIND = "ExteriorVenetianBlind";
357 public static final String CLASS_GARAGE_DOOR = "GarageDoor";
358 public static final String CLASS_AWNING = "Awning";
359 public static final String CLASS_ON_OFF = "OnOff";
360 public static final String CLASS_LIGHT = "Light";
361 public static final String CLASS_LIGHT_SENSOR = "LightSensor";
362 public static final String CLASS_SMOKE_SENSOR = "SmokeSensor";
363 public static final String CLASS_CONTACT_SENSOR = "ContactSensor";
364 public static final String CLASS_OCCUPANCY_SENSOR = "OccupancySensor";
365 public static final String CLASS_HUMIDITY_SENSOR = "HumiditySensor";
366 public static final String CLASS_WINDOW = "Window";
367 public static final String CLASS_ALARM = "Alarm";
368 public static final String CLASS_POD = "Pod";
369 public static final String CLASS_HEATING_SYSTEM = "HeatingSystem";
370 public static final String CLASS_EXTERIOR_HEATING_SYSTEM = "ExteriorHeatingSystem";
371 public static final String CLASS_DOOR_LOCK = "DoorLock";
372 public static final String CLASS_PERGOLA = "Pergola";
373 public static final String CLASS_WINDOW_HANDLE = "WindowHandle";
374 public static final String CLASS_TEMPERATURE_SENSOR = "TemperatureSensor";
375 public static final String CLASS_GATE = "Gate";
376 public static final String CLASS_CURTAIN = "Curtain";
377 public static final String CLASS_ELECTRICITY_SENSOR = "ElectricitySensor";
378 public static final String CLASS_DOCK = "Dock";
379 public static final String CLASS_SIREN = "Siren";
380 public static final String CLASS_ADJUSTABLE_SLATS_ROLLER_SHUTTER = "AdjustableSlatsRollerShutter";
381 public static final String CLASS_CAMERA = "Camera";
383 // unsupported uiClasses
384 public static final String THING_PROTOCOL_GATEWAY = "ProtocolGateway";
385 public static final String THING_REMOTE_CONTROLLER = "RemoteController";
386 public static final String THING_NETWORK_COMPONENT = "NetworkComponent";
389 public static final String FAILED_EVENT = "FAILED";
390 public static final String COMPLETED_EVENT = "COMPLETED";
392 // supported thing types for discovery
393 public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = new HashSet<>(Arrays.asList(THING_TYPE_GATEWAY,
394 THING_TYPE_ROLLERSHUTTER, THING_TYPE_ROLLERSHUTTER_SILENT, THING_TYPE_SCREEN, THING_TYPE_VENETIANBLIND,
395 THING_TYPE_EXTERIORSCREEN, THING_TYPE_EXTERIORVENETIANBLIND, THING_TYPE_GARAGEDOOR, THING_TYPE_AWNING,
396 THING_TYPE_ACTIONGROUP, THING_TYPE_ONOFF, THING_TYPE_LIGHT, THING_TYPE_LIGHTSENSOR, THING_TYPE_SMOKESENSOR,
397 THING_TYPE_CONTACTSENSOR, THING_TYPE_OCCUPANCYSENSOR, THING_TYPE_WINDOW, THING_TYPE_INTERNAL_ALARM,
398 THING_TYPE_EXTERNAL_ALARM, THING_TYPE_POD, THING_TYPE_ZWAVE_HEATING_SYSTEM, THING_TYPE_ONOFF_HEATING_SYSTEM,
399 THING_TYPE_DOOR_LOCK, THING_TYPE_PERGOLA, THING_TYPE_WINDOW_HANDLE, THING_TYPE_TEMPERATURESENSOR,
400 THING_TYPE_GATE, THING_TYPE_CURTAIN, THING_TYPE_ELECTRICITYSENSOR, THING_TYPE_DOCK, THING_TYPE_SIREN,
401 THING_TYPE_ADJUSTABLE_SLATS_ROLLERSHUTTER, THING_TYPE_MYFOX_CAMERA, THING_TYPE_ROLLERSHUTTER_UNO,
402 THING_TYPE_WATERSENSOR, THING_TYPE_HUMIDITYSENSOR, THING_TYPE_MYFOX_ALARM, THING_TYPE_THERMOSTAT,
403 THING_TYPE_DIMMER_LIGHT, THING_TYPE_EXTERIOR_HEATING_SYSTEM, THING_TYPE_VALVE_HEATING_SYSTEM,
404 THING_TYPE_BIOCLIMATIC_PERGOLA));
407 public static Map<Integer, String> gatewayTypes = new HashMap<Integer, String>() {
409 put(0, "VIRTUAL_KIZBOX");
412 put(20, "VERISURE_ALARM_SYSTEM");
413 put(21, "KIZBOX_MINI");
414 put(24, "KIZBOX_V2");
415 put(25, "MYFOX_ALARM_SYSTEM");
416 put(27, "KIZBOX_MINI_VMBUS");
417 put(28, "KIZBOX_MINI_IO");
418 put(29, "TAHOMA_V2");
419 put(30, "KIZBOX_V2_3H");
420 put(31, "KIZBOX_V2_2H");
421 put(32, "COZYTOUCH");
422 put(34, "CONNEXOON");
423 put(35, "JSW_CAMERA");
424 put(37, "KIZBOX_MINI_DAUGHTERBOARD");
425 put(38, "KIZBOX_MINI_DAUGHTERBOARD_ZWAVE");
426 put(39, "KIZBOX_MINI_DAUGHTERBOARD_ENOCEAN");
427 put(40, "KIZBOX_MINI_RAILDIN");
428 put(41, "TAHOMA_V2_RTS");
429 put(42, "KIZBOX_MINI_MODBUS");
430 put(43, "KIZBOX_MINI_OVP");
431 put(53, "CONNEXOON_RTS");
432 put(54, "OPENDOORS_LOCK_SYSTEM");
433 put(56, "CONNEXOON_RTS_JAPAN");
434 put(58, "HOME_PROTECT_SYSTEM");
435 put(62, "CONNEXOON_RTS_AUSTRALIA");
436 put(63, "THERMOSTAT_SOMFY_SYSTEM");
437 put(64, "BOX_ULTRA_LOW_COST_RTS");
438 put(65, "SMARTLY_MINI_DAUGHTERBOARD_ZWAVE");
439 put(66, "SMARTLY_MINIBOX_RAILDIN");
440 put(67, "TAHOMA_BEE");
441 put(72, "TAHOMA_RAIL_DIN");