AddonInfo extensions #3865

andrewfg · 2023-11-06T16:54:32Z

This PR contains core extensions to the AddonInfo class as foundation work to in order to support the discovery of addons to be suggested to be installed on setup.

Changes in AddonInfo

The AddonInfo DTO has been extended to include fields for ‘discovery-methods’ which identify the mechanisms by which an addon could be discovered. And sub- DTOs for ‘discovery-methods’ and ‘match-properties’ have been added.
The XML schema for AddonInfo has been extended accordingly.
The XML de-serializer for AddonInfo has been extended accordingly. With additional sub- DTO de-serializers for ‘discovery-methods’ and ‘match-properties’.
An additional DTO has been defined to contain a List<AddonInfo>
An additional XML de-serializer has been created for loading a List<AddonInfo> DTO.
The XML schema for AddonInfoList has been added.
Junit tests have been adapted/added for the above.

Other Changes in this PR

This PR also includes an 'AddonsInfoProvider' component that implements the AddonInfoProvider interface and contains the addon.xml information for all addons which it gets by reading all *.xml files which will have been installed in the /userdata/adddons/ folder.

Depends on openhab/openhab-addons#15780
Pre requisite for #3806

PR with documentation changes openhab/openhab-docs#2150

Signed-off-by: Andrew Fiddian-Green [email protected]

Signed-off-by: Andrew Fiddian-Green <[email protected]>

andrewfg · 2023-11-06T16:55:15Z

@mherwege ping.

mherwege · 2023-11-07T20:32:43Z

@andrewfg Based on the discussion in the addon PR, I think you can ommit the AddonInfoProviderInstaller. But you should bring most of the code from the addon PR in here, i.e. read an addons.xml file from userdata/etc and make it available through a specific AddonInfoProvider.

Signed-off-by: Andrew Fiddian-Green <[email protected]>

andrewfg · 2023-11-09T13:51:17Z

@J-N-K this PR is now fully aligned with the following..

openhab/openhab-distro#1604 (comment)

Done.

andrewfg · 2023-11-09T18:12:17Z

@J-N-K @mherwege @kaikreuzer just so you know: I have tested this PR by manually putting an 'addons.xml' file in the '/userdata/addons' folder, and I can confirm that its respective AddonInfoProvider does indeed load and parse the file and produce the necessary AddonInfo results.

And furthermore when my AddonSuggestionFinderService component is instantiated and queried from the Rest API, it indeed finds all thirteen of my addons that I would expect it to find..

