Manual Picbasic

PicBasic Pro Compiler
COPYRIGHT NOTICE Copyright 2004 m icroEngineering Labs, Inc. All rights reserved. This m anual describes the use and operation of the PicBasic Pro Com piler from m icroEngineering Labs, Inc. Use of the PicBasic Pro Com piler without first obtaining a license is a violation of law. To obtain a license, along with the latest version of the product and docum entation, contact m icroEngineering Labs, Inc. Publication and redistribution of this m anual over the Internet or in any other m edium without prior written consent is expressly forbidden. In all cases this copyright notice m ust rem ain intact and unchanged. m icroEngineering Labs, Inc. Box 60039 Colorado Springs CO 80960-0039 (719) 520-5323 (719) 520-1867 fax em ail: support@ m elabs.com web: www.m elabs.com
microEngineering Labs, Inc.
TRADEM ARKS EPIC and PicBasic Pro are tradem arks of m icroEngineering Labs, Inc. BASIC Stam p is a tradem ark of Parallax, Inc. PICm icro is a registered tradem ark of Microchip Technology Inc.
microEngineering Labs, Inc.
3/04
PicBasic Pro Compiler TABLE OF CONTENTS 1. Introduction . . . . . . . . . . . . . . . 1.1. The PICm icro MCUs 1.2. About This Manual . 1.3. Sam ple Program s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1 2 3
PicBasic Pro Compiler 4.5. Arrays . . . . . . . . . . . . . . . . . . . 4.6. Constants . . . . . . . . . . . . . . . . 4.7. Sym bols . . . . . . . . . . . . . . . . . 4.8. Num eric Constants . . . . . . . . 4.9. String Constants . . . . . . . . . . 4.10. Ports and Other Registers . . 4.11. Pins . . . . . . . . . . . . . . . . . . . 4.12. Com m ents . . . . . . . . . . . . . . 4.13. Multi-statem ent Lines . . . . . . 4.14. Line-extension Character . . . 4.15. INCLUDE . . . . . . . . . . . . . . . 4.16. DEFINE . . . . . . . . . . . . . . . . 4.17. Math Operators . . . . . . . . . . 4.17.1. Multiplication . . . . 4.17.2. Division . . . . . . . . 4.17.3. Shift . . . . . . . . . . . 4.17.4. ABS . . . . . . . . . . . 4.17.5. COS . . . . . . . . . . . 4.17.6. DCD . . . . . . . . . . . 4.17.7. DIG . . . . . . . . . . . . 4.17.8. DIV32 . . . . . . . . . . 4.17.9. MAX and MIN . . . . 4.17.10. NCD . . . . . . . . . . 4.17.11. REV . . . . . . . . . . 4.17.12. SIN . . . . . . . . . . . 4.17.13. SQR . . . . . . . . . . 4.17.14. Bitwise Operators 4.18. Com parison Operators . . . . 4.19. Logical Operators . . . . . . . . . 5. PicBasic Pro Statem ent Reference 5.1. @ . . . . . . . . . . . . . . . . . . 5.2. ADCIN . . . . . . . . . . . . . . 5.3. ASM..ENDASM . . . . . . . 5.4. BRANCH . . . . . . . . . . . . 5.5. BRANCHL . . . . . . . . . . . 5.6. BUTTON . . . . . . . . . . . . 5.7. CALL . . . . . . . . . . . . . . . 5.8. CLEAR . . . . . . . . . . . . . . 5.9. CLEARW DT . . . . . . . . . . 5.10. COUNT . . . . . . . . . . . . 5.11. DATA . . . . . . . . . . . . . . ii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 24 25 25 25 26 26 29 29 29 30 30 30 33 33 33 34 34 34 34 34 36 36 36 37 37 37 37 38 39 42 43 44 45 46 47 49 50 51 52 53
2. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1. Software Installation . . . . . . . . . . . . . . . . . . 2.2. Your First Program . . . . . . . . . . . . . . . . . . . 2.3. Program That MCU . . . . . . . . . . . . . . . . . . . 2.4. Its Alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.5. Ive Got Troubles . . . . . . . . . . . . . . . . . . . . . 2.5.1. PICm icro MCU Specific Issues . . . . . . . . 2.5.2. PicBasic and BASIC Stam p Com patiblity . 2.5.3. Code Crosses Page Boundary Messages 2.5.4. Out of Mem ory Errors . . . . . . . . . . . . . . . . 2.6. Coding Style . . . . . . . . . . . . . . . . . . . . . . . . 2.6.1. Com m ents . . . . . . . . . . . . . . . . . . 2.6.2. Pin and Variable Nam es . . . . . . . 2.6.3. Labels . . . . . . . . . . . . . . . . . . . . . 2.6.4. GOTO . . . . . . . . . . . . . . . . . . . . . 3. Com m and Line Options . . . . . . . . . 3.1. Usage . . . . . . . . . . . . . . 3.2. Options . . . . . . . . . . . . . 3.2.1. Option -A . . . . 3.2.2. Option -C . . . . 3.2.3. Option -E . . . . 3.2.4. Option -H or -? 3.2.5. Option -L . . . . 3.2.6. Option -O . . . . 3.2.7. Option -P . . . . 3.2.8. Option -S . . . . 3.2.9. Option -V . . . . 3.2.10. Option -Z . . . 4. PicBasic Pro Basics . 4.1. Identifiers . . 4.2. Line Labels 4.3. Variables . . 4.4. Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. 5 . 5 . 5 . 7 . 8 . 9 10 13 13 13 14 14 15 15 15 17 17 18 18 18 19 19 19 19 20 20 20 20 21 21 21 21 22
PicBasic Pro Compiler 5.12. 5.13. 5.14. 5.15. 5.16. 5.17. 5.18. 5.19. 5.20. 5.21. 5.22. 5.23. 5.24. 5.25. 5.26. 5.27. 5.28. 5.29. 5.30. 5.31. 5.32. 5.33. 5.34. 5.35. 5.36. 5.37. 5.38. 5.39. 5.40. 5.41. 5.42. 5.43. 5.44. 5.45. 5.46. 5.47. 5.48. 5.49. 5.50. 5.51. 5.52. 5.53. DEBUG . . . . . . . . . . . . DEBUGIN . . . . . . . . . . DISABLE . . . . . . . . . . . DISABLE DEBUG . . . . DISABLE INTERRUPT DTMFOUT . . . . . . . . . . EEPROM . . . . . . . . . . . ENABLE . . . . . . . . . . . ENABLE DEBUG . . . . ENABLE INTERRUPT . END . . . . . . . . . . . . . . . ERASECODE . . . . . . . FOR..NEXT . . . . . . . . . FREQOUT . . . . . . . . . . GOSUB . . . . . . . . . . . . GOTO . . . . . . . . . . . . . HIGH . . . . . . . . . . . . . . HPW M . . . . . . . . . . . . . HSERIN . . . . . . . . . . . . HSERIN2 . . . . . . . . . . . HSEROUT . . . . . . . . . . HSEROUT2 . . . . . . . . . I2CREAD . . . . . . . . . . . I2CW RITE . . . . . . . . . . IF..THEN . . . . . . . . . . . INPUT . . . . . . . . . . . . . LCDIN . . . . . . . . . . . . . LCDOUT . . . . . . . . . . . {LET} . . . . . . . . . . . . . . LOOKDOW N . . . . . . . . LOOKDOW N2 . . . . . . . LOOKUP . . . . . . . . . . . LOOKUP2 . . . . . . . . . . LOW . . . . . . . . . . . . . . NAP . . . . . . . . . . . . . . . ON DEBUG . . . . . . . . . ON INTERRUPT . . . . . OUTPUT . . . . . . . . . . . OW IN . . . . . . . . . . . . . OW OUT . . . . . . . . . . . PAUSE . . . . . . . . . . . . PAUSEUS . . . . . . . . . . iii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 . 56 . 58 . 59 . 60 . 61 . 62 . 63 . 64 . 65 . 66 . 67 . 68 . 69 . 70 . 71 . 72 . 73 . 75 . 78 . 79 . 81 . 82 . 86 . 89 . 91 . 92 . 93 . 97 . 98 . 99 100 101 102 103 104 105 107 108 109 110 111 5.54. 5.55. 5.56. 5.57. 5.58. 5.59. 5.60. 5.61. 5.62. 5.63. 5.64. 5.65. 5.66. 5.67. 5.68. 5.69. 5.70. 5.71. 5.72. 5.73. 5.74. 5.75. 5.76. 5.77. 5.78. 5.79. 5.80. 5.81. 5.82. 5.83. 5.84. 5.85. 5.86. 5.87. 5.88. 5.89. 6. Structure 6.1. 6.2. 6.3. 6.4.
PicBasic Pro Compiler PEEK . . . . . . . . . PEEKCODE . . . . POKE . . . . . . . . . POKECODE . . . . POT . . . . . . . . . . PULSIN . . . . . . . PULSOUT . . . . . PW M . . . . . . . . . RANDOM . . . . . . RCTIME . . . . . . . READ . . . . . . . . . READCODE . . . . REPEAT..UNTIL RESUME . . . . . . RETURN . . . . . . REVERSE . . . . . SELECT CASE . SERIN . . . . . . . . SERIN2 . . . . . . . SEROUT . . . . . . SEROUT2 . . . . . SHIFTIN . . . . . . . SHIFTOUT . . . . . SLEEP . . . . . . . . SOUND . . . . . . . STOP . . . . . . . . . SW AP . . . . . . . . TOGGLE . . . . . . USBIN . . . . . . . . USBINIT . . . . . . . USBOUT . . . . . . W HILE..W END . W RITE . . . . . . . . W RITECODE . . . XIN . . . . . . . . . . . XOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 113 114 115 116 118 119 120 121 122 123 124 125 126 127 128 129 130 132 137 140 145 148 150 151 152 153 154 155 156 157 158 159 160 161 163 167 167 167 168 168
of a Com piled Program . Target Specific Headers The Library Files . . . . . . PBP Generated Code . . .ASM File Structure . . . . iv
7. Other PicBasic Pro Considerations . . 7.1. How Fast is Fast Enough? 7.2. Configuration Settings . . . . 7.3. RAM Usage . . . . . . . . . . . . 7.4. Reserved W ords . . . . . . . . 7.5. Life After 2K . . . . . . . . . . . . 7.6. 12-Bit Core Considerations
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
169 169 171 171 173 173 174 177 177 178 180 181 183 183 184 186 191 191 191 192 192 193 193 193 193 194 195 196 196 196 197 197 197 198 198 198 198 199
Appendix A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Serin2/Serout2 Mode Exam ples . . . . . . . . . . . . . . . 201 Appendix B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Appendix C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Reserved W ords . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Appendix D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 ASCII Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Appendix E . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Microchip Assem bly Instruction Set . . . . . . . . . . . . . 211 Appendix F . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Contact Inform ation . . . . . . . . . . . . . . . . . . . . . . . . . 213
8. Assem bly Language Program m ing . . . . . . . . . . 8.1. Two Assem blers - No W aiting . . . . . . 8.2. Program m ing in Assem bly Language 8.3. Placem ent of In-line Assem bly . . . . . 8.4. Another Assem bly Issue . . . . . . . . . . 9. Interrupts 9.1. 9.2. 9.3. ................... Interrupts in General . . Interrupts in BASIC . . . Interrupts in Assem bler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10. PicBasic Pro / PicBasic / Stam p Differences . . . 10.1. Execution Speed . . . . . . . . . . . . . . . . . 10.2. Digital I/O . . . . . . . . . . . . . . . . . . . . . . . 10.3. Low Power Instructions . . . . . . . . . . . . 10.4. Missing PC Interface . . . . . . . . . . . . . . 10.5. No Autom atic Variables . . . . . . . . . . . . 10.6. No Nibble Variable Types . . . . . . . . . . 10.7. No DIRS . . . . . . . . . . . . . . . . . . . . . . . 10.8. No Autom atic Zeroing of Variables . . . 10.9. Math Operators . . . . . . . . . . . . . . . . . . 10.10. [ ] Versus ( ) . . . . . . . . . . . . . . . . . . . . 10.11. ABS . . . . . . . . . . . . . . . . . . . . . . . . . . 10.12. DATA, EEPROM, READ and W RITE 10.13. DEBUG . . . . . . . . . . . . . . . . . . . . . . . 10.14. FOR..NEXT . . . . . . . . . . . . . . . . . . . . 10.15. GOSUB and RETURN . . . . . . . . . . . 10.16. I2CREAD and I2CW RITE . . . . . . . . . 10.17. IF..THEN . . . . . . . . . . . . . . . . . . . . . . 10.18. LOOKDOW N and LOOKUP . . . . . . . 10.19. MAX and MIN . . . . . . . . . . . . . . . . . . 10.20. SERIN and SEROUT . . . . . . . . . . . . 10.21. SLEEP . . . . . . . . . . . . . . . . . . . . . . . . v
vi
PicBasic Pro Compiler For general purpose PICm icro MCU developm ent using the PicBasic Pro Com piler, the PIC12F675, 16F648A, 16F84, 16F876, 16F877, 18F252 and 18F452 are the current PICm icro MCUs of choice. These m icrocontrollers use flash technology to allow rapid erasing and reprogram m ing to speed program debugging. W ith the click of the m ouse in the program m ing software, the flash PICm icro MCU can be instantly erased and then reprogram m ed again and again. Other PICm icro MCUs in the PIC12C5xx, 12C67x, 14000, 16C4xx, 16C5x, 16C55x, 16C6xx, 16C7xx, 16C9xx, 17Cxxx and 18Cxxx series are either one-tim e program m able (OTP) or have a quartz window in the top (JW ) to allow erasure by exposure to ultraviolet light for several m inutes. Most PIC12F6xx, 16F6xx, 16F8xx and 18Fxxx devices also contain between 64 and 1024 bytes of non-volatile data m em ory that can be used to store program data and other param eters even when the power is turned off. This data area can be accessed sim ply by using the PicBasic Pro Com pilers READ and WRITE com m ands. (Program code is always perm anently stored in the PICm icro MCUs code space whether the power is on or off.) By using a flash PICm icro MCU for initial program testing, the debugging process m ay be sped along. Once the m ain routines of a program are operating satisfactorily, a PICm icro MCU with m ore capabilities or expanded features of the com piler m ay be utilized. W hile m any PICm icro MCU features will be discussed in this m anual, for full PICm icro MCU inform ation it is necessary to obtain the appropriate PICm icro MCU data sheets or the CD-ROM from Microchip Technology. Refer to Appendix F for contact inform ation.
1. Introduction
The PicBasic Pro Com piler (or PBP) m akes it even quicker and easier for you to program Microchip Technologys powerful PICm icro m icrocontrollers (MCUs). The English-like BASIC language is m uch easier to read and write than the quirky Microchip assem bly language. The PicBasic Pro Com piler is BASIC Stam p II like and has m ost of the libraries and functions of both the BASIC Stam p I and II. Being a true com piler, program s execute m uch faster and m ay be longer than their Stam p equivalents. PBP is not quite as com patible with the BASIC Stam ps as our original PicBasic Com piler is with the BS1. Decisions were m ade that we hope im prove the language overall. One of these was to add a real IF..THEN..ELSE..ENDIF instead of the IF..THEN(GOTO) of the Stam ps. These differences are spelled out later in this m anual. PBP defaults to create files that run on a PIC16F84-04/P clocked at 4MHz. Only a m inim um of other parts are necessary: 2 22pf capacitors for the 4MHz crystal, a 4.7K pull-up resistor tied to the /MCLR pin and a suitable 5- volt power supply. PICm icro MCUs other than the 16F84, as well as oscillators of frequencies other than 4MHz, m ay be used with the PicBasic Pro Com piler.
1.1. The PICmicro MCUs

The PicBasic Pro Com piler produces code that m ay be program m ed into a wide variety of PICm icro m icrocontrollers having from 8 to 84 pins and various on-chip features including A/D converters, hardware tim ers and serial ports. The current version of the PicBasic Pro Com piler supports m ost of the Microchip Technology PICm icro MCUs, including the 12-bit core, 14-bit core and both 16-bit core series, the PIC17Cxxx and PIC18Xxxx devices, as well as the Microm int PicStics. Lim ited support has been added for PICm icro MCUs based on the original 12-bit core. Support is lim ited as the 12-bit core PICm icro MCUs have a lim ited set of resources including a sm aller stack and sm aller code page size. See the README.TXT file for the very latest PICm icro MCU support list.
1.2. About This Manual

This m anual cannot be a full treatise on the BASIC language. It describes the PicBasic Pro Com piler instruction set and provides exam ples on how to use it. If you are not fam iliar with BASIC program m ing, you should acquire a book on the topic. Or just jum p right in. BASIC is designed as an easy-to-use language. Try a few sim ple com m ands to see how they work. Or start with the exam ples and then build on them .
PicBasic Pro Compiler The next section of this m anual covers installing the PicBasic Pro Com piler and writing your first program . Following is a section that describes different options for com piling program s. Program m ing basics are covered next, followed by a reference section listing each PicBasic Pro com m and in detail. The reference section shows each com m and prototype, a description of the com m and and som e exam ples. Curly brackets, {}, indicate optional param eters. The rem ainder of the m anual provides inform ation for advanced program m ers - the inner workings of the com piler.
1.3. Sample Programs

Exam ple program s to help get you started can be found in the SAMPLES subdirectory. Additional exam ple program s can be found in the sam ple program s section of the m icroEngineering Labs, Inc. web site.
PicBasic Pro Compiler The following program provides a good first test of a PICm icro MCU in the real world. You m ay type it in or you can sim ply copy it from the SAMPLES subdirectory included with the PicBasic Pro Com piler. The file is nam ed BLINK.BAS. The BASIC source file should be created in or m oved to the sam e directory where the PBP.EXE file is located. Example program to blink an LED connected to PORTB.0 about once a second loop: High PORTB.0 Pause 500 Low PORTB.0 Pause 500 Goto loop End Once you are satisfied that the program you have written will work flawlessly, you can execute the PicBasic Pro Com piler by clicking on the IDEs build or com pile button. If you are using DOS, enter PBP followed by the nam e of your text file at a DOS prom pt. For exam ple, if the text file you created is nam ed BLINK.BAS, at the DOS com m and prom pt enter: PBP blink If you dont tell it otherwise, the PicBasic Pro Com piler defaults to creating code for the PIC16F84. To com pile code for PICm icro MCUs other than the PIC16F84, sim ply use the -P com m and line option described later in the m anual to specify a different target processor. For exam ple, if you intend to run the above program , BLINK.BAS, on a PIC16F877, com pile it using the com m and: PBP -p16f877 blink Turn on LED Delay for .5 seconds Turn off LED Delay for .5 seconds Go back to loop and blink LED forever
2. Getting Started
2.1. Software Installation
The PicBasic Pro Com piler files are com pressed into the self-extracting file on the included disk. They m ust be uncom pressed before use. To install and uncom press the software, run (click on) INSTALL.BAT. If the PBP directory already exists, you m ay get an error m essage and the installation will continue. All of the necessary files will be installed to a subdirectory nam ed C:\PBP on the hard drive. The uncom pressed READ.ME file has the latest inform ation about the PicBasic Pro Com piler. Make sure that FILES and BUFFERS are set to at least 50 in your CONFIG.SYS file. Depending on how m any FILES and BUFFERS are already in use by your system , allocating an even larger num ber m ay be necessary.
2.2. Your First Program

For operation of the PicBasic Pro Com piler you will use the included IDE or a text editor or word processor for creation of your program source file, som e sort of PICm icro MCU program m er such as our EPIC Plus PICm icro Program m er or m elabs Serial Program m er, and the PicBasic Pro Com piler itself. Of course you also need a PC to run it all on. The sequence of events goes som ething like this: First, start the included or one of the other available IDEs/editors. Select the PICm icro MCU you intend to use from the IDEs drop-down list. Next, create the BASIC source file for the program or open one of the BASIC source files included with PBP. The source file nam e usually (but isnt required to) ends with the extension .BAS. The text file that is created m ust be pure ASCII text. It m ust not contain any special codes that m ight be inserted by word processors for their own purposes. You are usually given the option of saving the file as pure DOS or ASCII text by m ost word processors.
The com piler will display an initialization (copyright) m essage and process your file. If it likes your file, it will create an assem bler source code file (in this case nam ed BLINK.ASM) and autom atically invoke its assem bler (PM) to com plete the task. If all goes well, the final PICm icro 6
PicBasic Pro Compiler MCU code file will be created (in this case, BLINK.HEX). If you have m ade the com piler unhappy, it will issue a string of errors that will need to be corrected in your BASIC source file before you try com pilation again. To help ensure that your original file is flawless, it is best to start by writing and testing a short piece of your program , rather than writing an entire 100,000 line m onolith all at once and then trying to debug it from end to end.
PicBasic Pro Compiler should glow green on the m elabs Serial Program m er indicating it is ready. Launch the program m er software. Once the program m ing screen is displayed, select the PICm icro MCU you will be program m ing. Next, use the m ouse to click on Open file. Select BLINK.HEX or another file you would like to program into the PICm icro MCU from the dialog box. Once the file has been loaded, you can look at the Code or Mem ory window to see your PICm icro MCU program code. You should also look at the Configuration window and verify that it is as desired before proceeding. In general, the Oscillator should be set to XT for a 4MHz crystal and the W atchdog Tim er should be set to ON for PicBasic Pro program s. Most im portantly, Code Protect should be OFF when program m ing any windowed (JW ) PICm icro MCUs. You m ay not be able to erase a windowed PICm icro MCU that has been code protected. You can find m ore inform ation on these configuration fuses in the Microchip data sheet for the device you are using. W hen it all looks m arvelous, it is tim e to insert a PICm icro MCU into the program m ing socket and click on Program . The PICm icro MCU will first be checked to m ake sure it is blank and then your code will be program m ed into it. Once the program m ing is com plete and the LED is no longer red, it is tim e to test your program .
2.3. Program That MCU

There are two steps left - putting your com piled program into the PICm icro m icrocontroller and testing it. The PicBasic Pro Com piler generates standard 8-bit Merged Intel HEX (.HEX) files that m ay be used with any PICm icro MCU program m er including our EPIC Plus PICm icro Program m er and m elabs Serial Program m er. PICm icro MCUs cannot be program m ed with BASIC Stam p program m ing cables. The following is an exam ple of how a PICm icro MCU m ay be program m ed using one of our program m ers. Make sure there are no PICm icro MCUs installed in the program m er program m ing socket or any attached adapters. If you are using the EPIC Program m er, hook it to the PC parallel printer port using a DB25 m ale to DB25 fem ale printer extension cable. If you are using the m elabs Serial Program m er, hook it to the PC serial port using a DB9 m ale to DB9 fem ale serial cable or hook it to the USB port using a USB to serial adapter. Plug the AC adapter into the wall and then into the program m er (or attach 2 fresh 9-volt batteries to the EPIC Program m er and connect the Batt ON jum per. Using an AC adapter instead of batteries is highly recom m ended.) The LED(s) on the EPIC Program m er m ay be on or off at this point. Do not insert a PICm icro MCU into the program m ing socket when an LED is on or before the program m ing software has been started. The LED 7
2.4. Its Alive

The sam ple schem atic below gives you an idea of the few things that need to be connected to the PICm icro MCU to m ake it work. Basically, all you need is a pull-up resistor on the /MCLR line, a 4MHz crystal with 2 capacitors, and som e kind of 5-volt power supply. W e have added an LED and resistor to provide the output from the BLINK program .
PicBasic Pro Compiler power up properly and an external circuit m ay be necessary. See the Microchip data books for m ore inform ation. Be sure you have a good crystal with the proper value capacitors connected to it. Capacitor values can be hard to read. If the values are off by too m uch, the oscillator wont start and run properly. A 4MHz crystal with two 22pf (picofarad) ceram ic disk capacitors is a good start for m ost PICm icro MCUs. Once again, check out the Microchip data books for additional thoughts on the m atter. Make sure your power supply is up to the task. W hile the PICm icro MCU itself consum es very little power, the power supply m ust be filtered fairly well. If the PICm icro MCU is controlling devices that pull a lot of current from your power supply, as they turn on and off they can put enough of a glitch on the supply lines to cause the PICm icro MCU to stop working properly. Even an LED display can create enough of an instantaneous drain to m om entarily clobber a sm all power supply (like a 9-volt battery) and cause the PICm icro MCU to lose its m ind. Start sm all. W rite short program s to test features you are unsure of or m ight be having trouble with. Once these sm aller program s are working properly, you can build on them . Try doing things a different way. Som etim es what you are trying to do looks like it should work but doesnt, no m atter how hard you pound on it. Usually there is m ore than one way to skin a program . Try approaching the problem from a different angle and m aybe enlightenm ent will ensue.
Build and double check this sim ple circuit on a protoboard and plug in the PICm icro MCU you just program m ed. Our line of PICProto prototyping boards is perfect for this kind of thing. Connect a power supply. Your PICm icro MCU should com e to life and start blinking the LED about once a second. If it does not blink, check all of the connections and m ake sure 5 volts is present at the appropriate pins on the PICm icro MCU. From these sim ple beginnings, you can create your own worldconquering application.
2.5.1. PICmicro MCU Specific Issues 2.5. Ive Got Troubles

The m ost com m on problem s with getting PICm icro MCUs running involve m aking sure the few external com ponents are of the appropriate value and properly connected to the PICm icro MCU. Following are som e hints to help get things up and running. Make sure the /MCLR pin is connected to 5 volts either through som e kind of voltage protected reset circuit or sim ply with a 4.7K resistor. If you leave the pin unconnected, its level floats around and som etim es the PICm icro MCU will work but usually it wont. The PICm icro MCU has an on-chip power-on-reset circuit so in general just an external pull-up resistor is adequate. But in som e cases the PICm icro MCU m ay not 9 It is imperative that you read the M icrochip data sheet for the PICm icro M CU device you are using. Som e devices have features that can interfere with expected pin operations. The PIC16C62x and 16F62x parts (the 16C620, 621, 622, 16F627 and 628) are a good exam ple of this. These PICm icro MCUs, as well as others, have analog com parators on PORTA or another port. W hen these chips start up, PORTA is set to analog m ode. This m akes the pin functions on PORTA work in an unexpected m anner. To change the pins to digital, sim ply add the line: CMCON = 7 near the front of your program . 10
PicBasic Pro Compiler Any PICm icro MCU with analog inputs, such as the PIC16C7xx, PIC16F87x and PIC12C67x series devices, will com e up in analog m ode. You m ust set them to digital if that is how you intend to use them : ADCON1 = 7 For the PIC12F675 and 16F676, a different register m ust be set instead: ANSEL = 0 W hile these settings work for m any devices, you will need to check the data sheet for the specific device to verify the exact settings. Another exam ple of potential disaster is that PORTA, pin 4 exhibits unusual behavior when used as an output. This is because the pin has an open drain output rather than the usual bipolar stage of the rest of the output pins. This m eans it can pull to ground when set to 0, but it will sim ply float when set to a 1, instead of going high. To m ake this pin act in the expected manner, add a pull-up resistor between the pin and 5 volts. The value of the resistor m ay be between 1K and 33K, depending on the drive necessary for the connected input. This pin acts as any other pin when used as an input. Som e PICm icro MCUs, such as the PIC16F62x, 87x(A) and PIC18Fxxx allow low-voltage program m ing. This function takes over one of the PORTB pins and can cause the device to act erratically if this pin is not pulled low. It is best to m ake sure that low-voltage program m ing is not enabled at the tim e the PICm icro MCU is program m ed. All of the PICm icro MCU pins are set to inputs on power-up. If you need a pin to be an output, set it to an output before you use it, or use a PicBasic Pro com m and that does it for you. Once again, review the PICm icro MCU data sheets to becom e fam iliar with the idiosyncrasies of a particular part. There is no data direction (TRIS) register for PORTA on PIC17Cxxx devices. Therefore, com m ands that rely on the TRIS register for their operation, such as I2CREAD and I2CWRITE, m ay not be used on PORTA.
PicBasic Pro Compiler The nam e of the port pins on the PIC12C5xx, 12CE5xx, 12C67x, 12CE67x and 12F6xx devices is GPIO. The nam e for the TRIS register is TRISIO. GPIO.0 = 1 TRISIO = %101010 On the PIC12C5xx and 12CE5xx devices, pin GPIO.2 is forced to an input regardless of the setting of the TRIS register. To allow this pin to be used as a standard I/O pin, add the following line to the beginning of the program : OPTION_REG.5 = 0 As hinted at above, the nam e of the OPTION register on all PICm icro MCUs is OPTION_REG. Certain PICm icro MCUs have on-chip non-volatile data storage im plem ented like an I2C interfaced serial EEPROM. READ and WRITE will not work on devices with on-chip I2C interfaced serial EEPROM like the PIC12CE51x, 12CE67x and 16CE62x parts. Use the I2CREAD and I2CWRITE instructions instead. Som e PICm icro MCUs, such as the PIC12C67x, 12CE67x and 12F6xx, have on-chip RC oscillators. These devices contain an oscillator calibration factor in the last location of code space. The on-chip oscillator m ay be fine-tuned by acquiring the data from this location and m oving it into the OSCCAL register. Two DEFINEs have been created to perform this task autom atically each tim e the program starts: Define OSCCAL_1K 1 Define OSCCAL_2K 1 ' Set OSCCAL for 1K device ' Set OSCCAL for 2K device
Add one of these 2 DEFINEs near the beginning of the PicBasic Pro program to perform the setting of OSCCAL. If a UV erasable device has been erased, the value cannot be read from m em ory. If one of these DEFINEs is used on an erased part, it will cause
11
12
PicBasic Pro Compiler the program to loop endlessly. To set the OSCCAL register on an erased part, near the beginning of the program , add the line: OSCCAL = $a0 ' Set OSCCAL register to $a0
PicBasic Pro Compiler the m em ory available to W indows 95, 98, ME, NT, 2000 and XP. You m ust, of course, be running in a DOS shell from one of these 32-bit W indows environm ents or be within Microchip's MPLAB or another W indows IDE. To execute the W indows version from the DOS com m and line, sim ply substitute PBPW for PBP. PBPW blink
The $a0 is m erely an exam ple. The part would need to be read before it is erased to obtain the actual OSCCAL value for that particular device. PicBasic Pro will autom atically load the OSCCAL value for the PIC12C5xx and 12CE51x devices, if it is available. It is unnecessary to use the above DEFINEs with these devices. Please see the Microchip data sheets for m ore inform ation on OSCCAL and any of the other PICm icro MCU registers.
2.6. Coding Style

