Binding compatibilty

Christian_Feininger · March 12, 2023, 4:21pm

Hello,

I made some changes to my binding. I deployed it locally, where I run openHAB 3.3.0, however the binding update is developed with 4.0.0 snapshot. If I upload the JAR File to Marketplace I get the following error if I install it via the Marketplace:

The marketplace bundle was successfully installed but doesn't start: Could not resolve module: org.openhab.binding.sonnen [255]
  Unresolved requirement: Import-Package: com.google.gson; version="[2.9.0,3.0.0)"

How do I make it offically compatible to an older version?

wborn · March 12, 2023, 4:30pm

Try this:

Christian_Feininger · March 12, 2023, 5:14pm

Ok, I was able to compile it with the given options. I deployed the new JAR-File. When I install it, I dont see any more error in openhab log, however the Thing is not appearing in the menue.

As said using openHAB 3.3.0, do I need to adjust the parameters anyhow?

wborn · March 12, 2023, 5:21pm

You probably also need to add a binding.xml file for the older versions as it no longer exists in OH 4:

morph166955 · March 12, 2023, 5:38pm

Yup, I forgot that part. Make sure both binding and addon xml files are there.

Christian_Feininger · March 12, 2023, 5:51pm

Ok, sorry guys, where do I need to place the binding.xml and what is the content of it?

wborn · March 12, 2023, 6:03pm

You place it in src/main/resources/OH-INF/binding/binding.xml

See the 3.4.x branch for examples like this Astro Binding binding.xml.

Christian_Feininger · March 12, 2023, 6:34pm

Thanks, I can conform that it works now.

morph166955 · March 13, 2023, 5:14pm

Another option for anyone looking at this, you can make these changes to your binding and it sets this all automatically.

wborn · March 13, 2023, 5:39pm

It probably does render your CI build results useless for newer versions.
All openHAB APIs could be removed in newer versions and it will still build successfully.

morph166955 · March 13, 2023, 5:44pm

Oh it’s definitely not the “best option” but seeing as it does effectively the same thing as putting it on the CLI there’s no real difference. This just makes the CLI shorter. I opened up an issue here…

github.com/openhab/openhab-core

Ability to specify minimum dependency versions for backwards compatibility

opened 08:00PM - 12 Mar 23 UTC

morph166955

Not sure if this goes in core, addons, or distribution. My apologies if this go…es somewhere morr appropriate. With 4.0.0M1 dropped on Friday we have seen a good uptick in numbers of users who have moved to 4.0.0. With that has come a number of threads asking about jar compatibility with the marketplace. The vast majority of what I've seen can be fixed by creating jars with a few flags sent to maven to specify lower java and karaf versions as (in most cases) the developers haven't implemented anything that require the newer versions. To prevent issues in the future, it would be nice if the developers could specify the minimum dependency versions in the specific binding so that they become more backwards compatible. For example, on the AndroidTV binding I'm not doing anything that specifically requires Java 17. If I could put something in the xml that says "requires minimum java 11" rather than defaulting to 17, the jars wouldn't break as people upgrade. If the developer eventually does use a feature in a higher version they can then dial up their specific xml as needed. Alternatively, put a flag in to say "minimum OH version". So for example, specify that the jar should work in all versions from 3.4.0 and up. I realize things like the migration from bindings.xml to addons.xml complicates this, but it would be a step forward into preventing issues as people migrate in the future.

…to do something more permanent/stable/etc for the marketplace releases going forward.

system · April 24, 2023, 9:45am

This topic was automatically closed 41 days after the last reply. New replies are no longer allowed.