Omron TMFlow Script Language Owner's manual

Script Language Software version: TMflow 1.80

1

I664-E-01

Script Language

Manual

Original Instruction

Script Language Software version: TMflow 1.80

2

This Manual contains information of the Techman Robot product series (hereinafter referred to as the TM Robot).

The information contained herein is the property of Techman Robot Inc. (hereinafter referred to as the

Corporation). No part of this publication may be reproduced or copied in any way, shape or form without prior

authorization from the Corporation. No information contained herein shall be considered an offer or commitment.

It may be subject to change without notice. This Manual will be reviewed periodically. The Corporation will not be

liable for any error or omission.

logo is registered trademark of TECHMAN ROBOT INC. in Taiwan and other countries and the

company reserves the ownership of this manual and its copy and its copyrights.

Script Language Software version: TMflow 1.80

3

Terms and Conditions Agreement

Warranty Limitations of Liability

Warranties

• Exclusive Warranty

Omron’s exclusive warranty is that the Products will be free from defects in materials and workmanship

for a period of twelve months from the date of sale by Omron (or such other period expressed in writing

by Omron). Omron disclaims all other warranties, express or implied.

• Limitations

OMRON MAKES NO WARRANTY OR REPRESENTATION, EXPRESS OR IMPLIED, ABOUT NON-INFRINGEMENT,

MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OF THE PRODUCTS. BUYER ACKNOWLEDGES

THAT IT ALONE HAS DETERMINED THAT THE PRODUCTS WILL SUITABLY MEET THE REQUIREMENTS OF

THEIR INTENDED USE.

Omron further disclaims all warranties and responsibility of any type for claims or expenses based

on infringement by the Products or otherwise of any intellectual property right.

• Buyer Remedy

Omron’s sole obligation hereunder shall be, at Omron’s election, to (i) replace (in the form originally

shipped with Buyer responsible for labor charges for removal or replacement thereof) the non-complying

Product, (ii) repair the non-complying Product, or (iii) repay or credit Buyer an amount equal to the

purchase price of the non-complying Product; provided that in no event shall Omron be responsible for

warranty, repair, indemnity or any other claims or expenses regarding the Products unless Omron’s

analysis confirms that the Products were properly handled, stored, installed and maintained and not

subject to contamination, abuse, misuse or inappropriate modification. Return of any Products by Buyer

must be approved in writing by Omron before shipment. Omron Companies shall not be liable for the

suitability or unsuitability or the results from the use of Products in combination with any electrical or

electronic components, circuits, system assemblies or any other materials or substances or environments.

Any advice, recommendations or information given orally or in writing, are not to be construed as an

amendment or addition to the above warranty.

See http://www.omron.com/global/ or contact your Omron representative for published information.

Script Language Software version: TMflow 1.80

4

Limitation of Liability; Etc

OMRON COMPANIES SHALL NOT BE LIABLE FOR SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL

DAMAGES, LOSS OF PROFITS OR PRODUCTION OR COMMERCIAL LOSS IN ANY WAY CONNECTED WITH THE

PRODUCTS, WHETHER SUCH CLAIM IS BASED IN CONTRACT,

WARRANTY, NEGLIGENCE OR STRICT LIABILITY.

Further, in no event shall liability of Omron Companies exceed the individual price of the Product on which

liability is asserted.

Application Considerations

Suitability of Use

Omron Companies shall not be responsible for conformity with any standards, codes or regulations which

apply to the combination of the Product in the Buyer’s application or use of the Product. At Buyer’s

request, Omron will provide applicable third party certification documents identifying ratings and

limitations of use which apply to the Product. This information by itself is not sufficient for a complete

determination of the suitability of the Product in combination with the end product, machine, system, or

other application or use. Buyer shall be solely responsible for determining appropriateness of the

particular Product with respect to Buyer’s application, product or system. Buyer shall take application

responsibility in all cases.

NEVER USE THE PRODUCT FOR AN APPLICATION INVOLVING SERIOUS RISK TO LIFE OR PROPERTY

