FB_IotHttpClient

Dieser Funktionsbaustein ermöglicht die Kommunikation mit einem HTTP-Server.

Ein Client-Funktionsbaustein ist für die Verbindung mit genau einem Server verantwortlich. Die Methode Execute() des Funktionsbausteins muss zyklisch aufgerufen werden, um die Funktionalität des HTTP-Clients zu aktivieren. Die genaue Ressource auf dem Server wird mit der Eigenschaft sUri des Funktionsbausteins FB_IotHttpRequest spezifiziert.

Alle Verbindungsparameter sind als Eingangsparameter vorhanden und werden ausgewertet, wenn eine Verbindung hergestellt wird.

Syntax

Definition:

FUNCTION BLOCK FB_IotHttpClient 
VAR_INPUT
    //default is local host
    sHostName          : STRING((ParameterList.cSizeOfHttpClientHostName-1)) :=’127.0.0.1’;
    //default is 80
    nHostPort          : UINT :=80;
    bKeepAlive         : BOOL :=TRUE;        
    tConnectionTimeout : TIME :=T#10s;
    //optional parameter
    stTLS              : ST_IotSocketTls;
END_VAR
VAR_OUTPUT
    bError             : BOOL;
    hrErrorCode        : HRESULT;
    bConfigured        : BOOL;
    //TRUE if connection to server is established
    bConnected         : BOOL;
END_VAR

Eingänge

Name	Typ	Beschreibung
sHostName	STRING (255)	sHostName kann als Name oder als IP-Adresse festgelegt werden. Wenn keine Angaben gemacht werden, wird der lokale Host verwendet.
nHostPort	UINT	Hier kann der Hostport festgelegt werden. Der Standardwert ist 80.
bKeepAlive	BOOL	Legt fest, ob die Verbindung zum Server aufrechterhalten werden soll, bis entweder der Server oder Client sie beendet. Beachten Sie, dass nicht jeder Server diese Funktion unterstützt.
tConnectionTimeout	TIME	Legt das Verbindungs-Timeout fest.
stTLS	ST_IotSocketTls	Wenn der Server eine TLS-gesicherte Verbindung anbietet, kann die erforderliche Konfiguration hier implementiert werden.

Ausgänge

Name	Typ	Beschreibung
bError	BOOL	Wird TRUE, sobald eine Fehlersituation auftritt.
hrErrorCode	HRESULT	Gibt einen ADS Return Code zurück. Eine Erläuterung zu den möglichen ADS Return Codes befindet sich im Anhang.
bConfigured	BOOL	Wird TRUE, wenn die initiale Konfiguration abgeschlossen ist.
bConnected	BOOL	Wird TRUE, wenn eine Verbindung zum Host hergestellt ist. Beachten Sie, dass die Verbindung in der Regel nach jeder Anfrage geschlossen wird, abhängig vom Eingangsparameter bKeepAlive.

Methoden

Name	Beschreibung
Disconnect	Trennt den Client vom Server, wenn eine aktive Verbindung besteht.
Execute	Methode für Hintergrundkommunikation mit dem TwinCAT-Treiber. Die Methode muss für jede Funktionsbausteininstanz zyklisch aufgerufen werden. Wenn die Methode das erste Mal aufgerufen wird, bevor die Parameter geändert werden, werden Default-Werte verwendet. Dann kann eine Änderung der Parameter nur über die Neuparametrierung erreicht werden.

Name

Beschreibung

Disconnect

Trennt den Client vom Server, wenn eine aktive Verbindung besteht.

Execute

Methode für Hintergrundkommunikation mit dem TwinCAT-Treiber. Die Methode muss für jede Funktionsbausteininstanz zyklisch aufgerufen werden.

Wenn die Methode das erste Mal aufgerufen wird, bevor die Parameter geändert werden, werden Default-Werte verwendet. Dann kann eine Änderung der Parameter nur über die Neuparametrierung erreicht werden.

Voraussetzungen

Entwicklungsumgebung	Zielplattform	Einzubindende SPS-Bibliotheken
TwinCAT v3.1.4024.7 oder höher	IPC oder CX (x86, x64, ARM)	Tc3_IotBase