EIPGetHealthBit: Get the Health Bit Value

Function Block Description

This function block returns the value of a specified health bit.

Graphical Representation

Inputs

This table describes the input variables:

Input

Data type

Comment

i_xExecute

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

A rising edge of the input Execute starts the function block. The function block continues execution and the output Busy is set to TRUE. Another rising edge of the Execute input while the function block is executing is ignored.

  • FALSE: If the input Execute is set to FALSE during the execution of the function block, the output Done or Error is set to TRUE for one cycle.

  • TRUE: The output Done or Error is set to TRUE as long as the input Execute is set to TRUE.

i_uiConnId

UINT

Connection id.

Outputs

This table describes the output variables:

Output

Data type

Comment

q_xDone

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

  • FALSE: Execution has not been started, or an error has been detected.

  • TRUE: Execution terminated without an error detected.

q_xBusy

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

  • FALSE: Function block is not being executed.

  • TRUE: Function block is being executed.

q_xError

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

  • FALSE: Execution of the function block is running, no error has been detected.

  • TRUE: An error has been detected in the execution of the function block.

q_HealthValue

UINT

Returns the health value:

  • 0: the connection is not established.

  • 1: the connection is established.