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

Class SddpAddonFinder

java.lang.Object

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

org.openhab.core.config.discovery.addon.sddp.SddpAddonFinder

All Implemented Interfaces:

AddonFinder, SddpDeviceParticipant

@NonNullByDefault
public class SddpAddonFinder
extends BaseAddonFinder
implements SddpDeviceParticipant

This is a SddpAddonFinder for finding suggested Addons via SDDP.

Simple Device Discovery Protocol (SDDP) is a simple multicast discovery protocol implemented by many "smart home" devices to allow a controlling agent to easily discover and connect to devices on a local subnet.

SDDP was created by Control4, and is quite similar to UPnP's standard Simple Service Discovery Protocol (SSDP), and it serves a virtually identical purpose. SDDP is not a standard protocol and it is not publicly documented.

It checks the binding's addon.xml 'match-property' elements for the following SDDP properties:

driver

host

ipAddress

macAddress

manufacturer

model

port

primaryProxy

proxies

type

Author:

Andrew Fiddian-Green - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_NAME
static final String	SERVICE_TYPE

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

addonCandidates

Constructor Summary

Constructors

Constructor	Description
SddpAddonFinder(DiscoveryService discoveryService)

Method Summary

Modifier and Type	Method	Description
void	deactivate()
void	deviceAdded(SddpDevice device)
void	deviceRemoved(SddpDevice device)
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.
void	setAddonCandidates(List<AddonInfo> candidates)	The framework calls this method to provide a list of AddonInfo elements which contain potential candidates that this finder can iterate over in order to detect which ones to return via the getSuggestedAddons() method.

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

propertyMatches, 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

Constructor Details

SddpAddonFinder

public SddpAddonFinder(DiscoveryService discoveryService)

Method Details

deactivate

public void deactivate()

deviceAdded

public void deviceAdded(SddpDevice device)

Specified by:

deviceAdded in interface SddpDeviceParticipant

deviceRemoved

public void deviceRemoved(SddpDevice device)

Specified by:

deviceRemoved in interface SddpDeviceParticipant

getServiceName

public String getServiceName()

Specified by:

getServiceName in class BaseAddonFinder

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

setAddonCandidates

public void setAddonCandidates(List<AddonInfo> candidates)

Description copied from interface: AddonFinder

The framework calls this method to provide a list of AddonInfo elements which contain potential candidates that this finder can iterate over in order to detect which ones to return via the getSuggestedAddons() method.

Specified by:

setAddonCandidates in interface AddonFinder

Overrides:

setAddonCandidates in class BaseAddonFinder

Parameters:

candidates - a list of AddonInfo candidates.