User guide

ManualsBrandsKEYENCE ManualsSensorsSR-700 Series

E SR SCRIPT RM

SR-1000/D100/750/700 Series

Script Reference Rev.5.0

 Symbols

This user's manual uses the following symbols that alert you to important

messages. Be sure to read these messages carefully.

Important

Cautions as to operation that is always performed are shown.

Point

Cautions as to operation that can be easily performed incorrectly

are shown.

Reference

Matters that will help the user improve understanding of the text and

useful information are shown.

The items and pages to be referred to in this document are shown.

Introduction

This manual explains the script language described when using the edit read data

function and the edit image file name function on the SR-1000/D100/750/700

Series.

For information on the basic functions of the SR-1000/D100/750/700 Series, refer

to the corresponding user's manual.

This manual is written for users with basic knowledge of PC and programming

experience.

 SR-1000/D100/750/700 related manuals

z Included in CD-ROM

• SR-1000 User's Manual

• SR-D100 User's Manual

• SR-750 User's Manual

• SR-700 User's Manual

z Download from KEYENCE homepage

Download the latest manual from the following web page.

BarcodeReader.com

http://www.barcodereader.com/

DANGER

It indicates a hazardous situation which, if not avoided, will result

in death or serious injury.

WARNING

It indicates a hazardous situation which, if not avoided, could

result in death or serious injury.

CAUTION

It indicates a hazardous situation which, if not avoided, could

result in minor or moderate injury.

NOTICE

It indicates a situation which, if not avoided, could result in

product damage as well as property damage.

301GB

Table of Contents

General cautions .................................................................................. 1

1-1 Overview .............................................................................................. 2

1-2 Script execution flow ............................................................................ 2

1-3 What Script can do ............................................................................... 2

1-4 Script file configuration ......................................................................... 2

2-1 Naming rules ........................................................................................ 4

2-2 Variables .............................................................................................. 4

2-3 Table ....................................................................................................5

2-4 Array..................................................................................................... 5

3-1 Calculation............................................................................................ 6

3-2 Comparison ..........................................................................................6

3-3 Combination of condition......................................................................6

3-4 Character string concatenation ............................................................6

3-5 Pattern matching .................................................................................. 7

4-1 Conditional branching of process.........................................................8

4-2 Repeat process ....................................................................................9

5-1 Input/Output functions ........................................................................ 10

5-2 Data acquisition functions .................................................................. 10

5-3 Common functions (Basic) ................................................................. 11

5-4 Common functions (Advanced) .......................................................... 11

5-5 User-defined function ......................................................................... 12

6-1 Debug methods ..................................................................................13

6-2 Error message list .............................................................................. 13

7-1 Practical sample programs................................................................. 14

8-1 ASCII code table ................................................................................ 18

8-2 Reserved words/Language elements.................................................18

8-3 Code type...........................................................................................19

8-4 Troubleshooting..................................................................................19

8-5 Copyright indication............................................................................ 19

General cautions

• KEYENCE does not guarantee the results if it is used in a manner that differs

from the descriptions in this manual.

• It is prohibited to use or copy all or any part of this manual without prior approval.

• The information contained in this manual is subject to change without notice.

• The company names and product names described in this manual are registered

trademarks or trademarks of each company.

Summary of content (20 pages)

