Api.SetHeartbeat method

Configures the heartbeat settings, which periodically checks whether the motion application is running properly.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsError SetHeartbeat(
       bool Enable,
       double Timeout
)

Public Function SetHeartbeat(
       Enable As Boolean,
       Timeout As Double
) As KsError

Parameters

Enable

Type: bool

true to enable, and false to disable the heartbeat. By default, it is false.

Timeout

Type: double

The time period in which you need to use PulseHeartbeat to notify KINGSTAR that your application is running properly, or KINGSTAR assumes your application crashes and closes the EtherCAT link. The unit of time is second.

Return value

Type: KsError

A return code of a method.

Usable EtherCAT states

ecatOP

Examples

N/A