Api.VoeWrite method

Writes data into a VoE-enabled device through VoE (Vendor-specific protocol 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 VoeWrite(
       int SlaveId,
       uint VendorId,
       ushort VendorType,
       byte[] Data
)

Public Function VoeWrite(
       SlaveId As Integer,
       VendorId As UInteger,
       VendorType As UShort,
       Data 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.

VendorId

Type: uint

Vendor ID.

VendorType

Type: ushort

Vendor type.

Data

Type: byte[]

The data to be written.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

If you want to see the response from the VoE-enabled device after you send VoeWrite, you need to use RegisterMailboxCallback to retrieve the VoE message.

Usable EtherCAT states

ecatPreOp, ecatSafeOp, ecatOp

Examples

N/A