Tiny Machine Basic for the RC51 Programmable Relay Controller

Reference Manual for Version 1.3

Industrologic, Inc.
3201 Highgate Lane
St. Charles, MO
63301
USA

Phone: (636) 723-4000
www.industrologic.com
info@industrologic.com




Trademark and Copyright Information

Tiny Machine Basic and TMB are Trademarks of Industrologic, Inc. 2002
This document is Copyright (c) 2002 by Industrologic, Inc.
All rights reserved.

No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying or scanning, for any purpose other than the personal use by the purchaser of this product. Industrologic, Inc. reserves the right to revise this document at any time without obligation to notify any person of such revision. Industrologic, Inc. assumes no responsibility for any errors that may appear in this document.

Warning/Disclaimer

Whereas effort has been made to make the information in this document as useful and accurate as possible, Industrologic, Inc. assumes no responsibility for the application, usefulness, or completeness, of the information contained herein. Under no circumstance will Industrologic, Inc. be responsible or liable for any damages or losses including indirect or consequential damages or losses arising from either the use of any information contained within this manual or the use of any products or services referenced within this manual.


Overview and General Information

Tiny Machine Basic for the RC51 (TMB-RC51) is a simple BASIC language interpreter with a limited syntax and list of instructions. TMB-RC51 is not so much a high level language like most BASIC interpreters, but is a cross between BASIC and machine language. It has been written specifically for the 8 bit structure of the Intel 8051 instruction set compatible families of microcontrollers, and for program storage in a small serial EEPROM.

TMB-RC51 includes features that make it easy to write and understand bit manipulation programs. When entering programs it will understand values entered in decimal or hexadecimal as well as single byte character strings. It also features commands that can change the display of number values from decimal to hexadecimal.

Instructions entered while programming are saved as two-byte tokenized instructions, not as BASIC source code, therefore, all instruction arguments and line numbers are limited to a single byte (values from 0 to 255). Values that exceed this limit at run time will "roll over" or "roll under" back to a byte value, and will not cause a run-time error. Similarly, instructions that use a limited range of values and are given values outside that range will not cause a run-time error, but will either ignore the instruction or convert the illegal value to a legal value.

A "command" consists of an instruction and its single byte "argument", and will be performed as soon as entered. A program line entry consists of a number from 1 to 255, a space, an instruction, and a single byte argument. Lower case characters are converted to upper case when typed since all instructions must be in upper case. Line numbers and arguments are always a single byte and can be entered as decimal values, e.g. x xx xxx xD xxD xxxD, hexadecimal values, e.g. xH xxH, or quoted single character strings, e.g. "x".

Instructions that manipulate the I/O port bits of the microcontroller must be used in ways that are compatible with the port hardware. If any port bit is to be used as an input, it must be set to a logic level "high" state, or "1". (On power up the port pins are set high.)

Comments may be added to program files created and saved on a host computer and uploaded, but the program saved in the RC51 will not contain comments. Comments must be on separate lines, and any line that does not begin with a program line number may be a comment. When comment lines are sent to the RC51 during program upload, syntax errors occur, and the lines are ignored.


Variables

The following is a list of variables in TMB-RC51 which are byte values that can be read or assigned values by the user program.

A,B,C,D,E   general purpose byte variables where certain operations are performed
F,G,H,M,S   and where the results of certain operations are stored
The following is a list of byte variables that can be read and displayed, but cannot be assigned values by the user program. The user program must read KEY and INT often enough to insure that they contain current and valid values.

KEY    the ASCII value of the last character received at Serial
       Port 1 (cleared after being read)
       (See Appendix A for a table of these values)
INT    the number of low going pulses that have occurred at
       digital IO INT (cleared after being read)
(A)    a special description of variable A used to display the ASCII
       character rather than the numeric value

Instructions

The following is a list of instructions where [arg] is an argument to the instruction in the form of a byte variable, number, or ASCII character.

The command instructions will normally be used only as a command at the prompt, and the rest of the instructions will normally be used in a program, but may be used as a command at the prompt to see how the instruction works.

Command instructions:

