IApi.CoeReadSdoObjectDescription method

Reads the description of an SDO object through CANopen over EtherCAT (CoE).

Namespace: IntervalZero.KINGSTAR.Base.Api

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

Syntax

KsCommandStatus<SdoObjectDescription> CoeReadSdoObjectDescription(
       int SlaveId,
       int ObIndex
)

Function CoeReadSdoObjectDescription(
       SlaveId As Integer,
       ObIndex As Integer
) As KsCommandStatus(Of SdoObjectDescription)

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.

ObIndex

Type: int

The index of the object to read in the object dictionary.

Return value

Type:KsCommandStatus<SdoObjectDescription>

Returns a state of a method and the description of an SDO object.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A