WITHOUT ENSURING THAT THE SYSTEM AS A WHOLE HAS BEEN DESIGNED TO ADDRESS THE RISKS, AND

THAT THE OMRON PRODUCT(S) IS PROPERLY RATED AND INSTALLED FOR THE INTENDED USE WITHIN THE

OVERALL EQUIPMENT OR SYSTEM.

Programmable Products

Omron Companies shall not be responsible for the user’s programming of a programmable Product, or any

consequence thereof.

Disclaimers

Performance Data

Data presented in Omron Company websites, catalogs and other materials is provided as a guide for the

user in determining suitability and does not constitute a warranty. It may represent the result of Omron’s

test conditions and the user must correlate it to actual application requirements. Actual performance is

subject to the Omron’s Warranty and Limitations of Liability.

Script Language Software version: TMflow 1.80

5

Change in Specifications

Product specifications and accessories may be changed at any time based on improvements and other

reasons. It is our practice to change part numbers when published ratings or features are changed, or

when significant construction changes are made. However, some specifications of the Product may be

changed without any notice. When in doubt, special part numbers may be assigned to fix or establish key

specifications for your application. Please consult with your Omron representative at any time to confirm

actual specifications of purchased Product.

Errors and Omissions

Information presented by Omron Companies has been checked and is believed to be accurate; however,

no responsibility is assumed for clerical, typographical or proofreading errors or omissions.

Script Language Software version: TMflow 1.80

6

REVISION HISTORY ...................................................................................................... 15

1. VARIABLE DECLARATION COMMAND ................................................................... 16

1.1 int ...................................................................................................................................................... 16

1.2 float................................................................................................................................................... 16

1.3 double ............................................................................................................................................... 16

1.4 bool ................................................................................................................................................... 17

1.5 string ................................................................................................................................................. 17

1.6 list ..................................................................................................................................................... 18

1.7 array .................................................................................................................................................. 18

1.8 listarray ............................................................................................................................................. 19

1.9 datatable........................................................................................................................................... 19

1.10 datetime ........................................................................................................................................... 20

1.11 file ..................................................................................................................................................... 20

1.12 modbusTcp ....................................................................................................................................... 21

1.13 modbusRtu ....................................................................................................................................... 22

1.14 serialport .......................................................................................................................................... 22

1.15 network ............................................................................................................................................ 23

1.17 thread ............................................................................................................................................... 24

1.18 timer ................................................................................................................................................. 25

1.19 filepath.............................................................................................................................................. 25

1.20 importlibrary ..................................................................................................................................... 26

2. METHOD AND PROPERTY NAMES ......................................................................... 26

2.1 ClickEvent ......................................................................................................................................... 26

2.2 DisableMonitor ................................................................................................................................. 27

2.3 EnableMonitor .................................................................................................................................. 27

2.4 & ....................................................................................................................................................... 28

2.5 empty ................................................................................................................................................ 29

Contents

Script Language Software version: TMflow 1.80

7

2.6 newLine ............................................................................................................................................ 29

2.7 LF ...................................................................................................................................................... 29

2.8 Tab .................................................................................................................................................... 29

2.9 space ................................................................................................................................................. 29

2.10 IsNull ................................................................................................................................................. 30

2.11 IsConnected ...................................................................................................................................... 30

2.12 Where ............................................................................................................................................... 31

2.13 ReadExcelSheet ................................................................................................................................ 31

2.14 Query ................................................................................................................................................ 32

2.15 ModifyQuery..................................................................................................................................... 32

2.16 Merge ............................................................................................................................................... 32

2.17 DelValueAt ........................................................................................................................................ 33

2.18 DelValue ........................................................................................................................................... 33

2.19 AddValue .......................................................................................................................................... 34

2.20 DataBind ........................................................................................................................................... 34

2.21 GetCellValue ..................................................................................................................................... 35

2.22 CountRow ......................................................................................................................................... 35

2.23 CountColumn .................................................................................................................................... 36