[
  {
    "id": "homeconnect",
    "type": "binding",
    "uid": "binding-homeconnect",
    "name": "Home Connect Binding",
    "description": "The binding integrates the Home Connect (https://www.home-connect.com/) system into openHAB. It connects to household devices from brands like Bosch and Siemens.",
    "connection": "cloud",
    "countries": [],
    "serviceId": "binding.homeconnect",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_homeconnect._tcp.local."
      }
    ]
  },
  {
    "id": "ipp",
    "type": "binding",
    "uid": "binding-ipp",
    "name": "IPP Binding",
    "description": "This is the binding for the Internet Printing Protocol (IPP). You can show how many jobs are done/waiting on an IPP/CUPS Printer",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.ipp",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_ipp._tcp.local."
      }
    ]
  },
  {
    "id": "hue",
    "type": "binding",
    "uid": "binding-hue",
    "name": "Hue Binding",
    "description": "The Hue Binding integrates the Philips Hue system. It allows to control Hue bulbs.",
    "connection": "hybrid",
    "countries": [],
    "serviceId": "binding.hue",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_hue._tcp.local."
      },
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "modelName",
            "regex": "Philips hue bridge.*"
          }
        ]
      }
    ]
  },
  {
    "id": "oppo",
    "type": "binding",
    "uid": "binding-oppo",
    "name": "Oppo Blu-ray Player Binding",
    "description": "Controls Oppo UDP-203/205 and BDP-83/93/95/103/105 Blu-ray Players",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.oppo",
    "discoveryMethods": [
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "manufacturer",
            "regex": "(?i)OPPO"
          },
          {
            "name": "deviceType",
            "regex": ".*MediaRenderer.*"
          }
        ]
      }
    ]
  },
  {
    "id": "hdpowerview",
    "type": "binding",
    "uid": "binding-hdpowerview",
    "name": "Hunter Douglas PowerView Binding",
    "description": "The Hunter Douglas PowerView binding provides access to the Hunter Douglas line of PowerView shades.",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.hdpowerview",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_powerview-g3._tcp.local."
      },
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_powerview._tcp.local."
      }
    ]
  },
  {
    "id": "yamahareceiver",
    "type": "binding",
    "uid": "binding-yamahareceiver",
    "name": "YamahaReceiver Binding",
    "description": "For all network enabled Yamaha receivers.",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.yamahareceiver",
    "discoveryMethods": [
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "manufacturer",
            "regex": "(?i).*YAMAHA.*"
          },
          {
            "name": "deviceType",
            "regex": ".*MediaRenderer.*"
          }
        ]
      }
    ]
  },
  {
    "id": "tado",
    "type": "binding",
    "uid": "binding-tado",
    "name": "tado° Binding",
    "description": "Binding for tado° devices",
    "connection": "cloud",
    "countries": [],
    "serviceId": "binding.tado",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_hap._tcp.local.",
        "matchProperties": [
          {
            "name": "name",
            "regex": "tado.*"
          }
        ]
      }
    ]
  },
  {
    "id": "velux",
    "type": "binding",
    "uid": "binding-velux",
    "name": "@text/addon.velux.name",
    "description": "@text/addon.velux.description",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.velux",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_http._tcp.local.",
        "matchProperties": [
          {
            "name": "name",
            "regex": "(?i)VELUX.KLF.LAN.*"
          }
        ]
      }
    ]
  },
  {
    "id": "hpprinter",
    "type": "binding",
    "uid": "binding-hpprinter",
    "name": "HP Printer Binding",
    "description": "Binding for HP Printers with Embedded Web Servers",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.hpprinter",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_printer._tcp.local.",
        "matchProperties": [
          {
            "name": "rp",
            "regex": ".*"
          },
          {
            "name": "ty",
            "regex": "(?i)HP .*"
          }
        ]
      },
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_ipp._tcp.local.",
        "matchProperties": [
          {
            "name": "rp",
            "regex": ".*"
          },
          {
            "name": "ty",
            "regex": "(?i)HP .*"
          }
        ]
      }
    ]
  },
  {
    "id": "sonyaudio",
    "type": "binding",
    "uid": "binding-sonyaudio",
    "name": "SonyAudio Binding",
    "description": "This is the binding for SonyAudio products (Receivers and wireless speakers).",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.sonyaudio",
    "discoveryMethods": [
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "manufacturer",
            "regex": "(?i).*SONY.*"
          },
          {
            "name": "deviceType",
            "regex": ".*MediaRenderer.*"
          }
        ]
      }
    ]
  },
  {
    "id": "neohub",
    "type": "binding",
    "uid": "binding-neohub",
    "name": "NeoHub Binding",
    "description": "This is the binding for Heatmiser NeoHub devices",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.neohub",
    "discoveryMethods": [
      {
        "serviceType": "mdns",
        "mdnsServiceType": "_hap._tcp.local.",
        "matchProperties": [
          {
            "name": "name",
            "regex": "Heatmiser neoHub"
          }
        ]
      }
    ]
  },
  {
    "id": "upnpcontrol",
    "type": "binding",
    "uid": "binding-upnpcontrol",
    "name": "UPnP Control Binding",
    "description": "This binding acts as a UPnP Control Point that can query media server content directories and serve content to media renderers.",
    "connection": "local",
    "countries": [],
    "configDescriptionURI": "binding:upnpcontrol",
    "serviceId": "binding.upnpcontrol",
    "discoveryMethods": [
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "deviceType",
            "regex": ".*MediaRenderer.*"
          }
        ]
      },
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "deviceType",
            "regex": ".*MediaServer.*"
          }
        ]
      }
    ]
  },
  {
    "id": "harmonyhub",
    "type": "binding",
    "uid": "binding-harmonyhub",
    "name": "HarmonyHub Binding",
    "description": "The HarmonyHub Binding integrates Logitech Harmony hubs and remotes.",
    "connection": "local",
    "countries": [],
    "serviceId": "binding.harmonyhub",
    "discoveryMethods": [
      {
        "serviceType": "upnp",
        "matchProperties": [
          {
            "name": "modelName",
            "regex": "Harmony Hub"
          }
        ]
      }
    ]
  }
]

J-N-K · 2023-11-09T19:09:13Z

bundles/org.openhab.core.addon/.classpath

@@ -24,16 +24,16 @@
 			<attribute name="annotationpath" value="target/dependency"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java">


What happened here?

Umm. Not sure. I think Eclipse did it automagically when I wrote a new JUnit test.

Could you simply revert the changes so that this PR leaves the file untouched?

andrewfg · 2023-11-10T16:34:35Z

So I did a full build of everything incorporating both of my PRs in openhab-core, plus my PR in openhab-addons plus both of @J-N-K 's PRs in openhab-addons and openhab-distro, plus the PR of @mherwege in openhab-webui; (it took absolutely ages on my (old) PC); however .. it works!!

Following is a screenshot from the OH startup screen ..
Note: there is obviously a text localisation issue concerning e.g. the Velux binding

andrewfg · 2023-11-10T16:38:08Z

^
And here is what I see in the Add-on Store..

