Library.SoeWriteSsc Method

Writes data to a SubDevice through Servo Drive Profile over EtherCAT (SoE).

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

Syntax

Copy

public CommandStatus SoeWriteSsc(
    EcatHandle subDevice,
    byte driveNo,
    byte elementFlags,
    ushort idn,
    byte[] value
)

Parameters

subDevice

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

driveNo

Type: Byte
A drive's index.

elementFlags

Type: Byte
Which property of an idn is read.

idn

Type: UInt16
The identification number of an object.

value

Type: Byte[]
A buffer that contains the data to write.

Return Value

This method returns a CommandStatus class. 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.
ecatErrNullParameter	Parameter value is null.
ecatErrWrongParameter	One of the following conditions occurred: Parameter subDevice is invalid. Parameter value is 0.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrFeatureUnavailable	The SubDevice doesn't support SoE.