957GB

Table of Contents
General cautions .................................................................................. 1

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

SR-5000 Series 1-2
1-3
Script execution flow ............................................................................ 2
What Script can do ............................................................................... 2

Script Reference Rev.1.0 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
 Symbols 5-3 Common functions (Basic) ................................................................. 11
5-4 Common functions (Advanced) .......................................................... 11
This user's manual uses the following symbols that alert you to important 5-5 Controlling output terminals and triggers............................................ 12
messages. Be sure to read these messages carefully. 5-6 Confirmation command function......................................................... 13
5-7 User-defined function ......................................................................... 13
It indicates a hazardous situation which, if not avoided, will result
DANGER
in death or serious injury.
It indicates a hazardous situation which, if not avoided, could 6-1 Debug methods .................................................................................. 13
WARNING
result in death or serious injury. 6-2 Error message list .............................................................................. 14
It indicates a hazardous situation which, if not avoided, could
CAUTION
result in minor or moderate injury. 7-1 Practical sample programs................................................................. 14
It indicates a situation which, if not avoided, could result in
NOTICE
product damage as well as property damage.
8-1 ASCII code table ................................................................................ 20
8-2 Reserved words/Language elements................................................. 20
Important Cautions as to operation that is always performed are shown. 8-3 Code type ........................................................................................... 20
8-4 Troubleshooting.................................................................................. 21
8-5 Copyright indication............................................................................ 21
Point Cautions as to operation that can be easily performed incorrectly
are shown.
General cautions
Reference Matters that will help the user improve understanding of the text and
useful information are shown. • KEYENCE does not guarantee the results if it is used in a manner that differs
from the descriptions in this manual.
The items and pages to be referred to in this document are shown. • 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
Introduction trademarks or trademarks of each company.
This manual explains the script language described when using the edit read data
function and the edit image file name function on the SR-5000 Series.
For information on the basic functions of the SR-5000 Series, refer to the
corresponding user's manual.
This manual is written for users with basic knowledge of PC and programming
experience.

 SR-5000 related manuals

 Included in DVD-ROM
• SR-5000 User's Manual
 Download from KEYENCE homepage
Download the latest manual from the following web page.
BarcodeReader.com
http://www.barcodereader.com/

1 GB SR SCRIPT RM
1-1 Overview 1-3 What Script can do
Definition of Script file Examples of what the script can do
The Script explained in this manual is a simple programming language operating • Extracting arbitrary portion of read data
on the SR-5000 Series. • Appending arbitrary character strings to read data
Compared to using the setting software (AutoID Network Navigator), using the • Comparing data and outputting result data
script enables more flexible operations for the (1) Edit output data, (2) Edit image • Four arithmetic operations
file name, and (3) Control output terminals functions. • Changing image file names for FTP transmission
• Comparing data and generating output from the output terminals

Related software * "Additional information" set with AutoID Network Navigator cannot be used in
combination with the script.
 AutoID Network Navigator
Software to set the SR-5000 Series

 FileView
1-4 Script file configuration
Use this to send/receive the script file to/from the SR-5000 Series. This describes the configuration of the script file (FmtSet.lua).

* For detailed operation procedures for the AutoID Network Navigator and
FileView, refer to the corresponding user's manual. Script file configuration
FmtSet.lua file, the script program handled by SR-5000 consists of the following 3

1-2 Script execution flow parts.

(1) function readformatEvent()……………… Edit read data

(2) function nameformatEvent( idx ) ……… Edit image file name
Steps before executing the script (3) User-defined function …………………… User-defined function that can
be called for (1) and (2)
[1] Creating the script file [2] Changing the script execution setting [3] Transferring the script file
The process is written in the above parts in combination with variables or functions
provided by the SR-5000 system.

FmtSet.lua file

The file version can be determined

SCPVERSION="1.00" arbitrarily.
(Can be omitted.)

[1] Creating the script file function readformatEvent()

(1) Edit read data
Create the script file (FmtSet.lua) and write the program using a text editor such Process
(control output terminals)
end
as notepad.exe. (This manual describes writing methods for programming.)
[2] Changing the script execution setting function nameformatEvent( idx )
Using the AutoID Network Navigator, set the script execution setting of the  Process (2) Edit image file name
SR-5000 Series to "Enable". end
[3] Transferring the script file
function User-defined function
Transfer the script file (FmtSet.lua) to the SR-5000 Series. User-defined function that can be called
Process
for (1) and (2) (Can be omitted.)*1
end
For setting procedures for the AutoID Network Navigator, refer to the
corresponding user's manual. Putting 2 hyphens at the beginning
--Comment
enables writing comment.

Operations when executing the script *1 Multiple user-defined functions can be written as necessary. Skip this if not
used.
The script is executed when a code is read. For writing procedure of user-defined functions, refer to "5-7 User-defined
function" (Page 13).
[1] Reading a code [2] Executing the script when reading. [3] Sending the script execution result

Header 1239 Terminator

1234567890 123456789
The header and the terminator
are appended to the script
execution result and data is
output.

GB SR SCRIPT RM 2
 (1) Edit read data function readformatEvent() Comment description
This operates when "Edit data by script" is enabled on the code reader setting.
Format
Format
 1-line comment

function readformatEvent() -- Comment Character strings written after -- are treated as the comment.
Variable declaration
Process
 Multiple-line comment
The value entered into return is output as "Read
return(variable)
data". -- [[
end Comment Character strings surrounded with --[[ ]] are treated as the
Comment comment.
Example
]]

function readformatEvent()
local a Declares variable a.
a="successful reading!" Assigns "successful reading !" to variable a.
return(a) The value stored in a is output as "Read data".
end

* Up to 9990 characters can be assigned to return.

(2) Edit image file name function nameformatEvent(idx)

This operates when "Edit image file name by script (FTP transmission only)" is
enabled on the code reader setting.

Format

function nameformatEvent()
Variable declaration
Process
The value entered into return is output as "Image
return(variable)
file name".
end

Example

function nameformatEvent( idx )

local b Declares variable b.
b="image file" Assigns "image file" to variable b.
The value stored in b is output as "Image file
return(b)
name".
end

Up to 180 characters can be assigned to return.

File names are restricted by the FTP server and OS activating the FTP server. Use
the following characters for file names. If characters other than these are used, test
to check if operation is normal under the operation environment.
 Usable characters
abcdefghijklmnopqrstuvwxyz
ABCDEFGHIJKLMNOPQRSTUVWXYZ
0123456789

Reference • More than one "Variable" and "Process" can be written. For how to
define variables, refer to "2-1 Naming rules" (Page 4).
• A different function among functions can be called. "Calling the
function" (Page 13)
• Directories can be specified in file names.
To put a image file named "a" into the folder named [image] in the
root folder, specify the value such as image\\a in return.
Note if the applicable folder does not exist in the root folder, it does
not operate normally.

3 GB SR SCRIPT RM
2-1 Naming rules Characters and numerical values that can be assigned to variables
3 types of values can be assigned to variables: character string, numerical value
This describes naming rules for variables, etc. used in the script. and logical value
Text notation : "ABC", "keyence"
Naming methods Character code (decimal number) notation : "\013\010"
character string ([CR][LF])
 Script file name Escape sequence : "\r"
(CR)
The script file name handled by SR-5000 is FmtSet.lua only. Integer number : 1, -1
Numerical value Decimal number : 2.0, -2.0
 Names defined in the script program Hexadecimal number notation : 0x0a
Types of Name defined in the script program are as follows. True : true
Logical value
False : false
• Variable name, array variable name
• Function name * The condition that no value is assigned to the variable is called nil. If it is referred,
an error will occur. Be sure to assign a value before referring to the variable.
 Definitions of variable name and table name
Start the name with a 1-byte alphabet character.
 character string
