Omron eV+3 Robotics Integrated Controller Reference guide

eV+3

Keyword Reference Manual

I652-E-03

Copyright Notice

The information contained herein is the property of Omron Robotics and Safety Technologies, Inc., and

shall not be reproduced in whole or in part without prior written approval of Omron Robotics and Safety

Technologies, Inc.. The information herein is subject to change without notice and should not be con-

strued as a commitment by Omron Robotics and Safety Technologies, Inc. The documentation is peri-

odically reviewed and revised.

Omron Robotics and Safety Technologies, Inc., assumes no responsibility for any errors or omissions in

the documentation.

Copyright  2020 Omron Robotics and Safety Technologies, Inc. by OMRON Corporation. All rights

reserved.

Sysmac and SYSMAC are trademarks or registered trademarks of OMRON Corporation in Japan and

other countries for OMRON factory automation products.

EtherCAT® is a registered trademark and patented technology, licensed by Beckhoff Automation GmbH,

Germany.

DeviceNet is a trademark of ODVA.

Other company names and product names in this document are the trademarks or registered trademarks

of their respective companies.

Created in the United States of America.

22353-000 Rev. C eV+3KeywordReferenceManual 3

Table of Contents

Chapter 1: Introduction 13

1.1 Intended Audience 13

1.2 Related Manuals 14

1.3 Alert Levels 14

1.4 Special Information 14

1.5 Keyword Syntax 15

1.6 Keyword Parameters 15

Parameter Data Type Designations 16

Numeric Parameters 16

Chapter 2: Keyword QuickReference 19

2.1 Function Keyword Summary 19

2.2 Monitor Command Keyword Summary 25

2.3 Other Keyword Summary 29

2.4 Program Command Keyword Summary 29

2.5 System Parameter Keyword Summary 36

2.6 System Switch Keyword Summary 37

Chapter 3: Keyword Details 39

3.1 Function Keywords 39

ABS 39

ACCEL 40

ACOS 42

ALIGN 44

ASC 45

ASIN 46

ATAN2 48

BASE 50

BCD 51

BELT 52

BITS 54

BMASK 56

BSTATUS 57

CAS 59

$CHR 60

COM 61

CONFIG 62

COS 67

CUBRT 69

$DBLB 70

DBLB 71

DCB 73

$DECODE 74

$DEFAULT 77

DEFINED 79

DEST 80

DEVICE 82

DISTANCE 84

DURATION 85

DX 87

DY 88

DZ 89

ENCLATCH 90

$ENCODE 91

$ERROR 94

ERROR 95

FALSE 100

$FLTB 101

FLTB 102

FRACT 104

FRAME 105

FREE 107

GETC 108

GET.EVENT 110

HERE 111

HOUR.METER 112

$ID 113

ID 114

IDENTICAL 124

INRANGE 125

$INTB 127

INT 128

INTB 130

INVERSE 132

IOSTAT 133

LAST 136

LATCH 138

LATCHED 139

LEN 141

$LNGB 142

LNGB 143

MAX 145

$MID 146

MIN 147

NETWORK 148

NORMAL 150

NOT 151

NULL 152

OFF 153

ON 154

OUTSIDE 155

PARAMETER 156

#PDEST 157

4 eV+3KeywordReferenceManual 22353-000 Rev. C

22353-000 Rev. C eV+3KeywordReferenceManual 5

#PHERE 158

PI 159

#PLATCH 160

POS 161

#PPOINT 162

PRIORITY 164

RANDOM 165

RX 166

RY 167

RZ 168

SCALE 169

SELECT 170

#SET.POINT 172

SHIFT 173

SIG.INS 174

SIGN 176

SIG 177

SIN 179

SOLVE.FLAGS 181

SPEED 183

SQRT 185

SQR 186

STATE 187

STATUS 195

STRDIF 197

SWITCH 199

TAN 200

TAS 201

TASK 204

$TIME 207

$TIME4 209

TIME 211

TIMER 213

TOOL 216

TPS 217

TRANS 218

$TRANSB 220

TRANSB 221

TRUE 222

$TRUNCATE 223

$UNPACK 224

VAL 226

VLOCATION 227

VPARAMETER 230

VRESULT 232

