Skip to content

[Worxlandroid] Initial contribution #16893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
clinique wants to merge 20 commits into
base: main
Choose a base branch
from
Open

[Worxlandroid] Initial contribution #16893

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
7948d21
Worxlandroid new binding
clinique Jun 19, 2024
c72a4ab
Applying spotless
clinique Jun 19, 2024
de635ea
Code cleansing started
clinique Jun 19, 2024
3ae5a65
Updated to 4.3 and two SAT corrections
clinique Aug 6, 2024
c73c363
Adding https://github.com/clinique/openhab-addons/pull/24
clinique Aug 6, 2024
ed0170e
Code review n°1 corrections
clinique Aug 29, 2024
77bb4cd
Code review n°2 corrections
clinique Sep 7, 2024
30b58ac
Code review n°3 corrections
clinique Sep 7, 2024
c090241
Restoring lost Netatmo file
clinique Sep 7, 2024
cfe369c
Code review n°4
clinique Oct 4, 2024
f9d88a7
Adding Nils family name
clinique Oct 7, 2024
afad02b
Pom update to 5.0
clinique Dec 16, 2024
39bdf9f
Update the headers
clinique Jan 9, 2025
38a8098
Pom update to 5.1
clinique Jul 28, 2025
de4ea46
Remove unwanted netatmo file.
clinique Jul 28, 2025
d3bbd17
Restore Netatmo file
clinique Jul 28, 2025
898fa75
Forgot ressource files
clinique Jul 28, 2025
a4fe63a
Rebased
clinique Nov 7, 2025
18d657a
Update feature.xml
clinique Nov 7, 2025
586b348
Redoing pom.xml modifications
clinique Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,7 @@
/bundles/org.openhab.binding.wlanthermo/ @CSchlipp
/bundles/org.openhab.binding.wled/ @Skinah
/bundles/org.openhab.binding.wolfsmartset/ @BoBiene
/bundles/org.openhab.binding.worxlandroid/ @clinique
/bundles/org.openhab.binding.wundergroundupdatereceiver/ @danieldemus
/bundles/org.openhab.binding.x/ @computergeek1507
/bundles/org.openhab.binding.xmltv/ @clinique
Expand Down
5 changes: 5 additions & 0 deletions bom/openhab-addons/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2186,6 +2186,11 @@
<artifactId>org.openhab.binding.wolfsmartset</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.openhab.addons.bundles</groupId>
<artifactId>org.openhab.binding.worxlandroid</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.openhab.addons.bundles</groupId>
<artifactId>org.openhab.binding.wundergroundupdatereceiver</artifactId>
Expand Down
13 changes: 13 additions & 0 deletions bundles/org.openhab.binding.worxlandroid/NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This content is produced and maintained by the openHAB project.

* Project home: https://www.openhab.org

== Declared Project Licenses

This program and the accompanying materials are made available under the terms
of the Eclipse Public License 2.0 which is available at
https://www.eclipse.org/legal/epl-2.0/.

== Source Code

https://github.com/openhab/openhab-addons
526 changes: 526 additions & 0 deletions bundles/org.openhab.binding.worxlandroid/README.md
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions bundles/org.openhab.binding.worxlandroid/images/landroid.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions bundles/org.openhab.binding.worxlandroid/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.openhab.addons.bundles</groupId>
<artifactId>org.openhab.addons.reactor.bundles</artifactId>
<version>5.1.0-SNAPSHOT</version>
</parent>

<artifactId>org.openhab.binding.worxlandroid</artifactId>

<name>openHAB Add-ons :: Bundles :: Worx Landroid Binding</name>

<dependencies>
<dependency>
<groupId>software.amazon.awssdk.iotdevicesdk</groupId>
<artifactId>aws-iot-device-sdk</artifactId>
<version>1.15.0</version>
</dependency>
<dependency>
<groupId>software.amazon.awssdk.crt</groupId>
<artifactId>aws-crt</artifactId>
<version>0.25.1</version>
</dependency>
</dependencies>
Comment on lines 19 to 30
Copy link
Contributor

@lsiepel lsiepel Sep 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This binding performs some similar requests/response, so it should be possible to create them without these SDK's.
Could you remove these dependencies?

Copy link
Contributor Author

@clinique clinique Sep 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you be more explicit ? I'm afraid I did not get the meaning of your comment.
IIRW I tried to upgrade dependencies but it had major impact on code structure, so prefered to leave as it was.

Copy link
Contributor

@lsiepel lsiepel Sep 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant to say that the SDK should not be used. Instead the httpclient can be used to perform the same api request/responses.

You could look at the salus binding that also holds a very light weight base class doing much of the SDK work without needing the actual SDK.

Due to problems of the past with size, upgrades and other issues we try to keep these SDK’s out of the codebase.

Copy link
Contributor Author

@clinique clinique Sep 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lsiepel : This is for Mqtt client of AWS IoT, I remember I failed to switch to another MQTT client (because of the need of a websocket for the authentication IIRW that was not available with available one). I'll have another look at it to be sure.

Copy link
Contributor