W riting readable and m aintainable program s is an art. There are a few sim ple techniques you can follow that m ay help you becom e an artist.
2.6.1. Comments
Use lots of com m ents. Even though it m ay be perfectly obvious to you what the code is doing as you write it, som eone else looking at the program (or even yourself when you are som eone else later in life) m ay not have any idea of what you were trying to achieve. W hile com m ents take up space in your BASIC source file, they do not take up any additional space in the PICm icro MCU so use them freely. Make the com m ents tell you som ething useful about what the program is doing. A com m ent like Set Pin0 to 1" sim ply explains the syntax of the language but does nothing to tell you why you have the need to do this. Som ething like Turn on the Battery Low LED m ight be a lot m ore useful. A block of com m ents at the beginning of the program and before each section of code can describe what is about to happen in m ore detail than just the space rem aining after each statem ent. But dont include a com m ent block instead of individual line com m ents - use both. At the beginning of the program describe what the program is intended to do, who wrote it and when. It m ay also be useful to list revision inform ation and dates. Specifying what each pin is connected to can be helpful in rem em bering what hardware this particular program is designed to run on. If it is intended to be run with a non-standard crystal or special com piler options, be sure to list those.
2.5.2. PicBasic and BASIC Stamp Compatiblity

There are som e differences between the standard PicBasic Com piler, the BASIC Stam ps and the PicBasic Pro Com piler. See section 10 for inform ation on these differences.
2.5.3. Code Crosses Page Boundary Messages

Many PICm icro MCUs contain code space m em ory that is segm ented into 512, 2K or 8K word pages. As large files are com piled and then assem bled, they m ay start to use m ore than the first page. As each page is used, PM, the assem bler, will issue a m essage that the code is crossing a particular boundary. This is norm al and no cause for alarm . PBP will m ake sure to take care of m ost of the issues for you. The only thing that you m ust be aware of is the BRANCH instruction. If a BRANCH tries to access a label on the other side of a boundary, it will not work properly. BRANCHL should be used instead. It can address labels in any code page.
2.5.4. Out of Memory Errors

Com piling large PicBasic Pro source code files can tax the m em ory of the PC running the com piler. If an Out of Mem ory error is issued and the FILES and BUFFERS are set as recom m ended, an alternate version of PBP can be used. PBPW .EXE has been com piled to m ake use of all of 13
14
2.6.2. Pin and Variable Names

Make the nam e of a pin or variable som ething m ore coherent than Pin0 or B1. In addition to the liberal use of com m ents, descriptive pin and variable nam es can greatly enhance readability. The following code fragm ent dem onstrates: BattLED var PORTB.0 level var byte Low battery LED Variable will contain the battery level If batt level is low Turn on the LED
If level < 10 Then High BattLED Endif
2.6.3. Labels
Labels should also be m ore m eaningful than label1:" or here:. Even a label like loop: is m ore descriptive (though only slightly). Usually the line or routine you are jum ping to does som ething unique. Try and give at least a hint of its function with the label, and then follow up with a com m ent.
2.6.4. GOTO
Try not to use too m any GOTOs. W hile GOTOs m ay be a necessary evil, try to m inim ize their use as m uch as possible. Try to write your code in logical sections and not jum p around too m uch. GOSUBs can be helpful in achieving this.
15
16
3. Command Line Options

3.1. Usage
The PicBasic Pro Com piler can be invoked from the DOS com m and line using the following com m and form at: PBP Options Filename Zero or m ore Options can be used to m odify the m anner in which PBP com piles the specified file. Options begin with either a m inus ( - ) or a forward slash ( / ). The character following the m inus or slash is a letter which selects the Option. Additional characters m ay follow if the Option requires m ore inform ation. Each Option m ust be separated by a space and no spaces m ay occur within an Option. Multiple Options m ay be used at the sam e tim e. For exam ple the com m and line: PBP -p16f877 blink will cause the file BLINK.BAS to be com piled targeted for a PIC16F877 processor. The first item not starting with a m inus is assum ed to be the Filename. If no extension is specified, the default extension .BAS is used. If a path is specified, that directory is searched for the nam ed file. Regardless of where the source file is found, files generated by PBP are placed in the current directory. By default, PBP autom atically launches the assem bler (PM.EXE) if the com pilation has no errors. PBP expects to find PM.EXE in the sam e directory as PBP.EXE. If the com pilation has errors or the -S option is used, the assem bler is not launched. If PBP is invoked with no param eters or filenam e, a brief help screen is displayed.
3.2. Options
Option A C E H(?) L O P S V Z Description Use a different Assem bler Insert source lines as Com m ents into assem bler file Output errors to a file Display Help screen Use a different Library file Pass Option to assem bler Specify target Processor Skip execution of assem bler when done Verbose m ode Add source level debugging inform ation
3.2.1. Option -A
PBP has the capability to use either PM, which is included with PBP, or Microchips MPASMW IN as its assem bler. W hen using MPASMW IN, PBPW m ust be specified instead of PBP. PBPW is the W indows executable version of PBP. To specify MPASMW IN as the assem bler, use -ampasmwin on the com m and line: PBPW -ampasmwin filename MPASMW IN m ust be acquired from Microchip and set up in the system path. See the file MPLAB.TXT on the disk for m ore details. If no assem bler is specified on the com m and line, PM is used.
3.2.2. Option -C
The -C option causes PBP to insert the PicBasic Pro source file lines as com m ents into the assem bly language source file. This can be useful as a debugging tool or learning tool as it shows the PicBasic Pro instruction followed by the assem bly language instructions it generates. PBP -c filename
17
18
3.2.3. Option -E
The -E option causes PBP to send all the errors to a file, filenam e.er. PBP -e filename
3.2.7. Option -P
If not told otherwise, PBP com piles program s for the PIC16F84. If the program requires a different processor as its target, its nam e m ust be specified on the com m and line use the -P option. For exam ple, if the desired target processor for the PBP program is a PIC16F877, the com m and line should look som ething like the following: PBP -p16F877 filename
3.2.4. Option -H or -?
The -H or -?option causes PBP to display a brief help screen. This help screen is also displayed if no option and filenam e is specified on the com m and line.
3.2.8. Option -S
Norm ally, when PBP successfully com piles a program , it autom atically launches the assem bler. This is done to convert the assem bler output of PBP to a .HEX file. The -S option prevents this, leaving PBP's output in the generated .ASM file. Since -S prevents the assem bler from being invoked, options that are sim ply passed to the assem bler using the -O com m and line switch are effectively overridden. PBP -s filename
3.2.5. Option -L
The -L option lets you select the library used by PicBasic Pro. This option is generally unnecessary as the default library file is set in a configuration file for each m icrocontroller. For m ore inform ation on PicBasic Pro libraries, see the advanced sections later in this m anual. PBP -lpbpps2 filename This exam ple tells PBP to com pile filename using the PicStic2 library.
3.2.6. Option -O 3.2.9. Option -V

The -O option causes the letters following it to be passed to the assem bler on its com m and line as options. The PICm icro Macro Assem bler's m anual on disk contains inform ation on the assem bler and its options. PBP -ol filename This exam ple tells PBP to generate a filename.lst file after a successful com pilation. More than one -O option m ay be passed to the assem bler at a tim e. PBP -z filename The -V option turns on PBPs verbose m ode which presents m ore inform ation during program com pilation. PBP -v filename
3.2.10. Option -Z
The -Z option tells PBPW to add source level sim ulation and debugging inform ation to the files that are generated during com pilation. For an exam ple of how to use this within MPLAB, see the README.TXT file.
19
20
PicBasic Pro Compiler There are no predefined user variables in PicBasic Pro. For com patibility sake, two files have been provided that create the standard variables used with the BASIC Stam ps: BS1DEFS.BAS and BS2DEFS.BAS. To use one of these files, add the line: Include bs1defs.bas or Include bs2defs.bas near the top of the PicBasic Pro program . These files contain num erous VAR statem ents that create all of the BASIC Stam p variables and pin definitions. However, instead of using these canned files, we recom m end you create your own variables using nam es that are m eaningful to you. The num ber of variables available depends on the am ount of RAM on a particular device and the size of the variables and arrays. PBP reserves approxim ately 24 RAM locations for its own use. It m ay also create additional tem porary variables for use in sorting out com plex equations.
4. PicBasic Pro Basics

4.1. Identifiers
An identifier is, quite sim ply, a nam e. Identifiers are used in PBP for line labels and variable nam es. An identifier is any sequence of letters, digits, and underscores, although it m ust not start with a digit. Identifiers are not case sensitive, thus label, LABEL, and Label are all treated as equivalent. And while labels m ight be any num ber of characters in length, PBP only recognizes the first 31.
4.2. Line Labels

In order to m ark statem ents that the program m ight wish to reference with GOTO or GOSUB com m ands, PBP uses line labels. Unlike m any older BASICs, PBP doesn't allow line num bers and doesn't require that each line be labeled. Rather, any PBP line m ay start with a line label, which is sim ply an identifier followed by a colon (:). here: Serout 0,N2400,["Hello, World!",13,10] Goto here
4.4. Aliases
VAR can also be used to create an alias (another nam e) for a variable. This is m ost useful for accessing the innards of a variable. fido b0 b1 flea VAR VAR VAR VAR dog w0.byte0 w0.byte1 dog.0 fido is another name for dog b0 is the first byte of word w0 b1 is the second byte of word w0 flea is bit0 of dog
4.3. Variables
Variables are where tem porary data is stored in a PicBasic Pro program . They are created using the VAR keyword. Variables m ay be bits, bytes or words. Space for each variable is autom atically allocated in the m icrocontrollers RAM by PBP. The form at for creating a variable is as follows: Label VAR Size{.Modifiers}
Label is any identifier, excluding keywords, as described above. Size is BIT, BYTE or WORD. Optional Modifiers add additional control over how the variable is created and are listed in the table in the Aliases section. Som e exam ples of creating variable are: dog cat w0 VAR VAR VAR byte bit word
The variable m odifiers m ay also be used as part of variables in a statem ent: b = w0.byte0 OPTION_REG.7 = 0
21
22
PicBasic Pro Compiler Modifier BIT0 or 0 BIT1 or 1 BIT2 or 2 BIT3 or 3 BIT4 or 4 BIT5 or 5 BIT6 or 6 BIT7 or 7 BIT8 or 8 BIT9 or 9 BIT10 or 10 BIT11 or 11 BIT12 or 12 BIT13 or 13 BIT14 or 14 BIT15 or 15 BYTE0 or LOWBYTE BYTE1 or HIGHBYTE Description Create alias to bit 0 of byte or word Create alias to bit 1 of byte or word Create alias to bit 2 of byte or word Create alias to bit 3 of byte or word Create alias to bit 4 of byte or word Create alias to bit 5 of byte or word Create alias to bit 6 of byte or word Create alias to bit 7 of byte or word Create alias to bit 8 of word Create alias to bit 9 of word Create alias to bit 10 of word Create alias to bit 11 of word Create alias to bit 12 of word Create alias to bit 13 of word Create alias to bit 14 of word Create alias to bit 15 of word Create alias to low byte of word Create alias to high byte of word Size BIT BYTE WORD
PicBasic Pro Compiler The first array location is elem ent 0. In the fish array defined above, the elem ents are num bered fish[0] to fish[7] yielding 8 elem ents in total. Because of the way arrays are allocated in m em ory, there are size lim its for each type: Maxim um Num ber of elem ents 256 96* 48*
* Processor dependent. See the section on m em ory allocation for m ore inform ation. Arrays m ust fit entirely within one RAM bank on m ost PICm icro MCUs. They m ay not span RAM banks on 12-bit, 14-bit or 17Cxxx devices. (Arrays m ay span banks on 18Xxxx devices. Byte- and word-sized arrays are only lim ited in length by the am ount of m em ory.) The com piler will assure that arrays will fit in m em ory before successfully com piling.
4.6. Constants
Nam ed constants m ay be created in a sim ilar m anner to variables. It can be m ore convenient to use a constant nam e instead of a constant num ber. If the num ber needs to be changed, it m ay be changed in only one place in the program ; where the constant is defined. Variable data cannot be stored in a constant. Label CON Constant expression
4.5. Arrays
Variable arrays can be created in a sim ilar m anner to variables.
Som e exam ples of constants are: Label VAR Size[Number of elements] mice CON traps CON 3 mice * 1000
Label is any identifier, excluding keywords, as described above. Size is BIT, BYTE or WORD. Number of elements is how m any array locations is desired. Som e exam ples of creating arrays are: sharks VAR fish VAR byte[10] bit[8] 23
24
4.7. Symbols
SYMBOL provides yet another m ethod for aliasing variables and constants. It is included for BS1 com patibility. SYMBOL cannot be used to create a variable. Use VAR to create a variable. SYMBOL lion = cat cat was previously created using VAR SYMBOL mouse = 1 Same as mouse CON 1
4.10. Ports and Other Registers

All of the PICm icro MCU registers, including the ports, can be accessed just like any other byte-sized variable in PicBasic Pro. This m eans that they can be read from , written to or used in equations directly: PORTA = %01010101 anyvar = PORTB & $0f Write value to PORTA Isolate lower 4 bits of PORTB and place result into anyvar
4.8. Numeric Constants

PBP allows num eric constants to be defined in the three bases: decim al, binary and hexadecim al. Binary values are defined using the prefix '%' and hexadecim al values using the prefix '$'. Decim al values are the default and require no prefix. 100 %100 $100 Decimal value 100 Binary value for decimal 4 Hexadecimal value for decimal 256
4.11. Pins
Pins m ay be accessed in a num ber of different ways. The best way to specify a pin for an operation is to sim ply use its PORT nam e and bit num ber: PORTB.1 = 1 Set PORTB, bit 1 to a 1 To m ake it easier to rem em ber what a pin is used for, it m ay be assigned a nam e using the VAR com m and. In this m anner, the nam e m ay then be used in any operation: led Var PORTA.0 High led Rename PORTA.0 as led Set led (PORTA.0) high
For ease of program m ing, single characters are converted to their ASCII equivalents. Character constants m ust be quoted using double quotes and m ust contain only one character (otherwise, they are string constants, see below). "A" "d" ASCII value for decimal 65 ASCII value for decimal 100
For com patibility with the BASIC Stam p, pins used in PicBasic Pro Com piler com m ands m ay also be referred to by a num ber, 0 - 15. This num ber references different physical pins on the PICm icro MCU hardware ports dependent on how m any pins the m icrocontroller has. No. PICm icro MCU Pins 0-7 GPIO* PORTB PORTB PORTC 8 - 15 GPIO* PORTA* PORTC PORTD
4.9. String Constants

PBP doesn't provide string handling capabilities, but strings can be used with som e com m ands. A string contains one or m ore characters and is delim ited by double quotes. No escape sequences are supported for non-ASCII characters (although m ost PBP com m ands have this handling built-in). Lcdout "Hello" Output String (Short for "H","e","l","l","o") 8-pin 18-pin 28-pin (except 14000) 14000
40-pin+ PORTB PORTC *GPIO and PORTA do not have 8 I/O pins.
Strings are usually treated as a list of individual character values. 25 26
PicBasic Pro Compiler If a port does not have 8 pins, such as PORTA, only the pin num bers that exist m ay be used, i.e. 8 - 12. Using pin num bers 13 - 15 will have no discernable effect. This pin num ber, 0 - 15, has nothing to do with the physical pin num ber of a PICm icro MCU. Depending on the particular PICm icro MCU, pin num ber 0 could be physical pin 6, 21 or 33, but in each case it m aps to PORTB.0 (or GPIO.0 for 8-pin devices, or PORTC.0 for a PIC14000). High 0 B0 = 9 Toggle B0 Set PORTB.0 (or GPIO.0) high Select PORTC.1 (or PORTA.1) Toggle PORTC.1 (or PORTA.1)
PicBasic Pro Compiler PORTL and PORTH are also defined in PBP. PORTL encom passes pin 0 7 and PORTH encom passes pins 8 - 15. W hen a PICm icro MCU powers-up, all of the pins are set to input. To use a pin as an output, the pin or port m ust be set to an output or a com m and m ust be used that autom atically sets a pin to an output. To set a pin or port to an output (or input), set its TRIS register. Setting a TRIS bit to 0 m akes its corresponding port pin an output. Setting a TRIS bit to 1 m akes its corresponding port pin an input. For exam ple: TRISA = %00000000 sets all the PORTA pins to outputs. Or TRISA = 0
Pins m ay be referenced by num ber (0 - 15), nam e (e.g. Pin0, if BS1DEFS.BAS or BS2DEFS.BAS is included or you have defined them yourself), or full bit nam e (e.g. PORTA.1). Any pin or bit of the m icrocontroller can be accessed using the latter m ethod. The pin nam es (i.e. Pin0) are not autom atically included in your program . In m ost cases, you would define pin nam es as you see fit using the VAR com m and: led Var PORTB.3
TRISB = %11111111 sets all the PORTB pins to inputs. TRISC = %10101010
Or TRISB = 255
Sets all the even pins on PORTC to outputs, and the odd pins to inputs. Individual bit directions m ay be set in the sam e m anner. TRISA.0 = 0
However, two definition files have been provided to enhance BASIC Stam p com patibility. The files BS1DEFS.BAS or BS2DEFS.BAS m ay be included in the PicBasic Pro program to provide pin and bit nam es that m atch the BASIC Stam p nam es. Include bs1defs.bas or Include bs2defs.bas
sets PORTA, pin 0 to an output. All of the other pin directions on PORTA are unchanged. The BASIC Stam p variable nam es Dirs, Dirh, Dirl and Dir0-Dir15 are not defined and should not be used with the PicBasic Pro Com piler. TRIS should be used instead, but has the opposite state of Dirs. This does not work in PicBasic Pro:
BS1DEFS.BAS defines Pins, B0-B13, W0-W6 and m ost of the other BS1 pin and variable nam es. BS2DEFS.BAS defines Ins, Outs, InL, Inh, OutL, Outh, B0B25, W0-W12 and m ost of the other BS2 pin and variable nam es.
Dir0 = 1 Do this instead:
Doesnt set pin PORTB.0 to output
TRISB.0 = 0 Set pin PORTB.0 to output
27
28
4.12. Comments
A PBP com m ent starts with either the REM keyword, the single quote () or the sem i-colon (;). All following characters on this line are ignored. Unlike m any BASICs, REM is a unique keyword and not an abbreviation for REMark. Thus, variables nam es may begin with REM.
4.15. INCLUDE
Other BASIC source files m ay be added to a PBP program by using INCLUDE. You m ay have standardized subroutines, definitions or other files that you wish to keep separate. The Stam p and serial m ode definition files are exam ples of this. These files m ay be included in program s when they are necessary, but kept out of program s where they are not needed. The included files source code lines are inserted into the program exactly where the INCLUDE is placed. INCLUDE modedefs.bas
4.13. Multi-statement Lines

In order to allow m ore com pact program s and logical grouping of related com m ands, PBP supports the use of the colon (:) to separate statem ents placed on the sam e line. Thus, the following two exam ples are equivalent: W2 = W0 W0 = W1 W1 = W2 is the sam e as: W2 = W0 : W0 = W1 : W1 = W2 This does not, however, change the size of the generated code. DEFINE m ay be used to change the predefined oscillator value, the DEBUG pins and baud rate and the LCD pin locations, am ong other things. These definitions m ust be in all upper case, exactly as shown. If not, the com piler m ay not recognize them . No error m essage will be produced for DEFINEs the com piler does not recognize. See the appropriate sections of the m anual for specific inform ation on these definitions. A com plete list of DEFINEs is shown in Appendix B. DEFINE OSC 4 Oscillator speed in MHz: 3(3.58) 4 8 10 12 16 20 24 25 32 33 40
4.16. DEFINE
Som e elem ents, like the clock oscillator frequency and the LCD pin locations, are predefined in PBP. DEFINE allows a PBP program to change these definitions, if desired.
4.14. Line-extension Character

The m axim um num ber of characters that m ay appear on one PBP line is 256. Longer statem ents m ay be extended to the next line using the lineextension character ( _ ) at the end of each line to be continued. Branch B0,[label0,label1,label2,_ label3,label4]
4.17. Math Operators

Unlike the BASIC Stam p, the PicBasic Pro Com piler perform s all m ath and com parison operations in full hierarchal order. This m eans that there is precedence to the operators. Multiplies and divides are perform ed before adds and subtracts, for exam ple. To ensure the operations are 29 30
PicBasic Pro Compiler carried out in the order you would like, use parenthesis to group the operations: A = (B + C) * (D - E) All m ath operations are unsigned and perform ed with 16-bit precision.
PicBasic Pro Compiler Math Operators + * ** */ / // << >> ABS COS DCD DIG DIV32 MAX MIN NCD REV SIN SQR & | ^ ~ &/ |/ ^/ Addition Subtraction Multiplication Top 16 Bits of Multiplication Middle 16 Bits of Multiplication Division Rem ainder (Modulus) Shift Left Shift Right Absolute Value* Cosine 2n Decode Digit 31-bit x 15-bit Divide Maxim um * Minim um * Encode Reverse Bits Sine Square Root Bitwise AND Bitwise OR Bitwise Exclusive OR Bitwise NOT Bitwise NOT AND Bitwise NOT OR Bitwise NOT Exclusive OR Description
*Im plem entation differs from BASIC Stam p.
31
32
4.17.1. Multiplication
PBP perform s unsigned 16-bit x 16-bit m ultiplication. The '*' operator returns the lower 16 bits of the 32-bit internal result. This is the typical m ultiplication found in m ost program m ing languages. The '**' operator returns the upper 16 bits of the 32-bit internal result. These two operators can be used in conjunction to perform 16-bit x 16-bit m ultiplication that produces 32-bit results. W1 = W0 * 1000 W2 = W0 ** 1000 Multiply value in W0 by 1000 and place the result in W1 Multiply W0 by 1000 and place the high order 16 bits (which may be 0) in W2
4.17.4. ABS
ABS returns the absolute value of a num ber. If a byte is greater than 127 (high bit set), ABS will return 256 - value. If a word is greater than 32767 (high bit set), ABS will return 65536 - value. B1 = ABS B0
4.17.5. COS
COS returns the 8-bit cosine of a value. The result is in twos com plem ent form (i.e. -127 to 127). It uses a quarter-wave lookup table to find the result. Cosine starts with a value in binary radians, 0 to 255, as opposed to the usual 0 to 359 degrees. B1 = COS B0
The */ operator returns the m iddle 16 bits of the 32-bit internal result. W3 = W1 */ W0 Multiply W1 by W0 and place the middle 16 bits in W3
4.17.6. DCD
DCD returns the decoded value of a bit num ber. It changes a bit num ber (0 - 15) into a binary num ber with only that bit set to 1. All other bits are set to 0. B0 = DCD 2 Sets B0 to %00000100
4.17.2. Division
PBP perform s unsigned 16-bit x 16-bit division. The '/' operator returns the 16-bit result. The '//' operator returns the rem ainder. This is som etim es referred to as the m odulus of the num ber. W1 = W0 / 1000 W2 = W0 // 1000 Divide value in W0 by and place the result in Divide value in W0 by and place the remainder 1000 W1 1000 in W2
4.17.7. DIG
DIG returns the value of a decim al digit. Sim ply tell it the digit num ber (0 - 4 with 0 being the rightm ost digit) you would like the value of, and voila. B0 = 123 B1 = B0 DIG 1 Set B0 to 123 Sets B1 to 2 (digit 1 of 123)
4.17.3. Shift
The '<<' and '>>' operators shift a value left or right, respectively, 0 to 15 tim es. The newly shifted-in bits are set to 0. B0 = B0 << 3 W1 = W0 >> 1 Shifts B0 left 3 places (same as multiply by 8) Shifts W0 right 1 position and places result in W1 (same as divide by 2) 33
4.17.8. DIV32
PBPs m ultiply (*) function operates as a 16-bit x 16-bit m ultiply yielding a 32-bit internal result. However, since the com piler only supports a m axim um variable size of 16 bits, access to the result had to happen in 2 steps: c = b * a returns the lower 16 bits of the m ultiply while d = b ** a
34
PicBasic Pro Compiler returns the upper 16 bits. There was no way to access the 32-bit result as a unit. In m any cases it is desirable to be able to divide the entire 32-bit result of the m ultiply by a 16-bit num ber for averaging or scaling. A new function has been added for this purpose: DIV32. DIV32 is actually lim ited to dividing a 31-bit unsigned integer (m ax 2147483647) by a 15-bit unsigned integer (m ax 32767). This should suffice in m ost circum stances. As the com piler only allows a m axim um variable size of 16 bits, DIV32 relies that a m ultiply was just perform ed and that the internal com piler variables still contain the 32-bit result of the m ultiply. No other operation m ay occur between the m ultiply and the DIV32 or the internal variables m ay be altered, destroying the 32-bit m ultiplication result. This m eans, am ong other things, that ON INTERRUPT m ust be DISABLEd from before the m ultiply until after the DIV32. If ON INTERRUPT is not used, there is no need to add DISABLE to the program . Interrupts in assem bler should have no effect on the internal variables so they m ay be used without regard to DIV32. The following code fragm ent shows the operation of DIV32: a b c dummy Var Var Var Var Word Word Word Word
PicBasic Pro Compiler the 16-bit word size of a variable (65535). So the dum m y variable contains only the lower 16 bits of the result. In any case, it is not used by the DIV32 function. DIV32 uses variables internal to the com piler as the operands. In this exam ple, DIV32 divides the 32-bit result of the m ultiplication b * c by 100 and stores the result of this division, 5000, in the word-sized variable a.
4.17.9. MAX and MIN

MAX and MIN returns the m axim um and m inim um , respectively, of two num bers. It is usually used to lim it num bers to a value. B1 = B0 MAX 100 Set B1 to and 100 (B1 100 & 255) Set B1 to and 100 (B1 than 100) the larger of B0 will be between the smaller of B0 cant be bigger
B1 = B0 MIN 100
4.17.10. NCD
NCD returns the priority encoded bit num ber (1 - 16) of a value. It is used to find the highest bit set in a value. It returns 0 if no bit is set. B0 = NCD %01001000 Sets B0 to 7
4.17.11. REV
b = 500 c = 1000 Disable ' Necessary if On Interrupt used B0 = %10101100 REV 4 dummy = b * c a = DIV32 100 Enable ' Could also use ** or */ Sets B0 to %00000011 REV reverses the order of the lowest bits in a value. The num ber of bits to be reversed is from 1 to 16.
' Necessary if On Interrupt used
This program assigns b the value 500 and c the value 1000. W hen m ultiplied together, the result would be 500000. This num ber exceeds 35 36
PicBasic Pro Compiler Com parison Operator = or == <> or != < > Equal Not Equal Less Than Greater Than Less Than or Equal Greater Than or Equal Description
4.17.12. SIN
SIN returns the 8-bit sine of a value. The result is in twos com plem ent form (i.e. -127 to 127). It uses a quarter-wave lookup table to find the result. Sine starts with a value in binary radians, 0 to 255, as opposed to the usual 0 to 359 degrees. B1 = SIN B0
<= >= If i > 10 Then loop
4.17.13. SQR
SQR returns the square root of a value. Since PicBasic Pro only works with integers, the result will always be an 8-bit integer no larger than the actual result. B0 = SQR W1 Sets B0 to square root of W1
4.19. Logical Operators

Logical operators differ from bitwise operations. They yield a true/false result from their operation. Values of 0 are treated as false. Any other value is treated as true. They are m ostly used in conjunction with the com parison operators in an IF..THEN statem ent. The operators supported are: Logical Operator AND or && OR or || XOR or ^^ Description Logical AND Logical OR Logical Exclusive OR Logical NOT Logical NAND Logical NOR Logical NXOR
4.17.14. Bitwise Operators

Bitwise operators act on each bit of a value in boolean fashion. They can be used to isolate bits or add bits into a value. B0 = B0 & %00000001 B0 = B0 | %00000001 B0 = B0 ^ %00000001 Isolate bit 0 of B0 Set bit 0 of B0 Flip state of bit 0 of B0
4.18. Comparison Operators

Com parison operators are used in IF..THEN statem ents to com pare one expression with another. These com parisons are unsigned. They cannot be used to check if a num ber is less than 0.
NOT or ! ANDNOT ORNOT XORNOT
If (A == big) AND (B > mean) Then run Be sure to use parenthesis to tell PBP the exact order you want the operations to be perform ed.
37
38
PicBasic Pro Compiler INPUT Make pin an input. LCDIN Read from LCD RAM. LCDOUT Display characters on LCD. {LET} Assign result of an expression to a variable. LOOKDOWN Search constant table for value. LOOKDOWN2 Search constant / variable table for value. LOOKUP Fetch constant value from table. LOOKUP2 Fetch constant / variable value from table. LOW Make pin output low. NAP Power down processor for short period of tim e. ON DEBUG Execute BASIC debug m onitor. ON INTERRUPT Execute BASIC subroutine on an interrupt. OWIN One-wire input. OWOUT One-wire output. OUTPUT Make pin an output. PAUSE Delay (1 m illisecond resolution). PAUSEUS Delay (1 m icrosecond resolution). PEEK Read byte from register. PEEKCODE Read byte from code space. POKE Write byte to register. POKECODE Write byte to code space at device programming time. POT Read potentiometer on specified pin. PULSIN Measure pulse width on a pin. PULSOUT Generate pulse on a pin. PWM Output pulse width modulated pulse train to pin. RANDOM Generate pseudo-random number. RCTIME Measure pulse width on a pin. READ Read byte from on-chip EEPROM. READCODE Read word from code memory. REPEAT..UNTIL Execute statements until condition is true. RESUME Continue execution after interrupt handling. RETURN Continue at statement following last GOSUB. REVERSE Make output pin an input or an input pin an output. SELECT CASE Compare a variable with different values. SERIN Asynchronous serial input (BS1 style). SERIN2 Asynchronous serial input (BS2 style). SEROUT Asynchronous serial output (BS1 style). SEROUT2 Asynchronous serial output (BS2 style). SHIFTIN Synchronous serial input. SHIFTOUT Synchronous serial output. SLEEP Power down processor for a period of time. 40
5. PicBasic Pro Statement Reference

