ALPHAÔ

ALPHAÔ

COMMUNICATIONS PROTOCOL

VERSION 1.0

08/04/95

Adaptive Micro Systems, Inc.

7840 North 86th Street

Milwaukee, Wisconsin 53224

Table of Contents

1.0 DOCUMENT IDENTIFIER.............................................................................................................................................................................. 4

1.1 File Details......................................................................................................................................................................................... 4

1.2 Revision History............................................................................................................................................................................... 4

1.3 Revision Comments.......................................................................................................................................................................... 4

2.0 INTRODUCTION.............................................................................................................................................................................................. 5

3.0 PRINTPAK PROTOCOL.................................................................................................................................................................................. 6

4.0 EZ KEY II PROTOCOL..................................................................................................................................................................................... 7

4.1.0 Transmission Frame Format............................................................................................................................................................ 7

Unit Type Codes............................................................................................................................................................................... 8

Command Code................................................................................................................................................................................. 9

4.1.1 Transmission Frame Variations.................................................................................................................................................... 10

A. With Checksum field...................................................................................................................................................... 10

B. Nesting with Checksums............................................................................................................................................... 10

C. Nesting without Checksums......................................................................................................................................... 10

D. Type Code/Address Field Variation............................................................................................................................ 11

E. Pager Compatible Transmissions................................................................................................................................. 11

4.2.0 Text Files.......................................................................................................................................................................................... 13

4.2.1 Write Text File................................................................................................................................................................................. 13

4.2.2 Read Text File.................................................................................................................................................................................. 13

4.2.3 Response to Read Text File........................................................................................................................................................... 14

4.2.4 Text File Data Format..................................................................................................................................................................... 14

POSITION CODES.......................................................................................................................................................................... 15

MODE CODES................................................................................................................................................................................ 15

SPECIAL MODES........................................................................................................................................................................... 16

SPECIAL GRAPHICS..................................................................................................................................................................... 17

ASCII MESSAGE DATA.............................................................................................................................................................. 17

ASCII CHARACTERS................................................................................................................................................................... 17

CONTROL CODES......................................................................................................................................................................... 18

EXTENDED CHARACTER SETS................................................................................................................................................ 18

4.2.5 Priority Text File.............................................................................................................................................................................. 21

5.0 SPECIAL FUNCTIONS.................................................................................................................................................................................. 22

5.1 WRITE SPECIAL FUNCTIONS.................................................................................................................................................... 22

5.2 Read Special Functions................................................................................................................................................................. 22

5.3 Response to Read Special Functions.......................................................................................................................................... 23

5.4 Special Functions Data Formats................................................................................................................................................... 23

" " (20H) - Time-of-day Setting........................................................................................................................................ 23

"!" (21H) - Speaker Status................................................................................................................................................. 24

