Home

8520-6.6, 9/Series OCI, API Developer`s Guide

1. ue TCC nw NUM FILES Num Files UINT Both s DI Controls RECTORIES 59 PART PROGRAM COMMENT STRING Dir Num Files RY Controls PART PROGRAM SOURCE Source of Part Program USINT enumerated No Controls POWER ON TIME AFTER Power On Time After Reset UDINT HELLE Controls RESET POWER ON TIME OVERALL Power On Time Overall UDINT EY All Controls nm Yes R SELECTED_PART_ Selected Part Program Directory UINT enumerated Both Controls PROGRAM_DIR SUB_PROGRAM_ Sub program Macro Repeat Count UINT Both Controls REPEAT_COUNT WORKPIECES_CUT_ Workpieces Cut After Reset UDINT Both Controls AFTER RESET woweeces COT OVERALL uw w n As W ILL 22 21 71 LENS qur CURRENT FACTORS umm we n DEFAULT FACTORS nw loe owes ve nw e Ee Ror Pastas tema Pene De Jaw i caer EXT ROT FIRST AXIS _ Abscissa Rotation Center LREAL Both Inch Met ACTIVE UNITS Yes R W Mill Grinder CENTER ric De grees EXT ROT FIRST AXIS _ Abscissa Vector LREAL Both Inch Met ACTIVE UNITS Yes R W Mill Grinder VECTOR ric De grees
2. DH BAUD RATE enumeration DH OUTPUT FORMAT enumeration DH PARITY enumeration DH REMOTE STATION enumeration ERROR MESSAGE TYPE enumeration MACHINE TYPE enumeration MID START ACTION enumeration MID START TYPE enumeration MODE ACTIVE active mode enumeration MODE FEED feed mode enumeration MODE INCH METRIC inch metric mode enumeration OPTION SELECTED INDICES enumeration PORT BAUD RATE enumeration PORT COMM FORMAT enumeration PORT DATA BITS enumeration PORT PARITY enumeration PORT ID enumeration PORT TYPE enumeration PORTA DEVICE enumeration PORTB DEVICE enumeration PORT PROTOCOL enumeration Appendix Data Items Appendix B Commands Appendix OCI Error Handling Table of Contents vii PORT_STOP_BITS enumeration 6 15 PORT MULTI enumeration 6 15 PORT TIMEOUT VALUE enumeration 6 15 PP SOURCE enumeration 6 16 PRODUC
3. NUM DIRECTORIES SERVO MODULES SERVO NUM M_MODAL GROUP G_MODAL GROUP SETUP BUFFERS E ga wa masanchay NUM PP FILES OFFSET NUM kanaa 3 pe us TOOL NUM l sad Control LINK TYG R Background Foreground Selecting the Process for Dual Process Controls Logical vs Physical AMP Parameter Data Axis Calibration Data ltems Communication Port Data Items Error Message Data Items Miscellaneous Data Items Offset Data uides ea Durs Operating Mode Table of Contents ili PAL Variable Data ltems 4 47 Paramacro Variable Data 4 51 Part Program Directory Data Items 4 51 Part Program Block Data Items 4 54 Part Program Rotation and Scaling 4 55
4. 10 ACTIVE MODE Enumeration ACTIVE PAL MESSAGES Index ACTIVE PART PROGRAM A 11 ACTIVE PART PROGRAM BLOCKS ACTIVE PLANE AXES ACTIVE RADIUS DIAMETER MODE Enumeration 6 1 ACTIVE RANDOM TOOL NUM A 14 ACTIVE RANDOM TOOL NUM POCKET 5 14 ACTIVE RANDOM TOOL SHAFT POCK 14 ACTIVE SCALE INDICATOR ACTIVE SUB PROGRAM ACTIVE TOOL GEOM NUM ACTIVE TOOL LENGTH AXIS LOGICAL BIT PATTERN ACTIVE TOOL RADIUS NUM 4 44 8 ACTIVE TOOL WEAR NUM 4 44 ACTIVE UNITS 4 46 10 AdvancedDDE installing RSData through RSLinx Allen Bradley Basic Display Set source code 3 1 AMP Commands RESTORE AMP TRANSFER AMP FROM PORTA 8 1 TRANSFER FROM PORTB 1 TRANSFER AMP TO PORTA 8 1 TRANSFER TO PORTB TRANSFER HOMECAL TO PORTA a UJ mr TRANSFER HOMECAL TO PORTB TRANSFER REVERSAL ERROR TO PORTA TRANSFER REVERSAL ERROR TO PORTB TRANSFER REVERSAL ERROR TO PORTBJB 1 UPDATE AMP 5 8 B 1 Publication 8520 6 6 August 1999 N RB Publication 8520 6 6 August 1999 Data AMP parameters A 2 PARAMETER DATA TYPE AMP PARAMETER NUMBER NUM PATCHABLE AMP PARAMETER S A 2 SYSTEM SCAN TIME 22 AMP Parameter Data num AMP PARAMETER DATA TYPE PARAMETER NUMBER NUM PATCHABLE AMP PARAMETER S 4 17 DATA TYPE Enumeration AMP PARAMETER DATA TY
5. Contro 5 64 TRANSFER_REVERSAL ERROR TO _ Reversal error to port B Controls 45 UPDATE Updates on control after patch modi Controls fication Axis Calibration 8 i s 9 s s 65 REPLACE AXISCAL VALUE Replaces axis calibration values in table Controls 47 RESTORE AXISCAL Sends axis calibration from backup storage All Controls 154 SET_AXISCAL_PROCESS_NUMBER Sets the process number for axiscal All Controls 5 STOP_AXISCAL Disables axis calibration on the specified axis All Controls Both Both Both Both Both Both Both Both Both Both Both Both Both 61 TRANSFER_AXISCAL_FROM_PORTA Axis calibration from port A All Controls 67 TRANSFER AXISCAL FROM PORTB Axis calibration from port B Contro 5 Params Appendix B Parameter 1 1 type Parameter 2 2 3 Yes Yes amp 8 B E i Yes Logical Axis Number DINT Axis Cal Point No Yes Logical Axis Number DINT Cal Type enum Yes Logical Axis Number DINT Yes Logical Axis Number DINT Yes Logical Axis Number DINT Axis Cal Point No Process Number DINT Logical Axis Number DINT Publication 8520 6 6 August 1999 P2 type DINT DINT DINT Parameter 3 Cal Start enum Axiscal Meas Deviation Value P3 type DINT LREAL B 2 OCI Commands Inst Item Name Command Description Con
6. Connection to the Logic Engine was lost RSLinx was terminated and or the Logic Engine Topic Name is Invalid Press the SAVE amp EXIT softkey in the LGCMSG EDIT screen to reestablish connection with the Logic Engine for Messages Publication 8520 6 6 August 1999 Error Handling 5 EmrWm Emme CS DATA TYPE ERROR ITEM NOT DEFINED 1005 ITEM NOT AMPED WATCH LIST OPEN ERROR 1007 SPINDLE INDEX ERROR 1008 TOO MANY WATCH LISTS OPENED WATCH LIST NOT OPEN 1010 SMB CHANNEL NOT AVAILABLE 1011 INVALID ADDRESS 1012 DIRECTORY NOT SPECIFIED 1013 THIS IS NOT A CARD RACK 1014 MANY ITEMS REQUESTED 1015 INVALID AMP PARAMETER 1016 ONLY ONE AXIS ALLOWED 1017 TWO INDEX PAIRS NOT SPECIFIED 1018 INDEX BEYOND END OF DATA 1019 ITEM NOT VALID 1020 PACKET WILL NOT FIT IN SMB 2007 INVALID COMMAND Publication 8520 6 6 August 1999 C 6 OCI Error Handling 2008 EMPTY COMMAND 2009 ACCUM NOT ZERO 2010 NOT IN MODIFY AMP MODE 2011 UNDEFINED DATA 2012 CHANNEL NOT CONFIGURED 2013 INVALID INDEX 2014 INVALID MODE FOR WRITE 2015 OFFSET ACTIVATION ERROR 2016 NOT CONTROLLING CLIENT Publication 8520 6 6 August 1999 Error Handling C 7 3023 ILLEGAL MONITOR MODE 3024 MONITOR NOT ACTIVE 3032 BAD SEARCH NUMBER 3033 NO SEARCH PATTERN 3037 INVALID CNC COMM
7. port A 2 port B The id index must always be used with this data item You not use this index to access more than one port per request Data for this item is enumerated as follows 300 Baud 600 Baud 1200 Baud 2400 Baud 4800 Baud 9600 Baud 19200 Baud 38400 Baud For release 12 or greater o example assigning value of 6 to the following item PORT_BAUD_RATE 1 selects the baud rate of 19200 for port A PORT PROTOCOL port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the communication protocol for the specified port The index port_id identifies the port as follows 1 port A 2 port B Publication 8520 6 6 August 1999 4 22 Data Server Data Items Publication 8520 6 6 August 1999 The port_id index must always be used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 Raw 1 Level 1 2 Level 2 3 DF1 4 Level 2 For example assigning a value of 3 to the following item PORT PROTOCOL 1 selects DF1 protocol for port A Not all devices support all of these protocol options Refer to your hardware specification manual valid protocol types PORT TYPE port id
8. Data Server Commands Selecting the Process Command Syntax Publication 8520 6 6 August 1999 For applications where it is critical that the command is executed successfully before continuing on with processing make certain your code monitors the return code for confirmation before continuing Return code values are given in a table with each command The Basic Display Set checks some return codes and translates them into error messages See chapter 3 for details on the Basic Display Set For dual process systems follow the command name with a 1 or 2 to indicate the process number No process number by default makes request for process 1 Single process systems can also use 1 as a valid command request Use the table in appendix B ko determine if a command is available as dual process For example STOP_QUICK_CHECK 1 would attempt to stop quick check on process 1 Important Dual process does not apply to Release 1 of the 9 PC CNC Most development tools accept DDE commands in a standard format You must specify to the server e Service or Application name ABOCISERVER Topic Name CNCI or your alias for the CNC Link Type commands use manual link type After the above connection has been made the command can be issued The standard format for the command syntax of a DDE request is command argument argument Where command is the command string which identifi
9. Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the number of data bits used for the specified communication port The index port_id identifies the port as follows port A 2 port B The id index must always be used with this data item You not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 7 bit 1 8 bits For example assigning a value of 1 to the following item PORT STOP BITS 2 selects 8 data bits for port B PORT AUTO FILENAME port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read enable disable the auto filename feature The auto filename feature is used for tape punch and intelligent devices Refer to your operation and programming manual for details on using this feature The index port_id identifies the port as follows port A 2 port B Publication 8520 6 6 August 1999 4 26 Data Server Data Items Publication 8520 6 6 August 1999 The port_id index must always be used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 No disabled 1 Yes enabled 2 N A F
10. Hard Drive Selects the local or network drive on the PC as defined for the OCI file handler OCIFHCFG INI for 9 Series or the Configuration Manager for the 9 PC Refer to your OCI installation documentation for details on configuring the hard drive TM STATUS enumeration This enumeration identifies the status of the current tool for tool management Enumeration 0 Result Active Tool 1 Expired 2 Publication 8520 6 6 August 1999 Old Array Indices Strings 6 19 TM GRAPHICS TOOL COLOR enumeration This enumeration identifies the tool color for tool management graphing purposes Enumeration Result 4 Red 8 Green 12 Yellow 16 Blue 20 Magenta 24 Cyan 28 White UART BUSY STATUS enumeration BUSY STATUS is used to identify the status of the serial communication ports on the 9 Series processor The UART AB BUSY STATUS enumeration is Enumeration Result 0 Available 1 Allocated 2 In Use Important Enumeration does not apply to the 9 CNC Strings FILENAME string The filename argument only applies to requests that are made to specific part program file Filename command arguments to the data server use the following format command drive filename PPG Where drive is the disk the file is located on The drive argument is optional Valid drives include MAIND main directory on the PROTD protec
11. M wm acs VIRTUAL FORMATS Num digits to the right of the decimal point for INT Both Num Virtual aap All Controls virtual cylindrical axes VIRTUAL_NAMES Axis name used for virual C and cylindrical fea INT Num Virtual Names SS Controls tures T i Parameters w Slaves Inch Active Units IE ass Metric Degrees NUM_SER Inch Met ACTIVE_UNITS Controls VOS_ PLUS SPIN ric De DLES grees NUM_SER Yes R W All Controls VOS PLUS SPIN DLES 199 AXIS SKEW AMOUNT Amount of Axis Skew LREAL x i DISTANCE TO MARKER Distance To Marker LREAL FEED FORWARD PERCENT Feed Forward Percentage LREAL HOME CALIBRATION AMOUNT Home calibration amount Online AMP LREAL 6 MARKER STATUS Marker Not Found bit pattern 13 128 MAX NEGATIVE TORQUE Maximum 96 Rated Torque LREAL 1 MAX POSITIVE TORQUE Maximum Rated Torque LREAL Publication 8520 6 6 August 1999 NUM PROG AXE Inch Met ACTIVE UNITS R W All Controls S PLUS SKEWS ric De LAVES grees ie s sewa NUM SER R W All Controls VOS PLUS SPIN DLES NUM_SER R W All Controls VOS_ PLUS SPIN DLES a 124 FOLLOWING_ERROR Following Error LREAL Both NUM SER Inch Met ACTIVE UNITS Yes Controls VOS PLUS ric De DLES grees Data Items 17 Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency
12. CASE FORM NOT NEEDED SCREEN Error Handling C 3 Error Num EmorName 0 0 5 22 amp Select 6 We Rando amp m amp Stop e TPRESS ANY KEV TO CONTINUE MISSING GRINDER PD FILES MISSING LATHE MILL LANGUAGE FILES INCORRECT PASSWORD MUST END MESSING MISSING SCREEN POSITION FILES BASIC DISPLAY SET REVISION sp CHANGE ALLOWED ONY TOP SOFTER support the current AMP configuration 40500 Error Writing File to Disk Edited Program stored as on Hard Drive BASIC DISPLAY SET SELECT EXIT HERE THEN POWER DOWN THE 89 THERE IS NOT ENOUGH SPACE ON THE DISK Publication 8520 6 6 August 1999 Error Handling 90020 PART PROGRAM EDITOR ACTIVE CANNOT SWITCH SEARCH MONITOR ACTIVE CANNOT SWITCH LGCMSG EDIT LOGIC ANALYZ OSCIL SCOPE SAVE amp EXIT CANCEL 22 LOGIC MESSAGES IN SOFTLOGIX STRING DATA FILE NUMBER ACTIVE LOGIC MSG LINE LOGIC ENGINE TOP NAME CNC WAS STOPPED RESTART CNC USING THE 9 PC CONFIGURATION MANAGER SELECT EXIT OR USE THE OPTIONS MENU TO RECONNECT BDS TO THE CNC LOGIC MESSAGE LINK ERROR WARNING LOGIC MESSAGES UNAVAILABLE Unable to connect to the Logic Engine for Messages RSLinx could not be started and or the Logic Engine Topic Name is Invalid
13. COM CURRENT _ Current Aux Comm Config Entry DINT R W All Controls CONFIG_NUM 150 AUX COM HOST CHANNEL NUM Aux Comm Host Addr Config Channel Num USINT L No All Controls 151 AUX_COM_HOST_REMNODE_ ADDR Aux Comm Host Addr Config STRING1 R W All Controls Remote Node Addr AUX COM NUM SYMBOLS Aux comm command table number of symbols INT 1 NUM CMDS l No All Controls E AUX COM OUTPUT FORMAT Aux comm command table output format USINT enumer S NUM 05 1 LE RI Controls ated AUX COM REMOTE Aux comm command table remote filename STRING1 1 SEE 05 1 All Controls FILENAME Publication 8520 6 6 August 1999 Data Items 5 Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc AUX COM REMOTE NODE ADDRESS Aux comm command table remote node ad STRING mode NUM CMDS 1 BEBE AJ Controls dress AUX COM REMOTE STATION TYPE Aux comm command table remote station type USINT enumer NUM_CMDS 1 Controls ated AUX REMOTE SYMBOL Aux comm command table remote symbol STRING1 jo MMCMDSH RW ll Controls AUX COM SEND COMMAND PACKET Aux Com file transfer progress indicator qm Jug All Controls AUX COM SEND COMMAND STATUS Aux Com file transfer status indicator JM All Controls AUX CONFIG BAUD RATE Aux comm conf
14. Data Server Commands 5 45 RESTART PART PROGRAM restart action Use this command to restart your part program restart action enumeration 15 used to control the restart search operation This enumeration is Enumeration Result 1 Continue 2 Top of Program 3 Quit 4 Exit 5 Exit and Move For example RESTART PART PROGRAM 5 would select the current block as the next active program block and generate axis motion to place the axis at the calculated start point for this program block refer to your operation and programming manual for details SEQUENCE STOP PART PROGRAM block num This command activates or deactivates the sequence number stop feature and also specifies the block number that program execution will halt at Refer to your operation and programming manual for details on the Sequence Number Stop feature The block num argument with this command specifies the sequence number block number N word This numeric must be a whole number numeric ranging from 0 to 99999 Passing the argument value of 0 to the OCI server disables the sequence number stop feature For example SEQUENCE STOP PART PROGRAMY 0 disables the sequence number stop feature until the command is issued again with a valid block number Publication 8520 6 6 August 1999 5 46 Data Server Commands SET DIRECTORY target dir password string Use this command to select the active part prog
15. Controls FORMAT PORDWARIS oor 2 OO See foo a PORT PROGRAM NAWE wr e cons fe RW ao FORT REWIND ON Wo2 woo UART cewce seten e RW a C j jw M N NINNIN me rm Pp o j jw PORT stop ers eurea fe s ww POR TIMEOUT MUE saoir WT s NT emma ocr 2 nw aces RX CHAR PORTA Port A Serial I O Receive USINT 0 RX char size Controls Character R _ 7 240 241 139 143 141 145 233 226 229 232 230 237 238 227 235 236 234 231 239 228 138 142 140 144 OCI X CHAR PORTB Port B Serial 1 0 Receive USINT OCI RX char size Controls Character X CHAR PORTA Port A Serial I O Transmit USINT Controls Character TX CHAR_PORTB Port B Serial I O Transmit USINT Controls Character 316 UART A BUSY STATUS Port A busy status enum UINT od 109 All Controls Publication 8520 6 6 August 1999 4 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc 353 UART_MAX_BAUD_MODE Assign 176 for 19 2 kbaud USINT R W All Controls 48 for 38 4 kbaud Error Message I
16. Dual war Boh 97 TM DELETE TOOL Delete tool from tool management group m Dual war Buh Yes Too Group Number Number DN Enty Number Number 96 TM_INSERT_TOOL Insert tool into tool management group 54 TRANSFER PAL TO PAL and I O to port B Controls Paramacro Commands 36 BACKUP ALL PARAMETERS Backup all paramacro parameters All Controls 32 BACKUP_COM1_PARAMETERS Backup Com 1 paramacro parameters 33 BACKUP_COM2A_PARAMETERS Backup Com 2A paramacro parameters Retr Soe mer Part Program Commands 8 COPY PART PROGRAM Copies part program All Controls Al Al Contro Contro All Contro 1 152 CHECK IF FILE PRESENT Checks for exsitance of file i Publication 8520 6 6 August 1999 Entry Number where to Tool Group Number si Number r P3 type DINT ID SEARCH_MODE i PATTERN Part Program 117 ENTER_MIDSTART_SEARCH_MODE 118 EXECUTE MIDSTART SEARCH 119 SET MIDSTART SEARCH PATTERN 38 STOP QUICK CHECK 37 SYNTAX QUICK CHECK Tool Management Random Tool 26 ACTIVATE RANDOM TOOL 25 BACKUP RANDOM TOOL 24 TOOL MANAGE Publication 8520 6 6 August 1999 OCI Commands Command Description Copies part program o from for editing Copies part program file memory to memory Copies part program Copies part program Copies pa
17. 105 EXT ROT SECOND AXIS CENTER Ordinate Rotation Center LREAL Both Inch Met ACTIVE UNITS Yes R W Mill Grinder ric De grees Publication 8520 6 6 August 1999 Data Items A 13 Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc EXT ROT SECOND AXIS _ Ordinate Vector LREAL Both Inch Met ACTIVE UNITS Yes R W Mill Grinder VECTOR ric De grees SCALING CENTER Scaling Center LREAL Both Num Axes Inch Met ACTIVE UNITS Yes Controls ric De grees gt Position Information EM 328 AXIS FORMATS Num of digits to the right of the decimal point in USINT Both Num Prog Axes Yes Controls inch mode for axis names 329 AXIS FORMATS METRIC Num of digits to the right of the decimal point in USINT Both Num Prog Axes Yes Controls metric mode for axis names AXIS POSITION ABS Axis Positions Absolute LREAL Num Axes Inch Met ACTIVE UNITS Yes Controls ric De grees AXIS POSITION DTG Axis Positions Distance To Go LREAL Both Num Axes Inch Met ACTIVE UNITS Controls ric De grees AXIS POSITION PRG Axis Positions Programmed LREAL Both Num Axes Inch Met ACTIVE UNITS Controls ric De grees AXIS POSITION TAR Axis Positions Target LREAL Both Num Axes Inch Met ACTIVE UNITS Controls ric De grees SKEW SLAVE ABSOLUTE POSITION Absolute position of Skew slave axes LREAL Num Skew Axes I
18. EXIT SERIAL IO MONITOR MODE no arguments REPEAT TX SERIAL IO character SAVE DEVICE SETUP no argument SINGLE TX SERIAL 10 START SERIAL IO MONITOR no arguments STOP SERIAL IO MONITOR no arguments Miscellaneous CALCULATE calc string CLEAR ACTIVE ERRORS no argument CLEAR CYCLE TIME no argument CLEAR ERROR LOG no argument CLEAR POWER ON TIME OVERALL no argument CLEAR RUNTIME no argument CLEAR WORKPIECES CUT OVERALL no argument INPUT MDI STRING tex string REFORMAT MEMORY no arguments RELINQUISH CONTROL no argument REQUEST CONTROL no argument RESET MAX TIMES no argument STORE MESSAGE no arguments OSS Sete ee eo Seay ACTIVATE TOOL LENGTH offset number ACTIVATE TOOL RADIUS offset number ACTIVATE TOOL WEAR offset ACTIVATE WHEEL GEOM offset number ACTIVATE WHEEL RADIUS offset number BACKUP ALL OFFSETS Filename string BACKUP INTERF TABLE Filename string
19. RING DUPLICATE I O RING DEVICE EXTRA I O RING DEVICE MISSING I O RING DEVICE AD CO J c Cn b C O p 1 2 3 4 5 6 8 9 1 1 Publication 8520 6 6 August 1999 Basic Display Set BDS 3 25 The following screen shows the PD Ptr pd file The same file is generated for all languages The file header contains a key identifying the pointers These pointers are defined in SK NUMS NUMS SR NUMS and found in the language SPD printouts Each pointer is separated with a comma and spaces WordPad olx File Edit View Insert Format Help Dam alk al 8 SW OPTION SCREEN SOFTKEY PROMPT COND 1 10 0 155 171 0 11 0 0 185 91 192 0 0 0 0 0 0 0 For Help press F1 The following screen shows the english pmp file created when a request is made to print the screen prompts in English The left column of this file contains the text pointer number the right column contains the prompt ACTIVE SELECTED PECGEAM AES REACER CHAR FERIA SERCH FRON PORT Ls FR POT Bi FPON MEATY EDIT BELEITI Publication 8520 6 6 August 1999 3 26 Basic Display Set BDS Testing and Debugging Utilities Publication 8520 6 6 August 1999 The following screen shows the english stx file created when a request is made to print the screen text in English The le
20. This command is used only for systems with a data highway module Use this command to back up the data highway communication table setup For example AUX COM BACKUP CONFIG TABLE CMAIND DHPARAM backs up the data highway configuration tables to a file called DHPARAM in the controls main part program directory Important This command does not apply to the 9 CNC AUX COM CMD FWD SEARCH search type search string This command is used only for systems with a data highway module Use this command to perform a forward search in AUX COMM The search type enumeration for the aux com feature is as follows Enumeration Result index line command line channel name line rem node line file 9240 line file remote line remote station line format line num symbols line symbol 9240 line symbol remote line oO o e Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 16 Data Server Commands AUX REV SEARCH search type search string This command is used only for systems with a data highway module Use this command to perform a reverse search in AUX COMM The search type enumeration for the aux com feature is as follows Enumeration Result index line command line channel name line rem node line file 9240 line file remote line remote station line format line num symbols li
21. m CORRUPTED PASSWORD FILE INCORRECT PASSWORD CANNOT LINK 5 MISSING PASSWORD FILE DIVIDE BY ZERO CORRUPTED MISSING GRINDER SPD FILES 5 3 MISSING LATHE MILL PD FILES MISSING LATHE MILL SPD FILES MISSING PROMPT FILES Publication 8520 6 6 August 1999 Error Handling MISSING MESSAGE FILES IVALUE 4 MISSING GRINDER LANGUAGE FILES CANNOT LINK TO SAVE PROMPT CHANGES SAVE TEXT CHANGES 180000 SAVE SOFTKEY CHANGES 21 22 23 24 25 26 ILLEGAL FILE NAME 2 FILE ALREADY EXISTS OVERWRITE 2 ADD THE SOFTKEY SCREEN NUMBER REF CANNOT LOAD ERROR MESSAGES CORRECTLY 95 CANNOT LOAD CONTROL OPTIONS CORRECTLY ERROR MESSAGE NUMBER SHOWS DATA FILE ITEM NOT FOUND COMMAND ERROR POKE ERROR INVALID CHARACTER FROM PAL LINKING CLOSED MUST END 40500 MAKE YOUR Public Sub ASoftkeyPressed Index ROUTINE 35 MAKE YOUR Public Sub APromptPressed KeyCode Shift ROUTINE ODS PAL ALREADY RUNNING NCRYPT MODE NOT SUPPORTED 3 COMMENT PART PROGRAM NOT AVAILABLE ON HARD DISK REFORMAT MEMORY NOT ALLOWED ON HARD DISK 48050 BACKUP NOT ALLOWED HARD DISK 44 45 46 47 Publication 8520 6 6 August 1999 N A MISSING G CODE FILES C HAS NOT BEEN LINKED A FORM 45 DOES NOT EXIST
22. 4 14 Data Server Data Items Selecting the Process for Dual Process Controls Publication 8520 6 6 August 1999 The 9 Series provides dual process option which allows the use of the 9 Series to control multiple processes Many API data items and commands present different data based on the process you are looking at Refer to appendix A hnd B ko identify if your API data item or command is available in two different process Important Dual process options are not available for Release 1 of the 9 PC CNC To specify which process your API data request or command is targeting you can append the process number to the data item or command following a period For example NUM AXES 1 NUM AXES would request the number of axes in process 1 and process two respectively The default for all per process commands and API items is always process 1 so the API item NUM AXES on a dual process system returns only process 1 data If an item or command has an argument follow the process number with the argument For example AXIS NAME 2 2 3 would return the second and third axis names in process 2 Logical vs Physical Axes OCI Data Server Data Items 4 15 data items for presented the API in logical order with the exception of some AMP parameters which are defined in physical axis terms For example the data item DRILLING AXIS LOGICAL PATTERN is an example of a axis dat
23. Allen Bradley 9 Series OCI 8520 9API Important User Information Because of the variety of uses for the products described in this publication those responsible for the application and use of this control equipment must satisfy themselves that all necessary steps have been taken to assure that each application and use meets all performance and safety requirements including any applicable laws regulations codes and standards The illustrations charts sample programs and layout examples shown in this guide are intended solely for purposes of example Since there are many variables and requirements associated with any particular installation Allen Bradley does not assume responsibility or liability to include intellectual property liability for actual use based upon the examples shown in this publication Allen Bradley publication SGI 1 1 Safety Guidelines for the Application Installation and Maintenance of Solid State Control available from your local Allen Bradley office describes some important differences between solid state equipment and electromechanical devices that should be taken into consideration when applying products such as those described in this publication Reproduction of the contents of this copyrighted publication in whole or in part without written permission of Allen Bradley Company Inc is prohibited Throughout this manual we use notes to make you aware of safety con
24. An compatible 9 Series installed and powered up on the Ethernet network Publication 8520 6 6 August 1999 3 2 Basic Display Set BDS Installing the Source Code Publication 8520 6 6 August 1999 Important 9 CNC does not use Ethernet connections If you are using a 9 PC CNC we recommend that you use the 9 PC Configuration Manager to make sure your 9 PC is running e Rockwell Softwares JunctionBox executable The data server installed running and communicating to the OCI compatible CNC necessary to use the softkey and other provided editor utilities Not having your personal computer connected to your CNC will cause data errors any time you run code for a screen that contains a DDE call to a data item or command The Basic Display Set was developed using Microsoft Visual Basic Pro development tool You should be familiar with Visual Basic Pro Windows programming and the concepts behind dynamic data exchange DDE The source code for the Basic Display Set comes on 3 5 inch floppy disks labeled Basic Display Set Source Code Use the following procedure to import this source code to your Visual Basic Application 1 Insert the first disk of the Basic Display Set source code into your disk drive 2 Select the option from the Start menu 3 Enter in the Run dialog A SETUP where is the name of the drive containing disk one of the Basic Display Set sou
25. Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the type of port for port B note port A is always RS 232 The index port_id identifies the port as follows port A 2 port B The id index must always be used with this data item You not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 RS232C 1 RS422A For example assigning a value of 1 to the following item PORT_TYPE 2 selects RS422A communication hardware drivers for port B Data Server Data Items 4 23 PORT COMMUNICATION FORMAT port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the communication format for the specified communication port The index port id identifies the port as follows port A 2 port B The id index must always be used with this data item You not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 EIA 1 ASCII 2 N A For example assigning a value of 1 to the following item PORT COMMUNICATION FORMAT 2 selects ASCII communication format for port B PORT PARITY port id Data Type INT enumerat
26. Enumeration Result Short Unsigned Short Long Unsigned Long Quad Unsigned Quad Float Double Unsigned Character OA ASCII Character AUX REM STATION TYPE enumeration This enumeration for the aux com identifies the station type Enumeration 1 Result PLC 2 Unprotected r w 2 PLC 3 Word range r w 3 PLC 5 Typed r w 4 Important Compute Typed r w Enumeration does not apply to the 9 PC CNC AUX COM SEARCH TYPE enumeration The search type enumeration for the aux com feature is as follows Enumeration Result index line command line channel name line rem node address CNC file remote file remote station type output format line num symbols line OA C F CNC symbol line Important Publication 8520 6 6 August 1999 remote symbol line Enumeration does not apply to the 9 PC CNC Array Indices Strings 6 3 BACK BORING SHIFT DIRECTION enumeration This enumeration identifies the shift direction for back boring cycles Enumeration Result Axis 1 Name Plane G17 G18 G19 Primary Axis 1 Axis 1 Name Plane G17 G18 G19 Primary Axis 1 Axis 2 Name Plane G17 G18 G19 Primary Axis 2 Axis 2 Name Plane G17 G18 G19 Primary Axis 2 CALIBRATION_START enumeration The Calibration Start enumeration is used to
27. Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 14 Data Server Commands Communications Publication 8520 6 6 August 1999 TRANSFER_AXISCAL_TO_PORTB no argument Use this command to back up the current axis calibration data to a device connected to the control s port B This will back up axis calibration data currently in RAM This may or may not be the same axis calibration data stored in the control s backup memory For example TRANSFER AXISCAL TO would write the axis calibration data to the device connected to the control s port B This backup file is not in a man readable format Use the command TRANSFER AXISCAL FROM PORTB to retrieve axis calibration data configuration from a peripheral device Important This command does not apply to the 9 PC CNC ACTIVATE RIO PASSTHROUGH no argument Use this command to enable the remote I O passthrough feature For example ACTIVATE RIO PASSTHROUGH Important This command does not apply to the 9 PC CNC AUX COM ABORT COMMAND no argument This command is used only for systems with a data highway module Use this command to abort data highway module communications in progress For example AUX COM ABORT COMMAND aborts the the current DH transfer Important This command does not apply to the 9 PC CNC Data Server Commands 5 15 AUX BACKUP CONFIG TABLE filename
28. Num Spindles 4096 10 Volts Num Spindles 8 Num Spindles Num Spindles Difference in following error between the syn LREAL Both chronized spindles IPM MIL MMPM MIL Inch Met ric De grees ACTIVE UNITS Controls ACTIVE UNITS Controls BEEN di i Yes Controls Controls Controls R W All Controls Yes All Controls All Controls All Controls All Controls All Controls B DNE D De mw ums s B BR Controls ps Controls 18 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type EL Proc E ACTIVE PLANE AXES Bit pattern of axes in active plane DINT ELM Controls EXTERNAL WORK COORD External Work Coordinate LREAL Both Num Axes um EXTER R W All Controls ric De NAL WORK COO grees RD UNITS ETERLWORKCOORD UNTS Eqoma Work Unis m m 72 954 WORK COORD G54 Work Coordinate LREAL Both Num Axes Inch Met 6054 WORK COO Yes R W All Controls ric De RD UNITS grees G55 WORK COORD G55 Work Coordinate LREAL Both Num Axes Inch Met G55 WORK COO Yes R W All Controls ric De RD UNITS grees 76 656 WORK COORD G56 Work Coordinate LREAL Both Num Axes Inch Met 656 WORK COO Yes R W All Controls ric De RD UNITS grees 78 957 WORK COORD G57 Work Coordinate LREAL Both Num Axes Inch Met
29. PORT PROTOCOL 6 14 PORT STOP BITS 6 15 PORT TAPE MULTI Goes PORT_TIMEOUT VALUE 6 12 PORTA DEVICE 6 13 PORTB DEVICE 6 14 PP SOURCE 6 16 PRODUCT ID ROTATION EXT STATUS SCALING INDICATOR SEARCH METHOD 6 17 SEARCH TYPE 6 17 SERVO STATUS 6 17 SYSTEM STATE 6 18 TARGET DIR TM GRAPHICS TOOL COLOR 6 19 TM STATUS 6 18 BUSY STATUS Error Conditions overview Error ane global bas Error Message Cancel Command Error Message Data ACTIVE PAL MESSAGES COMMAND ERROR CODE LINE 1 MESSAGE DATA 4 Error Message Items ACTIVE ERROR MESSAGES ACTIVE PAL MESSAGES COMMAND ERROR CODE ERROR LOG MESSAGE NUM ERROR LOG MESSAGE PARAMETE ERROR MESSAGE TYPE Ea ERROR MESSAGE TYPE ERROR MESSAGES LINE 1 MESSAGE DATA A 4 NUM MESSAGE GROUPS WRITE ERROR CODE Error Numbers ERROR LOG MESSAGE NUM ERROR LOG MESSAGE PARAMETER A 4 ERROR LOG TIME STAMP A 4 ERROR MESSAGE TYPE A 4 Publication 8520 6 6 August 1999 Publication 8520 6 6 August 1999 ERROR MESSAGE TYPE Enumeration 6 7 ERROR MESSAGES A 4 ErrorFile creating Errors managing subroutine 3 11 on commands printing text with pointers 3 22 writing to file 3 26 writing to MsgBox ESTOP STATE Example using Visual Basic Examples DDE Overview 2 1 using Excel Visual Basic command Excel example read EXECUTE MIDST
30. Use this item in conjunction with the AXISCAL ABS POS item which returns the absolute position for axis calibration points AXISCAL POINTS USED axis num Data Type UINT Read Write Read only Array Index axis_number Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The AXISCAL_POINTS_USED item is used to read back the number of used axis calibration points used for a selected axis This item has one index as follows axis_num this index identifies the logical axis number for which you are requesting the number of axis calibration points Axis numbers are determined by your AMP configuration You can address multiple axes with one command An error is returned if a request is made to an invalid axis name Use the axis number in this request Axis names are not valid AXISCAL POINTS USED 1 4 returns the number of axis calibration points used for axes 1 2 3 and 4 separated by the TAB character Publication 8520 6 6 August 1999 4 20 Data Server Data Items Publication 8520 6 6 August 1999 AXISCAL_POINTS_FREE Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The AXISCAL POINTS FREE item is used to identify the how many axis calibration points remain unused Note the total number of axis calibration points is a total for all axes I
31. parameter to identify not the quick edit number or parameter number see AMP PARAMETER NUMBER The AMP PARAMETER DATA TYPE item returns an enumeration identifying the data type as follows Data Server Data Items 4 17 Enumeration Result Short Unsigned Short Long Unsigned Long Quad Unsigned Quad Float Double Unsigned Character ASCII Character INIo IAIA OINI lt For example AMP_PARAMETER_DATA_TYPE 1 returns the data type enumeration for patch AMP parameter number 1 Use NUMBER to identify the actual AMP parameter associated with patch AMP parameter number 1 AMP_PARAMETER_NUMBERpatchAMP_num Data Type UINT Read Write Read Array Index patchAMP_num Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC This data item is used to identify quick edit number of a specific patchAMP parameter For example AMP_PARAMETER_NUMBER 1 returns the value 11 indicating that AMP parameter with the quick edit number of 11 is the first patch AMP parameter NUM_PATCHABLE_AMP_PARAMETERS Data Type UINT Read Write Read Array Index patchAMP_num Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC This data item is used to identify the quantity of available AMP parameters that can be changed thru patch AMP For example if the value of NUM_PATC
32. August 1999 24 Error Handling MUST BE IN AUTO MUST BE IN CYCLE STOP CANNOT RESTART G24 HARD STOP PROGRAM SHOULD START HERE 10005 NO PROGRAM TO RESTART 10006 CONTINUE NOT ALLOWED INPUT STRING SYNTAX ERROR M02 OR M30 FOUND REQUEST TERMINATED WARNING VERIFY MODAL CODES 1010 WARNING G10 OFFSETS ALTERED 1001 CANNOT FIND CORRECT POSITION CANNOT USE EXIT BLOCK NOT FOUND SEARCH REQUIRES AN ACTIVE PROGRAM 1004 MIDSTART NOT ALLOWED FROM Publication 8520 6 6 August 1999 Error Handling 25 CANNOT EXIT CYCLE 1006 AXIS POSITION INCORRECT 11000 WRITE ENCRYPTION ENTRY ERROR Publication 8520 6 6 August 1999 Symbols User defined Globals system flags I O Variables 4 47 Parameters 2 parameters A 2 Data Numbers G591_WORK_COORD_UNITS A 18 A ABE Files source code ABG Files source code ABL Files source code ABM Files source code ABOCI launching in Visual Basic 3 5 source code directory structure 3 3 ABOCIIDAT data files ACTIVATE PART PROGRAM B 4 ACTIVATE RANDOM TOOL 8 5 ACTIVATE RIO PASSTHROUGH 8 2 ACTIVATE TOOL GEOM ACTIVATE TOOL LENGTH ACTIVATE TOOL RADIUS ACTIVATE TOOL WEAR ACTIVATE WHEEL GEOM ACTIVATE WHEEL RADIUS Activating a Form Form Activate subroutine ACTIVE ERROR MESSAGES
33. DRESSER AMOUNT PER REV A 6 DRESSER HOLD STATUS 6 DRESSER DISTANCE 6 DRESSER ROLL DIAMETER A 7 DRESSER STATUS A7 DRESSER SURFACE SPEED RATIO DRESSER TABLE UNITS DRILLING AXIS LOGICAL BIT PATTERN 8 DRILLING CLEARANCE AMOUNT 6 DRILLING RETRACT AMOUNT 6 Dual Process commands selecting for data items Dual process data items selecting for commands Dual process Only E Editor part program install directory softkeys English language bas printing text find utility ENTER AXISCAL_MODIFY_MODE ENTER MESTR SEARCH MODE ENTER PART SEARCH DE 5 49 B 4 E 6 ENTER SERIAL IO MONITOR MODE Enumerations ACTIVE MODE 6 9 EE RADIUS DIAMETER MODE 6 1 DATA TYPE 6 2 6 2 AUX REM STATION oe e 6 2 AUX COM SEARCH TYPE BACK BORING SHIFT DIRECTION 6 3 CALIBRATION START CALIBRATION TYPE COM MODE COPY FROM TYPE COPY MEM TO PORTA 6 4 COPY PORTA B TO MEM 6 4 COPY TO TYPE 6 4 DH BAUD RATE 6 6 DH CHANNEL 6 5 DH COMMAND 6 5 DH OUTPUT FORMAT DH PARITY DH REMOTE STATION DOWNLOAD IN PROGRESS P ERROR MESSAGE TYPE FEED MODE INCH METRIC MODE MACHINE TYPE 6 8 MID START ACTION 6 8 MID START MODE ACTIVE 6 9 MODE FEED 6 9 MODE Index 1 7 OPTION SELECTED_INDICES PORT_BAUD_RATE PORT COMM FORMAT PORT DATA BITS
34. DW en Ban Arm s ime crous imgs CC s imu eros inos on ween am o Am SECONDARY AWORD w n Arm f mPmcesDresser T T T C o3 C CURRENT WHEEL DIAMETER Current wheel diameter LREAL Inch Met ACTIVE_UNITS Grinder ric De grees DRESSER_AMOUNT_PER_REV Dresser amount per rev LREAL Inch Met ACTIVE_UNITS R W Grinder ric De grees Pe pressen on STIS ur o w e DRESSER_RETRACT_ Dresser retract distance LREAL Inch Met ACTIVE_UNITS R W Grinder DISTANCE ric De grees Publication 8520 6 6 August 1999 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc Dresser roll diameter DRESSER ROLL DIAMETER 7 LREAL OCI Inch Met ric De ACTIVE UNITS o j j jw _ URGET GER DRESSER SURFACE SPEED RATIO Dresser surface speed ratio LREAL 3 DRESSER TABLE UNITS Units for over the wheel dresser data entry UINT inch metric enum Initial wheel diameter LREAL WHEEL WIDTH Wheel width Miscellaneous System Information CONTROLLING OCI True 1 indicates this station is the data server USINT controlling station not necissarily controlling file server DATASCOPE DATA Data Scope Monitor serial port data USINT INITIAL WHEEL DIAMETER MAX WH
35. For example COPY MEM TO PORTB MAIND SOURCE PPG DSTIN 1 copies the program named SOURCE from the main CNC directory to a new part program named DSTIN on the device attached to port B Note the PPG extension is not necessary for most devices connected to port B If copying from the hardd directory this path must be the OCI file handlers configured working directory as specified in the OCIFHCFG INI file see your OCI integration manual Important This command does not apply to the 9 PC CNC COPY PORTA TO MEM src name mode gt dest filename string Use this command to copy your part program file from port to memory either the main or protected directories you can not copy directly to the PC drive The src name string is the name of the part program you are copying from the peripheral device on port A The dest filename string is the same as the file name string given on pag d 6 19 and includes specific directory information The remaining argument with this command is the mode argument which is an enumeration used to identify that you want to perform the copy or test the command syntax The test option will check the command syntax including the existence of the source program The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute copy Publication 8520 6 6 August 1999 5 42 Data Server Commands Publicatio
36. G57 WORK COO Yes R W All Controls ric De RD UNITS grees G58 WORK COORD G58 Work Coordinate LREAL Both Num Axes Inch Met G58 WORK COO Yes R W All Controls ric De RD UNITS grees G59 WORK COORD G59Work Coordinate LREAL Both Num Axes Inch Met G59 WORK COO Yes R W All Controls ric De RD UNITS grees G591_WORK_COORD G59 1 Work Coordinate LREAL Both Num Axes Inch Met G591 WORK CO Yes R W Controls ric De UNITS grees G592 WORK COORD G59 2 Work Coordinate LREAL Both Num Axes Inch Met 6592 WORK CO Yes R W Controls ric De ORD UNITS grees 6592 WORK COORD UNIS 659 2 Work Coordinate Unis P o nw a Contos Publication 8520 6 6 August 1999 Data Items 19 Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc 6593 WORK COORD G59 3 Work Coordinate LREAL Both Num Axes Inch Met G593 WORK CO Yes R W Controls ric De ORD UNITS grees PLANE E AXES INDICES Bit pattern of axes in currently active plane INT pee fh fee All Controls 202 WORK COORD LABELS Labels for work coordinates STRING ILE MAX WORK CO ORD Zones and Overtravels INTERF FIRST AXIS MINUS AREA 1 Interference zones first axis minus limit for dual ix Interf NEN Number Inch Met INTERF UNITS process interference zone 1 ric De Interf Tool Number grees INTERF FIRST AXIS PLUS
37. Online AMP Maximum geom offset change Online AMP Maximum geom radius Online AMP Maximum radius change Online AMP Maximum wear offset Online AMP Maximum wear offset change Online AMP Maximum wear radius Online AMP Maximum geom offset for Mill amp Dmill Online AMP Maximum geom offset change for Mill amp Dmill Online AMP Maximum wear offset for Mill amp Dmill Online AMP Maximum wear offset change for Mill amp Dmill Online AMP NUM TOOLS Number of tools AMP UINT T WORD T Word for Display DINT TOOL ENTRY UNITS Units for data display and entry for the tool OCI Data Items OCI 9 PC Both Both Both Both A 9 Array Indices NUM_PROG_AXE NUM_PROG_AXE NUM_PROG_AXE NUM_PROG_AXE Offset Num Publication 8520 6 6 August 1999 Units Dual Dependency Proc Control Type Lathe Grinder DLathe Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De a Lathe DLathe bed LN Grinder Lathe Grinder DLathe Inch Met ric De Controls Controls Controls 10 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc TOOL_L
38. PORT TYPE enumeration The port type enumeration is used to select the communication type for one of the serial communication ports The enumeration are Enumeration Result 0 RS232C 1 RS422A Important Enumeration does not apply to the 9 PC CNC Array Indices and Strings 6 13 PORTA DEVICE enumeration The port device enumeration is used to select the communication device used on port A The devices available for the port A enumeration are Enumeration Result 1 AB 1770 SB 2 RICOH PTR240R 3 DECITEK AB 8000 XPDR 4 FACIT N4000 5 DSI SP75 6 FACIT N4070 7 EPSON LX 810 8 EPSON SP 500 9 TEACH PENDANT 10 ODS 11 USER PUNCH 12 USER READER 13 USER PRINTER 14 GENERIC LEVEL 2 15 PAL RS232 COMM 16 GRECO MINIFILE 17 INTELLIGENT DEVICE Important does not apply to the 9 PC Publication 8520 6 6 August 1999 6 14 Array Indices and Strings Publication 8520 6 6 August 1999 PORTB DEVICE enumeration The portB device enumeration is used to select the communication device used on port B The devices available for the port B enumeration are Enumeration Result 1 AB 1770 SB 2 RICOH PTR240R 3 DECITEK AB 8000 XPDR 4 FACIT 000 5 DSI SP75 6 FACIT N4070 7 EPSON LX 810 8 EPSON SP 500 9 TEACH PENDANT 10 ODS 11 USER PUNCH 12 USER READER 13 USER PRINTER 14 G
39. Part Program Commands Publication 8520 6 6 August 1999 ACTIVATE PART PROGRAM string Use this command to activate a part program for automatic execution This command typically follows the SET PART PROGRAM INPUT DEVICE command which identifies the input device for the part program In the event that either port A or port B are selected as the input device the filename string argument does not require a source directory only the file name is necessary The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The directory for this program must be either the main MAIND protected PROTD on the CNC or the file servers configured directory on a local or networked drive HARDD For example ACTIVATE PART PROGRAM HARDD testl ppg activates the part program test on the OCI stations configured file handler drive The use of any hard drive or networked drive from the PC is a valid part program storage devices however this path must be the same path specified in the OCI file handler configuration file OCIFHCFG INI for the 9 Series or the Configuration Manager for the 9 PC as the file handlers working directory see your OCI installation manual for details Important CNC s connected to multiple stations the controlling file handler can directly impact the success or failure of this command Note
40. X raw LinkTopic abociserver CNC 1 Set Link Service Topic X raw LinkItem axis position prg 1 Sets Link Item to axisl program position X raw LinkMode 1 Sets link mode to automatic so 9 Series will update data X raw LinkRequest Establishes the connection if manual link had been requested Once these four lines of code are executed the value X raw Text will automatically be updated by the 9 Series or 9 PC whenever the data changes This is accomplished by the 9 Series 9 PC adding this data item to a watch list stored on the 9 Series or 9 When piece of data changes that s included on the watchlist the 9 Series or 9 PC automatically passes the new value to the OCI data server which then passes it on to the appropriate application in our case Visual Basic Writing Data POKE This example waits for a command button to be clicked by the operator to place the control in E STOP Since a command button is not a DDE conversation tool a text box was also created on the form named E STOP To place the control in E Stop a 1 is written to the PAL Logic flag SESTOP Like a DDE read the Write data is also stored as the text of the text box The following code was placed in the Click event of the command button Writing of data takes place when the LinkPoke request is made to the text box top LinkTopic abociserver CNC 1 Set Link Service and Topic top LinkItem SESTOP Sets Link Item to PAL Logic ESTOP
41. 1 would return the axis position of the skew slave axis for skew set 1 Multiprocess systems still have a maximum of two skew axis total VIRTUAL_FORMATS disp_mode Data Type INT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to identify the display format for a virtual axis 16 1 and G16 2 modes This item returns the number of digits to the right of the decimal point for the virtual axis position items AXIS_POSITION_ABS AXIS_POSITION_DTG AXIS_POSITION_PRG and AXIS_POSITION_TAR This is an an array of 4 integers The argument disp_mode selects the integers as follows VIRTUAL FORMATS 1 Absolute Displays VIRTUAL 5 2 DTG Displays VIRTUAL 5 3 Program Displays VIRTUAL FORMATS Target Displays CONTROLLING SPINDLE NUM Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Publication 8520 6 6 August 1999 4 60 Data Server Data Items Use this data item to identify the controlling spindle The controlling spindle is selected on the control with an G12 1 to G12 3 G12 3 for 9 PC This data item returns an integer value 1 Indicates Spindle 1 controlling 2 Indicates Spindle 2 controlling 3 Indicates Spindle 3 controlling Important Only 2 spindles
42. 1 and G16 2 modes This virtual axis is typically only available when in one of these modes This is an an array of 4 integers The argument selects the integers as follows VIRTUAL_NAMES 1 Provides axis name for Absolute Displays VIRTUAL_NAMES 2 Provides axis name for DTG Displays VIRTUAL_NAMES 3 Provides axis name for Program Displays VIRTUAL_NAMES 4 Provides axis name for Target Displays Not including the disp_mode argument returns all four integers The axis name is returned as its ASCII character value Axis names for virtual axes are defined in AMP This item returns all zeros if not in G16 1 or G16 2 modes This data item only returns the name for virtual axes in the four different display modes If you also require the actual location of the axis use the items AXIS POSITION ABS AXIS POSITION DTG AXIS POSITION PRG and AXIS POSITION TAR with arguments for the axis number after the last configured real logical axis number Spindle Data Items OCI Data Server Data Items 4 59 SKEW SLAVE ABSOLUTE POSITION skew set Data Type LREAL array Read Write Read only Array Index skew_set Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to identify the absolute position of the skew slave axis for a skew axis pair The control supports two sets of skew axe so the dimension of the skew_set array is two For example SKEW_SLAVE_ABSOLUTE_POSITION
43. 10 DEVICE OUTPUT DATA RING IO DEVICE TYPE A 11 PAL Messages source code form FINE SCAN TIME AVG A Ti PAL Logic Data A 10 10 10 7 A 10 AMPED FINE SCAN TIME A 11 BLOCK CYCLE 11 BLOCK CYCLE TIME MAX COARSE SCAN TIME A T1 FINE SCAN TIME AVG FINE SCAN TIME MAX A 11 FOREGROUND LOGIC TIME FOREGROUND LOGIC TIME A 11 PAL_REVISION PALLOC_FREE_SPACE Paramacro Commands BACKUP ALL PARAMETERS 5 35 B 4 B 5 BACKUP 1 PARAMETERS 4 5 KUP COM2A PARAMETERS 5 F gt A 9 AE Q OM2B PARAMETERS E 4 BA T 5 lo OM2V_PARAMETERS oo 37 CLEAR COM NAME B 4 B 5 ZERO ALL COM VALUES B 4 B 5 c HARED PARAMETERS 5 NA Se Paramacro Data SP variable number 1 51 a Paramacro Items COM2A_PARAMETER_NAMES 17 SPATT Parent main MDI Parity Enumeration 6 12 Part Program filename string Part Program Block Data ACTIVE PART PROGRAM BLOCKS 4 54 Part Program Commands ACTIVATE PART PROGRAM CHECK IF FILE PRESENT B 4 B 5 COPY MEM TO PORTA 5240 COPY MEM TO PORTA B 4 B 6 COPY MEM TO PORTB 5 40 B 4 B 6 COPY PART PROGRAM COPY PART PROGRAM FOR EDIT P gt 6 COPY PORTA TO MEM 5 2 4 COPY PORTB TO MEM 5 42 4 DEACTIVATE PART PROGRAM DELE
44. 3 Appendix A OCI Data Items This appendix lists the OCI data items categorized by feature The feature categories are Data Paramacro Items Paramacrofems T PaiPregrmDiedoWems Communication Port Parameters Part Program Rotation and Scaing Favor Nodule resin ana Sip cytes TFeduieDa PogamBolems T Random Tool and Too Life Management and W C6 ata T s p SewoPammees T WiscelameousSystemWfommaon _ SSC SCS e Onset Data Work Coordinate System information Operating Mode ZonesandOvenes WIPADua The following table of OCI data items uses these headings Item Name The string that should be passed to the OCI data server to read or write a specific piece of data Description A brief description indicating what data that item references Num Indices The number of array indices associated with the data item Array Indices The indices or enumeration used to reference a specific value of an data item array Units If the value returned is dependent on a specific measuring system or unit e g inch metric as determined by the units dependency column Units Dependency The controlling factor in determining the Units used to return a piece of data e g is
45. 5 SERVO NUM 4 SETUP BUFFERS SPINDLE NUM 4 4 TOOL NUM 4 8 Index Omission 4 3 INDEX_UART_MAX_BAUD_MODE Indexes for data items Initialize Forms subroutine 3 10 INITIALIZE AXISCAL TABLE INITIALIZE DEVICE SETUP B 2 INPUT MDI STRING INSERT AXISCAL POINT 5 11 B 1 Installing RSData Installing RSJunctionBox Installing BDS Source Code INTERF FIRST AXIS MINUS AREA 1 INT RST AXIS MINUS AREA 2 T RF FIRST AXIS PLUS AREA 1 T ch ejn INT m RF a RST AXIS PLUS AREA 2 B INT RF co ECOND AXIS MINUS AREA 1 gt INT RF SECOND AXIS MINUS AREA 2 RF 1 RF 1 INTERF TOOL NUM A 19 INTIAL WHEEL DIAMETER 7 Italian language bas printing text gt ECOND AXIS PLUS AREA 1 gt Sin INT m 92 ECOND AXIS PLUS AREA 2 gt lt 1 3 2 2 JunctionBox used with the BDS Keyboard adding softkeys softkey input Keyboard Input system form KeyPressed form 3 10 Killing Inactive Items RSJunctionBox L LANGUAGE BAS Languages printing Lathe Data Items LEVEL 2 STATUS PORTA LEVEL 2 STATUS PORTB LIMIT2 LOWER LIMITS LIMIT2 UPPER LIMITS A 19 LIMIT3 LOWER LIMITS LIMIT3 UPPER LIMITS LINE 1 MESSAGE DATA Link automatic manual 4 9 notify Link Type Attribute Linking CreateDataLink sub
46. 6 August 1999 Status of Commands and Data Items When a data item read is successful no return code is sent to the only the requested data is sent When a data item or command write is requested the control will send a return code indicating that the request was successful or failed API data item POKE request status 1s returned to the OCI in the reserved data item WRITE ERROR CODE Command status is returned to the OCI in the reserved data item COMMAND ERROR See page C for details on error handling Errors on Automatic Items When your OCI application requests a data item as automatic the OCI data server requests that item be added to the watchlist on the specified CNC refer to the data item chapter in this manual for details on the CNC watchlist If this data item is invalid for some reason e g bad syntax not a valid item watchlist full the control will return an error to the OCI data server indicating the error and the item was not added to the watchlist These errors are returned as text to the requesting DDE object e g Server Error 29 See Chapter 3 for details on how we use a CNC based watchlist for automatic items Errors on Manual Items When your OCI application requests a data item as manual the OCI data server requests a value for that item from the specified CNC If the data item is invalid the control will return an error to the OCI data server indicating the error condition These er
47. 9 PC CNC DEACTIVATE RIO PASSTHROUGH no argument Use this command to deactivate the remote I O passthrough feature For example DEACTIVATE RIO PASSTHROUGH deactivates RIO passthrough Important This command does not apply to the 9 PC CNC ENTER SERIAL 10 MONITOR MODE port id mode This command is used to load the serial I O monitor This will place the control in a setup diagnostic mode and tie up the serial port for diagnostics Use this mode to troubleshoot the control s serial communications The id argument is an enumeration which identifies which port you are configuring The mode argument specifies the I O monitor will be in either transmit or receive mode and is enumerated as follows Enumeration Result 1 Receive 2 Transmit Data Server Commands 5 19 For example ENTER_SERIAL_IO_MONITOR_MODE 2 2 would request the serial monitor for port on the control be in transmit mode You must exit the serial monitor before continuing with normal control operation Use the command EXIT SERIAL IO MONITOR MODE to leave the serial I O monitor mode Important This command does not apply to the 9 PC CNC EXIT SERIAL IO MONITOR MODE no arguments This command is used to unload the serial I O monitor For example EXIT SERIAL IO MONITOR will take the control out of the serial monitor mode You can not exit the serial I O monitor mo
48. AMP parameter number you want to edit Refer to your AMP reference manual for details on AMP parameters and their respective QuickEdit numbers Before you can make write to AMP parameters you must first execute a MODIFYING AMP command request When your changes are complete execute an UPDATE command to close the AMP file After completing AMP changes with this data item you must cycle power to the control for the change occur Exceptions to this are online AMP parameters that can be set real time such as servo motor integral and proportional gain values Online AMP parameters are provided as separate API data items found under their corresponding topic later in this chapter or appendi Important Only patch AMP parameters are writable Other parameters except online AMP parameters are read only Use the data item AMP_PARAMETER_NUMBER to identify what parameters are available patch AMP You should identify the data type for an AMP parameter before attempting to write to the parameter see AMP_PARAMETER_DATA_TYPE AMP_PARAMETER_DATA_TYPE Data USINT Read Write Read Array Index patchAMP_num Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC This data item is used to identify the data type format for AMP parameters that can be accessed using the patch AMP feature The patchAMP argument is the number of the patch
49. Contro Contro Contro Control Contro Contro Contro ii gt 5 5 5 5 Contro mw L mw mw T L mw me mw me T me mw ww m TL L RING1 Copytotypeenum DINT Test 0 Exec 1 DINT RING1 Copy to type enum DINT Test 0 Exec 1 DINT Dest File STRING1 Copy from type DINT Test 0 Exec 1 DINT enum 3 Dest File STRING1 Copy from type DINT Test 0 Exec 1 DINT enum RING1 pe ee Ts Inst ID 122 Part Program Execution 117 ENTER MIDSTART SEARCH MODE Enters midstart search mode Controls All Controls 118 EXECUTE MIDSTART SEARCH Executes midstart search 119 SET MIDSTART SEARCH PATTERN Sets midstart seach pattern 38 STOP QUICK CHECK Stops Quick Check 37 SYNTAX QUICK CHECK Quick Checks syntax Controls Tool Management Random Tool ACTIVATE RANDOM TOOL Activates random tool 25 BACKUP RANDOM TOOL Backup random tool data to part program 24 BACKUP TOOL MANAGE Backup tool management data to part program Es 11 RT CUSTOMIZE TOOL Customize random tool pocket 110 RT SET TOOL NUM Assign random tool number to pocket Al All Controls Controls OCI Commands 5 98 TM DELETE ALL Delete all the tool management groups pair 95 TM DELETE GROUP Delete tool group in tool management
50. Enumeration UART A BUSY STATUS 3 UART B BUSY STATUS A 3 UART MAX BAUD MODE 4 Unload Form Unload subroutine 3 10 Update Rate See AMP Reference Manual UPDATE AMP Utilities text find Index 21 V Variables initialize subroutine 3 10 VBP Visual Basic ABOCI VBP VELOCITY DISCHARGE RATE A 17 VELOCITY GAINS FROM TABLE VELOCITY INTEGRAL GAIN A 17 VELOCITY PROPORTIONAL GAIN A 17 VERIFY PART PROGRAM VERIFY WITH PORTA 5 49 B 4 B 6 VERIFY WITH PORTB VIRTUAL AXIS ALLOWED A 16 VIRTUAL FORMATS VIRTUAL NAMES Visual Basic BDS source code overview overview 1 7 Visual Basic Source Code See BDS Warm Links WARNING WHEEL DIAMETER Watch List defined WatchList removing inactive items 1 8 update rate WatchList Buffer Size WHEEL GEOM OFFSETS WHEEL WIDTH 7 Work Coordinate System Information ACTIVE PLANE AXES EXTERNAL WORK CODED ACT EXTERNAL WORK COORD UNITS G54 WORK COORD A 18 G54 WORK COORD UNITS G55 WORK COORD A 18 G55 WORK COORD UNITS G56 WORK COORD A 18 G56 WORK COORD UNITS 657 WORK COORD A 18 Publication 8520 6 6 August 1999 22 Publication 8520 6 6 August 1999 658 WORK COORD 659 WORK COORD 659 WORK COORD UNITS 9591 WORK 18 0591 WORK COORD 18 6592 WORK 6592 WORK COORD UIS 18 9593 WORK COORD A Eo O COORD LN IS WO
51. Management Random Tool 5 53 BACKUP RANDOM TOOL Filename string 5 54 Publication 8520 6 6 August 1999 Table of Contents Chapter 6 Array Indices and Strings Publication 8520 6 6 August 1999 Variable Ranges Enumerations BACKUP TOOL MANAGE Filename string 5 54 RT CUSTOMIZE TOOL pocket number pockets needed shaft_pocket 5 55 RT SET TOOL NUM tool number pocket number 5 56 TM DELETE no argument 5 56 TM DELETE GROUP tool_group_num 5 56 TM DELETE TOOL tool group num entry 5 57 TM INSERT TOOL tool group num tool num entry num 5 57 ACTIVE RADIUS DIAMETER MODE enumeration DATA TYPE enumeration AUX COM REM STATION TYPE enumeration AUX COM SEARCH TYPE enumeration BACK BORING SHIFT DIRECTION enumeration CALIBRATION START enumeration CALIBRATION TYPE enumeration COM MODE enumeration COPY MEM TO PORTAJB copy to type enumeration COPY PORTA B TO MEM copy from type enumeration DOWNLOAD IN PROGRESS enumeration DH CHANNEL TYPE enumeration DH COMMAND enumeration
52. OCI data server by establishing a DDE link to the Server through the application s link function The basic display set uses the RSJunctionBoxt utility for AdvancedDDE communications RSJunctionBox is optional for your own application based upon your applications performance requirements The data server uses RSLinx software to access the processor s through Windows TCP IP Ethernet tools This access does not apply for the 9 PC Publication 8520 6 6 August 1999 1 2 Open Control Interface Overview For 9 Series For 9 PC Your DDE compliant Application Your DDE compliant Application OCI CNC Part Program File Handler 9 PC Support Service 9 PCI Drivers PCI Bus 9 Series Processor s 9 PC Processor Your DDE Compliant Your application program is your DDE compliant Application Program Microsoft Windows based application This application provides the interface between your personal computer and the OCI data server The application can range from the more complex such as a compiled Microsoft Visual Basic executable which can provide the entire operator interface to your O Series or 9 PC to a simple Microsoft Excel spread sheet with only a few DDE calls used for data collection The Basic Display Set included with the OCI package is an example of a DDE compliant application program The basic display set is a compiled visual basic program and is discussed later i
53. Proc POSITION_LOOP_INIT_GAIN NUM_SER VOS PLUS SPIN DLES NUM PROG AXE S PLUS SKEWS LAVES Initial Gain of Position Loop 137 SERVO STATUS Ww ib REVERSAL ERROR DISTANCE Distance for reversal error comp Online AMP NUM SER VOS PLUS SPIN DLES NUM SER VOS PLUS SPIN DLES NUM SER VOS PLUS SPIN DLES NUM SER VOS PLUS SPIN DLES NUM SER VOS PLUS SPIN DLES NUM SER VOS PLUS SPIN DLES VUE TORQUE OFFSET PERCENT Torque Offset Percentage uU UNE EE EP m Ll EE AE _ E o o E E VELOCITY_DISCHARGE_RATE Discharge rate for velocity loops VELOCITY_INTEGRAL_GAIN Integral gain for the velocity loop VELOCITY_PROPORTIONAL_ GAIN Proportional gain for the velocity loop VELOCITY GAINS FROM TABLE Use Motor Tables 1 No Spindle Data Rm CONTROLLING SPINDLE NUM Controlling Spindle Number UINT S WORD Programmed S Word LREAL Both from the letter table NUM SPINDLES Num Spindles UINT Max Value 3 SPINDLE DAC COMMAND Spindle DAC Cmd for Control Spindle INT 3 132 SPINDLE GEAR RANGE MAX VOLTAGE Max Voltage for Spindle Gear Range REAL 111 SPINDLE MOTOR TYPE Motor Commutation of the Spindle UINT SPINDLE SPEED VALUE Spindle Speed Value LREAL Both from FGDATA 89 137 129 133 147 148 44 5 135 132 70 4 71 SYNC_SPINDLE_SKEW Work Coordinate System Information Y UII r c Publication 8520 6 6 August 1999
54. The argument for this command is the filename string as discussed on pagd 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP WORK COORD maind workbck ppg would create the backup program on the CNCs main directory and name the backup program workbck Data Server Commands 5 31 COPY OFFSET source axis destination axis This command copies all of the tool offset values from the tool geometry and wear tables from a source axis to a destination axis All tool offset values for the source axis are copied to the destination axis For example COPY OFFSET X copies the geometry and wear tables for the X axis to the Y axis values MEASURE TOOL GEOM tool number axis number ref pos This command performs the tool measure function refer to your operation and programming manual for details on measure When executed this command compares the actual axis position to the entered ref pos to determine the geometry offset Three arguments are specified with this
55. USINT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder The HARDWARE STATUS PORTA item identifies the current hardware status of port This is a bit pattern item whose bits identify the hardware status as follows Ma Indicates 0 CTS 1 RTS 2 not used 3 not used HARDWARE STATUS PORTB Data Type USINT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder The HARDWARE STATUS PORTB item identifies the current hardware status of port B This is a bit pattern item whose bits identify the hardware status as follows ili Indicates 0 CTS 1 RTS 2 DSR 3 DTR LEVEL 2 STATUS PORTA Data Type USINT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder The LEVEL 2 STATUS PORTA item identifies the current data status of communications on port A This is a bit pattern item whose bits identify the hardware status as follows Publication 8520 6 6 August 1999 4 32 Data Server Data Items Publication 8520 6 6 August 1999 m Indicates dud Indicates 0 dc1 receive 4 dc1 transmit 1 dc2 receive 5 dc2 transmit 2 dc3 receive 6 dc3 transmit 3 dc4 receive 7 dc4 transmit LEVEL 2 STATUS PORTB Data Type USINT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder The LEVEL 2 ST
56. an argument for this command The transmitted character must be an integer DINT equivalent of the ASCII character to transmit For example SINGLE TX SERIAL IO 68 will transmit the lone character D out the serial port Note this is used primarily for I O monitor diagnostics Important This command does not apply to the 9 PC CNC START SERIAL IO MONITOR no arguments This command is used to start the serial I O monitor For example START SERIAL IO MONITOR will begin the I O monitoring operation on the port selected with the command ENTER SERIAL IO MONITOR Important This command does not apply to the 9 PC CNC Miscellaneous OCI Data Server CNC Commands 5 21 STOP SERIAL IO MONITOR arguments This command is used to stop the serial I O monitor For example STOP SERIAL IO MONITOR will halt the I O monitoring operation on the port selected with the command ENTER SERIAL IO MONITOR This command does not however exit serial I O monitor mode Use the EXIT SERIAL IO MONITOR command to exit monitor mode Important This command does not apply to the 9 PC CNC CANCEL MESSAGE no argument Use this command to cancel active messages at the CNC Note it does not clear any active OCI error messages those loaded by your DDE application the OCI data server or the Windows NT operating system This command clears all active error messages provided the cause of the error has been eliminated CALCULATE
57. and programming manual for details ACTIVE TOOL RADIUS NUM Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The ACTIVE_TOOL_RADIUS_NUM data item identifies the last tool radius offset number activated on the control refer to the cutter compensation chapter of your operation and programming manual for details This tool radius number may have been activated through part program execution or from the execution of the OCI command ACTIVATE TOOL_RADIUS Note that an active offset number does not necessarily indicate the offset is currently active It only indicates the number of the offset that may or may not be active depending on the programmed operating mode of the control and the AMP configuration on how the offset is activated Refer to the offset chapter of your operation and programming manual for details Data Server Data Items 4 45 AMPED TOOL LENGTH AXIS LOGICAL BIT PATTERN Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to determine what axes are AMPed as the tool length axes in the process It returns a bit pattern of the logical axes in the process zero is reported to the logical axis number that axis is not AMPed as a tool length axis A one indicates th
58. and relinquish control commands discussed on 5 23 Some commands require string numeric or numeric enumeration be passed to the data server with the command name We call these strings or numerics Arguments Some of the more frequently used numeric enumerations and string formats are listed starting on page 6 1 Command argument names are included within parenthesis following the command Text strings appear in quotation marks Numerics and numeric enumerations appear without quotation marks For example AUX COM FWD SEARCH search type search string AUX CMD FWD SEARCH is a command Arguments for this command are search type a numeric enumeration and search string a string You must include all argument when making a command request to the data server even if you leave the argument blank comas must be included and all character strings even if they are blank 4 must be included By executing a command in your OCI application program a request is made by the OCI data server to the specified CNC The CNC attempts to perform the requested operation and sends a return code to the OCI data server see the data item COMMAND ERROR indicating status of the request While the CNC is processing a request the COMMAND ERROR CODE returns 3000 Typically a return code value of zero 0 indicates the request was performed successfully Publication 8520 6 6 August 1999 5 2
59. as follows 0 Yes use standard motor table values No don t use standard motor table values For example assiging a value of 1 to the following item VELOCITY GAINS FROM TABLE 1 Tells the control to ignore the standard motor table values and use the gains as entered by the user configuration for axis 1 Zones and Overtravels LOGICAL AXIS ZONE GROUP axis num Data Type UINT array Read Write Read only Array Index Axis Number Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to identify to what interference zone group the axis is assigned This is an array of n entries 1 entry per logical axis in the process Retrun values are 0 axis is not in a zone group 2 axis is assigned to zone group 2 3 axis is assigned to zone group 3 Publication 8520 6 6 August 1999 Overview Command Arguments Return Codes Chapter 5 OCI Data Server CNC Commands The OCI data server provides a number of CNC commands that can be passed from your application to the CNC These commands are used to request the CNC to perform some action or activity for example delete a part program from the CNC file directory or backup AMP to flash memory Important Commands as well as data poke requests can only be performed by the OCI data server if it is identified as the controlling OCI system at the CNC Use the request
60. calc string Use this command to perform a calculation on the equation entered as the calc string with this command Refer to your operation and programming manual for valid calc syntax The solution to this calculation is returned in the API data item CALCULATION RESULT For example CALCULATE 2 8 would return the value of 16 to the API item CALCULATION RESULT CLEAR ACTIVE ERRORS no argument This command clears all active error messages at the CNC from the error message log Note it does not clear any active OCI error messages those loaded by your DDE application the OCI data server or the Windows NT operating system Publication 8520 6 6 August 1999 5 22 Data Server Commands Publication 8520 6 6 August 1999 CLEAR_CYCLE TIME no argument Use this command to clear the cycle time recorded by the Time Parts Count Feature This command clears the time recorded for the individual part program elapsed execution time time between cycle start request and end of program Refer to your operation and programming manual for details on this feature CLEAR_ERROR_LOG no argument This command clears all error messages in the system error log CLEAR POWER ON TIME OVERALL no argument Use this command to clear the controls overall power on time This feature is included on the time parts display of the standard displays Refer to your operation and programming manual for details CLEAR RUN
61. determine the start point of axis calibration measurement for a specific axis The Calibration_Start enumeration is Enumeration Result 0 Most 1 Most Most means calibration points start at the calibration point entered with the most positive value Most negative means calibration points start at the calibration point entered with the most negative value Subsequent points will then be measured from the most positive or negative data point you enter for your ballscrew The Calibration_Type enumeration determines if the points are measured from the start point or from subsequent entered points CALIBRATION_TYPE enumeration The Calibration Type enumeration is used to identify the method used to enter calibration data in the axis calibration tables for a specific axis The Calibration_Type enumeration is Enumeration Result 0 Measurement 1 Deviation Measurement means each point entered is a measurement from the original start point Deviation means each point is a measurement from the preceding adjacent point entered Publication 8520 6 6 August 1999 Array Strings Publication 8520 6 6 August 1999 COM MODE enumeration Used for the I O monitor diagnostic screen Use this enumeration to specify that the I O monitor will transmit or receive data Enumeration Result 0 Transmit 1 Receive Important Enumeration does not apply to the 9 PC CNC COPY MEM TO PORTAJ copy to type en
62. does not apply to the 9 PC CNC AUX COM SENDCMD command index This command is used only for systems with a data highway module Use this command to transmit data using the argument command index to identify the DH channel to use 1 64 DINT For example AUX COM SENDCMD 1 Refer to your DH users manuals for details on the operation of this command This command is typically used to simulate a keystroke or other operation for the purpose of testing Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 18 Data Server Commands Publication 8520 6 6 August 1999 COPY DEVICE SETUP DEFAULTS port id device num This command is used to restore the communication defaults for a device attached to the control Executing this command restores the defaults set for a specific device and overwrites any changes that were made for that device with the device configuration API data items The id argument is an enumeration which identifies which port you are configuring The device num argument is also enumerated and identifies the specific device for which communication defaults are to be loaded See the enumerations chapters for port id and device num enumerations For example COPY DEVICE SETUP DEFAULTS 1 16 Loads the defaults in port A 1 for the Greco Minifile device number 16 Important This command does not apply to the
63. flag top LinkMode 2 Sets the link mode to manual top Text 1 Places the data to write into the text box top LinkPoke Writes the value 1 to SESTOP LinkMode VBLinkNone breaks the manual connection 0 Pt Bl pd Pd jP El Note that since we using PAL Logic flag in this example control s PAL Logic program still has the ability to overwrite items sent to the control PAL Logic always wins when conflicting writes occur to a flag since they are written immediately before the PAL Logic scan In this case unless your PAL program is written to repeatedly write a zero to SESTOP every scan or to write a True or False to your Logic program it shouldn t be a problem but you should keep it in mind when writing to PAL Logic variables through the OCI DDE interface Publication 8520 6 6 August 1999 2 4 DDE Data Server Examples DDE Commands In this example we execute a DDE command that writes MDI data to the CNC The user places the program block in a text box we created on the form named MDI Input Commands are always placed between square brackets This example uses the INPUT MDI STRING command Commands can be found in 4 br appendix B The following code is executed when a command button is pressed MDI Input LinkTopic abociserver CNC 1 Set Link Service and Topic MDI Input LinkMode MDI Input Linkl Chr 34 amp MDI Input L
64. identifies AMP process name for dual process systems The system installer configures a process name in AMP for each process controlled by the CNC This item returns the process name as a text string for the requested process Important Dual process systems are not available for release 1 of the 9 PC Follow the data item with a 1 or 2 to indicate the process number No process number makes a request for process 1 Single process systems can also use 1 as a valid data item request For example PROCESS NAMES 1 would return the text string used to identify the process 1 name Publication 8520 6 6 August 1999 4 42 Data Server Data Items Publication 8520 6 6 August 1999 SERVO FW REVISION num module Data Type DINT Read Write Read only Array Index num_module Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This double word provides the servo firmware revision as a 32 bit word The upper 16 bits indicate the major and minor revisions The lower 16 bits indicate the an internal Allen Bradley software revision that you should ignore For example for firmware revision 11 00 you would be returned the decimal integer 720896048 or in HEX 2AF8 0030 The lower 16 bits is the internal revision The upper 16 bits is the major revision 11000 11 00 You can access this data item for each servo module individually using the num module index This index cor
65. it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP COM2B PARAMETERS maind cm2Bback ppg would create the backup program on the CNCs main directory and name the backup program cm2bback BACKUP SHARED PARAMETERS Filename string This command tells the control to create a backup program of all the shared paramacro parameters 7100 7199 Refer to your operation and programming manual for details Shared paramacro parameters are only available on dual process control types The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP SHARED PARAMETERS maind shrdbck ppg would create the backup program on the CNCs main directory and name the backup program shrdbck Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 38 Data Server Commands
66. of CNC that uses the data item CNC Type For example lathe mill grinder etc Refer to pagd 4 8 details Other important information that may be included with data items is e Link Type None Automatic Notify Manual The link type is application selectable Refer to details Background Foreground data items are monitored in the controls background unless otherwise indicated text describing the data item All foreground data items are discussed in this chapter Refer to page 4 13 for details Dual Process Follow the data item with a 1 or 2 to indicate the process number No process number by default makes a request for process 1 Single process systems can also use 1 as a valid data item request Use the table in appendix A fo determine if an item is available as dual process For example PROCESS NAMEBS 1 would return the text string used to identify the process 1 name Important Currently process options do not apply to the 9 PC CNC e The value returned by many data items especially axis position information is not always rounded by the systems configured basic positional resolution If your application requires rounded display information you must perform the rounding in your applications code For example you may see an axis position as 0 5 on the position display but axis calibration items may see this position as 0 499999980314961 Publication 8520 6 6 A
67. on scaling The data for this item is returned as a bit pattern A true value in any bit indicates the axis is scaled The first bit of this word represents axis 1 For example if the returned integer is 11 which translates into 001011 indicating axes 1 2 and 4 are scaled PAL Variable Data Items 96 IJO Variable Data Type defined in ODS I O assigner Read Write Read Write outputs only both PAL protected Array Index none Control Type Lathe Mill Grinder Important Variable does not apply to 9 PC You can access all PAL I O variables assuming they have been assigned properly with the ODS I O assigner Your OCI application can read both PAL inputs and outputs Your OCI application can write to only PAL outputs read and writes are subject to the PAL logic which always has the authority to override any OCI settings Automatic reads of PAL variables are always added to the controls background watch list You must consider any timing issues this may present in your PAL and API applications Variables set by the OCI occur at the beginning of a PAL scan The PAL ladder runs and acts on these changes by writing to the variable tables This means if your OCI sets an output to true at the beginning of a PAL scan PAL can change the output point back to false during the PAL scan thus overriding the OCI request to set the output to true Publication 8520 6 6 August 1999 4 48 Data Server Data It
68. s ona yao pim as at sii OFT COE SG a s T ire THDS bette E E Spy Ep By Py Cy py ET This project window gives you access to the display forms and code used to compile the Basic Display Set screens Each form typically represents a specific O Series or 9 PC screen Publication 8520 6 6 August 1999 3 6 Basic Display Set BDS Basic Display Set Screen The majority of the 9 Series 9 Basic Display Set screens are Construction laid out using a combination of overlaying forms The forms used to build a typical 9 Series or 9 PC screen include ALLEN BRADLEY9 SERIES FRONTPANEL v File Options p Form IbIPromptinput ll IbISystemMessage E STOP InkSystemStat InkCommand InkE rr Comman System Information PR Sh IblAxesNDTG 0 IblAxesNTar T IblActiveProgi IbIEditedProg IblSubPrograr 10 Display Form Main MDI Form MEMORY MDI STOP N 2 IblProgramBlock IbICoverLabel IblDisplay2 f PAL MESSAGE form IbiLine21 297918 InkLabel ibiLine22 EN PAL Logic Messages Form W eS CC 1 MANAGE OFFSET d PRGRAM SYSTEM MANAGE PARAM CHECK 5 Softkey Ar
69. source code 1 loaded in the same directory the Basic Display Set and the variable SETUPMenu 1 set to True Set this variable by either e Manually change the variable in source code SETUPMenu is found in Global Bas InitGlobals or Manually change the variable FINAL EXE to False 2 From the Visual Basic Run menu select START The source code should load and begin running You should have the OCI workstation connected to an OCI compatible CNC and the OCI data server active or have your 9 PC running via the 9 PC Configuration Manager If the Basic Display Set can not find the default CNC you have selected you will be prompted to select another CNC to connect You should see the power turn on screen Pressing Enter should display the program position display 3 From the executing screen Setup menu select Softkeys FJ Alle File Options Testing Prompts Text PROGRAM 0 000 MMPH MEMORY PRGRAM OFFSET MACRO PRGRAM SYSTEM gt MANAGE PARAM CHECK SUPORT F2 F3 F5 EZ 8 basic displays should show softkey edit tools after loading the text files for all valid languages The softkey edit tools are shown in the following figure Publication 8520 6 6 August 1999 Basic Display Set BDS 3 13 Current Softkey Number Current Softkey Row SPD Ptr Edit Softkey Text buttons 1 thru 5 PRGR ors Im IBAs ex cnc PIE CHE CIE SUPONEN w
70. specific CNC The service name for the OCI data server is ABOCISERVER The data server runs in the Microsoft Windows 4 0 or higher operating environment OCI Data Server Read Data Requests Your OCI application can request data from the CNC Read requests can be automatic or manual Automatic items are added and maintained on a watchlist at the control Manual items are placed on the watchlist just long enough to report the current value of the item Refer to page 4 1 details on reading data items OCI Data Server Write Data Requests Information can be written to your CNC using a Poke operation When a Poke request is made by your application program to the OCI data server the data server passes this data on to the CNC processor which if valid will change the data item value Open Control Interface Overview 1 5 Poke requests only honored by the when they are made from the data servers controlling OCI station Refer to the API data item chapter in this manual for details on requesting control ATTENTION Extreme care must be taken when using the POKE capability If you inadvertently write bad data to a critical 9 Series or 9 PC configuration you could adversely affect the operation of the CNC OCI Data Server Command Requests Your OCI application can request the CNC to execute a command A description of the available CNC OCI commands begins on page Commands ask the control to p
71. system is available on both the 9 Series and the 9 PC CNC Some data items are not available on the dual processing system or are not available on the single processing system These are indicated as dual process only or single process only Other data items without this designation should be assumed available on both single and dual processing controls dual process is not available for Release 1 of the 9 PC The control type is determined by a combination of the executive software supplied with the control and the AMP configured control type Data Server Data Items 4 9 Link Type Your OCI application program must choose the link type to be used based on your specific data needs When you create an OCI application program you must choose the link type that meets your needs If your OCI application program requests a Manual Link Data that is identified a manual link type must be requested by your application program to get an update Changes to the data are not automatically updated on the OCI station by the control Your application must request that the control update the OCI station The application program receives only one update of the data from the control when the request is made OCI 9 Series Manual Link Server RSLinx DDE Application Application requests the current data value for 9 contained the Server 9 Series The Server reads the curre
72. the 9 PC Installation and Integration Manual A DDE conversation with the data service can be established using any Windows compliant application that supports Microsoft s Dynamic Data Exchange functions This chapter gives examples of such conversations established using Microsoft s Visual Basic and Microsoft s Excel A DDE conversation regardless of the software used to start the communication requires the following three things 1 ADDE Server or Application Name 2 A Topic Name to that server 3 A Data Item or Command to pass to that server DDE Server For the 9 Series or 9 PC the DDE server is always l ABOCISERVER This is the server name registered in Windows when you launch the 9 Series or 9 data server Publication 8520 6 6 August 1999 2 2 DDE Data Server Examples Using Visual Basic Publication 8520 6 6 August 1999 Topic Name The topic name is created by the data server when it is launched 9 Series only topic names are defined by you in the INI file OCIDSCFG INI A different topic name is created for each 9 Series CNC connection to the data server as an alias If you are using the 9 PC you create the topic name during 9 PC executive software installation or change the topic name via the 9 PC Configuration Manager The 9 PC has only one topic name The default alias for one CNC connection is CNC I The rest of this chapter assumes this is the alias you are using Refer to your 9 Ser
73. the Topicld For 9 PC CNCs the topic name is used to identify a 9 PC located in the host computer to facilitate communication between the 9 PC CNC executive and various client applications and services running on a Topicld for the 9 CNC is set in the Configuration Manager An item is either a data item or a command item Data items are listed starting on page and are used to read and write data from to your CNC Command items are listed starting on 5 1 used to request the 9 Series perform a specific task Publication 8520 6 6 August 1999 1 4 Open Control Interface Overview Data Server Publication 8520 6 6 August 1999 To access a piece of data named num_axes on a specific CNC you enter this information into your application s DDE Link function Service or Application Name Item Name ABOCISERVER NUM AXES Once you specify this information in your application program and execute the request the application establishes a link to the OCI data server and requests the data or command Once installed and executing the OCI data server is used to converse between a 9 Series CNC using RSLinx or 9 PC CNC and your application program using DDE Refer to your OCI Installation Manual or 9 PC Installation and Integration Manual for details on OCI installation and configuration The data server provides DDE interface for your application program from a
74. this may or may not be the same as the controlling data server Refer to your OCI installation manual for details COPY PART PROGRAM src filename string dest filename string Use this command to copy your part programs to from your Pc s hard drive to from either the protected or main CNC directories Valid devices in the filename string include the CNCs main directory the CNCs protected directory and the OCI file handlers configured PC directory Data Server Commands 5 39 The filename string format is given page 6 19 includes specific directory information Format for the arguments is source filename followed by destination filename For example COPY PART PROGRAM MAIND SOURCE PPG PROTD DEST PPG COPY MI EM TO MI EM copies the program named SOURCE PPG from the main CNC directory to a programmed named DEST PPG in the protected directory COPY MEM TO MEM src filename string dest filename string mode This command is used to copy a part program that already exists in one of the directories in control memory protected or main The filename string format is given on page 6 19 For example and includes specific directory information You can not use this command as a method of moving files from control memory to the PC hard drive Use the COPY PART PROGRAM command to copy across devices Format for the arguments is source filename followed by
75. 1 umm we n PRESENT LOGICAL BT PATTERN Bt patem oraes in eunenty ache pane ur mm _ n o z maes mmm meae on e s fromas 315 NUM MONITORED SERVOS of servos monitored prog axes skew Both All Controls slaves spindle NUM PROG AXES PLUS EXTRA Num programming axis inc duals and angled UINT Both Controls virtual axes r om scavo woos UNT 06 De s r s 7 CC s un senses s Yon Publication 8520 6 6 August 1999 16 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc 364 RACK_1394_SYSTEM_MODULE_HW_REVI Revision number associated with each rack of UINTI 9 PC 1394 5 Controls SION 1394 drives RIAL_RACKS 365 RACK_1394_SERCOS_ADDRESS Configured address associated with each rack UINT 9 1394 SE All controls of 1394 drives RIAL RACKS 366 RACK 1394 BOARD NUMBER Physical connector number for a 1394 rack to UINT 9 1394 SE Controls the CNC RIAL RACKS RACK 1394 AXIS MODULE ERRORS Error codes for the axis modules in one 1394 UINT 9 1394 SE Controls RIAL ROLLOVER AKS LOGICAL BN PATTERN tate wr bm Ares n
76. 11 B 1 REQUEST CONTROL RESET MAX TIMES RESTART PART PROGRAM RESTORE AMP RESTORE AXISCAL Return Codes for commands REVERSAL ERROR DISTANCE A 17 RING 10 CARD TYPE A 11 RING IO DEVICE ADDRESS A 11 RING IO DEVICE INPUT DATA A 11 RING IO DEVICE OUTPUT DATA A 11 RING IO DEVICE TYPE A 11 ROLLOVER AXIS LOGICAL BIT PATTE RN 4 57 A 16 Publication 8520 6 6 August 1999 Publication 8520 6 6 August 1999 ROTARY AXIS LOGICAL BIT PATTERN 1 58 A 16 ROTATION EXT STATUS Enumeration 6 16 Rows adding new softkeys RSData installing RSJunctionBox installing used with the BDS RSLinx overview 1 6 RSLinx Configurator Application RT CUSTOMIZE TOOL RT POCKETS NEEDED A 14 RT SET TOOL NUM SHAFT POCKET RT TOOL NUM A 14 RUNTIME A 12 RX CHAR PORTA RX CHAR PORTB S 5 WORD 4 61 17 SAVE DEVICE SETUP Saving text and prompt changes 3 21 Saving Softkey Changes SCALING CENTER A 13 SCALING INDICATOR Enumeration 6 16 Scan Time Screen Names SR NUMS bas Screen Size global bas Screens adding new pointer BDS display forms MASTER FRM printing pointers SetSPDPointer template SCRNPOS data files Search text or prompts 3 20 SEARCH METHOD Enumeration 6 17 SEARCH TYPE Enumeration 6 17 SECONDARY_AUX_WORD A 6 SELECTED PART PROGRAM DIR SEQUENCE STOP PART PROGRAM 5 45 B 4 B 6 Server See Data Serv
77. 13 19 PAL Logic messages are displayed on the MESSAGES frm Softkey Form SOFTKEYS FRM This form resides at the bottom of MAINMDI FRM It is used to handle softkey display and loads and unloads display forms as needed This form is loaded by MAINMDI FRM Basic Display Set In addition to the standard forms several basic modules can be found Basic Modules in the The function of these basic modules is This Basic Module Is Used To Manages general global data such as screen size GLOBAL BAS font sizes error handling and identifies general information about the CNC connected to the OCI Manages transition between languages and LANGUAGE BAS changes between the different text files for the different languages Defines constants used by the BDS to enforce OPT NUMS BAS option PAL capabilities removing softkeys and screens for features not supported on the system Defines constants used by the BDS to navigate the PD NUMS BAS softkey tree PR NUMS BAS Defines constants used by the BDS to refer to prompt text strings SK NUMS BAS Assigns text names to the softkey numbers returned the softkey module row of softkeys SOFTKEYS BAS Uses a case statement to identify what action should be taken when a specific softkey is pressed SR_NUMS BAS Assigns text names to the screen numbers returned by the softkey module Publication 8520 6 6 August 1999 3 8 Basic Display Set BD
78. 2 WORK COORD A 18 G592 WORK COORD UNITS A 18 G593 WORK COORD A 19 G593 WORK COORD UNITS German den oy printing text GLOBAL BAS Grinder Data Items H WORD A 8 Handling Errors C 1 HARDWARE STATUS PORTA HARDWARE STATUS PORTB HOME CALIBRATION AMOUNT A 16 Hot Link 4 10 IFP COPY CANCEL 7 In Process Dresser CURRENT DRESSER RPM A 6 CURRENT WHEEL DIAMETER DRESSER AMOUNT PER A 6 DRESSER HOLD STATUS A 6 DRESSER RETRACT DISTANCE DRESSER ROLL DIAMETER DRESSER STATUS A 7 DRESSER SURFACE SPEED RATIO DRESSER TABLE UNITS INITIAL WHEEL DIAMETER 7 MAX WHEEL_SPEED MIN WHEEL_DIAMETER NEW WHEEL DIAMETER Publication 8520 6 6 August 1999 I 10 Index Publication 8520 6 6 August 1999 WARNING WHEEL DIAMETER WHEEL WIDTH A 7 Inactive Items removing from Watchlist INCH METRIC MODE Enumeration Index AXIS NUM 4 4 G MODAL GROUP LOG SIZE 6 1 M MODAL GROUP MAX BLOCK TRANSFER MAX CUSTOM DIM NUMBER POCKETS 6 1 MAX NUMBER RING DEVICES MAX OFFSETS PAL MESSAGES 6 1 MAX PAXES MAX REMOTE 10 MAX SLOTS MAX TOOL ENTRIES MAX TOOL GROUPS MAX WORK COORD NUM CHANNELS NUM CMDS NUM DIRECTORIES R 4 6 1 NUM COM2A PARAMS NUM DEVICES NUM DISP LINES NUM FEATURES NUM MSGS NUM OEM MSGS NUM OPTION SLOTS NUM PP FILES NUM VIRTUAL NAMES OFFSET NUM 4 8 SERVO MODULES 4
79. 5 6106 CANNOT EDIT OTHER FILE IS BEING EDITED CANNOT EDIT MUST BE IN CYCLE OR E STOP 6108 INVALID TIME FORMAT MUST BE HH MM SS INVALID DATE FORMAT MUST BE MM DD YY MUST BE IN E STOP OR CYCLE STOPPED 110 MAX SIZE EXCEEDED DUPLICATE 7300 PATTERN NAME 7300 PATTERN NAME TOO LONG 115 MANY AXES SELECTED FOR DISPLAY FLASH IN USE TRY AGAIN LATER PORT B IS BUSY FILE DOWNLOAD COMPLETE FILE DOWNLOAD ERROR 130 FILEDOWNLOADERROR 130 SYMBOLNOTFOUND 135 MAXIMUM NUMBEROFPROGRAMS 6139 MAXIMUM NUMBER OF PROGRAMS 6140 CANNOT EDIT FILE UPLOADING 140 me mo LL NN Publication 8520 6 6 August 1999 22 Error Handling PROBE IS ARMED CAN T ADJUST SERVOS LETTER OR DIGIT MUST FOLLOW amp OR WILDCARD MUST BE AT START END OF SYMBOL MUST START WITH A LETTER 145 MUST START WITH amp LTR DIGIT CHARACTERS MUST DIGIT MUST START WITH OR LETTER LETTER OR DIGIT MUST FOLLOW SHIFT VALUE HAS TOO MANY DIGITS 150 LETTER OR DIGIT MUST FOLLOW MUST START WITH 96 OR LETTER 155 MUST START WITH OR LETTER LETTER OR DIGIT MUST FOLLOW 96 OR INCOMPATIBLE PAL LOGIC SOURCE PAL LOGIC SOURCE NOT DOWNLOADED TO CNC ODS RUNG MONITOR ACTIVE OBJECT NOT FOUND IN PROGRAM DISP SELECT NOT ALLOWED 165 SEARCH MONITOR SELECT NOT ALLOWED C
80. 6 6 August 1999 BACKUP RANDOM TOOL Filename string This command tells the control to create a backup program of the random tool management tables Refer to your operation and programming manual for details on using the random tool feature The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP RANDOM TOOL maind randback ppg would create the backup program on the CNC s main directory and name the backup program randback BACKUP TOOL MANAGE Filename string This command tells the control to create a backup program of the tool management tables Refer to your operation and programming manual for details on using the tool management feature The argument for this command is the filename string as discussed on 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the rem
81. 8520 6 6 August 1999 Error Handling Overview Appendix Error Handling The table on the following pages lists the errors that can be returned or generated by your OCI system The text files for these error strings can not be edited and are not in ASCII text form If you purchased the optional basic display set source code you can use the routine GetMsgString to call error messages GetMsgString is found in the Global BAS module and must be passed the integer error message number to return the text string of the appropriate error message Data Request Errors Requests to the OCI data server that are invalid are returned as a text string to the requesting item For example if you are requesting AXIS 7 and only 6 axes are configured on the system the value of AXIS NAME would be Server Error 29 Always test returned data for the string Server Error before presenting data to your application Command and Data Item POKE Errors The following tables list the error or status messages returned by the OCI data server or CNC when you issue a command or data item request The server will return the Error Number as data for the API data items When POKE requests are made to data items errors or success indication are returned to the API item WRITE ERROR CODE In the case of commands errors are returned to the API data item COMMAND ERROR CODE OK FILE DOESN T EXIST 2 CONTINUE TO RE RUN THIS TEST
82. 99 4 38 Data Server Data Items Miscellaneous Data Items Publication 8520 6 6 August 1999 ACTIVE PAL MESSAGES 13 Returns the text string for the active PAL Logic message that should be displayed on line 13 as defined in your PAL Logic application For each line returned the first 40 characters contain the ASCII characters that make up the message The next 40 characters contain a control character for each of the 40 message text characters Each of these control characters is made up of three attributes assigned to different bits of the word These control characters identify how each character of the message should be displayed as follows CODE INVERSE 0x40 CODE_NORMAL 0x00 CODE_BLINK_ON 0x80 CODE BLINK OFF 0x00 CHR BLACK 0x10 CHR_RED 0 11 CHR GREEN 0x12 CHR_YELLOW 0x13 CHR_BLUE 0x14 CHR_MAGENTA 0x15 CHR_CYAN 0x16 CHR_WHITE 0x17 COPYRIGHT_DATE Data Type String1 Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to identify the copyright date for the 9 Series or 9 PC CNC firmware Data is returned as a text string with the format mm dd yy where mm month dd day yy year Data Server Data Items 4 39 DATE Data Type String1 Read Write Read Write Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Re
83. ALLOWED 5086 ARCTAN SYNTAX ERROR 5087 SQUARE ROOT OF NEGATIVE INVALID EXPRESSION INCOMPLETE TOO MANY EXPRESSION NESTS TOO MANY IN EXPRESSION 90 COMPLETED WITH NO ERRORS COMPLETED WITH ERROR S 5093 ERROR FOUND 5094 NO MORE MDI BLOCKS 5095 PART PROGRAM NOT SELECTED 5096 MISSING M02 OR M30 MAXIMUM RETRACE COUNT REACHED 5099 NO FURTHER RETRACE ALLOWED 5100 RETRACE NOT ALLOWED 100 5101 BLOCK RETRACE ABORTED 5102 MDI NOT ALLOWED DURING RETRACE IN EXPRESSION INVALID OPERATOR IN EXPRESSION NUMBER IS OUT OF RANGE 5118 ILLEGAL ROTATION PLANE SELECTED 5119 CIRCULAR BLOCK NOT ALLOWED Publication 8520 6 6 August 1999 12 Error Handling OPTION NOT INSTALLED 120 AXES DATA MISSING QPP BLOCK FORMAT ERROR ILLEGAL ANGLE VALUE BOTH LINES ARE PARALLEL EXTRA DATA IN INTERRUPT MACRO INVALID AMP LETTER FORMAT INVALID LIFE TYPE INVALID EXPECTED TOOL LIFE INVALID TOOL GROUP INVALID TOOL NUMBER NOT IN G10L3 MODE MISSING INTEGRAND RADIUS WORD TOO MANY QPP NONMOTION BLOCKS 150 5151 ILLEGAL PRGRAMMED RETURN GROUP 5152 ILLEGAL PROGRAMMED RETURN TOOL 5153 INVALID MACRO COMMAND INTERRUPT NOT RECOGNIZED MISSING ROUGHING CYCLE DEPTH D WORD sm sie Publication 8520 6 6 August 1999 Error Handling C 13 MISSING ROUGHING CYCLE P Q WORD DATA STARVE
84. AND 3038 DH SEND ERROR 3039 SYNTAX ERROR 3040 TOOL ACTIVATION ERROR 3044 PP ALREADY ACTIVE 3045 DH DOWNLOAD ERROR DH DOWNLOAD SENT Publication 8520 6 6 August 1999 Error Handling Error Num Error Name o O File Server Errors ERROR READING FILE ON HARD DRIVE ERROR WRITING FILE TO HARD DRIVE ERROR CLOSING FILE ON HARD DRIVE ERROR ACCESSING FILE ON HARD DRIVE ERROR ACCESSING FILE ON HARD DRIVE INVALID OPERATION ERROR OPENING FILE FILE READ ERROR SERVER BUSY NOT CONTROLLING CLIENT IS ACTIVE MUST SPECIFY ALL ADDRESS BAD SMB SIZE ERROR OPENING CNC FILE ERROR WRITING FILE TO CNC FILE HANDLER NOT ACTIVE ENCRYPT ERROR FILE HANDLER TIMEOUT FILE HANDLER NETWORK ERROR Part Program Decode Errors THREAD LEAD ERROR READ ERROR INVALID AXIS FOR CSS CODING ERROR MANY DECIMAL POINTS G CODE TABLE ERROR AXIS ASSIGNED TO PAL LOGIC AXIS MOVER INVALID ZONE LIMIT THREAD LEAD IS ZERO MISSING F IN INVERSE TIME 10 DWELL VALUE NOT PROGRAMMED aj O1 O O O O O O O O O 0 CO NI O Oo A N Publication 8520 6 6 August 1999 Error Handling C 9 5012 MOTION NOT ALLOWED 5013 NEGATIVE DWELL VALUE ROTARY WORD OUT OF RANGE 5015 NOT ALLOWED THREADING ACTIVE 5016 NOT ALLOWED G41 G42 ACTIVE CHANGE
85. AREA 1 Interference zones first axis plus limit for dual LREAL Interf Tool Number Inch Met INTERF UNITS process interference zone 1 INTERF SECOND AXIS MINUS AREA 1 Interference zones second axis minus limit for LREAL dual process interference zone 1 ric De Interf Tool Number grees Interf Tool Number Inch Met INTERF UNITS ric De Interf Tool Number grees Interf Tool Number Inch Met INTERF UNITS ric De Interf Tool Number grees Interf Tool Number Inch Met INTERF UNITS ric De Interf Tool Number grees INTERF FIRST AXIS PLUS AREA 2 Interference zones first axis plus limit for dual LREAL process interference zone 2 INTERF SECOND AXIS MINUS AREA 2 Interference zones second axis minus limit for LREAL dual process interference zone 2 INTERF SECOND AXIS PLUS AREA 2 Interference zones second axis plus limit for LREAL dual process interference zone 2 7 INTERF TOOL NUM Number of Interference tools AMP UINT 17 4 LIMIT LOWER LIMITS Limit 2 Lower Limit LREAL LIMIT2 UPPER LIMITS Limit 2 Upper Limit LREAL Publication 8520 6 6 August 1999 Interf Tool Number Inch Met INTERF UNITS ric De Interf Tool Number grees Interf Tool Number Inch Met INTERF UNITS ric De Interf Tool Number a Axes Inch Met EME UNITS ric De grees 266 NTERF SECOND AXIS PLUS AREA 1 Interference zones second axis plus limit for LREAL dual process interference z
86. ART SEARCH B 5 B 6 EXECUTE PART PROGRAM SEARCH 5 44 B 4 B 6 EXIT AXISCAL MODIFY MODE B 1 EXIT SERIAL IO MONITOR MODE 5 19 B 2 Exiting text search utility 3 21 EXT ROT ANGLE A 12 EXT ROT FIRST AXIS EXT ROT FIRST AXIS CENTER A 12 EXT ROT FIRST AXIS VECTOR A 12 EXT ROT SECOND AXIS EXT ROT SECOND AXIS CENTER ill EXT ROT SECOND AXIS VECTOR EXTERNAL WORK COORD A18 EXTERNAL WORK COORD UNITS F F1 DIGIT FEEDRATE A 5 Factory Communication Module AUX COM CHANNEL NUMBER AUX COM CNC FILENAME AUX COM CNC SYMBOL AUX COM COMMAND AUX COM CURRENT CONFIG NUM AUX COM HOST CHANNEL NUM AUX COM HOST REMNODE ADDR AUX COM NUM SYMBOLS A 4 AUX COM OUTPUT 4 AUX COM REMOTE FILENAME AUX COM REMOTE NODE ADDRES S A 5 AUX COM REMOTE STATION TYPE AUX COM REMOTE SYMBOL A 5 AUX COM SEND COMMAND PACKE 5 AUX COM SEND COMMAND STATUS AUX CONFIG BAUD RATE AUX CONFIG CHANNEL NAME AUX CONFIG CHANNEL TYPE AUX CONFIG FILE PID A 5 AUX CONFIG FILE TIMEOUT 5 AUX CONFIG KEYBOARD PID AUX CONFIG PACKET 5 AUX CONFIG SERIAL DATA LENGTH A 5 AUX CONFIG SERIAL PARITY A3 AUX CONFIG SERIAL STOP BITS AUX CONFIG STATION ADDRESS AUX CONFIG STATUS 5 AUX MODIFYING TABLES Fanal EXE setting the variable FEED CLAMPED FEED FORWARD PERCENT A 16 FEED MODE A 5 FEED MODE Enumeration FEED MODE DISPLAY A 5 FE
87. ATTERN commands This search operation is performed on the active part program SET MIDSTART SEARCH PATTERN search string Use this command to set your midstart program search string This command specifies the text to be searched for in the part program Use this command in conjunction with the ENTER MIDSTART SEARCH MODE and the EXECUTE MIDSTART SEARCH commands The actual string required for this search depends on these other commands For example SET MIDSTART SEARCH PATTERN 100 If the command ENTER MIDSTART SEARCH MODE is set to N Search 1 the search will find program block number N100 If ENTER MIDSTART SEARCH MODE is set to string search 5 any text with the string 100 will be found STOP QUICK CHECK no argument This command is used to take the control out of QuickCheck mode QuickCheck is the 9 Series syntax checker Refer to your operation and programming manual for details on using QuickCheck and when QuickCheck requests are valid For example STOP QUICK CHECK would take the control out of QuickCheck mode Use the command SYNTAX QUICK CHECK to enable the QuickCheck mode Tool Management Random Tool OCI Data Server CNC Commands 5 53 SYNTAX QUICK CHECK no argument This command is used to place the control in QuickCheck mode QuickCheck is the 9 Series syntax checker When in this mode a cycle start request checks the currently active part program for syntax errors Axis motion typic
88. ATUS PORTB item identifies the current data status of communications on port B This is a bit pattern item whose bits identify the hardware status as follows eg Indicates das Indicates 0 dc1 receive 4 dc1 transmit 1 dc2 receive 5 dc2 transmit 2 dc3 receive 6 dc3 transmit 3 dc4 receive 7 dc4 transmit UART MAX BAUD MODE Data Type USINT Read Write Read Write Array Index none Control Type Lathe Mill Grinder Use this data item to select the maximum configured baud rate for all devices connected to the UART port Refer to your users manual for details on why this baud rate needs to be selected Setting a value of 176 selects a max baud rate of 19 2 kbaud Setting a value to this item at 48 selects a max baud rate of 38 4 kbaud Values other than 176 or 48 are ignored Data Server Data Items 4 33 Error Message Data Items COMMAND ERROR CODE Data Type INT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this command to identify the status of OCI commands issued to the CNC see the API command chapter in this manual Once a command is issued the command error code changes to 3000 indicating the control is executing the command Refer to Appendix listing of command errors The sign bit for this word is toggled after each error condition except 3000 to
89. AXISCAL MODIFY MODE no argument 5 10 INITIALIZE AXISCAL TABLE axis number calibration type 5 5 10 INSERT_AXISCAL POINT axis number 5 11 REPLACE AXISCAL VALUE axis number axis cal point value RESTORE AXISCAL no argument 5 12 STOP AXISCAL axis number 5 12 TRANSFER AXISCAL FROM PORTA no argument 5 12 TRANSFER AXISCAL FROM PORTB no argument 5 13 TRANSFER AXISCAL TO PORTA no argument 5 13 TRANSFER AXISCAL TO PORTB no argument 5 14 Communications 5 14 AUX COM ABORT COMMAND argument 5 14 AUX COM BACKUP CONFIG TABLE filename 5 15 Publication 8520 6 6 August 1999 iv Publication 8520 6 6 August 1999 AUX FWD SEARCH search type search string AUX REV SEARCH search type search string AUX COM CMDTBL TO FLASH no argument AUX COM CONFIG TO FLASH no argument AUX COM DOWNLOAD FILE source filename destination filename AUX COM HOST WRITE TO FLASH no argument AUX COM SENDCMD command COPY DEVICE SETUP DEFAULTS port id device num DEACTIVATE RIO PASSTHROUGH no argument ENTER SERIAL IO MONITOR MODE port id mode
90. Array Indices Strings 6 17 SEARCH METHOD enumeration Search Method enumeration is used to control the search operation The Search Method enumeration is Enumeration 1 Result Forward Reverse Top of Program Cancel 2 3 4 5 Exit Search SEARCH TYPE enumeration Search Type enumeration is used to identify the type of search operation The Search Type enumeration is Enumeration Result N Search O Search EOB Search Slew Search String Search nm Next Program SERVO_STATUS enumeration Servo_Status enumeration is used to identify the status of a specific servo The Servo_Status enumeration is Enumeration Result 0 lt Feedrate suppression 1 In position 2 gt Feedrate suppression 3 Excess error Publication 8520 6 6 August 1999 6 18 Array Indices Strings SYSTEM_STATE enumeration System State enumeration is used to select the status of execution on the control The System State enumeration is Enumeration 1 Result Cycle Stop Cycle On Cycle Suspend 2 3 4 E Stopped TARGET DIR enumeration The directory Enumeration is used to select one of the two directories on the control The enumeration are Enumeration Result Main Directory Selects the main part program directory on the control Protected Selects the protectable part program directory on the control
91. August 1999 5 50 Data Server Commands Publication 8520 6 6 August 1999 VERIFY_WITH_PORTB filename1 mode Use this command to perform a compare of two part programs One must reside in control memory you can not verify program on the hard drive with this command and one must be on the peripheral device attached to serial port B if you need to verify a part program from memory to memory see VERIFY PART PROGRAM command The filenamel argument is a file name strings and is described on page This file should be resident in control memory The filename string contain specific directory information The remaining argument with this command is the mode argument which is an enumeration used to identify if you want to perform the verification or test the command syntax The test option will check the command syntax The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute verify For example VERIFY WITH PORTB MAIND FILE1 PPG 1 performs the verification of part programs FILE1 which resides in the controls main program directory against the file currently accessed through portB Results of this command come back as an error code in the command error API item ACTIVE ERROR MESSAGES Test mode success can be checked using the COMMAND ERROR CODE API item Important This command does not apply to the 9 CNC Part Program Execution OCI Data Server CNC
92. BACKUP CONFIG TABLE AUX COM CMD FWD SEARCH AUX COM CMD REV SEARCH AUX COM CMDTBL FROM FLASH AUX COM CMDTBL TO FLASH 8 2 Index 5 AUX COM CONFIG FROM FLASH AUX COM CONFIG TO FLASH B 2 AUX COM DOWNLOAD FILE AUX COM HOST FROM FLASH B 2 AUX COM HOST WRITE TO FLASH AUX COM SENDCMD COPY DEVICE SETUP DEFAULTS DEACTIVATE RIO PASSTHROUGH B 2 ENTER SERIAL IO MONITOR MODE EXIT SERIAL IO MONITOR MODE INITIALIZE DEVICE SETUP B 2 REPEAT TX SERIAL IO SAVE DEVICE SETUP B 2 SINGLE TX SERIAL 10 START SERIAL 10 MONITOR STOP SERIAL 10 MONITOR Constants screen names Control CNC Commands Control Type Attribute Controlling Station CONTROLLING OCI A 7 CONTROLLING SPINDLE NUM COPY DEVICE SETUP DEFAULTS COPY FROM TYPE Enumeration COPY MEM TO MEM 5 39 B 4 B 6 COPY MEM TO PORTA COPY MEM TO PORTA B Enumeration 6 4 COPY MEM TO PORTB 5 40 B 4 B 6 COPY OFFSET 5 31 B 3 COPY PART PROGRAM COPY PART PROGRAM FOR EDIT COPY PORTA B TO MEM Enumeration COPY PORTA TO MEM COPY PORTB 5 42 4 6 COPY TO TYPE Enumeration COPYRIGHT DATE CURRENT DRESSER 6 CURRENT SCALE FACTORS A 12 Publication 8520 6 6 August 1999 Publication 8520 6 6 August 1999 CURRENT WHEEL DIAMETER Cursor Movement on master form CYCLE TIME A 11 D D WORD 8 Data Buffer 4 11 Data Files description Data Items presentati
93. BACKUP RADIUS TABLE Filename string BACKUP TOOL GEOM Filename string BACKUP TOOL WEAR Filename string BACKUP WHEEL GEOMETRY Filename string BACKUP WORK COORD Filename string COPY OFFSET source axis destination axis MEASURE TOOL GEOM tool number axis number ref pos Table of Contents 5 15 5 16 5 16 Table of Contents v MEASURE TOOL WEAR tool number axis number ref pos 5 32 MEASURE WHEEL GEOM tool number axis number ref 5 32 PAL Commands 5 33 TRANSFER PAL FROM PORTB no argument 5 34 TRANSFER PAL TO PORTA no argument 5 34 TRANSFER PAL TO PORTB argument 5 35 Paramacro 5 35 BACKUP COM1 PARAMETERS Filename string 5 36 BACKUP COM2A PARAMETERS Filename string 5 36 BACKUP COM2B PARAMETERS Filename string 5 37 BACKUP SHARED PARAMETERS Filename string 5 37 Part Program Commands 5 38 COPY PART PROGRAM src filename string dest filename Mc cT 5 38 COPY MEM TO MEM src filename string dest filename string eoa UAE RN Ed ud esi 5 39 COPY MEM TO PORTA src filename string dest HIDUB 22 5 40 COPY PORTB sr
94. C Data Server Commands 5 7 TRANSFER HOMECAL PORTB no argument Use this command to send the current home calibration data to a printer or other device connected to the control s port B This will print the home calibration data currently in RAM This may or may not be the same home calibration data stored in the control s flash memory For example TRANSFER HOMECAL TO prints the home calibration data to the device connected to the control s port B You can only use this command to output home calibration data to a printer Important This command does not apply to the 9 PC CNC TRANSFER REVERSAL ERROR TO PORTA no argument Use this command to send the current reversal error data to a printer or other device connected to the control s port A This will print the reversal error compensation data currently in RAM This may or may not be the same data stored in the control s flash memory For example TRANSFER REVERSAL ERROR TO PORTA prints the reversal error data to the device connected to the control s port A You can only use this command to output reversal error data to a printer Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 8 Data Server Commands Axis Calibration Publication 8520 6 6 August 1999 TRANSFER REVERSAL ERROR TO PORTB no argument Use this command to send the current reversal error data to a pr
95. C CNC PAL_REVISION Data Type DINT Read Write Read Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This double word provides the revision of the PAL symbols file This is not related to your compile date or download date for the PAL image It is an internal revision of the symbols used by your PAL application This is typically only used by Allen Bradley service representatives The upper 16 bits indicate the major revision the lower 16 bits indicate the minor revision Important This data item does not apply to the 9 PC CNC Data Server Data Items 4 51 Variable Data Items SP variable number Data Type LREAL Read Write Read Write Array Index paramacro variable number Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use paramacro data items to read or write paramacro variable values You can access all paramacro variables including local common system PAL Logic and dual process variables The majority of these support both read and write functions with the exception of some select system paramacro variables Details on read write capability of system paramacro variables are given in your operation and programming manual Format for this data item is SP followed by the variable number SP101 reads the value of paramacro variable 101 SP102 5 r
96. CAN TIME AMPed System Scan Time AMP usec LR All Controls 7 Aris Calibration t pem C C ji j l 19 AXISCAL ABS POS Axis Cal Absolute Position LREAL Both 2 Point Num Num Inch Met ACTIVE UNITS Yes Controls Axes ric De grees 1 AXISCAL MEAS DEV AMOUNT Axis Cal Measurement Deviation Amount LREAL Both 2 Point Num Num Inch Met ACTIVE UNITS Yes Controls Axes ric De grees 123 AXISCAL STATUS Axis Calibration Status INT bitpatten Both 1 NmAes AlcContols 10 156 20 22 Publication 8520 6 6 August 1999 Data Items A 3 Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc 309 AXISCAL TABLE TYPE Type of the Axiscal table Measurement Devi SINT NUM PROG AXES PLUS SKEWSLAVES Controls ation Communication Pon Parameters IT T T PORTA atacedtopotA w mwa DEWCE_ON PORTE foa o w mw aromas HARDWARE STATUS FORTA wr w aromas HARDWARE STATUS FORTE Poa e o w aromas Evere Sus PORTA o jo atoms 2 some wr n aromas PORT UART deves auo sear wm f ne aromas or PORT COMMUNICATION UART device communication format INT enumerated EE
97. CONFIG SERIAL PARITY A 5 AUX CONFIG SERIAL STOP BITS A 5 AUX CONFIG STATION ADDRESS AUX CONFIG STATUS PID A 5 AUX MODIFYING TABLES A 5 AVAILABLE MEMORY 4 51 A 11 Axes logical vs physical Axis Calibration AXISCAL ABS POS A 2 AXISCAL MEAS AMOUNT A 2 AXISCAL POINTS FREE AXISCAL POINTS USED IA 2 AXISCAL_STATUS A 2 BACKUP AXISCAL B 1 DELETE ALL AXISCAL POINTS B 1 DELETE AXISCAL POINT B 1 ENTER AXISCAL MODIFY MODE 1 EXIT AXISCAL MODIFY MODE B 1 INITIALIZE AXISCAL TABLE B 1 INSERT AXISCAL POINT B 1 NEXT AXISCAL AXIS REPLACE AXISCAL VALUE E RESTORE AXISCAL SET AXISCAL PROCESS NUMBER STOP_AXISCAL B 1 TRANSFER AXISCAL FROM PORTA TRANSFER AXISCAL FROM PORTB B 1 TRANSFER AXISCAL TO PORTB B 2 Axis Calibration Commands BACKUP AXISCAL DELETE ALL AXISCAL PONTS 5 9 5 9 DELETE AXISCAL POINT 5 ENTER AXISCAL MODIFY ODE EXIT AXISCAL MODIFY_MODE 5 10 INITIALIZE AXISCAL TABLE 5 10 INSERT AXISCAL POINT 5 11 REPLACE AXISCAL VALUE 5 11 RESTORE AXISCAL 5 12 STOP AXISCAL 5 12 TRANSFER AXISCAL FROM PORTA 5 12 TRANSFER AXISCAL FROM PORTB 5 13 TRANSFER AXISCAL TO PORTA 1 TRANSFER AXISCAL TO PORTB 1 Axis Calibration Data AXISCAL_ABS_POS 4 18 AXISCAL MEAS_ DEV AMOUNT 4 19 4 19 AXISCAL POINTS FREE AXISCAL POINTS USED 4 AXISCAL STATUS 4 20 AXIS_FORMATS_INCH A 13 AXIS FORMATS METRIC A 13 AXI
98. Commands 5 51 ENTER MIDSTART SEARCH MODE search type Use this command to enter midstart program Refer to your operation and programming manual for details on midstart operation The search type argument is an enumeration that identifies the type of search operation the control is to perform The enumerations are as follows Enumeration Result 1 N Search 2 O Search 3 EOB Search 4 Slew Search 5 String Search For example ENTER MIDSTART SEARCH MODE 1 readies the control to perform an N word search Exit search mode using the command EXECUTE MIDSTART SEARCH 5 Use this command in conjunction with the EXECUTE MIDSTART SEARCH MODE and the SET MIDSTART SEARCH PATTERN commands EXECUTE MIDSTART SEARCH search method After you have entered a search mode use this command to execute a mid program search The search method argument is an enumeration that identifies the direction of the search operation the control is to perform The enumerations are as follows Enumeration Result 1 Forward 2 Reverse 3 Top of Program 4 Cancel 5 Exit Search For example EXECUTE MIDSTART SEARCH 1 1 executes the midstart search in the forward direction Publication 8520 6 6 August 1999 5 52 Data Server Commands Publication 8520 6 6 August 1999 Use this command in conjunction with the ENTER_MIDSTART_SEARCH_MODE and the SET MIDSTART SEARCH P
99. Copy of 5 3 8 MASTER FRM Recommended Subroutines 3 10 Managing Errors on your Form 3 11 Publication 8520 6 6 August 1999 ii Table of Contents Chapter 4 OCI Data Server Data Items Publication 8520 6 6 August 1999 Using the Softkey Editor Utility Changing Softkey Text Changing the Softkey Row Creating Editing a Softkey Inserting New Screen Creating Editing the Screen Pointer Exiting Softkey Edit Mode Calling the Screen Pointer in Source Code Using the Text Find Utility Using the Text Find Utility Exiting the Text Search Utility Using the Print Utilities Testing and Debugging Utilities Debugging Utility Write to Error File Utility Data Dat YPE Cer Read WitE oae kb Gade awed erita babe pied Array Indexes POS NUM ba 5 1 _
100. D A RETRACE BUFFER WAS DELETED MANY NONMOTION BLOCKS DEADLOCK INVALID WORD CHAMFER LENGTH RADIUS TOO LARGE G53 ON AN UNHOMED AXES MDI NOT ALLOWED DURING INTERRUPT MACRO INVALID THRESHOLD RATE ILLEGAL G CODE IN INTERRUPT MACRO 185 PROBE ERROR PROBE CYCLES CALCULATION ERROR 5190 PROBE CYCLES PROGRAMMING ERROR 190 5191 THREAD FEEDRATE TOO LARGE S 98 Publication 8520 6 6 August 1999 C 14 OCI Error Handling FIXED CYCLE ALREADY ACTIVE 610 NOT ALLOWED DURING CYCLE STOOLRADUS TOOLARGE TOOL RADIUS TOO LARGE POCKET MILLING SHAPE IS INVALID D WORD IS GREATER THAN TOOL DIA TOOL OFFSET CHANGES NOT ALLOWED MISSING Q WORD MISSING L WORD 215 CYCLE ALREADY ACTIVE NOT ALLOWED FROM POCKET END NOT SAME AS START ILLEGAL G CODE IN POCKET TOOL RADIUS TOO SMALL FOR POCKET SIZE 225 5226 PLUNGE NOT ALLOWED MISSING OR ILLEGAL L VALUE so Publication 8520 6 6 August 1999 Error Handling 15 MISSING CODE MISSING DATA FROM BLOCK VIRTUAUREAL AXIS NAME CONFLICT AXIS AMPED AS NON SCALING AXIS 5238 SCALING INVALID DURING POLAR 5239 INVALID FIXED DRILLING AXIS ILLEGAL CODE DURING VIRTUAL 240 ILLEGAL CODE DURING G41 G42 5242 OVER SPEED IN POCKET CYCLE 5243 INVALID CYCLE PROFILE 5245 ALL DUAL AXES ARE PARKED 245
101. Data to communicate with the OCI DDE data server with considerably higher performance than standard DDE communications provide To install the RSData Custom OCX and the RSJunctionBox DDE communications module follow the instructions that accompanied these Rockwell Software products Source Code Directory The Basic Display Set pulls data from a variety of subdirectories Structure created during the setup of both the Basic Display Set executable and source code This directory structure must be maintained to properly compile the source code These subdirectories of the source code are as follows This Directory Contains this Data This is the main source code directory All other ABOCI or directories in this table are subdirectories of ABOCI ab9pc or ab9PC This directory contains the main Visual Basic project manager ABOCI VBP ABOCIBAS Basic routines commonly used by different forms in ab9pc BAS the Basic Display Set Contains the text files for softkey names error ABOCIDAT or messages and screen text Note files exist in this ab9pc DAT directory for each of the supported 9 Series languages ABOCHFIL or Contains data for the Allen Bradley part program ab9pc FIL editor ABOCI FRM or Forms used to generate the Basic Display Set ab9pc FRM screens a ds m Graphics files used by the Visual Basic application Publication 8520 6 6 August 1999 3 4 Basic Display Set BDS Publication 8520 6 6 August 1999 D
102. E MAX VOLTAG E A 17 SPINDLE MOTOR TYPE A 17 SPINDLE NUM Index SPINDLE SPEED VALUE SYNC SPINDLE SKEW A 17 SR NUMS BAS START SERIAL IO MONITOR STOP AXISCAL STOP QUICK CHECK STOP SERIAL IO MONITOR STORE OEM MESSAGE Strings filename Publication 8520 6 6 August 1999 20 Publication 8520 6 6 August 1999 text 6 20 SUB PROGRAM REPEAT COUNT A 12 Subroutines APromptPressed ASoftkeyPressed CreateDataLinks DisplayRows Form_Activate Form Unload InitForm InitformLevel variables LoadScreenForm 3 19 recommended using CNCCommand Syntax filename string 6 19 for commnads text strings SYNTAX QUICK CHECK 5 53 B 5 B 6 System Form source code System Information Data ESTOP STATE NUM PROCESS VELOCITY GAINS FROM TABLE 4 63 System Messages display on system form SYSTEM SCAN TIME A 2 SYSTEM STATE Enumeration SYTEM STATE A 8 T WORD A 9 TARGET DIR Enumeration 6 18 Template MASTER FRM Text changing softkeys language bas Text Find Utility Text Search TEXT STRING THREADING PULLOUT ANGLE A 6 THREADING PULLOUT DISTANCE A 6 TIME 4 39 A 8 TM ACCUMULATED LIFE A 14 TM ACTIVE ENTRY A 14 TM ACTIVE TOOL A 14 TM ACTIVE TOOL GROUP A 14 TM CUTTER NUM A 14 TM DELETE ALL TM DELETE GROUP 5 56 B 5 B 7 TM DELETE TOOL TM ENTRY NUM A 15 TM EXPECTED LIFE A 15 TM GRAPHICS
103. E PART PROGRAM SEARCH and the SET PART PROGRAM SEARCH PATTERN commands EXECUTE PART PROGRAM SEARCH Search Method After you have entered a search mode use this command to execute part program search The search method argument is an enumeration that identifies the direction of the search operation the control is to perform The enumerations are as follows Enumeration Result 1 Forward 2 Reverse 3 Top of Program 4 Cancel 5 Exit Search For example EXECUTE PART PROGRAM SEARCH 1 1 executes the search in the forward direction This command typically follows the ENTER PART PROGRAM SEARCH MODE and the SET PART PROGRAM SEARCH PATTERN commands This search operation is performed on the active part program RENAME PART PROGRAM src filename string dest filename string This command is used to rename a program that already exists in the specified directory The filename string format is given on page 6 19 and includes specific directory information Note the destination file directory and the source file directory must be the same You can not use this command as a method of moving files from drive to drive Format for the arguments is source filename followed by destination filename For example RENAME PART PROGRAM MAIND SOURCE PPG MAIND DESTINATION PPG renames the program called source ppg to destination ppg in the main CNC directory
104. ED VALUE 6 Feedrate Data F1 DIGIT FEEDRATE FEED CLAMPED FEED MODE FEED MODE DISPLAY A 5 FEED VALUE A 6 FG CRITICAL AVERAGE A 10 FG CRITICAL MAX A 10 FG TOTAL AVERAGE A 10 FG TOTAL MAX A 10 FILE _ 17 12 Filename String FINE SCAN TIME MAX A 11 Fixed Cycles BACK BORING SHIFT DIRECTION DRILLING CLEARANCE AMOUNT 6 DRILLING RETRACT AMOUNT THREADING PULLOUT ANGLE THREADING PULLOUT DISTANCE Focus LoadScreenForm 3 19 FOLLOWING ERROR Font Size global bas Foreground WatchLists FOREGROUND LOGIC TIME FOREGROUND LOGIC TIME 11 Form load unload subroutine 3 10 Form Master MASTER FRM Forms defining new text 3 20 for source code French language bas printing text Frequency of Update See AMP reference manual Functions recommended with master FW REVISION G G and M Code Status G CODE STATUS 6 G GROUP PROGRAMMED M CODE STATUS A 6 M GROUP PROGRAMMED A 6 NUM G GROUPS A 6 NUM M GROUPS SECONDARY AUX WORD 6 G code data file G CODE STATUS 4 6 G GROUP PROGRAMMED G MODAL GROUP Index G54 WORK COORD A 18 G54 WORK COORD UNITS 18 Index 1 9 955 WORK COORD A 18 G55 WORK COORD UNITS A 18 G56 WORK COORD UNITS A 18 G57 WORK COORD A 18 G57 WORK COORD UNITS A 18 G58 WORK COORD A 18 G58 WORK COORD UNITS A 18 G59 WORK COORD A 18 G59 WORK COORD UNITS A 18 G591 WORK COORD A 18 G59
105. EEL SPEED Maximum wheel speed RPM li MIN WHEEL DIAMETER 26 62 68 67 65 66 69 6 6 7 3 Minimum wheel diameter NEW WHEEL DIAMETER New wheel diameter WARNING WHEEL DIAMETER 1 1 1 1 1 Warning wheel diameter 1 1 3 3 3 ESTOP_STATE 0 control in E STOP USINT 1 control out of E STOP 318 IFP_COPY_CANCEL A write parameter to cancel copy in progress UINT J DOWNLOAD IN PROGRESS Downloading AMP PAL status INT enumerated Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De grees Inch Met ric De Inch Met ric De Publication 8520 6 6 August 1999 mw R W Grinder All Controls All Controls All Controls All Controls All Controls All Controls All Controls All Controls All Controls All Controls ary er s s s s RIW RIW 8 Data Items ee P DD YE Dependency Proc CS n Acos Fas YY E E p Sar num processes UNT 313 NUM PROG AXES Number of programmable axes in the system UINT Both Controls incl duals ul NUM PROG AXES PLUS SKEWSLAVES Number of prog axes plus deskew slaves in UINT Controls system re Mess p ks m e oem messas sm o e nw pe orn setecteo
106. ENERIC LEVEL 2 15 PAL RS232 COMM 16 GRECO MINIFILE 17 INTELLIGENT DEVICE Important Enumeration does not apply to the 9 PC CNC PORT PROTOCOL enumeration The port protocol enumeration is used to select the protocol used for one of the serial communication ports The enumeration are Enumeration Result 0 Raw 1 Level 1 2 Level 2 3 DF1 4 Level 2 Important Enumeration does not apply to the 9 CNC Array Indices Strings 6 15 PORT STOP BITS enumeration The port stop bits enumeration is used to determine the number of stop bits used for communication on one of the serial communication ports The enumeration are Enumeration Result 0 1 bit 1 1 5 bits 2 2 bits Important Enumeration does not apply to the 9 PC CNC PORT TAPE MULTI enumeration The port tape multi enumeration is used to determine if a tape being read written to the serial port contains multiple programs on the same tape The enumeration are Enumeration Result 0 No one program per tape 1 Yes multiple program tape 2 N A Important Enumeration does not apply to the 9 PC CNC PORT TIMEOUT VALUE enumeration The port timeout value enumeration is used to select the timeout period for failure to make maintain serial communications though one of the serial ports the enumeration are Enumeration Result 3 Seconds 15 Seconds 30 Seconds 60 Seconds 120 Seconds 180 Seconds 300 Second
107. ENGTH_GEOM_ Tool Length Geometry Offset LREAL Both 2 Offset Num Num Inch Met TOOL ENTRY UN Yes R W Lathe Mill OFFSETS Axes ric De ITS Tool number grees TOOL LENGTH WEAR _ Tool Length Wear Offset LREAL Both 2 Offset Num Num Inch Met TOOL ENTRY UN Yes R W Lathe Mill OFFSETS Axes ric De ITS Tool number grees TOOL ORIENTATION Tool Orientation Direction INT Both fa Ye RW Lathe Grinder TOOL RADIUS GEOM _ Tool Radius Geometry Offset LREAL Both Offset Num Inch Met TOOL ENTRY UN Yes R W Lathe Mill OFFSETS ric De ITS Tool number grees TOOL RADIUS WEAR Tool Radius Wear Offset LREAL Both Offset Num Inch Met TOOL ENTRY UN Yes R W Lathe Mill OFFSETS ric De ITS Tool number grees WHEEL GEOM OFFSETS Wheel Geometry Offset LREAL Both 2 Offset Num Num Inch Met TOOL ENTRY UN R W Grinder Axes ric De ITS Tool number grees Operating Mode Ec PAL s Ye R aeaea bm R Ae _ AS NODE em o v umo PAUlogcDaa OCO O LE qp E Prot 1 54 Prot System defined PAL globals variables UINT Both PAL PAL All Controls Spec Prot BLOCK TRANSFER READ DATA Block transfer read data ARST INT MAX BLOCK TRANSFER XLI All Controls BLOCK TRANSFER WRITE DATA Block transfer write data AWST INT on BLOCK TRAN
108. ER Miscellaneous CALCULATE B 2 CANCEL MESSAGE B 2 CLEAR ACTIVE ERRORS HE cuc eae CLEAR DEBUG MONITOR B 2 CLEAR ERROR LOG IES CLEAR POWER ON TIME OVERALL CLEAR RUNTIME B 3 INPUT MDI STRING RELINQUISH CONTROL REQUEST CONTROL B 3 RESET MAX TIMES STORE OEM MESSAGE B 3 Miscellaneous Commands CALCULATE Publication 8520 6 6 August 1999 Publication 8520 6 6 August 1999 CANCEL MESSAGE 5 21 CLEAR ACTIVE ERRORS CLEAR CYCLE TIME CLEAR ERROR LOG CLEAR POWER ON TIME OVERALL CLEAR RUNTIME CLEAR WORKPIECES CUT OVERALL 5 22 STRING REFORMAT MEMORY RELINQUISH CONTROL REQUEST CONTROL RESET MAX TIMES STORE OEM MESSAGE Miscellaneous Data COPYRIGHT DATE DATE 4 39 s FW_REVISION PROCESS CHANGE REQUEST 4 40 PROCESS NAMES PRODUCT ID SERVO FW REVISION 4 42 TIME Miscellaneous System Informaiton SYSTEM STATE 8 TIME 8 Miscellaneous System Information BOOT_FW_REVISION CALCULATION_RESULTS CONTROLLING_OCI COPYRIGHT DATE 7 DATASCOPE_DATA DATE ESTOP STATE FW REVISION IFP COPY CANCEL MACHINE TYPE NUM OPTIONS NUM PROCESSES NUM PROG AXES NUM PROG AXES PLUS SKEWSLAV ES A 8 OEM_MESSAGE 3 OPTION_SELECTED OPTION_SLOT_NAME 1 OPTION_SLOT_NAME 2 OPTION SLOT REV 1 OPTION SLOT REV 2 PROCESS CHANGE REQUEST A 8 PROCESS NAMES A 8 PRODUCT_ID A 8 SERV
109. For example if the main directory has three part programs in it O123456 DRVSHAFT RRIGHT47 0123456 would be program one DRVSHAFT would be program 2 and RRIGHT47 would be program 3 The maximum size of this array index is dependent on the number of programs in the directory For example the data item FILE_NAME which returns a string of the part program name uses this array index to determine which program name you want Note this data item also uses the NUM_CNC_DIRECTORIES array index Format is FILE_NAME NUM_CNC_DIRECTORIES NUM_PP_FILES FILE _NAME 1 3 returns the STRING of RRIGHT47 assuming RRIGHT47 is the third program in the main part program directory Part programs are stored in alphabetical order in the CNC directories Publication 8520 6 6 August 1999 4 8 Data Server Data Items Control Type Publication 8520 6 6 August 1999 OFFSET_NUM This array index is dimensioned in AMP as the maximum number of tool offsets allowed on your system TOOL_NUM This array index is dimensioned in AMP as the maximum number of tool numbers allowed on your system The Control Type attribute indicates the application s for which a particular data item can be used either Mill e athe e Grinder Important Grinder type control is not available for Release 1 of the 9 PC The entire dual processing system is not available for Release 1 of the 9 PC CNC The single processing
110. HABLE_AMP_PARAMETERS is 299 it indicates that the patch AMP numbers range from 1 to 299 Use this to identify the range for the patchAMP_num argument for the items AMP_PARAMETER_NUMBER and AMP_PARAMETER_DATA_TYPE Publication 8520 6 6 August 1999 4 18 Data Server Data Items Axis Calibration Data Items Publication 8520 6 6 August 1999 AXISCAL ABS POS point num axis num Data Type LREAL Read Write Read only Array Index point_number axis_number Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC The ABS POS item is used to read back the absolute point locations from the axis calibration table This item is read only Data points are added or removed using axis calibration command items Indexes for this item include point num this index identifies which point you are referencing Refer to your AMP reference manual for details You can address multiple points with one command An error is returned if a point is requested that does not exist for the specified axis Use this item in conjunction with AXISCAL POINTS USED axis num this index identifies the logical axis number for which you are requesting axis calibration data Axis numbers are determined by your AMP configuration You can only make requests for one axis at a time Use the axis number in this request Axis names are not valid AXISCAL ABS POS 1 34 1 returns axis cal
111. HARACTERS MUST FOLLOW WILDCARD NO CHARACTERS ENTERED FOR SYMBOL SKIPPING EXCLUDED SOURCE MODULE S NEED SHADOW RAM FOR ONLINE SEARCH 170 PAULOGIC PAGE WAITING EXIT MONITOR 6145 6147 6148 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6162 6163 6165 6167 6168 6170 6171 6172 6173 6174 Publication 8520 6 6 August 1999 Error Handling C 23 REQUIRES AT LEAST TWO AXES PAL LOGIC SOURCE REV MISMATCH CANT MONITOR HARD STOP DETECTION ERROR 6180 HARD STOP ACTIVATION ERROR 180 HARD STOP DIRECTION ERROR HARD STOP EXCESS ERROR 6183 ADAPTIVE FEED MAX LIMIT ADAPTIVE FEED MIN LIMIT 6185 AXIS IS HARD STOPPED CANT ADJUST SERVO 185 6186 NO OFFSET ACTIVE OFFSET MOTION PENDING ON CYCLE START SERIAL PORT IN USE SERIAL COMMUNICATIONS ERROR 2 SERIAL COMMUNICATIONS ERROR 3 CANNOT UPLOAD PAL LOGIC SOURCE NOT LOADED ILLEGAL COMMAND FROM ODS INVALID FILE TYPE ILLEGAL CONTROL TYPE 10 7010 021005 amp 9 SERIES REVISIONS DIFFER CANNOT UPLOAD PAL LOGIC NOT IN PROM 021PAL LOGIC PROM CHECKSUM ERROR 7014 AMP FILE SIZE ERROR 7015 SERIAL COMMUNICATIONS ERROR 4 ILLEGAL FILENAME 7020 7021 CHECKSUM ERROR IN FILE 20 PORT IS BUSY REQUEST DENIED DATA MAY BE OUTPUT TO PRINTER ONLY INSUFFICIENT MEMORY FOR PART PROGRAM TIME OUT OCCURED WHILE WAITING FOR INPUT Publication 8520 6 6
112. ICE 47 4 SET PART PROGRAM SEARCH PATTE RN 5 47 B 4 B 6 SetSPDPointer to call screens 3 19 Setup Menu activating SETUP BUFFERS Index Single process Only SINGLE TX SERIAL 10 Size Watchlist buffer 4 11 SK NUMS BAS SKEW SLAVE ABSOLUTE POSITION i Sofkteys exiting editor 3 18 Softkey action CASE statement Softkey Constants PR_Nums bas Softkey Editor Utility Softkey Names SK NUMS bas Softkeys adding changing adding new rows 3 16 ASoftkeyPressed subroutine 3 10 changing text printing pointers printing tree row pointer saving changes source code softkey form SPD PTR SOFTKEYS BAS Software required to edit BDS 3 1 Software Options Opt nums bas Source Code basic modules 1 19 BDS overview directory display form installing master frm 3 8 overview PAL message form softkey form system form SPJA 11 SP Paramacro Variable Spanish minina a LEZA printing text SPD Pointer File source code SPD ABL Pointer source code SPD_Pointers printing SPD_PTR current softkey row SPIN_SPD_VALUE Spindle Data CONTROLLING _SPINDLE_NUM 4 60 TO NUM_SPINDLES 4 60 A 17 S WORD 4 61 17 SPINDLE DAC COMMAND SPINDLE GEAR RANGE MAX VOLTA GE A 17 SPINDLE MOTOR TYPE 4 61 A 17 SPINDLE SPEED VALUE SYNC SPINDLE SKEW SPINDLE DAC COMMAND 60 4 61 A 17 SPINDLE GEAR RANG
113. INT enumerated Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to identify the CNC hardware platform connected to your OCI station The value returned for this product ID is enumerated as follows Enumeration Result 9 9 260 Lathe Mill 10 9 260 Grinder 1 11 9 290 Lathe Mill 12 9 290 Grinder 15 9 260 Multi Process 17 9 290 Multi Process 22 9 PC Lathe Mill 1 Grinder Control Type is not available for the 9 PC Important Dual process systems are not available for the 9 PC Data Server Data Items 4 41 FW REVISION Data Type DINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This double word provides the revision of the system executive as a 32 bit word The upper 16 bits indicate the major and minor revisions The lower 16 bits indicate the an internal Allen Bradley software revision that you should ignore For example for firmware revision 11 00 you would be returned the decimal integer 720896048 or in HEX 2AF8 0030 The lower 16 bits is the internal revision The upper 16 bits is the major revision 11000 11 00 PROCESS NAMES Data Type String Read Write Read only Array Index none Control Type Lathe Mill dual process only The PROCESS_NAMES data item
114. InactiveParts is not a documented feature of JBox you will not find it in any property sheet or attribute of a JBox control We used this feature by first making the declaration Declare Sub JBoxDestroyInactiveParts Lib RSJBOX32 dll bDestroyInactive as Long Publication 8520 6 6 August 1999 Than calling the function in the mainMDI form Load routine JBoxDestroyInactiveParts True Important This function call must be made only after the first RSData link data item is placed as an Automatic Item in the watch list OCI Basic Display Set Source Code Routines The OCI basic display set source code contains many useful subroutines that will make data retrieval command requests and data formatting simpler Refer to page for details on this source code and its subroutines Printing functions and debugging routines are also available in this source code Chapter 2 DDE Data Server Examples DDE Conversation This chapter assumes you have Overview Already installed your 9 Series 9 PC OCI software on your machine Configured your INI files properly OCI 9 Series only e Configured your 9 PC via the 9 PC Configuration Manager Made proper Ethernet connections with your 9 Series only Run your OCI data server without errors e Confirmed your communication is working for OCI by using the OCI testing tool refer to your 9 Series OCI Installation Manual for information about parsercl exe and for 9 PC by using
115. NOT MADE IN BUFFERED BLOCKS 5018 CIRCULAR PROGRAMMING ERROR 5019 ILLEGAL VALUE 5020 DECIMAL POINT NOT ALLOWED 20 ILLEGAL CHARACTER 022 ILLEGAL G CODE 5023 4 SIGN ERROR BLOCK LENGTH ERROR 5025 NEGATIVE VALUE NOT ALLOWED 5026 NUMERIC VALUE MISSING 5027 PARENTHESIS INPUT ERROR 5028 ENTRY OUT OF RANGE 5029 RADIUS TOO SMALL NO FEEDRATE PROGRAMMED 846 CALLED 7300 PATTERN NAME IS BAD notused _ TOO MANY MACRO CALLS GOTO SEQ NUMBER NOT FOUND 40 MISSING DO COMMAND INVALID END COMMAND NUMBER 4 OVERTRAVEL PROGRAM ERROR OVERTRAVEL PROGRAM ERROR Publication 8520 6 6 August 1999 C 10 OCI Error Handling ZONE 2 PROGRAM ERROR ZONE 3 PROGRAM ERROR DO RANGES INTERSECT 5058 MISSING GOTO COMMAND ERROR LOOKING FOR END COMMAND MISSING END COMMAND 60 DO NUMBER ALREADY USED 5062 INVALID OFFSET NUMBER 5063 INVALID TOOL TABLE TYPE 5064 INVALID T CODE FORMAT CANCEL REMOVE OFFSET BEFORE AXIS CHANGE 5066 INVALID TOOL AXIS 5068 INVALID G10 CODE INVALID PARAMETER NUMBER CANNOT READ A WRITE ONLY PARAMETER MANY I J K SETS PARAMETER ASIGNWENT SYNTAKERROR i sys GONOTALLOWEDINGROULAR Eos BAD STATETTOKEN COWBINATION PROGAMER Publication 8520 6 6 August 1999 Error Handling C 11 5084 RIGHT OPERAND MUST BE POSITIVE 5085 MULTIPLE FUNCTIONS NOW
116. O FW REVISION 8 MODE ACTIVE Enumeration MODE FEED Enumeration MODE INCH METRIC Enumeration MODIFYING AMP MsgBox to report errors 3 26 Multiprocess for commands selecting for commands selecting for data items Multiprocess Systems data items for N N WORD A 14 Network loading 4 11 NEW WHEEL DIAMETER A 7 NEXT AXISCAL AXIS B 1 Notify Link Type 4 10 NUM 1394 RACKS A 15 NUM AMP PARAMETERS A 14 NUM AXES A 15 NUM CHANNELS Index NUM CHDS Index 6 1 ea Index NUM COM2A PARAMS Index NUM_DEVICES Index NUM_DISP_LINES index NUM_FEATURES Index NUM FILES NUM G GROUPS 6 NUM M GROUPS A 6 NUM MESSAGE GROUPS A 4 NUM MONITORED SERVOS A 15 NUM MSGS Index NUM OEM MSGS Index NUM OPTION SLOTS Index NUM OPTIONS A 8 NUM PATCHABLE AMP PARAMETERS A 2 NUM PATCHAPBLE AMP PARAMETERS NUM POCKETS A 14 NUM_PP_FILES Index NUM_PROCESS NUM_PROCESSES A 8 NUM PROG AXES A 8 NUM PROG AXES PLUS EXTRA A 15 NUM PROG AXES PLUS SKEWSLAVES TA 8 NUM RING DEVICES A 11 NUM SERVOS A 15 NUM SERVOS MODULES A 15 NUM SERVOS PLUS SPINDLES 15 NUM SETUP BUFFERS A 14 NUM SKEWSLAVES A 15 NUM SPINDLES NUM TOOLS A 9 NUM VIRTUAL NAMES Index Number screen pointer 3 17 OCI commands overview overview Watchlist OCI Basic Display Set installing source OCI Data Server defined OCI Source Code See BDS OCX RSData in s
117. PE A 2 PARAMETER NUMBER AMPED FINE SCAN 17 AMPED TOOL LENGTH AXIS LOGICAL BIT PATTERN AMPED TOOL LENGTH DRILLING AXIS _LOGICAL_BIT_PATTERN A 8 ANGLED_WHEEL_ALLOWED A 15 API Data Items Application Name Arguments for commands Array Index See Index Array Indexes Automatic Items errors from Automatic Link Type AUX_COM_ABORT_COMMAND AUX COM BACKUP CONFIG TABLE 5 15 2 AUX CMD FWD_SEARCH 8 2 AUX REV SEARCH AUX CMDTBL FROM FLASH AUX COM CMDTBL TO FLASH B 2 AUX COM CNC FILENAME AUX COM CNC SYMBOL AUX COM COMMAND A 4 AUX COM CONFIG FROM FLASH 822 AUX COM CONFIG TO FLASH AUX COM CURRENT CONFIG NUM AUX COM DOWNLOAD FILE AUX COM HOST CHANNEL NUM A 4 AUX COM HOST FROM FLASH AUX COM HOST REMNODE ADDR 4 AUX COM HOST WRITE TO FLASH 5 17 B 2 AUX COM NUM SYMBOLS A 4 AUX COM OUTPUT FORMAT A 4 AUX COM REM STATION TYPE Enumeration AUX COM REMOTE FILENAME AUX s 5 AUX COM REMOTE STATION TYPE AUX COM REMOTE SYMBOL A 5 AUX COM SEARCH TYPE Enumeration AUX COM SEND COMMAND PACKET AUX COM SEND COMMAND STATUS AUX COM SENDCMD AUX CONFIG BAUD RATE 5 AUX CONFIG CHANNEL AUX CONFIG CHANNEL A 5 AUX CONFIG FILE PID A 5 CONFIG FILE TIMEOUT 5 AUX CONFIG KEYBOARD PID A 5 AUX CONFIG PACKET TIMEOUT A 5 AUX CONFIG SERIAL DATA LENGTH AUX
118. Position Data Items 4 56 Spindle Data 4 59 System Information Data Items 4 62 Zones and Overtravels 4 63 Chapter 5 OCI Data Server CNC Commands CNC Command Overview Command Return Codes Selecting the 5 Command Syntax Commands MODIFYING no argument 5 4 RESTORE argument 5 4 TRANSFER FROM PORTA argument 5 4 TRANSFER FROM PORTB no argument 5 5 TRANSFER TO PORTA no argument 5 5 TRANSFER TO PORTB no argument 5 6 TRANSFER HOMECAL TO PORTA no argument 5 6 TRANSFER HOMECAL TO PORTB no argument 5 7 TRANSFER REVERSAL ERROR TO PORTA no argument 5 7 TRANSFER REVERSAL ERROR TO PORTB no argument 5 8 UPDATE no argument 5 8 Axis Calibration 5 8 DELETE ALL AXISCAL POINTS no argument 5 9 DELETE AXISCAL POINT axis num axis cal point 5 9 ENTER AXISCAL MODIFY MODE no argument 5 9 EXIT
119. RAMMED SPINDLE UNAVAILABLE 5330 S CURVE CONFIGURATION ERROR 5331 ILLEGAL DATA IN ASYNCH MODE 5332 FIXED CYCLES NOT ALLOWED 5333 ILLEGAL PRE BLOCK REQUEST ILLEGAL POST BLOCK REQUEST 5335 ILLEGAL XFER INHIBIT REQUEST O1 O1 OT Gd GC GC CG GW GW S O O O CO NI O mm mw Publication 8520 6 6 August 1999 18 Error Handling 5336 NO TIME DEPENDENT MACRO IN G60 1 NO SOLID TAPPING IN G60 1 5338 POCKET CYCLES amp AMP PLANES INCOMPATIBLE 60001 ILLEGAL INPUT 6002 MEMORY FULL 6003 OPTION NOT INSTALLED POCKET IS PART OF CUSTOM TOOL 6005 CANNOT OPEN PROGRAM FOR WRITE 6006 CANNOT DELETE ALL PROGRAMS DUPLICATE PROGRAM 6008 PROGRAM NOT FOUND MISSING PROMPT DATA fort CNNOTFNDPAUOGOPAGE 7 DUPLICATEPROGRAMNAME 6013 DUPLICATE PROGRAM NAME PROGRAMS ARE DIFFERENT PROGRAMS ARE IDENTICAL 6020 CANNOT ASSIGN IN CURRENT MODE 20 021 ILLEGAL PASSWORD MUST ASSIGN TOOL NUMBER FIRST PASSWORD PROTECTED Publication 8520 6 6 August 1999 Error Handling 19 6033 MUST BE IN E STOP MUST BE IN MANUAL NOT ACTIVE SOFTKEY MTB TDECIMALPONTERRORT OOOO INVALID CHARACTER 043 MISSING PROGRAM NAME SYNTAX ERROR COMMA PROGRAM NAME TOO LONG CANNOT EDIT ACTIVE PROGRAM ERASE PROMPT 6048 IN
120. RI CHE CIEN Must be Key Edit Mode K Create New Softkey Pointer buttons 1 thru 6 2 If you haven t already entered text for this new softkey you are prompted for text for the softkey in the available languages Italiano EJEN pm Each of the text fields in the above screen writes data to a different softkey data file for each language The softkeys toggle through different languages each time the SWITCH LANG softkey is pressed After entering language text for your softkey in the appropriate languages press the OK button The softkey editor prompts you to add a Key or a Row select KEY if you entering softkey only that will not call another row of softkeys Note this key can still call a new screen Row select ROW if you are entering a softkey that is to call new or existing row of softkeys Inserting a New Screen OCI Basic Display Set BDS 3 17 4 After deciding if you entering key row you prompted to add a screen number If this softkey is to call a new form you should select Yes face Dirglan Set ADD THE SCFTEEY SCREEH HUMBER Screens for the Basic Display Set are called by softkey events When you add a new softkey using the softkey editor Create New Softkey Pointer you are prompted to add a screen number as shown above When you select yes to add the softkey screen numbe
121. RK_COORD_LABELS Work Coordinate System Information G58 WORK COORD A 18 WORK COORD LABELS A 19 WORKPIECES CUT AFTER RESET WORKPIECES CUT OVERALL A 12 WORKPIECES_REMAINING A 12 Write Example using Visual Basic Write Requests Write Read Property data items WRITE ERROR CODE A 4 Write2ErrorFile variable Writing Data Items poke 4 12 G57 WORK COORD UNITS Z ZERO ALL COM VALUES 8 8 5 Zones and Overtravels INTERF FIRST AXIS MINUS AREA 1 B INTERF FIRST AXIS MINUS AREA 2 T INTERF FIRST AXIS PLUS AREA 1 1 INTERF FIRST AXIS PLUS AREA 2 A 19 INTERF kirsa INTERF SECOND_AXIS_MINUS_AREA 2 A 19 INTERF SECOND AXIS PLUS AREA INTERF SECOND AXIS PLUS AREA ALSE INTERF TOOL NUM LIMIT2 LOWER LIMITS LIMIT2 UPPER LIMITS LIMIT3 LOWER LIMITS r LIMIT3 UPPER LIMITS 20 LOGICAL AXIS ZONE GROUP de Rockwell Automation Allen Bradley a Rockwell Automation Business has been helping its customers improve productivity and quality for more than 90 years We design manufacture and support a broad Allen Bradley range of automation products worldwide They include logic processors power and motion control devices operator interfaces sensors and a jud of software Rockwell is one of the world s leading technology companies Worldwide representation Argentina e Australia e Austria e Bahrain Be
122. ROGRAM SEARCH PATTERN 100 If the command ENTER PART PROGRAM SEARCH is set to N Search 1 the search will find program block number N100 If ENTER PART PROGRAM SEARCH MODE is set to string search 5 any text with the string 100 will be found Publication 8520 6 6 August 1999 5 48 Data Server Commands Publication 8520 6 6 August 1999 VERIFY PART PROGRAM 1 filename2 mode Use this command to perform a compare of two part programs that both reside in control memory you can not verify program on the hard drive with this command if you need to verify a part program from a peripheral see VERIFY WITH PORTA or PORTB Both the filenamel and filename2 strings are described on page These filename strings contain specific directory information The remaining argument with this command is the mode argument which is an enumeration used to identify that you want to perform the verification or test the command syntax test option will check the command syntax and in control memory to memory program checks will verify the programs exist The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute verify For example VERIFY PART PROGRAM MAIND FILE1 PPG MAIND FILEZ PPG 1 performs the verification of part programs to FILE in the controls main program directory Results of this command come back as an e
123. S Using MASTERM FRM Template to Create a Display Form Also include with the Basic Display Set source code are three forms used as templates to create the majority of the other display forms in this Visual Basic project These forms are found with the rest of the Basic Display Set forms in the FRM sub directory of your Basic Display Set source code We call these master forms They are MASTER FRM a highly comment form typically used for reference only when building other forms e MASTERO FRM use to build forms with no cursor movement MASTERM FRM use to build forms that require cursor movement The following section will walk you through the development of a screen using a MASTER FRM Tools Add Ins Help F ABYB Microsoft Visual Basic desig Ti File Edit View Publication 8520 6 6 August 1999 Master Form extended ink D ataf 1 3D False amp 00000000 0 None Master Form True True 13 Copy Pen D Solid Making a Copy of MASTER FRM Since the master forms are a good place to start for creating any additional screens in the Basic Display Set it is probably a good idea to use a copy of these forms instead of editing them directly This will always give you a clean starting point for any additional forms you need to create Basic Display Set BDS 3 9 To make of the MASTER FRM 1 Open a dummy Visual Ba
124. S NAME 4 4 A 15 AXIS NUM Index AXIS POSITION ABS A 13 AXIS POSITION DTG A 13 gt 1 3 AXIS POSITION PRG A 13 AXIS POSITION TAR A 13 AXIS PRESENT LOGICAL PATTER 4 56 15 7 AXIS RAD DIA MODE AXIS SKEW AMOUNT A 16 AXISCAL ABS POS AXISCAL MEAS DEV AMOUNT AXISCAL POINTS FREE AXISCAL POINTS USED AXISCAL STATUS AXISCAL TABLE TYPE A 3 B BACK BORING SHIFT DIRECTION BACK BORING SHIFT DIRECTION Enumeration Background Watchlists BACKUP ALL OFFSETS BACKUP ALL PARAMETERS BACKUP AMP BACKUP AXISCAL BACKUP COM1 PARAMETERS BACKUP COM2A PARAMETERS BACKUP COM2B PARAMETERS 5 37 4 5 BACKUP INTERF TABLE BACKUP RADIUS TABLE 5 28 B 3 BACKUP RANDOM TOOL 5 54 5 E E BACKUP SHARED PARAMETERS BACKUP TOOL GEOM BACKUP TOOL MANAGE BACKUP TOOL WEAR 5 29 B 3 BACKUP WHEEL GEOMETRY 5 30 BACKUP WORK COORD 52307823 Basic Modules source code Publication 8520 6 6 August 1999 1 4 Publication 8520 6 6 August 1999 Baud Rate See BDS ABE files ABG files ABL files ABM files basic modules DG code data file display form G code data file installing source code keyboard input main MDI form master form PAL message form PD pointers screen construction SCRNPOS file source code directory structure source code installation source code overview
125. SFER p ques Controls FG CRITICAL AVERAGE Critical Foreground Average UINT jc All Controls FG TOTAL AVERAGE Total Foreground Average UINT ue n Alconros FG TOTAL MAX Total Foreground Maximum UINT ue Alconros 192 MEMORY_DUMP_ADDRESS Memory dump start address DINT R W All Controls debug monitor Publication 8520 6 6 August 1999 298 99 2 Data Items 11 Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc 193 MEMORY DUMP DATA Memory dump data INT MEM DUMP SIZE All Controls debug monitor 190 PAL REVISION PAL Symbols Revision DINT Controls debug monitor 191 FREE SPACE Available Pool Memory DINT Both Bytes Controls debug monitor REMOTE INPUT DATA Remote I O input data RMI1 8 INT z 10 Controls REMOTE OUTPUT DATA Remote I O output data RMO1 8 INT IND IO Io MAX_REMOTE O fR R Al Controls 304 RING_IO_CARD_TYPE Output data from the ring device at the requested NUMBER_RING_DEVICES EUN position RING IO DEVICE ADDRESS Device address on the ring at the requested USINT MAX NUMBER RING DEVICES Controls position 302 RING IO DEVICE INPUT DATA Input data from the ring device at the requested USINT OCI MAX NUMBER RING DEVICES Controls posi
126. T a SERIAL IO MONITOR MODE 1 REPEAT TX SERIAL IO SAVE DEVICE SETUP 5 teo SINGLE TX SERIAL IO 5 20 START SERIAL IO MONITOR 5 20 STOP SERIAL 10 MONITOR 521 Communication Port Data HARDWARE STATUS PORTA e co HARDWARE STATUS PORTB INDEX UART MAX BAUD MODE LEVEL 2 STATUS PORTA 4 LEVEL 2 STATUS PORTB PORT AUTO FILENAME eT PORT BAUD RATE PORT COMMUNICATION FORMAT PORT DATA BITS PORT PARITY PORT PERCENT SELECTION PORT PROGRAM NAME PORT PROTOCOL 4 21 PORT REWIND ON M99 PORT REWINDE ON M02 M30 4 27 PORT STOP AT PROGRAM END PORT STOP BITS PORT TIMEOUT RX CHAR PORTE RX_CHAR_PORTB 1 30 Communication Port Parameters DEVICE 3 DEVICE ON 3 HARDWARE STATUS PORTB HARDWARE SUPPORT PORTA A 3 LEVEL 2 STATUS PORTA LEVEL 2 STATUS PORTB A 3 PORT AUTO FILENAME A 3 PORT BAUD RATE PORT COMMUNICATION FORMAT PORT DATA 3 PORT PARITY A 3 PORT PERCENT SELECTION 3 PORT PROGRAM 3 PORT PROTOCOL A PORT REWIND ON Tr 3 PORT REWIND ON M99 A i i A 3 PORT STOP PORT VALUE R53 3 PORT TYPE A RX CHAR PORAJA RX CHAR PORTB TX CHAR PORTB UART A BUSY STATUS UART B BUSY STATUS UART MAX BAUD MODE Communications ACTIVATE RIO PASSTHROUGH AU CON GOT COMMAND En AUX COM
127. T ID enumeration 6 16 ROTATION EXT STATUS enumeration 6 16 SCALING INDICATOR enumeration 6 16 SEARCH METHOD enumeration 6 17 SEARCH TYPE enumeration 6 17 SERVO STATUS enumeration 6 17 SYSTEM STATE enumeration 6 18 TARGET DIR enumeration 6 18 TM STATUS enumeration 6 18 TM GRAPHICS TOOL COLOR enumeration 6 19 UART BUSY STATUS enumeration MR M EEUU TEXT SIBING string 6 20 Error Handling Overview C 1 API Data Request Errors C 1 Command and Data Item POKE Errors C 1 Publication 8520 6 6 August 1999 Data Server Overview Chapter 1 Open Control Interface Overview This chapter contains an overview of the system and how it uses Windows DDE and RSLinx software to establish communications between the OCI data server and the 9 Series or 9 PC CNCs Once the OCI data server and RSLinx software for 9 Series CNCs have been configured and launched your DDE compliant application for example the OCI Basic Display Set can read and write data and execute commands on networked CNCs Your DDE compliant applications can access the data from the
128. T TIMEOUT VALUE PORT TIMEOUT VALUE Enumeration 6 15 PORT TYPE 4 22 3 PORT TYPE Enumeration 6 12 PORTA DEVICE Enumeration 6 13 PORTB DEVICE Enumeration Position Data AXIS PRESENT LOGICAL BIT PATTE RN 4 56 PLANE AXIS INDICES ROLLOVER AXIS LOGICAL BIT PATT ERN 4 57 ROTARY AXIS LOGICAL BIT PATTER N 4 58 SKEW SLAVE ABSOLUTE POSITION VIRTUAL FORMATS VIRTUAL NAMES Position Information AXIS FROMATS 131 AXIS FROMATS METRIC A 13 AXIS POSITION ABS AXIS POSITION DTG A 13 AXIS POSITION PRG A 13 AXIS POSITION 13 SKEW SLAVE ABSOLUTE POSITION A13 POSITION LOOP INIT GAIN POWER ON TIME AFTER RESET A 12 POWER ON TIME OVERALL A 12 PP SOURCE Enumeration 6 16 PR NUMS BAS Printing errors 3 22 prompts and pointers 3 22 softkeys and pointers 3 22 text and pointers PrintMenu Global Variable 3 22 PROBE APPROACH DISTANCE 13 PROBE APPROACH FEEDRATE A 13 PROBE ENTRY UNITS A 13 PROBE FEEDRATE A 14 PROBE LENGTH A 14 PROBE RADIUS A 14 PROBE TOLERANCE BAND A 14 Probing and Skip Cycles DEPTH PROBE FOLLOWING ERROR PROBE ENTRY UNITS A 13 PROBE FEEDRATE 14 PROBE LENGTH A 14 PROBE RADIUS PROBE TOLERANCE BAND A 14 Process selecting for commands selecting for data items setting for commands Process Select for data items 4 14 PROCESS CHANGE REQUEST PROCESS NAMES PRODUCT ID PROG ROT ANGLE A 13 Progr
129. TATUS 4 returns If this Group 4 M code is Active Returned Value G MODAL GROUP This array index is dimensioned by the valid G code modal groups You can find the G code modal groups range in G GROUPS an item Refer to your operation and programming manual for details on G codes and their respective modal groups For example the data item CODE STATUS which returns the active programmed G code number uses this array index to determine which modal group you are checking G CODE STATUS 4 returns If this group 4 G code is Active Returned Value Data Server Data Items 4 7 SETUP BUFFERS This array index is dimensioned by the currently available part program setup buffers This number is dependent on several factors including complexity of the current part program and number and type of features active at any given time This number will range from a minimum of 1 to a maximum of 21 For example the data item ACTIVE PART PROGRAM BLOCKS which allows you to identify blocks that have been read into the setup buffer uses this array index ACTIVE PART PROGRAM BLOCKS 2 NUM PP FILES This array index is dimensioned by the number of part programs currently in the directory Not to be confused with the part program name proceeded with the O word and often a number this integer value is the number in the directory of the program you want to investigate
130. TE PART PROGRAM 5 43 B 4 ENTER PART PROGRAM SEARCH M ODE 5 43 4 6 EXECUTE PART PROGRAM SEARCH 5 44 B 4 B 6 REFORMAT MEMORY B 4 B 6 RENAME PART PROGRAM B 4 B 6 RESTART PART PROGRAM SEQUENCE STOP PART PROGRAM 5 45 8 4 E 6 SET DIRECTORY 5 46 4 6 SET PART PROGRAM COMMENT E 5 47 B 4 B 6 SET_PART PROGRAM SEARCH_PATT ERN VERIFY PART PROGRAM E 38 VERIFY WITH PORTA 5 49 B 4 B 6 VERIFY WITH PORTB B 6 Part Program Directory Data AVAILABLE MEMORY FILE NAME NUM FILES PART PROGRAM COMMENT SELECTED PART PROGRAM DIR 4 52 Index 1 15 Part Program Directory Items ACTIVE PART PROGRAM A 11 ACTIVE SUB PROGRAM A 11 AVAILABLE MEMORY A 11 CYCLE TIME A 11 NUM FILES PART PROGRAM COMMENT 72 PART PROGRAM SOURCE POWER ON TIME AFTER RESET A 12 POWER ON _ 12 RUNTIME A 12 SELECTED PART PROGRAM DIR 1 SUB PROGRAM REPEAT COUNT T gt KPIECES CUT AFTER RESET 1 WORKPIECES CUT OVERALL WORKPIECES REMAINING ae wo gt N Part Program Editor directory location Part Program Execution ENTER_MIDSTART_SEARCH_MODE EXECUTE MIDSTART SEARCH SET MIDSTART SEARCH PATTERN STOP QUICK CHECK SYNTAX QUICK CHECK Part Program Execution Commands ENTER MIDSTART SEARCH MODE 6 EXECUTE MIDSTART SEARCH B 5 B 6 SET MIDSTART SEARCH PATTERN 6 STOP QUICK CHECK B 5 8 6 SYNTAX Q
131. TIME no argument This command is used to clear the runtime clock This clock records the time the control has spent actually executing part programs This feature is included on the time parts display of the Basic Display Set Refer to your operation and programming manual for details CLEAR WORKPIECES CUT OVERALL no argument Use this command to clear the overall workpieces cut counter This counter indicates how many times any part program has been run This feature is included on the time parts display of the Basic Display Set Refer to your operation and programming manual for details INPUT MDI STRING text string This command inputs a string as an MDI operation Once input a cycle start request will execute the MDI input For example INPUT MDI STRING G01X10Y10F1007 loads this part program block as the active block in MDI mode If loading multiple blocks include them in the same string separating each block with the end of block character Data Server Commands 5 23 REFORMAT MEMORY no arguments This command reformats the RAM disk on the CNC It will delete all part programs in both the main and protectable CNC directories It will not effect programs stored on the OCI stations hard drive Refer to your operation and programming manual for details on the reformat operation RELINQUISH CONTROL no argument Use this command to manage your system when multiple personal computers are running
132. TOO NANY AXES PROGRAME TOO MANY AXES PROGRAMMED RECIP AXIS NOT PROGRAMMED MASTER ONLY G CODE MUST PARK SLAVES 5258 INTEGRANDS NOT AMPED PROPERLY ILLEGAL M CODE 5263 QPP NOT ALLOWED DURING POLAR MODE O PO NINI N N N NI N 0j OT CT CT gt O N Publication 8520 6 6 August 1999 16 Error Handling ILLEGAL RECIPROCATION INTERVAL CHANNEL NAME TOO LONG INVALID CHANNEL 5275 INVALID REMOTE STATION TYPE 275 INVALID OUTPUT FORMAT INCORRECT NUMBER OF SYMBOLS INVALID DH COMMAND TYPE INVALID CCT INDEX CANNOT TAP IN CSS NEED SPINDLE FEEDBACK 844 TPALILOGIC AXIS STATUS CANNOT CHANGE INVALID WHEEL ANGLE ANGLED WHEEL NOT CONFIGURED 295 PLUNGE MOTION NOT PROGRAMMED Publication 8520 6 6 August 1999 Error Handling 17 VIRTUAL AXIS ALLOWED 300 AND G16 3 G16 4 CANNOT CONCURRENT WHEEL AXIS MOTION INVALID IN G16 3 G16 4 AXIS MOVER CONFLICT WITH G16 3 G16 4 SHIFT AWAY FROM ENDPOINT WORK CO ORD CHANGES NOT ALLOWED 305 G26 PLANE INCOMPATABILITY G26 NOT ALLOWED DEPTH PROBE AXIS NOT AMPED 925 NOT ALLOWED G24 PLANE INCOMPATABILITY 315 G24 NOT ALLOWED BAD FIRST POCKET BLOCK 320 T WORD NOT ALLOWED WITH M06 UNABLE TO SYNC IN CURRENT MODE SPINDLE MODES INCOMPATIBLE PROG
133. TOOL COLOR A 15 TM GRAPHICS TOOL COLOR Enumeration 6 19 TM GROUP NUM A 15 TM INSERT TOOL TM STATUS A 15 TM STATUS Enumeration 6 18 TM TOOL GROUP LIFE TYPE A 15 TM TOOL NUM A 15 TM TOOL OFFSET NUM A 15 TM TOOLS PER GROUP A 15 TM UPDATE IN PROGRESS A 15 Tool Management See TM Tool Management Random Tool ACTIVATE RANDOM TOOL 5 53 B 5 B 6 BACKUP RANDOM TOOL 5 54 5 BACKUP TOOL MANAGE 5 54 5 RT CUSTOMIZE TOOL 5 55 8 5 e TOOL ENTRY UNITS 9 TOOL LENGTH GEOM OFFSETS A 9 TOOL LENGTH WEAR OFFSETS A 10 TOOL NUM Index TOOL ORIENTATION A 10 TOOL RADIUS GEOM OFFSETS A 10 TOOL RADIUS WEAR OFFSETS A 10 Tools Required to edit Basic Display Set Topic Name 2 2 TORQUE 4 17 TORQUE OFFSET PERCENT A 17 TRANSFER AMP FROM PORTA TRANSFER AMP FROM PORTB TRANSFER AMP TO PORTA TRANSFER TO PORTE 5 6 B 1 TRANSFER AXISCAL FROM PORTA 5 12 B 1 B 2 TRANSFER AXISCAL FROM PORTB 5 13 1 TRANSFER AXISCAL TO PORTA TRANSFER AXISCAL TO PORT TRANSFER HOMECAL TO PORTA TRANSFER HOMECAL TO PORTB 578 1 TRANSFER PAL FROM PORTA B 3 TRANSFER PAL FROM TRANSFER PAL TO PORTA 5 34 B3 TRANSFER PAL TO PORT TRANSFER REVERSAL ERROR TO PO RTA TRANSFER REVERSAL ERROR TO PO 5 8 Tree Softkey Nums bas Two Process Systems 4 14 Two dimensional Arrays TX CHAR PORTB 3 U UART BUSY STATUS
134. TRANSFER PAL TO PORTB argument Use this command to back up the current PAL image and its source code if present on the control to a device connected to the control s port B This will back up the PAL image currently in RAM This may or may not be the same image stored in the control s backup memory For example TRANSFER PAL TO would write the PAL image to the device connected to the control s port B This backup file is not in a man readable format If you require a man readable version of PAL refer to the ODS document utility Use the command TRANSFER PAL FROM PORTB to retrieve an PAL image from a peripheral device Important This command does not apply to the 9 PC CNC BACKUP ALL PARAMETERS Filename string This command tells the control to create a backup program of the paramacro parameters COMI 100 199 COM2A 500 519 COM2B 520 999 and shared parameters for dual process systems 7100 7199 Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on pagd 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed
135. This file contains G code names and descriptions DGCODE DAT This file contains G code names and descriptions for dual process capability e SCRNPOS DAT This file is used for active G code status as well as storing the format of the display e PD ABG this file contains the PD pointers for grinder control types This file is an integral part of the 9 Series softkey tree structure This file is not supported by the 9 PC e PD ABL this file contains the PD pointers for mill and lathe control types This file is an integral part of the 9 5 or 9 PC softkey tree structure e SPD ABG this file contains the SPD pointers for grinder control types This file is an integral part of the 9 Series softkey tree structure This file is not supported by the 9 PC e SPD ABL this file contains the SPD pointers for mill and lathe control types This file is an integral part of the 9 5 or 9 PC softkey tree structure Basic Display Set BDS 3 5 Important Editing these text files should only be necessary when making minor name changes to screens or softkeys If your intent is to add additional information to screens or create new softkey levels we strongly recommend that you create your own text files Note if you update or upgrade your Basic Display Set source code these standard text files will be overwritten Basic Display Set Source The Basic Display Set was developed using Microsoft s Visual Basic Code Ov
136. UICK CHECK B 5 B 6 Part Program Rotation and Scaling CURRENT SCALE 12 DEAE te ACTORIS EXT ROT ANGLEJ A 12 a EXT ROT FIRST AXIS CENTER EXT ROT FIRST AXIS VECTOR EXT ROT SECOND AXIS EXT ROT SECOND AXIS CENTER EXT ROT SECOND AXIS VECTOR G CODE STATUS PROG ROT ANGLE Publication 8520 6 6 August 1999 Publication 8520 6 6 August 1999 SCALING CENTER 13 PART PROGRAM COMMENT 4 53 A 12 PART PROGRAM SOURCE A 12 Patch AMP writing PD Pointers source code PD ABL Pointer source code PD NUMS BAS PD Pointers printing Physical vs Logical Axes PLANE AXES INDICES A 19 PLANE AXIS INDICES Pointer adding screen 3 17 softkey rows 3 15 POKE 4 12 Example using Visual Basic inadvertently writing to critical data locations using Poke writing errors 3 26 PORT AUTO FILENAME PORT BAUD RATE PORT BAUD RATE Enumeration PORT COMM FORMAT Enumeration 6 11 PORT COMMUNICATION FORMAT PORT DATA BITS PORT DATA BITS Enumerations PORT ID Enumeration 6 16 PORT ID Enumerations 6 12 PORT PARITY PORT PARITY Enumeration 6 12 3 PORT PROGRAM PORT PROTOCOL 3 PORT PROTOCOL PORT PROTOCOL Enumeration PORT REWIND ON M02 03 3 PORT REWIND ON M02 M30 PORT REWIND ON M99 PORT STOP AT PROGRAM END A 3 PORT STOP BITS PORT STOP BITS Enumeration 6 15 PORT TAPE MULTI Enumeration 6 15 POR
137. UMQ3 1 would identify in the random tool table that tool number 3 is in tool changer pocket 1 TM DELETE ALL no argument Use this command to delete all the tool management groups For example TM DELETE ALL deletes all data in the tool management tables TM DELETE GROUP tool group num Use this command to delete all tools from a specified tool group The argument tool group num is the tool group number to delete For example DELETE GROUP 2 deletes all the tools in tool management tool group 2 Data Server Commands 5 57 TM DELETE TOOL tool group num entry num Use this command to delete a specific tool from a tool management group The two arguments for this command are tool group num the group the tool is currently assigned entry num the entry position of the tool to be deleted in the tool group For example TM DELETE TOOL 3 5 delete from tool group 3 the tool in the fifth position in that group TM INSERT TOOL tool group num tool num entry num Use this command to insert a tool into the a tool management group tool group num the group the tool is to be assigned tool num the tool number to be added to the group entry num the entry position in the tool management table for this entry A value of zero places it at the last entry in the table For example TM INSERT TOOL O 7 0 adds tool number 7 to the next open entry position in tool grou
138. VALID SHAFT CANNOT WRITE TO PROGRAM PROGRAM BLOCK TOO LONG 50 PAL LOGIC PAGE WAITING EXIT DISPLAY SELECT 6052 SEARCH STRING NOT FOUND 6053 MAXIMUM BLOCK NUMBER REACHED CANNOT DELETE OPEN PROGRAM CANNOT FORMAT OPEN PROGRAM CANNOT ACTIVATE OPEN PROGRAM MDI INPUT COMMAND TOO LONG PARITY ERROR IN PROGRAM 6068 ERROR ACCESSING PROGRAM 6064 SAVE COMPLETED 6065 DEFAULTS LOADED 6066 CURSORING NOT ALLOWED ILLEGAL AXIS DATA FORMAT 6068 ERROR IN CIRCLE DATA Publication 8520 6 6 August 1999 20 Error Handling 6069 TAN CIRCLE NOT IN 1ST BLOCK CIRCLE MID POINT NOT ENTERED 70 CREATING BACKUP FILE PLEASE WAIT PROGRAM ACTIVE PROGRAM BEING EDITED LOWER gt UPPER 6079 CANNOT REPLACE START POINT PALLOGIC PAGE WAITING SCREEN HAS PROMPT 80 Q D D O O O N O C1 ACTIVE OFFSET CAN NOT CHANGE CREATING TOOL MGMT FILE PLEASE WAIT INVALID TOOL GROUP INVALID THRESHOLD RATE 6098 MISSING TOOL ENTRY 6099 ACCUM AND EXPECTED LIFE ARE 0 6000 ACTIVE TOOL CANNOT BE DELETED 100 6101 ACTIVE GROUP CANNOT BE DELETED 6102 ACTIVE TOOL CANNOT BE CHANGED 6103 NO UNEXPIRED TOOL AVAILABLE 6104 CANNOT EDIT OPEN PROGRAM Publication 8520 6 6 August 1999 LL NNNM ms Error Handling C 21 6105 OPTIONAL FEATURE IS NOT PROVIDED 10
139. VATE RADIUS E TOOL RADIUS Activates tool radius ofset on mil tool radius offset on mill Tool Number DINT 18 a E_TOOL_WEAR ELIT NI tool wear offset Lathe Dual Lathe 22 ACTIVATE WHEEL GEOM E WHEEL_GEOM Activates wheel Activates wheel geometry offset offset Grinder pe al 7 Pei frp s me me 9 a pee n 28 BACKUP TOOL GEOM Backs up tool geometry offset to part program Lathe Mill Dual 27 BACKUP TOOL WEAR Backup tool wear offset to part program Lathe Mill Dual BACKUP WHEEL GEOMETRY Backs up grinder tool geometry table Grinder Bo 9 File Name STRING1 V uL P BACKUP WORK COORD Backs up work coordinate offset to part pro Controls STRING1 gram 120 COPY OFFSET Copies offset from source to destination for all Controls Yes Src Ax Name Dest STRING1 tools Name 21 MEASURE TOOL GEOM Measure tool geometry offset Lathe Dual pe we pee i Tool Number DINT DINT Desired Prog Pos LREAL Lathe MEASURE TOOL WEAR Measure tool wear offset Lathe Dual AE AEN Tool Number DINT DINT Desired Prog Pos LREAL Lathe 23 MEASURE WHEEL GEOM Measure wheel Measure wheel geometry offset offset jo No Tomum Number DN Aiso powr Desired Desired Prog Pos Pos LREAL PAL Commands Publication 8520 6 6 August 1999 Commands nm pcs DU iudi re ID Proc 54 TRANSFER PAL TO PORTB PAL an
140. WHEEL 3 ACTIVATE WHEEL RADIUS B 3 BACKUP ALL OFFSETS BACKUP INTERF TABLE B 3 BACKUP RADIUS TABLE B 3 BACKUP TOOL GEOM B 3 BACKUP TOOL WEAR Publication 8520 6 6 August 1999 Publication 8520 6 6 August 1999 BACKUP WHEEL 3 BACKUP WORK COORD COPY OFFSET B 3 MEASURE TOOL GEOM MEASURE TOOL WEAR B 3 MEASURE WHEEL GEOM OLE RSData custom Omission of Index Open Control Interface See OCI Operating Mode ACTIVE MODE A 10 ACTIVE SCALE INDICATOR ACTIVE UNITS 4 46 A 10 AXIS RAD DIA MODE 4 46 A 10 OPT NUMS BAS OPTION SELECTED 8 OPTION SELECTED INDICES Enumeration 6 10 OPTION SLOT NAME 1 8 OPTION SLOT NAME 2 A 8 OPTION SLOT REV 1 OPTION SLOT REV 2 A 8 Options NUMS bas Overview BDS screen construction BDS source code command requests error conditions OCI system RSLinx P PAL Commands TRANFER PAL FROM PORTA 5 TRANFER PAL PORTA 5 TRANSFER PAL _ FROM PORTA E 3 TRANSFER PAL FROM PORTB 5 34 B 3 TRANSFER PAL TO 2 TRANSFER PAL TO PORTB 5 35 PAL Data user defined globals 4 48 system flags 4 49 I O Variables BLOCK TRANSFER READ DATA BLOCK TRANSFER WRITE DATA FG CRITICAL AVERAGE A 10 FG CRITICAL MAX A 10 FG TOTAL AVERAGE A 10 RING 10 CARD TYPE A 1i RING 10 DEVICE ADDRESS A 117 RING 10 DEVICE INPUT DATATA f1 RING
141. a returned as a logical bit pattern Logical axis refers to the order that the axis are presented in the process For single process controls this is not much of an issue with the exception of spindles and virtual axes which are always stored as the last axes in the process Physical axis refers to the order in which the axes are created using the ODS AMP tool and are independent of the process the axes are assigned to Physical Axis Process Logical Axis Logical Axis Number order Assigned Process 1 Process 2 ANPed Axis 1 X Process 1 1 Axis 2 Y Process 1 2 Axs3 7 Process 1 3 Axis 4 U Shared 4 1 Axs5 A Process 2 2 Axs6 B Process 2 3 Axs7 Process 1 5 If looking at process 1 data item DRILLING_AXIS_LOGICAL_BIT_PATTERN 1 axis data would be returned in the bit pattern as X Y Z U C in the first five bits and for process 2 DRILLING AXIS LOGICAL PATTERN 2 axis data would be returned in the bit pattern as U A B in the first three bits Important Only single process is available for Release 1 of 9 PC Publication 8520 6 6 August 1999 4 16 Data Server Data Items AMP Parameter Data Items Publication 8520 6 6 August 1999 parameter num Data Type LREAL Read Write Read Write patch AMP only Read others Array Index none Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC Follow the symbol with the
142. allow the PC to identify a transition in this value in the event multiple commands execute on the CNC quickly To identify the actual error you must strip the most significant bit from this items value Strip this sign bit by anding the value returned by this item with 32767 7FFF The resulting value can be used in appendix C o identify the error The following table shows the value of Command Error after a request has been made to the CNC to execute three different commands the first of which is a bad command request the second and third executes successfully Value of Value after sign Indicates Command Error bit removed 0 0 Status OK 3000 3000 Executing Command 35786 3018 Bad Command Request 3000 3000 Executing Command 0 0 Status OK 3000 3000 Executing Command 8000 0 Status OK Publication 8520 6 6 August 1999 4 34 Data Server Data Items Publication 8520 6 6 August 1999 LINE 1 MESSAGE DATA error integer Data Type UDINT Read Write Read only Array Index error integer Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to pass the active line 1 error message from the CNC Refer to your operation and programming manual for details on line one active error messages If messages of the same priority are active this item will change between the different messages Ifa lower priority message is active it will not
143. ally does not occur PAL may request motion of an axis during a quick check operation Refer to your operation and programming manual for details on using QuickCheck and when QuickCheck requests are valid For example SYNTAX QUICK CHECK would place the control in QuickCheck mode Use the command STOP QUICK CHECK to disable the QuickCheck mode ACTIVATE RANDOM TOOL tool number pockets needed shaft pocket This command tells the control to look up characteristics for the specified tool active tool if it is to be used with the random tool feature Refer to your operation and programming manual for details on using the random tool feature There are three argument for this command They are tool number the tool number you are defining for the tool changer pockets needed the number of pockets required to hold this tool shaft pocket the pocket number that will contain the tool shaft If the tool covers more than one pocket enter which of the pockets that will contain the tool shaft here from 1 to the value entered for pockets needed For example ACTIVATE RANDOM TOOL 3 1 1 would activate random tool 3 which requires 1 pocket which is also the shaft pocket for the tool ACTIVATE RANDOM TOOL 3 2 would activate random tool 4 which requires three tool pockets with the shaft in the second pocket Publication 8520 6 6 August 1999 5 54 Data Server Commands Publication 8520
144. am Block Items ACTIVE PART PROGRAM BLOCKS WORD 14 NUM SETUP BUFFERS A 14 ProgramError Write Error 3 11 Project Visual Basic BDS source installation Prompt promptpressed subroutine 3 10 Prompt Search Prompts PR Nums bas text find utility R RACK 1394 SERCOS ADDRESS 16 RACK 1394 AXIS MODULE ERRORS RACK 1394 BOARD NUMBER RACK 1394 SYSTEM MODULE HW RE VISION Random Tool See RT Random Tool and Tool Life E NUDO ACTIVE RANDOM TOOL NUM A 14 ACTIVE RANDOM TOOL NUM POCK ETS A 14 A 13 DEPTH PROBE POSITION A 13 PROBE APPROACH DISTANCE A 13 PROBE APPROACH FEEDRATE A 13 Index 1 17 ACTIVE RANDOM TOOL SHAFT KET A 14 NUM AMP PARAMETERS A 14 NUM POCKETS A 14 RT POCKETS NEEDED RT POCKET A 14 RT TOOL NUM TM ACCUMULATED TM ACTIVE ENTRY A 14 TM ACTIVE 14 TM ACTIVE TOOL _ TM_CUTTER_COMP_ TM ENTRY TM EXPECTED LIFE AT TM_GRAPHICS TOOL STATUS TM TOOL GROUP _TYPE A 15 TM_TOOL_NUM TM TOOL OFFSET TM TOOLS PER 15 TM UPDATE IN PROGRESS Read Example using Visual Basic Read Requests Read Write property data items REFORMAT MEMORY 5 23 B 4 B 6 RELINQUISH CONTROL REMOTE INPUT DATA A 11 REMOTE OUTPUT DATA A 11 RENAME PART PROGRAM REPEAT TX SERIAL IO REPLACE AXISCAL VALUE 5
145. are available for Release 1 of the 9 PC NUM SPINDLES Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to identify the number of spindles currently configured on the CNC This data item returns an integer ranging from 1 to 3 spindles on the 9 Series and from 1 to 2 spindles on the 9 PC SPINDLE DAC COMMAND spindle num Data Type INT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to retrieve the current DAC output command for any given spindle The spindle_num index is the number of the spindle to monitor as configured in AMP 1 3 for 9 Series or 1 2 for 9 PC This item is only valid for spindles using an analog output A value of 4096 is equal to the max output of 10Volts A returned value of zero is zero volts SPINDLE MOTOR TYPE spindle num Data Type UINT enumerated Read Write Read only Array Index spindle num Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Publication 8520 6 6 August 1999 Data Server Data Items 4 61 The SPINDLE MOTOR TYPE data item is used to identify the motor commutation of the spindle spindle num configured in AMP The maximum allowable value fo
146. ata Files Data files are found in the ABOCI DAT ab9PC DAT directory and contain data that is used by the Basic Display Set to build 9 Series or 9 PC displays There are several different types of data files Each file is duplicated for the different languages supported by the control Most of these files are not standard ASCII text files You should not attempt to edit these files using an ASCII text editor We recommend using the text editor utilities provided with the Basic Display Set source code and discussed later in this chapter language ABM These data files contain the text for standard system and error messages The control sends a numeric error code when an error occurs which 15 then identified by the Visual Basic code as a specific line of text in this file In addition to this error message text the coded error message can also contain axis and direction information which is also decoded by the Basic Display Set executable e language ABL These data files contain the screen text used on mill and lathe control types Text 15 pulled from these files to build a screen on the Basic Display Set language ABG These data files contain the screen text used on grinder control types Text is pulled from these files to build screen on the Basic Display Set language ABE These data files contain text for screen displays and error messages related towards the PC side of the OCI system GCODE DAT
147. ation Result 1 Odd 2 Even 3 None Important Enumeration does not apply to the 9 PC CNC Array Indices Strings 6 7 DH REMOTE STATION enumeration The data highway remote station type enumeration is used to identify the type of remote device being used The remote station enumeration is Enumeration Result 1 PLC 2 unprotected R W 2 PLC 3 Word Range R W 3 PLC 5 Typed R W 4 Computer Typed R W Important Enumeration does not apply to the 9 PC CNC ERROR MESSAGE TYPE enumeration The Error Message Type enumeration is used to identify the type of error message to be displayed The Error Message Type enumeration 1 Enumeration Result Exclusive This indicates that no axis name or slot name accompanies this message It is a typically a system wide type message and not specific to a select axis or servo Axis Head The axis name is to precede the error message Axis Tail The axis name is to proceed the error message Channel Head communication port name precede the error message Channel Tail communication port name proceed the error message Slot Head The 1394 slot number is to precede the error message oc Slot Tail The 1394 Slot number is to proceed the error message Publication 8520 6 6 August 1999 6 8 Array Indices Strings MACHINE_TYPE enumeration The Machine Type enumeration is used to identify the AMP machine type con
148. be passed into this item until the higher priority message is cleared Messages are returned to the OCI station as a message base an index and any special characters for that message This information is provided using the three integer array associated with this data item Important Refer to your 9 Series PAL Reference Manual or 9 PC Logic Interface Reference Manual System Error Detection chapter for tables listing bases and the corresponding message index Descriptions for the error messages are available in your operation and programming manual LINE 1 MESSAGE DATA 1 This data item returns the error message base for the currently active line one error message LINE 1 MESSAGE 2 This data item is an enumeration that identifies the use of the information in the third word It is enumerated as follows Data Server Data Items 4 35 Value of Resulting impact to LINE 1 MESSAGE DATA2 LINE 1 MESSAGE 3 NO VARIABLE this indicates that the third word is not used This means there is no ac companying text for the message and there is only one message in this base EXCLUSIVE mutually exclusive message This indicates the third word of this data item is the message index for the given base AXIS HEAD there is only one message in this base The third word indicates the axis name to be shown at the beginning of the message AXIS TAIL there is only one message in this base The third word indicates th
149. ble ARDF There can be timing issues related to I O variables that are altered through the PAL for example if your OCI station changes a PAL variable that is later changed in the foreground scan the last device PAL logic or the OCI station that changes the data will be used Data Server Data Items 4 49 System Flags Data Type Defined by PAL Read Write Read Write PAL protected Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC You can access all PAL Logic system flags provided they are available on your 9 Series executive type e g some grinder system flags are not available on a lathe mill All read and writes are subject to the logic which always has the authority to override any OCI settings Automatic reads of PAL Logic variables are always added to the controls background watch list You must consider any timing issues this may present in your PAL Logic and API applications Variables set by the OCI occur at the beginning of a PAL scan The PAL Logic ladder runs and acts on these changes by writing to the variable tables This means if your OCI sets an output to true at the beginning of a PAL Logic scan PAL Logic can change the output point back to false during the PAL Logic scan thus overriding the OCI request to set the output to true PAL Logic system variables that are defined by PAL Logic as foreground only are also added to th
150. blication 8520 6 6 August 1999 5 34 Data Server Commands Publication 8520 6 6 August 1999 TRANSFER PAL FROM PORTB no argument Use this command to restore a PAL image from a peripheral device attached to the control s port B This will restore the PAL image to RAM For example TRANSFER PAL FROM PORTB would read the PAL image from the device connected to the control s port B This command will overwrite the PAL image currently in the control s RAM This will not affect the PAL image stored in the control s backup memory You must cycle power to the control whenever PAL is updated Important This command does not apply to the 9 CNC TRANSFER PAL TO PORTA no argument Use this command to back up the current PAL image and its source code if present on the control to a device connected to the control s portA This will back up the PAL image currently in RAM This may or may not be the same image stored in the control s backup memory For example TRANSFER PAL TO PORTA would write the PAL image to the device connected to the control s port A This backup file is not in a man readable format If you require a man readable version of PAL refer to the ODS document utility Use the command TRANSFER PAL FROM PORTA to retrieve an PAL image from a peripheral device Important This command does not apply to the 9 PC CNC Commands Data Server Commands 5 35
151. c De mm grees JW Probe Entry Units Inch Met Metric units always Yes ric De mm JW 2 Probe Entry Units Inch Met Metric units always Yes ric De mm Num setupbuffers Controls Controls Control Type Il Controls Lathe Mill Dual Lathe Mill Dual Lathe Mill Dual 196 ACTIVE RANDOM TOOL SHAFT POCKET Shaft pocket number of active random tool _ USINT 197 NUM AMP PARAMETERS Number of AMP Parameters UINT All Controls Controls Lathe Mill Lathe Mill 78 NUM POCKETS Number of tool pockets AMP UINT POCKETS NEEDED Random tool pockets needed USINT RT SHAFT POCKET Random tool shaft pocket USINT RT TOOL NUM Random tool number INT TM ACTIVE ENTRY Active tool management tool entry 212 TM ACTIVE TOOL Active tool management tool 21 TM ACTIVE TOOL GROUP Active tool management tool group 220 ACCUMULATED LIFE Tool management data accumulated life REAL 1 NUM BER POCKETS MAX NUM BER POCKETS NUM BER POCKETS MAX TOOL EN TRIES 224 225 i Lathe Mill Dual Lathe Mill NT NT NT ai i Em E Emi E E i m oa Um 412 1 1 1 Te 1 1 1 1 ae re 1 1 2 Publication 8520 6 6 August 1999 Data Items 15 Description Data Type OCI 9 PC Array Indic
152. c filename string dest MOE ene qam hes e 5 40 COPY PORTA TO MEM src name dest filename string HIDUB dace 5 41 COPY PORTB TO MEM src name dest filename string ac ea Re pu uqa Ear de 5 42 DEACTIVATE PART PROGRAM no argument 5 43 DELETE PART PROGRAM filename string 5 43 ENTER PART PROGRAM SEARCH MODE search type 5 43 EXECUTE PART PROGRAM SEARCH Search Method 5 44 RENAME PART PROGRAM filename string dest filename string 5 44 RESTART PART PROGRAM restart action 5 45 SEQUENCE STOP PART PROGRAM block num 5 45 SET DIRECTORY target dir password string 5 46 SET PART PROGRAM COMMENT filename string p Rog QPPL RD 5 46 SET PART PROGRAM INPUT DEVICE pp source 5 47 SET PART PROGRAM SEARCH PATTERN text string 5 47 VERIFY PART PROGRAM 1 filename2 mode 5 48 VERIFY WITH PORTA 1 mode 5 49 VERIFY WITH PORTB 1 mode 5 50 Part Program Execution 5 51 EXECUTE MIDSTART SEARCH search method 5 51 SET MIDSTART SEARCH PATTERN search 5 52 STOP QUICK CHECK no argument 5 52 SYNTAX QUICK CHECK no argument 5 53 Tool
153. calibration points from the axis calibration table After execution of this command the control will clear any data previously entered in the axis calibration table all processes For example DELETE ALL AXISCAL POINTS deletes all axis calibration points currently stored in the axis calibration table for all axes DELETE AXISCAL POINT axis num axis cal point Use this command to delete an axis calibration point The axis num argument for this command identifies which logical axis number to modify The axis cal point argument identifies the specific point to be deleted Both arguments for this command are integers DINT For example DELETE AXISCAL POINT 1 6 deletes the sixth calibration point for the first axis in the process configured in AMP ENTER AXISCAL MODIFY MODE no argument When this command is executed the axis calibration tables are opened for editing You must successfully issue this command before attempting to modify the axis calibration tables For example ENTER AXISCAL MODIFY MODE opens the axis calibration table for editing and allows access to the axis calibration data Publication 8520 6 6 August 1999 5 10 Data Server Commands Publication 8520 6 6 August 1999 EXIT_AXISCAL_MODIFY_MODE no argument When this command is executed the axis calibration tables are closed for editing You must issue this command when your edits to the axis calibration table are complete T
154. ch list it monitors the specified items in the list for changes When a change occurs to a piece of data the processor after waiting a configurable number of coarse iterations sends the OCI data server the new information If multiple OCI data servers are running on the network there can be multiple watch lists on any one control The 9 Series control is capable of maintaining multiple watch lists up to 4 different OCI stations and will return data as needed to the appropriate OCI station The 9 PC can maintain watchlists for only one data server Since the watchlist is maintained on the control s processor instead of on the workstation as is common with more typical DDE applications the OCI shows improved network performance over similar competition by not requiring continuous polling of data from the workstation It also prevents continuous transmission of automatic data on the network as data is only transferred to the OCI server when an item on the watchlist changes This is the reason no polling rate configuration is necessary for the OCI installation As more items are added to the watch list more processing time is required from the processor We recommend keeping the watchlist as small as possible to prevent performance degradation and out of room on watchlist errors Though most OCI applications make a negligible change in performance you should not unnecessarily load the system up with requests for data until that data item is a
155. cluding the existence of the source program The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute copy For example COPY MEM TO PORTA MAIND SOURCE PPG DSTIN 1 copies the program named SOURCE from the main CNC directory to a new part program named DSTIN on the device attached to port A Note the PPG extension is not necessary for most devices connected to port A If copying from the hardd directory this path must be the OCI file handlers configured working directory as specified in the OCIFHCFG INI file see your OCI integration manual Important This command does not apply to the 9 PC CNC COPY MEM TO PORTB src filename string dest name mode Use this command to copy your part program file from memory either the main protected or PC drive to port B The src filename string is the same as the file name string given on page 6 19 hnd includes specific directory information The dest name string is the name used to store the part program on tape Data Server Commands 5 41 remaining argument with this command is mode argument which is an enumeration used to identify that you want to perform the copy or test the command syntax The test option will check the command syntax including the existence of the source program The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute copy
156. code has a search utility which allows you to change text or prompts on any of the standard 9 Series screens as well as identify the text pointer numbers Important These search utilities do not apply to text found on the 9 Series or 9 PC editor any ODS screens including the PAL search monitor screens These screens can not be edited and are not part of the Basic Display Set source code Access the search utilities from the Setup menu in the Basic Display Set The Setup menu is only available when the source code is loaded in the same directory as the Basic Display Set and the variable SETUPMenu is set to True Set this variable by e Manually change the variable in source code found in Global Bas InitGlobals or in SetupGlobalVarsforNewCNC or Manually change the variable FINAL EXE to False You can search for either prompts or text Prompt Search If you select Prompt search from the setup menu you will be searching for prompts such as or CHANGE VALUE Prompts are text strings used to request an operator input of some type Text Search If you select Text search from the setup menu you will be searching for text used to build the standard screens such as ACTIVE PROGRAM or MEMORY After you have selected your search type the softkeys are removed from the screen and replaced with the following search dialog Basic Display Set BDS 3 21 Entry for Search String Entry Box
157. combined with the pointer information and softkey tree structure This file uses characters to separate different softkey names from the same softkey rack Below each softkey rack is pointer information for the first thru seventh softkey includes back and more softkeys and the softkey text pointer number Publication 8520 6 6 August 1999 3 24 Basic Display Set BDS PREVIOUS KEE2 HET KEM HEYS MEET BOFTKEY TEXT PEGRAMHAMAGETOFTZSET HACROI PFARTANJPRGRAMCHECE2STUTEHSUFCZOET Z 2 330 7 1 FERONT HEZAGETPATZ WORDTSUITCHLENGTDAVE MOWETER D 1811 8 12 350 1801 18 2 1 0 D DO 0 0 EXIT nz C B 1 3443 446 D By BH 0 TTAC EBBCONTEL iT D GO D 4 0 B 0 0 uu D D Du D 8 PE ACTPBGRAHTETRETCH HID ETPPGRAN T PATBZRATE IT PATHDISAEL a5 29 0 3582 553 554 18 TT SEG PARTE 10 0 0 0 354 ID 18 SILECTPRGRAMT FHIL STPRZOIBAM The error text file shown in the next figure lists the error message text strings and their respective error pointer numbers English err WordPad OFFSET MESSAGE ILLEGAL CPU 2 COMMAND I O RING NOT CONFIGURED ILLEGAL I O RING DEVICE CODE I O RING COMMUNICATIONS ERROR ILLEGAL I O RING RACK SLOT CODE CPU 2 FAILED CPU 2 FAILED DEVICES
158. command tool number the tool geometry offset number you are changing with this measure command axis number the logical axis number as defined in AMP ref pos the fixed reference position with no geometry or wear offsets active of the tool Refer to your operation and programming manual for details on determining this fixed machine position This is the position the control compares to the actual axis position to determine the geometry amount Important Lathe and Cylindrical Grinder control types this position ref pos value is always entered as a radius value For example MEASURE TOOL GEOM 2 1 1 777 would perform a measure operation to calculate the geometry offset amount for tool offset 2 axis 1 If no tool geometry or wear offsets were present the current tool position should be 1 777 The control then compares the actual tool position to 1 777 and uses the difference to create the appropriate geometry offset Publication 8520 6 6 August 1999 5 32 Data Server Commands Publication 8520 6 6 August 1999 MEASURE TOOL WEAR tool number axis number ref pos This command performs the tool measure function refer to your operation and programming manual for details on measure When executed this command compares the actual axis position to the entered ref pos to determine the wear offset Three arguments are specified with this command tool number the tool wear offset n
159. cro parameters 500 519 Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP COM2A PARAMETERS maind cm2Aback ppg would create the backup program on the CNCs main directory and name the backup program cm2aback Data Server Commands 5 37 BACKUP COM2B PARAMETERS string This command tells the control to create a backup program of all the common 2B paramacro parameters 520 999 Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create
160. ctually needed The maximum combined number of data items that any processor can maintain on all watch lists is based on what data items are in the watch list as well as remaining control memory Important If your application uses RSJunctionBox as used by the Basic Display Set you must include an item destroy command in your logic Item destroy is used to prevent the WatchList from filling by maintaining links to data items that are no longer needed Refer to page 1 8 for details on item destroy Important Refer to your AMP reference manual for details on determining and configuring the OCI WatchList Buffer Size Two watch lists are created on the CNC for every connected OCI station See the background foreground section in this chapter for details Systems with extremely large watch lists may need to increase their AMP configured system scan times Publication 8520 6 6 August 1999 4 12 Data Server Data Items operations are used to send data to the processor from the OCI data server The Server sends the value from your application program to the processor that contains the data item ATTENTION Extreme care must be taken when using the POKE capability If you inadvertently write to critical data in the CNC you could adversely affect the operation of the CNC Monitor the status of POKE commands using the data item WRITE_ERROR_CODE which will return the success or failure of a POKE operation as disc
161. d I O to port B Control Commands z z s 5 SEARCH MODE r PATTERN m Publication 8520 6 6 August 1999 Backup all paramacro parameters Backup Com 1 paramacro parameters Backup Com 2A paramacro parameters Backup Com 2B paramacro parameters Backup Shared paramacro parameters Clears all paramacro com2a names Sets specified paramacro com params to zero Activates part program Checks for exsitance of file Copies part program Copies part program to from OCI for editing Copies part program file memory to memory Copies part program file memory to port A Copies part program file memory to port B Copies part program file port A to memory Copies part program file port B to memory Deactivates part program Deletes part program Enters part program search mode Executes part program search Reformats part program memory Renames part program Sequence stop part program Sets directory Sets comments for part program Inputs device Sets part program search pattern Verifies part program Verifies part program with port A gt gt gt gt ii gt gt gt gt gt gt gt gt Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro Contro 5 Contro Contro
162. d in AMP Refer to your AMP Reference Manual for details Background tasks are executed whenever there is excess time available during a system scan time The execution continues only as long as there is excess time When the excess time is used up the current background task is marked and foreground PAL Logic execution begins Background execution resumes at the marked position when there is excess time available again during future coarse iterations Important Since background tasks may be updated at various intervals of the control cycle it is necessary to coordinate I O or other PAL Logic variables with system timing For the 9 PC no I O variables exist and the only access is through system flags For the 9 Series only any values that change in foreground and are accessed by the OCI at a later time time in a background scan should be saved to a global variable before the I O value changes due to another change of the variable in foreground Failing to do this can cause foreground events to be missed by the OCI data server When the OCI data server creates watch lists on the CNC it creates two different watchlists one for foreground data items and one for background data items If multiple OCI data servers connect to the same 9 5 each data server creates a separate foreground and background watch list Important Release 1 of the 9 PC can support only one data server Publication 8520 6 6 August 1999
163. d indicates the AUX comm tables INT OCI R W All Controls are currently being modified Feedrate Data ad F1 DIGIT FEEDRATE Single Digit Feedrates Online AMP LREAL OCI Inch Met ACTIVE UNITS R W All Controls ric De grees ace Sas aren Jee rone arse gm e qe p qe aeee h Publication 8520 6 6 August 1999 6 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc FEED_VALUE Feedrate Value LREAL Both ACTIVE_UNITS Yes All Controls FEED MODE A r BORING_SHIFT_DIRECTION Shift direction for back boring cycles Online All m AMP DRILLING CLEARANCE AMOUNT Clearance amount for drilling cycles Online LREAL Both Inch Met ACTIVE UNITS R W All Controls AMP ric De grees DRILLING RETRACT AMOUNT Retract amount for drilling cycles Online AMP LREAL Both Inch Met ACTIVE UNITS All Controls ric De grees THREADING PULLOUT ANGLE Pullout angle for threading cycles Online AMP LREAL Both UNE Degrees always Lathe DLathe THREADING PULLOUT DISTANCE Pullout distance for threading cycles Online LREAL EDITI Lathe DLathe AMP M Code Data wq E eS a s Group GGmnPupanne sn n Arme z uco sms mn ve n Arme s wcmou PROGRAINED MGmnPeganne
164. de if the port is currently sending diagnostic data Important This command does not apply to the 9 PC CNC REPEAT TX SERIAL IO character This command repeatedly transmits a character out the serial port when the I O monitor is active Specify the character to be sent out the serial port as an argument for this command The transmitted character must be an integer DINT equivalent of the ASCII character to transmit For example REPEAT TX SERIAL IO 68 will repeatedly transmit the lone character out the serial port Note this is used primarily for I O monitor diagnostics Use the STOP SERIAL IO MONITOR command to halt transmission Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 20 Data Server Commands Publication 8520 6 6 August 1999 SAVE DEVICE SETUP no argument Use this command to save changes made to the control s external device setup for ports A and or After configuring a device for a specific serial port such as baud rate stop bits etc use this command to save and activate your changes For example SAVE DEVICE SETUP saves the device setup for the control s port A and port B Important This command does not apply to the 9 PC CNC SINGLE TX SERIAL 10 character This command is used to transmit a single character out the serial port when the I O monitor is active Specify the character to be sent out the serial port as
165. destination filename The remaining argument with this command is the mode argument which is an enumeration used to identify that you want to perform the copy or test the command syntax The test option will check the command syntax including the existence of the source program The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute copy For example MAIND SOURCE PPG MAIND DESTINATION PPG 1 creates a new part program named DESTINATION PPG in the MAIND of the CNC that is a duplicate of the program named SOURCE PPG The destination file should not exist when you execute this command If it does the control will overwrite the previously existing destination part program Publication 8520 6 6 August 1999 5 40 Data Server Commands Publication 8520 6 6 August 1999 COPY MEM TO PORTA src filename string dest name mode Use this command to copy your part program file from memory either the main protected or PC drive to port A The src_filename_string is the same as the file name string given on page 6 19 includes specific directory information dest_name string is the name used to store the part program on tape The remaining argument with this command is the mode argument which is an enumeration used to identify that you want to perform the copy or test the command syntax The test option will check the command syntax in
166. e control s RAM Use the command RESTORE to retrieve the AMP file currently in flash Publication 8520 6 6 August 1999 5 4 Data Server Commands Publication 8520 6 6 August 1999 MODIFYING AMP no argument Use this command to open patch AMP You must send this command before the control will allow you access to patch AMP parameters The control must be in E STOP before this command is issued For example MODIFYING AMP opens the AMP image on the control for editing RESTORE no argument writes into RAM the AMP file currently stored in FLASH memory It is necessary to cycle power on the control when AMP is restored Use the command BACKUP AMP to store an AMP file into flash TRANSFER AMP FROM PORTA no argument Use this command to restore an AMP configuration that was backed up to a peripheral device attached to the control s portA This will restore the AMP configuration to RAM For example FROM PORTA reads the AMP configuration from the device connected to the control s port A This command will overwrite the AMP file currently in the control s RAM This will not affect the configuration stored in the control s flash memory It is necessary to cycle power on the control when AMP is restored Use this command to restore into RAM the AMP file currently in flash memory This command will overwrite the AMP currently residing in RAM Refer to you
167. e OCI Foreground watchlist Foreground Background selectable and Background only PAL Logic system variables are always loaded in to the OCI background watchlist as most other OCI API data items Format for this data item is followed by the name of the system variable SESTOPI Important For the 9 PC flags have a different syntax in Logic API still uses the format There can be timing issues related to variables that are altered through the logic for example if your OCI station changes a PAL Logic variable that is later changed in the foreground scan the last device PAL Logic or the OCI station that changes the data will be used The foreground background state of an OCI PAL Logic system variable is defined in your PAL Logic reference manual and not set by simply writing the variable in a foreground or background PAL Logic module Publication 8520 6 6 August 1999 4 50 Data Server Data Items Publication 8520 6 6 August 1999 Important Before the OCI system is allowed to set certain PAL Logic variables the software front panel flag SW PANE must be set to one true Failing to set SW PANE will cause the control to overwrite each PAL Logic scan any OCI requests to the following flags MODREQ RPDOREQ 550 SW DRY RUN AUXLRQ SNGBLK INHR BKRTRQ CYCSTR FRO SW SPNDIR RPDTRV BDRQ OPTSTP MXRQ STZE JRETRO CYCSTP Important above flags do not apply to the 9 P
168. e axis name to be shown at the end of the message CHANNEL TAIL there is only one message this base The third word indicates the channel used to be shown at the end of the message SLOT HEAD there is only one message in this base The third word indicates the ampli fier slot number to be shown at the beginning of the message SLOT there is only one message in this base The third word indicates the ampli fier slot number to be shown at the end of the message CHANNEL HEAD there is only one mes sage in this base The third word indicates the channel used to be shown at the begin ning of the message LINE 1 MESSAGE DATA 3 This data item returns an integer that is dependent on the value of LINE 1 MESSAGE 2 The value of LINE 1 MESSAGE DATA is interpreted as follows Exclusive Number word two value is 1 Word 3 returns the index of the error message in the message base Refer to your 9 Series PAL Reference Manual or 9 PC Logic Interface Reference Manual System Error Detection chapter for details on this error number indexes Axis Name word two value is 2 head or 3 tail Word 3 returns a bit pattern indicating which axis 1 to be displayed A one in any bit indicates that logical axis number is to have its axis name displayed right most bit being axis 1 Axis names are assigned to logical axis numbers in AMP Publication 8520 6 6 August 1999 4 36 Data Server Data Ite
169. e baud rate for one of the serial communication ports The enumeration are Enumeration Result 0 300 Baud 1 600 Baud 2 1200 Baud 3 2400 Baud 4 5 4800 Baud 9600 Baud 6 19200 Baud Important Enumeration does not apply to the 9 PC CNC PORT COMM FORMAT enumeration The port comm format enumeration is used to select the format for communication on one of the serial communication ports The enumerations are Enumeration Result 0 EIA 1 ASCII 2 N A Important Enumeration does not apply to the 9 PC CNC a PORT_DATA_BITS enumeration The port_data_bits enumeration is used to determine the number of data bits used for communication on one of the serial communication ports The enumeration are Enumeration Result 0 7 bit 1 8 bits Publication 8520 6 6 August 1999 6 12 Array Indices Strings Publication 8520 6 6 August 1999 Important does not apply to the 9 PC CNC PORT PARITY enumeration The port parity enumeration is used to select the parity for serial communications The parity enumeration is Enumeration Result 0 Odd 1 Even 2 None Important Enumeration does not apply to the 9 PC CNC PORT ID enumeration The port option enumeration is used to select one of the serial communication ports The enumeration are Enumeration Result 1 Port A 2 Port B Important Enumeration does not apply to the 9 PC CNC
170. e data server is used to select the active unit mode on the control Mode Inch Metric enumeration 15 Enumeration Result 2118 Inch Mode 2119 Metric Mode Publication 8520 6 6 August 1999 6 10 Array Indices Strings OPTION_SELECTED enumeration The option_selected_indices enumeration is used to identify the options enabled on your specific CNC The Option_Select_Indices enumeration 1 Enumeration Result Enumeration Result 0 Control Type 38 Reference Point Return 1 Part Program Storage Length 39 PAL Logic Offset Modification 2 QuickView QuickPath 40 PAL Display Page Capability FER Gus eta i PAL Lage Axis Mover 4 Thread Cutting Cycle Retract 42 G93 Inverse Time Programming 5 Constant Surface Speed 43 Polar Coordinate Programming 6 G34 Variable Lead Thread Cutting 44 Fixed Cycles 7 Auto Mid Program Start and Seq Srch 45 Programmable Mirror Image 8 Part Rotation 46 Feed Function F Digit Feed 9 Spindle Orient 47 G10 Programmable Data Input 10 Helical Interpolation 48 Part Program Up Download from ODS 11 Random Tool 49 Protected Paramacro Directory 12 Spindle Speed Dev Detection and Output 50 Software Option Used 13 Tool Path Graphics 51 US Feed Function 14 QuickView Guiding Graphics 52 1 Remote 1 0 15 Scaling 53 Part Rotation 16 Paramacro Programming 54 7300 Tape Compa
171. e logical axis is configured to be the default tool length axis For example AMPED_TOOL_LENGTH_AXIS_LOGICAL_BIT_PATTERN 1 Could return the bit pattern 00000100 This would indicate that the third axis is AMPed to be the default tool length axis DRILLING AXIS LOGICAL PATTERN Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to determine what axes are currently selected as the drilling axes in the process The drilling axis is the axis used for drilling operations for fixed drilling cycles It returns a bit pattern of the logical axes in the process If a zero is reported to the logical axis number that axis is not currently the active drilling axis A one indicates the logical axis is a active drilling axis For example DRILLING AXIS LOGICAL BIT PATTERN 1 Could return the bit pattern 00000100 This would indicate that the third axis is selected as the drilling axis for fixed cycles Publication 8520 6 6 August 1999 4 46 Data Server Data Items Operating Mode Publication 8520 6 6 August 1999 ACTIVE UNITS Data Type UINT enumerated Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The ACTIVE_UNITS data item is used to identify the current operating mode in terms of m
172. ea Form MAINMDI FRM This form provides the structure for all the 9 Series or 9 PC screens parent form It defines the size and layout initializes global variables loads system information form PAL Logic message form and softkey form Other forms overlay this form to provide the proper display System Form SYSTEM FRM This form overlays at the top of the Basic Display Set screen It is used to display system messages and prompts for input information It also manages keyboard input This form is loaded MAINMDI FRM Display Form screenname FRM This form overlays the center portion of MAINMDI FRM It is different and specific for each 9 Series or 9 PC screen to be displayed The Program Position Screen PROGPOS FRM is an example of a display form The PROGPOS FRM differs from other display forms in that it remains loaded in background anytime the Basic Display Set is running This improves performance since this screen is the most commonly used display form Typically display forms are loaded and unloaded by the softkey modules Publication 8520 6 6 August 1999 Basic Display Set BDS 3 7 PAL Logic Messages PALMSG FRM This form resides just below the display form and is used to display any messages sent from the PAL Logic to be displayed on lines 21 and 22 of the BDS This form is loaded by MAINMDI FRM Line 1 PAL Logic messages are displayed on the SYSTEM frm Line
173. eads the value of paramacro variables 102 thru 106 There can be timing issues related to paramacro variables that are altered through part program execution for example if your OCI station changes a variable that is later changed during part program execution or PAL Logic assignment in some cases foreground scan When reading writing local data items the local item is only valid for the main subprogram or paramacro program currently executing Refer to the paramacro chapter of your operation and programming manual for details on local values Part Program Directory Data Items AVAILABLE_MEMORY Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use the AVAILABLE MEMORY data item to determine the remaining part program space on the CNC s Main and Protected part program directories This data is returned as the number of bytes available Bytes can be converted to meters as indicated on the basic display set as 393 846 bytes 1 meter of tape Publication 8520 6 6 August 1999 4 52 Data Server Data Items Publication 8520 6 6 August 1999 Note the main and protected directories share the same RAM disk space This item will not return information about the PC s hard disk It is only valid for the CNC s RAM disk SELECTED PART PROGRAM DIR Data Type UINT enumerated Read Write Read only Arra
174. ear offset number 2 for axis number 3 Unless otherwise mentioned in the argument description most data items allow the omission of indexes which returns all data in that array For items that use two or more arguments only the right most argument can be omitted if it is valid to omit arguments Data returned from an array is delaminated by Tab characters and ended with a return line feed character Publication 8520 6 6 August 1999 4 4 Data Server Data Items Publication 8520 6 6 August 1999 AXIS NUM This array index is dimensioned by the axes number as configured on the system in For example the data item AXIS NAME which returns the name of the axes from the CNC is an array based on Axes Number So calling the data item AXIS NAME 2 returns the text string axis name for the second axis Calling the data item AXIS NAME 2 4 calls the text string for the axis names 2 3 and 4 The values are separated by a or tab character SPINDLE NUM This array index is dimensioned by the spindle number as configured on the system in AMP The 9 PC CNC supports 2 spindles Some 9 Series systems can support up to 3 spindles so this dimension ranges from 1 to 3 spindles For example the data item SPD VALUE which returns the active programmed spindle speed for a specified spindle uses this array index to determine which spindle speed you are requesting SPD VALUE 2 r
175. easurement system being used on the control The returned value is enumerated as follows Enumeration Result 2118 Inch Mode 2119 Metric Mode AXIS_RAD_DIA_MODE Data Type DINT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The AXIS RAD DIA MODE data item is used to identify which axes on the system are currently in radius or diameter mode refer to your Lathe or Grinder Operation and Programming Manual for details on radius diameter mode The data for this item is returned as a bit pattern A true value in any bit indicates that the axis is in diameter mode The first bit of this word represents axis 1 For example if the returned integer is 8 which translates into 01000 indicating the fourth axis is in diameter mode On Mill controls all axes are always in radius mode all bits of this word remain zero Only one axis can be in diameter mode on a Lathe Grinders can have multiple axes in diameter mode Data Server Data Items 4 47 ACTIVE_SCALE_INDICATOR Data Type DINT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The ACTIVE SCALE INDICATOR data item is used to identify which axes on the system are currently being scaled refer to your operation and programming manual for details
176. ed Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the parity used for the specified communication port The index port id identifies the port as follows port A 2 port B Publication 8520 6 6 August 1999 4 24 Data Server Data Items Publication 8520 6 6 August 1999 The port_id index must always be used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 Odd 1 Even 2 None For example assigning a value of 1 to the following item PORT PARITY 2 selects Even parity for port B PORT STOP BITS port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the number of stop bits used for the specified communication port The index port_id identifies the port as follows port A 2 port B The id index must always be used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 1 bit 1 1 5 bits 2 2 bits For example assigning a value of 1 to the following item PORT STOP BITS 2 selects 1 5 stop bits for port B Data Server Data Items 4 25 PORT DATA BITS port id
177. ems Publication 8520 6 6 August 1999 Format for this data item is 96 followed by the variable name 1 There can be timing issues related to I O variables that are altered through the PAL logic for example if your OCI station changes a PAL variable that is later changed in the foreground scan the last device PAL logic or the OCI station that changes the data will be used User Defined Globals Data Type Defined by PAL programmer Read Write Read Write PAL protected Array Index none Control Type Lathe Mill Grinder You can access all PAL user defined global variables assuming they have been defined properly in PAL local PAL variables can not be accessed All read and writes are subject to the PAL logic which always has the authority to override any OCI settings Automatic reads of PAL variables are always added to the controls background watch list You must consider any timing issues this may present in your PAL and API applications Important User Defined Globals do not apply to 9 PC Variables set by the OCI occur at the beginning of a PAL scan The PAL ladder runs and acts on these changes by writing to the variable tables This means if your OCI sets an output to true at the beginning of a PAL scan PAL can change the output point back to false during the PAL scan thus overriding the OCI request to set the output to true Format for this data item is followed by the name of the global varia
178. er Service Service Name Servo Information ANGLED WHEEL ALLOWED A 15 AXIS NAME A 15 AXIS PRESENT LOGICAL RN A 15 NUM 1394 RACKS A 15 NUM AXES A 15 NUM PROG AXES PLUS EXTRA NUM SERVO MODULES 15 NUM SERVOS A 15 NUM SERVOS PLUS SPINDLES NUM SKEWSLAVES A 15 RACK 1394 BOARD NUMBER RACK 1394 MODULE ERRORS A 16 RACK 1394 SERCOS ADDRESS RACK 1394 SYSTEM MODULE HW REVISION A 15 ROLLOVER AXIS LOGICAL BIT PATT ERN A 16 ROTARY AXIS LOGICAL BIT PATTER N SERVO TTE VIRTUAL AXIS 16 VIRTUAL FORMATS 16 VIRTUAL NAMES A 16 Servo Parameters AXIS SKEW AMOUNT AXISCAL TABLE TYPE A 3 DISTANCE TO MARKERT 16 FEED FORWARD PERCENT A 16 FOLLOWING ERROR A 16 HOME CALIBRATION AMOUNT A 16 MARKER STATUS A 16 MAX NEGATIVE TORQUE A 16 MAX POSITIVE TORQUE 16 NUM MONITORED SERVOS PLANE AXES INDICES POSITION LOOP INIT GAIN REVERSAL ERROR DISTANCETA 17 SERVO STATUS A 17 TORQUE A 17 TORQUE OFFSET PERCENT VELOCITY DISCHARGE RATE VELOCITY GAINS FROM TABLE VELOCITY INTEGRAL GAIN A 17 VELOCITY PROPORTIONAL GAIN 17 SERVO_FW_REVISION SERVO_MODULES Index SERVO_NAME SERVO_NUM Index SERVO STATUS A 17 SERVO STATUS Enumeration 6 17 SET AXISCAL PROCESS NUMBER B 1 SET DIRECTORY SET MIDSTART SEARCH PATTERN 52 5 SET PART PROGRAM COMMENT 5 46 B 4 B 6 SET PART PROGRAM INPUT DEV
179. er form should be shown when your form is unloaded InitForm private Most of the Basic Display Set forms make use of this routine to position labels based on MDI location and other assorted initialization parameters CreateDataL inks private This module is used to create any necessary DDE links to the CNC to load your form DisplayRows private This module is used to format the data on the display It is typically called from the module Inkdata change and handles how data is presented on the form InittormLevelVariables Publication 8520 6 6 August 1999 This module is used to initialize all the form level variables on a Form Load event Using the Softkey Editor Utility OCI Basic Display Set BDS 3 11 Managing Errors your Form When you develop your new screen we recommend you place in your code the following routine we use to handle and report error conditions On Error GoTo ProgramError add your code here Exit Sub Program Error WriteErrors string Err debug errorFile Resume Next End Sub Where string 15 the message you want displayed Err indicates to the code it is an error enter the string ERR debug is the string you want to pass on to help debug the error condition We recommend you use the name of the form and its sub name errorFile the number of the file to write errors into 1 writes to the poking error files 2 writes to
180. erform specific tasks such as download a part program or reformat the RAM disk When your application program requests a command be executed for a specific CNC the OCI data server passes this command on to the CNC which will if valid execute the command OCI Data Server Return and Error Codes CNCs that are off line or powered down will not respond to the requests that the OCI data server is sending them The OCI data server will retry a read write or command transaction if the processor is on line but currently busy If the OCI data server detects a severe error such as no response from the processor the OCI data server will stop trying to communicate to the device After a time specified in the 9 Series data server s INI file for the 9 Series CNCs and in the Configuration Manager for 9 PC CNCs the OCI data server will again try to contact the processor If it fails again the OCI data server will repeat the process until the failure no longer exists Important The 9 PC data server is configured via the 9 PC Configuration Manager The retries will affect OCI data server performance since they entail additional OCI data server communications When your OCI application requests either a data item or issues a command to the CNC through the OCI data server the request is either performed or rejected by the CNC Publication 8520 6 6 August 1999 1 6 Open Control Interface Overview RSLinx OEM Publication 8520 6
181. erview Pro development tool Assuming you have already installed the source code open the project using Microsoft s Visual Basic Pro You should see a project window similar to the following pr Lan Laplace Wit 1 1 1 PURA LEVEL F FARIUSLES IH TME ImirTcrmLlwwvelVarimhlws di Er kmcckSERE OF FORM hefi seo pens ers pe 2i Prem Form treed Thr MED d limas af applicaridr kekar T km perio Dpromsbm ard rrop bert har iE ra command arrar link sal as tha gicha amp i bw OFC babe Ci and THO oemi ITAL TI HIP Li SE ras form tbe fire child loaded iria us A ALI t mrarrup irm in mg b bhg DEAS GS N rapa dia i Bs him Frkabumiar lnzager Pim Erqmemib lldsed ds Integer bim b ECrr legar him FillErghttechedibeck ir him Bhauilabaikrrredigamiiad Bcolaun Privata Lrwking8ystemFrrm ks Bers mari La BccleAn Ww cala a Public rfrlpgissSPsEurnizg km kafee F pape C
182. es Units Dual Control Type Dependency Proc 218 TM CUTTER COMP NUM Tool management data cutter comp number USINT Both MAX TOOL EN R W Lathe Mill TRIES 16 TM ENTRY NUM Tool management data entry number USINT Both MAX TOOL EN Lathe Mill TRIES 21 TM EXPECTED LIFE Tool management data expected tool life REAL Both MAX TOOL EN Yes R W Lathe Mill TRIES TM GRAPHICS TOOL COLOR Tool management data graphics tool color USINT enumerated TOOL EN A Lathe TRIES TM GROUP NUM Tool management data group number INT Both MAX TOOL EN Yes Lathe Mill TRIES 19 TM STATUS Tool management data status USINT Both MAX TOOL EN Yes Lathe Mill TRIES TM TOOL GROUP LIFE TYPE Tool management group life type USINT TOOL GRO Lathe UPS TM TOOL GROUP THLD RATE Tool management group threshold rate USINT MAX TOOL GRO Lathe Mill UPS TM TOOL NUM Tool management data tool number INT Both MAX TOOL EN Yes Lathe Mill TRIES TM TOOL OFFSET NUM Tool management data tool offset number USINT Both MAX TOOL EN Yes R W Lathe TRIES TM TOOLS PER GROUP Number of tools in each valid tool group USINT TOOL GRO Lathe Dual UPS 5m n Ares _ L I T IT T L L mae ALLOWED ersen sorsana x __ Pe n ee a swe
183. es not return revision of the servo software on the 1394 CNC serial drive The data item uses this array index to determine which servo module you are referencing SERVO FW REVISION 2 returns the DINT value representing the firmware revision number for the second servo module on a 9 260 or 9 290 Refer to the SERVO FW REV item description for details on the return value format for this item SERVO NUM This array index is dimensioned by the AMP configured number of a specific servo port on the control This is the logical servo number including split dual spindles and adaptive depth probes This array index ranges from 1 to 15 For example the data item SERVO NAME which returns the name of the servo as configured in AMP uses this array index to determine which servo you are referencing SERVO NAME 6 returns the SINT value representing the axis name of the number six axis configured in AMP Publication 8520 6 6 August 1999 4 6 Data Server Data Items Publication 8520 6 6 August 1999 M MODAL GROUP This array index is dimensioned by the valid M code modal groups M code modal groups range from 0 to 13 Refer to your operation and programming manual for details on M codes and their respective modal groups For example the data item M CODE STATUS which returns the active programmed M code number uses this array index to determine which modal group you are checking M CODE S
184. es the operation For example INSERT AXISCAL POINT is an example command string argument is the data to pass to the CNC with the command For example axis num is an argument which is used to pass the number of the axis back to the control with the command string If multiple arguments are used with the command they are separated by a comma Data Server CNC Commands 5 3 The final command including argument to insert an axis calibration point would be INSERT_AXISCAL_POINT 1 Important If you are using the source code for the Basic Display Set command subroutine is available that simplifies the format and execution of CNC commands Use the routine CNCCommand passing it arguments of the Command String The following sections give the syntax and discuss the use of many of the OCI DDE commands They are categorized by feature and alphabetized in each category Feature Page AMP Commands 5 3 Axis Calibration Communications Miscellaneous 5 21 Offsets PAL Commands 5 33 Paramacro Commands Part Program Commands 5 38 Part Program Execution Tool Management Random Tool 5 53 Commands BACKUP no argument Use this command to back up the current AMP configuration to flash memory on the control Refer to your AMP reference manual for details on when and why AMP should be backed up to flash For example _ writes into flash memory the file currently residing in th
185. eturns the LREAL value representing the active spindle speed for spindle number 2 SPD VALUE 2 3 returns the LREAL values representing the active spindle speed for spindle number 2 and 3 The returned values are separated by al tab character NUM CNC DIRECTORIES This array index is dimensioned by the three available CNC part program directories They are Main Program Directory 2 Protectable Program Directory 3 OCI File Handler Configured Directory local to PC Data Server Data Items 4 5 For example the data item NUM FILES which returns the number of part programs that exist in a specific directory uses this array index to determine which directory you are requesting information NUM FILES 2 returns the UINT value representing the number of part programs currently residing in the protected part program directory You can not request information from multiple directories with the same command This argument can not be omitted from items that use the CNC DIRECTORIES argument SERVO MODULES This array index is dimensioned by the number of servo modules available on your 9 Series The array index always returns 1 a 9 PC CNC The 9 260 and 9 290 CNCs have up to three servo modules installed This array index ranges from 1 to 3 For example the data item SERVO FW REVISION returns the firmware revision number for the servo control on the 9 PC card This item do
186. evice Important This command does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 5 6 Data Server Commands Publication 8520 6 6 August 1999 TRANSFER TO PORTB no argument Use this command to back up the current AMP configuration to a device connected to the control s port B This will back up configuration currently in RAM This may or may not be the same configuration stored in the control s backup memory For example TRANSFER writes configuration to device connected to the control s port B This backup file is not in a man readable format If you require a man readable version of AMP refer to the ODS document utility Use the command TRANSFER FROM PORTB to retrieve an AMP configuration from a peripheral device Important This command does not apply to the 9 PC CNC TRANSFER HOMECAL TO PORTA no argument Use this command to send the current home calibration data to a printer or other device connected to the control s port A This will print the home calibration data currently in RAM This may or may not be the same home calibration data stored in the control s backup memory For example TRANSFER HOMECAL TO PORTA prints the home calibration data to the device connected to the control s port A You can only use this command to output home calibration data to a printer Important This command does not apply to the 9 PC CN
187. ey key numbers Pressing this button again changes it to S which indicates the pointer field shows the screen number Softkey and Screen Pointer This field contains either the number of the softkey row S mode or the screen number K mode called when that softkey is pressed Publication 8520 6 6 August 1999 3 14 Basic Display Set BDS Publication 8520 6 6 August 1999 Create New Softkey Pointer Buttons The 6 buttons to the right of the softkey and screen pointer are used to create a new softkey with a new softkey pointer and screen pointer if desired The softkey tree can be navigated as usual change rows or levels using the function keys or mouse as you would normally Important Though the softkey tree appears to be functional the tree will not call different forms or perform any of the functions usually available with the softkeys when in the softkey edit mode Changing Softkey Text To edit the text for any softkey click on the appropriate Edit Softkey Text button button shown just to the right of the softkey text you wish to change An Enter Text window opens up showing the current text for that softkey in all languages available on that system Edit Softkey Text buttons 1 thru 5 PRGR Softkey text not contain then 12 characters including spaces The first six characters entered go on the first line of the softkey use spaces to move any text to the seco
188. f this item indicates 100 points free it means 100 points are available on the system for all axes configured not 100 points per axis AXISCAL STATUS Data Type INT bit pattern Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The AXISCAL_STATUS identifies the status on a specific axis if axis calibration is enabled This item is returned as a integer that must be interpreted as a bit pattern Convert this items returned integer value to a bit pattern to interpret which axes have axis calibration enabled A one in any bit indicates axis calibration is enabled for that axis The first bit right most representing axis 1 A zero in any bit indicates axis calibration is disabled The maximum number of bits representing axes is the maximum configured number of program axes plus any deskew slaves AXISCAL_STATUS could return the integer 4 which would indicate only axis three has axis calibration enabled 00000000100 Data Server Data Items 4 21 Communication Important data items this section apply to 9 Series controls Data Items only PORT BAUD RATE port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the communication baud rate for the specified port The index port id identifies the port as follows
189. fast executing blocks to not make it to your OCI DDE application The actual part program block data begins in column 3 of the returned data The first two characters are reserved for the following symbols Symbol Identifies MDI Block Current executing block Block execution complete A Space Part Program Rotation and Scaling OCI Data Server Data Items 4 55 EXT ROT FIRST AXIS Data Type String Read Write Read Write Array Index none Control Type Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This data item identifies the abscissa axis for the external part rotation plane Refer to your operation and programming manual for details on external part rotation This item returns the ASCII character s representing the currently configured abscissa axis name Use the ASCII character s representing the desired axis when writing to this item Note valid axis names are listed in your operation and programming manual Some two axis names are two characters e g X EXT ROT SECOND AXIS Data Type String Read Write Read Write Array Index none Control Type Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This data item identifies the ordinate axis for the external part rotation plane Refer to your operation and programming manual for details on external part rotation This item returns the ASCII character s represent
190. figuration The Machine Type enumeration is Enumeration Result 17 Mill 34 Lathe A 35 Lathe B 36 Lathe C 69 Surface Grinder 1 70 Cylindrical Grinder 1 23 Transfer Line 145 Dual Mill 1 2 Dual Lathe 163 Dual Lathe B 164 Dual Lathe C Important Does not apply to the 9 PC CNC MID_START_ACTION enumeration Mid_Start_Action enumeration is used to control the mid program search operation The Mid_Start_Action enumeration is Enumeration Result Execute Restart Continue Top of Program Quit Exit Exit and Move C MID_START_TYPE enumeration Mid Start Type enumeration is used to determine the type of search operation to be performed when doing a mid program start The Mid Start Type enumeration is Enumeration Result 1 Restart 2 Seq Search 3 String Search Publication 8520 6 6 August 1999 Array Indices Strings 6 9 MODE ACTIVE active mode enumeration Mode Active enumeration is used to select the execution mode of the control The Mode Active enumeration is Enumeration Result 0 Manual 1 Auto 2 MDI MODE FEED feed mode enumeration Mode Feed enumeration is used to select the active feedrate mode on the control The Mode Feed enumeration is Enumeration Result 0 V D mode 1 IPM mode 2 IPR mode MODE INCH METRIC inch metric mode enumeration Mode Inch Metric enumeration to th
191. for Pointer Number PR_NUMS bas for prompts text file string number for text Maximum characters that can be inserted when responding to this prompt Prompts Only SEARCH Prompts LIHI SNR Edit last found search string Type Search press enter 1 ALTIVE rm Create new text and pointer Last Found Search String Enter either a pointer number text or prompt string in the appropriate box Pressing the enter key performs the search If you enter a string to search for the pointer number for the found string appears in the box Wildcard characters are invalid The search string function automatically inserts wild cards before and after the entered search string for example entering a search string A will find all strings that contain the letter A The found text for the search operation is displayed in the last found search string field Press the EDIT button to change the text for an already found pointer number Press the NEW button to add a new text pointer with a new text string to the language files Im Dari M PHORA r Fac am puas SELECTIGAHE Dwadich PANAH rona Exiting the Text Search Utility After you have completed the necessary changes to the text and prompt files you must save and exit the utility Exit the text or prompt search utilit
192. ft column of this file contains the text pointer number the right column contains the screen text emus TERTII ET pd pem Fores Sela ain al 1 2 THGLIBSH 1 POSE TOO IES 2 LINEAR i CIRCULAR 4 INTERPOLATION LINEAR INTERPOLATION CIBCULAR INTERPOLATION c FROM 1n STORE TO BLCEUP 11 INTEBHAL CVIS DIAMETER CUTTING CTCLE 12 The Basic Display Set has built in testing and debugging utilities that can simplify diagnosing problems with your modifications There are two different utilities provided Debugging when this utility is enabled extensive error messages appear in a MsgBox reporting detailed information on coding e Write to File this utility writes program errors data linking errors and data poke errors to their respective files Debugging Utility The debugging utility enables a Message box which identifies errors The Debugging utility is only available when the source code is loaded in the same directory as the Basic Display Set and the variable DEBUGGING 15 set to True Set this variable by one of these methods e Manually change the variable in source code DEBUGGING is found in Global Bas InitGlobals or e Manually change the variable FINAL EXE to False Basic Display Set BDS 3 27 Write to Error File Utility This utility writes program errors data linking errors and data poke errors to their respec
193. he current axis position The axis number argument defines the logical axis number as defined in for the axis point being added This argument is an integer DINT For example INSERT_AXISCAL_POINT 2 inserts an axis calibration point on the second logical axis at the current axis position REPLACE AXISCAL VALUE axis number axis cal point value Use this command to replace an axis calibration value When point is inserted INRSERT AXISCAL POINT the control enters measurement for the point equal to either the deviation or distance from zero as defined when the table was initialized Use this command to change the measurement axis number Defines the logical axis number as defined in AMP for the axis calibration table being modified This argument is an integer DINT axis cal point Defines the point number you wish to modify This argument is an integer DINT and must be an already existing axis calibration point value the actual measurement from zero or the previous point as defined when the table was initialized For example REPLACE AXISCAL VALUE 1 10 10 321 replaces the 10th axis calibration point measurement value for the first logical axis with the value of 10 321 Important Axis calibration points are numbered axis cal point based on their position on the axis not the order they are entered If you insert an axis calibration point it is assigned an axis cal point number ba
194. hen K is visible and RSIS un row number called is visible when up arrow is pressed ie Softkey row number called when right arrow is pressed Create New Softkey Pointer buttons 1 thru 6 The softkey row pointer called when that softkey is pressed K or the screen pointer called when that softkey is pressed S Current Softkey Row SPD PTR When you first load the softkey editor you will notice that the number on the far left where the up arrow would normally be is 18 This number indicates the current softkey row number So anytime softkey row 18 is called the softkeys PRGRAM MANAG OFFSET MACROPARAM etc are displayed Softkey Row Number Called The number in the white box below where the up arrow should be currently shows a zero This number indicates the row number called when the up arrow is pressed Since this is the first level of softkeys this box is white and zero indicates no new softkey row is called Current Softkey Number The current softkey number appears on top of the right arrow This field is not changeable however since this value is referenced throughout the Basic Display Set it is provided on this screen Edit Softkey Text Buttons The five buttons on the softkey names are used to change the text for a softkey K S Button Initially this button is set to K which indicates the pointer field beneath the softkeys is showing the softk
195. his command will close the axis calibration data tables For example EXIT_AXISCAL_MODIFY_MODE closes the axis calibration table Note this command does not send the axis calibration table to backup memory INITIALIZE_AXISCAL_TABLE axis number calibration_type calibration_start Use this command to initialize the axis calibration table after you have opened it for editing Typically the table is only initialized the first time it is opened for editing This command determines how axis calibration points are entered axis_number Defines the logical axis number as defined in AMP for the axis calibration table being modified This argument is an integer calibration_type Defines how points will be defined Select between 0 measurement points referenced from zero 1 deviation points referenced from previous point calibration_start Defines if the first point is 0 Most on the axis 1 Most on the axis Refer to your AMP reference manual for details on these different axis calibration measurement types For example INITIALIZE AXISCAL TABLE 1 0 1 initializes the axis calibration table for the first logical axis setting referencing all points from the same machine zero point and indicating the first point is the most negative point on that axis Data Server Commands 5 11 INSERT AXISCAL POINT axis number Use this command to insert an axis calibration point at t
196. ibration absolute positions for points 1 thru 34 for axis 1 Use this item in conjunction with the AXISCAL MEAS DEV AMOUNT item which returns the actual measurement for the absolute position AXISCAL MEAS DEV AMOUNT point num axis num Data Type LREAL Read Write Read only Array Index point_number axis_number Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC Data Server Data Items 4 19 The AXISCAL MEAS DEV AMOUNT item 15 used to read back the correction values from the axis calibration table Note this item is read only Data points are added or removed using axis calibration command items Indexes for this item include point num this index identifies which point you are referencing Points can be entered into the table as deviation or absolute Refer to your AMP reference manual for details You can address multiple points with one command An error is returned if a point is requested that does not exist for the specified axis Use this item in conjunction with AXISCAL POINTS USED axis num this index identifies the logical axis number for which you are requesting axis calibration data Axis numbers are determined by your AMP configuration You can only make requests for one axis at a time Use the axis number in this request Axis names are not valid AXISCAL MEAS DEV AMOUNT 5 6 2 returns axis calibration table values of points 5 and 6 for axis 2
197. ies OCI Installation Manual for details on configuring the INI file for 9 Series OCI or the Configuration Manager in the 9 PC Installation and Integration Manual for configuring the 9 PC Item Name The item name for the 9 Series or 9 PC data server can be either a data item refer to chapter 3 br appendix A or a command refer to chapter 4 br appendix B For example AVAILABLE MEMORY Is the valid name of an OCI topic that returns free memory information from the 9 Series or 9 PC Several different VB objects can be used to create DDE links to a DDE server Refer to your VB instruction manual for these items For the following example we created a text box on the VB form and named that text box X RAW This text box then stores the data returned from the data server X RAW Text It is important to remember that if the command fails or is invalid for some reason the string Server Error code for the connection will also be returned as the text value for this text box Your code should test the value of your DDE objects to identify and handle errors appropriately Reading Data In Microsoft Visual Basic the Service and Topic are included in the same property separated by a pipe character and enclosed in quotes This example simply gets the raw value of the axis 1 position no decimal point Later you ll need to format this data as determined by your system configuration before passing it on to users DDE Data Server Examples 2 3
198. iguration baud rate USINT enumer cmd NUM CHANNELS BENE Controls ated AUX CONFIG CHANNEL Aux comm configuration channel name STRING jog MMCHNNIS No RW Al Controls AUX CONFIG CHANNEL TYPE Aux comm configuration channel type USINT enumer MR NUM CHANNELS Controls ated AUX CONFIG FILE PID Aux comm configuration file pid USINT jog NUMCHANNELS RW _ All Controls AUX CONFIG FILE TIMEOUT Aux comm configuration file timeout UINT oi num cHanneLs No RW All Controls AUX CONFIG KEYBOARD PID Aux comm configuration keyboard pid USINT jog NuM cHANNeLS No RW AcContos AUX CONFIG PACKET Aux comm configuration packet timeout UINT NUM CHANNELS HE Controls TIMEOUT AUX CONFIG SERIAL DATA LENGTH Aux comm configuration serial data length USINT Joc NMMCHNNIS No RW Al Controls AUX CONFIG SERIAL PARITY Aux comm configuration serial parity USINT enumer NUM CHANNELS Bow ES All Controls ated AUX CONFIG SERIAL STOP BITS Aux comm configuration serial number of stop USINT NUM CHANNELS Controls bits AUX CONFIG STATION Aux comm configuration station address STRING NUM CHANNELS Ld Controls ADDRESS 26 AUX CONFIG STATUS PID Aux comm configuration status pid USINT NMMCHNNIS No RW Al Controis 321 AUX MODIFYING TABLES Status wor
199. in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP ALL PARAMETERS maind paraback ppg would create the backup program on the CNC s main directory and name the backup program paraback Publication 8520 6 6 August 1999 5 36 Data Server Commands Publication 8520 6 6 August 1999 BACKUP COM1 PARAMETERS Filename string This command tells the control to create a backup program of all the common 1 paramacro parameters 100 199 Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP COMI PARAMETERS maind comlback ppg would create the backup program on the CNCs main directory and name the backup program BACKUP COM2A PARAMETERS Filename string This command tells the control to create a backup program of all the common 2 parama
200. ing the currently configured ordinate axis name Use the ASCII character s representing the desired axis when writing to this item Note valid axis names are listed in your operation and programming manual Some two axis names are two characters e g X Publication 8520 6 6 August 1999 4 56 Data Server Data Items Position Data Items Publication 8520 6 6 August 1999 G CODE STATUS g code group Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this parameter to identify the active G code status the g code group argument is the modal group number to identify the active G code The returned value is 10 times the G code value For example G_CODE_STATUS 2 returns a value of 170 indicating that G code group 2s active G code is G17 You can not use this data item to identify non modal group 0 G codes Leaving off the argument will return all of the active modal G codes AXIS PRESENT LOGICAL BIT PATTERN Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to determine what axes are currently present in the process It returns a bit pattern of the logical axes in the process If a zero is reported to the logical axis number that axis is not pressent in the cur
201. ink ode 1 Set Link Mode to Automatic Execute input mdi string amp Chr 34 amp MDI Input Text amp _ vbLinkNone Using Microsoft Excel MS Excel is also capable of performing DDE conversations with the OCI data server This can prove a useful tool to collect data for statistical analysis of your machine process The following example shows a cell in Excel that is used to store the accumulated tool life though any valid OCI DDE could be substituted for the item name The syntax for a DDE call in Excel is all placed as an equation in the desired cell The equation defines the DDE Application Topic and data item equation syntax is as follows Application Topic ItemName The following is an example of an Excel cell that returns the accumulated tool life for tool number 3 ABOCISERVER CNC_1 TM_ACCUMULATED_LIFE 3 Publication 8520 6 6 August 1999 Chapter 3 OCI Basic Display Set BDS Basic Display Set The Basic Display Set is the standard OCI application software that Overview comes with your system This Windows based application program is the standard operator interface to your CNC It is designed to run in Windows and communicates with the OCI DDE data server The Basic Display Set is designed to closely emulate the 9 Series standard front panel For details on using the OCI Basic Display Set BDS refer to your OCI User s Manual and y
202. int option the Basic Display Set creates or overwrites if the file already exists a data file containing the text corresponding pointer number and other relevant information File naming convention is as follows File Extension Language File Name Error MSG Prompts SPD_Ptrs English English sft SIX spd German Deutsch French Francais Italian Italian Spanish Espanol Publication 8520 6 6 August 1999 Basic Display Set BDS 3 23 A file 1 created only for currently active language the Basic Display Set Use the SWITCH LANG softkey to change the Basic Display Sets displayed language and create different language print files Since the pointer file PD PTR s is identical for all languages the print PD Ptr s selection always creates the file PD ptr pd The following screen shows an example of the English sft file which is compiled from the English softkey tables This file uses tab characters to indicate different levels of the softkey tree It also shows the softkey number to the right of the text English sft WordPad iof xi File Edit View Insert Format Help Dele Sia aJ PRGRAMMANAGE 2 ACTIVEPRGRAM 1 DE ACTPRGRAM 30 SEARCH 610 N SEARCH FORURD REVRSE TOP OFPRGRAM CANCEL EXIT O SEARCH EOB SEARCH FORURD REVRSE TOP OFPRGRAM For Help press F1 This next screen example shows the English spd file which is compiled from the English softkey text file
203. inter or other device connected to the control s port B This will print the reversal error compensation data currently in RAM This may or may not be the same data stored in the control s flash memory For example TRANSFER REVERSAL ERROR TO prints the reversal error data to the device connected to the control s port B You can only use this command to output reversal error data to a printer Important This command does not apply to the 9 PC CNC UPDATE AMP no argument Use this command to save patch AMP changes you have made since the MODIFY AMP command was issued When this command is executed the control saves the edits to patch AMP and closes the AMP image You must cycle power on the control after successfully executing the UPDATE AMP command For example UPDATE AMP updates the AMP file image on the control It does not update AMP in flash memory BACKUP AXISCAL no argument Use this command to back up the current axis calibration tables to flash memory on the control Refer to your AMP reference manual for details on when and why axis calibration should be backed up to flash For example BACKUP AXISCAL writes into flash memory the axis calibration data currently residing in the control s RAM Use the command RESTORE AXISCAL to retrieve axis calibration data from flash Data Server Commands 5 9 DELETE ALL AXISCAL POINTS no argument Use this command to delete all axis
204. ion Manual for using the Configuration Manager on the 9 PC system Publication 8520 6 6 August 1999 5 24 Data Server Commands Offsets Publication 8520 6 6 August 1999 Once in control of a specific CNC other OCI stations can not request control of the CNC until the controlling station relinquishes control Control of a specific CNC is only relinquished when The controlling station successfully sends RELINQUISH CONTROL command The heartbeat timer specified in the OCIDSCFG INI file refer to your OCI installation manual for details times out On the 9 PC check your Configuration Manager When a OCI station gains control of a CNC the heartbeat timer value is sent to the CNC If the CNC does not hear the heartbeat timer from the OCI station in the specified amount of time it assumes the OCI station is no longer valid clears the watchlist for that station and removes that station as the controlling OCI power to the control is lost RESET MAX TIMES no argument This command resets maximum recorded times for system foreground timing These maximums are returned to OCI data items FG CRITICAL and TOTAL STORE OEM MESSAGE no arguments This command writes the entered OEM message which appears on the power turn on screen for standard OCI screens to flash memory Note you enter the OEM message using the data items OEM MESSAGE 1 OEM MESSAGE 2 AND MESSAGE 3 When y
205. ite Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This parameter is used to identify the E STOP status of the control It is updated as a foreground task on the CNC though update time to the OCI station is still configured in AMP Indicates this CNC is in E STOP 1 Indicates this CNC is out of E STOP NUM_PROCESSES Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 Grinder Control Type is not available for Release 1 of 9 PC This parameter is used to identify the number of processes the on the CNC Use this data item to identify multi process systems from single process systems 1 Indicates this controls 1 process 2 Indicates this CNC controls 2 processes Important This parameter does not apply to Release 1 of the 9 PC VELOCITY GAINS FROM TABLE axis num Data Type INT Read Write Read Write Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Data Server Data Items 4 63 This item is used determine if standard motor table values used for digital systems Standard motor tables select motor gains maximum etc from a fixed table based on the motor type selected The axis_num argument for this command identifies which logical axis number to modify Data for this item is enumerated
206. key is pressed New screen numbers added to Basic Display Set should be numbered 1501 or higher below 1501 is reserved by Allen Bradley This will help protect the integrity of your edits if any future Allen Bradley updates are installed on your OCI system Exiting Softkey Edit Mode After you have completed the necessary changes to the softkey tree and screen pointers added you must save and exit the softkey editor Exit the softkey editor by selecting Softkey Tree under the Setup menu PAS tnt TI PIS RAUM Y Basic Display Set SAVE SOFTKEY CHANGES Calling the Screen Pointer in Source Code Once you have added the necessary softkey and screen pointers you must make modifications to your source code to call the proper Screens Screens are called using two subroutines of the Basic Display Set Basic Display Set BDS 3 19 SetSPDPointer You should not need to edit this file unless there are special conditions you wish to apply to determine when and what screen 15 loaded when a softkey is pressed For example you may want to add a condition that prohibits access to a servo configuration screen when running a program SetSPDPointer 1 a routine found in the SOFTKEY BAS This subroutine uses the softkeys PD Number PD_PTR to determine which softkey choice was made and sets the variable ScreenNumber using a series of Case statements The Case Else statement at the end of this routine
207. lease 1 of 9 PC Use this data item is used to set read the current date from the control Format for this text string is mm dd yy where mm month dd day yy year When writing this data item you must use all eight characters of this text string Leading zeros must be included 01 02 96 TIME Data Type String1 Read Write Read Write Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item is used to set read the current time from the control Format for this text string is hr mm ss where hr hour in 24 hour clock mm minute second When writing this data item you must use all eight characters of this text string Leading zeros must be included 22 03 00 Publication 8520 6 6 August 1999 4 40 Data Server Data Items Publication 8520 6 6 August 1999 PROCESS CHANGE REQUEST Data Type INT Read Write Read Write Array Index none Control Type Lathe Mill On dual process systems use this data item to request the control change the currently active process Seting the value of PROCESS_CHANGE_REQUEST to one will request a process change The control resets the value to zero when the process change is completed Use the PAL Logic flag SPROCI to identify the currently actve process Important Dual process systems are not available for the 9 PC PRODUCT_ID Data Type U
208. lgium Brazil e Bulgaria Canada e Chile China PRC Colombia Costa Rica Croatia e Cyprus Czech Republic e Denmark e Ecuador Egypt e El Salvador e Finland e France e Germany Greece e Guatemala e Honduras e Hong Kong Hungary e Iceland e India e Indonesia e Ireland e Israel e Italy e Jamaica Japan e Jordan e Korea e Kuwait e Lebanon Malaysia e Mexico Netherlands e New Zealand Norway e Pakistan Peru e Philippines e Poland Portugal e Puerto Rico Qatar e Romania Russia CIS e Saudi Arabia e Singapore e Slovakia e Slovenia e South Africa Republic e Spain e Sweden Switzerland e Taiwan Thailand e Turkey United Arab Emirates e United Kingdom e United States e Uruguay Venezuela e Yugoslavia Allen Bradley Headquarters 1201 South Second Street Milwaukee WI 53204 USA Tel 1 414 382 2000 Fax 1 414 382 4444 Publication 8520 6 6 August 1999 PN 176714 Copyright 1999 Allen Bradley Company Inc Printed in USA
209. me string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP TOOL GEOM maind geombck ppg would create the backup program on the CNCs main directory and name the backup program geombck BACKUP TOOL WEAR Filename string This command tells the control to create a backup program of the tool wear offset tables Refer to your operation and programming manual for details on wear offsets The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP TOOL WEAR maind wearbck p
210. ment for this command This argument identify the location of this shaft pocket with respect to the total number of pockets needed always one for single pocket tools This argument ranges from 1 to the value entered for pockets needed These argument are integers For example RT CUSTOMIZE TOOL 16 4 2 would identify the tool currently in pocket 16 as a custom tool The shaft pocket is pocket 16 and the tool fixture overlaps pockets 15 16 17 and 18 RT CUSTOMIZE TOOL 3 1 would identify the tool currently in pocket 4 as a custom tool The shaft pocket is pocket 4 and the tool fixture overlaps pockets 5 and 6 Publication 8520 6 6 August 1999 5 56 Data Server Commands Publication 8520 6 6 August 1999 RT SET TOOL NUM too number pocket number Use this command to assign a tool number to a pocket in the random tool tables This command tells the control the location of a tool number in the tool changer Refer to your operation and programming manual for details on using the random tool feature To assign custom tool use the CUSTOM TOOL command register a tool currently in the tool holder use the ACTIVATE RANDOM TOOL command There are two arguments for this command They are tool number the tool number you are defining for the tool changer pocket number the number of the pocket currently holding the tool Both of these arguments are integers For example RT SET TOOL N
211. ms Publication 8520 6 6 August 1999 Channel Number word two value is 4 head or 5 tail Word 3 returns a value corresponding to the communications channel which has the error 1 indicates Port A 2 indicates Port B Slot Number word two value is 6 or 7 Word 3 returns a value corresponding to the slot number of the offending axis module in a 1394 or 9 440 amplifier rack For example if LINE 1 MESSAGE 48 LINE 1 MESSAGE DATA 3 LINE 1 MESSAGE DATA 3 5 it indicates message base 48 see your PAL Logic Manual system error detection chapter should be displayed followed by axis names for logical axes 1 and 3 00101 Assuming logical axes 1 and 3 axis names are X and Z the error message should read EXCESS SKEW ON XZ or if LINE 1 MESSAGE 55 LINE 1 MESSAGE DATA2 1 LINE 1 MESSAGE DATAj 16 it indicates error message 16 from message base 55 see your PAL Manual or 9 PC Logic Interface Reference Manual system error detection chapter should be displayed with no special head or tail characters This error message should read INVALID AMP DEFINED G CODE Important Source files are available with the Allen Bradley OCI Basic Display set source code that have all error message strings and their corresponding message bases Code is also available with the Basic Display Set source that manages these data items and displays errors accordingly Line 1 Message Data has a 4th entry for dual process onl
212. n 8520 6 6 August 1999 For example COPY PORTA SOURCE MAIND DSTIN PPG 1 copies the program named SOURCE from the device connected to port A to the new part program named DSTIN in the main CNC directory Note the PPG extension is not necessary for most devices connected to port A Important This command does not apply to the 9 CNC COPY PORTB TO MEM src dest filename string mode Use this command to copy your part program file from port B to memory either the main or protected directory you can not copy directly to the PC drive The src name string is the name of the part program you are copying from the peripheral device on port B The dest filename string is the same as the file name string given on page Ibat includes specific directory information The remaining argument with this command is the mode argument which is an enumeration used to identify that you want to perform the copy or test the command syntax The test option will check the command syntax including the existence of the source program The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute copy For example COPY PORTB TO MEM SOURCE MAIND DSTIN PPG 1 copies the program named SOURCE from the device connected to port B to the new part program named DSTIN in the main CNC directory Note the PPG extension is not necessary for most de
213. n code For example BACKUP INTERF TABLE maind intbck ppg would create the backup program on the CNCs main directory and name the backup program intbck Important This command does not apply to the 9 PC CNC BACKUP RADIUS TABLE Filename string This command tells the control to create a backup program of the grinder wheel dresser radius offset table for grinder systems only Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on pag 46 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP RADIUS TABLE maind radbck ppg would create the backup program on the CNCs main directory and name the backup program radbck Data Server Commands 5 29 BACKUP TOOL GEOM Filename string This command tells the control to create a backup program of the tool geometry offset tables Refer to your operation and programming manual for details on tool geometry offsets The argument for this command is the filena
214. n this manual The visual basic source code for these default screens is available as an option through your Allen Bradley sales office Publication 8520 6 6 August 1999 Open Control Interface Overview 1 3 DDE Overview DDE is a method used by Microsoft Windows to accomplish process to process communications This common protocol allows a DDE compliant Windows application to communicate with another DDE compliant Windows application DDE has been a part of Windows since version 2 0 and is supported by many of the most popular Windows application packages such as MS Excel and MS Word for Windows The implementation of DDE uses a data server called the OCI data server to send and receive data from the This data server provides a DDE interface so other DDE compliant Windows applications can access data as though the CNC information was from a local DDE device A application must provide three pieces of information to access a single piece of data from the OCI DDE data server e Service or Application name Topic name e tem name The service for your DDE application will be the Allen Bradley OCI DDE data server The name for this service 15 ABOCISERVER For the Allen Bradley OCI data server a topic is an ethernet alias for specific 9 Series CNC Refer to your OCI Installation Guide for details on establishing 9 Series ethernet topic names This alias is identified in the OCIDSCFG INI file as
215. nch Met ACTIVE UNITS Controls ric De grees Probing and Skip Cycles semasa Sex rl ric De 308 DEPTH PROBE FOLLOWING ERROR Following error for the depth probe servo Inch Met ACTIVE UNITS Yes grees ric De grees PROBE APPROACH DISTANCE Probing cycles compensation D Online AMP LREAL Inch Met Metric units always Yes ric De mm grees PROBE APPROACH FEEDRATE Probe cycle approach speed E Online AMP LREAL Inch Met Metric units always Yes 7 ric De mm sec grees Publication 8520 6 6 August 1999 DEPTH PROBE POSITION Position value for depth probe Inch Met ACTIVE UNITS Yes 24 26 23 25 355 07 277 279 SENE 14 Data Items 327 PROBE ENTRY UNITS Units for touch probe data entry INT inch metric enum 280 PROBE_FEEDRATE Probe cycle feedrate F Online AMP LREAL 281 Probe length for compensation Online AMP 82 radius for compensation Online 278 PROBE TOLERANCE BAND Probing cycles compensation B Online AMP STANT from the letter table os Both 194 ACTIVE RANDOM TOOL NUM Active random tool number INT Both 195 ACTIVE RANDOM TOOL NUM POCKETS Number of pockets for active random tool USINT Array Indices Units Dual Dependency Proc Probe Entry Units Inch Met Metric units always Yes ric De mm sec grees Probe Entry Units Inch Met Metric units always Yes ri
216. nd filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP ALL OFFSETS maind allback ppg would create the backup program on the CNC s main directory and name the backup program allback Publication 8520 6 6 August 1999 5 28 Data Server Commands Publication 8520 6 6 August 1999 BACKUP INTERF TABLE string This command tells the control to create a backup program of the interference tables for dual process systems only Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error retur
217. nd is the valid offset number as entered into the offset table for this tool ACTIVATE TOOL RADIUS 4 Activates the tool radius offset number 4 equivalent of programming an D4 in a part program This command only activates the offset value for tool radius D word You must still program the appropriate G code G40 G41 G42 in the part program to specify when and how the offset is activated Refer to your Mill operation and programming manual for details on activating tool cutter compensation Publication 8520 6 6 August 1999 5 26 Data Server Commands Publication 8520 6 6 August 1999 ACTIVATE TOOL WEAR offset number This command activates the specified tool wear offset This command is valid only for lathe control types The offset number argument for this command is the any valid offset number as entered into the tool wear offset table for this tool ACTIVATE TOOL WEAR 4 Activates the tool wear offset number 4 This command only activates the offset value for tool radius T word You must still program the appropriate G code G40 G41 G42 in the part program to specify when and how the offset is activated Refer to your Lathe operation and programming manual for details on activating TTRC ACTIVATE WHEEL GEOM offset number This command activates the specified wheel dresser geometry offset This command is valid only for grinder control types The offset number argument for this command i
218. nd line Basic Display Set BDS 3 15 Changing the Softkey Row Pointer To edit or change the set of softkeys called when a softkey is pressed edit the softkey row pointer The softkey row pointer is located in the white or yellow box beneath the softkey text 6 r OFFS m Er sla 18 MANARE PARAIEN SUPONEN ROME Edit Mode Q Softkey Row Pointers fields 1 thru 7 When the softkey pointer field is yellow it indicates that pressing this key will display another softkey row When the softkey pointer field is white it indicates that pressing this key does not call another softkey row The number in a white softkey row pointer is the softkey number A new form may be loaded for any softkey pressed regardless of if another softkey row is called See Inserting a New Screen on page 3 17 for details on identifying a screen pointer To change the next row of softkeys called by pressing a softkey edit the Softkey Row Number field You can change this field for the five softkeys as well as the up arrow back and right arrow more softkeys Publication 8520 6 6 August 1999 3 16 Basic Display Set BDS 18 RN Publication 8520 6 6 August 1999 Creating Editing a Softkey 1 To create a new or change the operation of an existing softkey press the Create New Softkey Pointer button PRGRAM Uu OFFS n SUPO
219. ne symbol 9240 line o oO C F o Important This command does not apply to the 9 PC CNC AUX COM CMDTBL FLASH no argument This command is used only for systems with a data highway module Use this command to write a command table to the flash memory For example AUX COM CMDTBL TO FLASH Important This command does not apply to the 9 PC CNC AUX COM CONFIG TO FLASH no argument This command is used only for systems with a data highway module Use this command to write an AUX COMM configuration to the flash memory For example AUX COM CONFIG TO FLASH Important This command does not apply to the 9 CNC Publication 8520 6 6 August 1999 Data Server Commands 5 17 AUX COM DOWNLOAD FILE source filename destination filename This command is used only for systems with a data highway module Use this command to download a file using the AUX COM module Note the source filename requires the source directory the destination filename does not For example DOWNLOAD FILE maind PROGI ppg Prog2 ppg Important This command does not apply to the 9 CNC AUX COM HOST WRITE TO FLASH no argument This command is used only for systems with a data highway module Use this command to write the AUX COMM host address configuration to the flash memory For example AUX COM HOST WRITE TO FLASH Important This command
220. ng manual max 20 characters SET PART PROGRAM COMMENT MAIND FILE1 PPG CUT INSIDE THREAD Publication 8520 6 6 August 1999 would assign the comment CUT INSIDE THREAD to the part program named in the main directory Data Server Commands 5 47 SET PART PROGRAM INPUT DEVICE pp source This command selects the input source for part programs The pp source argument is an enumeration as follows PP Source is used to select the source device for part programs For example use this enumeration to specify the port name of a program you intend to execute from a tape reader The PP Source enumeration is Enumeration Result 0 Control Memory 2 Port A 4 Port B Selecting enumeration 0 control memory allows the selection of a program directory either main protected or hard drive using the SET DIRECTORY command For example SET PART PROGRAM INPUT DEVICE 0 selects control memory for program selection Important This command does not apply to the 9 PC CNC SET PART PROGRAM SEARCH PATTERN text string Use this command to set your part program search string This command specifies the text to be searched for in the part program Use this command in conjunction with the ENTER PART PROGRAM SEARCH MODE and the EXECUTE PART PROGRAM SEARCH commands The actual string required for this search depends on these other commands For example SET PART P
221. nt value from the processor CNC containing the item data point through RSLinx Server sends the current value of the item to the DDE Application 9 only Manual Link Server DDE Application Application requests the current data value for 9 PC eo item contained in the OCI Server CNC The Server reads the current value from the 9 PC processor containing the item data point Server sends the current value of the item to the DDE Application Publication 8520 6 6 August 1999 4 10 Data Server Data Items Automatic Link Data that is identified as an automatic link type is added by the OCI server to the watch list The value for the item is then sent from the control to the OCI server and again any time the data item on the watch list changes Your application receives updates to the items each time the value changes on the control OCI 9 Series Automatic Link Server RSLinx DDE application requests automatic data item 9 from the OCI server The data server requests the 9 Series control add the data item to the 9 Series watch list CNC 0 The CNC adds the data item to the watch list and sends the current value of the data item back to the OCI server The 9 Series sends the value to the OCI data server whenever the item value changes The OCI server then passes the new value on to the DDE Application The 9 Series continues t
222. o update the OCI data server every time the value of the data item changes as long as the item remains in the 9 Series watchlist Notify link mode option though supported by most DDE application programs are not recommended Since the OCI system is designed to minimize network traffic notify links are added to the watch list instead of requiring your server continuously pole the CNC for status This nullifies the advantages typically gained by using a notify link type OCI 9 PC Automatic Link Server DDE application requests automatic data item from the OCI server The data server requests the 9 PC control add the data item to the 9 PC watch list CNC 0 The CNC adds the data item to the watch list and sends the current value of the data item back to the OCI server The 9 PC sends the value to the OCI data server whenever the item value changes The OCI server then passes the new value on to the DDE Application The 9 PC continues to update the OCI data server every time the value of the data item changes as long as the item remains in the 9 PC watchlist Publication 8520 6 6 August 1999 Data Server Data Items 4 11 WatchList Once your DDE application makes DDE request to data server the data item is added to a watchlist maintained by the CNC New items are added and old items are removed from the watch list as requested by the OCI data server Once the CNC has a wat
223. ol Type is not available for Release 1 of 9 PC This item is used to determine what axes are currently selected as the tool length axes in the process It returns a bit pattern of the logical axes in the process If a zero is reported to the logical axis number that axis is not currently a tool length axis A one indicates the logical axis is a tool length axis For example ACTIVE_TOOL_LENGTH_AXIS_LOGICAL_BIT_PATTERN 1 Could return the bit pattern 00000100 This would indicate that the third axis defined in that process is selected as the tool length axis Publication 8520 6 6 August 1999 4 44 Data Server Data Items Publication 8520 6 6 August 1999 ACTIVE TOOL WEAR NUM Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The ACTIVE_TOOL_WEAR_NUM data item identifies the last tool wear offset number activated on the control This tool wear number may have been activated through part program execution or from the execution of the OCI command ACTIVATE TOOL WEAR Note that an active offset number does not necessarily indicate the offset is physically implemented on the machine It only indicates the number of the offset that may or may not be active depending on the programmed operating mode of the control and the AMP configuration on how the offset is activated Refer to the offset chapter of your operation
224. on overview overview Data Links creating subroutine 3 10 Data Server commands defined read requests write requests 1 4 Data Types for data items 4 2 DATASCOPE_DATA A 7 DATE DDE automatic links manual links 4 9 notify links OCI interaction POKE requests service name topic name your compliant application DDE Item Name DDE Overview DDE Service DDE Topic Name DEACTIVATE PART PROGRAM B 4 B 6 DEACTIVATE RIO PASSTHROUGH 5 18 2 Debugging global variable Debugging Utilities DEFAU LT SCALE 5 12 DELETE ALL AXISCAL POINTS DELETE AXISCAL POINT DELETE PART PROGRAM 5 43 B 4 Delimination of Multiple Data DEPTH PROBE FOLLOWING ERROR DEPTH PROBE POSITION A 13 Destroylnactive RSJbox Development Tool Visual Basic DEVICE ON PORTA 4 3 DEVICE ON 3 DG code data file DH BAUD RATE Enumeration DH CHANNEL TYPE Enumeration 6 5 DH COMMAND Enumeration 6 5 DH OUTPUT FORMAT Enumeration DH PARITY Enumeration DH REMOTE STATION Enumeration 6 7 Dimension two dimensional array Directory source code destination Directory Structure BDS source code Directory Set Command Disks installing BDS source code Display formatting subroutine 3 10 Display Form DISTANCE TO MARKER A 16 DLL RSJBox Document using print utilities 3 22 DOWNLOAD IN PROGRESS A 7 DOWNLOAD IN PROGRESS Enumeration 6 5
225. one 1 331 INTERF FIRST AXIS MINUS AREA 2 Interference zones first axis minus limit for dual LREAL Interf Tool Number Inch Met INTERF UNITS process interference zone 2 ric De Interf Tool Number grees Controls Controls Controls Num Axes Inch Met ACTIVE UNITS ric De grees 20 Data Items Description Data Type OCI 9 PC Array Indices Units Dual Control Type Dependency Proc LIMIT3 LOWER LIMITS Limit 3 Lower Limit LREAL OCI Num Axes Inch Met ACTIVE UNITS Yes R W All Controls ric De grees LIMIT3 UPPER LIMITS Limit 3 Upper Limit LREAL OCI Num Axes Inch Met ACTIVE UNITS Yes All Controls ric De grees LOGICAL AXIS ZONE GROUP Array of integers for each axis where UINT OCI Num Axes Yes Controls 0 axis is not in zone group 2 axis is in zone group 2 3 axis is in zone group 3 Publication 8520 6 6 August 1999 Commands Inst Item Name Command Description Control Type ID AMP Commands s s 9 PC Both Both Both OCI 53 TRANSFER FROM PORTB AMP from port B 48 TO PORTA to port 52 TRANSFER TO PORTB AMP to port B Contro 56 TRANSFER HOMECAL TO PORTA Home calibration to port A Controls 62 TRANSFER HOMECAL TO PORTB Home calibration to port Controls 58 TRANSFER REVERSAL ERROR_TO_ Reversal error to port A
226. or example assigning a value of 1 to the following item PORT AUTO FILENAME 2 enables the auto filename feature for port B The enumeration is only available for tape devices that do not support this feature PORT STOP AT PROGRAM port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read enable disable the tape stop at program end feature This feature is used for tape devices Refer to your operation and programming manual for details on using this feature The index port_id identifies the port as follows port A 2 port B The id index must always be used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 No disabled 1 Yes enabled 2 N A For example assigning a value of 1 to the following item PORT STOP AT PROGRAM END 2 enables this feature for port B The N A enumeration is only available for tape devices that do not support this feature Non tape devices do not have this feature and will return an error if you attempt to read or write this data item Data Server Data Items PORT REWIND ON MO2 M30 port id 4 27 Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read enable di
227. ors on Manual 1 6 2552558 1 6 Your Development Tool Visual Basic 1 7 Special API Development Tools 1 7 RSLinx JBOX and RSData OCX 1 7 Basic Display Set Source Code Routines 1 8 Chapter 2 DDE Data Server Examples DDE Conversation 2 1 DUE SONG o REP 2 1 ID diro ETT 2 2 2 2 Using Visual Basic 2 2 Reading Data 2 2 Writing Data POKE 2 3 DDE Commands 2 4 Using Microsoft 2 4 Chapter 3 OCI Basic Display Set BDS Basic Display Set Overview 3 1 Installing the Source Code 3 2 Installing RSData Custom OCX 3 3 Source Code Directory Structure 3 3 Data FIGS m 3 4 Basic Display Set Source Code Overview 3 5 Basic Display Set Screen Construction 3 6 Basic Display Set Basic Modules 3 7 Using MASTERM FRM 3 8 Template to Create a Display Form 3 8 Making a
228. ot have this feature Data Server Data Items 4 29 PORT PROGRAM NAME port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read enable disable the part program name on tape feature This feature is used for tape devices Refer to your operation and programming manual for details on using this feature The index port_id identifies the port as follows 1 port A 2 port B The id index must always be used with this data item You not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 No disabled 1 Yes enabled 2 N A For example assigning a value of 1 to the following item PORT PROGRAM NAME 2 enables this feature for port B The N A enumeration is only available for tape devices that do not support this feature Non tape devices do not have this feature PORT TIMEOUT VALUE port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read write the timeout value used for the specified communication port The index port_id identifies the port as follows port A 2 port B Publication 8520 6 6 August 1999 4 30 Data Server Data Items Publication 8520 6 6 August 1999 The port_id index must always be
229. ote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP TOOL MANAGE maind mangback ppg Would create the backup program on the CNCs main directory and name the backup program mangback Data Server Commands 5 55 RT CUSTOMIZE TOOL pocket number pockets needed shaft pocket Use this command after you have already entered a tool number in the pocket using the RT SET TOOL NUM command and you need to make this a custom tool by adding additional pocket spaces and defining the shaft pocket for the tool This command tells the control how many pockets a tool requires and the location of the shaft pocket with respect to the first pocket for the custom tool Refer to your operation and programming manual for details on using the random tool feature There are three argument for this command They are pocket number the pocket number you are defining for the custom tool Note there must be a tool already assigned to this pocket This pocket number is the shaft pocket for the tool pockets needed the number of pockets required to hold this tool Include any pockets that the tool fixture overlaps shaft pocket the shaft pocket is always the pocket number used in the first argu
230. ou send the STORE OEM MESSAGE command to the control the current text string in these three data items is stored to flash memory for display on the power turn on screen ACTIVATE TOOL GEOM offset number This command activates the specified tool geometry offset This command is valid only for lathe control types The offset number argument for this command is the any valid offset number as entered into the tool geometry offset table for this tool ACTIVATE TOOL GEOM 4 Activates the tool geometry offset number 4 Data Server Commands 5 25 ACTIVATE TOOL LENGTH offset number This command loads the specified tool length offset H word This command is valid only for mill control types The offset number argument for this command is the valid offset number as entered into the offset table for this tool ACTIVATE TOOL LENGTH 4 Activates the tool length offset number 4 equivalent of programming an H4 in a part program This command only activates the offset value for tool length H word You must still program the appropriate G code G43 G44 G49 in the part program to specify when and how the offset is activated Refer to your Mill operation and programming manual for details on activating tool length offsets ACTIVATE TOOL RADIUS offset number This command loads the specified tool radius offset D word This command is valid only for mill control types The offset number argument for this comma
231. our operation and programming manual For details on installing the OCI Basic Display Set refer to your OCI Installation Manual or your 9 PC Installation and Integration Manual This chapter is designed to give you an understanding of how the Basic Display Set was developed and make it easier for you to modify and customize the Basic Display Set for your application The Basic Display Set was developed using Microsoft s Visual Basic Pro development tool Important Allen Bradley assumes no responsibility for the operation and function of the Basic Display Set once it has been modified from its original form To edit the Basic Display Set you will need personal computer running the Microsoft Windows NT version 4 0 or later operating system Microsoft Visual Basic version 5 0 or 6 0 e RSData custom control a product of Rockwell Software Allen Bradley Basic Display Set source code disks OCI 9 PC A working knowledge of Visual Basic Pro Windows programming and the concepts of Dynamic Data Exchange DDE We recommend your personal computer be linked through an Ethernet connection to an OCI compatible 9 Series CNC or have a 9 PC CNC running please use the 9 PC Configuration Manager to ensure that the 9 PC is running This is helpful for writing and debugging your edits In addition to the above list this optional connection requires Appropriate personal computer ethernet hardware and drivers
232. ource code MESSAGE 1 28 MESSAGE 2 A 8 OEM MESSAGE _3 A 8 Offset Commands ACTIVATE TOOL GEOM ERA ACTIVATE TOOL LENGTH ACTIVATE TOOL RADIUS 5 55 ACTIVATE TOOL WEAR 5 26 ACTIVATE WHEEL GEOM ACTIVATE WHEEL RADIUS BACKUP ALL OFFSETS BACKUP INTERF TABLE BACKUP RADIUS TABLE BACKUP TOOL GEOM BACKUP TOOL WEAR 20 BACKUP _ WHEEL nn roue BACKUP WORK COORD COPY OFFSET 5 31 5 31 Index l 13 MEASURE TOOL GEOM 5 31 MEASURE TOOL WEAR 5 32 MEASURE WHEEL GEOM 5 32 Offset Data ACTIVE TOOL GEOM NUM ACTIVE TOOL LENGTH EE LOGIC AL BIT PATTERN 8 ACTIVE TOOL RADIUS RUM ACTIVE TOOL WEAR NUM 4 44 AMPED TOOL LENGTH AXIS LOGIC AL PATTERN 4 45 A 8 D WORD DRILLING AXIS oe ee RN H_WORD a MAX GEOM OFFSET A 9 MAX GEOM OFFSET CHANGE 825 MAX_GEOM_RADIUS MAX_RADIUS_CHANGE A 9 MAX WEAR OFFSET 9 MAX WEAR OFFSET CHANGE 9 MAX WEAR RADIUS 9 MILL GEOM OFFSET A 9 MILL MAX GEOM OFFSET CHANGE MILL MAX WEAR OFFSET 9 a A 9 NUM_TOOLS T 9 TOOL ENTRY 9 TOOL LENGTH GEOM OFFSETS 3 3 TOOL LENGTH WEAR OFFSETS TOOL ORIENTATION A 10 TOOL RADIUS GEOM OFFSETS TOOL RADIUS WEAR OFFSETS WHEEL GEOM OFFSETS A 10 OFFSET NUM Index Offsets ACTIVATE TOOL GEOM E ACTIVATE TOOL LENGTH B 3 ACTIVATE TOOL RADIUS B 3 ACTIVATE TOOL WEAR B 3 ACTIVATE
233. p 2 Publication 8520 6 6 August 1999 Chapter 6 Array Indices and Strings Variable Ranges The following section lists the range of select variable indices Other enumerated indices and strings are discussed later in this chapter Indices Name see appendix A Max Value 9 Series 9 LOG SIZE 9 999 MAX BLOCK TRANSFER 32 MAX CUSTOM DIM 20 MAX NUMBER POCKETS 201 MAX NUMBER RING DEVICES 4 N A MAX OFFSETS 201 MAX PAL MESSAGES N A MAX PAXES 12 MAX REMOTE 10 8 8 MAX SLOTS 16 MAX TOOL ENTRIES 201 MAX TOOL GROUPS 201 MAX WORK COORD 10 DUMP SIZE 10 NUM CHANNELS N A NUM CMDS 64 N A NUM CNC DIRECTORIES 2 NUM 2 PARAMS 20 NUM DEVICES N A NUM DISP LINES 9 9 NUM FEATURES 26 NUM OEM MSGS 3 NUM OPTION SLOTS N A NUM MSGS 122 122 NUM VIRTUAL NAMES 4 4 Enumerations This section lists the enumerations that can be passed to or from the control with the different commands and data items The enumerations that are valid with a specific command or data item are listed with the command or data item descriptions ACTIVE RADIUS DIAMETER MODE enumeration This enumeration identifies the controls operating mode for diameter or radius programming Enumeration Result 0 Not Radius Diameter Axis 1 Radius Mode 2 Diameter Mode Publication 8520 6 6 August 1999 6 2 Array Strings DATA enumeration This enumeration identifies the data type for parameters
234. pg would create the backup program on the CNCs main directory and name the backup program wearbck Publication 8520 6 6 August 1999 5 30 Data Server Commands Publication 8520 6 6 August 1999 BACKUP WHEEL GEOMETRY Filename string This command tells the control to create a backup program of the grinder wheel dresser geometry offset table for grinder systems only Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on page 6 19 which will specify the directory and filename for the backup program The target directory for this backup program must be either the MAIND or PROTD You cannot create the backup program on the remote OCI hard drive If the filename specified with this argument does not exist on the CNC the control will create it assuming proper syntax is followed in the command If the filename already exists the control will abort the backup and send an error return code For example BACKUP WHEEL maind geombck ppg would create the backup program on the CNCs main directory and name the backup program geombck Important This command does not apply to the 9 CNC BACKUP WORK COORD Filename string This command tells the control to create a backup program of the work coordinate system offset tables Refer to your operation and programming manual for details on work coordinate offsets
235. r AMP reference manual for details on when and why AMP should be restored from flash For example RESTORE AMP Important This command does not apply to the 9 PC CNC Data Server Commands 5 5 TRANSFER FROM PORTB no argument Use this command to restore an AMP configuration that was backed up to a peripheral device attached to the control s port B This will restore the AMP configuration to RAM For example TRANSFER FROM PORTBJ reads the AMP configuration from the device connected to the control s port B This command will overwrite the AMP file currently in the control s RAM This will not affect the configuration stored in the control s flash memory It is necessary to cycle power on the control when AMP is restored Important This command does not apply to the 9 PC CNC TRANSFER AMP TO PORTA no argument Use this command to back up the current AMP configuration to a device connected to the control s portA This will back up configuration currently in RAM This may or may not be the same configuration stored in the control s backup memory For example TRANSFER AMP TO PORTA writes the AMP configuration to the device connected to the control s port A This backup file is not in a man readable format If you require a man readable version of AMP refer to the ODS document utility Use the command TRANSFER FROM PORTA to retrieve an AMP configuration from a peripheral d
236. r CNC Commands 5 33 ref pos the fixed reference position with no geometry or wear offsets active of the wheel or dresser Refer to your operation and programming manual for details on determining this fixed machine position This is the position the control compares to the actual axis position to determine the geometry amount Important Lathe and Cylindrical Grinder control types this position ref pos value is always entered as a radius value For example MEASURE WHEEL GEOM 2 1 1 777 would perform a measure operation to calculate the geometry offset amount for tool offset 2 axis 1 If no tool geometry or wear offsets were present the current tool position should be 1 777 The control then compares the actual tool position to 1 777 and uses the difference to create the appropriate geometry offset Important This command does not apply to the 9 PC CNC TRANSFER PAL FROM PORTA no argument Use this command to restore a PAL image from a peripheral device attached to the control s portA This will restore the PAL image to RAM For example TRANSFER PAL FROM PORTA would read the PAL image from the device connected to the control s port A This command will overwrite the PAL image currently in the control s RAM This will not affect the PAL image stored in the control s backup memory You must cycle power to the control whenever PAL is updated Important This command does not apply to the 9 PC CNC Pu
237. r a comment name string of a directory that is currently empty the server error code 29 is returned Publication 8520 6 6 August 1999 4 54 Data Server Data Items Part Program Block Data Items Publication 8520 6 6 August 1999 ACTIVE PART PROGRAM BLOCKS setup buffers Data Type String Read Write Read only Array Index setup buffers Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This data item is used to identify either the currently executing or about to execute part program blocks The control looks ahead a certain number of blocks when a part program is selected as active These blocks are loaded into the controls setup buffer The number of blocks actually in the controls setup buffer are dependent on the amount of available memory at any given time on the control The index for this data item is the number of the setup blocks The active block the one that s about to execute is in setup buffer 1 To request the active part program block you would link ACTIVE PART PROGRAM BLOCKS You must include the index with this data item You can not return more than one block per DDE request Important Due to the speed at which the control is capable of executing part program blocks some very short or blocks may not get passed to the DDE data server before the next block moves into that slot in the setup buffer This can cause some very
238. r spindle num is the number of configured spindles in The return value is enumerated as follows Enumeration Result 0 None 1 Position or Analog Spindle 2 Position Velocity 4 Digital or Digital Spindle 8 SERCOS SPINDLE SPEED VALUE Spindle Num Data Type LREAL Read Write Read only Array Index SPINDLE NUM Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to identify the spindle speed in RPM This item can be used as an array whose dimension is equal to the number of spindles on the 9 Series being polled For example SPINDLE SPEED VALUE 2 will return the spindle speed in RPM for the second spindle on the control S WORD Data Type LREAL Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This data item returns the last programmed S word This is not necessarily the active spindle RPM only the value of the last programmed S word for the spindle The spindle that the S word is applied to is dependent on the active controlling spindle when the S word was programmed G12 1 to G12 3 on the 9 Series or G12 1 to G12 2 on the 9 PC Publication 8520 6 6 August 1999 4 62 Data Server Data Items System Information Data Items Publication 8520 6 6 August 1999 ESTOP STATE Data Type USINT Read Wr
239. r the source code adds a screen pointer to the softkey structure Note the screen pointer added is always the same number as the softkey pointer see page 3 17 or details on screen pointers To edit view or change the screen pointer for a softkey view the screen pointer by clicking on the K button to toggle it to S screen mode Change the pointer manually as discussed in the next section Creating Editing the Screen Pointer To change the screen number called when a softkey is pressed edit the Screen Pointer Number field while in the softkey editor You can change this field for the five softkeys You can not change the screen number displayed when the up arrow back or right arrow more softkeys are pressed PR6RAM PRGRAM 18 MANAGE WA PARAM JEN CHECK SUPORTE TAN must be in Screen 10 0 0 0 Edit Mode S k Screen Pointer Number Fields buttons 1 thru 5 Important Edits to this field are typically only necessary when changing the field for an existing softkey If you are adding a new softkey to call a screen follow the directions for adding a softkey on 3 16 you will be prompted if you want the system to add the screen number automatically Publication 8520 6 6 August 1999 3 18 Basic Display Set BDS Publication 8520 6 6 August 1999 A zero in the screen pointer field indicates that no screen is called when that soft
240. ram directory This command is only valid when the input device is set to CNC using the command SET PART PROGRAM INPUT DEVICE The two arguments for this command are as follows target dir This argument is enumerated and identifies the directory to select The enumeration is as follows Enumeration Result 1 Main Directory Selects the main part program directory on the control 2 Protected Selects the protectable part program directory on the control Hard Drive Selects the local or network drive on the PC as 3 defined for the OCI file handler OCIFHCFG INI for 9 Series or the Configuration Manager for the 9 PC Refer to your OCI installation documentation for details on this file password string The protected directory of the CNC may be configured to require a password before allowing access If a password is necessary to select the directory use this second argument to include the password If no password is required this argument must still be passed as a NULL character For example SET DIRECTORY Q opertr1 would select the protected CNC directory using the password opertr1 SET PART PROGRAM COMMENT filename string text string This command adds a comment to the part program name to help better identify the part program The filename string format is given on and includes specific directory information The text string is the program comment as discussed in your operation and programmi
241. rce code 4 Follow the setup instructions as prompted on the screen Important During the setup process you will be prompted for a destination directory for this source code It is important that you choose the same directory that was used to load the Basic Display Set executable The Basic Display Set executable installation contains data files not included with the source code that are necessary to build a working OCI system The default setup directory for both the Basic Display Set executable and source code is or c ab9PC depending on the system the Basic Display Set was developed for 9 Series or 9 PC Basic Display Set BDS 3 3 When the setup utility is complete the Visual Basic Pro project file ABOCI VBP is installed in the source code directory Before you can open this project in Visual Basic you must first install the custom OCX called RSData This custom OCX is an improved DDE tool used extensively in the Basic Display Set source code Installing RSData Custom RSData is a Microsoft OLE custom control OCX created by OCX Rockwell Software The RSData control is designed to be used with any Dynamic Data Exchange Server and provides enhanced performance when used with applications that conform to AdvanceDDE protocol This custom OCX is used extensively in the Basic Display Set source code The RSData OCX uses a high speed DDE communications module called RSJunctionBox RSJunctionBox allows RS
242. rent configuration A one indicates the logical axis is in the plane For example AXIS_PRESENT_LOGICAL_BIT_PATTERN 1 Could return the bit pattern 00000111 This would indicate that the first second and third axes are present in process one Data Server Data Items 4 57 PLANE AXIS INDICES plane axes Data Type INT array Read Write Read only Array Index plane_axis Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to determine the axes in the currently active plane This item returns the axis number of the logical axes in the process If a zero is reported to the logical axis number that axis is not in the currently active plane Dual axes will return a set bit for all axes in the dual group if the group is in the process For example PLANE AXES INDICES 2 1 Returns an integer array of axes currently in the plane If this returns a 3 this would indicate the third logical axes in process two are in the currently active plane The first array reterns the number of the first axis in the plane The second array the second axis in the plane ROLLOVER AXIS LOGICAL BIT PATTERN Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to determine what axes are currently configured as rollover axes in the in the proce
243. responds to the position of the servo module in the chassis Not including the num module index results in the data being returned for all servo modules in the system separated by the TAB character 9 260 9 290 Chassis Servo Modules 3 1 2 Important the 9 PC system the number of servo modules is always 1 Offset Data Data Server Data Items 4 43 ACTIVE TOOL GEOM NUM Data Type UINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The ACTIVE_TOOL_GEOM_NUM data item identifies the last tool geometry offset number activated on the control refer to the offset chapter of your operation and programming manual for details This tool geometry number may have been activated through part program execution or from the execution of the OCI command ACTIVATE_TOOL_GEOM Note that an active offset number does not necessarily indicate the offset is physically implemented on the machine It only indicates the number of the offset that may or may not be active depending on the programmed operating mode of the control and the AMP configuration on how the offset is activated Refer to the offset chapter of your operation and programming manual for details ACTIVE TOOL LENGTH AXIS LOGICAL BIT PATTERN Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Contr
244. rol s port A This command will overwrite the axis calibration data currently in the control s RAM This will not affect axis calibration data stored in the control s backup memory Important This command does not apply to the 9 PC CNC Data Server Commands 5 13 TRANSFER AXISCAL FROM PORTB no argument Use this command to restore an axis calibration data table from a peripheral device attached to the control s port B This will restore the axis calibration data to RAM For example TRANSFER AXISCAL FROM PORTB would read the axis calibration data from the device connected to the control s port B This command will overwrite the axis calibration data currently in the control s RAM This will not affect axis calibration data stored in the control s backup memory Important This command does not apply to the 9 CNC TRANSFER AXISCAL TO PORTA no argument Use this command to back up the current axis calibration data to a device connected to the control s port A This will back up axis calibration data currently in RAM This may or may not be the same axis calibration data stored in the control s backup memory For example TRANSFER AXISCAL TO PORTA would write the axis calibration data to the device connected to the control s port A This backup file is not in a man readable format Use the command TRANSFER AXISCAL FROM PORTA to retrieve axis calibration data configuration from a peripheral device
245. rors are returned as text to the requesting DDE object e g Server Error 29 RSLinx OEM is installed on your windows workstation as an integral part of a complete OCI system This Rockwell Software utility provides the OCI DDE data server access to the 9 Series CNC through an ethernet connection A copy of RSLinx OEM comes with each OCI system you purchase from Allen Bradley RSLinx is not included with the development tool For each OCI station that you create or ship you must purchase an additional RSLinx license for that station Contact your Rockwell Automation sales representative for additional RSLinx licenses Your Development Visual Basic Special API Development Tools Open Control Interface Overview 1 7 Many development tools are available to enhance your machine interface as well as document machine statistics etc This manual is written assuming the use of Microsoft s Visual Basic development tool When we developed the basic display set we took advantage of several special development tools to simplify development and improve performance of our application RSLinx JBOX and RSData OCX The basic display set was developed using a sub set of Rockwell Softwares RSTools development kit This development tool provides many custom controls that will improve the look of your final application as well as enhance performance The basic display set makes extensive use of the RSData OCX custom con
246. routine 3 10 DisplayRows subroutine 3 10 Linx RSLinx Lite LoadScreenForm 3 19 LOG SIZE Index Logical vs Physical Axes LOGICAL AXIS ZONE GROUP LOT SIZE A 12 M M CODE STATUS M GROUP PROGRAMMED 6 17 M MODAL GROUP Index MACHINE TYPE A 8 MACHINE TYPE Enumeration Main MDI form MAINMDI form Manual Items errors on 1 6 Manual Link Type MARKER STATUS A 16 MASTER FRM Max Characters in prompt MAX BLOCK TRANSFER Index MAX CUSTOM DIM Index MAX GEOM OFFSET A 9 GEOM OFFSET CHANGE A 9 MAX GEOM RADIUS A 9 MAX NEGATIVE TORQUE A 16 NUMBER POCKETS Index 6 1 NUMBER RING DEVICES Index OFFSETS Index 6 1 PAL MESSAGES Index MAX POSITIVE TORQUE A 16 Index 1 11 MAX RADIUS CHANGE A 9 RAXES Index 6 1 REMOTE 10 Index SLOTS Index MAX TOOL ENTRIES Index MAX TOOL GROUPS Index MAX WEAR OFFSET A 9 WEAR OFFSET CHANGE MAX WEAR RADIUS A 8 MAX WHEEL SPEED A 7 MAX WORK COORD Index MDI main source code MEASURE TOOL GEOM MEASURE TOOL WEAR MEASURE WHEEL GEOM MEM DUMP SIZE Index MEMORY DUMP ADDRESS A 10 MEMORY DUMP DATA A 10 Menu print enable MID START ACTION Enumeration MID START TYPE Enumeration Mill Data Items MILL GEOM OFFSET A 9 MILL MAX GEOM OFFSET CHANGE 9 MILL MAX WEAR OFFSET A 9 MILL MAX WEAR OFFSET CHANGE MIN WHEEL DIAMET
247. rror code in the command error API item Test mode success can be checked using the COMMAND ERROR CODE API item Data Server Commands 5 49 VERIFY WITH PORTA filename1 mode Use this command to perform a compare of two part programs One must reside in control memory you can not verify program on the hard drive with this command and one must be on the peripheral device attached to serial port A if you need to verify a part program from memory to memory see VERIFY PART PROGRAM command The filenamel argument is a file name strings and is described on page 6 19 This file should be resident in control memory The remaining argument with this command is the mode argument which is an enumeration used to identify that you want to perform the verification or test the command syntax The test option will check the command syntax The enumeration for the mode argument is as follows Enumeration Result 0 test mode 1 execute verify For example VERIFY_WITH_PORTA MAIND FILE1 PPG 1 performs the verification of part programs FILE1 which resides in the controls main program directory against the file currently accessed through portA Results of this command come back as an error code in the command error API item ACTIVE ERROR MESSAGES Test mode success be checked using the COMMAND ERROR CODE API item Important This command does not apply to the 9 PC CNC Publication 8520 6 6
248. rt program Copies part program ile memory to port A ile memory to port B ile port A to memory ile port B to memory Deactivates part program Deletes part program Enters part program search mode Executes part program search Reformats part program memory Renames part program Sequence stop part program Sets directory Sets comments for part program Inputs device Sets part program search pattern Verifies part program Verifies part program with port A Verifies part program with port B Enters midstart search mode Executes midstart search Sets midstart seach pattern Stops Quick Check Quick Checks syntax Activates random tool Backup random tool data to part program Backup tool management data to part program Control Type gt Contro gt Contro gt Contro Contro S gt Contro Contro gt Contro gt Contro gt Contro gt Contro gt Contro gt Contro gt Contro gt Contro gt Contro gt Controls Contro gt Contro gt Contro gt Contro gt Contro Contro Controls Controls Lathe Mil Dual Lathe Mil Dual Lathe Mil Dual OCI 9 PC Dual Proc d Source File Name STRING1 Source File Name STRING1 Source File Name STRING1 Dest File Name STRING1 Des
249. s 600 Seconds Unlimited no timeout o mm co Important does not apply to the 9 CNC Publication 8520 6 6 August 1999 6 16 Array Indices Strings Publication 8520 6 6 August 1999 PP_SOURCE enumeration PP Source enumeration is used to select the source that the executing part program is going to come from For example use this enumeration to specify the port name of a program you intend to execute from a tape reader The Source enumeration is Enumeration Result 0 Control Memory 21 Port 41 Port B Important Does not apply to the 9 PC CNC PRODUCT 1 enumeration PRODUCT ID enumeration is used to identify the hardware platform The PRODUCT ID enumeration is Enumeration Result 9 9 260 Lathe Mill 10 9 260 Grinder 11 9 290 Lathe Mill 12 9 290 Grinder 15 9 260 Multi Process 17 9 290 Multi Process 22 9 PC Lathe Mill ROTATION EXT STATUS enumeration Rotation Ext Status enumeration is used to identify the status of external part rotation for a specific axis The Rotation Ext Status enumeration is Enumeration Result 0 External Rotation ON 1 External Rotation OFF SCALING INDICATOR enumeration Scaling Indicator enumeration is used to identify the status of scaling for a specific axis The Scaling Indicator enumeration is Enumeration Result 0 Scaling Off 1 Scaling On
250. s the any valid offset number as entered into the wheel or dresser geometry offset table for this tool ACTIVATE WHEEL 4 Activates the wheel dresser geometry offset number 4 Important This command does not apply to the 9 PC CNC Data Server Commands 5 27 ACTIVATE WHEEL RADIUS offset number This command activates the specified wheel dresser radius offset This command is valid only for grinder control types The offset number argument for this command is the any valid offset number as entered into the wheel dresser offset table for this tool ACTIVATE WHEEL RADIUS 4 Activates the wheel dresser offset number 4 This command only activates the offset value T word You must still program the appropriate G code G40 G41 G42 in the part program to specify when and how the offset is activated Refer to your Grinder operation and programming manual for details on activating dresser wheel radius compensation Important This command does not apply to the 9 CNC BACKUP ALL OFFSETS Filename string This command tells the control to create a backup program of the all offset tables including work coordinate system tool geometry and tool wear offset tables of these tables are backed up into one part program file Refer to your operation and programming manual for details The argument for this command is the filename string as discussed on page 6 19 which will specify the directory a
251. sable the tape rewind on 02 30 feature This feature is used for tape and intelligent devices Refer to your operations and programming manual for details on using this feature The index port_id identifies the port as follows port A 2 port B The id index must always be used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 No disabled 1 Yes enabled 2 N A For example assigning a value of 1 to the following item PORT REWIND ON M02 M20 2 enables this feature for port B The N A enumeration is only available for tape devices that do not support this feature Non tape devices do not have this feature and will return an error if you attempt to read or write this data item PORT REWIND ON M99 port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read enable disable the tape rewind on M99 feature This feature is used for tape or intelligent devices Refer to your operations and programming manual for details on using this feature The index port_id identifies the port as follows port A 2 port B Publication 8520 6 6 August 1999 4 28 Data Server Data Items Publication 8520 6 6 August 1999 The port_id index must always be used with this data item You can no
252. sed on its position on the axis All other points are renumbered accordingly Publication 8520 6 6 August 1999 5 12 Data Server Commands Publication 8520 6 6 August 1999 RESTORE AXISCAL no argument Use this command to restore into RAM the axis calibration data currently in flash memory This command will overwrite any axis calibration data currently residing in RAM Refer to your AMP reference manual for details on when and why axis calibration should be restored from flash For example RESTORE AXISCAL would write into RAM the axis calibration data currently stored in backup memory Use the command BACKUP AXISCAL to store axis calibration into backup STOP AXISCAL axis number Use this command to disable axis calibration on the specified axis axis number Defines the logical axis number as defined in AMP for the axis to disable axis calibration This argument is an integer DINT For example STOP AXISCAL 1 would cancel axis calibration from being applied to logical axis 1 Once disabled axis calibration can only be enabled by re homing the axis TRANSFER AXISCAL FROM PORTA no argument Use this command to restore an axis calibration data table from a peripheral device attached to the the control s port This will restore the axis calibration data to RAM For example TRANSFER AXISCAL FROM PORTA would read the axis calibration data from the device connected to the cont
253. sets the variable ScreenNumber PD PD_PTR ScreenNum The variable ScreenNum is the screen number pointer assigned in the softkey tree see page 3 17 so by default this routine loads the assigned screen number to the variable ScreenNumber whenever the softkey is pressed PD_PTR numbers are assigned in the file PD_NUMS BAS LoadScreenForm This subroutine found in the file Softkey BAS is used to load the final form This routine uses the ScreenNumber variable assigned in SetSPDPointer to determine what screen should be loaded A series of Case statements are used to define two variables which load the appropriate form CurrentForm a form and CurrentFormName a string Identify screen numbers with their corresponding screen names in the file SR NUMS BAS Any new screen numbers you are adding should be defined in this file Publication 8520 6 6 August 1999 3 20 Basic Display Set BDS Using the Text Find Utility Publication 8520 6 6 August 1999 To improve flexibility of our source code screen text and prompts are not directly entered on any screens Instead they are entered in different language text files and each screen calls the required piece of text from the appropriate file by a pointer when needed Unfortunately this can make it difficult to identify exactly what text Is to be displayed on what screen when writing code since only a file pointer 15 available on the screen The Basic Display Set source
254. sic project The default Project1 is acceptable Under the Visual Basic File menu select Add File Browse to your Basic Display set source code directory and select the master frm you wish to use for your new screen From the project window open the form and press F4 to bring up the properties sheet On the properties form change the field for the form to something other than one already used in the OCI Basic Display Set source code this name should be descriptive of what you plan to use this form for You may also choose to change the Caption field at this time as well From the File menu select Save File As in a new file name for the form in the Save As dialog box and select save This must also be a unique file name not already used in the Basic Display Set source code From the File menu select Open Project Visual Basic will prompt you to Save Changes to Assuming you already saved the file from step 5 you should be able to select No to Al on this dialog Open the Basic Display Set Visual Basic source project ABOCI VBP You should find this file in the directory you specified when you installed the Basic Display Set source code Under the Visual Basic File menu select Add File Select the form name you saved in step 6 This will add your copy of the master form to the Basic Display Set source project while keeping
255. siderations ATTENTION Identifies information about practices or circumstances that can lead to personal injury or death property damage or economic loss Attention statements help you to identify a hazard avoid the hazard recognize the consequences Important Identifies information that is critical for successful application and understanding of the product 9 Series and 9 PC are trademarks of Allen Bradley Company Inc Windows NT Visual Basic Pro Word for Windows Excel and DDE are tradmarks of Microsoft Inc Procom is a trademark of Datastorm Technologies Inc IBM is a tradmark of the International Business Machine Co RSLinx RSData RSJunctionBox RSTools and AdvanceDDE are trademarks of Rockwell Software Etherlink III is a trademark of 3Comm inc Table of Contents Chapter 1 Open Control Interface OCI Overview OCI Data Server Overview 1 1 Your DDE Compliant Application Program 1 2 OVBIVIBW Iud RS sia 1 3 The OUI Data Server Data Server Read Data Requests 1 4 Data Server Write Data Requests 1 4 Data Server Command Requests 1 5 Data Server Return and Error Codes 1 5 Status of Commands and POKE Data Items 1 6 Errors on Automatic 1 6 Err
256. source code 2 m SPD pointer a system form TU Bit Pattern logical vs physical axes 4 15 BLOCK CYCLE TIME A 11 BLOCK CYCLE TIME MAX A 11 BLOCK TRANSFER READ DATAJ A 10 BLOCK TRANSFER WRITE DATA A 10 BOOT FW REVISION A 7 CALCULATE 5 21 B 2 CALCULATION RESULTS A 7 CALIBRATION START enumeration CALIBRATION TYPE Enumeration CANCEL MESSAGE Characters max allowed in prompt 3 20 CHECK IF FILE PRESENT B 4 B 5 CLEAR ACTIVE ERRORS CLEAR NAME E 4 B 5 CLEAR CYCLE TIME CLEAR DEBUG MONITOR B 2 CLEAR ERROR LOG 5 22 B 2 CLEAR POWER ON TIME OVERALL CLEAR RUNTIME CLEAR WORKPIECES CUT OVERALL 5 22 B 3 CNC commands 5 1 Information global bas CNCCommand Subroutine COARSE SCAN TIME A T1 Coding using Visual Basic Cold Link COM_MODE Enumeration COM2A PARAMETER NAMES A 11 Command Requests overview COMMAND ERROR CODE Commands arguments example using Visual Basic overview syntax for using CNCCommand subroutine Communication Commands ACTIVATE RIO PASSTHROUGH AUX COM ABORT COMMAND AUX COM BACKUP CONFIG TABLE AUX COM CMD FWD SEARCH AUX COM CMD REV SEARCH AUX COM CMDTBL TO FLASH 5 16 AUX COM CONFIG TO FLASH 5 16 AUX COM DOWNLOAD FILE 5 17 AUX COM HOST WRITE TO FLASH AUX COM SENDCHD 5 17 COPY DEVICE SETUP DEFAULTS AJ DEACTIVATE RIO PASSTH ROUGH i ENTER SERIAL IO MONITOR MODE
257. ss It returns a bit pattern of the logical axes in the process If a zero is reported to the logical axis number that axis is not configured as a rollover axis A one indicates the logical axis 1 a rollover axis For example ROLLOVER AXIS LOGICAL BIT PATTERN 1 Could return the bit pattern 00000100 This would indicate that the third axis in the process is configured as a rollover axis Publication 8520 6 6 August 1999 4 58 Data Server Data Items Publication 8520 6 6 August 1999 ROTARY AXIS LOGICAL PATTERN Data Type UDINT Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to determine what axes are currently configured as rotary axes in the process It returns a bit pattern of the logical axes in the process If a zero is reported to the logical axis number that axis is not configured as a rotary axis A one indicates the logical axis is a rotary axis For example ROTARY_AXIS_LOGICAL_BIT_PATTERN 1 Could return the bit pattern 00000100 This would indicate that the third axis in the process is configured as a rotary axis VIRTUAL NAMES disp mode Data Type Integer Read Write Read only Array Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC This item is used to identify the name used for the virtual axis in 16
258. t File Name STRING1 Search enum DINT Search Method enum DINT File Name 1 STRING1 Stop Sequence No DINT Target Directory DINT enum Source of Part Prog DINT enum Search Pattern STRING1 File Name 1 STRING1 Midstart enum DINT Midstart Search Mode DINT enum Search Pattern STRING1 Yes Tool Number DINT Y Yes Yes es Yes Yes Yes Yes Yes Yes Yes Yes Yes es Ye ii Dest File Name STRING1 Test 0 Exec 1 DINT Copytotypeenum DINT Test 0 Exec 1 DINT Copy DINT Test 0 Exec 1 DINT Copy from type DINT Test 0 Exec 1 DINT enum Copy from type DINT Test 0 Exec 1 DINT enum STRING1 Source of Part Prog DINT Pockets Needed Shaft Pocket DINT DINT Inst ID 11 110 98 95 97 96 Commands B 7 xs DM pud i em T Proc Lathe Mill pe qe ape 4 Pocket Number DINT Pockels Needed DINT Shaft Pocket DINT Dual RT SET TOOL NUM Assign random tool number to pocket Lathe Mil Tool Number DINT Number of Pockets DINT Dual RT_CUSTOMIZE_TOOL Customize random tool pocket TM_DELETE_TOOL Delete tool from tool management group Dual wi 2 Yes Tool Too Group Number Number Enty Number Number TM_INSERT_TOOL Insert tool into tool management group Tool Group Number e Number EUN Entry Number where to DINT put tool Publication
259. t use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 No disabled 1 Yes enabled 2 N A For example assigning a value of 1 to the following item PORT REWIND ON M99 2 enables this feature for port B The N A enumeration is only available for tape devices that do not support this feature Non tape devices do not have this feature and will return an error if you attempt to read or write this data item PORT PERCENT SELECTION port id Data Type INT enumerated Read Write Read Write Array Index port_id Control Type Lathe Mill Grinder This item is used to read enable disable the sign as a valid end of program character for a tape This feature is used for tape or intelligent devices Refer to your operations and programming manual for details on using this feature The index port_id identifies the port as follows port A 2 port B The id index must always be used with this data item You not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 0 No disabled 1 Yes enabled 2 N A For example assigning a value of 1 to the following item PORT PERCENT SELECTION 2 enables this feature for port B The N A enumeration is only available for tape devices that do not support this feature Non tape devices do n
260. ta transfers through the data highway module The communication command enumeration is Enumeration Result w Write Variables r Read Variables f Send Fixed Status d Download File 0 Empty Command zero Important Enumeration does not apply to the 9 PC CNC Publication 8520 6 6 August 1999 6 6 Array Indices Strings Publication 8520 6 6 August 1999 DH_BAUD_RATE enumeration The data highway baud rate enumeration is used to select the communication baud rate for the data highway port The baud rate enumeration is Result 57 6K Baud DH only 115 2K Baud DH only 230 4 Baud DH only 1200 Baud serial only 2400 Baud serial only 4800 Baud serial only 9600 Baud serial only 8 19200 Baud serial only Enumeration Important Enumeration does not apply to the 9 PC CNC DH_OUTPUT_FORMAT enumeration The data highway output format enumeration 15 used to identify the communication format being used The output format enumeration Is Enumeration Result 1 Integer 2 Float 3 Long Real 4 Boolean Important Enumeration does not apply to the 9 CNC DH_PARITY enumeration The data highway parity enumeration is used to select the parity for serial communications This is used only for serial communications from the data highway module not available for DH communications The parity enumeration is Enumer
261. table directory on CNC HARDD disk drive on your PC not valid for some commands Publication 8520 6 6 August 1999 6 20 Array Strings filename PPG enter the name of the file in the selected directory that the command is targeting Valid filenames can be no more than eight alpha numerics long Any filename using numerics only no alpha characters is altered when passed to the CNC to conform to the 9 Series or 9 PC standard O word filename Oxxxxx The PPG must follow all part program names The following is a FILENAME example This command deletes the part program named 07654321 in the main directory PP DELETE MAIND 7654321 PPG Important HARDD option specifies hard drive location on your PC that is configured when the OCI system is installed Refer to your OCI Installation Manual for details on specifying the path on your PC used for part program storage TEXT STRING string Text String command arguments to the data server use the following format command textstring textstring Enter any null terminated character string length of the string will be verified by the control when it receives the command The following is a TEXTSTRING example This command writes a textstring to the OEM message area of the CNC OEM MESSAG Publication 8520 6 6 August 1999 E STORE This is CNC1 Ethernet Addr 130 120 10
262. tems ACTIVE ERROR MESSAGES Groups numbers of the active error messages E eee NUM DISP LINES Controls 49 PAL MESSAGES Active PAL Messages STRING1 PAL AllControls COMMAND ERROR CODE Error code from DDE command operations UINT E LER E Controls ERROR LOG MESSAGE NUM Error log message number UINT Bh 1 00 5908 No 100 ERROR_LOG_MESSAGE_ Error log message parameter UINT Both LOG_SIZE All Controls PARAMETER 101 ERROR LOG TIME STAMP Error log message time stamp STRING Bh t 1065 LM All Controls 174 ERROR MESSAGE TYPE Type of Error Messages USINT enumer nas STI Controls ated PS ERROR MESSAGES Error Eu UINT NUM MSG GROU Esp mre PS LINE 1 MESSAGE DATA Base type and parameter for ro M AN E error line UDINT Controls number 1 I NUM MESSAGE GROUPS Number of error message groups 0 of error message groups UINT No R Controls WRITE_ERROR_CODE Error code from DDE write operations Both Controls MESSAGE BASE LAST INDEX Number of system error messages in 100 200 E eem BASE Controls and 300 ranges ee 7 Factory Communication E ICT E IUE AL COM CNCLFLENANE Autom commande CNC erame on AW e ae s An con arcs 149
263. the OCI data server and file handler Only one OCI station can be in control able to issue commands and write data of any one given CNC This command identifies to the 9 Series or 9 PC CNC that it should no longer accept commands and file management activities from the OCI data server and file handler on this PC Use this command in conjunction with the REQUEST CONTROL command Important For Release 1 of the 9 PC CNC a single PC runs the OCI data server REQUEST CONTROL no argument This command is used to take control of a specific CNC with your OCI station The controlling OCI station personal computer has authority to execute commands and write data items on the CNC OCI stations that do not have control can only view OCI data items from the CNC This request is only honored if there is currently no other OCI station currently in control of the requested CNC Important This command only applies to the local PC for Release 1 of the 9 PC This command must be performed successfully before any other command can be executed or any data items are written by this OCI server Important The request and relinquish control commands are for the data server only They do not influence the controlling the file handler The controlling file handler is determined on a first connection basis Refer to your OCI Installation Manual for details on configuring the OCIFHCFG INI file for the 9 Series system and refer to your 9 PC Installat
264. the control in inch mode when the data is requested Publication 8520 6 6 August 1999 2 Data Items Dual Proc Is this data item referenced independently in each process of a dual process system If yes the item can be referenced as _ 1 and item_name 2 representing the different processes Identifies if the item 15 read only write only W both read and writable R W or dependent on your application or machine configuration such as PAL prot which indicates PAL defines the read writable properties of this item Control Type Identifies what control types allow the use of this data item Valid control types are All Controls lathe mill surface grinder cylindrical grinder Cyc cylindrical grinder Surf surface grinder Grinder both surface and cylindrical grinders DLathe dual lathe DMill dual mill Dual both dual lathe and mill OCI 9 PC Indicates which CNC provides this API information means information provided by 9 260 9 290 products means information provided by the 9 PC product Both means information provided by all three products listed earlier LAST ITEM 370 Both Description Data Type Array Indices Units Dual ontrol Type Dependency Proc bata EE E RES ld ANE BAA E sc ee er emp A Jr ce quo denm ees 3 pe AMPable SYSTEM S
265. the original master form intact Publication 8520 6 6 August 1999 3 10 Basic Display Set BDS MASTER FRM Recommended Subroutines When you develop your new screen we recommend you use the following subroutines to properly integrate your form into the Basic Display Set Use this Subroutine APromptPressed public Description Keyboard input is passed from the system form to this subroutine Use APromptPressed to identify what actions should be taken when the user presses a keyboard key This routine receives the KeyCode and Shift status from the system form FormKeyPressed ASoftkeyPressed public Softkey inputs are passed from the softkey form to this subroutine Use ASoftkeyPressed to identify what actions should be taken when the user presses a softkey This routine receives the softkey index 0 6 as variable SoftkeyChoice Note softkey management changing of levels and softkey names is handled by the softkey form Use this index in this form only to identify what actions your form should take Form Activate private Use this code to perform activities after the form is loaded This routine sets focus to the system form to monitor keyboard inputs after a new form is loaded Most forms Activate module has the line fmSystem setFocus Form Unload private This software module is typically used to shut off any automatic data links to the CNC as well as set the current form to whatev
266. tibility Mode 17 Interrupt Macro 55 Deskew split 18 HLL and Chamfering Corner Rounding 56 Dual Axes 19 Auto Acc Dec 57 Multiple Spindle 20 Zero Following Error 58 Multiple Processes 21 Multi Block Retrace 59 12 TN quy 22 Multi Level Block Delete e 12 8 Virtual Axis A Pus s Measure 24 Pocket Cycles 62 25 Irregular Pocket Cycles 63 2 Sate 26 Cylindrical Interpolation 64 On Line Search Monitor 27 Tool Management and Redundant Tool 67 512KB Extended Program Storage 28 Touch Probe Capability and Cycles 68 Synchronized Spindles 29 External Input Skip 69 S Curve Accel Decel 30 Combined Zones 2 and 3 70 3 Hi Res Axis 2 31 1 Arbitrary Angle n 3 Hi Res Axis 4 32 Manual Absolute On Off 72 3 9 1 Storage 33 HPG JOG during Program Execution 73 3 9 PC 4MB Storage 34 Interpolated Axis Calibration 74 3 9 PC 1 Servo Loop 35 2nd Auxiliary Function B Codes 75 3 9 PC 4 Servo Loops Publication 8520 6 6 August 1999 Array Indices Strings 6 11 Enumeration R 36 Digitizing 76 3 9 5 Servo Loops 37 PAL Logic Program Activation 7 3 9 PC 8 Servo Loops 1Does not apply to 9 PC Applies to a dual process system only 3Applies to 9 PC only Applies to lathe only 5Apllies to mill only Applies to grinder only 7Applies to mono process system only PORT_BAUD_RATE enumeration The port_baud_rate enumeration is used to select th
267. tion RING 10 DEVICE OUTPUT DATA Output data from the ring device at the requested USINT EA MAX NUMBER RING DEVICES eP All Controls position RING IO DEVICE Device type on the ring at the requested position USINT lo J NUMBER RING DEVICES Controls FINE SCAN TIME AVG Average scan time for secondary interpolation UINT 9 R Controls bil FINE SCAN TIME MAX Maximum scan time for secondary interpola UINT 9 Controls tion uv S FOREGROUND _LOGIC_TWE uv __ e n Arme EU Lm e MN m M s s be weorwEscm TE weed ur ac o D s mms bial COARSE_SCAN_TIME AMPed and computed primary interpolation UINT 9 Controls rate Paramacro tems Paramacro Parameters their numbers LREAL EPI m EL PARAMETER NAMES Com 2A Parameters Names STRING rcrum NUM COM2A PA BEEN Controls RAMS 7 Pari Program Directory C EIER rene Pan mou remeron Arm ACTWE sus ocn wieso e sa o Aces Publication 8520 6 6 August 1999 12 Data Items n s a Dependency Proc s wu MEMORY eebe Memoir Ur o n ee eee 2
268. tive files When this utility is enabled it creates the following files File Name Registers these type of errors Data poking errors from the Basic Display Set source code ABVBPOKE ERR that uses the CNCPoke sub call This file is referenced as error file number 1 in source code Linking errors from all CreateDataLinks routines and other ABVBPRGM ERR program errors encountered in the Basic Display Set This file is referenced as error file number 2 in source code The write to error file utility is only available when the source code is loaded in the same directory as the Basic Display Set and the variable WRITE2ERRORFILE is set to True Set this variable by one of these methods e Manually change the variable in source code WRITE2ERRORFILE 1 found in Global Bas InitGlobals e Manually change the variable FINAL EXE to False Publication 8520 6 6 August 1999 Data Format Chapter 4 OCI Data Server Data Items Each OCI data item is presented in the following format Data Item Description Indicates the format the data item will be presented Data Type to the OCI data server Refer to pagd 4 2 for details R indicates the data is read only passed from CNC Read Write R W indicates the data is both read and write Refer to pag 4 2 details Indicates the index in an array none indicates data Array Index can not be accessed as an array Refer to 4 3 details Indicates the type
269. to the linking error file See Writing to Error files utility later in this section Also included with this source code is the softkey editor utility Use this utility whenever you need to add remove rename or replace a softkey in the Basic Display Set softkey structure Though possible it is not recommended that you attempt to edit the softkey structure without using this utility You must have installed the Basic Display Set source code before you will be allowed to use the softkey editor Each softkey in the Basic Display Set is assigned a number Each rack of five softkeys plus the more and back arrow keys is also assigned a number These numbers are used by the Basic Display Set source code to determine if a softkey is to be displayed and what forms appear when a specific softkey is pressed Text for the softkeys are stored in the data files with the extension ABL and ABG Aliases for the softkey numbers are created in the basic file SOFTKEYS BAS Important Any softkeys you add must be softkey 1500 or higher Softkeys 1 to 1499 are used or reserved by Allen Bradley for future product development Publication 8520 6 6 August 1999 3 12 Basic Display Set BDS This procedure assumes you already have Visual Basic active with the source file ABOCI VBP open To use the softkey editor utility 1 Access the search utilities from the Setup menu in the Basic Display Set The Setup menu is only available when the
270. tory_id Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use this data item to determine the number of part programs currently stored on the CNC in the specified directory This item can not be used for part programs stored on the OCI hard drive or network drive The index for this item identifies the directory on the CNC in which you want the total number of part programs stored there Valid values for cnc_directory_id are 1 main directory 2 protected directory Excluding the index for this item provides the total number of part programs in both the main and protected directories PART PROGRAM COMMENT directory spec file num Data Type String Read Write Read only Array Index Program directory and file number Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use the PART PROGRAM COMMENT data item to receive the comment string from a specific directory for a specific file The directory spec index is enumerated as follows Main CNC directory 2 Protected CNC directory The file num index identifies the specific file in the directory This index is the position of the file in the directory the first file being file 1 Files are placed in the directory in alpha numeric order Requesting multiple part program comments will return the comment strings separated by the Tab character If a request is made fo
271. trol This control is used in place of standard windows DDE text transfers for most of the data links to the OCI data server This custom OCX dramatically improves the speed at which DDE data is transferred Included with the basic display set package is the JBOX DLL which is required to allow this custom control to function You must include this DLL with any OCI software you ship that uses the basic display set Included with the API development package is a subset of RSTools called RSData which provides the custom OCX control to add to your visual basic development tool and the JBox DLL necessary to make this application work Refer to your RSData user s guide for details Publication 8520 6 6 August 1999 1 8 Open Control Interface Overview JBoxDestroyInactiveParts When an item is requested of the OCI data server using the RSdata JBox control it is added to the watchlist on the specified control Because of the nature of more typical JBox applications when the request for this data from the application no longer exists JBox does not normally terminate the request for this item Since watchlist space on the CNC is limited even a small application will quickly run out of watchlist space To prevent this scenario we used an undocumented attribute of JBox called JBoxDestroyInactiveParts This attribute will remove any inactive automatic links from the data server which than removes it from the CNC watchlist Since JBoxDestroy
272. trol Type OCI 9 PC type P2 type P3 type ID Proc 60 TRANSFER AXISCAL TO PORTA Axis calibration to port A Contro 66 TRANSFER AXISCAL TO PORTB Axis calibration to port B Communications 156 INITIALIZE DEVICE SETUP Initialize the RAM copy of device setup at start Controls up i Miscellaneous CANCEL_MESSAGE Cancels active messages Contro CALCULATE Perform a math calculation on a string Contro a e e Search DINT Search String STRING1 Y gt gt gt gt gt gt gt gt gt gt gt gt gt CLEAR CYCLE TIME Clears cycle time CLEAR DEBUG MONITOR Clears fields in the debug monitor parameters Controls CLEAR ERROR LOG Clears error log Contro Publication 8520 6 6 August 1999 Commands B 3 Inst Item Name ID 106 CLEAR POWER ON TIME OVERALL Clears power on time overall All Contro 107 CLEAR WORKPIECES CUT OVERALL Clears workpieces cut overall Controls 90 INPUT MDI STRING Inputs MDI string Contro 92 RELINQUISH_CONTROL Relinquishes to CNC status as controlling Controls 91 REQUEST_CONTROL Registers with CNC as controlling OCI All Controls 1 STORE_OEM_MESSAGE Stores OEM message in backup All Controls Offsets 20 ACTIVATE_TOOL GEOM Activates tool geometry offset Lathe Dual Yes Tool Number DINT Lathe 93 ACTI
273. ugust 1999 4 2 Data Server Data Items Data Type Read Write Publication 8520 6 6 August 1999 The data type for a OCI data item determines how the data is returned from the control to the OCI You define variables according to this data type Requesting the wrong data type for a data item to the control can return invalid data or an error Valid data types include DATA TYPE Description STRING Alphanumeric string ranging from 0 to 65 535 characters INT Whole number ranging from 32 768 to 32 767 UINT Unsigned integer DINT Double integer UDINT Unsigned double integer LINT Long Integer SINT Signed integer USINT Unsigned single integer REAL Real number LREAL Long Real BOOL Boolean True False indicates the data is read only passed from to W indicates the data is write only passed from the OCI to the CNC R W indicates the data is both read and write Errors are generated if you attempt to write data to a read only OCI data item Write privileges for commands and data items are reserved for the controlling OCI station You must first successfully issue the REQUEST CONTROL command before write requests will be accepted by the OCI station Refer to the command chapter for details on issuing the REQUEST CONTROL command Array Indexes OCI Data Server Data Items 4 3 Some OCI data items are accessed as arrays The format for the majority of these arra
274. umber you are changing with this measure command axis number the logical axis number as defined in AMP ref pos the fixed reference position with no wear offsets active of the tool Refer to your operation and programming manual for details on determining this fixed machine position This is the position the control compares to the actual axis position to determine the wear amount Important Lathe Cylindrical Grinder control types this position ref pos value is always entered as a radius value For example MEASURE TOOL WEAR 1 2 1 777 would perform a measure operation to calculate the wear offset amount for tool offset 1 axis 2 If no tool wear were present the current tool position should be 1 777 control then compares the actual tool position to 1 777 and uses the difference to create the appropriate wear offset MEASURE WHEEL GEOM too number axis number ref pos This command performs the tool measure function refer to your operation and programming manual for details on measure This command is for grinder controls only When executed this command compares the actual axis position to the entered ref pos to determine the geometry offset Three arguments are specified with this command tool number the wheel dresser geometry offset number you are changing with this measure command axis number the logical axis number as defined in PAL Commands OCI Data Serve
275. umeration Use this enumeration to identify the copy type to be performed from memory Enumeration Result 0 Test Mode 1 Punch file 2 Multi punch 3 Punch next file 4 Punch all 5 Finish punch Important Enumeration does not apply to the 9 PC CNC COPY TO MEM copy from type enumeration Use this enumeration to identify the copy type to be performed from port Enumeration Result 0 Test 1 Input from reader 2 Multi reader input 3 Input next file Important Enumeration does not apply to the 9 PC CNC Array Indices Strings 6 5 DOWNLOAD_IN_PROGRESS download_in_progress enumeration is used to identify the current status of AMP and PAL downloads The enumeration 15 Enumeration Result 0 Idle 1 AMP Download Started 2 AMP Download Complete 3 PAL Download Started 4 PAL Download Complete 1 Important Enumeration does not apply to the 9 PC CNC DH CHANNEL TYPE enumeration The data highway channel type enumeration is used to select a communication port on the data highway module The DH CHANNEL TYPE enumeration is Enumeration Result 0 Available but not configured 1 DH Plug Port A 2 DH Plug Port B 3 RS232 Serial Port 4 RS422 Serial Port Important Enumeration does not apply to the 9 PC CNC DH_COMMAND enumeration The data highway command enumeration is used to make requests for da
276. used with this data item You can not use this index to access more than one port per request Data for this item is enumerated as follows This Value Indicates Selects 3 Seconds 15 Seconds 30 Seconds 60 Seconds 120 Seconds 180 Seconds 300 Seconds 600 Seconds Unlimited no timeout oc For example assigning value of 4 to following item PORT TIMEOUT VALUE 1 selects a timeout value of 120 seconds for port A RX CHAR PORTA r char size Data Type USINT Read Write Read only Array Index see RS232 charts Control Type Lathe Mill Grinder The CHAR PORTA item identifies a character received on serial port A The control always forces a null after each character received over this port So if a device sends an A character to this port this item will identify two characters received the A followed by the null character RX CHAR char size Data Type USINT Read Write Read only Array Index see RS232 charts Control Type Lathe Mill Grinder The CHAR PORTB item identifies a character received on serial port B The control always forces a null after each character received over this port So if a device sends an character to this port this item will identify two characters received the A followed by the null character HARDWARE_STATUS_PORTA OCI Data Server Data Items 4 31 Data
277. ussed in the error appendix later in this manual Important perform a poke operation the station making the request must be the controlling station Refer to the API command items REQUEST CONTROL and RELINQUISH CONTROL 9 Series Poke Server o DDE Application 9 Series The DDE Application sends a value to the Oe Server for data item The Server sends the new value to the processor containing the data item via RSLinx 9 Server DDE Application 9 PC CNC The DDE Application sends a value to the OCI Server for a data item The Server sends the new value to the processor containing the data item Publication 8520 6 6 August 1999 Background Foreground OCI Data Server Data Items 4 13 data items are monitored in the controls background unless otherwise indicated in the text describing the data item Foreground and Background speed is related to the system scan time The system scan time for the control is set in AMP You can set the system scan time in increments of 2 ms from 6 to 30 ms Foreground tasks occur during each system scan time Data items are hard coded in the processor as foreground or background Only the following data items are foreground items e ESTOP STATE Select PAL Logic system flags ones that are foreground only The rate at which the CNC tests and reports data changes for OCI watchlists is configure
278. uw fem i umo W n r ornon sior nwe opionsernene Serr sme j O e n o e ornon sior nee Omsa mesa j __ je n ornon soraa OmmsaResm Su srm n s ornon sorne OmmsaRwsw su sm p e n PROCESS CHANGE REQUEST o aw oa nl co xu EE NE d unn De Moms ules tal offset bata Data aaa A ELAR ACTIVE TOOL GEOW NUM _ AaiveTeolGeonetyNonber Bw De n ACTIVE TOOL LENGTH AXIS Bit pattern of axes currently programmed as UDINT Both Controls gemi DRUSI TT C 17 s ras pmerocwew nu Pe a AMPED TOOL LENGTH Bit pattern of axes configured as tool length UDINT Both Controls LOGICAL PATTERN axis WORD D Word for Display UINT Controls 351 DRILLING AXIS LOGICAL PATTERN Bit pattern of axes configured as drilling axis UDINT Both Controls for fixed cycles w HWORD jHWodfrDsky feon Ye Publication 8520 6 6 August 1999 276 MAX GEOM OFFSET MAX GEOM OFFSET CHANGE MAX GEOM RADIUS MAX RADIUS CHANGE MAX WEAR OFFSET MAX WEAR OFFSET CHANGE MAX WEAR RADIUS MILL MAX GEOM OFFSET MILL MAX GEOM OFFSET CHANGE MILL MAX WEAR OFFSET MILL MAX WEAR OFFSET CHANGE Maximum geom offset
279. vices connected to port B Important This command does not apply to the 9 PC CNC Data Server Commands 5 43 DEACTIVATE PART PROGRAM no argument Use this command to deactivate the currently active part program No arguments are required with this command For example DEACTIVATE PART PROGRAM would deactivate the part program currently active on the control DELETE PART PROGRAM filename string This command deletes the part program from the control or OCI station The filename string format is given on page 6 19 and includes specific directory information For example ETE PART PROGRAM MAIND DSTIN PPG would delete the part program DSTIN located in the controls main directory ENTER PART PROGRAM SEARCH MODE search type Use this command to access part program search mode The search type argument is an enumeration that identifies the type of search operation the control is to perform The enumerations are as follows Enumeration Result 1 N Search 2 O Search 3 EOB Search 4 Slew Search 5 String Search For example ENTER PART PROGRAM SEARCH MODE 1 readies the control to perform an N word search Exit search mode using the command EXECUTE PART PROGRAM 5 571 Publication 8520 6 6 August 1999 5 44 Data Server Commands Publication 8520 6 6 August 1999 Use this command in conjunction with the EXECUT
280. y Data Server Data Items 4 37 MESSAGE BASE LAST INDEX range num Data Type UDINT Read Write Read only Array Index range num Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC The message bases for system error messages are divided into three categories Common Message Base Range 1 200 Single Process Control Specific Message Base Range 201 300 and Dual Process Control Specific Message Base 301 400 The MESSAGE BASE LAST INDEX API returns the values of the last index in each of the message base sections mentioned above range num may be used to obtain the last index for a particular section For example MESSAGE BASE LAST INDEX I returns the last index of the Common Message Base ACTIVE PAL MESSAGES line num Data Type String Read Write Read only Array Index line_num Control Type Lathe Mill Grinder Important This data item does not apply to 9 PC This item is used to pass any active PAL Logic messages to the OCI station PAL Logic messages are created by your logic program The ine num index is used to identify the number of PAL Logic message You must use valid PAL Logic message line numbers for this data item Valid line numbers are 1 and 13 22 You can request up to five line numbers with each DDE request data item is returned as invalid if any other line numbers are used Publication 8520 6 6 August 19
281. y Index none Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use the SELECTED_PART_PROGRAM_DIR data item to identify the currently active control part program directory The directory is typically changed using the OCI command SET_DIRECTORY The value returned for this item is enumerated as follows 1 Main CNC directory 2 Protected CNC directory 3 OCI configured hard drive directory FILE_NAME directory_spec file_num Data Type String Read Write Read only Array Index Program directory and file number Control Type Lathe Mill Grinder 1 1 Grinder Control Type is not available for Release 1 of 9 PC Use the FILE_NAME data item to receive the file name string from a specific directory for a specific file The directory_spec index is enumerated as follows 1 Main CNC directory 2 Protected CNC directory The file_num index identifies the specific file in the directory This index is the position of the file in the directory the first file being file 1 Files are placed in the directory in alpha numeric order You can ask for multiple filenames from the same directory if desired For example FILE_NAME 1 1 6 would return the filename string for programs 1 thru 6 tab delaminated in the main CNC directory Data Server Data Items 4 53 NUM FILES cnc directory id Data Type UINT Read Write Read only Array Index cnc_direc
282. y by selecting Text or Prompt under the Setup menu You will be prompted to save your changes Publication 8520 6 6 August 1999 Basic Display Set BDS Using the Print Utilities P Allen Bradley 9 Series Front Panel The Basic Display Set provides a print utility to help you document your application This utility writes the requested data to a file for printing or use in a spread sheet The following items can be printed to a file Error Messages writes all error messages to an ASCII file Prompts writes all screen prompts to an ASCII file Softkey Tree writes all softkey text to an ASCH file Text writes all miscellaneous screen text to an ASCII file e PD Ptr s writes all softkey pointers to an ASCII file e SPD Ptr s writes all screen pointers to an ASCII file Access the print utilities from the File menu in the Basic Display Set The Print option under the File menu is only available when the source code is loaded in the same directory as the Basic Display Set and the variable PRINTMenu is set to True Set this variable by e Manually change the variable in source code PRINTMenu is found in Global Bas InitGlobals or in SetupGlobalVarsforNEWCNC or e Manually change the variable FINAL EXE to False Biel E Options Testing Setup Error Msg s Exi Prompts Softkey Tree Text PD_Ptr s SPD_Ptr s When you select the desired pr
283. ys can be broken down into just a few array indexes The array index is called out with each data item The following presents the format for the most common arrayed data This is not an inclusive list Other less frequently used array indexes are used and described with the data items or commands that use them Array Index Description AXIS NUM AMP configured axis number SPINDLE NUM AMP configured spindle number 1 to 3 configured spindle number for 9 PC 1 to 2 CNC DIRECTORIES 1 the main directory 2 the protectable directory or 3 the PC local OCI file handler directory typically the Pc s hard disk SERVO_MODULES the servo module number on the system 1 to 3 1 SERVO_NUM AMP configured number of the servo on your system M MODAL GROUP the modal group of a M code G MODAL GROUP the modal group of a G code SETUP BUFFERS the active number of part program setup buffers NUM PP FILES the number of part programs currently in the directory OFFSET NUM 1 Always 1 on 9 PC the tool offset number Many of the data items are two dimensional arrays and would thus have two array indexes associated with them For example the data item TOOL LENGTH WEAR OFFSETS is a two dimensional array using the indexes OFFSET NUM and AXIS NUM to define its boundaries Making the following data request of the server TOOL Ll ENGTH WEAR OFFSETS 2 3 requests the tool length w

8520-6.6, 9/Series OCI, API Developer`s Guide

Contents

Download Pdf Manuals

Related Search

Related Contents