Wago App HTTP
Wago App HTTP
Release 1.7.3.4
1 Description 1
3 80 Status 16
3.1 Status (GVL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2 eStatusHTTP_Curl (ENUM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4 ParameterList (PARAMS) 17
5 VersionHistory (GVL) 18
6 Library Reference 19
6.1 Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.1.1 Library Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.1.2 Library Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2 WagoSysCurl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.1 Library Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.2 Library Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.3 WagoSysErrorBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.3.1 Library Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.3.2 Library Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.3.3 Library Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.4 WagoSysVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.4.1 Library Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.4.2 Library Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.5 WagoTypesCurl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.5.1 Library Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.5.2 Library Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
i
6.6 WagoTypesErrorBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.6.1 Library Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.6.2 Library Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
ii
CHAPTER 1
Description
This document is automatically generated. Because of this, the chapter 30 Visualization is not shown in this
document. If you are interested in getting to know more about visualization, we refer to the library manager of
e!Cockpit.
Subject to Changes
WAGO GmbH & Co. KG reserves the right to provide for any alterations or modifications. WAGO GmbH & Co.
KG owns all rights arising from the granting of patents or from the legal protection of utility patents. Third-party
products are always mentioned without any reference to patent rights. Thus, the existence of such rights cannot
be excluded.
Personnel Qualification
All tasks that are carried out with libraries made for the e!COCKPIT software must only be performed by qualified
electrical specialists instructed in PLC programming according to IEC 61131-3.
All tasks that have an effect on the properties or the behavior of automation hardware or software products must
only be performed by qualified employees with a thorough knowledge of handling the products concerned.
Intended Use of e!COCKPIT Libraries
Libraries created for the e!COCKPIT software are used to simplify the development of application projects in the
IEC 61131-3 programming languages.
For automation tasks, WAGO offers programmable logic controllers in a wide variety of performance classes.
In combination with a wide range of I/O modules, the controllers can process standard types of field signals.
Controllers can be implemented centrally or in decentralized configurations. The controllers offer interfaces for
the most commonly used fieldbuses for use in decentralized configurations. Fieldbus independent I/O modules
are then linked via fieldbus couplers. WAGO controllers offer a runtime environment for user programs called
e!RUNTIME. Software projects for implementation in e!RUNTIME environments can be created in e!COCKPIT.
The programming environment in e!COCKPIT is based on the established CODESYS 3 industrial standard. Users
with a previous knowledge of CODESYS 3 will thus find this environment largely familiar. The following pro-
gramming languages of the IEC 61131-3 standard are available:
• Structured Text (ST)
• Ladder Diagram (LD)
• Function Block Diagram (FBD)
• Instruction List (IL)
• Sequential Function Chart (SFC)
1
WagoAppHTTP, Release 1.7.3.4
2
CHAPTER 2
2.1 Advanced
2.1.1 FbHTTP_Client_Curl (FB)
Interface variables
3
WagoAppHTTP, Release 1.7.3.4
Function description
This function block communicate with an HTTP server via HTTP(s) request.
2.1. Advanced 4
WagoAppHTTP, Release 1.7.3.4
2.1. Advanced 5
WagoAppHTTP, Release 1.7.3.4
Function description
This function block should be used reading data from a webserver. As defined by the standard, it is also possible
to transfer a small amount of data to the webserver. In this case the URI must contain the data in an appropriate
manner.
Input eAuthentication: | Option digest not yet supported
Input pHeader: | This input may be used to specify the Header field as defined in RFC7231 | example 1:
| sHeader:=’Accept: text/plain’ | pHeader:=adr(sHeader); | example 2: | sHeader:=’Content-type: text/html ;
charset=UTF-8’ | pHeader:=adr(sHeader);
2.1. Advanced 6
WagoAppHTTP, Release 1.7.3.4
Function description
This function block should be used reading data from a webserver by using the HTTP post command.
Input eAuthentication: | Option digest not yet supported
Input pHeader: | This input may be used to specify the Header field as defined in RFC7231 | exam-
ple 1: | pHeader:=adr(sHeader); | sHeader:=’Accept: text/plain’ | example 2: | pHeader:=adr(sHeader); |
sHeader:=’Content-type: text/html ; charset=UTF-8’
2.1. Advanced 7
WagoAppHTTP, Release 1.7.3.4
Function description
This function block should be used reading data from a webserver. As defined by the standard, it is also possible
to transfer a small amount of data to the webserver. In this case the URI must contain the data in an appropriate
manner.
Input eAuthentication: | Option digest not yet supported
Input sHeader: | This input may be used to specify the Header field as defined in RFC7231 | example 1: |
sHeader:=’Accept: text/plain’ | example 2: | sHeader:=’Content-type: text/html ; charset=UTF-8’
2.1. Advanced 8
WagoAppHTTP, Release 1.7.3.4
Input typSSL_Options: Use sCA_Path if you have imported a bundle file like cacert.pem By default the cac-
ert.pem from mozilla.org is used (for more information: http://hg.mozilla.org/releases/mozilla-release/raw-file/
default/security/nss/lib/ckfw/builtins/certdata.txt
Use sCA_Cert if you have imported a single server certificate in pem format.
Option xVerifyPeer allows to check the basic certificate information. Option should be false, if no server
certificate is available
Option xVerifyHost allows to check the exact identity of the server by means of common name.
Leave ‘‘sClientCert‘‘blank, unless a client certificate is used
Leave sClientCert_Key blank, unless a client certificate is used
Leave sClientCert_KeyPasswd blank, unless a client certificate is used
2.1. Advanced 9
WagoAppHTTP, Release 1.7.3.4
Function description
This function block should be used reading data from a webserver by using the HTTP post command.
Input eAuthentication: | Option digest not yet supported
Input pHeader: | This input may be used to specify the Header field as defined in RFC7231 | exam-
ple 1: | pHeader:=adr(sHeader); | sHeader:=’Accept: text/plain’ | example 2: | pHeader:=adr(sHeader); |
sHeader:=’Content-type: text/html ; charset=UTF-8’
Input typSSL_Options: Use sCA_Path if you have imported a bundle file like cacert.pem By default the cac-
ert.pem from mozilla.org is used (for more information: http://hg.mozilla.org/releases/mozilla-release/raw-file/
default/security/nss/lib/ckfw/builtins/certdata.txt
Use sCA_Cert if you have imported a single server certificate in pem format.
Option xVerifyPeer allows to check the basic certificate information. Option should be false, if no server
certificate is available
Option xVerifyHost allows to check the exact identity of the server by means of common name.
Leave ‘‘sClientCert‘‘blank, unless a client certificate is used
Leave sClientCert_Key blank, unless a client certificate is used
Leave sClientCert_KeyPasswd blank, unless a client certificate is used
2.1. Advanced 10
WagoAppHTTP, Release 1.7.3.4
Function description
This function block should be used reading data from a webserver. As defined by the standard, it is also possible
to transfer a small amount of data to the webserver. In this case the URI must contain the data in an appropriate
manner. The size of the URI is limited to 1023 byte.
Input eAuthentication: | Option digest not yet supported
Input sHeader: | This input may be used to specify the Header field as defined in RFC7231 | example 1: |
sHeader:=’Accept: text/plain’ | example 2: | sHeader:=’Content-type: text/html ; charset=UTF-8’
Function description
This function block should be used reading data from a webserver by using the HTTP post command.
Input eAuthentication: | Option digest not yet supported
Input sHeader: | This input may be used to specify the Header field as defined in RFC7231 | example 1: |
sHeader:=’Accept: text/plain’ | example 2: | sHeader:=’Content-type: text/html ; charset=UTF-8’
Function description
This function block should be used reading data from a webserver. As defined by the standard, it is also possible
to transfer a small amount of data to the webserver. In this case the URI must contain the data in an appropriate
manner. The size of the URI is limited to 1023 byte.
Input eAuthentication: | Option digest not yet supported
Input sHeader: | This input may be used to specify the Header field as defined in RFC7231 | example 1: |
sHeader:=’Accept: text/plain’ | example 2: | sHeader:=’Content-type: text/html ; charset=UTF-8’
Input typSSL_Options: Use sCA_Path if you have imported a bundle file like cacert.pem By default the cac-
ert.pem from mozilla.org is used (for more information: http://hg.mozilla.org/releases/mozilla-release/raw-file/
default/security/nss/lib/ckfw/builtins/certdata.txt
Use sCA_Cert if you have imported a single server certificate in pem format.
Option xVerifyPeer allows to check the basic certificate information. Option should be false, if no server
certificate is available
Option xVerifyHost allows to check the exact identity of the server by means of common name.
Leave ‘‘sClientCert‘‘blank, unless a client certificate is used
Leave sClientCert_Key blank, unless a client certificate is used
Leave sClientCert_KeyPasswd blank, unless a client certificate is used
Function description
This function block should be used reading data from a webserver by using the HTTP post command.
80 Status
16
CHAPTER 4
ParameterList (PARAMS)
17
CHAPTER 5
VersionHistory (GVL)
WagoAppHTTP
Date Version Author Change
10.12.2021 1.7.3.4 WAGO / Add DELETE command in FbHTTP_Client_Curl
u010663
04.06.2020 1.7.3.3 WAGO / Bugfix FbHTTP_Client_Curl
u010663
09.12.2019 1.7.3.2 WAGO / Improvement error codes, e.g. 404
u010663
09.05.2019 1.7.3.1 WAGO / New function block FbHTTP_Client_Curl in folder Advanced
u010663
08.01.2019 1.7.3.0 WAGO / Properties: free placeholder added
u015842
03.12.2018 1.7.2.0 WAGO / New function blocks in folder Advanced
u010663
04.06.2018 1.7.1.2 WAGO / Change Placeholder for WagoSysCurl
u013972
30.08.2017 1.7.1.1 WAGO / Documentation issues
u010663
05.04.2017 1.7.1.0 WAGO / Size of string inputs increased (1023)
u010663
15.12.2016 1.7.0.4 WAGO / Bugfix FbHTTPs_Get and FbHTTPs_Post, input
u010663 typAuthentification renamed
09.12.2016 1.7.0.2 WAGO / Add FbHTTPs_Get and FbHTTPs_Post ,
u010663 PFC200,PFC100:requieres FW>8
19.05.2016 1.6.0.1 WAGO / R3 released
u010663
Release Notes
Version 1.7.2.0 and greater require FW11Patch2 (with ipk tsccurl_0.0.2) or higher
Version 1.7.1.0 and greater require FW10 or higher
HTTPs functionality requieres in case of a PFC200 or PFC100 a firmware greater than 8 Authentifi-
cation method “Digest-MD5” not yet supported
18
CHAPTER 6
Library Reference
6.1 Standard
6.1.1 Library Identification
Placeholder: Standard
Default Resolution: Standard, * (System)
Namespace: Standard
6.2 WagoSysCurl
6.2.1 Library Identification
Placeholder: WagoSysCurl
Default Resolution: WagoSysCurl, * (WAGO)
Namespace: WagoSysCurl
19
WagoAppHTTP, Release 1.7.3.4
6.3 WagoSysErrorBase
6.3.1 Library Identification
Placeholder: WagoSysErrorBase
Default Resolution: WagoSysErrorBase, * (WAGO)
Namespace: WagoSysErrorBase
Parameter: RES_LOG_MAX_FILES = 1
6.4 WagoSysVersion
6.4.1 Library Identification
Name: WagoSysVersion
Version: 1.0.0.0
Company: WAGO
Namespace: WagoSysVersion
6.5 WagoTypesCurl
6.5.1 Library Identification
Placeholder: WagoTypesCurl
Default Resolution: WagoTypesCurl, * (WAGO)
Namespace: WagoTypesCurl
6.3. WagoSysErrorBase 20
WagoAppHTTP, Release 1.7.3.4
6.6 WagoTypesErrorBase
6.6.1 Library Identification
Placeholder: WagoTypesErrorBase
Default Resolution: WagoTypesErrorBase, * (WAGO)
Namespace: WagoTypesErrorBase
6.6. WagoTypesErrorBase 21