HCS II


                                  X P R E S S


                            System Reference Manual





                                  Release 2.0
                                     3/1/93

                                On-line Version




















     Circuit Cellar, Inc.
     4 Park St.
     Vernon, CT 06066
     (203) 875-2751

















     Circuit Cellar will not be held responsible for any damages caused by
     use or misuse of XPRESS and the HCS II. Circuit Cellar provides XPRESS
     with the understanding that the user will determine its fitness for
     any particular application and Circuit Cellar specifically disclaims
     any implied warranties.

     While we have attempted to provide accurate and up-to-date information
     in this manual, Circuit Cellar makes no representations or warranties
     respecting its contents. We reserve the right to make periodic changes
     to the text and to issue new editions of this manual without notifica-
     tion.

     Occasionally in this manual we refer to the products of manufacturers
     other than ourselves. Such references do not constitute an endorsement
     of these products, but are included for the purpose of illustration or
     clarification. We do not intend such technical information to super-
     sede information provided by the individual manufacturers. All
     trademarks referenced are the property of the respective trademark
     owners.

     COMM-Link, PL-Link, IR-Link, MCIR-Link, LCD-Link, DIO-Link, DIO+-Link,
     ADIO-Link, Supervisory Controller, XPRESS, and HCS II are trademarks
     of Circuit Cellar Inc.

     XPRESS and this manual are copyright (c) 1992, 1993, Circuit Cellar,
     Inc.

     All Rights Reserved





     1. System Overview  . . . . . . . . . . . . . . . . . . . . . .  1
        1.1 Definition of Terms  . . . . . . . . . . . . . . . . . .  2

     2. Software for the PC  . . . . . . . . . . . . . . . . . . . .  3
        2.1 COMPILE  . . . . . . . . . . . . . . . . . . . . . . . .  3
        2.2 HOST . . . . . . . . . . . . . . . . . . . . . . . . . .  4
        2.3 HOST Windows . . . . . . . . . . . . . . . . . . . . . .  5

     3. XPRESS Program Structure . . . . . . . . . . . . . . . . . .  7
        3.1 Configuration Section Keywords . . . . . . . . . . . . .  8
        3.2 Control Section Keywords . . . . . . . . . . . . . . . .  8
        3.3 Configuration Section Details  . . . . . . . . . . . . . 10
        3.4 Control Section Details  . . . . . . . . . . . . . . . . 12
            3.4.1 IF/IFA Statements  . . . . . . . . . . . . . . . . 12
            3.4.2 Conditions . . . . . . . . . . . . . . . . . . . . 13
            3.4.3 Actions and Assignments  . . . . . . . . . . . . . 22

     4. Data Logging . . . . . . . . . . . . . . . . . . . . . . . . 33
        4.1 Hardware Setup . . . . . . . . . . . . . . . . . . . . . 33
        4.2 Software Setup . . . . . . . . . . . . . . . . . . . . . 34
        4.3 What to Log  . . . . . . . . . . . . . . . . . . . . . . 34
        4.4 Logged Data Format . . . . . . . . . . . . . . . . . . . 35
        4.5 Sample Processing Software . . . . . . . . . . . . . . . 36

     Appendix A: Example Programs  . . . . . . . . . . . . . . . . . 39

     Appendix B: Port Assignments  . . . . . . . . . . . . . . . . . 43

     Appendix C: HOST/SC Serial Protocol . . . . . . . . . . . . . . 47








     1. System Overview
     ==================
     Welcome to the world of home automation. An automated home is a for-
     eign concept to many people used to living in a world of manual con-
     trol. The idea of lights turning on and off by themselves, drapes
     automatically opening or closing, or chimes ringing in response to a
     car in the driveway may take some getting used to. However, once
     you've lived with the conveniences for even a short time, you'll
     quickly come to rely on them.

     The Circuit Cellar Home Control System II is a new-generation control
     system with roots in industrial control. With its XPRESS (eXpandable,
     Programmable, Real-time Event Supervisory System) programming lan-
     guage, the HCS II gives users unprecedented control over their en-
     vironment.

     The basic HCS II setup consists simply of a Supervisory Controller
     (SC). The base SC gives the user 16 digital inputs, 8 digital outputs,
     and 8 channels of 8-bit analog-to-digital conversion. An optional
     plug-in expansion board increases the I/O on the SC to 40 inputs and
     32 outputs.

     By adding one or more COMM-Link modules, the system's reach increases
     by leaps and bounds. Up to 31 COMM-Link modules may be connected to
     the system using inexpensive twisted-pair wiring. A single twisted
     pair (up to 4000 feet long) run throughout the house is all that's
     needed to tie the system together.

     Among the COMM-Link modules, the PL-Link is used to communicate with
     X-10 devices connected to the power line. The IR-Link allows you to
     issue commands to the HCS II using a standard trainable hand-held IR
     remote control. The LCD-Link gives the user a gateway to the HCS II
     with its 4-line by 20-character display and four push-button inputs.
     Each DIO-Link has 8 bits of digital I/O: four inputs and four outputs.
     Finally, the ADIO sports 16 digital inputs, 8 digital outputs, 8 chan-
     nels of 8-bit A/D conversion, and 4 channels of 8-bit D/A conversion.
     Up to eight of each kind of module may be connected to the network (up
     to the system-wide limit of 31 modules total). Only one PL-Link may be
     used in a system, however.

     An IBM PC or compatible computer is used for initial setup and pro-
     gramming of the HCS II. When all is working as expected, the PC may be
     removed from the system until the next time a change is required. The
     HCS II doesn't tie up your expensive (and power hungry) PC.











     HCS II System Reference Manual                                  1

     1.1 Definition of Terms
     -----------------------
     You should understand the meaning of a number of terms used throughout
     this manual before you proceed.

     Supervisory Controller (SC)--the main board that controls the whole
          HCS II.
     COMM-Link--a generic term used to describe any of the HCS II network
          modules, which include the PL-Link, IR-Link, MCIR-Link, LCD-Link,
          DIO-Link, DIO+-Link, and ADIO-Link.
     Local Input (or Direct Input)--any digital input connected directly to
          the SC or Buffer Terminator Board (which conditions those sig-
          nals).
     Local Output (or Direct Output)--any digital output connected directly
          to the SC or Buffer Terminator Board.
     Netbit--any digital input or output connected to any COMM-Link network
          module.
     Edge--an on-to-off or an off-to-on transition on any digital input.
     RS-485--an interface standard used as the basis for the HCS II
          network. It defines the use of a single twisted-pair cable to
          carry all system communications.
     XPRESS--eXpandable, Programmable, Real-time Event Supervisory System;
          the programming language supported by the HCS II.



































     2                                   HCS II System Reference Manual



     2. Software on the PC
     =====================
     A PC-compatible computer is used to program and monitor the HCS II.
     Once the system is working, the PC may be disconnected or shut off un-
     til changes are needed. While the PC software will work on any PC com-
     patible right down to an original 4.77-MHz IBM PC for small systems,
     we recommend at least an 8-MHz PC or an AT-class machine be used. The
     software will work with a single floppy disk drive and either color or
     monochrome display.

     There are two programs used on the PC: COMPILE, used to compile XPRESS
     programs from their original source form to a binary representation
     used by the SC; and HOST, used to set the time, send XPRESS programs
     to the SC, display system status, clear the system log memory, and
     transfer logged data from the SC to a disk file on the PC.


     2.1 COMPILE
     -----------
     XPRESS programs may be written using any text editor capable of
     producing flat ASCII (or text) files. If you're using a fancy word
     processing program (such as Word Perfect, Microsoft Word, WordStar,
     Volkswriter, or any of the hundreds of others), be sure you save your
     code as a plain text file that contains no control characters or
     formatting commands.

     Before your XPRESS program can be sent to the SC, the program must be
     compiled. The compiling process checks your program for correct syntax
     and value ranges, and creates a binary file containing the raw code to
     be sent to the SC.

     The form of the COMPILE command line is as follows (items in braces
     are optional):

          COMPILE {filename}

     where:	filename is the name of the source file

     If the filename isn't given, COMPILE assumes the source file is called
     EVENTS.HCS. If the extension isn't given, COMPILE assumes an extension
     of .HCS. The following are valid command lines:

     COMPILE		compiles the code found in EVENTS.HCS
     COMPILE MYPROG	compiles the code found in MYPROG.HCS
     COMPILE PROG2.TXT	compiles the code found in PROG2.TXT

     COMPILE always creates a binary file called EVENTS.BIN. The HOST pro-
     gram expects your compiled XPRESS program to be in EVENTS.BIN, so be
     sure not to change the name of the file.







     HCS II System Reference Manual                                  3
     When errors are found during compilation, COMPILE will tell you what
     kind of error was found and what line it was on, and will display the
     offending piece of code.

     COMPILE will alert you to several kinds of errors. Syntax errors are
     usually typographical errors: a misspelled command or a missing state-
     ment. A single syntax error may result in more than one error message
     because COMPILE continues processing your program even after the error
     occurs. Often fixing a single error will eliminate multiple error mes-
     sages.

     Value errors are often more subtle. They occur when a value you've
     specified in a comparison or an assignment is too large or too small.
     For example, if you accidentally specify a time of 28:30 instead of
     18:30, COMPILE will flag a value error because the hours may only be
     between 0 and 23.

     COMPILE also checks for unbalanced parentheses and IF/END pairs.


     2.2 HOST
     --------
     The HOST program is used to send compiled XPRESS programs to the SC
     and to display overall system status. HOST displays everything in a
     text-based windowing environment and works equally well on graphics
     and text-only systems, and on color and monochrome systems. You should
     connect the SC to either COM1 or COM2 on your PC before running HOST.

     The form of the HOST command line is as follows (items in braces are
     optional):

           HOST {/COM1|/COM2} {/M} {//}

     where:	/COM1 tells HOST to use COM1
     		/COM2 tells HOST to use COM2
     		/M forces HOST into monochrome mode (display just
     		    black and white; usually used on systems with color
     		    adapter cards and monochrome monitors)
     		// displays a short help screen and exits

     Examples of valid HOST command lines include:

       HOST		start HOST in its default mode
       HOST /COM2	start HOST using COM2
       HOST /M		start HOST in monochrome mode
       HOST /M /COM2	start HOST in monochrome mode using COM2
       HOST //		tell HOST to display a short help screen and exit

     The default mode for HOST is to use COM1 and full-color windows.

     When HOST is started, it initializes all the windows, puts a command
     bar at the top of the screen, and displays a window containing in-
     formation about itself. The information window disappears after a few
     seconds.





     4                                   HCS II System Reference Manual

     There are six valid commands that may be issued to HOST:

     	! : redisplay the information window for a few seconds
     	T : set the SC's clock to the current time and date
     	L : load a new XPRESS program into the SC
     	C : clear the log memory
     	D : dump the logged data to a disk file on the PC
     	Q : quit HOST

     The T command reads the time and date from the PC's internal clock, so
     be sure you set the PC's clock and calendar to the correct time and
     date before running HOST.

     The L command expects to find your compiled XPRESS program in a file
     called EVENTS.BIN. If that file can't be found, an error message is
     displayed.

     The C command instructs the SC to clear its log memory. This command
     gives you a way to wipe out any old data and start logging new data at
     a known time.

     The D command dumps logged data from the SC's memory to a disk file on
     the PC. The data is always stored in a file called LOGDATA.BIN, so if
     you want to save any old data previously dumped to disk, be sure to
     rename the old data file before performing a new dump. See Chapter 6
     for more information on data logging.

     If there is a problem with the connection between the PC and the SC,
     HOST will time out during the T, L, C, and D commands. If a timeout
     occurs, a "sad" beep will sound and a message will pop up informing
     you of the timeout and asking you to try again. If the timeouts per-
     sist, you should check the physical connection between the PC and the
     SC.

     During both the T and L commands, HOST and the SC verify that the
     transfer of information proceeded error free. If an error occurs dur-
     ing the transfer, a "sad" beep will sound and a message will pop up
     that asks you to try again. A second try will usually succeed.

     Successful transfers of information during the T, L, C, and D commands
     result in a "happy" beep and a message that informs you of the suc-
     cess.


     2.3 HOST Windows
     ----------------
     HOST displays HCS II system status information in individual windows
     on the PC's screen. Each type of information has its own window. For
     example, in the upper right corner of the screen is the current time
     and date.

     The sizes of most windows depend on the information being displayed.
     The X-10 module status window on the left side of the screen expands





     HCS II System Reference Manual                                  5
     one line downward for each housecode you ask it to display. Using the
     DISPLAY configuration keyword in your XPRESS program, you may specify
     any or all housecodes to be displayed by HOST. Any modules that are on
     or dimmed (regardless of dim level) are designated by a "1" on the
     screen. Modules that are off or not used show up as "0" on the dis-
     play.

     The network module status window in the center of the screen displays
     the status of only those network modules defined by CONFIG statements
     in your XPRESS program. The following summarizes the three possible
     status indicators:

     	* : module active and responding normally
     	- : module didn't responded when polled by the SC
     	E : response from module contained an error and was discarded

     An occasional "-" indicates there might be some noise on the network
     and shouldn't be a concern. Any module showing a consistent "-" should
     be checked out. Similarly, an occasional "E" indicates some noise on
     the network and can usually be safely ignored. Consistent errors indi-
     cate a problem with the network.

     Finally, inputs and outputs connected directly to the SC (local inputs
     and outputs) are displayed in two separate windows on the right side
     of the screen. The number of inputs and outputs displayed depends on
     the hardware you define with the CONFIG statement in your XPRESS pro-
     gram.

     In all cases, the input and output bits are displayed in groups of 24
     horizontally (though a row may not contain a full 24 bits). A "1" in-
     dicates the bit is on and a "0" indicates the bit is off. The starting
     bit number for each row is shown at the left of each row. The numbers
     across the top of the rows are offsets from that starting bit number.
     For example, the first row might have "000" at the left, indicating
     the leftmost bit in the row is 0, followed by 1, then 2, and so forth.
     If the next row has "016" at its left, then the bit numbers in that
     row are 16, 17, 18, and so forth.






















     6                                   HCS II System Reference Manual



     3. XPRESS Program Structure
     ===========================
     XPRESS programs consist of two sections: configuration and control.

     The configuration section defines what processor board is being used
     as the SC, how many of each kind of COMM-Link is present on the
     network, and what X-10 housecodes should be displayed by the HOST pro-
     gram. It also contains all the label definitions.

     The control section makes up the bulk of the XPRESS program and con-
     sists of a series of IF/THEN/ELSE statements. The IF portion is made
     up of any number of system conditions combined using Boolean opera-
     tions. When the IF portion is true, the list of actions in the THEN
     portion is carried out. When the condition is false, any actions in
     the optional ELSE portion are executed instead. The BEGIN keyword is
     used to denote the end of the configuration section and the start of
     the control section.

     Note: Whenever the condition in the IF portion is true, the action
     list is executed once. If the condition remains true on later passes
     through the program, the action list is not executed again. The ac-
     tions are only executed again after the condition has been false on at
     least one pass through the program, and is then true again. Similarly,
     the ELSE portion of an IF statement is executed just once when the
     condition is false, and not again until the condition is evaluated
     true, then false again. See Section 3.4.1 for more details.

     Throughout the program, case is ignored (i.e., upper- and lower-case
     letters are treated identically).

     The following is a basic outline of the structure of an XPRESS pro-
     gram:

     					________
     	CONFIG SC = ...				|
     	CONFIG PL-Link = ...			|
     	CONFIG DIO-Link = ...			|
     						| Configuration
     	DISPLAY Modules = ...			| Section
     						|
     	DEFINE ...				|
     	DEFINE ...			________|














     HCS II System Reference Manual                                  7
     	BEGIN
     					________
     	IF ... THEN				|
     	   .					|
     	   .					| Control
     	ELSE					| Section
     	   .					|
     	   .					|
     	END				________|


     3.1 Configuration Section Keywords
     ----------------------------------
     In the configuration section, the keywords shown below are valid. They
     may appear in any order within the section, but may not be used at all
     after the BEGIN.

     Config <module> = n	<module> = "PL-Link", "IR-Link",
     				  "LCD-Link", "DIO-Link", "ADIO-Link",
     				  "DIO+-Link"
     				n = number of modules connected (0-7)
     Config SC = <hardware>	<hardware> = "SC1", "SC2", "SC3", "SC4",
     				  "SC5"
     Define <label> = <string>	<label> = any alphanumeric word up to 32
     				  characters long with no spaces
     				<string> = any valid XPRESS expression
     Display Modules = <list>	<list> = list of housecodes separated by
     				  commas
     ! <comment>		<comment> = comment ignored by the compiler


     3.2 Control Section Keywords
     ----------------------------
     The control section must start with a BEGIN statement. A basic state-
     ment consists of an IF portion, a THEN portion, and an optional ELSE
     portion. Expressions in the IF portion are separated by AND or OR and
     may be preceded by NOT. Evaluation proceeds in strict left-to-right
     order. Parentheses may be used to prioritize evaluation order.

     The basic form of a statement is as follows:

        IF|IFA {NOT}<expr1> <op> {NOT}<expr2> ... THEN
          <action1>; <action2>
            .
            .
        ELSE
          <action1>; <action2>
            .
            .
        END









     8                                   HCS II System Reference Manual

     Expressions in the IF portion are as follows:

     ADC(n) <op> v		n = valid ADC channel (0-127)
     Day <op> v			Day of month (1-31)
     DOW <op> v			Day of week (1-7)
     Input(n)=ON/OFF/EDGE	n = input number (0-135)
     IRcode(c) <op> v		c = received IR code (0-255)
     Module(m)=ON/OFF		m = module (A1-P16)
     Month <op> v		Month (1-12)
     Netbit(n)=ON/OFF/EDGE	n = valid netbit number (0-319)
     Output(n)=ON/OFF		n = output number (0-87)
     Reset			True after reset
     Time <op> hh:mm:dd		hh= hour (0-23); mm = min (0-59); dd = day
     				  (SU,MO,TU,WE,TH,FR,SA,DY [daily],
     				  WK [weekday], EN [weekend])
     Timer(n) <op> v		n = timer number (0-127)
     Variable(n) <op> v		n = variable number (0-127)
     Year <op> v		Year (0-99)

     where:
     	<op> = "=", "<>", ">", "<", ">=", "<="
     	v = constant (0-32767), ON, TRUE, OFF, FALSE, Variable(n),
     	       ADC(n), Timer(n), IRcode(c), Random(n), Day, Month,
     	       Year, DOW

     There may be any number of actions in the THEN/ELSE portions, each on
     a separate line or separated by a semicolon on a single line. Each
     program statement must have a single END after the ELSE (or the THEN
     if ELSE isn't used) portion. The following may be used in the
     THEN/ELSE portions:

     AllLightsOn(h)		h = housecode (A-P)
     AllUnitsOff(h)		h = housecode (A-P)
     ClearLog			Clear logged data from memory
     ClearTimers		Stop and clear all system timers
     ClearVariables		Clear all system variables to zero
     DAC(n)=v			n = channel number (0-31)
     Dec(Variable(n))		n = variable number (0-127)
     Inc(Variable(n))		n = variable number (0-127)
     LCD(n)="<string>"		n = LCD-Link number (0-7)
     				<string> = ASCII text string; must be
     				  surrounded by quotes
     LPT(n)="<string>"		n = DIO-Link number (0-7)
     				<string> = ASCII text string; must be
     				  surrounded by quotes
     Log(i)=v			i = reference ID of logged data
     MCIR(n)=v			n = MCIR-Link number (0-7)
     Module(m)=ON/OFF		m = module (A1-P16)
     Module(m)=DIM(n)		m = module (A1-P16)
     				n = steps to dim (1-31)
     Module(m)=BRIGHT(n)	m = module (A1-P16)
     				n = steps to brighten (1-31)
     Netbit(n)=ON/OFF		n = valid netbit number (0-239)





     HCS II System Reference Manual                                  9
     Output(n)=ON/OFF		n = output number (0-87)
     Random(n)			Generate random number (0-n)
     Refresh=v			Refresh interval (0-99) minutes (0=off)
     ResetIO			Reinitialize all direct I/O ports
     Timer(n)=ON/OFF		n = timer number (0-127)
     Variable(n)=v		n = variable number (0-127)

     where:
     	v = constant (0-32767), ON, TRUE, OFF, FALSE, Variable(n),
     	       ADC(n), Timer(n), IRcode(c), Random(n), Day, Month,
     	       Year, DOW, Equation

     Some expressions and actions require that specific COMM-Link modules
     be installed in the system to work properly. These requirements are
     noted in the detailed descriptions of each statement.


     3.3 Configuration Section Details
     ---------------------------------
     The configuration section defines various aspects of the system
     hardware plus allows you to define descriptive labels that make your
     XPRESS program more readable. For each keyword, a brief description is
     given, followed by the proper syntax and an example.


     CONFIG
     ------
     Define what hardware is being used with the HCS II

     Every HCS II installation contains a Supervisory Controller (SC). The
     SC may also have a single RTC-BUFIO board on top to provide more local
     I/O bits. A number of COMM-Link modules will also be connected to the
     SC in most installations. The SC must be told what hardware is in the
     system so it knows what I/O bits to display and what network modules
     to poll. The default condition is the SC board with no network
     modules. All I/O is through the SC's on-board I/O bits.

     If the SC is expecting to find a network module that isn't connected,
     the system will continue to run, but performance will degrade. To
     define the SC hardware and how many of each network module is con-
     nected, CONFIG is used. All CONFIG statements must precede the BEGIN
     statement. (Note that only one PL-Link may be used on the network.)

     All COMM-Link modules must start with network address 0 and be as-
     signed sequential addresses.

     Syntax:	Config <module> = n
     		Config SC = <hardware>











     10                                   HCS II System Reference Manual
     where:	<module> =	"PL-Link"
     				"IR-Link"      (use with MCIR-Link also)
     				"LCD-Link"
     				"DIO-Link"
     				"ADIO-Link"
     				"DIO+-Link"
     		n = number of network modules connected (0-7)

     		<hardware> = 	"SC1" (SC only)
     				"SC2" (SC, RTC-BUFIO or RTC-BUF50)
     				"SC3" (IND180, IND13)
     				"SC4" (IND180, IND13, IND54)
     				"SC5" (IND180, IND30, IND54)

     Example:	Config PL-Link = 1   ! 1 PL-Link on net
     		Config LCD-Link = 3  ! 3 LCD-Links on net
     		Config SC = SC2      ! SC with RTC-BUFIO


     DEFINE
     ------
     Define a descriptive program label

     Any valid XPRESS expression or action may be assigned to a descriptive
     label to enhance program readability. DEFINE is used to equate the
     label with the expression or action. All DEFINE statements must
     precede the BEGIN statement. Up to 512 labels may be defined with each
     label name up to 32 characters long. Label names may not contain em-
     bedded spaces.

     Syntax:	Define <label> = <statement>

     where:	<label> = any alphanumeric string up to 32 characters long.
     			   No spaces are allowed.
     		<statement> = any valid XPRESS expression or action

     Example:	Define KitchenLight  = Module(L4)
     		Define KitchenMotion = Input(2)
     		BEGIN
     		IF KitchenMotion = ON THEN
     		  KitchenLight = ON
     		END


     DISPLAY
     -------
     Define which X-10 housecodes to display by HOST

     You may specify which X-10 housecodes you want displayed by the HOST
     program. If this line is omitted, no housecodes are displayed by HOST.

     Syntax:	Display Modules = <housecodes>







     HCS II System Reference Manual                                  11
     where:	<housecodes> = list of housecode letters separated by
     				 commas

     Example:	DISPLAY Modules = A,B,C,F



     3.4 Control Section Details
     ---------------------------
     The control section is made up of a series of IF/THEN/ESLE statements.
     Any number of conditions may be tested in the IF portion, and any num-
     ber of actions or assignments may be carried out in the THEN and ELSE
     portions.


     3.4.1 IF/IFA Statements
     -----------------------
     Two kinds of IF statements are supported in XPRESS: IF and IFA
     (formerly GIF). When an IF statement is evaluated as true, its THEN
     portion is executed. On subsequent passes through the XPRESS program,
     if the condition in that IF statement continues to evaluate true, the
     THEN portion is skipped (it is executed exactly once for each occur-
     rance of a true condition). The THEN portion is only executed again
     when the condition evaluates false, then true again.

     On the other hand, when the condition in an IFA (IF Always) statement
     is true, its THEN portion is executed on every pass through the XPRESS
     program.

     When a statement contains an ELSE portion, the ELSE is treated accord-
     ing to its companion IF/IFA. That is, when an IF condition evaluates
     false, the ELSE portion is executed exactly once. On subsequent passes
     through the program, if the condition remains false, the ELSE portion
     is skipped. The condition in the IF statement must go true, then false
     again for the ELSE portion to be executed again.

     Likewise, an ELSE associated with an IFA is executed on every pass
     through the program in which the IFA condition evaluates false.

     For example, in the following code fragment, the "on" message is sent
     to the LCD-Link only once when the input goes true, and the "off" mes-
     sage is sent just once when the input goes false. If the THEN and ELSE
     portions weren't skipped on subsequent passes through the program, the
     LCD-Link would be overrun with messages.

     	IF Input(5)=ON THEN
     	  LCD(0) = "Input is on"
     	ELSE
     	  LCD(0) = "Input is off"
     	END

     In the next example, the LED connected to the output bit is toggled on
     every pass through the XPRESS program. Such a setup is useful to give
     a visual indication of overall system performance and can be helpful





     12                                   HCS II System Reference Manual
     in assessing how much a hardware or software change to the system af-
     fects its throughput.

     	IFA Output(2)=OFF THEN
     	  Output(2) = ON
     	ELSE
     	  Output(2) = OFF
     	END


     IF/IFA statements may be nested in any way to any number of levels.
     Care must be taken, however, when nesting IF statements within IFA
     statements. Take the following example:

     	IFA Input(10)=ON THEN
     	  Output(2) = ON
     	  IF Module(D2)=ON THEN
     	    LCD(0) = "Module is on"
     	  END
     	END

     When input 10 is on, the IFA's THEN portion is executed every time
     through the program. When module D2 turns on, the command to send a
     message to the LCD-Link is executed the first time, then skipped on
     subsequent passes. Now suppose input 10 turns off. The entire IFA THEN
     portion is skipped because the IFA condition is false. Even if module
     D2 turns off and then back on, the inside IF is never evaluated so it
     never sees the module's on-off-on transition. If module D2 is on when
     input 10 goes on again, the THEN portion associated with the inside IF
     is skipped because it hasn't seen the on-off-on transition on the
     module.

     It is very important to understand how IF and IFA work and what their
     differences are if you are to write XPRESS programs that work as you
     expect.


     3.4.2 Conditions
     ----------------
     The IF section is made up of a conditional statement. Conditions in
     the statement are separated by ANDs and ORs, and each condition may be
     preceded by a NOT. The default order of evaluation is left to right.
     Parentheses may be used to change the evaluation order.

     Note that equations using math may not be used in the IF portion of
     XPRESS statements. Math is only available when doing assignments.


     ADC
     ---
     Test analog channel (local and network)

     Any analog channel in the system (including local and network) may be
     tested. See Appendix B for tables that assign channel numbers to





     HCS II System Reference Manual                                  13
     specific hardware. Comparisons may be made with variables, constants,
     other ADC channels, and many other system values.

     Syntax:	ADC(n) <op> v

     where:	n = valid ADC channel (0-127)
     		<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     COMM-Links: ADIO (optional), DIO+ (optional)

     Example:	IF ADC(16)>=Variable(10) THEN
     		  Module(L6) = ON
     		END


     DAY
     ---
     Test current day of month

     Trigger actions based on the day of the month. Day will be in the
     range of 1-31.

     Syntax:	Day <op> v

     where:	<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     Examples:	IF Day=1 THEN
     		  LCD(0) = "Flip the calendar\n"
     		END

     The Day operand may be used in conjunction with a variable and an
     equation to determine whether the current day of the month is odd or
     even. Taking advantage of the integer math, the Odd calculation below
     results in a 0 (false) whenever Day is even and a 1 (true) whenever
     Day is odd.

     	DEFINE Odd = Variable(2)
     	DEFINE Sprinkler = Module(F2)















     14                                   HCS II System Reference Manual
     	BEGIN
     	IF Time=8:00:DY THEN
     	  Odd = Day - ((Day / 2) * 2)
     	  IFA Odd=TRUE THEN
     	    Sprinkler = ON
     	    LCD(0) = "Sprinkler day\n"
     	  ELSE
     	    LCD(0) = "No sprinkling today\n"
     	  END
     	END


     DOW
     ---
     Test current day of week

     Trigger actions based on the day of the week. Day-of-week tests may
     also be done with the Time keyword. DOW is 1 on Sunday and 7 on Satur-
     day.

     Syntax:	DOW <op> v

     where:	<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     Example:	IF DOW=3 THEN
     		  LCD(0) = "Today is Tuesday\n"
     		END


     INPUT
     -----
     Test current state of a local input

     All local input numbers are predefined and depend on the hardware
     being used. See Appendix B for a table of supported hardware and cor-
     responding input numbers.

     Syntax:	Input(n) = ON/TRUE/OFF/FALSE/EDGE

     where:	n = input number (0-135)

     Example:	IF Input(5)=EDGE THEN
     		  Output(8)=ON
     		END

     Inputs are normally either on or off. The transition from on to off or
     from off to on is known as an "edge." Detecting edges alone (as op-
     posed to either on or off) is useful when you want to know that the
     state of an input has changed, but don't care whether it changed to on
     or off.






     HCS II System Reference Manual                                  15
     Edge detection is done in software and requires a pulse width of at
     least 250 ms to detect local input edges (netbit edges require more
     time). Rising edges (off to on) and falling edges (on to off) are
     treated identically. You may determine whether a rising or falling
     edge has occurred by testing the input's level at the same time (e.g.,
     IF Input(3) = EDGE AND Input(3) = ON THEN it was a rising edge).

     Edges may be tested multiple times during a single pass through the
     XPRESS program. At the end of each pass through the list, the edge
     storage table is cleared.


     IRCODE
     ------
     Test whether an IR code has been received

     Up to seven IR-Link modules may be connected to the network, any of
     which can receive codes from hand-held IR remotes. IRCODE is used to
     test whether a particular code has been received and which IR-Link
     module received it.

     Syntax:	IRcode(c) <op> v

     where:	c = IR code (0-239)
     		<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW
     		v refers to an IR-Link module number, so really only
     		      makes sense when in the range of 0-7.
     COMM-Links: IR

     Examples:	IF IRcode(6)>=0 THEN
     		  Module(G6)=OFF
     		END

     If any IR-Link module has received IR code number 6, the X-10 module
     G6 is turned off.

     		IF IRcode(12)=3 THEN
     		  Output(5) = ON
     		END

     If IR-Link number 3 has received IR code number 12, output 5 will be
     turned on.

     	DEFINE MovieMode  = IRcode(5)
     	DEFINE FamilyRoom = 1
     	BEGIN
     	IF MovieMode=FamilyRoom THEN
     	  Module(D4) = Dim(8); Module(D5) = Dim(10)
     	  Output(12) = ON
     	END






     16                                   HCS II System Reference Manual
     Suppose IR-Link number 1 is located in the family room and IR code
     number 5 is defined as putting the system into "movie mode" (i.e.,
     "I'm sitting down to watch a movie, so set up the room appropriate-
     ly."). When you press the button on your hand-held IR remote to send
     IR code number 5, HCS II dims two lights and sets an output that trig-
     gers the automated drapes to close.


     MODULE
     ------
     Test the current state of an X-10 module

     X-10 modules may only be tested for on or off. Receiving all dim and
     bright commands with the PL-Link module is impossible, so only a
     module's on or off state is recorded. Determining the proper dim or
     bright level for a given situation is up to the user.

     Syntax:	Module(hnn) = ON/TRUE/OFF/FALSE

     where:	h = house code (A-P)
     		nn = module number (1-16)

     COMM-Links: PL

     Example:	IF Module(B8)=ON AND Input(7)=EDGE THEN
     		  Output(8)=OFF
     		END


     MONTH
     -----
     Test current month

     Trigger actions based on the current month. Month is 1 in January and
     12 in December.

     Syntax:	Month <op> v

     where:	<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     Example:	IF Month=10 THEN
     		  LCD(0) = "The month is October\n"
     		END


     NETBIT
     ------
     Test a network I/O bit

     Network I/O ports on DIO-Link modules may be either inputs or outputs
     depending on how they are referenced. If a bit is set to 1 or 0, its





     HCS II System Reference Manual                                  17
     output will go high or low and is treated as an output. If a bit is
     set to 1 and externally driven, it is considered an input. The direc-
     tion of I/O bits on all other COMM-Links is fixed (as described in Ap-
     pendix B). The current state of a bit, whether input or output, may be
     tested. Fixed bit numbers are assigned to COMM-Link modules as de-
     scribed in the table in Appendix B.

     Syntax:	Netbit(n) = ON/TRUE/OFF/FALSE/EDGE

     where:	n = valid netbit number (0-319)

     COMM-Links: DIO, ADIO, LCD, DIO+

     Example:	IF Netbit(3)=ON THEN
     		  Module(L5) = ON
     		END

     Netbit inputs are normally either on or off. The transition from on to
     off or from off to on is known as an "edge." Detecting edges alone (as
     opposed to either on or off) is useful when you want to know that the
     state of an input has changed, but don't care whether it changed to on
     or off.

     Edge detection is done in software and requires a pulse width of at
     least 1 second and (for complex networks) sometimes up to 5 seconds to
     detect netbit edges. Rising edges (off to on) and falling edges (on to
     off) are treated identically. You may determine whether a rising or
     falling edge has occurred by testing the input's level at the same
     time (e.g., IF Input(3) = EDGE AND Input(3) = ON THEN it was a rising
     edge).

     Edges may be tested multiple times during a single pass through the
     XPRESS program. At the end of each pass through the list, the edge
     storage table is cleared.


     OUTPUT
     ------
     Test the current state of a local output

     All local output numbers are predefined and depend on the hardware
     being used. See Appendix B for a table of supported hardware and cor-
     responding output numbers.

     Syntax:	Output(n) = ON/TRUE/OFF/FALSE

     where:	n = output number (0-87)

     Example:	IF Input(3)=OFF AND Output(8)=ON THEN
     		  Output(8)=OFF
     		END








     18                                   HCS II System Reference Manual

     RESET
     -----
     True after reset

     Upon a system reset or a new XPRESS program being loaded, this condi-
     tion is true for the first pass through the program and is always
     false thereafter. Used to set up initial or default system conditions.

     Syntax:	Reset

     Example:	IF Reset THEN
     		  Refresh = 10
     		  Module(D2) = ON
     		  Variable(4) = 0
     		END


     TIME
     ----
     Test current time of day

     Compare the current time to a given time of day. Hour, minute, and day
     of week are tested.

     Note that testing is based on a 24-hour day that lasts from midnight
     to midnight.

     Syntax:	Time <op> hh:mm:dd

     where:	<op> = "=", "<>", ">", "<", ">=", "<="
     		hh = hours (00-23)
     		mm = minutes (00-59)
     		dd = day of week (MO,TU,WE,TH,FR,SA,SU,DY,WK,EN)
     		      DY = daily, WK = weekday, EN = weekend

     Examples:	IF Time=08:00:DY THEN
     		  Output(7)=OFF
     		END

     At 8:00 in the morning every day, turn output number 7 off.

     		IFA Time>23:00:MO OR Time<6:00:TU THEN
     		  IF Input(9)=ON THEN
     		    Module(E5) = ON
     		  END
     		  IF Input(9)=OFF THEN
     		    Module(E5) = OFF
     		  END
     		END

     Turn on the porch light (controlled by X-10 module E5) when motion is
     detected on input number 9, and off again when the motion stops, but
     only if it is during the period between late Monday night and early
     Tuesday morning.




     HCS II System Reference Manual                                  19

     Note the use of the OR operator in the expression. The time of day and
     day of week are tested separately. The first expression will only be
     true on Monday and the second will only be true on Tuesday. Using an
     AND operator, as you might be inclined to do at first glance, will
     result in the expression always being false. Changing the day of week
     to daily

     	IFA Time>23:00:DY OR Time<6:00:DY THEN ...

     doesn't change the need to use an OR. The first expression will only
     be true when TIME is greater than 23:00 and less than 23:59. The sec-
     ond expression is only true when TIME is greater than 0:00 and less
     than 6:00. As before, using an AND will result in the expression al-
     ways being false.

     When testing times that don't straddle two days, an AND must be used.

     	IFA Time>6:00:DY AND Time<23:00:DY THEN ...

     In this case, if the OR operator were used, the expression would al-
     ways evaluate true. The first expression is true if TIME is greater
     than 6:00 and less than 23:59. The second expression is true if TIME
     is greater than 0:00 and less than 23:00. Combining these with an OR
     always results in a true state. Combining them with an AND gives the
     desired result.


     TIMER
     -----
     Test a timer

     Timers may be tested for whether they are running or not. Timers that
     are running may be tested against numerous system conditions. Timer
     numbers 0-63 are incremented every second while timers 64-127 are in-
     cremented once a minute.

     Syntax:	Timer(n) <op> v

     where:	n = timer number (0-127)
     		<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     Example:	IF Timer(3)>=8 THEN
     		  Module(G7) = OFF
     		END

     There are actually two sets of timers defined: one that counts seconds
     and another that counts minutes. Timers 0-63 are incremented once per
     second while timers 64-127 are incremented once per minute. Minute
     timers may trigger any time during the minute preceding the setpoint
     (i.e., a timer tested for 5 minutes may show true any time between 4
     minutes 1 second and 5 minutes).




     20                                   HCS II System Reference Manual

     When off, all value comparisons result in false. When turned on,
     timers are cleared to 0 and begin counting. To clear a timer that is
     already running, it is not necessary to stop the timer. It may simply
     be restarted (e.g., if a timer is started, allowed to run for 15 sec-
     onds, then turned on again, it is cleared to 0 and continues running
     from there).


     VARIABLE
     --------
     Test a variable

     Variables may contain any 16-bit number and may be tested against many
     different system conditions. Variables are considered off or false
     when set to zero and on or true when set to any nonzero value.

     Syntax:	Variable(n) <op> v

     where:	n = variable number (0-127)
     		<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     Example:	IF Variable(2)>5 THEN
     		  Output(4) = OFF
     		  Variable(2) = 0
     		END


     YEAR
     ----
     Test current year

     Trigger actions based on the current year. Year in in the range 0-99.

     Syntax:	Year <op> v

     where:	<op> = "=", "<>", ">", "<", ">=", "<="
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		      Variable(n), ADC(n), Timer(n), IRcode(c),
     		      Random(n), Day, Month, Year, DOW

     Example:	IF Year>=90 THEN
     		  LCD(0) = "These are the '90s\n"
     		END












     HCS II System Reference Manual                                  21

     3.4.3 Actions and Assignments
     -----------------------------
     The THEN and ELSE portions of the XPRESS statement may contain any
     number of actions and assignments. Items must be on separate lines or
     be separated by semicolons. IF and IFA statements may also be included
     in this section. IFs and IFAs may be nested in any combination to any
     number of levels.

     Mathematical equations may be used in assignment statements that deal
     with numbers. Such equations use signed, 16-bit, integer math opera-
     tions and support addition (+), subtraction (-), multiplication (*),
     and division (/). Evaluation takes place in strict left-to-right order
     (contrary to traditional math where multiplication and division have a
     higher precedence than addition and subtraction), however parentheses
     may be used to alter the order of evaluation.

     The negate operator is not supported, and all constants must be posi-
     tive. An overflow results in a value of 32767 and an underflow results
     in -32768. No errors are generated in over/underflow situations.

     An equation must fit on a single line!

     The following examples are valid:

     	Variable(2) = ((ADC(5) * 9) / 5) +32
     	DAC(3) = 1024 - (Variable(2) * 100)

     The first example would evaluate the same way with or without
     parentheses, but their usage often makes an equation more readable and
     eliminates all possibility for confusion. However, the second example
     would evaluate differently without the parentheses because of the
     left-to-right evaluation order used by default.


     ALLLIGHTSON
     -----------
     Turn on all X-10 lights in a housecode

     X-10 modules support an "All Lights On" command that turns on just
     lamp and wall switch modules set for the same housecode. This command
     is ignored by all other X-10 modules (including appliance modules)
     regardless of what is plugged into them.

     Syntax:	AllLightsOn(h)

     where:	h = housecode (A-P)

     COMM-Links: PL

     Example:	IF Input(8)=ON THEN
     		  AllLightsOn(B)
     		END






     22                                   HCS II System Reference Manual

     ALLUNITSOFF
     -----------
     Turn off all X-10 modules in a housecode

     X-10 modules support an "All Units Off" that turns off all X-10
     modules set for the same housecode.

     Syntax:	AllUnitsOff(h)

     where:	h = housecode (A-P)

     COMM-Links: PL

     Example:	IF Timer(18)>=30 THEN
     		  AllUnitsOff(G)
     		END


     CLEARLOG
     --------
     Clear all logged data values from memory

     On a system reset or new program load, the logged data pointer is left
     untouched (and uninitialized is starting the system from a cold
     start). Before any data logging is done, the data pointer should be
     cleared either with the HOST "C" command or with this command at the
     top of your XPRESS program.

     Syntax:	ClearLog

     Example:	IF Reset THEN
     		  ClearVariables; ClearTimers
     		  ClearLog
     		END


     CLEARTIMERS
     -----------
     Stop and clear all system timers

     On a system reset or new program load, all system timers are left run-
     ning (if they were running before the reset or program load).
     ClearTimers allows you to stop and clear all the system timers with a
     single command.

     Syntax:	ClearTimers

     Example:	IF Reset THEN
     		  ClearVariables; ClearTimers
     		  ClearLog
     		END







     HCS II System Reference Manual                                  23
     CLEARVARIABLES
     --------------
     Clear all system variables to 0

     On a system reset or new program load, all system variables are left
     with their previous values (or undefined). ClearVariables allows you
     to set all the system variables to 0 with a single command.

     Syntax:	ClearVariables

     Example:	IF Reset THEN
     		  ClearVariables; ClearTimers
     		  ClearLog
     		END


     DAC
     ---
     Set a network analog channel

     Set any DAC channel on any network ADIO module to an 8-bit value. See
     Appendix B for a list of channel numbers and corresponding ADIO module
     numbers.

     Syntax:	DAC(n) = v

     where:	n = channel number (0-31)
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		       Variable(n), ADC(n), Timer(n), IRcode(c),
     		       Random(n), Day, Month, Year, DOW, Equation

     COMM-Links: ADIO

     Example:	IF ADC(16)>=192 THEN
     		  DAC(2) = 32
     		END


     DEC
     ---
     Decrement a variable

     Variables may contain any 16-bit number and may be decremented to be
     used as counters.

     Syntax:	Dec(Variable(n))

     where:	n = variable number (0-127)











     24                                   HCS II System Reference Manual
     Example:	DEFINE Counter = Variable(2)

     		IF Input(4)=EDGE AND Input(4)=ON THEN
     		  Dec(Counter)
     		END


     INC
     ---
     Increment a variable

     Variables may contain any 16-bit number and may be incremented to be
     used as counters.

     Syntax:	Inc(Variable(n))

     where:	n = variable number (0-127)

     Example:	DEFINE Counter = Variable(2)

     		IF Input(4)=EDGE AND Input(4)=ON THEN
     		  Inc(Counter)
     		END


     LCD
     ---
     Send a message to an LCD-Link

     A message may be sent to any LCD-Link on the network consisting of
     text, current time and date, and variable values. The subset of ANSI
     control sequences supported by the LCD-Link may be used to format the
     display. Lines too long for the display are wrapped to the next line.
     When the bottom of the display is reached, the display will scroll.
     See the LCD-Link documentation for more information about the sup-
     ported ANSI commands.

     Syntax:	LCD(n) = "string", Variable(x), Variable(y), ...

     where:	n = LCD-Link number (0-7)
     		string = text string with embedded time, date, and
     	                  variable descriptors

     COMM-Links: LCD

     Control characters within the string follow the conventions outlined
     in the LCD-Link manual. Within "string" may be time, date, and vari-
     able descriptors. The descriptors are as follows:

     	%A = time (HH:MM)
     	%B = time (HH:MM:SS)
     	%C = day of week (Sun, Mon, ..., Sat)
     	%D = date (MM/DD/YY)
     	%E = date (Month DD, YYYY; Month = Jan, Feb, ..., Dec)





     HCS II System Reference Manual                                  25

     To display variables, a format descriptor is used within the string
     and the variable to be displayed is appended to the end of the string.
     The following formats are supported:

     	%Px = print a variable with x digits after the decimal point and
     	       no leading zeros or spaces
     	%Qx = print a variable with x digits after the decimal point and
     	       leading zeros replaced with spaces
     	%Rx = print a variable with x digits after the decimal point and
     	       leading zeros

     In the case of %P, only as many characters as necessary to represent
     the number are printed. In the case of %Q and %R, five digits are al-
     ways printed (though leading zeros are replaced by spaces with %Q),
     with the decimal point taking up one more character position. A lead-
     ing negative sign is added to any negative number. When x is zero, the
     decimal point isn't displayed at all.

     Examples:
     	LCD(0) = "\e[2JToday is %D\n  or\n%C, %E\n"

     This statement clears the display on LCD-Link 0 and creates the fol-
     lowing message:
     		Today is 03/15/93
     		  or
     		Mon, Mar 15, 1993


     In the following excerpt, when the button connected to input 5 is
     pressed to request a reading, the ADC is read and its raw value is as-
     signed to a variable. The raw reading (0-255) is converted to the ac-
     tual voltage being measured (0-5 volts) and both are displayed on the
     LCD-Link display. Note that variable 15 contains a value ten times
     larger than the actual voltage. When displayed with one digit after
     the decimal point, it shows the correct value and simulates floating
     point, though only integer math is involved.

     	DEFINE RawV = Variable(9)
     	DEFINE DisplayReading = Input(5)

     	BEGIN
     	IF DisplayReading=ON THEN
     	  RawV = ADC(2)
     	  Variable(15) = (RawV * 50) / 256
     	  LCD(0) = "Reading = %P1 volts\n", Variable(9)
     	  LCD(0) = "Raw value = %P0 \n", RawV
     	  LCD(0) = "Raw value = %Q0\nRaw value = %R0", RawV, RawV
     	END

     			Reading = 3.1 volts
     			Raw value = 161
     			Raw value =   161
     			Raw value = 00161





     26                                   HCS II System Reference Manual

     Tip: To display a degree symbol ("ø") on an LCD-Link, use the sequence
     "\xDF" in your display string. For example, the string "Temp = 28\xDF"
     displays "Temp = 28ø" on the LCD-Link.


     LOG
     ---
     Log a data value to memory

     At any time, a 16-bit value may be saved to memory for later process-
     ing by the user. The time and date of logging is saved with the value.
     A reference ID number is also stored with the value so different
     sensors and events may be logged to the same memory and sorted later.
     You must have an extra 32K SRAM installed in socket U10 of the Super-
     visory Controller in order to log data. See Chapter 6 for details on
     how to install an extra RAM chip and how the logged data is formatted.

     Syntax:	Log(i) = v

     where:	i = reference ID number (0-254)
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		       Variable(n), ADC(n), Timer(n), IRcode(c),
     		       Random(n), Day, Month, Year, DOW, Equation
     Example:
     	!
     	! Log the raw outside temperature reading
     	!  every 30 minutes and log whenever the
     	!  motion sensor is activated and whenever
     	!  the front door is opened.
     	!
     	DEFINE Temp = 0
     	DEFINE Motion = 1
     	DEFINE FrontDoor = 2

     	BEGIN
     	IF Reset THEN
     	  ClearLog
     	  Timer(70) = ON
     	END

     	IF Timer(70)>=30 THEN
     	  Log(Temp) = ADC(2)
     	  Timer(70) = ON
     	END
     	IF Input(2)=ON THEN
     	  Log(Motion) = 0
     	END
     	IF Input(5)=ON THEN
     	  Log(FrontDoor)
     	END

     Note that when logging the motion and front door, the actual value
     saved isn't important. Saving the reference ID and current time and





     HCS II System Reference Manual                                  27
     date is enough to tell you when each sensor was tripped. After the raw
     data has been dumped to a file on the PC, a program may be written to
     sort the data by reference IDs and produce a final report with data
     grouped by temperatures, motion, and front door activity.


     LPT
     ---
     Send a message to a DIO-Link

     A message may be sent to any DIO-Link on the network that has a byte-
     wide device connected to it (such as a printer) consisting of text,
     current time and date, and variable values. The subset of ANSI control
     sequences supported by the DIO-Link may be used to format the output.
     See the DIO-Link documentation for more information about device con-
     nection and supported ANSI commands.

     Syntax:	LPT(n) = "string", Variable(x), Variable(y), ...

     where:	n = DIO-Link number (0-7)
     		string = text string with embedded time, date, and
     	               variable descriptors

     COMM-Links: DIO

     See the LCD command in this section for complete details of the des-
     criptors and how they are used.


     MCIR
     ----
     Tell an MCIR-Link to send a trained infrared command

     The MCIR-Link stores trained IR commands and references them by num-
     ber. You must set up (train) the MCIR-Link in interactive mode before
     connecting it to the network. XPRESS only allows you to instruct the
     MCIR-Link to send a command that has already been stored. It does not
     allow remote training or loading of the MCIR-Link module. See the
     MCIR-Link manual for more details.

     Syntax:	MCIR(n) = v

     where:	n = MCIR-Link number (0-7)
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		       Variable(n), ADC(n), Timer(n), IRcode(c),
     		       Random(n), Day, Month, Year, DOW, Equation
     		v must be in the range of 1-999 or 1001-1999

     COMM-Links: MCIR










     28                                   HCS II System Reference Manual
     Example:	DEFINE TVon = 6      ! Trained MCIR code
     		BEGIN
     		IF Input(8)=ON THEN
     		  LCD(0) = "Turning on TV"
     		  MCIR(0) = TVon
     		END


     MODULE
     ------
     Turn any kind of X-10 module on or off. Lamp and switch modules may
     also be dimmed or brightened. Note that an X-10 module that is off
     must go to full brightness before its level may be adjusted. A module
     may not be gradually brightened from black unless it was previously
     turned full on and dimmed to black (not turned off).

     Syntax:	Module(hmm) = ON/OFF/ONA
     		Module(hmm) = DIM(n)
     		Module(hmm) = BRIGHT(n)

     where:	h = housecode (A-P)
     		mm = module number (1-16)
     		n = number of dim/bright steps (1-48)

     COMM-Links: PL

     When the Supervisory Controller knows that a particular X-10 module is
     already on, it won't send another ON command to it. To force the SC to
     always send an ON command, even if the module is already on, use the
     ONA (ON Always) command.

     Examples:	IF Input(3)=ON THEN
     		  Module(J9) = Dim(6)
     		END

     		! Module C1 is a chime module, which
     		!  sounds its chime any time it receives
     		!  an ON command. There is no need to
     		!  send it an OFF command because the
     		!  module just ignores it. We use ONA to
     		!  force the system to send an ON command
     		!  even though it thinks the module is
     		!  already on.
     		!
     		IF Input(5)=ON THEN
     		  Module(C1) = ONA
     		END












     HCS II System Reference Manual                                  29
     NETBIT
     ------
     Set a network I/O bit

     Set a network bit to either a high or a low state. If a DIO-Link bit
     is to be used as an input, it must be set high (ON) before it may be
     read. See NETBIT in Section 3.4.2 for more details.

     Syntax:	Netbit(n) = ON/OFF

     where:	n = valid netbit number (0-319)

     COMM-Links: DIO, ADIO, LCD, DIO+

     Example:	IF Input(23)=ON THEN
     		  Netbit(7) = ON
     		END


     OUTPUT
     ------
     Set a local output on or off

     Set a local output on or off. See the description of OUTPUT in Section
     3.4.2 for more details.

     Syntax:	Output(n) = ON/OFF

     where:	n = output number (0-87)

     Example:	IF Input(12)=ON THEN
     		  Output(8)=OFF
     		END


     RANDOM
     ------
     Choose a random number

     A pseudorandom number within a given range is selected and may be used
     in either comparisons or assignments. The number chosen is always be-
     tween zero and an upper limit passed to the function.

     Syntax:	Random(n)

     where:	n = upper limit for random number (1-255)

     Examples:	!
     		! Give the house a lived-in look by
     		!  turning on a light a random amount
     		!  of time (but no more than 20
     		!  minutes) after a certain time of day
     		!
     		DEFINE Light = Module(L4)





     30                                   HCS II System Reference Manual
     		BEGIN
     		IF Time=18:00:DY THEN
     		  Timer(70) = ON
     		  Variable(0) = Random(20)
     		END
     		IF Timer(70)>Variable(0) THEN
     		  Light = ON
     		  Timer(70) = OFF
     		END

     		! To select a random number between
     		!  20 and 80, use the following:
     		!
     		Variable(2) = 20 + Random(60)


     REFRESH
     -------
     Set PL-Link refresh period

     The PL-Link will periodically send out ON or OFF commands to all X-10
     modules that have received ON or OFF commands since the PL-Link's last
     reset. This action is used to set the period in which all modules will
     be reset. The system defaults to no refresh.

     Syntax:	Refresh = r

     where:	r = refresh period in minutes (0-99)
     		 (set to 0 to turn off refresh)

     COMM-Links: PL

     Example:	IF Input(23)=ON THEN
     		  Refresh=10
     		END

     All X-10 modules that have been referenced by the PL-Link since its
     last reset will be refreshed with a 10-minute period. The frequency at
     which commands are sent to the power line depends on how many modules
     must be refreshed. For example, if the refresh period is set for 10
     minutes and there are 20 modules in use, a new command is sent every
     30 seconds. After 10 minutes, all modules will have been refreshed and
     the cycle starts again.


     RESETIO
     -------
     Reinitialize all direct I/O ports

     In order to make the system more failsafe in noisy or harsh environ-
     ments, it is sometimes desireable to be able to periodically
     reinitialize all the hardware I/O ports to ensure they are properly
     configured for inputs and outputs. ResetIO reinitializes all system
     8255s to their proper configurations.





     HCS II System Reference Manual                                  31

     One note of caution: Whenever an 8255 is reconfigured, it clears all
     its output ports. The HCS will automatically update the output ports,
     but there may be a period of a few tens of microseconds when the out-
     puts aren't at the values you set them for.

     Syntax:	ResetIO

     Example:	!
     		! Reinitialize the direct I/O ports
     		!   every hour
     		!
     		IF Reset THEN
     		  Timer(80) = ON
     		END
     		IF Timer(80)>=60 THEN
     		  ResetIO
     		  Timer(80) = ON
     		END


     TIMER
     -----
     Start or stop a system timer. See TIMER in Section 3.4.2 for more
     details.

     Syntax:	Timer(n) = ON/OFF

     where:	n = timer number (0-63 for seconds, 64-127 for minutes)

     Example:	IF Input(4)=EDGE THEN
     		  Timer(7)=ON
     		END


     VARIABLE
     --------
     Set a variable

     Variables may contain any 16-bit value and may be set to a variety of
     system values and conditions.

     Syntax:	Variable(n) = v

     where:	n = variable number (0-127)
     		v = constant (0-32767), ON, TRUE, OFF, FALSE,
     		       Variable(n), ADC(n), Timer(n), IRcode(c),
     		       Random(n), Day, Month, Year, DOW, Equation

     Example:	IF Input(4)=OFF THEN
     		  Variable(3) = (ADC(5) * 12) - 10
     		END







     32                                   HCS II System Reference Manual



     4. Data Logging
     ===============
     While it is usually pretty easy to set up a control system based on
     specific events and known environmental conditions, sometimes it's
     useful to set up one or more sensors, collect data generated by those
     sensors, and then decide how the control system should work based on
     the collected data. The collected data may also be used to monitor
     what happens at home while you're away.

     Since the Supervisory Controller already has all manner of sensors
     connected to it, spare memory, a real-time clock/calendar, and some
     intelligence, it makes a very good data logging system in addition to
     a home control system. Using the LOG command (detailed in Section
     3.4.3), single 16-bit values may be stored to memory at any time. A
     reference ID is attached to the sample to allow data from many dif-
     ferent sensors to be logged to the same memory. Separating and sorting
     of the data is performed at a later time by custom processing software
     running the the host IBM PC. The current time and date are also saved
     with the data.

     After the SC has been logging data to its memory for a while, you use
     the "D" (Dump) command within HOST to dump the data from the SC's
     memory to a disk file on the PC. The data file is always called LOG-
     DATA. BIN, so be sure to rename an old file before performing a dump
     if you wish to save the old data.


     4.1 Hardware Setup
     ------------------
     In order to perform data logging, an additional 32K static RAM chip
     must be installed on the Supervisory Controller.

     Before doing anything, turn off the power to the SC. Install a stan-
     dard 62256 (or equivalent) chip in socket U10 on the SC (it is the
     empty 28-pin socket between the EPROM and existing RAM chip). Be sure
     to orient the chip in the same way as the other memory chips on either
     side of it. Plugging the chip in backwards will destroy the chip and
     could damage other components on the board.

     Next, verify that the two jumpers on JP6 (next to the new RAM chip)
     are installed between pins 2 & 3 and pins 4 & 5. Pin 1 of JP6 (the pin
     closest to the EPROM) should be left open.

     If you want the log memory to remain intact through a power outage,
     you'll need to use either a battery-backed RAM or a module that will
     back up a RAM chip plugged in on top of it (such as the Dallas Semi-
     conductor DS1210 module). If you have any questions about what kind of
     RAM chip will work in the socket or about how to battery back the
     memory, contact Circuit Cellar.

     When the RAM is installed and the jumpers in JP6 are set, you may turn
     the power back on and try out data logging.




     HCS II System Reference Manual                                  33


     4.2 Software Setup
     ------------------
     The first step that must be performed before logging any data is to
     clear the memory. Log memory may be cleared in one of two ways: from
     HOST or from within your XPRESS program.

     While in HOST, pressing "C" will clear the log memory. Clearing log
     memory from HOST may be done at any time. You may also embed a CLEAR-
     LOG command within your XPRESS program (see Section 3.4.3 for more
     details). Whenever the command is encountered, the log memory will be
     cleared. The command is most often placed at the top of the program
     and is run as a result of the RESET condition (see Section 3.4.2). The
     only potential drawback of clearing log memory on reset is your data
     is cleared any time you load a new program or the power is lost and
     restored. If you prefer to have more control over when memory is
     cleared, stick with HOST's "C" command.

     Once the log memory has been cleared, you may start logging data
     values to memory. Each time a value is saved with the LOG command, a
     16-bit value, a reference ID number, and the current time and date are
     saved (for a total of eight bytes). The purpose of the reference ID
     number becomes clear when you start planning what you want to log.

     If data values were saved to memory without IDs, you would be limited
     to storing data from just one kind of sensor. Otherwise, you wouldn't
     know which sensor had generated the data. By storing data in memory
     sequentially with IDs attached to each value, you may sort the data by
     IDs at a later time. The examples presented later in this section will
     clarify the concepts further.

     Up to 4096 samples may be stored in memory at any given time (32768
     bytes of RAM Ö 8 bytes per sample). When you reach the end of memory,
     new samples begin to overwrite the oldest samples, so when you dump
     the data to a disk file, you end up with the last 4096 samples stored.

     When you decide to retrieve the data from the SC's memory, select "D"
     from within HOST. The data is stored in a disk file called LOGDATA.BIN
     on the PC. Be aware that 32K of data transferred from the SC to the PC
     at 9600 bps will take up to 35 seconds to complete, so be patient. The
     SC also stops all processing of your XPRESS program while it's dumping
     data, so if having your SC off-line for 30 seconds or more is a prob-
     lem, be sure to dump your data and clear the log memory often to mini-
     mize transfer times.


     4.3 What to Log
     ---------------
     There are many situations where the time stamp saved with the logged
     data is more useful to you than the actual data stored. For example,
     if you want to log the fact that a motion sensor was tripped or a door
     was opened, simply log a 0 with a reference ID that is unique to the
     motion sensor or door sensor. When you later process the logged data,





     34                                   HCS II System Reference Manual
     you can ignore the data that was saved and associate the reference ID
     with the time and date saved. Take the following example:

     	DEFINE Temp = 0
     	DEFINE Motion = 1
     	DEFINE FrontDoor = 2

     	BEGIN

     	IF Reset THEN
     	  ClearLog
     	  Timer(70) = ON
     	END

     	IF Timer(70)>=30 THEN
     	  Log(Temp) = ADC(2)
     	  Timer(70) = ON
     	END
     	IF Input(2)=ON THEN
     	  Log(Motion) = 0
     	END
     	IF Input(5)=ON THEN
     	  Log(Frontdoor) = 0
     	END

     In the first LOG statement, the value of the temperature sensor is
     stored every 30 minutes. In this case, you use reference ID 0 to find
     the temperature data in the file, then associate the actual tempera-
     ture read with the time and date of when it was logged.

     In the second two LOG statements, you are only interested in when the
     sensors were tripped, not the value saved. Search the data file for
     reference IDs of 1 and you'll know every time that the motion sensor
     was tripped. Search for IDs of 2 and you'll know when the door was
     opened.


     4.4 Logged Data Format
     ----------------------
     Each logged data sample is stored in the LOGDATA.BIN file as follows:

     	Byte 0: Reference ID number	(0-254)
     	Byte 1: Low byte of data 	(0-255)
     	Byte 2: High byte of data	(0-255)
     	Byte 3: Month logged		(1-12)
     	Byte 4: Day logged		(1-31)
     	Byte 5: Hour logged		(0-23)
     	Byte 6: Minute logged		(0-59)
     	Byte 7: Second logged		(0-59)

     All values are in binary. This file may not simply be typed to the
     screen. It consists of primarily unprintable binary characters and
     must be further processed on the PC by custom software in order to be
     useful. The following section contains some sample processing code
     written in C to give you an idea of what's necessary.




     HCS II System Reference Manual                                  35


     4.5 Sample Processing Software
     ------------------------------
     The following C program (included on the distribution disk in both
     source and executable form) may be used to process data logged by the
     Supervisory Controller and dumped to disk. Feel free to modify the
     code to fit your needs. It was written in Turbo C, but should work
     with most any compiler.

     When run, the sample code reads the LOGDATA.BIN file (or another file
     you specify on the command line) and generates a report to the screen
     with the data grouped by reference ID numbers. The data value, date,
     and time are displayed, one record per line. You may redirect the out-
     put to a file or the printer for a permanent, readable record.

     To process the data in the file called MYDATA.BIN, use the command:

     	PROCESS MYDATA

     To process the data in LOGDATA.BIN and send it to a file called
     LOG.TXT, use the command:

     	PROCESS >LOG.TXT

     To process the data in the file called WEEKLY.RAW and send it to the
     printer, use the command:

     	PROCESS WEEKLY.RAW >PRN




     #include <stdio.h>
     #include <stdlib.h>

     #define false 0
     #define true  1

     FILE *fp
     unsigned char *logdata;
     unsigned int  len=0;


     unsigned int ReadData(char *input)
     {
        unsigned int i=0;

        if ((fp=fopen(input, "rb")) == NULL) {
           printf("\nError opening %s\n", input);
           fclose(fp);
           return 1;
        }
        logdata = malloc(32768);





     36                                   HCS II System Reference Manual
        if (!logdata) {
           printf("\nError allocating memory.\n");
           fclose(fp);
           return 1;
        }
        while (!feof(fp)) {
           logdata[i++] = getc(fp);
           len++;
        }
        fclose(fp);
        return 0;
     }

     void ProcessData(void)
     {
        unsigned int id, record, id_header;

        for (id=0; id<=254; id++) {
           id_header = false;
           for (record=0; record<len; record+=8) {
              if (logdata[record]==id) {
                 if (!id_header) {
                    printf("\nID = %u\n", id);
                    id_header = true;
                 }
                 printf("  % 5i  %02i/%02i, %02i:%02i:%02i\n",
                       logdata[record+1]+(logdata[record+2]*256),
                       logdata[record+3], logdata[record+4],
                       logdata[record+5], logdata[record+6],
                       logdata[record+7]);
              }
           }
        }
        printf("\n");
     }

     main(int argc, char *argv[])
     {
        char *file, name[16];
        unsigned int err=0;

        file = name;

        if (argc < 2)
           err = ReadData("LOGDATA.BIN");
        else {
           if (strchr(argv[1],'.'))
              err = ReadData(argv[1]);
           else {
              strcpy(file, argv[1]);
              strcat(file, ".BIN");
              err = ReadData(file);
           }
        }





     HCS II System Reference Manual                                  37
        if (!err)
           ProcessData();
        return 0;
     }























































     38                                   HCS II System Reference Manual



     Appendix A: Example Programs
     ============================
     Often the best way to learn is by example. The sample programs shown
     here aren't necessarily intended to do anything useful by themselves,
     but are meant to show how one or more elements of the XPRESS language
     are used.


     !
     ! Blink a direct output at a 2-second rate.
     !
     CONFIG SC = SC1

     DEFINE BlinkTimer = Timer(0)
     DEFINE Light = Output(0)

     BEGIN
     IF Reset THEN
       BlinkTimer = ON
     END

     IF BlinkTimer>=2 THEN
       IFA Light=OFF THEN
         Light = ON
       ELSE
         Light = OFF
       END
       BlinkTimer = ON
     END

     -----------------------------------------------------------------

     !
     ! Watch a motion detector connected to a netbit and count
     !  how many times motion is detected in a 30-second period.
     !  If the count exceeds 5 within that time period, sound
     !  the horn also connected to a netbit and turn on the
     !  lights.
     !
     CONFIG SC = SC1
     CONFIG PL-Link = 1
     CONFIG DIO = 1
     CONFIG LCD = 1

     DISPLAY Modules = L

     DEFINE Motion      = Netbit(0)
     DEFINE MotionCount = Variable(0)
     DEFINE MotionTimer = Timer(0)
     DEFINE Light1      = Module(L5)
     DEFINE Light2      = Module(L7)





     HCS II System Reference Manual                                  39
     DEFINE Horn        = Netbit(7)
     DEFINE Console     = LCD(0)
     BEGIN
     IF Reset THEN
       MotionTimer = OFF; Motion = ON
       Horn = OFF; MotionCount = 0
     END

     IF MotionTimer>30 AND MotionCount>5 THEN
       Horn = ON
       Light1 = ON; Light2 = ON
       MotionTimer = OFF; MotionCount = 0
       Console = "Motion limit exceeded.\n"
     END

     IFA Motion=ON THEN
       IF MotionTimer=OFF THEN
         MotionTimer = ON
       END
       IF MotionTimer = ON THEN
         Inc(MotionCounter)
       END
     END

     -----------------------------------------------------------------

     !
     ! Turn on lights in response to motion, but only if it is
     !  dark outside. Turn the lights off 20 minutes after the
     !  last motion has been detected at all hours (so the
     !  lights are automatically turned off even during the
     !  day). A light-level detector is connected to an
     !  ADIO-Link A/D converter.
     !
     CONFIG SC = SC1
     CONFIG PL-Link = 1
     CONFIG ADIO-Link = 1

     DISPLAY Modules = E

     DEFINE LivingLamp   = Module(E2)
     DEFINE LivingFloods = Module(E12)
     DEFINE LivingTimer  = Timer(45)
     DEFINE LivingMotion = Input(4)
     DEFINE LightLevel   = ADC(16)
     DEFINE Setpoint     = 85
     DEFINE Mode         = Variable(3)
     DEFINE Day          = 0
     DEFINE Night        = 1

     BEGIN
     IF Reset THEN
       Mode = Day; LivingTimer = OFF
     END





     40                                   HCS II System Reference Manual

     IF LightLevel<=Setpoint THEN
       Mode = Night
     END
     IF LightLevel>Setpoint THEN
       Mode = Day
     END
     IF Mode=Night AND LivingMotion=EDGE THEN
       LivingLamp = ON; LivingFloods = ON
     END

     IF LivingMotion=EDGE THEN
       LivingTimer = ON
     END

     IF LivingTimer>=20 THEN
       LivingLamp = OFF; LivingFloods = OFF
       LivingTimer = OFF
     END

     -----------------------------------------------------------------

     !
     ! A number of buttons on your hand-held remote are defined
     !  to put the HCS II into different modes. Actions are
     !  carried out depending on those modes.
     !
     CONFIG SC = SC1
     CONFIG PL-Link = 1
     CONFIG IR-Link = 3

     DISPLAY Modules = B,D,F

     DEFINE MovieMode    = IRcode(2)
     DEFINE DinnerMode   = IRcode(3)
     DEFINE RomanticMode = IRcode(7)
     DEFINE SleepMode    = IRcode(9)
     DEFINE FamilyRoom   = 0          ! IR-Link #0
     DEFINE DiningRoom   = 1          ! IR-Link #1
     DEFINE Bedroom      = 2          ! IR-Link #2
     DEFINE FamilyLight  = Module(F3)
     DEFINE DiningLight  = Module(D1)
     DEFINE BedLight     = Module(B4)
     DEFINE FamilyShades = Output(2)

     BEGIN
     IF MovieMode=FamilyRoom THEN
       FamilyLight = Dim(8)
       FamilyShades = ON
     END

     IF DinnerMode=DiningRoom THEN
       DiningLight = ON
     END





     HCS II System Reference Manual                                  41
     IF RomanticMode=DiningRoom THEN
       DiningLight = Dim(10)
     END

     IF SleepMode=Bedroom THEN
       BedLight = OFF; DiningLight = OFF
       FamilyLight = OFF; FamilyShades = ON
     END



















































     42                                   HCS II System Reference Manual



     Appendix B: Port Assignments
     ============================
     In order to maintain ease of configuration and setup, we have preas-
     signed port numbers to fixed hardware arrangements. Ports with fixed
     assignments include all direct inputs and outputs, netbits, A/D con-
     verters, and D/A converters. There is no way to reassign port numbers
     nor is there any way to reassign input/output assignments. Netbits on
     DIO-Links may be either inputs or outputs depending on whether the
     bits are read or written. All other ports are fixed as either input or
     output. The current state of all digital outputs may be tested within
     event equations.


     Direct I/O Ports
     ----------------
     The direct I/O ports are referenced using the Input and Output
     keywords in XPRESS.

        Board	Address	 I/O	Number	Connector	Labels
     	SC	 8000	 In	 0-7	    J4		PA0-PA7
     		 8001	 In	 8-15	    J4		PB0-PB7
     		 8002	 Out	 0-7	    J4		PC0-PC7

     	BUFIO/	 A000	 In	16-23	    J1		IA0-IA7
     	BUF50	 A001	 In	24-31	    J2		IB0-IB7
     		 A002	 In	32-39	    J3		IC0-IC7
     		 A010	 Out	16-23	    J4		OA0-OA7
     		 A011	 Out	24-31	    J5		OB0-OB7
     		 A012	 Out	32-39	    J6		OC0-OC7

     	IND180	 C800	 In	40-47	    J5		PA0-PA7
     		 C801	 In	48-55	    J5		PB0-PB7
     		 C802	 In	56-63	    J5		PC0-PC7
     		 C900	 Out	40-47	    J6		PA0-PA7
     		 C901	 Out	48-55	    J6		PB0-PB7
     		 C902	 Out	56-63	    J6		PC0-PC7

     	IND54	 EB00	 In	64-71	    J4		4PA0-4PA7
     		 EB01	 In	72-79	    J4		4PB0-4PB7
     		 EB02	 In	80-87	    J4		4PC0-4PC7
     		 EA00	 In	88-95	    J3		3PA0-3PA7
     		 EA01	 In	96-103	    J3		3PB0-3PB7
     		 EA02	 In	104-111	    J3		3PC0-3PC7
     		 E900	 In	112-119	    J2		2PA0-2PA7
     		 E901	 In	120-127	    J2		2PB0-2PB7
     		 E902	 In	128-135	    J2		2PC0-2PC7
     		 E800	 Out	64-71	    J1		1PA0-1PA7
     		 E801	 Out	72-79	    J1		1PB0-1PB7
     		 E802	 Out	80-87	    J1		1PC0-1PC7







     HCS II System Reference Manual                                  43
     Netbits
     -------
     Netbits are digital I/O bits found on the DIO-Link, DIO+-Link, LCD-
     Link, and ADIO-Link modules. Up to eight DIO-Links, eight DIO+-Links,
     eight LCD-Links, and six ADIO-Links may be used on the same network.
     The Netbit XPRESS keyword is used to both set and read netbits.

     DIO-Link netbits may be either inputs or outputs. To use a bit as an
     output, simply set the bit to either 1 or 0. To use the bit as an in-
     put, it must be set to a 1 on reset, then the bit may be read at any
     time and the current state of the input will be returned.

     LCD-Link netbits are fixed as inputs. The LCD-Link returns only a
     change in the input's state from 0 to 1. Therefore, LCD-Link netbits
     must be tested using the EDGE state rather than as ON or OFF.

     DIO+-Link and ADIO-Link netbits are fixed as either inputs or outputs.

     	DIO0: 0-7		LCD0: 64-67
     	DIO1: 8-15		LCD1: 68-71
     	DIO2: 16-23		LCD2: 72-75
     	DIO3: 24-31		LCD3: 76-79
     	DIO4: 32-39		LCD4: 80-83
     	DIO5: 40-47		LCD5: 84-87
     	DIO6: 48-55		LCD6: 88-91
     	DIO7: 56-63		LCD7: 92-95

     	ADIO0: 96-111  (Input)	112-119 (Output)
     	ADIO1: 120-135 (Input)	136-143 (Output)
     	ADIO2: 144-159 (Input)	160-167 (Output)
     	ADIO3: 168-183 (Input)	184-191 (Output)
     	ADIO4: 192-207 (Input)	208-215 (Output)
     	ADIO5: 216-231 (Input)	232-239 (Output)

     	DIOP0: 256-259 (Input)	260-263 (Output)
     	DIOP1: 264-267 (Input)	268-271 (Output)
     	DIOP2: 272-275 (Input)	276-279 (Output)
     	DIOP3: 280-283 (Input)	284-287 (Output)
     	DIOP4: 288-291 (Input)	292-295 (Output)
     	DIOP5: 296-299 (Input)	300-303 (Output)
     	DIOP6: 304-307 (Input)	308-311 (Output)
     	DIOP7: 312-315 (Input)	316-319 (Output)


     A/D Converters
     --------------
     The system A/D converters accept analog voltages in and produce digi-
     tal results, the range of the output values depending on the resolu-
     tion of the A/D converter. The ADC XPRESS keyword is used to read the
     converter channels. The SC's ADC is continuously scanned, resulting in
     each channel being read several times per second. The network ADCs are
     read only every few seconds, the frequency depending on how many
     modules there are on the network.






     44                                   HCS II System Reference Manual
     	SC: 0-7
     	IND13: 8-15	IND30: 96-111
     	ADIO0: 16-23	DIOP0: 112,113
     	ADIO1: 24-31	DIOP1: 114,115
     	ADIO2: 32-39	DIOP2: 116,117
     	ADIO3: 40-47	DIOP3: 118,119
     	ADIO4: 48-55	DIOP4: 120,121
     	ADIO5: 56-63	DIOP5: 122,123
     	ADIO6: 64-71	DIOP6: 124,125
     	ADIO7: 72-79	DIOP7: 126,127

     While a number is assigned to the optional second ADC channel on the
     DIO+-Link boards, only one 8-bit ADC channel per board is supported.

     The IND13 should be addressed for 9000H and the IND30 should be ad-
     dressed for 9800H. Only one ADC board (IND13 or IND30) may be in-
     stalled in an industrial (IND) system.


     D/A Converters
     --------------
     The only D/A converters in the system are on ADIO-Link modules. Any
     value from 0 to 255 may be sent to one of eight modules using the DAC
     XPRESS keyword, and the corresponding channel will output a voltage
     from 0 to 5 volts.

     	ADIO0: 0-3	ADIO4: 16-19
     	ADIO1: 4-7	ADIO5: 20-23
     	ADIO2: 8-11	ADIO6: 24-27
     	ADIO3: 12-15	ADIO7: 28-31





























     HCS II System Reference Manual                                  45



























































     46                                   HCS II System Reference Manual



     Appendix C: HOST/SC Serial Protocol
     ===================================
     The primary elements of the HCS II are the Supervisory Controller (SC)
     and the host IBM PC-compatible computer. The SC is responsible for
     overall system control while the host computer is used to edit and
     compile XPRESS programs, send the programs to the SC, set a new time
     in the SC, clear log memory, receive logged data and dump it to a disk
     file, and display system status. The program on the host computer used
     to communicate with the SC is called HOST.

     The SC is not only in control of all network activity, but is also in
     control of what is displayed by HOST. When it comes to displaying
     status information, HOST is completely passive, displaying only what
     the SC sends to it. The only time HOST has any control is when a new
     program or time is being sent to the SC, the log memory is being
     cleared, or logged data is requested from the SC.

     The status display protocols are covered first, followed by the pro-
     gram, time, and logged data transfer protocols.


     Status Display
     --------------
     All status messages sent from the SC to HOST contain a lead-in charac-
     ter that tells HOST what kind of status information is coming, fol-
     lowed by the actual status information in binary form.


     Current Time and Date
     ---------------------
     Syntax:	#[FractSec][Sec][Min][Hr][DOW][Day][Mon][Yr]

     where:	[FractSec] = hundredths of seconds (0-99)
     		[Sec] = seconds (0-59)
     		[Min] = minutes (0-59)
     		[Hr] = hour (0-23)
     		[DOW] = day of week (1-7, 1 = Sunday)
     		[Day] = day of month (1-31)
     		[Mon] = month (1-12)
     		[Yr] = year (00-99)

     All values are sent in BCD.

     Example: "#", 00h, 00h, 45h, 15h, 03h, 07h, 04h, 92h

     The current date and time are Tuesday, April 7, 1992, 3:45 p.m.










     HCS II System Reference Manual                                  47

     X-10 Modules
     ------------
     Syntax:	>[House][StatLo][StatHi]

     where:	[House] = housecode ("A"-"P")
     		[StatLo] = binary representation of modules 1-8
     		[StatHi] = binary representation of modules 9-16

     The on/off status of all the modules with the given housecode are sent
     every time as a 16-bit number. A 0 in a bit position indicates the
     corresponding module is off (or not used) and a 1 indicates the module
     is on (or dimmed). Bit 0 represents module 1 and proceeds up to bit
     15, which represents module 16. The low-order byte is sent first, fol-
     lowed by the high-order byte.

     Example: ">", "D", 05h, 34h

     Modules D1, D3, D11, D13, and D14 are on. The rest of the modules in
     housecode D are either off or not used.


     Network Modules
     ---------------
     Syntax:	*[NetMod][Stat]

     where:	[NetMod] = module type and number
     		[Stat] = 00h for timeout
     		         01h for active and error free
     		         02h for active but error in last received packet

     The [NetMod] parameter is broken into two parts. The low nybble con-
     tains the module number from 0 to 7. The high nybble contains the
     module type as follows:

     	1: PL-Link
     	2: MC/IR-Link
     	3: LCD-Link
     	4: DIO-Link
     	5: ADIO-Link
     	6: DIO+-Link

     Example: "*", 41h, 01h

     DIO-Link number 1 is active and error free.














     48                                   HCS II System Reference Manual

     Direct (local) Inputs
     ---------------------
     Syntax:	<[Group][Stat1][Stat2][Stat3]

     where:	[Group] = input group number ("0"-"5")
     		[Stat1] = status of inputs 1-8 in the group
     		[Stat2] = status of inputs 9-15 in the group
     		[Stat3] = status of inputs 16-23 in the group

     All direct inputs are grouped in blocks of 24. The groups are defined
     as follows:

     			Group	Inputs
     			0	0-15
     			1	16-39
     			2	40-63
     			3	64-87
     			4	88-111
     			5	112-135

     Any group containing fewer than 24 inputs is padded with zeros. The
     low-order bit in each byte corresponds to the lowest-numbered input
     represented within that byte.

     Example: "<", "3", 20h, 03h, 11h

     Inputs 69, 72, 73, 80, and 84 are all high. All the rest in the group
     of 64-87 are low.


     Direct (local) Outputs
     ----------------------
     Syntax:	}[Group][Stat1][Stat2][Stat3]

     where:	[Group] = output group number ("6"-"9")
     		[Stat1] = status of outputs 1-8 in the group
     		[Stat2] = status of outputs 9-15 in the group
     		[Stat3] = status of outputs 16-23 in the group

     All direct outputs are grouped in blocks of 24. The groups are defined
     as follows:

     			Group	Outputs
     			6	0-7
     			7	16-39
     			8	40-63
     			9	64-87

     Any group containing fewer than 24 outputs is padded with zeros. The
     low-order bit in each byte corresponds to the lowest-numbered output
     represented within that byte.

     Example: "}", "6", 71h, 00h, 00h





     HCS II System Reference Manual                                  49

     Outputs 0, 4, 5, and 6 are all high. All the rest in the group (1, 2,
     3, and 7) are low. The last two zeros sent are dummy values.


     Direct Analog Inputs
     --------------------
     Syntax:	~[StartChan][Chan0][Chan1]É[Chan15]

     where:	[StartChan] = Starting channel number (0, 8, or 96)
     		[Chanx] = 16-bit value of channel offset x

     Eight channels are sent after the starting channel number when the
     starting channel is 0 or 8. When the starting channel is 96, 16 chan-
     nels are sent. Channel values are sent low byte, followed by high
     byte.

     Example: "~", 00h, 45h, 00h, 29h, 00h, 8Eh, 00h, 5Ah, 00h, BDh, 00h,
     00h, 00h, F3h, 00h, 22h, 00h

     ADC channels 0-7 contain a variety of values.



     HOST Commands
     -------------
     Before a command may be sent to the Supervisory Controller, HOST must
     get the SC's attention. HOST sends an alert character ("!") to the SC
     and waits for a response. When the acknowledgement ("^") comes back,
     HOST may commence sending data to the SC. If the acknowledgement isn't
     received within a reasonable amount of time (within a second or so),
     HOST times out and alerts the user to the problem.


     New Time and Date
     -----------------
     Syntax:	#[FractSec][Sec][Min][Hr][DOW][Day][Mon][Yr][FFh]

     where:	[FractSec] = hundredths of seconds (0-99)
     		[Sec] = seconds (0-59)
     		[Min] = minutes (0-59)
     		[Hr] = hour (0-23)
     		[DOW] = day of week (1-7, 1 = Sunday)
     		[Day] = day of month (1-31)
     		[Mon] = month (1-12)
     		[Yr] = year (00-99)
     		[FFh] = terminates the data

     All values are sent in BCD.

     Example: "#", 00h, 00h, 45h, 15h, 03h, 07h, 04h, 92h, FFh

     The current date and time are set to Tuesday, April 7, 1992, 3:45 p.m.






     50                                   HCS II System Reference Manual

     New XPRESS Program
     ------------------
     Syntax:	=[NewProg]

     where:	[NewProg] = new XPRESS binary program

     The EVENTS.BIN file is read and every byte is sent to the SC without
     any attempt to interpret the data. After the last byte of the program
     has been sent to the SC, HOST waits for another acknowledgment ("^").
     If no acknowledgement is received within a reasonable amount of time
     (within a second or so), HOST times out and alerts the user. The lack
     of an acknowledgement indicates an error was detected during transmis-
     sion of the program. Both the new and old programs are thrown away by
     the SC and it enters an idle state.

     During compilation, a checksum is embedded in the binary XPRESS pro-
     gram and is used to verify the integrity of the program sent to the
     SC. It is also checked at power up to ensure memory wasn't corrupted
     by the cycling of power.


     Clear Log Memory
     ----------------
     Syntax:	%

     Before data may be logged to memory, the memory must be cleared, ei-
     ther from HOST by issuing the Clear command (a single percent charac-
     ter is sent to the SC) or by using the CLEARLOG command from within an
     XPRESS program. See Chapter 6 for more details.


     Dump Logged Data
     ----------------
     Syntax:	|

     In response to the dump command character (a single vertical bar), the
     SC immediately starts sending logged data to HOST. It is HOST's re-
     sponsibility to keep up with the incoming data and save it to disk
     when it's all been received. The data is terminated by a series of
     three FFh characters (such a series will never occur within the logged
     data, so is unique). The SC suspends all control activities while the
     transfer is in progress. A full data buffer (32K) will take approxi-
     mately 35 seconds to transfer at 9600 bps. See Chapter 6 for more
     details.














     HCS II System Reference Manual                                  51



























































     52                                   HCS II System Reference Manual