""" (22H) - General Information........................................................................................................................................ 24

"#" (23H) - Memory Pool................................................................................................................................................... 25

"$" (24H) - Memory Configuration.................................................................................................................................. 25

"%" (25H) - Memory Dump................................................................................................................................................ 26

"&" (26H) - Day-of-Week setting...................................................................................................................................... 26

"'" (27H) - Time Display Format...................................................................................................................................... 27

' (28H) - Speaker Tone Generation.............................................................................................................................. 27

")" (29H) - Run Time Table............................................................................................................................................... 27

"*" (2AH) - Serial Error Status........................................................................................................................................... 28

"," (2CH) - Soft Reset......................................................................................................................................................... 28

"-" (2DH) - Network Query................................................................................................................................................ 29

"." (2EH) - Run Sequence................................................................................................................................................. 29

"/" (2FH) - Dimming Control............................................................................................................................................. 29

"2"(32H) - Run Day Table................................................................................................................................................ 30

"4" (34H) - Clear Serial Error Status................................................................................................................................. 30

";" (3BH) - Date setting..................................................................................................................................................... 30

"5" (35H) - Counter Functions.......................................................................................................................................... 31

"7"(37H) - Serial Address................................................................................................................................................. 32

"8"(38H) - ALPHAVISION DOTS PICTURE file Memory Configuration................................................................. 32

"9" (39H) - Append to ALPHAVISION DOTS PICTURE file Memory Configuration............................................. 33

"T" (54H) - Temperature Offset......................................................................................................................................... 33

6.0 STRING FILES................................................................................................................................................................................................. 34

6.1 WRITE STRING FILE..................................................................................................................................................................... 34

6.2 READ STRING FILE....................................................................................................................................................................... 34

6.3 RESPONSE TO READ STRING FILE........................................................................................................................................... 35

6.4 STRING FILE DATA FORMAT................................................................................................................................................... 35

7.0 DOTS PICTURE FILES.................................................................................................................................................................................. 35

7.1 WRITE DOTS PICTURE FILE...................................................................................................................................................... 36

7.2 READ DOTS PICTURE FILE........................................................................................................................................................ 36

7.3 RESPONSE TO READ DOTS PICTURE FILE............................................................................................................................ 37

7.4 DOTS PICTURE FILE DATA FORMAT.................................................................................................................................... 37

8.0 ALPHAVISION DOTS PICTURE FILES..................................................................................................................................................... 40

8.1 WRITE ALPHAVISION DOTS PICTURE FILE......................................................................................................................... 40

8.2 READ ALPHAVISION DOTS PICTURE FILE........................................................................................................................... 40

8.3 RESPONSE TO READ ALPHAVISION DOTS PICTURE FILE............................................................................................... 41

9.0 ALPHAVISION BULLETIN MESSAGING................................................................................................................................................. 42

APPENDIX A.................................................................................................................................................................................................................. 43

FILE LABEL FORMAT.................................................................................................................................................................................. 43

APPENDIX B................................................................................................................................................................................................................... 44

TEXT FILE START AND STOP TIMES..................................................................................................................................................... 44

APPENDIX C................................................................................................................................................................................................................... 45

COUNTER PROTOCOL................................................................................................................................................................................. 45

APPENDIX D.................................................................................................................................................................................................................. 46

STRING FILE APPLICATION NOTES........................................................................................................................................................ 46

APPENDIX E................................................................................................................................................................................................................... 49

SAMPLE C PROGRAM................................................................................................................................................................................. 49

APPENDIX F................................................................................................................................................................................................................... 51

SAMPLE BASIC PROGRAM....................................................................................................................................................................... 51

APPENDIX G................................................................................................................................................................................................................... 52

NETWORK PIN-OUTS.................................................................................................................................................................................. 52

APPENDIX H.................................................................................................................................................................................................................. 58

PROTOCOL EXAMPLES.............................................................................................................................................................................. 58

1.0 DOCUMENT IDENTIFIER

1.1 File Details

Document Name: 9708-8061-01

File Name: 97088061.WPD

File Format: WordPerfect 6.1

1.2 Revision History

Version Date Author Approval Signature

1.0 May 17, 1995 Mike Peters

1.3 Revision Comments

Version Comments

1.0 First version using WordPerfect.

PrintPak added.

Printable character transmissions added.

Added identifier page with sign-offs and revision list.

2.0 INTRODUCTION

This document is designed to allow a user to communicate with the ALPHAÔ line of electronic message centers. The message centers must have the ALPHA firmware (EPROM) installed. The standard ALPHA EPROM contains two protocols by which you may communicate with a ALPHA sign. The two types are the PrintPakÔ Protocol and the EZ KEY IIÔ Protocol.

The PrintPak Protocol was engineered to facilitate the transmitting of messages to the ALPHA line of products via MicroSoft® WindowsÔ Generic Printer Driver. This makes it possible to transmit from your ALPHA sign by simply selecting print from your favorite text editor.

The EZ KEY II network was also engineered to facilitate the transmitting of messages, but also has the capabilities to send counters, pictures and more.

3.0 PRINTPAK PROTOCOL

The PrintPak Protocol allows a single message to be transmitted to a sign using a text only protocol. Special bracketed commands allow the insertion of modes, character sets, etc., into the message. PrintPak Protocol transmissions must be made at 9600 baud. PrintPak Protocol transmissions must always begin with the bracketed command {{Begin Message}}. This command may be followed by any combination of additional text and commands. Following is a list of all the supported commands. All commands are surrounded by double braces, and all commands are case sensitive. The end of the message is signaled by a timeout on the serial transmission.

PrintPak Protocol transmissions must always begin with the following message:

Mode commands are «{{» followed by a position, one space, the mode name, and then «}}».

The following example is for Fill Automode:

Possible positions are: Fill Top

Bot Mid

Possible modes are:

Automode Flash Hold Interlock

Roll Down Roll Up Roll In Roll Out

Roll Left Roll Right Rotate Scroll

Slide Snow Sparkle Spray

Starburst Switch Turn Page Twinkle

Wipe Down Wipe Up Wipe In Wipe Out

Wipe Left Wipe Right Cherry Bomb Fireworks

No Smoking Running Animal Slot Machine Thank You

Turbo Car Welcome Condensed Rotate Don’t Drink & Drive

Control commands are «{{» followed by a control command, and then «}}». The following example is for Green characters:

Possible Control commands are:

15/16 Row Fancy 15/16 Row Normal Ten Row Seven Row Normal

Seven Row Fancy Five Row On Wide Off Wide

On Flash Off Flash On Double High Off Double High

On True Descenders Off True Descenders On Fixed Width Off Fixed Width

Red Green Amber Light Red

Light Green Brown Orange Yellow

Rainbow1 Rainbow2 Mix Autocolor

New Line New Page Time Fahrenheit Temp.

Celsius Temperature Speed1 Speed2 Speed3

Speed4 Speed5 No Hold Time

NOTE: For specific mode and control code definitions, see EZ KEY II Protocol Section 4.2.0 Text Files on Page 13.

4.0 EZ KEY II PROTOCOL

The ALPHA line of products support several types of files and a number of special functions which are used for specific applications. They are as follows:

TEXT FILE

The ASCII message data and display mode information, along with various other control codes, are stored in TEXT files. DOTS PICTURE files and STRING files may be inserted into a TEXT file.

DOTS PICTURE FILE

The DOTS PICTURE files contain data patterns that correspond to a display picture. These patterns can be used to create virtually any logo pattern on the display of the message center. These DOTS PICTURE files are accessed via TEXT files.

ALPHAVISIONÔ DOTS PICTURE FILE

The ALPHAVISION DOTS PICTURE file is supported only on the ALPHAVISION products. It is similar to the standard DOTS PICTURE file as described above. The ALPHAVISION DOTS PICTURE file can be much larger than the standard DOTS PICTURE file. The ALPHAVISION DOTS PICTURE file supports data compression during serial transmission.

STRING FILE

The STRING files are used to store ASCII characters only. STRING files are used in applications where a string of frequently changing data must be transmitted to, and displayed by, the message center. Applications include the storage of a number which changes often, such as a temperature, a quantity, or a timer.

SPECIAL FUNCTIONS

The ALPHA network supports a range of special functions which give you access to internal registers, diagnostics, and other miscellaneous items.

4.1.0 Transmission Frame Format (example page 58)

This section describes the basic outline of transmissions on an EZ KEY II network.

Transmission speed: 1200, 2400,4800 or 9600 baud

Data bits: 7

Start bits: 1

Stop bits: 2

Parity: Even

Time‑out Period: 1 Second (any delays between bytes cannot exceed this)

All transmissions on the system must appear in the following format. (See Transmission Frame variations, Section 4.1.1 on page 9.):

<NUL>

<SOH>

Type Code

Addr.

Field

<STX>

Command Code

Data Field

<EOT>

<NUL> (00H): Frame synchronizing character, a minimum of five <NUL>s must be transmitted before the <SOH>. Five <SOH>s may be substituted for the five <NUL>s. The message center will establish the baud rate from the frame synchronizing character.

4.1.0 Transmission Frame Format (cont.)

<NUL>

<SOH>

Type Code

Addr.

Field

<STX>

Command Code

Data Field

<EOT>

<SOH> (01H): "Start of Header" character

<NUL>

<SOH>

Type Code

Addr.

Field

<STX>

Command Code

Data Field

<EOT>

Type Code: One ASCII character. Selects the type(s) or model(s) of sign that can receive this transmission frame.

<NUL>

<SOH>

Type Code

Addr.

Field

<STX>

Command Code

Data Field

<EOT>

Unit Type Codes

"Z" (5AH) - ALL Message Centers

"?" (3FH) ‑