BAUD=[arg]     Set baud rate of serial port to [arg] times 100, and save in
               EEPROM. Allowable values are 192, 96, 48, 24, 12, 6, 3. (If you
               change the baud rate in TMB-RC51, you will also need to change it
               in your terminal software!)

Example:
BAUD=96        set serial port baud rate to 9600


BOOTON         Run your program when TMB-RC51 starts (i.e., on power up)
BOOTOFF        Turn off the BOOTON feature (both are saved in EEPROM)
Note: The BOOTON feature can be overridden by pressing the pushbutton switch SW1 while power is applied to the RC51. TMB-RC51 will then return a prompt at 9600 baud (regardless of the baud rate specified with the BAUD instruction).

NEW            Erase all program lines
LIST           Display the program lines (if there are more than 20 lines the
               listing will pause until you press a key)
RUN            Run the program from the command prompt (>)
END            Stop the program and return to the prompt
The program can be stopped with the END instruction, by having no further lines to execute, (possibly by going to a non-existant line number above the rest of the lines), or by telling the program to go to line zero. If the program does not have a method of exiting in response to some program condition, the power will need to be cycled to return to the prompt.

Control and Program Flow instructions:

DELAY [arg]    Pause the program for [arg] tenths (1/10) of a second
GOTO [arg]     Jump to the instructions beginning at line number [arg]
GOSUB [arg]    Call subroutine at line number [arg] (1 layer deep only)
RETURN         Return to next instruction after the last GOSUB
LOOP [arg]     Begin a loop with [arg] iterations (1 layer deep only)
ENDLOOP        Terminate a loop
Subroutines and loops may only be one layer deep, that is, a subroutine may not contain another GOSUB instruction, and an ENDLOOP instruction must be performed before another LOOP instruction is performed.


Examples:
DELAY 255      delay 25.5 seconds

1 GOSUB 10     call subroutine at line 10
2 GOTO 1       jump to line 1
10 PRINT "A"   send an upper case A to the serial port
11 RETURN      jump to line following the GOSUB instruction

10 GOSUB A     call subroutine at the line number of the value of variable A
               (if the value of A is 20 it would be the same as GOSUB 20)

1 LOOP 255     start a loop of 255
2 PRINT "A"    send an upper case "A" to the serial port
3 ENDLOOP      jump back to line 2 until 255 loops have been done

Display and Keyboard instructions (Serial Port):

PRINT [arg]    Display a byte value in decimal/hexadecimal, or as character
               (This instruction sends characters out the serial port)
               See Appendix A for a table of these values

The PRINT instruction does not include a carriage return/line feed sequence (13D/10D or 0DH/0AH) after displaying a value or character like most BASIC languages. If either of these characters are desired they will need to be displayed separately. The PRINT instruction, when in HEX mode, will always display values with two digits followed by "H".

Lower case characters are converted to upper case when typed since all instructions must be in upper case. If a lower case displayable character is used as a value argument, the ASCII code must be used since it cannot be enclosed in quotes. For example, to print an "a" you must use PRINT 97 or PRINT 61H.

HEX            Display values in hexadecimal (try this at the command prompt)
DECIMAL        Display values in decimal (returns it to normal)
INPUT [arg]    Wait for a value to be entered (followed by a carriage return) and
               then put the value in [arg]. (This instruction waits for characters
               from the serial port)
               See Appendix A for a table of these values

The ESCAPE key will cancel value entry with the INPUT instruction, (but not stop the program)


Examples:
PRINT 0DH      send a carriage return to the serial port
PRINT 13       send a carriage return to the serial port
PRINT 0AH      send a line feed to the serial port
PRINT 10       send a line feed to the serial port
PRINT "A"      send an upper case A to the serial port
PRINT 65       send an upper case A to the serial port
PRINT 97       send a lower case A to the serial port
INPUT A        wait for a value and then set variable A to that value
 
A=66           ASCII code for 'B"
PRINT (A)      send ASCII character "B" to serial port

Variable Manipulation instructions:

A=[arg]        Set byte variable A to [arg]
A=A+[arg]      Add the value in [arg] to variable A
A=A-[arg]      Subtract the value in [arg] from variable A
A=A*[arg]      Multiply variable A by the value in [arg]
A=A/[arg]      Divide variable A by the value in [arg], (remainder is discarded)
A=A\[arg]      Remainder of dividing variable A by the value in [arg]

