Api.FoeReadFileToFile method

Reads the servo drive's file and saves it on the local machine.

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 FoeReadFileToFile(
       int SlaveId,
       bool BootState,
       string Name,
       uint Password,
       string File
)

Public Function FoeReadFileToFile(
       SlaveId As Integer,
       BootState As Boolean,
       Name As String,
       Password As UInteger,
       File 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.

BootState

Type: bool

Determines whether the EtherCAT slave is to be in the Bootstrap (Boot) state to use FoE. The Boot state can be used to update firmware or configure the slave settings.

true: Boot state.

false: Normal state.

Name

Type: string

The file name to read from the device.

Password

Type: uint

If the device requires a password to access the file, you need to specify the password here. Zero means there is no password.

File

Type: string

The file is a path of the local machine. When using this method, the data of the slave will be read and saved to the file, which is the path of the local machine.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

When the EtherCAT link starts properly, the slave's state is Init -> PreOp -> SafeOp -> Op. If the slave is in Op and you use this method with the BootState set to true, the slave's state will become Op -> Init -> Boot. After the task is done, its state becomes Init -> PreOp -> SafeOp -> Op again.

Usable EtherCAT states

ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A