1-byte alphanumeric characters and "_" (underscore) can be used.  Text notation
Do not use reserved words. Expresses with the text surrounded with "". Numerical values, symbols and
For reserved words, "8-2 Reserved words/Language elements" (Page 20). character strings can be written in "".
Do not use "_" (underscore) or a number at the beginning of the  Character code (decimal number) notation
NOTICE
name. It may not operate normally. Expresses the character string by specifying the ASCII code decimal number after
\.

2-2 Variables  Escape sequence

Expresses control characters and symbols using escape characters (\).
Character strings and numerical values used in the script are stored in containers Example
called variables to be handled.
a = "ABC" Assigns character string "ABC" to variable a.
3
Assigns character code (decimal number)
b = "\013\010"
notation "\013\010"([CR][LF]) to variable b.

a Variable name Specifies line break (\r) to variable c with escape

c = \r
sequence.
Stores numerical value 3 in variable a.

 Numerical value
 Positive and negative integer (decimal number notation)
Definition of variable
This expresses positive integer and negative integer as decimal number.
Values such as numerical values, character strings or calculated results can be
 Positive and negative decimal (decimal number notation)
assigned to variables.
This expresses positive decimal and negative decimal as decimal number.
 Declaration of variable
Important Decimal uses double-precision floating-point number, which may
Format have a margin of error.

local "variable name"

 Hexadecimal number notation
Example This expresses 0 or positive integer by adding a hexadecimal number after 0x.
The hexadecimal number notation cannot express decimal and negative integer.
local a Declares variable a. Example

 Assignment and initialization of variable a= 123 Assigns decimal number integer 123 to variable a.
b = -1.5 Assigns decimal number integer -1.5 to variable b.
Storing a value in a variable is called "assignment".
Assigning a value at the time of variable declaration is called "Initialization". c = 0x0f Assigns hexadecimal number f to variable c.

Example
 Logical value
local a=0 Initializes with 0 when declaring variable a. Logical value shows True or False to processed results.
a=1 Assigns 1 to variable a.

Escape sequence
If this is referred with no value assigned to the variable, an error will occur when
executing the script. Pattern Meaning
\r [CR](0x0D)
\n [LF](0x0A)
\a [BEL](0x07)
\b [BS](0x08)
\f [CL](0x0c)
\t [HT](0x09)
\v [VT](0x1B)
\\ Backslash
\" Double quotation
\' Single quotation
\000 Specifies an arbitrary character code as decimal number.

GB SR SCRIPT RM 4
2-3 Table 2-4 Array
The table is the data configuration to collect multiple data. 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.
123 1001 “camera”
Table Product
3 4 5 6 7
Table b

LotNo SerialNo name

b[1] b[2] b[3] b[4] b[5]

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.

Definition of table Definition of array

The table can store multiple data (fields).
Values such as numerical values, character strings or calculated results can be
Fields can store numerical values and character string data as variables do.
assigned to arrays.
 Declaration of table  Naming rules for array
Format Array names must start with a 1-byte alphanumeric character for the first character.
For the second character and after, 1-byte alphanumeric characters and "_"
(underscore) can be used. Array elements start from [1].
local “table name” ={field 1, field 2, field 3}
 Declaration of array
 Reference to data within the table
Table name.field name Format
Example 1) Table declaration and initialization
local“arrayname” ={}
Declares table Product.

local Product ={ LotNo=123 , Serial No=1001 , name="camera"}

LotNo=123 Example
Serial No =1001
name ="camera"
local b ={} Declares array b.

Example 2) Reference to data variables within the table  Assignment and initialization of array variable
Assign values to array valuables using { } and values. Specify multiple values by
local a = 0 Declares variable a.
dividing "," (comma).
local Product ={ LotNo=123 , Serial No=1001 , name="camera"} Declares table Product.
Example
Stores the name field of
a = Product.name
the table Product in a.
local a={} Declares array a.
a = {3,4,5,6} Assigns the 4 values 3, 4, 5, and 6 to array a.
Declares array b and initializes it with the 3
local b ={16,51,55}
values 16, 51, 55.
local b[3] = 10 Assigns 10 to the third value of array b.
Assigns 11 to the fourth value of array b (adds 1
local b[4] = 11
element).

5 GB SR SCRIPT RM
3-1 Calculation 3-3 Combination of condition
This describes arithmetic operators used for general calculations. This describes logical operators used when combining conditions.

Arithmetic operator Logical operator

Format Format

Arithmetic Logical operator Meaning

Meaning
operator Logical AND operator: If the first argument is false or nil, the value is returned.
and
+ Addition If not, the second argument is returned.
- Subtraction Logical OR operator: If the first argument is different from false or nil, the
* Multiplication or first argument is returned. If not, the second
argument is returned.
/ Division
Logical NOT operator: If the next value is false or nil, true is returned. If not,
% Remainder (from division) not
false is returned.
^ Power

On the left-hand side and the right-hand side of each operator, write an expression Example
using numerical values or variables of numerical values.
Examples of calculations and results
Example
Arithmetic expression Result

A=B+1 Assigns the result of variable B plus 1 to variable A. true and true true
true or true true
true and false false
Example
true or false true

Examples of calculations and results (a=5.5, b=2) not false true

not true false
Arithmetic expression Result
10 or 30 10
a+b 7.5
nil or 30 30
a-b 3.5
false or nil nil
a*b 11
a/b 2.75
a%b
a^b
1.5
30.25 3-4 Character string
concatenation
Important If character strings are assigned to variables and they cannot be
converted to numerical values during calculation, an error will This describes concatenation operators used to connect one character string to
occur on execution. another.

Reference To obtain only the integer part of division result, use arithmetic function Concatenation operator
math.floor.(Page 11)
Format
3-2 Comparison
variable 1..variable 2
Expresses using 2 periods ".." between
variables.
This describes comparative operators used when comparing numerical values or logical values.

Example
Comparative operator
Declares variable a and initializes with character
Format local a = "Keyence"
string "Keyence".
Declares variable b and initializes with character
local b = "Auto-ID"
Comparative operator Meaning string "Auto-ID".
< smaller local c Declares variable c.
<= smaller or equal c = a..b Assigns values after a and b are connected.
> greater Value of c: "KeyenceAuto-ID"
>= greater or equal
== equal
~= different

On the left-hand side and the right-hand side of each operator, write numerical
values, variables of numerical values or arithmetic expression.
Example

Examples of calculations and results (a=10, b=1)

Arithmetic expression Result

a >b true
a <b false
a == 10 true
a~=10 false

Important Comparison is also possible by assigning character strings to

variables. However, when variables are evaluated by conditional
expression, and if they cannot be converted to numerical values,
an error will occur on execution.