IF A=0 [arg]   If variable A is zero jump to line number [arg]
IF A<>0 [arg]  If variable A is not zero jump to line number [arg]
IF A=B [arg]   If variable A equals variable B jump to line number [arg]
IF A<>B [arg]  If variable A does not equal variable B jump to line number [arg]
IF A<B [arg}   If variable A is less than variable B jump to line number [arg]
IF A>B [arg]   If variable A is greater than variable B jump to line number [arg]


Examples:
A=KEY          get value of last character at Serial Port 1
A=A-66         subtract the ASCII value for "B", which is 66
IF A=0 30      if character was "B" then jump to line 30

A=A+B          add the value of variable B to variable A
A=A+10         add 10 to variable A (e.g., if A contained 10 it would
               become 20, if A contained 255 it would roll over to 9)
A=A-1          subtract 1 from A (e.g., if A contained 2 it would
               become 1, if A contained 0 it would roll under to 255)
A=A*10         multiply variable A by 10 (e.g., if A contained 10 it would
               become 100, if A contained 30 it would roll over to 44)
A=A/5          divide variable A by 5 (e.g., if A contained 10 it would
               become 2, if A contained 202 it would become 40)
A=A\7          divide variable A by 7 and return the remainder in variable A
               (e.g., if A contained 10 it would become 3, if A contained 21 it
               would become 0)

IF A=0 10      if variable A is equal to 0 then jump to line 10
IF A<>0 15     if variable A is not equal to 0 then jump to line 15
IF A<B 20      if variable A is less than variable B then jump to line 20

Relay, Digital I/O, Switch, and LED instructions:

RELAY1=[arg]   Turn on Relay1 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY2=[arg]   Turn on Relay2 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY3=[arg]   Turn on Relay3 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY4=[arg]   Turn on Relay4 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY5=[arg]   Turn on Relay5 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY6=[arg]   Turn on Relay6 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY7=[arg]   Turn on Relay7 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])
RELAY8=[arg]   Turn on Relay8 if [arg] is 1, turn it off if 0 (uses bit 0 of [arg])

RELAYS=[arg]   Change on/off status of all relays based on [arg], where
               Relays 8-1 are controlled by bits 7-0 of [arg] respectively


DO1=[arg]      Set digital I/O #1 high if [arg] is 1, low if 0 (uses bit 0 of [arg])
DO2=[arg]      Set digital I/O #2 high if [arg] is 1, low if 0 (uses bit 0 of [arg])
DO3=[arg]      Set digital I/O #3 high if [arg] is 1, low if 0 (uses bit 0 of [arg])
INT=[arg]      Set digital I/O INT high if [arg] is 1, low if 0 (uses bit 0 of [arg])
LED=[arg]      Turn on LED if [arg] is 1, turn off if 0 (uses bit 0 of [arg])
If any digital I/O is to be used as an input, it must be set high, (its power up setting.)

IF DI1=0 [arg]   If digital I/O #1 is low jump to line number [arg]
IF DI1=1 [arg]   If digital I/O #1 is high jump to line number [arg]
IF DI2=0 [arg]   If digital I/O #2 is low jump to line number [arg]
IF DI2=1 [arg]   If digital I/O #2 is high jump to line number [arg]
IF DI3=0 [arg]   If digital I/O #3 is low jump to line number [arg]
IF DI3=1 [arg]   If digital I/O #3 is high jump to line number [arg]
IF INT=0 [arg]   If digital I/O INT is low jump to line number [arg]
IF INT=1 [arg]   If digital I/O INT is high jump to line number [arg]
IF SW1=0 [arg]   If switch SW1 is low (pressed) jump to line number [arg]
IF SW1=1 [arg]   If switch SW1 is high (not pressed) jump to line number [arg]


Example:
DO1=1          set digital I/O high for use as an input
IF DI1=0 100   if digital input #1 is low jump to line number 100

Timer instructions

