Api.SoeReadSsc method

Uploads data from an EtherCAT slave to the EtherCAT master through SoE (Servo drive profile over EtherCAT).

Namespace: IntervalZero.KINGSTAR.Local.Api

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

Syntax

C#VB

public KsCommandStatus<byte[]> SoeReadSsc(
       int SlaveId,
       byte DriveNo,
       byte ElementFlags,
       ushort Idn,
       int Length
)

Public Function SoeReadSsc(
       SlaveId As Integer,
       DriveNo As Byte,
       ElementFlags As Byte,
       Idn As UShort,
       Length As Integer
) As KsCommandStatus(Of Byte())

Parameters

SlaveId

Type: int

The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.

DriveNo

Type: byte

The index of a drive.

ElementFlags

Type: byte

Which property of an IDN is read.

Idn

Type: ushort

The identification number of an object.

Length

Type: int

Data length.

Return value

Type: KsCommandStatus<byte[]>

Returns a state of a method and a byte array.

Usable EtherCAT states

ecatPreOp, ecatSafeOp, ecatOp

Examples

N/A