Cellwrite Studio operating manual · CWS-OM-001, revision A

Appendix A RAPID reference

The instructions, functions and data types of RAPID that Cellwrite Studio knows, each with a short description and its syntax. For the full description, each entry opens the ABB manual.

The descriptions are written by Cellwrite. The ABB manuals are ABB's and are not part of Cellwrite Studio: an entry opens your own copy, which you choose once, or the manual's page in the ABB Library.

ABB's own manual: RobotWare 7 (3HAC065038-001) · RobotWare 6 (3HAC050917-001).

Motion

ActUnit, CapAPTrSetupAI, CapAPTrSetupAO, CapAPTrSetupPERS, CapC, CapEquiDist, CapInitSupervision, CapL, CapNoProcess, CapRefresh, CapRemoveSupervision, CapSetDOAtStop, CapSetupSupervision, CapWeaveSync, ClearPath, DeactUnit, MoveAbsJ, MoveAbsL, MoveC, MoveCAO, MoveCDO, MoveCGO, MoveCSync, MoveExtJ, MoveJ, MoveJAO, MoveJDO, MoveJGO, MoveJSync, MoveL, MoveLAO, MoveLDO, MoveLGO, MoveLSync, MovePnP, RestoPath, StartMove, StartMoveRetry, StopMove, StopMoveReset, StorePath, WaitRob

Motion settings

AccSet, CirPathMode, ConfJ, ConfL, GripLoad, MechUnitLoad, MotionSup, PathAccLim, PathLengthGet, PathLengthReset, PathLengthStart, PathLengthStop, PathLevel, PathRecMoveBwd, PathRecMoveFwd, PathRecStart, PathRecStop, PathRecValidBwd, PathRecValidFwd, PathResol, SingArea, SoftAct, SoftDeact, SpeedLimAxis, SpeedLimCheckPoint, SpeedRefresh, TuneReset, TuneServo, VelSet, WorldAccLim

Search and trigger

SearchC, SearchExtJ, SearchL, TriggAbsJ, TriggC, TriggCheckIO, TriggDataCopy, TriggDataReset, TriggDataValid, TriggEquip, TriggInt, TriggIO, TriggJ, TriggJIOs, TriggL, TriggLIOs, TriggRampAO, TriggSpeed, TriggStopProc

Inputs and outputs

AInput, AliasIO, AOutput, DInput, DOutput, GInput, GInputDnum, GOutput, GOutputDnum, InvertDO, IOActivate, IODeactivate, IODeviceMute, IODeviceState, IODisable, IOEnable, IONetworkState, PulseDO, Reset, Set, SetAllDataVal, SetAO, SetDataSearch, SetDataVal, SetDO, SetGO, SetLeadThrough, SetupCyclicBool, TestDI, ValidIO, WaitAI, WaitAO, WaitDI, WaitDO, WaitGI, WaitGO

Program flow

Break, CallByVar, EXIT, ExitCycle, FOR, GOTO, IF, RETURN, Stop, SyncMoveOff, SyncMoveOn, TEST, WaitSyncTask, WaitTestAndSet, WaitTime, WaitUntil, WaitWObj, WHILE

Interrupts

CONNECT, IDelete, IDisable, IEnable, IError, IPers, ISignalAI, ISignalAO, ISignalDI, ISignalDO, ISignalGI, ISignalGO, ISleep, ITimer, IVarValue, IWatch

Errors and recovery

BookErrNo, ErrLog, ErrRaise, ErrWrite, RAISE, ReadErrData, RETRY, SkipWarn, TRYNEXT

Data and maths

Abs, AbsDnum, ACos, ACosDnum, Add, AND, ASin, ASinDnum, ATan, ATan2, ATan2Dnum, ATanDnum, BitAnd, BitAndDnum, BitCheck, BitCheckDnum, BitClear, BitLSh, BitLShDnum, BitNeg, BitNegDnum, BitOr, BitOrDnum, BitRSh, BitRShDnum, BitSet, BitXOr, BitXOrDnum, BytesToVal, Clear, Cos, CosDnum, CrossProd, CSpeedOverride, Decr, DecToHex, DefAccFrame, Dim, DIV, DnumToNum, DotProd, EventType, ExecHandler, ExecLevel, Exp, HexToDec, Incr, IndInpos, IndSpeed, IsBrakeCheckActive, IsCollFree, IsCyclicBool, IsLeadThrough, IsMechUnitActive, IsPers, IsStopMoveAct, IsStopStateEvent, IsSysId, IsVar, Max, MaxExtLinearSpeed, MaxExtReorientSpeed, MaxRobReorientSpeed, MaxRobSpeed, Min, MOD, ModExist, ModTimeDnum, MotionPlannerNo, NonMotionMode, NOT, NumToDnum, OR, ORobT, ParIdPosValid, ParIdRobValid, Pow, PowDnum, PPMovedInManMode, Present, ProgMemFree, RawBytesLen, RemainingRetries, RobName, Round, RoundDnum, SafetyControllerGetChecksum, SafetyControllerGetGroupChecksum, SafetyControllerGetNextGroupName, SafetyControllerGetOpModePinCode, SafetyControllerGetSWVersion, SafetyControllerGetUserChecksum, Sin, SinDnum, Sqrt, SqrtDnum, STCalcForce, STCalcTorque, STIsCalib, STIsClosed, STIsIndGun, STIsOpen, Tan, TanDnum, TestAndSet, TestSignRead, TextGet, TextTabFreeToUse, TextTabGet, Trunc, TruncDnum, Type, ValToBytes, VectMagn, XOR

Positions and frames

CalcJointT, CalcRobT, CalcRotAxFrameZ, CalcRotAxisFrame, CJointT, CorrClear, CorrCon, CorrDiscon, CorrRead, CorrWrite, CPos, CRobT, CTool, CWObj, DefDFrame, DefFrame, Distance, EOffsOff, EOffsOn, EOffsSet, EulerZYX, MirPos, NOrient, Offs, OrientZYX, PDispOff, PDispOn, PDispSet, PoseInv, PoseMult, PoseVect, RelTool

Strings

ArgName, ByteToStr, DnumToStr, NumToStr, StrFind, StrFormat, StrLen, StrMap, StrMatch, StrMemb, StrOrder, StrPart, StrSize, StrToByte, StrToVal, ValToStr

Files and serial channels

ClearIOBuff, Close, CloseDir, CopyFile, FileSize, FileTimeDnum, FSSize, IsFile, MakeDir, Open, OpenDir, ReadAnyBin, ReadBin, ReadCfgData, ReadDir, ReadDnum, ReadMotor, ReadNum, ReadRawBytes, ReadStr, ReadStrBin, ReadVar, ReadVarArr, RemoveDir, RemoveFile, RenameFile, Rewind, Write, WriteAnyBin, WriteBin, WriteCfgData, WriteRawBytes, WriteStrBin, WriteVar, WriteVarArr

FlexPendant

TPErase, TPReadDnum, TPReadFK, TPReadNum, TPShow, TPWrite, UIAlphaEntry, UIClientExist, UIDisplay, UIDnumEntry, UIDnumTune, UIListView, UIMessageBox, UIMsgBox, UIMsgWrite, UIMsgWriteAbort, UINumEntry, UINumTune, UIShow

Time

CDate, ClkRead, ClkReset, ClkStart, ClkStop, CTime, GetTime

System and tasks

ActEventBuffer, AliasCamera, AliasIOReset, ArcC, ArcCEnd, ArcCStart, ArcKill, ArcL, ArcLEnd, ArcLStart, ArcRefresh, BytesReset, CancelLoad, CheckProgRef, ClearRawBytes, Comment, ContactL, Continue, CopyRawBytes, CornerPathWarning, DeactEventBuffer, DebugBreak, DispC, DispCEnd, DispL, DispLEnd, DispLStart, DropWObj, EraseModule, FCAct, FCDeact, FCPressC, FCPressL, FCRefStart, FCRefStop, FitCircle, FitLine, FitPlane, FitSphere, FricIdEvaluate, FricIdInit, FricIdSetFricLevels, GetAxisDistance, GetAxisMoveTime, GetDataVal, GetGroupSignalInfo, GetMaxNumberOfCyclicBool, GetMecUnitName, GetModalPayLoadMode, GetMotorTorque, GetNextCyclicBool, GetNextMechUnit, GetNextOption, GetNextProduct, GetNextSym, GetNumberOfCyclicBool, GetServiceInfo, GetSignalOrigin, GetSysData, GetSysInfo, GetTaskName, GetTorqueMargin, GetTrapData, GetTSPStatus, GetUASUserName, HollowWristReset, ICap, ICapPathPos, IndAMove, IndCMove, IndDMove, IndReset, IndRMove, IRMQMessage, IsSyncMoveOn, Label, Load, LoadId, ManLoadIdProc, MatrixAdd, MatrixInverse, MatrixMult, MatrixReset, MatrixSolve, MatrixSolveQR, MatrixSub, MatrixSVD, MatrixTranspose, MotionProcessModeSet, MToolRotCalib, MToolTCPCalib, OpMode, PackDNHeader, PackRawBytes, PaintC, PaintL, ProcCall, ProcerrRecovery, RaiseToUser, RemoveAllCyclicBool, RemoveCyclicBool, ResetAxisDistance, ResetAxisMoveTime, ResetPPMoved, ResetRetryCount, ResetTorqueMargin, RobOS, RunMode, SafetyControllerSyncRequest, Save, SaveCfgData, SenDevice, SetSysData, SimCollision, SpotJ, SpotL, SpotMC, SpotML, SpyStart, SpyStop, StartLoad, STCalib, STClose, StepBwdPath, SToolRotCalib, SToolTCPCalib, STOpen, STTune, STTuneReset, SyncMoveResume, SyncMoveSuspend, SyncMoveUndo, SystemStopAction, TaskIsActive, TaskIsExecuting, TaskRunMec, TaskRunRob, TasksInSync, TestSignDefine, TestSignReset, TextTabInstall, TryInt, UnLoad, UnpackRawBytes, WaitLoad, WarmStart, WristOpt

Communication

CamFlush, CamGetExposure, CamGetLoadedJob, CamGetMode, CamGetName, CamGetParameter, CamGetResult, CamLoadJob, CamNumberOfResults, CamReqImage, CamSetExposure, CamSetParameter, CamSetProgramMode, CamSetRunMode, CamStartLoadJob, CamStartSetParameter, CamWaitLoadJob, CamWaitSetParameter, RMQEmptyQueue, RMQFindSlot, RMQGetMessage, RMQGetMsgData, RMQGetMsgHeader, RMQGetSlotName, RMQReadWait, RMQSendMessage, RMQSendWait, SocketAccept, SocketBind, SocketClose, SocketConnect, SocketCreate, SocketGetStatus, SocketListen, SocketPeek, SocketReceive, SocketReceiveFrom, SocketSend, SocketSendTo

World zones

WZBoxDef, WZCylDef, WZDisable, WZDOSet, WZEnable, WZFree, WZHomeJointDef, WZLimJointDef, WZLimSup, WZSphDef

Data types

bool, byte, cameratarget, capaptrreferencedata, capdata, capspeeddata, clock, confdata, dionum, dnum, errnum, extjoint, flypointdata, identno, intnum, iodev, jointtarget, listitem, loaddata, mecunit, num, orient, pnpdata, pos, pose, progdisp, restartdata, rmqheader, robjoint, robtarget, sensorvardata, shapedata, signalai, signalao, signaldi, signaldo, signalgi, signalgo, speeddata, stoppointdata, string, syncident, taskid, tasks, tooldata, triggdata, triggios, triggiosdnum, wobjdata, wzstationary, wztemporary, zonedata

Abs

Function · Data and maths

Returns the value without its sign.

Abs(Value)

Arguments: Value num

AbsDnum

Function · Data and maths

A RAPID function with 1 argument.

AbsDnum(Value)

Arguments: Value dnum

AccSet

Instruction · Motion settings

Lowers the acceleration and how fast it changes, for fragile parts or a gentler movement.

AccSet Acc, Ramp;

Arguments: Acc num, Ramp num

Optional: \FinePointRamp num

ACos

Function · Data and maths

Returns the angle, in degrees, whose cosine is the value.

ACos(Value)

Arguments: Value num

ACosDnum

Function · Data and maths

A RAPID function with 1 argument.

ACosDnum(Value)

Arguments: Value dnum

ActEventBuffer

Instruction · System and tasks

A RAPID instruction.

ActEventBuffer;

ActUnit

Instruction · Motion

Switches a mechanical unit, such as an external axis, on for motion, so that it moves and is included in the robot's moves.

ActUnit MechUnit;

Arguments: MechUnit mecunit

Add

Instruction · Data and maths

Adds a value to a numeric variable.

Add AddValue, AddDvalue;

Arguments: AddValue num, AddDvalue dnum

AInput

Function · Inputs and outputs

Returns the value of an analog input.

AInput(Signal)

Arguments: Signal signalai

AliasCamera

Instruction · System and tasks

A RAPID instruction with 2 arguments.

AliasCamera CameraName, ToCamera;

Arguments: CameraName string, ToCamera cameradev

AliasIO

Instruction · Inputs and outputs

Connects a signal declared in the program to a signal of the I/O configuration, by name.

AliasIO FromSignal, ToSignal;

Arguments: FromSignal anytype, ToSignal anytype

AliasIOReset

Instruction · System and tasks

A RAPID instruction with 1 argument.

AliasIOReset Signal;

Arguments: Signal anytype

AND

Function · Data and maths

A RAPID function.

AND()

AOutput

Function · Inputs and outputs

Returns the value of an analog output.

AOutput(Signal)

Arguments: Signal signalao

ArcC

Instruction · System and tasks

A RAPID instruction with 8 arguments.

ArcC CirPoint, ToPoint, Speed, Seam, Weld, Weave, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Seam seamdata, Weld welddata, Weave weavedata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \Corr, \T num

ArcCEnd

Instruction · System and tasks

A RAPID instruction with 7 arguments.

ArcCEnd CirPoint, ToPoint, Speed, Seam, Weld, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Seam seamdata, Weld welddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \T num

ArcCStart

Instruction · System and tasks

A RAPID instruction with 7 arguments.

ArcCStart CirPoint, ToPoint, Speed, Seam, Weld, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Seam seamdata, Weld welddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \T num

ArcKill

Instruction · System and tasks

A RAPID instruction.

ArcKill;

ArcL

Instruction · System and tasks

A RAPID instruction with 7 arguments.

ArcL ToPoint, Speed, Seam, Weld, Weave, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Seam seamdata, Weld welddata, Weave weavedata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \Corr, \T num, \On, \Off, \TrackPath

ArcLEnd

Instruction · System and tasks

A RAPID instruction with 6 arguments.

ArcLEnd ToPoint, Speed, Seam, Weld, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Seam seamdata, Weld welddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \T num

ArcLStart

Instruction · System and tasks

A RAPID instruction with 6 arguments.

ArcLStart ToPoint, Speed, Seam, Weld, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Seam seamdata, Weld welddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \T num

ArcRefresh

Instruction · System and tasks

A RAPID instruction.

ArcRefresh;

Optional: \Stop, \Resume

ArgName

Function · Strings

Returns the name of the data given as an argument.

ArgName(Parameter)

Arguments: Parameter anytype

Optional: \ErrorNumber

ASin

Function · Data and maths

Returns the angle, in degrees, whose sine is the value.

ASin(Value)

Arguments: Value num

ASinDnum

Function · Data and maths

A RAPID function with 1 argument.

ASinDnum(Value)

Arguments: Value dnum

ATan

Function · Data and maths

Returns the angle, in degrees, whose tangent is the value.

ATan(Value)

Arguments: Value num

ATan2

Function · Data and maths

Returns the angle, in degrees, of a point given by its y and x values, in the right quarter of the circle.

ATan2(Y, X)

Arguments: Y num, X num

ATan2Dnum

Function · Data and maths

A RAPID function with 2 arguments.

ATan2Dnum(Y, X)

Arguments: Y dnum, X dnum

ATanDnum

Function · Data and maths

A RAPID function with 1 argument.