VSTATE 234

WINDOW 235

3.2 Monitor Command Keywords 238

ABORT 238

BASE 240

BITS 242

CALIBRATE 244

CD 247

COMMANDS 248

COPY 250

CYCLE.END 251

DEFAULT 253

DELETE 257

DELETEL 259

DELETEM 261

DELETEP 263

DELETER 265

DELETES 267

DIRECTORY 269

DISABLE 271

DO 273

ENABLE 275

ESTOP 277

EXECUTE 278

FCOPY 282

FDELETE 284

FDIRECTORY 286

FLIST 291

FREE 292

FRENAME 293

FSET 294

HERE 295

ID 297

IO 300

JOG 302

KILL 306

LIST 307

LISTL 309

LISTP 311

LISTR 312

LISTS 314

LOAD 316

MDIRECTORY 319

MODULE 321

NET 323

PANIC 326

PARAMETER 327

PING 329

PRIME 330

PROCEED 332

RENAME 334

RESET 335

RESET.LOCK 336

RETRY 337

SELECT 339

SIGNAL 341

SPEED 343

SRV.RESET 345

SSTEP 346

6 eV+3KeywordReferenceManual 22353-000 Rev. C

22353-000 Rev. C eV+3KeywordReferenceManual 7

STACK 348

STATUS 350

STORE 354

STOREL 356

STOREM 358

STOREP 360

STORER 362

STORES 364

SWITCH 366

TESTP 368

TOOL 369

WAIT.START 371

WHERE 373

XSTEP 374

ZERO 377

3.3 Other Keywords 379

.END 379

IPS 380

MMPS 381

3.4 Program Command Keywords 382

ABORT 382

ABOVE 384

ACCEL 386

ALIGN 389

ALTER 390

ALTOFF 392

ALTON 393

ANY 395

APPRO 396

APPROS 397

ATTACH 398

AUTO 402

BASE 405

BELOW 407

BITS 409

BRAKE 411

BREAK 412

BY 414

CALIBRATE 415

CALL 419

CALLS 422

CASE 424

CLEAR.EVENT 427

CLEAR.LATCHES 428

COARSE 429

CPOFF 431

CPON 433

CYCLE.END 435

DECOMPOSE 437

DEF.DIO 439

DEFBELT 441

DEPART 443

DEPARTS 445

DETACH 447

DISABLE 449

DO 451

DOS 453

DRIVE 455

DURATION 457

ELSE 459

ENABLE 460

END 462

ESTOP 464

EXECUTE 465

EXIT 469

EXTERNAL 470

FCLOSE 472

FCMND 473

FCOPY 477

FDELETE 479

FEMPTY 481

FINE 483

FLIP 485

FOPEN 488

FOPENA 491

FOPEND 494

FOPENR 497

FOPENW 500

FOR 503

FSEEK 505

FSET 507

GLOBAL 509

GOTO 511

HALT 512

HERE 513

IF ... GOTO 515

IF ... THEN 517

IGNORE 519

JMOVE 520

JOG 521

KEYMODE 525

KILL 527

LEFTY 528

LOCAL 530

LOCK 532

MC 534

MCS 536

MULTIPLE 538

MOVE 539

MOVEC 540

MOVES 547

NEXT 548

NOFLIP 549

8 eV+3KeywordReferenceManual 22353-000 Rev. C

22353-000 Rev. C eV+3KeywordReferenceManual 9

NONULL 550

NOOVERLAP 552

NULL 554

OVERLAP 556

PACK 558

PANIC 560

PARAMETER 561

PAUSE 563

PDNT.CLEAR 564

PDNT.NOTIFY 565

PDNT.WRITE 566

PENDANT 568

PROCEED 571

.PROGRAM 573

PROMPT 576

REACT 578

REACTE 581

REACTI 583

READY 589

RELEASE 591

RESET 592

RETRY 593

RETURN 595

RETURNE 596

RIGHTY 597

RUNSIG 599

SELECT 601

SET.EVENT 603

SET 604

SETBELT 606

SETDEVICE 608

SIGNAL 610

SINGLE 612

SOLVE.ANGLES 613

SOLVE.TRANS 620

SPEED 622

STOP 625

