Api.RequestState method

Requests the KINGSTAR Subsystem to go into the specified EtherCAT state. For example, if the state is Op, and your requested state is PreOp, the KINGSTAR Subsystem will change the state to Op -> SafeOp -> PreOp. If the state is Init and your requested state is Op, the Subsystem will change the state to Init -> PreOp -> SafeOp -> Op.

Requesting the State Offline is equivalent to stopping KINGSTAR.
Requesting the State Op is equivalent to starting KINGSTAR.

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 RequestState(
       EthercatState State
)

Public Function RequestState(
       State As EthercatState
) As KsCommandStatus

Parameters

State

Type: EthercatState

The requested EtherCAT state.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A