Rockwell-automation 8520-9API 9/Series OCI API Developer's Guide Manual de usuario Pagina 1

P–1Publication XXXXXX.X - September 1995API Developer'sGuide9/Series OCI(85209API)AllenBradley

Chapter 1Publication 8520-6.6 - August 1999Open Control Interface (OCI)OverviewThis chapter contains an overview of the OCI system and how it usesWin

4–52 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Note the main and protected directories share the same RAM diskspace. This item wil

4–53OCI Data Server Data ItemsPublication 8520-6.6 - August 1999NUM_FILES, cnc_directory_idData Type UINTRead/Write Read onlyArray Index cnc_director

4–54 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ACTIVE_PART_PROGRAM_BLOCKS, setup_buffersData Type StringRead/Write Read onlyArray I

4–55OCI Data Server Data ItemsPublication 8520-6.6 - August 1999EXT_ROT_FIRST_AXISData Type StringRead/Write Read/WriteArray Index noneControl Type M

4–56 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999G_CODE_STATUS, g_code_groupData Type UINTRead/Write Read onlyArray Index noneControl

4–57OCI Data Server Data ItemsPublication 8520-6.6 - August 1999PLANE_AXIS_INDICES, plane_axesData Type INT[array]Read/Write Read onlyArray Index pla

4–58 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ROTARY_AXIS_LOGICAL_BIT_PATTERNData Type UDINTRead/Write Read onlyArray Index noneCo

4–59OCI Data Server Data ItemsPublication 8520-6.6 - August 1999SKEW_SLAVE_ABSOLUTE_POSITION, skew_setData Type LREAL (array)Read/Write Read onlyArra

4–60 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Use this data item to identify the controlling spindle. The controllingspindle is s

4–61OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The SPINDLE_MOTOR_TYPE data item is used to identify themotor commutation of the spin

1–2 Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 19999/Series OCIData Server9/Series BasicDisplay SetYour DDE compliant Applica

4–62 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ESTOP_STATEData Type USINTRead/Write Read onlyArray Index noneControl Type Lathe/Mil

4–63OCI Data Server Data ItemsPublication 8520-6.6 - August 1999This item is used to determine if standard motor table values are usedfor digital sys

Chapter 5Publication 8520-6.6 - August 1999OCI Data Server CNCCommandsThe OCI data server provides a number of CNC commands that canbe passed from yo

5–2 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999For applications where it is critical that the command is executedsuccessfully befo

