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.konnected.internal.handler;
15 import static org.openhab.binding.konnected.internal.KonnectedBindingConstants.*;
17 import java.math.BigDecimal;
18 import java.util.Arrays;
20 import java.util.Map.Entry;
21 import java.util.concurrent.TimeUnit;
23 import org.openhab.binding.konnected.internal.KonnectedConfiguration;
24 import org.openhab.binding.konnected.internal.KonnectedHTTPUtils;
25 import org.openhab.binding.konnected.internal.KonnectedHttpRetryExceeded;
26 import org.openhab.binding.konnected.internal.gson.KonnectedModuleGson;
27 import org.openhab.binding.konnected.internal.gson.KonnectedModulePayload;
28 import org.openhab.core.config.core.Configuration;
29 import org.openhab.core.config.core.validation.ConfigValidationException;
30 import org.openhab.core.library.types.OnOffType;
31 import org.openhab.core.library.types.QuantityType;
32 import org.openhab.core.library.unit.SIUnits;
33 import org.openhab.core.library.unit.Units;
34 import org.openhab.core.thing.Channel;
35 import org.openhab.core.thing.ChannelUID;
36 import org.openhab.core.thing.Thing;
37 import org.openhab.core.thing.ThingStatus;
38 import org.openhab.core.thing.ThingStatusDetail;
39 import org.openhab.core.thing.binding.BaseThingHandler;
40 import org.openhab.core.types.Command;
41 import org.openhab.core.types.RefreshType;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
45 import com.google.gson.Gson;
46 import com.google.gson.GsonBuilder;
49 * The {@link KonnectedHandler} is responsible for handling commands, which are
50 * sent to one of the channels.
52 * @author Zachary Christiansen - Initial contribution
54 public class KonnectedHandler extends BaseThingHandler {
55 private final Logger logger = LoggerFactory.getLogger(KonnectedHandler.class);
56 private KonnectedConfiguration config;
58 private final String konnectedServletPath;
59 private final KonnectedHTTPUtils http = new KonnectedHTTPUtils(30);
60 private String callbackIpAddress = null;
61 private String moduleIpAddress;
62 private Gson gson = new GsonBuilder().create();
63 private int retryCount;
66 * This is the constructor of the Konnected Handler.
68 * @param thing the instance of the Konnected thing
69 * @param webHookServlet the instance of the callback servlet that is running for communication with the Konnected
71 * @param hostAddress the webaddress of the openHAB server instance obtained by the runtime
72 * @param port the port on which the openHAB instance is running that was obtained by the runtime.
74 public KonnectedHandler(Thing thing, String path, String hostAddress, String port) {
77 this.konnectedServletPath = path;
78 callbackIpAddress = hostAddress + ":" + port;
79 logger.debug("The callback ip address is: {}", callbackIpAddress);
84 public void handleCommand(ChannelUID channelUID, Command command) {
85 // get the zone number in integer form
86 Channel channel = this.getThing().getChannel(channelUID.getId());
87 String channelType = channel.getChannelTypeUID().getAsString();
88 String zoneNumber = (String) channel.getConfiguration().get(CHANNEL_ZONE);
89 Integer zone = Integer.parseInt(zoneNumber);
90 logger.debug("The channelUID is: {} and the zone is : {}", channelUID.getAsString(), zone);
91 // convert the zone to the pin based on value at index of zone
92 Integer pin = Arrays.asList(PIN_TO_ZONE).get(zone);
93 // if the command is OnOfftype
94 if (command instanceof OnOffType) {
95 if (channelType.equalsIgnoreCase(CHANNEL_SWITCH)) {
96 logger.debug("A command was sent to a sensor type so we are ignoring the command");
98 int sendCommand = (OnOffType.OFF.compareTo((OnOffType) command));
99 logger.debug("The command being sent to pin {} for channel:{} is {}", pin, channelUID.getAsString(),
101 sendActuatorCommand(Integer.toString(sendCommand), pin, channelUID);
103 } else if (command instanceof RefreshType) {
104 // check to see if handler has been initialized before attempting to get state of pin, else wait one minute
105 if (this.isInitialized()) {
106 getSwitchState(pin, channelUID);
108 scheduler.schedule(() -> {
109 handleCommand(channelUID, command);
110 }, 1, TimeUnit.MINUTES);
116 * Process a {@link WebHookEvent} that has been received by the Servlet from a Konnected module with respect to a
117 * sensor event or status update request
119 * @param event the {@link KonnectedModuleGson} event that contains the state and pin information to be processed
121 public void handleWebHookEvent(KonnectedModuleGson event) {
122 // if we receive a command upteate the thing status to being online
123 updateStatus(ThingStatus.ONLINE);
124 // get the zone number based off of the index location of the pin value
125 String sentZone = Integer.toString(Arrays.asList(PIN_TO_ZONE).indexOf(event.getPin()));
126 // check that the zone number is in one of the channelUID definitions
127 logger.debug("Looping Through all channels on thing: {} to find a match for {}", thing.getUID().getAsString(),
128 event.getAuthToken());
129 getThing().getChannels().forEach(channel -> {
130 ChannelUID channelId = channel.getUID();
131 String zoneNumber = (String) channel.getConfiguration().get(CHANNEL_ZONE);
132 // if the string zone that was sent equals the last digit of the channelId found process it as the
133 // channelId else do nothing
134 if (sentZone.equalsIgnoreCase(zoneNumber)) {
136 "The configrued zone of channelID: {} was a match for the zone sent by the alarm panel: {} on thing: {}",
137 channelId, sentZone, this.getThing().getUID().getId());
138 String channelType = channel.getChannelTypeUID().getAsString();
139 logger.debug("The channeltypeID is: {}", channelType);
140 // check if the itemType has been defined for the zone received
141 // check the itemType of the Zone, if Contact, send the State if Temp send Temp, etc.
142 if (channelType.equalsIgnoreCase(CHANNEL_SWITCH) || channelType.equalsIgnoreCase(CHANNEL_ACTUATOR)) {
143 OnOffType onOffType = event.getState().equalsIgnoreCase(getOnState(channel)) ? OnOffType.ON
145 updateState(channelId, onOffType);
146 } else if (channelType.equalsIgnoreCase(CHANNEL_HUMIDITY)) {
147 // if the state is of type number then this means it is the humidity channel of the dht22
148 updateState(channelId, new QuantityType<>(Double.parseDouble(event.getHumi()), Units.PERCENT));
149 } else if (channelType.equalsIgnoreCase(CHANNEL_TEMPERATURE)) {
150 Configuration configuration = channel.getConfiguration();
151 if (((Boolean) configuration.get(CHANNEL_TEMPERATURE_TYPE))) {
152 updateState(channelId,
153 new QuantityType<>(Double.parseDouble(event.getTemp()), SIUnits.CELSIUS));
155 // need to check to make sure right dsb1820 address
156 logger.debug("The address of the DSB1820 sensor received from modeule {} is: {}",
157 this.thing.getUID(), event.getAddr());
158 if (event.getAddr().toString()
159 .equalsIgnoreCase((String) (configuration.get(CHANNEL_TEMPERATURE_DS18B20_ADDRESS)))) {
160 updateState(channelId,
161 new QuantityType<>(Double.parseDouble(event.getTemp()), SIUnits.CELSIUS));
163 logger.debug("The address of {} does not match {} not updating this channel",
164 event.getAddr().toString(),
165 (configuration.get(CHANNEL_TEMPERATURE_DS18B20_ADDRESS)));
171 "The zone number sent by the alarm panel: {} was not a match the configured zone for channelId: {} for thing {}",
172 sentZone, channelId, getThing().getThingTypeUID().toString());
177 private void checkConfiguration() throws ConfigValidationException {
178 logger.debug("Checking configuration on thing {}", this.getThing().getUID().getAsString());
179 Configuration testConfig = this.getConfig();
180 String testRetryCount = testConfig.get(RETRY_COUNT).toString();
181 String testRequestTimeout = testConfig.get(REQUEST_TIMEOUT).toString();
182 logger.debug("The RequestTimeout Parameter is Configured as: {}", testRequestTimeout);
183 logger.debug("The Retry Count Parameter is Configured as: {}", testRetryCount);
185 this.retryCount = Integer.parseInt(testRetryCount);
186 } catch (NumberFormatException e) {
188 "Please check your configuration of the Retry Count as it is not an Integer. It is configured as: {}, will contintue to configure the binding with the default of 2",
193 this.http.setRequestTimeout(Integer.parseInt(testRequestTimeout));
194 } catch (NumberFormatException e) {
196 "Please check your configuration of the Request Timeout as it is not an Integer. It is configured as: {}, will contintue to configure the binding with the default of 30",
200 if ((callbackIpAddress == null)) {
201 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
202 "Unable to obtain hostaddress from OSGI service, please configure hostaddress");
206 this.config = getConfigAs(KonnectedConfiguration.class);
211 public void handleConfigurationUpdate(Map<String, Object> configurationParameters)
212 throws ConfigValidationException {
213 this.validateConfigurationParameters(configurationParameters);
214 for (Entry<String, Object> configurationParameter : configurationParameters.entrySet()) {
215 Object value = configurationParameter.getValue();
216 logger.debug("Controller Configuration update {} to {}", configurationParameter.getKey(), value);
221 // this is a nonstandard implementation to to address the configuration of the konnected alarm panel (as
222 // opposed to the handler) until
223 // https://github.com/eclipse/smarthome/issues/3484 has been implemented in the framework
224 String[] cfg = configurationParameter.getKey().split("_");
225 if ("controller".equals(cfg[0])) {
226 if (cfg[1].equals("softreset") && value instanceof Boolean && (Boolean) value) {
227 scheduler.execute(() -> {
229 http.doGet(moduleIpAddress + "/settings?restart=true", null, retryCount);
230 } catch (KonnectedHttpRetryExceeded e) {
231 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
235 } else if (cfg[1].equals("removewifi") && value instanceof Boolean && (Boolean) value) {
236 scheduler.execute(() -> {
238 http.doGet(moduleIpAddress + "/settings?restore=true", null, retryCount);
239 } catch (KonnectedHttpRetryExceeded e) {
240 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
244 } else if (cfg[1].equals("sendConfig") && value instanceof Boolean && (Boolean) value) {
245 scheduler.execute(() -> {
247 String response = updateKonnectedModule();
248 logger.trace("The response from the konnected module with thingID {} was {}",
249 getThing().getUID().toString(), response);
250 if (response == null) {
251 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
252 "Unable to communicate with Konnected Module.");
254 updateStatus(ThingStatus.ONLINE);
256 } catch (KonnectedHttpRetryExceeded e) {
257 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
265 super.handleConfigurationUpdate(configurationParameters);
269 String response = updateKonnectedModule();
270 logger.trace("The response from the konnected module with thingID {} was {}",
271 getThing().getUID().toString(), response);
272 if (response == null) {
273 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
274 "Unable to communicate with Konnected Module confirm settings.");
276 updateStatus(ThingStatus.ONLINE);
278 } catch (KonnectedHttpRetryExceeded e) {
279 logger.trace("The number of retries was exceeeded during the HandleConfigurationUpdate(): {}",
281 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
286 public void initialize() {
287 updateStatus(ThingStatus.UNKNOWN);
289 checkConfiguration();
290 } catch (ConfigValidationException e) {
291 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
293 this.moduleIpAddress = this.getThing().getProperties().get(HOST).toString();
294 scheduler.execute(() -> {
296 String response = updateKonnectedModule();
297 if (response == null) {
298 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
299 "Unable to communicate with Konnected Module confirm settings or readd thing.");
301 updateStatus(ThingStatus.ONLINE);
303 } catch (KonnectedHttpRetryExceeded e) {
304 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
310 public void dispose() {
311 logger.debug("Running dispose()");
316 * This method constructs the payload that will be sent
317 * to the Konnected module via the put request
318 * it adds the appropriate sensors and actuators to the {@link KonnectedModulePayload}
319 * as well as the location of the callback {@link KonnectedJTTPServlet}
320 * and auth_token which can be used for validation
322 * @return a json settings payload which can be sent to the Konnected Module based on the Thing
324 private String constructSettingsPayload() {
325 String hostPath = "";
326 hostPath = callbackIpAddress + this.konnectedServletPath;
327 String authToken = getThing().getUID().getAsString();
328 logger.debug("The Auth_Token is: {}", authToken);
329 KonnectedModulePayload payload = new KonnectedModulePayload(authToken, "http://" + hostPath);
330 payload.setBlink(config.blink);
331 payload.setDiscovery(config.discovery);
332 this.getThing().getChannels().forEach(channel -> {
333 // ChannelUID channelId = channel.getUID();
334 if (isLinked(channel.getUID())) {
335 // adds linked channels to list based on last value of Channel ID
336 // which is set to a number
337 // get the zone number in integer form
338 String zoneNumber = (String) channel.getConfiguration().get(CHANNEL_ZONE);
339 Integer zone = Integer.parseInt(zoneNumber);
340 // convert the zone to the pin based on value at index of zone
341 Integer pin = Arrays.asList(PIN_TO_ZONE).get(zone);
342 // if the pin is an actuator add to actuator string
343 // else add to sensor string
344 // This is determined based off of the accepted item type, contact types are sensors
345 // switch types are actuators
346 String channelType = channel.getChannelTypeUID().getAsString();
347 logger.debug("The channeltypeID is: {}", channelType);
348 KonnectedModuleGson module = new KonnectedModuleGson();
350 if (channelType.equalsIgnoreCase(CHANNEL_SWITCH)) {
351 payload.addSensor(module);
352 logger.trace("Channel {} will be configured on the konnected alarm panel as a switch",
354 } else if (channelType.equalsIgnoreCase(CHANNEL_ACTUATOR)) {
355 payload.addActuators(module);
356 logger.trace("Channel {} will be configured on the konnected alarm panel as an actuator",
358 } else if (channelType.equalsIgnoreCase(CHANNEL_HUMIDITY)) {
359 // the humidity channels do not need to be added because the supported sensor (dht22) is added under
361 logger.trace("Channel {} is a humidity channel.", channel.toString());
362 } else if (channelType.equalsIgnoreCase(CHANNEL_TEMPERATURE)) {
363 logger.trace("Channel {} will be configured on the konnected alarm panel as a temperature sensor",
365 Configuration configuration = channel.getConfiguration();
366 if (configuration.get(CHANNEL_TEMPERATRUE_POLL) == null) {
367 module.setPollInterval(3);
369 module.setPollInterval(((BigDecimal) configuration.get(CHANNEL_TEMPERATRUE_POLL)).intValue());
371 logger.trace("The Temperature Sensor Type is: {} ",
372 configuration.get(CHANNEL_TEMPERATURE_TYPE).toString());
373 if ((boolean) configuration.get(CHANNEL_TEMPERATURE_TYPE)) {
374 // add it as a dht22 module
375 payload.addDht22(module);
377 "Channel {} will be configured on the konnected alarm panel as a DHT22 temperature sensor",
380 // add to payload as a DS18B20 module if the parameter is false
381 payload.addDs18b20(module);
383 "Channel {} will be configured on the konnected alarm panel as a DS18B20 temperature sensor",
387 logger.debug("Channel {} is of type {} which is not supported by the konnected binding",
388 channel.toString(), channelType);
391 logger.debug("The Channel {} is not linked to an item", channel.getUID());
394 // Create Json to Send to Konnected Module
396 String payloadString = gson.toJson(payload);
397 logger.debug("The payload is: {}", payloadString);
398 return payloadString;
402 * Prepares and sends the {@link KonnectedModulePayload} via the {@link KonnectedHttpUtils}
404 * @return response obtained from sending the settings payload to Konnected module defined by the thing
406 * @throws KonnectedHttpRetryExceeded if unable to communicate with the Konnected module defined by the Thing
408 private String updateKonnectedModule() throws KonnectedHttpRetryExceeded {
409 String payload = constructSettingsPayload();
410 String response = http.doPut(moduleIpAddress + "/settings", payload, retryCount);
411 logger.debug("The response of the put request was: {}", response);
416 * Sends a command to the module via {@link KonnectedHTTPUtils}
418 * @param scommand the string command, either 0 or 1 to send to the actutor pin on the Konnected module
419 * @param pin the pin to send the command to on the Konnected Module
421 private void sendActuatorCommand(String scommand, Integer pin, ChannelUID channelId) {
423 Channel channel = getThing().getChannel(channelId.getId());
424 if (!(channel == null)) {
425 logger.debug("getasstring: {} getID: {} getGroupId: {} toString:{}", channelId.getAsString(),
426 channelId.getId(), channelId.getGroupId(), channelId.toString());
427 Configuration configuration = channel.getConfiguration();
428 KonnectedModuleGson payload = new KonnectedModuleGson();
429 payload.setState(scommand);
431 // check to see if this is an On Command type, if so add the momentary, pause, times to the payload if
432 // they exist on the configuration.
433 if (scommand.equals(getOnState(channel))) {
434 if (configuration.get(CHANNEL_ACTUATOR_TIMES) == null) {
436 "The times configuration was not set for channelID: {}, not adding it to the payload.",
437 channelId.toString());
439 payload.setTimes(configuration.get(CHANNEL_ACTUATOR_TIMES).toString());
440 logger.debug("The times configuration was set to: {} for channelID: {}.",
441 configuration.get(CHANNEL_ACTUATOR_TIMES).toString(), channelId.toString());
443 if (configuration.get(CHANNEL_ACTUATOR_MOMENTARY) == null) {
445 "The momentary configuration was not set for channelID: {}, not adding it to the payload.",
446 channelId.toString());
448 payload.setMomentary(configuration.get(CHANNEL_ACTUATOR_MOMENTARY).toString());
449 logger.debug("The momentary configuration set to: {} channelID: {}.",
450 configuration.get(CHANNEL_ACTUATOR_MOMENTARY).toString(), channelId.toString());
452 if (configuration.get(CHANNEL_ACTUATOR_PAUSE) == null) {
454 "The pause configuration was not set for channelID: {}, not adding it to the payload.",
455 channelId.toString());
457 payload.setPause(configuration.get(CHANNEL_ACTUATOR_PAUSE).toString());
458 logger.debug("The pause configuration was set to: {} for channelID: {}.",
459 configuration.get(CHANNEL_ACTUATOR_PAUSE).toString(), channelId.toString());
462 String payloadString = gson.toJson(payload);
463 logger.debug("The command payload is: {}", payloadString);
464 http.doPut(moduleIpAddress + "/device", payloadString, retryCount);
466 logger.debug("The channel {} returned null for channelId.getID(): {}", channelId.toString(),
469 } catch (KonnectedHttpRetryExceeded e) {
470 logger.debug("Attempting to set the state of the actuator on thing {} failed: {}",
471 this.thing.getUID().getId(), e.getMessage());
472 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
473 "Unable to communicate with Konnected Alarm Panel confirm settings, and that module is online.");
477 private void getSwitchState(Integer pin, ChannelUID channelId) {
478 Channel channel = getThing().getChannel(channelId.getId());
479 if (!(channel == null)) {
480 logger.debug("getasstring: {} getID: {} getGroupId: {} toString:{}", channelId.getAsString(),
481 channelId.getId(), channelId.getGroupId(), channelId.toString());
482 KonnectedModuleGson payload = new KonnectedModuleGson();
484 String payloadString = gson.toJson(payload);
485 logger.debug("The command payload is: {}", payloadString);
487 sendSetSwitchState(payloadString);
488 } catch (KonnectedHttpRetryExceeded e) {
489 // try to get the state of the device one more time 30 seconds later. This way it can be confirmed if
490 // the device was simply in a reboot loop when device state was attempted the first time
491 scheduler.schedule(() -> {
493 sendSetSwitchState(payloadString);
494 } catch (KonnectedHttpRetryExceeded ex) {
495 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
496 "Unable to communicate with Konnected Alarm Panel confirm settings, and that module is online.");
497 logger.debug("Attempting to get the state of the zone on thing {} failed for channel: {} : {}",
498 this.thing.getUID().getId(), channelId.getAsString(), ex.getMessage());
500 }, 2, TimeUnit.MINUTES);
503 logger.debug("The channel {} returned null for channelId.getID(): {}", channelId.toString(),
508 private void sendSetSwitchState(String payloadString) throws KonnectedHttpRetryExceeded {
509 String response = http.doGet(moduleIpAddress + "/device", payloadString, retryCount);
510 KonnectedModuleGson event = gson.fromJson(response, KonnectedModuleGson.class);
511 this.handleWebHookEvent(event);
514 private String getOnState(Channel channel) {
515 String config = (String) channel.getConfiguration().get(CHANNEL_ONVALUE);
516 if (config == null) {