Rockwell Automation 8520-9API 9/Series OCI API Developer's Guide - Manual (Page 112)

Chapter
5
Publication 8520-6.6 - August 1999
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
and relinquish control commands discussed on
page 5–23.
Some commands require a 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_CMD_FWD_SEARCH (search_type, search_string")]
AUX_COM_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 OCI data server even if you leave the argument blank. All comas
must be included and all character strings, even if they are blank “”,
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_CODE) 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.
CNC Command Overview
Command Arguments
Return Codes