Library.ResetSubDeviceEsc Method

Resets the EtherCAT SubDevice Controller (ESC) of a SubDevice.

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

Copy

public CommandStatus ResetSubDeviceEsc(
    EcatHandle subDevice
)

Parameters

subDevice

Type: EcatHandle
A handle to a SubDevice. To retrieve the corresponding handle, use OpenSubDeviceByIndex, OpenSubDeviceByStationAddress, or OpenSubDeviceByExplicitId.

Return Value

This method returns a CommandStatus class. The read result is stored in property Value. If an error occurs, property State in CommandStatus is set to ecatCommandError, and the error code is stored in property ErrorId.

Possible errors:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	Parameter subDevice is invalid.
ecatErrWrongEnvironment	The ESC requesting channel is occupied.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongSubDeviceState	The method can't be used in the current SubDevice state. It can only be used in the Init state.