Skip to content
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

[ism8] Add manufacturer Wolf to add-on name field #17747

Closed
wants to merge 1 commit into from

Conversation

holgerfriedrich
Copy link
Member

This will show ism8 binding when users search for "wolf".

#17682 (comment)

We have two add-ons, ism8 and wolfsmartset (you will need one or the other depending on the smart home interface installed in the heating system). When a user types "wolf" into the search field of the add-on store, I would like to see both add-ons shown.

Current behaviour is as follows: Whey I search for "wolf", I get only the latter. The search mechanism seems to look at the name of the binding, but not at the description (which contains Wolf for both add-ons). Should I change the field name to "Wolf ISM8" in addon.xml or do you know a better way?

I am not sure if this should be done this way, as it feels somehow inconsistent with the actual name of the binding.

This will show ism8 binding when users search for "wolf".

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
@lsiepel
Copy link
Contributor

lsiepel commented Nov 15, 2024

Support for the suggestion finder could also eliminate the need to search for this binding?

@@ -4,7 +4,7 @@
xsi:schemaLocation="https://openhab.org/schemas/addon/v1.0.0 https://openhab.org/schemas/addon-1.0.0.xsd">

<type>binding</type>
<name>ISM8 Binding</name>
<name>Wolf ISM8 Binding</name>
Copy link
Contributor

@jlaur jlaur Nov 15, 2024

Choose a reason for hiding this comment

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

Please regenerate the I18N properties file after this change:

Also, when renaming the binding, for consistency it should probably also be renamed in these places:
https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.ism8#ism8-binding (the headline, see #17675)

<name>openHAB Add-ons :: Bundles :: Ism8 Binding</name>

<feature name="openhab-binding-ism8" description="ism8 Binding" version="${project.version}">

Copy link
Member Author

Choose a reason for hiding this comment

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

I am not sure if this is the right approach. I think that "renaming" the binding may be too much - just to give a better search experience.
Maybe it would be better to extend the search in the UI from title to the descriptions....
...and if that is too much effort, even living with the current situation might be an option.

What are your thoughts on that? @jlaur @lsiepel?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree that bindings should not be renamed just to add search words for the UI, so if the renaming otherwise doesn't make sense or seems overkill, then I would also rather prefer one of your other suggested options.

I don't know if it is feasible to use description for the search as well, but you could try to open an issue in the openhab-webui repo. At first it seems straightforward, but when looking at a description, for example this one: "This is the binding for the ISM8 card used for Wolf heating systems or other Wolf eBus devices.", I wonder if certain words should be excluded to not give too many unrelated results. At least it looks like a simple substring matcher, but maybe there is a fancy search machine behind. 😄

@holgerfriedrich
Copy link
Member Author

Support for the suggestion finder could also eliminate the need to search for this binding?

I took a Wireshark dump for about 15 mins on an ISM8 with (older) firmware 1.60:
On startup of the heating system, it shows MDNS traffic like this;
image
We have an entry in addons.xml,

<name>mdnsServiceType</name>
<value>_ism7._tcp.local.</value>

(I did not try out if this actually works).

The problem is, that I did not see any further activity on MDNS after startup of the heating system - and you typically do not power it down very often.
So from my perspective, auto-detection is possible, but quite limited.

@holgerfriedrich
Copy link
Member Author

Thanks, @jlaur, for the feedback.

I have opened openhab/openhab-webui#2870 and will close this one.

@holgerfriedrich holgerfriedrich deleted the pr-wolf-naming branch November 17, 2024 08:12
@openhab-bot
Copy link
Collaborator

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/entsoe-binding-4-0-0-5-0-0/149699/123

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants