scan < ioname > [ [ addr ] | [ < on | off > ] | [ < value > ] | [ < bon | boff > ] | [ < son | soff > ] ]
This is the top level I/O scanner command. It allows users to display the
current state of all local or remote system I/O 'points'. An I/O points is
either a 32-bit value considered as a unit (typically an analog value) or a
single discrete bit that is a members of 32-bit discrete I/O group.
I/O groups are always a full 32-bits wide regardless of how many bits are
actually implemented within the group. Analog values are always contained
within a single I/O group dedicated to only one scalar value. Discrete I/O
bits are contained somewhere within a 32-bit discrete I/O group. Not all
bits within any given I/O group (analog or discrete) are necessarily implemented.
The following commands allows various I/O displays options:
"scan <ioname>". This command displays the state of any unique I/O point
if the full I/O name is entered for <ioname> or all I/O points matching the
<ioname> specification up to the number of characters entered.
"scan <ioname> on|off". This command allows the discrete I/O point specified
by <ioname> to be 'forced' on ("scan <ioname> on") or off ("scan <ioname> off").
This command is available in engineering firmware builds only. The entire I/O
name must be specified.
"scan <ioname> <value>". This command allows the value specifed to be written
to the specified group as long as the group is an analog output. This command
is available in engineering firmware builds only. The entire I/O group name
must be specified.
"scan ioname bon|boff". This command allows 'bypass' status to be turned on
("scan <ioname> bon") or off ("scan <ioname> boff") for the I/O point specified
by <ioname>. The entire I/O name must be specified. See the command 'scan
bstatus' for more information on bypassing.
"scan ioname son|soff" This command allows scanning to be turned on
("scan <ioname> son") or off ("scan <ioname> soff") set for the I/O group
I/O specified by <ioname>. This command is available in engineering firmware
builds only. Only a group names are valid for <ioname>. It is not possible
to disable scanning for a discrete IO bit unless the entire group of which it
is a member is disabled. The command "scan bits" can be used to determine the
group to which an I/O bit belongs.
"scan ioname addr" This command displays address and register information
for the remote I/O group specified by <ioname>. The entire I/O group name must
be specified.
Commands are also available for the following operations (Go to "See Also"
below for links to more information on these commands and read the "Notes"
section below for important background information )
"scan groups"......List all I/O groups
"scan bits"..........List all I/O bits
"scan presence"...List all 'presence' bits
"scan bclear".......List all 'bypass' statuses
"scan bstatus"....Clear all 'bypass' statuses
"scan time".........Display scanner time diagnostics
"scan events"......Display I/O bits connected to system event flags
Trendsetter_400/800Trendsetter_NEWS
scan groups
scan bits
scan presence
scan bclear
scan bstatus
scan time
scan time [<clear>]
scan events
scan <ioname>
scan <ioname> [<addr>]
scan <ioname> [<on|off>]
scan <ioname> [<value>]
scan <ioname> [<bon|boff>]
scan <ioname> [<son|soff>]
All I/O bits or groups are accessed with the scan command by a 'standard
firmware name'. Standard firmware names generally have similar functionality
in all CTP machines. For example, users used to a name for a given I/O point
in one product will find the same name for an I/O point with an identical
function in another product. A standard firmware name has the general form
'XXX_ProperCaseName' where 'XXX' is a class mnemonic referring to the machine
subsystem in which the I/O bit or group is used and 'ProperCaseName' is a name
describing the function of the I/O in a reasonably concise way. The class
component and the proper name component are always separated a single
underscore character. The class mnemonic can be any length but is usually
two to four characters in length. Examples:
UI_LampStartButton
UI_Buzzer
CH_Power
DOOR_FrontLock
RLR_SensorHomeSideDown
REG_Sensor1
Where "UI" = "User Interface", "CH" = "Chiller", "RLR" = "Roller" and
"REG" = "Registration".
Analog I/O is the one case where the class portion of the name is fixed. A
class name of "AI_" denotes an analog input. A class name of "AO_" (that's
the letter O not a zero) denotes an analog output. This convention allows the
isolation of all analog values into a easily displayable list. Following are
some self-explanatory examples of analog standard firmware names:
AI_BallScrewTemp
AI_SystemPressure
AI_MainBoardTemp
AI_EngineTemp
AI_DrumVacuum
The only exception to the standard firmware I/O naming convention above is in
the case of 'presence bits'. A presence bit is a discrete input bit used to
indicate if a particular hardware component is detected in a machine. These
bits have no operational function other than to flag missing hardware. Presence
names always contain an ampersand character after the underscore separating the
class mnemonic and the proper name. Examples:
EH_&PowerCable (Head power cable presence)
TE_&Tach", (Tach encoder presence)
Where "EH" = "Exposure Head" and "TE" = "Tachometer Encoder".
This command is available.
Field
18-Jun-2001