IApi.AoeWriteSdoObject method

Writes data to a slave using the ADS over EtherCAT (AoE) SDO method.

Namespace: IntervalZero.KINGSTAR.Base.Api

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

Syntax

KsCommandStatus AoeWriteSdoObject(
       int SlaveId,
       int Port,
       int ObIndex,
       int ObSubIndex,
       bool CompleteAccess,
       byte[] Value
)

Function AoeWriteSdoObject(
       SlaveId As Integer,
       Port As Integer,
       ObIndex As Integer,
       ObSubIndex As Integer,
       CompleteAccess As Boolean,
       Value As Byte()
) As KsCommandStatus

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.

Port

Type: int

The EtherCAT slave port.

ObIndex

Type: int

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

ObSubIndex

Type: int

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

CompleteAccess

Type: bool

TRUE: Writes all subindexes. FALSE: Writes a single subindex.

Value

Type: byte[]

The value to be written.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A