[tellstick] Add support for Tellstick local API #10020

jannegpriv · 2021-02-01T16:04:30Z

Support for local API according to:
https://tellstick-server.readthedocs.io/en/v1.0.12/api.html

Signed-off-by: Jan Gustafsson jannegpriv@gmail.com

Link to community thread where I posted a jar-file for test:
https://community.openhab.org/t/tellstick-local-api/90204/4

This binding was not updated to use Null anntotations, I have therfor not added that in my PR.

The local API only returns JSON format and the live API is implemented to handle XML format, in the future the live API should probably be updated to use JSON as well (since live API seems to support both XML and JSON).

Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

fwolter · 2021-02-10T18:55:24Z

...ellstick/src/main/java/org/openhab/binding/tellstick/internal/TellstickBindingConstants.java

+    public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Collections
+            .unmodifiableSet(Stream.of(DIMMER_THING_TYPE, SWITCH_THING_TYPE, SENSOR_THING_TYPE, RAINSENSOR_THING_TYPE,
+                    WINDSENSOR_THING_TYPE, POWERSENSOR_THING_TYPE, TELLDUSCOREBRIDGE_THING_TYPE,
+                    TELLDUSLIVEBRIDGE_THING_TYPE, TELLDUSLOCALBRIDGE_THING_TYPE).collect(Collectors.toSet()));


Suggested change

public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Collections

.unmodifiableSet(Stream.of(DIMMER_THING_TYPE, SWITCH_THING_TYPE, SENSOR_THING_TYPE, RAINSENSOR_THING_TYPE,

WINDSENSOR_THING_TYPE, POWERSENSOR_THING_TYPE, TELLDUSCOREBRIDGE_THING_TYPE,

TELLDUSLIVEBRIDGE_THING_TYPE, TELLDUSLOCALBRIDGE_THING_TYPE).collect(Collectors.toSet()));

public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(DIMMER_THING_TYPE, SWITCH_THING_TYPE, SENSOR_THING_TYPE, RAINSENSOR_THING_TYPE,

WINDSENSOR_THING_TYPE, POWERSENSOR_THING_TYPE, TELLDUSCOREBRIDGE_THING_TYPE,

TELLDUSLIVEBRIDGE_THING_TYPE, TELLDUSLOCALBRIDGE_THING_TYPE);

Fixed for all Sets!

Fixed for all sets!

fwolter · 2021-02-10T18:58:32Z

...ck/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalBridgeHandler.java

+    private List<DeviceStatusListener> deviceStatusListeners = new Vector<>();
+    private final HttpClient httpClient;
+
+    private static final int REFRESH_DELAY = 10;


It's good practice to append the unit to the field name e.g. TIMEOUT_SEC.

fwolter · 2021-02-10T18:58:59Z

...ck/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalBridgeHandler.java

+    private ScheduledFuture<?> pollingJob;
+    private ScheduledFuture<?> immediateRefreshJob;


Please put all fields to the top.

fwolter · 2021-02-10T18:59:08Z

...ck/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalBridgeHandler.java