ATanDnum(Value)

Arguments: Value dnum

BitAnd

Function · Data and maths

Returns the bit-wise AND of two values.

BitAnd(BitData1, BitData2)

Arguments: BitData1 byte, BitData2 byte

BitAndDnum

Function · Data and maths

A RAPID function with 2 arguments.

BitAndDnum(Value1, Value2)

Arguments: Value1 dnum, Value2 dnum

BitCheck

Function · Data and maths

Returns TRUE when one bit of a byte or dnum is set.

BitCheck(BitData, BitPos)

Arguments: BitData byte, BitPos num

BitCheckDnum

Function · Data and maths

A RAPID function with 2 arguments.

BitCheckDnum(Value, BitPos)

Arguments: Value dnum, BitPos num

BitClear

Instruction · Data and maths

Sets one bit of a byte or dnum to 0.

BitClear BitPos;

Arguments: BitPos num

BitLSh

Function · Data and maths

Returns a value with its bits moved to the left.

BitLSh(BitData, ShiftSteps)

Arguments: BitData byte, ShiftSteps num

BitLShDnum

Function · Data and maths

A RAPID function with 2 arguments.

BitLShDnum(Value, ShiftSteps)

Arguments: Value dnum, ShiftSteps num

Optional: \Size num

BitNeg

Function · Data and maths

Returns a value with every bit changed.

BitNeg(BitData)

Arguments: BitData byte

BitNegDnum

Function · Data and maths

A RAPID function with 1 argument.

BitNegDnum(Value)

Arguments: Value dnum

Optional: \Size num

BitOr

Function · Data and maths

Returns the bit-wise OR of two values.

BitOr(BitData1, BitData2)

Arguments: BitData1 byte, BitData2 byte

BitOrDnum

Function · Data and maths

A RAPID function with 2 arguments.

BitOrDnum(Value1, Value2)

Arguments: Value1 dnum, Value2 dnum

BitRSh

Function · Data and maths

Returns a value with its bits moved to the right.

BitRSh(BitData, ShiftSteps)

Arguments: BitData byte, ShiftSteps num

BitRShDnum

Function · Data and maths

A RAPID function with 2 arguments.

BitRShDnum(Value, ShiftSteps)

Arguments: Value dnum, ShiftSteps num

BitSet

Instruction · Data and maths

Sets one bit of a byte or dnum to 1.

BitSet BitPos;

Arguments: BitPos num

BitXOr

Function · Data and maths

Returns the bit-wise exclusive OR of two values.

BitXOr(BitData1, BitData2)

Arguments: BitData1 byte, BitData2 byte

BitXOrDnum

Function · Data and maths

A RAPID function with 2 arguments.

BitXOrDnum(Value1, Value2)

Arguments: Value1 dnum, Value2 dnum

BookErrNo

Instruction · Errors and recovery

Gives an error number to the program, for its own errors.

BookErrNo ErrorName;

Arguments: ErrorName errnum

bool

Data type · Data types

A logical value: TRUE or FALSE.

Break

Instruction · Program flow

Stops the program at once, without waiting for the robot to finish its move. Used when testing.

Break;

byte

Data type · Data types

A whole number from 0 to 255.

BytesReset

Instruction · System and tasks

A RAPID instruction.

BytesReset;

BytesToVal

Function · Data and maths

A RAPID function.

BytesToVal()

Optional: \StartIndex num, \ToIndex num

ByteToStr

Function · Strings

Returns a byte written as a string.

ByteToStr(BitData)

Arguments: BitData byte

Optional: \Hex, \Okt, \Bin, \Char

CalcJointT

Function · Positions and frames

Returns the axis angles that reach a position.

CalcJointT(Rob_target, Tool)

Arguments: Rob_target robtarget, Tool tooldata

Optional: \UseCurWObjPos, \WObj wobjdata, \ErrorNumber

CalcRobT

Function · Positions and frames

Returns the position the tool reaches from given axis angles.

CalcRobT(Joint_target, Tool)

Arguments: Joint_target jointtarget, Tool tooldata

Optional: \WObj wobjdata

CalcRotAxFrameZ

Function · Positions and frames

A RAPID function with 4 arguments.

CalcRotAxFrameZ(TargetsInList, PositiveZPoint, MaxErr, MeanErr)

Arguments: TargetsInList num, PositiveZPoint robtarget, MaxErr num, MeanErr num

CalcRotAxisFrame

Function · Positions and frames

A RAPID function with 4 arguments.

CalcRotAxisFrame(MechUnit, TargetsInList, MaxErr, MeanErr)

Arguments: MechUnit mecunit, TargetsInList num, MaxErr num, MeanErr num

Optional: \AxisNo num

CallByVar

Instruction · Program flow

Calls a procedure whose name is built from a string and a number.

CallByVar;

cameratarget

Data type · Data types

A data type of the RAPID language with 14 components.

Components: name string, cframe pose, trans pos, rot orient, val1 num, val2 num, val3 num, val4 num, val5 num, string1 string, string2 string, type num, cameraname string, sceneid num

CamFlush

Instruction · Communication

A RAPID instruction with 1 argument.

CamFlush Camera;

Arguments: Camera cameradev

CamGetExposure

Function · Communication

A RAPID function with 1 argument.

CamGetExposure(Camera)

Arguments: Camera cameradev

Optional: \ExposureTime, \Brightness, \Contrast

CamGetLoadedJob

Function · Communication

A RAPID function with 1 argument.

CamGetLoadedJob(Camera)

Arguments: Camera cameradev

CamGetMode

Function · Communication

A RAPID function with 1 argument.

CamGetMode(Camera)

Arguments: Camera cameradev

CamGetName

Function · Communication

A RAPID function with 1 argument.

CamGetName(Camera)

Arguments: Camera cameradev

CamGetParameter

Instruction · Communication

A RAPID instruction with 2 arguments.

CamGetParameter Camera, ParName;

Arguments: Camera cameradev, ParName string

Optional: \NumVar num, \BoolVar bool, \StrVar string

CamGetResult

Instruction · Communication

A RAPID instruction with 2 arguments.

CamGetResult Camera, CamTarget;

Arguments: Camera cameradev, CamTarget CameraTarget

Optional: \SceneId num, \MaxTime num

CamLoadJob

Instruction · Communication

A RAPID instruction with 2 arguments.

CamLoadJob Camera, JobName;

Arguments: Camera cameradev, JobName string

Optional: \KeepTargets, \MaxTime num

CamNumberOfResults

Function · Communication

A RAPID function with 1 argument.

CamNumberOfResults(Camera)

Arguments: Camera cameradev

Optional: \SceneId num

CamReqImage

Instruction · Communication

A RAPID instruction with 1 argument.

CamReqImage Camera;

Arguments: Camera cameradev

Optional: \SceneId num, \KeepTargets, \AwaitComplete

CamSetExposure

Instruction · Communication

A RAPID instruction with 1 argument.

CamSetExposure Camera;

Arguments: Camera cameradev

Optional: \ExposureTime num, \Brightness num, \Contrast num

CamSetParameter

Instruction · Communication

A RAPID instruction with 2 arguments.

CamSetParameter Camera, ParName;

Arguments: Camera cameradev, ParName string

Optional: \NumVal num, \BoolVal bool, \StrVal string

CamSetProgramMode

Instruction · Communication

A RAPID instruction with 1 argument.

CamSetProgramMode Camera;

Arguments: Camera cameradev

CamSetRunMode

Instruction · Communication

A RAPID instruction with 1 argument.

CamSetRunMode Camera;

Arguments: Camera cameradev

CamStartLoadJob

Instruction · Communication

A RAPID instruction with 2 arguments.

CamStartLoadJob Camera, Name;

Arguments: Camera cameradev, Name string

Optional: \KeepTargets

CamStartSetParameter

Instruction · Communication

A RAPID instruction with 2 arguments.

CamStartSetParameter Camera, ParName;

Arguments: Camera cameradev, ParName string

Optional: \NumVal num, \BoolVal bool, \StrVal string

CamWaitLoadJob

Instruction · Communication

A RAPID instruction with 1 argument.

CamWaitLoadJob Camera;

Arguments: Camera cameradev

CamWaitSetParameter

Instruction · Communication

A RAPID instruction with 1 argument.

CamWaitSetParameter Camera;

Arguments: Camera cameradev

CancelLoad

Instruction · System and tasks

A RAPID instruction with 1 argument.

CancelLoad LoadNo;

Arguments: LoadNo loadsession

capaptrreferencedata

Data type · Data types

A data type of the RAPID language with 6 components.

Components: reference_y num, reference_z num, threshold_y num, threshold_z num, gain_y num, gain_z num

CapAPTrSetupAI

Instruction · Motion

A RAPID instruction with 3 arguments.

CapAPTrSetupAI aoi_y, ai_z, ReferenceData;

Arguments: aoi_y signalai, ai_z signalai, ReferenceData capaptrreferencedata

Optional: \MaxIncrCorr num, \WarnMaxCorr switch, \Filter num, \SampleTime num, \LogFile string, \LogSize num, \LatestCorr pos, \AccCorr pos

CapAPTrSetupAO

Instruction · Motion

A RAPID instruction with 3 arguments.

CapAPTrSetupAO ao_y, ao_z, ReferenceData;

Arguments: ao_y signalao, ao_z signalao, ReferenceData capaptrreferencedata

Optional: \MaxIncrCorr num, \WarnMaxCorr switch, \Filter num, \SampleTime num, \LogFile string, \LogSize num, \LatestCorr pos, \AccCorr pos

CapAPTrSetupPERS

Instruction · Motion

A RAPID instruction with 3 arguments.

CapAPTrSetupPERS var_y, var_z, ReferenceData;

Arguments: var_y num, var_z vnum, ReferenceData capaptrreferencedata

Optional: \ResetToReference switch, \MaxIncrCorr num, \WarnMaxCorr switch, \Filter num, \SampleTime num, \LogFile string, \LogSize num, \LatestCorr pos, \AccCorr pos

CapC

Instruction · Motion

A RAPID instruction with 8 arguments.

CapC CirPoint, ToPoint, Speed, Cdata, Weavestart, Weave, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Cdata capdata, Weavestart weavestartdata, Weave capweavedata, Zone zonedata, Tool tooldata

Optional: \Id identno, \Movestart_timer num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \Time num, \T1 triggdata, \TriggArray, \T2 triggdata, \T3 triggdata, \T4 triggdata, \T5 triggdata, \T6 triggdata, \T7 triggdata, \T8 triggdata, \TLoad loaddata

capdata

Data type · Data types

A data type of the RAPID language with 32 components.

Components: start_fly bool, first_instr bool, last_instr bool, restart_dist num, speed_data capspeeddata, fly_start num, start num, startspeed_time num, startmove_delay num, main num, fly_end num, start_fly_point flypointdata, time_before num, distance num, end_fly_point flypointdata, sup_timeouts supervtimeouts, pre_cond num, start_cond num, end_main_cond num, end_post1_cond num, end_post2_cond num, proc_times processtimes, pre num, post1 num, post2 num, block_at_restart restartblkdata, weave_start bool, motion_delay bool, pre_phase bool, startspeed_phase bool, post1_phase bool, post2_phase bool

CapEquiDist

Instruction · Motion

A RAPID instruction.

CapEquiDist;

Optional: \Distance num, \Reset

CapInitSupervision

Instruction · Motion

A RAPID instruction.

CapInitSupervision;

CapL

Instruction · Motion

A RAPID instruction with 7 arguments.

CapL ToPoint, Speed, Cdata, Weavestart, Weave, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Cdata capdata, Weavestart weavestartdata, Weave capweavedata, Zone zonedata, Tool tooldata

Optional: \Id identno, \Movestart_timer num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \Time num, \T1 triggdata, \TriggArray, \T2 triggdata, \T3 triggdata, \T4 triggdata, \T5 triggdata, \T6 triggdata, \T7 triggdata, \T8 triggdata, \TLoad loaddata

CapNoProcess

Instruction · Motion

A RAPID instruction with 1 argument.

CapNoProcess skip_dist;

Arguments: skip_dist num

CapRefresh

Instruction · Motion

A RAPID instruction.

CapRefresh;

Optional: \MainSpeed, \MainWeave, \Startweave bool, \RestartDist num

CapRemoveSupervision

Instruction · Motion

A RAPID instruction with 3 arguments.

CapRemoveSupervision Signal, Condition, Listtype;

Arguments: Signal signaldi, Condition num, Listtype num

Optional: \Deactivate

CapSetDOAtStop

Instruction · Motion

A RAPID instruction with 2 arguments.

CapSetDOAtStop Signal, Value;

Arguments: Signal signaldo, Value dionum

CapSetupSupervision

Instruction · Motion

A RAPID instruction with 3 arguments.

CapSetupSupervision Signal, Condition, Listtype;

Arguments: Signal signaldi, Condition num, Listtype num

Optional: \ErrIndSig signaldo

capspeeddata

Data type · Data types

A data type of the RAPID language with 4 components.

Components: start num, startspeed_time num, startmove_delay num, main num

CapWeaveSync

Instruction · Motion

A RAPID instruction with 4 arguments.

CapWeaveSync DoLeft, LevelLeft, DoRight, LevelRight;

Arguments: DoLeft signaldo, LevelLeft num, DoRight signaldo, LevelRight num

Optional: \Reset

CDate

Function · Time

Returns the controller's date as a string.

CDate()

CheckProgRef

Instruction · System and tasks

Checks that every name the program uses is declared.

CheckProgRef;

CirPathMode

Instruction · Motion settings

Sets how the tool turns along a circular move.

CirPathMode;

Optional: \PathFrame, \ObjectFrame, \CirPointOri, \Wrist45, \Wrist46, \Wrist56

CJointT

Function · Positions and frames

Returns the robot's current axis angles as a jointtarget.

CJointT()

Optional: \TaskRef taskid, \TaskName string

Clear

Instruction · Data and maths

Sets a numeric variable to 0.

Clear;

ClearIOBuff

Instruction · Files and serial channels

Empties the input buffer of a serial channel.

ClearPath

Instruction · Motion

Removes the moves the robot has planned but not yet made, so that it stops on the current path.

ClearPath;

ClearRawBytes

Instruction · System and tasks

A RAPID instruction with 1 argument.

ClearRawBytes RawData;

Arguments: RawData rawbytes

Optional: \FromIndex num

ClkRead

Function · Time

Returns the time a clock has measured, in seconds.

ClkRead(Clock)

Arguments: Clock clock

Optional: \HighRes

ClkReset

Instruction · Time

Sets a clock to zero.

ClkReset Clock;

Arguments: Clock clock

ClkStart

Instruction · Time

Starts a clock that measures time.

ClkStart Clock;

Arguments: Clock clock

ClkStop

Instruction · Time

Stops a clock.

ClkStop Clock;

Arguments: Clock clock

clock

Data type · Data types

A clock that measures time.

Close

Instruction · Files and serial channels

Closes a file or serial channel.

Close IODevice;

Arguments: IODevice iodev

CloseDir

Instruction · Files and serial channels

Closes a folder opened with OpenDir.

CloseDir Dev;

Arguments: Dev dir

Comment

Instruction · System and tasks

A RAPID instruction.

Comment;

confdata

Data type · Data types

The robot's configuration: which quarter turn axes 1, 4 and 6 are in, and which way the arm is set.

Components: cf1 num, cf4 num, cf6 num, cfx num

ConfJ

Instruction · Motion settings

Switches the check of the robot's configuration on or off for axis-wise moves.

ConfJ;

Optional: \On, \Off

ConfL

Instruction · Motion settings

Switches the check of the robot's configuration on or off for straight and circular moves.

ConfL;

Optional: \On, \Off

CONNECT

Instruction · Interrupts

Connects an interrupt number to the trap routine that handles it.

CONNECT interrupt WITH trap_routine;

ContactL

Instruction · System and tasks

A RAPID instruction with 3 arguments.

ContactL ToPoint, Speed, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Tool tooldata

Optional: \DesiredTorque, \ID identno, \Zone zonedata, \WObj wobjdata

Continue

Instruction · System and tasks

A RAPID instruction.

