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.
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
Allow dynamic documentation properties for binding #1360
Comments
* Exec actions timeout is now in seconds. Reference: openhab#1700 Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Details on how to use Duration now. Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
The problem with displaying the version is that there might be several bundles within one add-on:
In general all of these bundles have the same version, but in some cases, even non-openHAB bundles are part of the feature:
What would be the correct version to display and how should this be detected in a generic way? |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
I never got the difference between a bundle, addon and binding. Is this somewhere explained? Bundle: Osgi explains it as "Each bundle is a tightly coupled, dynamically loadable collection of classes, jars, and configuration files that explicitly declare their external dependencies (if any)." Can you provide an better specification? |
A A An |
Very comprehensively and well written, Jan. Thank you! 🥇 So I try simplify / summarize from a different perspective:
so when I do a
it really gives me the version of that bundle (I can see that that version is different from 3.4.0 when I install a self-compiled version via bundle:update) and when I do
"Version" and where does that version come from or better, how is this version derived or set? under /settings/addons/binding-xmppclient |
I made it bit simpler than reality :-) It's also possible to install bundles that are not part of feature (that happens if you drop a .jar in the addons folder or use There are also feature repositories (you can see the available repos with The version of the feature is set when the repository is build (in the This the version that you see in the UI. The "openHAB version" on the info page is taken from |
Ok, i give up, Jan A plan is good until it hits reality and things are sometimes just more complex as one might think. At least I learned a lot. Let me close that then. (just the fact that you provided so much valuable information here is a pity that we don't have that in our documentation but maybe when I have some time left some day it might find its way ;-) ) |
Currently there is one shortcoming that bundle information seems to be completely static. The documentation for a bundle can be for example looked up in PaperUI. However, sometimes the bundle itself likes to provide some information to the user related to the bundle itself which might be helpful for the user or the development community in case of issues.. In particular it is useful for support purposes.
An example would be presenting the build version of the bundle to know exactly what version a user is running without using advanced tools like karaf... as mentioned and described in the following thread:
https://community.openhab.org/t/solved-how-to-detect-exact-bundle-version-via-api/92375
(in this case I expose that through the thing but not the bundle information).
Therefore I would propose to add properties to bundles similar to what things have.
What do you think?
The text was updated successfully, but these errors were encountered: