READ_MODE (ENUM) ¶ TYPE READ_MODE : Read modes InOut: Name Initial Comment ONE_ELEMENT 0 Reads only the specified element CHILDREN_ONLY 1 Reads all child elements of the specified element RECURSIVE 2 Reads all underlying elements of the specified element
Function Blocks ¶ Function blocks to read, write and find XML elements. XMLFindElement (FunctionBlock) XMLFindElementAsync (FunctionBlock) XMLFindElementByStringAsync (FunctionBlock) XMLGetElement (FunctionBlock) XMLGetElementAsync (FunctionBlock) XMLWrite (FunctionBlock) XMLWriteAsync (FunctionBlock)
XMLFindElementByStringAsync (FB) ¶ FUNCTION_BLOCK XMLFindElementByStringAsync EXTENDS CBM.ETrig {attribute ‘hide_all_locals’} 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. ETrig Output xDone BOOL TRUE : Action successfully completed ETrig xBusy BOOL TRUE : Function block active ETrig xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrig Input sFileName STRING(gc_udiMaxValueSize) Path to a file wsElement STRING(gc_udiMaxValueSize) The element to find. if blank, the root element will be returend. attributeName STRING(gc_udiMaxValueSize) Name of the attribute, BLANK if not required attributeValue STRING(gc_udiMaxValueSize) Value of the attribute readMode READ_MODE Read mode paElements POINTER TO XMLElement Pointer to the result set udiMaxElements UDINT Maximum size of paElements udiStartPosition UDINT 0 Start position in bytes xTruncateValues BOOL FALSE true: All values that exceed the maximum value size will be truncated paDataArray POINTER TO BYTE 0 Pointer to XML data array, if 0 read from file (sFileName) udiDataArraySize UDINT 0 Size of paDataArray Output eError ERROR Error code if xError is true eLastError ERROR The last error udiCountElements UDINT Number of elemnents in paElements udiNextReadPos UDINT Position in file (in bytes) of the next xml element, 0 if last element eEncoding Encoding Encoding of the xml file
Parameter ¶ Param (ParamList)
Function Blocks ¶ WebSocketClient (FunctionBlock) Read (Method) SetInitialValue (Method) Write (Method) WebSocketRead (FunctionBlock) WebSocketWrite (FunctionBlock)
WebSocketClient.Read (METH) ¶ METHOD Read : NBS.ERROR Read incoming messages. If a message was received, then the message is copied to pData and xReceived is set to TRUE . udiCount corresponds to the size of the received data. Note This method MUST be called in each cycle because the method also handles other requests in background (ping, pong etc.). The method can be called directly OR via the function block WebSocketRead . InOut: Scope Name Type Comment Return Read NBS.ERROR Input pData __XWORD Pointer to the payload data udiSize UDINT Maximum size of the payload Output udiCount UDINT Size of the received data xReceived BOOL TRUE if data received eFrameType FRAME_TYPE Type of the payload xIsFinalFragment BOOL FALSE if the payload is incomplete and is sent via multiple packets. TRUE, if the payload is complete or if the payload was incomplete and this packet is the last packet of a message.
WebSocketClient.SetInitialValue (METH) ¶ METHOD SetInitialValue : NBS.ERROR This method is used for setting the tls context to tcp client as an initial value. Note If the itfContext is zero this method uses default settings for tls. InOut: Scope Name Type Initial Return SetInitialValue NBS.ERROR Input itfContext NBS.ITLSContext itfAsyncProperty NBS.IAsyncProperty 0 itfTSNContext NBS.ITSNContext 0
WebSocketClient.Write (METH) ¶ METHOD Write : NBS.ERROR Sends messages to a WebSocket server. This method sends the payload pData with the size udiSize to the server. InOut: Scope Name Type Initial Comment Return Write NBS.ERROR Input pData __XWORD Pointer to the payload data udiSize UDINT Size of the payload eFrameType FRAME_TYPE FRAME_TYPE.BINARY Type of the payload data Output udiCount UDINT Number of sent bytes. Note It can take more than one cycles to send a message if the payload is greater than the maximum buffer size.
WebSocketRead (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL WebSocketRead EXTENDS CBML.LConC Function block to read incoming messages using the Common Behavior Model (e.g. for CFC applications). Note This function block OR the Write method of the WebSocketClient MUST be called in each cycle because the method also handles other requests in background (ping, pong etc.). Set xEnable to TRUE if xActive of the WebSocketClient is TRUE . InOut: Scope Name Type Comment Inherited from Input xEnable BOOL TRUE : Activates the defined operation FALSE : Aborts/resets the defined operation LConC Output xBusy BOOL TRUE : Operation is running LConC xError BOOL TRUE : Error condition reached LConC Input itfWebSocketClient IWebSocketClient Reference to the WebSocketClient pData __XWORD Pointer to the payload data udiSize UDINT Maximum size of the payload Output xReady BOOL TRUE if data received udiCount UDINT Size of the received data eFrameType FRAME_TYPE Type of the payload xIsFinalFragment BOOL FALSE if the payload is incomplete and is sent via multiple packets. TRUE, if the payload is complete or if the payload was incomplete and this packet is the last packet of a message.
WebSocketWrite (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL WebSocketWrite EXTENDS CBML.ETrigTo Function block to send messages to WebSocket server using the Common Behavior Model (e.g. for CFC applications). InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigTo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigTo Output xDone BOOL Ready condition reached ETrigTo xBusy BOOL Operation is running ETrigTo xError BOOL Error condition reached ETrigTo Input itfWebSocketClient IWebSocketClient Reference to the WebSocketClient pData __XWORD Pointer to the payload data udiSize UDINT Size of the payload eFrameType FRAME_TYPE FRAME_TYPE.BINARY Type of the payload data Output udiCount UDINT Number of sent bytes. Note It can take more than one cycles to send a message if the payload is greater than the maximum buffer size.