public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[lutron] Minor code and doc updates (#8795)

Browse Source 
* [lutron] Minor code and doc updates
* [lutron] Address review comments

Signed-off-by: Bob Adair <bob.github@att.net>
This commit is contained in:
Bob A
2020-10-21 14:50:49 -04:00
committed by GitHub
parent 52b7c8e920
commit 800b500e01
12 changed files with 104 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/StringUtils.java Normal file
View File

@@ -0,0 +1,36 @@
/**
* Copyright (c) 2010-2020 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.lutron.internal;
import java.util.Objects;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
/**
* Supply some string utility methods formerly provided by org.apache.commons.lang.StringUtils.
*
* @author Bob Adair - Initial contribution
*
*/
@NonNullByDefault
public class StringUtils {
public static boolean equals(@Nullable String s1, @Nullable String s2) {
return Objects.equals(s1, s2);
}
public static boolean isEmpty(@Nullable String s1) {
return (s1 == null || s1.isEmpty());
}
}

2
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/config/IPBridgeConfig.java
View File

@@ -12,7 +12,7 @@
*/
package org.openhab.binding.lutron.internal.config;
import org.apache.commons.lang.StringUtils;
import org.openhab.binding.lutron.internal.StringUtils;
/**
* Configuration settings for an {@link org.openhab.binding.lutron.internal.handler.IPBridgeHandler}.

5
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/GrafikEyeHandler.java
View File

@@ -15,7 +15,6 @@ package org.openhab.binding.lutron.internal.grxprg;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.apache.commons.lang.NullArgumentException;
import org.openhab.core.library.types.DecimalType;
import org.openhab.core.library.types.IncreaseDecreaseType;
import org.openhab.core.library.types.OnOffType;
@@ -332,12 +331,12 @@ public class GrafikEyeHandler extends BaseThingHandler {
private PrgProtocolHandler getProtocolHandler() {
final Bridge bridge = getBridge();
if (bridge == null || !(bridge.getHandler() instanceof PrgBridgeHandler)) {
throw new NullArgumentException("Cannot have a Grafix Eye thing outside of the PRG bridge");
throw new IllegalArgumentException("Cannot have a Grafix Eye thing outside of the PRG bridge");
}
final PrgProtocolHandler handler = ((PrgBridgeHandler) bridge.getHandler()).getProtocolHandler();
if (handler == null) {
throw new NullArgumentException("No protocol handler set in the PrgBridgeHandler!");
throw new IllegalArgumentException("No protocol handler set in the PrgBridgeHandler!");
}
return handler;
}

5
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/PrgProtocolHandler.java
View File

@@ -24,7 +24,6 @@ import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang.NullArgumentException;
import org.openhab.core.library.types.DateTimeType;
import org.openhab.core.library.types.DecimalType;
import org.openhab.core.library.types.OnOffType;
@@ -629,11 +628,11 @@ class PrgProtocolHandler {
* Sets the time on the PRG interface
*
* @param calendar a non-null calendar to set the time to
* @throws NullArgumentException if calendar is null
* @throws IllegalArgumentException if calendar is null
*/
void setTime(Calendar calendar) {
if (calendar == null) {
throw new NullArgumentException("calendar cannot be null");
throw new IllegalArgumentException("calendar cannot be null");
}
final String cmd = String.format("%1 %2$tk %2$tM %2$tm %2$te %2ty %3", CMD_SETTIME, calendar,
calendar.get(Calendar.DAY_OF_WEEK));

6
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/CcoHandler.java
View File

@@ -15,8 +15,8 @@ package org.openhab.binding.lutron.internal.handler;
import static org.openhab.binding.lutron.internal.LutronBindingConstants.*;
import java.math.BigDecimal;
import java.util.Arrays;
import org.apache.commons.lang.StringUtils;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.lutron.internal.protocol.OutputCommand;
@@ -181,7 +181,7 @@ public class CcoHandler extends LutronHandler {
@Override
public void handleUpdate(LutronCommandType type, String... parameters) {
logger.debug("Update received for CCO: {} {}", type, StringUtils.join(parameters, ","));
logger.debug("Update received for CCO: {} {}", type, Arrays.asList(parameters));
if (outputType == CcoOutputType.MAINTAINED) {
if (type == LutronCommandType.OUTPUT && parameters.length > 1
@@ -193,7 +193,7 @@ public class CcoHandler extends LutronHandler {
BigDecimal state = new BigDecimal(parameters[1]);
updateState(CHANNEL_SWITCH, state.compareTo(BigDecimal.ZERO) == 0 ? OnOffType.OFF : OnOffType.ON);
} catch (NumberFormatException e) {
logger.warn("Unable to parse update {} {} from CCO {}", type, StringUtils.join(parameters, ","),
logger.warn("Unable to parse update {} {} from CCO {}", type, Arrays.asList(parameters),
integrationId);
return;
}

2
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/IPBridgeHandler.java
View File

@@ -25,7 +25,7 @@ import java.util.regex.MatchResult;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang.StringUtils;
import org.openhab.binding.lutron.internal.StringUtils;
import org.openhab.binding.lutron.internal.config.IPBridgeConfig;
import org.openhab.binding.lutron.internal.discovery.LutronDeviceDiscoveryService;
import org.openhab.binding.lutron.internal.net.TelnetSession;

8
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/LeapBridgeHandler.java
View File

@@ -281,8 +281,8 @@ public class LeapBridgeHandler extends LutronBridgeHandler implements LeapMessag
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, "Invalid port number");
return;
} catch (InterruptedIOException e) {
Thread.currentThread().interrupt();
logger.debug("Interrupted while establishing connection");
Thread.currentThread().interrupt();
return;
} catch (IOException e) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
@@ -337,9 +337,6 @@ public class LeapBridgeHandler extends LutronBridgeHandler implements LeapMessag
private synchronized void disconnect(boolean interruptAll) {
logger.debug("Disconnecting");
Thread senderThread = this.senderThread;
Thread readerThread = this.readerThread;
ScheduledFuture<?> connectRetryJob = this.connectRetryJob;
if (connectRetryJob != null) {
connectRetryJob.cancel(true);
@@ -351,9 +348,12 @@ public class LeapBridgeHandler extends LutronBridgeHandler implements LeapMessag
reconnectTaskCancel(interruptAll); // May be called from keepAliveReconnectJob thread
Thread senderThread = this.senderThread;
if (senderThread != null && senderThread.isAlive()) {
senderThread.interrupt();
}
Thread readerThread = this.readerThread;
if (readerThread != null && readerThread.isAlive()) {
readerThread.interrupt();
}

5
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/DeviceCommand.java
View File

@@ -102,7 +102,10 @@ public class DeviceCommand extends LutronCommandNew {
} else if (targetType == TargetType.VIRTUALKEYPAD) {
if (action.equals(DeviceCommand.ACTION_PRESS)) {
return new LeapCommand(Request.virtualButtonCommand(component, CommandType.PRESSANDRELEASE));
} else if (!action.equals(DeviceCommand.ACTION_RELEASE)) {
} else if (action.equals(DeviceCommand.ACTION_RELEASE)) {
logger.trace("Ignoring release command for virtual keypad button.");
return null;
} else {
logger.debug("Ignoring device command with unsupported action.");
return null;
}

6
bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/leap/LeapMessageParser.java
View File

@@ -38,7 +38,11 @@ import com.google.gson.JsonParser;
import com.google.gson.JsonSyntaxException;
/**
* Class responsible for parsing incoming LEAP messages
* Class responsible for parsing incoming LEAP messages. Calls back to an object implementing the
* LeapMessageParserCallbacks interface.
*
* Thanks to the authors of the pylutron-caseta Python API (github.com/gurumitts/pylutron-caseta), which I used as a
* reference when first researching the LEAP protocol.
*
* @author Bob Adair - Initial contribution
*/

49
bundles/org.openhab.binding.lutron/src/main/resources/OH-INF/thing/thing-types.xml
View File

@@ -6,7 +6,7 @@
<bridge-type id="ipbridge">
<label>Lutron IP Access Point</label>
<description>A Lutron controller using Lutron Integration Protocol (LIP) over TCP/IP</description>
<description>Lutron controller using Lutron Integration Protocol (LIP) over TCP/IP</description>
<properties>
<property name="vendor">Lutron</property>
</properties>
@@ -59,7 +59,7 @@
<bridge-type id="leapbridge">
<label>Lutron LEAP Access Point</label>
<description>A Lutron controller using LEAP protocol over TCP/IP</description>
<description>Lutron controller using LEAP protocol over TCP/IP</description>
<channels>
<channel id="command" typeId="command-type"/>
@@ -132,8 +132,9 @@
<bridge-type-ref id="leapbridge"/>
</supported-bridge-type-refs>
<label>Maestro Dimmer</label>
<label>Lutron Dimmer</label>
<description>Controls dimmable loads</description>
<category>Lightbulb</category>
<channels>
<channel id="lightlevel" typeId="lightDimmer"/>
@@ -202,8 +203,9 @@
<bridge-type-ref id="leapbridge"/>
</supported-bridge-type-refs>
<label>Sivoia QS Shade</label>
<description>Controls roller shades</description>
<label>Lutron Shade</label>
<description>Controls roller shades, drapes, and motor controllers</description>
<category>Blinds</category>
<channels>
<channel id="shadelevel" typeId="shadeControl"/>
@@ -258,8 +260,9 @@
<bridge-type-ref id="leapbridge"/>
</supported-bridge-type-refs>
<label>Maestro Switch</label>
<label>Lutron Switch</label>
<description>On/off switch</description>
<category>WallSwitch</category>
<channels>
<channel id="switchstatus" typeId="switchState"/>
@@ -368,6 +371,7 @@
<label>Radio Powr Savr Sensor</label>
<description>Motion sensor to detect occupancy status</description>
<category>MotionDetector</category>
<channels>
<channel id="occupancystatus" typeId="occupiedState"/>
@@ -411,6 +415,7 @@
<label>Occupancy Group</label>
<description>Shows state of occupancy sensor group</description>
<category>MotionDetector</category>
<channels>
<channel id="groupstate" typeId="groupState"/>
@@ -642,7 +647,7 @@
<bridge-type-ref id="ipbridge"/>
</supported-bridge-type-refs>
<label>GRAFIK Eye QS</label>
<label>GRAFIK Eye QS Keypad</label>
<description>Lutron GRAFIK Eye QS for RadioRA 2/HomeWorks QS</description>
<representation-property>integrationId</representation-property>
@@ -717,7 +722,6 @@
</config-description>
</thing-type>
<thing-type id="virtualkeypad">
<supported-bridge-type-refs>
<bridge-type-ref id="ipbridge"/>
@@ -838,7 +842,7 @@
<bridge-type id="prgbridge">
<label>Lutron GRX-PRG or GRX-CI-PRG Bridge</label>
<description>Ethernet access point to Lutron Grafik Eye 3x/4x Systems</description>
<description>Ethernet access point to Lutron GRAFIK Eye 3x/4x Systems</description>
<channels>
<channel id="buttonpress" typeId="buttonpress"/>
@@ -912,8 +916,8 @@
<bridge-type-ref id="prgbridge"/>
</supported-bridge-type-refs>
<label>Grafik Eye</label>
<description>Controls a Grafik Eye</description>
<label>GRAFIK Eye</label>
<description>Controls a GRAFIK Eye</description>
<channels>
<channel id="scene" typeId="scene"/>
@@ -1082,7 +1086,7 @@
<bridge-type id="hwserialbridge">
<label>Lutron HomeWorks RS232 Bridge</label>
<description>RS232 access point to Lutron HomeWorks lighting control system</description>
<description>RS232 access point to Legacy Lutron HomeWorks lighting control system</description>
<config-description>
<parameter name="serialPort" type="text" required="true">
@@ -1138,8 +1142,9 @@
<bridge-type-ref id="hwserialbridge"/>
</supported-bridge-type-refs>
<label>HomeWorks Dimmer</label>
<description>Controls dimmable loads</description>
<label>Lutron Dimmer (Legacy HomeWorks)</label>
<description>Controls dimmable loads for legacy HomeWorks systems</description>
<category>Lightbulb</category>
<channels>
<channel id="lightlevel" typeId="lightDimmer"/>
@@ -1165,7 +1170,7 @@
<bridge-type id="ra-rs232">
<label>Lutron RadioRA RS232</label>
<description>RS-232 access to Lutron RadioRA</description>
<description>RS-232 access to legacy Lutron RadioRA systems</description>
<config-description>
<parameter name="portName" type="text" required="true">
@@ -1185,8 +1190,9 @@
<supported-bridge-type-refs>
<bridge-type-ref id="ra-rs232"/>
</supported-bridge-type-refs>
<label>RadioRA Dimmer</label>
<description>RadioRA Dimmer</description>
<label>Lutron Dimmer (Legacy RadioRA)</label>
<description>Controls dimmable loads for legacy RadioRA systems</description>
<category>Lightbulb</category>
<channels>
<channel id="lightlevel" typeId="lightDimmer"/>
@@ -1212,8 +1218,9 @@
<supported-bridge-type-refs>
<bridge-type-ref id="ra-rs232"/>
</supported-bridge-type-refs>
<label>RadioRA Switch</label>
<description>RadioRA Switch</description>
<label>Lutron Switch (Legacy RadioRA)</label>
<description>On/off switch for Legacy RadioRA systems</description>
<category>WallSwitch</category>
<channels>
<channel id="switchstatus" typeId="switchState"/>
@@ -1231,8 +1238,8 @@
<supported-bridge-type-refs>
<bridge-type-ref id="ra-rs232"/>
</supported-bridge-type-refs>
<label>RadioRA Phantom Button</label>
<description>RadioRA Phantom Button</description>
<label>Phantom Button (Legacy RadioRA)</label>
<description>Phantom Button for Legacy RadioRA systems</description>
<channels>
<channel id="switchstatus" typeId="switchState"/>