User manual OMRON CX-SUPERVISOR SCRIPT REFERENCE REV2.0

[. . . ] W09E-EN-01 Software Release 2. 0 CX-Supervisor SCRIPT REFERENCE CX-Supervisor Script Language Software Revision 2. 0 OMRON CX-Supervisor ­ Script Language Notice OMRON products are manufactured for use according to proper procedures by a qualified operator and only for the purposes described in this manual. The following conventions are used to indicate and classify precautions in this manual. Always heed the information provided in them. Failure to heed precautions can result in injury to people or damage to the product. [. . . ] The template file can be written using any ASCII text editor, for instance a Text file (. TXT), a Rich Text file (. RTF) or a Hypertext file (. HTML). The report template is processed, dynamically replacing the point names with current values, and saved as output. txt. PrintReport Syntax returnstate = Printreport(ReportTemplateFile) Page 90 Revision 2. 0 OMRON Remarks Argument returnstate ReportTemplateFile Type bool string CHAPTER 6 ­ Functions and Methods Description Returnstate is `1' if the function is successful, or `0' otherwise. Pathname of the report template file. Typical Example PrintReport("report3. txt") The report template is processed, dynamically replacing the point names with current values, and printed to the default Windows printer. ViewReport Syntax returnstate = ViewReport(ReportTemplateFile) Remarks Argument returnstate ReportTemplateFile Type bool string Description Returnstate is `1' if the function is successful, or `0' otherwise. Pathname of the report template file. Typical Example ViewReport("report3. txt") Text Commands BCD Syntax result = BCD (value) Remarks Argument Value result Type ----Description Number to convert to Binary Coded Decimal (BCD). String containing BCD representation of value. Typical Example BCDStr = BCD(39) Revision 2. 0 Page 91 CHAPTER 6 ­ Functions and Methods In this example, `BCDstr' contains `00111001'. OMRON Bin Syntax result = Bin (value) Remarks Argument value result Type ----Description Number to be converted to a binary number. String containing binary representation of value. Typical Example BStr = Bin (20) In this example, `Bstr' contains `10100'. Chr Syntax result = Chr (value) Remarks Argument value result Type ----Description Extended ASCII value to convert to a character. String containing single character representation of value. Typical Example Char = Chr(65) In this example, `Char' contains `A'. FormatText Syntax textpoint = FormatText ("formattext", expression, . . . ) Page 92 Revision 2. 0 OMRON Remarks Argument textpoint formattext expression Type text point string Integer / real CHAPTER 6 ­ Functions and Methods Description A text point which holds the formatted text. The text (with appropriate formatting characters) that the result expression is inserted into. The value(s) or expression(s) that is inserted into formattext. Typical Examples TextPoint = FormatText ("Boiler temperature is %ld degrees. ", BoilerTemp) The value of the `BoilerTemp' point is inserted into the specified text at the position marked by the formatting characters (%ld) and then stored in the point `TextPoint'. If the value of `BoilerTemp' was 57 then the resultant text that is stored in `TextPoint' is as follows: "Boiler temperature is 57 degrees. " TextPoint = FormatText ("Boiler %ld temperature is %ld degrees. ", BoilerNo, BoilerTemp) The value of `BoilerNo' point is inserted at the first `%ld' marker and the value of the `BoilerTemp' point is inserted at the second `%ld' marker and the resulting string is stored in the point `TextPoint'. If the value of `BoilerNo' was 7 and the value of `BoilerTemp' was 43 then the resultant text stored in the `TextPoint' is as follows: "Boiler 7 temperature is 43 degrees. " Note: The formatting characters are standard `C' formatting characters (as used by the Clanguage sprintf function). Some commonly used types are: %ld. Prefix with decimal point and number to control position (for instance `%. 2f' for 2 decimal places); %s. Insert hexadecimal value (upper case HEX characters, for instance `FFFF'); %lx. Insert hexadecimal value (lower case HEX characters, for instance `ffff'); %c. Insert character (can be used to convert value to character, for instance to insert control character). With the text left aligned, and with a width field (for instance `%-6ld' to insert a value left aligned with a field 6 characters wide). Revision 2. 0 Page 93 CHAPTER 6 ­ Functions and Methods References OMRON More complex expressions (for instance controlling justification, decimal places, number base, etc. ) are also possible. Refer to any C language reference book for full details of the format used by the `sprintf' function. GetTextLength Syntax value = GetTextLength (textpoint) Remarks Argument textpoint returnpoint Type text Integer / real Description This is the point which has its text length counted. This is the point that holds the return value. Typical Example textpoint = "Hello World" count = GetTextLength (textpoint) The number of characters in `textpoint' is counted and the point `count' is set to the value 11. Hex Syntax result = Hex (value) Remarks Argument Value Result Type ----Description Number to be converted to a Hex number. String containing Hex representation of value. Typical Example HStr = Hex (44) In this example, `Hstr' contains `2C'. Left Syntax lefttext = Left(textpoint, noofchars) Page 94 Revision 2. 0 OMRON Remarks Argument textpoint noofchars lefttext Type text integer text CHAPTER 6 ­ Functions and Methods Description The text point containing the string that is to be manipulated. The number of characters to extract from the start of the string. Text point containing the specified range of characters. Typical Example textpoint = "abcdefgh" lefttext = Left(textpoint, 3) The text point `lefttext' contains the string `abc'. Message Syntax Message("message") Remarks Argument message Type string Description Contains the text string that is displayed in the message box. Typical Example Message("this is a message") The message `this is a message' is displayed in a Message Box. Mid Syntax midtext = Mid(textpoint, offset, noofchars) Remarks Argument textpoint offset noofchars midtext Type text integer integer text Description The text point containing the string that is to be manipulated. [. . . ] Supervisory Control and Data Acquisition. (see CX-Supervisor) Run Time Environment SCADA Revision 2. 0 Page 173 GLOSSARY OF TERMS ­ Script Language Server OMRON A Server is the central processing point of a Network which is accessible to all computers. Networks affect CX-Supervisor in that further associated options are available if the computer Network is connected. An application that can be used to view or interact with, whilst currently within CX-Supervisor. [. . . ]