IPS_IsSearching

 bool IPS_IsSearching (int $InstanzID) 

Parameterliste

Rückgabewert

Befindet sich die Instanz im Suchmodus, wird TRUE zurückgemeldet, andernfalls FALSE.

Beschreibung

Die Funktion prüft, ob sich die Instanz mit der ID InstanzID im Suchmodus befindet, also ob der mit IPS_StartSearch gestartete Suchmodus weder abgelaufen noch mit IPS_StopSearch beendet ist. Für Module ohne Suchmodus liefert sie FALSE. Bei einer nicht existierenden Instanz schlägt sie mit "Instance #... does not exist" fehl.

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.

Dieselbe Information enthält der Eintrag InstanceIsSearching von IPS_GetInstance.

Beispiel

if (IPS_IsSearching(12345)) {
    echo 'Die Instanz sucht gerade nach Geräten';
}