Api.EoeSetSlaveEoeIp method

Configures an EtherCAT slave's Ethernet over EtherCAT (EoE) network settings. For more information about EoE, see Ethernet over EtherCAT.

Namespace: IntervalZero.KINGSTAR.OpcUa.Api

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

Syntax

C#VB

public KsCommandStatus EoeSetSlaveEoeIp(
       int SlaveId,
       byte[] Mac,
       byte[] Ip,
       byte[] Subnet,
       byte[] Gateway,
       byte[] Dns,
       string DnsName
)

Public Function EoeSetSlaveEoeIp(
       SlaveId As Integer,
       Mac As Byte[],
       Ip As Byte[],
       Subnet As Byte[],
       Gateway As Byte[],
       Dns As Byte[],
       DnsNAme As String
) 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.

Mac

Type: byte[]

The MAC address of the slave.

Type: byte[]

The IP address of the slave.

Subnet

Type: byte[]

The subnet of the slave.

Gateway

Type: byte[]

The gateway of the slave.

Dns

Type: byte[]

The DNS of the slave.

DnsName

Type: string

The DNS name of the slave.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

If the EtherCAT slave supports EoE, and in RTX64 Control Panel, under Network and interfaces, in Manage interfaces, Device is set to RTX64 Virtual Network Interface. In Advanced NAL properties > TCP/IP Stack properties, Filter Name is set to KSeoe.rtdll, the slave will automatically get an IP address when it is started.
The IP, subnet, gateway, and DNS are usually represented as "1.2.3.4". Each of the four values is in the 0–255 range and can be stored in a byte.
To see the Eoe related settings, please refer to Concepts / Ethernet over EtherCAT

Usable EtherCAT states

ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A