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.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_DOUBLEPRESS = "doublePress";
131 public static final String CHANNEL_LONGPRESS = "longPress";
133 public static final String CHANNEL_ROCKERSWITCH_CHANNELA = "rockerswitchA";
134 public static final String CHANNEL_ROCKERSWITCH_CHANNELB = "rockerswitchB";
136 public static final String CHANNEL_VIRTUALSWITCHA = "virtualSwitchA";
137 public static final String CHANNEL_VIRTUALROLLERSHUTTERA = "virtualRollershutterA";
138 public static final String CHANNEL_VIRTUALROCKERSWITCHB = "virtualRockerswitchB";
139 public static final String CHANNEL_ROCKERSWITCHLISTENERSWITCH = "rockerswitchListenerSwitch";
140 public static final String CHANNEL_ROCKERSWITCHLISTENERROLLERSHUTTER = "rockerswitchListenerRollershutter";
141 public static final String CHANNEL_ROCKERSWITCHLISTENER_START = "rockerswitchListener";
143 public static final String CHANNEL_WINDOWHANDLESTATE = "windowHandleState";
144 public static final String CHANNEL_WINDOWSASHSTATE = "windowSashState";
145 public static final String CHANNEL_WINDOWCALIBRATIONSTATE = "windowCalibrationState";
146 public static final String CHANNEL_WINDOWCALIBRATIONSTEP = "windowCalibrationStep";
147 public static final String CHANNEL_WINDOWBREACHEVENT = "windowBreachEvent";
148 public static final String CHANNEL_CONTACT = "contact";
149 public static final String CHANNEL_TEACHINCMD = "teachInCMD";
150 public static final String CHANNEL_INSTANTPOWER = "instantpower";
151 public static final String CHANNEL_TOTALUSAGE = "totalusage";
152 public static final String CHANNEL_CURRENTFLOW = "currentFlow";
153 public static final String CHANNEL_CUMULATIVEVALUE = "cumulativeValue";
154 public static final String CHANNEL_BATTERY_VOLTAGE = "batteryVoltage";
155 public static final String CHANNEL_ENERGY_STORAGE = "energyStorage";
156 public static final String CHANNEL_BATTERY_LEVEL = "batteryLevel";
157 public static final String CHANNEL_BATTERYLOW = "batteryLow";
159 public static final String CHANNEL_AUTOOFF = "autoOFF";
160 public static final String CHANNEL_DELAYRADIOOFF = "delayRadioOFF";
161 public static final String CHANNEL_EXTERNALINTERFACEMODE = "externalInterfaceMode";
162 public static final String CHANNEL_TWOSTATESWITCH = "twoStateSwitch";
163 public static final String CHANNEL_ECOMODE = "ecoMode";
165 public static final String CHANNEL_RSSI = "rssi";
166 public static final String CHANNEL_REPEATCOUNT = "repeatCount";
167 public static final String CHANNEL_LASTRECEIVED = "lastReceived";
169 public static final String CHANNEL_GENERIC_SWITCH = "genericSwitch";
170 public static final String CHANNEL_GENERIC_ROLLERSHUTTER = "genericRollershutter";
171 public static final String CHANNEL_GENERIC_DIMMER = "genericDimmer";
172 public static final String CHANNEL_GENERIC_NUMBER = "genericNumber";
173 public static final String CHANNEL_GENERIC_STRING = "genericString";
174 public static final String CHANNEL_GENERIC_COLOR = "genericColor";
175 public static final String CHANNEL_GENERIC_TEACHINCMD = "genericTeachInCMD";
177 public static final String CHANNEL_VALVE_POSITION = "valvePosition";
178 public static final String CHANNEL_BUTTON_LOCK = "buttonLock";
179 public static final String CHANNEL_DISPLAY_ORIENTATION = "displayOrientation";
180 public static final String CHANNEL_TEMPERATURE_SETPOINT = "temperatureSetPoint";
181 public static final String CHANNEL_FEED_TEMPERATURE = "feedTemperature";
182 public static final String CHANNEL_MEASUREMENT_CONTROL = "measurementControl";
183 public static final String CHANNEL_FAILURE_CODE = "failureCode";
184 public static final String CHANNEL_WAKEUPCYCLE = "wakeUpCycle";
185 public static final String CHANNEL_SERVICECOMMAND = "serviceCommand";
186 public static final String CHANNEL_STATUS_REQUEST_EVENT = "statusRequestEvent";
187 public static final String VIRTUALCHANNEL_SEND_COMMAND = "sendCommand";
189 public static final String CHANNEL_VENTILATIONOPERATIONMODE = "ventilationOperationMode";
190 public static final String CHANNEL_FIREPLACESAFETYMODE = "fireplaceSafetyMode";
191 public static final String CHANNEL_HEATEXCHANGERBYPASSSTATUS = "heatExchangerBypassStatus";
192 public static final String CHANNEL_SUPPLYAIRFLAPSTATUS = "supplyAirFlapStatus";
193 public static final String CHANNEL_EXHAUSTAIRFLAPSTATUS = "exhaustAirFlapStatus";
194 public static final String CHANNEL_DEFROSTMODE = "defrostMode";
195 public static final String CHANNEL_COOLINGPROTECTIONMODE = "coolingProtectionMode";
196 public static final String CHANNEL_OUTDOORAIRHEATERSTATUS = "outdoorAirHeaterStatus";
197 public static final String CHANNEL_SUPPLYAIRHEATERSTATUS = "supplyAirHeaterStatus";
198 public static final String CHANNEL_DRAINHEATERSTATUS = "drainHeaterStatus";
199 public static final String CHANNEL_TIMEROPERATIONMODE = "timerOperationMode";
200 public static final String CHANNEL_WEEKLYTIMERPROGRAMSTATUS = "weeklyTimerProgramStatus";
201 public static final String CHANNEL_ROOMTEMPERATURECONTROLSTATUS = "roomTemperatureControlStatus";
202 public static final String CHANNEL_AIRQUALITYVALUE1 = "airQualityValue1";
203 public static final String CHANNEL_AIRQUALITYVALUE2 = "airQualityValue2";
204 public static final String CHANNEL_OUTDOORAIRTEMPERATURE = "outdoorAirTemperature";
205 public static final String CHANNEL_SUPPLYAIRTEMPERATURE = "supplyAirTemperature";
206 public static final String CHANNEL_INDOORAIRTEMPERATURE = "indoorAirTemperature";
207 public static final String CHANNEL_EXHAUSTAIRTEMPERATURE = "exhaustAirTemperature";
208 public static final String CHANNEL_SUPPLYAIRFANAIRFLOWRATE = "supplyAirFanAirFlowRate";
209 public static final String CHANNEL_EXHAUSTAIRFANAIRFLOWRATE = "exhaustAirFanAirFlowRate";
210 public static final String CHANNEL_SUPPLYFANSPEED = "supplyFanSpeed";
211 public static final String CHANNEL_EXHAUSTFANSPEED = "exhaustFanSpeed";
213 public static final Map<String, EnOceanChannelDescription> CHANNELID2CHANNELDESCRIPTION = Map.ofEntries(
214 Map.entry(CHANNEL_GENERAL_SWITCHING,
215 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERAL_SWITCHING),
216 CoreItemFactory.SWITCH)),
218 Map.entry(CHANNEL_GENERAL_SWITCHINGA,
219 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERAL_SWITCHINGA),
220 CoreItemFactory.SWITCH)),
221 Map.entry(CHANNEL_GENERAL_SWITCHINGB,
222 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERAL_SWITCHINGB),
223 CoreItemFactory.SWITCH)),
225 Map.entry(CHANNEL_DIMMER,
226 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DIMMER),
227 CoreItemFactory.DIMMER)),
228 Map.entry(CHANNEL_ROLLERSHUTTER,
229 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ROLLERSHUTTER),
230 CoreItemFactory.ROLLERSHUTTER)),
231 Map.entry(CHANNEL_ANGLE,
232 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ANGLE),
233 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Angle.class.getSimpleName())),
234 Map.entry(CHANNEL_TEMPERATURE,
235 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TEMPERATURE),
236 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
237 Map.entry(CHANNEL_HUMIDITY,
238 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_HUMIDITY),
239 CoreItemFactory.NUMBER)),
240 Map.entry(CHANNEL_FANSPEEDSTAGE,
241 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FANSPEEDSTAGE),
242 CoreItemFactory.STRING)),
243 Map.entry(CHANNEL_OCCUPANCY,
244 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_OCCUPANCY),
245 CoreItemFactory.SWITCH)),
246 Map.entry(CHANNEL_MOTIONDETECTION,
247 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_MOTION.getUID(),
248 CoreItemFactory.SWITCH)),
249 Map.entry(CHANNEL_VIBRATION,
250 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIBRATION),
251 CoreItemFactory.SWITCH)),
252 Map.entry(CHANNEL_ILLUMINATION,
253 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATION),
254 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
255 Map.entry(CHANNEL_ILLUMINATIONWEST,
256 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATIONWEST),
257 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
258 Map.entry(CHANNEL_ILLUMINATIONSOUTHNORTH,
259 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATIONSOUTHNORTH),
260 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
261 Map.entry(CHANNEL_ILLUMINATIONEAST,
262 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ILLUMINATIONEAST),
263 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Illuminance.class.getSimpleName())),
264 Map.entry(CHANNEL_WINDSPEED,
265 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_WIND_SPEED.getUID(),
266 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Speed.class.getSimpleName())),
267 Map.entry(CHANNEL_RAINSTATUS,
268 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_RAINSTATUS),
269 CoreItemFactory.SWITCH)),
270 Map.entry(CHANNEL_COUNTER,
271 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_COUNTER),
272 CoreItemFactory.NUMBER)),
273 Map.entry(CHANNEL_CURRENTNUMBER,
274 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CURRENTNUMBER),
275 CoreItemFactory.NUMBER)),
276 Map.entry(CHANNEL_SMOKEDETECTION,
277 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SMOKEDETECTION),
278 CoreItemFactory.SWITCH)),
279 Map.entry(CHANNEL_SENSORFAULT,
280 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
281 CoreItemFactory.SWITCH)),
282 Map.entry(CHANNEL_MAINTENANCESTATUS,
283 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
284 CoreItemFactory.SWITCH)),
285 Map.entry(CHANNEL_SENSORANALYSISHUMIDITYRANGE,
286 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
287 CoreItemFactory.SWITCH)),
288 Map.entry(CHANNEL_SENSORANALYSISTEMPERATURRANGE,
289 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SENSORFAULT),
290 CoreItemFactory.SWITCH)),
291 Map.entry(CHANNEL_TIMESINCELASTMAINTENANCE,
292 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TIMESINCELASTMAINTENANCE),
293 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Time.class.getSimpleName())),
294 Map.entry(CHANNEL_REMAININGPLT,
295 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_REMAININGPLT),
296 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Time.class.getSimpleName())),
297 Map.entry(CHANNEL_HYGROCOMFORTINDEX,
298 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_HYGROCOMFORTINDEX),
299 CoreItemFactory.STRING)),
300 Map.entry(CHANNEL_INDOORAIRANALYSIS,
301 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_INDOORAIRANALYSIS),
302 CoreItemFactory.STRING)),
303 Map.entry(CHANNEL_SETPOINT,
304 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SETPOINT),
305 CoreItemFactory.NUMBER)),
306 Map.entry(CHANNEL_CONTACT,
307 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CONTACT),
308 CoreItemFactory.CONTACT)),
309 Map.entry(CHANNEL_WINDOWHANDLESTATE,
310 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWHANDLESTATE),
311 CoreItemFactory.STRING)),
312 Map.entry(CHANNEL_WINDOWSASHSTATE,
313 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWSASHSTATE),
314 CoreItemFactory.STRING)),
315 Map.entry(CHANNEL_WINDOWCALIBRATIONSTATE,
316 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWCALIBRATIONSTATE),
317 CoreItemFactory.STRING)),
318 Map.entry(CHANNEL_WINDOWCALIBRATIONSTEP,
319 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWCALIBRATIONSTEP),
320 CoreItemFactory.STRING)),
322 Map.entry(CHANNEL_WINDOWBREACHEVENT,
323 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WINDOWBREACHEVENT), null, null,
326 CHANNEL_BATTERY_VOLTAGE,
327 new EnOceanChannelDescription(
328 new ChannelTypeUID(BINDING_ID, CHANNEL_BATTERY_VOLTAGE),
329 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
330 + ElectricPotential.class.getSimpleName())),
331 Map.entry(CHANNEL_ENERGY_STORAGE,
332 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ENERGY_STORAGE),
333 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
334 + ElectricPotential.class.getSimpleName())),
335 Map.entry(CHANNEL_BATTERY_LEVEL, new EnOceanChannelDescription(
336 DefaultSystemChannelTypeProvider.SYSTEM_CHANNEL_BATTERY_LEVEL.getUID(), CoreItemFactory.NUMBER)),
337 Map.entry(CHANNEL_BATTERYLOW,
338 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_CHANNEL_LOW_BATTERY.getUID(),
339 CoreItemFactory.SWITCH)),
340 Map.entry(CHANNEL_TEACHINCMD,
341 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TEACHINCMD),
342 CoreItemFactory.SWITCH)),
344 Map.entry(CHANNEL_PUSHBUTTON,
345 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
346 "Push button", false, true)),
347 Map.entry(CHANNEL_DOUBLEPRESS,
348 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
349 "Double press", false, true)),
350 Map.entry(CHANNEL_LONGPRESS,
351 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWBUTTON.getUID(), null,
352 "Long press", false, true)),
354 Map.entry(CHANNEL_ROCKERSWITCH_CHANNELA,
355 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWROCKER.getUID(), null,
356 "Rocker Switch - Channel A", false, false)),
357 Map.entry(CHANNEL_ROCKERSWITCH_CHANNELB,
358 new EnOceanChannelDescription(DefaultSystemChannelTypeProvider.SYSTEM_RAWROCKER.getUID(), null,
359 "Rocker Switch - Channel B", false, false)),
361 Map.entry(CHANNEL_VIRTUALSWITCHA,
362 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIRTUALSWITCHA),
363 CoreItemFactory.SWITCH, "", true, false)),
364 Map.entry(CHANNEL_VIRTUALROLLERSHUTTERA,
365 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIRTUALROLLERSHUTTERA),
366 CoreItemFactory.ROLLERSHUTTER, "", true, false)),
367 Map.entry(CHANNEL_VIRTUALROCKERSWITCHB,
368 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VIRTUALROCKERSWITCHB),
369 CoreItemFactory.STRING, "Rocker Switch - Channel B", true, false)),
370 Map.entry(CHANNEL_ROCKERSWITCHLISTENERSWITCH,
371 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ROCKERSWITCHLISTENERSWITCH),
372 CoreItemFactory.SWITCH, "Rocker Switch Listener (Switch)", true, false)),
373 Map.entry(CHANNEL_ROCKERSWITCHLISTENERROLLERSHUTTER,
374 new EnOceanChannelDescription(
375 new ChannelTypeUID(BINDING_ID, CHANNEL_ROCKERSWITCHLISTENERROLLERSHUTTER),
376 CoreItemFactory.ROLLERSHUTTER, "Rocker Switch Listener (Rollershutter)", true, false)),
378 Map.entry(CHANNEL_INSTANTPOWER,
379 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_INSTANTPOWER),
380 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Power.class.getSimpleName())),
381 Map.entry(CHANNEL_TOTALUSAGE,
382 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TOTALUSAGE),
383 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Energy.class.getSimpleName())),
384 Map.entry(CHANNEL_CURRENTFLOW,
385 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CURRENTFLOW),
386 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
387 + VolumetricFlowRate.class.getSimpleName())),
388 Map.entry(CHANNEL_CUMULATIVEVALUE,
389 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_CUMULATIVEVALUE),
390 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Volume.class.getSimpleName())),
391 Map.entry(CHANNEL_AUTOOFF,
392 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_AUTOOFF),
393 CoreItemFactory.NUMBER)),
394 Map.entry(CHANNEL_DELAYRADIOOFF,
395 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DELAYRADIOOFF),
396 CoreItemFactory.NUMBER)),
397 Map.entry(CHANNEL_EXTERNALINTERFACEMODE,
398 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXTERNALINTERFACEMODE),
399 CoreItemFactory.STRING)),
400 Map.entry(CHANNEL_TWOSTATESWITCH,
401 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TWOSTATESWITCH),
402 CoreItemFactory.SWITCH)),
403 Map.entry(CHANNEL_ECOMODE,
404 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ECOMODE),
405 CoreItemFactory.SWITCH)),
407 Map.entry(CHANNEL_RSSI,
408 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_RSSI),
409 CoreItemFactory.NUMBER)),
410 Map.entry(CHANNEL_REPEATCOUNT,
411 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_REPEATCOUNT),
412 CoreItemFactory.NUMBER)),
413 Map.entry(CHANNEL_LASTRECEIVED,
414 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_LASTRECEIVED),
415 CoreItemFactory.DATETIME)),
417 Map.entry(CHANNEL_GENERIC_SWITCH,
418 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_SWITCH),
419 CoreItemFactory.SWITCH)),
420 Map.entry(CHANNEL_GENERIC_ROLLERSHUTTER,
421 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_ROLLERSHUTTER),
422 CoreItemFactory.ROLLERSHUTTER)),
423 Map.entry(CHANNEL_GENERIC_DIMMER,
424 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_DIMMER),
425 CoreItemFactory.DIMMER)),
426 Map.entry(CHANNEL_GENERIC_NUMBER,
427 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_NUMBER),
428 CoreItemFactory.NUMBER)),
429 Map.entry(CHANNEL_GENERIC_STRING,
430 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_STRING),
431 CoreItemFactory.STRING)),
432 Map.entry(CHANNEL_GENERIC_COLOR,
433 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_COLOR),
434 CoreItemFactory.COLOR)),
435 Map.entry(CHANNEL_GENERIC_TEACHINCMD,
436 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_GENERIC_TEACHINCMD),
437 CoreItemFactory.SWITCH)),
439 Map.entry(CHANNEL_VALVE_POSITION,
440 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VALVE_POSITION),
441 CoreItemFactory.NUMBER)),
442 Map.entry(CHANNEL_BUTTON_LOCK,
443 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_BUTTON_LOCK),
444 CoreItemFactory.SWITCH)),
445 Map.entry(CHANNEL_DISPLAY_ORIENTATION,
446 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DISPLAY_ORIENTATION),
447 CoreItemFactory.NUMBER)),
448 Map.entry(CHANNEL_TEMPERATURE_SETPOINT,
449 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TEMPERATURE_SETPOINT),
450 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
451 Map.entry(CHANNEL_FEED_TEMPERATURE,
452 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FEED_TEMPERATURE),
453 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
454 Map.entry(CHANNEL_MEASUREMENT_CONTROL,
455 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_MEASUREMENT_CONTROL),
456 CoreItemFactory.SWITCH)),
457 Map.entry(CHANNEL_FAILURE_CODE,
458 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FAILURE_CODE),
459 CoreItemFactory.NUMBER)),
460 Map.entry(CHANNEL_WAKEUPCYCLE,
461 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WAKEUPCYCLE),
462 CoreItemFactory.NUMBER)),
463 Map.entry(CHANNEL_SERVICECOMMAND,
464 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SERVICECOMMAND),
465 CoreItemFactory.NUMBER)),
467 Map.entry(CHANNEL_VENTILATIONOPERATIONMODE,
468 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_VENTILATIONOPERATIONMODE),
469 CoreItemFactory.STRING)),
470 Map.entry(CHANNEL_FIREPLACESAFETYMODE,
471 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_FIREPLACESAFETYMODE),
472 CoreItemFactory.SWITCH)),
473 Map.entry(CHANNEL_HEATEXCHANGERBYPASSSTATUS,
474 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_HEATEXCHANGERBYPASSSTATUS),
475 CoreItemFactory.CONTACT)),
476 Map.entry(CHANNEL_SUPPLYAIRFLAPSTATUS,
477 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRFLAPSTATUS),
478 CoreItemFactory.CONTACT)),
479 Map.entry(CHANNEL_EXHAUSTAIRFLAPSTATUS,
480 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTAIRFLAPSTATUS),
481 CoreItemFactory.CONTACT)),
482 Map.entry(CHANNEL_DEFROSTMODE,
483 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DEFROSTMODE),
484 CoreItemFactory.SWITCH)),
485 Map.entry(CHANNEL_COOLINGPROTECTIONMODE,
486 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_COOLINGPROTECTIONMODE),
487 CoreItemFactory.SWITCH)),
488 Map.entry(CHANNEL_OUTDOORAIRHEATERSTATUS,
489 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_OUTDOORAIRHEATERSTATUS),
490 CoreItemFactory.SWITCH)),
491 Map.entry(CHANNEL_SUPPLYAIRHEATERSTATUS,
492 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRHEATERSTATUS),
493 CoreItemFactory.SWITCH)),
494 Map.entry(CHANNEL_DRAINHEATERSTATUS,
495 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_DRAINHEATERSTATUS),
496 CoreItemFactory.SWITCH)),
497 Map.entry(CHANNEL_TIMEROPERATIONMODE,
498 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_TIMEROPERATIONMODE),
499 CoreItemFactory.SWITCH)),
500 Map.entry(CHANNEL_WEEKLYTIMERPROGRAMSTATUS,
501 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_WEEKLYTIMERPROGRAMSTATUS),
502 CoreItemFactory.SWITCH)),
503 Map.entry(CHANNEL_ROOMTEMPERATURECONTROLSTATUS,
504 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_ROOMTEMPERATURECONTROLSTATUS),
505 CoreItemFactory.SWITCH)),
506 Map.entry(CHANNEL_AIRQUALITYVALUE1,
507 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_AIRQUALITYVALUE1),
508 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
509 + Dimensionless.class.getSimpleName())),
510 Map.entry(CHANNEL_AIRQUALITYVALUE2,
511 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_AIRQUALITYVALUE2),
512 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
513 + Dimensionless.class.getSimpleName())),
514 Map.entry(CHANNEL_OUTDOORAIRTEMPERATURE,
515 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_OUTDOORAIRTEMPERATURE),
516 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
517 Map.entry(CHANNEL_SUPPLYAIRTEMPERATURE,
518 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRTEMPERATURE),
519 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
520 Map.entry(CHANNEL_INDOORAIRTEMPERATURE,
521 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_INDOORAIRTEMPERATURE),
522 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
523 Map.entry(CHANNEL_EXHAUSTAIRTEMPERATURE,
524 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTAIRTEMPERATURE),
525 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR + Temperature.class.getSimpleName())),
526 Map.entry(CHANNEL_SUPPLYAIRFANAIRFLOWRATE,
527 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYAIRFANAIRFLOWRATE),
528 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
529 + VolumetricFlowRate.class.getSimpleName())),
530 Map.entry(CHANNEL_EXHAUSTAIRFANAIRFLOWRATE,
531 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTAIRFANAIRFLOWRATE),
532 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
533 + VolumetricFlowRate.class.getSimpleName())),
534 Map.entry(CHANNEL_SUPPLYFANSPEED,
535 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_SUPPLYFANSPEED),
536 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
537 + Dimensionless.class.getSimpleName())),
538 Map.entry(CHANNEL_EXHAUSTFANSPEED,
539 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_EXHAUSTFANSPEED),
540 CoreItemFactory.NUMBER + ItemUtil.EXTENSION_SEPARATOR
541 + Dimensionless.class.getSimpleName())),
543 Map.entry(CHANNEL_STATUS_REQUEST_EVENT,
544 new EnOceanChannelDescription(new ChannelTypeUID(BINDING_ID, CHANNEL_STATUS_REQUEST_EVENT), null,
547 Map.entry(CHANNEL_REPEATERMODE, new EnOceanChannelDescription(
548 new ChannelTypeUID(BINDING_ID, CHANNEL_REPEATERMODE), CoreItemFactory.STRING)));
550 // List of all repeater mode states
551 public static final String REPEATERMODE_OFF = "OFF";
552 public static final String REPEATERMODE_LEVEL_1 = "LEVEL1";
553 public static final String REPEATERMODE_LEVEL_2 = "LEVEL2";
555 // Bridge config properties
556 public static final String PATH = "path";
557 public static final String PARAMETER_NEXT_SENDERID = "nextSenderId";
560 public static final String PROPERTY_BASE_ID = "Base ID";
561 public static final String PROPERTY_REMAINING_WRITE_CYCLES_Base_ID = "Remaining Base ID Write Cycles";
562 public static final String PROPERTY_APP_VERSION = "APP Version";
563 public static final String PROPERTY_API_VERSION = "API Version";
564 public static final String PROPERTY_CHIP_ID = "Chip ID";
565 public static final String PROPERTY_DESCRIPTION = "Description";
568 public static final String PROPERTY_SENDINGENOCEAN_ID = "SendingEnoceanId";
570 // Thing config parameter
571 public static final String PARAMETER_SENDERIDOFFSET = "senderIdOffset";
572 public static final String PARAMETER_SENDINGEEPID = "sendingEEPId";
573 public static final String PARAMETER_RECEIVINGEEPID = "receivingEEPId";
575 public static final String PARAMETER_BROADCASTMESSAGES = "broadcastMessages";
576 public static final String PARAMETER_ENOCEANID = "enoceanId";
578 // Channel config parameter
579 public static final String PARAMETER_CHANNEL_TeachInMSG = "teachInMSG";
580 public static final String PARAMETER_CHANNEL_Duration = "duration";
581 public static final String PARAMETER_CHANNEL_SwitchMode = "switchMode";
583 // Manufacturer Ids - used to recognize special EEPs during auto discovery
584 public static final int ELTAKOID = 0x00d;
585 public static final int NODONID = 0x046; // NodOn devices are designed by ID-RF hence use their ID
586 public static final int PERMUNDOID = 0x033;
588 public static final String EMPTYENOCEANID = "00000000";
590 public static final byte ZERO = (byte) 0;