Continue;

CopyFile

Instruction · Files and serial channels

Copies a file.

CopyFile OldPath, NewPath;

Arguments: OldPath string, NewPath string

CopyRawBytes

Instruction · System and tasks

A RAPID instruction with 4 arguments.

CopyRawBytes FromRawData, FromIndex, ToRawData, ToIndex;

Arguments: FromRawData rawbytes, FromIndex num, ToRawData rawbytes, ToIndex num

Optional: \NoOfBytes num

CornerPathWarning

Instruction · System and tasks

A RAPID instruction with 1 argument.

CornerPathWarning Active;

Arguments: Active bool

CorrClear

Instruction · Positions and frames

Removes every path correction generator.

CorrClear;

CorrCon

Instruction · Positions and frames

Connects a path correction generator, such as a sensor that corrects the path while the robot moves.

CorrCon Descr;

Arguments: Descr corrdescr

CorrDiscon

Instruction · Positions and frames

Disconnects a path correction generator.

CorrDiscon Descr;

Arguments: Descr corrdescr

CorrRead

Function · Positions and frames

A RAPID function.

CorrRead()

CorrWrite

Instruction · Positions and frames

Writes a path correction to a connected correction generator.

CorrWrite Descr, Data;

Arguments: Descr corrdescr, Data pos

Cos

Function · Data and maths

Returns the cosine of an angle in degrees.

Cos(Angle)

Arguments: Angle num

CosDnum

Function · Data and maths

A RAPID function with 1 argument.

CosDnum(Angle)

Arguments: Angle dnum

CPos

Function · Positions and frames

Returns the current position of the tool centre point as x, y and z.

CPos()

Optional: \Tool tooldata, \WObj wobjdata

CRobT

Function · Positions and frames

Returns the robot's current position as a robtarget, in the tool and work object given.

CRobT()

Optional: \TaskRef taskid, \TaskName string, \Tool tooldata, \WObj wobjdata

CrossProd

Function · Data and maths

A RAPID function with 2 arguments.

CrossProd(Vector1, Vector2)

Arguments: Vector1 pos, Vector2 pos

CSpeedOverride

Function · Data and maths

A RAPID function.

CSpeedOverride()

Optional: \CTask

CTime

Function · Time

Returns the controller's time of day as a string.

CTime()

CTool

Function · Positions and frames

Returns the tool the robot uses now.

CTool()

Optional: \TaskRef taskid, \TaskName string

CWObj

Function · Positions and frames

Returns the work object the robot uses now.

CWObj()

Optional: \TaskRef taskid, \TaskName string

DeactEventBuffer

Instruction · System and tasks

A RAPID instruction.

DeactEventBuffer;

DeactUnit

Instruction · Motion

Switches a mechanical unit off for motion, so that it is left out of moves.

DeactUnit MechUnit;

Arguments: MechUnit mecunit

DebugBreak

Instruction · System and tasks

A RAPID instruction.

DebugBreak;

Decr

Instruction · Data and maths

Takes 1 from a numeric variable.

Decr;

DecToHex

Function · Data and maths

A RAPID function with 1 argument.

DecToHex(Str)

Arguments: Str string

DefAccFrame

Function · Data and maths

A RAPID function with 3 arguments.

DefAccFrame(TargetsInList, MaxErr, MeanErr)

Arguments: TargetsInList num, MaxErr num, MeanErr num

DefDFrame

Function · Positions and frames

Returns the frame that moves three points to three others.

DefDFrame(OldP1, OldP2, OldP3, NewP1, NewP2, NewP3)

Arguments: OldP1 robtarget, OldP2 robtarget, OldP3 robtarget, NewP1 robtarget, NewP2 robtarget, NewP3 robtarget

DefFrame

Function · Positions and frames

Returns a frame defined by three points.

DefFrame(NewP1, NewP2, NewP3)

Arguments: NewP1 robtarget, NewP2 robtarget, NewP3 robtarget

Optional: \Origin num

Dim

Function · Data and maths

Returns the size of an array in one of its dimensions.

Dim(ArrPar, DimNo)

Arguments: ArrPar anytype, DimNo num

DInput

Function · Inputs and outputs

Returns the value of a digital input.

DInput(Signal)

Arguments: Signal signaladi

dionum

Data type · Data types

The value of a digital signal: 0 or 1.

DispC

Instruction · System and tasks

A RAPID instruction with 6 arguments.

DispC CirPoint, ToPoint, Speed, Bead, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Bead beaddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \Corr

DispCEnd

Instruction · System and tasks

A RAPID instruction with 6 arguments.

DispCEnd CirPoint, ToPoint, Speed, Bead, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Bead beaddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata

DispL

Instruction · System and tasks

A RAPID instruction with 5 arguments.

DispL ToPoint, Speed, Bead, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Bead beaddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \Corr

DispLEnd

Instruction · System and tasks

A RAPID instruction with 5 arguments.

DispLEnd ToPoint, Speed, Bead, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Bead beaddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata

DispLStart

Instruction · System and tasks

A RAPID instruction with 5 arguments.

DispLStart ToPoint, Speed, Bead, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Bead beaddata, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata

Distance

Function · Positions and frames

Returns how far apart two points are, in millimetres.

Distance(Point1, Point2)

Arguments: Point1 pos, Point2 pos

DIV

Function · Data and maths

A RAPID function with 1 argument.

DIV()

Arguments: dnum

dnum

Data type · Data types

A number with double precision. Integers are exact up to about 4 thousand million million.

DnumToNum

Function · Data and maths

A RAPID function with 1 argument.

DnumToNum(Value)

Arguments: Value dnum

Optional: \Integer

DnumToStr

Function · Strings

Returns a dnum written as a string.

DnumToStr(Val, Dec)

Arguments: Val dnum, Dec num

Optional: \Exp, \Compact

DotProd

Function · Data and maths

Returns the dot product of two vectors.

DotProd(Vector1, Vector2)

Arguments: Vector1 pos, Vector2 pos

DOutput

Function · Inputs and outputs

Returns the value of a digital output.

DOutput(Signal)

Arguments: Signal signaldo

DropWObj

Instruction · System and tasks

A RAPID instruction with 1 argument.

DropWObj WObj;

Arguments: WObj wobjdata

EOffsOff

Instruction · Positions and frames

Ends the offset of the external axes.

EOffsOff;

EOffsOn

Instruction · Positions and frames

Starts an offset of the external axes.

EOffsOn ProgPoint;

Arguments: ProgPoint robtarget

Optional: \ExeP robtarget

EOffsSet

Instruction · Positions and frames

Starts an offset of the external axes given as values.

EOffsSet EAxOffs;

Arguments: EAxOffs extjoint

EraseModule

Instruction · System and tasks

Removes a module from the task.

EraseModule ModuleName;

Arguments: ModuleName string

ErrLog

Instruction · Errors and recovery

Writes a message with its own number to the event log.

ErrLog ErrorId, Argument1, Argument2, Argument3, Argument4, Argument5;

Arguments: ErrorId num, Argument1 errstr, Argument2 errstr, Argument3 errstr, Argument4 errstr, Argument5 errstr

Optional: \W

errnum

Data type · Data types

An error number, such as those ERRNO holds in an error handler.

ErrRaise

Instruction · Errors and recovery

Writes a message to the event log and raises an error in one step.

ErrRaise ErrorName, ErrorId, Argument1, Argument2, Argument3, Argument4, Argument5;

Arguments: ErrorName string, ErrorId num, Argument1 errstr, Argument2 errstr, Argument3 errstr, Argument4 errstr, Argument5 errstr

ErrWrite

Instruction · Errors and recovery

Writes a message to the event log, and shows it on the FlexPendant.

ErrWrite Header, Reason;

Arguments: Header string, Reason string

Optional: \W, \I, \RL2 string, \RL3 string, \RL4 string

EulerZYX

Function · Positions and frames

Returns one of the three angles of an orientation, about z, y or x.

EulerZYX(Rotation)

Arguments: Rotation orient

Optional: \X, \Y, \Z

EventType

Function · Data and maths

A RAPID function.

EventType()

ExecHandler

Function · Data and maths

A RAPID function.

ExecHandler()

ExecLevel

Function · Data and maths

A RAPID function.

ExecLevel()

EXIT

Instruction · Program flow

Ends the program. It can be started again only from the beginning of main.

EXIT;

ExitCycle

Instruction · Program flow

Ends the cycle and starts the next one from the beginning of main, keeping the values of the data.

ExitCycle;

Exp

Function · Data and maths

Returns e raised to a power.

Exp(Exponent)

Arguments: Exponent num

extjoint

Data type · Data types

The positions of up to six external axes.

Components: eax_a num, eax_b num, eax_c num, eax_d num, eax_e num, eax_f num

FCAct

Instruction · System and tasks

A RAPID instruction with 1 argument.

FCAct Tool;

Arguments: Tool tooldata

Optional: \WObj wobjdata

FCDeact

Instruction · System and tasks

A RAPID instruction.

FCDeact;

FCPressC

Instruction · System and tasks

A RAPID instruction with 7 arguments.

FCPressC CirPoint, ToPoint, Speed, Force, MaxStallTime, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Force num, MaxStallTime num, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata

FCPressL

Instruction · System and tasks

A RAPID instruction with 6 arguments.

FCPressL ToPoint, Speed, Force, MaxStallTime, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Force num, MaxStallTime num, Zone zonedata, Tool tooldata

Optional: \WObj wobjdata, \Inpos stoppointdata

FCRefStart

Instruction · System and tasks

A RAPID instruction with 1 argument.

FCRefStart BoxVol;

Arguments: BoxVol fcboxvol

FCRefStop

Instruction · System and tasks

A RAPID instruction.

FCRefStop;

FileSize

Function · Files and serial channels

Returns the size of a file in bytes.

FileSize(Path)

Arguments: Path string

FileTimeDnum

Function · Files and serial channels

A RAPID function with 1 argument.

FileTimeDnum(Path)

Arguments: Path string

Optional: \ModifyTime, \AccessTime, \StatCTime

FitCircle

Instruction · System and tasks

A RAPID instruction with 3 arguments.

FitCircle Center, Radius, Normal;

Arguments: Center pos, Radius num, Normal pos

Optional: \NumPoints num, \RMS num, \MaxErr num, \IndexWorst num

FitLine

Instruction · System and tasks

A RAPID instruction with 2 arguments.

FitLine P, V;

Arguments: P pos, V num

Optional: \NumPoints num, \RMS num, \MaxErr num, \IndexWorst num

FitPlane

Instruction · System and tasks

A RAPID instruction with 2 arguments.

FitPlane P, Normal;

Arguments: P pos, Normal pos

Optional: \NumPoints num, \RMS num, \MaxErr num, \IndexWorst num

FitSphere

Instruction · System and tasks

A RAPID instruction with 2 arguments.

FitSphere Center, Radius;

Arguments: Center pos, Radius num

Optional: \NumPoints num, \RMS num, \MaxErr num, \IndexWorst num

flypointdata

Data type · Data types

A data type of the RAPID language with 3 components.

Components: databases flypointdata, process_dist num, distance num

FOR

Instruction · Program flow

Repeats a block of instructions while a counter steps from one value to another.

FOR i FROM 1 TO 10 STEP 1 DO
  ...
ENDFOR

FricIdEvaluate

Instruction · System and tasks

A RAPID instruction.

FricIdEvaluate;

Optional: \MechUnit mecunit, \BwdSpeed speeddata, \NoPrint, \FricLevelMax num, \FricLevelMin num, \OptTolerance num

FricIdInit

Instruction · System and tasks

A RAPID instruction.

FricIdInit;

FricIdSetFricLevels

Instruction · System and tasks

A RAPID instruction.

FricIdSetFricLevels;

Optional: \MechUnit mecunit

FSSize

Function · Files and serial channels

A RAPID function with 1 argument.

FSSize(Name)

Arguments: Name string

Optional: \Total, \Free, \Kbyte, \Mbyte

GetAxisDistance

Function · System and tasks

A RAPID function with 2 arguments.

GetAxisDistance(MechUnit, AxisNo)

Arguments: MechUnit mecunit, AxisNo num

GetAxisMoveTime

Function · System and tasks

A RAPID function with 2 arguments.

GetAxisMoveTime(MechUnit, AxisNo)

Arguments: MechUnit mecunit, AxisNo num

GetDataVal

Instruction · System and tasks

A RAPID instruction with 2 arguments.

GetDataVal Object, Value;

Arguments: Object string, Value anytype

Optional: \Block datapos, \TaskRef taskid, \TaskName string

GetGroupSignalInfo

Instruction · System and tasks

A RAPID instruction with 1 argument.

GetGroupSignalInfo Signal;

Arguments: Signal anytype

Optional: \MaxDvalue dnum, \Label string, \DeviceName string

GetMaxNumberOfCyclicBool

Function · System and tasks

A RAPID function.

GetMaxNumberOfCyclicBool()

GetMecUnitName

Function · System and tasks

A RAPID function with 1 argument.

GetMecUnitName(MechUnit)

Arguments: MechUnit mecunit

GetModalPayLoadMode

Function · System and tasks

A RAPID function.

GetModalPayLoadMode()

GetMotorTorque

Function · System and tasks

A RAPID function with 1 argument.

GetMotorTorque(AxisNo)

Arguments: AxisNo num

Optional: \MecUnit mecunit

GetNextCyclicBool

Function · System and tasks

A RAPID function with 2 arguments.

GetNextCyclicBool(ListNumber, Name)

Arguments: ListNumber num, Name string

GetNextMechUnit

Function · System and tasks

A RAPID function with 2 arguments.

GetNextMechUnit(ListNumber, UnitName)

Arguments: ListNumber num, UnitName string

Optional: \MecRef mecunit, \TCPRob bool, \NoOfAxes num, \MecTaskNo num, \MotPlanNo num, \Active bool, \DriveModule num, \OKToDeact bool

GetNextOption

Function · System and tasks

A RAPID function with 2 arguments.

GetNextOption(ListNumber, OptionName)

Arguments: ListNumber num, OptionName string

GetNextProduct

Function · System and tasks

A RAPID function with 2 arguments.

GetNextProduct(ListNumber, ProductName)

Arguments: ListNumber num, ProductName string

Optional: \VersionName string

GetNextSym

Function · System and tasks

A RAPID function with 1 argument.

GetNextSym(Block)

Arguments: Block datapos

Optional: \Recursive

GetNumberOfCyclicBool

Function · System and tasks

A RAPID function.

GetNumberOfCyclicBool()

GetServiceInfo

Function · System and tasks

A RAPID function with 1 argument.

GetServiceInfo(MechUnit)

Arguments: MechUnit mecunit

Optional: \DutyTimeCnt

GetSignalOrigin

Function · System and tasks

A RAPID function with 2 arguments.

GetSignalOrigin(Signal, SignalName)

Arguments: Signal anytype, SignalName string

GetSysData

Instruction · System and tasks

Reads the tool, work object or load the system uses now.

GetSysData DestObject;

Arguments: DestObject anytype

Optional: \TaskRef taskid, \TaskName string, \ObjectName

GetSysInfo

Function · System and tasks

Returns facts about the controller, such as its serial number or software version.

GetSysInfo()

Optional: \SerialNo, \SWVersion, \SWVersionName, \RobotType, \CtrlId, \LanIp, \CtrlLang, \SystemName

GetTaskName

Function · System and tasks

Returns the name of the task the program runs in.

GetTaskName()

Optional: \TaskNo num, \MecTaskNo num

GetTime

Function · Time

Returns part of the controller's date or time as a number.

GetTime()

Optional: \WDay, \Hour, \Min, \Sec, \MSec

GetTorqueMargin

Function · System and tasks

A RAPID function.

GetTorqueMargin()

Optional: \MechUnit mecunit, \AxisNo num

GetTrapData

Instruction · System and tasks

A RAPID instruction with 1 argument.

GetTrapData TrapEvent;

Arguments: TrapEvent trapdata

GetTSPStatus

Function · System and tasks

A RAPID function with 2 arguments.

GetTSPStatus(TaskRef, TaskName)