@ Insert one line of assem bly language code. ADCIN Read on-chip analog to digital converter. ASM..ENDASM Insert assem bly language code section. BRANCH Com puted GOTO (equiv. to ON..GOTO). BRANCHL BRANCH out of page (long BRANCH). BUTTON Debounce and auto-repeat input on specified pin. CALL Call assem bly language subroutine. CLEAR Zero all variables. CLEARWDT Clear (tickle) W atchdog Tim er. COUNT Count num ber of pulses on a pin. DATA Define initial contents of on-chip EEPROM. DEBUG Asynchronous serial output to fixed pin and baud. DEBUGIN Asynchronous serial input from fixed pin and baud. DISABLE Disable ON DEBUG and ON INTERRUPT processing. DISABLE DEBUG Disable ON DEBUG processing. DISABLE INTERRUPT Disable ON INTERRUPT processing. DTMFOUT Produce touch-tone frequencies on a pin. EEPROM Define initial contents of on-chip EEPROM. ENABLE Enable ON DEBUG and ON INTERRUPT processing. ENABLE DEBUG Enable ON DEBUG processing. ENABLE INTERRUPT Enable ON INTERRUPT processing. END Stop program execution and enter low power m ode. ERASECODE Erase block of code m em ory. FOR..NEXT Repeatedly execute statem ents in a loop. FREQOUT Produce 1 or 2 frequencies on a pin. GOSUB Call BASIC subroutine at specified label. GOTO Continue execution at specified label. HIGH Make pin output high. HPWM Output hardware pulse width m odulated pulse train. HSERIN Hardware asynchronous serial input. HSERIN2 Hardware asynchronous serial input, second port. HSEROUT Hardware asynchronous serial output. HSEROUT2 Hardware asynchronous serial output, second port. I2CREAD Read from I 2C device. I2CWRITE W rite to I2C device. IF..THEN..ELSE..ENDIF Conditionally execute statem ents.
39
PicBasic Pro Compiler SOUND STOP SWAP TOGGLE USBIN USBINIT USBOUT WHILE..WEND WRITE WRITECODE XIN XOUT Generate tone or white-noise on specified pin. Stop program execution. Exchange the values of two variables. Make pin output and toggle state. USB input. Initialize USB. USB output. Execute statements while condition is true. Write byte to on-chip EEPROM. Write word to code memory. X-10 input. X-10 output.
5.1. @
@ Statement W hen used at the beginning of a line, @ provides a shortcut for inserting one assem bly language Statement into your PBP program . You can use this shortcut to m ix assem bly language code with PicBasic Pro statem ents. i Var rollme Var byte byte
For i = 1 To 4 rlf _rollme, F Next i
; Rotate byte left once
The @ shortcut can also be used to include assem bly language routines in another file. For exam ple: @ Include fp.asm
@ resets the register page to 0 before executing the assem bly language instruction. The register page should not be altered using @. See the section on assem bly language program m ing for m ore inform ation.
41
42
5.2. ADCIN
ADCIN Channel,Var Read the on-chip analog to digital converter Channel and store the result in Var. W hile the ADC registers can be accessed directly, ADCIN m akes the process a little easier. Before ADCIN can be used, the appropriate TRIS register m ust be set to m ake the desired pins inputs. ADCON1 or ANSEL also needs to be set to assign the desired pins to analog inputs and in som e cases to set the result form at and clock source. See the Microchip data sheets for m ore inform ation on these registers and how to set them for the specific device. Depending on the device, it m ay have an 8-, 10- or 12-bit ADC. The high bit of ADCON1 controls whether the result is left or right justified. In m ost cases, 8-bit results should be left justified (ADCON1.7 = 0) and 10- and 12-bit results should be right justified (ADCON1.7 = 1). Several DEFINEs m ay also be used. The defaults are shown below: DEFINE ADC_BITS 8 DEFINE ADC_CLOCK 3 DEFINE ADC_SAMPLEUS 50 Set number of bits in result (8, 10 or 12) Set clock source (rc = 3) Set sampling time in microseconds
5.3. ASM..ENDASM
ASM ENDASM The ASM and ENDASM instructions tells PBP that the code between these two lines is in assem bly language and should not be interpreted as PicBasic Pro statem ents. You can use these two instructions to m ix assem bly language code with PicBasic Pro statem ents. The m axim um size for an assem bler text section is 8K. This is the m axim um size for the actual source, including com m ents, not the generated code. If the text block is larger than this, you m ust break it into m ultiple ASM..ENDASM sections or sim ply include it in a separate file. ASM resets the register page to 0. You m ust ensure that the register page is reset to 0 before ENDASM, if the assem bly language code has altered it. ENDASM m ust not appear in a com m ent in the assem bly language section of the program . As the com piler cannot discern what is happening in the assem bly section, an ENDASM anywhere in an ASM section will cause the com piler to revert to BASIC parsing. See the section on assem bly language program m ing for m ore inform ation. ASM bsf PORTA, 0 bcf PORTB, 0 ENDASM ; Set bit 0 on PORTA ; Clear bit 0 on PORTB
ADC_SAMPLEUS is the num ber of m icroseconds the program waits between setting the Channel and starting the analog to digital conversion. This is the sam pling tim e. The m inim um num ber of m icroseconds usable is determ ined by the m inim um tim e for PAUSEUS. See its section for this inform ation. TRISA = 255 ADCON1 = 0 ADCIN 0, B0 Set PORTA to all input PORTA is analog Read channel 0 to B0
43
44
5.4. BRANCH
BRANCH Index,[Label{,Label...}] BRANCH causes the program to jum p to a different location based on a variable index. This is sim ilar to On..Goto in other BASICs. Index selects one of a list of Labels. Execution resum es at the indexed Label. For exam ple, if Index is zero, the program jum ps to the first Label specified in the list, if Index is one, the program jum ps to the second Label, and so on. If Index is greater than or equal to the num ber of Labels, no action is taken and execution continues with the statem ent following the BRANCH. Up to 255 (256 for PIC18Xxxx) Labels m ay be used in a BRANCH. For 12- and 14-bit core and PIC17Cxxx devices, Label m ust be in the sam e code page as the BRANCH instruction. If you cannot be sure they will be in the sam e code page, use BRANCHL below. For PIC18Xxxx devices, the Label m ust be within 1K of the BRANCH instruction as it uses a relative jum p. If the Label is out of this range, use BRANCHL. BRANCH B4,[dog,cat,fish] Same as: If B4=0 Then dog (goto dog) If B4=1 Then cat (goto cat) If B4=2 Then fish (goto fish)
5.5. BRANCHL
BRANCHL Index,[Label{,Label...}] BRANCHL (BRANCH long) works very sim ilarly to BRANCH in that it causes the program to jum p to a different location based on a variable index. The m ain differences are that it can jum p to a Label that is in a different code page than the BRANCHL instruction for 12- and 14-bit core and PIC17Cxxx devices, or further away than 1K for PIC18Xxxx devices and that it generates code that is about twice the size as code generated by the BRANCH instruction. If you are sure the labels are in the sam e page as the BRANCH instruction or if the m icrocontroller does not have m ore than one code page, using BRANCH instead of BRANCHL will m inim ize m em ory usage. Index selects one of a list of Labels. Execution resum es at the indexed Label. For exam ple, if Index is zero, the program jum ps to the first Label specified in the list, if Index is one, the program jum ps to the second Label, and so on. If Index is greater than or equal to the num ber of Labels, no action is taken and execution continues with the statem ent following the BRANCHL. Up to 127 (256 for PIC18Xxxx) Labels m ay be used in a BRANCHL. BRANCHL B4,[dog,cat,fish] Same as: If B4=0 Then dog (goto dog) If B4=1 Then cat (goto cat) If B4=2 Then fish (goto fish)
45
46
PicBasic Pro Compiler BUTTON accom plishes debounce by delaying program execution for a period of m illiseconds to wait for the contacts to settle down. The default debounce delay is 10m s. To change the debounce to another value, use DEFINE: Set button debounce delay to 50ms DEFINE BUTTON_PAUSE 50 Be sure that BUTTON_PAUSE is all in upper case. The m axim um delay for 12-bit core devices is 65m s. In general, it is easier to sim ply read the state of the pin in an IF..THEN than to use the BUTTON com m and as follows: If PORTB.2 = 1 Then notpressed
5.6. BUTTON
BUTTON Pin,Down,Delay,Rate,BVar,Action,Label Read Pin and optionally perform debounce and auto-repeat. Pin is autom atically m ade an input. Pin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Down Delay State of pin when button is pressed (0..1). Cycle count before auto-repeat starts (0..255). If 0, no debounce or auto-repeat is perform ed. If 255, debounce, but no auto-repeat, is perform ed. Auto-repeat rate (0..255). Byte-sized variable used internally for delay/repeat countdown. It m ust be initialized to 0 prior to use and not used elsewhere in the program . State of button to act on (0 if not pressed, 1 if pressed). Execution resum es at this label if Action is true.
Rate BVar
Action Label
Exam ple program : INCLUDE "modedefs.bas" SO Bpin B0 Con Con Var B0 = 0 0 2 Byte Include serial modes Define serial output pin Define Button input pin
Zero Button working buffer
loop: BUTTON Bpin,1,10,5,B0,0,notp
Goto notpressed if button not pressed on Pin2 BUTTON PORTB.2,0,100,10,B2,0,notpressed BUTTON needs to be used within a loop for auto-repeat to work properly.
Check button (skip if not pressed) Serout SO,N2400,["Press",13,10] ' Indicate button pressed notp: Serout SO,N2400,[#B0,13,10] ' Show working variable Pause 100 Goto loop Wait a little Do it forever
47
48
5.7. CALL
CALL Label Execute the assem bly language subroutine nam ed Label. GOSUB is norm ally used to execute a PicBasic Pro subroutine. The m ain difference between GOSUB and CALL is that with CALL, Labels existence is not checked until assem bly tim e. Using CALL, a Label in an assem bly language section can be accessed that is otherwise inaccessible to PBP. See the section on assem bly language program m ing for m ore inform ation on CALL. CALL pass Execute assembly language subroutine named _pass
5.8. CLEAR
CLEAR Set all RAM registers to zero. CLEAR zeroes all the RAM registers in each bank. This will set all variables, including the internal system variables (but not PICm icro MCU hardware registers) to zero. This is not autom atically done when a PBP program starts as it is on a BASIC Stam p. In general, the variables should be initialized in the program to an appropriate state rather than using CLEAR. CLEAR does not zero bank 0 registers on 12-bit core devices. CLEAR Clear all variables to 0
49
50
5.9. CLEARWDT
CLEARWDT Clear (tickle) the W atchdog Tim er. The W atchdog Tim er is used in conjunction with the SLEEP and NAP instructions to wake the PICm icro MCU after a certain period of tim e. Assem bler instructions (clrwdt) to keep the W atchdog Tim er from tim ing out under norm al circum stances and resetting the PICm icro MCU are autom atically inserted at appropriate places throughout the program . CLEARWDT allows the placem ent of additional clrwdt instructions in the program . CLEARWDT Clear Watchdog Timer
5.10. COUNT
COUNT Pin,Period,Var Count the num ber of pulses that occur on Pin during the Period and stores the result in Var. Pin is autom atically m ade an input. Pin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The resolution of Period is in m illiseconds. It tracks the oscillator frequency based on the DEFINEd OSC. COUNT checks the state of Pin in a tight loop and counts the low to high transitions. W ith a 4MHz oscillator it checks the pin state every 20us. W ith a 20MHz oscillator it checks the pin state every 4us. From this, it can be determ ined that the highest frequency of pulses that can be counted is 25KHz with a 4MHz oscillator and 125KHz with a 20MHz oscillator, if the frequency has a 50% duty cycle (the high tim e is the sam e as the low tim e). Count # of pulses on Pin1 in 100 milliseconds COUNT PORTB.1,100,W1 Determine frequency on a pin COUNT PORTA.2, 1000, W1 Count for 1 second Serout PORTB.0,N2400,[W1]
A DEFINE can be used to rem ove all of the clrwdt instructions the com piler autom atically adds. In m any cases, the clrwdt instruction is replaced with nop to preserve the tim ing of the routine. DEFINE NO_CLRWDT 1 Dont insert CLRWDTs
51
52
5.11. DATA
{Label} DATA {@Location,}Constant{,Constant...} Store constants in on-chip non-volatile EEPROM when the device is first program m ed. If the optional Location value is om itted, the first DATA statem ent starts storing at address 0 and subsequent statem ents store at the following locations. If the Location value is specified, it denotes the starting location where these values are stored. An optional Label (not followed by a colon) can be assigned to the starting EEPROM address for later reference by the program . Constant can be a num eric constant or a string constant. Only the least significant byte of num eric values are stored unless the WORD m odifier is used. Strings are stored as consecutive bytes of ASCII values. No length or term inator is autom atically added. DATA only works with m icrocontrollers with on-chip EEPROM such as the PIC12F675, 16F84, PIC16C84 and the PIC16F87x series. It will not work on devices with on-chip I2C interfaced serial EEPROM like the 12CE67x and 16CE62x parts. Since EEPROM is non-volatile m em ory, the data will rem ain intact even if the power is turned off. The data is stored in the EEPROM space only once at the tim e the m icrocontroller is program m ed, not each tim e the program is run. WRITE can be used to set the values of the on-chip EEPROM at runtim e. READ is used to retrieve these stored DATA values at runtim e. Store 10, 20 and 30 starting at location 4 DATA @4,10,20,30 Assign a label to a word at the next location dlabel DATA word $1234 Stores $34, $12 Skip 4 locations and store 10 0s DATA (4),0(10)
5.12. DEBUG
DEBUG Item{,Item...} Send one or m ore Items to a predefined pin at a predefined baud rate in standard asynchronous form at using 8 data bits, no parity and 1 stop bit (8N1). The pin is autom atically m ade an output. If a pound sign (#) precedes an Item, the ASCII representation for each digit is sent serially. DEBUG (on all devices except 12-bit core) also supports the sam e data m odifiers as SEROUT2. Refer to the section on SEROUT2 for this inform ation.
Modifier {I}{S}BIN{1..16} {I}{S}DEC{1..5} {I}{S}HEX{1..4} REP c\n STR ArrayVar{\n}
Operation Send binary digits Send decim al digits Send hexadecim al digits Send character c repeated n tim es Send string of n characters
DEBUG is one of several built-in asynchronous serial functions. It is the sm allest and fastest of the software generated serial routines. It can be used to send debugging inform ation (variables, program position m arkers, etc.) to a term inal program like Hyperterm . It can also be used anytim e serial output is desired on a fixed pin at a fixed baud rate. The serial pin and baud rate are specified using DEFINEs: Set Debug pin port DEFINE DEBUG_REG PORTB Set Debug pin bit DEFINE DEBUG_BIT 0 Set Debug baud rate DEFINE DEBUG_BAUD 2400
53
54
PicBasic Pro Compiler Set Debug mode: 0 = true, 1 = inverted DEFINE DEBUG_MODE 1 DEBUG assum es a 4MHz oscillator when generating its bit tim ing. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to any different oscillator value. In som e cases, the transm ission rates of DEBUG instructions m ay present characters too quickly to the receiving device. A DEFINE adds character pacing to the serial output transm issions. This allows additional tim e between the characters as they are transm itted. The character pacing DEFINE allows a delay of up to 65,535 m icroseconds (65.535 m illiseconds) between each character transm itted. For exam ple, to pause 1 m illisecond between the transm ission of each character: DEFINE DEBUG_PACING 1000 W hile single-chip RS-232 level converters are com m on and inexpensive, thanks to current RS-232 im plem entation and the excellent I/O specifications of the PICm icro MCU, m ost applications m ay not require level converters. Rather, inverted TTL (DEBUG_MODE 1) m ay be used. A current lim iting resistor is suggested (RS-232 is suppose to be short-tolerant). Modifier
5.13. DEBUGIN
DEBUGIN {Timeout,Label,}[Item{,Item...}] Receive one or m ore Items from a predefined pin at a predefined baud rate in standard asynchronous form at using 8 data bits, no parity and 1 stop bit (8N1). The pin is autom atically m ade an input. An optional Timeout and Label m ay be included to allow the program to continue if a character is not received within a certain am ount of tim e. Timeout is specified in 1 m illisecond units. If the serial input pin stays idle during the Timeout tim e, the program will exit the DEBUGIN com m and and jum p to Label. DEBUGIN (on all devices except 12-bit core) supports the sam e data m odifiers as SERIN2. Refer to the section on SERIN2 for this inform ation. Operation Receive binary digits Receive decim al digits Receive upper case hexadecim al digits Skip n received characters Receive string of n characters optionally ended in character c W ait for sequence of characters W ait for character string
BIN{1..16} DEC{1..5} HEX{1..4} SKIP n STR ArrayVar\n{\c} WAIT ( ) WAITSTR ArrayVar{\n}
Send the text B0= followed by the decimal value of B0 and a linefeed out serially DEBUG B0=,DEC B0,10
DEBUGIN is one of several built-in asynchronous serial functions. It is the sm allest and fastest of the software generated serial routines. It can be used to receive debugging inform ation from a term inal program like Hyperterm . It can also be used anytim e serial input is desired on a fixed pin at a fixed baud rate. The serial pin and baud rate are specified using DEFINEs:
55
56
PicBasic Pro Compiler Set Debugin pin port DEFINE DEBUGIN_REG Set Debugin pin bit DEFINE DEBUGIN_BIT
5.14. DISABLE
PORTB DISABLE 0 DISABLE both debug and interrupt processing following this instruction. Interrupts can still occur but the BASIC interrupt handler in the PicBasic Pro program and the debug m onitor will not be executed until an ENABLE is encountered. DISABLE and ENABLE are pseudo-ops in that they give the com piler directions, rather than actually generate code. See ON DEBUG and ON INTERRUPT for m ore inform ation. DISABLE myint: led = 1 Resume Enable Disable interrupts in handler Turn on LED when interrupted Return to main program Enable interrupts after handler
Set Debugin baud rate (same as Debug baud) DEFINE DEBUG_BAUD 2400 Set Debugin mode: 0 = true, 1 = inverted DEFINE DEBUGIN_MODE 1 If any of these DEFINEs are not included in a program , the DEBUGIN port, pin or m ode is set to the sam e values as they are for DEBUG. The DEBUGIN baud rate is always the sam e as DEBUGs. It cannot be DEFINEd differently. DEBUGIN assum es a 4MHz oscillator when generating its bit tim ing. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to any different oscillator value. W hile single-chip RS-232 level converters are com m on and inexpensive, thanks to current RS-232 im plem entation and the excellent I/O specifications of the PICm icro MCU, m ost applications m ay not require level converters. Rather, inverted TTL (DEBUGIN_MODE 1) m ay be used. A current lim iting resistor is necessary to dissipate the higher and som etim es negative RS-232 voltage.
Wait until the character A is received serially and put next character into B0 DEBUGIN [WAIT(A),B0] Skip 2 chars and grab a 4 digit decimal number DEBUGIN [SKIP 2,DEC4 B0]
57
58
5.15. DISABLE DEBUG

DISABLE DEBUG DISABLE DEBUG processing following this instruction. The debug m onitor will not be called between instructions until an ENABLE or ENABLE DEBUG is encountered. DISABLE DEBUG and ENABLE DEBUG are pseudo-ops in that they give the com piler directions, rather than actually generate code. See ON DEBUG for m ore inform ation. DISABLE DEBUG Disable debug monitor calls
5.16. DISABLE INTERRUPT

DISABLE INTERRUPT DISABLE INTERRUPT processing following this instruction. Interrupts can still occur but the BASIC interrupt handler in the PicBasic Pro program will not be executed until an ENABLE or ENABLE INTERRUPT is encountered. DISABLE INTERRUPT and ENABLE INTERRUPT are pseudo-ops in that they give the com piler directions, rather than actually generate code. See ON INTERRUPT for m ore inform ation. DISABLE INTERRUPT Disable interrupts in handler myint: led = 1 Turn on LED when interrupted Resume Return to main program Enable Interrupt Enable interrupts after handler
59
60
5.17. DTMFOUT
DTMFOUT Pin,{Onms,Offms,}[Tone{,Tone...}] Produce DTMF touch Tone sequence on Pin. Pin is autom atically m ade an output. Pin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Onms is the num ber of m illiseconds to sound each tone and Offms is the num ber of m illiseconds to pause between each tone. If they are not specified, Onms defaults to 200m s and Offms defaults to 50m s. Tones are num bered 0-15. Tones 0-9 are the sam e as on a telephone keypad. Tone 10 is the * key, Tone 11 is the # key and Tones 12-15 correspond to the extended keys A-D. DTMFOUT uses FREQOUT to generate the dual tones. FREQOUT generates tones using a form of pulse width m odulation. The raw data com ing out of the pin looks pretty scary. Som e kind of filter is usually necessary to sm ooth the signal to a sine wave and get rid of som e of the harm onics that are generated:
5.18. EEPROM
EEPROM {Location,}[Constant{,Constant...}] Store constants in on-chip EEPROM. If the optional Location value is om itted, the first EEPROM statem ent starts storing at address 0 and subsequent statem ents store at the following locations. If the Location value is specified, it denotes the starting location where these values are stored. Constant can be a num eric constant or a string constant. Only the least significant byte of num eric values are stored. Strings are stored as consecutive bytes of ASCII values. No length or term inator is autom atically added. EEPROM only works with m icrocontrollers with on-chip EEPROM such as the PIC12F675, 16F84, PIC16C84 and the PIC16F87x series. It will not work on devices with on-chip I2C interfaced serial EEPROM like the 12CE67x and 16CE62x parts. Since EEPROM is non-volatile m em ory, the data will rem ain intact even if the power is turned off. The data is stored in the EEPROM space only once at the tim e the m icrocontroller is program m ed, not each tim e the program is run. WRITE can be used to set the values of the on-chip EEPROM at runtim e. READ is used to retrieve these stored DATA values at runtim e. Store 10, 20 and 30 starting at location 4 EEPROM 4,[10,20,30]
DTMFOUT works best with a 20MHz or 40MHz oscillator. It can also work with a 10MHz oscillator and even at 4MHz, although it will start to get very hard to filter and be of fairly low am plitude. Any other frequency m ay not be used with DTMFOUT. DTMFOUT is not supported on 12-bit core PICm icro MCUs due to RAM and stack constraints. Send DTMF tones for 212 on Pin1 DTMFOUT PORTB.1,[2,1,2]
61
62
5.19. ENABLE
ENABLE ENABLE debug and interrupt processing that was previously DISABLEd following this instruction. DISABLE and ENABLE are pseudo-ops in that they give the com piler directions, rather than actually generate code. See ON DEBUG and ON INTERRUPT for m ore inform ation. Disable myint: led = 1 Resume ENABLE Disable interrupts in handler Turn on LED when interrupted Return to main program Enable interrupts after handler
5.20. ENABLE DEBUG

ENABLE DEBUG ENABLE DEBUG processing that was previously DISABLEd following this instruction. DISABLE DEBUG and ENABLE DEBUG are pseudo-ops in that they give the com piler directions, rather than actually generate code. See ON DEBUG for m ore inform ation. ENABLE DEBUG Enable calls to the debug monitor
63
64
5.21. ENABLE INTERRUPT

ENABLE INTERRUPT ENABLE INTERRUPT processing that was previously DISABLEd following this instruction. DISABLE INTERRUPT and ENABLE INTERRUPT are pseudo-ops in that they give the com piler directions, rather than actually generate code. See ON INTERRUPT for m ore inform ation. Disable Interrupt Disable interrupts in handler myint: led = 1 Turn on LED when interrupted Resume Return to main program ENABLE INTERRUPT Enable interrupts after handler
5.22. END
END Stop program execution and enter low power m ode. All of the I/O pins rem ain in their current state. END works by executing a Sleep instruction continuously in a loop. An END or STOP or GOTO should be placed at the end of every program to keep it from falling off the end of m em ory and starting over. END
65
66
5.23. ERASECODE
ERASECODE Block Som e flash PICm icro MCUs, like the PIC18Fxxx series, require a portion of the code space to be erased before it can be rewritten with WRITECODE. On these devices, an erase is perform ed a block at a tim e. An erase block m ay be 32 words (64 bytes) or another size, depending on the device. This size is usually larger than the write block size. See the Microchip data sheet for inform ation on the size of the erase block for the particular PICm icro MCU you are using. The first location of the block to be erased should be specified by Block. Block is a byte address from 0 to 65535, rather than a word address, for PIC18Fxxx devices. Be careful not to specify a Block that contains program code. Flash program writes m ust be enabled in the configuration for the PICm icro MCU at device program m ing tim e for ERASECODE to be able to erase. Using this instruction on devices that do not support block erase will cause a com pilation error. ERASECODE $100 Erase code block starting at location $100
5.24. FOR..NEXT
FOR Count = Start TO End {STEP {-} Inc} {Body} NEXT {Count} The FOR..NEXT loop allows program s to execute a num ber of statem ents (the Body) som e num ber of tim es using a variable as a counter. Due to its com plexity and versatility, FOR..NEXT is best described step by step: 1) 2) 3) The value of Start is assigned to the index variable, Count. Count can be a variable of any type. The Body is executed. The Body is optional and can be om itted (perhaps for a delay loop). The value of Inc is added to (or subtracted from if - is specified) Count. If no STEP clause is defined, Count is increm ented by one. If Count has not passed End or overflowed the variable type, execution returns to Step 2.
4)
If the loop needs to Count to m ore than 255, a word-sized variable m ust be used. FOR i = 1 TO 10 Count from 1 to 10 Serout 0,N2400,[#i, ] Send each number to Pin0 serially NEXT i Go back to and do next count Serout 0,N2400,[10] Send a linefeed
FOR B2 = 20 TO 10 STEP -2
Count from 20 to 10 by 2 Serout 0,N2400,[#B2, ] Send each number to Pin0 serially NEXT B2 Go back to and do next count Serout 0,N2400,[10] Send a linefeed
67
68
5.25. FREQOUT
FREQOUT Pin,Onms,Frequency1{,Frequency2} Produce the Frequency(s) on Pin for Onms m illiseconds. Pin is autom atically m ade an output. Pin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). One or two different frequencies from 0 to 32767 Hertz m ay be produced at a tim e. FREQOUT generates tones using a form of pulse width m odulation. The raw data com ing out of the pin looks pretty scary. Som e kind of filter is usually necessary to sm ooth the signal to a sine wave and get rid of som e of the harm onics that are generated:
5.26. GOSUB
GOSUB Label Jum p to the subroutine at Label saving its return address on the stack. Unlike GOTO, when a RETURN statem ent is reached, execution resum es with the statem ent following the last executed GOSUB statem ent. An unlim ited num ber of subroutines m ay be used in a program . Subroutines m ay also be nested. In other words, it is possible for a subroutine to call another subroutine. Such subroutine nesting m ust be restricted to no m ore than four levels deep (12 levels for 17Cxxx and 27 levels for 18Xxxx). GOSUB beep Execute subroutine named beep ... beep: High 0 Turn on LED connected to Pin0 Sound 1,[80,10] Beep speaker connected to Pin1 Low 0 Turn off LED connected to Pin0 Return Go back to main routine that called us
FREQOUT works best with a 20MHz or 40MHz oscillator. It can also work with a 10MHz oscillator and even at 4MHz, although it will start to get very hard to filter and be of fairly low am plitude. Any other frequency will cause FREQOUT to generate a frequency that is a ratio of the actual oscillator used and 20MHz. FREQOUT is not supported on 12-bit core PICm icro MCUs due to RAM and stack constraints. Send 1KHz tone on Pin1 for 2 seconds FREQOUT PORTB.1,2000,1000 Send 350Hz / 440Hz (Dial Tone) for 2 seconds FREQOUT PORTB.1,2000,350,440
69
70
5.27. GOTO
GOTO Label Program execution continues with the statem ents at Label. GOTO send Jump to statement labeled send ... send: Serout 0,N2400,[Hi] Send Hi out Pin0 serially
5.28. HIGH
HIGH Pin Make the specified Pin high. Pin is autom atically m ade an output. Pin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). HIGH 0 HIGH PORTA.0 Make Pin0 an output and set it high (~5 volts) Make PORTA, pin 0 an output and set it high (~5 volts) Define LED pin Make LED pin an output and set it high (~5 volts)
led
var PORTB.0 HIGH led
Alternatively, if the pin is already an output, a m uch quicker and shorter way (from a generated code standpoint) to set it high would be: PORTB.0 = 1 Set PORTB pin 0 high
71
72
PicBasic Pro Compiler OSC 4MHz 8MHz 10MHz 12MHz 16MHz 20MHz 24MHz 25MHz 33MHz 14-bit core and 18Xxxx 245Hz 489Hz 611Hz 733Hz 977Hz 1221Hz 1465Hz 1527Hz 2015Hz 2442Hz 17Cxxx 3907Hz 7813Hz 9766Hz 11719Hz 15625Hz 19531Hz 23438Hz 24415Hz 32227Hz na
5.29. HPWM
HPWM Channel,Dutycycle,Frequency Output a pulse width m odulated pulse train using PW M hardware available on som e PICm icro MCUs. It can run continuously in the background while the program is executing other instructions. Channel specifies which hardware PW M channel to use. Som e devices have 1, 2 or 3 PW M Channels. The Microchip data sheet for the particular device shows the fixed hardware pin for each Channel. For exam ple, for a PIC16F877, Channel 1 is CCP1 which is pin PORTC.2. Channel 2 is CCP2 which is pin PORTC.1. Som e devices, such as the PIC18C452, have alternate pins that m ay be used for HPWM. The following DEFINEs allow using these pins: DEFINE DEFINE DEFINE DEFINE CCP1_REG CCP1_BIT CCP2_REG CCP2_BIT PORTC 2 PORTC 1 Hpwm Hpwm Hpwm Hpwm 1 1 2 2 pin pin pin pin port bit port bit
40MHz
Dutycycle specifies the on/off (high/low) ratio of the signal. It ranges from 0 to 255, where 0 is off (low all the tim e) and 255 is on (high) all the tim e. A value of 127 gives a 50% duty cycle (square wave). Frequency is the desired frequency of the PW M signal. On devices with 2 channels, the Frequency m ust be the sam e on both channels. Not all frequencies are available at all oscillator settings. The highest frequency at any oscillator speed is 32767Hz. The lowest usable HPWM Frequency at each oscillator setting is shown in the following table:
The following DEFINEs specify which tim er, 1 or 2, to use with PW M channel 2 and PW M channel 3 for the PIC17C7xx devices. The default is tim er 1 if no DEFINE is specified. DEFINE HPWM2_TIMER 1 DEFINE HPWM3_TIMER 1 Hpwm 2 timer select Hpwm 3 timer select
After an HPWM com m and, the CCP control register is left in PW M m ode. If the CCP pin is to be used as a norm al I/O pin after an HPWM com m and, the CCP control register will need to be set to PW M off. See the Microchip data sheet for the particular device for m ore inform ation. HPWM 1,127,1000 Send a 50% duty cycle PWM signal at 1kHz Send a 25% duty cycle PWM signal at 2kHz
HPWM 1,64,2000
73
74
PicBasic Pro Compiler An optional Timeout and Label m ay be included to allow the program to continue if a character is not received within a certain am ount of tim e. Timeout is specified in 1 m illisecond units. If no character is received during the Timeout tim e, the program will exit the HSERIN com m and and jum p to Label. The serial data form at defaults to 8N1, 8 data bits, no parity bit and 1 stop bit. 7E1 (7 data bits, even parity, 1 stop bit) or 7O1 (7data bits, odd parity, 1 stop bit) can be enabled using one of the following DEFINEs: Use only if even parity desired DEFINE HSER_EVEN 1 Use only if odd parity desired DEFINE HSER_ODD 1 Use 8 bits + parity DEFINE HSER_BITS 9 The parity setting, along with all of the other HSER DEFINEs, affect both HERIN and HSEROUT. An optional ParityLabel m ay be included in the statem ent. The program will continue at this location if a character with a parity error is received. It should only be used if parity is enabled using one of the preceding DEFINEs. As the hardware serial port only has a 2 byte input buffer, it can easily overflow if characters are not read from it often enough. W hen this happens, the USART stops accepting new characters and needs to be reset. This overflow error can be reset by toggling the CREN bit in the RCSTA register. A DEFINE can be used to autom atically clear this error. However, you will not know that an error has occurred and characters m ay have been lost. DEFINE HSER_CLROERR To m anually clear an overrun error: RCSTA.4 = 0 RCSTA.4 = 1 76 1
5.30. HSERIN
HSERIN {ParityLabel,}{Timeout,Label,}[Item{,...}] Receive one or m ore Items from the hardware serial port on devices that support asynchronous serial com m unications in hardware. HSERIN is one of several built-in asynchronous serial functions. It can only be used with devices that have a hardware USART. See the device data sheet for inform ation on the serial input pin and other param eters. The serial param eters and baud rate are specified using DEFINEs: Set receive register to receiver enabled DEFINE HSER_RCSTA 90h Set transmit register to transmitter enabled DEFINE HSER_TXSTA 20h Set baud rate DEFINE HSER_BAUD
2400
Set SPBRG directly (normally set by HSER_BAUD) DEFINE HSER_SPBRG 25 HSER_RCSTA, HSER_TXSTA and HSER_SPBRG sim ply set each respective PICm icro MCU register, RCSTA, TXSTA and SPBRG to the hexadecim al value DEFINEd, once, at the beginning of the program . See the Microchip data sheet for the device for m ore inform ation on each of these registers. The TXSTA register BRGH bit (bit 2) controls the high speed m ode for the baud rate generator. Certain baud rates at certain oscillator speeds require this bit to be set to operate properly. To do this, set HSER_TXSTA to 24h instead of 20h. All baud rates at all oscillator speeds m ay not be supported by the device. See the Microchip data sheet for the hardware serial port baud rate tables and additional inform ation. HSERIN assum es a 4MHz oscillator when calculating the baud rate. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to the new oscillator value.
75
PicBasic Pro Compiler Since the serial reception is done in hardware, it is not possible to set the levels to an inverted state to elim inate an RS-232 driver. Therefore a suitable driver should be used with HSERIN. On devices with 2 hardware serial ports, HSERIN will only use the first port. The second port m ay read using HSERIN2. HSERIN supports the sam e data m odifiers that SERIN2 does. Refer to the section on SERIN2 for this inform ation.
5.31. HSERIN2
HSERIN2 {ParityLabel,}{Timeout,Label,}[Item{,...}] Receive one or m ore Items from the second hardware serial port on devices that support asynchronous serial com m unications in hardware. HSERIN2 works the sam e as HSERIN with the exception that is uses the second hardware serial port on devices that have 2 ports such as the PIC18F8720 It can only be used with devices that have 2 hardware USARTs. See the device data sheet for inform ation on the serial output pin and other param eters and the above section on HSERIN for m ore com m and details. The serial param eters and baud rate are specified using DEFINEs: Set receive register to receiver enabled DEFINE HSER2_RCSTA 90h Set transmit register to transmitter enabled DEFINE HSER2_TXSTA 20h Set baud rate DEFINE HSER2_BAUD 2400 Set SPBRG2 (normally set by HSER2_BAUD) DEFINE HSER2_SPBRG 25 Use only if even parity desired DEFINE HSER2_EVEN 1 Use only if odd parity desired DEFINE HSER2_ODD 1 Use 8 bits + parity DEFINE HSER2_BITS 9 Automatically clear overflow errors DEFINE HSER2_CLROERR 1 HSERIN2 [B0,DEC W1]
Modifier BIN{1..16} DEC{1..5} HEX{1..4} SKIP n STR ArrayVar\n{\c} WAIT ( ) WAITSTR ArrayVar{\n} HSERIN [B0,DEC W1]
Operation Receive binary digits Receive decim al digits Receive upper case hexadecim al digits Skip n received characters Receive string of n characters optionally ended in character c W ait for sequence of characters W ait for character string
77
78
PicBasic Pro Compiler The serial data form at defaults to 8N1, 8 data bits, no parity bit and 1 stop bit. 7E1 (7 data bits, even parity, 1 stop bit) or 7O1 (7data bits, odd parity, 1 stop bit) can be enabled using one of the following DEFINEs: Use only if even parity desired DEFINE HSER_EVEN 1 Use only if odd parity desired DEFINE HSER_ODD 1 Use 8 bits + parity DEFINE HSER_BITS 9 The parity setting, along with all of the other HSER DEFINEs, affect both HERIN and HSEROUT. Since the serial transm ission is done in hardware, it is not possible to set the levels to an inverted state to elim inate an RS-232 driver. Therefore a suitable driver should be used with HSEROUT. On devices with 2 hardware serial ports, HSEROUT will only use the first port. The second port m ay be accessed using HSEROUT2. HSEROUT supports the sam e data m odifiers that SEROUT2 does. Refer to the section on SEROUT2 for this inform ation.
5.32. HSEROUT
HSEROUT [Item{,Item...}] Send one or m ore Items to the hardware serial port on devices that support asynchronous serial com m unications in hardware. HSEROUT is one of several built-in asynchronous serial functions. It can only be used with devices that have a hardware USART. See the device data sheet for inform ation on the serial output pin and other param eters. The serial param eters and baud rate are specified using DEFINEs: Set receive register to receiver enabled DEFINE HSER_RCSTA 90h Set transmit register to transmitter enabled DEFINE HSER_TXSTA 20h Set baud rate DEFINE HSER_BAUD
2400
Set SPBRG directly (normally set by HSER_BAUD) DEFINE HSER_SPBRG 25 HSER_RCSTA, HSER_TXSTA and HSER_SPBRG sim ply set each respective PICm icro MCU register, RCSTA, TXSTA and SPBRG to the hexadecim al value DEFINEd, once, at the beginning of the program . See the Microchip data sheet for the device for m ore inform ation on each of these registers. The TXSTA register BRGH bit (bit 2) controls the high speed m ode for the baud rate generator. Certain baud rates at certain oscillator speeds require this bit to be set to operate properly. To do this, set HSER_TXSTA to 24h instead of 20h. All baud rates at all oscillator speeds m ay not be supported by the device. See the Microchip data sheet for the hardware serial port baud rate tables and additional inform ation. HSEROUT assum es a 4MHz oscillator when calculating the baud rate. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to the new oscillator value.
Send the decimal value of B0 followed by a linefeed out the hardware USART HSEROUT [DEC B0,10]
79
80
5.33. HSEROUT2
HSEROUT2 [Item{,Item...}] Send one or m ore Items to the second hardware serial port on devices that support asynchronous serial com m unications in hardware. HSEROUT2 works the sam e as HSEROUT with the exception that is uses the second hardware serial port on devices that have 2 ports such as the PIC18F8720. It can only be used with devices that have 2 hardware USARTs. See the device data sheet for inform ation on the serial output pin and other param eters and the above section on HSEROUT for m ore com m and details. The serial param eters and baud rate are specified using DEFINEs: Set receive register to receiver enabled DEFINE HSER2_RCSTA 90h Set transmit register to transmitter enabled DEFINE HSER2_TXSTA 20h Set baud rate DEFINE HSER2_BAUD 2400 Set SPBRG2 (normally set by HSER2_BAUD) DEFINE HSER2_SPBRG 25 Use only if even parity desired DEFINE HSER2_EVEN 1 Use only if odd parity desired DEFINE HSER2_ODD 1 Use 8 bits + parity DEFINE HSER2_BITS 9
5.34. I2CREAD
I2CREAD DataPin,ClockPin,Control,{Address,} [Var{,Var...}]{,Label} Send Control and optional Address bytes out the ClockPin and DataPin and store the byte(s) received into Var. ClockPin and DataPin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). I2CREAD and I2CWRITE can be used to read and write data to a serial EEPROM with a 2-wire I2C interface such as the Microchip 24LC01B and sim ilar devices. This allows data to be stored in external non-volatile m em ory so that it can be m aintained even after the power is turned off. These com m ands operate in the I2C m aster m ode and m ay also be used to talk to other devices with an I2C interface like tem perature sensors and A/D converters. For 12-bit core PICm icro MCUs only, the I2C clock and data pins are fixed at com pile tim e by DEFINEs. They still m ust be specified in the I2CREAD statem ents, though this inform ation is ignored by the com piler. DEFINE I2C_SCL PORTA,1 DEFINE I2C_SDA PORTA,0 For 12-bit core only For 12-bit core only
The upper 7 bits of the Control byte contain the control code along with chip select or additional address inform ation, depending on the particular device. The low order bit is an internal flag indicating whether it is a read or write com m and and should be kept clear. This form at for the Control byte is different than the form at used by the original PicBasic Com piler. Be sure to use this form at with PBP I2C operations. For exam ple, when com m unicating with a 24LC01B, the control code is %1010 and the chip selects are unused so the Control byte would be %10100000 or $A0. Form ats of Control bytes for som e of the different parts follows:
Send the decimal value of B0 followed by a linefeed out the hardware USART HSEROUT2 [DEC B0,10]
81
82
PicBasic Pro Compiler Device 24LC01B 24LC02B 24LC04B 24LC08B 24LC16B 24LC32B 24LC65 Capacity 128 bytes 256 bytes 512 bytes 1K bytes 2K bytes 4K bytes 8K bytes Control %1010xxx0 %1010xxx0 %1010xxb0 %1010xbb0 %1010bbb0 %1010ddd0 %1010ddd0 Address size 1 byte 1 byte 1 byte 1 byte 1 byte 2 bytes 2 bytes
PicBasic Pro Compiler If a word-sized array is specified, the 2 bytes that com prise each elem ent are read low byte first. This is the opposite of how sim ple words are read and is consistent with the way the com piler norm ally stores word-sized variables. If the optional Label is included, this label will be jum ped to if an acknowledge is not received from the I2C device. The I 2C instructions can be used to access the on-chip serial EEPROM on the 12CExxx and 16CExxx devices. Sim ply specify the pin nam es for the appropriate internal lines as part of the I2C com m and and place the following DEFINE at the top of the program : DEFINE I2C_INTERNAL 1 For the 12CE67x devices, the data line is GPIO.6 and the clock line is GPIO.7. For the 16CE62x devices, the data line is EEINTF.1 and the clock line is EEINTF.2. See the Microchip data sheets for these devices for m ore inform ation. The tim ing of the I2C instructions is set so that standard speed devices (100kHz) will be accessible at clock speeds up to 8MHz. Fast m ode devices (400kHz) m ay be used up to 20MHz. If it is desired to access a standard speed device at above 8MHz, the following DEFINE should be added to the program : DEFINE I2C_SLOW 1
bbb = block select (high order address) bits ddd = device select bits xxx = dont care The Address size sent (byte or word) is determ ined by the size of the variable that is used. If a byte-sized variable is used for the Address, an 8-bit address is sent. If a word-sized variable is used, a 16-bit address is sent. Be sure to use the proper sized variable for the device you wish to com m unicate with. Constants should not be used for the Address as the size can vary dependent on the size of the constant. Also, expressions should not be used as they can cause an im proper Address size to be sent. If a word-sized Var is specified, 2 bytes are read and stored into the Var high byte first, followed by the low byte. This order is different than the way variables are norm ally stored, low byte first. A m odifier, STR, m ay be included before the variable nam e. This can load an entire array (string) at once. If STR is specified, the following variable m ust be the nam e of a word or byte array, followed by a backslash (\) and a count: a addr var byte[8] var byte addr = 0 I2CREAD PORTC.4,PORTC.3,$a0,addr,[STR a\8]
Because of m em ory and stack constraints, this DEFINE for 12-bit core PICm icro MCUs does not do anything. Low-speed (100 kHz) I2C devices m ay be used up to 4MHz. Above 4MHz, high-speed (400kHz) devices should be used. Transfer on the I2C bus can be paused by the receiving device by its holding the clock line low (not supported on 12-bit core PICm icro MCUs). To enable this the following DEFINE should be added to the program : DEFINE I2C_HOLD 1
83
84
PicBasic Pro Compiler The I2C clock and data lines should be pulled up to Vcc with a 4.7K resistor per the following schem atic as they are both run in a bidirectional open-collector m anner. To m ake the I2C clock line bipolar instead of open-collector the following DEFINE m ay be added to the program : DEFINE I2C_SCLOUT 1
5.35. I2CWRITE
I2CWRITE DataPin,ClockPin,Control,{Address,} [Value{,Value...}]{,Label} I2CWRITE sends Control and optional Address out the I2C ClockPin and DataPin followed by Value. ClockPin and DataPin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). For 12-bit core PICm icro MCUs only, the I2C clock and data pins are fixed at com pile tim e by DEFINEs. They still m ust be specified in the I2CWRITE statem ents, though this inform ation is ignored by the com piler. DEFINE I2C_SCL PORTA,1 DEFINE I2C_SDA PORTA,0 For 12-bit core only For 12-bit core only
addr cont
var byte con %10100000 addr = 17 Set address to 17 Read data at address 17 into B2 I2CREAD PORTA.0,PORTA.1,cont,addr,[B2]
The Address size sent (byte or word) is determ ined by the size of the variable that is used. If a byte-sized variable is used for the Address, an 8-bit address is sent. If a word-sized variable is used, a 16-bit address is sent. Be sure to use the proper sized variable for the device you wish to com m unicate with. Constants should not be used for the Address as the size can vary dependent on the size of the constant. Also, expressions should not be used as they can cause an im proper Address size to be sent. W hen writing to a serial EEPROM, it is necessary to wait 10m s (device dependent) for the write to com plete before attem pting com m unication with the device again. If a subsequent I2CREAD or I2CWRITE is attem pted before the write is com plete, the access will be ignored. W hile a single I2CWRITE statem ent m ay be used to write m ultiple bytes at once, doing so m ay violate the above write tim ing requirem ent for serial EEPROMs. Som e serial EEPROMS let you write m ultiple bytes into a single page before necessitating the wait. Check the data sheet for the specific device you are using for these details. The m ultiple byte write feature m ay also be useful with I2C devices other than serial EEPROMs that dont have to wait between writes.
See the Microchip Non-Volatile Mem ory Products Data Book for m ore inform ation on these and other devices that m ay be used with the I2CREAD and I2CWRITE com m ands.
85
86
PicBasic Pro Compiler If a word-sized Value is specified, 2 bytes are sent, high byte first, followed by the low byte. This order is different than the way variables are norm ally stored, low byte first. A m odifier, STR, m ay be included before the variable nam e. This can be used to write an entire array (string) at once and take advantage of a serial EEPROMs page m ode. The data m ust fit into a single SEEPROM page. The page size is dependent on the particular SEEPROM device. If STR is specified, the following variable m ust be the nam e of a word or byte array, followed by a backslash (\) and a count: a addr var byte[8] var byte addr = 0 I2CWRITE PORTC.4,PORTC.3,$a0,addr,[STR a\8]
PicBasic Pro Compiler DEFINE I2C_SLOW 1
Because of m em ory and stack constraints, this DEFINE for 12-bit core PICm icro MCUs does not do anything. Low-speed (100 kHz) I2C devices m ay be used up to 4MHz. Above 4MHz, high-speed (400kHz) devices should be used. Transfer on the I2C bus can be paused by the receiving device by its holding the clock line low (not supported on 12-bit core PICm icro MCUs). To enable this the following DEFINE should be added to the program : DEFINE I2C_HOLD 1
To m ake the I2C clock line bipolar instead of open-collector the following DEFINE m ay be added to the program : DEFINE I2C_SCLOUT 1
If a word-sized array is specified, the 2 bytes that com prise each elem ent are written low byte first. This is the opposite of how sim ple words are written and is consistent with the way the com piler norm ally stores wordsized variables. If the optional Label is included, this label will be jum ped to if an acknowledge is not received from the I2C device. The I2C instructions can be used to access the on-chip serial EEPROM on the 12CExxx and 16CExxx devices. Sim ply specify the pin nam es for the appropriate internal lines as part of the I2C com m and and place the following DEFINE at the top of the program : DEFINE I2C_INTERNAL 1 For the 12CE67x devices, the data line is GPIO.6 and the clock line is GPIO.7. For the 16CE62x devices, the data line is EEINTF.1 and the clock line is EEINTF.2. See the Microchip data sheets for these devices for m ore inform ation. The tim ing of the I2C instructions is set so that standard speed devices (100kHz) will be accessible at clock speeds up to 8MHz. Fast m ode devices (400kHz) m ay be used up to 20MHz. If it is desired to access a standard speed device at above 8MHz, the following DEFINE should be added to the program : 87
See the I2CREAD com m and above for the rest of the story. addr cont var con byte %10100000
addr = 17 Set address to 17 Send the byte 6 to address 17 I2CWRITE PORTA.0,PORTA.1,cont,addr,[6] Pause 10 Wait 10ms for write to complete addr = 1 Set address to 1 Send the byte in B2 to address 1 I2CWRITE PORTA.0,PORTA.1,cont,addr,[B2] Pause 10 Wait 10ms for write to complete
88
PicBasic Pro Compiler If PORTB.0 Then itson If PORTB, pin 0 is high (1), jump to itson
5.36. IF..THEN
IF Comp {AND/OR Comp...} THEN Label
If (B0 = 10) And (B1 = 20) Then loop IF Comp {AND/OR Comp...} THEN Statement... IF Comp {AND/OR Comp...} THEN Statement... ELSE Statement... ENDIF Perform s one or m ore com parisons. Each Comp term can relate a variable to a constant or other variable and includes one of the com parison operators listed previously. IF..THEN evaluates the com parison term s for true or false. If it evaluates to true, the operation after the THEN is executed. If it evaluates to false, the operation after the THEN is not executed. Com parisons that evaluate to 0 are considered false. Any other value is considered true. All com parisons are unsigned since PBP only supports unsigned types. IF..THEN cannot be used to check if a num ber is less than 0. It is essential to use parenthesis to specify the order in which the operations should be tested. Otherwise, operator precedence will determ ine it for you and the result m ay not be as expected. IF..THEN can operate in 2 m anners. In one form , the THEN in an IF..THEN is essentially a GOTO. If the condition is true, the program will GOTO the label after the THEN. If the condition evaluates to false, the program will continue at the next line after the IF..THEN. If Pin0 = 0 Then pushd If button connected to Pin0 is pushed (0), jump to label pushd If the value in variable B0 is greater than or equal to 40, jump to old 89 90 In the second form , IF..THEN can conditionally execute a group of Statements following the THEN. The Statements m ay be placed after the THEN or m ay be on another line and followed by an optional ELSE and non-optional ENDIF to com plete the structure. If B0 <> 10 Then B0 = B0 + 1: B1 = B1 - 1 If B0 <> 10 Then B0 = B0 + 1 B1 = B1 - 1 Endif If B0 = 20 Then led = 1 Else led = 0 Endif
If B0 >= 40 Then old
5.37. INPUT
INPUT Pin Makes the specified Pin an input. Pin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). INPUT 0 INPUT PORTA.0 Make Pin0 an input Make PORTA, pin 0 an input
5.38. LCDIN
LCDIN {Address,}[Var{,Var...}] Read LCD RAM at Address and store data to Var. LCDs have RAM onboard that is used for character m em ory. Most LCDs have m ore RAM available that is necessary for the displayable area. This RAM can be written using the LCDOUT instruction. The LCDIN instruction allows this RAM to be read. CG (character generator) RAM runs from address $40 to $7f. Display data RAM starts at address $80. See the data sheet for the specific LCD for these addresses and functions. It is necessary to connect the LCD read/write line to a PICm icro MCU pin so that it m ay be controlled to select either a read (LCDIN) or write (LCDOUT) operation. Two DEFINEs control the pin address: DEFINE LCD_RWREG PORTE DEFINE LCD_RWBIT 2 LCD read/write pin port LCD read/write pin bit
Alternatively, the pin m ay be set to an input in a m uch quicker and shorter way (from a generated code standpoint): TRISB.0 = 1 Set PORTB, pin 0 to an input
All of the pins on a port m ay be set to inputs by setting the entire TRIS register at once: TRISB = %11111111 Set all of PORTB to inputs
See LCDOUT for inform ation on connecting an LCD to a PICm icro MCU. LCDIN [B0]
91
92
PicBasic Pro Compiler Com m and $FE, 1 $FE, 2 Clear display Return hom e Cursor off Underline cursor on Blinking cursor on Move cursor left one position Move cursor right one position Move cursor to beginning of first line Move cursor to beginning of second line Move cursor to beginning of third line Move cursor to beginning of fourth line Operation
5.39. LCDOUT
LCDOUT Item{,Item...} Display Items on an intelligent Liquid Crystal Display. PBP supports LCD m odules with a Hitachi 44780 controller or equivalent. These LCDs usually have a 14- or 16-pin single- or dual-row header at one edge. If a pound sign (#) precedes an Item, the ASCII representation for each digit is sent to the LCD. LCDOUT (on all devices except 12-bit core) can also use any of the m odifiers used with SEROUT2. See the section on SEROUT2 for this inform ation.
$FE, $0C $FE, $0E $FE, $0F $FE, $10 $FE, $14 $FE, $80 $FE, $C0
$FE, $94 $FE, $D4
Note that there are com m ands to m ove the cursor to the beginning of the different lines of a m ulti-line display. For m ost LCDs, the displayed characters and lines are not consecutive in display m em ory - there can be a break in between locations. For m ost 16x2 displays, the first line starts at $80 and the second line starts at $C0. The com m and: LCDOUT $FE, $80 + 4 sets the display to start writing characters at the forth position of the first line. 16x1 displays are usually form atted as 8x2 displays with a break between the m em ory locations for the first and second 8 characters. 4line displays also have a m ixed up m em ory m ap, as shown in the table above. See the data sheet for the particular LCD device for the character m em ory locations and additional com m ands.. LCDOUT $FE,1,Hello LCDOUT $FE,$C0,World LCDOUT B0,#B1 Clear display and show Hello Jump to second line and show World Display B0 and decimal ASCII value of B1
A program should wait for at least half a second before sending the first com m and to an LCD. It can take quite a while for an LCD to start up. The LCD is initialized the first tim e any character or com m and is sent to it using LCDOUT. If it is powered down and then powered back up for som e reason during operation, an internal flag can be reset to tell the program to reinitialize it the next tim e it uses LCDOUT: FLAGS = 0 Com m ands are sent to the LCD by sending a $FE followed by the com m and. Som e useful com m ands are listed in the following table:
93
94
PicBasic Pro Compiler The LCD m ay be connected to the PICm icro MCU using either a 4-bit bus or an 8-bit bus. If an 8-bit bus is used, all 8 bits m ust be on one port. If a 4-bit bus is used, the top 4 LCD data bits m ust be connected to either the bottom 4 or top 4 bits of one port. Enable and Register Select m ay be connected to any port pin. R/W m ay be tied to ground if the LCDIN com m and is not used. PBP assum es the LCD is connected to specific pins unless told otherwise using DEFINEs. It assum es the LCD will be used with a 4-bit bus with data lines DB4 - DB7 connected to PICm icro MCU PORTA.0 PORTA.3, Register Select to PORTA.4 and Enable to PORTB.3. It is also preset to initialize the LCD to a 2 line display. To change this setup, place one or m ore of the following DEFINEs, all in upper-case, at the top of your PicBasic Pro program : Set LCD Data port DEFINE LCD_DREG PORTA Set starting Data bit (0 or 4) if 4-bit bus DEFINE LCD_DBIT 0 Set LCD Register Select port DEFINE LCD_RSREG PORTA Set LCD Register Select bit DEFINE LCD_RSBIT 4 Set LCD Enable port DEFINE LCD_EREG PORTB Set LCD Enable bit DEFINE LCD_EBIT 3 Set LCD bus size (4 or 8 bits) DEFINE LCD_BITS 4 Set number of lines on LCD DEFINE LCD_LINES 2 Set command delay time in us DEFINE LCD_COMMANDUS 2000 Set data delay time in us DEFINE LCD_DATAUS 50 The following schem atic shows one way to connect an LCD to a PICm icro MCU, using the defaults:
95
96
5.40. {LET}
{LET} Var = Value Assign a Value to a Variable. The Value m ay be a constant, another variable or the result of an expression. Refer to the previous section on operators for m ore inform ation. The keyword LET itself is optional. LET B0 = B1 * B2 + B3 B0 = Sqr W1
5.41. LOOKDOWN
LOOKDOWN Search,[Constant{,Constant...}],Var The LOOKDOWN statem ent searches a list of 8-bit Constant values for the presence of the Search value. If found, the index of the m atching constant is stored in Var. Thus, if the value is found first in the list, Var is set to zero. If second in the list, Var is set to one. And so on. If not found, Var rem ains unchanged. The constant list can be a m ixture of num eric and string constants. Each character in a string is treated as a separate constant with the character's ASCII value. Array variables with a variable index m ay not be used in LOOKDOWN although array variables with a constant index are allowed. Up to 255 (256 for PIC18Xxxx) constants are allowed in the list. Serin 1,N2400,B0 Get hexadecimal character from Pin1 serially LOOKDOWN B0,[0123456789ABCDEF],B1 Convert hexadecimal character in B0 to decimal value B1 Serout 0,N2400,[#B1] Send decimal value to Pin0 serially
97
98
5.42. LOOKDOWN2
LOOKDOWN2 Search,{Test}[Value{,Value...}],Var The LOOKDOWN2 statem ent searches a list of Values for the presence of the Search value. If found, the index of the m atching constant is stored in Var. Thus, if the value is found first in the list, Var is set to zero. If second in the list, Var is set to one. And so on. If not found, Var rem ains unchanged. The optional param eter Test can be used to perform a test for other than equal to (=) while searching the list. For exam ple, the list could be searched for the first instance where the Search param eter is greater than the Value by using > as the Test param eter. If Test is left out, = is assum ed. The Value list can be a m ixture of 8- and 16-bit num eric and string constants and variables. Each character in a string is treated as a separate constant equal to the character's ASCII value. Expressions m ay not be used in the Value list, although they m ay be used as the Search value. Array variables with a variable index m ay not be used in LOOKDOWN2 although array variables with a constant index are allowed. Up to 85 (256 for PIC18Xxxx) values are allowed in the list. LOOKDOWN2 generates code that is about 3 tim es larger than LOOKDOWN. If the search list is m ade up only of 8-bit constants and strings, use LOOKDOWN. LOOKDOWN2 W0,[512,W1,1024],B0 LOOKDOWN2 W0,>[1000,100,10],B0
5.43. LOOKUP
LOOKUP Index,[Constant{,Constant...}],Var The LOOKUP statem ent can be used to retrieve values from a table of 8bit constants. If Index is zero, Var is set to the value of the first Constant. If Index is one, Var is set to the value of the second Constant. And so on. If Index is greater than or equal to the num ber of entries in the constant list, Var rem ains unchanged. The constant list can be a m ixture of num eric and string constants. Each character in a string is treated as a separate constant equal to the character's ASCII value. Array variables with a variable index m ay not be used in LOOKUP although array variables with a constant index are allowed. Up to 255 (256 for PIC18Xxxx) constants are allowed in the list. For B0 = 0 To 5 Count from 0 to 5 LOOKUP B0,[Hello!],B1 Get character number B0 from string to variable B1 Serout 0,N2400,[B1] Send character in B1 to Pin0 serially Next B0 Do next character
99
100
5.44. LOOKUP2
LOOKUP2 Index,[Value{,Value...}],Var
5.45. LOW
LOW Pin Make the specified Pin low. Pin is autom atically m ade an output. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). LOW 0 LOW PORTA.0 Make Pin0 an output and set it low (0 volts) Make PORTA, pin 0 an output and set it low (0 volts) Define LED pin Make LED pin an output and set it low (0 volts)
The LOOKUP2 statem ent can be used to retrieve entries from a table of Values. If Index is zero, Var is set to the first Value. If Index is one, Var is set to the second Value. And so on. If Index is greater than or equal to the num ber of entries in the list, and Var rem ains unchanged. The Value list can be a m ixture of 16-bit num eric and string constants and variables. Each character in a string is treated as a separate constant equal to the character's ASCII value. Expressions m ay not be used in the Value list, although they m ay be used as the Index value. Array variables with a variable index m ay not be used in LOOKUP2 although array variables with a constant index are allowed. Up to 85 (256 for PIC18Xxxx) values are allowed in the list. LOOKUP2 generates code that is about 3 tim es larger than LOOKUP. If the Value list is m ade up of only 8-bit constants and strings, use LOOKUP. LOOKUP2 B0,[256,512,1024],W1
led
var PORTB.0 LOW led
Alternatively, if the pin is already an output, a m uch quicker and shorter way (from a generated code standpoint) to set it low would be: PORTB.0 = 0 Set PORTB, pin 0 low
101
102
5.46. NAP
NAP Period Places the m icrocontroller into low power m ode for short periods of tim e. During this NAP, power consum ption is reduced to m inim um . NAP puts the processor to sleep for one W atchdog Tim er period. If the W atchdog Tim er is not enabled, the processor will sleep forever or until an enabled interrupt or reset is received. The Period is used to set the W atchdog tim er prescaler for devices that have a prescaler including the 12- and 14-bit core devices. The 16-bit core devices, including the 17Cxxx and 18Xxxx parts use a postscaler set at program m ing tim e to configure the W atchdog tim eout period. The com piler will disregard the Period set in the NAP instruction for the 16bit core devices. The listed Periods for the 12- and 14-bit core devices are only approxim ate because the tim ing derived from the W atchdog Tim er is R/C driven and can vary greatly from chip to chip and over tem perature. Since NAP uses the W atchdog Tim er, its tim ing is independent of the oscillator frequency. Period 0 1 2 3 4 5 6 7 Delay (Approx.) 18 m illiseconds 36 m illiseconds 72 m illiseconds 144 m illiseconds 288 m illiseconds 576 m illiseconds 1.152 seconds 2.304 seconds
5.47. ON DEBUG
ON DEBUG GOTO Label ON DEBUG allows a debug m onitor routine to be executed between each PicBasic Pro instruction The m ethod by which this happens is sim ilar to the m ethod used by ON INTERRUPT GOTO. Once ON DEBUG GOTO is encountered, a call to the specified debug label is inserted before each PicBasic Pro instruction in the program . DISABLE DEBUG prevents the insertion of this call while ENABLE DEBUG resum es the insertion of the call. A m onitor routine m ay be written that is activated before each instruction. This routine can send data to an LCD or to a serial com m program . Any program inform ation m ay be displayed or even altered in this m anner. A sm all m onitor program exam ple is posted on our web site. A word-sized system variable that resides in BANK0 is required to provide place to store the address the program was at before the m onitor routine was called by ON DEBUG GOTO: DEBUG_ADDRESS VAR WORD BANK0 SYSTEM
An Additional byte-sized variable m ay be used to return the level of the current program stack: DEBUG_STACK VAR BYTE BANK0 SYSTEM
This level should never be greater than 4 for 12- and 14-bit core PICm icro MCUs, 12 for PIC17Cxxx devices or 27 for PIC18Xxxx devices in a PicBasic Pro program . The supplied variable will be increm ented at each GOSUB and decrem ented at each RETURN. This variable should be set to 0 at the beginning of the program . Adding this variable to a program does add overhead in that the value of the variable m ust be increm ented and decrem ented at each GOSUB and RETURN.
NAP 7 Low power pause for about 2.3 seconds
103
104
PicBasic Pro Compiler Overhead is another issue. ON INTERRUPT will add instructions before every statem ent to check whether or not an interrupt has occurred. DISABLE turns off the addition of these instructions. ENABLE turns it back on again. Usually the additional instructions will not be m uch of a problem , but long program s in sm all m icrocontrollers could suffer. More than one ON INTERRUPT m ay be used in a program .
5.48. ON INTERRUPT
ON INTERRUPT GOTO Label ON INTERRUPT allows the handling of m icrocontroller interrupts by a PicBasic Pro subroutine. There are 2 ways to handle interrupts using the PicBasic Pro Com piler. The first is to write an assem bly language interrupt routine. This is the way to handle interrupts with the shortest latency and lowest overhead, but m ust contain only assem bly language, not BASIC, code. This m ethod is discussed under advanced topics in a later section. The second m ethod is to write a PicBasic Pro interrupt handler. This looks just like a PicBasic Pro subroutine but ends with a RESUME. W hen an interrupt occurs, it is flagged. As soon as the current PicBasic Pro statem ents execution is com plete, the program jum ps to the BASIC interrupt handler at Label. Once the interrupt handler is com plete, a RESUME statem ent sends the program back to where it was when the interrupt occurred, picking up where it left off. DISABLE and ENABLE allow different sections of a PicBasic Pro program to execute without the possibility of being interrupted. The m ost notable place to use DISABLE is right before the actual interrupt handler. Or the interrupt handler m ay be placed before the ON INTERRUPT statem ent as the interrupt flag is not checked before the first ON INTERRUPT in a program . Latency is the tim e it takes from the tim e of the actual interrupt to the tim e the interrupt handler is entered. Since PicBasic Pro statem ents are not re-entrant (i.e. you cannot execute another PicBasic Pro statem ent while one is being executed), there can be considerable latency before the interrupt routine is entered. PBP will not enter the BASIC interrupt handler until it has finished executing the current statem ent. If the statem ent is a PAUSE or SERIN, it could be quite a while before the interrupt is acknowledged. The program m ust be designed with this latency in m ind. If it is unacceptable and the interrupts m ust be handled m ore quickly, an assem bly language interrupt routine m ust be used. 105
ON INTERRUPT GOTO myint Interrupt handler is myint INTCON = %10010000 Enable RB0 interrupt . . . DISABLE myint: led = 1 RESUME ENABLE Disable interrupts in handler Turn on LED when interrupted Return to main program Enable interrupts after handler
To turn off interrupts perm anently (or until needed again) once ON INTERRUPT has been used, set INTCON to $80: INTCON = $80
106
5.49. OUTPUT
OUTPUT Pin Make the specified Pin an output. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). OUTPUT 0 OUTPUT PORTA.0 Make Pin0 an output Make PORTA, pin 0 an output
5.50. OWIN
OWIN Pin,Mode,[Item...] Optionally send a reset pulse to a one-wire device and then read one or m ore bits or bytes of data from it, optionally ending with another reset pulse. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Mode specifies whether a reset is sent before and/or after the operation and the size of the data item s, either bit or byte. Mode bit num ber 0 Effect 1 = send reset pulse before data 1 = send reset pulse after data 0 = byte-sized data, 1 = bit-sized data
Alternatively, the pin m ay be set to an output in a m uch quicker and shorter way (from a generated code standpoint): TRISB.0 = 0 Set PORTB, pin 0 to an output
All of the pins on a port m ay be set to outputs by setting the entire TRIS register at once: TRISB = %00000000 Set all of PORTB to outputs
1 2
Som e Mode exam ples would be: Mode of %000 (decim al 0) m eans no reset and byte-sized data, Mode of %001 (decim al 1) m eans reset before data and byte-sized data, Mode of %100 (decim al 4) m eans no reset and bit-sized data. Item is one or m ore variables or m odifiers separated by com m as. The allowable m odifiers are STR for reading data into a byte array variable and SKIP for skipping a num ber of input values. The SKIP and STR m odifiers are not supported for the 12-bit core PICm icro MCUs because of RAM and stack size lim its. OWIN PORTC.0,%000,[STR temperature\2,SKIP 4, count_remain, count_per_c] This statem ent would receive bytes from a one-wire device on PORTC pin 0 with no reset pulse being sent. It would receive 2 bytes and put them into the byte array tem perature, skip the next 4 bytes and then read the final 2 bytes into separate variables.
107
108
5.51. OWOUT
OWOUT Pin,Mode,[Item...] Optionally send a reset pulse to a one-wire device and then writes one or m ore bits or bytes of data to it, optionally ending with another reset pulse. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Mode specifies whether a reset is sent before and/or after the operation and the size of the data item s, either bit or byte. Mode bit num ber 0 1 2 Effect 1 = send reset pulse before data 1 = send reset pulse after data 0 = byte-sized data, 1 = bit-sized data
5.52. PAUSE
PAUSE Period Pause the program for Period m illiseconds. Period is 16-bits, so delays can be up to 65,535 m illiseconds (a little over a m inute). Unlike the other delay functions (NAP and SLEEP), PAUSE doesn't put the m icrocontroller into low power m ode. Thus, PAUSE consum es m ore power but is also m uch m ore accurate. It has the sam e accuracy as the system clock. PAUSE assum es an oscillator frequency of 4MHz. If an oscillator other that 4MHz is used, PBP m ust be told using a DEFINE OSC com m and. See the section on speed for m ore inform ation. PAUSE 1000 Delay for 1 second
Som e Mode exam ples would be: Mode of %000 (decim al 0) m eans no reset and byte-sized data, Mode of %001 (decim al 1) m eans reset before data and byte-sized data, Mode of %100 (decim al 4) m eans no reset and bit-sized data. Item is one or m ore constants, variables or m odifiers separated by com m as. The allowable m odifiers are STR for sending data from a byte array variable and REP for sending a num ber of repeated values. The REP and STR m odifiers are not supported for the 12-bit core PICm icro MCUs because of RAM and stack size lim its. OWOUT PORTC.0,%001,[$cc,$be] This statem ent would send a reset pulse to a one-wire device on PORTC pin 0 followed by the bytes $cc and $be.
109
110
5.53. PAUSEUS
PAUSEUS Period Pause the program for Period m icroseconds. Period is 16-bits, so delays can be up to 65,535 m icroseconds. Unlike the other delay functions (NAP and SLEEP), PAUSEUS doesn't put the m icrocontroller into low power m ode. Thus, PAUSEUS consum es m ore power but is also m uch m ore accurate. Because PAUSEUS takes a m inim um num ber of cycles to operate, depending on the frequency of the oscillator, delays of less than a m inim um num ber of m icroseconds are not possible using PAUSEUS. To obtain shorter delays, use an assem bly language routine. OSC 3 (3.58) 4 8 10 12 16 20,24 25-33* 40** Minim um delay 20us 24us 12us 8us 7us 5us 3us 2us 2us
5.54. PEEK
PEEK Address,Var Read the m icrocontroller register at the specified Address and stores the result in Var. Special PICm icro MCU features such as A/D converters and additional I/O ports m ay be read using PEEK. If Address is a constant, the contents of this register num ber are placed into Var. If Address is the nam e of a special function register, e.g. PORTA, the contents of this register will be placed into Var. If Address is a RAM location, the value of the RAM location will first be read, then the contents of the register specified by that value will be placed into Var. However, all of the PICm icro MCU registers can be and should be accessed without using PEEK and POKE. All of the PICm icro MCU registers are considered 8-bit variables by PicBasic Pro and m ay be used as you would any other byte-sized variable. They can be read directly or used directly in equations. B0 = PORTA Get current PORTA pin states to B0
* PIC17Cxxx and PIC18Xxxx only. ** PIC18Xxxx only. PAUSEUS assum es an oscillator frequency of 4MHz. If an oscillator other that 4MHz is used, PBP m ust be told using a DEFINE OSC com m and. See the section on speed for m ore inform ation. PAUSEUS 1000 Delay for 1 millisecond
111
112
5.55. PEEKCODE
PEEKCODE Address,Var Read a value from the code space at the specified Address and store the result in Var. PEEKCODE can be used to read data stored in the code space of a PICm icro MCU. It executes a call to the specified Address and places the returned value in Var. The specified location should contain a retlw and the data value. POKECODE m ay be used to store this value at the tim e the device is program m ed. PEEKCODE $3ff, OSCCAL Get OSCCAL value for PIC12C671/12CE673 Get OSCCAL value for PIC12C672/12CE674
5.56. POKE
POKE Address,Value W rite Value to the m icrocontroller register at the specified Address. Special PICm icro MCU features such as A/D converters and additional I/O ports m ay be written using POKE. If Address is a constant, Value is placed into this register num ber. If Address is the nam e of a special function register, e.g. PORTA, Value will be placed into this register. If Address is a RAM location, the contents of the RAM location will first be read, then Value is placed into the register specified by those contents. However, all of the PICm icro MCU registers can be and should be accessed without using PEEK and POKE. All of the PICm icro MCU registers are considered 8-bit variables by PicBasic Pro and m ay be used as you would any other byte-sized variable. They can be written directly or used directly in equations. TRISA = 0 Set PORTA to all outputs PORTA.0 = 1 Set PORTA bit 0 high
PEEKCODE $7ff, OSCCAL
113
114
5.57. POKECODE
POKECODE {@Address,}Value{,Value...} Store Values to the code space at the current program address or optional specified Address at the tim e the m icrocontroller is program m ed. POKECODE can be used to generate tables in the code space of the PICm icro MCU. It generates a return with the data in W . This data can be accessed using the PEEKCODE instruction. If the optional Address is not specified, data storage will be located im m ediately after the preceding program instruction written. To avoid interruption of program flow, POKECODE should be the last line of your program . It should be place after the END or STOP com m and. POKECODE 10, 20, 30 Generates: retlw 10 retlw 20 retlw 30 Store 10, 20, and 30 in code space
5.58. POT
POT Pin,Scale,Var Reads a potentiom eter (or som e other resistive device) on Pin. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The resistance is m easured by tim ing the discharge of a capacitor through the resistor (typically 5K to 50K). Scale is used to adjust for varying RC constants. For larger RC constants, Scale should be set low (a m inim um value of one). For sm aller RC constants, Scale should be set to its m axim um value (255). If Scale is set correctly, Var should be zero near m inim um resistance and 255 near m axim um resistance. Unfortunately, Scale m ust be determ ined experim entally. To do so, set the device under m easure to m axim um resistance and read it with Scale set to 127. Adjust Scale until the Pot com m and returns 254. If 255, decrease the scale. If 253 or lower, increase the scale. (Note: This is sim ilar to the process perform ed by the Alt-P option of the BS1 environm ent). Use the following code to autom ate the process. Make sure that you set the pot to m axim um resistance. B0 Var scale Var Byte Byte
POKECODE @$7ff, $94 Generates: org 7ffh retlw 94h
Set OSCCAL value for PIC12C672/12CE674
For scale = 1 To 255 POT 0,scale,B0 If (B0 > 253) Then calibrated Next scale Serout 2,0,["Increase R or C.",10,13] Stop calibrated: Serout 2,0,["Scale= ",#scale,10,13]
115
116
PicBasic Pro Compiler Potentiom eter wiring exam ple:
5.59. PULSIN
PULSIN Pin,State,Var Measures pulse width on Pin. If State is zero, the width of a low pulse is m easured. If State is one, the width of a high pulse is m easured. The m easured width is placed in Var. If the pulse edge never happens or the width of the pulse is too great to m easure, Var is set to zero. If an 8-bit variable is used, only the LSB of the 16-bit m easurem ent is returned. Pin is autom atically m ade an input. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The resolution of PULSIN is dependent upon the oscillator frequency. If a 4MHz oscillator is used, the pulse width is returned in 10us increm ents. If a 20MHz oscillator is used, the pulse width will have a 2us resolution. Defining an OSC value has no effect on PULSIN. The resolution always changes with the actual oscillator speed. PULSIN norm ally waits a m axim um of 65535 counts before it determ ines there is no pulse. If it is desired to wait fewer counts before it stops looking for a pulse or the end of a pulse, a DEFINE can be added: DEFINE PULSIN_MAX 1000 This DEFINE also affects RCTIME in the sam e m anner. Measure high pulse on Pin4 stored in W3 PULSIN PORTB.4,1,W3
117
118
5.60. PULSOUT
PULSOUT Pin,Period Generates a pulse on Pin of specified Period. The pulse is generated by toggling the pin twice, thus the initial state of the pin determ ines the polarity of the pulse. Pin is autom atically m ade an output. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The resolution of PULSOUT is dependent upon the oscillator frequency. If a 4MHz oscillator is used, the Period of the generated pulse will be in 10us increm ents. If a 20MHz oscillator is used, Period will have a 2us resolution. Defining an OSC value has no effect on PULSOUT. The resolution always changes with the actual oscillator speed. Send a pulse 1mSec long (at 4MHz) to Pin5 PULSOUT PORTB.5,100
5.61. PWM
PWM Pin,Duty,Cycle Outputs a pulse width m odulated pulse train on Pin. Each cycle of PW M consists of 256 steps. The Duty cycle for each PW M cycle ranges from 0 (0%) to 255 (100%). This PW M cycle is repeated Cycle tim es. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The Cycle tim e of PWM is dependent upon the oscillator frequency. If a 4MHz oscillator is used, each Cycle is about 5m s long. If a 20MHz oscillator is used, each Cycle is about 1m s in length. Defining an OSC value has no effect on PWM. The Cycle tim e always changes with the actual oscillator speed. If you want continuous PW M output and the PICm icro MCU has PW M hardware, HPWM m ay be used instead of PWM. Pin is m ade an output just prior to pulse generation and reverts to an input after generation stops. The PWM output on a pin looks like so m uch garbage, not a beautiful series of square waves. A filter of som e sort is necessary to turn the signal into som ething useful. An RC circuit can be used as a sim ple D/A converter:
PWM PORTB.7,127,100
Send a 50% duty cycle PWM signal out Pin7 for 100 cycles
119
120
5.62. RANDOM
RANDOM Var Perform one iteration of pseudo-random ization on Var. Var should be a 16-bit variable. Array variables with a variable index m ay not be used in RANDOM although array variables with a constant index are allowed. Var is used both as the seed and to store the result. The pseudo-random algorithm used has a walking length of 65535 (only zero is not produced). RANDOM W4 Randomize value in W4
5.63. RCTIME
RCTIME Pin,State,Var RCTIME m easures the tim e a Pin stays in a particular State. It is basically half a PULSIN. Pin is autom atically m ade an input. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). RCTIME m ay be used to read a potentiom eter (or som e other resistive device). Resistance can be m easured by discharging and tim ing the charge (or vice versa) of a capacitor through the resistor (typically 5K to 50K). The resolution of RCTIME is dependent upon the oscillator frequency. If a 4MHz oscillator is used, the tim e in state is returned in 10us increm ents. If a 20MHz oscillator is used, the tim e in state will have a 2us resolution. Defining an OSC value has no effect on RCTIME. The resolution always changes with the actual oscillator speed. If the pin never changes state, 0 is returned. RCTIME norm ally waits a m axim um of 65535 counts before it determ ines there is no pulse change of state. If it is desired to wait fewer counts before it stops looking for this change, a DEFINE can be added: DEFINE PULSIN_MAX 1000 This DEFINE also affects PULSIN in the sam e m anner. Low PORTB.3 Pause 10 RCTIME PORTB.3,0,W0 Discharge cap to start Discharge for 10ms Read potentiometer on Pin3
121
122
5.64. READ
READ Address,Var Read a byte from the on-chip EEPROM at the specified Address and stores the result in Var. This instruction m ay only be used with a PICm icro MCU that has an on-chip EEPROM data area such as the PIC12F675, 16F84, 16C84 and the 16F87x series. READ will not work on devices with on-chip I2C interfaced serial EEPROM like the PIC12CE67x and 16CE62x parts. Use the I2CREAD instruction instead. READ 5,B2 Put the value at EEPROM location 5 into B2
5.65. READCODE
READCODE Address,Var Read the code at location Address into Var. Som e PIC16Fxxx and PIC18Xxxx devices allow program code to be read at run-tim e. This m ay be useful for additional data storage or to verify the validity of the program code. For PIC16Fxxx devices, 14-bit-sized data can be read from word code space Addresses. For PIC18Xxxx devices, byte or word-sized data can be read from byte code space Addresses between 0 and 65535. The listing file m ay be exam ined to determ ine program addresses. READCODE $100,w Put the code word at location $100 into W
To read a word, each of the 2 bytes that m ake up the word m ust be read separately: w Var READ READ Word 0,w.BYTE0 1,w.BYTE1
123
124
5.66. REPEAT..UNTIL
REPEAT Statement... UNTIL Condition REPEATedly execute Statements UNTIL the specified Condition is true. W hen the Condition is true, execution continues at the statem ent following the UNTIL. Condition m ay be any com parison expression. i = 0 Repeat PORTB.0[i] = 0 i = i + 1 Until i > 7
5.67. RESUME
RESUME {Label} Pick up where program left off after handling an interrupt. RESUME is sim ilar to RETURN but is used at the end of a PicBasic Pro interrupt handler. If the optional Label is used, program execution will continue at the Label instead of where it was when it was interrupted. In this case, any other return addresses on the stack will no longer be accessible. See ON INTERRUPT for m ore inform ation. clockint: seconds = seconds + 1 Count time RESUME Return to program after interrupt High errorled RESUME restart Turn on error LED Resume somewhere else
error:
125
126
5.68. RETURN
RETURN Return from subroutine. RETURN resum es execution at the statem ent following the GOSUB which called the subroutine. Gosub sub1 Go to subroutine labeled sub1 ... sub1: Serout 0,N2400,[Lunch] Send Lunch out Pin0 serially RETURN Return to main program after Gosub
5.69. REVERSE
REVERSE Pin If Pin is an input, it is m ade an output. If Pin is an output, it is m ade an input. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Output 4 REVERSE 4 Make Pin4 an output Change Pin4 to an input
127
128
5.70. SELECT CASE