+
+    @Override
+    public void dispose() {
+        logger.debug("Local Handler disposed.");


Can this message be replaced by using the debugger or by increasing the framework's log level? See point 4 https://www.openhab.org/docs/developer/guidelines.html#f-logging

I removed it!

fwolter · 2021-02-10T18:59:24Z

...ck/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalBridgeHandler.java

+
+    @Override
+    public void initialize() {
+        logger.debug("Initializing Telldus Local bridge handler.");


See above. Remove logging.

I removed it!

fwolter · 2021-02-10T19:08:55Z

...lstick/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalException.java

+ *
+ * @author Jan Gustafsson - Initial contribution
+ */
+public class TelldusLocalException extends TellstickException {


Please add the NonNullByDefault annotation.

fwolter · 2021-02-10T19:09:14Z

...tick/src/main/java/org/openhab/binding/tellstick/internal/local/json/LocalDataTypeValue.java

+ *
+ * @author Jan Gustafsson - Initial contribution
+ */
+public class LocalDataTypeValue {


You could move this into a package called dto or append DTO to the class name to get rid of the checkstyle warning about missing NonNullByDefault annotation.

fwolter · 2021-02-10T19:10:16Z

bundles/org.openhab.binding.tellstick/src/main/resources/OH-INF/thing/bridge.xml

+		<config-description>
+			<parameter name="ipAddress" type="text" required="true">
+				<label>Local IP Address</label>
+				<description>The local IP address of the Tellstick.</description>


You could specify <context>network-address</context> to get a free validation.

fwolter · 2021-02-10T19:11:01Z

bundles/org.openhab.binding.tellstick/src/main/resources/OH-INF/thing/bridge.xml

+				<description>The local IP address of the Tellstick.</description>
+			</parameter>
+			<parameter name="accessToken" type="text" required="true">
+				<context>credentials</context>


Are you sure this conext exists?

No, I have removed it!

fwolter · 2021-02-10T19:11:18Z

bundles/org.openhab.binding.tellstick/src/main/resources/OH-INF/thing/bridge.xml

+				<label>Access Token</label>
+				<description>The access token.</description>
+			</parameter>
+			<parameter name="refreshInterval" type="integer" required="false">


Suggested change

<parameter name="refreshInterval" type="integer" required="false">

<parameter name="refreshInterval" type="integer" required="false" min="0" unit="ms">

Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

fwolter

The titel of this PR will show up in the OH changelog. Can you make it a bit more self-explanatory?

fwolter · 2021-02-16T22:23:41Z

...ck/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalBridgeHandler.java

+                for (TellstickLocalSensorDTO sensor : previouslist.getSensors()) {
+                    sensor.setUpdated(false);
+                }
+                logger.trace("Update sensors, reset updated flag1");


Can this message be replaced by using the debugger or by increasing the framework's log level? See point 4 https://www.openhab.org/docs/developer/guidelines.html#f-logging

Please check all.

fwolter · 2021-02-16T22:24:04Z

...ck/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalBridgeHandler.java

+                }
+                this.deviceList = newList;
+            } else {
+                logger.trace("updateDevices, Updating devices.");


Can this message be replaced by using the debugger or by increasing the framework's log level? See point 4 https://www.openhab.org/docs/developer/guidelines.html#f-logging

fwolter · 2021-02-16T22:32:29Z

...lstick/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalException.java

+    private static final long serialVersionUID = 3067179547449454711L;
+
+    @Override
+    public @NonNull String getMessage() {


This is added automatically.

Suggested change

public @NonNull String getMessage() {

public String getMessage() {

I got a compilation error if I remove it:

ERROR] /Users/jannegpriv/git/openhab-master3/git/openhab-addons/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/local/TelldusLocalException.java:[35,12] The default '@org.eclipse.jdt.annotation.NonNull' conflicts with the inherited '@org.eclipse.jdt.annotation.Nullable' annotation in the overridden method from org.tellstick.device.TellstickException

Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

fwolter

LGTM

…API. (openhab#10020) * Fix for openhab#9841. Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com> Signed-off-by: John Marshall <john.marshall.au@gmail.com>

…API. (openhab#10020) * Fix for openhab#9841. Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

Fix for openhab#9841.

780bfcb

Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

jannegpriv requested a review from a team as a code owner February 1, 2021 16:04

cpmeister added the enhancement An enhancement or new feature for an existing add-on label Feb 7, 2021

fwolter self-assigned this Feb 10, 2021

fwolter requested changes Feb 10, 2021

View reviewed changes

Updated after code review.

c6e85a5

Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

jannegpriv force-pushed the 9841-tellstick branch from df8ee1d to c6e85a5 Compare February 15, 2021 22:15

fwolter requested changes Feb 16, 2021

View reviewed changes

jannegpriv changed the title ~~[tellstick] Fix for #9841.~~ [tellstick] Fix for #9841, adding support for Tellstick local API. Feb 17, 2021

Updated after code review.

f40a6c4

Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

fwolter approved these changes Feb 18, 2021

View reviewed changes

fwolter merged commit 0853aa7 into openhab:main Feb 18, 2021

fwolter added this to the 3.1 milestone Feb 18, 2021

fwolter removed their assignment Feb 18, 2021

jannegpriv deleted the 9841-tellstick branch March 31, 2021 18:01

wborn changed the title ~~[tellstick] Fix for #9841, adding support for Tellstick local API.~~ [tellstick] Add support for Tellstick local API Jun 22, 2021

thinkingstone pushed a commit to thinkingstone/openhab-addons that referenced this pull request Nov 7, 2021

[tellstick] Fix for openhab#9841, adding support for Tellstick local …

ccdebc5

…API. (openhab#10020) * Fix for openhab#9841. Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this pull request May 5, 2022

[tellstick] Fix for openhab#9841, adding support for Tellstick local …

5d4ba9a

…API. (openhab#10020) * Fix for openhab#9841. Signed-off-by: Jan Gustafsson <jannegpriv@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tellstick] Add support for Tellstick local API #10020

[tellstick] Add support for Tellstick local API #10020

jannegpriv commented Feb 1, 2021 •

edited by wborn

fwolter Feb 10, 2021

jannegpriv Feb 12, 2021

jannegpriv Feb 12, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 15, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter Feb 10, 2021

jannegpriv Feb 13, 2021

fwolter left a comment

fwolter Feb 16, 2021

jannegpriv Feb 17, 2021

fwolter Feb 16, 2021

jannegpriv Feb 17, 2021

fwolter Feb 16, 2021

jannegpriv Feb 17, 2021

jannegpriv Feb 17, 2021

fwolter left a comment

		private ScheduledFuture<?> pollingJob;
		private ScheduledFuture<?> immediateRefreshJob;

	<parameter name="refreshInterval" type="integer" required="false">
	<parameter name="refreshInterval" type="integer" required="false" min="0" unit="ms">

	public @NonNull String getMessage() {
	public String getMessage() {

[tellstick] Add support for Tellstick local API #10020

[tellstick] Add support for Tellstick local API #10020

Conversation

jannegpriv commented Feb 1, 2021 • edited by wborn

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fwolter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fwolter left a comment

Choose a reason for hiding this comment

jannegpriv commented Feb 1, 2021 •

edited by wborn