TMB-RC51 includes four software countdown timers that can be individually set for periods of up to 255 hours, 255 minutes, or 255 seconds. Unlike the DELAY instruction, which pauses the program while waiting for the time to elapse, the countdown timers can be set, and will then run in the background. They can then be tested periodically while the program continues to see if they have timed out.
SETTIMER 1          set timer #1 from the values in variables H, M, and S
                    where H=hours, M=minutes, and S=seconds
SETTIMER 2          set timer #2
SETTIMER 3          set timer #3
SETTIMER 4          set timer #4

CLEARTIMER 1        turn off timer #1 so that it can no longer cause a timeout
CLEARTIMER 2        turn off timer #2 so that it can no longer cause a timeout
CLEARTIMER 3        turn off timer #3 so that it can no longer cause a timeout
CLEARTIMER 4        turn off timer #4 so that it can no longer cause a timeout

IF TIMER1=0 [arg]   If timer #1 has not timed out jump to line number [arg]
IF TIMER1=1 [arg]   If timer #1 has timed out jump to line number [arg]
IF TIMER2=0 [arg]   If timer #2 has not timed out jump to line number [arg]
IF TIMER2=1 [arg]   If timer #2 has timed out jump to line number [arg]
IF TIMER3=0 [arg]   If timer #3 has not timed out jump to line number [arg]
IF TIMER3=1 [arg]   If timer #3 has timed out jump to line number [arg]
IF TIMER4=0 [arg]   If timer #4 has not timed out jump to line number [arg]
IF TIMER4=1 [arg]   If timer #4 has timed out jump to line number [arg]


Example:
H=0                 zero hours
M=30                30 minutes
S=0                 zero seconds
SETTIMER 1          set timer #1 to timeout after 30 seconds

IF TIMER1=1 100     if timer #1 times out go to line number 100

Real-Time Clock instructions:

TMB-RC51 includes a real-time clock that can be both set and read. Since the RC51 does not have a battery backup system the clock will not retain its time if power is removed. When power is applied the clock will be set to zero hours, minutes, and seconds, and will begin keeping time even if a program is not running. The time can then be set if desired at the prompt or when a program is running. Since the clock is software based, its accuracy is dependent on components on the RC51 board and will vary from unit to unit. Adjustments can be made in the program to improve accuracy on a particular board.

SETCLOCK            set clock from the values in variables H, M, and S
                    where H=hours, M=minutes, and S=seconds
READCLOCK           read clock and place the values into variables H, M, and S
                    where H=hours, M=minutes, and S=seconds

Examples:
H=23                23 hundred hours
M=0                 zero minutes
S=0                 zero seconds
SETCLOCK            set clock to 11PM even

READCLOCK           read clock values
PRINT H             display hours
PRINT ":"
PRINT M             display minutes
PRINT ":"
PRINT S             display seconds

EEPROM instructions:

Part of the EEPROM used to store the user program can also be used to store program data such as configuration information that must be saved if the power is removed from the RC51. EEPROM addresses 1 through 255 correspond to TMB-RC51 line numbers 1 through 255. Using an EEPROM address will cause it to not be available for program line storage and will overwrite any program line stored there. Likewise, entering a program line at an EEPROM address will overwrite the data stored there.

When data is written to an EEPROM address, it is likely that the data will represent program instructions and arguments, which TMB-RC51 will attempt to RUN and LIST. In order to prevent the program from running this data as an instruction, an END instruction must be placed at a line number lower than any data address used so that the program will stop before reaching the data. If this is not done, the program may do any number of undesirable things, e.g., erasing itself or changing the baud rate unexpectedly. It is also suggested that the highest possible EEPROM addresses be used for data so that it is LISTED after the normal program lines.

Most EEPROMs may be written over a million times, but even this limit could be exceeded if the program wrote to the EEPROM in an unintended loop caused by incorrect programming, so some caution should be used. EEPROMs may be read an unlimited number of times.

WRITEEE [arg]  Write the 2 byte values in variables A and B to the EEPROM word at
               address [arg], where [arg] is an address from 1 to 255

READEE [arg]   Read the EEPROM word at address [arg] and put the 2 byte values in
               variables A and B, where [arg] is an address from 1 to 255

