Command list

The following table shows the KINGSTAR Commands. You can find the same capabilities in KINGSTAR Control Panel.

NOTE: The name Real-Time Subsystem is the same as that in KINGSTAR Control Panel.

Commands	Description
Start-RealtimeSubsystem	Starts the Real-Time Subsystem.
Stop-RealtimeSubsystem [-force]	Stops the PLC OPC UA, PLC, and KINGSTAR Subsystems in order, then closes the OPC UA connections that are using the Real-Time subsystem, and finally stops the Real-Time subsystem. When `-force` is used, in addition to doing all of the above, it also terminates all RTSS and RTSS proxy processes before stopping the Real-Time Subsystem, including terminating the KINGSTAR Control Panel, as these prevent the Real-Time subsystem from shutting down. While KINGSTAR Control Panel or some RTSS processes are running, you cannot use `Stop-RealtimeSubsystem` to stop Real-Time Subsystem—you must use `Stop-RealtimeSubsystem -force`, but this way, the system might become unstable. To use `Stop-RealtimeSubsystem` while KINGSTAR Control Panel or RTSS processes are running, do the following before you use it: In the notification area, close KINGSTAR Control Panel. For further details, see Tools > KINGSTAR Control Panel > Exit KINGSTAR Control Panel. Exit RTX64 programs.
Start-KingstarSubsystem [-instanceid m] [-idealprocessor n]	Starts the KINGSTAR Subsystem. It starts the Real-Time Subsystem first, and then the KINGSTAR Subsystem. You can use `instanceid` to specify an instance and `idealprocessor` to specify a CPU core for KINGSTAR to run on. If you don't have Multiple Master Package and you have no need to specify a CPU core for KINGSTAR, just send `Start-KingstarSubsystem`. Multiple instances requires Multiple Master Package. For more information about instance and idealprocessor, see the following descriptions: KINGSTAR RT and Win32 APIs > KINGSTAR Fieldbus > Fieldbus functions > Subsystem control > Create Tools > KINGSTAR Control Panel > Tools > Runtime Settings > General Settings.
Stop-KingstarSubsystem [-instanceid m]	Stops the KINGSTAR Subsystem. If PLC OPC UA servser and KINGSTAR PLC Runtime have been started, they will be stopped first, and then the KINGSTAR Subsystem. You can specify the instance you want to stop with the `-instanceid` instruction.
Start-PlcProcess	Starts KINGSTAR PLC Runtime.
Stop-PlcProcess	Stops KINGSTAR PLC Runtime.
Start-PlcOpcUaServer	Starts KINGSTAR PLC Runtime and PLC OPC UA Server.
Stop-PlcOpcUaServer	Stops KINGSTAR PLC Runtime and PLC OPC UA Server.
Check-RealtimeSubsystem	Checks whether the Real-Time Subsystem is started. True: started. False: not started.
Check-KingstarSubsystem [-instanceid m]	Checks whether the KINGSTAR Subsystem is started. You can specify the instance you want to check. True: started. False: not started.
Check-PlcProcess	Checks whether KINGSTAR PLC Runtime is started. True: started. False: not started.
Check-PlcOpcuaServer	Checks whether KINGSTAR PLC Runtime and PLC OPC UA Server are started. True: started. False: not started.
-help \| /help \| -? \| /?	Displays the KINGSTAR Commands list and each command's description.