SELECT CASE Var CASE Expr1 {, Expr...} Statement... CASE Expr2 {, Expr...} Statement... {CASE ELSE Statement...} END SELECT CASE statem ents are som etim es easier to use than m ultiple IF..THENs. These statem ents are used to com pare a variable with different values or ranges of values, and take action based on the value. The Variable to be used in all of the com parisons is specified in the SELECT CASE statem ent. Each CASE is followed by the Statements to be executed if the CASE is true. IS m ay be used to specify a com parison other than equal to. If none of the CASEs are true, the Statements under the optional CASE ELSE statem ent are executed. An END SELECT closes the SELECT CASE. SELECT CASE x CASE 1 y = CASE 2, 3 y = CASE IS > y = CASE ELSE y = END SELECT
5.71. SERIN
SERIN Pin,Mode,{Timeout,Label,}{[Qual...],}{Item...} Receive one or m ore Items on Pin in standard asynchronous form at using 8 data bits, no parity and one stop bit (8N1). SERIN is sim ilar to the BS1 Serin com m and with the addition of a Timeout. Pin is autom atically m ade an input. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The Mode nam es (e.g. T2400) are defined in the file MODEDEFS.BAS. To use them , add the line: Include modedefs.bas to the top of the PicBasic Pro program . BS1DEFS.BAS and BS2DEFS.BAS already includes MODEDEFS.BAS. Do not include it again if one of these files is already included. The Mode num bers m ay be used without including this file. Mode No. Baud Rate 0 1 2 3 4 5 6 7 2400 1200 9600 300 2400 1200 9600 300 Inverted True
Mode 10 20 5 100 0 T2400 T1200 T9600 T300 N2400 N1200 N9600 N300
State
An optional Timeout and Label m ay be included to allow the program to continue if a character is not received within a certain am ount of tim e. Timeout is specified in 1 m illisecond units. If the serial input pin stays in
129
130
PicBasic Pro Compiler the idle state during the Timeout tim e, the program will exit the SERIN com m and and jum p to Label. The list of data item s to be received m ay be preceded by one or m ore qualifiers enclosed within brackets. SERIN m ust receive these bytes in exact order before receiving the data item s. If any byte received does not m atch the next byte in the qualifier sequence, the qualification process starts over (i.e. the next received byte is com pared to the first item in the qualifier list). A Qualifier can be a constant, variable or a string constant. Each character of a string is treated as an individual qualifier. Once the qualifiers are satisfied, SERIN begins storing data in the variables associated with each Item. If the variable nam e is used alone, the value of the received ASCII character is stored in the variable. If variable is preceded by a pound sign ( # ), SERIN converts a decim al value in ASCII and stores the result in that variable. All non-digits received prior to the first digit of the decim al value are ignored and discarded. The non-digit character which term inates the decim al value is also discarded. SERIN assum es a 4MHz oscillator when generating its bit tim ing. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to the new oscillator value. W hile single-chip RS-232 level converters are com m on and inexpensive, the excellent I/O specifications of the PICm icro MCU allow m ost applications to run without level converters. Rather, inverted input (N300..N9600) can be used is conjunction with a current lim iting resistor.
5.72. SERIN2
SERIN2 DataPin{\FlowPin},Mode,{ParityLabel,} {Timeout,Label,}[Item...] Receive one or m ore Items on Pin in standard asynchronous form at. SERIN2 is sim ilar to the BS2 Serin com m and. DataPin is autom atically m ade an input. The optional FlowPin is autom atically m ade an output. DataPin and FlowPin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The optional flow control pin, FlowPin, m ay be included to help keep data from overrunning the receiver. If it is used, FlowPin is autom atically set to the enabled state to allow transm ission of each character. This enabled state is determ ined by the polarity of the data specified by Mode. Mode is used to specify the baud rate and operating param eters of the serial transfer. The low order 13 bits select the baud rate. Bit 13 selects parity or no parity. Bit 14 selects inverted or true level. Bit 15 is not used. The baud rate bits specify the bit tim e in m icroseconds - 20. To find the value for a given baud rate, use the equation: (1000000 / baud) - 20 Som e standard baud rates are listed in the following table. Baud Rate 300 600 1200 2400 Bits 0 - 12 3313 1646 813 396 188 84 32 132
Wait until the character A is received serially on Pin1 and put next character into B0 SERIN 1,N2400,[A],B0
4800 9600* 19200*
131
PicBasic Pro Compiler *Oscillator faster than 4MHz m ay be required. Bit 13 selects parity (bit 13 = 1) or no parity (bit 13 = 0). Norm ally, the serial transm issions are 8N1 (8 data bits, no parity and 1 stop bit). If parity is selected, the data is received as 7E1 (7 data bits, even parity and 1 stop bit). To receive odd parity instead of even parity, include the following DEFINE in the program : DEFINE SER2_ODD 1 W ith parity enabled: Bit 14 selects the level of the data and flow control pins. If bit 14 = 0, the data is received in true form for use with RS-232 drivers. If bit14 = 1, the data is received inverted. This m ode can be used to avoid installing RS232 drivers. Som e exam ples of Mode are: Mode = 84 (9600 baud, no parity, true), Mode = 16780 (2400 baud, no parity, inverted), Mode = 27889 (300 baud, even parity, inverted). Appendix A shows m ore Mode exam ples. If ParityLabel is included, this label will be jum ped to if a character with bad parity is received. It should only be used if parity is selected (bit 13 = 1). An optional Timeout and Label m ay be included to allow the program to continue if a character is not received within a certain am ount of tim e. Timeout is specified in 1 m illisecond units. If the serial input pin stays in the idle state during the Timeout tim e, the program will exit the SERIN2 com m and and jum p to Label. A DEFINE allows the use of data bits other than 8 (or 7 with parity). SER2_BITS data bits m ay range from 4 bits to 8 (the default if no DEFINE is specified). Enabling parity uses one of the num ber of bits specified. Defining SER2_BITS to 9 allows 8 bits to be read and written along with a 9th parity bit. W ith parity disabled (the default): DEFINE SER2_BITS 4 ' Set Serin2 and Serout2 data bits to 4 133
PicBasic Pro Compiler DEFINE SER2_BITS 5 DEFINE SER2_BITS 6 DEFINE SER2_BITS 7 DEFINE SER2_BITS 8 ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to and Serout2 5 and Serout2 6 and Serout2 7 and Serout2 8 (default)
DEFINE SER2_BITS 5 DEFINE SER2_BITS 6 DEFINE SER2_BITS 7 DEFINE SER2_BITS 8 DEFINE SER2_BITS 9
' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to
and Serout2 4 and Serout2 5 and Serout2 6 and Serout2 7 (default) and Serout2 8
SERIN2 supports m any different data m odifiers which m ay be m ixed and m atched freely within a single SERIN2 statem ent to provide various input form atting. Modifier BIN{1..16} DEC{1..5} HEX{1..4} SKIP n STR ArrayVar\n{\c} WAIT ( ) WAITSTR ArrayVar{\n} Operation Receive binary digits Receive decim al digits Receive upper case hexadecim al digits Skip n received characters Receive string of n characters optionally ended in character c W ait for sequence of characters W ait for character string
134
PicBasic Pro Compiler 1) A variable preceded by BIN will receive the ASCII representation of its binary value. For exam ple, if BIN B0 is specified and 1000" is received, B0 will be set to 8. A variable preceded by DEC will receive the ASCII representation of its decim al value. For exam ple, if DEC B0 is specified and 123" is received, B0 will be set to 123. A variable preceded by HEX will receive the ASCII representation of its hexadecim al value. For exam ple, if HEX B0 is specified and FE" is received, B0 will be set to 254. SKIP followed by a count will skip that m any characters in the input stream . For exam ple, SKIP 4 will skip 4 characters.. STR followed by a byte array variable, count and optional ending character will receive a string of characters. The string length is determ ined by the count or when the optional character is encountered in the input. The list of data item s to be received m ay be preceded by one or m ore qualifiers between parenthesis after WAIT. SERIN2 m ust receive these bytes in exact order before receiving the data item s. If any byte received does not m atch the next byte in the qualifier sequence, the qualification process starts over (i.e. the next received byte is com pared to the first item in the qualifier list). A Qualifier can be a constant, variable or a string constant. Each character of a string is treated as an individual qualifier. WAITSTR can be used as WAIT above to force SERIN2 to wait for a string of characters of an optional length before proceeding.
PicBasic Pro Compiler SERIN2 assum es a 4MHz oscillator when generating its bit tim ing. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to the new oscillator value. An oscillator speed faster than 4MHz m ay be required for reliable operation at 9600 baud and above. W hile single-chip RS-232 level converters are com m on and inexpensive, thanks to current RS-232 im plem entation and the excellent I/O specifications of the PICm icro MCU, m ost applications don't require level converters. Rather, inverted TTL (Mode bit 14 = 1) can be used. A current lim iting resistor is suggested (RS-232 is suppose to be short-tolerant).
2)
3)
4) 5)
6)
SERIN2 is not supported on 12-bit core PICm icro MCUs due to RAM and stack constraints. Wait until the character A is received serially on Pin1 and put next character into B0 SERIN2 1,16780,[WAIT(A),B0] Skip 2 chars and grab a 4 digit decimal number SERIN2 PORTA.1,84,[SKIP 2,DEC4 B0] SERIN2 PORTA.1\PORTA.0,84,100,tlabel,[WAIT(x, b0),STR ar]
7)
Once any WAIT or WAITSTR qualifiers are satisfied, SERIN2 begins storing data in the variables associated with each Item. If the variable nam e is used alone, the value of the received ASCII character is stored in the variable. If variable is preceded by BIN, DEC or HEX, then SERIN2 converts a binary, decim al or hexadecim al value in ASCII and stores the result in that variable. All non-digits received prior to the first digit of the decim al value are ignored and discarded. The non-digit character which term inates the value is also discarded. BIN, DEC and HEX m ay be followed by a num ber. Norm ally, these m odifiers receive as m any digits as are in the input. However, if a num ber follows the m odifier, SERIN2 will always receive that num ber of digits, skipping additional digits as necessary. 135
136
PicBasic Pro Compiler Mode T2400 T1200 T9600 T300 N2400 N1200 Mode No. Baud Rate 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 2400 1200 9600 300 2400 1200 9600 300 2400 1200 9600 300 2400 1200 9600 300 Open Inverted* Open True* Driven Inverted Driven True State
5.73. SEROUT
SEROUT Pin,Mode,[Item{,Item...}] Sends one or m ore item s to Pin in standard asynchronous form at using 8 data bits, no parity and one stop (8N1). SEROUT is sim ilar to the BS1 Serout com m and. Pin is autom atically m ade an output. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The Mode nam es (e.g. T2400) are defined in the file MODEDEFS.BAS. To use them , add the line: Include modedefs.bas to the top of the PicBasic Pro program . BS1DEFS.BAS and BS2DEFS.BAS already includes MODEDEFS.BAS. Do not include it again if one of these files is already included. The Mode num bers m ay be used without including this file.
N9600 N300 OT2400 OT1200 OT9600 OT300 ON2400 ON1200 ON9600 ON300
* Open m odes not supported on 12-bit core PICm icro MCUs. SEROUT supports three different data types which m ay be m ixed and m atched freely within a single SEROUT statem ent. 1) 2) A string constant is output as a literal string of characters. A num eric value (either a variable or a constant) will send the corresponding ASCII character. Most notably, 13 is carriage return and 10 is line feed. A num eric value preceded by a pound sign ( # ) will send the ASCII representation of its decim al value. For exam ple, if W0 = 123, then #W0 (or #123) will send 1", 2", 3".
3)
SEROUT assum es a 4MHz oscillator when generating its bit tim ing. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to the new oscillator value.
137
138
PicBasic Pro Compiler In som e cases, the transm ission rates of SEROUT instructions m ay present characters too quickly to the receiving device. A DEFINE adds character pacing to the serial output transm issions. This allows additional tim e between the characters as they are transm itted. The character pacing DEFINE allows a delay of 1 to 65,535 m icroseconds (.001 to 65.535 m illiseconds) between each character transm itted. For exam ple, to pause 1 m illisecond between the transm ission of each character: DEFINE CHAR_PACING 1000 W hile single-chip RS-232 level converters are com m on and inexpensive, thanks to current RS-232 im plem entation and the excellent I/O specifications of the PICm icro MCU, m ost applications don't require level converters. Rather, inverted TTL (N300..N9600) can be used. A current lim iting resistor is suggested (RS-232 is suppose to be short-tolerant).
5.74. SEROUT2
SEROUT2 DataPin{\FlowPin},Mode,{Pace,} {Timeout,Label,}[Item...] Send one or m ore Items to DataPin in standard asynchronous form at. SEROUT2 is sim ilar to the BS2 Serout com m and. DataPin is autom atically m ade an output. The optional FlowPin is autom atically m ade an input. DataPin and FlowPin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). The optional flow control pin, FlowPin, m ay be included to help keep data from overrunning the receiver. If it is used, the serial data will not be sent until FlowPin is in the proper state. This state is determ ined by the polarity of the data specified by Mode. An optional Timeout and Label m ay be included to allow the program to continue if the FlowPin does not change to the enabled state within a certain am ount of tim e. Timeout is specified in units of 1 m illisecond. If FlowPin stays disabled during the Timeout tim e, the program will exit the SEROUT2 com m and and jum p to Label. In som e cases, the transm ission rates of SEROUT2 instructions m ay present characters too quickly to the receiving device. It m ay not be desirable to use an extra pin for flow control. An optional Pace can be used to add character pacing to the serial output transm issions. This allows additional tim e between the characters as they are transm itted. The character pacing allows a delay of 1 to 65,535 m illiseconds between each character transm itted. Mode is used to specify the baud rate and operating param eters of the serial transfer. The low order 13 bits select the baud rate. Bit 13 selects parity or no parity. Bit 14 selects inverted or true level. Bit 15 selects whether it is driven or open. The baud rate bits specify the bit tim e in m icroseconds - 20. To find the value for a given baud rate, use the equation: (1000000 / baud) - 20
SEROUT 0,N2400,[#B0,10] Send the ASCII value of B0 followed by a linefeed out Pin0 serially
139
140
PicBasic Pro Compiler Som e standard baud rates are listed in the following table. Baud Rate 300 600 1200 2400 4800 9600* 19200* Bits 0 - 12 3313 1646 813 396 188 84 32 W ith parity enabled:
PicBasic Pro Compiler W ith parity disabled (the default): DEFINE SER2_BITS 4 DEFINE SER2_BITS 5 DEFINE SER2_BITS 6 DEFINE SER2_BITS 7 DEFINE SER2_BITS 8 ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to and Serout2 4 and Serout2 5 and Serout2 6 and Serout2 7 and Serout2 8 (default)
*Oscillator faster than 4MHz m ay be required. Bit 13 selects parity (bit 13 = 1) or no parity (bit 13 = 0). Norm ally, the serial transm issions are 8N1 (8 data bits, no parity and 1 stop bit). If parity is selected, the data is sent as 7E1 (7 data bits, even parity and 1 stop bit). To transm it odd parity instead of even parity, include the following DEFINE in the program : DEFINE SER2_ODD 1
DEFINE SER2_BITS 5 DEFINE SER2_BITS 6 DEFINE SER2_BITS 7 DEFINE SER2_BITS 8 DEFINE SER2_BITS 9
' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to ' Set Serin2 data bits to
and Serout2 4 and Serout2 5 and Serout2 6 and Serout2 7 (default) and Serout2 8
Bit 14 selects the level of the data and flow control pins. If bit 14 = 0, the data is sent in true form for use with RS-232 drivers. If bit14 = 1, the data is sent inverted. This m ode can be used to avoid installing RS-232 drivers. Bit 15 selects whether the data pin is always driven (bit 15 = 0), or is open in one of the states (bit 15 = 1). The open m ode can be used to chain several devices together on the sam e serial bus. See Appendix A for a table of Mode exam ples. A DEFINE allows the use of data bits other than 8 (or 7 with parity). SER2_BITS data bits m ay range from 4 bits to 8 (the default if no DEFINE is specified). Enabling parity uses one of the num ber of bits specified. Defining SER2_BITS to 9 allows 8 bits to be read and written along with a 9th parity bit.
SEROUT2 supports m any different data m odifiers which m ay be m ixed and m atched freely within a single SEROUT2 statem ent to provide various output form atting. Modifier {I}{S}BIN{1..16} {I}{S}DEC{1..5} {I}{S}HEX{1..4} REP c\n STR ArrayVar{\n} Operation Send binary digits Send decim al digits Send hexadecim al digits Send character c repeated n tim es Send string of n characters
141
142
PicBasic Pro Compiler 1) 2) A string constant is output as a literal string of characters. A num eric value (either a variable or a constant) will send the corresponding ASCII character. Most notably, 13 is carriage return and 10 is line feed. A num eric value preceded by BIN will send the ASCII representation of its binary value. For exam ple, if B0 = 8, then BIN B0 (or BIN 8) will send 1000". A num eric value preceded by DEC will send the ASCII representation of its decim al value. For exam ple, if B0 = 123, then DEC B0 (or DEC 123) will send 123". A num eric value preceded by HEX will send the ASCII representation of its hexadecim al value. For exam ple, if B0 = 254, then HEX B0 (or HEX 254) will send FE. REP followed by a character and count will repeat the character, count tim e. For exam ple, REP 0"\4 will send 0000". STR followed by a byte array variable and optional count will send a string of characters. The string length is determ ined by the count or when a 0 character is encountered in the string.
PicBasic Pro Compiler Any or all of the m odifier com binations m ay be used at once. For exam ple, ISDEC4 B0. SEROUT2 assum es a 4MHz oscillator when generating its bit tim ing. To m aintain the proper baud rate tim ing with other oscillator values, be sure to DEFINE the OSC setting to the new oscillator value. An oscillator speed faster than 4MHz m ay be required for reliable operation at 9600 baud and above. W hile single-chip RS-232 level converters are com m on and inexpensive, thanks to current RS-232 im plem entation and the excellent I/O specifications of the PICm icro MCU, m ost applications don't require level converters. Rather, inverted TTL (Mode bit 14 = 1) can be used. A current lim iting resistor is suggested (RS-232 is suppose to be short-tolerant).
3)
4)
5)
6) 7)
BIN, DEC and HEX m ay be preceded or followed by several optional param eters. If any of them are preceded by an I (for indicated), the output will be preceded by either a %, # or $ to indicate the following value is binary, decim al or hexadecim al. If any are preceded by an S (for signed), the output will be sent preceded by a - if the high order bit of the data is set. This allows the transm ission of negative num bers. Keep in m ind that all of the m ath and com parisons in PBP are unsigned. However, unsigned m ath can yield signed results. For exam ple, take the case of B0 = 9 - 10. The result of DEC B0 would be 255". Sending SDEC B0 would give -1" since the high order bit is sent. So with a little trickery, the unsigned m ath of PBP can yield signed results. BIN, DEC and HEX m ay also be followed by a num ber. Norm ally, these m odifiers display exactly as m any digits as are necessary, zero blanked (leading zeros are not sent). However, if a num ber follows the m odifier, SEROUT2 will always send that num ber of digits, adding leading zeros as necessary. It will also trim of any extra high order digits. For exam ple, BIN6 8 would send 001000" and BIN2 8 would send 00".
SEROUT2 is not supported on 12-bit core PICm icro MCUs due to RAM and stack constraints. Send the ASCII value of B0 followed by a linefeed out Pin0 serially at 2400 baud SEROUT2 0,16780,[DEC B0,10] Send B0 = followed by the binary value of B0 out PORTA pin 1 serially at 9600 baud SEROUT2 PORTA.1,84,[B0=, IHEX4 B0]
143
144
PicBasic Pro Compiler Mode MSBPRE Mode No. 0 Operation Shift data in highest bit first, Read data before sending clock. Clock idles low. Shift data in lowest bit first, Read data before sending clock. Clock idles low. Shift data in highest bit first, Read data after sending clock. Clock idles low. Shift data in lowest bit first, Read data after sending clock. Clock idles low. Shift data in highest bit first, Read data before sending clock. Clock idles high. Shift data in lowest bit first, Read data before sending clock. Clock idles high. Shift data in highest bit first, Read data after sending clock. Clock idles high. Shift data in lowest bit first, Read data after sending clock. Clock idles high.
5.75. SHIFTIN
SHIFTIN DataPin,ClockPin,Mode,[Var{\Bits}...] Clock ClockPin, synchronously shift in bits on DataPin and store the data received into Var. ClockPin and DataPin m ay be a constant, 015, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). \Bits optionally specifies the num ber of bits to be shifted in. If it is not specified, 8 bits are shifted in, independent of the variable type. The Bits shifted in are always the low order bits, regardless of the Mode used, LSB or MSB. The Mode nam es (e.g. MSBPRE) are defined in the file MODEDEFS.BAS. To use them , add the line: Include modedefs.bas
LSBPRE
MSBPOST
LSBPOST
5 to the top of the PicBasic Pro program . BS1DEFS.BAS and BS2DEFS.BAS already includes MODEDEFS.BAS. Do not include it again if one of these files is already included. The Mode num bers m ay be used without including this file.. Som e Modes do not have a nam e. For Modes 0-3, the clock idles low, toggles high to clock in a bit, and then returns low. For Modes 4-7, the clock idles high, toggles low to clock in a bit, and then returns high.
The shift clock runs at about 50kHz, dependent on the oscillator. The active state is held to a m inim um of 2 m icroseconds. A DEFINE allows the active state of the clock to be extended by an additional num ber of m icroseconds up to 65,535 (65.535 m illiseconds) to slow the clock rate. The m inim um additional delay is defined by the PAUSEUS tim ing. See its section for the m inim um for any given oscillator. This DEFINE is not available on 12-bit core PICm icro MCUs. For exam ple, to slow the clock by an additional 100 m icroseconds: DEFINE SHIFT_PAUSEUS 100
145
146
PicBasic Pro Compiler The following diagram shows the relationship of the clock to the data for the various m odes:
5.76. SHIFTOUT
SHIFTOUT DataPin,ClockPin,Mode,[Var{\Bits}...] Synchronously shift out Var on ClockPin and DataPin. ClockPin and DataPin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). \Bits optionally specifies the num ber of bits to be shifted out. If it is not specified, 8 bits are shifted out, independent of the variable type. The Bits shifted out are always the low order bits, regardless of the Mode used, LSB or MSB. Up to 16 Bits can be shifted out of a single variable. If m ore than 16 Bits are required, m ultiple variables or constants m ay be included between the square brackets. The Mode nam es (e.g. LSBFIRST) are defined in the file MODEDEFS.BAS. To use them , add the line: Include modedefs.bas
SHIFTIN 0,1,MSBPRE,[B0,B1\4] to the top of the PicBasic Pro program . BS1DEFS.BAS and BS2DEFS.BAS already includes MODEDEFS.BAS. Do not include it again if one of these files is already included. The Mode num bers m ay be used without including this file. Som e Modes do not have a nam e. For Modes 0-1, the clock idles low, toggles high to clock in a bit, and then returns low. For Modes 4-5, the clock idles high, toggles low to clock in a bit, and then returns high. Mode LSBFIRST MSBFIRST Mode No. 0 1 4 5 Operation Shift data out lowest bit first. Clock idles low. Shift data out highest bit first. Clock idles low. Shift data out lowest bit first. Clock idles high. Shift data out highest bit first. Clock idles high.
147
148
PicBasic Pro Compiler The shift clock runs at about 50kHz, dependent on the oscillator. The active state is held to a m inim um of 2 m icroseconds. A DEFINE allows the active state of the clock to be extended by an additional num ber of m icroseconds up to 65,535 (65.535 m illiseconds) to slow the clock rate. The m inim um additional delay is defined by the PAUSEUS tim ing. See its section for the m inim um for any given oscillator. This DEFINE is not available on 12-bit core PICm icro MCUs. For exam ple, to slow the clock by an additional 100 m icroseconds: DEFINE SHIFT_PAUSEUS 100 The following diagram shows the relationship of the clock to the data for the various m odes:
5.77. SLEEP
SLEEP Period Place m icrocontroller into low power m ode for Period seconds. Period is 16-bits, so delays can be up to 65,535 seconds (just over 18 hours). SLEEP uses the W atchdog Tim er so it is independent of the actual oscillator frequency. The granularity is about 2.3 seconds and m ay vary based on device specifics and tem perature. This variance is unlike the BASIC Stam p. The change was necessitated because when the PICm icro MCU executes a W atchdog Tim er reset, it resets m any of the internal registers to predefined values. These values m ay differ greatly from what your program m ay expect. By running the SLEEP com m and uncalibrated, this issue is sidestepped. SLEEP 60 Sleep for about 1 minute
SHIFTOUT 0,1,MSBFIRST,[B0,B1] SHIFTOUT PORTA.1,PORTA.2,1,[wordvar\4] SHIFTOUT PORTC.1,PORTB.1,4,[$1234\16, $56]
149
150
5.78. SOUND
SOUND Pin,[Note,Duration{,Note,Duration...}] Generates tone and/or white noise on the specified Pin. Pin is autom atically m ade an output. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Note 0 is silence. Notes 1-127 are tones. Notes 128-255 are white noise. Tones and white noises are in ascending order (i.e. 1 and 128 are the lowest frequencies, 127 and 255 are the highest). Note 1 is about 78.74Hz and Note 127 is about 10,000Hz. Duration is 0-255 and determ ines how long the Note is played in about 12 m illisecond increm ents. Note and Duration needn't be constants. SOUND outputs TTL-level square waves. Thanks to the excellent I/O characteristics of the PICm icro MCU, a speaker can be driven through a capacitor. The value of the capacitor should be determ ined based on the frequencies of interest and the speaker load. Piezo speakers can be driven directly.
5.79. STOP
STOP Stop program execution by executing an endless loop. This does not place the m icrocontroller into low power m ode. The m icrocontroller is still working as hard as ever. It is just not getting m uch done. STOP Stop program dead in its tracks
SOUND PORTB.7,[100,10,50,10]
Send 2 sounds consecutively to Pin7
151
152
5.80. SWAP
SWAP Variable,Variable Exchange the values between 2 variables. Usually, it is a tedious process to swap the value of 2 variables. SWAP does it in one statem ent without using any interm ediate variables. It can be used with bit, byte and word variables. Array variables with a variable index m ay not be used in SWAP although array variables with a constant index are allowed. temp = B0 B0 = B1 B1 = temp SWAP B0,B1 Old way
5.81. TOGGLE
TOGGLE Pin Invert the state of the specified Pin. Pin is autom atically m ade an output. Pin m ay be a constant, 0 - 15, or a variable that contains a num ber 0 - 15 (e.g. B0) or a pin nam e (e.g. PORTA.0). Low 0 TOGGLE 0 Start Pin0 as low Change state of Pin0 to high
New way
153
154
5.82. USBIN
USBIN Endpoint,Buffer,Countvar,Label Get any available USB data for the Endpoint and place it in the Buffer. Buffer m ust be a byte array of suitable length to contain the data. Countvar will contain the num ber of bytes transferred to the buffer. Label will be jum ped to if no data is available. This instruction m ay only be used with a PICm icro MCU that has an onchip USB port such as the PIC16C745 and PIC16C765. The USB subdirectory contains the m odified Microchip USB libraries as well as an exam ple program s. USB program s requires several additional files to operate (which are in the USB subdirectory), som e of which will require m odification for your particular application. See the text file in the USB subdirectory for m ore inform ation on the USB com m ands. USB com m unications is m uch m ore com plicated than synchronous (SHIFTIN and SHIFTOUT) and asynchronous (SERIN, SEROUT and so forth) com m unications. There is m uch m ore to know about USB operation that can possibly be described here. The USB inform ation on the Microchip web site needs to be studied. Also, the book "USB Com plete" by Jan Axelson m ay be helpful. USBIN 1, buffer, cnt, idleloop
5.83. USBINIT
USBINIT USBINIT needs to be one of the first statem ents in a program that uses USB com m unications. It will initialize the USB portion of the PICm icro MCU and wait until the USB bus is configured and enabled. This instruction m ay only be used with a PICm icro MCU that has an onchip USB port such as the PIC16C745 and PIC16C765. The USB subdirectory contains the m odified Microchip USB libraries as well as an exam ple program s. USB program s requires several additional files to operate (which are in the USB subdirectory), som e of which will require m odification for your particular application. See the text file in the USB subdirectory for m ore inform ation on the USB com m ands. USB com m unications is m uch m ore com plicated than synchronous (SHIFTIN and SHIFTOUT) and asynchronous (SERIN, SEROUT and so forth) com m unications. There is m uch m ore to know about USB operation that can possibly be described here. The USB inform ation on the Microchip web site needs to be studied. Also, the book "USB Com plete" by Jan Axelson m ay be helpful. USBINIT
155
156
5.84. USBOUT
USBOUT Endpoint,Buffer,Count,Label Take Count num ber of bytes from the array variable Buffer and send them to the USB Endpoint. If the USB buffer does not have room for the data because of a pending transm ission, no data will be transferred and program execution will continue at Label. This instruction m ay only be used with a PICm icro MCU that has an onchip USB port such as the PIC16C745 and PIC16C765. The USB subdirectory contains the m odified Microchip USB libraries as well as an exam ple program s. USB program s requires several additional files to operate (which are in the USB subdirectory), som e of which will require m odification for your particular application. See the text file in the USB subdirectory for m ore inform ation on the USB com m ands. USB com m unications is m uch m ore com plicated than synchronous (SHIFTIN and SHIFTOUT) and asynchronous (SERIN, SEROUT and so forth) com m unications. There is m uch m ore to know about USB operation that can possibly be described here. The USB inform ation on the Microchip web site needs to be studied. Also, the book "USB Com plete" by Jan Axelson m ay be helpful. USBOUT 1, buffer,4,outloop
5.85. WHILE..WEND
WHILE Condition Statement... WEND Repeatedly execute Statements WHILE Condition is true. W hen the Condition is no longer true, execution continues at the statem ent following the WEND. Condition m ay be any com parison expression. i = 1 WHILE i <= 10 Serout 0,N2400,[No:,#i,13,10] i = i + 1 WEND
157
158
5.86. WRITE
WRITE Address,Value W rite byte Value to the on-chip EEPROM at the specified Address. This instruction m ay only be used with a PICm icro MCU that has an onchip EEPROM data area such as the PIC12F675, 16F84, 16C84 and the 16F87x series. WRITE is used to set the values of the on-chip EEPROM at runtim e. To set the values of the on-chip EEPROM at device program m ing-tim e, use the DATA or EEPROM statem ent. Each WRITE is self-tim ed and takes about 10 m illiseconds to execute on a PICm icro MCU. If interrupts are used in a program , they m ust be turned off (m asked, not DISABLEd) before executing a WRITE, and turned back on (if desired) after the write instruction is com plete. An interrupt occurring during a WRITE m ay cause it to fail. WRITE will not work on devices with on-chip I2C interfaced serial EEPROM like the PIC12CE67x and 16CE62x parts. Use the I2CWRITE instruction instead. WRITE 5,B0 Send value in B0 to EEPROM location 5
5.87. WRITECODE
WRITECODE Address,Value W rite Value to the code space at location Address. Som e PIC16Fxxx and PIC18Fxxx devices allow program code to be written at run-tim e. W hile writing self-m odifying code can be a dangerous technique, it does allow non-volatile data storage above 64 - 256 bytes. One m ust be very careful not to write over active program m em ory. The listing file m ay be exam ined to determ ine program addresses. For PIC16Fxxx devices, 14-bit-sized data can be written to word code space Addresses. For PIC18Fxxx devices, byte or word-sized data can be written to byte code space Addresses between 0 and 65535. For block accessed devices, like the PIC16F877a and 18F452, a com plete block m ust be written at once. This write block size is different for different PICm icro MCUs. See the Microchip data sheet for the particular device for inform ation on the block size. Additionally, som e flash PICm icro MCUs, like the PIC18Fxxx series, require a portion of the code space to be erased before it can be rewritten with WRITECODE. See the section on ERASECODE for m ore inform ation. If interrupts are used in a program , they m ust be turned off (m asked, not DISABLEd) before executing a WRITECODE, and turned back on (if desired) after the write instruction is com plete. An interrupt occurring during a WRITECODE m ay cause it to fail. Flash program writes m ust be enabled in the configuration for the PICm icro MCU at device program m ing tim e for WRITECODE to be able to write. WRITECODE $100,w Send value in W to code space location $100
To write a word, each of the 2 bytes that m ake up the word m ust be written separately: w Var Word WRITE 0,w.BYTE0 WRITE 1,w.BYTE1
159
160
PicBasic Pro Compiler m odules at once so the m odule num ber is unnecessary. Hopefully, later exam ples will clarify things. Key Code num bers 0-15 correspond to m odule num bers 1-16. These Key Code num bers are different from the actual num bers sent and received by the X10 m odules. This difference is to m atch the Key Codes in the BS2. To rem ove this Stam p translation, the following DEFINE m ay be used: DEFINE XINXLAT_OFF 1 XIN is not supported on 12-bit core PICm icro MCUs due to RAM and stack constraints. XOUT below lists the functions as well as the wiring inform ation. housekey Var Word
5.88. XIN
XIN DataPin,ZeroPin,{Timeout,Label,}[Var{,...}] Receive X-10 data and store the House Code and Key Code in Var. XIN is used to receive inform ation from X-10 devices that can send such inform ation. X-10 m odules are available from a wide variety of sources under several trade nam es. An interface is required to connect the m icrocontroller to the AC power line. The TW -523 for two-way X-10 com m unications is required by XIN. This device contains the power line interface and isolates the m icrocontroller from the AC line. Since the X10 form at is patented, this interface also covers the license fees. DataPin is autom atically m ade an input to receive data from the X-10 interface. ZeroPin is autom atically m ade an input to received the zero crossing tim ing from the X-10 interface. Both pins should be pulled up to 5 volts with 4.7K resistors. DataPin and ZeroPin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). An optional Timeout and Label m ay be included to allow the program to continue if X-10 data is not received within a certain am ount of tim e. Timeout is specified in AC power line half-cycles (approxim ately 8.33 m illiseconds). XIN only processes data at each zero crossing of the AC power line as received on ZeroPin. If there are no transitions on this line, XIN will effectively wait forever. If Var is word-sized, each House Code received is stored in the upper byte of the word. Each received Key Code is stored in the lower byte of the word. If Var is a byte, only the Key Code is stored. The House Code is a num ber between 0 and 15 that corresponds to the House Code set on the X-10 m odule A through P. The Key Code can be either the num ber of a specific X-10 m odule or the function that is to be perform ed by a m odule. In norm al practice, first a com m and specifying the X-10 m odule num ber is sent, followed by a com m and specifying the function desired. Som e functions operate on all 161
Get X-10 data loop: XIN PORTA.2,PORTA.0,[housekey] Display X-10 data on LCD Lcdout $fe,1,House=,#housekey.byte1, Key=,#housekey.byte0 Goto loop Do it forever
Check for X-10 data, go to nodata if none XIN PORTA.2,PORTA.0,1,nodata,[housekey]
162
PicBasic Pro Compiler The KeyCode (function) nam es (e.g. unitOn) are defined in the file MODEDEFS.BAS. To use them , add the line: Include modedefs.bas to the top of the PicBasic Pro program . BS1DEFS.BAS and BS2DEFS.BAS already includes MODEDEFS.BAS. Do not include it again if one of these files is already included. The KeyCode num bers m ay be used without including this file. KeyCode unitOn unitOff unitsOff lightsOn lightsOff KeyCode No. %10010 %11010 %11100 %10100 %10000 %10110 %11110 Operation Turn m odule on Turn m odule off Turn all m odules off Turn all light m odules on Turn all light m odules off Brighten light m odule Dim light m odule
5.89. XOUT
XOUT DataPin,ZeroPin, [HouseCode\KeyCode{\Repeat}{,...}] Send HouseCode followed by KeyCode, Repeat num ber of tim es in X10 form at. If the optional Repeat is left off, 2 tim es (the m inim um ) is assum ed. Repeat is usually reserved for use with the Bright and Dim com m ands. XOUT is used to send control inform ation to X-10 m odules. These m odules are available from a wide variety of sources under several trade nam es. An interface is required to connect the m icrocontroller to the AC power line. Either the PL-513 for send only, or the TW -523 for two-way X-10 com m unications are required. These devices contain the power line interface and isolate the m icrocontroller from the AC line. Since the X-10 form at is patented, these interfaces also cover the license fees. DataPin is autom atically m ade an output to send data to the X-10 interface. ZeroPin is autom atically m ade an input to received the zero crossing tim ing from the X-10 interface. It should be pulled up to 5 volts with a 4.7K resistor. DataPin and ZeroPin m ay be a constant, 0-15, or a variable that contains a num ber 0-15 (e.g. B0) or a pin nam e (e.g. PORTA.0). XOUT only processes data at each zero crossing of the AC power line as received on ZeroPin. If there are no transitions on this line, XOUT will effectively wait forever. HouseCode is a num ber between 0 and 15 that corresponds to the House Code set on the X-10 m odule A through P. The proper HouseCode m ust be sent as part of each com m and. The KeyCode can be either the num ber of a specific X-10 m odule or the function that is to be perform ed by a m odule. In norm al practice, first a com m and specifying the X-10 m odule num ber is sent, followed by a com m and specifying the function desired. Som e functions operate on all m odules at once so the m odule num ber is unnecessary. Hopefully, later exam ples will clarify things. KeyCode num bers 0-15 correspond to m odule num bers 1-16.
bright dim
These Keycode num bers are different from the actual num bers sent and received by the X10 m odules. This difference is to m atch the Keycodes in the BS2. To rem ove this Stam p translation, the following DEFINE m ay be used: DEFINE XOUTXLAT_OFF 1 XOUT is not supported on 12-bit core PICm icro MCUs due to RAM and stack constraints. W iring to the X-10 interfaces requires 4 connections. Output from the X10 interface (zero crossing and receive data) are open-collector and require a pull up resistor of around 4.7K to 5 volts. W iring tables for each interface is shown below:
163
164
PicBasic Pro Compiler PL-513 W iring W ire No. 1 2 3 4 W ire Color Black Red Green Yellow Connection Zero crossing output Zero crossing com m on X-10 transm it com m on X-10 transm it input
TW -523 W iring W ire No. 1 2 3 4 W ire Color Black Red Green Yellow Connection Zero crossing output Com m on X-10 receive output X-10 transm it input
house Var unit Var
Byte Byte
Include modedefs.bas house = 0 Set house to 0 (A) unit = 8 Set unit to 8 (9) Turn on unit 8 in house 0 XOUT PORTA.1,PORTA.0,[house\unit,house\unitOn] Turn off all the lights in house 0 XOUT PORTA.1,PORTA.0,[house\lightsOff] Blink light 0 on and off every 10 seconds XOUT PORTA.1,PORTA.0,[house\0] loop: XOUT PORTA.1,PORTA.0,[house\unitOn] Pause 10000 Wait 10 seconds XOUT PORTA.1,PORTA.0,[house\unitOff] Pause 10000 Wait 10 seconds Goto loop 165 166
PicBasic Pro Compiler these subroutines. Most PicBasic Pro com m ands consist of a m acro and, usually, an associated library subroutine. PBPPIC14.RAM contains the VAR statem ents that allocate the m em ory needed by the library. PIC14EXT.BAS contains the external definitions that tells PBP all of the 14-bit core PICm icro MCU register nam es.
6. Structure of a Compiled Program