@lsiepel lsiepel Sep 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have not looked in depth on how the MQTT client and websocket / authentication work together. I just know that we tent not to accept these SDK's. For the salus binding we had a similar issue with the software.amazon.awssdk.crt package. A fix was found by some lightweight classes that implemented the authentication.
Hope you figure out how to get rid of the SDK with these suggestions, otherwise please post the specific problems you encounter and maybe we can find a fix together. If ultimately it seems not feasable, we can always merge it as is, but yeah really prefer not to..

Copy link
Member

@wborn wborn Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find any problems so far with the URL encoder in the HiveMQ implementation, is that still a problem and why?

What I found after looking at the code:

Copy link
Contributor Author

@clinique clinique Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried HiveMQ client in my eatly tentative. I do not find back what blocked me at the time but the result is I did not suceed in that way.

Copy link
Contributor

@lsiepel lsiepel Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find any problems so far with the URL encoder in the HiveMQ implementation, is that still a problem and why?

Did you read the linked comment? As that also points to: hivemq/hivemq-mqtt-client#643
Maybe @jpg0 can elaborate on the issue and if your suggestion is a workaround.
@clinique would it be possible for you to give it another try and describe where you encounter issues? It would be helpfull to either find a workaround or a decision on SDK usage.

Copy link
Member

@wborn wborn Aug 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As that also points to: hivemq/hivemq-mqtt-client#643

That issue is not very detailed as it doesn't tell exactly where the issue occurs.

Also I couldn't relate the code in that issue to actual HiveMQ Client APIs. 🤔

Copy link
Contributor

@jpg0 jpg0 Aug 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I filed that issue quite a while ago. I have just tried to dig through this as I had originally come to the same conclusion as you, but could not make it work. I've managed to reduce it to the following code:

import java.net.URI;

class Main {
    public static void main(String[] args) throws Exception {
        String input = "x/y";
        URI uri = new URI(
            "wss", null, "host", 8080, "/test", input, null);
            
        //Try to output: x%2Fy
        System.out.println(uri.getRawQuery());
    }
}

In the above it creates a URI just like hivemq, then passes it on to Netty which extracts the raw query as you pointed out. The challenge is to get the string that Netty uses (and is returned by getRawQuery()) to be equal to x%2Fy (AWS explicitly checks the exact URI for sig validation, so it cannot be different at all). If you pass it unencoded (x/y) is remains this way, if you pass it encoded (x%2Fy) it double encodes it.


</project>
10 changes: 10 additions & 0 deletions bundles/org.openhab.binding.worxlandroid/src/main/feature/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<features name="org.openhab.binding.worxlandroid-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>

