demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

switch to SDDP discovery (#17508)

Browse Source 
Signed-off-by: Michael Lobstein <michael.lobstein@gmail.com>
Signed-off-by: Ciprian Pascu <contact@ciprianpascu.ro>
This commit is contained in:
mlobstein 2024-10-05 03:54:41 -05:00 committed by Ciprian Pascu
parent 17d03903e0
commit 832ba7e3ea
4 changed files with 18 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.kaleidescape/README.md
View File

@ -22,7 +22,7 @@ The binding supports either a TCP/IP connection or direct serial port connection
## Discovery
Auto-discovery is supported for Alto and Strato components if the device can be located on the local network using UPnP.
Auto-discovery is supported for Alto and Strato components if the device can be located on the local network using SDDP.
Manually initiated discovery will locate all legacy Premiere line components if they are on the same IP subnet of the openHAB server.
In the Inbox, select Search For Things and then choose the Kaleidescape Binding to initiate a discovery scan.

2
bundles/org.openhab.binding.kaleidescape/src/main/feature/feature.xml
View File

@ -5,7 +5,7 @@
<feature name="openhab-binding-kaleidescape" description="Kaleidescape Binding" version="${project.version}">
<feature>openhab-runtime-base</feature>
<feature>openhab-transport-serial</feature>
<feature>openhab-transport-upnp</feature>
<feature>openhab-core-config-discovery-sddp</feature>
<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.kaleidescape/${project.version}</bundle>
</feature>
</features>

39
bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/discovery/KaleidescapeDiscoveryParticipant.java
View File

@ -20,10 +20,10 @@ import java.util.Set;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.jupnp.model.meta.RemoteDevice;
import org.openhab.core.config.discovery.DiscoveryResult;
import org.openhab.core.config.discovery.DiscoveryResultBuilder;
import org.openhab.core.config.discovery.upnp.UpnpDiscoveryParticipant;
import org.openhab.core.config.discovery.sddp.SddpDevice;
import org.openhab.core.config.discovery.sddp.SddpDiscoveryParticipant;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.ThingUID;
import org.osgi.service.component.annotations.Component;
@ -31,14 +31,14 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@link KaleidescapeDiscoveryParticipant} class discovers Strato/Encore line components automatically via UPnP.
* The {@link KaleidescapeDiscoveryParticipant} class discovers Strato/Encore line components automatically via SDDP.
*
* @author Michael Lobstein - Initial contribution
*
*/
@NonNullByDefault
@Component(immediate = true)
public class KaleidescapeDiscoveryParticipant implements UpnpDiscoveryParticipant {
public class KaleidescapeDiscoveryParticipant implements SddpDiscoveryParticipant {
private final Logger logger = LoggerFactory.getLogger(KaleidescapeDiscoveryParticipant.class);
private static final String MANUFACTURER = "Kaleidescape";
@ -53,26 +53,19 @@ public class KaleidescapeDiscoveryParticipant implements UpnpDiscoveryParticipan
}
@Override
public @Nullable DiscoveryResult createResult(RemoteDevice device) {
public @Nullable DiscoveryResult createResult(SddpDevice device) {
final ThingUID uid = getThingUID(device);
if (uid != null) {
final Map<String, Object> properties = new HashMap<>(3);
final String label;
if (device.getDetails().getFriendlyName() != null && !device.getDetails().getFriendlyName().isBlank()) {
label = device.getDetails().getFriendlyName();
} else {
label = device.getDetails().getModelDetails().getModelName();
}
properties.put(PROPERTY_UUID, uid.getId());
properties.put(PROPERTY_HOST_NAME, device.getIdentity().getDescriptorURL().getHost());
properties.put(PROPERTY_HOST_NAME, device.ipAddress);
properties.put(PROPERTY_PORT_NUM, DEFAULT_API_PORT);
final DiscoveryResult result = DiscoveryResultBuilder.create(uid).withProperties(properties)
.withRepresentationProperty(PROPERTY_UUID).withLabel(label).build();
.withRepresentationProperty(PROPERTY_UUID).withLabel(device.model).build();
logger.debug("Created a DiscoveryResult for device '{}' with UID '{}'", label, uid.getId());
logger.debug("Created a DiscoveryResult for device '{}' with UID '{}'", device.model, uid.getId());
return result;
} else {
return null;
@ -80,24 +73,20 @@ public class KaleidescapeDiscoveryParticipant implements UpnpDiscoveryParticipan
}
@Override
public @Nullable ThingUID getThingUID(RemoteDevice device) {
if (device.getDetails().getManufacturerDetails().getManufacturer() != null
&& device.getDetails().getModelDetails().getModelName() != null
&& device.getDetails().getManufacturerDetails().getManufacturer().startsWith(MANUFACTURER)) {
final String modelName = device.getDetails().getModelDetails().getModelName();
final String id = device.getIdentity().getUdn().getIdentifierString().replace(":", EMPTY);
public @Nullable ThingUID getThingUID(SddpDevice device) {
if (device.manufacturer.startsWith(MANUFACTURER)) {
final String id = device.macAddress;
logger.debug("Kaleidescape {} with id {} found at {}", modelName, id,
device.getIdentity().getDescriptorURL().getHost());
logger.debug("Kaleidescape {} with id {} found at {}", device.model, id, device.host);
if (id.isBlank()) {
logger.debug("Invalid UDN for Kaleidescape device: {}", device.toString());
return null;
}
if (modelName.contains(ALTO)) {
if (device.model.contains(ALTO)) {
return new ThingUID(THING_TYPE_ALTO, id);
} else if (modelName.contains(STRATO)) {
} else if (device.model.contains(STRATO)) {
return new ThingUID(THING_TYPE_STRATO, id);
}
}

8
bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/addon/addon.xml
View File

@ -10,15 +10,11 @@
<discovery-methods>
<discovery-method>
<service-type>upnp</service-type>
<service-type>sddp</service-type>
<match-properties>
<match-property>
<name>manufacturer</name>
<regex>(?i)Kaleidescape</regex>
</match-property>
<match-property>
<name>deviceType</name>
<regex>.*Basic.*</regex>
<regex>(?i).*kaleidescape.*</regex>
</match-property>
</match-properties>
</discovery-method>