....core.config.core/src/main/java/org/openhab/core/config/core/xml/util/XmlDocumentReader.java

...penhab.core.addon/src/main/java/org/openhab/core/addon/infoproviders/AddonsInfoProvider.java

Signed-off-by: Andrew Fiddian-Green <[email protected]>

mherwege · 2023-11-24T22:22:12Z

LGTM

mherwege · 2023-11-30T12:38:38Z

Depends on #3806

@andrewfg Does it depend on it, or is it a pre-requisite? I believe it is just a pre-requisite.

Apart from being a pre-requisite, the big added value of this PR (combined with openhab/openhab-addons#15870 and openhab/openhab-distro#1604) is that it makes all distribution add-on info available before installation of the add-on. This potentially allows extending the UI to filter on more add-on attributes.

@openhab/maintainers This PR and the 2 related ones are a foundation for making add-on selection easier or automatic. They don't do it by themselves, but collect all the necessary information. There is no code in here that would start discovery processes. Would it be possible to review and merge these as a start?
#3806 can be reviewed as a second step, considering also the debate about enabling/disabling finders.
I think another PR for the UI could be created to allow filtering add-ons in the store on attributes once this has been merged and is available.

andrewfg · 2023-11-30T13:50:52Z

Does it depend on it, or is it a pre-requisite? I believe it is just a pre-requisite.

It is indeed only a pre-requisite.

kaikreuzer · 2023-12-03T21:04:05Z

Many thanks for all your efforts @andrewfg and @mherwege! I'm very happy to see this feature being implemented, especially as I was the one formulating the initial issue about it.
I've started reviewing this PR and will come back with feedback very soon. The plan is definitely to get this into 4.1!

andrewfg · 2023-12-03T21:10:14Z

@kaikreuzer I appreciate your support. This PR is only a part step, and #3806 contains the full set.

kaikreuzer

lgtm, thanks!
I have only a few minor comments/questions, see below.

bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/AddonInfoListReader.java

bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/AddonInfoRegistry.java

kaikreuzer · 2023-12-04T18:34:31Z

...penhab.core.addon/src/main/java/org/openhab/core/addon/infoproviders/AddonsInfoProvider.java

+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.core.addon.infoproviders;


Please always use singular for package names.
But does this really need a separate package? And does it have to be a public one or could it be moved to org.openhab.core.addon.internal.xml?

TBH I am not sure if it needs to be public; maybe #3806 needs it? But I will move it to internal here, and we could eventually move it back in #3806..

...penhab.core.addon/src/main/java/org/openhab/core/addon/infoproviders/AddonsInfoProvider.java

kaikreuzer · 2023-12-04T18:50:33Z

bundles/org.openhab.core.addon/.classpath

@@ -24,16 +24,16 @@
 			<attribute name="annotationpath" value="target/dependency"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java">


Could you simply revert the changes so that this PR leaves the file untouched?

bundles/org.openhab.core.config.core/.classpath

Signed-off-by: Andrew Fiddian-Green <[email protected]>

kaikreuzer

Thanks for the prompt updates!

kaikreuzer · 2023-12-05T15:54:33Z

FTR: I have deployed the updated XSDs on our website, see openhab/website@74e3185.

mherwege · 2023-12-05T16:09:31Z

@andrewfg @kaikreuzer Thank you for the work and the review.

andrewfg · 2023-12-05T16:17:45Z

@mherwege and thank you too!!

andrewfg · 2023-12-05T16:38:09Z

have deployed the updated XSDs on our website

@kaikreuzer Cool. Thank you. I have openhab/openhab-addons#15817 building now. The first few bindings already passed the schema verification. :)

EDIT: they all passed the verification :)

[addoninfo] core extensions

236c8f2

Signed-off-by: Andrew Fiddian-Green <[email protected]>

andrewfg requested a review from a team as a code owner November 6, 2023 16:54

andrewfg mentioned this pull request Nov 6, 2023

Service to find suggested addons to install #3806

Merged

andrewfg added 3 commits November 8, 2023 13:30

[addoninfo] remove addon installer; add code to core

dd09a15

Signed-off-by: Andrew Fiddian-Green <[email protected]>

[addoninfo] fix path name

418164d

Signed-off-by: Andrew Fiddian-Green <[email protected]>

[addoninfo] xml schemas

ff2ddaa

Signed-off-by: Andrew Fiddian-Green <[email protected]>

This was referenced Nov 8, 2023

Install add-on discovery file from openhab-addons openhab/openhab-distro#1604

Merged

Build addon xml openhab/openhab-addons#15870

Merged

andrewfg added 2 commits November 9, 2023 12:43

[addoninfo] xml schemas (again)

c0d48dd

Signed-off-by: Andrew Fiddian-Green <[email protected]>

[addoninfo] update AddonsInfoProvider

720b581