GB SR SCRIPT RM 6
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 (! " # $ % & ' ( ) * + , - . / : ; > = < ? @ [ \ ] ^ _ ` { | })
%s Space character (0x09,0x0a,0x0b,0x0c,0x0d,0x20)
%u Alphabet uppercase
%w Alphabet and number
%x Hexadecimal number (0 to 9, a to f, A to F)
%z null character
% character*1 Literal character

*1 Specify characters other than alphanumeric characters

Quantifier

Pattern Meaning
+ Matches with 1 or more times repetitions of the previous character.
Matches with 0 or more times repetitions of the previous character.

(Longest match)
Matches with 0 or more times repetitions of the previous character.
-
(Shortest match)
? Matches with 0 or 1 time repetition of the previous character.

Range specification

Pattern Meaning
[0-9] Number (0 to 9)
[^0-9] Not number (0 to 9)
[a-z] Alphabet lowercase (a to z)
[A-Z] Alphabet uppercase (A to Z)
[a-zA-Z] Alphabet lowercase and alphabet uppercase (a to z and A to Z)
[0-9a-zA-Z] Number and alphabet (0 to 9, a to z and A to Z)

* If ^ (caret) is added to the beginning of the pattern, the match is fixed to the
beginning of the target character string.
If $ (dollar) is added to the end of the pattern, the match is fixed to the end of the
target character string.

7 GB SR SCRIPT RM
4-1 Conditional branching of Conditional expression

process For "condition" of if sentences, write conditional expressions using comparative

operators as below.

To branch processes, use if sentences. Comparison type Conditional expression Description

Character string if (str == "A") then If str is equal to "A"
comparison if (str ~= "A") then If str is not equal to "A"
if sentence if (i < 10) then If i is less than 10
if (i < =10) then If i is 10 or less
Format Numerical value if (i ==10) then If i is equal to 10
comparison if (i > =10) then If i is 10 or more
 For 1 branch if (i > 10) then If i is more than 10
if (i ~=10) then If i is a number other than 10
if condition 1 then If "condition 1" is fulfilled, "process 1" is executed.
Character string if ( bool == true) then if bool is true
process 1 If "condition 1" is not fulfilled, no process is executed. comparison if ( bool ~= true) then if bool is not true
end
For details of comparative operators, refer to "3-2 Comparison" (Page 6).
 For 2 branches (using else)
Example 1
if condition 1 then
If "condition 1" is fulfilled, "process 1" is executed. if type<10 then
process 1 If type is less than 10, assign 1 to termID.
termID=1
else
If "condition 1" is not fulfilled, "process 2" is executed. end
process 2
end
Example 2
 For 3 branches (using elseif)

if condition 1 then if type<10 then

If "condition 1" is fulfilled, "process 1" is executed. If type is less than 10, assign 10 to termID.
process 1 termID=10

elseif condition 2 then elseif type<20 then

If "condition 1" is not fulfilled but "condition 2" is fulfilled, If type is 10 or more and less than 20, assign 20 to termID.
process 2 "process 2" is executed. termID=20

else else
If both "condition 1" and "condition 2" are not fulfilled, "process If type is 20 or more, assign 30 to termID.
process 3 3" is executed. termID=30

end end
No
condition 1
Yes Reference Up to 20 nests can be made for the conditional branching.
No
condition 2
Yes

process 1 process 2 process 3

Reference The "elsif condition then process" sentence can be written multiple
times.

GB SR SCRIPT RM 8
4-2 Repeat process repeat until sentence
repeat until sentences execute process at least once. After the last condition is
This section describes processes when repeating processes. checked, whether to repeat is judged.

while sentence Format

while sentences perform repeat process by specifying continuation conditions.
repeat • After the process is executed once, the process is repeated
until the condition is fulfilled.
Format Process
until condition

while continuation As long as the continuation condition is fulfilled, the process is

Example
condition do repeated.
If the continuation condition is not fulfilled, the repeat process
Process ends. repeat
Regardless of the i value, the value for a is increased by two,
end a=a+2 and the value for i is increased by one.
If i is 10 or less, the value for a is increased by two.
i = i+1
No
Continuation condition until (i<=10)
Yes

Process
break sentence
Use break when going out in the middle of repeat process of while sentences or of
for sentences.

Example Format
while (i<=10) do
If i is 10 or less, the value for i is increased by one. while continuation
i = i+1 condition do
No
end Conditional expression Continuation condition

Yes
Process
break
for sentence Conditional expression
end No
for sentences repeat process using the counter to count the number of repetitions. end
Process

Format

 Base
* break can be written only just before end.
for Initialization expression for counter, • Sets the default value to the counter To call break in the middle of the sentence, write as below.
and final value do (variable). The process is repeated until
the value exceeds the final value. Example
Process • Each time the process ends, the counter
increases by one. do
end break
 Specifying "increment of counter" end

for Initialization expression for counter, final value • Sets the default value to the counter
and increment of counter do (variable). The process is repeated until
the value exceeds the final value.
• Each time the process ends, the counter
Process increases by positive and negative integer
value specified.
end
Initialization of

No
Final value of counter >= counter

Yes
Process

Addition of counter

Example

for i=1,5 do
If i is 5 or less, the value for a is increased by two.
a=a+2
end

9 GB SR SCRIPT RM
5-1 Input/Output functions 5-2 Data acquisition functions
This section describes basic functions for editing data of SR-5000. This describes the functions to obtain data of codes read by SR-5000.

readResult(idx)
Functions used in readResult(idx)
Edit read data
These functions obtain information of read data. Use as readResult(n):***
Argument idx : Index for read information array*1 Example) readResult(n):readData()
Return value return : Read value Function name Argument Return value
readData() None Read data
*1 The number of arrays can be obtained using the common function
symbolType() None Code type (Refer to "8-3 Code type" (Page 20).)
"readCount()".
Symbol identifier (3 characters) (Refer to "8-3
If idx is omitted, the first code is specified. symbolIdentifier() None
Code type" (Page 20).)
bankNo() None Bank number
regionNo() None Region number
imageResult(idx) scanTimes() None Scan count
Code top coordinates:
cornerCoordinates() None
Edit image file name "X1/Y1:X2/Y2:X3/Y3:X4/Y4"
centerCoordinate() None Code center coordinates: "X1/Y1"
Argument idx : Index for image name information array*2 eccQuality() None Unused error correction (0 to 100)
Return value return : Image file name imageFileNames() None Image file name*1
*2 The number of arrays can be obtained using the common function readingDuration() None Reading duration [ms]
ppc() None PPC
"imageCount()".
cellNum() None Number of cells:"Vertical/horizontal"*2
If idx is omitted, the first code is specified. cellSize() None Cell size (mm)*2
codeSize() None Code size (mm):"Vertical/horizontal"*2

Data entry to readResult and imageResult *1 When using the script for the edit image file name, the file name after the image
file is changed is output. 
When multiple image files exist, the value of the Inter-delimiter is the same
Example 1
value set for the SR-5000.
*2 This function is designed for 2D codes.
When reading in the "Standard read mode" is performed on SR-5000 by When a barcode, not a 2D code, is read with the SR-5000, the narrow bar width
registering 3 parameter banks for which alternate reading is enabled. is stored during the execution of the cellSize() function. When a barcode is
read, cellNum() and codeSize() cannot be executed.
• Read OK • When using the SR-5000's advanced multi head, the append data of the slave is
When reading is successful with the first bank all obtained with readData().

readResult(1) Functions used when reading the GS1 composite

Function name Argument Return value
imageResult(1)
readData() None Read data *1
symbolIdentifier() None Symbol identifier *1
When reading is successful with the second and third banks Code top coordinates: *2
cornerCoordinates() None "X1/Y1:X2/Y2:X3/Y3:X4/Y4:X1/Y1:X2/Y2:X3/
readResult(1) Y3:X4/Y4"
Code center coordinates: *2
centerCoordinate() None
imageResult(1) "X1/Y1:X1/Y1"
readDataCompositeLen1D() None Data length of the GS1 composite 1D code
• Read error *1 When reading the GS1 composite (JAN/EAN/UPC), the 1D code and 2D code
When reading fails are connected with a composite delimiter and then output.
*2 When reading the GS1 composite code, values of the 1D code and 2D code
readResult(1) are obtained separately, connected with a partition mark, and then output.

imageResult(1) imageResult(2) imageResult(3)

Functions used in imageResult(idx)
These functions obtain information of captured images. Use as imageResult(n):***
Example) imageResult(1):bankNo()
Function name Argument Return value
bankNo() None Bank number or nil
imageFileName() None Image file name
Character string data of the barcode itself or nil
readDatas() None
(Concatenated when multiple data are present.)
readResultIdx() None Index table of append data (readResult(n)) or nil

GB SR SCRIPT RM 10
5-3 Common functions (Basic) 5-4 Common functions (Advanced)
These functions can be used in common. These functions can be used in common. Following is the more advanced functions.

Character string processing functions Numeric calculation

