FB_SendVisionDataClient - General Information

Overview

Type:

Function block

Available as of:

V1.7.3.0

Inherits from:

-

Implements:

-

This chapter provides information on:

Task

Send a vision protocol with configured product data.

Description

The function block FB_SendVisionDataClient sends a specific vision protocol. The protocol is created by the function block. The data to be sent can be added using the methods of the function block.

NOTE: The FB_SendVisionDataClient can be used to send a vision protocol to the FB_ReceiveVisionDataServer, for example to simulate a camera.

Interface

Input

Data type

Description

i_xEnable

BOOL

A rising edge FALSE -> TRUE activates the POU, a falling edge TRUE -> FALSE deactivates the POU.

A deactivated POU does not execute any action.

i_xDiagQuit

BOOL

A rising edge FALSE -> TRUE cancels an active exception of the POU.

Output

Data type

Description

q_xActive

BOOL

TRUE: The POU is active. If the output is TRUE while the i_xEnable is deactivated, the POU must first terminate its ongoing processing before transitioning this output to FALSE.

FALSE: The POU is inactive

q_xReady

BOOL

TRUE: The POU is ready to operate and can accept user commands.

FALSE: The function block is not ready to accept user commands.

q_etDiag

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Diagnostic message

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = GD.ET_Diag.Ok -> Status message

q_etDiag <> GD.ET_Diag.Ok -> Diagnostic message

q_sMsg

STRING[80]

Event-triggered message that gives more detailed information on the diagnostic state.

q_xConnectedToServer

BOOL

Indicates if the client is connected to a server.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok.

ConfigurationFailed

ConfigurationInvalid

16

Configuration invalid.

ExecutionAborted

AddressInUse

18

Address is in use.

CertificateFailureClient

74

The certificate is not valid.

CertificateNotFound

72

The certificate could not be found.

CertificateNoKey

76

No private key is available.

ConnectionRefused

17

The connection to the server was refused.

InitTlsContextFailed

75

Too many sockets are used.

AddressInUse

Enumeration name:

AddressInUse

Enumeration value:

18

Description:

Duplicate address.

Issue

Cause

Solution

The IP address is already used.

The IP address and port combination is not unique.

Verify that the combination of IP address and port is unique and available.

CertificateFailureClient

Enumeration name:

CertificateFailureClient

Enumeration value:

74

Description:

The certificate is not valid.

Issue

Cause

Solution

The certificate is not valid.

The certificate is not stored in Trusted Certificate.

Move the certificate from Quarantined Certificate to Trusted Certificate and reboot the controller.

For further information, refer to Handling the TLS-Certification or in the Security Screen (Machine Expert > V2.0 > Software > Programming > Menu Commands Online Help > Security Screen ) in the Online Help.

CertificateNotFound

Enumeration name:

CertificateNotFound

Enumeration value:

72

Description:

The certificate could not be found.

Issue

Cause

Solution

The certificate is not found on the controller.

An incorrect name for the certificate was selected.

Ensure that the correct name is selected in Certificate Name.

CertificateNoKey

Enumeration name:

CertificateNoKey

Enumeration value:

76

Description:

No private key is available.

Issue

Cause

Solution

No private key is available.

The certificate has no private key.

Use a certificate with a private key or the default certificate.

ConnectionRefused

Enumeration name:

ConnectionRefused

Enumeration value:

17

Description:

The connection to server has been refused.

Issue

Cause

Solution

Connection to server was unsuccessful.

The connection to the server could not be established.

Verify that the server is configured and available.

ConfigurationInvalid

Enumeration name:

ConfigurationInvalid

Enumeration value:

16

Description:

The configuration is invalid.

Issue

Cause

Solution

The configuration is invalid.

No Configuration method has been successfully called.

Ensure that theConfiguration method that was used, (ConfigurationTls() or ConfigurationNoTls() ), was called successfully before enabling the FB_SendVisionDataClient.

InitTlsContextFailed

Enumeration name:

InitTlsContextFailed

Enumeration value:

75

Description:

Too many sockets are used.

Issue

Cause

Solution

Too many sockets are used, only 10 sockets are available.

Too many sockets for TCP connection are open.

Ensure that not more than 10 sockets are used. 10 sockets are valid for the complete controller. If other connections are used, ensure these connections are closed correctly.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

Status message: Reading the data was successful.

Methods

Name

Description

ClearVisionData

Clear vision data and prepare the function block to receive new data.

ConfigurationTLS

Configure the IP address and port the server monitors, and set the TLS settings.

ConfigurationNoTLS

Configure the IP address and port the server monitors.

RegisterLoggerPoint

Register the FB_SendVisionData to the Application Logger.

Send

Send the protocol of vision data, set by SetHeader(...), SetNextProduct(...), and SetAdditionalString(...).

SetAdditionalString

Add an additional string to the vision protocol.

SetHeader

Set the data for the header of the vision protocol.

SetNextProduct

Set the data of one product.

Properties

Name

Data type

Accessing

Description

uiNumberOfProductsSet

UINT

Get

Number of products available to send to the server.

xVisionDataSend

BOOL

Get

Signal that new vision data has been sent. Will be reset with next call of SetHeaderData().