Add a new optional input parameter to discovery services #4389

lolodomo · 2024-09-25T20:58:53Z

Related to #4388

Signed-off-by: Laurent Garnier [email protected]

lolodomo · 2024-09-25T21:01:24Z

....core.config.discovery/src/main/java/org/openhab/core/config/discovery/DiscoveryService.java

+     * @param input an input parameter to be used during discovery scan
+     * @param listener a listener that is notified about errors or termination of the scan
+     */
+    void startScanWithInput(String input, @Nullable ScanListener listener);


Note that I added a new method rather than adding a new parameter to the existing method startScan because this method is called by few bindings.
But it is also possible to only update the existing method and prepare a fix for existing bindings.

Any reason not to overload the startScan method ?

void startScan(@Nullable ScanListener listener); void startScan(String input, @Nullable ScanListener listener);

Ok, method renamed.

There is still the method void startScanWithInput(String input), the main method that will be overriden in a binding. Before renaming it into startScan, I have to check if we have bindings declaring such method.

$ find */src -name "*.java" -exec grep -H "void startScan(" {} \; | grep -v "void startScan()" org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java: private void startScan(RioSystemConfig sysConfig) { org.openhab.binding.webthing/src/main/java/org/openhab/binding/webthing/internal/discovery/WebthingDiscoveryService.java: private void startScan(boolean isBackground) {

Ok, there should be no risk I believe. I will rename also the last remaining startScanWithInput.

Every occurrence of startScanWithInput is now renamed.

To come back to my initial comment, in case you would prefer to not add a new method but rather add a parameter to the existing method, I checked how many bindings should be updated. Only five: easee, gardena, homematic, hue and lutron. So not a big deal. Let me know what you prefer.

$ find */src -name "*.java" -exec grep -H "startScan(" {} \; | grep -v "startScan()" org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/handler/EaseeSiteHandler.java: discoveryService.startScan(null); org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/handler/GardenaAccountHandler.java: discoveryService.startScan(null); org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/handler/HomematicBridgeHandler.java: discoveryService.startScan(null); org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/Clip2BridgeHandler.java: discoveryService.startScan(null); org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/IPBridgeHandler.java: discoveryService.startScan(null); org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusDiscoveryService.java: scanStarted |= service.startScan(this); org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusEndpointDiscoveryService.java: public boolean startScan(ModbusDiscoveryService service) { org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusThingHandlerDiscoveryService.java: boolean startScan(ModbusDiscoveryService service); org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java: startScan(rioConfig); org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java: * {@link #startScan(RioSystemConfig)} when a device should be scanned and 'things' discovered from it org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java: private void startScan(RioSystemConfig sysConfig) { org.openhab.binding.webthing/src/main/java/org/openhab/binding/webthing/internal/discovery/WebthingDiscoveryService.java: startScan(true); org.openhab.binding.webthing/src/main/java/org/openhab/binding/webthing/internal/discovery/WebthingDiscoveryService.java: private void startScan(boolean isBackground) { org.openhab.binding.webthing/src/main/java/org/openhab/binding/webthing/internal/discovery/WebthingDiscoveryService.java: startScan(false);

lolodomo · 2024-09-25T21:07:53Z

I tested it with success with a modified version of the astro binding.

@digitaldan : what you have to do for matter binding in your discovery service is calling the constructor of AbstractDiscoveryService with 2 additional parameters, the label and description of your discovery input parameter (pairing code). You can even use @text/xxx + entries in your properties file to have translated label and description returned by the new REST API (that will be used by Main UI).
And finally you have to override and implement this method:

    void startScan(String input)

lolodomo · 2024-09-25T21:10:21Z

This is almost finished, I have in mind to add unit tests for the discovery REST API. I will add them later this week.

lolodomo · 2024-09-25T23:17:46Z

For your information, I was able to build the full addons repo with these core changes (my build was done without running tests).

digitaldan · 2024-09-26T02:47:56Z

Thanks @lolodomo , i am going to take a look at this tomorrow!

florian-h05

LGTM, thanks!
The new API endpoint provides everything that is required I think 👍

lolodomo · 2024-09-26T20:47:00Z

...t.core/src/main/java/org/openhab/core/io/rest/core/internal/discovery/DiscoveryResource.java

+            return JSONResponse.createResponse(Status.NOT_FOUND, null,
+                    "No discovery service found for binding " + bindingId);


I am not sure if I should rather return Response.status(Status.NOT_FOUND).build()
I find the two approaches used in core framework without understanding which one is the most adapted.

Using JSONResponse.createResponse allows returning a JSON with an error message in addition to the simple HTTP status.

I would prefer your current approach because it provides the additional info, which is more user-friendly, but TBH I don’t know if anyone really „reads“ that response.

Related to openhab#4388 Signed-off-by: Laurent Garnier <[email protected]>

holgerfriedrich

Otherwise, LGTM!

...y/src/main/java/org/openhab/core/config/discovery/internal/DiscoveryServiceRegistryImpl.java

Signed-off-by: Laurent Garnier <[email protected]>

holgerfriedrich

LGTM, thanks!

@digitaldan shall I wait for your feedback or can I merge this?

digitaldan · 2024-09-29T11:28:58Z

Thanks @lolodomo looks great, @holgerfriedrich LGTM 👍

lolodomo · 2024-09-29T13:21:39Z

@florian-h05: you can now implement the UI part ;)

florian-h05 · 2024-09-30T13:06:39Z

...nfig.discovery/src/main/java/org/openhab/core/config/discovery/AbstractDiscoveryService.java

@@ -133,6 +162,21 @@ public Set<ThingTypeUID> getSupportedThingTypes() {
        return supportedThingTypes;
    }

+    @Override
+    public boolean isScanInputSupported() {
+        return scanInputLabel != null && scanInputDescription != null;


@lolodomo
I think the goal of this implementation was to automatically return true if label and description are provided.
This however does not work at the moment, you rather need this:

return getScanInputLabel() != null && getScanInputDescription() != null;

What is the difference?

When using the methods instead of the classes private fields, isScanInputSupported will return true if both the label and the description methods are overwritten in a child class. With the current implementation, this is not the case, thus requiring a child class that already provides label and description trough the methods to also overwrite the isScanInputSupported method.
I will create a PR to fix that.

#4393 is merged

For your information, the idea is absolutely not to override getScanInputLabel and getScanInputDescription in a binding, but only to provide label and description in the constructor of the binding discovery service.

Makes sense ... sorry for the chaos.

By the way, your change is not a problem ;)

Refs openhab/openhab-core#4389. Signed-off-by: Florian Hotze <[email protected]>

florian-h05 · 2024-09-30T13:25:22Z

UI part is implemented: openhab/openhab-webui#2771

Refs openhab/openhab-core#4389. Signed-off-by: Florian Hotze <[email protected]>

…covery services Fixes an issue from openhab#4389. For more details see openhab#4389 (comment). Signed-off-by: Florian Hotze <[email protected]>

…covery services (#4393) Fixes an issue from #4389. Signed-off-by: Florian Hotze <[email protected]>

Regression of openhab/openhab-core#4389 Signed-off-by: Jacob Laursen <[email protected]>

lolodomo requested a review from a team as a code owner September 25, 2024 20:58

lolodomo commented Sep 25, 2024

View reviewed changes

lolodomo force-pushed the discovery_param branch 2 times, most recently from f3a9d02 to 390b80a Compare September 26, 2024 10:16

florian-h05 approved these changes Sep 26, 2024

View reviewed changes

lolodomo commented Sep 26, 2024

View reviewed changes

Add a new optional input parameter to discovery services

2896560

Related to openhab#4388 Signed-off-by: Laurent Garnier <[email protected]>

lolodomo force-pushed the discovery_param branch from 390b80a to 2896560 Compare September 28, 2024 07:56

florian-h05 approved these changes Sep 28, 2024

View reviewed changes

holgerfriedrich reviewed Sep 28, 2024

View reviewed changes

...y/src/main/java/org/openhab/core/config/discovery/internal/DiscoveryServiceRegistryImpl.java Outdated Show resolved Hide resolved

holgerfriedrich added the enhancement An enhancement or new feature of the Core label Sep 28, 2024

Review comment: restore IllegalStateException

a80378e

Signed-off-by: Laurent Garnier <[email protected]>

holgerfriedrich approved these changes Sep 29, 2024

View reviewed changes

holgerfriedrich added rebuild Triggers the Jenkins PR build and removed rebuild Triggers the Jenkins PR build labels Sep 29, 2024

holgerfriedrich merged commit b8b3ec9 into openhab:main Sep 29, 2024
5 checks passed

holgerfriedrich added this to the 4.3 milestone Sep 29, 2024

lolodomo deleted the discovery_param branch September 29, 2024 12:51

florian-h05 reviewed Sep 30, 2024

View reviewed changes

florian-h05 added a commit to florian-h05/openhab-webui that referenced this pull request Sep 30, 2024

Thing add page: Add support for optional scan input

1de9695

Refs openhab/openhab-core#4389. Signed-off-by: Florian Hotze <[email protected]>

florian-h05 mentioned this pull request Sep 30, 2024

Thing add page: Add support for optional scan input openhab/openhab-webui#2771

Merged

florian-h05 added a commit to openhab/openhab-webui that referenced this pull request Sep 30, 2024

Thing add page: Add support for optional scan input (#2771)

38a486a

Refs openhab/openhab-core#4389. Signed-off-by: Florian Hotze <[email protected]>

florian-h05 mentioned this pull request Sep 30, 2024

Fix discovery input parameter not enabled if label/description provided #4393

Merged

holgerfriedrich pushed a commit that referenced this pull request Sep 30, 2024

Fix input parameter not enabled if label/description provided for dis…

c454ee2

…covery services (#4393) Fixes an issue from #4389. Signed-off-by: Florian Hotze <[email protected]>

jlaur added a commit to jlaur/openhab-addons that referenced this pull request Oct 1, 2024

Fix build

208172c

Regression of openhab/openhab-core#4389 Signed-off-by: Jacob Laursen <[email protected]>

jlaur mentioned this pull request Oct 1, 2024

[linktap] Fix build openhab/openhab-addons#17493

Merged

lsiepel pushed a commit to openhab/openhab-addons that referenced this pull request Oct 1, 2024

Fix build (#17493)

4651f5c

Regression of openhab/openhab-core#4389 Signed-off-by: Jacob Laursen <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a new optional input parameter to discovery services #4389

Add a new optional input parameter to discovery services #4389

lolodomo commented Sep 25, 2024

lolodomo Sep 25, 2024

digitaldan Sep 26, 2024

lolodomo Sep 26, 2024

lolodomo Sep 26, 2024 •

edited

Loading

lolodomo Sep 26, 2024 •

edited

Loading

lolodomo Sep 26, 2024

lolodomo commented Sep 25, 2024 •

edited

Loading

lolodomo commented Sep 25, 2024

lolodomo commented Sep 25, 2024

digitaldan commented Sep 26, 2024

florian-h05 left a comment

lolodomo Sep 26, 2024

florian-h05 Sep 26, 2024

holgerfriedrich left a comment

holgerfriedrich left a comment

digitaldan commented Sep 29, 2024

lolodomo commented Sep 29, 2024

florian-h05 Sep 30, 2024

lolodomo Sep 30, 2024

florian-h05 Sep 30, 2024

holgerfriedrich Sep 30, 2024

lolodomo Sep 30, 2024

florian-h05 Sep 30, 2024

lolodomo Sep 30, 2024

florian-h05 commented Sep 30, 2024

		return JSONResponse.createResponse(Status.NOT_FOUND, null,
		"No discovery service found for binding " + bindingId);

Add a new optional input parameter to discovery services #4389

Add a new optional input parameter to discovery services #4389

Conversation

lolodomo commented Sep 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lolodomo Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

lolodomo Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lolodomo commented Sep 25, 2024 • edited Loading

lolodomo commented Sep 25, 2024

lolodomo commented Sep 25, 2024

digitaldan commented Sep 26, 2024

florian-h05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holgerfriedrich left a comment

Choose a reason for hiding this comment

holgerfriedrich left a comment

Choose a reason for hiding this comment

digitaldan commented Sep 29, 2024

lolodomo commented Sep 29, 2024

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

florian-h05 commented Sep 30, 2024

lolodomo Sep 26, 2024 •

edited

Loading

lolodomo Sep 26, 2024 •

edited

Loading

lolodomo commented Sep 25, 2024 •

edited

Loading