Home

CX-Supervisor Script Language

1. Altitude Fuel Burning Lift Group 1 OpenLogView Balloon ItemList Both these commands will open the Data Log Viewer and load the Balloon log file and show the named items OpenLogView Balloon ItemList C Program Files Omron Cx SUPERVISOR App MySessionInfo txt This command will open the Data Log Viewer and Balloon log file as above but the Data Log Viewer will always appear in the same position and with the same settings not as it was last shown StartLogging Syntax returnstate or returnstate Revision 2 0 StartLogging datasetname StartLogging databaselink Page 109 CHAPTER 6 Functions and Methods OMRON Remarks ACT tee TI returnstate bool Optional 1 if the function is successful otherwise 0 datasetname text Name of Data Set to start logging as text point or constant databaselink text Name of Database link to start logging as text point or constant Typical Example StartLogging Process 1 This command will start logging of all items in the named data set If the file is closed it will be automatically opened StopLogging Syntax returnstate StopLogging datasetname or returnstate StopLogging databaselink Remarks Optional 1 if the function is successful otherwise 0 datasetname Text Name of Data Set to stop logging as text point or constant databaselink text Name of Database link to stop logging as text point or constant
2. Typical Example Result DBSupports CSV Recordsetl1 Delete Checks if records can be deleted in Recordset1 Page 122 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Note If the MovePrevious operation is not supported then only Forward Only cursor movements are supported DBUpdate Description Update the record being added in a Recordset Used in conjunction with DBAddNew to commit a new record Note DBUpdate is ONLY required when DBAddNew has been used at the Field level When DBAddNew is used at the Recordset level an additional DBUpdate is not required as this is performed automatically Syntax returnstate DBUpdate level Remarks returnstate 1 if the function is successful otherwise 0 level A text point or constant specifying the connection level This must be a Recordset level Typical Example DBAddNew Northwind Order Details OrderID DBAddNew Northwind Order Details ProductID DBAddNew Northwind Order Details Quantity DBAddNew Northwind Order Details UnitPrice DBUpdate Northwind Order Details Each required field is added to the new record using multiple calls to DBAddNew When the record is complete it is added to the Recordset by calling the DBUpdate function DBWrite Description Writes a set of records into a Recordset from the associated point s This function operates on both Recordset and Field levels At the Recordset level all the associated point
3. Compound Assign OP Boolean Comments F F or II Constants Literals NaN null true false Infinity undefined Control flow break continue for for in if else return while Dates and Time Date getDate getDay getFullYear getHours getMilliseconds getMinutes getMonth getSeconds getTime getTimezoneOffset getYear getUTCDate getUTCDay getUTCFullYear getUTCHours getUTCMilliseconds getUTCMinutes getUTCMonth getUTCSeconds setDate setFullYear setHours setMilliseconds setMinutes setMonth setSeconds setTime setYear setUTCDate setUTCFullYear setUTCHours setUTCmillisecinds setUTCMinutes setUTCMonth setUTCSeconds toGMTString toLocaleString toUTCString parse UTC Declarations function new this var with Page 154 Revision 2 0 OMRON Category Function Creation APPENDIX C JScript Features Keyword Feature Function arguments length Global Methods Global escape unescape eval isFinite isNaN parselnt parseFloat Maths Math abs acos asin atan atan2 ceil cos exp floor log max min pow random round sin sqrt tan E LN2 LN10 LOG2E LOG10E Pl SQRT1_2 SQRT2 Numbers Number MAX_VALUE MIN_VALUE NaN NEGATIVE_INFINITY POSITIVE_INFINITY Object Creation Object new constructor prototype toString valueOf Operators Addition Subtraction Modulus arithmetic
4. The Type column refers to the types of script and expression the function can be applied to All refers to both expressions and scripts Scr refers to scripts only OP refers to Object and Page scripts only Page 9 CHAPTER 4 CX Supervisor Script Language OMRON Points Basic Point Assignment Syntax pointname expression Remarks The point name to be assigned a value expression The value to be assigned to pointname The expression may be of type Boolean Integer Real or Text Typical Examples count 100 The Integer or Real point count is assigned the value 100 result TRUE The Boolean point result is assigned the state TRUE name Valve position The Text point name is assigned the associated text contained within quotation marks Note When assigning Real floating point values to an Integer point the assignment uses the Symetrical Rounding Down towards 0 standard This means a value of 4 1 would be assign a value 4 A value of 4 1 would asign a value of 4 References Refer to chapter 4 Punctuation for details of the use of quotation marks Page 10 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language Further Point Assignment Syntax pointname expression Remarks MT anion pointname The point name to be assigned a value expression The value to be assigned to pointname The expression may be of type Boolean Integer
5. Typical Example StopLogging Process 1 This command will stop logging of all items in the named data set Database Commands DBAddNew Description Adds a new record to a Recordset This function will fail if the Recordset is opened with a lock of Read Only Page 110 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Syntax returnstate DBAddNew level Remarks returnstate bool 1 if the function is successful otherwise 0 A text point or constant specifying the connection level This level text should be a field or recordset level Typical Examples Result DBAddNew Northwind Order Details Using a Recordset connection level a new record is added with values from all fields associated with a property type Add Point Result is set true if this was successful DBAddNew Northwind Order Details OrderID DBAddNew Northwind Order Details ProductID DBAddNew Northwind Order Details Quantity DBAddNew Northwind Order Details UnitPrice DBUpdate Northwind Order Details Using a Field connection level each required field is added to the new record using multiple calls to DBAddNew When the record is complete it is added by calling the DBUpdate function Note To use DBAddNew with a Recordset level the Recordset must be configured to perform this type of operation i e it will need to contain fields for any primary keys and non null values required to create a new reco
6. 0 otherwise channel Integer This is an integer point which contains the return value of the point DDEInitiate command Both server and topic parameters applied to the channel in the DDEInitiate command must be open or an error is reported Typical Example channelname DDEInitiate Excel Sheet1 xls DDEOpenLinks channelname The DDEOpenLinks command enables points which have been configured to communicate via DDE to begin data transfer Data transfer between CX Supervisor and the application Microsoft Excel is automatically maintained until the channel is closed either by Microsoft Excel or by the command DDETerminate using the Integer point channelname or the command DDETerminateAll DDEPoke Syntax returnstate DDEPoke channel item pointname Remarks Returnstate is 1 if the function is successful or 0 otherwise channel Integer This is an integer point which contains the return value of the point DDEInitiate command Both server and topic parameters applied to the in the DDElnitiate command must be open or an error is reported item string This is an item as recognised by the server application For instance a cell is an item within a spreadsheet application Likewise a page is an item for a word processing application It is wholly dependant on the server application pointname point This is a point whose attributes must include a DDE Access of Read Only or Read Writ
7. 102 Program Manager 173 Page 179 INDEX Script Language Programmable Logic Controller See PLC Project 173 Project Scripts 7 Punctuation Command String Delimiters 23 Indentation 24 Multiple Commands 24 Parenthesis 25 Quotation Marks 25 Q Quotation Marks Punctuation 25 R Rand General Commands 51 Read File Commands 85 ReadMessage File Commands 85 Recipe 173 Recipe Commands 88 DisplayRecipes 88 DownloadRecipe 89 Relational Operators Logic and Arithmetic 14 Remarks Miscellaneous Commands 25 Report Commands 90 GenerateReport 90 PrintReport 90 ViewReport 91 Return Subroutines 23 Right Text Commands 96 Rotate Object Commands 45 RunApplication General Commands 52 RunHelp General Commands 52 Runtime Environment 173 S SCADA 173 Script Editor AND statement 168 Applications use of external gt 1 Page 180 OMRON Arithmetic functions 12 15 Conditional statements nesting 17 19 Control Statements 15 22 See also Control Statements Current object statement 38 Examples 133 Executable files use of 1 158 170 FALSE Boolean state 1 4 Logical functions 13 14 Mathematical precedence 11 12 Multiple statements on one line 24 Nesting conditional statements 17 19 NOT statement 172 Object Commands 38 See also Object Commands Operator and operand 1 172 OR statement
8. FOR NEXT Loop Syntax FOR pointname startpt TO endpt STEP steppt statementblock1 NEXT Remarks pointname The pointname to be used as the loop counter startpt The initial setting of pointname and the first value to be used through the loop endpt The last value to be used The loop ends when pointname exceeds this value steppt Amount to increase pointname by every pass of the loop Steppt can be negative to count backwards providing startpt is larger than endpt The STEP keyword and variable may be omitted in which case pointname is incremented at each pass of the loop identical to adding STEP 1 Typical Examples FOR loopcount 0 TO 100 Ellipse 1 vertical fill loopcount NEXT In this example Ellipse_1 is gradually filled 100 times FOR loopcount 100 TO O STEP 5 Ellipse 1 vertical fill loopcount NEXT In this example the fill for Ellipse_1 is gradually removed 20 times 100 times 5 Note Loop statements should be used with caution as they consume processor time while they are running and some other parts of the system may not be updated DO WHILE UNTIL Loop Syntax DO WHILE expression statementblock LOOP or DO statementblock LOOP WHILE expression Revision 2 0 Page 21 CHAPTER 4 CX Supervisor Script Language OMRON or DO UNTIL expression statementblock LOOP or DO statementblock LOOP UNTIL expression Remarks expression The expression may be a point or
9. file integer Number of file to export where 0 is the latest active file 1 is the previous file etc outputfile string File name for output file May include full path which will be created automatically if it does not exist All these arguments are optional and may be omitted provided there are no further arguments i e to specify the format datasetname and item list must be included but file and output may be omitted Typical Examples or or Page 106 ExportAndViewLog Balloon ExportAndViewLog Balloon Altitude Fuel Burning Lift Group 1 CSV BDTM 0 output ItemList 0 Altitude ItemList 1 Fuel ItemList 2 Burning ItemList 3 List ItemList 4 Group 1 ExportAndViewLog Balloon ItemList CSV BDTM 0 output Revision 2 0 OMRON CHAPTER 6 Functions and Methods All these commands will export all the data in the specified file for the named data set to the named output file in the format specified as per ExportLog It then launches an appropriate viewer to display the file using the Windows file associations ExportLog Syntax ExportLog datasetname item list format file outputfile or ExportLog datasetname TextArray format file outputfile Remarks Name of Data Set to export as text point or constant item list string List of Items and or Groups within the data set to export separated by commas Alterna
10. graphid pagename Remarks Returnstate is 1 if the function is successful or 0 otherwise graphid The identifier of the trend or scatter graph to be cleared pagename string Optional parameter indicating the name of the page that the graph is on Typical Examples ClearGraph Graph_1 TestPagel The trend or scatter graph on TestPage1 with the identifier Graph_1 has its data cleared ClearGraph Graph 2 The trend or scatter graph on the current page with the identifier Graph_2 has its data cleared StartGraph Syntax returnstate StartGraph graphid pagename Remarks Tie Returnstate is 1 if the function is successful or 0 otherwise graphid The identifier of the trend or scatter graph to be started pagename string Optional parameter indicating the name of the page that the graph is on Typical Examples StartGraph Graph_ 1 TestPagel The trend or scatter graph on TestPage1 with the identifier Graph_1 has its data logging started StartGraph Graph 2 Page 162 Revision 2 0 OMRON APPENDIX D Obsolete Features The trend or scatter graph on the current page with the identifier Graph 2 has its data logging started Note This command is provided for compatibility with SCS v2 0 applications For newer applications the data logging facilities should be used in preference StopGraph
11. Northwind Order Details Position pos Go to the third record in the Recordset DBMove Northwind Order Details Page 6 Go to the sixth page in the Recordset Note Bookmarks are returned from the function DBProperty they enable you to return to a marked record even after records have been added or deleted Page 116 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Note Some Providers do not support moving in the Previous direction i e cursors are Forward Only Some Forward Only providers do allow moving First while some are strictly Forward Only i e the Recordset has to be Re queried effectively a combined Close then Open operation to reset the cursor back to the start of the Recordset Some Providers that do support moving Previous do not support moving to Position However in order to be consistent CX Supervisor ensures that that all operations except Bookmarks will work for any connection to any provider but you need to bear in mind when designing applications that use Forward Only cursors that there may be some long winded acrobatics being performed behind the scenes See DBSupports for details of how to check the type of cursor in force Note Bookmarks will only work if specifically supported by the Provider DBOpen Description Opens a Connection or Recordset Opening a Connection will automatically open all recordsets associated with it that are marked as
12. Number of milliseconds to wait before continuing Typical Example Sleep 1000 CX Supervisor waits 1 second Note 1 The sleep statement should be used with caution as some other parts of the system may not be updated while a script is sleeping It also uses multithreading which means some tasks like PLC communication may occur in parallel and behave unpredictably Note 2 In a well designed truly event driven system use of the Sleep statement should never be required Always consider if the statements after the Sleep should be in their own script executed when a Condition occurs Page 156 Revision 2 0 OMRON APPENDIX D Obsolete Features Note 3 The Granularity or intervals differs between Operating Systems In Windows NT and 2000 expiration is checked every 10ms so Sleep 100 actually pauses for any time between 100 to 109 99 milliseconds depending on when it was started For Windows 98 and ME the granularity is 55ms so Sleep 100 actually pauses for 110 2 times 55 to 164 99 milliseconds nearly 3 times 55 For this reason Sleep statements can act differently on different Operating Systems making the application OS dependant Note 4 Sleep should never be used as a delay for timing processes for the following reasons The actual time delay depends on the OS as described above There is always an error of 0 to 1 granularity depending on when the action is started The frequency can not be guaranteed as
13. OMRON CHAPTER 5 CHAPTER 5 VBScript Language Reference VBScript Language Reference This chapter is a reference for the syntax of Microsoft Visual Basic scripting language called VBScript These features are provided by the Windows Scripting Host included by default with Windows 2000 and Windows XP For a full User Guide Language reference and details of the latest versions and support contact Microsoft at fattp msdn microsoft com List of Features Category Keyword Feature Array handling Array Dim Private Public ReDim IsArray Erase LBound UBound Assignments Comments Set Comments using or Rem Constants Literals Empty Nothing Null True False Control flow Do Loop For Next For Each Next If Then Else Select Case While Wend With Conversions Abs Asc AscB AscW Chr ChrB ChrwW CBool CByte CCur Cdate CDbl Cint CLng CSng CStr DataSerial DateValue Hex Oct Fix Int Sgn TimeSerial TimeValue Date Times Date Time DateAdd DateDiff DatePart DateSerial DateValue Day Month MonthName Weekday weekdayName Year Hour Minute Second Now Revision 2 0 Page 31 CHAPTER 5 VBScript Language Reference Category Keyword Feature OMRON TimeSerial TimeValue Declarations Class Const Dim Private Public ReDim Function Sub Property Get Property Let Property Set Error Ha
14. 172 Parenthesis 12 25 Quotation marks 24 Relational functions 14 15 Script code examples 133 Subroutines 22 23 See also Subroutines TRUE Boolean state 1 4 Script Examples 133 Balloon Script 133 Script Interface 139 Functions 139 141 PLC Memory Functions 146 Script Interface Functions Active 148 ClockRead 147 ClockWrite 148 ClosePLC 143 DownloadProgram 151 GetDeviceConfig 150 IsBadQuality 147 LastErrorString 153 OpenPLC 143 Protect 152 RawFINS 148 Read 140 ReadArea 144 RunMode 145 SetDefaultPLC 142 SetDeviceAddress 149 SetDeviceConfig 150 TCGetStatus 148 TCRemoteLocal 149 TypeName 145 146 147 UploadProgram 151 Revision 2 0 OMRON Value 139 142 Values 142 Write 140 WriteArea 145 Scripts 7 Objects 7 Page 7 Project 7 Security Commands 103 Login 103 Logout 103 SetupUsers 104 SelectFile File Commands 86 Server 174 Server Application 174 SetBit Point Commands 65 SetPLCMode PLC Commands 69 SetPLCPhoneNumber PLC Commands 69 SetupUsers Security Commands 104 ShutDown General Commands 54 Simple Conditional Statements Control Statements 15 StartLogging Data Logging Commands 109 Statement 174 StopLogging Data Logging Commands 110 String 174 Subroutines 22 Call 22 Return 23 Super Video Graphics Adapter See SVGA Supervisory Control and Data Acqui
15. DBClose Northwind Closes the connection to the Northwind database and also any Recordsets which may be open DBDelete Description Deletes the specified number of records from the current record position This function works only at the Recordset level This function will fail if the Recordset is opened with a lock of Read Only Syntax returnstate DBDelete level quantity Remarks ACTA O TT returnstate 1 if the function is successful otherwise 0 level A text point or constant specifying the connection level This must be a recordset level quantity i Number of records to delete Typical Examples Result DBDelete Northwind Order Details 10 Page 112 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Delete the next 10 records in the recordset DBMove First Result DBDelete Northwind Order Details 10 Delete the first 10 records DBExecute Description The DBExecute function allows the execution of miscellaneous commands and allows for future expansion by supporting new commands without the need to create more new DB functions Syntax return DBExecute level command parameter Remarks MC tee TN return 1 if the function is successful otherwise 0 except for Find and FindNext commands which return the record number if found or if not set the current record to EOF and return 1 level A text point or constant specifying the connection level which depend
16. FALSE InputPoint point returnflag A request is made that the current value of point point should be read In the second example returnflag is set to TRUE when the value is returned from the PLC Note The value is not returned immediately it is not possible to use the returned value in the same script as the InputPoint command Instead the value should be accessed from within an On Condition script which has an expression of returnflag TRUE OutputPoint Syntax returnstate OutputPoint pointname Remarks MC we TI Returnstate is 1 if the function is successful or 0 otherwise The point to be updated Typical Examples Output Point result The point result is updated with its current value Note The value of a point connected to a PLC is not be set if the point is currently in a forced state PointExists Syntax returnpoint PointExists pointname Remarks This text contains the point name Boolean point that contains the return value Page 64 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Typical Example PointName Testpoint Exists PointExists PointName The Boolean point Exists is set to TRUE if a point called TestPoint exists Note PointName is a text point which can be set to any string value SetBit Syntax returnstate SetBit pointname bit value Remarks Tie Returnstate is 1 if the fu
17. IsDate IsEmpty IsNull IsNumeric IsObject TypeName VarType Page 33 CHAPTER 6 Functions and Methods CHAPTER 6 Functions and Methods This chapter describes the Functions and Methods available to the scripting language In most cases this can be CX Supervisor script VBScript or JScript OMRON The following table describes the Functions and Methods at a glance Function Name AcknowledgeAlarm Function Type alarm command Type Remarks Acknowledges an alarm AcknowledgeAllAlarms alarm command Acknowledges all alarms AcknowledgeLatestAlarm alarm command Acknowledge the latest alarm Acos unary function Applies unary expression Asin unary function Applies unary expression Atan unary function Applies unary expression CancelForce point command Removes the forcing of values on a point Chr text command Displays a character based on the ASCII character set ClearAlarmHistory alarm command Clears the alarm history ClearErrorLog event error commands Clears the error log ClearLogFile Data Logging command Clears a data log file ClearSpoolQueue printer command Discards any queued messages or alarms close object command Closes a specified page CloseAlarmHistory alarm command Closes the current alarm history CloseAlarmStatus alarm command Closes the current alarm
18. Multiplication Division Negation Equality Inequality Less Than lt Less Than or Equal To lt Greater Than gt Greater Than or Equal To gt Logical And amp amp Or Not Bitwise And amp Or Not Xor Bitwise Left Shift lt lt Shift Right gt gt Unsigned Shift Right gt gt gt Conditional Comma delete typeof void Decrement Increment Objects Array Boolean Date Function Global Math Number Object String Strings String charAt charCodeAt fromCharCode indexOf lastIndexOf split toLowerCase toUpperCase length Revision 2 0 Page 155 APPENDIX D Obsolete Features OMRON APPENDIX D Obsolete Features This appendix provides a summary of features that are obsolete and have been removed from the standard documentation Details are included here to assist maintaining old projects still using these features These features should not be used in development of new solutions as it is likely support for the following features may and will be removed from the next or future releases Windows NT Windows ME Windows 98 and Windows 95 This product will no longer install on these operatinf systems It is recommended to upgrade to a later Windows version Sleep Description Pause execution of a script for specified duration Syntax Sleep duration Remarks ANETO Tore IT Ll Duration
19. Note If there is only 1 PLC in the project then it is not necessary to call the SetDefaultPLC function The first PLC in a project will automatically be set as the default PLC OpenPLC Opens a PLC for communications If no PLC is specified then the default PLC is opened Example 1 CXServer SetDefaultPLC MyPLC CXServer OpenPLC CXServer DM 100 10 CXServer DM 50 10 Example 2 CXServer OpenPLC MyPLC CXServer DM 100 10 ClosePLC Closes a previously opened PLC If no PLC is specified then the default PLC is closed Example CXServer ClosePLC MyPLC Read Function to read the value of a PLC point Example of synchronous Read intVal CXServer Read MyPLC MyPoint 0 In this example the Point MyPoint will be read from the PLC MyPLC and stored in intVal The script will wait for the read operation to complete before continuing to execute the next line due to the 0 parameter This is identical to the operation of the Value method Note If the PLC is not open then this command will cause it to be opened and then closed after the read is complete If more than one read or write operation is to be performed it is considerably faster and more efficient to use the OpenPLC command first do all the reading and writing and then if required use the ClosePLC command to close the PLC Write Function to write the value of a PLC point Example of synchro
20. While alarm printing is disabled any new messages are stored but not printed When alarm printing is re enabled any pending messages are printed if in line mode or added to the current page if in page mode PrintActivePage Syntax returnstate PrintActivePage flag Remarks argument Type TI Returnstate is 1 if the function is successful or 0 otherwise flag bool Flag is to indicate whether the print setup dialog is to be displayed before printing Typical Example PrintActivePage TRUE The currently active page is sent to the printer The flag TRUE indicates that the print dialog is displayed FALSE causes the print dialog not to be shown PrintPage Syntax returnstate PrintPage pagename flag rintheaderfooter g pag g P Remarks Returnstate is 1 if the function is successful or 0 otherwise The name of the page to be printed Jlag bool Flag to indicate whether the print setup dialog is to be displayed before printing printheaderfooter bool Optional Flag to control if printout details are included in a header and footer Revision 2 0 Page 101 CHAPTER 6 Functions and Methods OMRON Typical Example PrintPage pagel1 TRUE The CX Supervisor page is sent to the printer The flag TRUE indicates that the print dialog is displayed first to allow for printer configuration If FALSE was specified instead of TRUE then the print di
21. backup directory on drive A DeleteFile Syntax returnstate DeleteFile filename Remarks Returnstate Returnstate is 1 if the function is successful or 0 otherwise Pathname of file to be deleted Typical Example DeleteFile c pagename pag The file c pagename pag is deleted EditFile Syntax returnstate EditFile filename Page 82 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks returnstate bool Returnstate is 1 if the function is successful or 0 otherwise Pathname of the file to be edited Typical Example EditFile C report3 txt FileExists Syntax returnpoint FileExists filename Remarks This text string contains the file name Boolean point that contains the return value Typical Example FileName TEST TXT Exists FileExists FileName The Boolean point Exists is set to TRUE if a file called C TEST TXT exists Note FileName is a text point which can be set to any string value MoveFile Syntax returnstate MoveFile sourcename destname Remarks Returnstate Returnstate is 1 if the function is successful or 0 otherwise Pathname of fle to be moved Pathname of destination of move Typical Example MoveFile c autoexec bat c autoexec old Revision 2 0 Page 83 CHAPTER 6 Functions and Methods
22. motor3 motor4 can be achieved by applying indirection to textpoint using the notation and changing the contents of textpoint Page 26 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language For instance in order to dynamically change the Boolean point a toggle button is linked to follow these steps 123 1 2 Link the toggle button to a textpoint using indirection e g textpoint Link the following script code to run as required e g on clicking a button e Text ValueToText index e TextPoint motor text The ValueToText function converts the integer value of the point index into a string held in the textpoint text Therefore the point text contains either 1 2 3 or 4 The expression motor text appends the contents of the point text to the literal string motor Therefore textpoint contains either motorl motor2 motor3 or motor4 dependant on the value of index Change the value of the index to determine which Boolean point to control e g via the Edit Point Value Analogue animation Point Arrays within Script Commands and Expressions It is possible to access the elements of a point array directly or indirectly from within scripts or expressions Setting the value of an array point directly arraypoint 2 30 Getting the value of an array point directly
23. value arraypoint 2 Setting the value of an array point using indirection textpoint arraypoint textpoint 2 30 Getting the value of an array point using indirection textpoint arraypoint value textpoint 2 An example using Point Arrays The value of array points can be seen in a situation where it is necessary to dynamically change the pointname that an object is linked to In the following example a toggle button is configured to control the Boolean state of one of four elements of an array point The Boolean array point motor is configured to contain 4 elements The integer point index which has a range 0 3 is used to dynamically change the element of the point being controlled Revision 2 0 Page 27 CHAPTER 4 CX Supervisor Script Language OMRON In order to dynamically change the element of a Boolean point that a toggle button is linked to follow these steps 1 2 3 1 Link the toggle button to an array point e g motor index 2 Change the value of the index to determine which element of the Boolean point to control e g via the Edit Point Value Analogue animation Using Aliases This facility is used to declare an alias that is to define a text string that can be used in place of another text string or a number within any script or expression The Alias Definitions dialog is displayed by selecting the Alias Definition option from
24. which are described in chapter 6 Object Commends Blink command Colour command Disable command Visible command Move command Rotate command Vertical fill command Horizontal fill command Height command Width command The content of the commands are made up arithmetical or logical expressions x and y co ordinates or references varying between commands The colour command requires a colour identifier Revision 2 0 Page 39 CHAPTER 6 Functions and Methods OMRON Typical Examples POLYGON 1 colour red POLYGON 1 colour red The specified object POLYGON_1 is set to be red in colour References Refer to CX Supervisor User Manual for details of object names Chapter 6 Blink for use of the blink command Chapter 6 Colour for use of the colour command Chapter 6 Disable for use of the disable command Chapter 6 Height for use of the height command Chapter 6 Horizontal Fill for use of the horizontal fill command Chapter 6 Move for use of the move command Chapter 6 Rotate for use of the rotate command Chapter 6 Vertical Fill for use of the vertical fill command Chapter 6 Visible for use of the visible command Chapter 6 Width for use of the width command gt gt gt gt gt o gt o Blink Syntax objectname blink colour status Remarks objectname This is the name of the object Where a script is directly attached to an object objectname is
25. E5 X ES J 20 StatusWordsOnly Bool E5 K only TRUE indicates valid words below 21 StatusO word ES K only 22 Status word ES K only value point The returned status parameter value Refer to paramID above real or int for details Typical Example templ TcGetStatusParameter e5ak temp2 temp3 TCRemoteLocal Syntax returnstate TCRemoteLocal TController mode Page 72 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise TController string This is a string representing the name of the temperature controller mode point This is a point depicting the mode of operation and defines the operational mode of a temperature controller 0 This specifies the temperature controller is in remote mode 1 This specifies that the temperature controller is in local mode Typical Example templ TCRemoteLocal e5ak temp2 Note This command was previously called TCOperationalMode TCRequestStatus Syntax returnstate TCRequestStatus Tcontroller returnflag Remarks Te Returnstate is 1 if the function is successful or 0 otherwise TController String This is a string representing the name of the temperature controller returnflag Point This is a point depicting that the status has been returned and is available for the command TCGetStatusParameter Typical Example templ T
26. Parity number of data bits and stop bits HandShaking Integer The required handshaking protocol Valid values are 0 None 1 XonXoff 2 RTS 3 RTS amp XonXoff TerminationChar Integer A character indicating the end of the message ControlCharFlag Bool A flag indicating that control characters contained in a received message should be Ignored TermMode Integer Optional Flags to indicate how to use the termination character ONINPUT or value 1 Function InputComPort expects Termination Character This is the default value if omitted ONOUTPUT or value 2 Function OutputComPort appends Termination Character ONINPUT ONOUTPUT or value 3 both of the above Typical Example bState SetupCOMPort 2 9600 N 8 1 0 0x0D TRUE ActiveX Functions GetProperty Description Gets the value of a property of an OLE object and stores it in a point Syntax propertyvalue GetProperty object property Remarks propertyvalue The value of the property Type is dependant on the type of the property object The name of the OLE object to get the property of property The name of the property to get Any number of parameters for the property Revision 2 0 Page 127 CHAPTER 6 Functions and Methods OMRON Typical Examples OLElHeight GetProperty OLE1 Height This will read the property Height from the OLE object OLE1 and store it in the p
27. Syntax returnstate StopGraph graphid pagename Remarks Returnstate is 1 if the function is successful or 0 otherwise graphid The identifier of the trend or scatter graph to be stopped pagename string Optional parameter indicating the name of the page that the graph is on Typical Examples StopGraph Graph_1 TestPagel The trend or scatter graph on TestPage1 with the identifier Graph_1 has its data logging stopped StopGraph Graph _ 2 The trend or scatter graph on the current page with the identifier Graph 2 has its data logging stopped EditGraph Syntax returnstate EditGraph graphid Remarks ACTA IET TN Returnstate is 1 if the function is successful or 0 otherwise graphid The identifier of the trend graph to be edited Typical Example EditGraph Graph_1 The Edit Graph dialog is displayed offering options to view historical data for the chosen trend graph Revision 2 0 Page 163 APPENDIX D Obsolete Features OMRON Display Data loads the currently selected data sample i e either the current screen data or a snapshot of the data into the trend graph Snapshot stores the current data buffer associated with the trend graph The snapshot is given a time stamped default description Description provides the ability to change the description associated with the snapshot Import Data provides the ability to
28. a calculation of constants and or points that produces a result statementblock One or more statements to be executed multiple times depending on expression Typical Example DO WHILE dooropen TRUE Message You must shut the door before continuing LOOP DO nextchar Mid Mystring position 1 position position 1 LOOP UNTIL nextchar A Note Loop statements should be used with caution as they consume processor time while they are running and some other parts of the system may not be updated Subroutines Call Syntax CALL subroutine arguments Page 22 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language Remarks MT anion subroutine The name of the subroutine defined at project level arguments The list of arguments required by the subroutine separated by commas Each argument may be a pointname constant arithmetical or logical expression or any valid combination Typical Example CALL MySub Second Default 2 Intl Return Syntax RETURN Typical Example IF limit gt 1000 TH RETURN ELSE value limit ENDIF nal zZ REM final part of script POLYGON_1 COLOUR red ELLIPSE 5 WIDTH value The integer point limit is tested for its value If its value exceeds 1000 then the condition is met and the RETURN command is executed All statements after the RETURN command are ignored If the value of integer point limit does not exce
29. communicates with PLCs and other I O mechanisms An ingredient must specify a target value for its related point This is the value to which the point will be set in runtime when the recipe is downloaded An integral part of Microsoft Windows which allows Microsoft Windows based applications to be started CX Supervisor is run from the Taskbar In CX Supervisor a text object is a string on a page Attributes such as typeface point size embolden italicise underline left justify flush right and centre can be applied to enhance its presentation A type of point that holds a string A Multi Byte Character Set which not only includes European Characters like DBCS but can also include global support including for Japanese Chinese and Cyrillic fonts However Unicode is not supported on all Windows platforms Recipe validation code is CX Supervisor script language which is used to check point values before downloading a recipe A mode of video display that provides 640 x 480 pixel resolution with 16 colours and is supported on Video Graphics Adapter systems A Visual Basic style scripting language supported by Microsoft s Windows Scripting Host Revision 2 0 OMRON VGA mode Windows Desktop Windows Scripting Host Wizard Revision 2 0 GLOSSARY OF TERMS Script Language A mode of video display that provides 640 x 480 pixel resolution with 16 colours and is supported on Video Graphics Adapter systems An inte
30. count 75 result log count Both examples provide identical functionality but the use of the colon between statements allows both to reside on the same line Page 24 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language Parenthesis Typical Examples result 20 30 40 The result is 1220 result 20 30 40 The values in parenthesis are calculated first The result is 2000 References Refer to chapter 4 Logic and Arithmetic Arithmetric Operations for further details Quotation Marks Typical Examples name Valve position The Text point name is assigned associated text contained within quotation marks Quotation marks must be used in this instance Message This text to be displayed as a message Passing static text as arguments to functions BlueCarsAck IsAlarmAcknowledged BLUEPAINT The point BlueCarsAck is assigned a Boolean state based on the alarm BLUEPAINT Quotation marks must be used for an alarm name Remarks Syntax REM rem comment or comment Remarks Typical Examples REM The following statement adds two numbers result 45 754 Revision 2 0 Page 25 CHAPTER 4 CX Supervisor Script Language OMRON result 45 754 add two numbers Indirection within Script Commands and Expressions It is possible to use text points directly or indirectly in place of literal string arguments within scripts and expressions For instance each of th
31. for details of the use of indentation Case Select Syntax SELECT CASE expression CASE expression statementblock1 CASE expression statementblock2 CASE expression statementblock3 END SELECT or SELECT CASE expression CASE expression statementblock1 CASE expression statementblock2 CASE ELSE statementblock3 END SELECT Remarks expression The expression may be a point or a calculation of constants and or points that produces a result statementblockl One or more statements that are only performed if the preceding CASE expression is met statementblock2 One or more statements that are only performed if the preceding CASE expression is met statementblock3 One or more statements that are only performed if the preceding CASE expression is met Revision 2 0 Page 19 CHAPTER 4 CX Supervisor Script Language OMRON Typical Examples SELECT CASE colourvalue CASE 1 colour blue CASE 2 colour green CASE 3 colour cyan CASE ELSE colour 0 END SELECT This example shows the assignment of a colour according to the value of a point The value of Integer point colourvalue is evaluated and compared with each case until a match is found When a match is found the sequence of actions associated with the CASE statement is performed When colourvalue is 1 the colour given to the current object is blue when colourvalue is 2 the colour given to the current object is green when colourvalue is
32. information of particular interest for efficient and convenient operation of the product 1 2 3 Indicates lists of one sort or another such as procedures checklists etc Represents a shortcut on the Toolbar to one of the options available on the Y menu of the same window BA Stan Indicates a program must be started usually by clicking the appropriate option under the standard Windows Start button OMRON 2009 All rights reserved No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means mechanical electronic photocopying recording or otherwise without the prior written permission of OMRON All copyright and trademarks acknowledged No patent liability is assumed with respect to the use of the information contained herein Moreover because OMRON is constantly striving to improve its high quality products the information contained in this manual is subject to change without notice Every precaution has been taken in the preparation of this manual Nevertheless OMRON assumes no responsibility for errors or omissions Neither is any liability assumed for damages resulting from the use of the information contained in this publication Revision 2 0 Page iii CX Supervisor Script Language OMRON Page iv Revision 2 0 OMRON CX Supervisor Script Language About this Manual This manual describes the script language syntax as a supplement to CX
33. load in a previously saved trend graph file Export Data provides the ability to store a snapshot to a file either in internal CX Supervisor format or as a text file that can be imported into other applications Delete removes the currently selected snapshot Note This command is provided for compatibility with SCS v2 0 applications For newer applications the data logging facilities should be used in preference Note This command can only be used if the trend is set to log to a file SaveGraph Syntax returnstate SaveGraph graphid Remarks Returnstate is 1 if the function is successful or 0 otherwise graphid The identifier of the trend to be saved pagename string Optional parameter indicating the name of the page that the graph is on Typical Examples SaveGraph Graph_1 TestPagel The trend graph on the page TestPage with the identifier Graph_1 has its data saved to disc SaveGraph Graph _ 2 The trend graph on the current page with the identifier Graph 2 has its data saved to disc Snapshot Syntax returnstate Snapshot graphid pagename Page 164 Revision 2 0 OMRON APPENDIX D Obsolete Features Remarks A A returnstate bool Returnstatei is 1 if the function is successful or 0 otherwise graphid The identifier of the trend graph to have a snapshot pagename string Optional parameter indicating the name
34. of the page that the graph is on Typical Examples Snapshot Graph 1 TestPagel The current data in trend graph Graph on TestPagel is stored and is able to be viewed via the EditGraph command Snapshot Graph 2 The current data in trend graph Graph1 on the current page is stored and is able to be viewed via the EditGraph command Note This command is provided for compatibility with SCS v2 0 applications For newer applications the data logging facilities should be used in preference GetPointValue Syntax returnpoint GetPointValue pointname offset Remarks Tie This is the name of the point whose contents are to be returned offset integer This specifies the offset into an array point 0 if the point is not an array point returnpoint point Point that contains the return value The type of data returned is dependant on the pointname specified Typical Example pointname 10 returnpoint GetPointValue pointname 0 The point returnpoint contains the value 10 The offset is added to any offset specified for pointname For example returnpoint GetPointValue a 10 10 Causes the 21st element offsets begin at zero of array a to be retrieved Note Itis often simpler to access an array element directly e g returnpoint a 20 Revision 2 0 Page 165 APPENDIX D Obsolete Features OMRON GetSpoolCount Syntax returnstate GetSpoolCount Re
35. or Real and can include other points logical or arithmetical expressions Mathematical precedence is applied as follows Parenthesis highest Unary minus and NOT logical operator Multiplication division and modulus Addition and subtraction Greater than less than greater than or equal to and less than or equal to relational operators Shift Left SHL and Shift Right SHR Equal to and not equal to relational operators Bitwise AND XOR OR AND logical operator OR logical operator lowest Typical Examples lift height rate 5 0 The Integer or Real point lift is assigned the value calculated by the value of point rate divided by 5 plus the value of point height Precedence can be changed by the introduction of parenthesis lift lift 0 2 The Integer or Real point lift is assigned the value calculated by the current value of point lift minus 0 2 distance distance time The Integer or Real point distance is assigned the value calculated by the current value of point distance multiplied by point time References Refer to chapter 4 Logic and Arithmetic for details of the use of arithmetic and logic functions Refer to chapter 4 Punctuation for details of the use of parenthesis Revision 2 0 Page 11 CHAPTER 4 CX Supervisor Script Language OMRON Logic and Arithmetic Arithmetic Operators Syntax pointname expression Remarks The point nam
36. the Project menu It can also be displayed if Aliases is selected from the script editor The dialog displays either the User defined aliases or the preset System aliases and is toggled between these two displays by pressing the User System Alias button The following illustration shows the Alias Definitions dialog displaying a number of User defined aliases The System aliases are pre defined and can not be edited or added to Alias Definitions x BOTTOMCENTRE Bottom Centre Left Top User Defined Bottom Bottom Left Centre Right Right Top Left Centre Left Down Bottom Right Indicates Frame Colour should be set Top Right Top Centre Indicates Fill Colour should be set e Syntax AliasName Alias definition optional comment Page 28 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language Remarks ACTA IO TT AliasName The string name of the alias Alias definition string This is a string representing the actual text or expression of the expanded alias This is an optional comment The symbol at the beginning of each line initiates each alias command For example the text string SomePoint could be used to represent any sequence of characters in a script or expression e g it could be defined as SomePoint InArray 1 or even SomePoint Inarray 1 Inarray 2 2 This is an easy way of identifying the individual members of array points It can also be used to associa
37. the function is successful or 0 otherwise ReportTemplateFile Pathname of the report template file Typical Example ViewReport report3 txt Text Commands BCD Syntax result BCD value Remarks Value Number to convert to Binary Coded Decimal BCD i String containing BCD representation of value Typical Example BCDStr BCD 39 Revision 2 0 Page 91 CHAPTER 6 Functions and Methods OMRON In this example BCDstr contains 00111001 Bin Syntax result Bin value Remarks MEA Number to be converted to a binary number reut String containing binary representation of value Typical Example BStr Bin 20 In this example Bstr contains 10100 Chr Syntax result Chr value Remarks vame Extended ASCII value to convert to a character reut 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 CHAPTER 6 Functions and Methods Remarks menes nn textpoint A text point which holds the formatted text formattext string The text with appropriate formatting characters that the result expression is inserted into Integer The value s or expression s that is inserted into formattext real Typical Exam
38. using script with multiple PLCs in the project Example 2 CXServer DM 100 75 In this example the value 75 will be written to DM100 in the PLC Bit addressing that is accessing data from individual memory bits is also supported by these memory areas IR AR HR and CIO Example 3 bVal CXServer IR 100 2 In this example the status of bit IR100 2 i e bit 2 of IR100 will be read from the PLC and stored in bVal e g bVal will be set to TRUE or FALSE Example 4 CXServer IR 100 2 True In this example bit IR100 2 i e bit 2 of IR100 in the PLC will be set to True Note that use of the quotes is optional but is required to differentiate between 100 1 and 100 10 ListPLCs Holds a list of all PLC names configured in the project file This property is read only Page 146 Revision 2 0 OMRON APPENDIX B CX Server Communications Control Example Dim arrayOfPLCs Dim nUbound nLbound arrayOfPLCs CXServer ListPLCs nLbound LBound arrayOfPLCs nUbound UBound arrayOfPLCs For Count nLbound To nUbound MsgBox arrayOfPLCs Count Next In this example the list of PLC names in the project configured stored in arrayOfPLCs and then each is displayed in a message box ListPoints Holds a list of all point names configured in the project file or PLC This property is read only Example Dim arrayOfPoints Dim nUbound nLbound arrayOfPoints CXServer ListPoints sPLC nLbound LB
39. vbInteger is assumed The script will wait for the read operation to complete before continuing to execute the next line Note If accessing from a CX Supervisor script the following integral values should be used for the return type vbEmpty 0 Uninitialized default vbCurrency 6 Currency subtype vbString_ 8 Ptringsubtype vbObject__ P_ Pbjer_____ vbDataObject 13 Data access object Page 144 Revision 2 0 OMRON APPENDIX B CX Server Communications Control bArray 8192 Array WriteArea Writes a block of memory to a specified area in a PLC Examples of synchronous write MyString TestString CxXServer WriteArea MyPLC DM50 10 MyString Dim newValue 2 newValue 1 0 newValue 2 1 CXServer WriteArea BoilerTemp 2 newValue In the first example the contents of MyString will be written into DM50 to DM54 Any additional data in MyString will be ignored i e if MyString is 15 characters in length then the first 10 characters will be written to DM50 to DM54 and the remaining 5 characters will be ignored Note each PLC address holds 2 characters The second example shows that a logical name can be used The script will wait for the write operation to complete before continuing to execute the next line RunMode Reads the current operating mode of a PLC Stop Program Debug Monitor Run where 0 Stop Program mode 1 Debug mode 2 Monitor mode and 4 Run mode Example i
40. 00 in value and position is less than 450 in value i e the value of position is between 300 and 450 then the expression has been met and an action is initiated in this instance the current object is made visible if the expression is met This example is a Boolean example whereby either the expression is met TRUE or not met FALSE A Boolean value is always returned from a Digital Expression field as opposed to an Expression field which returns an Integer or Real value Operators used within this example are fully described in chapter 4 Logic and Arithmetic Visibility x Digital Expression position gt 300 AND position lt 450 c j ance Wisibility State The following example of an expression contains a value point prompt which is included at the value position denoted by a symbol Page 4 Revision 2 0 OMRON CHAPTER 2 Expressions Display Value Analogue Expression DK Second Displayed Text Number of seconds Format F Left Justified Standard IT Leading Zeros Scientific Cancel Browse di Hexadecimal Refer to the CX Supervisor User Manual for detailed dialog descriptions Note Note Note Note Note Revision 2 0 Boolean Expressions execute when the expression is TRUE so it can be said that every Boolean expression has an inferred TRUE Sometimes Boolean expre
41. 105 ExportAndViewLog 105 ExportLog 107 OpenLogFile 108 OpenLogView 108 StartLogging 109 StopLogging 110 DBCS 170 DCOM 170 DDE 170 DeleteFile File Commands 82 Development environment 170 Disable Object Commands 42 DisableGroup Point Commands 58 DisablePoint Point Commands 59 Display Page Page Commands 47 DisplayAlarmHistory Alarm Commands 78 DisplayAlarmStatus Alarm Commands 79 DisplayErrorLog Event Error Commands 98 DisplayPicture General Commands 50 DisplayRecipes Recipe Commands 88 DLL 170 Do While Until Loop Control Statements 21 Double Byte Character Set See DBCS Download 170 DownloadPLCProgram PLC Commands 66 DownloadRecipe Recipe Commands 89 Dynamic Data Exchange See DDE Dynamic Link Library See DLL E EditFile File Commands 82 EnableAlarms Alarm Commands 79 Revision 2 0 INDEX Script Language EnableErrorLogging Event Error Commands 99 EnableGroup Point Commands 60 EnableOLE Communications Commands 55 EnablePLC Communications Commands 56 EnablePoint Point Commands 61 EnablePrinting Printer Commands 100 Event Error Commands 98 ClearErrorLog 98 CloseErrorLog 98 DisplayErrorLog 98 EnableErrorLogging 99 LogError 99 LogEvent 99 Exponential General Commands 49 53 ExportAndViewLog Data Logging Commands 105 ExportLog Data Logging Commands 107
42. 16777215 This is the desired colour s RGB value format is OxBBGGRR colourlD Some colour values within the colour palette have a meaningful colourID This takes the form of the colour name e g black or yellow Alternatively an integer value of 0x1000000 can be added to a number 0 65 to select a palette entry context This argument is optional an may be omitted It defines which part of the object has it s colour changed May be one or more of FILL change fill colour AFRAME changes frame colour If omitted both are changed Equivalent to FILL FRAME Revision 2 0 Page 41 CHAPTER 6 Functions and Methods OMRON Typical Examples TEXT_3 colour blue or TEXT_3 colour blue The object TEXT_3 is set to blue BALL colour 35 0x1000000 The object BALL is set to colour 35 from the colour palette BALL colour 0xFF0000 FILL The object BALL is set to blue shade tintl tint2 IF shade gt 65 OR shade lt 0 THEN shade 0 ENDIF ELLIPSE 1 colour shade 0x1000000 The point shade is set to a value based on tintl and tint2 and is tested first to ensure that it is a value between 0 and 65 If shade falls outside this range then it cannot be applied as a colour to an object and is therefore reset to 0 or black ELLIPSE_1 is set to the palette colour of the value of shade References Refer to chapter 6 Colour Palette for details o
43. 3 the colour given to the current object is cyan If colourvalue falls outside the integer range 1 3 then the colour given is 0 black Like ELSE and ELSEIF the CASE ELSE statement is optional SELECT CASE TRUE CASE temperature gt 0 AND temperature lt 10 colour blue CASE temperature gt 10 AND temperature lt 20 colour green CASE temperature gt 20 AND temperature lt 30 colour red CASE ELSE colour white ENDSELECT In this example instead of using a point as the condition as with the previous example the value is the condition in this case Boolean state TRUE with the integer point temperature being tested at each case If it is TRUE that temperature is between 0 and 10 then the current object is set to blue or if it is TRUE that temperature is between 11 and 20 then the current object is set to green or if it is TRUE that temperature is between 21 and 30 then the current object is set to red If none of these CASE statements are met then the current object is set to white Like ELSE and ELSEIF the CASE ELSE statement is optional References Refer to chapter 6 Object Commands for details of applying attributes to an object and for the use of the Colour object command Refer to chapter 8 Colour Palette for details of the Colour Palette colour designation Page 20 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language
44. 88 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Typical Example DisplayRecipes The current recipes is displayed References Refer to the CX Supervisor User Manual for details of recipes DownloadRecipe Syntax returnstate DownloadRecipe recipename Remarks Returnstate is 1 if the function is successful or 0 otherwise The name of the recipe to be downloaded Typical Example DownloadRecipe recipel The recipe recipel is downloaded References Refer to the CX Supervisor User Manual for details of recipes UploadRecipe Syntax returnstate UploadRecipe recipename processed Remarks returnstate bool Returnstate is 1 if the function is successful or 0 otherwise recipename string The name of the recipe to be uploaded processed bool Flag set to true when operation has been completed Typical Example UploadRecipe recipel done Revision 2 0 Page 89 CHAPTER 6 Functions and Methods OMRON The recipe recipel is uploaded and point done is set True when the upload is complete References Refer to the CX Supervisor User Manual for details of recipes Report Commands GenerateReport Syntax returnstate GenerateReport ReportTemplateFile ReportOutputFile Remarks men Tyee Y on sd Returnstate is 1 if the function is successful or 0 otherwise ReportTemplateFile Pathnam
45. 91 Visible Object Commands 46 Visual Basic See VBScript VJM 171 W Width Object Commands 47 Page 182 OMRON Windows Desktop 175 Windows Scripting Host 175 JScript 154 VBScript 31 Windows Taskbar 174 Wizard 175 Write File Commands 87 WriteMessage File Commands 88 WSH See Windows Scripting Host Revision 2 0
46. Bitwise Shift Right SHR or gt gt Typical Examples MSB value amp 128 The Boolean point MSB is set TRUE if the binary representation of value has the bit set which is worth 128 Pattern value lt lt 2 The binary representation of value is shifted left twice and stored in pattern Each Shift Left operation has the effect of doubling the value so two shifts quadruple the value Logical Operators Syntax pointname expression or IF expression or DO WHILE expression or DO UNTIL expression Revision 2 0 Page 13 CHAPTER 4 CX Supervisor Script Language OMRON Remarks MT ion Pointname The point name to be assigned a value based on a logical expression Expression The Boolean value to be assigned to pointname or the Boolean value forming a conditional statement The expression includes the following operators with points and constants e And AND e Or OR e Not NOT Typical Examples flag temp AND speed The Boolean point flag is assigned a value based on the logic of point temp AND point speed If temp and speed are both not zero flag is set to 1 or TRUE A value of zero in either temp or speed supplies FALSE or 0 to flag IF flag AND temp AND speed THEN flag FALSE ENDIF The Boolean point flag is assigned FALSE on the condition that flag AND poi
47. BoolPoint point Name of Boolean point to be edited Text Caption for Edit dialog Text description for Boolean state 0 Text description for Boolean state 1 Typical Example EditPoint bFlag Select ON or OFF ON OFF A dialog is displayed to edit the Boolean point bFlag to ON or OFF with a caption Select ON or OFF A dialog is displayed to edit the analogue point nValue between 0 and 9999 with a caption Enter a new value without using the onscreen keyboard EditPoint nValue Enter a new value 0 000000 9999 000000 FALSI GI GI A dialog is displayed to edit the Text point txtMessage with a caption Set Text to echoing the input and not displaying the onscreen keyboard EditPoint txtMessage Set Text to FALSE FALS EnableGroup Syntax returnstate EnableGroup groupname Remarks Returnstate is 1 if the function is successful or 0 otherwise Name of the group containing the points to enable Typical Example EnableGroup lt Default gt Page 60 Revision 2 0 OMRON CHAPTER 6 Functions and Methods All points belonging to the lt Default gt group is enabled thus allowing values to be read written EnablePoint Syntax returnstate EnablePoint pointname Remarks A e e returnstate bool Returnstate is 1 if the function is successful or 0 otherwise Name of point to b
48. C The port must have been configured and opened before it can be closed Syntax ReturnState CloseCOMPort PortNumber Revision 2 0 Page 125 CHAPTER 6 Functions and Methods OMRON Remarks ACT tee TI ReturnState Bool True if successful else false PortNumber Integer The number of the port previously configured using the function SetupCOMPort and opened using the script function OpenCOMPort Typical Example bState CloseCOMPort 1 OpenCOMPort Description Opens the designated serial communications port on the PC for transmitting or receiving data The port must have been configured before it can be opened Syntax ReturnState OpenCOMPort PortNumber Remarks ReturnState Bool True if successful else false portNumber Integer The number of the port previously configured using the function SetupCOMPort Typical Example bState OpenCOMPort 1 SetupCOMPort Description Configures the designated serial communications port on the PC for transmitting or receiving data Syntax ReturnState SetupCOMPort PortNumber ConfigurationString HandShaking TerminationChar ControlCharFlag TermMode Remarks Argument Type Description Page 126 Revision 2 0 OMRON CHAPTER 6 Functions and Methods returnstate Bool True if successful else false portnumber Integer The number of the serial port to be configured ConfigurationString Text A string indicating the desired Baud rate
49. CRequestStatus e5ak temp2 Note The status information is NOT returned immediately it is not possible to access the status information in the same script as the TCRequestStatus command Instead the status information should be accessed from within an On Condition script which has an expression of returnflag TRUE TCRspLsp Syntax returnstate TCRspLsp Tcontroller mode Revision 2 0 Page 73 CHAPTER 6 Functions and Methods OMRON Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise TController This is a string representing the name of the temperature controller mode Point This is a point depicting the mode of operation and defines the setpoint mode used by the temperature controller 0 This specifies remote setpoint mode 1 This specifies local setpoint mode Typical Example templ TCRspLsp e5ak temp2 Note This command was previously called TCSetpoint TCRunStop Syntax returnstate TCRunStop TController mode Remarks Returnstate is 1 if the function is successful or 0 otherwise TController string This is a string representing the name of the temperature controller mode point This is a point depicting the mode of operation and defines either auto output mode shift or manual output mode shift 0 This specifies manual output mode shift 1 This specifies auto output mode shift Typical Example templ
50. CX Supervisor Script Language Software Revision 3 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 DANGER Indicates information that if not heeded is likely to result in loss of life or serious injury WARNING Indicates information that if not heeded could possibly result in loss of life or serious injury Caution Indicates information that if not heeded could result in relatively serious or minor injury damage to the product or faulty operation OMRON Product References All OMRON products are capitalised in this manual The word Unit is also capitalised when it refers to an OMRON product regardless of whether or not it appears in the proper name of the product The abbreviation PLC means Programmable Logic Controller and is not used as an abbreviation for anything else Revision 2 0 Page i CX Supervisor Script Language OMRON Page ii Revision 2 0 OMRON CX Supervisor Script Language Visual Aids The following headings appear in the left column of the manual to help you locate different types of information Note Indicates
51. Expressions 3 F File Commands 81 CloseFile 81 CopyFile 81 DeleteFile 82 EditFile 82 FileExists 83 MoveFile 83 OpenFile 84 PrintFile 84 Read 85 ReadMessage 85 SelectFile 86 Write 87 WriteMessage 88 FileExists File Commands 83 For Next Loop Control Statements 21 Force Point Commands 61 ForceReset Point Commands 61 ForceSet Point Commands 62 FormatText Text Commands 92 Functions and Methods 9 34 Further Point Assignment Points 11 Page 177 INDEX Script Language G General Commands 49 DisplayPicture 50 Exponential 49 53 GetPerformancelnfo 54 PlayOLE 49 PlaySound 51 Rand 51 RunApplication 52 RunHelp 52 ShutDown 54 GenerateReport Report Commands 90 GetBit Point Commands 62 GetPerformanceInfo General Commands 54 GetPLCMode PLC Commands 67 GetTextLength Text Commands 94 Glossary of Terms 168 Graphic Object 171 Graphical User Interface See GUI GUI 171 H Height Object Commands 43 Hex Text Commands 94 Horizontal Fill Object Commands 43 I Icons 171 Indentation Punctuation 24 Indirection within Script Commands and Expressions 26 Ingredient 171 InitiateArray Point Commands 63 Input Point Point Commands 63 Input Output type 171 Is AlarmAcknowledged Alarm Commands 80 IsAlarmActive Alarm Commands 80 Item 171 Pag
52. H IR LR SR ST T TC TK W Functions for getting and setting the memory areas in the PLC Property Holds a list of all PLC names configured in the project file This property is read only Property Holds a list of all point names configured in the project file This property is read only Checks whether a point is currently indicating bad quality Reads the PLC Clock Sets the PLC Clock Function that enables raw FINS commands to be sent to a specified PLC Function for returning the connection status of a specified PLC Function for returning the device status of a specified temperature controller Function for switching a specified temperature controller into Remote or Local mode Sets PLC Network Node and Unit number and IP address Sets any element of device configuration Page 141 APPENDIX B CX Server Communications Control OMRON GetDeviceConfig Gets any element of device configuration UploadProgram Uploads a program from a PLC DownloadProgram Downloads a program to a PLC Protect Protects or releases protection on program memory LastErrorString Description of last error that occurred Value Reads the value of an address from a PLC or writes a value to an address in a PLC This function allows logical names Example 1 Reading a value from the PLC using a logical name intVal CXServer Value BoilerTemp or intVal CXServer BoilerTemp In these examples the PLC address associated wi
53. Min slider control throughout the flight Clicking Reset clears the current game and initialises a new game Clicking the on off pushbutton starts the game When the balloon is airborne clouds move slowly horizontally and change colour slightly Clicking Help at any time brings up a special help page clicking Close from this help page returns the user to the game The blue gauge shows the amount of fuel consumed and left The project consists of three page scripts and one object The three page scripts are initiated at varied intervals 10 milliseconds 100 milliseconds and 1000 milliseconds The page script initiated at intervals of 10 milliseconds determines the position of each cloud and the speed at which each cloud moves The page script initiated at intervals of 1000 milliseconds determines how the balloon reacts to the conditions Revision 2 0 Page 133 CHAPTER 7 Script Example OMRON The page script initiated at intervals of 100 milliseconds provides the main configuration of the game reacting to user input and moving the balloon accordingly This page script is as follows IF burner AND alt gt 400 0 THEN burner FALSE ENDIF IF burner THEN fuel fuel rate IF fuel lt 0 0 THEN fuel 0 0 burner FALSE ENDIF ENDIF IF burner AND fuel gt 0 0 AND rate gt 0 0 THEN lift lift rate 5 0 ELSE IF alt gt 140 0 THEN lift lift 0 2 ENDIF ENDIF IF lift lt 10 0 THEN lift 10 0 ENDIF alt alt l
54. OK OpenComponent Component PLC In this example the Performance Monitor component monitoring the PLC PLC06 is opened OK is used to determine if the action was successful Point Commands CancelForce Syntax returnstate CancelForce pointname Remarks Tie Returnstate is 1 if the function is successful or 0 otherwise pointname point Name of point If the point is an array point then all elements within the array have the CancelForce command applied Typical Example CancelForce point1 The forcing of values on the point point1 is cancelled References Refer to PLC operation manuals for a detailed description of Force Set and Force Reset Revision 2 0 Page 57 CHAPTER 6 Functions and Methods OMRON CopyArray Syntax CopyArray SourceArray DestArray Remarks menes nn SourceArray as Name of point array to copy from Typical Example InitArray DestArray 0 First initialise DestArray SourceArray 0 1 SourceArray 1 2 SourceArray 2 3 Then initialise SourceArray to 1 2 3 CopyArray SourceArray DestArray Finally copy the content of the source array SourceArray to the destination array DestArray The two arrays do not have to be the same size as each other for example if DestArray contains 20 elements only elements 0 1 and 2 are set to 1 2 and 3 respectively the remaining elements are unchange
55. OMRON The file c lautoexec bat is moved to the file c lautoexec old OpenFile Syntax returnstate OpenFile filename Remarks Returnstate bool Returnstate is 1 if the function is successful or 0 otherwise Pathname of file to be opened Typical Example OpenFile c filename The file c filename csf is opened and able to be accessed by the Read and Write script commands Only one file can be open at a time A file is created if it doesn t already exist Files can be shared for instance located on a network drive and accessed by several running CX Supervisor applications simultaneously this can be used for data exchange Note An extension csf will always be added to the filename so it must not be specifed as part of the argument PrintFile Syntax returnstate PrintFile filename Remarks ACTO IET TI Returnstate Returnstate is 1 if the function is successful or 0 otherwise Pathname of fle to be printed Typical Example PrintFile c lautoexec bat The file c autoexec bat is sent to the currently configured printer Script commands that have textual arguments can take either literal strings within quotes or text points Page 84 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Note CX Supervisor uses the OLE registration information file extension associations to decide how to print a file It inv
56. Page Commands Display Page Syntax display pagename or display pagename X Y Revision 2 0 Page 47 CHAPTER 6 Functions and Methods OMRON Remarks MT ion pagename This is the name of the page for display based on its filename without the file extension e g the pagename for CAR PAG is simply CAR Typical Examples display CAR The page CAR PAG is displayed textpoint CAR display textpoint The page CAR PAG is displayed display CAR 100 200 The page CAR PAG is displayed in a custom position 100 pixels across from the left of the main window and 200 pixels down from the top Close Page Syntax close pagename Remarks pagename This is the name of the page for closure based on its filename without the file extension e g the pagename for CAR PAG is simply CAR The pagename for closure must be currently open Note The close operation will cause the page to be unloaded including all objects ActiveX controls and scripts Care must be taken not to attempt to access them after the close instruction Note Where the script containing the close instruction is on the page to be closed this should be the last instruction in the script as it will cause the script to be unloaded Typical Examples close CAR The page CAR PAG is closed textpoint CAR close textpoint The page CAR PAG is closed P
57. Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks ACTO IET TN returnstate Returnstate is 1 if the function is successful or 0 otherwise helpfile Pathname of helpfile to be run helpindex Index into a help topic as defined by the help file being run Typical Example RunHelp c myhelp hlp 0 The helpfile c myhelp hlp is run and topic 0 shown SetLanguage Description Change the language of text on display This will reload the system language file from the program folder i e with a LNG extension and the user defined text from the application folder i e with a USL extension This function is the programmatic equivalent of the user right clicking and changing the Language Settings option Syntax SetLanguage language name Remarks OCT twee IC language name string Name of language to set to Must be identical to filename of related file with Ing file extension Standard options are English Czech Danish Deutsch Espa ol Finnish French Italiano Nederlands Belgi Norwegian Portugu s Slovenija and Swedish In addition Default will load the designers default language Typical Example SetLanguage Espa ol In this example the Spanish language files will be loaded SetLanguage Default In this example the language will revert to the default specified by the application designer Revision 2 0 Page 53 CHAPTER 6 Func
58. Supervisor application user manual This manual contains the following Chapter 1 Introduction An overview to this manual including special typographical conventions Chapter 2 Expressions A description of the use of expressions within scripts Chapter 3 Scripts An introduction to scripts and the type of scripts Chapter 4 CX Supervisor Script Language A detailed reference to the CX Supervisor script language Chapter 5 VBScript Language Reference A reference for the VBScript language Chapter 6 Functions and Methods A detailed reference to the functions and methods available to script languages Chapter 7 Script Examples A description of the script language in practice using some examples Chapter 8 Colour Palette A description of the colour palette that can be applied to certain script statements Appendix A OPC Communications Control This appendix contains a list of the available component properties and gives details of the Visual Basic script interface Appendix B CX Server Communications Control This appendix contains a list of the available component properties and gives details of the Visual Basic script interface Appendix C JScript Features This appendix provides a summary of the JScript features available for use with the ExecuteJScript and ExecuteJScriptFile script functions Appendix D Obsolete Features This appendix provides a summary of the obsolete features which remain enabled for backward com
59. TCRunStop e5ak temp2 Note This command was previously called TCModeShift TCSaveData Syntax returnstate TCSaveData TController Page 74 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks returnstate Bool Returnstate is 1 if the function is successful or 0 otherwise TController String This is a string representing the name of the temperature controller Typical Example templ TCSaveData e5ak temp2 TCSettingLevel1 Syntax returnstate TCSettingLevell TController Remarks returnstate Bool Returnstate is 1 if the function is successful or 0 otherwise TController String This is a string representing the name of the temperature controller Typical Example templ TCSettingLevell e5ak TCReset Syntax returnstate TCReset TController Remarks Returnstate is 1 if the function is successful or 0 otherwise TController String This is a string representing the name of the temperature controller Typical Example templ TCReset e5ak Revision 2 0 Page 75 CHAPTER 6 Functions and Methods OMRON Alarm Commands AcknowledgeAlarm Syntax returnstate AcknowledgeAlarm alarmname Remarks Returnstate is 1 if the function is successful or 0 otherwise This is the identifier of the alarm Typical Example AcknowledgeAlarm temphigh The alarm temphigh is acknow
60. The TCRemoteLocal command will execute the Remote Local command for the specified temperature controller Example in this example the E5AK device is being set to local mode Set the device to local mode CXServer TCRemoteLocal E5AK 1 Example in this example the E5AK device is being set to remote mode Set the device to remote mode CXServer TCRemoteLocal E5AK 0 SetDeviceAddress This function can be used to set key elements of a device address the network number node number unit number and Ethernet IP address The numbers are in the range 0 to 255 with 1 being used to denote ignore this parameter This function is for advanced users only Note this method does not interpret or verify the data passed and it is possible to pass invalid data that will prevent a device communicating Care should be taken to ensure that all data passed is valid This method should not be used while a PLC is open and communicating Example NetworkNum 1 NodeNum 2 UnitNum 1 iPAddress 10 0 0 1 bValid CXServer SetDeviceAddress PLC1 NetworkNum NodeNum UnitNum IPAddress Note The return Boolean value bValid is set to True if no errors were detected However this does not necessarily mean that all the parameters used were valid or appropriate for the PLC being used Revision 2 0 Page 149 APPENDIX B CX Server Communications Control OMRON SetDeviceConfig This is a function
61. X Supervisor User Manual for further details to configure the Alarm message printer Syntax righttext Right textpoint noofchars Remarks The text point containing the string that is to be manipulated The number of characters to extract from the end of the string righttext Text point containing the specified range of characters Typical Example textpoint abcdefgh righttext Right textpoint 3 The text point righttext contains the string fgh Revision 2 0 OMRON CHAPTER 6 Functions and Methods TextToValue Syntax valuepoint TextToValue textpoint Remarks ACTO te ET textpoint text The text point containing the string that is to be converted into a number A point containing the value returned after conversion from a string Typical Examples textpoint 10 valuepoint TextToValue textpoint The value 10 is assigned to the point valuepoint textpoint 10 34 realpoint TextToValue textpoint gt The real value 10 34 is assigned to the real point realpoint ValueToText Syntax textpoint ValueToText value Remarks ACTO EE ET value integer The number that is to be placed into the textpoint A point name is also a valid parameter textpoint text point A text point containing the value converted into a string Typical Examples textpoint ValueToText 10 The value 10 is put into a string and assigned to the te
62. a binary file Note The 4 and 5 parameters are reserved and should always be 1 and 0 respectively DownloadProgram The DownloadProgram function can be used to write a program to a PLC This function should not be used at the same time as any other PLC communications The project and PLC will automatically be opened if required This function is for advanced users only Note Care should be taken with this function to ensure that the program written is valid for the PLC to which it is downloaded Example bValid CXServer DownloadProgram PLC1 c test2 bin 1 0 The first parameter is the PLC name The second parameter is the local source file name A bin file extention is typical for a binary file To download the current program the third parameter should be an empty string but may also be set to the name of a file to download to the root directory of a memory card e g Example obj Note The 4 and 5 parameters are reserved and should always be 1 and 0 respectively Revision 2 0 Page 151 APPENDIX B CX Server Communications Control OMRON Protect The Protect function can be used to protect or remove protection from PLC program memory This function should not be used at the same time as any other PLC communications The project and PLC will automatically be opened if required This function is for advanced users only Example 1 sets protection for CS series PLC Dim SetProtection Dim PasswordStr
63. age 48 Revision 2 0 OMRON CHAPTER 6 Functions and Methods General Commands Exponential Description Mathematical function to calculate a value raised to a power Syntax result Exp value exponent Remarks ACTO Te IT result integer Point name to receive returned result of value raised to the power of exponent Power to raise value by Typical Example MSBMask Exp 2 15 In this example MSBMask is assigned the value 2 5 i e 32 768 PlayOLE Description Initiate an OLE verb or method on an OLE 2 object The verb number is object dependent so refer to the object s documentation This function is now largely obsolete as most objects are nowadays ActiveX objects Syntax returnstate PlayOLE objectname OLEVerbNumber Revision 2 0 Page 49 CHAPTER 6 Functions and Methods OMRON Remarks ACTO te TS returnstate Returnstate is 1 if the function is successful or 0 otherwise The identifier of the OLE object to be played OLEVerbNumber integer The verb number has a specific meaning to the OLE application Typical values are 0 specifies the action that occurs when an end user double clicks the object in its container The object determines this action often edit or play 1 instructs the object to show itself for editing or viewing Usually an alias for some other object defined verb 2 instructs an object to open itself for editing in a w
64. al or arithmetical notation as a test The condition can evaluate Boolean state TRUE and FALSE Integer or Real numbers or a text string Statementblock1 One or more statements which are performed if the condition is met Statementblock2 One or more statements which are performed if the condition is not met Typical Examples IF fuel lt 0 THEN fuel 0 ENDIF Provided Integer point fuel is less than 0 then it is assigned the value 0 IF burner THEN fuel fuel rate ENDIF Provided Boolean point burner is TRUE then Integer point fuel is assigned a new value It is also possible to apply IF burner TRUE THEN as the first line with identical results IF distance gt 630 AND distance lt 660 AND lift gt 3 THEN winner TRUE burner FALSE ENDIF Provided that Integer point distance is greater in value than 630 AND distance is less in value than 660 i e distance is a value between 630 and 660 AND point lift is greater than or equal to 3 then Boolean points winner and burner are assigned new values IF burner AND fuel gt 0 AND rate gt 0 THEN fuel fuel rate ELSE lift 0 altitude 0 ENDIF Provided that Boolean point burner is TRUE AND points fuel and rate are greater in value than 0 then fuel is assigned a new value Otherwise points lift and altitude are assigned a
65. alog is not shown the page is just printed PrintScreen Syntax returnstate PrintScreen flag Remarks Returnstate is 1 if the function is successful or 0 otherwise flag bool Flag to indicate whether the print setup dialog is to be displayed before printing Typical Example PrintScreen FALSE All CX Supervisor pages currently on view is printed The flag FALSE indicates that the print dialog is not displayed A flag of TRUE causes the print dialog to be shown allowing the user to configure or choose the printer PrintSpoolQueue Syntax returnstate PrintspoolQueue Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example PrintSpoolQueue Any message typically printed alarms that are queued up waiting to be sent to the CX Supervisor Alarm Message printer is printed immediately Page 102 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Security Commands Login Syntax returnstate Login username password Remarks ACT tre ET returnstate bool Returnstate is 1 if the function is successful or 0 otherwise username Text Optional parameter with name of user to login If omitted the login dialog will be shown password Text Optional parameter with password for user to login If used username must be specified even if only empty i e If omitted the login dialog will be shown Typi
66. ans MyArray 0 Page 5 CHAPTER 2 Expressions OMRON Page 6 Revision 2 0 OMRON CHAPTER 3 Scripts CHAPTER 3 Scripts A CX Supervisor script is a simple programming language used to manipulate points Scripts can be created at different levels at object level page level or project level Although the script code can be applied to all levels of script there are subtle differences described in the following paragraphs Object If a script is executed as a runtime action of an object then the script can affect the object of the action or any other depending on the actual content of the script Page Page scripts are concerned with manipulating points and graphical objects that are used or included within that page In other words page scripts are used to drive a number of actions on the occurrence of a particular event These actions may manipulate several graphical objects on one page Project Scripts can be applied to a project to manipulate points These scripts are associated with events that occur throughout the whole operating session Revision 2 0 Page 7 CHAPTER 3 Scripts OMRON Page 8 Revision 2 0 OMRON CHAPTER 4 CHAPTER 4 CX Supervisor Script Language CX Supervisor Script Language Revision 2 0 This chapter describes the CX Supervisor script language syntax It provides a detailed definition of the syntax of CX Supervisor scripts that drive project page and object actions and CX Supervis
67. auto open Recordsets can be opened in isolation by selecting the appropriate level Syntax returnstate DBOpen level Remarks ACTO we seston id returnstate 1 if the function is successful otherwise 0 level A text point or constant specifying the connection level This may be a Connection or Recordset level Typical Examples DBOpen Northwind Open the connection to the Northwind database and automatically open any Recordsets set to open on connection done DBOpen Northwind Order Details Just open a specific Recordset Revision 2 0 Page 117 CHAPTER 6 Functions and Methods OMRON DBProperty Description Returns the requested property This function operates on the Recordset and Field levels The type of the value returned depends on the property requested Syntax returnstate DBProperty level property Remarks returnstate Property value returned See table for type level A text point or constant specifying the connection level This may be a Recordset or Field level property The name of the property to get For details see the Recordset Properties and Field Properties tables Typical Examples Page DBProperty CSV Result CurrentPage Get the current page for the CSV Result Recordset FieldSize DBProperty Northwind Customers Address Size Get the size for the Address field Note The Recordset will only return valid properties when it is Open R
68. ay work but should only be used on Omron advice GetDeviceConfig This is a function that can be used to read any element of the CX Server device configuration All the data is passed and received in textual form This function is for advanced users only Example Page 150 Dim Setting Device PLC 1 Section NET Entry IPADDR Setting CXServer GetDeviceConfig Device Section Entry Revision 2 0 OMRON APPENDIX B CX Server Communications Control Currently supported parameter values are as described for the SetDeviceConfig method UploadProgram The UploadProgram function can be used to read a program from a PLC The program is read in binary form and stored in a user specified file This function should not be used at the same time as any other PLC communications The project and PLC will automatically be opened if required This function is for advanced users only Example Dim SourceFile Dim DestinationFile Sourcefile DestinationFile c test1 bin CXServer UploadProgram PLC1 SourceFile DestinationFile 1 0 The first parameter is the PLC name The second parameter is the source file name To upload the current program this should be an empty string but may also be set to the name of a file in the root directory of a memory card e g Example obj The third parameter is the name of the local file to store the program A bin file extention is typical for
69. cal Examples Login The Login dialog is displayed for user entry Login Designer Designer The default Designer user is logged in automatically using matching password References Refer to the CX Supervisor User Manual for details of Login Logout Syntax returnstate Logout Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example Logout The user is logged out Revision 2 0 Page 103 CHAPTER 6 Functions and Methods OMRON References Refer to the CX Supervisor User Manual for details of Logout Setup Users Syntax returnstate SetupUsers Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example SetupUsers The Setup Users dialog is displayed for user entry References Refer to the CX Supervisor User Manual for details of setting and modifying user details Data Logging Commands ClearLogFile Syntax ClearLogFile datasetname Remarks Name of Data Set to clear as text point or constant Typical Example ClearLogFile Process 1 This command will clear all data from the active latest log file for this data set and add a Clear Event indicator Page 104 Revision 2 0 OMRON CHAPTER 6 Functions and Methods CloseLogFile Syntax returnstate CloseLogFile datasetname or returnstate CloseLogFile databaselink Remarks returnstate Optio
70. ch offset top The height of object LINE_1 is changed to the value calculated by points stretch and offset keeping the top where it is Horizontal Fill Syntax objectname horizontal fill expression context Revision 2 0 Page 43 CHAPTER 6 Functions and Methods OMRON Move Page 44 Remarks MT ion objectname This is the name of the object Where a script is directly attached to an object objectname is not required expression This is an arithmetic expression that must return a value between 0 and 100 On return of a valid result the fill commences from left to right context This argument is optional and may be omitted It defines which side of the object is filled from May be one of LEFT fill from the left RIGHT fill from the right If omitted LEFT is assumed Typical Examples horizontal fill 50 The current object to which this example applies is filled by 50 ELLIPS Gl 1 horizontal fill GAS LEVEL RIGHT The object ELLIPSE 1 is filled from the right provided the point GAS LEVEL returns a valid result between 0 and 100 Syntax objectname move x co ordinate y co ordinate Remarks MT anion objectname This is the name of the object following any amendment to the object name Where a script is directly attached to an object objectname is not required x co ordinate The x and y co ordinates of the origin of the object at its resultan
71. controller TCSettingLevel1 temp controller command All Performs a settinglevel function for the temperature controller TextToValue text command Scr Converts a string to a numerical point value UploadPLCProgram PLC command All Uploads programs in the PLC to specified files ValueToText Converts a numerical value into a text point verica object command _ OP Species he vertical lof an object vse Tobjectcommand OP Toggles the visibility ofan objet wan Tobjectcommand OP Specifies the width of an obet Revision 2 0 Page 37 CHAPTER 6 Functions and Methods OMRON Function Name Function Type Remarks WriteMessage Writes text to an external file The Type column refers to the types of script and expression the function can be applied to All refers to both expressions and scripts Scr refers to scripts only OP refers to Object and Page scripts only Object Commands Object commands control native CX Supervisor graphical objects like rectangles or lines Note Objects are native to CX Supervisor and therefore cannot be accessed or commands issued from external script languages like VBScript or Jscript Current Object Syntax objectcommand Remarks objectcommand The expression can be made up of the following commands which are also described in chapter 6 Object Commands Colour command Disable command Visible command Move command Rotate command Vertical fill comman
72. cript stored in a text file to be executed This uses the windows scripting host which must be installed See chapter 5 for a list of supported functions Syntax returnstate ExecuteVBScriptFile scriptfile Remarks returnstate bool 1 if the function is successful otherwise 0 scriptfile Text The name of the file with the Visual Basic Script to execute Typical Examples returnstate ExecuteVBScriptFile c vbscript txt This will execute the Visual Basic Script stored in c vbscript txt Page 130 Revision 2 0 OMRON CHAPTER 6 Functions and Methods ExecuteJScriptFile Description Allows Java script stored in a text file to be executed This uses the windows scripting host which must be installed See Appendix C for a list of supported functions Syntax returnstate ExecuteJScriptFile scriptfile Remarks returnstate bool 1 if the function is successful otherwise 0 scriptfile Text The name of the file with the Java Script to execute Typical Examples returnstate ExecuteJScriptFile c jscript txt This will execute the Java Script stored in c jscript txt GenerateEvent Description This command is only used in conjunction with a remote connection using a CX Supervisor Communications control see User Manual Chapter 15 Connecting to remote applications This command allows the Server machine to post unsolicited data back to the client machine This data is captur
73. ctions and Methods Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise Typical Example ShutDown CX Supervisor runtime operation is terminated Communications Commands CloseComponent Syntax Returnstate CloseComponent ComponentName PLCName Remarks Aumont IET TN returnstate Returnstate is 1 if the function is successful or 0 otherwise ComponentName text A Text point or text constant containing the name of the component to close PLCName text Text point or text constant containing the name of the PLC that the component to close is attached to Typical Examples CloseComponent PLC Data Monitor MyPLC In this example the PLC Data Monitor component monitoring the PLC MyPLC is closed Component Performance Monitor PLC PLCO6 OK CloseComponent Component PLC In this example the Performance Monitor component monitoring the PLC PLC06 is closed OK is used to determine if the action was successful EnableOLE Syntax returnstate EnableOLE pointname Revision 2 0 Page 55 CHAPTER 6 Functions and Methods OMRON Remarks A A a returnstate bool Returnstate is 1 if the function is successful or 0 otherwise A Boolean point that holds the required enable disable state Typical Examples EnableOLE result OLE functions are enabled based on the value of point resul
74. d References Refer to the CX Supervisor User Manual for details of alarms CloseAlarmStatus Syntax returnstate CloseAlarmStatus Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example CloseAlarmStatus The current alarm status window is closed References Refer to the CX Supervisor User Manual for details of alarms DisplayAlarmHistory Syntax returnstate DisplayAlarmHistory Remarks Returnstate is 1 if the function is successful or 0 otherwise Page 78 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Typical Example DisplayAlarmHistory The alarm history window is displayed References Refer to the CX Supervisor User Manual for details of alarms DisplayAlarmStatus Syntax returnstate DisplayAlarmStatus Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example DisplayAlarmStatus The current alarm status is displayed References Refer to the CX Supervisor User Manual for details of alarms EnableAlarms Syntax EnableAlarms flag message Remarks flag If set TRUE then alarm logging is enabled If set FALSE logging is disabled message Text message which is recorded in the alarm log to indicate change of status Typical Example EnableAlarms TRUE Alarm logging enabled Revision 2 0 Page 79 CHAPTER 6 F
75. d Horizontal fill command Height command Width command The content of the commands are made up of arithmetical or logical expressions x and y co ordinates or references varying between commands The colour command requires a colour identifier Typical Example colour red The current object is specified as red in colour Page 38 Revision 2 0 OMRON CHAPTER 6 Functions and Methods References Refer to 1 1 10 10 1 Other Objects Syntax Chapter 6 Blink for use of the blink command Chapter 6 Colour for use of the colour command Chapter 6 Disable for use of the disable command Chapter 6 Height for use of the height command Chapter 6 Horizontal Fill for use of the horizontal fill command Chapter 6 Move for use of the move command Chapter 6 Rotate for use of the rotate command Chapter 6 Vertical Fill for use of the vertical fill command Chapter 6 Visible for use of the visible command Chapter 6 Width for use of the width command The CX Supervisor User Manual for details of the Animation Editor objectname objectcommand pagename objectname objectcommand Remarks objectname objectcommand This is the name of the object The object is provided with a generic name on creation which can be amended later to something more meaningful The script is automatically updated following any amendment to the object name This can be made up of the following commands
76. d i e O s If DestArray is smaller than SourceArray i e it contains two elements then only elements 0 and 1 are set to 1 and 2 respectively Note CopyArray accepts arrays of different type i e Boolean arrays can be copied into Real arrays the only restriction is that Text arrays cannot be copied into numeric arrays and vice versa DisableGroup Syntax returnstate DisableGroup groupname Remarks ACTO Te IT Returnstate is 1 if the function is successful or 0 otherwise Name of the group containing the points to disable Page 58 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Typical Example DisableGroup lt Default gt All points belonging to the lt Default gt group is disabled thus preventing values from being read written DisablePoint Syntax returnstate DisablePoint pointname Remarks E Returnstate is 1 if the function is successful or 0 otherwise Name of point w e disabled Typical Example DisablePoint point1 The point point1 is disabled thus preventing values to be read written Note This is useful for optimisation of communications EditPoint Syntax EditPoint BoolPoint Caption OffText OnText or EditPoint AnalogPoint Caption MinValue MaxValue Keyboard or EditPoint TextPoint EchoOff Keyboard Revision 2 0 Page 59 CHAPTER 6 Functions and Methods OMRON Remarks arsument ATI IO
77. dify the connection string BeginTrans Connection Begins a new Transaction CommitTrans Connection Saves any pending changes and ends the current transaction RollbackTrans Connection Cancels any changes made and ends the transaction CommitTransAll Connection Saves all changes and ends all transactions RollbackTransAll Connection Cancels all changes and ends all transactions TransCount Connection Returns the number of pending transactions Requery Recordset Re run the Recordset Query CancelUpdate Recordset Cancel a DBAddNew operation Find Recordset Find the specified criteria in a Recordset FinNext Recordset Combined DBMove Next DBFind operation Source Recordset Modify the Recordset source Filter Recordset Apply a filter to a Recordset Save Recordset Saves a Recordset in XML format DBGetLastError Description Returns the last error string generated by the Database provider and displays it in a message box Syntax returnstate DBGetLastError level display Page 114 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks ACTA e TN returnstate The error message from the provider level A text point or constant specifying the connection level This must be a Connection level display Optional flag By default DBGetLastError will display the providers error message in a message box Setting this flag to FALSE prevents this action Typical Examples DBGetLastError Northwind or DBGetLastErro
78. e The contents of this point are assigned to the server application Typical Example channelname DDEInitiate Excel Sheet1 xls DDEPoke channelname R2C5 data Revision 2 0 Page 159 APPENDIX D Obsolete Features OMRON The content of point data is sent to row 2 column 5 of SHEET1 XLS in the Microsoft application The Microsoft Excel application and SHEET1 XLS are specified by Integer point channelname DDERequest Syntax pointname DDERequest channel item Remarks channel Integer This is an integer point which contains the return value of the point DDEInitiate command Both server and topic parameters applied to the channel in the DDEInitiate command must be open or an error is reported item string This is an item as recognised by the server application For instance a cell is an item within a spreadsheet application Likewise a page is an item for a word processing application It is wholly dependent on the server application pointname point This is a point whose attributes must include a DDE Access of Read Write Typical Example channelname DDEInitiate Excel Sheet1 xls cellref DDERequest channelname R2C5 The point cellref is filled from a specific item row 2 column 5 from SHEET1 XLS from the Microsoft Excel application specified by the Integer point channelname DDETerminate Syntax returnstate DDETerminat
79. e Syntax returnstate OpenLogFile datasetname or returnstate OpenLogFile databaselink Remarks Optional 1 if the function is successful otherwise 0 datasetname text Name of Data Set to open as text point or constant databaselink text Name of Database link to open as text point or constant Typical Example OpenLogFile Balloon This command will open the log file ready to start logging As the function is disk intensive it should not be called frequently OpenLogView Syntax OpenLogView datasetname item list sessionfile or OpenLogView datasetname TextArray sessionfile Page 108 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks Argument Type Description datasetname string Name of Data Set to view as text point or constant item list string List of Items and or Groups within the data set to view separated by commas TextArray string A text point which has an array size specified as 1 or more array elements Each element holds an Item or Group name sessionfile string Optional filename of session information file The Data Log Viewer is shown with the session settings e g Window position size colours grid options etc stored in the session file If omitted the previous settings are used Typical Example OpenLogView Balloon Altitude Fuel Burning Lift Group 1 or ItemList 0 ItemList 1 ItemList 2 ItemList 3 ItemList 4
80. e channel Remarks Returnstate is 1 if the function is successful or 0 otherwise channel Integer This is an integer point which contains the return value of the point DDEInitiate command Both server and topic parameters applied to the channel in the DDEInitiate command must be open or an error is reported Page 160 Revision 2 0 OMRON APPENDIX D Obsolete Features Typical Example DDETerminate channelname The server and topic specified by Integer point channelname is closed DDETerminateAll Syntax returnstate DDETerminateAll Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example DDETerminateAll All previously initiated DDE links are closed EnableDDE Syntax returnstate EnableDDE pointname Remarks Returnstate is 1 if the function is successful or 0 otherwise bool point A Boolean point that holds the required enable disable state Typical Examples EnableDDE result DDE functions are enabled based on the value of point result If point is TRUE then DDE is enabled if point is FALSE then DDE is disabled EnableDDE TRUE DDE functions can also be enabled directly without using a point to hold the desired status Revision 2 0 Page 161 APPENDIX D Obsolete Features OMRON Graph Commands ClearGraph Syntax returnstate ClearGraph
81. e 178 OMRON J Java Script See JScript Java Script Features 154 JScript 171 JScript Features 154 L Left Text Commands 94 Lite Communications Control 141 LogError Event Error Commands 99 LogEvent Event Error Commands 99 Logic and Arithmetic 12 Arithmetic Operators 12 Bitwise Operators 12 Relational Operators 14 Logical Operators Logic and Arithmetic 13 Login Security Commands 103 Logout Security Commands 103 M Message Text Commands 95 Microsoft Excel 171 Windows 171 Word for Windows 171 Mid Text Commands 95 Miscellaneous Commands Remarks 25 Move Object Commands 44 MoveFile File Commands 83 Multiple Commands Punctuation 24 N Nested Conditional Statements Control Statements 17 Nesting 171 Non volatile 172 Revision 2 0 OMRON O Object 172 Object Commands 38 Blink 40 Colour 41 Current Object 38 Disable 42 Height 43 Horizontal Fill 43 Move 44 Other Objects 39 Rotate 45 Vertical Fill 46 Visible 46 Width 47 Objects Scripts 7 Obsolete Features 156 OPC Communications Control 139 OpenComponent Communications Commands 56 OpenFile File Commands 84 OpenLogFile Data Logging Commands 108 OpenLogView Data Logging Commands 108 Other Objects Object Commands 39 OutputP oint Point Commands 64 P Page Scripts 7 Page Command
82. e enabled Typical Example EnablePoint point1 The point point1 is enabled thus allowing values to be read written Force Syntax returnstate Force pointname Remarks Returnstate is 1 if the function is successful or 0 otherwise pointname point Name of point to have force state applied If the point is an array point then all elements within the array have the Force command applied Typical Example Force point1 The point point1 is locked in its current state i e if it is currently set to 1 it cannot be changed until the forced state is removed via the CancelForce command ForceReset Syntax returnstate ForceReset pointname Revision 2 0 Page 61 CHAPTER 6 Functions and Methods OMRON Remarks A e e returnstate bool Returnstate is 1 if the function is successful or 0 otherwise pointname point Name of point If the point is an array point then all elements within the array have the ForceReset command applied Typical Example ForceReset point1 The Boolean point point1 has its value set to FALSE References Refer to PLC operation manuals for a detailed description of ForceSet and ForceReset ForceSet Syntax returnstate ForceSet pointname Remarks Returnstate is 1 if the function is successful or 0 otherwise pointname point Name of point If the point is an array point then all elements within
83. e following commands has the same effect Using a string literal PlayOLE ole 1 0 Using a textpoint directly textpoint ole 1 PlayOLE textpoint 0 Using a textpoint indirectly via the 2 notation text ole 1 textpoint text PlayOLE textpoint 0 It is possible to use text points indirectly in place of point name arguments within script commands For instance each of the following commands has the same effect Using a point name directly verbnumber 0 PlayOLE ole 1 verbnumber Using a textpoint indirectly via the notation verbnumber 0 textpoint verbnumber PlayOLE ole 1 textpoint An example using Indirection The value of point indirection can be seen in a situation where it is necessary to dynamically change the pointname that an object is linked to In the following example a toggle button is configured to control the Boolean state of one of four points The four Boolean points to be controlled are called motor1 motor2 motor3 and motor4 The text point textpoint is used to store the name of the Boolean point to be controlled The text point text is used to store the string value of the integer point index The integer point index which has a range 1 4 is used to dynamically change the point being controlled Access to any of the four Boolean points motor1 motor2
84. e function is successful or 0 otherwise TController string This is a string representing the name of the temperature controller mode point This is a point depicting the mode of operation and defines the method used by a temperature controller for storing internal variables 0 In this mode variables are stored in RAM and EPROM 1 In this mode variables are stored in RAM only Typical Example templ TCBackupMode ea5k temp2 TCGetStatusParameter Syntax returnstate TCGetStatusParameter TController paramID value Revision 2 0 Page 71 CHAPTER 6 Functions and Methods OMRON Remarks A e a returnstate bool Returnstatei is 1 if the function is successful or 0 otherwise TController string This is a string representing the name of the temperature controller OCNIANDNRWNK O NO paramID point This is a point depicting the required parameter range 0 to 22 ControlMode Output InputShiftDelay Bool E5 F ES X ES J DisplayUnit PIDConstantDisplay Bool E5 F E5 X ES J OutputT ype CoolingType Output2 Alarm1 Alarm2 10 InputType Integer ES F E5 X ES J 11 OperationMode 12 BackupMode 13 AutoTuneMode 14 OverFlow Bool ES F E5 X E5 J 15 UnderFlow Bool E5 F E5 X ES J 16 SensorMalfunction Bool ES F E5 X E5 J 17 ADConvertorFailure Bool ES F E5 X E5 J 18 RAMAbnormality Bool E5 F E5 X E5 J 19 RAMMismatch Bool E5 F
85. e of the report template file ReportOutputFile Pathname of the report output file Typical Example GenerateReport report3 txt output txt The ReportTemplateFile report3 txt contains a predefined set of point names and text laid out exactly as the report reader likes to view them The point names contained within enclosing characters are the CX Supervisor names for the data that is required in the report The enclosing characters can be changed in the Project Runtime Setting Report setting dialog box but once set must be fixed for all reports generated by the project 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 CHAPTER 6 Functions and Methods Remarks returnstate bool Returnstate is 1 if the function is successful or 0 otherwise ReportTemplateFile 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 Returnstate is 1 if
86. e to be assigned a value based on an arithmetical expression expression The value to be assigned to pointname The expression may include the following operators with points and constants Addition Subtraction Multiplication Division Modulus Increment Decrement Typical Examples result 60 20 5 The Integer or Real point result is assigned the value calculated by the value of 20 divided by 5 plus 60 lift height rate 5 0 The Integer or Real point lift is assigned the value calculated by the value of point rate divided by 5 plus the value of point height Precedence can be changed by the introduction of parenthesis References Refer to chapter 4 Punctuation for details of the use of parenthesis Bitwise Operators Syntax pointname expression or IF expression or DO WHILE expression Page 12 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language or DO UNTIL expression Remarks Argument Description The pointname to be assigned a value based on the bitwise operation expression The value to be assigned to pointname or to be evaluated as a Boolean expression The expression can include the following operators with points and constants Bitwise AND BITAND or amp Bitwise OR BITOR or Bitwise XOR XOR or Bitwise Shift Left SHL or lt lt
87. ecordset Properties The properties of a Recordset are Page 118 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Property Description Return type CurrentRecord Current cursor position Integer RecordCount Number of records in the Recordset Integer Bookmark Record marker Real PageCount Number of pages in the Recordset Integer PageSize Number of records in a page Integer CurrentPage Page in which the cursor position resides Integer Source Command or SQL that created the Recordset Text Sort Field name s the Recordset is sorted on Text FieldCount Number of fields columns in the Recordset Integer BOF Current position is at the start of the Recordset Bool EOF Current position is at the end of the Recordset Bool Field Properties The properties of a Field are Value of the field at the current position As type of field Name of the Field String The fields data type String Maximum width of the field Integer DBRead Description Reads a record from a Recordset to the associated point s or if associated points are array points reads a whole page of records This function operates on both Recordset and Field levels At the Field level the associated column values from the Recordsets current position will be copied into the Point number of elements copied number of elements in the Point no paging applies at the Field level Syntax retur
88. ed 1000 then the RETURN command is not executed and statements after the RETURN command are performed References Refer to the CX Supervisor User Manual for the use of the RETURN statement for Recipe validation Punctuation Command String Delimiters Description Alternative string delimiters allowing string to contain quote characters Revision 2 0 Page 23 CHAPTER 4 CX Supervisor Script Language OMRON Syntax Some string text Typical Example Message Error Invalid Function occurred The f and braces inserted around the whole strings allows the actual text in the string to contain quotes which will be displayed normally They can be used in any situation where quotes can be used whether or not embedded quotes are required However for clarity the quote characters should be used by preference Indentation Typical Examples IF burner AND fuel gt 0 AND rate gt 0 THEN lift lift rate 5 ELSE IF altitude gt 140 THEN lift lift 0 2 ENDIF ENDIF IF burner AND fuel gt 0 AND rate gt O THEN lift lift rate 5 ELSE IF altitude gt 140 THEN VEE TREE 0 2 ENDIF ENDIF Both examples provide identical functionality but the use of indentation either spaces or tabs to show the construction of the statements aids readability The use of the ELSEIF statement in this example was omitted for clarity Multiple Commands Typical Examples count 75 result log count
89. ed in the client s OnEvent handler The data for the parameters is entirely at the designer s discretion depending on what the client needs to be informed of Syntax returnstate GenerateEvent paraml param2 param3 Remarks returnstate 1 if the function is successful otherwise 0 paraml Optional Parameter of data to send param2 Optional Parameter of data to send param3 Optional Parameter of data to send Revision 2 0 Page 131 CHAPTER 6 Functions and Methods OMRON Typical Examples returnstate GenerateEvent Archive W w An Archive event is sent to the client application that may force the client to perform some specified archive operation The second and third parameters are not used returnstate GenerateEvent Alarm Set Boiler alarm 95 5 An event is sent to the client application which can be interpreted as The Boiler alarm has been set with a process value of 95 5 Page 132 Revision 2 0 OMRON CHAPTER 7 Script Example CHAPTER 7 Script Example This chapter provides an example application for a script The script is a typical script exercising the basic commands It is described twice once as a whole and once on a line by line basis Balloon Script The following script applies to a simple game JE U Help Reset a en 0 The user must attempt to land the balloon on the plateau on the right using the Max
90. eld ef gt gt gt gt gt H H o He oo o oo FT FT Fe SF He b Blink Close page Colour Change Analogue Colour Change Digital Display Status Text Display Text Point Display Value Edit point value Analogue Edit point value Digital Edit point value Text Enable Disable Horizontal move Horizontal percentage fill Resize height Resize width Rotate Show page Vertical move Vertical percentage fill Visible The following example of a simple expression contains a point redcars attached to a particular object with an appropriate object action Resize Height At runtime once the value of the point has been met within the attributes declared within the Active Expression Range Required Height fields Revision 2 0 Page 3 CHAPTER 2 Expressions OMRON the current object is resized accordingly This example is an Integer or Real example whereby the value of the point either falls inside or outside the specified range In this example the point redcars must fall between 0 and 40 for the expression to be met Resize Height x Expression redcars Cancel Active Expression Range Required Height Minimum Value fo Minimurn Height fo Maximum Value fao Maximum Height fiso Justification 7 Bottom C Centre C Top The following example of a more complex expression contains a test on point position If position is more than 3
91. er topic Remarks channel Integer This is an integer point which contains the return value of the point DDEInitiate command server String This contains the application that supports DDE as a DDE server Typically this is the name of the applications EXE executable file without the filename extension At runtime the server application must be open or a value cannot be returned and an error is reported topic String This contains the name of the topic recognised by the server application Typically a topic is a document within an application At runtime the topic must be open or a value cannot be returned and an error is reported The topic may be left empty which enables documents to open remotely prior to making a specified connection The topic name System may be used to find out which other topics within the server application are available However this is dependant on the server application supporting this topic Typical Example channelname DDEInitiate Excel Sheet1 xls The Integer point channelname is provided with a DDE link to the application Microsoft Excel which is run by the executable filename EXCEL EXE and to the file SHEET1 XLS within that application DDEOpenLinks Syntax returnstate DDEOpenLinks channel Page 158 Revision 2 0 OMRON APPENDIX D Obsolete Features Remarks ACETONA servo returnstate Returnstate is 1 if the function is successful or
92. erOfRecords DBSchema Invoice Data Types RecordCount Read the Number of records in the Schema DBSchema Invoice Data types Read 2 Read Schema page 2 results into the associated point DBSchema Invoice Data Types Set Columns COLUMN_NAME Set a new Schema to return column names DBState Description Reports if the specified level is in the requested state Revision 2 0 Page 121 CHAPTER 6 Functions and Methods OMRON Syntax return DBState level state Remarks return 1 if the specified level is in the requested state otherwise 0 level A text point or constant specifying the connection level This may be a Connection or Recordset level state The requested state must be either Open or Closed Typical Examples State DBState Invoice Closed Checks ifthe Connection Invoice is currently closed State DBState Northwind Customers Open Checks if the Recordset Customers is currently open DBSupports Description Returns TRUE if the specified Recordset supports the requested operation Syntax return DBSupports level operation Remarks return 1 if the specified Recordset supports the requested operation otherwise 0 level A text point or constant specifying the connection level This must be a Recordset level operation The requested operation may be one of AddNew Bookmark Delete Find MovePrevious or Update
93. f colour names and colour numbers Disable Syntax objectname disable expression Remarks objectname This is the name of the selectable object Where a script is directly attached to an object objectname is not required The expression can be made up of points resulting in TRUE or FALSE Typical Examples disable TRUE The current pushbutton object to which this example applies is disabled PUSH 8 disable count AND flag Page 42 Revision 2 0 OMRON CHAPTER 6 Functions and Methods The selectable object PUSH_8 is disabled provided Integer point count AND Boolean point flag return TRUE Height Syntax objectname height expression context objectname height expression Remarks Argument Description objectname This is the name of the object following any amendment to the object name Where a script is directly attached to an object objectname is not required expression This is a value point or an arithmetic expression returning a new height value in pixels context This argument is optional and may be omitted It defines which part of the object is the datum and remains static May be one of TOP uses object top as datum CENTRE uses object centre as datum BOTTOM uses object bottom as datum If omitted CENTRE is assumed Typical Examples height 100 or height 100 The height of the current object is set to 100 LINE 1 height stret
94. function is successful or 0 otherwise Contains the text string that is displayed in the Error Log priority integer Priority assigned to the error 0 low 1 medium 2 high Typical Example LogError This is an error 1 The message This is an error appears as a medium priority error in the error log LogEvent Syntax returnstate LogEvent message Revision 2 0 Page 99 CHAPTER 6 Functions and Methods OMRON Remarks returnstate bool Returnstate is 1 if the function is successful or 0 otherwise Contains the text string that is displayed in the Error Log Typical Example LogEvent this is an event The message this is an event appears as an event in the error log Printer Commands ClearSpoolQueue Syntax returnstate ClearSpoolQueue Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example ClearSpoolQueue Any messages typically printed alarms that are queued up waiting to be sent to the CX Supervisor Alarm Message printer is discarded EnablePrinting Syntax returnstate EnablePrinting flag Remarks Returnstate is 1 if the function is successful or 0 otherwise Oo disable To eable Page 100 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Typical Example EnablePrinting FALSE Disables printing EnablePrinting TRUE Enables printing
95. gral part of Microsoft Windows which allows Microsoft Windows based applications to be started from icons and for all applications to be organised CX Supervisor can be run from Windows Desktop A scripting engine supplied by Microsoft to run VBScript or JScript See http msdn microsoft com scripting Wizards are dialogs used by the CX Supervisor development environment to take the user through complex operations in a simplified step by step process Page 175 INDEX Script Language INDEX A AcknowledgeAlarms Alarm Commands 76 AcknowledgeAllAlarms Alarm Commands 76 AcknowledgeLatestAlarm Alarm Commands 77 Alarm Commands 76 AcknowledgeAlarms 76 AcknowledgeAllAlarms 76 AcknowledgeLatestAlarm 77 ClearAlarmHistory 77 CloseAlarmHistory 77 CloseAlarmStatus 78 DisplayAlarmHistory 78 DisplayAlarmStatus 79 EnableAlarms 79 Is AlarmAcknowledged 80 IsAlarmActive 80 Alarms Script Editor 76 81 Alias Examples 29 Animation Editor Expressions 3 170 Animations Expressions within 3 Appendix A OPC Communications Control 139 Appendix B Lite Communications Control 141 Appendix C JScript Features 154 Appendix D Obsolete Features 156 Application 168 Arguments 168 Arithmetic Operators Logic and Arithmetic 12 B Balloon Script Script Examples 133 Basic Point Assignment Points 10 BCD Text Commands 91 Page 176 OMRON Bin Text Commands 92 Bitma
96. he application in the CX Supervisor development environment Supervisory Control and Data Acquisition see CX Supervisor Page 173 GLOSSARY OF TERMS Script Language Server Server Application Statement String SVGA mode CX Supervisor Target Value Taskbar Text Object Text type Unicode Validation Code VGA mode VBScript Page 174 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 Within the CX Supervisor script language a statement is a command understood by the run time environment Statements are constructed of commands and arguments which when combined help to formulate a finished application to be used in the run time environment The contents of a Text type point that can only contain literal alphanumeric characters A string starts following an opening quotation mark and ends before a closing question mark in the example name spot the point name holds the string spot A mode of video display that provides 800 x 600 pixel resolution or higher with 16 or more colours and is supported on Super Video Graphics Adapter systems A SCADA software application which creates and maintains graphical user interfaces and
97. he value of lift Outside of the script language expressions consisting of operators and operands can be used to control objects through actions Revision 2 0 OMRON Field association Graphic Object GUI I O type Icon Ingredient Integer type Ttem JScript JVM Microsoft Excel Microsoft Windows Microsoft Word for Windows Nesting Revision 2 0 GLOSSARY OF TERMS Script Language A field association enables a link to be made between a CX Supervisor Point and a particular field i e column within a recordset In CX Supervisor a graphic object is created in the development environment and can be a line an arc a polygon including a square and rectangle a round rectangle an ellipse including a circle or a polyline A complex object can exist as a combination of two or more graphic objects Graphical User Interface Part of a program that interacts with the user and takes full advantage of the graphics displays of computers A GUI employs pull down menus and dialog boxes for ease of use Like all Microsoft Windows based applications CX Supervisor has a GUI Input Output type An attribute of a point that defines the origin and destination of the data for that point The data for a point can originate be input from and is destined is output to to the internal computer memory or PLC Pictorial representations of computer resources and functions The CX Supervisor development environ
98. hema results or properties or set up new schema criteria This function operates only at a Schema level Syntax return DBSchema level command parameters Page 120 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks ACTA e TN return Value returned by command For some commands e g RecordCount this is an integer value for other commands this is a text value level text A text point or constant specifying the connection level This must be a Schema level command text The command must be one of the following Read Transfers a schema page into the associated point Set Enables schema details to be modified Type Returns the current Schema Type Criteria Returns the current Schema Criteria Filter Returns the current Schema Filter RecordCount Returns the number of records in the current Schema PageCount Returns the number of pages in the current Schema CurrentPage Returns the current Schema page parameters Some commands require or more extra parameters Read takes an optional parameter Page Number of type integer If no Page Number is supplied this function will return page 1 when first called and automatically return the next page of schemas for each subsequent call cycling back to the beginning when all pages have been returned Set takes three text parameters for Schema Name Criteria and Filter Typical Examples Numb
99. ift IF alt lt 140 0 THEN IF distance gt 630 0 AND distance lt 660 0 AND lift gt 3 0 THEN winner TRUE burner FALSE ENDIF IF lift lt 3 0 then crash TRUE burner FALSE ENDIF lift 0 0 ENDIF speed alt 140 0 100 0 IF speed lt 0 0 then speed 0 0 ENDIF distance distance speed The following paragraphs describe the above script on a line by line basis IF burner AND alt gt 400 0 THEN burner FALSE ENDIF Page 134 Revision 2 0 OMRON CHAPTER 7 Script Example If the fuel burner is on based on Boolean point burner set to TRUE and the altitude of the balloon based on point alt exceeds 400 then the fuel burner is turned off Point alt is measured in pixels between 140 and 1000 so the value of 400 is the height in pixels IF burner THEN fuel fuel rate IF fuel lt 0 0 THEN fuel 0 0 burner FALSE ENDIF ENDIF If the fuel burner is on the amount of fuel remaining decreases by the rate of ascent The rate of ascent point rate can be modified by moving the slider If point fuel currently has a value of less than 0 then there is no fuel left and the fuel burner is turned off IF burner AND fuel gt 0 0 AND rate gt 0 0 THEN lift lift rate 5 0 ELSE IF alt gt 140 0 THEN Tife TIEG 02 ENDIF ENDIF If the fuel burner is on and there is still fuel left and the rate of ascent exceeds 0 the balloon has taken off then point lift is inc
100. igin is fixed to the screen even if the object is moved Otherwise the rotation origin is relative to object position xcoord Only required if USERDEFINED is specified These integer variables ycoord specify the rotation origin in pixels Typical Examples rotate 45 The current object to which this example applies is rotated by 45 RECTANGLE 1 rotate tilt USERDEFINED 0 100 10 The object RECTANGLE 1 is rotated by the value of tilt about a point 100 10 relative to the objects current position rotate a sin b The current object is rotated based on the result of an arithmetic expression involving points named a and b Revision 2 0 Page 45 CHAPTER 6 Functions and Methods OMRON Vertical Fill Syntax objectname vertical fill expression context Remarks MCU TI objectname This is the name of the object Where a script is directly attached to an object objectname is not required expression This is an arithmetic expression that must return a value between 0 and 100 On return of a valid result the fill commences from bottom to top context This argument may be omitted May be one of DOWN Fill object downwards UP Fill object upwards If omitted UP is assumed Typical Examples vertical fill 50 The current object to which this example applies is filled by 50 ELLIPSE 1 vertical fill OIL QUANTITY DOWN The object ELLIPSE 1 is filled provided the p
101. ile The File Open dialog will be displayed showing all files in the current working directory The users choice will be stored in tFile TFile SelectFile Text Files txt txt The File Open dialog will be displayed showing just files with a txt extension in the current working directory TFile SelectFile Text Files txt csv txt csv The File Open dialog will be displayed showing files with either a txt or csv extension in the current working directory TFile SelectFile Text Files txt csv txt csv Document Files doc doc In this example the Files of type filter has 2 choices one to show text files i e both txt and csv files and one to show document files just doc files TFile SelectFile C WINDOWS The File Open dialog will be displayed showing all files in the CAWINDOWS directory Syntax returnstate Write RecordiId pointname Remarks Tie Returnstate Returnstate is 1 if the function is successful or 0 otherwise Recordld An index into the file Name s of point s containing data to write to the open file Typical Examples WroteOK Write indexno Second The point Second is written to the currently open file using the value of indexno as an index into the file Pass or fail status is stored in WroteOK Write 2 Second Minute Hour The poin
102. indow separate from that of its container 3 causes an object to remove its user interface from the view Applies only to objects that are activated in place Positive numbers designate object specific verbs Typical Example PlayOLE ole 1 0 The object ole_1 is played using its primary verb DisplayPicture Description Reload a picture for a Picture object Syntax returnstate DisplayPicture objectname filename Remarks Tie Returnstate is 1 if the function is successful or 0 otherwise objectname string The identifier of the bitmap object with a to be loaded and displayed filename string The filename of the bitmap to be displayed This can be a constant inside quotes or a text point Typical Example DisplayPicture Bitmap_1 C Application Floorplanl1 bmp Page 50 Revision 2 0 OMRON CHAPTER 6 Functions and Methods The object Bitmap_1 will load and display the Floorplan bitmap DisplayPicture Bitmap 2 txtFileName The object Bitmap_2 will load and display the file name stored in txtFileName text point PlaySound Description Plays a Windows WAV sound file using the standard Windows sound channel and Sound Card driver Syntax returnstate PlaySound soundfile Remarks ACTA EE TI Returnstate is 1 if the function is successful or 0 otherwise Path of sound file to be played Typical Example PlaySound c noise wa
103. ing Dim PasswordNumber EnableProtection true PasswordString Password PasswordNumber 0 CXServer Protect PLC1 EnableProtection PasswordString PasswordNumber Example 2 unsets protection for C series PLC Dim SetProtection Dim PasswordString Dim PasswordNumber EnableProtection false PasswordString PasswordNumber 12345678 CXServer Protect PLC1 EnableProtection PasswordString PasswordNumber The parameters of this command are in order PLC Name of PLC EnableProtection true to set password protection false to unset it PasswordString Password as a string For CS series PLCs this should be a string of up to 8 characters For CV PLCs this should be a string of up to 8 characters containing a hexadecimal number e g 12345678 For C series PLCs this should be a string of up to 4 characters containing a hexadecimal number e g 1234 PasswordNumber currently this is only used for C and CV series PLCs and only when the password string is empty In those circumstances it is simply a number representing the value of the 4 or 8 digit password Please note that the password is entered in CX Programmer as a hexadecimal string as with the PasswordString parameter above and that for example the value 1234 in decimal is the equivalent to 04d2 as a hexadecimal password string Additional C Series PLC notes For C series the PLC program needs code the first line of
104. is present This function need only be called once to receive multiple messages every time the termination character is recieved Syntax ReturnState InputCOMPort PortNumber Message MessagePresent MaxLength Remarks ReturnState Bool True if successful else false PortNumber Integer The number of the port previously configured using the function SetupCOMPort and opened with OpenCOMPort message Text Text point to hold ASCII text message received through the Page 124 Revision 2 0 OMRON CHAPTER 6 Functions and Methods port MessagePresent Bool Boolean point indicating that a message has been received MaxLength Integer Optional Maximum length of transmission before input is terminated Used where fixed length packets are received without termination characters Typical Example bState InputCOMPort 1 Msg bTransmission OutputCOMPort Description Sends an ASCII text message out through the designated serial communications port Syntax ReturnState OutputCOMPort PortNumber Message Remarks ReturnState Bool True if successful else false PortNumber Integer The number of the port previously configured using the function SetupCOMPort and opened with OpenCOMPort message Text Text point holding the ASCII text message to send through the port Typical Example bState OutputCOMPort 1 Msg CloseCOMPort Description Closes the designated serial communications port on the P
105. ision 2 0 Page vii CX Supervisor Script Language OMRON Table of Contents Chapter 6 continued Page Temperature Controller Comm ii iii 73 Alar Commands lc aa e alitas 79 Pile Commands a A AE oa Renee aes 84 Recipe Commands vs A Se ee a N A E ERN S 93 Report Commandsiaii aie nied Ai eGR AER Bee RR SAA NERA A as 95 Text Commands a 97 Event Error Commands ese paste 103 Printer Commands AA BRIE A AA Satie A sa ec es 105 Security Commands 4 c0 sesh ess veh ovesaseaachis heralded aed okies dashar enh ode een EOE ales 109 Data Logeing COMMON ee eae 111 Database Commands aii A Ree eee he a 117 Serial Port Functions ias 130 ActiveX FUNCHONS A a ee Ae a et 133 Chapter 7 Script Examples sccciccccccecsscsccccscescctsonssenncseseasecssensosssesacscses L37 BallooniScript 3 355 n ot 137 Chapter 8 Colour Palette nic csi LA Appendix A OPC Communications Control scccsssssossseoee 143 Component Properties ds 143 ais A aes E tea ea fedh tons daans eoend toned nated T 143 IPUDCHLONS As 4 eet taal E E Ge AE Ui Me eats qu ete apo terest et 143 Appendix B CX Server Communications Control s00sse000 145 Component Properties sec cas 145 Script Interfaces iien kri i E RE EERE aetna eae vette a pees eens 145 FUNCIONS iia la aos 145 PLO Memory FUNCION ied Ae be Gin ha RO eee ee 145 Appendix C JScript Features ccsccccsccscsccscscsssscscsscsscsseseseees LOL Page viii Revisi
106. ledged References Refer to the CX Supervisor User Manual for details of alarms AcknowledgeAllAlarms Syntax returnstate AcknowledgeAllAlarms Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example AcknowledgeAllAlarms All alarms are acknowledged References Refer to the CX Supervisor User Manual for details of alarms Page 76 Revision 2 0 OMRON CHAPTER 6 Functions and Methods AcknowledgeLatestAlarm Syntax returnstate AcknowledgeLatestAlarm Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise Typical Example AcknowledgeLatestAlarm The most current alarm of the highest priority is acknowledged References Refer to the CX Supervisor User Manual for details of alarms ClearAlarmHistory Syntax returnstate ClearAlarmHistory Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example ClearAlarmHistory The alarm history window is cleared and the log is cleared References Refer to the CX Supervisor User Manual for details of alarms CloseAlarmHistory Syntax returnstate CloseAlarmHistory Revision 2 0 Page 77 CHAPTER 6 Functions and Methods OMRON Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise Typical Example CloseAlarmHistory The alarm history window is close
107. lt property so is assumed if omitted Therefore the following examples are the same intVal OMRONCXOPCCommunicationsControl1 Value MyGroup BoilerTemp and intVal OMRONCXOPCCommunicationsControl1 MyGroup BoilerTemp Reads the value of an OPC item Example of synchronous read intVal OMRONCXOPCCommunicationsControl1 Read MyGroup BoilerTemp In this example the OPC item BoilerTemp in the OPC group called MyGroup will be read from the OPC Server and will be stored in intVal The script will wait for the read operation to complete before continuing to execute the next line This is identical to the operation of the Value method Writes the value of an OPC item Example of synchronous write OMRONCXOPCCommunicationsControl1 Write MyGroup BoilerTemp NewValue In this example NewValue will be written to the OPC item BoilerTemp in the OPC group called MyGroup The script will wait for the write operation to complete before continuing to execute the next line This is identical to the operation of the Value method Page 140 Revision 2 0 OMRON APPENDIX B APPENDIX B CX Server Communications Control CX Server Communications Control When the Project Settings gt Advanced settings option Allow advanced script access to PLC via CXServer control option is selected a CX Server Communications Control is automaticalled created
108. marks E returnstate i Number of messages queued up waiting to be printed on Alarm Message printer Typical Example NumberMessages GetSpoolCount The count of the number of messages typically printed alarms that are queued up waiting to be sent to the CX Supervisor Alarm Message printer is returned SetPrinterConfig Syntax returnstate StePrintConfig Driver Device Port Remarks Returnstate is 1 if the function is successful or 0 otherwise Name of printer device e g Epson9 for 9 pin Epson printers Device String Name of specific device e g Epson FX 870 This is optional Line Terminator String Optional Sets terminator e g cr to be added to end of each printed line Typical Examples SetPrinterConfig SCSPRN LPT1 This uses standard CX Supervisor line print driver SetPrinterConfig This uses default Windows printer driver SetPrinterConfig Epson9 LPT2 This uses Epson printer driver attached to LPT2 Page 166 Revision 2 0 OMRON APPENDIX D Obsolete Features SetPrinterConfig DriverNamePoint DeviceNamePoint PrintNamePoint This uses text points Terminator FormatText c c 13 10 Character 10 is If newline character 13 is cr carriage return SetPrinterConfig Epson9 LPT1 Terminator Revision 2 0 Page 167 GLOSSARY OF TERMS Scrip
109. me CXServer ClockWrite PLC1 NewDate RawFINS This function enables raw FINS commands to be sent to a specified PLC This function is for advanced users familiar with the Omron FINS protocol only VBScript Example Dim sFINS Dim sResponse sFINS 0501 sResponse CXServer RawFINS sFins sPLC txtFINSResponse sResponse txtFINSResponse is a CX Supervisor point Active Returns the connection status of a specified PLC VBScript Example bActive CXServer Active MyPLC bActive is a CX Supervisor point In this example the connected status would be read from MyPLC and stored in CX Supervisor point bActive If MyPLC is connected bActive would be set to True TCGetStatus Return status data for the specified temperature controller Example Dim bTCStatusResponse bTCStatusResponse CXServer TCGetStatus E5AK Heating output is bTCStatusResponse 21 Page 148 Revision 2 0 OMRON APPENDIX B CX Server Communications Control Cooling output is bTCStatusResponse 22 Alarm 1 output is bTCStatusResponse 23 Alarm 2 output is bTCStatusResponse 24 Alarm 3 output is bTCStatusResponse 25 Stopped status is bTCStatusResponse 28 Remote status is bTCStatusResponse 30 In this example the device status is being read from ESAK as an array of bytes The response from the temperature controller is stored as an array of bytes in bTCStatusResponse TCRemoteLocal
110. ment and run time environment are run from icons Each recipe consists of at least one ingredient Each ingredient must be related to an existing point A type of point where the value of the point can only be a whole positive or negative number Within the CX Supervisor script language Item is a generic term for a point OPC item or Temperature Controller item A Java style scripting language supported by Microsoft s Windows Scripting Host Java Virtual Machine A spreadsheet application A windowing environment that is noted for its GUI and for features such as multiple typefaces desk accessories such as a clock calculator calendar and notepad and the capability of moving text and graphics from one application to another via a clipboard CX Supervisor will run only under Microsoft Windows A word processing application To incorporate one or more IF THEN ELSE ELSEIF ENDIF statements inside a structure of the same kind Page 171 GLOSSARY OF TERMS Script Language OMRON Network Non V olatile NOT Object OLE DB Operand Operator OR Pages Page 172 1 Part of the PLC configuration based on the device type The number of Networks available is dependant on the device type 2 A number of computers linked together with a central processing point known as a Server which is accessible to all computers Networks affect CX Supervisor in that further Network associated options are available if the c
111. mponent comms command All Opens a component for a PLC e g CX Server components PLCCommsFailed PLC command All Specifies if the PLC communications have failed Alarm message printer point ReadMessage Reads text from an external file Right Extracts characters from the right of a string abject command OP _ Rotates an object Page 36 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Function Name Remarks SetBit point command Sets a specific bit from a point a Puc commana a Ses the modera LG aa nee sn i nary function An Applies unary expression Aon temp controller command Starts or stops a temperature controller auto tune operation TCBackupMode temp controller command Defines how a temperature controller stores internal variables TCGetStatusParameter temp controller command All Retrieves the temperature controller status parameter TCRemoteLocal temp controller command All Defines the operational mode of a temperature controller TCRequestStatus temp controller command Retrieves the temperature controller status TCReset temp controller command Resets the temperature controller TCRspLsp temp controller command All Defines the setpoint mode used by the temperature controller TCRunStop temp controller command All Defines either auto output mode shift or manual output mode shift TCSaveData temp controller command All Saves data associated with the temperature
112. nal 1 if the function is successful otherwise 0 datasetname Name of Data Set to close as text point or constant databaselink Name of Database link to close as text point or constant Typical Example CloseLogFile Process 1 This command will close the active log file for the data set Logging for this data set is automatically stopped CloseLogView Syntax CloseLogView datasetname Remarks Name of Data Set view to close as text point or constant Typical Example CloseLogView Process 1 This command will close the Data Log Viewer which is displaying the named data set ExportAndViewLog Syntax ExportAndViewLog datasetname item list format file outputfile or Revision 2 0 Page 105 CHAPTER 6 Functions and Methods OMRON ExportAndViewLog datasetname TextArray format file outputfile Remarks datasetname Name of Data Set to export as text point or constant List of Items and or Groups within the data set to export separated by commas Alternatively use to export all A text point which has an array size specified as 1 or more array elements Each element holds an Item or Group name format string Either CSV or Text to specify output format May include suffix followed by B to exclude break information D to exclude the log date T to exclude the log time M to exclude to log milliseconds G to not Group On Change data together
113. nction is successful or 0 otherwise pointname integer This is the name of the point to set the bit for Indirection or real point arrays may be used bit This specifies the bit to set This specifies the value to set the bit to Typical Example testpoint 0 SetBit testpoint 4 TRUE The point testpoint contains the value 16 PLC Commands ClosePLC Syntax returnstate ClosePLC plcname Revision 2 0 Page 65 CHAPTER 6 Functions and Methods OMRON Remarks returnstate bool 1 if the function is successful otherwise 0 plcname string Name of PLC to be opened If the PLC is being accessed using a communications component e g the Omron CX Communications Control this parameter should be the control name and PLC name separated by a dot e g OMRONCXCommunicationsControl controlPLC Typical Example ClosePLC controlPLC The PLC called controlPLC is closed No further communications with the PLC will take place until it is reopened DownloadPLCProgram Syntax returnstate DownloadPLCProgram plcname filename processed Remarks ACETATO ewan Returnstate is 1 if the function is successful or 0 otherwise Name of PLC to download the program to filename string Name of the file on disk to download to the PLC Ifa drive and path are not specified the current directory is assumed which may not be the same as the application directory Ifa filename is
114. nding On Error Err Expressions Eval Excute RegExp Replace Test Formatting Strings FormatCurrency FormatDateTime FormatNumber FormatPercent Input Output InputBox LoadPicture MsgBox Literals Empty False Nothing Null True Math Atn Cos Sin Tan Exp Log Sqr Randomize Rnd Miscellaneous Eval Function Execute Statement RGB Function Objects CreateObject Err Object GetObject RegExp Operators Addition Subtraction Exporentiation Modulus arithmetic Mod Multiplication Division Integer Division Negation String concatentation amp Equality Inequality lt gt Less Than lt LessThan or Equal lt Greater Than gt Greater Than or Equal To gt Is And Or Xor Eqv Imp Options Option Explicit Page 32 Revision 2 0 OMRON Revision 2 0 CHAPTER 5 VBScript Language Reference Category Keyword Feature Procedures Call Function Sub Property Get Property Let Property Set Rounding Abs Int Fix Round Sgn Script Engine ID ScriptEngine ScriptEngineBuildVersion ScriptEngineMajorVersion ScriptEngineMinorVersion Strings Asc AscB AscW Chr ChrB ChrwW Filter InStr InStrB InStrRev Join Len LenB LCase UCase Left LeftB Mid MidB Right RightB Replace Space Split StrComp String StrReverse LTrim RTrim Trim Variants IsArray
115. ndition script containing the code to be executed after the mode is set with the processed flag as the expression e g done SetPLCPhoneNumber Syntax Returnstate SetPLCPhoneNumber plcname numbertext Remarks Returnstate is 1 if the function is successful or 0 otherwise Name of PLC to change the number of New phone number for the PLC Typical Example SetPLCPhoneNumber controlPLC 01234 987654 The phone number for the PLC is changed to the required value Revision 2 0 Page 69 CHAPTER 6 Functions and Methods OMRON UploadPLCProgram Syntax returnstate UploadPLCProgram plcname filename processed Remarks returnstate bool Returnstate i is 1 if the function is successful or 0 otherwise Name of PLC to upload the program from filename string Name of the file on disk to upload the program to Ifa drive and path are not specified the file is created in the current directory which may not be the same as the application directory Ifa filename is specified as the user is prompted at runtime for a filename processed bool processed is set to TRUE when the operation is actually completed Typical Example UploadPLCProgram controlPLC Prog01 bin done The program in the PLC controlPLC is uploaded to the file Prog01 bin in the current directory Before continuing the script waits up to five seconds for the action t
116. nent Properties Property Title Example Description DisplayErrors True When set True the object will display a message box for any errors False If set to False error messages are not displayed ProjectName Name of OPC file containing the client setup ServerComputerName MyPC This is the name of the PC with the OPC Server ServerName Name of the OPC Server to connect to e g OMRON OpenDataServer 1 ServerProjectName Optional filename which if specified causes the OPC Server to use the specified file if supported by the server Script Interface The Script Interface defines the methods for the OPC communications control Functions Value Function for getting and setting an OPC item value Read Function to read the value of an OPC item Write Function to write the value of an OPC item Value Reads or writes the value of an OPC item Example Reading a value intVal OMRONCXOPCCommunicationsControl1 Value MyGroup BoilerTemp In this example the OPC item BoilerTemp in the OPC group called MyGroup will be read from the OPC Server and will be stored in intVal Revision 2 0 Page 139 APPENDIX A OPC Communications Control OMRON Read Write Example 2 Writing a value OMRONCXOPCCommunicationsControl1 Value MyGroup BoilerTemp 50 In this example the value 50 will be written to the OPC item BoilerTemp Note Value is the defau
117. new value References Refer to chapter 4 Punctuation Indentation for details on the layout of code Page 16 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language Nested Conditional Statements Syntax IF conditionA THEN statementblock1 IF conditionB THEN statementblock3 ENDIF ELSE statementblock2 ENDIF or IF conditionA THEN statementblock1 IF conditionB THEN tatementblock3 ELSE statementblock4 ENDIF ELSE statementblock2 ENDIF n or IF conditionA THEN statementblock1 ELSEIF conditionB THEN statementblock3 ENDIF or IF conditionA THEN statementblock1 ELSE statementblock2 IF conditionB THEN statementblock3 ELSE statementblock4 ENDIF ENDIF Revision 2 0 Page 17 CHAPTER 4 CX Supervisor Script Language OMRON Remarks MCU anion conditionA The condition is made up of points and constants using relational logical or arithmetical notation as a test The condition can evaluate Boolean state TRUE and FALSE Integer or Real numbers or a text string conditionB This condition is nested in the first condition either on a successful or unsuccessful evaluation of conditionA The condition is made up of points and constants using relational logical or arithmetical notation as a test The condition can evaluate Boolean state TRUE and FALSE Integer or Real numbers or a text string There is no limit to the number of nested conditional statements
118. not required colour Colour to blink to Some colour values within the colour palette have a meaningful colourID This takes the form of the colour name e g black or yellow Alternatively an integer value of 0x1000000 can be added to a number 0 65 to select a palette entry This argument may be omitted May be on of TRUE turn blinking On FALSE turn blinking Off If omitted TRUE is assumed Page 40 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Typical Examples blink red TRUE Start blinking red LINE _1 blink OxFFFFOO status The object LINE_1 starts or stops blinking yellow depending on value of Boolean point status Colour Syntax objectname colour expression context colour expression context or objectname colour colourID context colour colourID context An equals sign may be used as an alternative to brackets objectname colour expression colour expression or objectname colour colourID colour expression Either spelling colour or color is acceptable Note An equals sign may also be used for most other object commands even if it is not directly specified in this manual Remarks objectname This is the name of the object Where a script is directly attached to an object objectname is not required expression The expression may be an Integer point or a calculation of constants and or points that produce an Integer value between 0 and
119. nous write CXServer Write MyPLC MyPoint NewValue 0 Revision 2 0 Page 143 APPENDIX B CX Server Communications Control OMRON In this example NewValue will be written to the point MyPoint in the PLC called MyPLC The script will wait for the write operation to complete before continuing to execute the next line due to the 0 parameter This is identical to the operation of the Value method Note If the PLC is not open then this command will cause it to be opened and then closed after the write is complete If more than one read or write operation is to be performed it is considerably faster and more efficient to use the OpenPLC command first do all the reading and writing and then if required use the ClosePLC command to close the PLC ReadArea Reads a specified block of memory from a PLC Examples of synchronous read MyVariant CXServer ReadArea MyPLC DMO 12 vbString MyVariant CXServer ReadArea BoilerTemp 10 vbinteger MyVariant CXServer ReadArea BoilerTemp 20 In the first example DMO to DM11 will be read as characters part of a string from MyPLC and will be stored in MyVariant The second example demonstrates that it is also possible to use a logical name for the start address and that any VB variant types such as vbInteger can be used The third example shows that the VB Variant type parameter is optional if none is specified then
120. nstate DBRead level reset Revision 2 0 Page 119 CHAPTER 6 Functions and Methods OMRON Remarks MCU tee TN returnstate 1 if the function is successful otherwise 0 level A text point or constant specifying the connection level This may be a Recordset or Field level reset This argument is optional and may be omitted If omitted or TRUE when the read is complete the record cursor is reset to the position prior to reading Typical Examples DBRead Northwind Customers Read the next page of records from the Customers Recordset DBRead Northwind Customers FALSE Read the next page of records from the Customers Recordset and leave the cursor at the next record DBRead Northwind Customers Address The Address field is read If it is an array point the Address is read from subsequent records until the array has been filled Note Use with reset TRUE is useful if the read operation is being combined with a subsequent Write operation i e you can read in a set of records resetting the cursor make modifications to some of the fields and then Write the changes back to the Recordset Note Use with reset FALSE will leave the current position at the start of the next set of records This option can be of benefit if the Provider only supports forward moving cursors or you simply want to step through the records a page at a time DBSchema Description Issues commands to read sc
121. nt temp AND point speed are all not zero If the condition fails then flag is not assigned FALSE References Refer to chapter 4 Control Statements for details of the use of the IF THEN ELSE ELSEIF ENDIF statements Relational Operators Syntax IF expression or DO WHILE expression or DO UNTIL expression Page 14 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language Remarks MC anion Expression The value forming a conditional statement The expression may include the following operators with points and constants Greater than gt Less than lt Greater than or equal to gt Less than or equal to lt Not equal to Equal to Typical Example IF fuel lt 0 TH fuel 0 ENDIF El Z The point fuel is assigned the value 0 on the condition that currently fuel is less than 0 If fuel is not less than 0 then it is not assigned the new value References Refer to chapter 4 Control Statements for details of the use of the IF THEN ELSE ELSEIF ENDIF statements Control Statements Simple Conditional Statements Syntax IF condition THEN statementblock1 ENDIF or IF condition THEN statementblock1 ELSE statementblock2 ENDIF Revision 2 0 Page 15 CHAPTER 4 CX Supervisor Script Language OMRON Remarks MT anion Condition The condition is made up of points and constants using relational logic
122. nt and can be a pushbutton a toggle button a slider a trend graph a rotational gauge or a linear gauge Essentially a control object can be a complex graphic object consisting of a number of primitive graphic objects which provides user interaction An advanced communications management system for OMRON PLCs providing facilities for software to maintain PLC device and address information and to communicate with OMRON PLCs and their supported network types CX Server supports CS Series PLCs A Database connection or Connection for short contains the details used to access a data source This can either be via Data Source Name DSN filename or directory A Database Connection Level is a string which determines what level in the database tree hierarchy is to be operated on Some examples are listed below Northwind Connectionlevel CSV Result Recordset level Northwind Order Details OrderID Field level Invoice Data Types Schema level A Database recordset or Recordset for short is a set of records This could either be an actual Table in the database or a table that has been generated as a consequence of running a Query A Database Schema or Schema for short obtains database schema information from a Provider A Database Server Query or Server Query for short is a query that is stored in the actual Database They are pre defined and added by the database designer which means they are fixed for the duration of a projec
123. ntMode CXServer RunMode MyPLC In this example the operating mode would be read from MyPLC and stored in intMode If MyPLC was in Monitor mode then intMode would be set to the value 2 TypeName Reads the PLC model name of a PLC e g C200H CQM1H CVM1 etc Example strPLCType CXServer TypeName MyPLC In this example the PLC model type will be read from MyPLC and will be stored in strPLCType IsPointValid Checks if a Point name has been defined in the CX Server project file Revision 2 0 Page 145 APPENDIX B CX Server Communications Control OMRON Examples bValid CXServer IsPointValid MyPoint bValid CXServer IsPointValid MyPoint MyPLC In both examples the boolean variable bValid is set True if the point MyPoint has been defined PLC Memory Functions A AR C ClO D DM DR E EM G GR H IR LR SR ST T TC TK W All PLC memory functions e g A AR D DM etc work in exactly the same way The following examples use the DM function to get and set the value of a DM address in a PLC Example 1 intVal CXServer DM 100 In this example the contents of DM100 will be read from the PLC and stored in intVal Note These examples assume there is only 1 PLC in the CX Server project file or that the SetDefaultPLC function has been used to select the required PLC Refer to the SetDefaultPLC function for details about
124. ntax Returnstate OpenPLC plcname processed Remarks ACTO E IT returnstate bool 1 if the function is successful otherwise 0 plcname string Name of PLC to be opened If the PLC is being accessed using a communications component e g the Omron CX Communications Control this parameter should be the control name and PLC name separated by a dot e g OMRONCXCommunicationsControl controlPLC processed Flag set to TRUE when set operation has actually been completed Typical Example OpenPLC controlPLC doneopen The PLC called controlPLC is opened for communication Revision 2 0 Page 67 CHAPTER 6 Functions and Methods OMRON Note that the PLC may not be opened immediately after the statement has been executed The processed flag will be set at a later time when the operation has been completed Therefore if using statements which require the operation to be completed create an On Condition script containing the code to be executed after the PLC is opened with the processed flag as the expression this is generally more efficient PLCCommsFailed Syntax returnstate PLCCommsFailed plcname Remarks MC we IT Returnstate is 1 if the function is successful or 0 otherwise Nae of PLC be checked Typical Example IsFailing PLCCommsFailed controlPLC The point IsFailing is set to true if the PLC called controlPLC is currently not communicating Otherwi
125. o succeed Note The operation may not be complete immediately after the statement has been executed The processed flag done is set at a later time when the operation has been completed Therefore if using statements that require the upload to be completed create an On Condition script containing the code to be executed after the upload with the processed flag as the expression e g done Note This command can only be used when the PLC is in STOP mode Refer to chapter 6 GetPLCMode or chapter 6 SetPLCMode for further information Temperature Controller Commands TCAutoTune Syntax returnstate TCAutoTune TController mode Page 70 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise TController string This is a string representing the name of the temperature controller mode point This is a point depicting the mode of operation and defines the operation to be carried out when a TCAutoTune command is issued 0 Indicates that the auto tuning operation is to be stopped 1 This mode is supported on the E5 K and is used to set the limit cycle of the manipulated variable change width to 40 2 This is used to start the auto tuning operation Typical Example templ TCAutoTune e5ak temp2 TCBackupMode Syntax returnstate TCBackupMode TController mode Remarks Returnstate is 1 if th
126. oint OLEHeight DM100Value GetProperty CXComms1 DM 100 This will read the property DM with one parameter 100 from the OLE object CXComms1 and store it in the point DM100Value PutProperty Description Puts a value stored in a point into the property of an OLE object Syntax PutProperty object property value Remarks object The name of the OLE object containing the property to change property The name of the property to put Any number of parameters for the property value The value to write to the property Type is dependant on the type of property Can also be a number Typical Examples PutProperty OLE1 Left NewLeftValue This will write the value stored in the point NewLeftValue to the property Left in the OLE object OLE1 Put Property CXComms1 DM 10 NewValue This will write the value stored in the point NewValue to the property DM with one parameter 10 in the OLE object CXComms1 PutProperty Gaugel Value 25 2 This will write the value 25 2 to the object Gaugel Page 128 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Execute Description Execute a method of an OLE object Syntax Execute object method Remarks Description The name of the OLE object The name of the method to execute Any number of parameters for the method Ty
127. oint OIL QUANTITY returns a valid result between 0 and 100 Visible Syntax objectname visible expression Remarks MC IT objectname This is the name of the object Where a script is directly attached to an object objectname is not required The expression can be made up of points resulting in TRUE or FALSE Typical Examples visible TRUE The current object to which this example applies becomes visible POLYLINE 8 visible count AND flag Page 46 Revision 2 0 OMRON CHAPTER 6 Functions and Methods The object POLYLINE 8 is made visible provided Integer point count AND Boolean point flag return TRUE Width Syntax objectname width expression context Remarks objectname This is the name of the object Where a script is directly attached to an object objectname is not required gt expression This is a value point or an arithmetic expression returning a new width value in pixels context This argument may be omitted May be one of ALEFT use left of object as datum CENTRE use centre of object as datum ARIGHT use right of object as datum If omitted CENTRE is assumed Typical Examples width 150 The width of the current object is set to 150 LINE _1 width squeeze offset RIGHT The width of object LINE 1 is changed to the value calculated by points squeeze and offset keeping the rightmost point fixed
128. okes the parent application associated with a particular file extension instructing the application to start minimised and passing the print command For example if the file extension txt is associated with Notepad then Notepad is invoked to print the file Read Syntax returnstate Read RecordId pointname Remarks Tie Returnstate Returnstate is 1 if the function is successful or 0 otherwise Recordld An index into the file Pointname point Name s of point s to be updated with the data read from the open file Typical Examples Read 1 value The point value is loaded with the value read from the currently open file using the value of 1 as an index into the file ReadOK Read indexno valuel value2 value3 The points valuel value2 value are loaded using the value of indexno as an index into the file Pass or fail status is stored in ReadOK Note Itis advisable to use a RecordId less than 1024 whenever possible in order to optimise file access time records 0 to 1023 are cached ReadMessage Syntax returnstate ReadMessage filename offset textpoint noofchars Revision 2 0 Page 85 CHAPTER 6 Functions and Methods OMRON Remarks ACTO te ET Returnstate Returnstate is 1 if the function is successful or 0 otherwise Pathname of file to be read Offset integer An offset from the beginning of the file in character
129. omputer is Network connected A point that is designated as non volatile is a point whose value is saved on disk and automatically reloaded when CX Supervisor resumes execution A logic operator used to interrogate Boolean type points which produces the Boolean inverse of the supplied argument An example of NOT is that if a is a statement and is FALSE then NOT returns TRUE Ifa is a statement and is TRUE then NOT returns FALSE In CX Supervisor an object can be text graphics a control a bitmap or ActiveX object as created in the development environment A complex object can exist as a combination of two or more objects of any of the above types Specifically graphical objects can be categorised as a line an arc a polygon including a square and rectangle a round rectangle an ellipse including a circle or a polyline A control is essentially a complex graphic object and is specifically either a pushbutton a toggle button a slider a trend graph a rotational gauge or a linear gauge OLE DB is the underlying database technology on which ADO relies OLE BD is designed to be the successor to ODBC The term used for constants or point variables A symbol used as a function with infix syntax if it has two arguments e g or prefix syntax if it has only one argument e g NOT The CX Supervisor script language uses operators for built in functions such as arithmetic and logic A logic
130. on 2 0 OMRON CX Supervisor Script Language Appendix D Obsolete Features ccssccccsssscsssscecsscsssccssseecssceees 153 GIGSSArY OFT CHM co sicecsesscsisscecadscsdevaasrivesaetcceatcessesasedngaccetedehsesdanscosenasecs 161 o T EA EEE AT ETE 169 Revision 2 0 Page ix OMRON CHAPTER 1 Introduction CHAPTER 1 Introduction This reference manual describes the script language syntax as a supplement to the CX Supervisor User Manual It provides detailed definition of the syntax of CX Supervisor scripts that drive project page object actions and CX Supervisor expressions as used by objects and scripts Typographic conventions used in the examples in this reference manual are as follows Script commands and reserved words are shown in the preferred case which may be either lower upper or mixed case Points are shown in lower case Objects are shown in upper case The following terms are used in this reference manual Application A set of files containing an executable file that carry out certain tasks This reference manual refers to the Microsoft Excel and Microsoft Word for Windows applications Constant A point or object within a script that takes only one specific value Executable A file that contains programs or commands and has an EXE extension Nesting To incorporate one or more IF THEN ELSE ELSEIF ENDIF statements inside a structure of the same kind Operands Con
131. operator used to interrogate Boolean type points OR returns TRUE if any of the supplied arguments are TRUE An example of OR is that if a is a statement and b is a statement OR will return TRUE if either a and b are TRUE If both statements return FALSE then OR will return FALSE The combination and manipulation of pages containing objects within projects forms the basis of CX Supervisor More than one page can exist for each project The pages in a project provide the visual aspect of CX Supervisor corresponding to a display with the objects contained in each page providing a graphical representation of the system being monitored Revision 2 0 OMRON Parameter Association Pixel PLC Point variable Point Program Manager Project Real type Recipe Run Time Environment SCADA Revision 2 0 GLOSSARY OF TERMS Script Language A Parameter Association enables values either constant or stored in a point to be passed to a Server Query A single displayable point on the screen from which a displayed image is constructed The screen resolution of the computers Visual Display Unit VDU is defined by the number of pixels across and the number of pixels down e g 1024 x 768 See also SVGA mode and VGA mode Programmable Logic Controller A point within the CX Supervisor script language that stores a value or string assigned to that point A point is used to hold a value of a p
132. or expressions as used by objects and scripts In conjunction with the script functions and methods described in Chapter 6 the CX Supervisor script language provides a very powerful compiled fast and full featured programming language The following table describes the script language syntax at a glance Function Name Function Type Remarks 8 A lt lt gt gt objects bitwise operators statement Applies bitwise expressions Specifies an object name for modification or test Specifies a point name for modification or test Applies arithmetic expressions Applies relational expressions Applies logical expressions Call a subroutine Script segment to be repeated OP points statement All arithmetic operators All lt gt lt 5 gt l relational operators A logical operators CALL A DO LOOP WHILE UNTIL statement EXIT DO FALSE Boolean state S FOR TO STEP NEXT EXIT statement S FOR S Applies Boolean expression Script segment to be repeated Applies a test to a script IFTHEN ELSE ELSEIF statement ENDIF o o oaa A logical operators SELECT CASE END statement S SELECT TRUE Boolean state Applies Boolean expression pplies logical expressions pplies logical expressions Remarks on line or lines of script Stops sequential execution of script Applied to complex tests Il Il Il cr cr cr cr Il Il cr cr cr r
133. ound arrayOfPoints nUbound UBound arrayOfPoints For Count 1 To UBound arrayOfPoints MsgBox arrayOfPoints Count Next In this example the list of Points configured for the PLC name specified in text point sPLC is stored in arrayOfPoints and each displayed in a message box Example 2 arrayOfPoints CXServer ListPoints If ListPoints is used without a parameter then points from all PLCs are returned IsBadQuality Checks whether a point is currently indicating Bad Quality Example Dim bBad bBad CXServer IsBadQuality MyPLC MyPoint Note IsBadQuality will return True in situations where the quality is unknown e g where no previous communications with a point has occurred ClockRead Function that reads the PLC clock Revision 2 0 Page 147 APPENDIX B CX Server Communications Control OMRON Example Dim NewDate NewDate CXServer ClockRead PLC1 dates can be manipulated via standard VBScript methods FormatDate Time DatePart etc TextBox1 NewDate this uses a Microsoft Forms Text Box to convert date to string TextPoint1 TextBox1 this writes the date string to a CX Supervisor text point ClockWrite Function that sets the PLC clock The expected format for the date is dd mm yyyy hh mm ss Example Dim NewDate set time date value here using standard VBScript methods Date Time Now CDate etc NewDate Now This example sets the time to the current PC ti
134. p 168 Pixel 173 Bitwise Operators Logic and Arithmetic 12 Blink Object Commands 40 C Call Subroutines 22 CancelForce Point Commands 57 Case Selected Control Statements 19 Chr Text Commands 92 ClearAlarmHistory Alarm Commands 77 ClearErrorLog Event Error Commands 98 ClearLogFile Data Logging Commands 104 ClearSpoolQueue Printer Commands 100 Close Page Page Commands 48 CloseAlarmHistory Alarm Commands 77 CloseAlarmStatus Alarm Commands 78 CloseComponent Communications Commands 55 CloseErrorLog Event Error Commands 98 CloseFile File Commands 81 CloseLogFile Data Logging Commands 105 CloseLog View Data Logging Commands 105 Colour Object Commands 41 Colour Palette 137 COM 168 Command String Delimiters Punctuation 23 Communications Commands 55 CloseComponent 55 EnableOLE 55 EnablePLC 56 OpenComponent 56 Communications Drive 169 Constant 169 Control Object 169 Control Statements 15 Case Selected 19 Do While Until Loop 21 For Next Loop 21 Nested Conditional Statements 17 Simple Conditional Statements 15 Conventions in this manual 1 CopyArray Point Commands 58 Revision 2 0 OMRON CopyFile File Commands 81 Current Object Object Commands 38 CX Server 169 CX Supervisor 174 D Data Logging Commands 104 ClearLogFile 104 CloseLogFile 105 CloseLogView
135. patibility A Glossary of Terms and Index are also provided Revision 2 0 Page v CX Supervisor Script Language OMRON Page vi Revision 2 0 OMRON CX Supervisor Script Language TABLE OF CONTENTS ESA NDS O uses eaei a Page Chapter 1 Introduction a sessccssccccsssscesscoscctassecennscdsssnsosesatsseceudsedoussssosnsses L Chapter 2 Expres siQis rai alo Chapter 3 SOI is d 1010 e E EE EE E E E E A E E ES 7 PAGS E EA A E ESA E S TAE O E A E EOT ETE 7 Prodi a cs a A 7 Chapter 4 CX Supervisor Script Language seesssoeesooecssecessoossssesess Y POS A A is 10 Logic and Arithmetic iseyen o e e a o e 12 ControlStatements ci e e mkt aces 15 Subroutines iii Aida 22 A E NA 23 Indirection within Script Commands and Expressions cccccesscessceeeceeeceseceseceecseeeseeeseeeneenseeeeeees 26 Point Arrays within Script Commands and Expressions ccs cesseeesceseceseceseceecseecseeeseeeseenseeereees 27 Use ALIASES st A a de e ast o o 28 Chapter 5 VBScript Language reference ssccccccssscessseecsssessees OL LAS features uen Ses RSs OB Acc ce eS cad 31 Chapter 6 Functions and Metho0dS omomoocooommss JD Object Commands aci 39 Page Commands A 49 General COMME 50 Communications Commands cecesccsesescssesecscseesececseesececnecsececsececsessececsesseeecsesseeecneeseteeneeaeeaees 56 Pont Command ss ii AAA he RRB RRO AAA As 58 PLE Commands iis RN 68 Rev
136. pical Examples Execute OLE1 Start This will call the method Start on the object OLE1 Execute CXComms1 OpenPLC MyPLC This will call the method OpenPLC with one text parameter MyPLC on the OLE object CXComms1 ExecuteVBScript Description Creates aliases allowing Visual Basic Script to be executed in line This uses the Windows Scripting Host See chapter 5 for a list of supported functions and details of the Windows Scripting Host Syntax VBSCRIPT ENDSCRIPT Typical Examples VBSCRIPT OLE1 LEFT Point PointName ENDSCRIPT This Visual Basic Script will write the value from the point PointName into the property Left of the OLE object OLE Revision 2 0 Page 129 CHAPTER 6 Functions and Methods OMRON ExecuteJScript Description Creates aliases allowing Java Script to be executed in line See Appendix C for a list of supported functions and details of the Windows Scripting Host Syntax JSCRIPT ENDSCRIPT Typical Examples JSCRIPT Point PointName OLE 1 Height ENDSCRIPT This Java Script will write the value of the property Height from the OLE object OLE1 into the Point named PointName Note The Java Script can not include the or characters To use these put the script in a text file and use the ExecuteJScriptFile function ExecuteVBScriptFile Description Allows Visual Basic s
137. ples 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 Yold 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 Yold 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 C language sprintf function Some commonly used types are ld Insert integer value f Insert decimal value Prefix with decimal point and number to control position for instance 2f for 2 decimal places s Insert string IX Insert hexadecimal value upper case HEX characters for instance FFFF lx Insert hexadecimal value lower case HEX characters for instance ffff sr c Insert characte
138. 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 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 The text point containing the string that is to be manipulated offset integer The zero based index of the first character in the string that is to be included in the extract The number of characters to extract from the string Text point containing the specified range of characters Revision 2 0 Page 95 CHAPTER 6 Functions and Methods OMRON Typical Example textpoint abcdefgh midtext Mid textpoint 3 2 The text point midtext contains the string de PrintMessage Right Page 96 Syntax PrintMessage message Remarks Argument Type Description Contains the text string that is sent to the printer Typical Example PrintMessage Print this message The message print this message is printed to the configured Alarm message printer queued if operating in page mode or printing has been disabled by the EnablePrinting command References Refer to the C
139. r Northwind TRUE Both the above lines will get and display the last error to occur for the Northwind connection ErrMsg DBGetLastError Northwind FALSE The last error to occur for the Northwind connection is stored Text point ErrMsg without displaying a message box DBMove Description The DBMove function enables you to navigate around a Recordset by moving the position of the current record in the Recordset When a Recordset is first opened the first record is the current record Syntax returnstate DBMove level direction position Revision 2 0 Page 115 CHAPTER 6 Functions and Methods OMRON Remarks ACT Tee TN returnstate bool 1 if the function is successful otherwise 0 level text A text point or constant specifying the connection level This must be a Recordset level direction text A text string indicating where to move to May be one of First Last Next Previous Position FirstPage LastPage NextPage PreviousPage Page Bookmark position int real This optional parameter is only required when directions of Position Page and Bookmark are used When used with Position and Page this parameter must be an integer and is the record or page number to move to When used with Bookmark this parameter must be a real Typical Examples DBMove Northwind Order Details First Go to the first record in the Recordset pos 3 DBMove
140. r 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 OMRON References 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 Description This is the point which has its text length counted This is the point that holds the return value real 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 Value Number to be converted to a Hex number Result 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 CHAPTER 6 Functions and Methods Remarks textpoint The text point containing the string that is to be manipulated The number of characters to extract from the start of the string lefttext Text
141. rd When used at Recordset level all fields associated with the Recordset with property type Add are added as if calling DBAddNew and the record is updated as if calling DBUpdate Points associated with the Add property can be array points thus enabling you to add multiple records in one operation Note When using a Field level connection the operation may be cancelled at any stage before the DBUpdate function is called by calling the DBExecute command CancelUpdate Note Only Fields with a property type of Add can be added to a Recordset The value s of the associated points at the time DBUpdate is called will be used to create the record Note Depending on the ADO provider the added record may not be visible until the Recordset is requeried See DBExecute parameter Requery for more information Revision 2 0 Page 111 CHAPTER 6 Functions and Methods OMRON DBClose Description Closes a Connection or Recordset Closing a Connection will automatically close all recordsets associated with it Recordsets can be closed in isolation by selecting the appropriate level Syntax returnstate DBClose level Remarks returnstate 1 if the function is successful otherwise 0 level A text point or constant specifying the connection level This should be a connection or recordset level Typical Examples Result DBClose Northwind Order Details Closes the Order Details Recordset Result
142. redefined type Boolean Integer Text etc The contents of a point may be controlled by a graphical object or I O mechanism such as PLC communication The contents of a point may control the action or appearance of an object or be used for output via an I O mechanism An integral part of Microsoft Windows 3 x which allows Microsoft Windows based applications to be started from icons and for all applications to be organised CX Supervisor can be run from Program Manager A CX Supervisor application will consist of one or a number of pages linked together The pages may contain passive or active graphics text or animations and may be grouped together logically to form a project A project may consist of many pages or simply a single page Projects may be built and tested within the CX Supervisor development environment and run stand alone under the CX Supervisor run time environment Only one project at a time may be open for editing within the CX Supervisor development environment A type of point where the value of the point can be any number including those containing a decimal point A recipe is a set of pre defined steps used to perform a particular task A CX Supervisor project may contain zero or more number of recipes Recipes are defined in the development environment and executed or downloaded in the run time environment SCADA applications are run using the run time environment of CX Supervisor following creation of t
143. remented by the rate of ascent divided by 5 to allow the balloon to climb Otherwise the balloon must be descending and point lift is decremented by 0 2 IF lift lt 10 0 THEN lift 10 0 ENDIF Once point lift reaches 10 it is not allowed to go lower alt alt lift The altitude of the balloon is incremented by point lift IF alt lt 140 0 THEN IF distance gt 630 0 AND distance lt 660 0 AND lift gt 3 0 THEN winner TRUE burner FALSE ENDIF If the balloon has hit the ground point alt equals 140 then provided it is on the plateaux the position of the balloon in pixels defined by point distance is between 630 and 660 and the rate of descent is not too fast defined by point lift then the game is won IF lift lt 3 0 then crash TRUE burner FALSE ENDIF Revision 2 0 Page 135 CHAPTER 7 Script Example OMRON If the balloon has hit the ground point alt equals 140 then if the rate of descent is not too fast defined by point lift then the game is lost lift 0 0 ENDIF Point lift is reset speed alt 140 0 100 0 IF speed lt 0 0 then speed 0 0 ENDIF Point speed is calculated based on the altitude distance distance speed Point distance is calculated based on the speed Page 136 Revision 2 0 OMRON CHAPTER 8 Colour Palette CHAPTER 8 Colour Palette This chapter discusses the colour palette A colour ma
144. rs Officially using only 7 bits allows definitions for only 127 characters and does not include any accented characters The representation of an image stored in a computer s memory Each picture element pixel is represented by bits stored in the memory In CX Supervisor a bitmap image can be installed as a single object A type of point where the value of the point can be one of two states Essentially the two states are 0 and 1 but these states can be assigned a meaningful designation Examples are State Example Example Example Example 0 OFF FALSE OUT CLOSED 1 ON TRUE IN OPEN See also AND NOT and OR COM is a Microsoft technology that allows components used to interact Revision 2 0 OMRON Communications Driver Constant Control Object CX Server Database connection Database Connection Level Database Recordset Database Schema Database Server Query Revision 2 0 GLOSSARY OF TERMS Script Language The relevant communications management system for OMRON PLCs in conjunction with Microsoft Windows providing facilities for other SYSMAC software to maintain PLC device and address information and to communicate with OMRON PLCs and their supported network types Within CX Supervisor a constant is a point within the script language that takes only one specific value In CX Supervisor a control object is applied in the development environme
145. s indicating where to start reading from The text point which holds the characters read from the file point The number of characters to read from the file Typical Example ReadMessage C CX SUPERVISOR TESTFILE TXT 0 TextPoint 20 The first 20 characters are be read from the file C CX SUPERVISOR TESTFILE TXT and stored in the point TextPoint Note Text points can hold up to 256 characters therefore a maximum of 256 characters can be read from the file SelectFile Syntax filename SelectFile filter path Remarks Filename Text string returned Contains fully qualified filename including drive and path if OK was selected from OpenFile comms dialog otherwise contains empty string Filter string Optional argument If omitted will show all files This argument must be supplied if path is specified i e set to Specifies the filter string used by the Files of type list The string should contain 1 or more filters separated with a pipe character and end with 2 characters 1 e Each filter should have some user text and 1 or more file specs separated with a semicolon No spaces should be used except within the user text Path string Optional argument Specifies the path to show initially If omitted the dialog shows the current working directory Page 86 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Write Typical Example TFile SelectF
146. s 47 Close Page 48 Display Page 47 Pages 172 Parenthesis Punctuation 25 Pixel 173 PlayOLE General Commands 49 PlaySound General Commands 51 PLC 173 Network 172 PLC Commands 65 DownloadPLCProgram 66 GetPLCMode 67 PLCCommsFailed 68 PLCMonitor 68 SetPLCMode 69 Revision 2 0 INDEX Script Language SetPLCPhoneNumber 69 UploadPLCProgram 70 PLC Memory Functions 146 PLCCommsFailed PLC Commands 68 PLCMonitor PLC Commands 68 Point 173 Point Arrays within Script Commands and Expressions 27 Point Commands 57 CancelForce 57 CopyAtray 58 DisableGroup 58 DisablePoint 59 EnableGroup 60 EnablePoint 61 Force 61 ForceReset 61 ForceSet 62 GetBit 62 InitiateArray 63 Input Point 63 OutputPoint 64 PointExists 64 SetBit 65 Point Variable 173 PointExists Point Commands 64 Points 10 Basic Point Assignment 10 Boolean 168 Further Point Assignment 11 Integer 171 Real 173 Script Editor 10 11 Text 174 PrintActivePage Printer Commands 101 Printer Commands 100 ClearSpoolQueue 100 EnablePrinting 100 PrintActivePage 101 PrintPage 101 PrintScreen 102 PrintSpoolQueue 102 PrintFile File Commands 84 PrintMessage Text Commands 96 PrintPage Printer Commands 101 PrintReport Report Commands 90 PrintScreen Printer Commands 102 PrintSpoolQueue Printer Commands
147. s on the command specified command Command to execute May be one of the commands listed below parameter Command parameter only required with certain commands For Connection this parameter should hold the new connection string For Find and FindNext this parameter should be the search criteria For Source this is the Recordset source For Filter this is the Recordset filter Typical Examples Pos DBExecute Northwind Order Details Find UnitPrice gt 14 00 Find the next record satisfying the specified criteria starting from the current position Valid search criteria include ProductName LIKE G wildcard search finds all records where ProductName starts with G Quantity 5 Price gt 6 99 Only single search values are allowed using multiple values with AND or OR will fail DBExecute Connectionl Recordset1 Source Table2 Modify the Recordsets source to open a different table than configured Revision 2 0 Page 113 CHAPTER 6 Functions and Methods OMRON DBExecute Northwind Shippers Filter CompanyName United Package Apply a filter to display only records with a company name United Package DBExecute Northwind Shippers Filter Cancel an existing filter by passing an empty string DBExecute Commands Command Connection Description Level Connection Connection Mo
148. s values from the Points will be written into the Recordset starting at the current record 1 page of values will be written for each Point At the Field level the associated values from the point are written into the Recordsets starting at the current position The number of elements written number of elements in the Point This function will fail if the Recordset is opened with a Lock of Read Only Revision 2 0 Page 123 CHAPTER 6 Functions and Methods OMRON Syntax return DBWrite level reset Remarks return 1 if the function is successful otherwise 0 level A text point or constant specifying the connection level This must be a Recordset level reset This argument is optional and may be omitted If omitted or TRUE when the write is complete the record cursor is reset to the position prior to writing Typical Examples DBWrite Northwind Customers Write all point values to the associated Customers fields DBWrite Northwind Customers Address FALSE Write the point values to the Address column and leave the cursor at the next set of records Serial Port Functions InputCOMPort Description Sets the serial communications port for receiving ASCII text messages Any message received is placed in the text point The boolean flag is set true to indicate that a message has been received It is up to the user to reset this flag between receiving messages in order to indicate that a new message
149. se it is set to false Note This function returns to TRUE from the time when a communications timeout error with the named PLC occurs until successful communication with the PLC takes place PLCMonitor Syntax returnstate PLCMonitor plcname Remarks ACTO te TN Returnstate is 1 if the function is successful or 0 otherwise Name of PLC lo be monitored Typical Example PLCMonitor controlPLc The monitor dialog for the PLC called controlPLC is invoked This dialog can be used to check PLC status change mode etc Page 68 Revision 2 0 OMRON CHAPTER 6 Functions and Methods SetPLCMode Syntax returnstate SetPLCMode plcname mode processed Remarks ACTA IET TI returnstate Returnstate is 1 if the function is successful or 0 otherwise Name of PEC mode string A value for the new PLC mode Valid modes are STOP DEBUG RUN and MONITOR processed bool processed is set to TRUE when the operation is actually completed Typical Examples SetPLCMode controlPLC STOP done In this example the mode of the PLC called controlPLC is changed to STOP Note The mode may not be changed immediately after the statement has been executed The processed flag done is set at a later time when the operation has been completed Therefore if using statements that require the operation to be completed create an On Co
150. sition See SCADA SVGA 174 T Target Value 174 TCAutoTune Temperature Controller Commands 70 TCBackupMode Temperature Controller Commands 71 TCGetStatusParameter Temperature Controller Commands 71 TCRemoteLocal Temperature Controller Commands 72 TCRequestStatus Temperature Controller Commands 73 TCReset Temperature Controller Commands 75 TCRspLsp Temperature Controller Commands 73 Revision 2 0 INDEX Script Language TCRunStop Temperature Controller Commands 74 TCSaveData Temperature Controller Commands 74 TCSettingLevell Temperature Controller Commands 75 Temperature Controller Commands 70 TCAutoTune 70 TCBackupMode 71 TCGetStatusParameter 71 TCRemoteLocal 72 TCRequestStatus 73 TCReset 75 TCRspLsp 73 TCRunStop 74 TCSaveData 74 TCSettingLevell 75 Text Commands 91 BCD 91 Bin 92 Chr 92 FormatText 92 GetTextLength 94 Hex 94 Left 94 Message 95 Mid 95 PrintMessage 96 Right 96 TextToValue 97 ValueToText 97 Text Object 174 TextToValue Text Commands 97 Typographical conventions 1 U Unicode 174 UploadPLCProgram PLC Commands 70 Using Aliases 28 V Validation Code 174 ValueToText Text Commands 97 VBScript 31 174 Page 181 INDEX Script Language Vertical Fill Object Commands 46 VGA 174 175 Video Graphics Adapter 174 See VGA ViewReport Report Commands
151. specified as the user is prompted at runtime for a filename processed bool processed is set to TRUE when the operation is actually completed Typical Example DownloadPLCProgram controlPLC Prog01 bin done The program stored in the file Prog01 bin in the current directory is downloaded to the PLC controlPLC Before continuing the script waits up to five seconds for the action to succeed Note The operation may not be complete immediately after the statement has been executed The processed flag done is set at a later time when the operation has been completed Therefore if using statements that require the upload to be completed create an On Condition script containing the code to be executed after the upload with the processed flag as the expression e g done Page 66 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Note This command can only be used when the PLC is in STOP mode Refer to chapter 6 GetPLCMode or chapter 6 SetPLCMode for further information GetPLCMode Syntax mode GetPLCMode plcname Remarks mode string A Text point containing the current PLC mode Possible modes are STOP DEBUG RUN MONITOR and UNKNOWN Name ofthe PLC Typical Example currentmode GetPLCMode controlPLC In this example the current mode of the PLC controlPLC is stored in the point currentmode OpenPLC Sy
152. ssions can be difficult to read e g bMyFlagPoint or BitMask amp 0x80 It can help maintenance if this TRUE is explicitly specified e g bMyFlagPoint TRUE or BitMask amp 0x80 TRUE When using Boolean operators e g amp amp never mix tests for Boolean and non Boolean operands For example never use bMyFlagPoint 1 or bMyFlagPoint 0 Instead always test using the correct Boolean constant i e TRUE or FALSE for CX Supervisor scripts or True and False when using VBScript On Condition scripts are only executed when the expression is TRUE Sometimes this leads to peculiar results for example using Second as it will be executed when Second changes to 59 and to 1 but not when it changes to 0 To execute a condition script any time a point changes force the expression to always evaluate to TRUE for example Second TRUE This works because the Second forces the expression to be tested when the point changes but the TRUE means the test will return TRUE regardless of the value of the point Use array points in On Condition expressions with caution The expression MyArray 3 1 does not mean execute every time the third element changes to 1 It means execute when any element of MyArray changes and the third element happens to be 1 Using an array point without any index is the same as specifying element 0 i e MyArray actually me
153. stants or point variables Operators Relational arithmetic and logical statements for instance lt or AND Or The symbol is used to represent or where there are two or more forms of the same syntax Point Types Either Boolean Integer Real or Text Point Variable A point or object within a script that may take different values oo 99 Strings Data in the form of text delimited by quotation marks point which can be assigned to a The and braces Must be inserted around the argument command or an error is reported An error is reported if there are spaces between braces TRUE and FALSE Refer exclusively to Boolean states where Boolean state 0 is FALSE and Boolean state 1 is TRUE Revision 2 0 Page 1 CHAPTER 1 Introduction OMRON Page 2 Revision 2 0 OMRON CHAPTER 2 Expressions This chapter describes the use of expressions within scripts Expressions consist of operators and operands CHAPTER 2 Expressions Operators are relational arithmetic logical and include many functions Operands are constants or point variables Expressions can be used in a script as part of a statement refer to chapter 3 Scripts chapter 4 CX Supervisor Script Language and Chapter 6 Functions and Methods However expressions can be applied to the following actions directly using the associated Expression or Digital Expression fi
154. statementblockl One or more statements which are performed if conditionA is met statementblock2 One or more statements which are performed if conditionA is not met statementblock3 One or more statements which are performed if conditionB is met statementblock4 One or more statements which are performed if conditionB is not met Typical Examples IF burner AND fuel gt 0 AND rate gt 0 THEN lift lift rate 5 ELSE count 1 IF altitude gt 140 THEN Witt 11fFt 0 2 ENDIF ENDIF Provided a successful evaluation has been made to points burner AND fuel AND rate point lift is updated with the current value of rate divided by 5 plus lift Otherwise a further evaluation is required on point altitude If altitude is currently greater than 140 then lift is decremented by 0 2 IF burner AND fuel gt 0 AND rate gt 0 THEN lift lift rate 5 ELSE IF altitude gt 140 THEN Lift Tift 00 2 ENDIF ENDIF IF burner AND fuel gt 0 AND rate gt O THEN lift lift rate 5 ELSEIF altitude gt 140 THEN lift lift 0 2 ENDIF Page 18 Revision 2 0 OMRON CHAPTER 4 CX Supervisor Script Language These two examples are identical The use of the ELSEIF statement combines the ELSE statement and the IF ENDIF statements for brevity It is acceptable to have more than one ELSEIF statement in an IF THEN ELSE ELSEIF ENDIF construct References Refer to chapter 4 Punctuation
155. status CloseComponent comms command Closes a component for a PLC e g CX Server components CloseErrorLog error command Closes the currently open Error Log CloseFile file command Closes the open file CloseLogFile Data Logging command Closes a data log file CloseLogView Data Logging command Closes the log viewer ClosePLC PLC command Close communications with a PLC colour Feos Tuna function AN Applies unary expression asas T objectcommand OP Disables an object DisableGroup All Prevents a group of points to be read or written DisablePoint Disables communications to a point display object command Displays a specified page cos Page 34 object command Specifies a colour to an object Revision 2 0 OMRON CHAPTER 6 Functions and Methods Function Name Function Type Remarks DisplayAlarmHistory Displays the current alarm history DisplayAlarmStatus alarm command Displays the alarm status of all current alarms DisplayErrorLog Displays the current Error Log DisplayPicture Reload an image for a picture object DisplayRecipes View the current recipes in the project DownloadPLCProgram PLC command Downloads specified files to the PLC DownloadRecipe recipe command Scr Downloads a specified recipe EditFile Edits a specified file EnableAlarms Enables alarm functions EnableErrorLogging error command Scr All actions become s
156. t If result is TRUE then OLE is enabled If result is FALSE then OLE is disabled EnableOLE TRUE OLE functions can also be enabled directly without using a point to hold the desired status EnablePLC Syntax returnstate EnablePLC pointname Remarks ACTA IET TI Returnstate is 1 if the function is successful or 0 otherwise bool point A Boolean point that holds the required enable disable state Typical Examples EnablePLC result PLC functions are enabled based on the value of point result If result is TRUE then PLC functions are enabled If result is FALSE then they are disabled EnablePLC TRUE PLC functions can also be enabled directly without using a point to hold the desired status OpenComponent Syntax Returnstate OpenComponent ComponentName PLCName Page 56 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks returnstate Returnstate is 1 if the function is successful or 0 otherwise ComponentName text A Text point or text constant containing the name of the component to open PLCName text Text point or text constant containing the name of the PLC that the component to open is attached to Typical Examples OpenComponent PLC Data Monitor MyPLC In this example the PLC Data Monitor component monitoring the PLC MyPLC is opened Component Performance Monitor PLC PLCO6
157. t Server Queries may have pre defined Parameters which allow criteria to be passed to the query at runtime e g values to filter allowing one query to be used to produce different results Each pre defined parameter must have a Parameter Association defined Because these queries are stored in a compiled and tested form they are more efficient and therefore preferential to running a SQL Query Page 169 GLOSSARY OF TERMS Script Language OMRON Database SQL Query DBCS DCOM DDE Development Environment DLL Download Executable Expressions Page 170 A Database SQL Query or SQL Query for short is interpreted dynamically at runtime The SQL Text can be modified at runtime enabling different Queries to be run for varying situations however the SQL Text has to be compiled on the fly every time it is executed and consequently is less efficient than a Server Query DBCS stands for Double Byte Character Set and is a Microsoft extension of ASCII which uses 2 bytes 16 bits to define character codes With this larger range it can include accented characters extended ASCII characters Nordic characters and symbols DCOM is a distributed version of COM that allows components on different PCs to interact over a network Dynamic Data Exchange Now obsolete A channel through which correctly prepared programs can actively exchange data and control other applications within Microsoft Windows SCADA applications are crea
158. t Language OMRON GLOSSARY OF TERMS ADO AND Application Arguments ASCII Bitmap Boolean type COM Page 168 ADO stands for Active Data Objects and is data access technology which uses OLE DB to access data sources in a uniform way e g MS Access databases MS Excel spreadsheets and Comma Separated Variable files A logic operator used to interrogate Boolean type points AND returns TRUE if all arguments are TRUE An example of AND is that if a is a statement and b is a statement AND returns TRUE if both a and b are TRUE If one or both statements return FALSE then AND returns FALSE A software program that accomplishes a specific task Examples of applications are CX Supervisor SYSMAC CDM Microsoft Word for Windows and Microsoft Excel CX Supervisor and its development environment allows the creation and testing of new applications through a Graphical User Interface GUI Words phrases or numbers that can be entered on the same line as a command or statement to expand or modify the command or statement within the CX Supervisor script language The command acts on the argument In essence the command is a verb and the argument is the object of the verb An example of an argument in CX Supervisor is Message Text where Message is a command within the script language and Text is the argument upon which the command will act An old standard defining a set of characte
159. t position in y co ordinate pixels are specified in the form x y Points alone or as part of an arithmetic expression may be used as a basis for this expression Typical Examples move 100 200 The current object to which this example applies is moved to the specified position POLYGON 1 move xpos ypos 5 The object POLYGON_ 1 is moved to the position specified by points xpos and ypos divided by 5 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Rotate Syntax objectname rotate angle context fixed xcoord ycoord Remarks MT TN objectname This is the name of the object Where a script is directly attached to an object objectname is not required Points alone or as part of an arithmetic expression may be used as an angle context This argument is not required and may be omitted May be one of TOPLEFT rotate around top left of object TOPCENTRE rotate around top centre of object TOPRIGHT rotate around top right of object CENTRELEFT rotate around centre left of object ACENTRE rotate around centre of object CENTRERIGHT rotate around centre right of object ABOTTOMLEFT rotate around bottom left of object BOTTEMCENTRE rotate around bottom centre of object Y BOTTOMRIGHT rotate around bottom right of object USERDEFINED user defined point specified in xcoord and ycoord fixed This argument may be omitted If this boolean value is true the rotation or
160. te names with numbers for example SecondsPerDay 86400 Alias definitions are stored in a simple text file in the project directory called lt project name gt pre The format of the file consists of any number of lines such as Test1 InArray 12 10 i e an symbol followed by the name of the alias then an equals sign or space followed by the definition of the alias Anything that follows the last apostrophe symbol on a line is interpreted as a comment Any line which does not start with the symbol is also assumed to be a comment Typical Examples Declare boiler temperatures BoilerTempl InArray 0 for boiler room 1 BoilerTemp2 InArray 1 for boiler room 2 SecondsPerMinute 60 sets duration Aliases may also be used to create a complicated expression such as HYPOTENUSE sqrt Opposite Opposite Adjacent Adjacent Calculates length of Hypotenuse This can be used in a script in the following way Opposite 8 45 Adjacent 9 756 length HYPOTENUSE where Opposite Adjacent and length are all REAL points Revision 2 0 Page 29 CHAPTER 4 CX Supervisor Script Language OMRON Note Changing an alias definition after it has been used in an expression or script will not automatically change the result in the script The appropriate script or expression where that alias is used must be accessed and recompiled by pressing the OK button in order to apply the changes Page 30 Revision 2 0
161. ted and tested using the development environment within CX Supervisor On completion the finished application can be delivered as a final customer application to be run by the run time environment Dynamic Link Library A program file that although cannot be run stand alone as an executable can be utilised by one or more applications or programs as a common service DLL files have a DLL extension DLL s comprise a number of stand alone functions In CX Supervisor a DLL containing icons can be accessed to represent the display part of an OLE object One such DLL MORICONS DLL is provided in the standard Microsoft Windows installation A recipe is downloaded during runtime This process involves identifying the appropriate recipe and executing the validation code if any exists The download is complete when each ingredient has set its point to the target value A file that contains programs or commands of an application that can be executed by a user or another application Executable files have a EXE file extension CX Supervisor provides two executable files one for the development environment CXSUPERVISORDEV EXE and one for the run time environment SCS EXE In the CX Supervisor script language expressions are a construct for computing a value from one or more operands For instance in the example lift height rate the expression is height rate where the result yielded from the expression is used for t
162. th BoilerTemp will be read from the PLC and stored in intVal Value is the default property and does not have to be specified Example 2 Writing a value to the PLC using a logical name CXServer Value BoilerTemp 50 or CXServer BoilerTemp 50 In these examples the value 50 will be written to the PLC address associated with BoilerTemp Value is the default property and does not have to be specified Values Reads an array of values from a PLC or writes an array of values to a PLC This function allows logical names If an array is used then a SAFEARRAY is returned with all values Example 1 Reading an array of values from the PLC using a logical name SomeArray CXServer Values BoilerTemps Example 2 Writing an array of values to the PLC using a logical name CXServer Values BoilerTemps SomeArray SetDefaultPLC The SetDefaultPLC function can be used to inform the script parser that a particular PLC is has been set as the default Once a default PLC has been set then it is not necessary with some functions to specify a PLC name For example CXServer SetDefaultPLC MyPLC intVal CXServer Value BoilerTemp1 CXServer Value BoilerTemp1 75 intVal CXServer Value DM50 Page 142 Revision 2 0 OMRON APPENDIX B CX Server Communications Control Each Value function above will access data in the PLC called MyPLC
163. that can be used to set any element of CX Server device configuration All the data is passed in textual form This function is for advanced users only Note This method does not interpret or verify the data passed and it is possible to pass invalid data that will prevent a device communicating Care should be taken to ensure that all data passed is valid This method should not be used while a PLC is open and communicating Example Device PLC1 Section NET Entry IPADDR Setting 10 0 0 1 bValid CXServer SetDeviceConfig Device Section Entry Setting Note The return Boolean value bValid is set to True if no errors were detected However this does not necessarily mean that all the parameters used were valid or appropriate for the device being used Only the following Section Entry and Setting parameter value combinations are currently supported Section ADDRESS Entry DNA Setting 0 Setting 255 this can be used to set the network number Section ADDRESS Entry DA1 Setting 0 Setting 255 this can be used to set the node number Section ADDRESS Entry UNIT Setting 0 Setting 255 this can be used to set the unit number Section ADDRESS Entry IPADDR Setting 0 0 0 0 Setting 255 255 255 255 this can be used to set the Ethernet IP address Other parameter values m
164. the application in the PLC to enable password setting release and this fixes the password value e g LD AR10 01 FUN49 0 0 1234 1234 password value in Hex Page 152 Revision 2 0 OMRON APPENDIX B CX Server Communications Control When setting the password this value is used rather than the value passed i e the password string or number is ignored The correct password must be provided however when disabling the password protection LastErrorString This property which can be set as well as read is a textual description of the last error that occurred If none have occurred it is blank Example txtError CXServer LastErrorString CXServer LastErrorString Page 153 Revision 2 0 APPENDIX C JScript Features APPENDIX C JScript Features OMRON This appendix provides a summary of JScript features available for use with the ExecuteJScript and ExecuteJScriptFile script functions These features are provided by the Windows Scripting Host included by default with Windows 98 Windows ME Windows 2000 and Windows XP and installed by Internet Explorer 4 0 and later For Windows 95 and Windows NT the Windows Scripting Host is available as a free download from Microsoft s Web site For details of the latest versions and support contact Microsoft at http msdn microsoft com scripting Category Keyword Feature Array Handing Array join length reverse sort Assignments Booleans Assign
165. the OS may be busy or handling other processes DDE Commands DDE as a means for exchanging data has now been obsolete for some years In fact for so long even its successor OLE Automation is obsolete DDE has also proved to be a poor technology suffering from unfixed memory leaks both in the native Operating Systems and tools like Microsoft Excel This technology has now been replaced and the CX Supervisor Communications Control should be used instead The following DDE script commands are obsolete DDEExecute Syntax returnstate DDEExecute channel command Remarks Returnstate is 1 if the function is successful or 0 otherwise channel Integer This is an integer point which contains the return value of the point DDEInitiate command Both server and topic parameters applied to the channel based on the DDEInitiate command must be open or an error is reported command String This is a command as recognised by the server application specified within the channel Typical Example channelname DDEInitiate Excel Sheet1 xls DDEExecute channelname OPEN C EXCEL WORK SHEET2 XLS J Revision 2 0 Page 157 APPENDIX D Obsolete Features OMRON The file SHEET2 XLS within path C EXCEL WORK is opened in Microsoft Excel as specified by the Integer point channelname The file SHEET1 XLS is already open in Microsoft Excel DDElnitiate Syntax channel DDEInitiate serv
166. the array have the ForceSet command applied Typical Example ForceSet point1 The Boolean point point has its value set to TRUE References Refer to PLC operation manuals for a detailed description of Force Set and Force Reset GetBit Syntax returnpoint GetBit pointname bit Page 62 Revision 2 0 OMRON CHAPTER 6 Functions and Methods Remarks pointname Integer This is the name of the point to get the bit value from real Indirection or point value may be used bit integer This specifies which bit to get the value of This contains the return value TRUE or FALSE Typical Example pointname 256 returnpoint GetBit pointname 8 The point returnpoint contains TRUE InitialiseArray Syntax InitArray arrayname value Remarks C arramname Name oF poi ary see Value to set all elements of the array to Typical Example InitArray MyArray 0 In this example all elements of the array MyArray are set to 0 InputPoint Syntax returnstate InputPoint pointname returnflag Remarks Returnstate is 1 if the function is successful or 0 otherwise The point name whose data is to be read returnflag point Optional Boolean point which is set to TRUE when value is returned from the PLC Revision 2 0 Page 63 CHAPTER 6 Functions and Methods OMRON Typical Examples Input Point point returnflag
167. the function is successful or 0 otherwise pointname bool A Boolean point that holds the required status of whether blank spaces should be stripped from the file when it is closed Typical Examples CloseFile status The currently open file is closed Blank spaces at the end of each line are stripped from the file if the Boolean point status is set to TRUE CloseFile FALSE In this example the currently open file is closed and any blank spaces are not stripped from the file Note If blank spaces are stripped from the file then it greatly reduces in size but it takes slightly longer to close Blank spaces should not be stripped from the file if it is being used on a network drive by more than one system at a time CopyFile Syntax returnstate CopyFile sourcename destname Revision 2 0 Page 81 CHAPTER 6 Functions and Methods OMRON Remarks Returnstate Returnstate is 1 if the function is successful or 0 otherwise sourcename string Pathname of file to be copied May include a wildcard character destname string Pathname of destination of copy If path name does not exist it is created Typical Example CopyFile c autoexec bat c autoexec old The file c autoexec bat is copied to the file c autoexec old CopyFile c logging dlv a backup The data log files ending in dlv in C logging are copied to the
168. tions and Methods OMRON GetPerformancelnfo Description Read the value of a performance and diagnostics Property as shown by the Performance Monitor and Diagnostics dialog Syntax returnvalue GetPerformanceInfo PLC Point Property Name Remarks Tie Returnstate is 1 if the function is successful or 0 otherwise PLC string If specified is the name of the PLC to get the property of If the property is not a PLC property then specify empty string Point string If specified is the name of the Point to get the property of If the property is not a Point property then specify empty string Property Name string Name of Property to read Must be identical to the displayed property name If both PLC and Point are empty strings then the Summary property is returned Typical Example GetPerformancelnfo Performance Index In this example the Summary Performance Index will be read GetPerformanceInfo Processing Time ms In this example the CPU Time processing time will be read GetPerformanceInfo MyPLC Actual CPS In this example the actual characters per second for MyPLC will be returned GetPerformanceInfo MyPoint Read Callbacks In this example the read callbacks for MyPoint point will be returned ShutDown Description Closes the CX Supervisor application Syntax returnstate ShutDown Page 54 Revision 2 0 OMRON CHAPTER 6 Fun
169. tively use to export all TextArray string A text point which has an array size specified as or more array elements Each element holds an Item or Group name format string Either CSV or Text to specify output format May include suffix followed by B to exclude break information D to exclude the log date T to exclude the log time M to exclude to log milliseconds G to not Group On Change data together file integer Number of file to export where 0 is the latest active file 1 is the previous file etc outputfile string File name for output file May include full path which will be created automatically if it does not exist All these arguments are optional and may be omitted provided there are no further arguments i e to specify the format datasetname and item list must be included but file and output may be omitted Typical Examples ExportLog Balloon or ExportLog Balloon Altitude Fuel Burning Lift Group 1 CSV BDIM 0 output or Revision 2 0 Page 107 CHAPTER 6 Functions and Methods OMRON ItemList 0 Altitude ItemList 1 Fuel ItemList 2 Burning ItemList 3 List ItemList 4 Group 1 ExportAndViewLog Balloon ItemList CSV BDTM 0 output All these commands will export all the data in the specified file for the named data set to the named output file in the format specified OpenLogFil
170. to allow script access to CX Server functions This ActiveX control is always named CXServer without any hyphen and can always be used from any script This appendix contains a list of the available component properties and methods on the script interface Functions Value Values SetDefaultPLC OpenPLC ClosePLC Read Write ReadArea WriteArea RunMode TypeName IsPointValid PLC Memory Functions ListPLCs ListPoints IsBadQuality ClockRead ClockWrite RawFINS Active TCGetStatus TCRemoteLocal SetDeviceAddress SetDeviceConfig Revision 2 0 Function for getting and setting an area of memory ina PLC This function allows logical names to be used If an array is used the first element is returned Function for getting and setting an area of memory ina PLC This function allows logical names to be used If an array is used then a SAFEARRAY is returned with all values Function for setting the default PLC This is primarily used when a project contains multiple PLCs Opens the specific PLC for communications Closes the specific PLC Function to read the value of a PLC point Function to write the value of a PLC point Function for reading a block of memory from the PLC Function for writing a block of memory to the PLC Function for reading writing the current mode of the PLC Function for reading the PLC type e g CQM1H Checks a point name is valid A AR C CIO D DM DR E EM G GR
171. ts Second Minute Hour are written to the currently open file using the value 2 as an index into the file Revision 2 0 Page 87 CHAPTER 6 Functions and Methods OMRON Note Itis advisable to use a RecordId less than 1024 whenever possible in order to optimise file access time records 0 to 1023 are cached WriteMessage Syntax returnstate WriteMessage filename offset text linefeed Remarks Returnstate is 1 if the function is successful or 0 otherwise Pathname of file to be written offset integer An offset from the beginning of the file in characters indicating where to start writing If the offset is 1 then the message is appended to the end of the file The text to be written into the file linefeed bool A flag to indicate a carriage return and line feed should be appended Typical Example WriteMessage C CX SUPERVISOR TESTFILE TXT 0 Hello World TRUE The text Hello World is written at the start of the C CX SUPERVISOR TESTFILE TXT file and a carriage return and line feed is appended which moves and subsequent text to the start of the next line Note When the text is written into the file it overwrites any existing text that may exist at this location Recipe Commands DisplayRecipes Syntax returnstate DisplayRecipes Remarks Returnstate is 1 if the function is successful or 0 otherwise Page
172. ubject to Error Logging EnableGroup Permits a group of points to be read or written FormatText text command All Inserts text with standard C formatting characters GenerateReport report command All Produces a report based on a report template GetBit Retrieves a bit from a point GetPerformancelnfo general command All Retrieves internal performance and diagnostic values GetPLCMode PLC command Retrieves the mode of a PLC GetTextLength text command All Specifies the number of characters in a text point height object command OP Specifies the height of an object horizontal fill object command OP Specifies the horizontal fill of an object InputPoint Reads a value from a point IsAlarmAcknowledged alarm command Scr Tests if a specified alarm has been acknowledged IsAlarmActive alarm command Scr Tests if a specified alarm is currently active string Revision 2 0 Page 35 CHAPTER 6 Functions and Methods OMRON Function Name Function Type Remarks unary function All Calculates the natural logarithm on a number log10 unary function All Calculates the base 10 logarithm on a number LogError error command Scr Logs an error message with the error logger LogEvent Logs an event message with the error logger Logs a user alo a run time application Logout security command Scr Logs a user out of a run time application Ma pom eres aistrg tor esrng a isiesemnra cee reed EE OpenCo
173. unctions and Methods OMRON References Refer to the CX Supervisor User Manual for details of alarms IsAlarmAcknowledged Syntax pointname IsAlarmAcknowledged alarmname Remarks pointname bool point The Boolean point name to be assigned a value based on the test of an acknowledged alarm alarmname The identifier of the alarm Typical Example acknowledged IsAlarmAcknowledged temptoohigh The point acknowledged is assigned Boolean state TRUE if the temptoohigh alarm is currently acknowledged The point is assigned Boolean state FALSE if the alarm is not currently acknowledged References Refer to the CX Supervisor User Manual for details of alarms IsAlarmActive Syntax pointname IsAlarmActive alarmname Remarks MTC O IT pointname bool point The Boolean point name to be assigned a value based on the test of an active alarm The identifier of the alarm Typical Example active IsAlarmActive temptoohigh The point active is assigned Boolean state TRUE if the temptoohigh alarm is currently active The point is assigned Boolean state FALSE if the alarm is not currently active Page 80 Revision 2 0 OMRON CHAPTER 6 Functions and Methods References Refer to the CX Supervisor User Manual for details of alarms File Commands CloseFile Syntax returnstate CloseFile pointname Remarks Returnstate is 1 if
174. v The soundfile c noise wav is played Rand Description Returns a random integer between 0 and the specified limit Syntax pointname Rand upperlimit Remarks Te upperlimit integer The maximum negative or positive integer value that the Rand function can generate pointname Point that contains the integer returned from the Rand function point Revision 2 0 Page 51 CHAPTER 6 Functions and Methods OMRON Typical Example randomnumber Rand upperlimit A random integer in the range 0 to upperlimit is returned and contained in the point randomnumber Maximum upperlimit is 32767 Note If upperlimit is negative then the range is 0 to the negative number RunApplication Description Requests the operating system runs a new program It will run in a separate process and RunApplication does not wait for the application to be launched The specified filename must be executable i e have an extension of EXE COM or BAT Syntax returnstate RunApplication executable Remarks ACTA E ET Returnstate is 1 if the function is successful or 0 otherwise Pathname of executable fle Typical Example RunApplication c myprog exe The executable file c myprog exe is run RunHelp Description Invokes the Windows Help engine and loads a help file showing a specific topic number Syntax returnstate RunHelp helpfile helpindex Page 52
175. xt point textpoint value 10 textpoint ValueToText value This has the same effect as the previous example Revision 2 0 Page 97 CHAPTER 6 Functions and Methods OMRON Event Error Commands ClearErrorLog Syntax ClearErrorLog Typical Example ClearErrorLog The error list is cleared and the log deleted CloseErrorLog Syntax returnstate CloseErrorlLog Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example CloseErrorLog The list of all currently logged errors is closed DisplayErrorLog Syntax returnstate DisplayErrorLog Remarks Returnstate is 1 if the function is successful or 0 otherwise Typical Example DisplayErrorLog A list of all currently logged errors is displayed in a dialog Page 98 Revision 2 0 OMRON CHAPTER 6 Functions and Methods EnableErrorLogging Syntax returnstate EnableErrorLogging pointname Remarks returnstate bool Returnstate is 1 if the function is successful or 0 otherwise A Boolean point Typical Example EnableErrorLogging flag Error Logging is enabled based on the Boolean point flag If flag is TRUE then error logging is enabled If flag is false then error logging is disabled LogError Syntax returnstate LogError message priority Remarks Te Returnstate is 1 if the
176. y be specified by its name or number The following table provides a cross reference between these Some colour names made up of more than one word are separated by an underscore or a hyphen A specified colour can be changed in the CX Supervisor development environment for the current session such changes cannot be saved to a Page or Project unless colours are changed from the Colour Palette located under the General Settings submenu in the Project menu Using a 16 colour based screen resolution consult the Microsoft Windows documentation for further information colours 16 to 65 are dithered from the sixteen base colours Higher colour based resolutions are not dithered ne colour no coeur MC oa IE E Ts yellow 18 ofthe Ts dark tive 20 oey Sk green 2 sve O e Revision 2 0 Page 137 CHAPTER 8 Colour Palette OMRON Page 138 Revision 2 0 OMRON APPENDIX A OPC Communications Control APPENDIX A OPC Communications Control This appendix contains a list of the available component properties and gives details of the Visual Basic script interface These properties can be set in run time by using a Visual Basic script command for example OMRONCXOPCCommunicationsControll ServerNodeName NAME The Script Interface defines the Visual Basic script interface for the OPC communications control See ExecuteVBScript script functions for more information on running Visual Basic Script Compo

CX-Supervisor Script Language

Contents

Download Pdf Manuals

Related Search

Related Contents