diff --git a/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java b/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java index 6cab05b42..252103dc1 100644 --- a/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java +++ b/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java @@ -57,6 +57,70 @@ import org.slf4j.LoggerFactory; /** * This is a {@link IpAddonFinder} for finding suggested add-ons by sending IP packets to the * network and collecting responses. + * + * This finder is intended to detect devices on the network which do not announce via UPnP + * or mDNS. Some devices respond to queries to defined multicast addresses and ports and thus + * can be detected by sending a single frame on the IP network. + *
+ * Be aware of possible side effects of sending packets to unknown devices in the network! + * This is why the IP finder is not intended for large scale network scanning, e.g. using + * large port or IP ranges. + *
+ * Configuration + *
+ * The following parameters can be used to configure frames to be sent to the network: + *
+ *
| discovery-parameter | + *values | + *comment | + *
| {@code type} | + *ipMulticast | + *no other options implemented | + *
| {@code destIp} | + *destination IP address | + *+ * |
| {@code destPort} | + *destination port | + *+ * |
| {@code request} | + *description of request frame as hex bytes separated by spaces (e.g. 0x01 0x02 ...) | + *dynamic replacement of variables $srcIp and $srcPort, no others implemented yet + * |
| {@code timeoutMs} | + *timeout to wait for a answers | + *+ * |
+ * Packets are sent out on ever available network interface. + *
+ * There is currently only one match-property defined: {@code response}. + * It allows a regex match, but currently only ".*" is supported. + *
+ * Limitations + *
+ * The {@link IpAddonFinder} is still under active development. + * There are limitations: + *