VT220 Programmer Reference Manual

Chapter 3

Contents

Appendix A

---

4 Received Codes

4.1 General

This chapter describes the terminal's response to codes it may receive from an application or host system. This Chapter assumes you are familiar with the character encoding conventions and terminology covered in Chapter 2.

All data received by the VT220 consists of single and multiple-character codes: graphic (printing or display) characters, control characters, escape sequences, control sequences and device control strings. Much of that data consists of graphic characters that simply appear on the screen with no other effect. Control characters, escape sequences, control sequences and device control strings are all "control functions" that you use in your program to specify how the terminal should process, transmit, and display characters. Each control function has a unique name and each name has a unique abbreviation (mnemonic). Both the name and the abbreviation are standardized.

By default, the terminal interprets individual control and graphic characters according to the DEC Multinational Character Set code mapping (Chapter 2).

NOTE: The terminal usually ignores control codes it does not support. However, codes sent to the terminal other than those specified in this manual can cause unexpected results.

The codes described in this chapter are described as used in VT220 mode unless otherwise indicated.

4.2 Control Characters

Tables 4-1 and 4-2 define the action taken by the terminal when receiving C0 and C1 control characters. The VT220 does not recognize all C0 or C1 characters. Those not shown in either table are ignored (no action taken).

Table 4-1 shows that SO (0/14) and SI (0/15) are also called LS1 and LS0, respectively. SO and SI (shift out and shift in) are the traditional ASCII names or mnemonics. LS1 and LS0 (lock shift G1 and lock shift G0) are alternate names that are useful when dealing with the variety of character set mappings possible. LS1 and LS0 are the names used in this chapter.

Table 4-2 shows the equivalent 7-bit code extension for each 8-bit C1 code. The code extensions require one more byte than the C1 codes. Chapter 2 describes when to use C1 codes and when to use 7-bit code extensions.

4.3 Compatibility Level (DECSCL)

You can set the terminal to a particular level of operation for compatibility with an application. There are two possible levels, level 1 (VT100 operation) and level 2 (VT200 operation). You can set the VT220 (a level 2 terminal) to either level 1 or level 2. These functional levels are defined in Table 4-3.

You can set the compatibility level of the terminal by using the following sequences.

NOTE: You only have to apply restrictions for a lower compatibility level when there is a noncompatible interaction with software written for the lower level.

9/11 3/6 3/1 2/2  7/0
CSI   6   1   "    p

9/11 3/6 3/2 2/2  7/0
CSI   6   2   "    p

9/11 3/6 3/2 3/11 3/0 2/2 7/0
CSI   6   2   ;    0   "   p

9/11 3/6 3/2 3/11 3/2 2/2 7/0  
CSI   6   2   ;    2   "   p

9/11 3/6 3/2 3/11 3/1 2/2 7/0
CSI   6   2   ;    1   "   p

4.4 Character Set Selection (SCS)

Character encoding in the VT220 was introduced in Chapter 2. The control functions you need to select different graphic character sets are described in this section. Coding differences between the VT220 and VT100 terminals are pointed out where they may affect software compatibility between the VT220 and VT100-type terminals.

The VT220's graphic character repertoire consists of the following graphic sets. (See Chapter 2 for a description of these character sets).

• ASCII graphics
• DEC supplemental graphics (level 2)
• DEC special graphics
• National replacement character (NRC) sets
• Down-line-loadable (level 2)

Generally, you select character sets as follows (Figure 4-1).

NOTE: GR is available only in VT200 mode.

First, you use SCS sequences to designate graphic sets as G0, G1, G2, and G3. This makes the graphics sets available for your program when you map them into GL or GR. To map one of these sets into GL or GR, you must invoke the selected set (G0 through G3) into GL or GR by using locking shifts (LS0, LS1, LS2, LS3, LS1R, LS2R, LS3R) or single shifts (SS2, SS3).

Character sets remain designated until the terminal receives another SCS sequence. All locking shifts remain active until the terminal receives another locking shift. Single shifts SS2 and SS3 are active for only the next single graphic character.

You do not need to select character sets in this manner every time you use the terminal, because there is a default mapping. The default mapping in VT200 mode is ASCII graphics in GL and DEC supplemental graphics in GR (DEC multinational). The default graphic character set mapping is reset whenever you power up the terminal. Your application can also select the default mapping by using the soft terminal reset sequence (DECSTR).

The following sections describe all control functions for designating and invoking graphic character sets.

4.4.1 Designating Hard Character Sets

You designate hard character sets (ASCII, DEC supplemental graphics, DEC special graphics, and national replacement character sets) as G0 through G3, using the following escape sequence formats.

1/11 2/8
ESC   (   {final}

1/11 2/9
ESC   )   {final}

1/11 2/10
ESC   *   {final}

1/11 2/11
ESC   +   {final}

NOTE: You cannot designate a G2 and G3 set in VT100 mode.

The final character in the escape sequences above represents the character set you want to designate. Table 4-4 lists the available character sets and their associated final character.

