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

Class SddpDiscoveryService

java.lang.Object

org.openhab.core.config.discovery.AbstractDiscoveryService

org.openhab.core.config.discovery.sddp.SddpDiscoveryService

All Implemented Interfaces:

AutoCloseable, DiscoveryService, NetworkAddressChangeListener

@NonNullByDefault
public class SddpDiscoveryService
extends AbstractDiscoveryService
implements AutoCloseable, NetworkAddressChangeListener

This is a DiscoveryService implementation, which can find SDDP devices in the network.

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.

Support for bindings can be achieved by implementing and registering a SddpDiscoveryParticipant. Support for finders can be achieved by implementing and registering a SddpDeviceParticipant.

Author:

Andrew Fiddian-Green - Initial contribution

Field Summary

Fields inherited from class org.openhab.core.config.discovery.AbstractDiscoveryService

i18nProvider, localeProvider, scanListener, scheduler

Fields inherited from interface org.openhab.core.config.discovery.DiscoveryService

CONFIG_PROPERTY_BACKGROUND_DISCOVERY

Constructor Summary

Constructors

Constructor	Description
SddpDiscoveryService(@Nullable Map<String,Object> configProperties, NetworkAddressService networkAddressService, TranslationProvider i18nProvider, LocaleProvider localeProvider)

Method Summary

Modifier and Type	Method	Description
void	addSddpDeviceParticipant(SddpDeviceParticipant participant)
protected void	addSddpDiscoveryParticipant(SddpDiscoveryParticipant participant)
void	close()
Optional<SddpDevice>	createSddpDevice(String data)	Optionally create an SddpDevice object from UDP packet data if the data is good.
protected void	deactivate()	Called on component deactivation, if the implementation of this class is an OSGi declarative service and does not override the method.
Set<ThingTypeUID>	getSupportedThingTypes()	Returns the list of Thing types which are supported by the DiscoveryService.
protected void	modified(@Nullable Map<String,Object> configProperties)	Called when the configuration for the discovery service is changed.
void	onChanged(List<CidrAddress> added, List<CidrAddress> removed)	If the network interfaces change then cancel and recreate all pending tasks.
void	removeSddpDeviceParticipant(SddpDeviceParticipant participant)
void	removeSddpDiscoveryParticipant(SddpDiscoveryParticipant participant)
protected void	startBackgroundDiscovery()	Can be overridden to start background discovery logic.
protected void	startScan()	Schedule to send one single SDDP SEARCH request, and listen for responses.
protected void	stopBackgroundDiscovery()	Can be overridden to stop background discovery logic.

Methods inherited from class org.openhab.core.config.discovery.AbstractDiscoveryService

abortScan, activate, addDiscoveryListener, getLocalizedDiscoveryResult, getScanInputDescription, getScanInputLabel, getScanTimeout, getTimestampOfLastScan, isBackgroundDiscoveryEnabled, isScanInputSupported, removeDiscoveryListener, removeOlderResults, removeOlderResults, removeOlderResults, startScan, startScan, startScan, stopScan, thingDiscovered, thingRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.net.NetworkAddressChangeListener

onPrimaryAddressChanged

Constructor Details

SddpDiscoveryService

public SddpDiscoveryService(@Nullable Map<String,Object> configProperties,
 NetworkAddressService networkAddressService,
 TranslationProvider i18nProvider,
 LocaleProvider localeProvider)

Method Details

addSddpDeviceParticipant

public void addSddpDeviceParticipant(SddpDeviceParticipant participant)

addSddpDiscoveryParticipant

protected void addSddpDiscoveryParticipant(SddpDiscoveryParticipant participant)

close

public void close()

Specified by:

close in interface AutoCloseable

createSddpDevice

public Optional<SddpDevice> createSddpDevice(String data)

Optionally create an SddpDevice object from UDP packet data if the data is good.

deactivate

protected void deactivate()

Description copied from class: AbstractDiscoveryService

Called on component deactivation, if the implementation of this class is an OSGi declarative service and does not override the method. The method implementation calls AbstractDiscoveryService.stopBackgroundDiscovery() if background discovery is enabled at the time of component deactivation.

Overrides:

deactivate in class AbstractDiscoveryService

getSupportedThingTypes

public Set<ThingTypeUID> getSupportedThingTypes()

Description copied from class: AbstractDiscoveryService

Returns the list of Thing types which are supported by the DiscoveryService.

Specified by:

getSupportedThingTypes in interface DiscoveryService

Overrides:

getSupportedThingTypes in class AbstractDiscoveryService

Returns:

the list of Thing types which are supported by the discovery service (not null, could be empty)

modified

protected void modified(@Nullable Map<String,Object> configProperties)

Description copied from class: AbstractDiscoveryService

Called when the configuration for the discovery service is changed. If background discovery should be enabled and is currently disabled, the method AbstractDiscoveryService.startBackgroundDiscovery() is called. If background discovery should be disabled and is currently enabled, the method AbstractDiscoveryService.stopBackgroundDiscovery() is called. In all other cases, nothing happens.

Overrides:

modified in class AbstractDiscoveryService

Parameters:

configProperties - configuration properties

onChanged

public void onChanged(List<CidrAddress> added,
 List<CidrAddress> removed)

If the network interfaces change then cancel and recreate all pending tasks.

Specified by:

onChanged in interface NetworkAddressChangeListener

Parameters:

added - Unmodifiable list of recently added network addresses

removed - Unmodifiable list of recently removed network addresses

removeSddpDeviceParticipant

public void removeSddpDeviceParticipant(SddpDeviceParticipant participant)

removeSddpDiscoveryParticipant

public void removeSddpDiscoveryParticipant(SddpDiscoveryParticipant participant)

startBackgroundDiscovery

protected void startBackgroundDiscovery()

Description copied from class: AbstractDiscoveryService

Can be overridden to start background discovery logic. This method is called if background discovery is enabled when the component is being activated (see AbstractDiscoveryService.activate(java.util.Map<java.lang.String, java.lang.Object>).

Overrides:

startBackgroundDiscovery in class AbstractDiscoveryService

startScan

protected void startScan()

Schedule to send one single SDDP SEARCH request, and listen for responses.

Specified by:

startScan in class AbstractDiscoveryService

stopBackgroundDiscovery

protected void stopBackgroundDiscovery()

Description copied from class: AbstractDiscoveryService

Can be overridden to stop background discovery logic. This method is called if background discovery is enabled when the component is being deactivated (see AbstractDiscoveryService.deactivate().

Overrides:

stopBackgroundDiscovery in class AbstractDiscoveryService