2.24 DataSqlCMD ...................................................................................................................................... 36

2.25 DataSource ....................................................................................................................................... 36

2.26 CopyUIControl .................................................................................................................................. 37

2.27 DeleteUIControl ................................................................................................................................ 37

2.28 ShowWindow.................................................................................................................................... 38

2.29 HideWindow ..................................................................................................................................... 38

2.30 EmbedSubWindow ........................................................................................................................... 39

2.31 HideSubWindow ............................................................................................................................... 39

2.32 ClientSize .......................................................................................................................................... 39

2.33 IsRunning .......................................................................................................................................... 40

Script Language Software version: TMflow 1.80

8

2.34 Execute ............................................................................................................................................. 40

2.35 SetProject ......................................................................................................................................... 41

2.36 Min .................................................................................................................................................... 41

2.37 Tan .................................................................................................................................................... 42

2.38 Floor .................................................................................................................................................. 42

2.39 Cos .................................................................................................................................................... 42

2.40 Sin ..................................................................................................................................................... 43

2.41 Abs .................................................................................................................................................... 43

2.42 NumReverse ..................................................................................................................................... 44

2.43 Max ................................................................................................................................................... 44

2.44 Round ............................................................................................................................................... 44

2.45 Random ............................................................................................................................................ 45

2.46 GetTargetTextValue .......................................................................................................................... 45

2.47 GetMouseLeaveUIName .................................................................................................................. 46

2.48 GetMouseEnterUIName ................................................................................................................... 46

2.49 GetClickUIName................................................................................................................................ 47

2.50 CopyFromScreenToFile ..................................................................................................................... 47

2.51 GetTagValue ..................................................................................................................................... 47

2.52 UpdateTagValue ............................................................................................................................... 48

2.53 GetValue ........................................................................................................................................... 48

2.54 ChangeValue ..................................................................................................................................... 49

2.55 Ping ................................................................................................................................................... 49

2.56 Send .................................................................................................................................................. 50

2.57 ReceiveData ...................................................................................................................................... 51

2.58 Open ................................................................................................................................................. 51

2.59 Close ................................................................................................................................................. 51

2.60 Play ................................................................................................................................................... 52

2.61 Pause ................................................................................................................................................ 52

Script Language Software version: TMflow 1.80

9

2.62 Start .................................................................................................................................................. 53

2.63 Stop ................................................................................................................................................... 53

2.64 FullScreen ......................................................................................................................................... 54

2.65 GetStatus .......................................................................................................................................... 54

2.66 EnableLoop ....................................................................................................................................... 55

2.67 BackgroundImage ............................................................................................................................. 55

2.68 Checked ............................................................................................................................................ 55

2.69 Dock .................................................................................................................................................. 56

2.70 Enabled ............................................................................................................................................. 56

2.71 SetFocus ............................................................................................................................................ 57

2.72 ForeColor .......................................................................................................................................... 57

2.73 BackColor .......................................................................................................................................... 58

2.74 Items ................................................................................................................................................. 58

2.75 CurrentIndex ..................................................................................................................................... 58

2.76 RemoveItem ..................................................................................................................................... 59

2.77 MaxDropDownItems ........................................................................................................................ 59

2.78 Left .................................................................................................................................................... 60

2.79 Top .................................................................................................................................................... 60

2.80 Length ............................................................................................................................................... 61

2.81 MinLength......................................................................................................................................... 61

2.82 GetName........................................................................................................................................... 62

2.83 LeavedRowIndex............................................................................................................................... 62

2.84 SelectedRowIndex ............................................................................................................................ 62

2.85 ReadLinesTolist ................................................................................................................................. 63

2.86 ReadLinesBySplitTolist ...................................................................................................................... 63

2.87 Size .................................................................................................................................................... 64

2.88 Target ................................................................................................................................................ 64

2.89 URL .................................................................................................................................................... 65

Script Language Software version: TMflow 1.80

10

2.90 Visible ............................................................................................................................................... 65

2.91 Refresh .............................................................................................................................................. 66

2.92 ExecuteAction ................................................................................................................................... 66

2.93 SelectedTabPageIndex...................................................................................................................... 66

2.94 call ..................................................................................................................................................... 67

2.95 exit .................................................................................................................................................... 67

2.96 for ..................................................................................................................................................... 68

2.97 GetUserGroup .................................................................................................................................. 68

2.98 GetUserName ................................................................................................................................... 69

2.99 if ........................................................................................................................................................ 69

2.100 messagebox ...................................................................................................................................... 70

2.101 return ................................................................................................................................................ 70

2.102 break ................................................................................................................................................. 70

2.104 switch ................................................................................................................................................ 71

2.105 while ................................................................................................................................................. 72

2.106 writelog ............................................................................................................................................. 73

2.107 FindIndex .......................................................................................................................................... 73

2.108 ChangeData ...................................................................................................................................... 74

2.109 SetStartDate ..................................................................................................................................... 74

2.110 SetEndDate ....................................................................................................................................... 74

2.111 ChangeDefinition .............................................................................................................................. 75

2.112 CreateDirectory ................................................................................................................................ 75

2.113 DeleteFile .......................................................................................................................................... 76

2.114 AddDay ............................................................................................................................................. 76

2.115 AddMilliSecond ................................................................................................................................. 76

2.116 AddMinute ........................................................................................................................................ 77

2.117 AddSecond ........................................................................................................................................ 77

2.118 AddYear ............................................................................................................................................ 78

Script Language Software version: TMflow 1.80

11

2.119 AddMonth ........................................................................................................................................ 78

2.120 AddHour ........................................................................................................................................... 79

2.121 GetDays ............................................................................................................................................ 79

2.122 GetHours........................................................................................................................................... 79

2.123 GetMilliSeconds ................................................................................................................................ 80

2.124 GetMinutes ....................................................................................................................................... 80

2.125 GetSeconds ....................................................................................................................................... 81

2.126 GetDay .............................................................................................................................................. 81

2.127 GetHour ............................................................................................................................................ 81

2.128 GetMonth ......................................................................................................................................... 82

2.129 GetMilliSecond ................................................................................................................................. 82

2.130 GetMinute ........................................................................................................................................ 83

2.131 GetSecond ........................................................................................................................................ 83

2.132 GetWeek ........................................................................................................................................... 84

2.133 GetYear ............................................................................................................................................. 84

2.134 GetDefinition .................................................................................................................................... 84

2.135 GetAllNames ..................................................................................................................................... 85

2.136 GetFileNames ................................................................................................................................... 85

2.137 GetDirectoryNames .......................................................................................................................... 86

2.138 GetMessage ...................................................................................................................................... 86

2.139 GetNow ............................................................................................................................................. 86

2.140 GetTimeSpanByDay .......................................................................................................................... 87

2.141 GetTimeSpanByHour ........................................................................................................................ 87

2.142 GetTimeSpanByMillisecond .............................................................................................................. 88

2.143 GetTimeSpanByMinute .................................................................................................................... 88

2.144 GetTimeSpanBySecond .................................................................................................................... 89

2.145 ReadInputs ........................................................................................................................................ 89

2.146 ReadCoils .......................................................................................................................................... 90

Script Language Software version: TMflow 1.80

12

2.147 ReadHoldingRegistersToFloat .......................................................................................................... 90

2.148 ReadHoldingRegistersToInt16 .......................................................................................................... 91

2.149 ReadHoldingRegistersToHex ............................................................................................................ 91

2.150 ReadHoldingRegistersToInt32 .......................................................................................................... 91

2.151 ReadHoldingRegistersToString ......................................................................................................... 92

2.152 ReadHoldingRegisters ....................................................................................................................... 92

2.153 ReadInputRegistersToHex ................................................................................................................ 93

2.154 ReadInputRegistersToInt16 .............................................................................................................. 93

2.155 ReadInputRegistersToFloat .............................................................................................................. 94

2.156 ReadInputRegistersToInt32 .............................................................................................................. 94

2.157 ReadInputRegistersToString ............................................................................................................. 95

2.158 ReadInputRegisters .......................................................................................................................... 95

2.159 WriteMultipleRegistersByString ....................................................................................................... 96

2.160 WriteMultipleRegisters .................................................................................................................... 96

2.161 WriteMultipleRegistersByHex .......................................................................................................... 97

2.162 WriteSingleCoil ................................................................................................................................. 97

2.163 WriteSingleRegister .......................................................................................................................... 98

2.164 IsError ............................................................................................................................................... 98

2.165 IsExisted ............................................................................................................................................ 99

2.166 IsWork ............................................................................................................................................... 99

2.167 SqlParameters ................................................................................................................................ 100

2.168 SetRequestParameters ................................................................................................................... 100

2.169 SetUrlParameters ........................................................................................................................... 101

2.170 GetWebApiValue ............................................................................................................................ 101

2.171 Submit ............................................................................................................................................. 101

2.172 WriteLines ....................................................................................................................................... 102

2.173 WriteLinesByAppend ...................................................................................................................... 102

2.174 WriteLinesBylist .............................................................................................................................. 103

Script Language Software version: TMflow 1.80

13

2.175 Image .............................................................................................................................................. 103

2.176 Text ................................................................................................................................................. 104

2.177 SystemVoice ................................................................................................................................... 104

2.178 ExecuteFunction ............................................................................................................................. 105

2.179 RunWinForm ................................................................................................................................... 105

2.180 UShortArrayToFloat ........................................................................................................................ 106

2.181 FloatToUShortArray ........................................................................................................................ 106

2.182 ToBytes ........................................................................................................................................... 107

2.183 BinaryToInt ..................................................................................................................................... 107

2.184 IntToHex ......................................................................................................................................... 108

2.185 HexToInt ......................................................................................................................................... 108

2.186 FloatToHex ...................................................................................................................................... 108

2.187 HexToFloat ...................................................................................................................................... 109

2.188 ToInt................................................................................................................................................ 109

2.189 ToFloat ............................................................................................................................................ 110

2.190 ToDouble ........................................................................................................................................ 110

2.191 callAsync ......................................................................................................................................... 111

2.192 callApplication ................................................................................................................................ 111

2.193 callDashboard ................................................................................................................................. 112

2.194 CustomMessageBox ....................................................................................................................... 112

2.195 GetServiceEngineIsWork ................................................................................................................ 113

2.196 GetDashboardErrorCode ................................................................................................................ 113

2.197 GetDashboardErrorMessage .......................................................................................................... 113

2.198 GetServiceEngineErrorCode ........................................................................................................... 114

2.199 GetServiceEngineErrorMessage ..................................................................................................... 114

2.200 TriggerSystemError ......................................................................................................................... 115

2.201 DelGroupDevice .............................................................................................................................. 115

2.202 AddGroupDevice ............................................................................................................................ 116

Script Language Software version: TMflow 1.80

14

2.203 GetDefaultProject ........................................................................................................................... 116

2.204 ChangeRobot .................................................................................................................................. 117

2.205 GetProjectListFromServiceEngine .................................................................................................. 117

2.206 GetPlayTotal ................................................................................................................................... 118

2.207 GetRobotVersion ............................................................................................................................ 118

2.208 GetRobotIP ..................................................................................................................................... 118

2.209 GetProjectListFromRobot ............................................................................................................... 119

2.210 RefreshProjectList ........................................................................................................................... 119

2.211 GetActivityRate ............................................................................................................................... 120

2.212 CancelGotoFirst .............................................................................................................................. 120

Script Language Software version: TMflow 1.80

15

Revision History

Revision Date Revised Content

01 January, 2021 Original release

Script Language Software version: TMflow 1.80

16

1. Variable declaration command

This chapter describes the command set related to TMflow in TM Operator Mode.

1.1 int

Declare as a numeric type

Syntax1

Syntax: int variable name = initial value

Parameter

Initial value

Return value

No return value

Description

Example: int i = 0

1.2 float

Declared as a single floating-point value type, the decimal point is accurate to the 7th digit

Syntax1

float variable name = initial value

Parameter

Initial value

Return value

No return value

Description

Example: float f = 34.7445

1.3 double

Declared as a double-floating-point numeric type, the decimal point is accurate to the 15th digit

Script Language Software version: TMflow 1.80

17

Syntax1

Syntax: double variable name = initial value

Parameter

Initial value

Return value

No return value

Description

Example: double f = 100.00007445

1.4 bool

Declared as boolean type

Syntax1

Syntax: bool variable name = initial value

Parameter

Variable initial value (true or false) (1 or 0)

Return value

No return value

Description

Example 1: bool b = false

Example 2: bool b = 0

1.5 string

Declared as a string type.(use reserved word “empty” for initiating a empty string).

Syntax1

Syntax: string variable name = initial value

Parameter

Script Language Software version: TMflow 1.80

18

Initial value

Return value

No return value

Description

Example 1: string s = ABC

Note : All string should be declared with double quotations.

1.6 list

Declared as a 1 dimensional dynamic array (i.e. the length is not fixed).

Syntax1

Syntax: list variable name = empty(data type on each cell is string)

Parameter

string

Return value

No return value

Description

Example: list ly = string

1.7 array

Declared as a 1 dimensional array type (the length of an array is always fixed as first declaration).

Syntax1

Syntax: array variable name = Type, Type, Type...(It is available to have different types of element in an array)

Parameter

Int、string、float…

Return value

No return value

Description

Example: array ay = int,string,sting,float (total 4 elements in an array)

Script Language Software version: TMflow 1.80

19

1.8 listarray

Declare as a 2 dimensional array (the columns are fixed in length while rows are not).

Syntax1

Syntax: listarray variable_name = Type, Type, Type… (It is available to have different types of element in an

listarray)

Note: the declaration defines the maximum number of elements on a row, if a row is already full, a newly

added element will be automatically assigned to a new row.

Parameter

Int、string、float…

Return value

No return value

Description

Example: listarray ly = int,int,int (The maximum number of elements on a row is 3)

1.9 datatable

Declared as a datatable type.

There are 3 types of declaration;

1. Self-defined datatable.

2. Declare by system data connection ID.

3. User-defined Database Connection format.

Syntax1

Syntax 1: datatable variable_name = column name@type,column name@type, column name@type...

Syntax 2: datatable variable_name = Database Connect ID

Syntax 3: datatable variable_name = int (Connection Method – 1: MSSQL, 2:Oracle, 3:MySQL),

string(Connection format, a string of data that can access an external DB)

Parameter

 Syntax 1: Define field name, type

Script Language Software version: TMflow 1.80

20

 Syntax 2: ID Code of Database Connect

 Syntax 3: Connection method, connection format

Return value

No return value

Description

Example 1: datatable dt = Index@int, Name@string, Price@float,Qty@int

Example 2: datatable dt = "a7ab1487-17ad-408e-ae49-d1f2a045ea2e"

Example 3: datatable dt = 1,"Data Source = .\SQL2014EXPRESS;Initial Catalog=Noah;Persist Security

Info=True;User ID=sa;Password=1234”

1.10 datetime

Declared as a DataTime type

Syntax1

Syntax: datetime variable_name = date format

Parameter

date format, you can refer to the Microsoft date format description

Reference URL:

https://docs.microsoft.com/zh-tw/dotnet/standard/base-types/custom-date-and-time-format-strings

Return value

No return value

Description

Example 1: datatime d = "yyyy/MM/dd or M/d/yyyy"

Example 2: datatime d = "MM/dd/yyyy hh:mm:ss" (if there are any space on the format, please use

double quotation marks to include)

Please refer to the manual for more DateTime formats

1.11 file

Declare a file object

Page is loading ...

Omron TMFlow Script Language Owner's manual

Omron TMFlow Script Language Owner's manual

Related papers

Other documents