-
-
Notifications
You must be signed in to change notification settings - Fork 205
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
Addon suggestion finder xml #1908
Conversation
Signed-off-by: Andrew Fiddian-Green <[email protected]>
@mherwege for info |
Signed-off-by: Andrew Fiddian-Green <[email protected]>
…penhab.binding.zwave into suggestion-finder Merge Signed-off-by: Andrew Fiddian-Green <[email protected]>
Signed-off-by: Andrew Fiddian-Green <[email protected]>
Signed-off-by: Andrew Fiddian-Green <[email protected]>
Signed-off-by: Andrew Fiddian-Green <[email protected]>
Signed-off-by: Andrew Fiddian-Green <[email protected]>
Note: since openhab/openhab-core#3922 has been merged, this one is now ready for review. |
So I see that the same products are referenced in both the zigbee and zwave. I've not tried to work out what these products are so it's hard to know if this is an error, uncertainty, or what... I wonder if we shouldn't document this somewhere so that we know what these product IDs relate to. |
Yes these are dual function sticks that support both Z-Wave and ZigBee. For documentation see these |
Ok, I guess this is the hzusb1... I'd suggest we should document this somewhere it won't get lost. I think the PR is not a good place - I'd suggest either the XML, or possibly the readme. It will otherwise be a nightmare to work out what all these are later as it's rather verbose (by the nature of how it's been implemented) |
The two lists of chipId’s are as follows. The 10C4:8A2A is the dual function one common to both.
I am happy to add documentation. Would you prefer it to be in the read me, or the finder Java doc, or as you say the xml? |
I don't think it should be in Javadoc... Personally, I'd put it directly in the XML since then it's right next to the definitions of the devices, so it's easy to work out what is what. The other option would be to add a section on discovery in the readme and provide a table there if someone doesn't like to add comments in the XML. |
I already wrote a chapter in the docs (see below) which I can extend.. |
My point wasn't so much around the functionality - but somewhere that documents what So, I don't think you want to add that to the developper docs that you referenced. For me, this should go in the XML file where these definitions are made so we know exactly what this equates to. Alternatively, my other suggestion was it could. go in readme for each binding. |
Ok. We have a custom xml reader for those files, so hopefully it can handle comment fields in the xml without falling over. If so then I will simply add those comments. If not then I will need to fix that first. |
Signed-off-by: Andrew Fiddian-Green <[email protected]>
Ok. Done. @cdjackson see also this openhab/org.openhab.binding.zigbee#821 |
Thanks. |
This PR adds the suggestion finder xml to the addon.xml file in anticipation of the PR in openhab-core being merged.
Signed-off-by: Andrew Fiddian-Green [email protected]