PBP is designed to be easy to use. Program s can be com piled and run with little thought to PBP's internal workings. Som e people, however, only have confidence in a product when they understand its internal workings. Others are just plain curious. This section is for them . It describes the files used and output generated by PBP and gives som e idea of what is going on.
6.3. PBP Generated Code 6.1. Target Specific Headers

Three target (PICm icro MCU) specific header files are used when a program is com piled. One is used by PBP, the other two are included for use by the assem bler. A file with the nam e of the m icrocontroller followed by the extension .BAS contains chip specific inform ation needed by PBP. This includes the m em ory profile of the chip, which library it uses, and includes for the definition of the variables it needs. For the PIC16F84, the default m icrocontroller, the file is nam ed 16F84.BAS. A file with the nam e of the m icrocontroller followed by the extension .INC is included in the generated .ASM file to give the assem bler inform ation about the chip, including the default configuration param eters (oscillator m ode, W atchdog Tim er setting, etc.). For the PIC16F84, for example, the file is nam ed 16F84.INC. Finally, the assem bler has its own include file that defines the addresses of the m icrocontroller registers. This file is usually nam ed som ething on the order of M16F8x.INC and is in the INC subdirectory. A PicBasic Pro com piled program is built in several stages. First PBP creates the .ASM file. It then builds a custom .MAC file that contains only the m acros from the m acro library that are used in the .ASM file. If everything is error free up to this point, it launches the assem bler. The assem bler generates its own set of files. These include the .HEX final output file and possibly listing and debugging files.
6.4. .ASM File Structure