Examples:
A=FFH          set variable A value
B=FFH          set variable B value
WRITTEE 250    write A and B to memory location 250
READEE 255     read memory location 255 and place in variables A and B

Host computer instructions:

When the RC51 is used with a host computer as an RS-232 serial data acquisition and control board, its relays and digital outputs can be set using the same commands and syntax that are used when running a Tiny Machine Basic program. The following commands allow the host computer to read the values and status of the inputs and outputs in a similar manner.

STATUS        Display values and status of inputs and outputs in the format:
              RR DD CC KK
              where:
              RR = status of Relays 8-1 (bits 7-0) in 2 hexadecimal digits (00-FF)
              DD = status of SW1 (bit 4), INT (bit 3), and digital inputs
              3-1 (bits 2-0) in 2 hexadecimal digits (00-FF)
              CC = value of the variable INT (count) in 2 hexadecimal digits (00-FF)
              KK = value of the variable KEY in 2 hexadecimal digits (00-FF)

Appendix A

The following is a table of character codes and their equivalent (ASCII) characters. These values are useful when using the PRINT instruction or when testing variables (like the variable KEY) for a specific character.

Decimal          Control Char. Control      Decimal               Decimal
Value   Character  Abbreviation  Key        Value   Character     Value   Character
-------------------------------------------------------------------------------------------
00      NULL                NUL  ^@         45      - (hyphen)    90      Z    
01      START OF HEADING    SOH  ^A         46      . (period)    91      [ (left bracket)
02      START OF TEXT       STX  ^B         47      /             92      \ (backslash)
03      END OF TEXT         ETX  ^C         48      0             93      ] (right bracket)
04      END OF TRANSMIT     EOT  ^D         49      1             94      ^ (carat)
05      ENQUIRY             ENQ  ^E         50      2             95      _ (underscore)
06      ACKNOWLEDGE         ACK  ^F         51      3             96      ` (accent)
07      BEEP                BEL  ^G         52      4             97      a
08      BACK SPACE          BS   ^H         53      5             98      b
09      HORIZONTAL TAB      HT   ^I         54      6             99      c
10      LINE FEED           LF   ^J         55      7             100     d
11      VERTICAL TAB        VT   ^K         56      8             101     e
12      FORM FEED           FF   ^L         57      9             102     f
13      CARRIAGE RETURN     CR   ^M         58      :             103     g
14      SHIFT OUT           SO   ^N         59      ;             104     h
15      SHIFT IN            SI   ^O         60      <             105     i
15      DEVICE LINK ESC     DLE  ^P         61      =             106     j
17      DC1 X-ON            DC1  ^Q         62      >             107     k
18      DC2                 DC2  ^R         63      ?             108     l
19      DC3 X-OFF           DC3  ^S         64      @             109     m
20      DC4                 DC4  ^T         65      A             110     n
21      NEG. ACKNOWLEDGE    NAK  ^U         66      B             111     o
22      SYNC. IDLE          SYN  ^V         67      C             112     p
23      END OF TX BLOCK     ETB  ^W         68      D             113     q
24      CANCEL              CAN  ^X         69      E             114     r
25      END MEDIUM          EM   ^Y         70      F             115     s
26      SUBSTITUTE          SUB  ^Z         71      G             116     t
27      ESCAPE              ESC             72      H             117     u
28      RIGHT ARROW (on PC)                 73      I             118     v
29      LEFT ARROW  (on PC)                 74      J             119     w
30      UP ARROW    (on PC)                 75      K             120     x
31      DOWN ARROW  (on PC)                 76      L             121     y
32      BLANK SPACE                         77      M             122     z
33      !                                   78      N             123     { (left brace)
34      " (double quote)                    79      O             124     | (vertical bar) 
35      # (number sign)                     80      P             125     } (right brace)
36      $                                   81      Q             126     ~ (tilde)
37      %                                   82      R             127     DELETE
38      &                                   83      S
39      ' (single quote)                    84      T
40      ( (open parenthesis)                85      U
41      ) (close parenthesis)               86      V
42      *                                   87      W
43      +                                   88      X
44      , (comma)                           89      Y


end of manual
log file