Arguments: TaskRef taskid, TaskName string

GetUASUserName

Function · System and tasks

A RAPID function.

GetUASUserName()

GInput

Function · Inputs and outputs

Returns the value of a group input.

GInput(Signal)

Arguments: Signal signalgi

GInputDnum

Function · Inputs and outputs

Returns the value of a group input as a dnum, for groups wider than 23 bits.

GInputDnum(Signal)

Arguments: Signal signalgi

GOTO

Instruction · Program flow

Jumps to a label in the same routine.

GOTO label;
...
label:

GOutput

Function · Inputs and outputs

Returns the value of a group output.

GOutput(Signal)

Arguments: Signal signalgo

GOutputDnum

Function · Inputs and outputs

Returns the value of a group output as a dnum.

GOutputDnum(Signal)

Arguments: Signal signalgo

GripLoad

Instruction · Motion settings

Tells the robot the weight and centre of gravity of the part it now holds, so that its motion control allows for it.

GripLoad Load;

Arguments: Load loaddata

HexToDec

Function · Data and maths

A RAPID function with 1 argument.

HexToDec(Str)

Arguments: Str string

HollowWristReset

Instruction · System and tasks

A RAPID instruction.

HollowWristReset;

ICap

Instruction · System and tasks

A RAPID instruction with 2 arguments.

ICap Interrupt, Event;

Arguments: Interrupt intnum, Event num

ICapPathPos

Instruction · System and tasks

A RAPID instruction with 3 arguments.

ICapPathPos p_robt, sen_pos, Interrupt;

Arguments: p_robt robtarget, sen_pos pos, Interrupt intnum

Optional: \EOffs, \NoDispl

IDelete

Instruction · Interrupts

Removes an interrupt so that it is no longer raised, and frees its number.

IDelete;

identno

Data type · Data types

A number that identifies synchronised moves in different tasks.

IDisable

Instruction · Interrupts

Holds back every interrupt. Interrupts that occur meanwhile are kept and handled after IEnable.

IDisable;

IEnable

Instruction · Interrupts

Lets interrupts be handled again after IDisable.

IEnable;

IError

Instruction · Interrupts

Orders an interrupt when an error of a given kind occurs.

IError ErrorDomain;

Arguments: ErrorDomain errdomain

Optional: \ErrorId num

IF

Instruction · Program flow

Runs a block of instructions only when a condition is true, with optional ELSEIF and ELSE blocks for the other cases.

IF condition THEN
  ...
ELSEIF condition THEN
  ...
ELSE
  ...
ENDIF

Incr

Instruction · Data and maths

Adds 1 to a numeric variable.

Incr;

IndAMove

Instruction · System and tasks

A RAPID instruction with 3 arguments.

IndAMove MecUnit, Axis, Speed;

Arguments: MecUnit mecunit, Axis num, Speed num

Optional: \ToAbsPos robtarget, \ToAbsNum num, \Ramp num

IndCMove

Instruction · System and tasks

A RAPID instruction with 3 arguments.

IndCMove MecUnit, Axis, Speed;

Arguments: MecUnit mecunit, Axis num, Speed num

Optional: \Ramp num

IndDMove

Instruction · System and tasks

A RAPID instruction with 4 arguments.

IndDMove MecUnit, Axis, Delta, Speed;

Arguments: MecUnit mecunit, Axis num, Delta num, Speed num

Optional: \Ramp num

IndInpos

Function · Data and maths

A RAPID function with 2 arguments.

IndInpos(MecUnit, Axis)

Arguments: MecUnit mecunit, Axis num

IndReset

Instruction · System and tasks

A RAPID instruction with 2 arguments.

IndReset MecUnit, Axis;

Arguments: MecUnit mecunit, Axis num

Optional: \RefPos robtarget, \RefNum num, \Short, \Fwd, \Bwd, \Old

IndRMove

Instruction · System and tasks

A RAPID instruction with 3 arguments.

IndRMove MecUnit, Axis, Speed;

Arguments: MecUnit mecunit, Axis num, Speed num

Optional: \ToRelPos robtargets, \ToRelNum num, \Short, \Fwd, \Bwd, \Ramp num

IndSpeed

Function · Data and maths

A RAPID function with 2 arguments.

IndSpeed(MecUnit, Axis)

Arguments: MecUnit mecunit, Axis num

Optional: \InSpeed, \ZeroSpeed

intnum

Data type · Data types

An interrupt number, connected to a trap routine.

InvertDO

Instruction · Inputs and outputs

Changes a digital output to its other value.

InvertDO Signal;

Arguments: Signal signaldo

IOActivate

Instruction · Inputs and outputs

A RAPID instruction with 2 arguments.

IOActivate DeviceName, MaxTime;

Arguments: DeviceName string, MaxTime num

IODeactivate

Instruction · Inputs and outputs

A RAPID instruction with 2 arguments.

IODeactivate DeviceName, MaxTime;

Arguments: DeviceName string, MaxTime num

iodev

Data type · Data types

A file or serial channel opened with Open.

IODeviceMute

Instruction · Inputs and outputs

A RAPID instruction with 1 argument.

IODeviceMute device_name;

Arguments: device_name string

Optional: \On, \Off

IODeviceState

Function · Inputs and outputs

A RAPID function with 1 argument.

IODeviceState(DeviceName)

Arguments: DeviceName string

Optional: \Phys, \Logic

IODisable

Instruction · Inputs and outputs

Disables an I/O device, so that its signals are no longer read or written.

IOEnable

Instruction · Inputs and outputs

Enables an I/O device again.

IONetworkState

Function · Inputs and outputs

A RAPID function with 1 argument.

IONetworkState(NetworkName)

Arguments: NetworkName string

Optional: \Phys, \Logic

IPers

Instruction · Interrupts

Orders an interrupt when a persistent variable changes.

IPers Name, Interrupt;

Arguments: Name anytype, Interrupt intnum

Optional: \Single, \SingleSafe

IRMQMessage

Instruction · System and tasks

A RAPID instruction with 2 arguments.

IRMQMessage InterruptDataType, Interrupt;

Arguments: InterruptDataType anytype, Interrupt intnum

IsBrakeCheckActive

Function · Data and maths

A RAPID function.

IsBrakeCheckActive()

IsCollFree

Function · Data and maths

A RAPID function with 1 argument.

IsCollFree(ThisRobotPos)

Arguments: ThisRobotPos jointtarget

Optional: \Rob1Pos jointtarget, \Rob2Pos jointtarget, \Rob3Pos jointtarget, \Rob4Pos jointtarget

IsCyclicBool

Function · Data and maths

A RAPID function with 1 argument.

IsCyclicBool()

Arguments: bool

IsFile

Function · Files and serial channels

Returns TRUE when a file of the type given exists.

IsFile(Path)

Arguments: Path string

Optional: \Directory, \Fifo, \RegFile, \BlockSpec, \CharSpec

ISignalAI

Instruction · Interrupts

Orders an interrupt when an analog input passes a value.

ISignalAI Signal, Condition, HighValue, LowValue, DeltaValue, Interrupt;

Arguments: Signal signalai, Condition aiotrigg, HighValue num, LowValue num, DeltaValue num, Interrupt intnum

Optional: \Single, \SingleSafe

ISignalAO

Instruction · Interrupts

Orders an interrupt when an analog output passes a value.

ISignalAO Signal, Condition, HighValue, LowValue, DeltaValue, Interrupt;

Arguments: Signal signalao, Condition aiotrigg, HighValue num, LowValue num, DeltaValue num, Interrupt intnum

Optional: \Single, \SingleSafe

ISignalDI

Instruction · Interrupts

Orders an interrupt when a digital input changes to a value.

ISignalDI Signal, TriggValue, Interrupt;

Arguments: Signal signaldi, TriggValue dionum, Interrupt intnum

Optional: \Single, \SingleSafe

ISignalDO

Instruction · Interrupts

Orders an interrupt when a digital output changes to a value.

ISignalDO Signal, TriggValue, Interrupt;

Arguments: Signal signaldo, TriggValue dionum, Interrupt intnum

Optional: \Single, \SingleSafe

ISignalGI

Instruction · Interrupts

Orders an interrupt when a group input changes.

ISignalGI Signal, Interrupt;

Arguments: Signal signalgi, Interrupt intnum

Optional: \Single, \SingleSafe

ISignalGO

Instruction · Interrupts

Orders an interrupt when a group output changes.

ISignalGO Signal, Interrupt;

Arguments: Signal signalgo, Interrupt intnum

Optional: \Single, \SingleSafe

IsLeadThrough

Function · Data and maths

A RAPID function.

IsLeadThrough()

Optional: \MecUnit mecunit, \Active, \Set

ISleep

Instruction · Interrupts

Puts an interrupt to sleep: it is not raised until IWatch.

ISleep Interrupt;

Arguments: Interrupt intnum

IsMechUnitActive

Function · Data and maths

A RAPID function with 1 argument.

IsMechUnitActive(MechUnit)

Arguments: MechUnit mecunit

IsPers

Function · Data and maths

Returns TRUE when an argument is a persistent variable.

IsPers()

IsStopMoveAct

Function · Data and maths

A RAPID function.

IsStopMoveAct()

Optional: \FromMoveTask, \FromNonMoveTask

IsStopStateEvent

Function · Data and maths

A RAPID function.

IsStopStateEvent()

Optional: \PPMoved, \PPToMain

IsSyncMoveOn

Function · System and tasks

Returns TRUE while the task makes synchronised moves.

IsSyncMoveOn()

IsSysId

Function · Data and maths

A RAPID function with 1 argument.

IsSysId(SystemId)

Arguments: SystemId string

IsVar

Function · Data and maths

Returns TRUE when an argument is a variable.

IsVar()

ITimer

Instruction · Interrupts

Orders an interrupt after a time, once or over and over.

ITimer Time, Interrupt;

Arguments: Time num, Interrupt intnum

Optional: \Single, \SingleSafe

IVarValue

Instruction · Interrupts

Orders an interrupt when a sensor value passes a limit.

IVarValue device, VarNo, Value, Interrupt;

Arguments: device string, VarNo num, Value num, Interrupt intnum

Optional: \Unit num, \DeadBand num, \ReportAtTool, \SpeedAdapt num, \APTR

IWatch

Instruction · Interrupts

Wakes an interrupt put to sleep with ISleep.

IWatch Interrupt;

Arguments: Interrupt intnum

jointtarget

Data type · Data types

A position given as the angles of the robot's axes and the positions of its external axes.

Components: robax robjoint, rax_1 num, rax_2 num, rax_3 num, rax_4 num, rax_5 num, rax_6 num, extax extjoint, eax_a num, eax_b num, eax_c num, eax_d num, eax_e num, eax_f num

Label

Instruction · System and tasks

A RAPID instruction.

Label;

listitem

Data type · Data types

A data type of the RAPID language with 2 components.

Components: image string, text string

Load

Instruction · System and tasks

Loads a program module into the task while the program runs.

Load FilePath;

Arguments: FilePath string

Optional: \Dynamic, \File string, \CheckRef

loaddata

Data type · Data types

A load: its weight, centre of gravity and inertia.

LoadId

Instruction · System and tasks

A RAPID instruction with 3 arguments.

LoadId ParIdType, LoadIdType, Tool;

Arguments: ParIdType paridnum, LoadIdType loadidnum, Tool tooldata

Optional: \PayLoad loaddata, \WObj wobjdata, \ConfAngle num, \SlowTest, \Accuracy num

MakeDir

Instruction · Files and serial channels

Makes a folder.

MakeDir Path;

Arguments: Path string

ManLoadIdProc

Instruction · System and tasks

A RAPID instruction.

ManLoadIdProc;

Optional: \ParIdType paridnum, \MechUnit mecunit, \MechUnitName string, \AxisNumber num, \PayLoad num

MatrixAdd

Instruction · System and tasks

A RAPID instruction.

MatrixAdd;

Optional: \A_m num, \A_n num

MatrixInverse

Instruction · System and tasks

A RAPID instruction.

MatrixInverse;

Optional: \A_m num, \A_n num, \Result_m num, \Result_n num, \Tolerance dnum

MatrixMult

Instruction · System and tasks

A RAPID instruction with 1 argument.

MatrixMult Scalar;

Arguments: Scalar dnum

Optional: \A_m num, \A_n num, \B_m num, \B_n num, \Result_m num, \Result_n num

MatrixReset

Instruction · System and tasks

A RAPID instruction.

MatrixReset;

Optional: \A_m num, \A_n num

MatrixSolve

Instruction · System and tasks

A RAPID instruction.

MatrixSolve;

Optional: \A_m num, \A_n num

MatrixSolveQR

Instruction · System and tasks

A RAPID instruction.

MatrixSolveQR;

Optional: \A_m num, \A_n num

MatrixSub

Instruction · System and tasks

A RAPID instruction.

MatrixSub;

Optional: \A_m num, \A_n num

MatrixSVD

Instruction · System and tasks

A RAPID instruction.

MatrixSVD;

Optional: \A_m num, \A_n num, \Econ

MatrixTranspose

Instruction · System and tasks

A RAPID instruction.

MatrixTranspose;

Optional: \A_m num, \A_n num, \Result_m num, \Result_n num

Max

Function · Data and maths

A RAPID function with 2 arguments.

Max(A, B)

Arguments: A num, B num

MaxExtLinearSpeed

Function · Data and maths

A RAPID function.

MaxExtLinearSpeed()

MaxExtReorientSpeed

Function · Data and maths

A RAPID function.

MaxExtReorientSpeed()

MaxRobReorientSpeed

Function · Data and maths

A RAPID function.

MaxRobReorientSpeed()

MaxRobSpeed

Function · Data and maths

A RAPID function.

MaxRobSpeed()

MechUnitLoad

Instruction · Motion settings

Sets the load carried by a mechanical unit, such as a positioner holding a fixture.

MechUnitLoad MechUnit, AxisNo, Load;

Arguments: MechUnit mecunit, AxisNo num, Load loaddata

mecunit

Data type · Data types

A mechanical unit: the robot or an external axis.

Min

Function · Data and maths

A RAPID function with 2 arguments.

Min(A, B)

Arguments: A num, B num

MirPos

Function · Positions and frames

Returns a point mirrored in a plane.

MirPos(Point, MirPlane)

Arguments: Point robtarget, MirPlane wobjdata

Optional: \WObj wobjdata, \MirY

MOD

Function · Data and maths

A RAPID function with 1 argument.

MOD()

Arguments: dnum

ModExist

Function · Data and maths

A RAPID function with 1 argument.

ModExist(ModuleName)

Arguments: ModuleName string

ModTimeDnum

Function · Data and maths

A RAPID function with 1 argument.

ModTimeDnum(Object)

Arguments: Object string

MotionPlannerNo

Function · Data and maths

A RAPID function.

MotionPlannerNo()

MotionProcessModeSet

Instruction · System and tasks

A RAPID instruction with 1 argument.

MotionProcessModeSet Mode;

Arguments: Mode motionprocessmode

MotionSup

Instruction · Motion settings

Switches motion supervision, the collision detection of the arm, on or off, or changes how sensitive it is.

MotionSup;

Optional: \On, \Off, \Tunevalue num, \NoBackoff

MoveAbsJ

Instruction · Motion

Moves the robot and its external axes to a position given as axis angles rather than as a tool position. The tool and work object only affect the speed. Often used for home positions, where the configuration must be exact.

MoveAbsJ ToJointPos, Speed, Zone, Tool;

Arguments: ToJointPos jointtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \NoEoffs, \V num, \T num, \KeepStartPath num, \KeepEndPath num, \Z num, \Inpos stoppointdata, \WObj wobjdata, \TLoad loaddata

MoveAbsL

Instruction · Motion

A RAPID instruction with 4 arguments.

MoveAbsL ToJointPos, Speed, Zone, Tool;

Arguments: ToJointPos jointtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \V num, \T num, \KeepStartPath num, \KeepEndPath num, \Z num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \TLoad loaddata, \FollowConveyor

MoveC

Instruction · Motion

Moves the tool centre point along a circular arc through a circle point to the target. The arc is fixed by the start point, the circle point and the target.