The .ASM file has a very specific structure. Things m ust be done in a particular order for everything to work out properly. The first item placed in the file is an equate defining which assem bler is to be used, followed by an INCLUDE to tell the assem bler which m icroprocessor is the target and give it som e basic inform ation, such as the configuration data. Next, all of the variable allocations and aliasing is listed. EEPROM initialization is next, if called for. An INCLUDE for the m acro file is then placed in the file, followed by an INCLUDE for the library subroutines. Finally, the actual program code is incorporated. This program code is sim ply a list of m acros that were generated from the PicBasic Pro lines.
6.2. The Library Files

PBP includes a set of library files that contain all of the code and definition files for a particular group of m icrocontrollers. In the case of 14bit core PICm icro MCUs, for exam ple, these files start with the nam e PBPPIC14. PBPPIC14.LIB contains all of the assem bly language subroutines used by the com piler. PBPPIC14.MAC contains all of the m acros that call 167
168
PicBasic Pro Compiler Norm ally, PBP defaults to using a 4MHz oscillator. Adding the statem ent: DEFINE OSC 8
7. Other PicBasic Pro Considerations

7.1. How Fast is Fast Enough?
By default, the PicBasic Pro Com piler generates program s intended to be run on a PICm icro MCU with a 4MHz crystal or ceram ic resonator. All of the tim e-sensitive instructions assum e a 1 m icrosecond instruction tim e for their delays. This allows a PAUSE 1000, for exam ple, to wait 1 second and the SERIN and SEROUT com m ands baud rates to be accurate. There are tim es, however, when it would be useful to run the PICm icro MCU at a frequency other than 4MHz. Even though the com piled program s m ove along at a pretty good clip, it m ight be nice to run them even faster. Or m aybe it is desirable to do serial input or output at 19,200 baud or higher. PicBasic Pro program s m ay be run at clock frequencies other than 4MHz in a couple of different ways. The first is to sim ply use an oscillator other than 4MHz and dont tell PBP. This can be a useful technique if you pay attention to what happens to the tim e dependent instructions. If you wish to run the serial bus at 19,200 as described above, you would sim ply clock the m icrocontroller with an 8MHz crystal rather than a 4MHz crystal. This, in effect, m akes everything run twice as fast, including the SERIN and SEROUT com m ands. If you tell SERIN or SEROUT to run at 9600 baud, the doubling of the crystal speed will double the actual baud rate to 19,200 baud. However, keep in m ind com m ands such as PAUSE and SOUND will also run twice as fast. The PAUSE 1000 m entioned above would only wait .5 seconds with an 8MHz crystal before allowing program execution to continue. The preferred technique is to use a different oscillator frequency and tell PBP of your intentions. This is done through the use of a DEFINE. DEFINE, as dem onstrated in the LCDOUT com m and in a previous section, is used to tell PBP to use som ething other than its defaults.
near the beginning of the PicBasic Pro program tells PBP an 8MHz oscillator will be used instead. The acceptable oscillator definitions are: OSC 3 (3.58) 4 8 10 12 16 20 24 25* 32* 33* 40** Minim um delay 20us 24us 12us 8us 7us 5us 3us 3us 2us 2us 2us 2us
* PIC17Cxxx and PIC18Xxxx only. ** PIC18Xxxx only. Telling PBP the oscillator frequency allows it to com pensate and produce the correct tim ing for COUNT, DEBUG, DEBUGIN, DTMFOUT, FREQOUT, HPWM, HSERIN, HSEROUT, I2CREAD, I2CWRITE, LCDOUT, OWIN, OWOUT, PAUSE, PAUSEUS, SERIN, SERIN2, SEROUT, SEROUT2, SHIFTIN, SHIFTOUT, SOUND, XIN and XOUT. Changing the oscillator frequency m ay also be used to enhance the resolution of the PULSIN, PULSOUT and RCTIME instructions. At 4MHz these instructions operate with a 10 m icrosecond resolution. If a 20MHz crystal is used, the resolution is increased 5 tim es to 2 m icroseconds. There is a tradeoff, however. The pulse width is still m easured to a 16-bit word variable. W ith a 2 m icrosecond resolution, the m axim um m easurable pulse width would be 131,070 m icroseconds. 170
169
PicBasic Pro Compiler Going the other direction and running with a 32.768kHz oscillator is problem atic. It m ay be desirable to attem pt this for reduced power consum ption reasons and it will work to som e extent. The SERIN and SEROUT com m ands will be unusable and the W atchdog Tim er m ay cause the program to restart periodically. Experim ent to find out if your particular application is possible at this clock speed. It doesnt hurt to try.
PicBasic Pro Compiler The variables are assigned to RAM sequentially in a particular order. The order is word arrays first (if any), followed by byte and bit arrays. Then space is allocated for words, bytes and finally individual bits. Bits are packed into bytes as possible. This order m akes the best use of available RAM. (For PIC18Xxxx devices, arrays are allocated last.) Arrays m ust fit into a single bank on m ost PICm icro MCUs. They m ay not cross a bank boundary. This effectively lim its the length of an individual array. See the previous section on arrays for these lim its. You can suggest to PBP a particular bank to place the variable in: penny nickel VAR VAR WORD BANK0 BYTE BANK1
7.2. Configuration Settings

