Params ¶ Param (ParamList)
Param (PARAMS) ¶ HTTPClient parameters InOut: Scope Name Type Initial Comment Constant g_udiMaxRequestSize UDINT 20000 Maximum size of the http request in btyes g_udiMaxResponseSize UDINT 20000 Maximum size of the http response in bytes g_udiMaxHeaderSize UDINT 4000 Maximum size of the http header in bytes g_udiMaxOAuth2TokenSize UDINT 2048 Maximum size of the OAuth2 access and refresh token
Structs ¶ HttpResult (Struct) URL (Struct)
HttpResult (STRUCT) ¶ TYPE HttpResult : STRUCT The result of a http request InOut: Name Type Comment iStatus INT http status wsHeader WSTRING(g_udiMaxHeaderSize) http header as WSTRING wsContent WSTRING(g_udiMaxResponseSize) The result of the request as WSTRING sHeader STRING(g_udiMaxHeaderSize) http header as STRING sContent STRING(g_udiMaxResponseSize) The result of the request as STRING diContentLength DINT Count of bytes in sContent
URL (STRUCT) ¶ TYPE URL : STRUCT URL structure InOut: Name Type Comment sProtocol STRING(5) Protocol e.g. http, NOTE: ONLY HTTP IS SUPPORTED! sDomain STRING(255) The domain e.g. ‘twitter.api.com’ uiPort UINT Port of the server sPath STRING(1024) The path e.g. ‘/1.1/statuses/update.json’
Public ¶ Function Blocks BasicAuthWebClient (FunctionBlock) DigestAuthWebClient (FunctionBlock) mGetKeyValues (Method) OAuth1WebClient (FunctionBlock) OAuth2WebClient (FunctionBlock) ResetToken (Method) WebClient (FunctionBlock)
Function Blocks ¶ BasicAuthWebClient (FunctionBlock) DigestAuthWebClient (FunctionBlock) mGetKeyValues (Method) OAuth1WebClient (FunctionBlock) OAuth2WebClient (FunctionBlock) ResetToken (Method) WebClient (FunctionBlock)
BasicAuthWebClient (FB) ¶ FUNCTION_BLOCK BasicAuthWebClient Webclient with basic authentification InOut: Scope Name Type Initial Comment Input wsLogin WSTRING(255) Login name wsPassword WSTRING(255) Password xExecute BOOL Rising edge: Send request udiTimeOut UDINT Timeout in micro seconds sURL STRING(1024) URL of the web server eRequestType REQUEST_TYPE REQUEST_TYPE.GET Type of the request: POST or GET eContentType CONTENT_TYPE CONTENT_TYPE.APPLICATION_FORM HTTP Content-Type of the request pwsAdditionalHeader POINTER TO WSTRING Additional HTTP header pwsPostValue POINTER TO WSTRING Post parameter xCloseConnection BOOL FALSE Close the connection after each request. itfTLSContext NBS.ITLSContext 0 Encapsulates all the data neccecray to handle encrypted tcp connections Static initialization, as shown in the following code snippet. VAR commonName : STRING := 'MyRrasPi' ; ciCertInfo : NBS.CERT_INFO := ( psInfo := ADR ( commonName ), udiSize := LEN ( commonName )); myTLSContext : NBS.TLSContext := ( ePurpose := NBS.PURPOSE.CLIENT_SIDE , sUseCaseName := 'NBSTest' , sTLSVersion := '1.3' , ciCertInfo := ciCertInfo , udiVerificationMode := 2 ); END_VAR itfAsyncProperty NBS.IAsyncProperty 0 Runs the connect process in a own background task, usage see library Net Base Services Output xDone BOOL xBusy BOOL xError BOOL eError ERROR Current error state httpResult HttpResult The result of the request
DigestAuthWebClient (FB) ¶ FUNCTION_BLOCK DigestAuthWebClient EXTENDS CBM.ETrigTo Webclient for digest authentification, MD5 and SHA-256 available InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrigTo udiTimeOut UDINT Defines the time (µs) after which an FB (e.g. requiring an external acknowledgement) aborts operation due to a timeout with error message. ETrigTo Output xDone BOOL TRUE : Action successfully completed ETrigTo xBusy BOOL TRUE : Function block active ETrigTo xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrigTo Input wsLogin WSTRING(255) Login name wsPassword WSTRING(255) Password sURL STRING(1024) URL of the web server eRequestType REQUEST_TYPE REQUEST_TYPE.GET Type of the request: eContentType CONTENT_TYPE CONTENT_TYPE.APPLICATION_FORM HTTP Content-Type of the request pwsAdditionalHeader POINTER TO WSTRING Additional HTTP header pwsPostValue POINTER TO WSTRING Post parameter xCloseConnection BOOL FALSE Close the connection after each request. itfTLSContext NBS.ITLSContext 0 Encapsulates all the data neccecray to handle encrypted tcp connections Static initialization, as shown in the following code snippet. VAR commonName : STRING := 'MyRrasPi' ; ciCertInfo : NBS.CERT_INFO := ( psInfo := ADR ( commonName ), udiSize := LEN ( commonName )); myTLSContext : NBS.TLSContext := ( ePurpose := NBS.PURPOSE.CLIENT_SIDE , sUseCaseName := 'NBSTest' , sTLSVersion := '1.3' , ciCertInfo := ciCertInfo , udiVerificationMode := 2 ); END_VAR itfAsyncProperty NBS.IAsyncProperty 0 Runs the connect process in a own background task, usage see library Net Base Services Output eError ERROR Current error state httpResult HttpResult The result of the request Methods: mGetKeyValues Structure: mGetKeyValues (Method)
Param (PARAMS) ¶ InOut: Scope Name Type Initial Comment Constant gc_udiBufferSize UDINT 4096 Buffersize: Maximum size of a single xml element inclusive attributes and value gc_udiMaxValueSize UDINT 255 Maximum size of names, values, attributes and attribute names gc_MaxStructureDepth UINT 100 Maximum structure depth of the XML file