| 
| | | PicPuter 2.0 : Chapter 5 : Statements |
commands :
5.01 CONTNUE5.02 RUN [line_number]5.03 : {intel hex record}5.04 ; Comment
statements :
5.05 CLRB sram , sram|flash|const5.06 CLRPGM sram|flash|const [,] sram|flash|const5.07 CPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.08 DATA const5.09 DISASM sram|flash|const [, sram|flash|const]5.10 DO5.11 DUMP sram|flash|const [,] [sram|flash|const]5.12 END5.13 FOR sram = sram|flash|const TO sram|flash|const5.14
FPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.15 GETCHAR sram5.16 GOTO sram|flash|const [math sram|flash|const]5.17 GOSUB sram|flash|const [math sram|flash|const]5.18 HPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.19 IF sram|flash|const [math sram|flash|const] (RETurn|GOTo linenum|GOSub linenum)5.20 IHEX sram|flash|const [,] sram|flash|const5.21 INPUT sram5.22
LCDCMD var|reg|const5.23 LCDPOS var|reg|const5.24 LCPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.25 LFPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.26 LHPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.27 LPRINT "string" OR sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.28 LIST [var|reg|const] [,] [var|reg|const]5.29 NEXT var5.30
PAUSE sram [,] (tick|hun|sec|min|hour|adc|rx)5.31 POP sram5.32 PRINT "string" or sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf]5.33 PUSH sram|flash|const [math sram|flash|const]5.34 RETURN5.35 RANDOMIZE sram|flash|const [math sram|flash|const]5.36 SETB sram [,] sram|flash|const5.37 SYS sram|flash|const [math sram|flash|const]5.38 TRACE sram5.39
UNTIL sram|flash|const [math sram|flash|const]5.40 USER5.41 USR5.42 USR2 sram|reg|const [,] sram|reg|const5.43 USRM sram|flash|const [math sram|flash|const]5.44 WAIT sram [,] sram|reg|const5.45 WAITLO sram [,] sram|reg|const5.46 WHILE sram|flash|const [math sram|flash|const]
Commands |
Commands may only be used on the command line and may not be used as basic statements.
Continues program execution after a break has occurred.
This command resumes a basic program at the line following the PC value.
Also See : [ RUN | END ]
Internal Action:
__EVENT__ | = RUN_BIT;
PC++;
RUN PC;
[ index | memory |
math | statements | variables | registers | assembler ]
Runs a basic program.
If a line number is provided, basic begins running at that line number. If run is typed without any parameters, the basic program begins at statement #1.
Note: 'Autorun after reset' starts at statement 0.
Also See : [ CONTNUE | END ]
Internal Action:
__EVENT__ | = RUN_BIT;
PC=0;
GetNumber(PC);
RUN PC;
[ index | memory | math | statements | variables | registers | assembler ]
Intel Hex Record Writer.
The Colin command is used to interpret Intel Hex Record to write flash ram. If the record overwrites the PicPuter kernel $0000 - $1000 , the
bootloader must be used.
A status character is return for each Intel Hex Record record that is interpreted.
* - The Record was written
O - The Record is verified and does not need to be written.
C - Checksum Error, the checksum did not match.
A - Address error, either trying to overwrite the bootloader or odd address.
S - Size Error, odd sized or zero sized.
R - Range Error, the address beyond the end of flash ram $1FFF.
I - Info Error, an extended address record ignored by PicPuter.
? - Not an intel hex record.
[ index | memory | math | statements | variables | registers | assembler ]
Comment
PicPuter treats the semicolon as the end of line. Everything after a semicolon is ignored, so it is a useful way to comment PicPuter code. The comments are not stored inside or listed by PicPuter though.
[ index | memory | math | statements | variables | registers | assembler ]
| Statements |
All statements can either be used within a basic program or on the command line.
| 5.05 | CLRB sram &sbquo sram|flash|const |
Clear a single bit in a variable or register.
;Clear a single bit.
70 A=$FFFF
71 CLRB A , 0
72 ?$ A
Output:
$FFFE
;Disable All IRQS
70 CLRB INTCON , 7
Output:
Disables all IRQS, a watchdog reset
will occur if IRQs are not re-enabled.
Also See : [ SETB ]
Internal Action:
*sram |= 1<< bit;
[ index | memory | math | statements | variables | registers | assembler ]
| 5.06 | CLRPGM sram|flash|const &sbquo sram|flash|const |
Clears a range of basic program statements.
This statement deletes a range of basic lines. It should be used with care inside of a basic program since, well it deletes basic. There is no side effect if it deletes itself.
;Secret Message
70 a=10
75 do
80 PAUSE 1 SEC
85 A=A-1
90 ?A CRLF
95 WHILE A != 0
100 clrpgm 64 100
Output:
This program will self-destruct in 10 seconds.
[ index | memory | math | statements | variables | registers | assembler ]
| 5.07 | CPRINT sram|flash [op sram|flash] [SPace|CRlf|RETurn] |
Prints a single character to the serial port.
This command prints a single character to the serial port. The character printed is the lower 8 bits of any sram ,
flash or __CONSTANT__ location, as well as any math operation.
The optional command suffixes SPACE or CRLF are used to print a space or carriage return line feed afterwards. The optional RETURN suffix performs a return command following the statement.
If the CONFIGURATOR bit LCD_MIRROR is set then the output is also sent to the LCD character display.
70 A=65
71 CPRINT A
72 CPRINT A+1
73 CPRINT 67
Output:
ABC
Also See : [ LCPRINT | PRINT | HPRINT ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.08 | DATa sram|flash|const |
Prevents the listing of X number of basic statements.
When listed, it causes a gap to occur in the listing. Execution is currently undefined, but I will think of something.
[ index | memory | math | statements | variables | registers | assembler ]
| 5.09 | DISasm sram|flash|const [&sbquo sram|flash|const] |
Print out the range as assembler opcodes.
This statement is used to disassemble the contents of flash memory and display it as PIC assembly opcodes. The output of this command is the same as the input the built-in assembler requires. It is possible to use this command as a way to save an assembler program, or even a basic program.
;Disasm Helper
69 a=$0800
70 do
71 cprint 12 ; Clear screen, home cursor
72 b=a+16
73 disasm a , b
74 getchar c
76 a+=16
77 if c==65 return ; is it a capitol A
78 a=a-32
79 if c==66 return ; is it a capitol B
80 a+=16
81 return
Output:
Disassembles starting at $800.
(If A is pressed the next page is displayed.)
(If B is pressed the previous page is displayed.)
[ index | memory | math | statements | variables | registers | assembler ]
Pushes the program counter onto the stack.
This statement is used to create do WHILE , do UNTIL , and do
RETURN loops.
70 a=0
71 do
72 print a SPACE
73 a=a+1
74 while a < 10
Output:
0 1 2 3 4 5 6 7 8 9
;Loop Forever
70 a=0
71 do
72 print a SPACE
73 a=a+1
74 return
Output:
0 1 2 3 4 5 6 7 ... -2 -1 0 1 2 ...
Also See : [ WHILE | UNTIL | RETURN ]
Internal Action:
*SP++=PC
[ index | memory | math | statements | variables | registers | assembler ]
| 5.11 | DUMp var|reg|arr|flash|const [&sbquo var|reg|arr|flash|const]
|
Displays the value of flash memory.
The dump statement displays flash memory as table of hexadecimal values.
DUMP $0000 $003F
Output:
$0000: $2900 $2359 $2800 $28B6 $00FF $0E03 $0183 $00FE
$0008: $080A $00FC $018A $0804 $00FD $1C8C $2872 $108C
$0010: $146E $1DEF $285D $0EB8 $0838 $39F0 $0439 $0088
$0018: $3030 $0084 $0CB8 $0380 $1903 $11B8 $0A84 $0B80
$0020: $282D $0384 $1784 $0800 $1384 $0080 $1D03 $15B8
$0028: $0A84 $1784 $0800 $1384 $0080 $0A84 $1D84 $281A
$0030: $1783 $083A $1D03 $0BBE $2847 $0A3C $00BE $300C
$0038: $05B9 $1BBA $2841 $0D08 $3902 $1C88 $3801 $03BA
It should be noted that the output of the DUMP command can be used to write flash memory locations. This provides a convenient method to initialize memory with a table.
$1000: $0000 $0001 2 3 4 5
Output:
Flashes locations $1000-$1005 with 0 1 2 3 4 and 5.
[ index | memory | math | statements | variables | registers | assembler ]
Stops program execution.
If the CONTNUE command is entered at the command line, execution begins at the next line.
Example:
10 end
Effect:
a very boring program.
Also See : [ CONTNUE | __BREAK__ ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.13 | FOR sram=sram|flash|const to sram|flash|const |
The for part of a for next loop.
For next loops are used to repeat a number of statements a number of times. After each loop iteration the variable increments by one.
70 FOR A = 1 TO 10
75 PRINT A SPACE
80 NEXT A
Output:
1 2 3 4 5 6 7 8 9 10
Also See : [ FOR | NEXT ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.14 | FPRint sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf] |
Prints a value as an 8.8 fixed point value.
This command splits a 16 bit value into two 8 bit values. The upper eight bits are treated as the whole number. The lower 8 bits are treated as fraction and is converted from 0-255 to the range 0-99.
The maximum range for an 8.8 fixed point number is -127.99 to 127.99
Also See : [ PRINT | HPRINT | CPRINT ]
[ index | memory | math | statements | variables | registers | assembler ]
Gets a single and stores its value in a variable
Reads a single character from the serial port and stores its ascii value in a variable. If any control characters are encountered (ascii below 32 including, return, delete) the value 0 is returned.
70 GETCHAR A
75 CPRINT A
80 PRINT " = "
85 PRINT A CRLF
Also See : [ INPUT ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.16 | GOTO sram|flash|const [math sram|flash|const] |
Goto a specific line number.
Goto a specific line number, or indirectly through a variable or expression.
60 A=60
70 PRINT A SPACE
80 GOTO A
Output:
10 10 10 ...
Also See : [ GOSUB | IF ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.17 | GOSUB sram|flash|const [math sram|flash|const] |
Push the return address on the stack then goto a specific line number.
Push the return address on the stack then goto a specific line number or indirectly through a variable or expression.
70 gosub 50
71 print a + 1
72 end
73 a=10
74 print a
75 return
Output:
10 11
70 A=RND & $07
71 gosub A+90
72 print a
73 end
99 return
Output:
(random, 0 - 7)
[ index | memory | math | statements | variables | registers | assembler ]
| 5.18 | HPRint sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf] |
Prints a number in hexidecimal.
An optional command suffix allow a SPACE or CRLF to be printed after the expression. The optional RETURN suffix performs a return command following the statement.
70 A=$0400
75 ? A SPACE
80 ?$ A
Output:
1024 $0400
Also See : [ PRINT | FPRINT | CPRINT ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.19 | IF condition RETURN|GOTO|GOSUB linenumber |
Conditional goto or gosub a linenumber.
If the expression is true then the goto or gosub is taken, otherwise the next statement is executed.
70 a=10
75 PRINT A
80 A=A+1
85 IF A!=14 GOTO 75
Output:
10 11 12 13
Also See : [ GOTO | GOSUB | RETURN ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.20 | IHEX sram|flash|const &sbquo sram|flash|const |
Prints memory range as Intel hex records.
This command displays a range of memory as industry standard Intel Hex Record. These text records may be saved to backup the contents of flash memory. The output of this command can be used to write flash memory. This may be done either on the command line, or in the bootloader .
[ index | memory | math | statements | variables | registers | assembler ]
Inputs a number into a variable.
This statement inputs a number into variable. The number may be expressed as a signed decimal or hexidecimal value.
Also See : [ GETCHAR ]
[ index | memory | math | statements | variables | registers | assembler ]
| 5.22 | LCDPos sram|flash|const [math sram|flash|const] |
Moves the cursor of the lcd display.
71 LCDPOS 6
72 lprint "World"
73 LCDPOS 0
74 lprint "Hello "
Output:
Hello World
Also See : [ LCDCMD | LPRINT | LHPRINT | LFPRINT | LCPRINT ]
[ index | memory | math | statements | variables | registers | assembler ]
|
5.23 | LCDCMD sram|flash|const [math sram|flash|const] |
Sends a command to the lcd display.
LCD displays have special commands to clear the screen, move the position of the cursor, home the cursor or create a custom character. Clearing the screen or homing the cursor can also be done by printing the characters 12 and 11 respectively. The LCDCMD and LCPRINT allows full access to the lcd display.
;Clear LCD screen 3 ways
71 LCDCMD 1
72 LPRINT "\12"
73 LCPRINT 12
;Create a custom character
71 LCPRINT 0
72 LCDCMD $40
73 LPRINT "\$0E\$11\$80\$80"
74 LPRINT "\$11\$0E\$80"
75 LCDCMD $80
(BUG) The values 0, 10, 11, 12, 13 can not be printed because they are interpreted as control characters. The workaround is to set an unused bit. EG. $00 becomes $80.
Also See : [ LCDPOS | LPRINT | LHPRINT | LFPRINT | LCPRINT ]
[ index | memory | math | statements | variables | registers |
assembler ]
| 5.24 | LCPRINT sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf] |
Prints a character to the lcd display.
The character is only printed to the lcd display. The _CONFIGURATOR_ LCD bit must be set for the LCD to operate. An optional command suffix allow a SPACE or CRLF to be printed after the expression. The optional return suffix performs a return command following the statement.
70 Z=65
71 LCPRINT Z
72 LCPRINT Z+1
73 LCPRINT 67
Output:
ABC
Also See : [ LPRINT | LHPRINT | LFPRINT | LCDCMD | LCDPOS ]
[ index | memory | math | statements | variables | registers | assembler ]
|
5.25 | LFPrint sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf] |
Also See : [ LPRINT | LHPRINT | LCPRINT | LCDCMD | LCDPOS ]
[ index | memory | math | statements | variables | registers |
assembler ]
| 5.26 | LHPrint sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf] |
Prints a number in hexidecimal to the lcd display.
The hexadecimal number is only printed to the lcd display. The _CONFIGURATOR_ LCD bit must be set for the LCD to operate. An optional command suffix allow a SPACE or CRLF to be printed after the expression. The optional return suffix performs a return command following the statement.
70 A=$0400
71 LPRINT A SPACE
72 LHPRINT A
Output:
1024 $0400
Also See : [ LPRINT | LFPRINT | LCPRINT | LCDCMD | LCDPOS ]
[ index | memory | math | statements | variables | registers | assembler ]
|
5.27 | LPRINT "string"| sram|flash|const [math sram|flash|const] [RETurn|SPace|CRlf] |
Prints a number or a string constant to the lcd display.
The expression is only printed to the lcd display. The _CONFIGURATOR_ LCD bit must be set for the LCD to operate. An optional command suffix allow a SPACE or CRLF to be printed after the expression. The optional return suffix performs a return command following the statement. Strings are limited to 6 characters in length.
70 lprint "Hello" SPACE
71 lprint "World" CRLF
Output:
Hello World
70 A=6
71 LPRINT A - 6 SPACE
72 LPRINT A
Output:
0 6
Also See : [ LHPRINT | LFPRINT | LCPRINT | LCDCMD | LCDPOS ]
[ index | memory | math | statements | variables | registers | assembler ]
|
5.28 | LIst [sram|flash|const] &sbquo [sram|flash|const] |
Lists the current program
The current program can be displayed using the list command. If two parameters are given, then the command will only list the lines in between, provided the second parameter is greater than the first. The list command can also be used with variables or as a program statement.
LIST ; entire program.
LIST 1 3 ; statements 1 through 3
LIST 1 A ; statements 1 through the value of a
[ index | memory | math | statements | variables | registers | assembler ]
the Next part of a for next loop.
Does the Next part of a for next loop.
[ index | memory | math |
statements | variables | registers | assembler ]
| 5.30 | PAUSE sram|flash|const &sbquo tick|hun|sec|min|hour|adc|rx|user |
Waits for a specified event to occur.
Waits for a specified event. The number is used to pause multiple times.
70 PAUSE 1 sec
Output:
delays 1 second
70 PAUSE 50 hun
Output:
delays .5 seconds
71 PAUSE 1 ADC
72 PRINT ADC0 SPACE
73 PRINT ADC1 SPACE
74 PRINT ADC2 SPACE
75 PRINT ADC3 CRLF
76 GOTO 71
Output:
Displays the ADC values after each conversion
[ index | memory | math | statements | variables | registers | assembler ]
Pops a 16 bit value from the stack.
Internal Action:
*sram = *SP++;
Also See : [ POP ]
[ index |
memory | math | statements | variables | registers | assembler ]
| 5.32 | [PRINT | ?] expression [RETurn|SPace|CRlf] |
Prints a number or a string constant.
An optional command suffix allow a SPACE or CRLF to be printed after the expression. The optional RETURN suffix performs a return command following the statement. Strings are limited to 6 characters in length. The print statement mayalso be contracted to '?'.
70 print "Hello "
80 print "World" CRLF
Output:
Hello World
70 A=6
75 PRINT A - 6 SPACE
80 PRINT A
Output:
0 6
70 print "Hello"
75 print "\13\10"
80 ? "\$d\$a"
85 print "World" CRLF
Output:
Hello
World
70 A=RND & 7
75 GOSUB 90 + A
80 END
90 ? "red" RETURN
91 ? "yellow" RETURN
92 ? "blue" RETURN
93 ? "orange" RETURN
94 ? "purple" RETURN
95 ? "green" RETURN
96 ? "black" RETURN
97 ? "white" RETURN
[ index | memory | math | statements | variables | registers | assembler ]
| 5.33 | PUSH sram|flash|const [math sram|flash|const] |
Push a 16 bit value on the stack.
Internal Action:
*SP-- = value;
Also See : [ POP ]
[
index | memory | math | statements | variables | registers | assembler ]
Return from a subroutine.
70 gosub 90
75 print a + 1
80 end
90 a=10
95 print a space
99 return
Output:
10 11
Also See : [ DO | GOSUB ]
Internal Action:
PC=*SP++;
[ index | memory | math | statements | variables | registers | assembler ]
| 5.35 | RANDomize sram|flash|const [op] [sram|flash|const] |
Increases the randomness of the random number generator
This command is used runs a specific number of itterations of the random bit stream. The variable RND will automatically be modified twice every 1uS if the CONFIGURATOR RANDOM bit is set. If the bit is clear, RND will not change unless the RANDOMIZE command is issued. This is usefull if you want to create a specific recreatable pattern of random numbers.
[ index | memory | math | statements | variables | registers | assembler ]
| 5.36 | SETb sram &sbquo sram|flash|const |
Sets a single bit in a variable or internal register
10 A=0
20 SETB A , 2
30 print A
Output:
4
Example: (Disable All IRQS)
10 CLRB INTCON , 7
Output:
Disables all IRQS , a watchdog reset
will occur if IRQs are not reenabled.
Also See : [ CLRB ]
Internal Action:
*sram |= (1<< bit);
[ index | memory | math | statements | variables | registers | assembler ]
| 5.37 | SYS sram|flash|const [math sram|flash|const] |
Calls an assembly routine.
A native assembly routine is called at the specified address. The register __STATUS__ is cleared and __PCLATH__ is modified before entering the routine.
10 sys $110
Output:
calls the pic assembly routine at $110, the bootloader.
Internal Action:
CLRF __STATUS__
CALL value
[ index | memory | math | statements | variables | registers | assembler ]
Trace a variable
This command is useful for debugging. It allows you to print out a
variables or registers whenever program execute stops.
[ index | memory | math | statements | variables | registers | assembler ]
| 5.39 | UNTil sram|flash|const [math sram|flash|const] |
Do Until Loop.
A do-until loop allows you to repeat a number of statements until a condition is true.
70 A = 0
71 DO
72 A = A + 1
73 PRINT A SPACE
74 UNTIL A > 5
Output:
1 2 3 4 5 6
Also See : [ DO | UNTIL | WHILE ]
Internal Action:
if (condition false) {pop pc ; push pc}
else SP--
[ index | memory | math | statements | variables | registers | assembler ]
User Information.
The USER command displays the user information if PicPuter has been registered. Its there to make registered users think about giving away copies with there name address and email in it. Of course, this only works during the first copy, so I can disable a group of keys bases on a number of parameters in future updates if need be. But please just register your PicPuter, it is fast and cheap, and I lose money on PicPuter each year.
[ index | memory | math | statements | variables | registers | assembler ]
User command.
The usr command is used to extend the PicPuter Basic Language. When this command is interpreted, the assembly routine at $1005 is executed. This command takes no parameters.
Also See : [ USR | USR2 | USRM ]
Internal Action:
CALL $1005
[ index | memory | math |
statements | variables | registers | assembler ]
| 5.42 | USR2 sram|flash|const &sbquo sram|flash|const |
User command with 2 patameters.
The usr2 command is used to extend the PicPuter Basic Language. When this command is interpreted, the assembly routine at $1006 is executed. This command takes two parameters whos value is passed in $TBD and $TBD.
Also See : [ USR | USR2 |
USRM ]
Internal Action:
CALL ADDRESSING
CALL $1006
[ index | memory | math | statements | variables | registers | assembler ]
| 5.43 | USRM sram|flash|const [op] [sram|flash|const] |
User command with math parameter.
The usrm command is used to extend the PicPuter Basic Language. When this command is interpreted, the assembly routine at $1007 is executed. This command take either one parameter or math expression. Its value is passed in $F0 LSB and $F1 MSB.
Also See : [ USR | USR2 | USRM ]
Internal Action:
CALL ADDRESSING
CALL MATH
CALL $1007
[ index | memory | math | statements | variables | registers | assembler ]
| 5.44 | WAIT sram &sbquo sram|flash|const |
Waits until a bit reads as one.
This command only works on 8 bit data. The sram location and the bit-mask are truncated to 8 bits. If you want to wait on the upper 8 bits of a 16 bit value, use the 'h' modifier.
70 SETB TRISC , 4 ; Set PortC.4 as an input
71 SETB TRISC , 5 ; Set PortC.4 as an input
72 WAIT PORTC , $30
Output:
Waits until PORTC pin 4 or 5 is HI.
Also See : [ PAUSE | WAIT | WAITLO ]
Internal Action:
while ~(*sram & bitmask) {MPU_USAGE++;clrwdt;}
[ index | memory | math | statements | variables | registers | assembler ]
| 5.45 | WAITLo
sram &sbquo sram|flash|const |
Wait until a specific bit reads as zero.
This command only works on 8 bit data. The sram location and the bit-mask are truncated to 8 bits. If you want to wait on the upper 8 bits of a 16 bit value, use the 'h' modifier.
70 SETB TRISC , 4 ; Set PortC.4 as an input
71 WAITLO PORTC , $10
72 PRINT "Press" CRLF
Output:
Pauses execution until PORTC.4 is LO
Also See : [ PAUSE | WAIT | WAITLO ]
Internal Action:
while ~((~*sram) & bitmask) {MPU_USAGE++;clrwdt;}
[ index | memory | math | statements | variables | registers | assembler ]
| 5.46 | WHIle
sram|flash|const [math sram|flash|const] |
Do While Loop.
A do-while loop allows you to repeat a number of statements while the condition holds true.
70 A = 0
71 DO
72 A = A + 1
73 PRINT A
74 WHILE A < 5
Output:
1 2 3 4 5
Also See : [ DO | UNTIL | WHILE ]
Internal Action:
if (condition true) {pop pc ; push pc}
else SP--;
[ index | memory | math | statements | variables | registers | assembler ]
|