As m entioned earlier, the default configuration settings for a particular device is set in the .INC file with the sam e nam e as the device, e.g. 16F84.INC. These settings can be changed at the tim e the device is physically program m ed. The oscillator defaults to XT on m ost devices. This is the setting for the default 4MHz oscillator. If a faster oscillator is used, this setting m ust be changed to HS. The W atchdog Tim er is enabled by PBP. It is used, along with the TMR0 prescaler, to support the NAP and SLEEP instructions. If neither of the instructions are used in a program , the W atchdog Tim er m ay be disabled and the prescaler used for som ething else. Code Protect defaults to off but m ay be set to on when the device is physically program m ed. Do not code protect a windowed device. See the Microchip data sheet for the particular device for the configuration data specific to that part.
If specific bank requests are m ade, those are handled first. If there is not enough room in a requested bank, the first available space is used and a warning is issued. You can even set specific addresses for variables. In m ost cases, it is better to let PBP handle the m em ory m apping for you. But in som e cases, such as storage of the W register in an interrupt handler, it is necessary to define a fixed address. This m ay be done in a sim ilar m anner to bank selection: w_store VAR BYTE $20
7.3. RAM Usage

In general it is not necessary to know how RAM is allocated by PBP in the m icrocontroller. PBP takes care of all the details so the program m er doesnt have to. However there are tim es when this knowledge could be useful. Variables are stored in the PICm icro MCUs RAM registers. The first available RAM location is $0C for the PIC16F84 and som e of the sm aller PICm icro MCUs, and $20 for the PIC16C74 and other larger PICm icro MCUs. Refer to the Microchip PICm icro MCU data books for the actual location of the start of the RAM registers for a given m icrocontroller. 171
Several system variables, using about 24 bytes of RAM, are autom atically allocated by the com piler for use by library subroutines. These variables are allocated in the file PBPPIC14.RAM and m ust be in bank 0 (or bank A on PIC18Xxxx devices). User variables are prepended with an underscore (_) while system variables have no underscore so that they do not interfere with each other. R0 VAR WORD SYSTEM
BASIC Stam p variables B0 - B25 and W 0 - W 12 are not autom atically allocated. It is best to create your own variables using the VAR instruction. However if you want these variables to be created for you, 172
PicBasic Pro Compiler sim ply include the appropriate file, BS1DEFS.BAS or BS2DEFS.BAS, at the beginning of the PicBasic Pro program . These variables allocate space separate and apart from any other variables you m ay later create. This is different than the BS2 where using the canned variables and user created variables can get you into hot water. Additional tem porary variables m ay be generated autom atically by the com piler to help it sort out equations. A listing of these variables, as well as the entire m em ory m ap, m ay be seen in the generated .ASM or .LST file. If there is not enough RAM m em ory available for the variables, an unable to fit variable in m em ory error m essage will be issued.
PicBasic Pro Compiler Norm ally this is not an issue as the library is the first thing in a PicBasic Pro program and the entire library is sm aller than 2K. However, attention m ust be payed to this issue if additional libraries are used. Assem bly language interrupt handlers m ust also fit into page 0 of code space. Putting them at the beginning of the PicBasic Pro program should m ake this work. See the upcom ing section on assem bly language for m ore inform ation. The addition of instructions to set the PCLATH bits does add overhead to the produced code. PBP will set the PCLATH bits before any Call or Goto instruction on 12-bit core PICm icro MCUs with m ore than 512 words of code space, 14-bit core devices with m ore than 2K of code space and PIC17Cxxx devices with m ore than 8K of code space. There are specific PicBasic Pro instructions to assist with the 2K issues.
7.4. Reserved Words

Reserved words are sim ply that - words that are reserved for use by the com piler and m ay not be defined as either variable nam es or labels. These reserved words m ay be the nam es of com m ands, pseudo-ops, variable types or the nam es of the PICm icro MCU registers. The pseudo-ops, variable types and com m ands keywords are listed in their appropriate sections and in Appendix C. The nam es of the PICm icro MCU registers are defined in the file PIC14EXT.BAS. If the files BS1DEFS.BAS, BS2DEFS.BAS or MODEDEFS.BAS are included, the definitions inside essentially becom e reserved words and m ay not be redefined. BRANCHL was created to allow branching to labels that m ay be further than 1K locations away on PIC18Xxxx devices or on the other side of a page boundary for all other devices. If the PICm icro MCU has only one code page of program space, BRANCH m ay be used as it takes up less space than BRANCHL. If the m icrocontroller has m ore than one page of code space, and you cannot be certain that BRANCH will always act within the sam e page, use BRANCHL. The assem bler m ay issue a warning that a page boundary has been crossed. This is norm al and is there to suggest that you check for any BRANCHes that m ay cross a page boundary.
7.5. Life After 2K 7.6. 12-Bit Core Considerations

Yes, there is life after 2K using the PicBasic Pro Com piler. PICm icro MCUs have a segm ented code space. PICm icro MCU instructions in 14-bit core parts such as Call and Goto only have enough bits within them to address 2K of program space. To get to code outside the 2K boundary, the PCLATH register m ust be set before each Call or Goto. PBP autom atically sets these PCLATH bits for you. There are a few restrictions im posed, however. The PicBasic Pro library m ust fit entirely into page 0 of code space (the first half of page 0 for 12-bit core devices). 173 Because of the architecture of the 12-bit core PICm icro MCUs, program s com piled for them by PBP will, in general, be larger and slower that program s com piled for the other PICm icro MCU fam ilies. In m any cases, choosing a device from one of these other fam ilies will be m ore appropriate. However, m any useful program s can be written and com piled for the 12-bit core devices. The two m ain program m ing lim itations that will m ost likely occur are running out of RAM m em ory for variables and running past the first 256 word lim it for the library routines. These lim itations have m ade it 174
PicBasic Pro Compiler necessary to elim inate som e com piler comm ands and m odify the operation of som e others. The com piler for 12-bit core PICm icro MCUs uses between 20 and 22 bytes of RAM for its internal variables, with additional RAM used for any necessary tem porary variables. This RAM allocation includes a 4 level software stack so that the BASIC program can still nest GOSUBs up to 4 levels deep. Som e PICm icro MCU devices only have 24 or 25 bytes of RAM so there is very little space for user variables on those devices. If the Unable to Fit Variable error m essage occurs during com pilation, choose another PICm icro MCU with m ore general purpose RAM. 12-bit core PICm icro MCUs can call only into the first half (256 words) of a code page. Since the com piler's library routines are all accessed by calls, they m ust reside entirely in the first 256 words of the PICm icro MCU code space. Many library routines, such as I2CREAD, are fairly large. It m ay only take a few routines to overrun the first 256 words of code space. If it is necessary to use m ore library routines that will fit into the first half of the first code page, it will be necessary to m ove to a 14- or 16-bit core PICm icro MCU instead of the 12-bit core device.
175
176
PicBasic Pro Compiler in the DOS PATH. See the file MPLAB.TXT on the disk and the m icroEngineering Labs, Inc. web site for m ore details. MPASM m ay be used with PBP in two ways. If the com m and line option "-am pasm " is used, MPASM will be launched following com pilation to com plete the process. MPASM will display its own screen with its progress. PBP -ampasm filename
8. Assembly Language Programming

Assem bly language routines can be a useful adjunct to a PicBasic Pro Com piler program . W hile in general m ost tasks can be done com pletely in BASIC, there are tim es when it m ight be necessary to do a particular task faster, or using a sm aller am ount of code space, or just differently than the com piler does it. At those tim es it is useful to have the capabilities of an in-line assem bler. It can be beneficial to write m ost of a program quickly using the PicBasic Pro language and then sprinkle in a few lines of assem bly code to increase the functionality. This additional code m ay be inserted directly into the PBP program or included as another file.
Alternatively, the com m and line option "-am p" will launch MPASM in quiet m ode and only display any errors. However, the launcher consum es additional m em ory that is therefore not available to MPASM. PBP -amp filename For m axim um m em ory availability to MPASM, the com m and line option "-am pasm " should be used or the W indows version of MPASM, "-am pasm win", should be used. In any case, MPASM is not included with PBP and m ust be obtained from Microchip. See the file MPLAB.TXT on the disk for m ore inform ation.
8.1. Two Assemblers - No Waiting

Upon execution, PBP first com piles the program into assem bly language and then autom atically launches an assem bler. This converts the assem bler output into the final .HEX file which can be program m ed into a m icrocontroller. Two different assem blers m ay be used with PBP: PM, our PICm icro MCU Macro Assem bler, and MPASM, Microchips assem bler. PM is included with the com piler while MPASM m ust be obtained directly from Microchip via their web site or is included with their PICm icro MCU program m ers. There are benefits and drawbacks to using each assem bler. PM is handy because it is included as part of PBP. It is also m uch faster than MPASM and can assem ble m uch larger program s in DOS. PM includes an 8051-style instruction set that is m ore intuitive than the Microchip m nem onics. For com plete inform ation on the PICm icro Macro Assem bler, see the PM.TXT file on disk. MPASM, on the other hand, has the capability of creating a .COD file. This file contains additional inform ation that can be very useful with sim ulators and em ulators. MPASM is also m ore com patible with the wide variety of assem bly language exam ples found on the web and in Microchips data books. PBP defaults to using PM. To use MPASM with PBP, install all of the MPASM files into their own subdirectory. This subdirectory m ust also be 177
8.2. Programming in Assembly Language

PBP program s m ay contain a single line of assem bly language preceded by an at sym bol (@), or one or m ore lines of assem bly code preceded by the ASM keyword and ended by the ENDASM keyword. Both keywords appear on their lines alone. @ Asm bsf bcf bcf Endasm The lines of assem bly are copied verbatim into the assem bly output file. This allows the PBP program to use all of the facilities of PM, the PICm icro Macro Assem bler. This also, however, requires that the 178 STATUS,RP0 TRISA,0 STATUS,RP0 bsf PORTA,0
PicBasic Pro Compiler program m er have som e fam iliarity with the PBP libraries. PBPs notational conventions are sim ilar to other com m ercial com pilers and should com e as no shock to program m ers experienced enough to attem pt in-line assem bly. All identifier nam es defined in a PBP program are sim ilarly defined in assem bly, but with the nam e preceded with an underscore ( _ ). This allows access to user variables, constants, and even labeled locations, in assem bly: B0 Asm movlw 10 movwf _B0 Endasm Thus, any nam e defined in assem bly starting with an underscore has the possibility of conflicting with a PBP generated sym bol. If conflict is avoided, can these underscored assem bly values be accessed from PBP? No. Rem em ber, the underscored nam es generated by PBP are only shadows of the actual inform ation defined in the com piler. Since inline assem bly is copied directly to the output file and not processed by the com piler, the com piler not only lacks any type or value inform ation about assem bly sym bols, it is com pletely unaware that they exist. If variables are to be shared between assem bly and PBP, you m ust define the variables in PBP. Just as underscored sym bols have possible conflicts, so do sym bols not starting with underscores. The problem is internal library identifiers. Luckily, m ost library identifiers contain a '?' or m ake reference to one of the working registers (such as R0). Avoiding such nam es should reduce problem s. If you should have a nam e collision, the assem bler will report the duplicate definitions as an error. In assem bly language the com m ent designator changes from the single quote ( ) in PicBasic Pro to a sem icolon ( ; ). PicBasic Pro comment ; Assembly language comment Var Byte
8.3. Placement of In-line Assembly

PBP statem ents execute in order of their appearance in the source. The organization of the code is as follows: Starting at location 0, the reset vector, PBP inserts som e startup code followed by a jum p to INIT. Next, the called-for library subroutines are stuffed in. At the end of the library is INIT, where any additional initialization is com pleted. Finally, at the label MAIN, the com piled PicBasic Pro statem ent code is added. The first executable line that appears in the PicBasic Pro source is where the program starts execution. That statem ent literally appears in m em ory right behind the controllers startup and library code, right after the MAIN label. The tendency of program m ers is to place their own library functions written using the in-line assem bler either before or after their code. In light of the above explanation, this could create som e obvious problem s. If they appear early in the program , the assem bly routines execute prior to any PBP instructions (som e program m ers will invariably exploit this feature). If they appear at the tail of the program , execution which "falls off the end" of the PBP statem ents m ay m ysteriously find them selves unintentionally executing assem bly routines. There are a couple of deciding factors as to where m ight be the best place to insert assem bly language subroutines. If the entire program fits into one code page, place your assem bly routines after your PBP code. If you need to term inate your program , explicitly place an END or STOP statem ent at the end of your code rather than floating off into space. If the program is longer than one code page, it could m ake m ore sense to put the assem bly language routines at the beginning of the PBP program . This should ensure them of being in the first code page so that you know where to find them . This is the way assem bly language interrupt routines should be handled. If the routines are placed at the front, you m ust include a GOTO (or JMP) around the code to the first executable PBP statem ent. See the section on interrupts for an exam ple of this. The actual code for the assem bly language routines m ay be included in your program or in a separate file. If a routine is used by only one 180
179
PicBasic Pro Compiler particular PicBasic Pro program , it would m ake sense to include the assem bler code within the PBP source file. This routine can then be accessed using the CALL com m and. If it is used by several different PBP program s, a separate file containing the assem bly routines can sim ply be included at the appropriate place in the PicBasic Pro source: Asm Include myasm.inc Endasm
8.4. Another Assembly Issue

PICm icro MCU registers are banked. PBP keeps track of which register bank it is pointing to at all tim es. It knows if it is pointing to a TRIS register, for exam ple, it needs to change the bank select bits before it can access a PORT. It also knows to reset the bank select bits to 0 before m aking a Call or a Goto. It does this because it cant know the state of the bank select bits at the new location. So anytim e there is a change of locale or a label that can be called or jum ped to, the bank select bits are zeroed. It also resets the bank select bits before each ASM and the @ assem bler shortcut. Once again, the assem bler routine wont know the current state of the bits so they are set to a known state. The assem bler code m ust be sure to reset the bank select bits before it exits, if it has altered them .
181
182
PicBasic Pro Compiler are reserved for CALLs and nested BASIC GOSUBs. You m ust m ake sure that your GOSUBs are only nested 3 (11 for PIC17Cxxx and 26 for PIC18Xxxx) deep at m ost with no CALLs within them in order to have a stack location available for the return address. If your interrupt handler uses the stack (by doing a Call or GOSUB itself for exam ple), youll need to have additional stack space available. Once you have dealt with the stack issues, you need to enable the appropriate interrupts. This usually m eans setting the INTCON register. Set the necessary enable bits along with Global Interrupt Enable. For exam ple: INTCON = %10010000 enables the interrupt for RB0/INT. Depending on the actual interrupt desired, you m ay also need to set one of the PIE registers. Refer to the Microchip PICm icro MCU data books for additional inform ation on how to use interrupts. They give exam ples of storing processor context as well as all the necessary inform ation to enable a particular interrupt. This data is invaluable to your success. Finally, select the best technique with which to handle your particular interrupts.
9. Interrupts
Interrupts can be a scary and useful way to m ake your program really difficult to debug. Interrupts are triggered by hardware events, either an I/O pin changing state or a tim er tim ing out and so forth. If enabled (which by default they arent), an interrupt causes the processor to stop whatever it is doing and jum p to a specific routine in the m icrocontroller called an interrupt handler. Interrupts are not for the faint of heart. They can be very tricky to im plem ent properly, but at the sam e tim e they can provide very useful functions. For exam ple, an interrupt could be used to buffer serial input data behind the scenes while the m ain PicBasic Pro program is off doing som ething else. (This particular usage would require a m icrocontroller with a hardware serial port.) There are m any ways to avoid using interrupts. Quickly polling a pin or register bit instead is usually fast enough to get the job done. Or you can check the value of an interrupt flag without actually enabling interrupts. However, if you just gotta do it, here are som e hints on how to go about it. The PicBasic Pro Com piler has two different m echanism s to handle interrupts. The first is sim ply to write the interrupt handler in assem bler and tack it onto the front of a PBP program . The second m ethod is to use the PicBasic Pro statem ent ON INTERRUPT. Each m ethod will be covered separately, after we talk about interrupts in general.
9.2. Interrupts in BASIC

The easiest way to write an interrupt handler is to write it in PicBasic Pro using the ON INTERRUPT statem ent. ON INTERRUPT tells PBP to activate its internal interrupt handling and to jum p to your BASIC interrupt handler as soon as it can after receiving an interrupt. W hich brings us the first issue. Using ON INTERRUPT, when an interrupt occurs PBP sim ply flags the event and im m ediately goes back to what it was doing. It does not im m ediately vector to your interrupt handler. Since PBP statem ents are not re-entrant (PBP m ust finish the statem ent that is being executed before it can begin a new one) there could be considerable delay (latency) before the interrupt is handled.
9.1. Interrupts in General

W hen an interrupt occurs, the PICm icro MCU stores the address of the next instruction it was supposed to execute on the stack and jum ps to location 4. The first thing this m eans is that you need an extra location on the hardware stack, which is only 8 deep on the 14-bit core devices to begin with. The PicBasic Pro library routines can use up to 4 stack locations them selves. The rem aining 4 (12 for PIC17Cxxx and 27 for PIC18Xxxx) 183
184
PicBasic Pro Compiler As an exam ple, lets say that the PicBasic Pro program just started execution of a Pause 10000 when an interrupt occurs. PBP will flag the interrupt and continue with the PAUSE. It could be up to 10 seconds later before the interrupt handler is executed. If it is buffering characters from a serial port, m any characters will be m issed. To m inim ize the problem , use only statem ents that dont take very long to execute. For exam ple, instead of Pause 10000, use Pause 1 in a long FOR..NEXT loop. This will allow PBP to com plete each statem ent m ore quickly and handle any pending interrupts. If interrupt processing needs to occur m ore quicky than can be provided by ON INTERRUPT, interrupts in assem bly language should be used. Exactly what happens when ON INTERRUPT is used is this: A short interrupt handler is placed at location 4 in the PICm icro MCU. This interrupt handler is sim ply a Return. W hat this does is send the program back to what it was doing before the interrupt occurred. It doesnt require any processor context saving. W hat it doesnt do is re-enable Global Interrupts as happens using an Retfie. A Call to a short subroutine is placed before each statem ent in the PicBasic Pro program once an ON INTERRUPT is encountered. This short subroutine checks the state of the Global Interrupt Enable bit. If it is off, an interrupt is pending so it vectors to the users interrupt handler. If it is still set, the program continues with the next BASIC statem ent, after which, the GIE bit is checked again, and so forth. W hen the RESUME statem ent is encountered at the end of the BASIC interrupt handler, it sets the GIE bit to re-enable interrupts and returns to where the program was before the interrupt occurred. If RESUME is given a label to jum p to, execution will continue at that location instead. All previous return addresses will be lost in this case. DISABLE stops PBP from inserting the Call to the interrupt checker after each statem ent. This allows sections of code to execute without the possibility of being interrupted. ENABLE allows the insertion to continue. A DISABLE should be placed before the interrupt handler so that it will not keep getting restarted by checking the GIE bit.
PicBasic Pro Compiler If it is desired to turn off interrupts for som e reason after ON INTERRUPT is encountered, you m ust not turn off the GIE bit. Turning off this bit tells PBP an interrupt has happened and it will execute the interrupt handler forever. Instead set: INTCON = $80 This disables all the individual interrupts but leaves the Global Interrupt Enable bit set.
9.3. Interrupts in Assembler

Interrupts in assem bly language are a little trickier. Since you have no idea of what the processor was doing when it was interrupted, you have no idea of the state of the W register, the STATUS flags, PCLATH or even what register page you are pointing to. If you need to alter any of these, and you probably will, you m ust save the current values so that you can restore them before allowing the processor to go back to what it was doing before it was so rudely interrupted. This is called saving and restoring the processor context. If the processor context, upon return from the interrupt, is not left exactly the way you found it, all kinds of subtle bugs and even m ajor system crashes can and will occur. This of course m eans that you cannot even safely use the com pilers internal variables for storing the processor context. You cannot tell which variables are in use by the library routines at any given tim e. You should create variables in the PicBasic Pro program for the express purpose of saving W , the STATUS register and any other register that m ay need to be altered by the interrupt handler. These variables should not be otherwise used in the BASIC program . W hile it seem s a sim ple m atter to save W in any RAM register, it is actually som ewhat m ore com plicated. The problem occurs in that you have no way of knowing what register bank you are pointing to when the interrupt happens. If you have reserved a location in Bank0 and the current register pointers are set to Bank1, for exam ple, you could
185
186
PicBasic Pro Compiler overwrite an unintended location. Therefore you m ust reserve a RAM register location in each bank of the device at the sam e offset. As an exam ple, let's choose the 16C74(A). It has 2 banks of RAM registers starting at $20 and $A0 respectively. To be safe, we need to reserve the sam e location in each bank. In this case we will choose the first location in each bank. A special construct has been added to the VAR com m and to allow this: wsave var wsave1 var byte $20 system byte $a0 system ssave psave var var
PicBasic Pro Compiler byte bank0 system byte bank0 system
In any case, you m ust restore these registers at the end of your assem bler interrupt handler. If the 14-bit core PICm icro MCU has 2K or less of code space, or it is an PIC18Xxxx device, the registers are not saved. Your interrupt handler m ust save and restore any used registers. Finally, you need to tell PBP that you are using an assem bly language interrupt handler and where to find it. This is accom plished with a DEFINE: DEFINE INTHAND Label For 18Xxxx parts, an additional DEFINE allows assigning the low priority interrupt handler label: DEFINE INTLHAND Label Label is the beginning of your interrupt routine. PBP will place a jum p to this Label at location 4 in the PICm icro MCU. ' Assembly language interrupt example led var PORTB.1 byte $20 system byte bank0 system byte bank0 system
This instructs the com piler to place the variable at a particular location in RAM. In this m anner, if the save of W "punches through" to another bank, it will not corrupt other data. The interrupt routine should be as short and fast as you can possibly m ake it. If it takes too long to execute, the W atchdog Tim er could tim eout and really m ake a m ess of things. The routine should end with an Retfie instruction to return from the interrupt and allow the processor to pick up where it left off in your PicBasic Pro program . A good place to put the assem bly language interrupt handler is at the very beginning of your PicBasic Pro program . A GOTO needs to be inserted before it to m ake sure it wont be executed when the program starts. See the exam ple below for a dem onstration of this. If a 14-bit core PICm icro MCU has m ore than 2K of code space, an interrupt stub is autom atically added that saves the W , STATUS and PCLATH registers into the variables wsave, ssave and psave, before going to your interrupt handler. Storage for these variables m ust be allocated in the BASIC program : wsave var wsave1 var wsave2 var wsave3 var byte $20 system byte $a0 system byte $120 system byte $1a0 system
wsave var ssave var psave var
Goto start
' Skip around interrupt handler
Define interrupt handler define INTHAND myint Assembly language interrupt handler asm ; Save W, STATUS and PCLATH registers myint movwf wsave ; <= 2K only swapf STATUS, W ; <= 2K only clrf STATUS ; <= 2K only 188
If device has RAM in bank1 If device has RAM in bank2 If device has RAM in bank3
187
PicBasic Pro Compiler movwf ssave movf PCLATH, W movwf psave ; <= 2K only ; <= 2K only ; <= 2K only
; Insert interrupt code here ; Save and restore FSR if used bsf _led ; Turn on LED (for example)
; Restore PCLATH, STATUS and W registers movf psave, W movwf PCLATH swapf ssave, W movwf STATUS swapf wsave, F swapf wsave, W retfie endasm PicBasic Pro program starts here start: Low led Turn LED off Enable interrupt on PORTB.0 INTCON = %10010000 loop: Goto loop Wait here till interrupted
189
190
PicBasic Pro Compiler statem ents. The first com m and reads the pin's low level and outputs its com plem ent. The output driver (which is now high) begins to charge the cap. If the second operation is perform ed too quickly, it still reads the pin's level as low, even though the output driver is high. As such, the second operation will also drive the pin high. In practice, this is not m uch of a problem . And those com m ands designed for these types of interfacing (SOUND and POT, for exam ple) have built-in protection. This problem is not specific to PBP program s. This is a com m on problem for PICm icro MCU (and other m icrocontroller) program s and is one of the realities of program m ing hardware directly.
10. PicBasic Pro / PicBasic / Stamp Differences