Function name Argument Return value Function name Argument Return value
str: character string math.max(v,…) v: numerical value Maximum value among arguments
Character string of m digits counted from the start of
left (str, m) m: number of digits math.min(v,…) v: numerical value Minimum value among arguments
the character string (str).
(1 to 9990)
math.abs(v) v: numerical value Absolute value
Character string of m digits counted from s digit
math.floor(v) v: numerical value Integer with decimals truncated
position from the start of the character string (str). If
str: character string math.ceil(v) v: numerical value Integer with decimals rounded up
m is not specified, the range from the start position
mid(str, s, m) s: 1 to 9990
(s) to the end is specified. If the start position is a: numerical value
m: 1 to 9990 math.pow(a,n) an
outside the range of character string data, there is no n: numerical value
return value. math.sqrt(v) v: positive numerical value √v
str: character string Character string of m digits counted from the end of math.deg(rad) rad: numerical value Converts radian values to angular degrees.
right(str, m)
m: 1 to 9990 the character string (str)
math.rad(deg) deg: numerical value Converts angular degrees to radian values.
str: character string
math.sin(rad) rad: numerical value sin
m: 1 to 9990 The mth character string after dividing the character
field(str, m, sep) math.cos(rad) rad: numerical value cos
sep: character  string (str) with the separator (sep)
(1 character) math.tan(rad) rad: numerical value tan
math.asin(rad) rad: numerical value arc sin

Reader status acquisition functions math.acos(rad) rad: numerical value arc cos
math.atan(rad) rad: numerical value arc tan
Function name Argument Return value
time() None Time
Character string operation
readCount() None Total number of reading results*1
*1
imageCount() None Total number of saved images Function name Argument Return value
Comparison result string.len(str) str: character string Character string (str) length
result() None
0: Comparison OK, 1: Comparison NG, 2: ERROR Converts the character string (str) to
string.lower(str) str: character string
IP address (delimited by underscore) lowercase characters.
ipAddress() None
ex)192_168_100_001 Converts the character string (str) to
string.upper(str) str: character string
masterSlaveID() None Master/Slave ID uppercase characters.
masterSlaveGroupName() None Master/Slave group name str: character string Character string that repeated the character
string.rep(str,n)
n: numerical value string (str) n times
*1 When the Master/Slave function is used, result data cannot be obtained correctly.
Reverses the alignment sequence of
string.reverse(str) str: character string
character string (str).
Debug function
str: character string
Portion of character string from ith character
Function name Argument Return value string.sub(str,i,j) i: numerical value
to jth character of the character string (str)
j: numerical value
str: character Outputs character strings (str) when debug is
print(str) str: character string Returns the character code for the ith
string executed.*2 string.byte(str,i)
i: numerical value character of the character string (str)
*2 The output setting turns ON after the "SCPDBG,1" command is executed. "6-1
string.char(c1,c2,…) c1: numerical value Character string for the character code.
Debug methods" (Page 13)
str: character string Searches characters that match p among
string.find(str,p) p: character string or the character string (str), and then returns
regular expression the digit number at the head.
str: character string
Returns characters that match p among the
string.match(str,p) p: character string or
character string (str).
regular expression
Used for for loop.
str: character string
Each time the characters that match p
string.gmatch(str,p) p: character string or
among the character string (str) are called,
regular expression
the result is returned in turn.
str: character string
p: character string or Replaces characters that match p among
regular expression the character string (str) with r.
string.gsub(str,p,r,n)
r: character string If n is specified, the first n characters in the
n: numerical value (Can be character string are replaced.
omitted)

Array operation
Function name Argument Return value
tbl: array name
Character strings combined after the data
sep: character (1 character)
table.concat(tbl,sep,i,j) from tbl[i] to l[j] in the array (tbl) is delimited
i: numerical value
by sep.
j: numerical value
Inserts v into the tbl[i] position in the array
tbl: array name (tbl).
table.insert(tbl,i,v) i: numerical value Elements following the ith position are
v: numerical value moved backward by one.
No return value.
Returns the largest index value in the array
table.maxn(tbl) tbl: array name
(tbl).
Deletes the element at the tbl[i] position in
tbl: array name the array (tbl). Elements following the ith
table.remove(tbl,i)
i: numerical value position are moved forward by one.
No return value.
Sorts the elements in the array (tbl).
table.sort(tbl) tbl: array name
No return value.

11 GB SR SCRIPT RM
Bit calculations
Function name Argument Return value
5-5 Controlling output
bitAnd(a,b)
a: numerical value
b: numerical value
Logical disjunction (OR) of a and b terminals and triggers
bitNot(a) a: numerical value Negation of a
Controlling output terminals
a: numerical value
bitOr(a,b) Logical conjunction (AND) of a and b
b: numerical value Function name Argument Return value
a: numerical value Exclusive disjunction (exclusive OR) of a n: output None
bitXor(a,b) outonEvent(n)
b: numerical value and b terminal number (The corresponding output terminal turns on.)
a: numerical value
bitLeftShift(a,b) Shifts a to the left by b bits
b: numerical value
a: numerical value
Controlling triggers
bitRightShift(a,b) Shifts a to the right by b bits
b: numerical value
Function name Argument Return value
a: numerical value
bitLeftRotate(a,b) Rotates a to the left by b bits Instruction to continue capturing images
b: numerical value
invokeNextShot(n) n: bank number If n is left blank, the SR operates with a bank on which
a: numerical value alternating is enabled.
bitRightRotate(a,b) Rotates a to the right by b bits
b: numerical value
If you turn off the timing input, reading will end without capturing the next image
a: numerical value Returns the bit in position b from the lowest
bitExtract(a,b) regardless of whether this function is executed or not.
b: numerical value order position of a
a: numerical value The value in which the bit in position b from
bitReplace(a,b,c) b: numerical value the lowest order position of a is replaced
c: numerical value with bit c  Timing diagrams
• Normal
Bit calculation functions are calculations performed in units of 32 bits.
Timing input
Statistical information (functions for SR WEB Monitor use)
Image capture +
Function name Argument Return value decoding

None
id: 0-63
stat.setName(id,str) Sets the name of the slot with the specified • When using invokeNextShot(n)
str: character string
ID (up to 16 characters)
None Timing input
id: 0-63
stat.setValue(id,v) Sets the value of the slot with the specified
v: 0-65535
ID Image capture +
decoding
stat.getName(id) id: 0-63 Name of the slot with the specified ID
invokeNextShot(n)
stat.getValue(id) id: 0-63 Value of the slot with the specified ID*1
*1
stat.incValue(id) id: 0-63 Value of the slot with the specified ID) + 1
Trigger status
*1 Any values that exceed 65535 are set to 65535.
Function name Argument Return value
Others Trigger status
isTriggerActive() None 0: triggers are off
Function name Argument Return value 1: triggers are on
v: judgment If v is False, mes is output. Number of times the script was called while the trigger
assert( v,mes) scriptExecNum() None
mes: character string The program is force-quit. was applied

error("",1) -
Errors (ScriptError) out explicitly and  Timing diagrams
terminates the program.
• isTriggerActive
print(mes) mes: character string Outputs messages for debug.
Converts to numerical values. Timing input
tonumber(v) v: value Returns nil if value conversion is not
possible. isTriggerActive
tostring(v) v: value Converts to character strings.
1 0
type(v) v: value Variable type
• scriptExecNum()

Timing input

Script processing

scriptExecNum()
0 1 2 0 1 0

Trigger control precautions

 Limits when performing trigger control
EtherNet/IP,
Out signals
Script PROFINET Saving
LED*2
processing SCRIPT Completion Read images
OK ERROR
CONTROL bit *3 error bit
When capturing
images
 
When reading is
judged to be  Green 
successful *1
When outputting
data


*1 This refers to the case in which the conditions for successful reading
specified with the SR-5000 are met. When using script triggers, reading is not
judged as resulting in an error.
*2 This is the color displayed by the OK/ERROR LED (green/red) of the
SR-5000 main unit. When using script triggers, this LED does not light in red.
*3 This indicates "Read Complete" or "Ext. Request Complete" when using
EtherNet/IP or PROFINET with the SR-5000.

GB SR SCRIPT RM 12
5-6 Confirmation command 6-1 Debug methods
function This section describes debug methods when the script is executed.