MoveC CirPoint, ToPoint, Speed, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \V num, \T num, \KeepStartPath num, \KeepEndPath num, \Z num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \TLoad loaddata

MoveCAO

Instruction · Motion

A RAPID instruction with 7 arguments.

MoveCAO CirPoint, ToPoint, Speed, Zone, Tool, Signal, Value;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signalao, Value num

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveCDO

Instruction · Motion

A circular move that sets a digital output in the middle of the corner path at the target.

MoveCDO CirPoint, ToPoint, Speed, Zone, Tool, Signal, Value;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signaldo, Value dionum

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveCGO

Instruction · Motion

A RAPID instruction with 6 arguments.

MoveCGO CirPoint, ToPoint, Speed, Zone, Tool, Signal;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signalgo

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \Value num, \Dvalue dnum, \TLoad loaddata

MoveCSync

Instruction · Motion

A circular move that calls a routine in the middle of the corner path at the target.

MoveCSync CirPoint, ToPoint, Speed, Zone, Tool, ProcName;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, ProcName string

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveExtJ

Instruction · Motion

Moves external axes alone, such as a positioner or track, with no robot axis moving.

MoveExtJ ToJointPos, Speed, Zone;

Arguments: ToJointPos jointtarget, Speed speeddata, Zone zonedata

Optional: \Conc, \ID identno, \UseEOffs, \T num, \Inpos stoppointdata

MoveJ

Instruction · Motion

Moves the robot to the target with all axes moving together, so the path between the points is not a straight line. It is usually the fastest way between two points that are far apart and is used for moves through free space.

MoveJ ToPoint, Speed, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \V num, \T num, \KeepStartPath num, \KeepEndPath num, \Z num, \Inpos stoppointdata, \WObj wobjdata, \TLoad loaddata

MoveJAO

Instruction · Motion

A RAPID instruction with 6 arguments.

MoveJAO ToPoint, Speed, Zone, Tool, Signal, Value;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signalao, Value num

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveJDO

Instruction · Motion

An axis-wise move that sets a digital output in the middle of the corner path at the target.

MoveJDO ToPoint, Speed, Zone, Tool, Signal, Value;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signaldo, Value dionum

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveJGO

Instruction · Motion

A RAPID instruction with 5 arguments.

MoveJGO ToPoint, Speed, Zone, Tool, Signal;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signalgo

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \Value num, \Dvalue dnum, \TLoad loaddata

MoveJSync

Instruction · Motion

An axis-wise move that calls a routine in the middle of the corner path at the target.

MoveJSync ToPoint, Speed, Zone, Tool, ProcName;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, ProcName string

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveL

Instruction · Motion

Moves the tool centre point in a straight line to the target, at the speed given, finishing the move as the zone allows. Used wherever the path between points matters, such as approaching a fixture or following a seam.

MoveL ToPoint, Speed, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \V num, \T num, \KeepStartPath num, \KeepEndPath num, \Z num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \TLoad loaddata, \FollowConveyor

MoveLAO

Instruction · Motion

A RAPID instruction with 6 arguments.

MoveLAO ToPoint, Speed, Zone, Tool, Signal, Value;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signalao, Value num

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveLDO

Instruction · Motion

A straight-line move that sets a digital output in the middle of the corner path at the target.

MoveLDO ToPoint, Speed, Zone, Tool, Signal, Value;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signaldo, Value dionum

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MoveLGO

Instruction · Motion

A RAPID instruction with 5 arguments.

MoveLGO ToPoint, Speed, Zone, Tool, Signal;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, Signal signaldo

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \Value num, \Dvalue dnum, \TLoad loaddata

MoveLSync

Instruction · Motion

A straight-line move that calls a routine in the middle of the corner path at the target.

MoveLSync ToPoint, Speed, Zone, Tool, ProcName;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata, ProcName string

Optional: \ID identno, \T num, \KeepStartPath num, \KeepEndPath num, \WObj wobjdata, \TLoad loaddata

MovePnP

Instruction · Motion

A RAPID instruction with 4 arguments.

MovePnP ToPoint, Speed, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \ID identno, \PnPHeight num, \Inpos stoppointdata, \WObj wobjdata, \TLoad loaddata, \PnPDataIN pnpdata, \SignalIN signaldi, \Value dionum, \MaxTime num, \TimeFlag bool, \PnPTrigg triggdata, \PnPTriggOption num

MToolRotCalib

Instruction · System and tasks

A RAPID instruction with 3 arguments.

MToolRotCalib RefTip, ZPos, Tool;

Arguments: RefTip jointtarget, ZPos jointtarget, Tool tooldata

Optional: \XPos jointtarget

MToolTCPCalib

Instruction · System and tasks

A RAPID instruction with 7 arguments.

MToolTCPCalib Pos1, Pos2, Pos3, Pos4, Tool, MaxErr, MeanErr;

Arguments: Pos1 jointtarget, Pos2 jointtarget, Pos3 jointtarget, Pos4 jointtarget, Tool tooldata, MaxErr num, MeanErr num

NonMotionMode

Function · Data and maths

A RAPID function.

NonMotionMode()

NOrient

Function · Positions and frames

Returns an orientation made exact, when rounding has left it a little off.

NOrient(Rotation)

Arguments: Rotation orient

NOT

Function · Data and maths

A RAPID function.

NOT()

num

Data type · Data types

A number, with or without decimals. Integers are exact up to about 8 million.

NumToDnum

Function · Data and maths

A RAPID function with 1 argument.

NumToDnum(Value)

Arguments: Value num

NumToStr

Function · Strings

Returns a number written as a string, with a number of decimals.

NumToStr(Val, Dec)

Arguments: Val num, Dec num

Optional: \Exp, \Compact

Offs

Function · Positions and frames

Returns a point moved by an x, y and z distance in the point's work object frame.

Offs(Point, XOffset, YOffset, ZOffset)

Arguments: Point robtarget, XOffset num, YOffset num, ZOffset num

Open

Instruction · Files and serial channels

Opens a file or a serial channel for reading or writing.

Open Object, IODevice;

Arguments: Object string, IODevice iodev

Optional: \File string, \Read, \Write, \Append, \Bin, \ISOLatin1Encoding

OpenDir

Instruction · Files and serial channels

Opens a folder to read its contents.

OpenDir Dev, Path;

Arguments: Dev dir, Path string

OpMode

Function · System and tasks

Returns the operating mode: automatic, manual reduced speed or manual full speed.

OpMode()

OR

Function · Data and maths

A RAPID function.

OR()

orient

Data type · Data types

An orientation, as a quaternion of four numbers.

Components: q1 num, q2 num, q3 num, q4 num

OrientZYX

Function · Positions and frames

Returns an orientation built from three angles, about z, y and x in turn.

OrientZYX(ZAngle, YAngle, XAngle)

Arguments: ZAngle num, YAngle num, XAngle num

ORobT

Function · Data and maths

A RAPID function with 1 argument.

ORobT(OrgPoint)

Arguments: OrgPoint robtarget

Optional: \InPDisp, \InEOffs

PackDNHeader

Instruction · System and tasks

A RAPID instruction with 3 arguments.

PackDNHeader Service, Path, RawData;

Arguments: Service string, Path string, RawData rawbytes

PackRawBytes

Instruction · System and tasks

A RAPID instruction with 3 arguments.

PackRawBytes Value, RawData, StartIndex;

Arguments: Value anytype, RawData rawbytes, StartIndex num

Optional: \Network, \Hex1, \IntX inttypes, \Float4, \UTF8Encoding, \ISOLatin1Encoding

PaintC

Instruction · System and tasks

A RAPID instruction with 4 arguments.

PaintC CirPoint, ToPoint, Speed, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \Brush brushdata

PaintL

Instruction · System and tasks

A RAPID instruction with 3 arguments.

PaintL ToPoint, Speed, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Tool tooldata

Optional: \WObj wobjdata, \TLoad loaddata, \Brush brushdata

ParIdPosValid

Function · Data and maths

A RAPID function with 2 arguments.

ParIdPosValid(ParIdType, Pos)

Arguments: ParIdType paridnum, Pos jointtarget

Optional: \ConfAngle num

ParIdRobValid

Function · Data and maths

A RAPID function with 1 argument.

ParIdRobValid(ParIdType)

Arguments: ParIdType paridnum

Optional: \MechUnit mecunit, \AxisNo num

PathAccLim

Instruction · Motion settings

Limits the acceleration and deceleration of the tool centre point along the path.

PathAccLim AccLim, DecelLim;

Arguments: AccLim bool, DecelLim bool

Optional: \AccMax num, \DecelMax num

PathLengthGet

Function · Motion settings

A RAPID function.

PathLengthGet()

PathLengthReset

Instruction · Motion settings

A RAPID instruction.

PathLengthReset;

PathLengthStart

Instruction · Motion settings

A RAPID instruction.

PathLengthStart;

PathLengthStop

Instruction · Motion settings

A RAPID instruction.

PathLengthStop;

PathLevel

Function · Motion settings

A RAPID function.

PathLevel()

PathRecMoveBwd

Instruction · Motion settings

A RAPID instruction.

PathRecMoveBwd;

Optional: \ID pathrecid, \ToolOffs pos, \Speed speeddata

PathRecMoveFwd

Instruction · Motion settings

A RAPID instruction.

PathRecMoveFwd;

Optional: \ID pathid, \ToolOffs pos, \Speed speeddata

PathRecStart

Instruction · Motion settings

A RAPID instruction with 1 argument.

PathRecStart ID;

Arguments: ID pathrecid

PathRecStop

Instruction · Motion settings

A RAPID instruction.

PathRecStop;

Optional: \switch

PathRecValidBwd

Function · Motion settings

A RAPID function.

PathRecValidBwd()

Optional: \ID pathrecid

PathRecValidFwd

Function · Motion settings

A RAPID function.

PathRecValidFwd()

Optional: \ID pathrecid

PathResol

Instruction · Motion settings

Changes how often the path is calculated, for very fast or very slow moves.

PathResol PathSampleTime;

Arguments: PathSampleTime num

PDispOff

Instruction · Positions and frames

Ends the program displacement.

PDispOff;

PDispOn

Instruction · Positions and frames

Starts a program displacement: the points that follow are moved by the difference between two positions.

PDispOn , ProgPoint, Tool;

Arguments: robtarget, ProgPoint robtarget, Tool tooldata

Optional: \WObj wobjdata

PDispSet

Instruction · Positions and frames

Starts a program displacement given as a frame.

PDispSet DispFrame;

Arguments: DispFrame pose

pnpdata

Data type · Data types

A data type of the RAPID language with 4 components.

Components: smooth_start num, smooth_end num, z_above_start zonedata, z_above_end zonedata

pos

Data type · Data types

A position in space: x, y and z in millimetres.

Components: x num, y num, z num

pose

Data type · Data types

A frame: a position and an orientation.

Components: trans pos, rot orient

PoseInv

Function · Positions and frames

Returns the inverse of a frame.

PoseInv()

Arguments: pose

PoseMult

Function · Positions and frames

Returns the product of two frames: the second frame expressed in the first.

PoseMult(Pose1, Pose2)

Arguments: Pose1 pose, Pose2 pose

PoseVect

Function · Positions and frames

Returns a vector transformed by a frame.

PoseVect(Pose, Pos)

Arguments: Pose pose, Pos pos

Pow

Function · Data and maths

Returns a value raised to a power.

Pow(Base, Exponent)

Arguments: Base num, Exponent num

PowDnum

Function · Data and maths

A RAPID function with 2 arguments.

PowDnum(Base, Exponent)

Arguments: Base dnum, Exponent num

PPMovedInManMode

Function · Data and maths

A RAPID function.

PPMovedInManMode()

Present

Function · Data and maths

Returns TRUE when an optional argument was given in the call.

Present(OptPar)

Arguments: OptPar anytype

ProcCall

Instruction · System and tasks

A RAPID instruction.

ProcCall;

ProcerrRecovery

Instruction · System and tasks

A RAPID instruction.

ProcerrRecovery;

Optional: \SyncOrgMoveInst, \ProcSignal signaldo

progdisp

Data type · Data types

A program displacement in use.

Components: pdisp pose, trans pos, x num, y num, z num, rot orient, q1 num, q2 num, q3 num, q4 num, eoffs extjoint, eax_a num, eax_b num, eax_c num, eax_d num, eax_e num, eax_f num

ProgMemFree

Function · Data and maths

A RAPID function.

ProgMemFree()

PulseDO

Instruction · Inputs and outputs

Gives a digital output a pulse of a set length.

PulseDO Signal;

Arguments: Signal signaldo

Optional: \High, \PLength num

RAISE

Instruction · Errors and recovery

Raises an error, so that the error handler of the routine, or of the routine that called it, takes over.

RAISE;
RAISE error_number;

RaiseToUser

Instruction · System and tasks

A RAPID instruction.

RaiseToUser;

Optional: \Resume, \BreakOff, \ErrorNumber errnum

RawBytesLen

Function · Data and maths

A RAPID function with 1 argument.

RawBytesLen(RawData)

Arguments: RawData rawbytes

ReadAnyBin

Instruction · Files and serial channels

Reads data of any type from a binary file or serial channel.

ReadAnyBin IODevice;

Arguments: IODevice iodev

Optional: \Time num

ReadBin

Function · Files and serial channels

Reads a byte from a binary file or serial channel.

ReadBin(IODevice)

Arguments: IODevice iodev

Optional: \Time num

ReadCfgData

Instruction · Files and serial channels

A RAPID instruction with 3 arguments.

ReadCfgData InstancePath, Attribute, CfgData;

Arguments: InstancePath string, Attribute string, CfgData anytype

Optional: \ListNo num

ReadDir

Function · Files and serial channels

Reads the next name in a folder opened with OpenDir.

ReadDir(Dev)

Arguments: Dev dir

ReadDnum

Function · Files and serial channels

A RAPID function with 1 argument.

ReadDnum(IODevice)

Arguments: IODevice iodev

Optional: \Delim string, \Time num, \ISOLatin1Encoding

ReadErrData

Instruction · Errors and recovery

In a trap: reads what is known of the error that raised it.

ReadErrData TrapEvent, ErrorDomain, ErrorId, ErrorType;

Arguments: TrapEvent trapdata, ErrorDomain errdomain, ErrorId num, ErrorType errtype

Optional: \Title string, \Str1 string, \Str2 string, \Str3 string, \Str4 string, \Str5 string

ReadMotor

Function · Files and serial channels

A RAPID function with 1 argument.

ReadMotor(Axis)

Arguments: Axis num

Optional: \MecUnit mecunit

ReadNum

Function · Files and serial channels

Reads a number from a file or serial channel.

ReadNum(IODevice)

Arguments: IODevice iodev

Optional: \Delim string, \Time num, \ISOLatin1Encoding

ReadRawBytes

Instruction · Files and serial channels

A RAPID instruction with 2 arguments.

ReadRawBytes IODevice, RawData;

Arguments: IODevice iodev, RawData rawbytes

Optional: \Time num

ReadStr

Function · Files and serial channels

Reads a line of text from a file or serial channel.

ReadStr(IODevice)

Arguments: IODevice iodev

Optional: \Delim string, \RemoveCR, \DiscardHeaders, \Time num, \Line num, \ISOLatin1Encoding, \Status

ReadStrBin

Function · Files and serial channels

Reads a number of characters from a binary file or serial channel.

ReadStrBin(IODevice, NoOfChars)

Arguments: IODevice iodev, NoOfChars num

Optional: \Time num

ReadVar

Function · Files and serial channels

A RAPID function with 2 arguments.

ReadVar(device, VarNo)

Arguments: device string, VarNo num

Optional: \TaskName string

ReadVarArr

Instruction · Files and serial channels

A RAPID instruction with 1 argument.

ReadVarArr Device;

Arguments: Device string

Optional: \TaskName string

RelTool

Function · Positions and frames

Returns a point moved, and optionally turned, in the frame of the tool.

RelTool(Point, Dx, Dy, Dz)

Arguments: Point robtarget, Dx num, Dy num, Dz num

