Library.PulseHeartbeat Method

Sends a signal to notify E-CAT Fieldbus that the user application is running properly.

Namespace:  IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly:  IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

public EcatErrorCode PulseHeartbeat(
    EcatHandle mainDevice
)

Parameters

mainDevice

Type: EcatHandle
A handle to a MainDevice. To retrieve the corresponding handle, use CreateMainDevice or OpenMainDevice.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Remarks

The E-CAT Fieldbus uses a heartbeat mechanism to detect if the connection between the MainDevice instance and user applications is lost. When heartbeat is enabled (through SetHeartbeat), users must use PulseHeartbeat to periodically notify the corresponding MainDevice within the specified time. Otherwise, the MainDevice will assume the connection is lost and close the EtherCAT link, which works like Stop.

See Also:

• Library Class
• IntervalZero.MaxRT.Ecat.Api.NetApi Namespace