Command Code Block; Staging Block; Payload Block - Symmetricom TimeProvider 1100 Reference Manual

Command Code Block

The Command Code Block uniquely identifies the command and identifies the
action to be taken. It consists of a verb and one or more modifiers, separated by the
dash character ( - ).
ED-DAT, for instance, is the command code block used in the TimeProvider's "Edit
Date" TL1 command. ED is the verb and DAT is the modifier indicating that the
command will edit a date object.

Staging Block

The Staging Block is comprised of the following blocks, each separated by the block
separator character.
The Target Identifier (tid) – The tid identifies the specific TimeProvider unit to
which the command applies. The position of the tid is mandatory within the
command string, but it is usually optional sense its value can be null. If it is used
in the command, it must match the Source Identifier (sid) that is set within the unit
or the unit will not respond to the command. If the command is not directly sent to
the unit, as when the command is routed to the unit via a Gateway NE (called
indirect routing), a non-null tid is required.
The Access Identifier (aid) – The aid uniquely identifies the entity within the
associated target unit. In the TL1 syntax descriptions provided in
this manual, the <aid> syntax tag is used specifically to denote modules, inputs,
outputs, or ports. Other more specific syntax tags are used to denote types of
entities, such as <uid> a user identifier, or <cid> a command identifier. The
position of the aid block within the command string always occurs between the
second and third block separator character.
The Correlation Tag (ctag) – The ctag is used to correlate commands and
responses. It can be any alphanumeric string up to six characters in length. In the
TimeProvider, use of the ctag is not mandatory, but is strongly recommended. If
the value for the ctag is null in the command string, the unit returns a zero ( 0 ) as
the ctag in responses.
The General Block – In the TimeProvider the General Block is not used so its
value should always be null. If the General Block is the last block in the command
syntax, it, and the remaining block separator characters can be omitted from the
command string.

Payload Block

The Payload Block contains the parameters associated with the command's
operation. In the TimeProvider's command syntax, the Payload Block can take on
either of the following two forms, depending on the command:
097-58001-01 Revision E – September 2006
Chapter 1 TL1 Overview
TL1 Command Structure
Chapter 2
TimeProvider TL1 Reference Guide
of
15