UsbSerialDiscovery service based on Windows registry

[andrewfg]

This is a new implementation of the UsbSerialDiscovery interface for Windows, which discovers USB devices by reading from the Windows registry.

This may be an alternative, or an extension, to #3930

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

[andrewfg]

@mherwege 4yi

[andrewfg]

@mherwege it will probably fail the Karaf build (as usual) due to missing feature :( -- EDIT: fixed :)

[andrewfg]

@mherwege I added the missing serial port and interface information

[andrewfg]

As #3922 is now merged, this one is also ready for review.

[wborn]

This seems useful for Windows users. 👍

I only have a few minor comments:

[andrewfg]

@wborn there is still the question of which UsbSerialDiscovery components should be loaded on which platforms .. I guess the following .. => WDYT? And the next question is how to program the dependencies and karaf stuff .. which is probably beyond my capabilities :(

• ser2net - all platforms
• sysfs - Linux
• windowsregistry - Windows
• javaxusb - all platforms except Linux and Windows

[wborn]

I guess the following

Yes that probably makes sense.

sysfs - Linux

It doesn't use any native dependency which is very convenient because Linux runs on so many platforms. So it will result in fewer issues compared to javaxusb.

javaxusb - all platforms except Linux and Windows

It uses native libraries and only supports Linux, Windows and macOS. So it probably only makes sense to use it on macOS.

And the next question is how to program the dependencies and karaf stuff

You may be able to use <conditional> for that, see also #3632 (comment).

[andrewfg]

may be able to use for that

@wborn the following is simply a wild guess idea .. but I would like to have some feedback from more knowledgeable Karaf experts before even attempting to make such a commit.

.. in particular if the osgi.native.osname~=Windows is a proper syntax..

<feature name="openhab-transport-serial" description="Serial Transport" version="${project.version}">
    <feature>openhab-core-base</feature>

    <requirement>openhab.tp;filter:="(feature=commons-net)"</requirement>
    <feature dependency="true">openhab.tp-commons-net</feature>

    <requirement>openhab.tp;filter:="(&amp;(feature=serial)(impl=rxtx))"</requirement>
    <feature dependency="true">openhab.tp-serial-rxtx</feature>

    <feature dependency="true">openhab-core-io-transport-mdns</feature>

    <bundle>mvn:org.openhab.core.bundles/org.openhab.core.config.serial/${project.version}</bundle>
    <bundle>mvn:org.openhab.core.bundles/org.openhab.core.config.discovery.usbserial/${project.version}</bundle>
    
    <conditional>
        <condition>req:osgi.native;filter:="(osgi.native.osname=MacOS)"</condition>
        <bundle>mvn:org.openhab.core.bundles/org.openhab.core.config.discovery.usbserial.javaxusb/${project.version}</bundle>
    </conditional>
    
    <conditional>
        <condition>req:osgi.native;filter:="(osgi.native.osname=Linux)"</condition>
        <bundle>mvn:org.openhab.core.bundles/org.openhab.core.config.discovery.usbserial.linuxsysfs/${project.version}</bundle>
    </conditional>
    
    <bundle>mvn:org.openhab.core.bundles/org.openhab.core.config.discovery.usbserial.ser2net/${project.version}</bundle>
    
    <conditional>
        <condition>req:osgi.native;filter:="(osgi.native.osname~=Windows)"</condition>
        <bundle>mvn:org.openhab.core.bundles/org.openhab.core.config.discovery.usbserial.windowsregistry/${project.version}</bundle>
    </conditional>
    
    <bundle>mvn:org.openhab.core.bundles/org.openhab.core.io.transport.serial/${project.version}</bundle>
    <bundle>mvn:org.openhab.core.bundles/org.openhab.core.io.transport.serial.rxtx/${project.version}</bundle>
    <bundle>mvn:org.openhab.core.bundles/org.openhab.core.io.transport.serial.rxtx.rfc2217/${project.version}</bundle>

</feature>

[wborn]

I haven't used this myself yet. Just give it a try and see what happens. 🙂

[andrewfg]

Just give it a try and see what happens

Yeah. I just ran a full build of OH this afternoon (it takes ages on my machine; I probably need to buy a new one). The build succeeded without error. But I will test it tomorrow.

[andrewfg]

@wborn below is a screenshot in Windows showing that this (Windows) discovery is installed, and the existing (Linux) discovery is not. To be ultra safe we would need to check the opposite case on a Linux machine. However I currently don't have a Linux test machine, so I wonder if you could eventually test it for me?

[wborn]

I wonder if you could eventually test it for me?

I just gave it a test on Ubuntu and the linuxsysfs bundle keeps getting installed while the windowsregistry bundle is not. 👍

[wborn]

Thanks for the new UsbSerialDiscovery!

[andrewfg]

gave it a test on Ubuntu and the linuxsysfs bundle keeps getting installed

I also -- finally -- managed to test it on a RasPi3 running Linux and it also shows the correct components loaded..