Optional: \Rx num, \Ry num, \Rz num

RemainingRetries

Function · Data and maths

A RAPID function.

RemainingRetries()

RemoveAllCyclicBool

Instruction · System and tasks

A RAPID instruction.

RemoveAllCyclicBool;

Optional: \AllTasks

RemoveCyclicBool

Instruction · System and tasks

A RAPID instruction with 2 arguments.

RemoveCyclicBool Flag, Name;

Arguments: Flag bool, Name string

RemoveDir

Instruction · Files and serial channels

Removes an empty folder.

RemoveDir Path;

Arguments: Path string

RemoveFile

Instruction · Files and serial channels

Removes a file.

RemoveFile Path;

Arguments: Path string

RenameFile

Instruction · Files and serial channels

Renames a file.

RenameFile OldPath, NewPath;

Arguments: OldPath string, NewPath string

Reset

Instruction · Inputs and outputs

Sets a digital output to 0.

Reset Signal;

Arguments: Signal signaldo

ResetAxisDistance

Instruction · System and tasks

A RAPID instruction with 2 arguments.

ResetAxisDistance MechUnit, AxisNo;

Arguments: MechUnit mecunit, AxisNo num

ResetAxisMoveTime

Instruction · System and tasks

A RAPID instruction with 2 arguments.

ResetAxisMoveTime MechUnit, AxisNo;

Arguments: MechUnit mecunit, AxisNo num

ResetPPMoved

Instruction · System and tasks

A RAPID instruction.

ResetPPMoved;

ResetRetryCount

Instruction · System and tasks

A RAPID instruction.

ResetRetryCount;

ResetTorqueMargin

Instruction · System and tasks

A RAPID instruction with 2 arguments.

ResetTorqueMargin ,;

Arguments: mecunit, num

restartdata

Data type · Data types

A data type of the RAPID language with 15 components.

Components: restartstop bool, stoponpath bool, predo1val dionum, postdo1val dionum, prego1val num, postgo1val num, prego2val num, postgo2val num, prego3val num, postgo3val num, prego4val num, postgo4val num, preshadowval dionum, shadowflanks dionum, postshadowval dionum

RestoPath

Instruction · Motion

Restores the path saved with StorePath.

RestoPath;

RETRY

Instruction · Errors and recovery

In an error handler: runs the instruction that failed again.

RETRY;

RETURN

Instruction · Program flow

Ends the routine. A function returns its value with it.

RETURN;
RETURN value;   ! in a function

Rewind

Instruction · Files and serial channels

Goes back to the start of a file.

Rewind;

RMQEmptyQueue

Instruction · Communication

A RAPID instruction.

RMQEmptyQueue;

RMQFindSlot

Instruction · Communication

A RAPID instruction with 2 arguments.

RMQFindSlot Slot, Name;

Arguments: Slot rmqslot, Name string

RMQGetMessage

Instruction · Communication

Takes the next message from the task's message queue.

RMQGetMessage Message;

Arguments: Message rmqmessage

RMQGetMsgData

Instruction · Communication

A RAPID instruction with 2 arguments.

RMQGetMsgData Message, Data;

Arguments: Message rmqmessage, Data anytype

RMQGetMsgHeader

Instruction · Communication

A RAPID instruction with 1 argument.

RMQGetMsgHeader Message;

Arguments: Message rmqmessage

Optional: \Header rmqheader

RMQGetSlotName

Function · Communication

A RAPID function with 1 argument.

RMQGetSlotName(Slot)

Arguments: Slot rmqslot

rmqheader

Data type · Data types

A data type of the RAPID language with 5 components.

Components: datatype string, ndim num, dim1 num, dim2 num, dim3 num

RMQReadWait

Instruction · Communication

A RAPID instruction with 1 argument.

RMQReadWait Message;

Arguments: Message rmqmessage

Optional: \TimeOut num

RMQSendMessage

Instruction · Communication

Sends a message to another task's message queue.

RMQSendMessage Slot, SendData;

Arguments: Slot rmqslot, SendData anytype

Optional: \UserDef num

RMQSendWait

Instruction · Communication

A RAPID instruction with 4 arguments.

RMQSendWait Slot, SendData, Message, ReceiveDataType;

Arguments: Slot rmqslot, SendData anytype, Message rmqmessage, ReceiveDataType anytype

Optional: \UserDef num, \Timeout num

robjoint

Data type · Data types

The angles of the robot's six axes, in degrees.

Components: rax_1 num, rax_2 num, rax_3 num, rax_4 num, rax_5 num, rax_6 num

RobName

Function · Data and maths

A RAPID function.

RobName()

RobOS

Instruction · System and tasks

Returns TRUE when the program runs on a real controller and FALSE in a virtual one.

robtarget

Data type · Data types

A position of the robot and its external axes: where the tool is, how it is turned, the robot's configuration and the external axes' positions.

Components: trans pos, x num, y num, z num, rot orient, q1 num, q2 num, q3 num, q4 num, robconf confdata, cf1 num, cf4 num, cf6 num, cfx num, extax extjoint, eax_a num, eax_b num, eax_c num, eax_d num, eax_e num, eax_f num

Round

Function · Data and maths

Returns a value rounded to a number of decimals.

Round(Val)

Arguments: Val num

Optional: \Dec num

RoundDnum

Function · Data and maths

A RAPID function with 1 argument.

RoundDnum(Val)

Arguments: Val dnum

Optional: \Dec num

RunMode

Function · System and tasks

Returns the running mode: continuous, a single cycle, or stepping.

RunMode()

Optional: \Main

SafetyControllerGetChecksum

Function · Data and maths

A RAPID function.

SafetyControllerGetChecksum()

SafetyControllerGetGroupChecksum

Function · Data and maths

A RAPID function with 1 argument.

SafetyControllerGetGroupChecksum(GroupName)

Arguments: GroupName string

SafetyControllerGetNextGroupName

Function · Data and maths

A RAPID function with 2 arguments.

SafetyControllerGetNextGroupName(listno, group_name)

Arguments: listno num, group_name string

SafetyControllerGetOpModePinCode

Function · Data and maths

A RAPID function.

SafetyControllerGetOpModePinCode()

SafetyControllerGetSWVersion

Function · Data and maths

A RAPID function.

SafetyControllerGetSWVersion()

SafetyControllerGetUserChecksum

Function · Data and maths

A RAPID function.

SafetyControllerGetUserChecksum()

SafetyControllerSyncRequest

Instruction · System and tasks

A RAPID instruction.

SafetyControllerSyncRequest;

Save

Instruction · System and tasks

Saves a program module to a file.

Save , ModuleName;

Arguments: taskid, ModuleName string

Optional: \FilePath string, \File string

SaveCfgData

Instruction · System and tasks

A RAPID instruction with 2 arguments.

SaveCfgData FilePath, Domain;

Arguments: FilePath string, Domain cfgdomain

Optional: \File string

SearchC

Instruction · Search and trigger

Moves the tool along an arc while watching a signal, and stores the position when it changes.

SearchC Signal, PersBool, CirPoint, ToPoint, Speed, Tool;

Arguments: Signal signaldi, PersBool bool, CirPoint robtarget, ToPoint robtarget, Speed speeddata, Tool tooldata

Optional: \Stop, \SStop, \Sup, \Flanks, \PosFlank, \NegFlank, \HighLevel, \LowLevel, \ID identno, \V num, \T num, \WObj wobjdata, \Corr, \TLoad loaddata

SearchExtJ

Instruction · Search and trigger

Moves external axes while watching a signal, and stores the position when it changes.

SearchExtJ Signal, PersBool, ToJointPos, Speed;

Arguments: Signal signaldi, PersBool bool, ToJointPos jointtarget, Speed speeddata

Optional: \Stop, \SStop, \Sup, \Flanks, \PosFlank, \NegFlank, \HighLevel, \LowLevel, \ID identno, \UseEOffs, \T num

SearchL

Instruction · Search and trigger

Moves the tool in a straight line while watching a signal. When the signal changes, the position is stored, and the robot stops or continues as the switches say. Used to find a part whose position varies.

SearchL Signal, PersBool, ToPoint, Speed, Tool;

Arguments: Signal signaldi, PersBool bool, ToPoint robtarget, Speed speeddata, Tool tooldata

Optional: \Stop, \SStop, \Sup, \Flanks, \PosFlank, \NegFlank, \HighLevel, \LowLevel, \ID identno, \V num, \T num, \WObj wobjdata, \Corr, \TLoad loaddata

SenDevice

Instruction · System and tasks

A RAPID instruction with 3 arguments.

SenDevice device, BlockNo, FileName;

Arguments: device string, BlockNo num, FileName string

sensorvardata

Data type · Data types

A data type of the RAPID language with 5 components.

Components: varnumber num, sensordatatype num, raw bool, scale num, value dnum

Set

Instruction · Inputs and outputs

Sets a digital output to 1.

Set Signal;

Arguments: Signal signaldo

SetAllDataVal

Instruction · Inputs and outputs

A RAPID instruction with 2 arguments.

SetAllDataVal Type, Value;

Arguments: Type string, Value anytype

Optional: \TypeMod string, \Object string, \Hidden

SetAO

Instruction · Inputs and outputs

Sets an analog output to a value.

SetAO Signal, Value;

Arguments: Signal signalao, Value num

SetDataSearch

Instruction · Inputs and outputs

A RAPID instruction with 1 argument.

SetDataSearch Type;

Arguments: Type string

Optional: \TypeMod string, \Object string, \PersSym, \VarSym, \ConstSym, \InTask, \InMod string, \InRout string, \GlobalSym, \LocalSym

SetDataVal

Instruction · Inputs and outputs

A RAPID instruction with 2 arguments.

SetDataVal Object, Value;

Arguments: Object string, Value anytype

Optional: \Block datapos, \TaskRef taskid, \TaskName string

SetDO

Instruction · Inputs and outputs

Sets a digital output to a value, optionally after a delay.

SetDO Signal, Value;

Arguments: Signal signaldo, Value dionum

Optional: \SDelay num

SetGO

Instruction · Inputs and outputs

Sets a group of digital outputs to a value.

SetGO Signal, Value, Dvalue;

Arguments: Signal signalgo, Value num, Dvalue dnum

Optional: \SDelay num

SetLeadThrough

Instruction · Inputs and outputs

A RAPID instruction.

SetLeadThrough;

Optional: \On, \Off, \NoStopMove, \NoStartMove, \NoClearPath

SetSysData

Instruction · System and tasks

Sets the tool, work object or load the system uses now.

SetSysData SourceObject;

Arguments: SourceObject anytype

Optional: \ObjectName string

SetupCyclicBool

Instruction · Inputs and outputs

A RAPID instruction with 2 arguments.

SetupCyclicBool Flag, Cond;

Arguments: Flag bool, Cond bool

Optional: \Signal signaldo

shapedata

Data type · Data types

The shape of a world zone.

signalai

Data type · Data types

An analog input signal.

signalao

Data type · Data types

An analog output signal.

signaldi

Data type · Data types

A digital input signal.

signaldo

Data type · Data types

A digital output signal.

signalgi

Data type · Data types

A group of digital inputs read as one number.

signalgo

Data type · Data types

A group of digital outputs written as one number.

SimCollision

Instruction · System and tasks

A RAPID instruction.

SimCollision;

Sin

Function · Data and maths

Returns the sine of an angle in degrees.

Sin(Angle)

Arguments: Angle num

SinDnum

Function · Data and maths

A RAPID function with 1 argument.

SinDnum(Angle)

Arguments: Angle dnum

SingArea

Instruction · Motion settings

Sets how the robot moves near a wrist singularity: with a small change of orientation allowed, or not.

SingArea;

Optional: \Wrist, \LockAxis4, \Off

SkipWarn

Instruction · Errors and recovery

Leaves the last warning out of the event log.

SkipWarn;

SocketAccept

Instruction · Communication

Accepts a connection on a listening socket.

SocketAccept Socket, ClientSocket;

Arguments: Socket socketdev, ClientSocket socketdev

Optional: \ClientAddress string, \Time num

SocketBind

Instruction · Communication

Binds a socket to an address and port of the controller.

SocketBind Socket, LocalAddress, LocalPort;

Arguments: Socket socketdev, LocalAddress string, LocalPort num

SocketClose

Instruction · Communication

Closes a socket.

SocketClose Socket;

Arguments: Socket socketdev

SocketConnect

Instruction · Communication

Connects a socket to a server.

SocketConnect Socket, Address, Port;

Arguments: Socket socketdev, Address string, Port num

Optional: \Time num

SocketCreate

Instruction · Communication

Makes a network socket for the program to use.

SocketCreate Socket;

Arguments: Socket socketdev

Optional: \UDP, \ISOLatin1Encoding

SocketGetStatus

Function · Communication

Returns the state of a socket.

SocketGetStatus(Socket)

Arguments: Socket socketdev

SocketListen

Instruction · Communication

Lets a socket accept connections.

SocketListen Socket;

Arguments: Socket socketdev

SocketPeek

Function · Communication

A RAPID function with 1 argument.

SocketPeek(Socket)

Arguments: Socket socketdev

SocketReceive

Instruction · Communication

Receives data through a socket.

SocketReceive Socket;

Arguments: Socket socketdev

Optional: \Str string, \RawData rawbytes, \Data, \ReadNoOfBytes num, \NoRecBytes num, \Time num, \ISOLatin1Encoding

SocketReceiveFrom

Instruction · Communication

A RAPID instruction with 3 arguments.

SocketReceiveFrom Socket, RemoteAddress, RemotePort;

Arguments: Socket socketdev, RemoteAddress string, RemotePort num

Optional: \Str string, \RawData rawbytes, \Data, \ReadNoOfBytes num, \NoRecBytes num, \Time num, \ISOLatin1Encoding

SocketSend

Instruction · Communication

Sends data through a socket.

SocketSend Socket;

Arguments: Socket socketdev

Optional: \Str string, \RawData rawdata, \Data, \NoOfBytes num, \ISOLatin1Encoding

SocketSendTo

Instruction · Communication

A RAPID instruction with 3 arguments.

SocketSendTo Socket, RemoteAddress, RemotePort;

Arguments: Socket socketdev, RemoteAddress string, RemotePort num

Optional: \Str string, \RawData rawdata, \Data, \NoOfBytes num, \ISOLatin1Encoding

SoftAct

Instruction · Motion settings

Makes one robot axis soft, so that it gives way to outside forces.

SoftAct Axis, Softness;

Arguments: Axis num, Softness num

Optional: \MechUnit mecunit, \Ramp num

SoftDeact

Instruction · Motion settings

Ends soft servo on every axis.

SoftDeact;

Optional: \Ramp num

speeddata

Data type · Data types

Speeds for a move: of the tool centre point, of its turning, and of external axes.

Components: v_tcp num, v_ori num, v_leax num, v_reax num

SpeedLimAxis

Instruction · Motion settings

A RAPID instruction with 3 arguments.

SpeedLimAxis MechUnit, AxisNo, AxisSpeed;

Arguments: MechUnit mecunit, AxisNo num, AxisSpeed num

SpeedLimCheckPoint

Instruction · Motion settings

A RAPID instruction with 1 argument.

SpeedLimCheckPoint RobSpeed;

Arguments: RobSpeed num

SpeedRefresh

Instruction · Motion settings

Changes the speed override of the move that is running.

SpeedRefresh Override;

Arguments: Override num

SpotJ

Instruction · System and tasks

A RAPID instruction with 4 arguments.

SpotJ ToPoint, Speed, Spot, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Spot spotdata, Tool tooldata

Optional: \InPos stoppointdata, \NoConc, \Retract, \WObj wobjdata, \TLoad loaddata

SpotL

Instruction · System and tasks

A RAPID instruction with 4 arguments.

SpotL ToPoint, Speed, Spot, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Spot spotdata, Tool tooldata

Optional: \InPos stoppointdata, \NoConc, \Retract, \WObj wobjdata, \TLoad loaddata

SpotMC

Instruction · System and tasks

A RAPID instruction with 5 arguments.

SpotMC CirPoint, ToPoint, Speed, Spot, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Spot spotdata, Tool tooldata