SWITCH 626

TIMER 628

TOOL 629

TYPE 630

UNTIL 633

VALUE 634

VPARAMETER 635

VRUN 637

VWAITI 638

WAIT 639

WAIT.EVENT 640

WHILE 643

WINDOW 645

WRITE 647

3.5 System Parameter Keywords 650

BELT.MODE 650

DEVIATION 653

JOG.TIME 654

NOT.CALIBRATED 655

VTIMEOUT 657

3.6 SystemSwitch Keywords 658

AUTO.POWER.OFF 658

CP 660

DECEL.100 661

DELAY.IN.TOL 662

DRY.RUN 664

MESSAGES 666

OBSTACLE 667

POWER 669

ROBOT 671

SCALE.ACCEL 673

SCALE.ACCEL.ROT 675

UPPER 676

10 eV+3KeywordReferenceManual 22353-000 Rev. C

Revision History

Revision

Code ReleaseDate Details

A July, 2020 Original release

B August, 2020 Minor corrections and updates

C October, 2020 Updates for Viper robots and minor corrections

22353-000 Rev. C eV+3KeywordReferenceManual 11

Chapter 1: Introduction

eV+ uses a special programming language and command set to send and request information

to and from the operating system. The keywords detailed in this manual are used when cre-

ating programs with Sysmac Studio and issuing commands from the Monitor Window in the

Sysmac Studio interface.

Additional Information: More information about keyword syntax, parameters,

and data types can be found in theeV+3 User'sManual (Cat.No. I651).

IMPORTANT: An error "Command not supported"will be returned if a

keyword is issued on a system that does not include the NJ-series Robot Integ-

rated CPUUnit as the Host System.

There are 6 different types of keywords that are used based on the functionality that is needed

as described below.

Table 1-1. eV+ Keyword Types

Keyword Type Usage

Functionkeywords Used to return values from the eV+ Operating System.

Monitor command

keywords

Used to issue individual operations in the Monitor Window or to cre-

ate Monitor Commandprograms.

Program command

keywords

Used to command operations in V+ Programs.

System parameter

keyword

Used to manipulate systemparameters in V+ Programs or with the

Monitor Window.

System switch

keywords

Used to manipulate system switches in V+ Programs or with

theMonitor Window.

Other keywords Used to specify units when using the SPEEDprogram command

keyword.

Refer to the eV+3 User'sManual (Cat.No. I651) for more inform-

ation.

1.1 Intended Audience

This manual is intended for the following personnel, who must also have knowledge of com-

mon programming practices and robotic control methods.

lPersonnel in charge of introducing FA systems.

lPersonnel in charge of designing FA systems.

lPersonnel in charge of installing and maintaining FA systems.

lPersonnel in charge of managing FA systems and facilities.

22353-000 Rev. C eV+3KeywordReferenceManual 13

14 eV+3KeywordReferenceManual 22353-000 Rev. C

1.2 Related Manuals

1.2 Related Manuals

Use the following related manuals for reference.

Table 1-2. Related Manuals

Manual Description

eV+3 User'sManual (Cat.No. I651) Provides information that is necessary to use

eV+.

Sysmac Studio Robot Integrated System Build-

ing Function with Robot Integrated CPU Unit

Operation Manual (Cat. No. W595)

Learning about the operating procedures and

functions of the Sysmac Studio to configure

Robot Integrated System using Robot Integ-

rated CPU Unit.

Robot User Guides User Guide for the robot in use.

T20 Pendant User's Manual (Cat. No. I601) Describes the use of the optional T20 manual

control pendant.

NJ-series Robot Integrated CPUUnit

User'sManual (Cat. No. O037)

Describes the settings and operation of the

CPU Unit and programming concepts for

OMRON robot control.

Robot Safety Guide (Cat. No. I590) Contains safety information forOMRON indus-

trial robots.

1.3 Alert Levels

The following alert levels are used throughout this document.

!

DANGER: Identifies an imminently hazardous situation which, if not

avoided, is likely to result in serious injury, and might result in death or severe

property damage.

!

WARNING: Identifies a potentially hazardous situation which, if not avoided,

will result in minor or moderate injury, and might result in serious injury,

death, or significant property damage.

