forked from openhab/openhab-addons
-
Notifications
You must be signed in to change notification settings - Fork 1
/
MieleApplianceHandler.java
454 lines (415 loc) · 19.1 KB
/
MieleApplianceHandler.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
/**
* Copyright (c) 2010-2022 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.miele.internal.handler;
import static org.openhab.binding.miele.internal.MieleBindingConstants.*;
import java.time.Instant;
import java.time.ZonedDateTime;
import java.time.temporal.ChronoUnit;
import java.util.HashMap;
import java.util.IllformedLocaleException;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.miele.internal.DeviceUtil;
import org.openhab.binding.miele.internal.MieleTranslationProvider;
import org.openhab.binding.miele.internal.TimeStabilizer;
import org.openhab.binding.miele.internal.api.dto.DeviceClassObject;
import org.openhab.binding.miele.internal.api.dto.DeviceMetaData;
import org.openhab.binding.miele.internal.api.dto.DeviceProperty;
import org.openhab.binding.miele.internal.api.dto.HomeDevice;
import org.openhab.core.i18n.LocaleProvider;
import org.openhab.core.i18n.TimeZoneProvider;
import org.openhab.core.i18n.TranslationProvider;
import org.openhab.core.library.types.DateTimeType;
import org.openhab.core.library.types.OnOffType;
import org.openhab.core.library.types.QuantityType;
import org.openhab.core.library.unit.Units;
import org.openhab.core.thing.Bridge;
import org.openhab.core.thing.ChannelUID;
import org.openhab.core.thing.Thing;
import org.openhab.core.thing.ThingStatus;
import org.openhab.core.thing.ThingStatusDetail;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.ThingUID;
import org.openhab.core.thing.binding.BaseThingHandler;
import org.openhab.core.thing.binding.ThingHandler;
import org.openhab.core.types.Command;
import org.openhab.core.types.RefreshType;
import org.openhab.core.types.State;
import org.openhab.core.types.UnDefType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
/**
* The {@link MieleApplianceHandler} is an abstract class
* responsible for handling commands, which are sent to one
* of the channels of the appliance that understands/"talks"
* the {@link ApplianceChannelSelector} datapoints
*
* @author Karel Goderis - Initial contribution
* @author Martin Lepsy - Added check for JsonNull result
* @author Jacob Laursen - Fixed multicast and protocol support (ZigBee/LAN)
*/
@NonNullByDefault
public abstract class MieleApplianceHandler<E extends Enum<E> & ApplianceChannelSelector> extends BaseThingHandler
implements ApplianceStatusListener {
private final Logger logger = LoggerFactory.getLogger(MieleApplianceHandler.class);
public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Set.of(THING_TYPE_DISHWASHER, THING_TYPE_OVEN,
THING_TYPE_FRIDGE, THING_TYPE_DRYER, THING_TYPE_HOB, THING_TYPE_FRIDGEFREEZER, THING_TYPE_HOOD,
THING_TYPE_WASHINGMACHINE, THING_TYPE_COFFEEMACHINE);
protected Gson gson = new Gson();
protected @Nullable String applianceId;
private @Nullable MieleBridgeHandler bridgeHandler;
protected TranslationProvider i18nProvider;
protected LocaleProvider localeProvider;
protected MieleTranslationProvider translationProvider;
private TimeZoneProvider timeZoneProvider;
private TimeStabilizer startTimeStabilizer;
private TimeStabilizer finishTimeStabilizer;
private Class<E> selectorType;
protected String modelID;
protected Map<String, String> metaDataCache = new HashMap<>();
public MieleApplianceHandler(Thing thing, TranslationProvider i18nProvider, LocaleProvider localeProvider,
TimeZoneProvider timeZoneProvider, Class<E> selectorType, String modelID) {
super(thing);
this.i18nProvider = i18nProvider;
this.localeProvider = localeProvider;
this.selectorType = selectorType;
this.modelID = modelID;
this.translationProvider = new MieleTranslationProvider(i18nProvider, localeProvider);
this.timeZoneProvider = timeZoneProvider;
this.startTimeStabilizer = new TimeStabilizer();
this.finishTimeStabilizer = new TimeStabilizer();
}
public ApplianceChannelSelector getValueSelectorFromChannelID(String valueSelectorText)
throws IllegalArgumentException {
E[] enumConstants = selectorType.getEnumConstants();
if (enumConstants == null) {
throw new IllegalArgumentException(
String.format("Could not get enum constants for value selector: %s", valueSelectorText));
}
for (ApplianceChannelSelector c : enumConstants) {
if (c.getChannelID().equals(valueSelectorText)) {
return c;
}
}
throw new IllegalArgumentException(String.format("Not valid value selector: %s", valueSelectorText));
}
public ApplianceChannelSelector getValueSelectorFromMieleID(String valueSelectorText)
throws IllegalArgumentException {
E[] enumConstants = selectorType.getEnumConstants();
if (enumConstants == null) {
throw new IllegalArgumentException(
String.format("Could not get enum constants for value selector: %s", valueSelectorText));
}
for (ApplianceChannelSelector c : enumConstants) {
if (!c.getMieleID().isEmpty() && c.getMieleID().equals(valueSelectorText)) {
return c;
}
}
throw new IllegalArgumentException(String.format("Not valid value selector: %s", valueSelectorText));
}
@Override
public void initialize() {
logger.debug("Initializing handler for thing {}", getThing().getUID());
final String applianceId = (String) getThing().getConfiguration().getProperties().get(APPLIANCE_ID);
if (applianceId == null || applianceId.isBlank()) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.CONFIGURATION_ERROR,
"@text/offline.configuration-error.uid-not-set");
return;
}
this.applianceId = applianceId;
Bridge bridge = getBridge();
if (bridge == null) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.CONFIGURATION_ERROR,
"@text/offline.configuration-error.bridge-missing");
return;
}
initializeTranslationProvider(bridge);
updateStatus(ThingStatus.UNKNOWN);
MieleBridgeHandler bridgeHandler = getMieleBridgeHandler();
if (bridgeHandler != null) {
bridgeHandler.registerApplianceStatusListener(applianceId, this);
}
}
private void initializeTranslationProvider(Bridge bridge) {
Locale locale = null;
String language = (String) bridge.getConfiguration().get(LANGUAGE);
if (language != null && !language.isBlank()) {
try {
locale = new Locale.Builder().setLanguageTag(language).build();
} catch (IllformedLocaleException e) {
logger.warn("Invalid language configured: {}", e.getMessage());
}
}
if (locale == null) {
logger.debug("No language configured, using system language.");
this.translationProvider = new MieleTranslationProvider(i18nProvider, localeProvider);
} else {
this.translationProvider = new MieleTranslationProvider(i18nProvider, localeProvider, locale);
}
}
@Override
public void dispose() {
logger.debug("Handler disposes. Unregistering listener.");
String applianceId = this.applianceId;
if (applianceId != null) {
MieleBridgeHandler bridgeHandler = getMieleBridgeHandler();
if (bridgeHandler != null) {
bridgeHandler.unregisterApplianceStatusListener(applianceId, this);
}
applianceId = null;
}
startTimeStabilizer.clear();
finishTimeStabilizer.clear();
}
@Override
public void handleCommand(ChannelUID channelUID, Command command) {
// Here we could handle commands that are common to all Miele Appliances, but so far I don't know of any
if (command instanceof RefreshType) {
// Placeholder for future refinement
return;
}
}
@Override
public void onApplianceStateChanged(DeviceClassObject dco) {
JsonArray properties = dco.Properties;
if (properties == null) {
return;
}
for (JsonElement prop : properties.getAsJsonArray()) {
try {
DeviceProperty dp = gson.fromJson(prop, DeviceProperty.class);
if (dp == null) {
continue;
}
if (!EXTENDED_DEVICE_STATE_PROPERTY_NAME.equals(dp.Name)) {
dp.Value = dp.Value.trim();
dp.Value = dp.Value.strip();
}
onAppliancePropertyChanged(dp);
} catch (Exception p) {
// Ignore - this is due to an unrecognized and not yet reverse-engineered array property
}
}
}
@Override
public void onAppliancePropertyChanged(DeviceProperty dp) {
try {
DeviceMetaData dmd = null;
if (dp.Metadata == null) {
String metadata = metaDataCache.get(new StringBuilder().append(dp.Name).toString().trim());
if (metadata != null) {
JsonObject jsonMetadata = (JsonObject) JsonParser.parseString(metadata);
dmd = gson.fromJson(jsonMetadata, DeviceMetaData.class);
// only keep the enum, if any - that's all we care for events we receive via multicast
// all other fields are nulled
if (dmd != null) {
dmd.LocalizedID = null;
dmd.LocalizedValue = null;
dmd.Filter = null;
dmd.description = null;
}
}
}
JsonObject jsonMetadata = dp.Metadata;
if (jsonMetadata != null) {
String metadata = jsonMetadata.toString().replace("enum", "MieleEnum");
JsonObject jsonMetaData = (JsonObject) JsonParser.parseString(metadata);
dmd = gson.fromJson(jsonMetaData, DeviceMetaData.class);
metaDataCache.put(new StringBuilder().append(dp.Name).toString().trim(), metadata);
}
ThingUID thingUid = getThing().getUID();
if (EXTENDED_DEVICE_STATE_PROPERTY_NAME.equals(dp.Name)) {
if (!dp.Value.isEmpty()) {
byte[] extendedStateBytes = DeviceUtil.stringToBytes(dp.Value);
logger.trace("Extended device state for {}: {}", getThing().getUID(),
DeviceUtil.bytesToHex(extendedStateBytes));
if (this instanceof ExtendedDeviceStateListener) {
((ExtendedDeviceStateListener) this).onApplianceExtendedStateChanged(extendedStateBytes);
}
}
return;
} else if (START_TIME_PROPERTY_NAME.equals(dp.Name)) {
updateStateFromTime(new ChannelUID(thingUid, START_CHANNEL_ID), dp.Value, startTimeStabilizer);
return;
} else if (FINISH_TIME_PROPERTY_NAME.equals(dp.Name)) {
updateDurationState(new ChannelUID(thingUid, FINISH_CHANNEL_ID), dp.Value);
updateStateFromTime(new ChannelUID(thingUid, END_CHANNEL_ID), dp.Value, finishTimeStabilizer);
return;
}
ApplianceChannelSelector selector = null;
try {
selector = getValueSelectorFromMieleID(dp.Name);
} catch (Exception h) {
logger.trace("{} is not a valid channel for a {}", dp.Name, modelID);
}
String dpValue = dp.Value.strip().trim();
if (selector != null) {
String channelId = selector.getChannelID();
State state = selector.getState(dpValue, dmd, this.translationProvider);
if (selector.isProperty()) {
String value = state.toString();
logger.trace("Updating the property '{}' of '{}' to '{}'", channelId, thingUid, value);
updateProperty(channelId, value);
} else {
ChannelUID theChannelUID = new ChannelUID(thingUid, channelId);
logger.trace("Update state of {} with getState '{}'", theChannelUID, state);
updateState(theChannelUID, state);
updateRawChannel(dp.Name, dpValue);
}
}
} catch (IllegalArgumentException e) {
logger.warn("An exception occurred while processing a changed device property: '{}'", e.getMessage());
}
}
protected void updateExtendedState(String channelId, State state) {
ChannelUID channelUid = new ChannelUID(getThing().getUID(), channelId);
logger.trace("Update state of {} with extended state '{}'", channelUid, state);
updateState(channelUid, state);
}
private void updateStateFromTime(ChannelUID channelUid, String value, TimeStabilizer stabilizer) {
try {
long minutesFromNow = Long.valueOf(value);
if (minutesFromNow > 0) {
Instant rawTime = Instant.now().truncatedTo(ChronoUnit.MINUTES).plusSeconds(minutesFromNow * 60);
ZonedDateTime correctedTime = stabilizer.apply(rawTime).atZone(timeZoneProvider.getTimeZone());
ZonedDateTime truncatedTime = correctedTime.truncatedTo(ChronoUnit.MINUTES);
logger.trace("Update state of {} from {} -> '{}' -> '{}' to '{}'", channelUid, minutesFromNow, rawTime,
correctedTime, truncatedTime);
updateState(channelUid, new DateTimeType(truncatedTime));
return;
}
} catch (NumberFormatException e) {
// Fall through.
}
updateState(channelUid, UnDefType.UNDEF);
stabilizer.clear();
}
private void updateDurationState(ChannelUID channelUid, String value) {
try {
long minutesFromNow = Long.valueOf(value);
if (minutesFromNow > 0) {
updateState(channelUid, new QuantityType<>(minutesFromNow, Units.MINUTE));
return;
}
} catch (NumberFormatException e) {
// Fall through.
}
updateState(channelUid, UnDefType.UNDEF);
}
protected void updateSwitchOnOffFromState(DeviceProperty dp) {
if (!STATE_PROPERTY_NAME.equals(dp.Name)) {
return;
}
// Switch is trigger channel, but current state can be deduced from state.
ChannelUID channelUid = new ChannelUID(getThing().getUID(), SWITCH_CHANNEL_ID);
State state = OnOffType.from(!dp.Value.equals(String.valueOf(STATE_OFF)));
logger.trace("Update state of {} to {} through '{}'", channelUid, state, dp.Name);
updateState(channelUid, state);
}
protected void updateSwitchStartStopFromState(DeviceProperty dp) {
if (!STATE_PROPERTY_NAME.equals(dp.Name)) {
return;
}
// Switch is trigger channel, but current state can be deduced from state.
ChannelUID channelUid = new ChannelUID(getThing().getUID(), SWITCH_CHANNEL_ID);
State state = OnOffType.from(dp.Value.equals(String.valueOf(STATE_RUNNING)));
logger.trace("Update state of {} to {} through '{}'", channelUid, state, dp.Name);
updateState(channelUid, state);
}
/**
* Update raw value channels for properties already mapped to text channels.
* Currently ApplianceChannelSelector only supports 1:1 mapping from property
* to channel.
*/
private void updateRawChannel(String propertyName, String value) {
String channelId;
switch (propertyName) {
case STATE_PROPERTY_NAME:
channelId = STATE_CHANNEL_ID;
break;
case PROGRAM_ID_PROPERTY_NAME:
channelId = PROGRAM_CHANNEL_ID;
break;
default:
return;
}
ApplianceChannelSelector selector = null;
try {
selector = getValueSelectorFromChannelID(channelId);
} catch (IllegalArgumentException e) {
logger.trace("{} is not a valid channel for a {}", channelId, modelID);
return;
}
ChannelUID channelUid = new ChannelUID(getThing().getUID(), channelId);
State state = selector.getState(value);
logger.trace("Update state of {} with getState '{}'", channelUid, state);
updateState(channelUid, state);
}
@Override
public void onApplianceRemoved() {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.GONE);
}
@Override
public void onApplianceAdded(HomeDevice appliance) {
Map<String, String> properties = editProperties();
String vendor = appliance.Vendor;
if (vendor != null) {
properties.put(Thing.PROPERTY_VENDOR, vendor);
}
properties.put(Thing.PROPERTY_MODEL_ID, appliance.getApplianceModel());
properties.put(Thing.PROPERTY_SERIAL_NUMBER, appliance.getSerialNumber());
properties.put(Thing.PROPERTY_FIRMWARE_VERSION, appliance.getFirmwareVersion());
String protocolAdapterName = appliance.ProtocolAdapterName;
if (protocolAdapterName != null) {
properties.put(PROPERTY_PROTOCOL_ADAPTER, protocolAdapterName);
}
String deviceClass = appliance.getDeviceClass();
if (deviceClass != null) {
properties.put(PROPERTY_DEVICE_CLASS, deviceClass);
}
String connectionType = appliance.getConnectionType();
if (connectionType != null) {
properties.put(PROPERTY_CONNECTION_TYPE, connectionType);
}
String connectionBaudRate = appliance.getConnectionBaudRate();
if (connectionBaudRate != null) {
properties.put(PROPERTY_CONNECTION_BAUD_RATE, connectionBaudRate);
}
updateProperties(properties);
updateStatus(ThingStatus.ONLINE);
}
protected synchronized @Nullable MieleBridgeHandler getMieleBridgeHandler() {
if (this.bridgeHandler == null) {
Bridge bridge = getBridge();
if (bridge == null) {
return null;
}
ThingHandler handler = bridge.getHandler();
if (handler instanceof MieleBridgeHandler) {
this.bridgeHandler = (MieleBridgeHandler) handler;
}
}
return this.bridgeHandler;
}
protected boolean isResultProcessable(JsonElement result) {
return !result.isJsonNull();
}
}