Optional: \Sup, \Retract, \InPos stoppointdata, \WObj wobjdata, \TLoad loaddata

SpotML

Instruction · System and tasks

A RAPID instruction with 4 arguments.

SpotML ToPoint, Speed, Spot, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Spot spotdata, Tool tooldata

Optional: \Sup, \Retract, \InPos stoppointdata, \WObj wobjdata, \TLoad loaddata

SpyStart

Instruction · System and tasks

A RAPID instruction with 1 argument.

SpyStart File;

Arguments: File string

SpyStop

Instruction · System and tasks

A RAPID instruction.

SpyStop;

Sqrt

Function · Data and maths

Returns the square root.

Sqrt(Value)

Arguments: Value num

SqrtDnum

Function · Data and maths

A RAPID function with 1 argument.

SqrtDnum(Value)

Arguments: Value dnum

StartLoad

Instruction · System and tasks

Starts loading a program module in the background.

StartLoad FilePath, LoadNo;

Arguments: FilePath string, LoadNo loadsession

Optional: \Dynamic, \File string

StartMove

Instruction · Motion

Starts the robot moving again after StopMove or after a stop in an error handler.

StartMove;

Optional: \AllMotionTasks

StartMoveRetry

Instruction · Motion

Starts the movement again and retries the instruction that failed, in one step. Used in error handlers.

StartMoveRetry;

STCalcForce

Function · Data and maths

A RAPID function with 2 arguments.

STCalcForce(ToolName, MotorTorque)

Arguments: ToolName string, MotorTorque num

STCalcTorque

Function · Data and maths

A RAPID function with 2 arguments.

STCalcTorque(ToolName, TipForce)

Arguments: ToolName string, TipForce num

STCalib

Instruction · System and tasks

A RAPID instruction with 1 argument.

STCalib ToolName;

Arguments: ToolName string

Optional: \ToolChg, \TipChg, \TipWear, \RetPosAdj, \PrePos num, \Conc

STClose

Instruction · System and tasks

A RAPID instruction with 3 arguments.

STClose ToolName, Tipforce, Thickness;

Arguments: ToolName string, Tipforce num, Thickness num

Optional: \Conc

StepBwdPath

Instruction · System and tasks

A RAPID instruction with 2 arguments.

StepBwdPath StepLength, StepTime;

Arguments: StepLength num, StepTime num

STIsCalib

Function · Data and maths

A RAPID function with 1 argument.

STIsCalib(ToolName)

Arguments: ToolName string

Optional: \sguninit, \sgunsynch

STIsClosed

Function · Data and maths

A RAPID function with 1 argument.

STIsClosed(ToolName)

Arguments: ToolName string

Optional: \RetThickness

STIsIndGun

Function · Data and maths

A RAPID function with 1 argument.

STIsIndGun(ToolName)

Arguments: ToolName string

STIsOpen

Function · Data and maths

A RAPID function with 1 argument.

STIsOpen(ToolName)

Arguments: ToolName string

Optional: \RetTipWear, \RetPosAdj

SToolRotCalib

Instruction · System and tasks

A RAPID instruction with 4 arguments.

SToolRotCalib RefTip, ZPos, XPos, Tool;

Arguments: RefTip robtarget, ZPos robtarget, XPos robtarget, Tool tooldata

SToolTCPCalib

Instruction · System and tasks

A RAPID instruction with 7 arguments.

SToolTCPCalib Pos1, Pos2, Pos3, Pos4, Tool, MaxErr, MeanErr;

Arguments: Pos1 robtarget, Pos2 robtarget, Pos3 robtarget, Pos4 robtarget, Tool tooldata, MaxErr num, MeanErr num

Stop

Instruction · Program flow

Stops the program. It can be started again from the next instruction.

Stop;

Optional: \NoRegain, \AllMoveTasks

STOpen

Instruction · System and tasks

A RAPID instruction with 1 argument.

STOpen ToolName;

Arguments: ToolName string

Optional: \WaitZeroSpeed, \Conc

StopMove

Instruction · Motion

Stops the robot's movement. The move is not cancelled: StartMove continues it from where it stopped.

StopMove;

Optional: \AllMotionTasks

StopMoveReset

Instruction · Motion

Clears the stopped state set by StopMove so that a new movement can start without StartMove.

StopMoveReset;

Optional: \AllMotionTasks

stoppointdata

Data type · Data types

How a fine point ends: in position, standing still, or after a time.

Components: type stoppoint, progsynch bool, inpos inposdata, position num, speed num, mintime num, maxtime num, stoptime num, followtime num

StorePath

Instruction · Motion

Saves the current path so that the robot can make other moves, for example in an interrupt or error handler, and come back.

StorePath;

Optional: \KeepSync

StrFind

Function · Strings

Returns the position of the first character of a set found in a string.

StrFind(Str, ChPos, Set)

Arguments: Str string, ChPos num, Set string

Optional: \NotInSet

StrFormat

Function · Strings

A RAPID function with 1 argument.

StrFormat(Text)

Arguments: Text string

Optional: \Arg1 string, \Arg2 string, \Arg3 string, \Arg4 string, \Arg5 string, \Arg6 string, \Remaining, \SmartTruncate string

string

Data type · Data types

Text of up to 80 characters.

StrLen

Function · Strings

Returns the number of characters in a string.

StrLen(Str)

Arguments: Str string

StrMap

Function · Strings

Returns a string with characters replaced, character for character.

StrMap(Str, FromMap, ToMap)

Arguments: Str string, FromMap string, ToMap string

StrMatch

Function · Strings

Returns the position where a pattern is found in a string.

StrMatch(Str, ChPos, Pattern)

Arguments: Str string, ChPos num, Pattern string

StrMemb

Function · Strings

Returns TRUE when a character of a string belongs to a set.

StrMemb(Str, ChPos, Set)

Arguments: Str string, ChPos num, Set string

StrOrder

Function · Strings

Returns TRUE when two strings are in order.

StrOrder(Str1, Str2, Order)

Arguments: Str1 string, Str2 string, Order string

StrPart

Function · Strings

Returns part of a string, from a position and of a length.

StrPart(Str, ChPos, Len)

Arguments: Str string, ChPos num, Len num

StrSize

Function · Strings

A RAPID function with 1 argument.

StrSize(Str)

Arguments: Str string

StrToByte

Function · Strings

Converts a string to a byte.

StrToByte(ConStr)

Arguments: ConStr string

Optional: \Hex, \Okt, \Bin, \Char

StrToVal

Function · Strings

Reads a value of any type from its text, and returns TRUE when the text could be read.

StrToVal(Str)

Arguments: Str string

STTune

Instruction · System and tasks

A RAPID instruction with 3 arguments.

STTune MecUnit, TuneValue, Type;

Arguments: MecUnit mecunit, TuneValue num, Type tunegtype

STTuneReset

Instruction · System and tasks

A RAPID instruction with 1 argument.

STTuneReset MecUnit;

Arguments: MecUnit mecunit

syncident

Data type · Data types

A synchronisation point for WaitSyncTask and SyncMoveOn.

SyncMoveOff

Instruction · Program flow

Ends synchronised moves.

SyncMoveOff SyncID;

Arguments: SyncID syncident

Optional: \TimeOut num

SyncMoveOn

Instruction · Program flow

Starts moves synchronised between robots in different tasks.

SyncMoveOn SyncID;

Arguments: SyncID syncident

Optional: \TimeOut num

SyncMoveResume

Instruction · System and tasks

A RAPID instruction.

SyncMoveResume;

SyncMoveSuspend

Instruction · System and tasks

A RAPID instruction.

SyncMoveSuspend;

SyncMoveUndo

Instruction · System and tasks

A RAPID instruction.

SyncMoveUndo;

SystemStopAction

Instruction · System and tasks

A RAPID instruction.

SystemStopAction;

Optional: \Stop, \StopBlock, \Halt

Tan

Function · Data and maths

Returns the tangent of an angle in degrees.

Tan(Angle)

Arguments: Angle num

TanDnum

Function · Data and maths

A RAPID function with 1 argument.

TanDnum(Angle)

Arguments: Angle dnum

taskid

Data type · Data types

A task of the controller.

TaskIsActive

Function · System and tasks

A RAPID function with 2 arguments.

TaskIsActive(TaskRef, TaskName)

Arguments: TaskRef taskid, TaskName string

TaskIsExecuting

Function · System and tasks

A RAPID function with 2 arguments.

TaskIsExecuting(TaskRef, TaskName)

Arguments: TaskRef taskid, TaskName string

TaskRunMec

Function · System and tasks

A RAPID function.

TaskRunMec()

TaskRunRob

Function · System and tasks

A RAPID function.

TaskRunRob()

tasks

Data type · Data types

A list of tasks that synchronise with each other.

Components: taskname string

TasksInSync

Function · System and tasks

A RAPID function.

TasksInSync()

TEST

Instruction · Program flow

Runs one of several blocks of instructions, chosen by the value of an expression, with a DEFAULT block for any other value.

TEST expression
CASE value1, value2:
  ...
DEFAULT:
  ...
ENDTEST

TestAndSet

Function · Data and maths

A RAPID function.

TestAndSet()

TestDI

Function · Inputs and outputs

Returns TRUE when a digital input is set.

TestDI(Signal)

Arguments: Signal signaldi

TestSignDefine

Instruction · System and tasks

A RAPID instruction with 5 arguments.

TestSignDefine Channel, SignalId, MechUnit, Axis, SampleTime;

Arguments: Channel num, SignalId testsignal, MechUnit mecunit, Axis num, SampleTime num

TestSignRead

Function · Data and maths

A RAPID function with 1 argument.

TestSignRead(Channel)

Arguments: Channel num

TestSignReset

Instruction · System and tasks

A RAPID instruction.

TestSignReset;

TextGet

Function · Data and maths

A RAPID function with 2 arguments.

TextGet(Table, Index)

Arguments: Table num, Index num

Optional: \Arg1 string, \Arg2 string, \Arg3 string, \Arg4 string, \Arg5 string, \Arg6 string, \Remaining, \SmartTruncate string

TextTabFreeToUse

Function · Data and maths

A RAPID function with 1 argument.

TextTabFreeToUse(TableName)

Arguments: TableName string

TextTabGet

Function · Data and maths

A RAPID function with 1 argument.

TextTabGet(TableName)

Arguments: TableName string

TextTabInstall

Instruction · System and tasks

A RAPID instruction with 1 argument.

TextTabInstall File;

Arguments: File string

tooldata

Data type · Data types

A tool: whether the robot holds it, its frame from the robot's flange, and its load.

TPErase

Instruction · FlexPendant

Clears the text written on the FlexPendant.

TPErase;

TPReadDnum

Instruction · FlexPendant

Asks the operator for a dnum.

TPReadDnum TPText;

Arguments: TPText string

Optional: \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag

TPReadFK

Instruction · FlexPendant

Shows a message with up to five function keys and waits for the operator to press one.

TPReadFK TPText, TPFK1, TPFK2, TPFK3, TPFK4, TPFK5;

Arguments: TPText string, TPFK1 string, TPFK2 string, TPFK3 string, TPFK4 string, TPFK5 string

Optional: \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag

TPReadNum

Instruction · FlexPendant

Asks the operator for a number.

TPReadNum TPText;

Arguments: TPText string

Optional: \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag

TPShow

Instruction · FlexPendant

Shows one of the FlexPendant's windows.

TPShow Window;

Arguments: Window tpnum

TPWrite

Instruction · FlexPendant

Writes a line of text, and optionally a value, on the FlexPendant.

TPWrite TPText;

Arguments: TPText string

Optional: \Num num, \Bool bool, \Pos pos, \Orient orient, \Dnum dnum

TriggAbsJ

Instruction · Search and trigger

A RAPID instruction with 5 arguments.

TriggAbsJ ToJointPos, Speed, Trigg_1, Zone, Tool;

Arguments: ToJointPos jointtarget, Speed speeddata, Trigg_1 triggdata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \NoEoffs, \T num, \T2 triggdata, \T3 triggdata, \T4 triggdata, \T5 triggdata, \T6 triggdata, \T7 triggdata, \T8 triggdata, \KeepStartPath num, \KeepEndPath num, \Inpos stoppointdata, \WObj wobjdata, \TLoad loaddata

TriggC

Instruction · Search and trigger

A circular move that carries out trigger events along the path.

TriggC CirPoint, ToPoint, Speed, Trigg_1, Zone, Tool;

Arguments: CirPoint robtarget, ToPoint robtarget, Speed speeddata, Trigg_1 triggdata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \T num, \T2 triggdata, \T3 triggdata, \T4 triggdata, \T5 triggdata, \T6 triggdata, \T7 triggdata, \T8 triggdata, \KeepStartPath num, \KeepEndPath num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \TLoad loaddata

TriggCheckIO

Instruction · Search and trigger

Defines a trigger event that checks a signal at a point along the move and raises an interrupt if it is not as expected.

TriggCheckIO TriggData, Distance, Signal, Relation, CheckValue, CheckDvalue, Interrupt;

Arguments: TriggData triggdata, Distance num, Signal anytype, Relation opnum, CheckValue num, CheckDvalue dnum, Interrupt intnum

Optional: \Start, \Next, \Time, \StopMove, \Inhib bool, \Mode triggmode

triggdata

Data type · Data types

A trigger event, defined with TriggIO, TriggEquip or TriggInt and carried out by TriggL, TriggJ or TriggC.

TriggDataCopy

Instruction · Search and trigger

A RAPID instruction with 2 arguments.

TriggDataCopy Source, Destination;

Arguments: Source triggdata, Destination triggdata

TriggDataReset

Instruction · Search and trigger

A RAPID instruction with 1 argument.

TriggDataReset TriggData;

Arguments: TriggData triggdata

TriggDataValid

Function · Search and trigger

A RAPID function with 1 argument.

TriggDataValid(TriggData)

Arguments: TriggData triggdata

TriggEquip

Instruction · Search and trigger

Defines a trigger event that sets an output, allowing for the time the equipment takes to react.

TriggEquip TriggData, Distance, EquipLag, SetValue, SetDvalue;

Arguments: TriggData triggdata, Distance num, EquipLag num, SetValue num, SetDvalue dnum

Optional: \Start, \Next, \DOp signaldo, \GOp signalgo, \AOp signalao, \ProcID num, \Inhib bool, \InhibSetValue anytype, \Mode triggmode

TriggInt

Instruction · Search and trigger

Defines a trigger event that raises an interrupt at a point along the move.

TriggInt TriggData, Distance, Interrupt;

Arguments: TriggData triggdata, Distance num, Interrupt intnum

Optional: \Start, \Next, \Time, \Inhib bool, \Mode triggmode

TriggIO

Instruction · Search and trigger

Defines a trigger event that sets an output at a distance or time along the move it is used with.

TriggIO TriggData, Distance, SetValue, SetDvalue;

Arguments: TriggData triggdata, Distance num, SetValue num, SetDvalue dnum

Optional: \Start, \Time, \DOp signaldo, \GOp signalgo, \AOp signalao, \ProcID num, \DODelay num, \Inhib bool, \InhibSetValue anytype, \Mode triggmode

triggios

Data type · Data types

A data type of the RAPID language with 6 components.

Components: used bool, distance num, start bool, equiplag num, signalname string, setvalue num

triggiosdnum

Data type · Data types

A data type of the RAPID language with 6 components.

Components: used bool, distance num, start bool, equiplag num, signalname string, setvalue dnum

TriggJ

Instruction · Search and trigger

An axis-wise move that carries out trigger events along the path.

TriggJ ToPoint, Speed, Trigg_1, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Trigg_1 triggdata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \T num, \T2 triggdata, \T3 triggdata, \T4 triggdata, \T5 triggdata, \T6 triggdata, \T7 triggdata, \T8 triggdata, \KeepStartPath num, \KeepEndPath num, \Inpos stoppointdata, \WObj wobjdata, \TLoad loaddata

TriggJIOs

Instruction · Search and trigger

An axis-wise move that sets several outputs at given points along the path.