!

CAUTION: Identifies a potentially hazardous situation which, if not avoided,

might result in minor injury, moderate injury, or property damage.

1.4 Special Information

The following notation is used throughout this document to indicate special information.

IMPORTANT: Information to ensure safe use of the product.

Chapter 1: Introduction

NOTE: Information for more effective use of the product.

Additional Information: Helpful tips, recommendations, and best practices.

1.5 Keyword Syntax

Use the following guidelines with the keyword syntax provided in this manual.

lKeywords are presented with uppercase text and parameters are presented with lower-

case text.

lAny parentheses, brackets, and commas must be used exactly as shown.

lBold text represents required syntax and non-bold text represents optional syntax.

lCommas must be present between consecutive parameters.

lBlank spaces are not evaluated by the system and extra spaces or missing spaces do not

cause syntax problems.

Use the following example to understand how keyword syntax is presented in this manual.

KEYWORD req_param1 = req_param2 SECONDARY.KEYWORD opt_param1, opt_param2

Table 1-3. Keyword Syntax Details

Item Details

KEYWORD Required and must be entered exactly as shown.

req_param1 Required and must be replaced with a value, variable, or expres-

sion.

=Assignment operator. If required, follows the keyword and / or

parameters.

req_param2 Required when an equal sign is present and must be replaced with

a value, variable, or expression.

SECONDARY.KEYWORD If present, required and must be entered exactly as shown.

opt_param1, opt_param2 Optional and if used, must be replaced with a value, variable, or

expression.

1.6 Keyword Parameters

This section describes parameters and how they are used withkeyword syntax.

NOTE: Do not confuse keyword parameters with system parameter keywords.

Refer to System Parameter Keywords on page 650 for more information.

Parameters are considered arguments to keywords. Keywords may have multiple required and

optional parameters. Some keywords do not use any parameters such as BREAK or FALSE .

22353-000 Rev. C eV+3KeywordReferenceManual 15

16 eV+3KeywordReferenceManual 22353-000 Rev. C

1.6 Keyword Parameters

When an optional parameter is omitted, the system will assume a default. Omitting an

optional parameter that is in the middle of the keyword's syntax must respect the use of any

necessary commas, as shown below.

CALL program_name(1, , n+3)

If an the optional parameter is trailing, it can be removed if unused. Consider the CALL

keyword shown with the syntax structure CALL program(arg_list). If this keyword is used to

simply execute a new subroutine program without passing arguments, the syntax would be as

follows.

CALL program_name

Parameter Data Type Designations

The data type of the constant or variable must be the same type that is required by the

keyword. String and numeric parameters can be constant values or any valid variable names.

Use the following rules to designate parameter data types used in keyword syntax.

lString variables must be preceded with the $symbol and string constants must be

enclosed in quotes.

lPrecision Point variables must be preceded with a # symbol.

lBelt variables must be preceded with a % symbol.

lReal and integer constants can be used without modification.

Additional Information: Keywords cannot be used as variable names or pro-

gram names.

Numeric Parameters

Several types of numeric parameters can appear in keyword syntax. For each type of para-

meter, the value can generally be specified by a numeric constant, a variable name, or a math-

ematical expression. There are some restrictions on the numeric values that are accepted by

eV+. The following rules determine how a value will be interpreted in the various situations.

lDistances are used to define locations to where a robot is to move. The unit of measure

for distances is in millimeters, although units are never explicitly entered for any value.

Values entered for distances can be positive or negative. Refer to theIPS keyword for a

special case of specifying robot speed in inches/s.

lJoint numbers are integers from 1 up to the number of joints in the robot. Refer to the

robot User's Guide for information about robot joint numbering arrangements.

lSignal numbers are used to identify digital signals. They are always considered as

integer values. A negative signal number indicates an OFF state. Refer to the appro-

priate robot user's guide and the eV+3 User'sManual (Cat.No. I651) for more information

about signal numbers for your particular robot.

lInteger parameters can be satisfied with real values (values with integer and fractional

parts). When an integer is required, the value is rounded and the resulting integer is

used.

lParameters indicated as being scalar variables can be satisfied with a real value (with

integer and fractional parts) except where noted. Scalar variables can range from -