You can obtain the reply result of SR Series confirmation commands (RN/RP/RC/
RB/RD). Operation check procedure
For details on the command numbers and the reply details, see the user's manual
of the SR Series.
1 Send the FmtSet.lua file to SR-5000 Series using AutoID Network
Navigator.
Function name Argument Return value
n: confirmation
2 Start the AutoID Network Navigator [Terminal] and click [LON] to
execCmd("n") Confirmation command reply result
command start reading.

Applicable commands RN/RP/RC/RB/RD, KEYENCE, EMAC 3 Read with the code reader and check if the result is correctly
reflected.
* You cannot use commands other than those listed above.
• For editing read data
→ Check if the output data is correct.

5-7
• For editing image file name
User-defined function → When using the setting to send image files via FTP, check the name of
image file uploaded on the specified FTP server.

This section describes functions that can be uniquely defined by users.

* While reading, if an error message such as "Load Error" is displayed, debug
according to the following debug methods.
User-defined function Error message Description
LoadError Script file loading failed.
Format An error has occurred in
ReadResultScriptError
readformatEvent.
An error has occurred in
 Definition of function ImageResultScriptError
nameformatEvent.
function function name (argument) Script timeout error.
TimeoutError
The script execution took too long. *1
Variable declaration
ScriptError Other errors.
Process
*1 The time for script timeout should be 3 seconds.
return(variable) The value entered into return is the return value.
end
Debug methods
 Calling the function
 Error details check
Function name (value)
1 Send the "SCPERR" command to SR-5000 Series with AutoID
Network Navigator [Terminal]. (Executing this command will display
Example 1 the error details.)

function readformatEvent() 2 "error ~~~ FmtSet.lua: ○ : ~~" is displayed. The number applied to ○
local a Declares variable a.
is the corresponding row in error.
Open FmtSet.lua with the text editor and repair the source code.
a= test_1() Stores the result of test_1() in variable a.
a = a .. "ABC" Appends character string "ABC" to variable a.  print(mes) display (Page 12)
return(a) Outputs the result.
To check (debug output) the variable value in the source code of FmtSet.lua,
end use the print function.

1 Write the print function on where the variable value is to be checked

function test_1() Defines the user-defined function test_1().
in the source code of FmtSet.lua.
local c Declares variable c.
c = 123 Assigns "123" to variable c.
2 Send the "SCPDBG,1" command to SR-5000 Series with AutoID
Network Navigator [Terminal]. (Executing this command enables
return(c) The value of variable c is the return value.
debug output when reading.)
end
3 Click [LON] to start reading.
Execution result 123ABC The content specified as the argument of the print function is output.
Referring to this output result, open FmtSet.lua with the text editor and repair
the source code.

4 After the source code is repaired, send the "SCPDBG,0" command

and disable debug output.

13 GB SR SCRIPT RM
6-2 Error message list Other errors
Error message Description
Memory shortage has occurred.
After the "SCPDBG,1" command is executed, if the script file is sent to the code not enough memory
Review the program.
reader, the following error messages are displayed.
The readformatEvent function does not
attempt to call global 'readformatEvent' (a nil value) exist.
Error message list Write the readformatEvent function.

Load errors The nameformatEvent function does not

attempt to call global 'nameformatEvent' (a nil
exist.
value)
Error message Description Write the nameformatEvent function.
error loading module 'FmtSet' from file 'FmtSet.lua': “]]” of the comment “-[[ ]]” is missing. Aborted while the program is running.
FmtSet.lua:○: unfinished long comment near '<eof>' Add “]]” to the end of the comment. • Aborted by the CANCEL command
error loading module 'FmtSet' from file 'FmtSet.lua': end is missing for “function” on the first • Aborted due to the timeout of the
FmtSet.lua:○: 'end' expected (to close 'function' at line. program execution time
FmtSet.lua:○: cancel
line 1) near '<eof>' Write end at the correct position. Check if the program is not
supposed to go into the infinite loop
error loading module 'FmtSet' from file 'FmtSet.lua': end is missing for “for” on the second
or the process time of the program is
FmtSet.lua:○: 'end' expected (to close 'for' at line 2) line.
too long.
near '<eof>' Write end at the correct position.
error loading module 'FmtSet' from file 'FmtSet.lua':
“)” for “(” is missing.
FmtSet.lua:○: ')' expected (to close '(' at line 1) near

7-1
Write “)” at the correct position.
'<eof>'

error loading module 'FmtSet' from file 'FmtSet.lua':

When declaring function, “)” for “(” is
missing.
Practical sample programs
FmtSet.lua:○: <name> or '...' expected near 'end'
Write “)” at the correct position.
Grammatical error (Arithmetic expression
error loading module 'FmtSet' from file 'FmtSet.lua': error).
Sample programs
FmtSet.lua:○: '=' expected near '+' Check if the arithmetic expression is 1 Editing read data
correct.
Grammatical error (Is == used instead of 1-1 Extracting the first 1 character and the last 2 characters of read data.
error loading module 'FmtSet' from file 'FmtSet.lua':
=?) 1-2 Deleting the first 1 character of read data.
FmtSet.lua:○: '=' expected near '=='
Correct == to =. 1-3 Deleting all unnecessary zeros at the beginning of barcode.
Grammatical error (Is = used instead of
error loading module 'FmtSet' from file 'FmtSet.lua':
==?) 2 Count
FmtSet.lua:○: 'then' expected near '='
Correct = to ==.
2-1 Counting the number of readings
Grammatical error (Is a value assigned to
error loading module 'FmtSet' from file 'FmtSet.lua': the reserved word?)
3 Conditional branching
FmtSet.lua:○: unexpected symbol near '=' Do not assign any value to the reserved
word. 3-1 Outputting the type of read codes
error loading module 'FmtSet' from file 'FmtSet.lua': Numerical value writing error. 3-2 Branching according to the read results (OK/NG/ERROR)
FmtSet.lua:○: malformed number near '1.a' Write numerical values correctly.
3-3 Branching after looking at the first 1 character of read data

4 Comparison
Execution errors
Error message Description
4-1 Comparison when specific characters are included in read data
4-2 Comparison when control characters are included in read data
Was the arithmetic expression written
FmtSet.lua:○: attempt to perform arithmetic on a 4-3 Deleting control characters when they are included in read data
with character strings?
string value
Write it correctly. 4-4 Deleting <LF>(0x) when it is included in read data
Was the arithmetic expression written 4-5 Date comparison
FmtSet.lua:○: attempt to perform arithmetic on
with character strings?
global 'a' (a string value) 5 Calculations
Write it correctly.
Concatenation failed. 5-1 Obtaining angular degrees of a tilted 2D code
FmtSet.lua:○: attempt to concatenate a nil value Check if values other than character
5-2 Obtaining angular degrees of a tilted barcode
strings are not specified.
5-3 Bit calculations
Concatenation failed.
FmtSet.lua:○: attempt to concatenate global 'a' (a
Check if values other than character 6 Editing read image file names
table value)
strings are not specified.
Undeclared functions were called. 6-1 Appending read data to the read image file name
FmtSet.lua:○: attempt to call global 'a' (a nil value) Check if the name of the function to call 6-2 Appending date and time to the read image file name
is correct. 6-3 Appending date and time and read data to the read image file name
Undeclared functions were called.
FmtSet.lua:○: attempt to call global 'a' (a number
Check if the name of the function to call 7 Controlling output terminals
value)
is correct.
7-1 Controlling output terminals (OK/NG/ERROR)
Undeclared tables were called.
FmtSet.lua:○: attempt to index global 'a' (a nil value) Check if the name of the table to call is 7-2 Preventing duplicate reading
correct.
8 Controlling triggers with scripts
Undeclared tables were called.
FmtSet.lua:○: attempt to index global 'a' (a string
Check if the name of the table to call is 8-1 Continuing reading until the character "S" is read at the start of the data
value)
correct. 8-2 Detecting timing input turning off
FmtSet.lua:○: bad argument #1 to 'cos' (number Wrong argument.
expected, got string) Specify the correct argument. 9 Confirmation commands
FmtSet.lua:○: bad argument #2 to 'max' (number Wrong argument.
9-1 MAC address confirmation command
expected, got nil) Specify the correct argument.
9-2 Reader explanation confirmation command