To designate a character set as any of the graphic sets (G0 through G3), you must include a final character in one of the escape sequences in Table 4-4. For example, to designate the ASCII character set as the G0 graphic set you would use the following escape sequence.

   ESC  (  B

To designate the ASCII character set as the G2 graphic set you would use this escape sequence.

   ESC  *  B

Note that there is a definite pattern of escape sequences in the designation process.

4.4.2 Designating Soft (Down-Line-Loadable) Character Sets

You can define a soft character set (font) that may or may not replace one of the existing hard sets (ROM fonts). If you do replace a hard set, the replacement occurs for both the 80 and 132-column versions.

A soft character set that replaces a hard character set remains in effect until the soft character set is cleared or redefined. The soft character set is cleared by the "Recall" and "Default" set-up features, and by the power-up self-test. The soft character set is redefined by a DECDLD device control string, described later in this chapter. If the soft character set you define does not replace an existing hard set, then it is used in addition to the hard sets.

NOTE: Only VT220 mode supports the designation of a soft character set.

You designate a soft (down-line-loadable) character set by using the following escape sequences.

1/11 2/8 ....... 
ESC   (    Dscs

1/11 2/9 ....... 
ESC   )    Dscs

1/11 2/10 ...... 
ESC   *    Dscs

1/11 2/11 ...... 
ESC   +    Dscs

In these sequences, Dscs is a variable that defines the soft character set used.

I I F        

Here are three examples of Dscs.

2/0 4/0
sp   @

4/2
 B

2/6 2/5  4/3 
 &   %    c

4.4.3 Invoking Character Sets with Locking Shifts

Once you have designated your character sets, you can invoke G0, G1, G2, or G3 into GL or GR. To invoke a set, you use the locking shift (LS) control functions, as shown in Table 4-5 and Figures 4-2 and 4-3.

4.4.4 Invoking Character Sets with Single Shifts

After you designate your character sets, you can invoke G2 or G3 into GL for a single graphic character. To do this, you use the single shift (SS) control functions described below and in Figures 4-2 and 4-3.

All single shifts are active for only the next single graphic character. The terminal returns the previous character set after displaying a single graphic character.

4.4.4.1 SS2 -- Single Shift G2

SS2 is an 8-bit control character (8/14) that invokes G2 into GL for the next graphic character. You can also express SS2 as an escape sequence when coding for a 7-bit environment, as follows.

    1/11  4/14
    ESC    N

4.4.4.2 SS3 -- Single Shift G3

SS3 is an 8-bit control character (8/15) that invokes G3 into GL for the next graphic character. You can also express SS3 as an escape sequence when coding for a 7-bit environment as follows.

    1/11  4/15
    ESC    O

4.5 Select C1 Controls

You can use select C1 controls (code extension announcers) in your program to control the representation of C1 control codes returned to the application by the terminal. (See Chapter 2 for information on working with 7-bit and 8-bit environments.) The terminal always accepts 7-bit or 8-bit forms for C1 controls in either VT200 mode.

Digital recommends that you use DECSCL sequences instead of select C1 controls. The advantage is that DECSCL performs a soft reset, putting the terminal in a known state, in addition to setting the terminal mode and C1 control state.

NOTE: These sequences are supported only in VT200 mode.

4.5.1 Select 7-Bit C1 Control Transmission (S7C1T)

The following sequence converts all C1 codes returned to the application to their equivalent 7-bit code extensions.

    1/11 2/0  4/7
    ESC  sp    F

NOTE: The S7C1T sequence is ignored in VT100 or VT52 mode.

4.5.2 Select 8-Bit C1 Control Transmission (S8C1T)

The following sequence returns C1 codes to the application without converting them to their equivalent 7-bit code extensions.

    1/11 2/0  4/6
    ESC  sp    G

4.6 Terminal Modes

A mode is one of several operating states used by the terminal. Each mode changes the way the terminal works. Table 4-6 lists the selectable modes and their set/reset control sequences. The following sections describe these modes.

Each mode has an identifying name (mnemonic). You can set or reset modes individually or in strings using set mode (SM) or reset mode (RM) control sequences. You can also lock certain features, called user preference features, by using the General Set-Up screen; this prevents the host from changing the feature.

Digital private control sequences (permitted within the extensions of ANSI standards) are identified by DEC in the control sequence mnemonic. These sequences include a question mark character (?) after the control sequence introducer.

You can also select these modes from the keyboard by using set-up screens.

4.6.1 Set Mode (SM)

The set mode sequence for ANSI modes is as follows.

    9/11      3/11   3/11    6/8
    CSI   Ps   ; .... ;   Ps  h

The set mode sequence for Digital private modes is as follows.

    9/11  3/15      3/11   3/11    6/8
    CSI    ?    Ps   ; .... ;   Ps  h

You use these sequences to set the ANSI and Digital private modes, individually or in strings. Tables 4-7 and 4-8 list the Ps parameters. You cannot use ANSI modes and Digital private modes in the same SM string.

4.6.2 Reset Mode (RM)

The reset mode sequence for ANSI modes is as follows.

    9/11      3/11   3/11    6/12
    CSI   Ps   ; .... ;   Ps  l

The reset mode sequence for Digital private modes is as follows.

    9/11  3/15      3/11   3/11    6/12
    CSI    ?    Ps   ; .... ;   Ps  l

You use these sequences to reset the ANSI and Digital private modes, individually or in strings. Tables 4-7 and 4-8 list the Ps parameters. You cannot use ANSI modes and Digital private modes in the same RM string.

4.6.3 Keyboard Action Mode (KAM)

Keyboard Action mode lets your program lock and unlock the keyboard. When the keyboard is locked, it cannot send codes to the program. To alert the operator, the terminal turns on the Wait indicators and disables the keyclick features whenever the keyboard is locked.

You can set or reset keyboard action mode as follows.

NOTE: This is a user preference feature that you can lock by using set-up.

9/11 3/2  6/8
CSI   2    h

9/11 3/2  6/12 
CSI   2    l

4.6.4 Insert/Replace Mode (IRM)

The terminal displays received characters at the cursor position. Insert/Replace mode determines how the terminal adds characters to the screen. Insert mode displays the new character and moves previously displayed characters to the right. Replace mode adds characters by replacing the character at the cursor position.

You can set or reset insert/replace mode as follows.

9/11 3/4  6/8
CSI   4    h

9/11 3/4  6/12 
CSI   4    l

4.6.5 Send/Receive Mode (SRM)

Send/receive mode turns local echo on or off. When send/receive mode is reset (local echo on), every character sent from the keyboard automatically appears on the screen. Therefore, the host does not have to send (echo) the character back to the terminal display. When send/receive mode is set (local echo off), the terminal only sends characters to the application. The host must echo the characters back to the screen.

You can set or reset send/receive mode as follows.

9/11 3/1  3/2 6/8
CSI   1    2   h

9/11 3/1  3/2 6/12 
CSI   1    2   l

4.6.6 Line Feed/New Line Mode (LNM)

Line feed/new line mode selects the control character(s) transmitted to the application by the Return and Enter keys. Enter sends the same code as Return only when the auxiliary keypad is in Keypad numeric mode (DECKPNM).

Line feed/new line also selects the action taken by the terminal when receiving line feed (LF), form feed (FF), or vertical tab (VT) codes. These three codes are always processed identically.

You set and reset line feed/new line mode as follows.

NOTE: For compatibility with Digital software, this mode should always be reset.

9/11 3/2  3/0 6/8
CSI   2    0   h

9/11 3/2  3/0 6/12 
CSI   2    0   l

4.6.7 Text Cursor Enable Mode (DECTCEM)

Text cursor enable mode determines if the text cursor is visible.

You set and reset this mode as follows.

9/11 3/15 3/2 3/5 6/8
CSI   ?    2   5   h

9/11 3/15 3/2 3/5 6/12 
CSI   ?    2   5   l

4.6.8 Cursor Key Mode (DECCKM)

Cursor key mode determines the characters sent by the cursor keys.

You can set and reset this mode as follows.

9/11 3/15 3/1 6/8
CSI   ?    1   h

9/11 3/15 3/1 6/12 
CSI   ?    1   l

4.6.9 ANSI/VT52 Mode (DECANM)

In ANSI mode, reset selects VT52 compatibility mode. In VT52 mode, the terminal responds like a VT52 terminal to private Digital sequences. The reset state of this mode sets the terminal to the VT52 mode. There is no set state for this mode.

9/11  3/15  3/2  6/12
CSI    ?     2    l

Sets the terminal to VT52 mode.

4.6.10 Column Mode (DECCOLM)

Column mode selects the number of columns per line (80 or 132) on the screen. The screen can display 24 lines of text with either selection.

You select the number of columns per line as follows.

NOTE: When the terminal receives the sequence, the screen is erased and the cursor moves to the home position. This also sets the scrolling region for full screen (24 lines).

9/11 3/15 3/3 6/8
CSI   ?    3   h

9/11 3/15 3/3 6/12 
CSI   ?    3   l

4.6.11 Scrolling Mode (DECSCLM)

Scrolling is the upward or downward movement of existing lines on the screen. There are two methods of scrolling, jump scroll and smooth scroll (6 lines per second).

You can set or reset the scroll mode as follows.

NOTE: This is a user preference feature that you can lock by using set-up.

9/11 3/15 3/4 6/8
CSI   ?    4   h

9/11 3/15 3/4 6/12 
CSI   ?    4   l

4.6.12 Screen Mode (DECSCNM)

Screen mode selects either a dark or light (reverse) display background on the screen.

You can set or reset screen mode as follows.

NOTE: This is a user preference feature that you can lock by using set-up.

9/11 3/15 3/5 6/8
CSI   ?    5   h

9/11 3/15 3/5 6/12 
CSI   ?    5   l

4.6.13 Origin Mode (DECOM)

Origin mode allows cursor addressing relative to a user-defined origin. This mode resets when the terminal is powered up or reset. It does not affect the erase in display (ED) function.

You can set or reset origin mode as follows.

9/11 3/15 3/6 6/8
CSI   ?    6   h

9/11 3/15 3/6 6/12 
CSI   ?    6   l

4.6.14 Auto Wrap Mode (DECAWM)

This mode selects where received graphic characters appear when the cursor is at the right margin.

You can set or reset auto wrap mode as follows.

NOTE: Regardless of this selection, the tab character never moves the cursor to the next line.

9/11 3/15 3/7 6/8
CSI   ?    7   h

9/11 3/15 3/7 6/12 
CSI   ?    7   l

4.6.15 Auto Repeat (DECARM)

Auto repeat mode selects automatic key repeating. When auto repeat mode is set, a key pressed for more than 0.5 seconds automatically repeats the transmission of the character until the key is released. The following keys never auto repeat: Hold Screen, Print Screen, Set-Up, Data/Talk, Break, Return, Compose Character, Lock, Shift, and Ctrl.

You can set or reset auto repeat mode as follows.

NOTE: This is a user preference feature that you can lock by using set-up.

9/11 3/15 3/8 6/8
CSI   ?    8   h

9/11 3/15 3/8 6/12 
CSI   ?    8   l

4.6.16 Print Form Feed Mode (DECPFF)

This mode determines whether or not the terminal sends a print termination character after a screen print. The form feed control character (FF) serves as the print termination character.

You can set or reset print form feed mode as follows.

9/11 3/15 3/1 3/8  6/8
CSI   ?    1   8    h

9/11 3/15 3/1 3/8  6/12 
CSI   ?    1   8    l

4.6.17 Print Extent Mode (DECPEX)

Print extent mode selects the full screen or the scrolling region to print during a print screen operation.

You can set or reset this mode as follows.

9/11 3/15 3/1 3/9  6/8
CSI   ?    1   9    h

9/11 3/15 3/1 3/9  6/12 
CSI   ?    1   9    l

4.6.18 Keypad Mode (DECKPAM/DECKPNM)

The auxiliary keypad generates either numeric characters or control functions. Selecting application or numeric keypad mode determines the type of characters.

You can select the keypad mode as follows.

NOTE: When the terminal is powered up or reset, the terminal selects numeric keypad mode.

1/11 3/13 
ESC   =

1/11 3/14 
ESC   >

4.6.19 Character Set Mode (DECNRCM)

Character set mode determines whether the terminal uses national replacement character sets or the DEC multinational character set.

You can select this mode as follows.

9/11 3/15 3/4 3/2 6/8
CSI   ?    4   2   h

9/11 3/15 3/4 3/2 6/12
CSI   ?    4   2   l

4.7 Cursor Positioning

The cursor indicates the active screen position where the next character will appear (in the absence of auto wrap). A number of operations implicitly affect cursor positioning. In addition, you can control cursor movement using the following sequences.

NOTE: Pn is a variable, ASCII coded, numeric parameter. If you select no parameter or a parameter value of 0, the terminal assumes the parameter equals 1.

9/11     4/1
CSI  Pn   A

9/11     4/2
CSI  Pn   B

9/11     4/3
CSI  Pn   C

9/11     4/4
CSI  Pn   D

9/11     3/11    4/8 
CSI  Pl   ;   Pc  H

9/11     3/11    6/6 
CSI  Pl   ;   Pc  f

1/11 4/4
ESC   D

1/11 4/13
ESM   M

1/11 4/5
ESC   E

1/11 3/7
ESC   7

1/11 3/8
ESC   8

4.8 Tab Stops

You select tab stop positions on the horizontal lines of the screen. The cursor advances (tabs) to the next tab stop when the terminal receives a horizontal tab code (HT, 0/9). If there is no next tab, HT moves the cursor to the right margin.

You can set and clear the tab stops as follows.

NOTE: This is a user preference feature that you can lock in set-up.

1/11 4/8
ESC   H

9/11 6/7
CSI   g

9/11 3/0 6/7 
CSI   0   g

9/11 3/3 6/7 
CSI   3   g

4.9 Character Rendition and Attributes

Character rendition and attributes are display features that affect the way a character is displayed, without changing the character. You can change character rendition using select graphic rendition (SGR) sequences. You can also designate characters to be erasable or not erasable when by using the select character attribute (DECSCA) sequence. DECSCA affects erase sequences.

4.9.1 Select Graphic Rendition (SGR)

You can select one or more character renditions at a time by using the following format.

   9/11    3/11         6/13
   CSI  Ps  ;   Ps ...   m

When you use multiple parameters, they are executed in sequence. The effects are cumulative. For example, you can change from increased intensity to blinking-underlined as follows.

   9/11 3/0 3/11 3/4 3/11 3/5 6/13
   CSI   0   ;    4   ;    5   m

When you select a single parameter, no delimiter (3/11) is used. For example, you can select the blinking only parameter as follows.

   9/11 3/5 6/13
   CSI   5   m

After you select an attribute, all new characters received by the terminal appear with that attribute. If you move the characters by scrolling, the attribute moves with the characters.

You can select character attributes by using the formats described above and the following Ps parameter values.

3/0
 0

3/1
 1

3/4
 4

3/5
 5

3/7
 7

3/2 3/2 
 2   2

3/2 3/4 
 2   4

3/2 3/5 
 2   5

3/2 3/7 
 2   7

4.9.2 Select Character Attributes (DECSCA)

You can select all characters to be erasable or not erasable by using the following format. (See the "Erasing" section in this chapter.)

NOTE: This sequence is supported only in VT200 mode.

   9/11     2/2  7/1
   CSI  Ps   "    q

Ps is one of the following values.

NOTE: A parameter value of 0 implies the default, which is attributes off (erasable by DECSEL/DECSED). A parameter value of 2 is an explicit request for this attribute to be off (so the character is erasable by DECSEL/DECSED).

4.10 Line Attributes

Lines attributes are display features that affect a complete display line. The cursor selects the line affected by the attribute. The cursor stays in the same character position when the attribute changes, unless the attribute would move the cursor past the right margin. In that case, the cursor stops at the right margin. When you move lines on the screen by scrolling, the attribute moves with the line. Select line attributes by using the following sequences.

NOTE: If you erase an entire line while using the erase in display (ED) sequence, the line attribute changes to single-height and single-width.

4.10.1 Double Height Line (DECDHL)

These sequences make the line with the cursor the top or bottom half of a double-height, double-width line. You must use these sequences in pairs on adjacent lines. The same character must be used on both lines to form a full character. If the line was previously single-width, single-height, all characters to the right of center are lost.

1/11 2/3 3/3 
ESC   #   3

1/11 2/3 3/4 
ESC   #   4

4.10.2 Single-Width Line (DECSWL)

The DECSWL sequence makes the line with the cursor single-width, single-height. This is the line attribute for all new lines on the screen.

1/11 2/3 3/5
ESC   #   5

4.10.3 Double-Width Line (DECDWL)

The DECDWL sequence makes the line with the cursor double-width, single-height. If the line was previously single-width, single-height, all characters to the right of center screen are lost.

1/11 2/3 3/6
ESC   #   6

4.11 Editing

You use editing sequences to insert and delete characters and lines of characters at the cursor position. The cursor position does not change when inserting or deleting lines.

You can delete characters or insert and delete lines as follows.

NOTE: Pn is a variable, ASCII-coded, numeric parameter. If you select no parameter or a parameter value of 0, the terminal assumes a parameter value of 1.

9/11    4/12 
CSI  Pn  L

9/11    4/13 
CSI  Pn  M

9/11    4/0 
CSI  Pn  @

9/11    5/0 
CSI  Pn  P

4.12 Erasing

Erasing removes characters from the screen without affecting other characters on the screen. Erased characters are lost. The cursor position does not change when erasing characters or lines. Erasing a character also erases any character attribute of the character.

You can erase characters as follows.

9/11     5/8 
CSI  Pn   X

9/11 4/11
CSI   K

9/11 3/0  4/11 
CSI   0    K

9/11 3/1  4/11 
CSI   1    K

9/11 3/2  4/11 
CSI   2    K

9/11 4/10 
CSI   J

9/11 3/0  4/10 
CSI   0    J

9/11 3/1  4/10 
CSI   1    J

9/11 3/2  4/10
CSI   2    J

9/11 3/15 4/11 
CSI   ?    K

9/11 3/15 3/0 4/11 
CSI   ?    0   K

9/11 3/15 3/1 4/11 
CSI   ?    1   K

9/11 3/15 3/2 4/11 
CSI   ?    2   K

9/11 3/15 4/10 
CSI   ?    J

9/11 3/15 3/0 4/10 
CSI   ?    0   J

9/11 3/15 3/1 4/10 
CSI   ?    1   J

9/11 3/15 3/2 4/10 
CSI   ?    2   J

4.13 Scrolling Margins (Top and Bottom)

The scrolling region is the area of the screen that can receive new characters by scrolling old characters off the screen. The area is defined by the top and bottom screen margins. The smallest scrolling region allowed is two lines; therefore the number of the top margin must be at least one less than the number of the bottom margin.

You can select the top and bottom margins of the scrolling region as follows.

4.13.1 Set Top and Bottom Margins (DECSTBM)

This sequence selects top and bottom margins defining the scrolling region.

   9/11    3/11     7/2
   CSI  Pt  ;   Pb   r

4.14 Printing

You can select all print operations with control sequences. When characters are printed on the screen, terminal and printer tab stops are ignored. Print characters are spaced with the space (SP) character. The terminal transmits a carriage return (CR) and line feed (LF), a vertical tab (VT), or a form feed (FF) after the last printable character of a line (not a space character).

NOTE: Spaces with video attributes are printable characters.

Before you select a print operation, you should check printer status with the print status report (DSR) (see the "Reports" section in this chapter.)

You can select print operations as follows.

9/11 3/15 3/5  6/9 
CSI   ?    5    i

9/11 3/15 3/4  6/9 
CSI   ?    4    i

9/11 3/5  6/9 
CSI   5    i

9/11 3/4  6/9 
CSI   4    i

9/11 3/15 3/1  6/9 
CSI   ?    1    i

9/11 6/9 
CSI   i

9/11 3/0  6/9 
CSI   0    i

4.15 User Defined Keys (DECUDK)

Fifteen of the terminal's top-row function keys are programmable: F6 through F14, Do, Help, and F17 through F20. (Hold Screen, Print Screen, Set-Up, Data/Talk and Break have dedicated local functions and are not programmable). When the terminal is in VT200 mode, you can down-line-load one or more key sequences for the programmable function keys by using DECUDK device control strings. (The programmable function keys are inoperative in the VT100 and VT52 modes.)

To access the programmed values of the keys, you type Shift-(function key). To access the normal control sequence values, you press the function key alone.

There are 256 bytes available to the 15 programmable function keys. Space is supplied on a first-come/first-serve basis. Once the 256 bytes are used, you cannot redefine any more keys unless you clear space. There are three ways you can clear space.

1. Redefine a key or keys by using a DECUDK.

2. Clear a key or keys by using a DECUDK.

3. Clear the definition set with a terminal power-up or recall operation.

NOTE: All keys definitions are stored in volatile RAM. UDK key definitions are lost when terminal power is lost.

4.15.1 DECUDK Device Control String Format

NOTE: See Chapter 2 for general information about device control strings.

The device control string format for down-line-loading UDK functions is as follows.

Each string component is described below.

NOTE: This sequence is supported only in VT200 mode.

The device control string introducer is DCS (9/0). This character introduces the control string. DCS is an 8-bit character (9/0) that you can also express as ESC P (1/11 5/0) when coding for a 7-bit environment.

The clear parameter (Pc) determines which keys are cleared and when. A value of 0 (clear all) clears all keys, then loads each specific key as it is met in the DRCS. A value of 1 (load new values, clear old only when redefined) clears each key to be reloaded just before loading it; a 1 does not clear keys that are not being redefined. By using a value of 1 for Pc, you can redefine some keys without reloading them all.

NOTE: There are only 256 bytes available. A key definition cannot contain more than 256 bytes or the number of bytes available when that key is loaded, whichever is less.

Note that if you set Pc to 1 (load new, but do not clear old), a key load may fail because no room is available – even though the final total for all keys would have been 256 bytes or less. The reason for this is as follows.

With Pc set to 1, keys are cleared and loaded sequentially. Sequential loading may result in intermediate storage requirements higher than 256 bytes, even though the final requirement would be 256 bytes or less. For example, suppose F6 contained 120 bytes, F7 contained 110 bytes, and F8 contained 20 bytes. Loading F8 with 40 bytes, F6 with 1 byte and F7 with 1 byte works if all keys are cleared first, but not if the keys are cleared as they are sequentially redefined. When you try to load F8 with 40 bytes, the load fails because only 26 bytes are free at that time (256 - 120 - 110 = 26).

The following is a summary of Pc values and meanings.

The lock parameter (Pl) determines whether the key definitions are locked or not locked after you load them. Pl follows the Pc values and is separated by a semicolon character (;, 3/11) as a delimiter. If you set the Pl value to 0 (lock), the keys are locked at the completion of loading. At this point, the terminal operator must unlock the keys for redefinition using set-up. If you set the Pl value to 1 (do not lock), the keys are available for further definition with another DECUDK string. The default for the lock parameter is lock.

NOTE: A Pl value of 1 does not unlock the keys. It simply does not lock them.

The following is a summary of Pl values and meanings.

The final character, a vertical bar (7/12), designates this control string as a DECUDK.

The key definition strings (Kyn/Stn) are included in the data following the final character and before the string terminator. Each key definition string consists of a key selector number (Kyn) and a string parameter (Stn) separated by a slash (/, 2/15).

The key selector numbers (Kyn) specify the particular key to be redefined, and the string parameters (Stn) are the encoded contents of the keys. The string parameters (Stn) consist of hex pairs in the range of 3/0 through 3/9 (0 through 9), 4/1 through 4/6 (A through F), and 6/1 through 6/6 (a through f). When you combine these hex values, they represent an 8-bit quantity.

This method lets you use any of the 256 character codes in the key sequence. You can use key definition strings in any order. You can also specify multiple definitions using a semicolon (; 3/11) as a delimiter.

Here is a list of definable keys and their identifying values.

The string terminator is ST (9/12). This is an 8-bit control character that you can also express as ESC \ (1/11, 5/12) when coding for a 7-bit environment.

NOTE: To access the programmed values of keys, you type Shift-(function key). To access the normal control sequences, you type the function key alone.

4.15.2 Things to Keep in Mind When Loading Keys

Here are some general guidelines you should keep in mind when loading the keys.

• Software should use the UDK function to clear key definition space. You can do this by clearing keys without locking them. After the keys are cleared, you can use the UDK function to redefine the keys and lock them.

• Generally, you should not leave keys unlocked. This could cause a breach of security for the terminal user and the computer system.

• The host must keep track of space available for definitions.

• If you redefine a key, the old sequence is lost. This may clear some space if the new sequence is shorter than the previous definition.

• The terminal uses a special lock to arbitrate the programming of keys. You can turn this lock on or off in set-up. It may also be turned on with a DECUDK from the host. The lock acts globally over all programmable keys.

• The default value for each key definition is empty (blank). When you clear the keys, they are empty. All key definitions are stored in volatile RAM. If the terminal loses power, key definitions are lost. An aborted function key load (by error or other cause) locks the keys, saves the already successfully loaded fraction, and sends the rest of the DECUDK sequence to the screen. An invalid DCS hex pair in a key definition string causes an aborted load.

4.15.3 Examples and Recommendations for Using DECUDK

To clear keys, send the following sequence.

   9/0  3/0  3/11  3/1  7/12  9/12
   DCS   0    ;     1    |     ST

To lock keys, send the following sequence.

   9/0  3/1  3/11  3/0  7/12  9/12
   DCS   1    ;     0    |     ST

Suppose you want to define key F20 to be "PRINT", and you want to do this without clearing or locking any other keys. The first part of your sequence would look like this.

   9/0  3/1  3/11  3/1  7/12  3/3  3/4  2/15
   DCS   1    ;     1    |     3    4    /

The 34 after the final character (7/12) identifies key F20. After the slash character (2/15), you would include the definition. The encoding for "PRINT" is as follows.

   P = 50 hex
   R = 52 hex
   I = 49 hex
   N = 4E hex
   T = 54 hex

So the rest of the sequence you enter after the slash character would look like this.

   3/5  3/0  3/5  3/2  3/4  3/9  3/4  4/5  3/5  3/4  9/12
    5    0    5    2    4    9    4    E    5    4    ST

The ST character (9/12) marks the end of the sequence.

4.16 Down-Line-Loadable Character Set

In a VT200 mode, the terminal lets you create and down-line-load a character set containing up to 94 characters. This character set is called a dynamically redefinable character set (DRCS). After you create characters, you can load them into the terminal DRCS buffer by using a DECDLD device control string.

NOTE: This character set is not loaded into nonvolatile RAM. So when the terminal is powered off, characters are lost.

4.16.1 Designing a Character Set

Figure 4-4 compares DRCS cell size and the terminal's normal character cell size in pixels. Note that the maximum number of pixels in the DRCS cell is 80 (8 × 10). Note also, that the normal terminal's character cell size is less than the DRCS cell size. Since the terminal ignores characters defined beyond the DRCS cell size, you must design your characters to fit the DRCS cell size.

Each pixel in a character font is represented by a bit with a binary value of 1 (on) or 0 (off). One (1) specifies foreground (pixel on) and zero (0) specifies background (pixel off).

For example, suppose you want to design character A. To do this, you follow a four-step process.

1. First designate which pixels are to be on and which pixels will be off. Your design may look like Figure 4-5.

2. After you establish what your DRCS character A will look like, divide the pixels of the DRCS character cell into columns of six bits each using the format shown in Figure 4-6. The column numbers here designate the order in which the columns are sent to the terminal.

   Each column is now represented as a vertical 1 × 6 pixel matrix called a sixel. The least significant bit is at the top, and the most significant bit is at the bottom. Because the character height (10 pixels) is not a multiple of 6, the columns on the bottom of the character cell have only 4 bits each. (The two highest order bits, 5 and 6, are ignored.)

3. After you divide your DRCS character into six-pixel columns (sixels), convert the binary values of each column to its equivalent character. Because column codes are restricted to characters with the range of ? (octal 077) to ~ (octal 176), you must add an offset of octal 077 to each column octal value. Thus, binary value 000000 is converted to octal 077 (octal 0 + octal 77); binary 110101 is converted to octal 164 (octal 65 + octal 077); and binary 111111 is converted to octal 176 (octal 077 + 077).

4. After you convert the binary column codes to octal values (using the offset), convert the octal value for each column to its equivalent character using the ASCII table in Chapter 2. Figure 4-7 provides this conversion procedure for our example of a DRCS character A.

Use this procedure to design each DRCS characters you want. You can then down-line-load your DRCS characters with the DECDLD device control string described in the next section. The DRCS characters consist of a string or strings of characters.

4.16.2 Down-Line-Loading DRCS Characters

You can down-line-load your DRCS character set with the following DECDLD device control string format.

NOTE: See Chapter 2 for general information about device control strings.

   DCS Pfn;Pcn;Pe;Pcms;Pw;Pt { Dscs Sxbp1;Sxbp2;...;Sxbpn ST

DCS (9/0) is the device control string introducer. It is an 8-bit control character that you can also express as ESC P (1/11, 5/0) when coding for a 7-bit environment.

Pfn;Pcn;Pe;Pcms;Pw;Pt are parameter characters, separated by semicolons. Table 4-9 describes these parameters. Valid values for Pcms, Pw, and Pt are: Pcms = 0, 2, 3 or 4; Pw = 0, 1 or 2; and Pt = 0 or 1. Invalid combinations are ignored. You can use a loaded font (character set) in 80 or 132 columns.

{ (7/11) is the final character that marks the end of the parameter characters and specifies a DECDLD function.

Dscs defines the character set name for the soft font, and is used in the SCS (select character set) escape sequence.

Sxbp1;Sxbp2;...;Sxbpn are sixel bit patterns (1 to 94 patterns) for characters separated by semicolons. Each sixel bit pattern has the form:

    S...S/S...S

where

• the first S...S represents the upper columns (sixels) of the DRCS character,
• the slash (2/5) advances the sixel pattern to the lower columns of the DRCS character,
• and the second S...S represents the lower columns (sixels) of the DRCS (Figure 4-6).

ST (9/12) is the string terminator. It is an 8-bit control character that you can also express as ESC \ (1/11, 5/12) when coding for a 7-bit environment.

4.16.3 DECDLD Example

Suppose you want to load a character set starting with the character A, designed in the example in Paragraph 4.16.1. To do this, you could use the following device control string.

   DCS 1;1;1 { sp @ ogcacgo/B?????B;(next character);.....ST

DCS introduces the sequence.

1;1;1 specifies loading the DRCS font buffer, selects the starting character as column 2/row 1 of ASCII chart (Chapter 2), and selects to erase only the characters that are loaded (Table 4-9). Note that Pcms, Pw, and Pt are not included; they default to 0 values.

{ indicates the end of the parameter characters and specifies that this is a DECDLD control string.

sp @ defines a character set as an unregistered soft set. This value is the recommended default value for user-defined sets. The "sp" represents one space. Other DRCS values can be used to define other specific character sets.

ogcacgo are the character codes for the upper columns of the example DRCS character A.

/ advances the sixel sequence to the lower columns of the example DRCS character A.

B?????B are the character codes for the lower columns of the example DRCS character A.

; signals the end of the DRCS character string being loaded and the beginning of another DRCS character to be loaded.

ST indicates the end of the device control string.

NOTE: See the "Character Set Selection" section in this chapter for information on designating and invoking soft character sets.

4.16.4 Clearing a Down-Line-Loaded Character Set

You can clear a character set that you have down-line-loaded by using the following DECDLD control sequence:

   DCS 1;1;2 { sp @ ST

Down-line-loaded character sets are also cleared by the following actions.

• Performing the power-up self test
• Using the set-up "Recall" or "Default" fields
• Using RIS or ESC c sequences

4.17 Reports

The terminal sends reports in response to host computer requests. These reports provide identification (type of terminal), cursor position, and terminal operating status. There are two categories of reports, device attributes (DA) and device status reports (DSR).

4.17.1 Device Attributes (DA)

There are two DA exchanges (dialogues) between the host computer and the VT220, primary DA and secondary DA.

4.17.1.1 Primary DA

In the primary DA exchange (the first exchange), the host asks for the terminal's service class code and the basic attributes. The terminal's response depends on the value of the "Terminal ID" field selected in set-up.

A typical primary DA exchange is as follows.

CSI ? 62; 1; 2; 6; 7; 8; 9 c 

ESC [ ? 1; 2 c

ESC [ ? 1; 0 c

ESC [ ? 6 c

4.17.1.2 Secondary DA

In the secondary DA exchange (the second exchange), the host asks for the terminal's identification code, firmware version level, and an account of the hardware options installed.

A typical secondary DA is as follows.

CSI > 1; Pv; Po c

Example

    CSI>1;10;0c = VT220 version 1.0, no options.

4.17.2 Device Status Report (DSR)

In a DSR exchange, the host computer asks for the general operating status of the terminal and/or printer. If the terminal is in print controller mode, the printer receives the DSR request but cannot answer.

DSR – VT220

A typical DSR exchange is as follows.

CSI Pv; Ph R 

DSR – Printer Port

NOTE: Determine the printer status before entering any print mode or starting any print function.

A typical DSR exchange is as follows.

CSI ? 15 n 

CSI ? 13 n 

CSI ? 10 n 

CSI ? 11 n 

DSR – User Defined Keys (VT220 mode only)

A typical DSR exchange is as follows.

CSI ? 25 n 

CSI ? 20 n 

CSI ? 21 n 

DSR – Keyboard Language

A typical DSR exchange is as follows.

CSI ? 26 n 

CSI ? 27; Pn n 

4.17.3 Identification (DECID)

The DECID sequence causes the terminal to send a primary DA response sequence. Digital does not recommend using DECID. You should use the primary DA request for this purpose.

The DECID sequence is as follows.

   1/11 5/10
   ESC   Z

4.18 Terminal Reset (DECSTR and RIS)

There are two terminal reset escape sequences. One causes a soft terminal reset (DECSTR), and the other causes a hard terminal reset (RIS).

4.18.1 Soft Terminal Reset (DECSTR)

You can invoke DECSTR (soft terminal reset) from the keyboard by selecting "Reset Terminal" in the Set-Up Directory screen. It can be invoked directly from the host computer via the DECSTR sequence, if the terminal is in a VT200 mode. (When the terminal is in VT100 or VT52 mode, the escape sequence is ignored.) It can also be invoked indirectly via the DECSCL sequence (ignored in VT52 mode).

The DECSTR sequence sets the terminal to the power-up default states listed in Table 4-10.

The DECSTR escape sequence is as follows.

   9/11 2/1 7/0
   CSI   !   p

4.18.2 Hard Terminal Reset (RIS)

You can invoke RIS (hard terminal reset or reset to initial state) from the keyboard by selecting "Recall" in the Set-Up Directory screen. It can also be invoked from the host computer with an escape sequence. RIS causes an NVR recall. All set-up parameters are replaced either by their NVR values, or power-up default values if NVR values do not exist.

In addition, RIS performs the following actions.

• Performs a communications line disconnect.

• Clears UDKs.

• Clears a down-line-loaded character set.

• Clears the screen.

• Returns the cursor to the upper-left corner of the screen.

• Sets the SGR state to normal.

• Sets the selective erase attribute write state to "not erasable".

• Sets all character sets to the default.

The RIS escape sequence is as follows.

   1/11 6/3
   ESC   c

NOTE: Use this sequence with caution. Parity and baud rate are restored from NVR.

4.19 Tests and Adjustments (DECTST and DECALN)

The terminal has tests and alignment patterns you can invoke from the keyboard or from the host computer with control and escape sequences. Test and alignment procedures are usually performed only by Digital Manufacturing and Field Service personnel.

This section provides the sequences used to invoke the tests and the alignment patterns. For detailed information, see the VT220 Pocket Service Guide.

4.19.1 Tests (DECTST)

The sequence format for invoking terminal tests is as follows.

   9/11 3/4  3/11     3/11    3/11     7/9
   CSI   4    ;   Ps   ; ..... ;   Ps   y

Each Ps is a parameter indicating a test to perform. After the first parameter (4), the parameters each select one test from the following list. You can invoke several tests at one time by separating the parameters with semicolons. The tests are not necessarily executed in the order you enter them.

NOTE: DECTST causes a communications line disconnect.

4.19.2 Adjustments (DECALN)

The terminal has a screen alignment pattern that service personnel use to adjust the screen. You can display the screen alignment pattern with the DECALN sequence.

   1/11 2/3 3/8
   ESC   #   8

This sequence fills the screen with uppercase E's.

4.20 VT52 Mode Escape Sequences

The VT52 mode allows the VT220 to operate with Digital software written for the VT52 terminal. In VT52 mode, all C0 control characters are allowed, although some are ignored. No C1 control characters or ANSI mode control functions are allowed. The user-defined keys are disabled. Table 4-11 defines the VT52 mode escape sequences. Table 3-3 in Chapter 3 defines the VT52 auxiliary keypad codes. The set-up VT100 (ASCII/UK) default character set applies to VT52 mode as well.