Chapter 1: Introduction

9.22*1018 to 9.22*1018 in value (displayed as -9.22E18 and 9.22E18). Numbers declared

to be double-precision values can range from -1.8*10-307 to 1.8*10-307.

All numbers in this manual are decimal unless otherwise noted. Binary numbers are shown as

^B, octal numbers as ^, and hexadecimal numbers as ^H.

22353-000 Rev. C eV+3KeywordReferenceManual 17

Chapter 2: Keyword QuickReference

Use the sections below as a quick reference to all keywords described in this document.

2.1 Function Keyword Summary

The table below provides a summary of all function keywords.

Keyword Description Reference

ABS Real-valued function that returns the absolute value (mag-

nitude) of the argument provided.

Page 39

ACCEL Real-valued function that returns the current setting for robot

acceleration, deceleration, or the maximum allowable per-

centage limits defined in the robot configuration profile.

Page 40

ACOS Real-valued function that returns the arc cosine of its argu-

ment.

Page 42

ALIGN Transformation function that aligns the input location with the

nearest axis of the world coordinate system.

Page 44

ASC Real-valued function that returns an ASCII character value

from within a string.

Page 45

ASIN Real-valued function that returns the arc sine of its argument. Page 46

ATAN2 Real-valued function that returns the size of the angle in

degrees that has its trigonometric tangent equal to value_

1/value_2.

Page 48

BASE Transformation function that returns the transformation value

that represents the translation and rotation set by the last

BASE program command or monitor command.

Page 50

BCD Real-valued function that converts a real value to Binary Coded

Decimal (BCD) format.

Page 51

BELT Real-valued function that returns information about a con-

veyor belt being tracked with the conveyor tracking feature.

Page 52

BITS Real-valued function that reads multiple digital signals and

returns the value corresponding to the binary bit pattern.

Page 54

BMASK Real-valued function that creates a bit mask by setting indi-

vidual bits.

Page 56

BSTATUS Real-valued function that returns information about the status

of the conveyor tracking system.

Page 57

CAS Real-valued function that compares a real variable to a test

value and conditionally sets a new value as one indivisible oper-

ation.

Page 59

22353-000 Rev. C eV+3KeywordReferenceManual 19

20 eV+3KeywordReferenceManual 22353-000 Rev. C

2.1 Function Keyword Summary

Keyword Description Reference

$CHR String function that returns a one-character string cor-

responding to a given ASCII value.

Page 60

COM Perform the binary complement operation on a value. Page 61

CONFIG Real-valued function that returns a value providing information

about the robot's geometric configuration or the status of the

motion servo control features.

Page 62

COS Real-valued function that returns the trigonometric cosine of a

given angle.

Page 67

CUBRT Real-valued function that returns the cube root of a value. Page 69

$DBLB String function that returns an 8-byte string containing the bin-

ary representation of a real value in double-precision IEEE 754

floating-point format.

Page 70

DBLB Real-valued function that returns the value of eight bytes of a

string interpreted as an IEEE double-precision floating-point

number.

Page 71

DCB Real-valued function that converts BCD digits into an equi-

valent integer value.

Page 73

$DECODE String function that extracts part of a string as delimited by

given break characters.

Page 74

$DEFAULT String function that returns a string containing the current or

initial system default device, unit, and directory path for disk

file access.

Page 77

DEFINED Real-valued function that determines if a variable has been

defined.

Page 79

DEST Transformation function that returns a transformation value

representing the planned destination location for the current

robot motion.

Page 80

DEVICE Real-valued function that returns a real value from a specified

device. The value may be data or status information, depending

upon the device and the parameters.

Page 82

DISTANCE Real-valued function that determines the distance between the

points defined by two location values.

Page 84

DURATION Real-valued function that returns the current setting for one of

the motion DURATION specifications.

Page 85

DX Real-valued function that returns the X-axis component of a

given transformation value.

Page 87

DY Real-valued function that returns the Y-axis component of a

given transformation value.

Page 88

DZ Real-valued function that returns the Z-axis component of a

given transformation value.

Page 89

Page is loading ...

Omron eV+3 Robotics Integrated Controller, eV+3 Keyword Reference guide

Related papers

Other documents