GB SR SCRIPT RM 14
 1 Editing read data 3 Conditional branching

1-1 Extracting the first 1 character and the last 2 characters of read data. 3-1 Outputting the type of read codes

function readformatEvent() function readformatEvent()

local read_data local data = readResult():symbolType() -- Stores code types.
read_data = readResult():readData() -- Obtains the code reading result. if data == 1 then -- Conditionally branches according
read_data = left(read_data,1)..right(read_data,2) -- Extracts 1 character on the left return "QR" to the type of code.
return(read_data) and 2 characters on the right. elseif data == 2 then
end return "DataMatrix"
elseif data == 5 then
return "GS1 DataBar"
Execution result elseif data == 6 then
return "CODE39"
elseif data == 7 then
Read data : keyence
return "ITF"
Execution result : kce elseif data == 9 then
return "Codabar"
elseif data == 10 then
1-2 Deleting the first 1 character of read data. return "JAN/EAN/UPC"
elseif data == 11 then
function readformatEvent() return "CODE128"
local read_data elseif data == 0 then
local datalength return "no data"
read_data = readResult():readData() -- Stores read data in the variable. end
datalength = string.len(read_data) -- Obtains the length of read data return "other"
read_data = mid(read_data,2,datalength-1) -- Extracting character strings from end
return(read_data) the second character to the end.
end
Execution result

Execution result
Read data : keyence

Execution result : DataMatrix

Read data : keyence
* The symbolType function in "5-2 Data acquisition functions" (Page 10) is
Execution result : eyence
used.

1-3 Deleting all unnecessary zeros at the beginning of barcode.

3-2 Branching according to the read results (OK/NG/ERROR)
function readformatEvent()
local read_data = readResult():readData() -- Obtains the code reading result. function readformatEvent() -- Branches according to the read
local data local r_data = result() results (OK/NG/ERROR).
data = string.gsub(read_data,"^0+","") -- Remove consecutive zeros from local data = readResult():readData()
return(data) the start. if r_data == 0 then -- OK image
end return "OK:"..data
elseif r_data == 1 then -- Comparison NG
return "NG:"..data
Execution result elseif r_data == 2 then -- READ ERROR
return "ERROR:"..data
end
Read data : 00000143 return "result has no return"
end
Execution result : 143

Execution result

2 Count
Read data : keyence

Execution result : OK:keyence (Reading success)

2-1 Counting the number of readings

3-3 Branching after looking at the first 1 character of read data

local count = 0 -- Retains count.*1
function readformatEvent()
local maxCount = 5 -- If codes are read 5 times or more, function readformatEvent()
local data "5 count over" is returned. local data = readResult():readData() -- Obtains the code reading result.
while count < maxCount do local header = left(data,1) -- Obtains the first 1 character.
count = count + 1 if header == "1" then
data = readResult():readData() .. ":count_data is"..count return "A"
return data elseif header == "2" then
end return "B"
return "5 count over" else
end return "Z"
end
return "other"
Execution result end

Read data : keyence Execution result

Number of readings : n (n=1 to 4) n=5 and more
Execution result : keyence:count_data is n 5 count over Read data : 1SR-D100 2SR-D110 3SR-D100HA
*1 The variable value defined here is initialized when the script file is sent again or Execution result :A B Z
the SR main unit is reset.
* When the Master/Slave function is used, the count is not correct.

15 GB SR SCRIPT RM
 4 Comparison 4-5 Date comparison

4-1 Comparison when specific characters are included in read data function readformatEvent()
local year=2012
local month=12
function readformatEvent() local date=22
local o_data= "" local code_Year
if string.match(readResult():readData(),"456") then -- When "456" is included in read data local code_Month
o_data = readResult():readData() .. "_OK" -- Appends "_OK" to the end of read data. local code_Date
else -- Other cases local read_data = readResult():readData()
o_data = readResult():readData() .. "_NG" -- Appends "_NG" to the end of read if string.len(read_data) < 8 then
end data. return("reading data is not correct")
return (o_data) end
end code_Year = tonumber(left(read_data ,4)) -- Extracts date information and
code_Month = tonumber(mid(read_data,5,2)) converts it to numerical values.
code_Date = tonumber(mid(read_data,7,2))
Execution result
if code_Year < year then
Read data : 123456789 return "The year is not correct"
elseif code_Month < month then
Execution result : 123456789_OK return "The month is not correct"
elseif code_Date < date then
( "3-5 Pattern matching" (Page 7)is used.) return "The date is not correct"
end
return ("OK") -- Returns OK.
4-2 Comparison when control characters are included in read data
end

function readformatEvent()
local o_data= "" Execution result
if string.match(readResult():readData(),"%c") then -- When control characters are included in read data
o_data = "OK" -- Outputs "OK".
Read data : 22001225. 20111222
else -- Other cases
o_data ="NG" -- Outputs "NG". Execution result : OK The year is not correct
end
return (o_data) This is used to control expiration dates, etc. The date data in the barcode is
end compared with the reference date and output.

Execution result

Read data : ABC<HT>123

Execution result : OK

( "3-5 Pattern matching" (Page 7)is used.)

4-3 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","") -- Deletes control characters
read_data=string.gsub(read_data,"%z","") -- Deletes NULL<0x00>
return(read_data)
end

Execution result

Read data : <SOH><SOH>123

Execution result : 123

( "3-5 Pattern matching" (Page 7)is used.)

4-4 Deleting <LF>(0x0A) when it is included in read data

function readformatEvent()
local read_data
read_data=readResult():readData()
read_data=string.gsub(read_data,"\010","") -- Deletes [LF]<0x0A>(010 in
return(read_data) decimal number)
end

Execution result

Read data : ABC<LF>123

Execution result : ABC123

GB SR SCRIPT RM 16
 5 Calculations 5-2 Obtaining angular degrees of a tilted barcode

function readformatEvent()
5-1 Obtaining angular degrees of a tilted 2D code
local o_data_u
local o_data --Output data
function readformatEvent()
if result() == 2 then -- Displays the message at read if result() == 2 then --Displays the message at read
return "READ_ERROR" error. return "READ_ERROR" error.
end end
local o_data
local data = readResult():cornerCoordinates() -- Obtains the coordinates at 4 positions of code. local data = readResult():cornerCoordinates() -- Obtains the coordinates at 4 positions of code.
local x1_y1 = field(data,1,":") -- x1/y1:x2/y2:x3/y3:x4/y4 local x1_y1 = field(data,1,":") --x1/y1:x2/y2:x3/y3:x4/y4
local x2_y2 = field(data,2,":") local x2_y2 = field(data,2,":")
local x1 = tonumber(field(x1_y1,1,"/")) local x3_y3 = field(data,3,":")
local y1 = tonumber(field(x1_y1,2,"/")) local x4_y4 = field(data,4,":")
local x2 = tonumber(field(x2_y2,1,"/")) local x1 = tonumber(field(x1_y1,1,"/")) --Converts it to numerical values
local y2 = tonumber(field(x2_y2,2,"/")) local y1 = tonumber(field(x1_y1,2,"/")) and assigns the value to the
if (x1 - x2) == 0 then local x2 = tonumber(field(x2_y2,1,"/")) variable.
o_data = "90".."[deg]_"..readResult():readData() local y2 = tonumber(field(x2_y2,2,"/"))
return (o_data) local x3 = tonumber(field(x3_y3,1,"/"))
elseif (y1 - y2) == 0 then local y3 = tonumber(field(x3_y3,2,"/"))
o_data = "0".."[deg]_"..readResult():readData() local x4 = tonumber(field(x4_y4,1,"/"))
return (o_data) local y4 = tonumber(field(x4_y4,2,"/"))
else
o_data = (y1 - y2)/(x2 - x1)
o_data = math.atan(o_data) -- Obtains arctan. if (x3 - x2) == 0 then
o_data = math.deg(o_data) -- Radian --> Converted to deg(°). if (y3 - y2) > 0 then
o_data = math.floor(o_data) -- Truncates decimals. o_data_u = 0
o_data = o_data.."[deg]_"..readResult():readData() else
return (o_data) -- Appends read data to output. o_data_u = 180
end end
end elseif (y3 - y2) == 0 then
if (x3 - x2) > 0 then
o_data_u = -90
Execution result else
o_data_u = 90
end
Read Data : else
o_data_u = (y3 - y2)/(x3-x2)
o_data_u = math.atan(o_data_u)
Execution result : 45[deg]_keyence 0[deg]_keyence o_data_u = math.deg(o_data_u)
o_data_u = math.floor(o_data_u)
Angular degrees when a workpiece is read from the front are obtained.
* If it is read from angles other than the front, correct angular degrees cannot be if (x3 > x2) then
obtained. o_data_u = -90 + o_data_u
else
* Set the "partition mark" for SR to ":" (colon).
o_data_u = 90 + o_data_u
end
end