Com patibility is a two-edged sword. And then there is the pointy end. PicBasic Pro has m ade som e concessions to usability and code size. Therefore we call it BASIC Stam p like rather than BASIC Stam p com patible. PBP has m ost of the BASIC Stam p I and II instruction set and syntax. However there are som e significant differences. The following sections discuss the im plem entation details of PBP program s that m ight present problem s. It is hoped that if you do encounter problem s, these discussions will help illum inate the differences and possible solutions.
10.3. Low Power Instructions 10.1. Execution Speed

The largest potential problem is speed. W ithout the overhead of reading instructions from the serial EEPROM, m any PBP instructions (such as GOTO and GOSUB) execute hundreds of tim es faster than their BASIC Stam p equivalents. W hile in m any cases this is a benefit, program s whose tim ing has been developed em pirically m ay experience problem s. The solution is sim ple - good program s don't rely on statem ent tim ing such as FOR..NEXT loops. W henever possible, a program should use handshaking and other non-tem poral synchronization m ethods. If delays are needed, statem ents specifically generating delays (PAUSE, PAUSEUS, NAP or SLEEP) should be used. W hen the W atchdog Tim er tim e-out wakes a PICm icro MCU from sleep m ode, execution resum es without disturbing the state of the I/O pins. For unknown reasons, when the BASIC Stam p resum es execution after a low power instruction (NAP or SLEEP), the I/O pins are disturbed for approxim ately 18 m Sec. PBP program s m ake use of the PIC's I/O coherency. The NAP and SLEEP instructions do not disturb the I/O pins.
10.4. Missing PC Interface

Since PBP generated program s run directly on a PICm icro MCU, there is no need for the Stam p's PC interface pins (PCO and PCI). The lack of a PC interface does introduce som e differences. W ithout the Stam ps IDE running on a PC, there is no place to send debugging inform ation. Debugging can still be accom plished by using one of the serial output instructions like DEBUG or SEROUT in conjunction with a term inal program running on the PC such as Hyperterm . W ithout the PC to wake the PICm icro MCU from an END or STOP statem ent, it rem ains idle until /MCLR is lowered, an interrupt occurs or power is cycled.
10.2. Digital I/O

Unlike the BASIC Stam p, PBP program s operate directly on the PORT and TRIS registers. W hile this has speed and RAM/ROM size advantages, there is one potential drawback. Som e of the I/O com m ands (e.g. TOGGLE and PULSOUT) perform readm odify-write operations directly on the PORT register. If two such operations are perform ed too close together and the output is driving an inductive or capacitive load, it is possible the operation will fail. Suppose, for exam ple, that a speaker is driven though a 10uF cap (just as with the SOUND com m and). Also suppose the pin is initially low and the program m er is attem pting to generate a pulse using TOGGLE 191
192
10.5. No Automatic Variables

The PicBasic Pro Com piler does not autom atically create any variables like B0 or W 0. They m ust be defined using VAR. Two files are provided: BS1DEFS.BAS and BS2DEFS.BAS that will define the standard BS1 or BS2 variables. However, it is recom m ended that you assign your own variables with m eaningful nam es rather than using either of these files.
10.9. Math Operators

Mathem atical expressions in PBP have precedence of operation. This m eans they are not evaluated in strict left to right order as they are in the BASIC Stam p and original PicBasic Com piler. This precedence m eans that m ultiplication and division are done before adds and subtracts, for exam ple. Parenthesis should be used to group operations into the order in which they are to be perform ed. In this m anner, there will be no doubt about the order of the operations. The following table list the operators in hierarchal order: Highest Precedence () NOT ~
10.6. No Nibble Variable Types

The BS2's nibble variable type is not im plem ented in the PicBasic Pro Com piler. As PBP allows m any m ore variables than a BS2, sim ply change nibble variable types to bytes.
10.7. No DIRS
The BASIC Stam p variable nam es Dirs, Dirh, Dirl and Dir0-Dir15 are not defined and should not be used with the PicBasic Pro Com piler. TRIS should be used instead, but has the opposite state of Dirs. This does not work in PicBasic Pro:
Dir0 = 1 Do this instead: TRISB.0 = 0 Set pin PORTB.0 to output or sim ply use a com m and that autom atically sets the pin direction. Doesnt set pin PORTB.0 to output SQR ABS DCD NCD COS SIN * ** */ / // + << >> MIN 193 194
10.8. No Automatic Zeroing of Variables

The BASIC Stam p sets all the variables and registers to 0 when a program starts. This is not autom atically done when a PBP program starts. In general, the variables should be initialized in the program to an appropriate state. Alternatively, CLEAR can be used to zero all the variables when a program starts.
PicBasic Pro Compiler Highest Precedence MAX DIG REV & ^ | &/ /| ^/ && AND ^^ XOR || OR Lowest Precedence
PicBasic Pro Compiler Any instructions that previously used parenthesis in their syntax should be changed to include square brackets instead.
10.11. ABS
ABS works slightly differently than on the Stam p in that it will take the absolute value of a byte as well as a word.
10.12. DATA, EEPROM, READ and WRITE

The BASIC Stam p allows serial EEPROM space not used for program storage to store non-volatile data. Since PBP program s execute directly from the PICm icro MCU's ROM space, EEPROM storage m ust be im plem ented in som e other m anner. The PIC16F84 (the default target for PBP program s), PIC16F83 and PIC16C84 have 64 bytes of on-chip EEPROM. PBP program s m ay use this for EEPROM operations and supports the Stam p's DATA, EEPROM, READ and WRITE com m ands. To access off-chip non-volatile data storage, the I2CREAD and I2CWRITE instructions have been added. These instructions allow 2wire com m unications with serial EEPROMs like Microchip Technologys 24LC01B. READ and WRITE will not work on devices with on-chip I2C interfaced serial EEPROM like the PIC12CE67x and PIC16CE62x parts. Use the I2CREAD and I2CWRITE instructions instead.
10.10. [ ] Versus ( )
PBP uses square brackets, [], in statem ents where parenthesis, (), were previously used. This is m ore in keeping with BASIC Stam p II syntax. For exam ple, the BS1 and original PicBasic Com piler SEROUT instruction looks som ething like: Serout 0,T2400,(B0) The PicBasic Pro Com piler SEROUT instruction looks like: Serout 0,T2400,[B0]
10.13. DEBUG
DEBUG in PBP is not a special case of SEROUT as it is on the Stam ps. It has its own m uch shorter routine that works with a fixed pin and baud rate. It can be used in the sam e m anner to send debugging inform ation to a term inal program or other serial device. DEBUG sends serial data out on PORTB, pin 0 at 2400 baud, unless otherwise DEFINEd.
195
196
PicBasic Pro Compiler Question m arks (?) in DEBUG statem ents are ignored. The m odifier ASC? Is not supported and should not be used.
10.17. IF..THEN
The BASIC Stam ps and the original PicBasic com piler only allow a label to be specified after an IF..THEN. PicBasic Pro additionally allows an IF..THEN..ELSE..ENDIF construct as well as allowing actual code to be executed as a result of an IF or ELSE.
10.14. FOR..NEXT
The BS2 autom atically sets the direction of the STEP for a FOR..NEXT loop. If the ending value is sm aller than the starting value and a STEP value is not specified, -1 is assum ed. PicBasic Pro always defaults to 1 if a STEP value is not specified. If a STEP of -1 is desired to m ake the loop count backwards, it m ust be specified: For i = 10 To 1 Step -1
10.18. LOOKDOWN and LOOKUP

LOOKDOWN and LOOKUP use BS1 syntax. LOOKDOWN2 and LOOKUP2 use BS2 syntax. LOOKDOWN and LOOKUP only support 8-bit constants in the table, not variables as in the BS1. You m ust use LOOKDOWN2 or LOOKUP2 if variables are required in the table.
10.15. GOSUB and RETURN

Subroutines are im plem ented via the GOSUB and RETURN statem ents. User variable W6 is used by the BS1 as a four nibble stack. Thus, Stam p program s m ay have up to 16 GOSUBs and subroutines can be nested up to four levels deep. The PICm icro MCUs have Call and Return instructions as well as an eight level stack. PBP program s m ake use of these instructions and m ay use four levels of this stack, with the other four levels being reserved for library routines. Thus, W6 is unused, subroutines m ay still be nested up to four levels deep (12 for PIC17Cxxx and 27 for PIC18Xxxx) and the num ber of GOSUBs is lim ited only by the PICm icro MCU's code space.
10.19. MAX and MIN

The MAX and MIN operators function have been altered som ewhat from the way they work on the Stam p and the original PicBasic Com piler. MAX will return the m axim um of two values. MIN will return the m inim um of two values. This corresponds m ore closely to m ost other BASICs and does not have the 0 and 65535 lim it problem s of the Stam ps MIN and MAX instructions. In m ost cases, you need only change MIN to MAX and MAX to MIN in your Stam p program s for them to work properly with PBP.
10.16. I2CREAD and I2CWRITE

The I2CREAD and I2CWRITE com m ands differ from the original PicBasic Com pilers I2CIN and I2COUT com m ands. The m ost obvious difference is that the data and clock pin num bers are now specified as part of the com m and. They are no longer fixed to specific pins. The other difference is that the control byte form at has changed. You no longer set the address size as part of the control byte. Instead, the address size is determ ined by the type of the address variable. If a bytesized variable is used, an 8-bit address is sent. If a word-sized variable is used, a 16-bit address is sent.
10.20. SERIN and SEROUT

SERIN and SEROUT use BS1 syntax. SERIN2 and SEROUT2 use BS2 syntax. A BS2 style tim eout has been added to the SERIN com m and. SERIN and SEROUT have been altered to run up to 9600 baud from the BS1 lim it of 2400 baud. This has been accom plished by replacing the little used rate of 600 baud with 9600 baud. Modes of T9600, N9600, OT9600 and ON9600 m ay now be used. 600 baud is no longer available and will cause a com pilation error if an attem pt is m ade to use it.
197
198
10.21. SLEEP
PBPs SLEEP com m and is based solely on the W atchdog Tim er. It is not calibrated using the system clock oscillator. This is because of the affect W atchdog Tim er resets have on the PICm icro MCU. W henever the PICm icro MCU was reset during SLEEP calibration, it altered the states of som e of the internal registers. For sm aller PICm icro MCUs with few registers, these registers could be saved before and restored after calibration resets. However, since PBP m ay be used on m any different PICm icro MCUs with m any registers that are altered upon reset, this save and restore proved to be too unwieldy. Therefore SLEEP runs in an uncalibrated m ode based strictly upon the accuracy of the W atchdog Tim er. This ensures the stability of the PICm icro MCU registers and I/O ports. However, since the W atchdog Tim er is driven by an internal R/C oscillator, its period can vary significantly based on tem perature and individual chip variations. If greater accuracy is needed, PAUSE, which is not a low-power com m and, should be used.
199
200

Baud Rate BIT 15 (Output) BIT 14 (Conversion ) True True Inverted Inverted BIT 13 (Parity ) None Even* None Even* Mode Number
Appendix A
Serin2/Serout2 Mode Examples
2400 Baud Rate BIT 15 (Output) BIT 14 (Conversion ) True True Inverted Inverted True True Inverted Inverted BIT 13 (Parity ) None Even* None Even* None Even* None Even* Mode Number 2400 2400 3313 11505 19697 27889 36081 44273 52465 60657 9600** 9600** 9600** 9600** 9600** 9600** 9600** 1200 1200 1200 1200 1200 1200 1200 1200 Driven Driven Driven Driven Open Open Open Open True True Inverted Inverted True True Inverted Inverted None Even* None Even* None Even* None Even* 813 9005 17197 25389 33581 41773 49965 58157 19200** 19200** 19200** 19200** 19200** 19200** 19200** 2400 2400 2400 2400 Driven Driven Driven Driven True True Inverted Inverted None Even* None Even* 396 8588 16780 24972 19200** 9600** 2400
Open Open Open Open
33164 41356 49548 57740
300 300 300 300 300 300 300 300
Driven Driven Driven Driven Open Open Open Open
True True Inverted Inverted True True Inverted Inverted
None Even* None Even* None Even* None Even*
84 8276 16468 24660 32852 41044 49236 57428
True True Inverted Inverted True True Inverted Inverted
None Even* None Even* None Even* None Even*
32 8224 16416 24608 32800 40992 49184 57376
*For odd parity, add: DEFINE SER2_ODD 1. **Oscillator faster than 4MHz m ay be required.
201
202

DEFINE I2C_HOLD 1 DEFINE I2C_INTERNAL 1 Pause I2C transmission while clock held low Use for internal EEPROM on 16CExxx and 12CExxx Set serial clock bipolar instead of open-collector Use for >8MHz OSC with standard speed devices For 12-bit core only For 12-bit core only Assign assembler interrupt handler label Assign assembler low priority interrupt handler label for 18Xxxx LCD data port LCD data starting bit 0 or 4 LCD register select port LCD register select bit LCD enable port LCD enable bit LCD read/write port LCD read/write bit LCD bus size 4 or 8 Number lines on LCD Command delay time in us Data delay time in us Bootloader is being used Dont insert CLRWDTs Oscillator speed in MHz: 3(3.58) 4 8 10 12 16 20 24 25 32 33 40 Set OSCCAL for 12C671/12CE673 Set OSCCAL for 12C672/12CE674 Maximum Pulsin/ Rctime count Change reset address for 18Xxxx Set number of data bits for Serin2 and Serout2 Set odd parity for Serin2 and Serout2 Slow down the Shiftin and Shiftout clock Use 18Xxxx LFSR instruction Dont translate Xin commands to BS2 format Dont translate Xout commands to BS2 format
Appendix B
Defines
DEFINE I2C_SCLOUT 1 DEFINE ADC_BITS 8 DEFINE ADC_CLOCK 3 DEFINE ADC_SAMPLEUS 50 DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE BUTTON_PAUSE 10 CCP1_REG PORTC CCP1_BIT 2 CCP2_REG PORTC CCP2_BIT 1 CHAR_PACING 1000 DEBUG_REG PORTB DEBUG_BIT 0 DEBUG_BAUD 2400 DEBUG_MODE 1 DEBUG_PACING 1000 DEBUGIN_REG PORTB DEBUGIN_BIT 0 DEBUGIN_MODE 1 HPWM2_TIMER 1 HPWM3_TIMER 1 HSER_BAUD 2400 HSER_SPBRG 25 HSER_RCSTA 90h HSER_TXSTA 20h HSER_EVEN 1 Number of bits in Adcin result ADC clock source (rc = 3) ADC sampling time in microseconds Button debounce delay in ms Hpwm 1 pin port Hpwm 1 pin bit Hpwm 2 pin port Hpwm 2 pin bit Serout character pacing in us Debug pin port Debug pin bit Debug baud rate Debug mode: 0 = True, 1 = Inverted Debug character pacing in us Debugin pin port Debugin pin bit Debugin mode: 0 = True, 1 = Inverted Hpwm 2 timer select Hpwm 3 timer select Hser baud rate Hser spbrg init Hser receive status init Hser transmit status init Use only if even parity desired Use only if odd parity desired Use for 8 bits + parity Automatically clear Hserin overflow errors Hser port to use on devices with more than one Hser2 baud rate Hser2 spbrg2 init Hser2 receive status init Hser2 transmit status init Use only if even parity desired Use only if odd parity desired Use for 8 bits + parity Automatically clear Hserin overflow errors DEFINE I2C_SLOW 1 DEFINE I2C_SCL PORTA,1 DEFINE I2C_SDA PORTA,0 DEFINE INTHAND Label DEFINE INTLHAND Label
DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE
LCD_DREG PORTA LCD_DBIT 0 LCD_RSREG PORTA LCD_RSBIT 4 LCD_EREG PORTB LCD_EBIT 3 LCD_RWREG PORTE LCD_RWBIT 2 LCD_BITS 4 LCD_LINES 2 LCD_COMMANDUS 2000 LCD_DATAUS 50 LOADER_USED 1 NO_CLRWDT 1 OSC 4
DEFINE HSER_ODD 1 DEFINE HSER_BITS 9 DEFINE HSER_CLROERR 1 DEFINE HSER_PORT 1 DEFINE DEFINE DEFINE DEFINE DEFINE HSER2_BAUD 2400 HSER2_SPBRG 25 HSER2_RCSTA 90h HSER2_TXSTA 20h HSER2_EVEN 1
DEFINE DEFINE DEFINE DEFINE
OSCCAL_1K 1 OSCCAL_2K 1 PULSIN_MAX 65535 RESET_ORG 0h
DEFINE SER2_BITS 8 DEFINE SER2_ODD 1 DEFINE SHIFT_PAUSEUS 50 DEFINE USE_LFSR 1 DEFINE XINXLAT_OFF 1 DEFINE XOUTXLAT_OFF 1
DEFINE HSER2_ODD 1 DEFINE HSER2_BITS 9 DEFINE HSER2_CLROERR 1
203
204

ISBIN9 ISBIN10 ISBIN11 ISBIN12 ISBIN13 ISBIN14 ISBIN15 ISBIN16 ISDEC ISDEC1 ISDEC2 ISDEC3 ISDEC4 ISDEC5 ISHEX ISHEX1 ISHEX2 ISHEX3 ISHEX4 ISHEX5 LCDIN LCDOUT LET LIBRARY LOOKDOWN LOOKDOWN2 LOOKUP LOOKUP2 LOW MAX MIN MOD NAP NCD NEXT NOT OFF ON OR ORNOT OUTPUT OWIN OWOUT PAUSE PAUSEUS PEEK PEEKCODE POKE POKECODE POLLIN POLLMODE POLLOUT POLLRUN POLLWAIT POT PULSIN PULSOUT PUT PWM RANDOM RCTIME READ READCODE REM REP REPEAT RESUME RETURN REV REVERSE SBIN SBIN1 SBIN2 SBIN3 SBIN4 SBIN5 SBIN6 SBIN7 SBIN8 SBIN9 SBIN10 SBIN11 SBIN12 SBIN13 SBIN14 SBIN15 SBIN16 SDEC SDEC1 SDEC2 SDEC3 SDEC4 SDEC5 SELECT SERIN SERIN2 SEROUT SEROUT2 SHEX SHEX1 SHEX2 SHEX3 SHEX4 SHEX5 SHIFTIN SHIFTOUT SIN SKIP SLEEP SOUND SQR STEP STOP STR SWAP SYMBOL SYSTEM THEN TO TOGGLE UNTIL USBIN USBINIT USBOUT VAR WAIT WAITSTR WEND WHILE WORD WRITE WRITECODE XIN XOR XORNOT XOUT
Appendix C
Reserved Words
ABS ADCIN AND ANDNOT ASM AUXIO BANK0 BANK1 BANK2 BANK3 BANK4 BANK5 BANK6 BANK7 BANK8 BANK9 BANK10 BANK11 BANK12 BANK13 BANK14 BANK15 BANKA BIN BIN1 BIN2 BIN3 BIN4 BIN5 BIN6 BIN7 BIN8 BIN9 BIN10 BIN11 BIN12 BIN13 BIN14 BIN15 BIN16 BIT BRANCH BRANCHL BUTTON BYTE CALL CASE CLEAR CLEARWDT CON COS COUNT DATA DCD DEBUG DEBUGIN DEC DEC1 DEC2 DEC3 DEC4 DEC5 DEFINE DIG DISABLE DIV32 DTMFOUT EEPROM ELSE ENABLE END ENDASM ENDIF ERASECODE EXT FOR FREQOUT GET GOSUB GOTO HEX HEX1 HEX2 HEX3 HEX4 HEX5 HIGH HPWM HSERIN HSERIN2 HSEROUT HSEROUT2 I2CREAD I2CWRITE IBIN IBIN1 IBIN2 IBIN3 IBIN4 IBIN5 IBIN6 IBIN7 IBIN8 IBIN9 IBIN10 IBIN11 IBIN12 IBIN13 IBIN14 IBIN15 IBIN16 IDEC IDEC1 IDEC2 IDEC3 IDEC4 IDEC5 IF IHEX IHEX1 IHEX2 IHEX3 IHEX4 IHEX5 INCLUDE INPUT INTERRUPT IS ISBIN ISBIN1 ISBIN2 ISBIN3 ISBIN4 ISBIN5 ISBIN6 ISBIN7 ISBIN8
205
206
PicBasic Pro Compiler Decimal 20 21 22 Hex 14 15 16 17 18 19 1A 1B 1C 1D 1E 1F ASCII Function DC4 (device control 4) NAK (negative acknowledge) SYN (synchronous idle) ETB (end of trans. block) CAN (cancel) EM (end of medium) SUB (substitute) ESC (escape) FS (file separator) GS (group separator) RS (record separator) US (unit separator) Key Ctrl-T Ctrl-U Ctrl-V Ctrl-W Ctrl-X Ctrl-Y Ctrl-Z Ctrl-[ Ctrl-\ Ctrl-] Ctrl-^ Ctrl-_
Appendix D
ASCII Table
ASCII Control Characters Decimal 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 Hex 0 1 2 3 4 5 6 7 8 9 A B C D E F 10 11 12 13 ASCII Function NUL (null) SOH (start of heading) STX (start of text) ETX (end of text) EOT (end of transmission) ENQ (enquiry) ACK (acknowledge) BEL (bell) BS (backspace) HT (horizontal tab) LF (line feed) VT (vertical tab) FF (form feed) CR (carriage return) SO (shift out) SI (shift in) DLE (data link escape) DC1 (device control 1) DC2 (device control 2) DC3 (device control 3) Key Ctrl-@ Ctrl-A Ctrl-B Ctrl-C Ctrl-D Ctrl-E Ctrl-F Ctrl-G Ctrl-H Ctrl-I Ctrl-J Ctrl-K Ctrl-L Ctrl-M Ctrl-N Ctrl-O Ctrl-P Ctrl-Q Ctrl-R Ctrl-S
23 24 25 26 27 28 29 30 31
207
208
PicBasic Pro Compiler Standard ASCII Character Set

Decimal He x 20 21 22 23 24 25 26 27 28 29 2A 2B 2C 2D 2E 2F 30 31 32 33 34 35 36 37 Display/ Key Space ! " # $ % & ' ( ) * + , . / 0 1 2 3 4 5 6 7 Decimal He x 40 41 42 43 44 45 46 47 48 49 4A 4B 4C 4D 4E 4F 50 51 52 53 54 55 56 57 Display/ Key @ A B C D E F G H I J K L M N O P Q R S T U V W Decimal He x 60 61 62 63 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70 71 72 73 74 75 76 77 Display /Key ` a b c d e f g h i j k l m n o p q r s t u v w Decimal He x 38 39 3A 3B 3C 3D 3E 3F Display/ Key 8 9 : ; < = > ?

Decimal He x 58 59 5A 5B 5C 5D 5E 5F Display/ Key X Y Z [ \ ] ^ _ Decimal He x 78 79 7A 7B 7C 7D 7E 7F Display /Key x y z { | } ~ DEL
56 57 58 59 60 61 62 63
88 89 90 91 92 93 94 95
120 121 122 123 124 125 126 127
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
209
210
Appendix E
Microchip Assembly Instruction Set
ADDLW**k ADDWF ANDLW ANDWF BCF BSF BTFSC BTFSS CALL CLRF CLRW CLRWDT COMF DECF DECFSZ f, d GOTO INCF INCFSZ IORLW IORWF MOVF MOVLW MOVWF NOP OPTION* RETFIE** RETLW RETURN** RLF RRF SLEEP SUBLW** k SUBWF SWAPF TRIS* XORLW XORWF f, d k f, d f, b f, b f, b f, b k f
f, d f, d k f, d f, d k f, d f, d k f
k f, d f, d
f, d f, d k f, d
b - bit address d - destination: 0 = w, 1 = f f - register file address k - literal constant * 12-bit core only ** 14-bit core only
211
212
Appendix F
Contact Information
Technical support and sales m ay be reached at: microEngineering Labs, Inc. Box 60039 Colorado Springs CO 80960-0039 (719) 520-5323 (719) 520-1867 fax http://www.m elabs.com em ail:support@ m elabs.com
READ THE FOLLOW ING TERM S AND CONDITIONS CAREFULLY BEFORE OPENING THIS PACKAGE. m icroEngineering Labs, Inc. ("the Com pany") is willing to license the enclosed software to the purchaser of the software ("Licensee") only on the condition that Licensee accepts all of the term s and conditions set forth below. By opening this sealed package, Licensee is agreeing to be bound by these term s and conditions.
Disclaimer of Liability THE COM PANY DISCLAIM S ALL W ARRANTIES, EXPRESS OR IM PLIED, INCLUDING W ITHOUT LIM ITATION THE IM PLIED W ARRANTY OF FITNESS FOR A PARTICULAR PURPOSE AND THE IM PLIED W ARRANTY OF M ERCHANTABILITY. IN NO EVENT SHALL THE COM PANY OR ITS EM PLOYEES, AGENTS, SUPPLIERS OR CONTRACTORS BE LIABLE FOR ANY INCIDENTAL, INDIRECT, SPECIAL OR CONSEQUENTIAL DAM AGES ARISING OUT OF OR IN CONNECTION W ITH LICENSE GRANTED UNDER THIS AGREEM ENT, INCLUDING W ITHOUT LIM ITATION, LOST PROFITS, DOW NTIM E, GOODW ILL, DAM AGE TO OR REPLACEM ENT OF EQUIPM ENT OR PROPERTY, OR ANY COSTS FOR RECOVERING, REPROGRAM M ING OR REPRODUCING ANY DATA USED W ITH THE COM PANY'S PRODUCTS.
PIC m icrocontroller data sheets and literature m ay be obtained from : M icrochip Technology Inc. 2355 W . Chandler Blvd. Chandler AZ 85224-6199 (480) 792-7200 (480) 792-7277 fax http://www.m icrochip.com em ail:literature@ m icrochip.com
Softw are License In consideration of Licensee's paym ent of the license fee, which is part of the price Licensee paid for this product, and Licensee's agreem ent to abide by the term s and conditions on this page, the Com pany grants Licensee a nonexclusive right to use and display the copy of the enclosed software on a single com puter at a single location. Licensee owns only the enclosed disk on which the software is recorded or fixed, and the Com pany retains all right, title and ownership (including the copyright) to the software recorded on the original disk copy and all subsequent copies of the software. Licensee m ay not network the software or otherwise use it on m ore than one com puter term inal at the sam e tim e. Copies m ay only be m ade for archival or backup purposes. The enclosed software is licensed only to the Licensee and m ay not be transferred to anyone else, nor m ay copies be given to anyone else. Any violation of the term s and conditions of this software license shall result in the im m ediate term ination of the license. 213

Manual Picbasic

Uploaded by

Copyright:

Available Formats

Manual Picbasic

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Manual Picbasic

Uploaded by

Copyright:

Available Formats

PicBasic Pro Compiler

microEngineering Labs, Inc.

PicBasic Pro Compiler

microEngineering Labs, Inc.

PicBasic Pro Compiler

PicBasic Pro Compiler

PicBasic Pro Compiler

1.1. The PICmicro MCUs

1.2. About This Manual

PicBasic Pro Compiler

1.3. Sample Programs

PicBasic Pro Compiler

2.2. Your First Program

2.3. Program That MCU

2.4. Its Alive

PicBasic Pro Compiler

2.5.1. PICmicro MCU Specific Issues 2.5. Ive Got Troubles

2.6. Coding Style

2.5.2. PicBasic and BASIC Stamp Compatiblity

2.5.3. Code Crosses Page Boundary Messages

2.5.4. Out of Memory Errors

PicBasic Pro Compiler

PicBasic Pro Compiler

2.6.2. Pin and Variable Names

If level < 10 Then High BattLED Endif

PicBasic Pro Compiler

PicBasic Pro Compiler

3. Command Line Options

PicBasic Pro Compiler

PicBasic Pro Compiler

3.2.6. Option -O 3.2.9. Option -V

PicBasic Pro Compiler

4. PicBasic Pro Basics

4.2. Line Labels

PicBasic Pro Compiler

PicBasic Pro Compiler

4.10. Ports and Other Registers

4.8. Numeric Constants

4.9. String Constants

Strings are usually treated as a list of individual character values. 25 26

Dir0 = 1 Do this instead:

Doesnt set pin PORTB.0 to output

TRISB.0 = 0 Set pin PORTB.0 to output

PicBasic Pro Compiler

PicBasic Pro Compiler

4.13. Multi-statement Lines

4.14. Line-extension Character

4.17. Math Operators

*Im plem entation differs from BASIC Stam p.

PicBasic Pro Compiler

PicBasic Pro Compiler

4.17.9. MAX and MIN

' Necessary if On Interrupt used

PicBasic Pro Compiler

<= >= If i > 10 Then loop

4.19. Logical Operators

4.17.14. Bitwise Operators

4.18. Comparison Operators

NOT or ! ANDNOT ORNOT XORNOT

PicBasic Pro Compiler