How to get an addon to show up in the new Addon Suggestion Finder list?

holgerf · December 19, 2023, 9:45pm

For IP discovery I created a new issue to collect requirements from different addons:

Extend service to suggest addons via generic IP scan

opened 09:39PM - 19 Dec 23 UTC

enhancement

PR #3920 introduced a (partly) generic addon finder, which allows to discover de…vices by sending single IP frames. This is useful for devices which do not actively announce and require a search request to a multicast address. Maybe the word scanning is a bit misleading, at the moment it is just a single search frame, and only once at start-up in the current implementation. Note: if case you can use mdns or upnp, there are separate addon finders for this! If you want to detect a service running locally, there is one for processes as well. The implementation is rather tuned to a single use right now - detecting KNX installations - but is intended to be extended towards release 4.2. **This issue is to collect requirements from other addons** which can be used when starting a generalization. The configuration is via ```addon.xml``` and looks like this: ``` <discovery-method> <discovery-method> <service-type>ip</service-type> <discovery-parameters> <discovery-parameter> <name>type</name> <value>ipMulticast</value> </discovery-parameter> <discovery-parameter> <name>destIp</name> <value>224.0.23.12</value> </discovery-parameter> <discovery-parameter> <name>destPort</name> <value>3671</value> </discovery-parameter> <discovery-parameter> <name>request</name> <value>0x06 0x10 0x02 0x01 0x00 0x0e 0x08 0x01 $srcIp $srcPort</value> </discovery-parameter> <discovery-parameter> <name>timeoutMs</name> <value>5000</value> </discovery-parameter> </discovery-parameters> <match-properties> <match-property> <name>response</name> <regex>.*</regex> </match-property> </match-properties> </discovery-method> </discovery-methods> ``` Frames to be sent are specified in the parameter section, and dynamic replacement of source IP and port is possible. Any return frame is matched, only the catch all .* is supported. | addon | detection method | scan interval | dynamic data | parsed response | PR | | --- | --- | --- | --- | --- | --- | | knx | mulitcast frame (hex data) | once | srcIp, srcPort | .* | #3912 | | ipcamera | multicase frame (xml) | tbd | randomNumber | tbd | N/A | (table to be continued) Features to be developed (incomplete list): * send at regular intervals (add-on specific setting) * real regex matching for result frames (match packet as hex stream, and loop over all result frames until match is found or timeout occurs) * new dynamic data, e.g. randomNumber of certain length

Please note that mDNS, UPnP, and process addon suggestion finders exist as well and should be preferred if possible.