2 * Copyright (c) 2010-2024 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.knx.internal.dpt;
15 import static org.openhab.binding.knx.internal.KNXBindingConstants.disableUoM;
17 import java.math.BigDecimal;
18 import java.text.ParseException;
19 import java.text.SimpleDateFormat;
20 import java.util.Calendar;
21 import java.util.Date;
22 import java.util.Locale;
24 import java.util.regex.Matcher;
25 import java.util.regex.Pattern;
27 import org.eclipse.jdt.annotation.NonNullByDefault;
28 import org.eclipse.jdt.annotation.Nullable;
29 import org.openhab.core.library.types.DateTimeType;
30 import org.openhab.core.library.types.DecimalType;
31 import org.openhab.core.library.types.HSBType;
32 import org.openhab.core.library.types.IncreaseDecreaseType;
33 import org.openhab.core.library.types.OnOffType;
34 import org.openhab.core.library.types.OpenClosedType;
35 import org.openhab.core.library.types.PercentType;
36 import org.openhab.core.library.types.QuantityType;
37 import org.openhab.core.library.types.StopMoveType;
38 import org.openhab.core.library.types.StringType;
39 import org.openhab.core.library.types.UpDownType;
40 import org.openhab.core.types.Type;
41 import org.openhab.core.types.UnDefType;
42 import org.openhab.core.util.ColorUtil;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
46 import tuwien.auto.calimero.KNXException;
47 import tuwien.auto.calimero.KNXFormatException;
48 import tuwien.auto.calimero.KNXIllegalArgumentException;
49 import tuwien.auto.calimero.dptxlator.DPTXlator;
50 import tuwien.auto.calimero.dptxlator.DPTXlator1BitControlled;
51 import tuwien.auto.calimero.dptxlator.DPTXlator2ByteUnsigned;
52 import tuwien.auto.calimero.dptxlator.DPTXlator3BitControlled;
53 import tuwien.auto.calimero.dptxlator.DPTXlator64BitSigned;
54 import tuwien.auto.calimero.dptxlator.DPTXlator8BitUnsigned;
55 import tuwien.auto.calimero.dptxlator.DPTXlatorBoolean;
56 import tuwien.auto.calimero.dptxlator.DPTXlatorDateTime;
57 import tuwien.auto.calimero.dptxlator.DPTXlatorSceneControl;
58 import tuwien.auto.calimero.dptxlator.TranslatorTypes;
61 * This class decodes raw data received from the KNX bus to an openHAB datatype
63 * Parts of this code are based on the openHAB KNXCoreTypeMapper by Kai Kreuzer et al.
65 * @author Jan N. Klug - Initial contribution
68 public class ValueDecoder {
69 private static final Logger LOGGER = LoggerFactory.getLogger(ValueDecoder.class);
71 private static final String TIME_DAY_FORMAT = "EEE, HH:mm:ss";
72 private static final String TIME_FORMAT = "HH:mm:ss";
73 private static final String DATE_FORMAT = "yyyy-MM-dd";
74 // RGB: "r:123 g:123 b:123" value-range: 0-255
75 private static final Pattern RGB_PATTERN = Pattern.compile("r:(?<r>\\d+) g:(?<g>\\d+) b:(?<b>\\d+)");
76 // RGBW: "100 27 25 12 %", value range: 0-100, invalid values: "-"
77 private static final Pattern RGBW_PATTERN = Pattern
78 .compile("(?:(?<r>[\\d,.]+)|-)\\s(?:(?<g>[\\d,.]+)|-)\\s(?:(?<b>[\\d,.]+)|-)\\s(?:(?<w>[\\d,.]+)|-)\\s%");
79 // xyY: "(0,123 0,123) 56 %", value range 0-1 for xy (comma or point as decimal point), 0-100 for Y, invalid values
81 public static final Pattern XYY_PATTERN = Pattern
82 .compile("(?:\\((?<x>\\d+(?:[,.]\\d+)?) (?<y>\\d+(?:[,.]\\d+)?)\\))?\\s*(?:(?<Y>\\d+(?:[,.]\\d+)?)\\s%)?");
84 private static boolean check235001(byte[] data) throws KNXException {
85 if (data.length != 6) {
86 throw new KNXFormatException("DPT235 broken frame");
88 if ((data[5] & 2) == 0) {
89 LOGGER.trace("DPT235.001 w/o ActiveEnergy ignored");
95 private static boolean check23561001(byte[] data) throws KNXException {
96 if (data.length != 6) {
97 throw new KNXFormatException("DPT235 broken frame");
99 if ((data[5] & 1) == 0) {
100 LOGGER.trace("DPT235.61001 w/o Tariff ignored");
107 * convert the raw value received to the corresponding openHAB value
109 * @param dptId the DPT of the given data
110 * @param data a byte array containing the value
111 * @param preferredType the preferred datatype for this conversion
112 * @return the data converted to an openHAB Type (or null if conversion failed)
114 public static @Nullable Type decode(String dptId, byte[] data, Class<? extends Type> preferredType) {
117 String translatorDptId = dptId;
118 DPTXlator translator;
120 translator = TranslatorTypes.createTranslator(0, DPTUtil.NORMALIZED_DPT.getOrDefault(dptId, dptId));
121 translator.setData(data);
122 value = translator.getValue();
123 translatorDptId = translator.getType().getID();
124 } catch (KNXException e) {
125 // special handling for decoding DPTs not yet supported by Calimero
126 if ("235.001".equals(dptId)) {
127 if (!check235001(data)) {
130 translator = TranslatorTypes.createTranslator(0, "13.010");
131 translator.setData(data);
132 value = translator.getValue();
134 translatorDptId = dptId;
135 } else if ("235.61001".equals(dptId)) {
136 if (!check23561001(data)) {
139 translator = TranslatorTypes.createTranslator(0, "5.006");
140 translator.setData(new byte[] { data[4] });
141 value = translator.getValue();
143 translatorDptId = dptId;
145 // no known special case, handle unknown translator outer try block
149 String id = dptId; // prefer using the user-supplied DPT
151 Matcher m = DPTUtil.DPT_PATTERN.matcher(id);
152 if (!m.matches() || m.groupCount() != 2) {
153 LOGGER.trace("User-Supplied DPT '{}' did not match for sub-type, using DPT returned from Translator",
155 id = translatorDptId;
156 m = DPTUtil.DPT_PATTERN.matcher(id);
157 if (!m.matches() || m.groupCount() != 2) {
158 LOGGER.warn("Couldn't identify main/sub number in dptID '{}'", id);
162 LOGGER.trace("Finally using datapoint DPT = {}", id);
164 String mainType = m.group("main");
165 String subType = m.group("sub");
169 return handleDpt1(subType, translator, preferredType);
171 DPTXlator1BitControlled translator1BitControlled = (DPTXlator1BitControlled) translator;
172 int decValue = (translator1BitControlled.getControlBit() ? 2 : 0)
173 + (translator1BitControlled.getValueBit() ? 1 : 0);
174 return new DecimalType(decValue);
176 return handleDpt3(subType, translator);
178 if ("020".equals(subType)) {
179 return handleStringOrDecimal(data, value, preferredType, 8);
181 return handleNumericDpt(id, translator, preferredType);
184 return handleDpt10(value);
186 return DateTimeType.valueOf(new SimpleDateFormat(DateTimeType.DATE_PATTERN)
187 .format(new SimpleDateFormat(DATE_FORMAT).parse(value)));
189 DPTXlatorSceneControl translatorSceneControl = (DPTXlatorSceneControl) translator;
190 int decimalValue = translatorSceneControl.getSceneNumber();
191 if (value.startsWith("learn")) {
192 decimalValue += 0x80;
194 return new DecimalType(decimalValue);
196 return handleDpt19(translator, data);
199 return handleStringOrDecimal(data, value, preferredType, 8);
201 return handleStringOrDecimal(data, value, preferredType, 16);
204 case "250": // Map all combined color transitions to String,
205 case "252": // as no native support is planned.
206 case "253": // Currently only one subtype 2xx.600
207 case "254": // is defined for those DPTs.
208 return StringType.valueOf(value);
209 case "243": // color translation, fix regional
210 case "249": // settings
211 return StringType.valueOf(value.replace(',', '.').replace(". ", ", "));
213 return handleDpt232(value, subType);
215 return handleDpt242(value);
217 return handleDpt251(value, subType, preferredType);
219 return handleNumericDpt(id, translator, preferredType);
221 } catch (NumberFormatException | KNXFormatException | KNXIllegalArgumentException | ParseException e) {
222 LOGGER.info("Translator couldn't parse data '{}' for datapoint type '{}' ({}).", data, dptId, e.getClass());
223 } catch (KNXException e) {
224 LOGGER.warn("Failed creating a translator for datapoint type '{}'.", dptId, e);
230 private static Type handleDpt1(String subType, DPTXlator translator, Class<? extends Type> preferredType) {
231 DPTXlatorBoolean translatorBoolean = (DPTXlatorBoolean) translator;
234 return translatorBoolean.getValueBoolean() ? UpDownType.DOWN : UpDownType.UP;
237 // default is OpenClosedType (Contact), but it may be mapped to OnOffType as well
238 if (OnOffType.class.equals(preferredType)) {
239 return OnOffType.from(translatorBoolean.getValueBoolean());
242 // This is wrong for DPT 1.009. It should be true -> CLOSE, false -> OPEN, but unfortunately
243 // can't be fixed without breaking a lot of working installations.
244 // The documentation has been updated to reflect that. / @J-N-K
245 return translatorBoolean.getValueBoolean() ? OpenClosedType.OPEN : OpenClosedType.CLOSED;
247 return translatorBoolean.getValueBoolean() ? StopMoveType.MOVE : StopMoveType.STOP;
249 return DecimalType.valueOf(translatorBoolean.getValueBoolean() ? "1" : "0");
251 // default is OnOffType (Switch), but it may be mapped to OpenClosedType as well
252 if (OpenClosedType.class.equals(preferredType)) {
253 return translatorBoolean.getValueBoolean() ? OpenClosedType.OPEN : OpenClosedType.CLOSED;
256 return OnOffType.from(translatorBoolean.getValueBoolean());
260 private static @Nullable Type handleDpt3(String subType, DPTXlator translator) {
261 DPTXlator3BitControlled translator3BitControlled = (DPTXlator3BitControlled) translator;
262 if (translator3BitControlled.getStepCode() == 0) {
263 LOGGER.debug("convertRawDataToType: KNX DPT_Control_Dimming: break received.");
264 return UnDefType.NULL;
268 return translator3BitControlled.getControlBit() ? IncreaseDecreaseType.INCREASE
269 : IncreaseDecreaseType.DECREASE;
271 return translator3BitControlled.getControlBit() ? UpDownType.DOWN : UpDownType.UP;
273 LOGGER.warn("DPT3, subtype '{}' is unknown.", subType);
278 private static Type handleDpt10(String value) throws ParseException {
279 // Calimero will provide either TIME_DAY_FORMAT or TIME_FORMAT, no-day is not printed
282 date = new SimpleDateFormat(TIME_DAY_FORMAT, Locale.US).parse(value);
283 } catch (ParseException pe) {
284 date = new SimpleDateFormat(TIME_FORMAT, Locale.US).parse(value);
286 return DateTimeType.valueOf(new SimpleDateFormat(DateTimeType.DATE_PATTERN).format(date));
289 private static @Nullable Type handleDpt19(DPTXlator translator, byte[] data) throws KNXFormatException {
290 DPTXlatorDateTime translatorDateTime = (DPTXlatorDateTime) translator;
291 if (translatorDateTime.isFaultyClock()) {
292 // Not supported: faulty clock
293 LOGGER.debug("KNX clock msg ignored: clock faulty bit set, which is not supported");
295 } else if (!translatorDateTime.isValidField(DPTXlatorDateTime.YEAR)
296 && translatorDateTime.isValidField(DPTXlatorDateTime.DATE)) {
297 // Not supported: "/1/1" (month and day without year)
298 LOGGER.debug("KNX clock msg ignored: no year, but day and month, which is not supported");
300 } else if (translatorDateTime.isValidField(DPTXlatorDateTime.YEAR)
301 && !translatorDateTime.isValidField(DPTXlatorDateTime.DATE)) {
302 // Not supported: "1900" (year without month and day)
303 LOGGER.debug("KNX clock msg ignored: no day and month, but year, which is not supported");
305 } else if (!translatorDateTime.isValidField(DPTXlatorDateTime.YEAR)
306 && !translatorDateTime.isValidField(DPTXlatorDateTime.DATE)
307 && !translatorDateTime.isValidField(DPTXlatorDateTime.TIME)) {
308 // Not supported: No year, no date and no time
309 LOGGER.debug("KNX clock msg ignored: no day and month or year, which is not supported");
313 Calendar cal = Calendar.getInstance();
314 if (translatorDateTime.isValidField(DPTXlatorDateTime.YEAR)
315 && !translatorDateTime.isValidField(DPTXlatorDateTime.TIME)) {
316 // Pure date format, no time information
317 cal.setTimeInMillis(translatorDateTime.getValueMilliseconds());
318 String value = new SimpleDateFormat(DateTimeType.DATE_PATTERN).format(cal.getTime());
319 return DateTimeType.valueOf(value);
320 } else if (!translatorDateTime.isValidField(DPTXlatorDateTime.YEAR)
321 && translatorDateTime.isValidField(DPTXlatorDateTime.TIME)) {
322 // Pure time format, no date information
324 cal.set(Calendar.HOUR_OF_DAY, translatorDateTime.getHour());
325 cal.set(Calendar.MINUTE, translatorDateTime.getMinute());
326 cal.set(Calendar.SECOND, translatorDateTime.getSecond());
327 String value = new SimpleDateFormat(DateTimeType.DATE_PATTERN).format(cal.getTime());
328 return DateTimeType.valueOf(value);
329 } else if (translatorDateTime.isValidField(DPTXlatorDateTime.YEAR)
330 && translatorDateTime.isValidField(DPTXlatorDateTime.TIME)) {
331 // Date format and time information
333 cal.setTimeInMillis(translatorDateTime.getValueMilliseconds());
334 } catch (KNXFormatException ignore) {
335 // throws KNXFormatException in case DST (SUTI) flag does not match calendar
336 // As the spec regards the SUTI flag as purely informative, flip it and try again.
337 if (data.length < 8) {
340 data[6] = (byte) (data[6] ^ 0x01);
341 translator.setData(data, 0);
342 cal.setTimeInMillis(translatorDateTime.getValueMilliseconds());
344 String value = new SimpleDateFormat(DateTimeType.DATE_PATTERN).format(cal.getTime());
345 return DateTimeType.valueOf(value);
347 LOGGER.warn("Failed to convert '{}'", translator.getValue());
352 private static @Nullable Type handleStringOrDecimal(byte[] data, String value, Class<? extends Type> preferredType,
354 if (DecimalType.class.equals(preferredType)) {
356 // need a new translator for 8 bit unsigned, as Calimero handles only the string type
358 DPTXlator8BitUnsigned translator = new DPTXlator8BitUnsigned("5.010");
359 translator.setData(data);
360 return new DecimalType(translator.getValueUnsigned());
361 } else if (bits == 16) {
362 DPTXlator2ByteUnsigned translator = new DPTXlator2ByteUnsigned("7.001");
363 translator.setData(data);
364 return new DecimalType(translator.getValueUnsigned());
368 } catch (KNXFormatException e) {
372 return StringType.valueOf(value);
376 private static @Nullable Type handleDpt232(String value, String subType) {
377 Matcher rgb = RGB_PATTERN.matcher(value);
379 int r = Integer.parseInt(rgb.group("r"));
380 int g = Integer.parseInt(rgb.group("g"));
381 int b = Integer.parseInt(rgb.group("b"));
385 return HSBType.fromRGB(r, g, b);
387 // MDT specific: mis-use 232.600 for hsv instead of rgb
388 DecimalType hue = new DecimalType(coerceToRange(r * 360.0 / 255.0, 0.0, 359.9999));
389 PercentType sat = new PercentType(BigDecimal.valueOf(coerceToRange(g / 2.55, 0.0, 100.0)));
390 PercentType bright = new PercentType(BigDecimal.valueOf(coerceToRange(b / 2.55, 0.0, 100.0)));
391 return new HSBType(hue, sat, bright);
393 LOGGER.warn("Unknown subtype '232.{}', no conversion possible.", subType);
397 LOGGER.warn("Failed to convert '{}' (DPT 232): Pattern does not match", value);
401 private static @Nullable Type handleDpt242(String value) {
402 Matcher xyY = XYY_PATTERN.matcher(value);
404 String stringx = xyY.group("x");
405 String stringy = xyY.group("y");
406 String stringY = xyY.group("Y");
408 if (stringx != null && stringy != null) {
409 double x = Double.parseDouble(stringx.replace(",", "."));
410 double y = Double.parseDouble(stringy.replace(",", "."));
411 if (stringY == null) {
412 return ColorUtil.xyToHsb(new double[] { x, y });
414 double pY = Double.parseDouble(stringY.replace(",", "."));
415 return ColorUtil.xyToHsb(new double[] { x, y, pY / 100.0 });
419 LOGGER.warn("Failed to convert '{}' (DPT 242): Pattern does not match", value);
423 private static @Nullable Type handleDpt251(String value, String subType, Class<? extends Type> preferredType) {
424 Matcher rgbw = RGBW_PATTERN.matcher(value);
425 if (rgbw.matches()) {
426 String rString = rgbw.group("r");
427 String gString = rgbw.group("g");
428 String bString = rgbw.group("b");
429 String wString = rgbw.group("w");
433 if (rString != null && gString != null && bString != null && HSBType.class.equals(preferredType)) {
434 // does not support PercentType and r,g,b valid -> HSBType
435 int r = coerceToRange((int) (Double.parseDouble(rString.replace(",", ".")) * 2.55), 0, 255);
436 int g = coerceToRange((int) (Double.parseDouble(gString.replace(",", ".")) * 2.55), 0, 255);
437 int b = coerceToRange((int) (Double.parseDouble(bString.replace(",", ".")) * 2.55), 0, 255);
439 return HSBType.fromRGB(r, g, b);
440 } else if (wString != null && PercentType.class.equals(preferredType)) {
441 // does support PercentType and w valid -> PercentType
442 BigDecimal w = new BigDecimal(wString.replace(",", "."));
444 return new PercentType(w);
447 // special type used by OH for .600 indicating that RGBW should be handled with a single HSBType,
448 // typically we use HSBType for RGB and PercentType for W.
449 if (rString != null && gString != null && bString != null && wString != null
450 && HSBType.class.equals(preferredType)) {
451 // does support PercentType and w valid -> PercentType
452 int r = coerceToRange((int) (Double.parseDouble(rString.replace(",", ".")) * 2.55), 0, 255);
453 int g = coerceToRange((int) (Double.parseDouble(gString.replace(",", ".")) * 2.55), 0, 255);
454 int b = coerceToRange((int) (Double.parseDouble(bString.replace(",", ".")) * 2.55), 0, 255);
455 int w = coerceToRange((int) (Double.parseDouble(wString.replace(",", ".")) * 2.55), 0, 255);
457 return ColorUtil.rgbToHsb(new int[] { r, g, b, w });
460 LOGGER.warn("Unknown subtype '251.{}', no conversion possible.", subType);
465 LOGGER.warn("Failed to convert '{}' (DPT 251): Pattern does not match or invalid content", value);
469 private static @Nullable Type handleNumericDpt(String id, DPTXlator translator, Class<? extends Type> preferredType)
470 throws KNXFormatException {
471 Set<Class<? extends Type>> allowedTypes = DPTUtil.getAllowedTypes(id);
473 double value = translator.getNumericValue();
474 if (allowedTypes.contains(PercentType.class)
475 && (HSBType.class.equals(preferredType) || PercentType.class.equals(preferredType))) {
476 return new PercentType(BigDecimal.valueOf(Math.round(value)));
479 if (allowedTypes.contains(QuantityType.class) && !disableUoM) {
480 String unit = DPTUnits.getUnitForDpt(id);
482 if (translator instanceof DPTXlator64BitSigned translatorSigned) {
483 // prevent loss of precision, do not represent 64bit decimal using double
484 return new QuantityType<>(translatorSigned.getValueSigned() + " " + unit);
486 return new QuantityType<>(value + " " + unit);
488 LOGGER.trace("Could not determine unit for DPT '{}', fallback to plain decimal", id);
492 if (allowedTypes.contains(DecimalType.class)) {
493 if (translator instanceof DPTXlator64BitSigned translatorSigned) {
494 // prevent loss of precision, do not represent 64bit decimal using double
495 return new DecimalType(translatorSigned.getValueSigned());
497 return new DecimalType(value);
500 LOGGER.warn("Failed to convert '{}' (DPT '{}'): no matching type found", value, id);
504 private static double coerceToRange(double value, double min, double max) {
505 return Math.min(Math.max(value, min), max);
508 private static int coerceToRange(int value, int min, int max) {
509 return Math.min(Math.max(value, min), max);