Package org.openhab.core.config.discovery.addon.usb

Class UsbAddonFinder

java.lang.Object

org.openhab.core.config.discovery.addon.BaseAddonFinder

org.openhab.core.config.discovery.addon.usb.UsbAddonFinder

All Implemented Interfaces:

AddonFinder, UsbSerialDiscoveryListener

@NonNullByDefault
public class UsbAddonFinder
extends BaseAddonFinder
implements UsbSerialDiscoveryListener

This is a AddonFinder for finding suggested add-ons related to USB devices.

It supports the following values for the 'match-property' 'name' element:

product - match on the product description text

manufacturer - match on the device manufacturer text

chipId - match on the chip vendor id plus product id

remote - match on whether the device is connected remotely or locally

Author:

Andrew Fiddian-Green - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHIP_ID
static final String	MANUFACTURER
static final String	PRODUCT
static final String	REMOTE
static final String	SERVICE_NAME
static final String	SERVICE_TYPE
static final Set<String>	SUPPORTED_PROPERTIES

Fields inherited from class org.openhab.core.config.discovery.addon.BaseAddonFinder

addonCandidates

Constructor Summary

Constructors

Constructor	Description
UsbAddonFinder()

Method Summary

Modifier and Type	Method	Description
protected void	addUsbSerialDiscovery(UsbSerialDiscovery usbSerialDiscovery)
String	getServiceName()
Set<AddonInfo>	getSuggestedAddons()	The framework calls this method to scan through the candidate list of AddonInfo and return a subset of those that it suggests to be installed.
protected void	removeUsbSerialDiscovery(UsbSerialDiscovery usbSerialDiscovery)
void	usbSerialDeviceDiscovered(UsbSerialDeviceInformation discoveredInfo)	Add the discovered USB device information record to our internal map.
void	usbSerialDeviceRemoved(UsbSerialDeviceInformation removedInfo)	Called when a serial port provided by a USB device has been removed.

Methods inherited from class org.openhab.core.config.discovery.addon.BaseAddonFinder

propertyMatches, setAddonCandidates, unsetAddonCandidates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SERVICE_TYPE

public static final String SERVICE_TYPE

See Also:

• Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

• Constant Field Values

PRODUCT

public static final String PRODUCT

See Also:

• Constant Field Values

MANUFACTURER

public static final String MANUFACTURER

See Also:

• Constant Field Values

CHIP_ID

public static final String CHIP_ID

See Also:

• Constant Field Values

REMOTE

public static final String REMOTE

See Also:

• Constant Field Values

SUPPORTED_PROPERTIES

public static final Set<String> SUPPORTED_PROPERTIES

Constructor Details

UsbAddonFinder

public UsbAddonFinder()

Method Details

addUsbSerialDiscovery

protected void addUsbSerialDiscovery(UsbSerialDiscovery usbSerialDiscovery)

removeUsbSerialDiscovery

protected void removeUsbSerialDiscovery(UsbSerialDiscovery usbSerialDiscovery)

getSuggestedAddons

public Set<AddonInfo> getSuggestedAddons()

Description copied from interface: AddonFinder

The framework calls this method to scan through the candidate list of AddonInfo and return a subset of those that it suggests to be installed.

Specified by:

getSuggestedAddons in interface AddonFinder

getServiceName

public String getServiceName()

Specified by:

getServiceName in class BaseAddonFinder

usbSerialDeviceDiscovered

public void usbSerialDeviceDiscovered(UsbSerialDeviceInformation discoveredInfo)

Add the discovered USB device information record to our internal map. If there is already an entry in the map then merge the two sets of data.

Specified by:

usbSerialDeviceDiscovered in interface UsbSerialDiscoveryListener

Parameters:

discoveredInfo - the newly discovered USB device information.

usbSerialDeviceRemoved

public void usbSerialDeviceRemoved(UsbSerialDeviceInformation removedInfo)

Description copied from interface: UsbSerialDiscoveryListener

Called when a serial port provided by a USB device has been removed.

Specified by:

usbSerialDeviceRemoved in interface UsbSerialDiscoveryListener