TriggJIOs ToPoint, Speed, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \T num, \TriggData1, \TriggData3, \KeepStartPath num, \KeepEndPath num, \Inpos stoppointdata, \WObj wobjdata, \TLoad loaddata

TriggL

Instruction · Search and trigger

A straight-line move that carries out trigger events, such as setting outputs, at given distances or times along the path.

TriggL ToPoint, Speed, Trigg_1, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Trigg_1 triggdata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \T num, \T2 triggdata, \T3 triggdata, \T4 triggdata, \T5 triggdata, \T6 triggdata, \T7 triggdata, \T8 triggdata, \KeepStartPath num, \KeepEndPath num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \TLoad loaddata, \FollowConveyor

TriggLIOs

Instruction · Search and trigger

A straight-line move that sets several outputs at given points along the path.

TriggLIOs ToPoint, Speed, Zone, Tool;

Arguments: ToPoint robtarget, Speed speeddata, Zone zonedata, Tool tooldata

Optional: \Conc, \ID identno, \T num, \TriggData1, \TriggData3, \KeepStartPath num, \KeepEndPath num, \Inpos stoppointdata, \WObj wobjdata, \Corr, \TLoad loaddata

TriggRampAO

Instruction · Search and trigger

Defines a ramp of an analog output along the move.

TriggRampAO TriggData, Distance, EquipLag, AOutput, SetValue, RampLength;

Arguments: TriggData triggdata, Distance num, EquipLag num, AOutput signalao, SetValue num, RampLength num

Optional: \Start, \Next, \Time, \Inhib bool, \InhibSetValue anytype, \Mode triggmode

TriggSpeed

Instruction · Search and trigger

Defines an analog output that follows the speed of the tool, for example to control a glue flow.

TriggSpeed TriggData, Distance, ScaleLag, AOp, ScaleValue;

Arguments: TriggData triggdata, Distance num, ScaleLag num, AOp signalao, ScaleValue num

Optional: \Start, \Next, \DipLag num, \ErrDO, \Inhib, \InhibSetValue anytype, \Mode triggmode

TriggStopProc

Instruction · Search and trigger

Watches the trigger outputs so that they are set to safe values if the robot stops.

TriggStopProc RestartRef;

Arguments: RestartRef restartdata

Optional: \DO1 signaldo

Trunc

Function · Data and maths

Returns a value cut to a number of decimals.

Trunc(Val)

Arguments: Val num

Optional: \Dec num

TruncDnum

Function · Data and maths

A RAPID function with 1 argument.

TruncDnum(Val)

Arguments: Val dnum

Optional: \Dec num

TryInt

Instruction · System and tasks

A RAPID instruction with 2 arguments.

TryInt DataObj, DataObj2;

Arguments: DataObj num, DataObj2 dnum

TRYNEXT

Instruction · Errors and recovery

In an error handler: carries on with the instruction after the one that failed.

TRYNEXT;

TuneReset

Instruction · Motion settings

Puts the servo tuning back to its normal values.

TuneReset;

TuneServo

Instruction · Motion settings

Adjusts the servo tuning of an axis.

TuneServo MecUnit, Axis, TuneValue;

Arguments: MecUnit mecunit, Axis num, TuneValue num

Optional: \Type tunetype

Type

Function · Data and maths

A RAPID function with 1 argument.

Type(Data)

Arguments: Data anytype

Optional: \BaseName

UIAlphaEntry

Function · FlexPendant

Asks the operator for text.

UIAlphaEntry()

Optional: \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \InitString string, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIClientExist

Function · FlexPendant

A RAPID function.

UIClientExist()

UIDisplay

Instruction · FlexPendant

A RAPID instruction with 1 argument.

UIDisplay ID;

Arguments: ID string

Optional: \Args string, \InstanceId uidisplaynum, \Status uidisplaystatus

UIDnumEntry

Function · FlexPendant

A RAPID function with 1 argument.

UIDnumEntry(Message)

Arguments: Message string

Optional: \Header string, \MsgArray, \Wrap, \Icon icondata, \Image string, \InitValue dnum, \MinValue dnum, \MaxValue dnum, \AsInteger, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIDnumTune

Function · FlexPendant

A RAPID function with 2 arguments.

UIDnumTune(InitValue, Increment)

Arguments: InitValue dnum, Increment dnum

Optional: \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \MinValue dnum, \MaxValue dnum, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIListView

Function · FlexPendant

Shows a list on the FlexPendant and returns the item picked.

UIListView()

Arguments: string

Optional: \Buttons buttondata, \BtnArray, \Icon icondata, \DefaultIndex num, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIMessageBox

Function · FlexPendant

Shows a message with buttons on the FlexPendant and returns the button pressed.

UIMessageBox()

Optional: \Header string, \Message string, \MsgArray, \Wrap, \Buttons buttondata, \BtnArray, \DefaultBtn btnres, \Icon icondata, \Image string, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIMsgBox

Instruction · FlexPendant

Shows a message with buttons on the FlexPendant and waits for an answer.

UIMsgBox MsgLine1;

Arguments: MsgLine1 string

Optional: \Header string, \MsgLine2 string, \MsgLine3 string, \MsgLine4 string, \MsgLine5 string, \Wrap, \Buttons buttondata, \Icon icondata, \Image string, \Result, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIMsgWrite

Instruction · FlexPendant

A RAPID instruction with 2 arguments.

UIMsgWrite Header, Message;

Arguments: Header string, Message string

Optional: \Wrap, \Icon icondata, \Image string, \PersBool bool, \PersBoolName string, \AbortValue, \UIActiveSignal signaldo

UIMsgWriteAbort

Instruction · FlexPendant

A RAPID instruction.

UIMsgWriteAbort;

UINumEntry

Function · FlexPendant

Asks the operator for a number with a keypad, within limits.

UINumEntry(Message)

Arguments: Message string

Optional: \Header string, \MsgArray, \Wrap, \Icon icondata, \Image string, \InitValue dnum, \MinValue dnum, \MaxValue dnum, \AsInteger, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UINumTune

Function · FlexPendant

Lets the operator tune a number up and down.

UINumTune(Message, InitValue, Increment)

Arguments: Message string, InitValue num, Increment num

Optional: \Header string, \MsgArray, \Wrap, \Icon icondata, \Image string, \MinValue num, \MaxValue num, \MaxTime num, \DIBreak signaldi, \DIPassive, \DOBreak signaldo, \DOPassive, \PersBoolBreak bool, \PersBoolPassive, \BreakFlag, \UIActiveSignal signaldo

UIShow

Instruction · FlexPendant

Opens an application on the FlexPendant.

UnLoad

Instruction · System and tasks

Removes a program module loaded with Load or StartLoad.

UnLoad FilePath;

Arguments: FilePath string

Optional: \ErrIfChanged, \Save, \File string

UnpackRawBytes

Instruction · System and tasks

A RAPID instruction with 3 arguments.

UnpackRawBytes RawData, StartIndex, Value;

Arguments: RawData rawbytes, StartIndex num, Value anytype

Optional: \Network, \Hex1, \IntX inttypes, \Float4, \UTF8Encoding num, \ISOLatin1Encoding num

ValidIO

Function · Inputs and outputs

Returns TRUE when a signal can be used: it exists and its device is running.

ValidIO(Signal)

Arguments: Signal anytype

ValToBytes

Function · Data and maths

A RAPID function with 1 argument.

ValToBytes(Value)

Arguments: Value anytype

Optional: \StartIndex num

ValToStr

Function · Strings

Returns a value of any type written as a string.

ValToStr(Val)

Arguments: Val anytype

VectMagn

Function · Data and maths

A RAPID function with 1 argument.

VectMagn(Vector)

Arguments: Vector pos

VelSet

Instruction · Motion settings

Limits the speed of the robot: a percentage of the programmed speeds and a highest speed for the tool centre point.

VelSet Override, Max;

Arguments: Override num, Max num

WaitAI

Instruction · Inputs and outputs

Waits until an analog input is above or below a value.

WaitAI Signal, Value;

Arguments: Signal signalai, Value num

Optional: \LT, \GT, \MaxTime num, \ValueAtTimeout num, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitAO

Instruction · Inputs and outputs

Waits until an analog output is above or below a value.

WaitAO Signal, Value;

Arguments: Signal signalao, Value num

Optional: \LT, \GT, \MaxTime num, \ValueAtTimeout num, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitDI

Instruction · Inputs and outputs

Waits until a digital input has a value, optionally for a longest time.

WaitDI Signal, Value;

Arguments: Signal signaldi, Value dionum

Optional: \MaxTime num, \TimeFlag bool, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitDO

Instruction · Inputs and outputs

Waits until a digital output has a value.

WaitDO Signal, Value;

Arguments: Signal signaldo, Value dionum

Optional: \MaxTime num, \TimeFlag bool, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitGI

Instruction · Inputs and outputs

Waits until a group input has a value.

WaitGI Signal, Value, Dvalue;

Arguments: Signal signalgi, Value num, Dvalue dnum

Optional: \NOTEQ, \LT, \GT, \MaxTime num, \ValueAtTimeout num, \DvalueAtTimeout dnum, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitGO

Instruction · Inputs and outputs

Waits until a group output has a value.

WaitGO Signal, Value, Dvalue;

Arguments: Signal signalgo, Value num, Dvalue dnum

Optional: \NOTEQ, \LT, \GT, \MaxTime num, \ValueAtTimeout num, \DvalueAtTimeout dnum, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitLoad

Instruction · System and tasks

Waits for a module started with StartLoad, and links it into the program.

WaitLoad LoadNo;

Arguments: LoadNo loadsession

Optional: \UnloadPath string, \UnloadFile string, \CheckRef

WaitRob

Instruction · Motion

Waits until the robot and external axes have reached their target, with the zone or with zero speed.

WaitRob;

Optional: \InPos, \ZeroSpeed

WaitSyncTask

Instruction · Program flow

Waits until the other tasks named reach the same synchronisation point.

WaitSyncTask SyncID;

Arguments: SyncID syncident

Optional: \InPos, \TimeOut num

WaitTestAndSet

Instruction · Program flow

A RAPID instruction with 1 argument.

WaitTestAndSet Object;

Arguments: Object bool

WaitTime

Instruction · Program flow

Waits for a number of seconds.

WaitTime Time;

Arguments: Time num

Optional: \InPos

WaitUntil

Instruction · Program flow

Waits until a condition is true, optionally for a longest time.

WaitUntil Cond;

Arguments: Cond bool

Optional: \InPos, \MaxTime num, \TimeFlag bool, \PollRate num, \Visualize, \Header string, \Message string, \MsgArray, \Wrap, \Icon icondata, \Image string, \VisualizeTime num, \UIActiveSignal signaldo, \ErrorNumber, \TimeOutSignal signaldo, \TimeOutGOSignal signalgo, \TimeOutGOValue dnum

WaitWObj

Instruction · Program flow

A RAPID instruction with 1 argument.

WaitWObj WObj;

Arguments: WObj wobjdata

Optional: \RelDist num, \MaxTime num, \TimeFlag bool

WarmStart

Instruction · System and tasks

A RAPID instruction.

WarmStart;

WHILE

Instruction · Program flow

Repeats a block of instructions as long as a condition stays true.

WHILE condition DO
  ...
ENDWHILE

wobjdata

Data type · Data types

A work object: the frame the points are taught in, and whether the robot or a fixed fixture holds it.

Components: robhold bool, ufprog bool, ufmec string, uframe pose, trans pos, x num, y num, z num, rot orient, q1 num, q2 num, q3 num, q4 num, oframe pose

WorldAccLim

Instruction · Motion settings

Limits the acceleration in the world frame, for loads that must not be shaken.

WorldAccLim;

Optional: \On num, \Off

WristOpt

Instruction · System and tasks

A RAPID instruction with 6 arguments.

WristOpt Pos1, Pos2, Pos3, Pos4, CalPosAx4, CalPosAx5;

Arguments: Pos1 jointtarget, Pos2 jointtarget, Pos3 jointtarget, Pos4 jointtarget, CalPosAx4 num, CalPosAx5 num

Optional: \OptTool tooldata, \OptMaxErr num, \OptMeanErr num

Write

Instruction · Files and serial channels

Writes text and a value to a file or serial channel.

Write IODevice, String;

Arguments: IODevice iodev, String string

Optional: \Num num, \Bool bool, \Pos pos, \Orient orient, \Dnum dnum, \NoNewLine, \ISOLatin1Encoding

WriteAnyBin

Instruction · Files and serial channels

Writes data of any type to a binary file or serial channel.

WriteAnyBin IODevice, Data;

Arguments: IODevice iodev, Data anytype

WriteBin

Instruction · Files and serial channels

Writes bytes to a binary file or serial channel.

WriteBin IODevice, NChar;

Arguments: IODevice iodev, NChar num

WriteCfgData

Instruction · Files and serial channels

A RAPID instruction with 3 arguments.

WriteCfgData InstancePath, Attribute, CfgData;

Arguments: InstancePath string, Attribute string, CfgData anytype

Optional: \ListNo num

WriteRawBytes

Instruction · Files and serial channels

A RAPID instruction with 2 arguments.

WriteRawBytes IODevice, RawData;

Arguments: IODevice iodev, RawData rawbytes

Optional: \NoOfBytes num

WriteStrBin

Instruction · Files and serial channels

Writes a string to a binary file or serial channel.

WriteStrBin IODevice, Str;

Arguments: IODevice iodev, Str string

Optional: \ISOLatin1Encoding

WriteVar

Instruction · Files and serial channels

A RAPID instruction with 3 arguments.

WriteVar device, VarNo, VarData;

Arguments: device string, VarNo num, VarData num

Optional: \TaskName string

WriteVarArr

Instruction · Files and serial channels

A RAPID instruction with 1 argument.

WriteVarArr Device;

Arguments: Device string

Optional: \TaskName string

WZBoxDef

Instruction · World zones

Defines a world zone shaped as a box.

WZBoxDef LowPoint, Shape, HighPoint;

Arguments: LowPoint pos, Shape shapedata, HighPoint pos

WZCylDef

Instruction · World zones

Defines a world zone shaped as a cylinder.

WZCylDef Shape, CentrePoint, Radius, Height;

Arguments: Shape shapedata, CentrePoint pos, Radius num, Height num

Optional: \Inside, \Outside

WZDisable

Instruction · World zones

Stops the supervision of a temporary world zone.

WZDisable;

WZDOSet

Instruction · World zones

Starts supervision that sets an output while the robot is in a world zone.

WZDOSet Shape, Signal, SetValue;

Arguments: Shape shapedata, Signal signaldo, SetValue dionum

Optional: \Inside, \Before

WZEnable

Instruction · World zones

Starts the supervision of a temporary world zone again.

WZEnable;

WZFree

Instruction · World zones

Removes a temporary world zone.

WZFree;

WZHomeJointDef

Instruction · World zones

Defines a world zone of axis angles, for a home position.

WZHomeJointDef Shape, MiddleJointVal, DeltaJointVal;

Arguments: Shape shapedata, MiddleJointVal jointtarget, DeltaJointVal jointtarget

WZLimJointDef

Instruction · World zones

Defines a world zone of axis angles that limits where the axes may go.

WZLimJointDef Shape, LowJointVal, HighJointVal;

Arguments: Shape shapedata, LowJointVal jointtarget, HighJointVal jointtarget

WZLimSup

Instruction · World zones

Starts supervision that stops the robot before it enters a world zone.

WZLimSup Shape;

Arguments: Shape shapedata

WZSphDef

Instruction · World zones

Defines a world zone shaped as a sphere.

WZSphDef Shape, CentrePoint, Radius;

Arguments: Shape shapedata, CentrePoint pos, Radius num

wzstationary

Data type · Data types

A world zone that stays active while the controller runs.

wztemporary

Data type · Data types

A temporary world zone, which the program can switch off and on.

Components: wz num

XOR

Function · Data and maths

A RAPID function.

XOR()

zonedata

Data type · Data types

How close the robot must come to a point before it turns towards the next one. A fine point stops at the point.

Components: finep bool, pzone_tcp num, pzone_ori num, pzone_eax num, zone_ori num, zone_leax num, zone_reax num