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.enocean.internal;
18 import javax.measure.quantity.Angle;
19 import javax.measure.quantity.Dimensionless;
20 import javax.measure.quantity.ElectricPotential;
21 import javax.measure.quantity.Energy;
22 import javax.measure.quantity.Illuminance;
23 import javax.measure.quantity.Power;
24 import javax.measure.quantity.Speed;
25 import javax.measure.quantity.Temperature;
26 import javax.measure.quantity.Time;
27 import javax.measure.quantity.Volume;
29 import org.eclipse.jdt.annotation.NonNullByDefault;
30 import org.openhab.core.items.ItemUtil;
31 import org.openhab.core.library.CoreItemFactory;
32 import org.openhab.core.library.dimension.VolumetricFlowRate;
33 import org.openhab.core.thing.DefaultSystemChannelTypeProvider;
34 import org.openhab.core.thing.ThingTypeUID;
35 import org.openhab.core.thing.type.ChannelTypeUID;
38 * The {@link EnOceanBinding} class defines common constants, which are
39 * used across the whole binding.
41 * @author Daniel Weber - Initial contribution
44 public class EnOceanBindingConstants {
46 public static final String BINDING_ID = "enocean";
49 public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, "bridge");
51 // List of all Thing Type UIDs
52 public static final ThingTypeUID THING_TYPE_PUSHBUTTON = new ThingTypeUID(BINDING_ID, "pushButton");
53 public static final ThingTypeUID THING_TYPE_ROCKERSWITCH = new ThingTypeUID(BINDING_ID, "rockerSwitch");
54 public static final ThingTypeUID THING_TYPE_CLASSICDEVICE = new ThingTypeUID(BINDING_ID, "classicDevice");
56 public static final ThingTypeUID THING_TYPE_CENTRALCOMMAND = new ThingTypeUID(BINDING_ID, "centralCommand");
57 public static final ThingTypeUID THING_TYPE_ROOMOPERATINGPANEL = new ThingTypeUID(BINDING_ID, "roomOperatingPanel");
58 public static final ThingTypeUID THING_TYPE_MECHANICALHANDLE = new ThingTypeUID(BINDING_ID, "mechanicalHandle");
59 public static final ThingTypeUID THING_TYPE_CONTACT = new ThingTypeUID(BINDING_ID, "contact");
60 public static final ThingTypeUID THING_TYPE_MEASUREMENTSWITCH = new ThingTypeUID(BINDING_ID, "measurementSwitch");
61 public static final ThingTypeUID THING_TYPE_TEMPERATURESENSOR = new ThingTypeUID(BINDING_ID, "temperatureSensor");
62 public static final ThingTypeUID THING_TYPE_TEMPERATUREHUMIDITYSENSOR = new ThingTypeUID(BINDING_ID,
63 "temperatureHumiditySensor");
64 public static final ThingTypeUID THING_TYPE_AUTOMATEDMETERSENSOR = new ThingTypeUID(BINDING_ID,
65 "automatedMeterSensor");
66 public static final ThingTypeUID THING_TYPE_THERMOSTAT = new ThingTypeUID(BINDING_ID, "thermostat");
67 public static final ThingTypeUID THING_TYPE_OCCUPANCYSENSOR = new ThingTypeUID(BINDING_ID, "occupancySensor");
68 public static final ThingTypeUID THING_TYPE_LIGHTTEMPERATUREOCCUPANCYSENSOR = new ThingTypeUID(BINDING_ID,
69 "lightTemperatureOccupancySensor");
70 public static final ThingTypeUID THING_TYPE_LIGHTSENSOR = new ThingTypeUID(BINDING_ID, "lightSensor");
71 public static final ThingTypeUID THING_TYPE_ENVIRONMENTALSENSOR = new ThingTypeUID(BINDING_ID,
72 "environmentalSensor");
73 public static final ThingTypeUID THING_TYPE_GENERICTHING = new ThingTypeUID(BINDING_ID, "genericThing");
74 public static final ThingTypeUID THING_TYPE_ROLLERSHUTTER = new ThingTypeUID(BINDING_ID, "rollershutter");
75 public static final ThingTypeUID THING_TYPE_MULTFUNCTIONSMOKEDETECTOR = new ThingTypeUID(BINDING_ID,
76 "multiFunctionSmokeDetector");
78 public static final ThingTypeUID THING_TYPE_HEATRECOVERYVENTILATION = new ThingTypeUID(BINDING_ID,
79 "heatRecoveryVentilation");
80 public static final ThingTypeUID THING_TYPE_WINDOWSASHHANDLESENSOR = new ThingTypeUID(BINDING_ID,
81 "windowSashHandleSensor");
83 public static final Set<ThingTypeUID> SUPPORTED_DEVICE_THING_TYPES_UIDS = Set.of(THING_TYPE_PUSHBUTTON,
84 THING_TYPE_ROCKERSWITCH, THING_TYPE_CLASSICDEVICE, THING_TYPE_CENTRALCOMMAND, THING_TYPE_ROOMOPERATINGPANEL,
85 THING_TYPE_MECHANICALHANDLE, THING_TYPE_CONTACT, THING_TYPE_MEASUREMENTSWITCH, THING_TYPE_TEMPERATURESENSOR,
86 THING_TYPE_TEMPERATUREHUMIDITYSENSOR, THING_TYPE_GENERICTHING, THING_TYPE_ROLLERSHUTTER,
87 THING_TYPE_OCCUPANCYSENSOR, THING_TYPE_LIGHTTEMPERATUREOCCUPANCYSENSOR, THING_TYPE_LIGHTSENSOR,
88 THING_TYPE_ENVIRONMENTALSENSOR, THING_TYPE_AUTOMATEDMETERSENSOR, THING_TYPE_THERMOSTAT,
89 THING_TYPE_MULTFUNCTIONSMOKEDETECTOR, THING_TYPE_HEATRECOVERYVENTILATION,
90 THING_TYPE_WINDOWSASHHANDLESENSOR);
92 // List of all Channel Type Ids, these type ids are also used as channel ids during dynamic creation of channels
93 // this makes it a lot easier as we do not have to manage a type id and an id, drawback long channel names
94 public static final String CHANNEL_REPEATERMODE = "repeaterMode";
95 public static final String CHANNEL_SETBASEID = "setBaseId";
96 public static final String CHANNEL_GENERAL_SWITCHING = "generalSwitch";
98 public static final String CHANNEL_GENERAL_SWITCHINGA = "generalSwitchA"; // used for D2-01-12 EEP
99 public static final String CHANNEL_GENERAL_SWITCHINGB = "generalSwitchB"; // used for D2-01-12 EEP
101 public static final String CHANNEL_DIMMER = "dimmer";
102 public static final String CHANNEL_ROLLERSHUTTER = "rollershutter";
103 public static final String CHANNEL_ANGLE = "angle";
104 public static final String CHANNEL_TEMPERATURE = "temperature";
105 public static final String CHANNEL_HUMIDITY = "humidity";
106 public static final String CHANNEL_SETPOINT = "setPoint";
107 public static final String CHANNEL_FANSPEEDSTAGE = "fanSpeedStage";
108 public static final String CHANNEL_OCCUPANCY = "occupancy";
109 public static final String CHANNEL_MOTIONDETECTION = "motionDetection";
110 public static final String CHANNEL_VIBRATION = "vibration";
111 public static final String CHANNEL_ILLUMINATION = "illumination";
112 public static final String CHANNEL_ILLUMINATIONWEST = "illuminationWest";
113 public static final String CHANNEL_ILLUMINATIONSOUTHNORTH = "illuminationSouthNorth";
114 public static final String CHANNEL_ILLUMINATIONEAST = "illuminationEast";
115 public static final String CHANNEL_WINDSPEED = "windspeed";
116 public static final String CHANNEL_RAINSTATUS = "rainStatus";
117 public static final String CHANNEL_COUNTER = "counter";
118 public static final String CHANNEL_CURRENTNUMBER = "currentNumber";
119 public static final String CHANNEL_SMOKEDETECTION = "smokeDetection";
120 public static final String CHANNEL_SENSORFAULT = "sensorFault";
121 public static final String CHANNEL_MAINTENANCESTATUS = "maintenanceStatus";
122 public static final String CHANNEL_SENSORANALYSISHUMIDITYRANGE = "saHumidityRange";
123 public static final String CHANNEL_SENSORANALYSISTEMPERATURRANGE = "saTemperatureRange";
124 public static final String CHANNEL_TIMESINCELASTMAINTENANCE = "timeSinceLastMaintenance";
125 public static final String CHANNEL_REMAININGPLT = "remainingPLT";
126 public static final String CHANNEL_HYGROCOMFORTINDEX = "hygroComfortIndex";
127 public static final String CHANNEL_INDOORAIRANALYSIS = "indoorAirAnalysis";
129 public static final String CHANNEL_PUSHBUTTON = "pushButton";
130 public static final String CHANNEL_PUSHBUTTON2 = "pushButton2";
131 public static final String CHANNEL_DOUBLEPRESS = "doublePress";
132 public static final String CHANNEL_LONGPRESS = "longPress";
134 public static final String CHANNEL_ROCKERSWITCH_CHANNELA = "rockerswitchA";
135 public static final String CHANNEL_ROCKERSWITCH_CHANNELB = "rockerswitchB";
136 public static final String CHANNEL_ROCKERSWITCH_ACTION = "rockerSwitchAction";
137 public static final ChannelTypeUID CHANNELTYPE_ROCKERSWITCH_ACTION_UID = new ChannelTypeUID(BINDING_ID,
138 CHANNEL_ROCKERSWITCH_ACTION);
140 public static final String CHANNEL_VIRTUALSWITCHA = "virtualSwitchA";
141 public static final String CHANNEL_VIRTUALROLLERSHUTTERA = "virtualRollershutterA";
142 public static final String CHANNEL_VIRTUALROCKERSWITCHB = "virtualRockerswitchB";
143 public static final String CHANNEL_ROCKERSWITCHLISTENERSWITCH = "rockerswitchListenerSwitch";
144 public static final String CHANNEL_ROCKERSWITCHLISTENERROLLERSHUTTER = "rockerswitchListenerRollershutter";
145 public static final String CHANNEL_ROCKERSWITCHLISTENER_START = "rockerswitchListener";
147 public static final String CHANNEL_WINDOWHANDLESTATE = "windowHandleState";
148 public static final String CHANNEL_WINDOWSASHSTATE = "windowSashState";
149 public static final String CHANNEL_WINDOWCALIBRATIONSTATE = "windowCalibrationState";
150 public static final String CHANNEL_WINDOWCALIBRATIONSTEP = "windowCalibrationStep";
151 public static final String CHANNEL_WINDOWBREACHEVENT = "windowBreachEvent";
152 public static final String CHANNEL_PROTECTIONPLUSEVENT = "protectionPlusEvent";
153 public static final String CHANNEL_VACATIONMODETOGGLEEVENT = "vacationModeToggleEvent";
154 public static final String CHANNEL_CONTACT = "contact";
155 public static final String CHANNEL_TEACHINCMD = "teachInCMD";
156 public static final String CHANNEL_INSTANTPOWER = "instantpower";
157 public static final String CHANNEL_TOTALUSAGE = "totalusage";
158 public static final String CHANNEL_CURRENTFLOW = "currentFlow";
159 public static final String CHANNEL_CUMULATIVEVALUE = "cumulativeValue";
160 public static final String CHANNEL_BATTERY_VOLTAGE = "batteryVoltage";
161 public static final String CHANNEL_ENERGY_STORAGE = "energyStorage";
162 public static final String CHANNEL_BATTERY_LEVEL = "batteryLevel";
163 public static final String CHANNEL_BATTERYLOW = "batteryLow";
165 public static final String CHANNEL_AUTOOFF = "autoOFF";
166 public static final String CHANNEL_DELAYRADIOOFF = "delayRadioOFF";
167 public static final String CHANNEL_EXTERNALINTERFACEMODE = "externalInterfaceMode";
168 public static final String CHANNEL_TWOSTATESWITCH = "twoStateSwitch";
169 public static final String CHANNEL_ECOMODE = "ecoMode";
171 public static final String CHANNEL_RSSI = "rssi";
172 public static final String CHANNEL_REPEATCOUNT = "repeatCount";
173 public static final String CHANNEL_LASTRECEIVED = "lastReceived";
175 public static final String CHANNEL_GENERIC_SWITCH = "genericSwitch";
176 public static final String CHANNEL_GENERIC_ROLLERSHUTTER = "genericRollershutter";
177 public static final String CHANNEL_GENERIC_DIMMER = "genericDimmer";
178 public static final String CHANNEL_GENERIC_NUMBER = "genericNumber";
179 public static final String CHANNEL_GENERIC_STRING = "genericString";
180 public static final String CHANNEL_GENERIC_COLOR = "genericColor";
181 public static final String CHANNEL_GENERIC_TEACHINCMD = "genericTeachInCMD";
183 public static final String CHANNEL_VALVE_POSITION = "valvePosition";
184 public static final String CHANNEL_BUTTON_LOCK = "buttonLock";
185 public static final String CHANNEL_DISPLAY_ORIENTATION = "displayOrientation";
186 public static final String CHANNEL_TEMPERATURE_SETPOINT = "temperatureSetPoint";
187 public static final String CHANNEL_FEED_TEMPERATURE = "feedTemperature";
188 public static final String CHANNEL_MEASUREMENT_CONTROL = "measurementControl";
189 public static final String CHANNEL_FAILURE_CODE = "failureCode";
190 public static final String CHANNEL_WAKEUPCYCLE = "wakeUpCycle";
191 public static final String CHANNEL_SERVICECOMMAND = "serviceCommand";
192 public static final String CHANNEL_STATUS_REQUEST_EVENT = "statusRequestEvent";
193 public static final String VIRTUALCHANNEL_SEND_COMMAND = "sendCommand";
195 public static final String CHANNEL_VENTILATIONOPERATIONMODE = "ventilationOperationMode";
196 public static final String CHANNEL_FIREPLACESAFETYMODE = "fireplaceSafetyMode";
197 public static final String CHANNEL_HEATEXCHANGERBYPASSSTATUS = "heatExchangerBypassStatus";
198 public static final String CHANNEL_SUPPLYAIRFLAPSTATUS = "supplyAirFlapStatus";
199 public static final String CHANNEL_EXHAUSTAIRFLAPSTATUS = "exhaustAirFlapStatus";
200 public static final String CHANNEL_DEFROSTMODE = "defrostMode";
201 public static final String CHANNEL_COOLINGPROTECTIONMODE = "coolingProtectionMode";
202 public static final String CHANNEL_OUTDOORAIRHEATERSTATUS = "outdoorAirHeaterStatus";
203 public static final String CHANNEL_SUPPLYAIRHEATERSTATUS = "supplyAirHeaterStatus";
204 public static final String CHANNEL_DRAINHEATERSTATUS = "drainHeaterStatus";
205 public static final String CHANNEL_TIMEROPERATIONMODE = "timerOperationMode";
206 public static final String CHANNEL_WEEKLYTIMERPROGRAMSTATUS = "weeklyTimerProgramStatus";
207 public static final String CHANNEL_ROOMTEMPERATURECONTROLSTATUS = "roomTemperatureControlStatus";
208 public static final String CHANNEL_AIRQUALITYVALUE1 = "airQualityValue1";
209 public static final String CHANNEL_AIRQUALITYVALUE2 = "airQualityValue2";
210 public static final String CHANNEL_OUTDOORAIRTEMPERATURE = "outdoorAirTemperature";
211 public static final String CHANNEL_SUPPLYAIRTEMPERATURE = "supplyAirTemperature";
212 public static final String CHANNEL_INDOORAIRTEMPERATURE = "indoorAirTemperature";
213 public static final String CHANNEL_EXHAUSTAIRTEMPERATURE = "exhaustAirTemperature";
214 public static final String CHANNEL_SUPPLYAIRFANAIRFLOWRATE = "supplyAirFanAirFlowRate";
215 public static final String CHANNEL_EXHAUSTAIRFANAIRFLOWRATE = "exhaustAirFanAirFlowRate";
216 public static final String CHANNEL_SUPPLYFANSPEED = "supplyFanSpeed";
217 public static final String CHANNEL_EXHAUSTFANSPEED = "exhaustFanSpeed";
219 public static final Map<String, EnOceanChannelDescription> CHANNELID2CHANNELDESCRIPTION = Map.ofEntries(
220 Map.entry(CHANNEL_GENERAL_SWITCHING,
221 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERAL_SWITCHING),
222 CoreItemFactory.SWITCH)),
224 Map.entry(CHANNEL_GENERAL_SWITCHINGA,
225 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERAL_SWITCHINGA),
226 CoreItemFactory.SWITCH)),
227 Map.entry(CHANNEL_GENERAL_SWITCHINGB,
228 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERAL_SWITCHINGB),
229 CoreItemFactory.SWITCH)),
231 Map.entry(CHANNEL_DIMMER,
232 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DIMMER),
233 CoreItemFactory.DIMMER)),
234 Map.entry(CHANNEL_ROLLERSHUTTER,
235 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ROLLERSHUTTER),
236 CoreItemFactory.ROLLERSHUTTER)),
237 Map.entry(CHANNEL_ANGLE,
238 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ANGLE),
239 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Angle.class.getSimpleName())),
240 Map.entry(CHANNEL_TEMPERATURE,
241 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TEMPERATURE),
242 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
243 Map.entry(CHANNEL_HUMIDITY,
244 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_HUMIDITY),
245 CoreItemFactory.NUMBER)),
246 Map.entry(CHANNEL_FANSPEEDSTAGE,
247 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FANSPEEDSTAGE),
248 CoreItemFactory.STRING)),
249 Map.entry(CHANNEL_OCCUPANCY,
250 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_OCCUPANCY),
251 CoreItemFactory.SWITCH)),
252 Map.entry(CHANNEL_MOTIONDETECTION,
253 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_MOTION.getUID(),
254 CoreItemFactory.SWITCH)),
255 Map.entry(CHANNEL_VIBRATION,
256 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIBRATION),
257 CoreItemFactory.SWITCH)),
258 Map.entry(CHANNEL_ILLUMINATION,
259 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATION),
260 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
261 Map.entry(CHANNEL_ILLUMINATIONWEST,
262 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATIONWEST),
263 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
264 Map.entry(CHANNEL_ILLUMINATIONSOUTHNORTH,
265 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATIONSOUTHNORTH),
266 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
267 Map.entry(CHANNEL_ILLUMINATIONEAST,
268 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATIONEAST),
269 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
270 Map.entry(CHANNEL_WINDSPEED,
271 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_WIND_SPEED.getUID(),
272 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Speed.class.getSimpleName())),
273 Map.entry(CHANNEL_RAINSTATUS,
274 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_RAINSTATUS),
275 CoreItemFactory.SWITCH)),
276 Map.entry(CHANNEL_COUNTER,
277 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_COUNTER),
278 CoreItemFactory.NUMBER)),
279 Map.entry(CHANNEL_CURRENTNUMBER,
280 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CURRENTNUMBER),
281 CoreItemFactory.NUMBER)),
282 Map.entry(CHANNEL_SMOKEDETECTION,
283 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SMOKEDETECTION),
284 CoreItemFactory.SWITCH)),
285 Map.entry(CHANNEL_SENSORFAULT,
286 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
287 CoreItemFactory.SWITCH)),
288 Map.entry(CHANNEL_MAINTENANCESTATUS,
289 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
290 CoreItemFactory.SWITCH)),
291 Map.entry(CHANNEL_SENSORANALYSISHUMIDITYRANGE,
292 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
293 CoreItemFactory.SWITCH)),
294 Map.entry(CHANNEL_SENSORANALYSISTEMPERATURRANGE,
295 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
296 CoreItemFactory.SWITCH)),
297 Map.entry(CHANNEL_TIMESINCELASTMAINTENANCE,
298 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TIMESINCELASTMAINTENANCE),
299 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Time.class.getSimpleName())),
300 Map.entry(CHANNEL_REMAININGPLT,
301 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_REMAININGPLT),
302 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Time.class.getSimpleName())),
303 Map.entry(CHANNEL_HYGROCOMFORTINDEX,
304 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_HYGROCOMFORTINDEX),
305 CoreItemFactory.STRING)),
306 Map.entry(CHANNEL_INDOORAIRANALYSIS,
307 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_INDOORAIRANALYSIS),
308 CoreItemFactory.STRING)),
309 Map.entry(CHANNEL_SETPOINT,
310 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SETPOINT),
311 CoreItemFactory.NUMBER)),
312 Map.entry(CHANNEL_CONTACT,
313 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CONTACT),
314 CoreItemFactory.CONTACT)),
315 Map.entry(CHANNEL_WINDOWHANDLESTATE,
316 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWHANDLESTATE),
317 CoreItemFactory.STRING)),
318 Map.entry(CHANNEL_WINDOWSASHSTATE,
319 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWSASHSTATE),
320 CoreItemFactory.STRING)),
321 Map.entry(CHANNEL_WINDOWCALIBRATIONSTATE,
322 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWCALIBRATIONSTATE),
323 CoreItemFactory.STRING)),
324 Map.entry(CHANNEL_WINDOWCALIBRATIONSTEP,
325 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWCALIBRATIONSTEP),
326 CoreItemFactory.STRING)),
328 Map.entry(CHANNEL_WINDOWBREACHEVENT,
329 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWBREACHEVENT), null, null,
331 Map.entry(CHANNEL_PROTECTIONPLUSEVENT,
332 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_PROTECTIONPLUSEVENT), null,
334 Map.entry(CHANNEL_VACATIONMODETOGGLEEVENT,
335 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VACATIONMODETOGGLEEVENT), null,
338 CHANNEL_BATTERY_VOLTAGE,
339 new EnOceanChannelDescription(
340 new ChannelTypeUID(BINDING_ID, CHANNEL_BATTERY_VOLTAGE),
341 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
342 + ElectricPotential.class.getSimpleName())),
343 Map.entry(CHANNEL_ENERGY_STORAGE,
344 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ENERGY_STORAGE),
345 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
346 + ElectricPotential.class.getSimpleName())),
347 Map.entry(CHANNEL_BATTERY_LEVEL, new EnOceanChannelDescription(
348 DefaultSystemChannelTypeProvider.SYSTEM_CHANNEL_BATTERY_LEVEL.getUID(), CoreItemFactory.NUMBER)),
349 Map.entry(CHANNEL_BATTERYLOW,
350 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_CHANNEL_LOW_BATTERY.getUID(),
351 CoreItemFactory.SWITCH)),
352 Map.entry(CHANNEL_TEACHINCMD,
353 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TEACHINCMD),
354 CoreItemFactory.SWITCH)),
356 Map.entry(CHANNEL_PUSHBUTTON,
357 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
358 "Push button", false, true)),
359 Map.entry(CHANNEL_PUSHBUTTON2,
360 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
361 "Push button 2", false, true)),
362 Map.entry(CHANNEL_DOUBLEPRESS,
363 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
364 "Double press", false, true)),
365 Map.entry(CHANNEL_LONGPRESS,
366 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
367 "Long press", false, true)),
369 Map.entry(CHANNEL_ROCKERSWITCH_CHANNELA,
370 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWROCKER.getUID(), null,
371 "Rocker Switch - Channel A", false, false)),
372 Map.entry(CHANNEL_ROCKERSWITCH_CHANNELB,
373 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWROCKER.getUID(), null,
374 "Rocker Switch - Channel B", false, false)),
375 Map.entry(CHANNEL_ROCKERSWITCH_ACTION,
376 new EnOceanChannelDescription(CHANNELTYPE_ROCKERSWITCH_ACTION_UID, null, "Rocker Switch Action",
379 Map.entry(CHANNEL_VIRTUALSWITCHA,
380 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIRTUALSWITCHA),
381 CoreItemFactory.SWITCH, "", true, false)),
382 Map.entry(CHANNEL_VIRTUALROLLERSHUTTERA,
383 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIRTUALROLLERSHUTTERA),
384 CoreItemFactory.ROLLERSHUTTER, "", true, false)),
385 Map.entry(CHANNEL_VIRTUALROCKERSWITCHB,
386 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIRTUALROCKERSWITCHB),
387 CoreItemFactory.STRING, "Rocker Switch - Channel B", true, false)),
388 Map.entry(CHANNEL_ROCKERSWITCHLISTENERSWITCH,
389 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ROCKERSWITCHLISTENERSWITCH),
390 CoreItemFactory.SWITCH, "Rocker Switch Listener (Switch)", true, false)),
391 Map.entry(CHANNEL_ROCKERSWITCHLISTENERROLLERSHUTTER,
392 new EnOceanChannelDescription(
393 new ChannelTypeUID(BINDING_ID, CHANNEL_ROCKERSWITCHLISTENERROLLERSHUTTER),
394 CoreItemFactory.ROLLERSHUTTER, "Rocker Switch Listener (Rollershutter)", true, false)),
396 Map.entry(CHANNEL_INSTANTPOWER,
397 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_INSTANTPOWER),
398 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Power.class.getSimpleName())),
399 Map.entry(CHANNEL_TOTALUSAGE,
400 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TOTALUSAGE),
401 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Energy.class.getSimpleName())),
402 Map.entry(CHANNEL_CURRENTFLOW,
403 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CURRENTFLOW),
404 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
405 + VolumetricFlowRate.class.getSimpleName())),
406 Map.entry(CHANNEL_CUMULATIVEVALUE,
407 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CUMULATIVEVALUE),
408 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Volume.class.getSimpleName())),
409 Map.entry(CHANNEL_AUTOOFF,
410 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_AUTOOFF),
411 CoreItemFactory.NUMBER)),
412 Map.entry(CHANNEL_DELAYRADIOOFF,
413 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DELAYRADIOOFF),
414 CoreItemFactory.NUMBER)),
415 Map.entry(CHANNEL_EXTERNALINTERFACEMODE,
416 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXTERNALINTERFACEMODE),
417 CoreItemFactory.STRING)),
418 Map.entry(CHANNEL_TWOSTATESWITCH,
419 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TWOSTATESWITCH),
420 CoreItemFactory.SWITCH)),
421 Map.entry(CHANNEL_ECOMODE,
422 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ECOMODE),
423 CoreItemFactory.SWITCH)),
425 Map.entry(CHANNEL_RSSI,
426 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_RSSI),
427 CoreItemFactory.NUMBER)),
428 Map.entry(CHANNEL_REPEATCOUNT,
429 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_REPEATCOUNT),
430 CoreItemFactory.NUMBER)),
431 Map.entry(CHANNEL_LASTRECEIVED,
432 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_LASTRECEIVED),
433 CoreItemFactory.DATETIME)),
435 Map.entry(CHANNEL_GENERIC_SWITCH,
436 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_SWITCH),
437 CoreItemFactory.SWITCH)),
438 Map.entry(CHANNEL_GENERIC_ROLLERSHUTTER,
439 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_ROLLERSHUTTER),
440 CoreItemFactory.ROLLERSHUTTER)),
441 Map.entry(CHANNEL_GENERIC_DIMMER,
442 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_DIMMER),
443 CoreItemFactory.DIMMER)),
444 Map.entry(CHANNEL_GENERIC_NUMBER,
445 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_NUMBER),
446 CoreItemFactory.NUMBER)),
447 Map.entry(CHANNEL_GENERIC_STRING,
448 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_STRING),
449 CoreItemFactory.STRING)),
450 Map.entry(CHANNEL_GENERIC_COLOR,
451 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_COLOR),
452 CoreItemFactory.COLOR)),
453 Map.entry(CHANNEL_GENERIC_TEACHINCMD,
454 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_TEACHINCMD),
455 CoreItemFactory.SWITCH)),
457 Map.entry(CHANNEL_VALVE_POSITION,
458 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VALVE_POSITION),
459 CoreItemFactory.NUMBER)),
460 Map.entry(CHANNEL_BUTTON_LOCK,
461 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_BUTTON_LOCK),
462 CoreItemFactory.SWITCH)),
463 Map.entry(CHANNEL_DISPLAY_ORIENTATION,
464 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DISPLAY_ORIENTATION),
465 CoreItemFactory.NUMBER)),
466 Map.entry(CHANNEL_TEMPERATURE_SETPOINT,
467 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TEMPERATURE_SETPOINT),
468 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
469 Map.entry(CHANNEL_FEED_TEMPERATURE,
470 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FEED_TEMPERATURE),
471 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
472 Map.entry(CHANNEL_MEASUREMENT_CONTROL,
473 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_MEASUREMENT_CONTROL),
474 CoreItemFactory.SWITCH)),
475 Map.entry(CHANNEL_FAILURE_CODE,
476 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FAILURE_CODE),
477 CoreItemFactory.NUMBER)),
478 Map.entry(CHANNEL_WAKEUPCYCLE,
479 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WAKEUPCYCLE),
480 CoreItemFactory.NUMBER)),
481 Map.entry(CHANNEL_SERVICECOMMAND,
482 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SERVICECOMMAND),
483 CoreItemFactory.NUMBER)),
485 Map.entry(CHANNEL_VENTILATIONOPERATIONMODE,
486 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VENTILATIONOPERATIONMODE),
487 CoreItemFactory.STRING)),
488 Map.entry(CHANNEL_FIREPLACESAFETYMODE,
489 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FIREPLACESAFETYMODE),
490 CoreItemFactory.SWITCH)),
491 Map.entry(CHANNEL_HEATEXCHANGERBYPASSSTATUS,
492 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_HEATEXCHANGERBYPASSSTATUS),
493 CoreItemFactory.CONTACT)),
494 Map.entry(CHANNEL_SUPPLYAIRFLAPSTATUS,
495 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRFLAPSTATUS),
496 CoreItemFactory.CONTACT)),
497 Map.entry(CHANNEL_EXHAUSTAIRFLAPSTATUS,
498 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTAIRFLAPSTATUS),
499 CoreItemFactory.CONTACT)),
500 Map.entry(CHANNEL_DEFROSTMODE,
501 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DEFROSTMODE),
502 CoreItemFactory.SWITCH)),
503 Map.entry(CHANNEL_COOLINGPROTECTIONMODE,
504 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_COOLINGPROTECTIONMODE),
505 CoreItemFactory.SWITCH)),
506 Map.entry(CHANNEL_OUTDOORAIRHEATERSTATUS,
507 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_OUTDOORAIRHEATERSTATUS),
508 CoreItemFactory.SWITCH)),
509 Map.entry(CHANNEL_SUPPLYAIRHEATERSTATUS,
510 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRHEATERSTATUS),
511 CoreItemFactory.SWITCH)),
512 Map.entry(CHANNEL_DRAINHEATERSTATUS,
513 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DRAINHEATERSTATUS),
514 CoreItemFactory.SWITCH)),
515 Map.entry(CHANNEL_TIMEROPERATIONMODE,
516 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TIMEROPERATIONMODE),
517 CoreItemFactory.SWITCH)),
518 Map.entry(CHANNEL_WEEKLYTIMERPROGRAMSTATUS,
519 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WEEKLYTIMERPROGRAMSTATUS),
520 CoreItemFactory.SWITCH)),
521 Map.entry(CHANNEL_ROOMTEMPERATURECONTROLSTATUS,
522 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ROOMTEMPERATURECONTROLSTATUS),
523 CoreItemFactory.SWITCH)),
524 Map.entry(CHANNEL_AIRQUALITYVALUE1,
525 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_AIRQUALITYVALUE1),
526 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
527 + Dimensionless.class.getSimpleName())),
528 Map.entry(CHANNEL_AIRQUALITYVALUE2,
529 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_AIRQUALITYVALUE2),
530 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
531 + Dimensionless.class.getSimpleName())),
532 Map.entry(CHANNEL_OUTDOORAIRTEMPERATURE,
533 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_OUTDOORAIRTEMPERATURE),
534 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
535 Map.entry(CHANNEL_SUPPLYAIRTEMPERATURE,
536 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRTEMPERATURE),
537 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
538 Map.entry(CHANNEL_INDOORAIRTEMPERATURE,
539 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_INDOORAIRTEMPERATURE),
540 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
541 Map.entry(CHANNEL_EXHAUSTAIRTEMPERATURE,
542 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTAIRTEMPERATURE),
543 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
544 Map.entry(CHANNEL_SUPPLYAIRFANAIRFLOWRATE,
545 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRFANAIRFLOWRATE),
546 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
547 + VolumetricFlowRate.class.getSimpleName())),
548 Map.entry(CHANNEL_EXHAUSTAIRFANAIRFLOWRATE,
549 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTAIRFANAIRFLOWRATE),
550 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
551 + VolumetricFlowRate.class.getSimpleName())),
552 Map.entry(CHANNEL_SUPPLYFANSPEED,
553 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYFANSPEED),
554 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
555 + Dimensionless.class.getSimpleName())),
556 Map.entry(CHANNEL_EXHAUSTFANSPEED,
557 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTFANSPEED),
558 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
559 + Dimensionless.class.getSimpleName())),
561 Map.entry(CHANNEL_STATUS_REQUEST_EVENT,
562 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_STATUS_REQUEST_EVENT), null,
565 Map.entry(CHANNEL_REPEATERMODE, new EnOceanChannelDescription(
566 new ChannelTypeUID(BINDING_ID, CHANNEL_REPEATERMODE), CoreItemFactory.STRING)));
568 // List of all repeater mode states
569 public static final String REPEATERMODE_OFF = "OFF";
570 public static final String REPEATERMODE_LEVEL_1 = "LEVEL1";
571 public static final String REPEATERMODE_LEVEL_2 = "LEVEL2";
573 // Bridge config properties
574 public static final String PATH = "path";
575 public static final String PARAMETER_NEXT_SENDERID = "nextSenderId";
578 public static final String PROPERTY_BASE_ID = "Base ID";
579 public static final String PROPERTY_REMAINING_WRITE_CYCLES_Base_ID = "Remaining Base ID Write Cycles";
580 public static final String PROPERTY_APP_VERSION = "APP Version";
581 public static final String PROPERTY_API_VERSION = "API Version";
582 public static final String PROPERTY_CHIP_ID = "Chip ID";
583 public static final String PROPERTY_DESCRIPTION = "Description";
586 public static final String PROPERTY_SENDINGENOCEAN_ID = "SendingEnoceanId";
588 // Thing config parameter
589 public static final String PARAMETER_SENDERIDOFFSET = "senderIdOffset";
590 public static final String PARAMETER_SENDINGEEPID = "sendingEEPId";
591 public static final String PARAMETER_RECEIVINGEEPID = "receivingEEPId";
593 public static final String PARAMETER_BROADCASTMESSAGES = "broadcastMessages";
594 public static final String PARAMETER_ENOCEANID = "enoceanId";
596 // Channel config parameter
597 public static final String PARAMETER_CHANNEL_TeachInMSG = "teachInMSG";
598 public static final String PARAMETER_CHANNEL_Duration = "duration";
599 public static final String PARAMETER_CHANNEL_SwitchMode = "switchMode";
601 // Manufacturer Ids - used to recognize special EEPs during auto discovery
602 public static final int ELTAKOID = 0x00d;
603 public static final int NODONID = 0x046; // NodOn devices are designed by ID-RF hence use their ID
604 public static final int PERMUNDOID = 0x033;
606 public static final String EMPTYENOCEANID = "00000000";
608 public static final byte ZERO = (byte) 0;