Signed-off-by: Andrew Fiddian-Green <[email protected]>

andrewfg mentioned this pull request Nov 9, 2023

[addonsinfoprovider] Addon for providing addon-info of other addons openhab/openhab-addons#15780

Closed

J-N-K reviewed Nov 9, 2023

View reviewed changes

andrewfg mentioned this pull request Nov 10, 2023

Extra fields for addon discovery in addon.xml openhab/openhab-docs#2150

Merged

Merge branch 'openhab:main' into addon-dto-extension

b786ac8

mherwege reviewed Nov 22, 2023

View reviewed changes

....core.config.core/src/main/java/org/openhab/core/config/core/xml/util/XmlDocumentReader.java Outdated Show resolved Hide resolved

mherwege reviewed Nov 22, 2023

View reviewed changes

...penhab.core.addon/src/main/java/org/openhab/core/addon/infoproviders/AddonsInfoProvider.java Outdated Show resolved Hide resolved

[addoninfp] adopt reviewer suggestions

16845c5

Signed-off-by: Andrew Fiddian-Green <[email protected]>

Merge branch 'openhab:main' into addon-dto-extension

6b1d750

kaikreuzer requested changes Dec 4, 2023

View reviewed changes

kaikreuzer mentioned this pull request Dec 5, 2023

Make bindings discoverable on system startup openhab/openhab-addons#15817

Merged

[addonInfo extensions] adopt reviewer suggestions

164187c

Signed-off-by: Andrew Fiddian-Green <[email protected]>

andrewfg requested a review from kaikreuzer December 5, 2023 12:33

[addonInfo extensions] adopt reviewer suggestions

d249146

Signed-off-by: Andrew Fiddian-Green <[email protected]>

kaikreuzer approved these changes Dec 5, 2023

View reviewed changes

kaikreuzer merged commit cc9b705 into openhab:main Dec 5, 2023
3 checks passed

kaikreuzer added this to the 4.1 milestone Dec 5, 2023

lolodomo mentioned this pull request Dec 6, 2023

Problem with AddonInfoProvider with OH snapshot 3757 #3901

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AddonInfo extensions #3865

AddonInfo extensions #3865

andrewfg commented Nov 6, 2023 •

edited

Loading

andrewfg commented Nov 6, 2023

mherwege commented Nov 7, 2023

andrewfg commented Nov 9, 2023

andrewfg commented Nov 9, 2023

J-N-K Nov 9, 2023

andrewfg Nov 9, 2023

kaikreuzer Dec 4, 2023

andrewfg commented Nov 10, 2023

andrewfg commented Nov 10, 2023

mherwege commented Nov 24, 2023

mherwege commented Nov 30, 2023

andrewfg commented Nov 30, 2023 •

edited

Loading

kaikreuzer commented Dec 3, 2023

andrewfg commented Dec 3, 2023

kaikreuzer left a comment

kaikreuzer Dec 4, 2023

andrewfg Dec 5, 2023

kaikreuzer Dec 4, 2023

kaikreuzer left a comment

kaikreuzer commented Dec 5, 2023

mherwege commented Dec 5, 2023

andrewfg commented Dec 5, 2023

andrewfg commented Dec 5, 2023 •

edited

Loading

AddonInfo extensions #3865

AddonInfo extensions #3865

Conversation

andrewfg commented Nov 6, 2023 • edited Loading

andrewfg commented Nov 6, 2023

mherwege commented Nov 7, 2023

andrewfg commented Nov 9, 2023

andrewfg commented Nov 9, 2023

J-N-K Nov 9, 2023

Choose a reason for hiding this comment

andrewfg Nov 9, 2023

Choose a reason for hiding this comment

kaikreuzer Dec 4, 2023

Choose a reason for hiding this comment

andrewfg commented Nov 10, 2023

andrewfg commented Nov 10, 2023

mherwege commented Nov 24, 2023

mherwege commented Nov 30, 2023

andrewfg commented Nov 30, 2023 • edited Loading

kaikreuzer commented Dec 3, 2023

andrewfg commented Dec 3, 2023

kaikreuzer left a comment

Choose a reason for hiding this comment

kaikreuzer Dec 4, 2023

Choose a reason for hiding this comment

andrewfg Dec 5, 2023

Choose a reason for hiding this comment

kaikreuzer Dec 4, 2023

Choose a reason for hiding this comment

kaikreuzer left a comment

Choose a reason for hiding this comment

kaikreuzer commented Dec 5, 2023

mherwege commented Dec 5, 2023

andrewfg commented Dec 5, 2023

andrewfg commented Dec 5, 2023 • edited Loading

andrewfg commented Nov 6, 2023 •

edited

Loading

andrewfg commented Nov 30, 2023 •

edited

Loading

andrewfg commented Dec 5, 2023 •

edited

Loading