PAGE 1
Table of Contents 301GB General cautions .................................................................................. 1 SR-1000/D100/750/700 Series Script Reference Rev.5.0 Symbols This user's manual uses the following symbols that alert you to important messages. Be sure to read these messages carefully. DANGER It indicates a hazardous situation which, if not avoided, will result in death or serious injury.
PAGE 2
1-1 1-3 Overview Definition of Script file What Script can do Examples of what the script can do The Script explained in this manual is a simple programming language operating on the SR-1000/D100/750/700 Series. Compared to using the setting software (AutoID Network Navigator), using the script enables more flexible operations for the (1) Edit output data, (2) Edit image file name, and (3) Control output terminals functions.
PAGE 3
(1) Edit read data function readformatEvent() Comment description This operates when "Edit data by script" is enabled on the code reader setting. Format Format z 1-line comment function readformatEvent() -- Comment Character strings written after -- are treated as the comment. Variable declaration Process return(variable) z Multiple-line comment The value entered into return is output as "Read data".
PAGE 4
2-1 Naming rules Characters and numerical values that can be assigned to variables This describes naming rules for variables, etc. used in the script. 3 types of values can be assigned to variables: character string, numerical value and logical value character string Text notation : "ABC", "keyence" Character code (decimal number) notation : "¥013¥010" ([CR][LF]) Escape sequence : "¥r" (CR) Numerical value Integer number Decimal number Hexadecimal number notation : 1, -1 : 2.0, -2.
PAGE 5
2-3 2-4 Table The table is the data configuration to collect multiple data. Table 123 Product 1001 The array is a type of table and a data column that can store multiple values. Similar to normal variables, reference and assignment can be made. “camera” Table LotNo SerialNo Array b 3 4 5 6 7 b[1] b[2] b[3] b[4] b[5] name Data (fields) such as LotNo, SerialNo and name are collected in the table (Product). Numerical values 3,4,5,6,7 are stored in table b.
PAGE 6
3-1 3-3 Calculation This describes arithmetic operators used for general calculations. Combination of condition This describes logical operators used when combining conditions. Arithmetic operator Logical operator Format Format Arithmetic operator Meaning + Addition - Subtraction * Multiplication / Division % Remainder (from division) ^ Power Logical AND operator: If the first argument is false or nil, the value is returned. If not, the second argument is returned.
PAGE 7
3-5 Pattern matching This section describes how to search character strings with specific patterns (Pattern matching) from character strings. Pattern Patterns used to search alphabets, numbers, symbols, etc. from character strings. Meta-character Pattern Meaning . All characters (arbitrary 1 character) %a Character %c Control character (0x01 to 0x1F, 0x7F) %d Number %l Alphabet lowercase %p Symbol (! " # $ % & ' ( ) * + , - .
PAGE 8
4-1 Conditional branching of process Conditional expression For "condition" of if sentences, write conditional expressions using comparative operators as below. Comparison type To branch processes, use if sentences. Character string comparison if sentence Format Numerical value comparison z For 1 branch if condition 1 then process 1 If "condition 1" is fulfilled, "process 1" is executed. Character string comparison If "condition 1" is not fulfilled, no process is executed.
PAGE 9
4-2 Repeat process repeat until sentence repeat until sentences execute process at least once. After the last condition is checked, whether to repeat is judged. This section describes processes when repeating processes. Format while sentence while sentences perform repeat process by specifying continuation conditions. repeat Format Process • After the process is executed once, the process is repeated until the condition is fulfilled.
PAGE 10
5-1 5-2 Input/Output functions This section describes basic functions for editing data of SR-1000/D100/750/700. Data acquisition functions This describes the functions to obtain data of codes read by SR-1000/D100/750/700. readResult(idx) Functions used in readResult(idx) Edit read data These functions obtain information of read data.
PAGE 11
5-3 5-4 Common functions (Basic) These functions can be used in common. These functions can be used in common. Following is the more advanced functions. Character string processing functions Function name left (str, m) mid(str, s, m) Argument str: character string m: number of digits (1 to 9990) Return value Character string of m digits counted from the start of the character string (str).
PAGE 12
5-5 Array operation Function name Argument Return value Applicable model tbl: array name sep: character (1 character) table.concat(tbl,se i: numerical p,i,j) value j: numerical value Character strings combined after the data from tbl[i] to l[j] in the array (tbl) is delimited by sep. tbl: array name i: numerical table.insert(tbl,i,v value ) v: numerical value Inserts v into the tbl[i] position in the array (tbl). Elements following the ith position are moved backward by one. No return value.
PAGE 13
6-1 6-2 Debug methods This section describes debug methods when the script is executed. After the "SCPDBG,1" command is executed, if the script file is sent to the code reader, the following error messages are displayed. Operation check procedure 1 2 3 Error message list Send the FmtSet.lua file to SR-1000/D100/750/700 Series using AutoID Network Navigator. Load errors Error message error loading module 'FmtSet' from file 'FmtSet.lua': “]]” of the comment “-[[ ]]” is missing. FmtSet.
PAGE 14
1 Editing read data Other errors Error message not enough memory Description Memory shortage has occurred. Review the program. 1-1 The readformatEvent function does not attempt to call global 'readformatEvent' (a nil value) exist. Write the readformatEvent function. attempt to call global 'nameformatEvent' (a nil value) The nameformatEvent function does not exist. Write the nameformatEvent function. FmtSet.lua:○: cancel Aborted while the program is running.
PAGE 15
2 Count 2-1 3-2 function readformatEvent() local r_data = result() local data = readResult():readData() if r_data == 0 then return "OK:"..data elseif r_data == 1 then return "NG:"..data elseif r_data == 2 then return "ERROR:"..data end return "result has no return" end Counting the number of read codes with "Multi2 read mode".
PAGE 16
4-3 5 Calculations Deleting control characters when they are included in read data function readformatEvent() local read_data read_data=readResult():readData() read_data=string.gsub(read_data,"%c","") read_data=string.
PAGE 17
5-2 6 Editing read image file names Obtaining angular degrees of a tilted barcode function readformatEvent() local o_data_u local o_data 6-1 Appending read data to the read image file name --Output data if result() == 2 then return "READ_ERROR" end --Displays the message at read error.
PAGE 18
8-1 7 Controlling output terminals ASCII code table To use scripts to control the output terminals, you have to set "Enable scripts," and then configure the settings as shown below. High-order 4 bits Hexadecimal number 7-1 Controlling output terminals (OK/NG/ERROR) function readformatEvent() local r_data = result() local data = readResult():readData() Loworder 4 bits if r_data == 0 then outonEvent(1) --If the result is OK, turn on OUT1.
PAGE 19
8-4 Pattern matching Pattern Meaning Troubleshooting The script does not operate. . All characters (arbitrary 1 character) %a Character %c Control character (0x01 to 0x1F, 0x7F) %d Number %l Alphabet lowercase %p Symbol (! " # $ % & ' ( ) * + , - .
PAGE 20
Revision History Date of printing Version WARRANTIES AND DISCLAIMERS (1) KEYENCE warrants the Products to be free of defects in materials and workmanship for a period of one (1) year from the date of shipment. If any models or samples were shown to Buyer, such models or samples were used merely to illustrate the general type and quality of the Products and not to represent that the Products would necessarily conform to said models or samples.