SCT Scout SC4415, User Manual

Page: 14 / 46

Document# SCT-UM026FVC Page 14 of 46 Confidential
3. Programming
3.1 Overview
For the purposes of this manual, all descriptions and examples will be from the perspective of a terminal emulator
connected to the Scout hardware as described in Section 2.3.
The application programming interface for the SC4415 is a simple command and response type of interface similar to
that of terminal applications. Commands are defined for each application mode and are made up of a combination of
configuration and operational command types. The user can invoke the defined commands by sending the command
name followed by the required arguments. Additional details about command formats are discussed in Section 3.2.2.
3.2 Command Interface
This section describes the features and the usage of the SC4415 Command Interface.
3.2.1 Prompts
Once a connection has been established with the SC4415, the command prompt will become visible. The command
prompt indicates that Scout is ready to accept a new command. The types of command prompts are shown in Table
3.2.1-1.
Type Prompt Section
Standard Prompt -> 3.2.4.1
Primary queue
B>
3.2.4.2
Secondary queue
b>
3.2.4.2
Event Message
E>
3.2.6
Table 3.2.1-1 – Command Prompt Types
As general good practice, it is important for automated applications to always wait to receive the command prompt
prior to sending a new command. Failure to do so can result in a potential data overflow which may cause the
programming interface to become unresponsive. Programming examples which follow this practice can be obtained by
referring to Section 6.1 and visiting the Scout Support Portal.
If the command prompt is not visible upon connecting to Scout, pressing the enter key will re-
print the current command prompt.
3.2.2 Formatting
Any numerical arguments may be represented as either decimal or hexadecimal values provided the hexadecimal value
is prefixed by the characters ‘0x’. For example, if a command argument is provided using the decimal value of ‘10’, the
hexadecimal equivalent would be entered as ‘0xA’.
Commands are described using a specific notation in order communicate the proper usage of a command and its
arguments. Table 3.2.2-1 provides some examples for how a command and its syntax is described. The synopsis and
details for each command can be obtained using Scout’s built-in help system as described in Section 3.2.3.
Definition Details
CMD1 The Command CMD1 does not require any arguments
CMD2 <ARG1> <ARG2>
The Command CMD2 has two mandatory numeric arguments, ARG1
and ARG2
CMD3 <ARG1> [<ARG2>]
The Command CMD3 has one mandatory numeric argument, ARG1,
and one optional numerical argument, ARG2 .