]> git.basschouten.com Git - openhab-addons.git/blob
87345342c01729a3bfca42d65d2eae55ff3cd08b
[openhab-addons.git] /
1 /**
2  * Copyright (c) 2010-2021 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.somfytahoma.internal;
14
15 import java.util.Arrays;
16 import java.util.HashMap;
17 import java.util.HashSet;
18 import java.util.Map;
19 import java.util.Set;
20
21 import org.eclipse.jdt.annotation.NonNullByDefault;
22 import org.openhab.core.thing.ThingTypeUID;
23
24 /**
25  * The {@link SomfyTahomaBindingConstants} class defines common constants, which are
26  * used across the whole binding.
27  *
28  * @author Ondrej Pecta - Initial contribution
29  */
30 @NonNullByDefault
31 public class SomfyTahomaBindingConstants {
32
33     public static final String BINDING_ID = "somfytahoma";
34
35     // Things
36     // Bridge
37     public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, "bridge");
38
39     // Gateway
40     public static final ThingTypeUID THING_TYPE_GATEWAY = new ThingTypeUID(BINDING_ID, "gateway");
41
42     // Roller Shutter
43     public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER = new ThingTypeUID(BINDING_ID, "rollershutter");
44
45     // Silent Roller Shutter
46     public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER_SILENT = new ThingTypeUID(BINDING_ID,
47             "rollershutter_silent");
48
49     // Uno Roller Shutter
50     public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER_UNO = new ThingTypeUID(BINDING_ID, "rollershutter_uno");
51
52     // Screen
53     public static final ThingTypeUID THING_TYPE_SCREEN = new ThingTypeUID(BINDING_ID, "screen");
54
55     // Venetian Blind
56     public static final ThingTypeUID THING_TYPE_VENETIANBLIND = new ThingTypeUID(BINDING_ID, "venetianblind");
57
58     // Exterior Screen
59     public static final ThingTypeUID THING_TYPE_EXTERIORSCREEN = new ThingTypeUID(BINDING_ID, "exteriorscreen");
60
61     // Exterior Venetian Blind
62     public static final ThingTypeUID THING_TYPE_EXTERIORVENETIANBLIND = new ThingTypeUID(BINDING_ID,
63             "exteriorvenetianblind");
64
65     // Garage Door
66     public static final ThingTypeUID THING_TYPE_GARAGEDOOR = new ThingTypeUID(BINDING_ID, "garagedoor");
67
68     // Awning
69     public static final ThingTypeUID THING_TYPE_AWNING = new ThingTypeUID(BINDING_ID, "awning");
70
71     // Actiongroup
72     public static final ThingTypeUID THING_TYPE_ACTIONGROUP = new ThingTypeUID(BINDING_ID, "actiongroup");
73
74     // On Off
75     public static final ThingTypeUID THING_TYPE_ONOFF = new ThingTypeUID(BINDING_ID, "onoff");
76
77     // Light
78     public static final ThingTypeUID THING_TYPE_LIGHT = new ThingTypeUID(BINDING_ID, "light");
79
80     // DimmerLight
81     public static final ThingTypeUID THING_TYPE_DIMMER_LIGHT = new ThingTypeUID(BINDING_ID, "dimmerlight");
82
83     // Light sensor
84     public static final ThingTypeUID THING_TYPE_LIGHTSENSOR = new ThingTypeUID(BINDING_ID, "lightsensor");
85
86     // Smoke sensor
87     public static final ThingTypeUID THING_TYPE_SMOKESENSOR = new ThingTypeUID(BINDING_ID, "smokesensor");
88
89     // Contact sensor
90     public static final ThingTypeUID THING_TYPE_CONTACTSENSOR = new ThingTypeUID(BINDING_ID, "contactsensor");
91
92     // Occupancy sensor
93     public static final ThingTypeUID THING_TYPE_OCCUPANCYSENSOR = new ThingTypeUID(BINDING_ID, "occupancysensor");
94
95     // Water sensor
96     public static final ThingTypeUID THING_TYPE_WATERSENSOR = new ThingTypeUID(BINDING_ID, "watersensor");
97
98     // Humidity sensor
99     public static final ThingTypeUID THING_TYPE_HUMIDITYSENSOR = new ThingTypeUID(BINDING_ID, "humiditysensor");
100
101     // Window
102     public static final ThingTypeUID THING_TYPE_WINDOW = new ThingTypeUID(BINDING_ID, "window");
103
104     // Alarm
105     public static final ThingTypeUID THING_TYPE_INTERNAL_ALARM = new ThingTypeUID(BINDING_ID, "internalalarm");
106     public static final ThingTypeUID THING_TYPE_EXTERNAL_ALARM = new ThingTypeUID(BINDING_ID, "externalalarm");
107     public static final ThingTypeUID THING_TYPE_MYFOX_ALARM = new ThingTypeUID(BINDING_ID, "myfoxalarm");
108
109     // Pod
110     public static final ThingTypeUID THING_TYPE_POD = new ThingTypeUID(BINDING_ID, "pod");
111
112     // Heating system
113     public static final ThingTypeUID THING_TYPE_VALVE_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID,
114             "valveheatingsystem");
115     public static final ThingTypeUID THING_TYPE_ZWAVE_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID, "heatingsystem");
116     public static final ThingTypeUID THING_TYPE_ONOFF_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID,
117             "onoffheatingsystem");
118     public static final ThingTypeUID THING_TYPE_EXTERIOR_HEATING_SYSTEM = new ThingTypeUID(BINDING_ID,
119             "exteriorheatingsystem");
120
121     // Door lock
122     public static final ThingTypeUID THING_TYPE_DOOR_LOCK = new ThingTypeUID(BINDING_ID, "doorlock");
123
124     // Pergola
125     public static final ThingTypeUID THING_TYPE_PERGOLA = new ThingTypeUID(BINDING_ID, "pergola");
126
127     // Window handle
128     public static final ThingTypeUID THING_TYPE_WINDOW_HANDLE = new ThingTypeUID(BINDING_ID, "windowhandle");
129
130     // Temperature sensor
131     public static final ThingTypeUID THING_TYPE_TEMPERATURESENSOR = new ThingTypeUID(BINDING_ID, "temperaturesensor");
132
133     // Gate
134     public static final ThingTypeUID THING_TYPE_GATE = new ThingTypeUID(BINDING_ID, "gate");
135
136     // Curtains
137     public static final ThingTypeUID THING_TYPE_CURTAIN = new ThingTypeUID(BINDING_ID, "curtain");
138
139     // Electricity sensor
140     public static final ThingTypeUID THING_TYPE_ELECTRICITYSENSOR = new ThingTypeUID(BINDING_ID, "electricitysensor");
141
142     // Dock
143     public static final ThingTypeUID THING_TYPE_DOCK = new ThingTypeUID(BINDING_ID, "dock");
144
145     // Siren
146     public static final ThingTypeUID THING_TYPE_SIREN = new ThingTypeUID(BINDING_ID, "siren");
147
148     // Adjustable slats roller shutter
149     public static final ThingTypeUID THING_TYPE_ADJUSTABLE_SLATS_ROLLERSHUTTER = new ThingTypeUID(BINDING_ID,
150             "adjustableslatsrollershutter");
151
152     // MyFox Camera
153     public static final ThingTypeUID THING_TYPE_MYFOX_CAMERA = new ThingTypeUID(BINDING_ID, "myfoxcamera");
154
155     // Thermostat
156     public static final ThingTypeUID THING_TYPE_THERMOSTAT = new ThingTypeUID(BINDING_ID, "thermostat");
157
158     // List of all Channel ids
159     public static final String RSSI = "rssi";
160
161     // Gateway
162     public static final String STATUS = "status";
163     public static final String SCENARIOS = "scenarios";
164
165     // Roller shutter, Awning, Screen, Blind, Garage door, Window, Curtain
166     public static final String CONTROL = "control";
167
168     // Adjustable slats roller shutter
169     public static final String ROCKER = "rocker";
170
171     // Silent roller shutter
172     public static final String CONTROL_SILENT = "control_silent";
173
174     // Blind
175     public static final String ORIENTATION = "orientation";
176     public static final String CLOSURE_AND_ORIENTATION = "closure_orientation";
177
178     // Action group
179     public static final String EXECUTE_ACTION = "execute_action";
180
181     // OnOff, Light
182     public static final String SWITCH = "switch";
183
184     // Dimmer Light
185     public static final String LIGHT_INTENSITY = "light_intensity";
186
187     // Door lock
188     public static final String LOCK = "lock";
189     public static final String OPEN = "open";
190
191     // Smoke sensor, Occupancy sensor, Contact sensor, Water sensor
192     public static final String CONTACT = "contact";
193     public static final String SENSOR_DEFECT = "sensor_defect";
194
195     // Humidity sensor
196     public static final String HUMIDITY = "humidity";
197
198     // Smoke sensor
199     public static final String ALARM_CHECK = "alarm_check";
200     public static final String RADIO_BATTERY = "radio_battery";
201     public static final String SENSOR_BATTERY = "sensor_battery";
202
203     // Light sensor
204     public static final String LUMINANCE = "luminance";
205
206     // Temperature sensor
207     public static final String TEMPERATURE = "temperature";
208
209     // Alarm
210     public static final String ALARM_COMMAND = "alarm_command";
211     public static final String ALARM_STATE = "alarm_state";
212     public static final String TARGET_ALARM_STATE = "target_alarm_state";
213     public static final String INTRUSION_CONTROL = "intrusion_control";
214     public static final String INTRUSION_STATE = "intrusion_state";
215
216     // Pod
217     public static final String CYCLIC_BUTTON = "cyclic_button";
218     public static final String LIGHTING_LED_POD_MODE = "lighting_led_pod_mode";
219
220     // Heating system
221     public static final String TARGET_TEMPERATURE = "target_temperature";
222     public static final String CURRENT_TEMPERATURE = "current_temperature";
223     public static final String CURRENT_STATE = "current_state";
224     public static final String BATTERY_LEVEL = "battery_level";
225     public static final String TARGET_HEATING_LEVEL = "target_heating_level";
226     public static final String HEATING_LEVEL = "heating_level";
227
228     // Thermostat
229     public static final String HEATING_MODE = "heating_mode";
230     public static final String DEROGATION_ACTIVATION = "derogation_activation";
231
232     // Thermostat & Valve Heating system
233     public static final String DEROGATED_TARGET_TEMPERATURE = "derogated_target_temperature";
234     public static final String DEROGATION_HEATING_MODE = "derogation_heating_mode";
235
236     // Valve heating system
237     public static final String CURRENT_HEATING_MODE = "current_heating_mode";
238     public static final String OPEN_CLOSED_VALVE = "open_closed_valve";
239     public static final String OPERATING_MODE = "operating_mode";
240
241     // Window handle
242     public static final String HANDLE_STATE = "handle_state";
243
244     // Gate
245     public static final String GATE_STATE = "gate_state";
246     public static final String GATE_COMMAND = "gate_command";
247     public static final String GATE_POSITION = "gate_position";
248
249     // ElectricitySensor
250     public static final String ENERGY_CONSUMPTION = "energy_consumption";
251
252     // Dock
253     public static final String BATTERY_STATUS = "battery_status";
254     public static final String SIREN_STATUS = "siren_status";
255     public static final String SHORT_BIP = "short_beep";
256     public static final String LONG_BIP = "long_beep";
257
258     // Siren
259     public static final String MEMORIZED_VOLUME = "memorized_volume";
260     public static final String ONOFF_STATE = "onoff";
261     public static final String BATTERY = "battery";
262
263     // Myfox Alarm
264     public static final String MYFOX_ALARM_COMMAND = "myfox_alarm_command";
265
266     // Myfox Alarm & Camera
267     public static final String CLOUD_STATUS = "cloud_status";
268
269     // Myfox Camera
270     public static final String SHUTTER = "shutter";
271
272     // Constants
273     public static final String TAHOMA_API_URL = "https://www.tahomalink.com/enduser-mobile-web/enduserAPI/";
274     public static final String TAHOMA_EVENTS_URL = TAHOMA_API_URL + "events/";
275     public static final String SETUP_URL = TAHOMA_API_URL + "setup/";
276     public static final String GATEWAYS_URL = SETUP_URL + "gateways/";
277     public static final String DEVICES_URL = SETUP_URL + "devices/";
278     public static final String REFRESH_URL = DEVICES_URL + "states/refresh";
279     public static final String EXEC_URL = TAHOMA_API_URL + "exec/";
280     public static final String DELETE_URL = EXEC_URL + "current/setup/";
281     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";
282     public static final int TAHOMA_TIMEOUT = 5;
283     public static final String UNAUTHORIZED = "Not logged in";
284     public static final int TYPE_PERCENT = 1;
285     public static final int TYPE_DECIMAL = 2;
286     public static final int TYPE_STRING = 3;
287     public static final int TYPE_BOOLEAN = 6;
288     public static final String UNAVAILABLE = "unavailable";
289     public static final String AUTHENTICATION_CHALLENGE = "HTTP protocol violation: Authentication challenge without WWW-Authenticate header";
290     public static final String TOO_MANY_REQUESTS = "Too many requests, try again later";
291     public static final int SUSPEND_TIME = 120;
292     public static final int RECONCILIATION_TIME = 600;
293
294     // Commands
295     public static final String COMMAND_MY = "my";
296     public static final String COMMAND_SET_CLOSURE = "setClosure";
297     public static final String COMMAND_SET_CLOSURE_ORIENTATION = "setClosureAndOrientation";
298     public static final String COMMAND_SET_DEPLOYMENT = "setDeployment";
299     public static final String COMMAND_SET_ORIENTATION = "setOrientation";
300     public static final String COMMAND_SET_CLOSURESPEED = "setClosureAndLinearSpeed";
301     public static final String COMMAND_SET_HEATINGLEVEL = "setHeatingLevel";
302     public static final String COMMAND_SET_PEDESTRIANPOSITION = "setPedestrianPosition";
303     public static final String COMMAND_SET_ROCKERPOSITION = "setRockerPosition";
304     public static final String COMMAND_SET_DEROGATION = "setDerogation";
305     public static final String COMMAND_UP = "up";
306     public static final String COMMAND_DOWN = "down";
307     public static final String COMMAND_OPEN = "open";
308     public static final String COMMAND_CLOSE = "close";
309     public static final String COMMAND_STOP = "stop";
310     public static final String COMMAND_OFF = "off";
311     public static final String COMMAND_CHECK_TRIGGER = "checkEventTrigger";
312
313     // States
314     public static final String NAME_STATE = "core:NameState";
315     public static final String RSSI_LEVEL_STATE = "core:RSSILevelState";
316     public static final String STATUS_STATE = "core:StatusState";
317     public static final String ENERGY_CONSUMPTION_STATE = "core:ElectricEnergyConsumptionState";
318     public static final String CYCLIC_BUTTON_STATE = "core:CyclicButtonState";
319     public static final String BATTERY_STATUS_STATE = "internal:BatteryStatusState";
320     public static final String SLATE_ORIENTATION_STATE = "core:SlateOrientationState";
321     public static final String CLOSURE_OR_ROCKER_STATE = "core:ClosureOrRockerPositionState";
322     public static final String MYFOX_SHUTTER_STATUS_STATE = "myfox:ShutterStatusState";
323     public static final String TARGET_CLOSURE_STATE = "core:TargetClosureState";
324     public static final String WATER_DETECTION_STATE = "core:WaterDetectionState";
325     public static final String CLOUD_DEVICE_STATUS_STATE = "core:CloudDeviceStatusState";
326     public static final String BATTERY_LEVEL_STATE = "core:BatteryLevelState";
327     public static final String SIREN_STATUS_STATE = "internal:SirenStatusState";
328     public static final String TARGET_TEMPERATURE_STATE = "core:TargetTemperatureState";
329     public static final String TARGET_ROOM_TEMPERATURE_STATE = "core:TargetRoomTemperatureState";
330     public static final String SMOKE_STATE = "core:SmokeState";
331     public static final String SENSOR_DEFECT_STATE = "core:SensorDefectState";
332     public static final String RADIO_PART_BATTERY_STATE = "io:MaintenanceRadioPartBatteryState";
333     public static final String SENSOR_PART_BATTERY_STATE = "io:MaintenanceSensorPartBatteryState";
334     public static final String ZWAVE_SET_POINT_TYPE_STATE = "zwave:SetPointTypeState";
335
336     // supported uiClasses
337     public static final String CLASS_ROLLER_SHUTTER = "RollerShutter";
338     public static final String CLASS_SCREEN = "Screen";
339     public static final String CLASS_VENETIAN_BLIND = "VenetianBlind";
340     public static final String CLASS_EXTERIOR_SCREEN = "ExteriorScreen";
341     public static final String CLASS_EXTERIOR_VENETIAN_BLIND = "ExteriorVenetianBlind";
342     public static final String CLASS_GARAGE_DOOR = "GarageDoor";
343     public static final String CLASS_AWNING = "Awning";
344     public static final String CLASS_ON_OFF = "OnOff";
345     public static final String CLASS_LIGHT = "Light";
346     public static final String CLASS_LIGHT_SENSOR = "LightSensor";
347     public static final String CLASS_SMOKE_SENSOR = "SmokeSensor";
348     public static final String CLASS_CONTACT_SENSOR = "ContactSensor";
349     public static final String CLASS_OCCUPANCY_SENSOR = "OccupancySensor";
350     public static final String CLASS_HUMIDITY_SENSOR = "HumiditySensor";
351     public static final String CLASS_WINDOW = "Window";
352     public static final String CLASS_ALARM = "Alarm";
353     public static final String CLASS_POD = "Pod";
354     public static final String CLASS_HEATING_SYSTEM = "HeatingSystem";
355     public static final String CLASS_EXTERIOR_HEATING_SYSTEM = "ExteriorHeatingSystem";
356     public static final String CLASS_DOOR_LOCK = "DoorLock";
357     public static final String CLASS_PERGOLA = "Pergola";
358     public static final String CLASS_WINDOW_HANDLE = "WindowHandle";
359     public static final String CLASS_TEMPERATURE_SENSOR = "TemperatureSensor";
360     public static final String CLASS_GATE = "Gate";
361     public static final String CLASS_CURTAIN = "Curtain";
362     public static final String CLASS_ELECTRICITY_SENSOR = "ElectricitySensor";
363     public static final String CLASS_DOCK = "Dock";
364     public static final String CLASS_SIREN = "Siren";
365     public static final String CLASS_ADJUSTABLE_SLATS_ROLLER_SHUTTER = "AdjustableSlatsRollerShutter";
366     public static final String CLASS_CAMERA = "Camera";
367
368     // unsupported uiClasses
369     public static final String THING_PROTOCOL_GATEWAY = "ProtocolGateway";
370     public static final String THING_REMOTE_CONTROLLER = "RemoteController";
371     public static final String THING_NETWORK_COMPONENT = "NetworkComponent";
372
373     // Event states
374     public static final String FAILED_EVENT = "FAILED";
375     public static final String COMPLETED_EVENT = "COMPLETED";
376
377     // supported thing types for discovery
378     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = new HashSet<>(Arrays.asList(THING_TYPE_GATEWAY,
379             THING_TYPE_ROLLERSHUTTER, THING_TYPE_ROLLERSHUTTER_SILENT, THING_TYPE_SCREEN, THING_TYPE_VENETIANBLIND,
380             THING_TYPE_EXTERIORSCREEN, THING_TYPE_EXTERIORVENETIANBLIND, THING_TYPE_GARAGEDOOR, THING_TYPE_AWNING,
381             THING_TYPE_ACTIONGROUP, THING_TYPE_ONOFF, THING_TYPE_LIGHT, THING_TYPE_LIGHTSENSOR, THING_TYPE_SMOKESENSOR,
382             THING_TYPE_CONTACTSENSOR, THING_TYPE_OCCUPANCYSENSOR, THING_TYPE_WINDOW, THING_TYPE_INTERNAL_ALARM,
383             THING_TYPE_EXTERNAL_ALARM, THING_TYPE_POD, THING_TYPE_ZWAVE_HEATING_SYSTEM, THING_TYPE_ONOFF_HEATING_SYSTEM,
384             THING_TYPE_DOOR_LOCK, THING_TYPE_PERGOLA, THING_TYPE_WINDOW_HANDLE, THING_TYPE_TEMPERATURESENSOR,
385             THING_TYPE_GATE, THING_TYPE_CURTAIN, THING_TYPE_ELECTRICITYSENSOR, THING_TYPE_DOCK, THING_TYPE_SIREN,
386             THING_TYPE_ADJUSTABLE_SLATS_ROLLERSHUTTER, THING_TYPE_MYFOX_CAMERA, THING_TYPE_ROLLERSHUTTER_UNO,
387             THING_TYPE_WATERSENSOR, THING_TYPE_HUMIDITYSENSOR, THING_TYPE_MYFOX_ALARM, THING_TYPE_THERMOSTAT,
388             THING_TYPE_DIMMER_LIGHT, THING_TYPE_EXTERIOR_HEATING_SYSTEM, THING_TYPE_VALVE_HEATING_SYSTEM));
389
390     // somfy gateways
391     public static Map<Integer, String> gatewayTypes = new HashMap<Integer, String>() {
392         {
393             put(0, "VIRTUAL_KIZBOX");
394             put(2, "KIZBOX_V1");
395             put(15, "TAHOMA");
396             put(20, "VERISURE_ALARM_SYSTEM");
397             put(21, "KIZBOX_MINI");
398             put(24, "KIZBOX_V2");
399             put(25, "MYFOX_ALARM_SYSTEM");
400             put(27, "KIZBOX_MINI_VMBUS");
401             put(28, "KIZBOX_MINI_IO");
402             put(29, "TAHOMA_V2");
403             put(30, "KIZBOX_V2_3H");
404             put(31, "KIZBOX_V2_2H");
405             put(34, "CONNEXOON");
406             put(35, "JSW_CAMERA");
407             put(37, "KIZBOX_MINI_DAUGHTERBOARD");
408             put(38, "KIZBOX_MINI_DAUGHTERBOARD_ZWAVE");
409             put(39, "KIZBOX_MINI_DAUGHTERBOARD_ENOCEAN");
410             put(40, "KIZBOX_MINI_RAILDIN");
411             put(41, "TAHOMA_V2_RTS");
412             put(42, "KIZBOX_MINI_MODBUS");
413             put(43, "KIZBOX_MINI_OVP");
414             put(53, "CONNEXOON_RTS");
415             put(54, "OPENDOORS_LOCK_SYSTEM");
416             put(56, "CONNEXOON_RTS_JAPAN");
417             put(58, "HOME_PROTECT_SYSTEM");
418             put(62, "CONNEXOON_RTS_AUSTRALIA");
419             put(63, "THERMOSTAT_SOMFY_SYSTEM");
420             put(64, "BOX_ULTRA_LOW_COST_RTS");
421             put(65, "SMARTLY_MINI_DAUGHTERBOARD_ZWAVE");
422             put(66, "SMARTLY_MINIBOX_RAILDIN");
423             put(67, "TAHOMA_BEE");
424             put(72, "TAHOMA_RAIL_DIN");
425             put(77, "ELIOT");
426             put(88, "WISER");
427         }
428     };
429 }