2 * Copyright (c) 2010-2022 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.insteon.internal.handler;
15 import java.lang.reflect.Type;
16 import java.math.BigDecimal;
17 import java.util.ArrayList;
18 import java.util.Collections;
19 import java.util.HashMap;
20 import java.util.HashSet;
21 import java.util.List;
23 import java.util.Objects;
25 import java.util.stream.Collectors;
26 import java.util.stream.Stream;
28 import org.eclipse.jdt.annotation.NonNullByDefault;
29 import org.eclipse.jdt.annotation.Nullable;
30 import org.openhab.binding.insteon.internal.InsteonBinding;
31 import org.openhab.binding.insteon.internal.InsteonBindingConstants;
32 import org.openhab.binding.insteon.internal.config.InsteonChannelConfiguration;
33 import org.openhab.binding.insteon.internal.config.InsteonDeviceConfiguration;
34 import org.openhab.binding.insteon.internal.device.DeviceFeature;
35 import org.openhab.binding.insteon.internal.device.DeviceTypeLoader;
36 import org.openhab.binding.insteon.internal.device.InsteonAddress;
37 import org.openhab.binding.insteon.internal.device.InsteonDevice;
38 import org.openhab.core.thing.Bridge;
39 import org.openhab.core.thing.Channel;
40 import org.openhab.core.thing.ChannelUID;
41 import org.openhab.core.thing.Thing;
42 import org.openhab.core.thing.ThingStatus;
43 import org.openhab.core.thing.ThingStatusDetail;
44 import org.openhab.core.thing.binding.BaseThingHandler;
45 import org.openhab.core.thing.binding.ThingHandlerCallback;
46 import org.openhab.core.thing.type.ChannelTypeUID;
47 import org.openhab.core.types.Command;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
51 import com.google.gson.Gson;
52 import com.google.gson.JsonParseException;
53 import com.google.gson.reflect.TypeToken;
56 * The {@link InsteonDeviceHandler} is responsible for handling commands, which are
57 * sent to one of the channels.
59 * @author Rob Nielsen - Initial contribution
62 public class InsteonDeviceHandler extends BaseThingHandler {
64 private static final Set<String> ALL_CHANNEL_IDS = Collections.unmodifiableSet(Stream.of(
65 InsteonBindingConstants.AC_DELAY, InsteonBindingConstants.BACKLIGHT_DURATION,
66 InsteonBindingConstants.BATTERY_LEVEL, InsteonBindingConstants.BATTERY_PERCENT,
67 InsteonBindingConstants.BATTERY_WATERMARK_LEVEL, InsteonBindingConstants.BEEP,
68 InsteonBindingConstants.BOTTOM_OUTLET, InsteonBindingConstants.BUTTON_A, InsteonBindingConstants.BUTTON_B,
69 InsteonBindingConstants.BUTTON_C, InsteonBindingConstants.BUTTON_D, InsteonBindingConstants.BUTTON_E,
70 InsteonBindingConstants.BUTTON_F, InsteonBindingConstants.BUTTON_G, InsteonBindingConstants.BUTTON_H,
71 InsteonBindingConstants.BROADCAST_ON_OFF, InsteonBindingConstants.CONTACT,
72 InsteonBindingConstants.COOL_SET_POINT, InsteonBindingConstants.DIMMER, InsteonBindingConstants.FAN,
73 InsteonBindingConstants.FAN_MODE, InsteonBindingConstants.FAST_ON_OFF,
74 InsteonBindingConstants.FAST_ON_OFF_BUTTON_A, InsteonBindingConstants.FAST_ON_OFF_BUTTON_B,
75 InsteonBindingConstants.FAST_ON_OFF_BUTTON_C, InsteonBindingConstants.FAST_ON_OFF_BUTTON_D,
76 InsteonBindingConstants.FAST_ON_OFF_BUTTON_E, InsteonBindingConstants.FAST_ON_OFF_BUTTON_F,
77 InsteonBindingConstants.FAST_ON_OFF_BUTTON_G, InsteonBindingConstants.FAST_ON_OFF_BUTTON_H,
78 InsteonBindingConstants.HEAT_SET_POINT, InsteonBindingConstants.HUMIDITY,
79 InsteonBindingConstants.HUMIDITY_HIGH, InsteonBindingConstants.HUMIDITY_LOW,
80 InsteonBindingConstants.IS_COOLING, InsteonBindingConstants.IS_HEATING,
81 InsteonBindingConstants.KEYPAD_BUTTON_A, InsteonBindingConstants.KEYPAD_BUTTON_B,
82 InsteonBindingConstants.KEYPAD_BUTTON_C, InsteonBindingConstants.KEYPAD_BUTTON_D,
83 InsteonBindingConstants.KEYPAD_BUTTON_E, InsteonBindingConstants.KEYPAD_BUTTON_F,
84 InsteonBindingConstants.KEYPAD_BUTTON_G, InsteonBindingConstants.KEYPAD_BUTTON_H,
85 InsteonBindingConstants.KWH, InsteonBindingConstants.LAST_HEARD_FROM,
86 InsteonBindingConstants.LED_BRIGHTNESS, InsteonBindingConstants.LED_ONOFF,
87 InsteonBindingConstants.LIGHT_DIMMER, InsteonBindingConstants.LIGHT_LEVEL,
88 InsteonBindingConstants.LIGHT_LEVEL_ABOVE_THRESHOLD, InsteonBindingConstants.LOAD_DIMMER,
89 InsteonBindingConstants.LOAD_SWITCH, InsteonBindingConstants.LOAD_SWITCH_FAST_ON_OFF,
90 InsteonBindingConstants.LOAD_SWITCH_MANUAL_CHANGE, InsteonBindingConstants.LOWBATTERY,
91 InsteonBindingConstants.MANUAL_CHANGE, InsteonBindingConstants.MANUAL_CHANGE_BUTTON_A,
92 InsteonBindingConstants.MANUAL_CHANGE_BUTTON_B, InsteonBindingConstants.MANUAL_CHANGE_BUTTON_C,
93 InsteonBindingConstants.MANUAL_CHANGE_BUTTON_D, InsteonBindingConstants.MANUAL_CHANGE_BUTTON_E,
94 InsteonBindingConstants.MANUAL_CHANGE_BUTTON_F, InsteonBindingConstants.MANUAL_CHANGE_BUTTON_G,
95 InsteonBindingConstants.MANUAL_CHANGE_BUTTON_H, InsteonBindingConstants.NOTIFICATION,
96 InsteonBindingConstants.ON_LEVEL, InsteonBindingConstants.RAMP_DIMMER, InsteonBindingConstants.RAMP_RATE,
97 InsteonBindingConstants.RESET, InsteonBindingConstants.STAGE1_DURATION, InsteonBindingConstants.SWITCH,
98 InsteonBindingConstants.SYSTEM_MODE, InsteonBindingConstants.TAMPER_SWITCH,
99 InsteonBindingConstants.TEMPERATURE, InsteonBindingConstants.TEMPERATURE_LEVEL,
100 InsteonBindingConstants.TOP_OUTLET, InsteonBindingConstants.UPDATE, InsteonBindingConstants.WATTS)
101 .collect(Collectors.toSet()));
103 public static final String BROADCAST_GROUPS = "broadcastGroups";
104 public static final String BROADCAST_ON_OFF = "broadcastonoff";
105 public static final String CMD = "cmd";
106 public static final String CMD_RESET = "reset";
107 public static final String CMD_UPDATE = "update";
108 public static final String DATA = "data";
109 public static final String FIELD = "field";
110 public static final String FIELD_BATTERY_LEVEL = "battery_level";
111 public static final String FIELD_BATTERY_PERCENTAGE = "battery_percentage";
112 public static final String FIELD_BATTERY_WATERMARK_LEVEL = "battery_watermark_level";
113 public static final String FIELD_KWH = "kwh";
114 public static final String FIELD_LIGHT_LEVEL = "light_level";
115 public static final String FIELD_TEMPERATURE_LEVEL = "temperature_level";
116 public static final String FIELD_WATTS = "watts";
117 public static final String GROUP = "group";
118 public static final String METER = "meter";
120 public static final String HIDDEN_DOOR_SENSOR_PRODUCT_KEY = "F00.00.03";
121 public static final String MOTION_SENSOR_II_PRODUCT_KEY = "F00.00.24";
122 public static final String MOTION_SENSOR_PRODUCT_KEY = "0x00004A";
123 public static final String PLM_PRODUCT_KEY = "0x000045";
124 public static final String POWER_METER_PRODUCT_KEY = "F00.00.17";
126 private final Logger logger = LoggerFactory.getLogger(InsteonDeviceHandler.class);
128 private @Nullable InsteonDeviceConfiguration config;
130 public InsteonDeviceHandler(Thing thing) {
135 public void initialize() {
136 config = getConfigAs(InsteonDeviceConfiguration.class);
138 scheduler.execute(() -> {
139 if (getBridge() == null) {
140 String msg = "An Insteon network bridge has not been selected for this device.";
141 logger.warn("{} {}", thing.getUID().getAsString(), msg);
143 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
147 InsteonDeviceConfiguration config = this.config;
148 if (config == null) {
149 String msg = "Insteon device configuration is null.";
150 logger.warn("{} {}", thing.getUID().getAsString(), msg);
152 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
155 String address = config.getAddress();
156 if (!InsteonAddress.isValid(address)) {
157 String msg = "Unable to start Insteon device, the insteon or X10 address '" + address
158 + "' is invalid. It must be in the format 'AB.CD.EF' or 'H.U' (X10).";
159 logger.warn("{} {}", thing.getUID().getAsString(), msg);
161 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
165 DeviceTypeLoader instance = DeviceTypeLoader.instance();
166 if (instance == null) {
167 String msg = "Device type loader is null.";
168 logger.warn("{} {}", thing.getUID().getAsString(), msg);
170 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
174 String productKey = config.getProductKey();
175 if (instance.getDeviceType(productKey) == null) {
176 String msg = "Unable to start Insteon device, invalid product key '" + productKey + "'.";
177 logger.warn("{} {}", thing.getUID().getAsString(), msg);
179 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
183 String deviceConfig = config.getDeviceConfig();
184 Map<String, Object> deviceConfigMap;
185 if (deviceConfig != null) {
186 Type mapType = new TypeToken<Map<String, Object>>() {
189 deviceConfigMap = Objects.requireNonNull(new Gson().fromJson(deviceConfig, mapType));
190 } catch (JsonParseException e) {
191 String msg = "The device configuration parameter is not valid JSON.";
192 logger.warn("{} {}", thing.getUID().getAsString(), msg);
194 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
198 deviceConfigMap = Collections.emptyMap();
201 InsteonBinding insteonBinding = getInsteonBinding();
202 InsteonAddress insteonAddress = new InsteonAddress(address);
203 if (insteonBinding.getDevice(insteonAddress) != null) {
204 String msg = "A device already exists with the address '" + address + "'.";
205 logger.warn("{} {}", thing.getUID().getAsString(), msg);
207 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
211 InsteonDevice device = insteonBinding.makeNewDevice(insteonAddress, productKey, deviceConfigMap);
212 if (device == null) {
213 String msg = "Unable to create a device with the product key '" + productKey + "' with the address'"
215 logger.warn("{} {}", thing.getUID().getAsString(), msg);
217 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
221 ThingHandlerCallback callback = getCallback();
222 if (callback == null) {
223 String msg = "Unable to get thing handler callback.";
224 logger.warn("{} {}", thing.getUID().getAsString(), msg);
226 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
230 Map<String, Channel> channelMap = new HashMap<>();
231 String thingId = getThing().getUID().getAsString();
232 for (String channelId : ALL_CHANNEL_IDS) {
233 String feature = channelId.toLowerCase();
235 if (productKey.equals(HIDDEN_DOOR_SENSOR_PRODUCT_KEY)) {
236 if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_LEVEL)
237 || feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_WATERMARK_LEVEL)) {
240 } else if (productKey.equals(MOTION_SENSOR_PRODUCT_KEY)) {
241 if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_LEVEL)
242 || feature.equalsIgnoreCase(InsteonBindingConstants.LIGHT_LEVEL)) {
245 } else if (productKey.equals(MOTION_SENSOR_II_PRODUCT_KEY)) {
246 if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_LEVEL)
247 || feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_PERCENT)
248 || feature.equalsIgnoreCase(InsteonBindingConstants.LIGHT_LEVEL)
249 || feature.equalsIgnoreCase(InsteonBindingConstants.TEMPERATURE_LEVEL)) {
252 } else if (productKey.equals(PLM_PRODUCT_KEY)) {
253 String parts[] = feature.split("#");
254 if (parts.length == 2 && parts[0].equalsIgnoreCase(InsteonBindingConstants.BROADCAST_ON_OFF)
255 && parts[1].matches("^\\d+$")) {
256 feature = BROADCAST_ON_OFF;
258 } else if (productKey.equals(POWER_METER_PRODUCT_KEY)) {
259 if (feature.equalsIgnoreCase(InsteonBindingConstants.KWH)
260 || feature.equalsIgnoreCase(InsteonBindingConstants.RESET)
261 || feature.equalsIgnoreCase(InsteonBindingConstants.UPDATE)
262 || feature.equalsIgnoreCase(InsteonBindingConstants.WATTS)) {
267 DeviceFeature f = device.getFeature(feature);
269 if (!f.isFeatureGroup()) {
270 if (channelId.equals(InsteonBindingConstants.BROADCAST_ON_OFF)) {
271 Set<String> broadcastChannels = new HashSet<>();
272 for (Channel channel : thing.getChannels()) {
273 String id = channel.getUID().getId();
274 if (id.startsWith(InsteonBindingConstants.BROADCAST_ON_OFF)) {
275 channelMap.put(id, channel);
276 broadcastChannels.add(id);
280 Object groups = deviceConfigMap.get(BROADCAST_GROUPS);
281 if (groups != null) {
282 boolean valid = false;
283 if (groups instanceof List<?>) {
285 for (Object o : (List<?>) groups) {
286 if (o instanceof Double && (Double) o % 1 == 0) {
287 String id = InsteonBindingConstants.BROADCAST_ON_OFF + "#"
288 + ((Double) o).intValue();
289 if (!broadcastChannels.contains(id)) {
290 ChannelUID channelUID = new ChannelUID(thing.getUID(), id);
291 ChannelTypeUID channelTypeUID = new ChannelTypeUID(
292 InsteonBindingConstants.BINDING_ID,
293 InsteonBindingConstants.SWITCH);
294 Channel channel = callback
295 .createChannelBuilder(channelUID, channelTypeUID).withLabel(id)
298 channelMap.put(id, channel);
299 broadcastChannels.add(id);
309 String msg = "The value for key " + BROADCAST_GROUPS
310 + " must be an array of integers in the device configuration parameter.";
311 logger.warn("{} {}", thing.getUID().getAsString(), msg);
313 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
318 ChannelUID channelUID = new ChannelUID(thing.getUID(), channelId);
319 ChannelTypeUID channelTypeUID = new ChannelTypeUID(InsteonBindingConstants.BINDING_ID,
321 Channel channel = thing.getChannel(channelUID);
322 if (channel == null) {
323 channel = callback.createChannelBuilder(channelUID, channelTypeUID).build();
326 channelMap.put(channelId, channel);
329 logger.debug("{} is a feature group for {}. It will not be added as a channel.", feature,
335 if (!channelMap.isEmpty() || device.isModem()) {
336 List<Channel> channels = new ArrayList<>();
337 StringBuilder channelList = new StringBuilder();
338 if (!channelMap.isEmpty()) {
339 List<String> channelIds = new ArrayList<>(channelMap.keySet());
340 Collections.sort(channelIds);
341 channelIds.forEach(channelId -> {
342 Channel channel = channelMap.get(channelId);
343 if (channel != null) {
344 channels.add(channel);
346 if (channelList.length() > 0) {
347 channelList.append(", ");
349 channelList.append(channelId);
353 updateThing(editThing().withChannels(channels).build());
356 StringBuilder builder = new StringBuilder(thingId);
357 builder.append(" address = ");
358 builder.append(address);
359 builder.append(" productKey = ");
360 builder.append(productKey);
361 builder.append(" channels = ");
362 builder.append(channelList.toString());
363 String msg = builder.toString();
364 logger.debug("{}", msg);
366 getInsteonNetworkHandler().initialized(getThing().getUID(), msg);
368 channels.forEach(channel -> {
369 if (isLinked(channel.getUID())) {
370 channelLinked(channel.getUID());
374 updateStatus(ThingStatus.ONLINE);
376 String msg = "Product key '" + productKey
377 + "' does not have any features that match existing channels.";
379 logger.warn("{} {}", thing.getUID().getAsString(), msg);
381 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
387 public void dispose() {
388 InsteonDeviceConfiguration config = this.config;
389 if (config != null) {
390 String address = config.getAddress();
391 if (getBridge() != null && InsteonAddress.isValid(address)) {
392 getInsteonBinding().removeDevice(new InsteonAddress(address));
394 logger.debug("removed {} address = {}", getThing().getUID().getAsString(), address);
397 getInsteonNetworkHandler().disposed(getThing().getUID());
404 public void handleCommand(ChannelUID channelUID, Command command) {
405 logger.debug("channel {} was triggered with the command {}", channelUID.getAsString(), command);
407 getInsteonBinding().sendCommand(channelUID.getAsString(), command);
411 public void channelLinked(ChannelUID channelUID) {
412 if (getInsteonNetworkHandler().isChannelLinked(channelUID)) {
416 Map<String, String> params = new HashMap<>();
417 Channel channel = getThing().getChannel(channelUID.getId());
418 if (channel == null) {
419 logger.warn("channel is null");
423 Map<String, Object> channelProperties = channel.getConfiguration().getProperties();
424 for (String key : channelProperties.keySet()) {
425 Object value = channelProperties.get(key);
426 if (value instanceof String) {
427 params.put(key, (String) value);
428 } else if (value instanceof BigDecimal) {
429 String s = ((BigDecimal) value).toPlainString();
432 logger.warn("not a string or big decimal value key '{}' value '{}' {}", key, value,
433 value != null ? value.getClass().getName() : "unknown");
437 String feature = channelUID.getId().toLowerCase();
438 InsteonDeviceConfiguration config = this.config;
439 if (config == null) {
440 logger.warn("insteon device config is null");
443 String productKey = config.getProductKey();
444 if (productKey.equals(HIDDEN_DOOR_SENSOR_PRODUCT_KEY)) {
445 if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_LEVEL)) {
446 params.put(FIELD, FIELD_BATTERY_LEVEL);
448 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_WATERMARK_LEVEL)) {
449 params.put(FIELD, FIELD_BATTERY_WATERMARK_LEVEL);
452 } else if (productKey.equals(MOTION_SENSOR_PRODUCT_KEY)) {
453 if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_LEVEL)) {
454 params.put(FIELD, FIELD_BATTERY_LEVEL);
456 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.LIGHT_LEVEL)) {
457 params.put(FIELD, FIELD_LIGHT_LEVEL);
460 } else if (productKey.equals(MOTION_SENSOR_II_PRODUCT_KEY)) {
461 if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_LEVEL)) {
462 params.put(FIELD, FIELD_BATTERY_LEVEL);
464 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.BATTERY_PERCENT)) {
465 params.put(FIELD, FIELD_BATTERY_PERCENTAGE);
467 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.LIGHT_LEVEL)) {
468 params.put(FIELD, FIELD_LIGHT_LEVEL);
470 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.TEMPERATURE_LEVEL)) {
471 params.put(FIELD, FIELD_TEMPERATURE_LEVEL);
474 } else if (productKey.equals(PLM_PRODUCT_KEY)) {
475 String parts[] = feature.split("#");
476 if (parts.length == 2 && parts[0].equalsIgnoreCase(InsteonBindingConstants.BROADCAST_ON_OFF)
477 && parts[1].matches("^\\d+$")) {
478 params.put(GROUP, parts[1]);
479 feature = BROADCAST_ON_OFF;
481 } else if (productKey.equals(POWER_METER_PRODUCT_KEY)) {
482 if (feature.equalsIgnoreCase(InsteonBindingConstants.KWH)) {
483 params.put(FIELD, FIELD_KWH);
484 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.WATTS)) {
485 params.put(FIELD, FIELD_WATTS);
486 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.RESET)) {
487 params.put(CMD, CMD_RESET);
488 } else if (feature.equalsIgnoreCase(InsteonBindingConstants.UPDATE)) {
489 params.put(CMD, CMD_UPDATE);
495 InsteonChannelConfiguration bindingConfig = new InsteonChannelConfiguration(channelUID, feature,
496 new InsteonAddress(config.getAddress()), productKey, params);
497 getInsteonBinding().addFeatureListener(bindingConfig);
499 StringBuilder builder = new StringBuilder(channelUID.getAsString());
500 builder.append(" feature = ");
501 builder.append(feature);
502 builder.append(" parameters = ");
503 builder.append(params);
504 String msg = builder.toString();
505 logger.debug("{}", msg);
507 getInsteonNetworkHandler().linked(channelUID, msg);
511 public void channelUnlinked(ChannelUID channelUID) {
512 getInsteonBinding().removeFeatureListener(channelUID);
513 getInsteonNetworkHandler().unlinked(channelUID);
515 logger.debug("channel {} unlinked ", channelUID.getAsString());
518 private InsteonNetworkHandler getInsteonNetworkHandler() {
519 Bridge bridge = getBridge();
520 if (bridge == null) {
521 throw new IllegalArgumentException("insteon network bridge is null");
523 InsteonNetworkHandler handler = (InsteonNetworkHandler) bridge.getHandler();
524 if (handler == null) {
525 throw new IllegalArgumentException("insteon network handler is null");
530 private InsteonBinding getInsteonBinding() {
531 return getInsteonNetworkHandler().getInsteonBinding();