FC_ControllerStopSet - General Information

Overview

Type:

Function

Available as of:

SystemInterface_1.32.6.0

Versions:

Current version

Task

Request to stop one or more jobs.

Description

The command: "Stop" for one or all the drives (i_stAxisId=Gc_stLogAddrAllTypes) is set (Set) or reset (Reset). Also refer to function FC_ControllerStopReset().

The result may be read at any time using the parameter ControllerStopSet. The affected drives are stopped. The job processing remains in the "Stop" condition until the stop requirements have been reset. Pending jobs are not affected. The new status is processed in the next real-time cycle. Read AxisState in order to verify the status of the axis.

Parameters out of range

If the input parameter i_rSmooth is out of range, it is automatically adjusted (> 100 => 100, < 0 => 0).

If i_rDeceleration is out of range, the value -2 (Deceleration invalid) is returned.

Interface

Input

Data type

Description

i_stAxisId

ST_LogicalAddress

Logical address of the drive

i_rDeceleration

REAL

Deceleration in % of Acc-Max

i_rSmooth

REAL

0 - 100

Return Value

Data type

Description

DINT

0: OK

-1: Logical address of the drive is invalid

-2: Deceleration invalid (valid range: 0.001 <= Deceleration <= 100.0)