o_data = o_data_u.."[deg]_"..readResult():readData() --Appends read data to output.

return (o_data)

end

Execution result

Read Data

Execution result
:

*SR* *SR*
: 30[deg]_SR 0[deg]_SR

Angular degrees when a workpiece is read from the front are obtained.
* If it is read from angles other than the front, correct angular degrees cannot be
obtained.
* Set the "partition mark" for SR to ":" (colon).

5-3 Bit calculations

function readformatEvent()
local a ={}
a[1] = bitAnd(0,0)
a[2] = bitAnd(1,0)
a[3] = bitAnd(0,1)
a[4] = bitAnd(1,1)
return(a[1]..a[2]..a[3]..a[4])
end

Execution result

Read Data : P002

Execution result : 0001

17 GB SR SCRIPT RM
 6 Editing read image file names 7 Controlling output terminals
To use scripts to control the output terminals, you have to set "Enable scripts," and
6-1 Appending read data to the read image file name then configure the settings as shown below.

function nameformatEvent()
local read_data
read_data = readResult():readData() -- Obtains the code reading result.
return(read_data)
end

Execution result

Read data : keyence

Execution result : keyence.bmp

* The read data is specified as the image file name. If a code with exactly the same
data contents is read, the same image file name is adopted. In this case, the old
file is overwritten.

6-2 Appending date and time to the read image file name
7-1 Controlling output terminals (OK/NG/ERROR)
function nameformatEvent()
return(time()) -- Obtains date information.
end function readformatEvent()
local r_data = result()
local data = readResult():readData()
Execution result
if r_data == 0 then --If the result is OK, turn on OUT1.
outonEvent(1)
Read data : keyence
elseif r_data == 2 then --If the result is ERROR, turn on
Execution result : 20121222120001.bmp
outonEvent(2) OUT2.
* Sending settings from AutoID Network Navigator to the SR-5000 Series else --In all other situations, turn on
synchronizes the time of the PC to that of the SR-5000 Series. outonEvent(1) OUT1 and OUT2.
outonEvent(2)
end
6-3 Appending date and time and read data to the read image file name return (data)

end
function nameformatEvent()
local read_data
read_data = readResult():readData() -- Obtains the code reading result. Execution result
read_data = time().."_"..read_data -- Appends date information.
return(read_data)
end
Read data : keyence

Execution result Execution result : OUT1 turns on.

Read data : keyence 7-2 Preventing duplicate reading

Execution result : 20121222120001_keyence.bmp
local g_latestData = ""
* Sending settings from AutoID Network Navigator to the SR-5000 Series
synchronizes the time of the PC to that of the SR-5000 Series. function readformatEvent()
local r_data = result() --Branching depending on the result (OK/ERROR)
local readData = readResult():readData() --Read data
if r_data == 0 then --OK
if g_latestData == readData then
return ""
end
g_latestData = readData
outonEvent(1)
return readData
--ERROR
elseif r_data == 2 then
outonEvent(2)
return "ERROR"
end

end

Execution result

Read data : keyence

Execution result : keyence (The same data is not output twice.)

GB SR SCRIPT RM 18
 8 Controlling triggers with scripts 9 Confirmation commands
To control triggers with scripts, you have to set "Enable scripts," and then configure
the settings as shown below. 9-1 MAC address confirmation command

function readformatEvent()
local output_data
output_data=execCmd("EMAC") -Execute the command.
return(output_data)
end

Execution result

8-1 Continuing reading until the character "S" is read at the start of the data Execution result: OK,EMAC,0001FC2D8206

function readformatEvent()
local i 9-2 Reader explanation confirmation command
local read_data
local output_data You can use the SR-5000 to obtain the values set below.

for i = 1, readCount() do
read_data = readResult(i):readData()
if left(read_data,1) == "S" then
return("S data is found!")
elseif result() == 0 then
output_data = "This data isn't S"
invokeNextShot() --Continue reading.
else
output_data = "Read ERROR"
invokeNextShot() --Continue reading.
end
end
return (output_data)

end

Execution result

Read data : S001 P002

Execution result : "S data is found!" "Read ERROR!"

8-2 Detecting timing input turning off

function readformatEvent() function readformatEvent()

invokeNextShot() --Continue reading. local output_data
if isTriggerActive() == 0 then output_data=execCmd("RP,620") -Execute the command.
return("Trigger off") --Detect the trigger being turned off. return(output_data)
else end
return(scriptExecNum()) --Count the number of times the
end script has been executed.
end
Execution result
Execution result : OK,RP,ABCDEFGH
Execution result

Read data : S001 10 SR WEB Monitor statistical information

Execution result : 1
2 10-1 Displaying the count information in SR WEB Monitor
3
Trigger OFF
local i=0
function readformatEvent()
i=i+1
stat.setName(1,"Count")
stat.setValue(1,i)

return (readResult():readData())
end

Execution result

Read data : keyence

Execution result : Count:1 (displayed in the web browser)

19 GB SR SCRIPT RM
8-1 ASCII code table Pattern matching

Pattern Meaning
High-order 4 bits . All characters (arbitrary 1 character)

