IPS_StartSearch

 bool IPS_StartSearch (int $InstanzID) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Die Funktion startet den Suchmodus der Instanz mit der ID InstanzID für 5 Minuten. Befindet sich die Instanz bereits im Suchmodus, wird die Suche ab jetzt um 5 Minuten verlängert.

Einige Geräte-Module unterstützen einen Suchmodus, z.B. die Instanzen für FS20, HMS, EnOcean oder HomeMatic. Im Suchmodus meldet die Instanz jedes empfangene Gerät mit seiner Adresse, zusammen mit einer bereits vorhandenen Instanz für diese Adresse. Die Verwaltungskonsole zeigt diese Ergebnisse im Suchdialog an, sodass ein Gerät durch Auslösen am Gerät gefunden und der Instanz zugeordnet werden kann. Der Suchmodus endet automatisch nach 5 Minuten. Vorzeitig beendet wird die Suche mit IPS_StopSearch.

Start und Ende der Suche werden über die Nachrichten IM_SEARCHSTART und IM_SEARCHSTOP gemeldet.

Unterstützt das Modul keinen Suchmodus, schlägt die Funktion mit "This module does not support searching" fehl, bei einer nicht existierenden Instanz mit "Instance #... does not exist". Ob eine Instanz den Suchmodus unterstützt, prüft IPS_SupportsSearching.

Beispiel

if (IPS_SupportsSearching(12345)) {
    IPS_StartSearch(12345);
}