<feature name="openhab-binding-worxlandroid" description="Worx Landroid Binding" version="${project.version}">
<feature>openhab-runtime-base</feature>
<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.worxlandroid/${project.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/software.amazon.awssdk.iotdevicesdk.aws-iot-device-sdk/1.27.4</bundle>
</feature>
</features>
110 changes: 110 additions & 0 deletions ...src/main/java/org/openhab/binding/worxlandroid/internal/WorxLandroidBindingConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
/*
* Copyright (c) 2010-2025 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.worxlandroid.internal;

import java.util.Set;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;

/**
* The {@link WorxLandroidBindingConstants} class defines datCommon constants, which are
* used across the whole binding.
*
* @author Nils Billing - Initial contribution
*/
@NonNullByDefault
public class WorxLandroidBindingConstants {

public static final String BINDING_ID = "worxlandroid";

// List of all Thing Type UIDs
public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, "bridge");
public static final ThingTypeUID THING_TYPE_MOWER = new ThingTypeUID(BINDING_ID, "mower");

public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Set.of(THING_TYPE_MOWER);

// Channel group ids
public static final String GROUP_COMMON = "common";
public static final String GROUP_CONFIG = "config";
public static final String GROUP_MULTI_ZONES = "multi-zones";
public static final String GROUP_SCHEDULE = "schedule";
public static final String GROUP_ONE_TIME = "one-time";
public static final String GROUP_BATTERY = "battery";
public static final String GROUP_ORIENTATION = "orientation";
public static final String GROUP_METRICS = "metrics";
public static final String GROUP_RAIN = "rain";
public static final String GROUP_WIFI = "wifi";
public static final String GROUP_AWS = "aws";

// List channel ids
// common
public static final String CHANNEL_ONLINE_TIMESTAMP = "online-timestamp";
public static final String CHANNEL_ACTION = "action";
public static final String CHANNEL_ENABLE = "enable";
public static final String CHANNEL_ONLINE = "online";
public static final String CHANNEL_LOCK = "lock";
public static final String CHANNEL_RSSI = "rssi";

// AWS
public static final String CHANNEL_POLL = "poll";
public static final String CHANNEL_CONNECTED = "connected";

// cfgCommon
public static final String CHANNEL_TIMESTAMP = "timestamp";
public static final String CHANNEL_COMMAND = "command";
public static final String CHANNEL_DELAY = "delay";

// cfgSc
public static final String CHANNEL_TIME_EXTENSION = "time-extension";
public static final String CHANNEL_MODE = "mode";
public static final String CHANNEL_START = "next-start";
public static final String CHANNEL_STOP = "next-stop";

// cfgScXXXday
public static final String CHANNEL_DURATION = "duration";
public static final String CHANNEL_EDGECUT = "edgecut";
public static final String CHANNEL_TIME = "time";

// datCommon
public static final String CHANNEL_WIFI_QUALITY = "wifi-quality";
public static final String CHANNEL_LAST_ZONE = "last-zone";
public static final String CHANNEL_STATUS_CODE = "status";
public static final String CHANNEL_ERROR_CODE = "error";

// datBattery
public static final String CHANNEL_TEMPERATURE = "temperature";
public static final String CHANNEL_VOLTAGE = "voltage";
public static final String CHANNEL_LEVEL = "level";
public static final String CHANNEL_CHARGE_CYCLES = "charge-cycles";
public static final String CHANNEL_CHARGE_CYCLES_TOTAL = "charge-cycles-total";
public static final String CHANNEL_CHARGING = "charging";

// datDmp
public static final String CHANNEL_PITCH = "pitch";
public static final String CHANNEL_ROLL = "roll";
public static final String CHANNEL_YAW = "yaw";

// datSt
public static final String CHANNEL_BLADE_TIME = "blade-time";
public static final String CHANNEL_BLADE_TIME_TOTAL = "blade-time-total";
public static final String CHANNEL_DISTANCE = "distance";
public static final String CHANNEL_TOTAL_TIME = "total-time";

// datRain
public static final String CHANNEL_RAIN_STATE = "state";
public static final String CHANNEL_RAIN_COUNTER = "counter";

public static final String CHANNEL_PREFIX_ALLOCATION = "allocation-%d";
public static final String CHANNEL_PREFIX_ZONE = "zone-%d";
}
98 changes: 98 additions & 0 deletions ...d/src/main/java/org/openhab/binding/worxlandroid/internal/WorxLandroidHandlerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
/*
* Copyright (c) 2010-2025 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.worxlandroid.internal;

import static org.openhab.binding.worxlandroid.internal.WorxLandroidBindingConstants.*;

import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
import java.util.Set;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.worxlandroid.internal.api.WorxApiHandler;
import org.openhab.binding.worxlandroid.internal.discovery.MowerDiscoveryService;
import org.openhab.binding.worxlandroid.internal.handler.WorxLandroidBridgeHandler;
import org.openhab.binding.worxlandroid.internal.handler.WorxLandroidMowerHandler;
import org.openhab.core.auth.client.oauth2.OAuthFactory;
import org.openhab.core.config.discovery.DiscoveryService;
import org.openhab.core.thing.Bridge;
import org.openhab.core.thing.Thing;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.ThingUID;
import org.openhab.core.thing.binding.BaseThingHandlerFactory;
import org.openhab.core.thing.binding.ThingHandler;
import org.openhab.core.thing.binding.ThingHandlerFactory;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

/**
* The {@link WorxLandroidHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Nils Billing - Initial contribution
* @author Gaël L'hopital - Added oAuthFactory
*/
@NonNullByDefault
@Component(configurationPid = "binding.worxlandroid", service = ThingHandlerFactory.class)
public class WorxLandroidHandlerFactory extends BaseThingHandlerFactory {
private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_MOWER, THING_TYPE_BRIDGE);

private final Map<ThingUID, ServiceRegistration<?>> discoveryServiceRegs = new HashMap<>();
private final OAuthFactory oAuthFactory;
private final WorxApiHandler worxApiHandler;

@Activate
public WorxLandroidHandlerFactory(final @Reference OAuthFactory oAuthFactory,
final @Reference WorxApiHandler worxApiHandler) {
this.oAuthFactory = oAuthFactory;
this.worxApiHandler = worxApiHandler;
}

@Override
public boolean supportsThingType(ThingTypeUID thingTypeUID) {
return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
}

@Override
protected @Nullable ThingHandler createHandler(Thing thing) {
ThingTypeUID thingTypeUID = thing.getThingTypeUID();

if (THING_TYPE_BRIDGE.equals(thingTypeUID)) {
WorxLandroidBridgeHandler bridgeHandler = new WorxLandroidBridgeHandler((Bridge) thing, worxApiHandler,
oAuthFactory);
MowerDiscoveryService discoveryService = new MowerDiscoveryService(bridgeHandler);
discoveryServiceRegs.put(thing.getUID(), bundleContext.registerService(DiscoveryService.class.getName(),
discoveryService, new Hashtable<>()));

return bridgeHandler;
} else if (THING_TYPE_MOWER.equals(thingTypeUID)) {
return new WorxLandroidMowerHandler(thing, worxApiHandler.getDeserializer());
}
return null;
}

@Override
protected void removeHandler(ThingHandler handler) {
if (handler instanceof WorxLandroidBridgeHandler) {
ServiceRegistration<?> serviceReg = discoveryServiceRegs.remove(handler.getThing().getUID());
if (serviceReg != null) {
serviceReg.unregister();
}
}
super.removeHandler(handler);
}
}
Loading