Hexadecimal %a Character
0 1 2 3 4 5 6 7
number %c Control character (0x01 to 0x1F, 0x7F)
%d Number
Binary
0000 0001 0010 0011 0100 0101 0110 0111 %l Alphabet lowercase
number
%p Symbol (! " # $ % & ' ( ) * + , - . / : ; > = < ? @ [ \ ] ^ _ ` { | })
NUL DLE (SP) 0 @ P ` p
0 0000 %s Space character (0x09,0x0a,0x0b,0x0c,0x0d,0x20)
000 016 032 048 064 080 096 112
SOH DC1 ! 1 A Q a q %u Alphabet uppercase
1 0001
001 017 033 049 065 081 097 113 %w Alphabet and number
STX DC2 " 2 B R b r %x Hexadecimal number (0 to 9, a to f, A to F)
2 0010
002 018 034 050 066 082 098 114 %z null character
ETX DC3 # 3 C S c s % character*1 Literal character
3 0011
003 019 035 051 067 083 099 115
*1 Specify characters other than alphanumeric characters
EOT DC4 $ 4 D T d t
4 0100
004 020 036 052 068 084 100 116

5 0101
ENQ
005
ACK
NAK
021
SYN
%
021
&
5
053
6
E
069
F
U
085
V
e
101
f
u
117
v
8-3 Code type
6 0110
006 022 038 054 070 086 102 118

Low- 7 0111
BEL ETB ' 7 G W g w Code type list used for symbolType of readResult(idx)
007 023 039 055 071 087 103 119
order 4
bits BS CAN ( 8 H X h x
8 1000 Code type Return value of symbolType
008 024 040 056 072 088 104 120
Reading error 0
HT EM ) 9 I Y i y
9 1001 QR 1
009 025 041 057 073 089 105 121
LF SUB * : J Z j z DataMatrix 2
A 1010
010 026 042 058 074 090 106 122 PDF417/MicroPDF 3
VT ESC + ; K [ k { GS1 DataBar 5
B 1011
011 027 043 059 075 091 107 123 CODE39 6
CL FS , < L \ l | ITF 7
C 1100
012 028 044 060 076 092 108 124
2of5 8
CR GS - = M ] m }
D 1101 NW-7(Codabar) 9
013 029 045 061 077 093 109 125
JAN/EAN/UPC 10
SOH RS . > N ^ n ~
E 1110 CODE128 11
014 030 046 062 078 094 110 126
SI US / ? O _ o DEL COOP2of5 12
F 1111
015 031 047 063 079 095 111 127 CODE93 13
CC-A/B(GS1 DataBar) 14

8-2
CC-A/B(JAN/EAN/UPC) 15

Reserved words/Language CC-A/B/C(GS-128)

Postal
16
17
elements Pharmacode 18
DotCode 20

Reserved word list

and break do else elseif end false for function

goto if in local nil not or repeat return
then true until while

* Do not use variables/functions starting with "_" (underscore).

Priority of operator

High ^
not # - (unary)
* / %
+ -
..
< > <= >= ~= ==
and
Low or

GB SR SCRIPT RM 20
 Code type list used for symbolIdentifier of readResult(idx) 8-4 Troubleshooting
Code type Detail Symbol ID
QR : Model 1 ]Q0 The script does not operate.
: Model 2, ECI not applied ]Q1
: Model 2, ECI applied ]Q2 If codes can be read normally but the script does not operate, the script execution
: Model 2, ECI not applied, FNC1 (1st) ]Q3 setting of the SR-5000 Series may not be set to "Enable". Using the AutoID
: Model 2, ECI applied, FNC1 (1st) ]Q4 Network Navigator, set the script execution setting to "Enable".
: Model 2, ECI not applied, FNC1 (2nd) ]Q5
* For using the AutoID Network Navigator, refer to the corresponding user's
manual.
: Model 2, ECI applied, FNC1 (2nd) ]Q6
DataMatrix : ECC 200 ]d1
: ECC 200, FNC1 (1st) ]d2
Expected results cannot be achieved.
: ECC 200, FNC1 (2nd) ]d3
Debug according to "6-1 Debug methods" (Page 13)
: ECC 200, ECI applied ]d4
: ECC 200, ECI applied, FNC1 (1st) ]d5 An error occurs when executed.
: ECC 200, ECI applied, FNC1 (2nd) ]d6
CODE39 No check digit validation ]A0 See the applicable error message on "6-2 Error message list" (Page 14), and
Check digit is validated and transmitted. ]A1 revise the program.
Check digit is validated but not transmitted. ]A3
ITF No check digit validation ]I0 Barcodes/2D codes cannot be read.
Check digit is validated and transmitted. ]I1
Check digit is validated but not transmitted. ]I3 Reading setting may not be correctly made on your code reader. Using the AutoID
NW-7(Codabar) ]F0 Network Navigator, make the reading setting for the SR-5000 Series.
JAN/EAN/UPC UPC-A, UPC-E, JAN/EAN13 ]E0 * For using the AutoID Network Navigator, refer to the corresponding user's
JAN/EAN8 ]E4
manual.

8-5
UPC-A, UPC-E, JAN/EAN13
]E3

CODE128
Addon 2, addon 5
FNC1 not included. ]C0 Copyright indication
FNC1 on the first digit (GS1-128). ]C1
FNC1 on the second digit. ]C2 This software uses the following libraries:
GS1 Databar ]e0 Lua:
PDF417, Standard ]L0 Copyright (c) 1994-2017 Lua.org, PUC-Rio.
MicroPDF417 Extended channel interpretation ]L1
Basic channel interpretation ]L2
CODE93 ]G0
2of5 ]S0
COOP2of5 ]X0
Trioptic CODE39 ]A8
Postal ]X0
DotCode generic data ]J0
GS1 format (GS1 DotCode) ]J1
Application Specific ]J2
generic data + ECI ]J3
GS1 format (GS1 DotCode) + ECI ]J4
Application Specific + ECI ]J5

21 GB SR SCRIPT RM
 Revision History WARRANTIES AND DISCLAIMERS
(1) KEYENCE warrants the Products to be free of defects in materials and workmanship
Date of printing Version Revision contents for a period of one (1) year from the date of shipment. If any models or samples were
April 2020 Official release 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. Any Products found to be defective
must be shipped to KEYENCE with all shipping costs paid by Buyer or offered to
KEYENCE for inspection and examination. Upon examination by KEYENCE,
KEYENCE, at its sole option, will refund the purchase price of, or repair or replace at
no charge any Products found to be defective. This warranty does not apply to any
defects resulting from any action of Buyer, including but not limited to improper
installation, improper interfacing, improper repair, unauthorized modification,
misapplication and mishandling, such as exposure to excessive current, heat,
coldness, moisture, vibration or outdoors air. Components which wear are not
warranted.
(2) KEYENCE is pleased to offer suggestions on the use of its various Products. They are
only suggestions, and it is Buyer's responsibility to ascertain the fitness of the
Products for Buyer's intended use. KEYENCE will not be responsible for any damages
that may result from the use of the Products.
(3) The Products and any samples ("Products/Samples") supplied to Buyer are not to be
used internally in humans, for human transportation, as safety devices or fail-safe
systems, unless their written specifications state otherwise. Should any Products/
Samples be used in such a manner or misused in any way, KEYENCE assumes no
responsibility, and additionally Buyer will indemnify KEYENCE and hold KEYENCE
harmless from any liability or damage whatsoever arising out of any misuse of the
Products/Samples.
(4) OTHER THAN AS STATED HEREIN, THE PRODUCTS/SAMPLES ARE PROVIDED
WITH NO OTHER WARRANTIES WHATSOEVER. ALL EXPRESS, IMPLIED, AND
STATUTORY WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, AND NON-INFRINGEMENT OF PROPRIETARY RIGHTS, ARE
EXPRESSLY DISCLAIMED.
IN NO EVENT SHALL KEYENCE AND ITS AFFILIATED ENTITIES BE LIABLE TO
ANY PERSON OR ENTITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, PUNITIVE,
SPECIAL OR CONSEQUENTIAL DAMAGES (INCLUDING, WITHOUT LIMITATION,
ANY DAMAGES RESULTING FROM LOSS OF USE, BUSINESS INTERRUPTION,
LOSS OF INFORMATION, LOSS OR INACCURACY OF DATA, LOSS OF
PROFITS, LOSS OF SAVINGS, THE COST OF PROCUREMENT OF
SUBSTITUTED GOODS, SERVICES OR TECHNOLOGIES, OR FOR ANY MATTER
ARISING OUT OF OR IN CONNECTION WITH THE USE OR INABILITY TO USE
THE PRODUCTS, EVEN IF KEYENCE OR ONE OF ITS AFFILIATED ENTITIES
WAS ADVISED OF A POSSIBLE THIRD PARTY'S CLAIM FOR DAMAGES OR
ANY OTHER CLAIM AGAINST BUYER. In some jurisdictions, some of the foregoing
warranty disclaimers or damage limitations may not apply.

BUYER'S TRANSFER OBLIGATIONS:

If the Products/Samples purchased by Buyer are to be resold or delivered to a third
party, Buyer must provide such third party with a copy of this document, all
specifications, manuals, catalogs, leaflets and written information provided to Buyer
pertaining to the Products/Samples.
E 1101-3

 BarcodeReader.com
http://www.barcodereader.com/
You can download technical documents useful for BL/SR/RF introduction and
operation.

GB SR SCRIPT RM 22
23 GB SR SCRIPT RM
 Copyright (c) 2020 KEYENCE CORPORATION. All rights reserved.

GB SR SCRIPT RM 24 193175GB 2030-1 957GB Printed in Japan