5–3OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999The final command, including argument, to insert an axis calibrationpoint would be:[

5–4 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999MODIFYING_AMP (no argument)Use this command to open patch AMP. You must send thisc

5–5OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_AMP_FROM_PORTB (no argument)Use this command to restore an AMP configuratio

5–6 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_AMP_TO_PORTB (no argument)Use this command to back up the current AMP conf

5–7OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_HOMECAL_TO_PORTB (no argument)Use this command to send the current home cal

5–8 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_REVERSAL_ERROR_TO_PORTB (no argument)Use this command to send the current

1–3Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 1999DDE OverviewDDE is a method used by Microsoft Windows to accomplishprocess-

5–9OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999DELETE_ALL_AXISCAL_POINTS (no argument)Use this command to delete all axis calibrati

5–10 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999EXIT_AXISCAL_MODIFY_MODE (no argument)When this command is executed the axis calib

5–11OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999INSERT_AXISCAL_POINT (axis_number)Use this command to insert an axis calibration po

5–12 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999RESTORE_AXISCAL (no argument)Use this command to restore into RAM the axis calibra

5–13OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_AXISCAL_FROM_PORTB (no argument)Use this command to restore an axis calibr

5–14 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_AXISCAL_TO_PORTB (no argument)Use this command to back up the current axi

5–15OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999AUX_COM_BACKUP_CONFIG_TABLE ("filename")This command is used only for sys

5–16 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999AUX_COM_CMD_REV_SEARCH (search_type," search_string")This command is use

5–17OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999AUX_COM_DOWNLOAD_FILE ("source_filename",destination_filename")This

5–18 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999COPY_DEVICE_SETUP_DEFAULTS (port_ id, device_num )This command is used to restore

1–4 Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 1999To access a piece of data named num_axes on a specific CNC, youenter this

5–19OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999For example:[ENTER_SERIAL_IO_MONITOR_MODE (2, 2)]would request the serial I/O monit

5–20 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999SAVE_DEVICE_SETUP (no argument)Use this command to save changes made to the contro

5–21OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999STOP_SERIAL_IO_MONITOR (no arguments)This command is used to stop the serial I/O mo

5–22 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999CLEAR_CYCLE_TIME (no argument)Use this command to clear the cycle time recorded by

5–23OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999REFORMAT_MEMORY (no arguments)This command reformats the RAM disk on the CNC. It w

5–24 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999Once in control of a specific CNC, other OCI stations can notrequest control of th

5–25OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999ACTIVATE_TOOL_LENGTH (offset_number)This command loads the specified tool length of

5–26 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999ACTIVATE_TOOL_WEAR (offset_number)This command activates the specified tool wear o

5–27OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999ACTIVATE_WHEEL_RADIUS (offset_number)This command activates the specified wheel/dre

5–28 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999BACKUP_INTERF_TABLE ("Filename_string")This command tells the control to

1–5Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 1999Poke requests are only honored by the CNC when they are madefrom the data s

5–29OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999BACKUP_TOOL_GEOM ("Filename_string")This command tells the control to cre

5–30 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999BACKUP_WHEEL_GEOMETRY ("Filename_string")This command tells the control

5–31OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999COPY_OFFSET ("source_axis, destination_axis")This command copies all of t

5–32 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999MEASURE_TOOL_WEAR (tool_number, axis_number, ref_pos)This command performs the too

5–33OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999ref_pos – the fixed reference position (with no geometry or wearoffsets active) of

5–34 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_PAL_FROM_PORTB (no argument)Use this command to restore a PAL image from

5–35OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TRANSFER_PAL_TO_PORTB (no argument)Use this command to back up the current PAL imag

5–36 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999BACKUP_COM1_PARAMETERS ("Filename_string")This command tells the control

5–37OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999BACKUP_COM2B_PARAMETERS ("Filename_string")This command tells the control

5–38 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999ACTIVATE_PART_PROGRAM ("Filename_string")Use this command to activate a

1–6 Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 1999Status of Commands and POKE Data ItemsWhen a data item read is successful

5–39OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999The filename string format is given on page 6–19 and includesspecific directory inf

5–40 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999COPY_MEM_TO_PORTA (`src_filename_string", dest_name",mode)Use this comm

5–41OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999The remaining argument with this command is the mode argumentwhich is an enumeratio

5–42 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999For example:[COPY_PORTA_TO_MEM (“SOURCE”,“MAIND:DSTIN.PPG”, 1)]copies the program

5–43OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999DEACTIVATE_PART_PROGRAM (no argument)Use this command to deactivate the currently a

5–44 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999Use this command in conjunction with theEXECUTE_PART_PROGRAM_SEARCH_MODE and theSE

5–45OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999RESTART_PART_PROGRAM (restart_action)Use this command to restart your part program.

5–46 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999SET_DIRECTORY (target_dir, password_string")Use this command to select the a

5–47OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999SET_PART_PROGRAM_INPUT_DEVICE (pp_source)This command selects the input source for

5–48 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999VERIFY_PART_PROGRAM ("filename1", filename2", mode)Use this comman

1–7Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 1999Many development tools are available to enhance your machineinterface as we

5–49OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999VERIFY_WITH_PORTA ("filename1", mode)Use this command to perform a compar

5–50 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999VERIFY_WITH_PORTB ("filename1", mode)Use this command to perform a comp

5–51OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999ENTER_MIDSTART_SEARCH_MODE(search_type)Use this command to enter midstart program.

5–52 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999Use this command in conjunction with theENTER_MIDSTART_SEARCH_MODE and theSET_MIDS

5–53OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999SYNTAX_QUICK_CHECK (no argument)This command is used to place the control in QuickC

5–54 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999BACKUP_RANDOM_TOOL ("Filename_string")This command tells the control to

5–55OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999RT_CUSTOMIZE_TOOL (pocket_number, pockets_needed,shaft_pocket)Use this command afte

5–56 OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999RT_SET_TOOL_NUM (tool_number, pocket_number)Use this command to assign a tool numb

5–57OCI Data Server CNC CommandsPublication 8520-6.6 - August 1999TM_DELETE_TOOL (tool_group_num, entry_num)Use this command to delete a specific too

Chapter 6Publication 8520-6.6 - August 1999Array Indices and StringsThe following section lists the range of select variable indices. Otherenumerate

1–8 Open Control Interface (OCI) OverviewPublication 8520-6.6 - August 1999JBoxDestroyInactivePartsWhen an item is requested of the OCI data server u

6–2 Array Indices and StringsPublication 8520-6.6 - August 1999AMP_DATA_TYPE enumerationThis enumeration identifies the data type for AMP parameters.

6–3Array Indices and StringsPublication 8520-6.6 - August 1999BACK_BORING_SHIFT_DIRECTION enumerationThis enumeration identifies the shift direction

6–4 Array Indices and StringsPublication 8520-6.6 - August 1999COM_MODE enumerationUsed for the I/O monitor diagnostic screen. Use this enumeration

6–5Array Indices and StringsPublication 8520-6.6 - August 1999DOWNLOAD_IN_PROGRESS enumerationThe download_in_progress enumeration is used to identif

6–6 Array Indices and StringsPublication 8520-6.6 - August 1999DH_BAUD_RATE enumerationThe data highway baud rate enumeration is used to select theco

6–7Array Indices and StringsPublication 8520-6.6 - August 1999DH_REMOTE_STATION enumerationThe data highway remote station type enumeration is used t

6–8 Array Indices and StringsPublication 8520-6.6 - August 1999MACHINE_TYPE enumerationThe Machine_Type enumeration is used to identify the AMPmachin

6–9Array Indices and StringsPublication 8520-6.6 - August 1999MODE_ACTIVE (active mode) enumerationMode_Active enumeration is used to select the exec

6–10 Array Indices and StringsPublication 8520-6.6 - August 1999OPTION_SELECTED enumerationThe option_selected_indices enumeration is used to identif

6–11Array Indices and StringsPublication 8520-6.6 - August 1999Enumeration: Result:Enumeration:Result:36 1Digitizing 76 39/PC 5 Servo Loops3

Chapter 2Publication 8520-6.6 - August 1999DDE Data Server ExamplesThis chapter assumes you have:• Already installed your 9/Series or 9/PC OCI softwa

6–12 Array Indices and StringsPublication 8520-6.6 - August 1999Important: Enumeration does not apply to the 9/PC CNC.PORT_PARITY enumerationThe port

6–13Array Indices and StringsPublication 8520-6.6 - August 1999PORTA_DEVICE enumerationThe port_device enumeration is used to select the communicatio

6–14 Array Indices and StringsPublication 8520-6.6 - August 1999PORTB_DEVICE enumerationThe portB_device enumeration is used to select the communicat

6–15Array Indices and StringsPublication 8520-6.6 - August 1999PORT_STOP_BITS enumerationThe port_stop_bits enumeration is used to determine the numb

6–16 Array Indices and StringsPublication 8520-6.6 - August 1999PP_SOURCE enumerationPP_Source enumeration is used to select the source that theexecu

6–17Array Indices and StringsPublication 8520-6.6 - August 1999SEARCH_METHOD enumerationSearch_Method enumeration is used to control the search opera

6–18 Array Indices and StringsPublication 8520-6.6 - August 1999SYSTEM_STATE enumerationSystem_State enumeration is used to select the status of exec

6–19Array Indices and StringsPublication 8520-6.6 - August 1999TM_GRAPHICS_TOOL_COLOR enumerationThis enumeration identifies the tool color for tool

6–20 Array Indices and StringsPublication 8520-6.6 - August 1999filename.PPG – enter the name of the file in the selected directorythat the command i

Appendix APublication 8520-6.6. - August 1999 OCI Data ItemsThis appendix lists the OCI data items categorized by feature. The feature categories

2–2 DDE Data Server ExamplesPublication 8520-6.6 - August 1999Topic NameThe topic name is created by the data server when it is launched.9/Series onl

OCI Data ItemsA–2Publication 8520-6.6. - August 1999 Dual Proc.: – Is this data item referenced independently in each process of a dual process system

OCI Data Items A–3Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data ItemsA–4Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptionI

OCI Data Items A–5Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data ItemsA–6Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptionI

OCI Data Items A–7Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data ItemsA–8Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptionI

OCI Data Items A–9Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data ItemsA–10Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data Items A–11Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptio

Because of the variety of uses for the products described in thispublication, those responsible for the application and use of thiscontrol equipment m

2–3DDE Data Server ExamplesPublication 8520-6.6 - August 1999X_raw.LinkTopic = ”abociserver|CNC_1” ’Set Link Service and TopicX_raw.LinkItem = ”axis

OCI Data ItemsA–12Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data Items A–13Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptio

OCI Data ItemsA–14Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data Items A–15Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptio

OCI Data ItemsA–16Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data Items A–17Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptio

OCI Data ItemsA–18Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

OCI Data Items A–19Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescriptio

OCI Data ItemsA–20Publication 8520-6.6. - August 1999 Control TypeReqDualProc.Units DependencyUnitsArray IndicesNumIndicesOCI/9/PCData TypeDescription

Appendix BPublication 8520-6.6. - August 1999 OCI CommandsInstIDItem (Name) Command Description Control Type OCI / 9/PC # Params DualProc.Parameter

2–4 DDE Data Server ExamplesPublication 8520-6.6 - August 1999DDE CommandsIn this example we execute a DDE command that writes MDI data tothe CNC. T

OCI CommandsB–2Publication 8520-6.6. - August 1999 InstIDP3 typeParameter 3P2 typeParameter 2P1 typeParameter 1DualProc.# ParamsOCI / 9/PCControl Type

OCI Commands B–3Publication 8520-6.6. - August 1999 InstIDP3 typeParameter 3P2 typeParameter 2P1 typeParameter 1DualProc.# ParamsOCI / 9/PCControl Typ

OCI CommandsB–4Publication 8520-6.6. - August 1999 InstIDP3 typeParameter 3P2 typeParameter 2P1 typeParameter 1DualProc.# ParamsOCI / 9/PCControl Type

OCI Commands B–5Publication 8520-6.6. - August 1999 InstIDP3 typeParameter 3P2 typeParameter 2P1 typeParameter 1DualProc.# ParamsOCI / 9/PCControl Typ

OCI CommandsB–6Publication 8520-6.6. - August 1999 InstIDP3 typeParameter 3P2 typeParameter 2P1 typeParameter 1DualProc.# ParamsOCI / 9/PCControl Type

OCI Commands B–7Publication 8520-6.6. - August 1999 InstIDP3 typeParameter 3P2 typeParameter 2P1 typeParameter 1DualProc.# ParamsOCI / 9/PCControl Typ

Appendix ECPublication 8520-6.6. - August 1999OCI Error HandlingThe table on the following pages lists the errors that can be returned or generatedby

OCI Error HandlingC–2Publication 8520-6.6. - August 1999Error Num: Error Name:13 "MISSING MESSAGE FILES"14 "MISSING GRINDER LANGUAGE

OCI Error Handling C–3Publication 8520-6.6. - August 1999Error Num: Error Name:50 "&Error Msg's"51 "&Prompts"52 &q

OCI Error HandlingC–4Publication 8520-6.6. - August 1999Error Num: Error Name:90 "PART PROGRAM EDITOR ACTIVE, CANNOT SWITCH CNC"91 "S

Chapter 3Publication 8520-6.6 - August 1999OCI Basic Display Set (BDS)The Basic Display Set is the standard OCI application software thatcomes with y

OCI Error Handling C–5Publication 8520-6.6. - August 1999Error Num: Error Name:Read Errors for API data items:1000 "DATA TYPE ERROR"1001 &qu

OCI Error HandlingC–6Publication 8520-6.6. - August 1999Error Num: Error Name:2008 "EMPTY COMMAND"2009 "ACCUM NOT ZERO"2010 "

OCI Error Handling C–7Publication 8520-6.6. - August 1999Error Num: Error Name:3023 "ILLEGAL MONITOR MODE"3024 "MONITOR NOT ACTIVE"

OCI Error HandlingC–8Publication 8520-6.6. - August 1999Error Num: Error Name:3063 "NO OFFSET ACTIVE"3064 "OFFSET MOTION PENDING ON CYC

OCI Error Handling C–9Publication 8520-6.6. - August 19995012 "MOTION NOT ALLOWED"5013 "NEGATIVE DWELL VALUE"5014 "R

OCI Error HandlingC–10Publication 8520-6.6. - August 19995048 "ZONE 2 PROGRAM ERROR"5049 "ZONE 3 PROGRAM ERROR"5050 "

OCI Error Handling C–11Publication 8520-6.6. - August 19995084 "RIGHT OPERAND MUST BE POSITIVE"5085 "MULTIPLE FUNCTIONS NOW ALLOW

OCI Error HandlingC–12Publication 8520-6.6. - August 19995120 "OPTION NOT INSTALLED" 1205121 "AXES DATA MISSING"5122

OCI Error Handling C–13Publication 8520-6.6. - August 19995156 "MISSING ROUGHING CYCLE (P/Q) WORD"5157 "INVALID ROUGHING CYCLE (P

OCI Error HandlingC–14Publication 8520-6.6. - August 19995192 "DEPTH > PROGRAMMED ENDPOINT"5193 "INVALID INFEED (P WORD)"

3–2 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Important: The 9/PC CNC does not use Ethernet connections. Ifyou are using a 9/PC C

OCI Error Handling C–15Publication 8520-6.6. - August 19995228 "MISSING CUTTER COMP CODE"5229 "MISSING DATA FROM BLOCK"5230

OCI Error HandlingC–16Publication 8520-6.6. - August 19995264 "ILLEGAL RECIPROCATION INTERVAL"5265 "ONLY ONE M19 ALLOWED PER BLOC

OCI Error Handling C–17Publication 8520-6.6. - August 19995300 "VIRTUAL AXIS NOT ALLOWED" 3005301 "IPD

OCI Error HandlingC–18Publication 8520-6.6. - August 19995336 NO TIME DEPENDENT MACRO IN G60.1",5337 NO SOLID TAPPING IN G60.1",5338 POCK

OCI Error Handling C–19Publication 8520-6.6. - August 19996033 "MUST BE IN (E-STOP)"6034 "MUST BE IN (CYCLE STOP) AND (EOB)"

OCI Error HandlingC–20Publication 8520-6.6. - August 19996069 "TAN CIRCLE NOT IN 1ST BLOCK"6070 "CIRCLE MID-POINT NOT ENTERED&quo

OCI Error Handling C–21Publication 8520-6.6. - August 19996105 "OPTIONAL FEATURE IS NOT PROVIDED" 1056106 "CANNOT EDIT -

OCI Error HandlingC–22Publication 8520-6.6. - August 19996141 "PROBE IS ARMED, CAN'T ADJUST SERVOS"6142 "MUST START WITH $,%

OCI Error Handling C–23Publication 8520-6.6. - August 19996177 "REQUIRES AT LEAST TWO AXES"6178 "PAL/LOGIC SOURCE REV. MISMATCH -

OCI Error HandlingC–24Publication 8520-6.6. - August 19997025 "FILE CANNOT BE CONVERTED TO EIA FORMAT"7026 "UNABLE TO OPEN THE UA

3–3OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999When the setup utility is complete the Visual Basic Pro project fileABOCI.VBP is inst

OCI Error Handling C–25Publication 8520-6.6. - August 199910015 "CANNOT EXIT IN CYCLE"10016 "AXIS POSITION INCORRECT"11000

Publication 85206.6 - August 1999Symbols! User-defined Globals, 4-48$ system flags, 4-49% I/O Variables, 4-47@ - AMP Parameters, A-2@ - AMP parame

IndexI–2Publication 85206.6 - August 1999AMP Data@ - AMP parameters, A-2AMP_PARAMETER_DATA_TYPE, A-2AMP_PARAMETER_NUMBER, A-2NUM_PATCHABLE_AMP_PARAM

IndexI–3Publication 85206.6 - August 1999AXISCAL_MEAS_DEV_AMOUNT, A-2AXISCAL_POINTS_FREE, A-2AXISCAL_POINTS_USED, A-2AXISCAL_STATUS, A-2BACKUP_AXISC

IndexI–4Publication 85206.6 - August 1999Baud Rate. See PortBDSABE files, 3-4ABG files, 3-4ABL files, 3-4ABM files, 3-4basic modules, 3-7DG-cod

IndexI–5Publication 85206.6 - August 1999PORT_BAUD_RATE, 4-21PORT_COMMUNICATION_FORMAT,4-23PORT_DATA_BITS, 4-25PORT_PARITY, 4-23PORT_PERCENT_SELE

IndexI–6Publication 85206.6 - August 1999CURRENT_WHEEL_DIAMETER, A-6Cursor Movement, on master form, 3-8CYCLE_TIME, A-11DD_WORD, A-8Data Buffer,

IndexI–7Publication 85206.6 - August 1999Dual-processdata items, 4-14selecting for commands, 5-2Dual-process Only, 4-8EEditorpart program install

IndexI–8Publication 85206.6 - August 1999ERROR_MESSAGE_TYPE Enumeration,6-7ERROR_MESSAGES, A-4ErrorFile, creating, 3-11Errorsmanaging subroutine,

IndexI–9Publication 85206.6 - August 1999FILE_NAME, 4-7, 4-52, A-12FILE_SIZE, A-12Filename String, 6-19FINE_SCAN_TIME_MAX, A-11Fixed CyclesBACK_B

3–4 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Data FilesData files are found in the ABOCI\DAT or ab9PC\DAT directory andcontain da

IndexI–10Publication 85206.6 - August 1999WARNING_WHEEL_DIAMETER, A-7WHEEL_WIDTH, A-7Inactive Items, removing from WatchList,1-8INCH/METRIC_MODE En

IndexI–11Publication 85206.6 - August 1999LIMIT3_UPPER_LIMITS, A-20LINE_1_MESSAGE_DATA, 4-34, A-4Linkautomatic, 4-10manual, 4-9notify, 4-10Link

IndexI–12Publication 85206.6 - August 1999CANCEL_MESSAGE, 5-21CLEAR_ACTIVE_ERRORS, 5-21CLEAR_CYCLE_TIME, 5-22CLEAR_ERROR_LOG, 5-22CLEAR_POWER_ON

IndexI–13Publication 85206.6 - August 1999NUM_PP_FILES Index, 4-7NUM_PROCESS, 4-62NUM_PROCESSES, A-8NUM_PROG_AXES, A-8NUM_PROG_AXES_PLUS_EXTRA, A-

IndexI–14Publication 85206.6 - August 1999BACKUP_WHEEL_GEOMETRY, B-3BACKUP_WORK_COORD, B-3COPY_OFFSET, B-3MEASURE_TOOL_GEOM, B-3MEASURE_TOOL_WEAR, B

IndexI–15Publication 85206.6 - August 1999Parent, main MDI, 3-6Parity Enumeration, 6-12Part Program, filename string, 6-19Part Program Block Data

IndexI–16Publication 85206.6 - August 1999SCALING_CENTER, A-13PART_PROGRAM_COMMENT, 4-53,A-12PART_PROGRAM_SOURCE, A-12Patch AMP, writing, 4-16PD P

IndexI–17Publication 85206.6 - August 1999PROBE_TOLERANCE_BAND, A-14Probing and Skip CyclesDEPTH_PROBE_FOLLOWING_ERROR, A-13DEPTH_PROBE_POSITION, A-

IndexI–18Publication 85206.6 - August 1999ROTARY_AXIS_LOGICAL_BIT_PATTERN,4-58, A-16ROTATION_EXT_STATUS Enumeration,6-16Rows, adding new softkeys,

IndexI–19Publication 85206.6 - August 1999SERVO_FW_REVISION, 4-5, 4-42, A-8SERVO_MODULES Index, 4-5SERVO_NAME, 4-5, A-16SERVO_NUM Index, 4-5SER

3–5OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Important: Editing these text files should only be necessary whenmaking minor name ch

IndexI–20Publication 85206.6 - August 1999text, 6-20SUB_PROGRAM_REPEAT_COUNT, A-12SubroutinesAPromptPressed, 3-10ASoftkeyPressed, 3-10CreateDataL

IndexI–21Publication 85206.6 - August 1999TRANSFER_AMP_FROM_PORTA, 5-4,B-1TRANSFER_AMP_FROM_PORTB, 5-5,B-1TRANSFER_AMP_TO_PORTA, 5-5, B-1TRANSFER

IndexI–22Publication 85206.6 - August 1999G57_WORK_COORD_UNITS, A-18G58_WORK_COORD_UNITS, A-18G59_WORK_COORD, A-18G59_WORK_COORD_UNITS, A-18G591_WO

IndexI–2Publication 85206.6 - August 1999AllenBradley, a Rockwell Automation Business, has been helping its customers improveproductivity and quali

3–6 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999The majority of the 9/Series or 9/PC Basic Display Set screens arelaid out using a c

3–7OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999• PAL/Logic Messages (PALMSG.FRM) – This form resides justbelow the display form and

3–8 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Also include with the Basic Display Set source code are three formsused as templates

Table of ContentsPublication 85206.6 - August 1999Chapter 1Open Control Interface (OCI) OverviewOCI Data Server Overview 1-1. . . . . . . . . . . .

3–9OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999To make a copy of the MASTER.FRM:1. Open a dummy Visual Basic project. The default “

3–10 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999MASTER.FRM Recommended SubroutinesWhen you develop your new screen we recommend you

3–11OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Managing Errors on your FormWhen you develop your new screen we recommend you place

3–12 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999This procedure assumes you already have Visual Basic active withthe source file ABO

3–13OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Current Softkey Row (SPD_Ptr)Current Softkey NumberToggles between showingsoftkey ro

3–14 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Create New Softkey Pointer ButtonsThe 6 buttons to the right of the softkey and scr

3–15OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Changing the Softkey Row PointerTo edit or change the set of softkeys called when a

3–16 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Creating/Editing a Softkey1. To create a new or change the operation of an existing

3–17OCI Basic Display Set (BDS)Publication 8520-6.6 - August 19994. After deciding if you are entering a key or row you are promptedto add a screen n

3–18 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999A zero in the screen pointer field indicates that no screen is calledwhen that soft

Table of ContentsiiPublication 85206.6 - August 1999Using the Softkey Editor Utility 3-11. . . . . . . . . . . . . . . . . . . . . . . . . . . . Ch

3–19OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999SetSPDPointerYou should not need to edit this file unless there are specialcondition

3–20 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999To improve flexibility of our source code, screen text and promptsare not directly

3–21OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Last Found Search StringEntry Box for Search StringEntry Box for Pointer Number(PR_N

3–22 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999The Basic Display Set provides a print utility to help you documentyour application

3–23OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999A file is created only for the currently active language on the BasicDisplay Set. U

3–24 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999The error text file shown in the next figure lists the error messagetext strings an

3–25OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999The following screen shows the PD_Ptr.pd file. The same file isgenerated for all la

3–26 OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999The following screen shows the english.stx file created when arequest is made to pr

3–27OCI Basic Display Set (BDS)Publication 8520-6.6 - August 1999Write to Error File UtilityThis utility writes program errors, data linking errors,

Chapter 4Publication 8520-6.6 - August 1999OCI Data Server Data ItemsEach OCI data item is presented in the following format:Data Item DescriptionDat

Table of Contents iiiPublication 85206.6 - August 1999PAL Variable Data Items 4-47. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P

4–2 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The data type for a OCI data item determines how the data isreturned from the control

4–3OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Some OCI data items are accessed as arrays. The format for themajority of these array

4–4 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999AXIS_NUMThis array index is dimensioned by the axes number as configuredon the system

4–5OCI Data Server Data ItemsPublication 8520-6.6 - August 1999For example the data item NUM_FILES, which returns the numberof part programs that exi

4–6 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999M_MODAL_GROUPThis array index is dimensioned by the valid M code modal groups.M code

4–7OCI Data Server Data ItemsPublication 8520-6.6 - August 1999SETUP_BUFFERSThis array index is dimensioned by the currently available partprogram se

4–8 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999OFFSET_NUMThis array index is dimensioned in AMP as the maximum number oftool offsets

4–9OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Your OCI application program must choose the link type to be usedbased on your specifi

4–10 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999• Automatic Link. Data that is identified as an automatic link typeis added by the O

4–11OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The OCI WatchListOnce your DDE application makes a DDE request to the OCI dataserver,

Table of ContentsivPublication 85206.6 - August 1999AUX_COM_CMD_FWD_SEARCH (search_type, search_string") 5-15AUX_COM_CMD_REV_SEARCH (search_t

4–12 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999• POKE POKE operations are used to send data to the processorfrom the OCI data serv

4–13OCI Data Server Data ItemsPublication 8520-6.6 - August 1999All data items are monitored in the controls background unlessotherwise indicated in

4–14 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The 9/Series provides a dual process option which allows the use ofthe 9/Series to c

4–15OCI Data Server Data ItemsPublication 8520-6.6 - August 1999All data items for axes are presented in the OCI API in “logical”order with the excep

4–16 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999@parameter_numData Type LREALRead/Write Read/Write (patch AMP only) Read (others)Arr

4–17OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Enumeration Result:0 Short1 Unsigned Short2 Long3 Unsigned Long4 Quad5 Unsigned Quad6

4–18 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999AXISCAL_ABS_POS, point_num, axis_numData Type LREALRead/Write Read onlyArray Index p

4–19OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The AXISCAL_MEAS_DEV_AMOUNT item is used to read backthe correction values from the a

4–20 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999AXISCAL_POINTS_FREEData Type UINTRead/Write Read onlyArray Index noneControl Type La

4–21OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Important:The data items in this section apply to 9/Series controlsonly.PORT_BAUD_RAT

Table of Contents vPublication 85206.6 - August 1999MEASURE_TOOL_WEAR (tool_number, axis_number, ref_pos) 5-32. MEASURE_WHEEL_GEOM (tool_number, ax

4–22 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The port_id index must always be used with this data item. You cannot use this inde

4–23OCI Data Server Data ItemsPublication 8520-6.6 - August 1999PORT_COMMUNICATION_FORMAT, port_idData Type INT (enumerated)Read/Write Read/WriteArra

4–24 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The port_id index must always be used with this data item. You cannot use this inde

4–25OCI Data Server Data ItemsPublication 8520-6.6 - August 1999PORT_DATA_BITS, port_idData Type INT (enumerated)Read/Write Read/WriteArray Index por

4–26 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The port_id index must always be used with this data item. You cannot use this inde

4–27OCI Data Server Data ItemsPublication 8520-6.6 - August 1999PORT_REWIND_ON_MO2_M30, port_idData Type INT (enumerated)Read/Write Read/WriteArray I

4–28 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The port_id index must always be used with this data item. You cannot use this inde

4–29OCI Data Server Data ItemsPublication 8520-6.6 - August 1999PORT_PROGRAM_NAME, port_idData Type INT (enumerated)Read/Write Read/WriteArray Index

4–30 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999The port_id index must always be used with this data item. You cannot use this inde

4–31OCI Data Server Data ItemsPublication 8520-6.6 - August 1999HARDWARE_STATUS_PORTAData Type USINT (bit pattern)Read/Write Read onlyArray Index non

Table of ContentsviPublication 85206.6 - August 1999BACKUP_TOOL_MANAGE ("Filename_string") 5-54. . . . . . . . . . . . . RT_CUSTOMIZE_TOO

4–32 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ThisBit:Indicates:ThisBit:Indicates:0 dc1 (receive) 4 dc1 (transmit)1 dc2 (receive)

4–33OCI Data Server Data ItemsPublication 8520-6.6 - August 1999COMMAND_ERROR_CODEData Type INTRead/Write Read onlyArray Index noneControl Type Lathe

4–34 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999LINE_1_MESSAGE_DATA, error_integerData Type UDINTRead/Write Read onlyArray Index err

4–35OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Value of LINE_1_MESSAGE_DATA,2Resulting impact to LINE_1_MESSAGE_DATA,3:0 NO_VARIABLE

4–36 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Channel Number – (word two value is 4(head) or 5(tail)). Word 3returns a value corre

4–37OCI Data Server Data ItemsPublication 8520-6.6 - August 1999MESSAGE_BASE-LAST-INDEX, range_numData Type UDINTRead/Write Read onlyArray Index rang

4–38 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ACTIVE_PAL_MESSAGES,13Returns the text string for the active PAL/Logic message that

4–39OCI Data Server Data ItemsPublication 8520-6.6 - August 1999DATEData Type String1Read/Write Read/WriteArray Index noneControl Type Lathe/Mill/Gri

4–40 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999PROCESS_CHANGE_REQUESTData Type INTRead/Write Read/WriteArray Index noneControl Type

4–41OCI Data Server Data ItemsPublication 8520-6.6 - August 1999FW_REVISIONData Type DINTRead/Write Read onlyArray Index noneControl Type Lathe/Mill/

Table of Contents viiPublication 85206.6 - August 1999PORT_STOP_BITS enumeration 6-15. . . . . . . . . . . . . . . . . . . . . . . . PORT_TAPE_MULT

4–42 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999SERVO_FW_REVISION, num_moduleData Type DINTRead/Write Read onlyArray Index num_modul

4–43OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ACTIVE_TOOL_GEOM_NUMData Type UINTRead/Write Read onlyArray Index noneControl Type La

4–44 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ACTIVE_TOOL_WEAR_NUMData Type UINTRead/Write Read onlyArray Index noneControl Type L

4–45OCI Data Server Data ItemsPublication 8520-6.6 - August 1999AMPED_TOOL_LENGTH_AXIS_LOGICAL_BIT_PATTERNData Type UDINTRead/Write Read onlyArray In

4–46 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ACTIVE_UNITSData Type UINT (enumerated)Read/Write Read onlyArray Index noneControl T

4–47OCI Data Server Data ItemsPublication 8520-6.6 - August 1999ACTIVE_SCALE_INDICATORData Type DINT (bit pattern)Read/Write Read onlyArray Index non

4–48 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Format for this data item is % followed by the variable name:%HDIO1There can be timi

4–49OCI Data Server Data ItemsPublication 8520-6.6 - August 1999$ System FlagsData Type Defined by PALRead/Write Read/Write (PAL protected)Array Inde

4–50 OCI Data Server Data ItemsPublication 8520-6.6 - August 1999Important: Before the OCI system is allowed to set certainPAL/Logic variables, the s

4–51OCI Data Server Data ItemsPublication 8520-6.6 - August 1999SP (variable number)Data Type LREALRead/Write Read/WriteArray Index paramacro variabl