GCBasic documentation

GCB team
Table of Contents
Introducing Great Cow BASIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  1
Using GCBASIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  1
Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  1
Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  8
Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  9
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
Microcontroller Fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  12
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  17
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  18
Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  19
Lookup Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  24
ReadTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  25
Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
Subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  28
Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  32
Converters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  35
Command References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  39
Analog/Digital conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  39
ADFormat (Deprecated - Do not use) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  39
ADOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  40
ReadAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  40
ReadAD10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  42
EEPROM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
EPRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
EPWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  44
ProgramErase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
ProgramRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
ProgramWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
HEFM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
 HEFM Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
HEFreadBlock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  48
HEFRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  48
HEFwriteBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  49
HEFWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  50
Flow control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  51
Do . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  51
End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  52
Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  53
For . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  54
Gosub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  55
Goto. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  56
If . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  57
IndCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  59
Pause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  60
Repeat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  60
Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  61
Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  67
Interrupts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  69
Interrupts overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  69
IntOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  70
IntOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
On Interrupt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
On Interrupt: The default handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  78
Keypad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
Keypad Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
KeypadData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  82
KeypadRaw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  84
Graphical LCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
GLCD Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
ILI9340 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  90
KS0108 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  92
PCD8544 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  96
SDD1289 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  99
SSD1306 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  101
ST7735 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  105
ST7920 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  107
ST7920GLCDClearGraphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  117
 ST7920GLCDDisableGraphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  117
ST7920GLCDEnableGraphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  118
ST7920GraphicTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  118
ST7920LineHs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  118
ST7920Locate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  119
ST7920Tile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  120
ST7920cTile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  120
ST7920gLocate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  121
ST7920gTile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  121
ST7920lineh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  122
ST7920linev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  122
ST7920GLCDReadByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  122
ST7920WriteByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  123
ST7920WriteCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  124
ST7920WriteData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  124
ST7920gReaddata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  125
Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  125
Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  125
FilledBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  126
FilledCircle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  126
GLCDCLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  127
GLCDDrawChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  127
GLCDDrawString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  128
GLCDPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  128
GLCDReadByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  129
GLCDTimeDelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  129
GLCDWriteByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  129
InitGLCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  130
Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  131
Pset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  132
Liquid Crystal Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  133
LCD Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  133
LCD_IO 0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  134
LCD_IO 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  136
LCD_IO 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  137
LCD_IO 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  140
LCD_IO 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  142
LCD_IO 10 Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  144
 LCD_IO 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  144
LCD_IO 12 Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  146
LCD_SPEED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  146
CLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  147
Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  148
LCDBacklight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  148
LCDCreateChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  149
LCDCreateGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  150
LCDCmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  152
LCDCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  155
LCDHex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  157
LCDHome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  159
LCDDisplayOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  160
LCDDisplayOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  160
LCDSpace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  161
LCDWriteChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  162
Locate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  163
Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  164
Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  165
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  166
Two Wire LCD Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  166
Four Wire LCD Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  170
Eight Wire LCD Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  175
LCD_IO 10 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  179
Pulse with modulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  182
PWM Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  182
PWMOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  184
PWMOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  186
PWMOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  187
HPWM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  187
Random Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  189
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  189
Random . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  190
Randomize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  190
7-Segment Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  191
7 Segment Displays Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  191
Common Cathode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  193
Common Anode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  194
 DisplayValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  196
DisplayChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  199
One Wire Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  199
DS18B20 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  199
ReadDigitalTemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  200
ReadTemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  201
ReadTemp12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  203
Serial Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  206
RS232 (software) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  206
RS232 Software Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  206
InitSer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  206
SerSend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  207
SerReceive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  208
SerPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  209
RS232 (hardware) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  212
RS232 Hardware Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  212
HSerPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  213
HSerReceive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  215
HSerSend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  216
HserPrintByteCRLF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  217
HserPrintCRLF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  218
PS/2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  218
PS/2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  218
InKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  219
PS2SetKBLeds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  221
PS2ReadByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  222
PS2WriteByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  223
SPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  223
SPIMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  223
SPITransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  224
I2C Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  226
I2C Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  226
I2CAckPollState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  229
I2CAckpoll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  229
I2CReceive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  230
I2CReset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  233
I2CRestart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  233
I2CSend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  234
 I2CStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  236
I2CStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  237
I2C/TWI Hardware Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  237
HI2C Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  237
HI2CAckPollState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  240
HI2CReceive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  241
HI2CRestart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  247
HI2CSend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  248
HI2CStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  249
HI2CStartOccurred . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  250
HI2CMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  250
HI2CSetAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  250
HI2CStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  251
HI2CStopped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  251
Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  252
Sound Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  252
Tone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  252
ShortTone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  253
Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  254
Timer Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  254
ClearTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  254
InitTimer0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  255
InitTimer1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  257
InitTimer2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  259
InitTimer3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  259
InitTimer4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  260
InitTimer6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  261
Settimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  261
StartTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  262
StopTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  262
Reading Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  263
Variables Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  263
Using Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  263
More on setting Variables and Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  264
Setting Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  266
Dim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  268
BcdToDec_GCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  269
DecToBcd_GCB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  270
 Rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  270
Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  272
SWAP4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  273
SWAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  274
String Manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  274
Asc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  274
ByteToBin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  275
Chr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  276
Hex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  276
Instr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  277
LCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  278
Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  279
Len . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  280
Ltrim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  281
Mid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  281
Pad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  282
Right . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  283
Rtrim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  284
Str . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  284
Trim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  285
UCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  286
Val . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  287
WordToBin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  289
Concatenation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  289
Miscellaneous Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  290
Dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  290
Pot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  291
PulseOutInv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  293
PulseIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  294
PulseOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  294
Peek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  295
Poke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  296
Weak Pullups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  297
Maths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  299
Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  299
Average . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  299
Logarithms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  300
Log2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  300
 Loge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  301
Log10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  301
Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  302
Sqrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  303
Trigonometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  305
Compiler Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  308
#chip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  308
#config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  309
#define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  309
#if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  309
#ifdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  310
#ifndef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  312
#include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  313
#script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  314
#startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  314
#mem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  314
Other directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  315
Compiler Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  315
#option bootloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  315
#option NoContextSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  316
#option nolatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  317
Using Assembler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  318
Assembler Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  318
Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  319
Macros Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  319
Example Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  320
Measuring a Pulse Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  320
Implementing a method with a Pin name as a parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  322
Example Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  324
Flashing LEDs and an Interrupt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  324
Flashing LED with timing parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  326
Generate Accurate Pulses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  328
Graphical LCD Demonstration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  330
InfraRed Remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  333
SonyRemote.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  335
Midpoint Circle Algorithm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  337
IC2 Master Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  339
I2C Slave Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  344
 RGB LED Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  351
Serial/RS232 Buffer Ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  353
Sine Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  354
Trigonometry Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  359
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  361
Great Cow Graphical Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  362
Code Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  362
Windows .NET Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  364
GCBasic for Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  364
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  364
Introducing Great Cow BASIC
Hello, and welcome to Great Cow BASIC help. This help file is intended to act as a backup to several
other documents - to clarify topics which may not be made clear adequately in other places.

For information on installing GCBASIC and several other programs that may be helpful, please see
Getting Started with Great Cow BASIC.

If you’re new to programming, you should try the Great Cow BASIC tutorial. This explains everything
in a step-by-step manner, and assumes no prior knowledge.

If you’ve programmed in another language, then the demonstration files and command reference may
be the best place to turn.

If there’s anything else that you need help on, please visit the Great Cow BASIC forum.

Using GCBASIC
About GCBASIC

Need to compile a program with Great Cow BASIC, but don’t know where to begin? Try these
instructions:

1. First, download and install GCBASIC. It’s best if you let everything install to its default directory
(folder).

2. Open up the folder that contains GCBASIC. This is generally C:\Program Files\GCBASIC.

3. Open the folder that contains the program you want to compile. Make sure that you open it in a
new window.

4. Drag the icon of the file you want to compile onto gcbasic.exe. The compiler will open, compile the
file, and then close again.
(1)
5. A file called compiled.hex will have been created. Download this to your microcontroller , and
you’re set to go!

Additional, more detailed instructions are available on the Getting Started with GCBASIC page.

(1)
You need a suitable programmer to do this, and instructions should be included with the
programmer on how to download to the microcontroller.

Changes
Formal Release of GBASIC.EXE 0.941 31.07.2015

Updates to this Help are as follows:

Release 0.941
• Added weak pullup command set

• Added RAM usage when defining Array

• Added new method to use a Constant to define an Array

• Added information on how to set address on mjkdz I2C LCD 1602 Modules

• Added new constants ChipWords and ChipEEPROM

• Added new Table definition method

• Added new capabilities to Lookup Tables

• Added new capability to READAD for AVR microcomputers

• Added instructions to compile GCBASIC under Linux

• Added new command to invert an KS0108 GLCD display

• Added new example code - FLASH_LED

• Added how to set chip speed to non standard speeds

• Added new command parameter to hardware USART command set

• Added new command set for second hardware I2C port. The HI2C2 command set

• Added new command set for second USART port

• Added new ILI9340 GLCD driver command set

• Added SDD1289 GLCD driver command set

• Added example code

Measuring Pulse Width To Sub-Microsecond Resolution
Generating Accurate Pulses using a Macro
How to pass a Port address to routine using a Macro

• Added .NET support section

• Revised SPIMode command parameters

• Added #option NoContextSave

• Added On Intterupt: The default handler

• Added new sub-section Compiler Options, moved options from Compiler Directives

Release 0.94b
• Added HEFM support

• Added SSD 1306 GLCD Driver support

Release v0.91
• Added USART_TX_BLOCKING

• Added LCD_SPEED
 • Improved LCD section

Release v0.9ho
• Updated parameter passing to Sub routines

• New and revised LCD section to include LCD_IO 10 and 12

• Remove of LAT where appropiate

• LAT has been deprecated. The compiler will redirect all I/O pin writes from PORTx to LATx
registers on PIC 16F1/18F.

• Use #option nolatch if problems occur.

• ADFormat changed to deprecated.

• Add default action to #CHIP when no frequency is specified.

Release v0.9hm
• Correct errors in PWM section and improved examples.

Release v0.9hn
• Changes to Arrays. Number of elements is now limited to 10,000 for 12F and 16F devices, or, the
available RAM.

• Lookup tables updated to reflect new methods of populating tables.

1. a single value on each line

2. multiple elements on a single line separated by commas

3. constants and calculations within the single line data table entries are permitted

• Repeat loop changed to support EXIT REPEAT

• New Pad command. The Pad method is used to create string to a specific length that is extended
with a specific character

• Added DS18B20 command set.

v0.9hm
• Updated I2C - software and hardware. Demonstration code now uses Chipino demonstration
board. Changed to Serial I2C section with these new examples.

• New Functional Commands:

LCDDisplayOn
LCDDisplayOff
LCDBackLight ( On | Off )

• New Defines to support LCD functionality are:

LCD_SPEED FAST
LCD_SPEED MEDIUM
LCD_SPEED SLOW
 • Revised Functionality LCDHex now supports printing of leading zeros when the HEX number is
less than 0x10. call LCDHex as follows to ensure leading zeros are present.
LCDHex byte_value, LeadingZeroActive ; parameter called LeadingZeroActive

• New support for GLCD PCD8544 devices.

Changed GLCD section of the help to support the new device.

v0.9hl
• HSERPRINTCLRF - Added parameter to repeat the number of CRLF sent.

• Hardware I2C command set added. This is revised functionality to provide support the MSSP
module.

@0.9hk
• Help file updated to correct Power entry, it was in the incorrect section. Moved to Maths section
and other minors typos.

• Correct Timer0 information. Revised to show constants and the timer code was corrected.

@v0.9hj
• This information relates to the Hot Release 11 May 2014. Where functionality is not supported
by earlier versions of GCB please upgrade. Some functions will not work in the earlier releases
of Great Cow Basic.

• New Functional Commands

Circle. Draws a circle on the GLCD screen.
FilledCircle. Fills a circle on the GLCD screen
Log function(s)
Power function.

• Revised Functional Commands

Line. Now draws lines between any two points on the GLCD display.
#define GLCD_PROTECTOVERRUN . Controls drawing of circles to prevent overdraw of the circle at
display extremes.
#define Line OldLine. Adding this define will revert to the old line drawing routines. This has
been added for backward compatibility.

• Help File Revisions

Added PulseIn
Added IR_Remote header example
Added revised GLCD demonstration example
Added RGB LED Control example
Added section to show inline documentation method, see Code Documentation

@ v0.9hk
• Documented method for GCGB documentation.
Added MATHS.H
Added SQRT function.
@ v0.9hi
• Support for ST7735 documented. Functionality added to GLCD.h

• Support for ST7920 Graphical LCD 128 * 64 device.

• Revised GLCD section to include the one new and one undocumented device.

• New GLCD commands for support of ST7920 GLCD

ST7920GLCDEnableGraphics
ST7920GLCDDisableGraphics
ST7920GLCDClearGraphics
ST7920Locate
ST7920gTile
ST7920Tile
ST7920cTile
ST7920SetIcon
ST7920GraphicTest
ST7920LineHs
ST7920gLocate
ST7920lineh
ST7920linev

• Documented support for ST7735 GLCD.

• Revise GLCD commands with backwards compatibility:

GLCDCLS
GLCDPrint - supports LCD and GLCD modes
GLCDDrawString - support for string handling
GLCDDrawChar - Optional Colour
Box
FilledBox
Line
PSet
GLCDReady

• InitGLCD, includes fix for startup routine for KS0108 devices

Private ST7920 functions but can be used as needed..
ST7920WriteCommand
ST7920WriteData
ST7920WriteByte
ST7920gReaddata
ST7920GLCDReadByte
GLCDTimeDelay

• Updated conditional test information.

• Updated KeyPad information.

• Updated Lookup table information.

 • Added Macro information.

• Added new Trig maths section.

• Added two new Circle examples

• Added Other Directive information.

• Added example programs

• Mid Point Circles

• Trigonometry Circles

@v0.9hg
• Corrected GLCD Common Anode display pages

@v0.9hf
• Revised 7 Segment section to support Common Cathode. Split 7 Segment entry to show the two
options available.

@v0.9he
• New commands. Required post March 2014 LCD.h:
LCDHOME, LCDSPACE, LCDCreateGraph, LCDCursor, `LCDCmd

• Added Concatenation

• Updated DisplayValue to show the support for HEX values. Required post March 2014
7Segment.h

• Updated GLCD example code to ensure the example compiled without external files.

• Added Trigonometry and the example application

• Updated the LCD Overview to include the LATx support for higher clock speed. Required post
March 2014 LCD.h

@v0.9hd
• Revised Rotate to clarify type supported byte types.

@v0.9hc Mar 2014

• Revised HSERPRINT to show Integers and Longs are supported and changed the text to be
correct.

• Added HserPrintByteCRLF and HserPrintCRLF

• Added Sine Table Example

• Revised TABLE to show the limitation with respect to using WORDS when placing TABLES in
EEPROM

@v0.9hb Mar 2014

• Added PulseOutInv
 • I2CRestart

• Add new variants to use of Comments

• Added Assembler Section

Jan 14
• New item(s):
Len, Asc, Chr, Trim, Ltrim, Rtrim, Swap4, Swap, Abs, Average, Trim, Ltrim, Rtrim, Wordtobin, Bytetobin,
GLCD, DectoBCD, BCDtoDec
Using variables
More on constants and variables
Acknowledgements

• Changes to:
Str, Hex, Poke, Else, Readtable, Exit (was exitsub)
Command line parameters Frequently asked questions

• Fixed typos.

• Updated REPEAT maximum repeat value.

• Updated most pages for layout.

Fixed links to external pages, again. This time downloaded as full html pages, for POT and LC.
Added LABEL, Bootloader and revise Select, add READAD10
Fix Double SWAP

@v0.9hg
• Corrected GLCD Common Anode display pages

@v0.9hf
• Revised 7 Segment section to support Common Cathode. Split 7 Segment entry to show the two
options available.

@v0.9he
• New commands. Required post March 2014 LCD.h:
LCDHOME, LCDSPACE, LCDCreateGraph, LCDCursor, LCDCmd

• Added Concatenation

• Updated DisplayValue to show the support for HEX values. Required post March 2014
7Segment.h

• Updated GLCD example code to ensure the example compiled without external files.

• Added Trigonometry and the example application

• Updated the LCD Overview to include the LATx support for higher clock speed. Required post
March 2014 LCD.h

@v0.9hd
 • Revised Rotate to clarify type supported byte types.

@v0.9hc Mar 2014

• Revised HSERPRINT to show Integers and Longs are supported and changed the text to be
correct.

• Added HserPrintByteCRLF and HserPrintCRLF

• Added Sine Table Example

• Revised TABLE to show the limitation with respect to using WORDS when placing TABLES in
EEPROM

@v0.9hb Mar 2014

• Added PulseOutInv

• I2CRestart

• Add new variants to use of Comments

• Added Assembler Section

Jan 14
• New item(s):
Len, sc, Chr, Trim, Ltrim, Rtrim, Swap4, Swap, Abs, Average, Trim, Ltrim, Rtrim, Wordtobin, Bytetobin,
GLCD, DectoBCD, BCDtoDec
Using variables
More on constants and variables
Acknowledgements

• Changes to:
Str, Hex, Poke, Else, Readtable, Exit (was exitsub)
Command line parameters Frequently asked questions

• Fixed typos.

• Updated REPEAT maximum repeat value.

• Updated most pages for layout.

Fixed links to external pages, again. This time downloaded as full html pages, for POT and LC.
Added LABEL, Bootloader and revise Select, add READAD10
Fix Double SWAP

Command Line Parameters

About the Command Line Parameters

GCBASIC [/O:output.asm] [/A:assembler] [/P:programmer] [/K:\{C|A}] [/V] [/L] [/NP]

filename
 Switch Description Default

/O:filename Sets the name of the assembly Same name as the input file, but
file generated to filename. with a .asm extension.

/A:assembler Batch file used to call The program will not be

(1)
assembler . If /A:GCASM is given, assembled
GCBASIC will use its internal
assembler.

/P:programmer Batch file used to call The program will not be

(1)
programmer . This parameter is downloaded.
ignored if the program is not
assembled.

/K:{C|A} Keep original code in assembly No original code left in output.

output. /K:C will save comments,
/K:A will preserve all input code.

/V Verbose mode - compiler gives -

more detailed information about
its activities.

/L Show license and exit. -

/NP Do not pause on errors. Use with Pause when an error occurs, and
IDEs. wait for the user to press a key.

filename The file to compile. -

(1)
For the /A: and /P: switches, there are special options available. If %FILENAME% is present, it will be
replaced by the name of the .asm file. %FN_NOEXT% will be replaced by the name of the .asm file but
without an extension, and %CHIPMODEL% will be replaced with the name of the chip. The name of the chip
will be the same as that on the chip data file.

A batch to to load the ASM from GCBASIC into MPASM. I think that your m.bat should be like this:

@ECHO OFF
echo C:\progra~1\microc~1\mpasms~1\MPASMWIN /c- /o- /q+ /l- /x- /w1 %code%.asm
C:\progra~1\microc~1\mpasms~1\MPASMWIN /c- /o- /q+ /l- /x- /w1 %code%.asm

Frequently Asked Questions

Why doesn’t anything come up when I run gcbasic.exe?

Great Cow BASIC is a command line compiler. To compile a file, you can drag and drop it onto the
gcbasic.exe icon. There are also several Integrated Development Environments, or IDEs, available for
GCBASIC. These will give you an area where you can edit your program and a button to send the
program to the chip. Several are listed on the GCBASIC website.

What chips does Great Cow BASIC support?

Hopefully, all 8 bit PIC chips (those in the PIC10, PIC12, PIC16 and PIC18 families). If you find one that
GCBASIC does not work with properly, please post about it in the Compiler Problems section of the
GCBASIC forum. Support for Atmel AVR chips has been added.

Is Great Cow BASIC case sensitive?

No! For example, Set, SET, set, SeT, etc are all treated exactly the same way by GCBASIC.

Can I specify the bit of a variable to alter using another variable?

No. Set variable.other variable. This does not work. GCBasic may not generate an error, but it will not
act as expected.

Why is x feature not implemented?

Because it hasn’t been thought of, or no-one has been able to implement it! If there are any features
that you would like to see in Great Cow BASIC, please post them in the "Open Discussion" section of the
GCBASIC forum. Or, if you can, have a go at adding the feature yourself!

When using an include file does this use lots of memory?

When using include files, in this instance the <ds3231.h> include, if you are not using all the functions
of the include file, does GCB know not to include the non used functions within the include file when
compiling, or does everything get included anyway. For instance, if I am not using the hardware I2C,
does all the code related to hardware I2C still get compiled in the code?

GCBASIC only compiles functions and subroutines if they are called. GCBASIC starts by compiling the
main routine, then anything called from there. Each time it finds a new subroutine that is called, it
compiles it and anything that it calls. If a subroutine is not needed, it does not get compiled.

My LCD will not operate as expected?

Try adding. #define LCD_SPEED SLOW

This will slow the writing to the LCD.

Acknowledgements
Developers and Contributors:

Hugh Considine - Main developer of Great Cow Basic

Stefano Bonomi - Two-wire LCD subroutines

Geordie Millar - Swap and Swap4 subroutines

Jacques Nilo - HEFM and help file conversion to asciidoc

Finn Stokes - 8-bit multiply routine, program memory access code

Evan Venn - Utilities, revised I2C routines and the update to this help file

Translation Contributors:

Stefano Delfiore - Italian

Pablo Curvelo - Spanish

Murat Inceer - Turkish

Other Contributors:

Russ Hensel - Great Cow BASIC Notes.

Chuck Hellebuyck - His documentation for the GLCD and other pieces, see here.

Frank Steinberg - GCB@SYN IDE for Great Cow Basic, see here.

Alexy T. - SynWrite IDE used for GCB IDE, see here.

Thomas Henry for the Select Case and the Sine Table examples, see here and here respectively.

William Roth for the LCD code and supporting diagrams.

Conversion of asciidoctor documentation files:

See the asciidoctor Web site and the support forum.

Microcontroller Fundamentals
Inputs/Outputs
About Inputs and Outputs

Most general purpose pins on a microcontroller can function in one of two modes: input mode, or
output mode.

When acting as an input, the pin will be placed in high impedance state. The microcontroller will then
sense the pin, and the program can read the state of the pin and make decisions based on it.

When in output mode, the microcontroller will connect the pin to either Vcc (the positive supply), or
Vss (ground, or the negative supply). The program can then set the state of the pin.

GCBASIC will attempt to determine the direction of each pin, and set it appropriately. However, if the
pin is read from and written to, then then pin must be configured to input / output mode by the
program, using the appropriate Dir commands.

Configuration
About Configuration

(Note: This section does not apply to AVR microcontrollers. AVR chips do have a similar configuration
settings, but they are controlled through "Configuration Fuses". GCBASIC cannot set these - you*must*use
the programmer software.)

Every PIC chip has a CONFIG word. This is an area of memory on the chip that stores settings which
govern the operation of the chip.

The following asects of the chip are governed by the CONFIG word:

• Oscillator selection - will the chip run from an internal oscillator, or is an external one attached?

• Automatic resets - should the chip reset if the power drops too low? If it detects it is running the
same piece of code over and over?

• Code protection - what areas of memory must be kept hidden once written to?

• Pin usage - which pins are available for programming, resetting the chip, or emitting PWM signals?

The exact configuration settings vary amongst chips. To find out a list of valid settings, please consult
the datasheet for the PIC chip that you wish to use.

This can all be rather confusing - hence, GCBASIC will automatically set some config settings, unless
told otherwise:

• Low Voltage Programming (LVP) is turned off. This enables the PGM pin (usually B3 or B4) to be
used as a normal I/O pin.

• Watchdog Timer (WDT) is turned off. The WDT resets the chip if it runs the same piece of code
over and over - this can cause trouble with some of the longer delay routines in GCBASIC.

• Master Clear (MCLR) is disabled where possible. On many newer chips this allows the MCLR pin
(often PORTA.5) to be used as a standard input port. It also removes the need for a pull-up resistor
on the MCLR pin.

• An oscillator mode will be selected, based on the following rules:

◦ If the PIC has an internal oscillator, and the internal oscillator is capable of generating the
speed specified in the #chip line, then the internal oscillator will be used.

◦ If the clock speed is over 4 Mhz, the external HS oscillator is selected

◦ If the clock speed is 4 MHz or less, then the external XT oscillator mode is selected.

Note that these settings can easily be individually overridden whenever needed. For example, if the
Watchdog Timer is needed, adding the line
 #config WDT = ON

This will enable the watchdog timer, without affecting any other configuration settings.

Using Configuration

Once the necessary CONFIG options have been determined, adding them to the program is easy. On a
new line type "#config" and then list the desired options separated by commas, such as in this line:

#config OSC = RC, BODEN = OFF

GCBASIC also supports this format on 10/12/16 series chips:

#config INTOSC_OSC_NOCLKOUT, BODEN_OFF

However, for upwards compatibility with 18F chips, you should use the = style config settings.

It is possible to have several #config lines in a program - for instance, one in the main program, and
one in each of several #include files. However, care must then be taken to ensure that the settings in
one file do not conflict with those in another.

For more help, see #config Directive

Syntax
Arrays
About Arrays

An array is a special type of variable - one which can store several values at once. It is essentially a list
of numbers in which each one can be addressed individually through the use of an "index". The index
is a value in brackets immediately after the name of the array.

Examples of array names are:

Array/Index Meaning

Fish(10) Element 10 of an array called Fish

DataLog(2) The second number in an array named DataLog

ButtonList(Temp) An element in the array ButtonList that is selected

according to the value in the variable Temp
Defining an array

Use the DIM command to define an array.

DIM array_title ( number_of_elements )

The number of elements can be number, a variable or a constant. The use of constant was
implemented at GCBASIC compiler v0.941

Setting an entire array at once

It is possible to set several elements of an array with a single line of code. This short example shows
how:

Dim TestVar(10)
TestVar = 1, 2, 3, 4, 5, 6, 7, 8, 9

Element 0 of TestVar will be set to the number of items in the list, which in this case is 9. Each element
of the array will then be loaded with the corresponding value in the list - so in the example, TestVar(1)
will be set to 1, TestVar(2) to 2, and so on.

If there are many items in the array, it may be better to use a Lookup Table to store the items, and then
copy some of the data items into a smaller array as needed.

Using Arrays

To use an array, its name is specified, then the index. Arrays can be used everywhere that a normal
variable can be used.

The limit on array size varies dependent on the chip type.

1. The 12F/16F series of chips the array limit is the physical RAM less a few bytes for array handling.

2. For the AVR or an 18F there is not limit other than free RAM.

3. However, GCBASIC limits the array size of any array to 10,000 elements.

Get the most from the available memory

Array RAM usage is determined by the architecture of the chip type. Getting most out of the available
memory is determined by the allocation of the array within the available banks of memory.

An example is an array of 6 or 7 bytes when there is only 24 bytes of RAM and the 24 bytes is split
across multiple memory banks. Assume in this example that 18 bytes have allocated to other variables
and there is 29 bytes total available. An array of 6 bytes will fit into the free space in one bank, but the
array of 7 will not.
GCBASIC currently cannot split an array over banks, so if there are 6 bytes free in one bank and 5 in
another, you cannot have an array of 7 bytes. This would be very hard to do efficiently on 12F/16F as
there would be a series of special function registers in the middle of the array when using a 12F or 16F.
This constraint is not the case on 16F1/18F as linear addressing makes it easy to span banks because
the SFRs are not making the problem (as with 12F/16F).

For more help, see Declaring arrays with DIM

Comments
Usage:

Adding comments to your GCB program is done with an apostrophe before the comment line. You can
also comment out sections of code if you want just by placing an apostrophe, a semi-colon or use the
statement REM at the beginning of each line. The SynGCB IDE has a feature to do this automatically.

Example:

' The number of pins to flash

#define FlashPins 2

REM You can create a header using an apostrophe before each line
REM This is a great way to describe your program
REM You can also use it to describe the hardware connections.

' You can place comments above the command or on the same line
Dir PORTB Out ' Initialise PORTB to all Outputs

; The Main loop

do
PORTB = 0 ' All Pins off
Wait 1 S ' Delay 1 second
PORTB = 0xFF ' All pins on
Wait 1 s ' Delay 1 second
Loop

Conditions
About Conditions

In GCBASIC (and most other programming languages) a condition is a statement that can be either true
or false. Conditions are used when the program must make a decision. A condition is generally given as
a value or variable, a relative operator (such as = or >), and another value or variable. Several
conditions can be combined to form one condition through the use of logical operators such as AND
and OR.
GCBASIC supports these relative operators:

Symbol Meaning

= Equal

<> Not Equal

< Less Than

> Greater Than

⇐ Less than or equal to

>= Equal to or greater than

In addition, these logical operators can be used to combine several conditions into one:

Name Abbreviation Condition true if

AND & both conditions are true

OR | at least one condition is true

XOR # one condition is true

NOT ! the condition is not true

NOT is slightly different to the other logical operators, in that it only needs one other condition. Other
arithmetic operators may be combined in conditions, to change values before they are compared, for
example.

GCBASIC has two built in conditions - TRUE, which is always true, and FALSE, which is always false.
These can be used to create infinite loops.

It is also possible to test individual bits in conditions. To do this, specify the bit to test, then 1 or 0 (or
ON and OFF respectively). Presently there is no way to combine bit tests with other conditions - NOT,
AND, OR and XOR will not work.

Example conditions:

Condition Comments

Temp = 0 Condition is true if Temp = 0

Sensor <> 0 Condition is true if Sensor is not 0

Reading1 > Reading2 True if Reading1 is more than Reading2

Mode = 1 AND Time > 10 True if Mode is 1 and Time is more than 10

Heat > 5 OR Smoke > 2 True if Heat is more than 5 or Smoke is more than
2
Condition Comments

Light >= 10 AND (NOT Time > 7) True if Light is 10 or more, and Time is 7 or less

Temp.0 ON True if Temp bit 0 is on

Constants
About Defines

A define is a type of directive that tells the compiler to find a given word, and replace it with another
word or number. Defines are useful for situations where a routine needs to be easily altered. For
example, a define could be used to specify the amount of time to run an alarm for once triggered.

It is also possible to use defines to specify ports - thus defines can be used to aid in the creation of code
that can easily be adapted to run on a different PIC with different ports.

GCBASIC makes considerable use of defines internally. For instance, the LCD code uses defines to set
the ports that it must use to communicate with the LCD.

Using Defines

To create a define is a matter of using the #define directive. Here are some examples of defines:

#define Line 34
#define Light PORTB.0
#define LightOn Set PORTB.0 on

Line is a simple constant - GCBASIC will find Line in the program, and replace it with the number 34.
This could be used in a line following program, to make it easier to calibrate the program for different
lighting conditions.

Light is a port - it represents a particular pin on the PIC chip. This would be of use if the program had
many lines of code that controlled the light, and there was a possibility that the port the light was
attached to would need to change in the future.

LightOn is a define used to make the program more readable. Rather than typing Set PORTB.0 on over
and over, it would then be made possible to type LightOn, and have the compiler do the hard work.

GCBasic Defined constants

 #define ON 1
#define OFF 0
#define TRUE 255
#define FALSE 0

'Names for symbols

#define AND &
#define OR |
#define XOR #
#define NOT !
#define MOD %
#define forever 0

Functions
About Functions

Functions are a special type of subroutine that can return a value. This means that when the name of
the function is used in the place of a variable, GCBASIC will call the function, get a value from it, and
then put the value into the line of code in the place of the variable.

Functions may also have parameters - these are treated in exactly the same way as parameters for
subroutines. The only exception is that brackets are required around any parameters when calling a
function.

Using Functions

This program uses a function called AverageAD to take two analog readings, and then make a decision
based on the average:
 'Select chip
#chip 16F88, 20

'Define ports
#define LED PORTB.0
#define Sensor AN0

'Set port directions

dir LED out
dir PORTA.0 in

'Main code
Do
Set PORTB.0 Off
If AverageAD > 128 Then Set PORTB.0 On
wait 10 ms
Loop

Function AverageAD
'Get 2 readings, divide by 2, store in AverageAD
'Note the cast, the result of ReadAD needs to be converted to
'a word before adding, or the result may overflow.
AverageAD = ([word]ReadAD(Sensor) + ReadAD(Sensor)) / 2
end function

See Also Subroutines, Exit

Labels
About Labels

Labels are used as markers throughout the program. Labels are used to mark a position in the program
to ‘jump to’ from another position using a goto, gosub or other command.

Labels can be any word (that is not already a reserved keyword) and may contain digits and the
underscore character. Labels must start with a letter or underscore (not digit), and are followed
directly by a colon (:) at the marker position. The colon is not required within the actual commands.

The compiler is not case sensitive. Lower and/or upper case may be used at any time.

Example:
 'This program will flash the light until the button is pressed
'off. Notice the label named SWITCH_OFF.

#chip 16F628A, 4

#define BUTTON PORTB.0

#define LIGHT PORTB.1
Dir BUTTON In
Dir BUTTON Out

Do
PulseOut LIGHT, 500 ms
If BUTTON = 1 Then Goto SWITCH_OFF
Wait 500 ms
If BUTTON = 1 Then Goto SWITCH_OFF
Loop

SWITCH_OFF:
Set LIGHT Off
'Chip will enter low power mode when program ends

For more help, see Goto, Gosub

Lookup Tables
About Lookup Tables

A lookup table is a list of values that are stored in the program memory of the chip, which can be
accessed using the ReadTable command.

The advantage of lookup tables is that they are memory efficient, compared to an equivalent set of IF
statements.

Data tables can be define by

1. a single value on each line

2. multiple elements on a single line separated by commas

3. constants and calculations within the single line data table entries are permitted

4. an external data source file

Defining Tables

A single value on each line

 Table TestDataSource as Integer
    12
    24
    36
    48
    60
    72
    End Table

Multiple elements on a single line separated by commas:

Table TestDataSource as Integer

    12, 24, 36
    48, 60, 72
    End Table

Constants and calculations within the single line:

#define calculation_constant 2

Table TestDataSource as Integer

    1 * calculation_constant
    2 * calculation_constant
    4 * calculation_constant
    8 * calculation_constant
    16 * calculation_constant
    32 * calculation_constant
    End Table

Data tables can now be loaded directly from a file. The source file will be read as a hexidecimal raw
file.

Table TestDataSource from "sourcefile.raw"

Using Lookup Tables

First, the table must be created. The code to create a lookup table is simple - a line that has Table and
then the name of the table, a list of numbers (up to 10,000 elements), and then End Table.

For tables with more than 255 elements it is mandated to used a WORD variable to read the size of the
table. See below.

Once the table is created, the ReadTable command is used to read data from it. The ReadTable command
requires the name of the table it is to read, the location of the item to retrieve, and a variable to store
the retrieved number in.

Lookup tables can store byte, word, longs and integer values. GCBASIC will automatically detect the
type of the table depending on the values in it. GCBASIC can be explicitly instructed to cast the table to
a variable type, as follows:

Table TestDataSource as Integer

12
24
36
48
60
72
End Table

Item 0 of a lookup table stores the size of the table. If the ReadTable command attempts to read beyond
the end of the table, the value 0 will be returned.

For tables with more than 255 elements it is mandatory to use a WORD variable to read the size of the
table. See below.

dim lengthoftable word

readtable TestDataSource , 0, lengthoftable
print lengthoftable ; will print the size as a word

table TestDataSource
'a table with more than 255 elements
end table

For tables that are defined using an external file the table data will be read into the TestDataSource
table from the external file.

An example file is shown below:

The following program will import the external data file.

 #chip 16f877a

Table TestDataSource from "sourcefile.raw"

for nn = 1 to 10
  ReadTable TestDataSource, nn, inc
  HSerPrint inc
next

And the program will out the following:

Advanced use of Lookup Tables

You can use the Table statement to store the data table in EEPROM. If the compiler is told to store a data
table in "Data" memory, it will store it in the EEPROM.

The limitation of of using EPPROM tables is that you can only store BYTEs. You cannot
NOTE
store WORD values in the EEPROM tables.

Here is some example code:

 #chip 16F628

'Read table item

'Must use ReadTable and a variable for the index, or the table won't be
downloaded to EEPROM

TableLoc = 2
ReadTable TestDataSource, TableLoc, SomeVar

'Write to table , this is not required

EPWrite 1, 45

'Table of values to write to EEPROM

'EEPROM location 0 will store length of table
'Subsequent locations will each store a value

Table TestDataSource Store Data

12
24
36
48
60
72
End Table

For more help, see ReadTable

Miscellaneous
Combining multiple instructions

It is possible to combine multiple instructions on a single line, by separating them with a colon. For
example, this code:
 Set PORTB.0 On
Set PORTB.1 On
Wait 1 sec
Set PORTB.0 Off
Set PORTB.0 Off

could also be written as:

Set PORTB.0 On: Set PORTB.1 On

Wait 1 sec
Set PORTB.0 Off: Set PORTB.0 Off

In most cases, it will make no difference if commands share a line or not. However, special care should
be taken with If commands, as this code:

Set PORTB.0 Off

Set PORTB.1 Off
If Temp > 10 Then Set PORTB.0 On: Set PORTB.1 On
Wait 1 s

Will be equivalent to this:

Set PORTB.0 Off

Set PORTB.1 Off
If Temp > 10 Then
Set PORTB.0 On
Set PORTB.1 On
End If
Wait 1 s

Also, the commands used to start and end subroutines, data tables and functions must be alone on a
line. For example, this is WRONG:

Sub Something: Set PORTB.0 Off: End Sub

ReadTable
Syntax:

ReadTable TableName, Item, Output

Command Availability:
Available on all microcontrollers.

Explanation:

The ReadTable command is used to read information from lookup tables. TableName is the name of the
table that is to be read, Item is the line of the table to read, and Output is the variable to write the
retrieved value in to.

Item is 1 for the first line of the table, 2 for the second, and so on. Item 0 gives the size of the table. Care
must be taken to ensure that the program is not told to read beyond the end of the table, or strange
effects will be observed.

The type of Output should match the type of data stored in the table. For example, if the table contains
Word values then Output should be a Word variable. If the type does not match, GCBASIC will attempt
to convert the value.

Example:

'Chip Settings
#chip 16F88, 20

'Hardware Settings
#define LED PORTB.0
Dir LED Out

'Main Routine
ReadTable TimesTwelve, 4, Temp
Set LED Off
If Temp = 48 Then Set LED On

'Lookup table named "TimesTwelve"

Table TimesTwelve
12
24
36
48
60
72
84
96
108
120
132
144
End Table
For more help, see Lookup Tables

Scripts
About Scripts

A script is a small section of code that Great Cow BASIC runs when it starts to compile a program. Their
main use is to perform calculations that are required to adjust the program for different speed chips.

Scripts are not compiled and downloaded to the microcontroller - GCBASIC reads them, runs them,
removes them from the program and then allows any results they have calculated to be used as
constants in the program.

Inside a script, constants are treated like variables. Scripts can read the values of constants, and set
them to contain new values.

Using Lookup Tables

Scripts start with #script and end with #endscript. Inside, they can consist of 3 commands:

If
Assignment (=)
Error

If is similar to the If command in normal GCBASIC code, except that it doesn’t have an Else clause. It is
used to compare the values of constants.

The = sign is identical to that in GCBASIC programs. The constant that is to be set goes on the left side of
the =, and the new value goes on the right.

Error is used to display an error message. Anything after the Error command is displayed at the end of
compilation, and is saved in the error log for the program.

Example Script

This script is used in the pwm.h file. It takes the values of the constants PWM_Freq, PWM_Duty and
ChipMHz, and uses the equations shown in the PIC datasheets to calculate the correct values for the
relevant system variables.
 #script
PR2Temp = int((1/PWM_Freq)/(4*(1/(ChipMHz*1000))))
T2PR = 1
If PR2Temp > 255 Then
PR2Temp = Int((1 / PWM_Freq) / (16 * (1 / (ChipMHz * 1000))))
T2PR = 4
If PR2Temp > 255 Then
PR2Temp = Int(( 1 / PWM_Freq) / (64 * (1 / (ChipMHz * 1000))))
T2PR = 16
If PR2Temp > 255 Then
Error Invalid PWM Frequency value
End If
End If
End If

DutyCycle = (PWM_Duty * 10.24) * PR2Temp / 1024

DutyCycleH = (DutyCycle AND 1020) / 4
DutyCycleL = DutyCycle AND 3
#endscript

After this script has run, the values PR2Temp, DutyCycleH and DutyCycleL are used as constants to set up
the required variables.

Subroutines
About Subroutines

A subroutine is a small program inside of the main program. Subroutines are typically used when a
task needs to be repeated several times in different parts of the main program.

There are two main uses for subroutines:

• Keeping programs neat and easy to read

• Reducing the size of programs by allowing common sections of code to be reused.

When the PIC comes to a subroutine it saves its location in the current program before jumping to the
start of, or calling, the subroutine. Once it reaches the end of the subroutine it returns to the main
program, and continues to run the code where it left off previously.

Normally, it is possible for subroutines to call other subroutines. There are limits to the number of
times that a subroutine can call another sub, which vary from chip to chip:

PIC Family Instruction Width Number of subs called

10F*, 12C5*, 12F5*, 16C5*, 16F5* 12 1

PIC Family Instruction Width Number of subs called

12C*, 12F*, 16C*, 16F*, except 14 7

those above

18F*, 18C* 16 31

These limits are due to the amount of memory on the PIC which saves its location before it jumps to a
new subroutine. Some GCBASIC commands are subroutines, so you should always allow for 2 or 3
subroutine calls more than your program has.

AVR microcontrollers have no fixed limit on how many subroutines can be called at a time, but if too
many are called then some variables on the chip may be corrupted. To check if there are too many
subroutines, work out the most that will be called at once, then multiply that number by 2 and create
an array of that size. If an out of memory error message comes up, there are too many calls.

Another feature of subroutines is that they are able to accept parameters. These are values that are
passed from the main program to the subroutine when it is called, and then passed back when the
subroutine ends.

Using Subroutines

To call a subroutine is very simple - all that is needed is the name of the sub, and then a list of
parameters. This code will call a subroutine named "Buzz" that has no parameters:

Buzz

If the sub has parameters, then they should be listed after the name of the subroutine. This would be
the command to call a subroutine named "MoveArm" that has three parameters:

MoveArm NewX, NewY, 10

If a subroutine has parameters, you may choose to put brackets around them, like so:

MoveArm (NewX, NewY, 10)

All that this does is change the appearance of the code - it doesn’t make any difference to what the code
does. Decide which one meets your own personal preference, and then stick with it.

Creating subroutines

To create a subroutine is almost as simple as using one. There must be a line at the start which has sub,
and then the name of the subroutine. Also, there needs to be a line at the end of the subroutine which
reads end sub. To create a subroutine called Buzz, this is the required code:
 sub Buzz

'code for the subroutine goes here

end sub

If the subroutine has parameters, then they need to be listed after the name. For example, to define the
MoveArm sub used above, use this code:

sub MoveArm(ArmX, ArmY, ArmZ)

'code for the subroutine goes here

end sub

In the above sub, ArmX, ArmY and ArmZ are all variables. If the call from above is used, the variables will
have these values at the start of the subroutine:

ArmX = NewX
ArmY = NewY
ArmZ = 10

When the subroutine has finished running, GCBASIC will copy the values back where possible. NewX
will be assigned to ArmX, and NewY will be assigned to ArmY. GCBASIC will not attempt to set the number
10 to ArmZ.

Controlling the direction data moves in

It is possible to instruct GCBASIC not to copy the value back after the subroutine is called. If a
subroutine is defined like this:

sub MoveArm(In ArmX, In ArmY, In ArmZ)

'code for the subroutine goes here

end sub

Then GCBASIC will copy the values to the subroutine, but will not copy them back.

GCBASIC can also be prevented from copying the values back, by adding Out before the parameter
name. This is used in the EEPROM reading routines - there is no point copying a data value into the
read subroutine, so Out has been used to avoid wasting time and memory. The EPRead routine is
defined as Sub EPRead(In Address, Out Data).
Many older sections of code use #NR at the end of the line where the parameters are specified. The #NR
means "No Return", and when used has the same effect as adding In before every parameter. Use of #NR
is not recommended, as it does not give the same level of control.

Using different data types for parameters

It is possible to use any type of variable a as parameter for a subroutine. Just add As and then the data
type to the end of the parameter name. For example, to make all of the parameters for the MoveArm
subroutine word variables, use this code:

sub MoveArm(ArmX As Word, ArmY As Word, ArmZ As Word)

...
end sub

Optional parameters

Sometimes, the same value may be used over and over again for a parameter, except in a particular
case. If this occurs, a default value may be specified for the parameter, and then a value for that
parameter only needs to be given in a call if it is different to the default.

For example, suppose a subroutine to create an error beep is required. Normally it emits ! 440 Hz tone,
but sometimes a different tone is required. To create the sub, this code would be use:

Sub ErrorBeep(Optional OutTmne As Word = 440)

  Tone OutTone, 100
End Sub

Note the Optional before the parameter, and the = 440 after it. This tells GCBASIC that if no parameter
is supplied, then set the OutTone parameter to 440.

If called using this line:

ErrorBeep

then a 440 Hz beep will be emitted. If called using this line:

ErrorBeep 1000

then the sub will produce a 1000 Hz tone.

When using several parameters, it is possible to make any number of them optional. If the optional
parameter/s are at the end of the call, then no value needs to be specified. If they are at the start or in
the middle, then you must insert commas to allow GCBASIC to tell where the optional parameters are.
Overloading

It is possible to have 2 subroutines with the same name, but different parameters. This is known as
overloading, and GCBASIC will automatically select the most appropriate subroutine for each call.

An example of this is the Print routine in the LCD routines. There are actually several Print
subroutines; for example, one has a byte parameter, one a word parameter, and one a string
parameter. If this command is used:

Print 100

Then the Print (byte) subroutine will be called. However, if this command is used:

Print 30112

Then the Print (word) subroutine will be called. If there is no exact match for a particular call,
GCBASIC will use the option that requires the least conversion of variable types. For example, if this
command is used:

Print PORTB.0

The byte print will be used. This is because byte is the closest type to the single bit parameter.

See Also Functions, Exit

Variables
About Variables

A variable is an area of memory on the microcontroller that can be used to store a number or a series
of letters. This is useful for many purposes, such as taking a sensor reading and acting on it, or
counting the number of times the robot has performed a particular task.

Each variable must be given a name, such as "MyVariable" or "PieCounter". Choosing a name for a
variable is easy - just don’t include spaces or any symbols (other than _), and make sure that the name
is at least 2 characters (letters and/or numbers) long.

Variable Types

There are several different types of variable, and each type can store a different sort of information.
These are the variable types that Great Cow BASIC can currently use:
Variable type Information that this variable Example uses for this type of
can store variable

Bit A bit (0 or 1) Flags to track whether or not a

piece of code has run

Byte A whole number between 0 and General purpose storage of data,

255 such as counters

Word A whole number between 0 and Storage of extra large numbers

65535

Integer A whole number between -32768 Anything where a negative

and 32767 number will occur

Long A whole number between 0 and Storing very, very big numbers
32
2 (4.29 billion)

Array A list of whole numbers ranging Logs of sensor readings

from 0 to 255

String A series of letters, numbers and Messages that are to be shown

symbols. on a screen

Using Variables

Byte variables do not need any special commands to set them up - just put the name of the variable in
to the command where the variable is needed.

Other types of variable can be used in a very similar way, except that they must be "dimensioned" first.
This involves using the DIM command, to tell Great Cow BASIC that it is dealing with something other
than a byte variable.

A key feature of variables is that it is possible the have the microcontroller check a variable, and only
run a section of code if it is a given value. This can be done with the IF command.

String Variables

Strings are defined as follows:

'Create buffer variables to store received messages

Dim Buffer As String

String variables default to the following rules and the RAM constraints of a specific chip.

• 10 bytes for chips with less than 16 bytes of RAM.

• 20 bytes for chips with 16 to 367 bytes of RAM.

• 40 bytes for devices with more RAM than 367 bytes.

 • For chips that have less RAM then required RAM to support the strings will be NOT be allocated.
You cannot store a string 20 characters long in a chip with 16 bytes of RAM.

Defining a length for the string is the best way to limit memory usage. It is good practice if you need a
string of a certain size to set the length of a strings, since the default length for a string variable
changes depending on the amount of memory in the microcontroller (see above).

To set the length see the example below:

'Create buffer variables to store received messages as 16 bytes long

Dim OutBuffer As String * 16

Variable Aliases

Some variables are aliases, which are used to refer to memory locations used by other variables. These
are useful for joining predefined byte variable together to form word variables.

Alias are not like pointers in many languages - they must always refer to the same variable or variables
and cannot be changed.

Casting

Casting changes the type of a variable or value. Placing the type that the value should be converted to
in square brackets will tell the compiler to convert it. For example, this will cause two byte variables to
be treated as word variables by the addition code:

Dim MyWord As Word

MyWord = [word]ByteVar + AnotherByteVar

Why do this? If there are no casts, then GCBASIC will add the two values using the byte addition code,
and then convert the result to a word to store in MyWord. Suppose that ByteVar is 150, and AnotherByteVar
is 231. When added, this will come to 381 - which will overflow, leaving 125 in the result. However,
when the cast is added, GCBASIC will treat ByteVar as if it were a word, and so will use the word
addition code. This will cause the correct result to be calculated.

Often, a cast will be used when calculating an average:

MyAverage = ([word]Value1 + Value2) / 2

It’s also possible to cast the second value:

MyAverage = (Value1 + [word]Value2) / 2

The result will be exactly the same.

For more help, see: Declaring variables with DIM, Setting Variables

Doing things to individual bits of variables see, Set, Rotate

Checking variables and doing different things based on their value, see If, Do, For, Conditions

Converters
About Converters

Converters allow GCBasic to read files that have been created by other programs. A converter can
convert these files into GCBASIC libraries or any GCBASIC instruction or a GCBasic dataset.

The use case for using a converters can be where you have a data source file another computer system.
This files could be databases, graphical, reference data or music files. The converter will read these
source files and convert into a format the can be processed by GCBasic. The conversion process is
completed by external application which can written by the developer or you can use one of the
converters provided with the GCBasic release.

The GCBasic release includes the converter for BMP files, EZ CAD files and standard Text files.

With an appropriate Converter is installed, and an associated #include to these non-GCBASIC files,
GCBasic will detect that the file extension and hand the processing to the external converting program.
When the external converting program had complete GCBasic will then continue to with the converted
source file as a GCBasic source file.

An example of an converters is to read an existing picture file, to convert the picture file to a GCB table,
then to refer to the picture file table to display the picture file on a GLCD.

Conversion is achieved by including a command within the source program to transform external
data. The command used is the instruction #include followed by the data source. An example:

'Convert ManLooking.BMP to a GCBASIC usable format.

#include <..\converters\ManLooking.BMP>

The inclusion of the #include line within a GCBASIC program will enable the commencement of the
following process:

1. GCBASIC will examine the ..\converters folder structure for a configuration file that will handle
the file extension specified in the include statement.

2. GCBASIC will examine the configuration file(s) *.INI for command line instructions.

3. GCBASIC will at stage examine the folder structure for the source file and the target transformed
 file. If the source file is older than the transformed file the next step will not be executed, goto step
6.

4. GCBASIC will execute the command as specified within the configuration file to transform the
source file to the target file.

The Conversion program must create the output file extension as specified in the configuration file.
If the include statement as an extension of .TXT and the configuration files states the input file
extension as .TXT and the output as .GCB the converted file must have the extension of .GCB.

#include <..\converters\ManLooking.BMP>

Init file is input file as BMP and output as GCB, then the file expected is
..\converters\ManLooking.GCB

5. GCBASIC will attempt to include the transformed target file (with the file extension as specified in
the configuration file) within the GCBASIC program.

6. GCBASIC will resume normal processing of the GCBASIC program including the transformed target
file, therefore, with normal compiling and errors handling.

For example programs see here.

More about Converters

1. The configuration file

The configuration file MUST have the extension of .INI. No leading spaces are permitted in the
configuration file. Specification of the configuration file. The file has four items: desc, in, out and
exe. Where:

desc : Is the description shown in GCGB

in : Is the source file extension to be transformed
out : Is the targer transformed file extension.
exe : Is the executable to be run for this specific configuration file.

You can have multiple configuration files within the ..\converters folder structure.

GCBASIC will examine all configuration file to match the extension as specified in the #include
command.

Example 1 :
 ezCircuit Designer Projects conversion configuration file is called ezcd2GCBasic.ini. The
source extension is .ezproj, the transformed file extension is .h, and the executable is called
ezcd2GCBasic.exe

desc = ezCircuit Designer Projects (*.ezproj)

in = ezproj
out = h
exe = ezcd2GCBasic .exe

Example 2 :

CoreChart Programs conversion configuration file is called bst2GCBasic.ini. The source

extension is .bst, the transformed file extension is .GCB, and the executable is called
bst2GCBasic.exe

desc = CoreChart Programs (*.bst)

in = bst
out = GCB
exe = bst2GCBasic .exe

Example 3 :

BMP (Black and White) conversion configuration file is called BMP2GCBasic.ini. The source
extension is .bmp, the transformed file extension is .GCB, and the executable is called
BMP2GCBASIC.exe.

desc = BMP file (*.bmp)

in = bmp
out = GCB
exe = BMP2GCBASIC .exe

An example :

#include <..\converters\ManLooking.BMP>

Will be converted by the BMP2GCBASIC .EXE to ..\converters\ManLooking.GCB

Example 4 :
 Data file conversion configuration file is called TXT2GCB.ini. The source extension is .TXT, the
transformed file extension is .GCB, and the command line called AWKRUN.BAT .

desc = Infrared Patterns (*.txt)

in = txt
out = GCB
exe = awkrun.bat

An example :

#include <..\converters\InfraRedPatterns.TXT>

Will be converted by the AWKRUN.BAT to ..\converters\ InfraRedPatterns.GCB

The example would require a supporting batch file and a script process to complete the
transformation.

2. Conversion Executable

The conversion executable may be written in any language (compiled or interpreted).

The conversion executable MUST create the converted file with the correct file extension as
specified in the configuration file.

The conversion executable will be passed one parameter - the source file name. Using example #3
the conversion executable would be passed ..\converters\ManLooking.BMP

The conversion executable MUST create a GCBASIC compatible source file. Any valid
commands/instruction are permitted.

3. Installation

The INI file, the source file and the conversion executable MUST be located in the ..\converters
folder. The converters folder is relative to the GCBASIC.EXE compiler folder.

Example 5 : Converter Program

 This program converts the InfraRedPatterns.TXT into InfraRedPatterns.GCB that will have a
GCBasic table called DataSource. This example is located in the converter folder of the GCBasic
installation.

#chip16f877a, 16
#include <..\converters\InfraRedPatterns.TXT>

dir portb out

' These must be WORDs as this could be large table.

dim TableReadPosition, TableLen as word

dir portb out

' Read the table length

TableReadPosition = 0
ReadTable DataSource, TableReadPosition, TableLen

Do Forever
    For TableReadPosition = 1 to TableLen step 2
        ReadTable DataSource, TableReadPosition, TransmissionPattern
        ReadTable DataSource, TableReadPosition+1 , PulseDelay
        portb = TransmissionPattern
        wait PulseDelay ms
    next
Loop

Command References
Analog/Digital conversion
ADFormat (Deprecated - Do not use)

Syntax:

ADFormat ( Format_Left | Format_Right )

Command Availability:

Available only on PIC.

Explanation:

Left justified means 8 bits in the high byte, 2 in the low. Right justified means 2 in the high byte, and
the remaining 8 in the low byte. It’s only supported on PIC.

ADOff

This command is obsolete. There should be no need to call it. GCBASIC will automatically disable the
A/D converter and set all pins to digital mode when starting the program, and after every use of the
ReadAD function.

It is recommended that this command be removed from all programs.

ReadAD

Syntax:

var = ReadAD (port)

Command Availability:

Available on all PIC and AVR chips with an analog to digital converter module built in.

Explanation:

Return an 8 bit number [0-255]

ReadAD is a function that can be used to read the built-in analog to digital converter that many
microcontroller chips include. port should be AN0, AN1, AN2, etc., up to the number of analog inputs
available on the chip that is in use. Those familiar with AVR microcontrollers can also refer to the ports
as ADC0, ADC1, etc. Refer to the datasheet for the microcontroller chip to find the number of ports
available. (Note: it’s perfectly acceptable to use ANx on AVR, or ADCx on PIC.)

Another function, ReadAD10, is almost identical to ReadAD. The only difference is that it returns a full 10
bit value in a word variable.

AD_Delay controls is the acquisition delay. The default value is 20 us. This can be changed by adding the
following constant.

#define AD_Delay 2 10us

ADSpeed controls the source of the clock for the ADC module. It varies from one chip to another.
InternalClock is a PIC only option that will drive the ADC from an internal RC oscillator. The default
value is 128.
 'default value
#define ADSpeed MediumSpeed

'pre-defined constants
#define HighSpeed 255
#define MediumSpeed 128
#define LowSpeed 0

AD_VREF_DELAY controls the charging time for VRef capacitor on AVR microprocessors only. This
therefore controls the charge from internal VRef. ReadAD will not be accurate for internal reference
without this.

When selecting the reference source for ADC on ATmega328 GCBASIC will overwrite anything that you
put into te ADMUX register - but this option allow you change the ADC reference source on AVR
microprocessors. You can set the AD_REF_SOURCE constant to whatever you want to use. It defaults to
the VCC pin, as example you can set the AVR to use the 1.1V reference with this:

#define AD_REF_SOURCE AD_REF_256 ' 256 refers to the 2.56V reference on some older AVRs,
but the same code will select the 1.1V reference on an ATmega328p

Example 1:

' Dynamically switching reference.

#define AD_REF_SOURCE ADRefSource
#define AD_VREF_DELAY 5 ms
AdRefSource = AD_REF_AVCC
HSerPrint ReadAD10(AN1)
HSerPrint ", "
AdRefSource = AD_REF_256
HSerPrint ReadAD10(AN1)

The example above sets the AD_REF_SOURCE to a variable, and then changes the value of the variable
to select the source. With this approach, we also need to allow time to charge the reference capacitor
to the correct voltage. This capability is available from GCBASIC version 9.41.

Example 2:

This example reads the ADC port and writes the output to the EEPROM.
 #chip 16F819, 8
#config osc = int

'Set the input pin direction

Dir PORTA.0 In

'Loop to take readings until the EEPROM is full

For CurrentAddress = 0 to 255
    'Take a reading and log it
    EPWrite CurrentAddress, ReadAD(AN0)
    'Wait 10 minutes before getting another reading
    Wait 10 min
Next

See Also ReadAD10

ReadAD10

Syntax:

var = ReadAD10 (port)

Command Availability:

Available on all PIC and AVR chips with an analog to digital converter module built in.

Explanation:

Return an 10 bit number [0-1023] in a word variable.

ReadAD10 is a function that can be used to read the built-in analog to digital converter that many
microcontroller chips include. port should be AN0, AN1, AN2, etc., up to the number of analog inputs
available on the chip that is in use. Those familiar with AVR microcontrollers can also refer to the ports
as ADC0, ADC1, etc. Refer to the datasheet for the microcontroller chip to find the number of ports
available. (Note: it’s perfectly acceptable to use ANx on AVR, or ADCx on PIC.)

Another function, ReadAD is almost identical to ReadAD10. The only difference is that it returns a byte
variable.

AD_Delay controls is the acquisition delay. The default value is 20 us. This can be changed by adding the
following constant.

#define AD_Delay 2 10us

ADSpeed controls the source of the clock for the ADC module. It varies from one chip to another.
InternalClock is a PIC only option that will drive the ADC from an internal RC oscillator. The default
value is 128.

'default value
#define ADSpeed MediumSpeed

'pre-defined constants
#define HighSpeed 255
#define MediumSpeed 128
#define LowSpeed 0

Example:

#chip 16F819, 8
#config osc = int

'Set the input pin direction

Dir PORTA.0 In

'Loop to take readings until the EEPROM is full

For CurrentAddress = 0 to 255
'Take a reading and show it
    Print str(ReadAD10(AN0))
'Wait 10 minutes before getting another reading
    Wait 10 min
Next

See Also ReadAD

EEPROM
EPRead

Syntax:

EPRead location, store

Command Availability:

Available on all PIC and AVR chips with EEPROM data memory.

Explanation:
EPRead is used to read information from the EEPROM data storage that many microcontroller chips are
equipped with. location represents the location to read data from, and varies from one chip to
another. store is the variable in which to store the data after it has been read from EEPROM.

Example:

'Program to turn a light on and off

'Will remember the last status

#chip tiny2313, 1
#define Button PORTB.0
#define Light PORTB.1

Dir Button In
Dir Light Out

'Load saved status

EPRead 0, LightStatus

If LightStatus = 0 Then
  Set Light Off
Else
  Set Light On
End If

Do
'Wait for the button to be pressed
Wait While Button = On
Wait While Button = Off
'Toggle value, record
LightStatus = !LightStatus
EPWrite 0, LightStatus

'Update light
If LightStatus = 0 Then
  Set Light Off
Else
  Set Light On
End If
Loop

For more help, see EPWrite

EPWrite

Syntax:
 EPWrite location, data

Command Availability:

Available on all PIC and AVR chips with EEPROM data memory.

Explanation:

EPWrite is used to write information to the EEPROM data storage, so that it can be accessed later by a
programmer on the PC, or by the EPRead command. location represents the location to read data from,
and varies from one chip to another. data is the data that is to be written to the EEPROM, and can be a
value or a variable.

Example:

#chip 16F819, 8
#config osc = int

'Set the input pin direction

Dir PORTA.0 In

'Loop to take readings until the EEPROM is full

For CurrentAddress = 0 to 255
'Take a reading and log it
    EPWrite CurrentAddress, ReadAD(AN0)
'Wait 10 minutes before getting another reading
    Wait 10 min
Next

For more help, see EPRead

ProgramErase

Syntax:

ProgramErase(location)

Command Availability:

Available on all PIC chips with self write capability. Not available on AVR at present.

Explanation:

ProgramErase erases information from the program memory on chips that support this feature. The
largest value possible for location depends on the amount of program memory on the PIC, which is
given on the datasheet.

This command must be called before writing to a block of memory. It is slow in comparison to other
GCBASIC commands. Note that is erases memory in 32-byte blocks - see the relevant PIC datasheet for
more information.

This is an advanced command which should only be used by advanced developers. Care must be taken
with this command, as it can easily erase the program that is running on the PIC.

For more help, see ProgramRead, ProgramWrite

ProgramRead

Syntax:

ProgramRead (location, store)

Command Availability:

Available on all PIC chips with self write capability. Not available on AVR at present.

Explanation:

ProgramRead reads information from the program memory on chips that support this feature. location
and store are both word variables, meaning that they can store values over 255.

The largest value possible for location depends on the amount of program memory on the PIC, which
is given on the datasheet. store is 14 bits wide, and thus can store values up to 16383.

This is an advanced command which should only be used by advanced developers.

Example:

For more help, see ProgramErase, ProgramWrite

ProgramWrite

Syntax:

ProgramWrite (location, value)

Command Availability:

Available on all PIC chips with self write capability. Not available on AVR at present.
Explanation:

ProgramWrite writes information to the program memory on chips that support this feature. location
and value are both word variables.

The largest value possible for location depends on the amount of program memory on the PIC, which
is given on the datasheet. value is 14 bits wide, and thus can store values up to 16383.

This is an advanced command which should only be used by advanced developers. ProgramErase must
be used to clear a block of memory BEFORE ProgramWrite is called.

Example:

For more help, see ProgramErase, ProgramRead

HEFM
HEFM Overview

Introduction:

This section of the Help file assumes you have a release of Great Cow Basic June 2015 or later. Several
members of the PIC family, including the PIC16F14xx, PIC16F15xx and PIC16F17xx have replaced the
data EEPROM present on older models with a block of Flash memory that is designed to provide the
same high endurance (100K erase/write cycles). This high endurance flash memory (HEFM) is a block
of 128 locations found at the top of the Flash program memory. Each location can only be used to hold
a byte variable (whereas the standard Flash memory for a mid-range PIC MCU will typically hold 14
bits of information). The main difference between EEPROM and HEFM is that the former does allow
byte-by-byte erase whereas the latter does not. With HEFM data must be erased before a write and this
can only be performed in blocks (also referred as rows) of a fixed size associated with the chip design.

The heflash.h library uses as an input the following variables which are available from the chips *.dat
files supporting HEFM.

Variable Name Type Content

HEFLASH_ROWSIZE Byte Size of an HEFM block in words

HEFLASH_START Word Starting address of HEFM

HEFLASH_END Word Ending address of HEFM

 Whenever you update the hex file of your PIC with your programmer you will
erase the data that are stored in HEFM. If you want to avoid that you will have to
flash your PIC with a software that allow memory exclusion when flashing. This is
WARNING
the case of Microchip MPLAB IPE (Go to Advanced Mode/Enter password/Select
Memory/Tick “Preserve Flash on Program”/ Enter Start and End address of your
HEFM).

HEFreadBlock

Syntax:

HEFreadBlock(buffer(), Flash_row, count)

• Buffer() is the destination byte array (must be sufficiently large)

• Flash_row is the HEFM relative location (i.e. the row number)

• Count is the number of bytes to be retrieved

Command availability:

Available on specific Microchip MCUs only. Check your datasheet.

Explanation:

HEFreadBlock reads information from the HEFM on chips that support this feature. buffer is a byte
array of length equal to count. Reading starts at the beginning of given row number

Example

#chip 16F1509, 8
; The following example reads a byte vector
; from row 0 of the HEFM of the 16F1509
dim data(32)
HEFreadBlock(data,0,HEFLASH_ROWSIZE)

HEFRead

Syntax:

HEFRead(HEFaddress, HEFDataValue)

• HEFaddress is the HEFM relative location in the whole HEFM area (i.e. a number generally
comprised between 0 and 127)
 • HEFDataValue is the byte data being retrieved

Command availability:

Available on specific Microchip MCUs only. Check your datasheet.

Explanation:

This subroutine reads information from the HEFM given its relative number in the whole HEFM area.
It is the equivalent of the EPRead subroutine for EEPROM. The subroutine will compute the row
number and the offset in the row from HEFaddress and HEFLASH_ROWSIZE. It will then call the
HEFreadBlock subroutine to retrieve the byte data.

Example:

#chip 16F1509, 8
; The following example stores in the byte variable “value” the
; HEFM byte variable located in row 1 at offset 2
HEFRead(34,value)

HEFwriteBlock

Syntax:

HEFwriteBlock(Flash_row, buffer(), count)

• Flash_row is the HEFM relative location (i.e. the row number)

• Buffer() is the source byte array

• Count is the number of bytes to be copied

Command availability:

Available on specific Microchip MCUs only. Check your datasheet.

Explanation:

HEFwriteBlock writes information to the HEFM on chips that support this feature. buffer is a byte
array of length equal to count. Writing starts at the beginning of the given row number.

Be aware that this subroutine will first erase whatever data are present on the
WARNING
destination row. If you want to preserve them check the HEFwrite subroutine.
Example:

#chip 16F1509, 8
; The following example generates a byte vector and stores it
; in row 0 of the HEFM of the 16F1509
dim data(32)
for index = 1 to 32
  data(index)=index
next
HEFwriteBlock(0,data,HEFLASH_ROWSIZE)
;
; Now we store a string in row 1
Dim Hello as String
Hello="Hello GCB World!"
HEFwriteBlock(1,Hello,len(Hello))

HEFWrite

Syntax:

HEFWrite(HEFaddress, HEFDataValue)

• HEFaddress is the HEFM relative location in the whole HEFM area (i.e. a number generally
comprised between 0 and 127)

• HEFDataValue is the byte data being retrieved

Command availability:

Available on specific Microchip MCUs only. Check your datasheet.

Explanation:

This subroutine writes information to the HEFM given its relative number in the whole HEFM area. It
is the equivalent of the EPWrite subroutine for EEPROM. The subroutine will compute the row number
and the offset in the row from HEFaddress and HEFLASH_ROWSIZE. It will then call the
HEFWriteBlock subroutine to store the byte data.

Example:

#chip 16F1509, 8
; The following example stores in the byte variable “value” the
; HEFM byte variable located in row 1 at offset 2
HEFWrite(34,value)
Flow control
Do

Syntax:

Do [{While | Until} condition]

...
program code
... +
<condition> Exit Do
...
Loop [{While | Until} condition]

Command Availability:

Available on all microcontrollers.

Explanation:

The Do command will cause the code between the Do and the Loop to run repeatedly while condition is
true or until condition is true, depending on whether While or Until has been specified.

Note that the While or Until and the condition can only be specified once, or not at all. If they are not
specified, then the code will repeat endlessly.

Optionally, you can specify a condition to EXIT the Do-Loop immediately.

Example 1:

'This code will flash a light until the button is pressed

#chip 12F629, 4
#config osc = int

#define BUTTON GPIO.3

#define LIGHT GPIO.5

Dir BUTTON In
Dir LIGHT Out

Do Until BUTTON = 1
PulseOut LIGHT, 1 s
Wait 1 s
Loop
Example 2:

This code will also flash a light until the button is pressed. This example uses EXIT DO within a
continuous loop.

#chip 12F629, 4
#config osc = int

#define BUTTON GPIO.3

#define LIGHT GPIO.5

Dir BUTTON In
Dir LIGHT Out

Do
PulseOut LIGHT, 1 s
Wait 1 s
if BUTTON = 1 then EXIT DO
Loop

For more help, see Conditions

End

Syntax:

End

Command Availability:

Available on all microcontrollers.

Explanation:

When the End command is used, the program will immediately stop running. There are very few cases
where this command is needed - generally, the program should be an endless loop.

Example:

'This program will turn on the red light, but not the green light
Set RED On
End
Set GREEN On
Exit

Syntax options:

Exit Sub | Exit Function | Exit Do | Exit For | Exit Repeat

Command Availability:

Available on all microcontrollers.

Explanation:

This command will make the program exit the routine it is currently in, as it would if it came to the end
of the routine.

Applies to Subroutines, Functions, For-Next loops, Do-Loop loops and Repeat loops.

Example:

#chip tiny13, 1

#define SENSOR PORTB.0

#define BUZZER PORTB.1
#define LIGHT PORTB.2
Dir SENSOR In
Dir BUZZER Out
Dir LIGHT Out

Do
Burglar
Loop

'Burglar Alarm subroutine

Sub Burglar
If SENSOR = 0 Then
Set BUZZER Off
Set LIGHT Off
Exit Sub
End If
Set BUZZER On
Set LIGHT On
End Sub

For more help, see Do, For, Sub, Functions, Repeat

For

Syntax:

For counter = start To end [Step increment]

 ...
program code
 ...
<condition> Exit For
 ...
Next

Command Availability:

Available on all microcontrollers.

Explanation:

The For command is ideal for situations where a piece of code needs to be run a set number of times,
and where it is necessary to keep track of how many times the code has run. When the For command is
first executed, counter is set to start. Then, each successive time the program loops, increment is added
to counter, until counter is equal to end. Then, the program continues beyond the Next.

Step and increment are optionals. If Step is not specified, GCBASIC will increment counter by 1 each time
the code is run.

The Exit For is optional and can used to exit the loop upon a specific condition.

Example 1:

'This code will flash a green light 6 times.

 +
#chip 16F88, 8
#config Osc = Int
 +
#define LED PORTB.0
Dir LED Out
 +
For LoopCounter = 1 to 6
PulseOut Led, 1 s
Wait 1 s
Next

Example 2:
 'This code will flash alternate LEDS until the switch is pressed.
 +
#chip 16F88, 8
#config Osc = Int

#define LED1 PORTB.0

Dir LED1 Out
#define LED2 PORTB.2
Dir LED2 Out

#define SWITCH1 PORTA.0

Dir SWITCH1 In
main:
PulseOut LED1, 1 s
For LoopCounterOut = 1 to 250
PulseOut LED2, 4 Ms
if switch = On then Exit For
Next
Set LED2 OFF
goto main

For more help, see Repeat

Gosub

Syntax:

Gosub label

Command Availability:

Available on all microcontrollers.

Explanation:

The Gosub command is used to jump to a label as a subroutine, in a similar way to Goto. The difference
is that Return can then be used to return to the line of code after the Goto.

Gosub should not be used if it can be avoided. It is not required to call a subroutine that
NOTE
has been defined using Sub, just write the name of the subroutine.

Example:
 'This program will flash an LED on portb bit 0 and play a beep on
'porta bit 4. until the robot is turned off.

#chip 16F628A, 4 'Change this to suit your circuit

#define SOUNDOUT PORTA.4

#define LIGHT PORTB.0
Dir LIGHT Out

Do
'Flash Light
PulseOut LIGHT, 1 s
Wait 1 s
'Beep
Gosub PlayBeep
Loop

PlayBeep:
Tone 200, 10
Tone 100, 10
Return

For more help, see Goto, Labels

Goto

Syntax:

Goto label

Command Availability:

Available on all microcontrollers.

Explanation:

The Goto command will make the robot jump to the line specified, and continue running the program
from there. The Goto command is mainly useful for exiting out of loops - if you need to create an
infinite loop, use the Do command instead.

Be careful how you use Goto. If used too much, it can make programs very hard to read.

To define a label, put the name of the label alone on a line, with just a colon (:) after it.

Example:
 'This program will flash the light until the button is pressed
'off. Notice the label named SWITCH_OFF.

#chip 16F628A, 4 'Change this line to suit your circuit

#define BUTTON PORTB.0

#define LIGHT PORTB.1
Dir BUTTON In
Dir BUTTON Out

Do
PulseOut LIGHT, 500 ms
If BUTTON = 1 Then Goto SWITCH_OFF
Wait 500 ms
If BUTTON = 1 Then Goto SWITCH_OFF
Loop

SWITCH_OFF:
Set LIGHT Off
'Chip will enter low power mode when program ends

For more help, see Gosub, Labels

If

Syntax:

Short form:
If condition Then command

Long form:
If condition Then
...
program code
...
End If

Using Else:
If condition Then
code to run if true
Else
code to run if false
End If

Command Availability:
Available on all microcontrollers.

Explanation:

The If command is the most common command used to make decisions. If condition is true, then
command (short) or program code (long) will be run. If it is false, then the robot will skip to the code
located on the next line (short) or after the End If (long form).

If Else is used, then the condition between If and Else will run if the condition is true, and the code
between Else and End If will run if the condition is false.

WARNING Else must be on a separate line in the source code.

Supported:

    <instruction>
Else
    <instruction>

Not Supported, but will compile :

<instruction> Else
<instruction>

Example:
 'Turn a light on or off depending on a light sensor

#chip 12F683, 8
#config osc = int

#define LIGHT GPIO.1

#define SENSOR AN3
#define SENSOR_PORT GPIO.4

Dir LIGHT Out

Dir SENSOR_PORT In

Do
If ReadAD(SENSOR) > 128 Then
Set LIGHT Off
Else
Set LIGHT On
End If
Loop

For more help, see Conditions

IndCall

Syntax:

IndCall Address

Command Availability:

Available on all microcontrollers.

Explanation:

IndCall provides a basic implementation of function pointers. Address is the program memory location
of the subroutine that is to be called. There are two ways to specify this - either by providing a direct
reference to the subroutine using the @ operator, or by specifying a word variable that contains the
address.

This command is useful for callbacks. For example, a particular subroutine might read bytes from a
serial connection, but different actions may need to be taken at different times. A different subroutine
could be created for each action, and then the subroutine for the appropriate action could be passed to
the serial connection reading routine each time it is called.
 Calling subroutines that have parameters using IndCall is not supported. Errors
WARNING
may occur. If data needs to be passed, use a variable instead.

Example:

'Flash an LED using an indirect call

#chip 12F683

'Create a word variable, and set it to the memory location of the

'Blink subroutine.
Dim FlashingSub As Word
FlashingSub = @Blink

'Main loop
Do
'Indirect call to subroutine at location FlashingSub
IndCall FlashingSub
Loop

'LED flashing subroutine

Sub Blink
PulseOut GPIO.0, 500 ms
Wait 500 ms
End Sub

Pause

Syntax:

Fixed Length Delay:

Pause _time_ms

Command Availability:

Available on all microcontrollers.

Explanation:

The Pause command will cause the program to wait for either a specified amount of time in
milliseconds.

Repeat

Syntax:
 Repeat times
 ...
program code
 ...
<condition> Exit Repeat
 ...
End Repeat

Command Availability:

Available on all microcontrollers.

Explanation:

The Repeat command is ideal for situations where a piece of code needs to be run a set number of
times. It uses less memory and runs faster than the For command, and should be used wherever it is
not necessary to count how many times the code has run.

Optionally, you can specify a condition to Exit the Repeat-Loop immediately.

Repeat has a maximum repeat value of 65535.

Example:

'This code will flash a green light 6 times.

#chip 16F88, 20

#define LED PORTB.0

dir LED out

Repeat 6
PulseOut LED, 1 s
Wait 1 s
End Repeat

See Also For

Select

Syntax:
 Select Case var

Case value1
code1

Case value2
code2

Case Else
code3

End Select

Command Availability:

Available on all microcontrollers.

Explanation:

The Select Case control structure is used to select and run a particular section of code, based on the
value of var. If var equals value1 then code1 will be run. Once code1 has run, the chip will jump to the
End Select command and continue running the program. If none of the other conditions are true, then
the code under the Case Else section will be run.

Case Else is optional, and the program will function correctly without it.

If there is only one line of code after the Case, the code may look neater if the line is placed after the
Case. This is shown below in the example, for cases 3, 4 and 5.

It is important to note that only one section of code will be run when using Select Case.

There are two examples shown below.

Example 1:
 'Program to read a value from a potentiometer, and display a
'different word based on the result

#chip 18F4550, 20

'LCD connection settings

#define LCD_IO 4
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

DIR PORTA.0 IN
Do
Temp = ReadAD(AN0) / 20
CLS
Select Case Temp
Case 0
Print "None!"
Case 1
Print "One"
Case 2
Print "Two"
Case 3: Print "Three"
Case 4: Print "Four"
Case 5: Print "Five"
Case Else
Print "A lot!"
End Select
Wait 250 ms
Loop

Example 2:

This code demonstrates how to receive codes from a handheld remote control unit. This has been
tested and supports a Sony TV remote and also a universal remote set to Sony TV mode.

The program gets both the device number and the key number, and also translates the key number to
English. The received results are displayed on an LCD.

The circuit for the IR receiver and the chip is shown below.

;A program to receive IR codes sent by a Sony

;compatible handheld remote control.

#chip 16F88, 8 ;PIC16F88 running at 8 MHz

#config mclr=off ;reset handled internally
#config osc=int ;use internal clock

;----- Constants

#define LCD_IO 4 ;4-bit mode

#define LCD_RS PortB.2 ;pin 8 is Register Select
#define LCD_Enable PortB.3 ;pin 9 is Enable
#define LCD_DB4 PortB.4 ;DB4 on pin 10
#define LCD_DB5 PortB.5 ;DB5 on pin 11
#define LCD_DB6 PortB.6 ;DB6 on pin 12
#define LCD_DB7 PortB.7 ;DB7 on pin 13
#define LCD_NO_RW 1 ;ground RW line on LCD
#define IR PortA.0 ;sensor on pin 17

;----- Variables

dim device, cmd, count, i as byte

dim pulse(12) ;pulse count array
dim button as string ;ASCII for button label

;----- Program

dir PortA in ;A.0 is IR input

dir PortB out ;B.2 - B.6 for LCD

cls ;clear the LCD

print "Dev: Cmd:" ;logo for top line
locate 1,0
print "Button:" ;logo for second line

do
  getIR, cmd ;wait for IR signal
  printCmd ;show device and command
  printKey ;show key label
  wait 10 mS ;ignore any repeats
loop ;repeat forever

;----- Subroutines

sub getIR
  tarry1:
    count = 0 ;wait for start bit
    do while IR = 0 ;measure width (active low)
      wait 100 uS ;24 X 100 uS = 2.4 mS
      count += 1
    loop
  if count < 20 then goto tarry1 ;less than this so wait

  for i=1 to 12 ;read/store the 12 pulses

    tarry2:
      count = 0
      do while IR = 0 ;zero = 6 units = 0.6 mS
        wait 100 uS ;one = 12 units = 1.2 mS
        count += 1
      loop
    if count < 4 then goto tarry2 ;too small to be legit
    pulse(i) = count ;else store pulse width
  next

  cmd = 0 ;command built up here

  for i = 1 to 7 ;1st seven bits are the cmd
    cmd = cmd / 2 ;shift into place
    if pulse(i) > 10 then ;longer than 10 mS
       cmd = cmd + 64 ;so call it a one
    end if
  next

  device = 0 ;device number built up here

  for i=8 to 12 ;next 5 bits are device number
    device = device / 2
    if pulse(i) > 10 then
       device = device + 16
    end if
  next
end sub

sub printCmd ;print device number

  locate 0,5
  print " "
  locate 0,5
  print device

  locate 0,13 ;print raw command number

  print " "
  locate 0,13
  print cmd
end sub

sub PrintKey ;print translated button

  locate 1,9
  print " "
  locate 1,9
  select case cmd ;translate command code
    case 0
      button = "One"
    case 1
      button = "Two"
    case 2
      button = "Three"
    case 3
      button = "Four"
    case 4
      button = "Five"
    case 5
      button = "Six"
    case 6
      button = "Seven"
    case 7
      button = "Eight"
    case 8
      button = "Nine"
    case 9
      button = "Zero"
    case 10
      button = "#####"
    case 11
      button = "Enter"
    case 12
      button = "#####"
    case 13
      button = "#####"
    case 14
      button = "#####"
    case 15
      button = "#####"
    case 16
      button = "Chan+"
    case 17
      button = "Chan-"
    case 18
      button = "Vol+"
    case 19
      button = "Vol-"
    case 20
      button = "Mute"
    case 21
      button = "Power"
    case else
      button = " "
   end select
  print button
end sub

Wait

Syntax:

Fixed Length Delay:

Wait time units

Conditional Delay:
Wait {While | Until} condition

Command Availability:

Available on all microcontrollers.

Explanation:

The Wait command will cause the program to wait for either a specified amount of time (such as 1
second), or while/until a condition is true.

When using the fixed-length delay, there is a variety of units that are available:
Unit Length of unit Delay range

us 1 microsecond 1 us - 65535 us

10us 10 microseconds 10 us - 2.55 ms

ms 1 millisecond 1 ms - 65535 ms

10ms 10 milliseconds 10 ms - 2.55 s

s 1 second 1 s - 255 s

m 1 minute 1 min - 255 min

h 1 hour 1 hour - 255 hours

At one stage, GCBASIC variables could not hold more than 255. The 10us and 10ms units were added as a
way to work around this limit. There is now no such limit (Wait 1000 ms will work for example), so
these are not really needed. However, you may see them in some older examples or programs, and the
10us units are sometimes the shortest delay that will work accurately.

Example:
 'This code will wait until a button is pressed, then it will flash
'a light every half a second and produce a 440 Hz tone.

#chip 16F819, 8
#config osc = int

#define BUTTON PORTB.0

#define SPEAKER PORTB.1
#define LIGHT PORTB.2
Dir BUTTON In
Dir SPEAKER Out
Dir LIGHT Out

'Assumes Button switches on when pressed

Wait Until BUTTON = 1
Wait Until BUTTON = 0

Do
    'Flash the light
    Set LIGHT On
    Wait 500 ms
    Set LIGHT Off

    'Produce the tone

    '440 Hz = 880 changes = tone on for 1.14 ms
    Repeat 440
        PulseOut SPEAKER, 1140 us
        Wait 114 10us 'Wait for 114 x 10 us (1.14 ms)
    End Repeat
Loop

For more help, see Conditions

Interrupts
Interrupts overview

Introduction

Interrupts are a feature of many microcontrollers. They allow the microcontroller to temporarily
pause (interrupt) the code it is running and then start running another piece of code when some event
occurs. Once it has dealt with the event, it will return to where it was and continue running the
program.

Many events can trigger an interrupt, such as a timer reaching its limit, a serial message being
received, or a special pin on the microcontroller receiving a signal.

Using Interrupts

There are two ways to use interrupts in GCBASIC. The first way is to use the On Interrupt command.
This will automatically enable a given interrupt, and run a particular subroutine when the interrupt
occurs.

The other way to deal with interrupts is to create a subroutine called Interrupt. GCBASIC will call this
subroutine whenever an interrupt occurs, and then your code can check the "flag" bits to determine
which interrupt has occured, and what should be done about it. If you use this approach, then you’ll
need to enable the desired interrupts manually. It is also essential that your code clears the flag bits, or
else the interrupt routine will be called repeatedly.

Some combination of these two methods is also possible - the code generated by On Interrupt with
check to see if the interrupt is one it recognises. If the interrupt is recognised, On Interrupt will deal
with it - if not, the Interrupt subroutine will be called to deal with the interrupt.

The recommended way is to use On Interrupt, as it is both more efficient and easier to set up.

During some sections of code, it is desirable not to have any interrupts occur. If this is the case, then
use the IntOff command to disable interrupts at the start of the section, and IntOn to re-enable them at
the end. If any interrupt events occur while interrupts are disabled, then they will be processed as
soon as interrupts are re-enabled. If the program does not use interrupts, IntOn and IntOff will be
removed automatically by GCBASIC.

See Also IntOff, IntOn, On Interrupt

IntOff

Syntax:

IntOff

Command Availability:

Available on PIC and AVR microcontrollers with interrupt support. Will be automatically removed on
chips without interrupts.

Explanation:

IntOff is used to disable interrupts on the microcontroller. It should be used at the start of code which
is timing-sensitive, and which would not function correctly if paused and restarted.

It is essential that IntOn is used to turn interrupts on again after the timing-sensitive code has finished
running. If not, no interrupts will be handled.
IntOff will be removed from the program if no interrupts are used. It is recommended that IntOff be
placed before all code that is timing sensitive, in case interrupts are implemented later.

See also IntOn, Interrupts

IntOn

Syntax:

IntOn

Command Availability:

Available on PIC and AVR microcontrollers with interrupt support. Will be automatically removed on
chips without interrupts.

Explanation:

IntOn is used to enable interrupts on the microcontroller after IntOff has disabled them. It should be
used at the end of code which is timing-sensitive.

IntOn will be removed from the program if no interrupts are used.

See also IntOff, Interrupts

On Interrupt

Syntax:

On Interrupt event Call handler On Interrupt event Ignore

Command Availability:

Available on PIC and AVR microcontrollers with interrupt support.

Explanation:

On Interrupt will add code to call the subroutine handler whenever the interrupt event occurs. When
Call is specified, GCBASIC will enable the interrupt, and call the interrupt handler when it occurs.
When Ignore is specified, GCBASIC will disable the interrupt handler and prevent it from being called
when the event occurs. If the event occurs while the handler is disabled, then the handler will be
called as soon as it is re-enabled. The only way to prevent this from happening is to manually clear the
flag bit for the interrupt.

There are many possible interrupt events that can occur, and the events vary greatly from chip to chip.
GCBASIC will display an error if a given chip cannot support the specified event.
In some cases, On Interrupt will not be able to set or clear the interrupt flag and/or enable bits. If this is
the case, GCBASIC will display a warning. You will need to consult the chip datasheet and use the Set
command to manually set/clear the flag and enable bits, both at the start of the program and inside the
interrupt handler subroutine. If On Interrupt is used to handle an event, then the Interrupt subroutine
will not be called for that event. However, it will still be called for any events not dealt with by On
Interrupt.

Events:

GCBASIC supports the events shown on the table below. Some events are only implemented on a few
specialised chips. Events in grey are supported by PICs and AVRs, events in blue are only supported by
some PICs, and events in red are only supported by AVRs.

Note that GCBASIC doesn’t fully support all of the hardware which can generate interrupts - some work
may be required with various system variables to control the unsupported peripherals.

Event Name Description

ADCReady The analog/digital converter has finished a

conversion

BatteryFail The battery has failed in some way. This is only

implemented on the ATmega406

CANActivity CAN bus activity is taking place

CANBadMessage A bad CAN message has been received

CANError Some CAN error has occured

CANHighWatermark CAN high watermark reached

CANRx0Ready New message present in buffer 0

CANRx1Ready New message present in buffer 1

CANRx2Ready New message present in buffer 2

CANRxReady New message present

CANTransferComplete Transfer of data has been completed

CANTx0Ready Buffer 0 has been sent

CANTx1Ready Buffer 1 has been sent

CANTx2Ready Buffer 2 has been sent

CANTxReady Sending has completed

CCADCAccReady CC ADC accumulate conversion finished

(ATmega406 only)
Event Name Description

CCADCReady CC ADC instantaneous conversion finished

(ATmega406 only)

CCADCRegular CC ADC regular conversion finished (ATmega406

only)

CCP1 The CCP1 module has captured an event

CCP2 The CCP2 module has captured an event

CCP3 The CCP3 module has captured an event

CCP4 The CCP4 module has captured an event

CCP5 The CCP5 module has captured an event

Comp0Change The output of comparator 0 has changed

Comp1Change The output of comparator 1 has changed

Comp2Change The output of comparator 2 has changed

Crypto The KEELOQ module has generated an interrupt

EEPROMReady An EEPROM write has finished

Ethernet The Ethernet module has generated an interrupt.

This must be dealt within the handler.

ExtInt0 External Interrupt pin 0 has been ed

ExtInt1 External Interrupt pin 1 has been ed

ExtInt2 External Interrupt pin 2 has been ed

ExtInt3 External Interrupt pin 3 has been ed

ExtInt4 External Interrupt pin 4 has been ed

ExtInt5 External Interrupt pin 5 has been ed

ExtInt6 External Interrupt pin 6 has been ed

ExtInt7 External Interrupt pin 7 has been ed

GPIOChange The pins on port GPIO have changed

LCDReady The LCD is about to draw a segment

LPWU The Low Power Wake Up has been ed

OscillatorFail The external oscillator has failed, and the PIC is

running from an internal oscillator.

PinChange Logic level of PCINT pin has changed

Event Name Description

PinChange0 Logic level of PCINT0 pin has changed

PinChange1 Logic level of PCINT1 pin has changed

PinChange2 Logic level of PCINT2 pin has changed

PinChange3 Logic level of PCINT3 pin has changed

PinChange4 Logic level of PCINT4 pin has changed

PinChange5 Logic level of PCINT5 pin has changed

PinChange6 Logic level of PCINT6 pin has changed

PinChange7 Logic level of PCINT7 pin has changed

PMPReady A Parallel Master Port read or write has finished

PORTAChange The pins on port A have changed

PORTABChange The pins on port A and/or B have changed

PORTBChange The pins on port B have changed

PSC0Capture The counter for Power Stage Controller 0 matches

the value in a compare register, the value of the
counter has been captured, or a synchronisation
error has occurred

PSC0EndCycle Power Stage Controller 0 has reached the end of

its cycle

PSC1Capture The counter for Power Stage Controller 1 matches

the value in a compare register, the value of the
counter has been captured, or a synchronisation
error has occurred

PSC1EndCycle Power Stage Controller 1 has reached the end of

its cycle

PSC2Capture The counter for Power Stage Controller 2 matches

the value in a compare register, the value of the
counter has been captured, or a synchronisation
error has occurred

PSC2EndCycle Power Stage Controller 2 has reached the end of

its cycle

PSPReady A Parallel Slave Port read or write has finished

PWMTimeBase The PWM time base matches the PWM Time Base
Period register (PTPER)

SPIReady The SPI module has finished the previous transfer

Event Name Description

SPMReady A write to program memory by the spm

instruction has finished

SPPReady A SPP read or write has finished

SSP1Collision SSP1 has detected a bus collision

SSP1Ready The SSP/SSP1/MSSP1 module has finished sending

or receiving

SSP2Collision SSP2 has detected a bus collision

SSP2Ready The SSP2/MSSP2 module has finished sending or

receiving

Timer0Capture An input event on the pin ICP0 has caused the

value of Timer 0 to be captured in the ICR0
register

Timer0Match1 Timer 0 matches the Timer 0 output compare

register A (OCR0A)

Timer0Match2 Timer 0 matches the Timer 0 output compare

register B (OCR0B)

Timer0Overflow Timer 0 has overflowed

Timer1Capture An input event on the pin ICP1 has caused the

value of Timer 1 to be captured in the ICR1
register

Timer1Error The Timer 1 Fault Protection unit has been ed by

an input on the INT0 pin

Timer1Match1 Timer 1 matches the Timer 1 output compare

register A (OCR1A)

Timer1Match2 Timer 1 matches the Timer 1 output compare

register B (OCR1B)

Timer1Match3 Timer 1 matches the Timer 1 output compare

register C (OCR1C)

Timer1Match4 Timer 1 matches the Timer 1 output compare

register D (OCR1D)

Timer1Overflow Timer 1 has overflowed

Timer2Match1 Timer 2 matches the Timer 2 output compare

register A (OCR2A)

Timer2Match2 Timer 2 matches the Timer 2 output compare

register B (OCR2B)
Event Name Description

Timer2Overflow Timer 2 has overflowed

Timer3Capture An input event on the pin ICP3 has caused the

value of Timer 3 to be captured in the ICR3
register

Timer3Match1 Timer 3 matches the Timer 3 output compare

register A (OCR3A)

Timer3Match2 Timer 3 matches the Timer 3 output compare

register B (OCR3B)

Timer3Match3 Timer 3 matches the Timer 3 output compare

register C (OCR3C)

Timer3Overflow Timer 3 has overflowed

Timer4Capture An input event on the pin ICP4 has caused the

value of Timer 4 to be captured in the ICR4
register

Timer4Match1 Timer 4 matches the Timer 4 output compare

register A (OCR4A)

Timer4Match2 Timer 4 matches the Timer 4 output compare

register B (OCR4B)

Timer4Match3 Timer 4 matches the Timer 4 output compare

register C (OCR4C)

Timer4Overflow Timer 4 has overflowed

Timer5CAP1 An input on the CAP1 pin has caused the value of

Timer 5 to be captured in CAP1BUF

Timer5CAP2 An input on the CAP2 pin has caused the value of

Timer 5 to be captured in CAP2BUF

Timer5CAP3 An input on the CAP3 pin has caused the value of

Timer 5 to be captured in CAP3BUF

Timer5Capture An input event on the pin ICP5 has caused the

value of Timer 5 to be captured in the ICR5
register

Timer5Match Timer5 matches the PR5 register

Timer5Match1 Timer 5 matches the Timer 5 output compare

register A (OCR5A)

Timer5Match2 Timer 5 matches the Timer 5 output compare

register B (OCR5B)
Event Name Description

Timer5Match3 Timer 5 matches the Timer 5 output compare

register C (OCR5C)

Timer5Overflow Timer 5 has overflowed

TWIConnect The AVR has been connected to or disconnected

from the TWI (I2C) bus

TWIReady The TWI has finished the previous transmission

and is ready to send or receive more data

UsartRX1Ready UART/USART 1 has received data

UsartRX2Ready UART/USART 2 has received data

UsartRX3Ready UART/USART 3 has received data

UsartRX4Ready UART/USART 4 has received data

UsartTX1Ready UART/USART 1 is ready to send data

UsartTX1Sent UART/USART 1 has finished sending data

UsartTX2Ready UART/USART 2 is ready to send data

UsartTX2Sent UART/USART 2 has finished sending data

UsartTX3Ready UART/USART 3 is ready to send data

UsartTX3Sent UART/USART 3 has finished sending data

UsartTX4Ready UART/USART 4 is ready to send data

UsartTX4Sent UART/USART 4 has finished sending data

USBEndpoint A USB endpoint has generated an interrupt

USB The USB module has generated an interrupt. This

must be dealt with in the handler.

USIOverflow The USI counter has overflowed from 15 to 0

USIStart The USI module has detected a start condition

VoltageFail The input voltage has dropped too low

VoltageRegulator An interrupt has been generated by the voltage

regulator (ATmega16HVA only)

WakeUp The Wake-Up timer has overflowed

WDT An interrupt has been generated by the Watchdog

Timer

Example:
 'This program increments a counter every time Timer1 overflows
#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 4
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

InitTimer1 Osc, PS1_1/8

StartTimer 1
CounterValue = 0

Wait 100 ms
Print "Int Test"

On Interrupt Timer1Overflow Call IncCounter

Do
    CLS
    Print CounterValue
    Wait 100 ms
Loop

Sub IncCounter
    CounterValue ++
End Sub

For more help, see InitTimer0 article contains an example of using Timer 0 and On Interrupt to
generate a Pulse Width Modulation signal to control a motor.

See also IntOff, IntOn

On Interrupt: The default handler

Introduction

GCBasic supports a default interrupt handler in two modes:

1. You can define the interrupt flags and the default handler (a sub routine) will executed

2. You can define an On Interrupt event Call handler where the handler is executed that matches the
event and where all other define/valid events are handled by the default handler (a sub routine),
 The easiest way to write an interrupt handler is to write it in GCBasic in conjunction with the On
Interrupt statement. On Interrupt tells microprocessor to activate its internal interrupt handling
and to jump to a predetermined interrupt handler (a sub routine that has been defined) when the
interrupt handler (the sub routine) has completed processing returns to correct address in the
program. See On Interrupt.

This method of supports the handling interrupts by enabling a default interrupt subroutine.

Example 1

Basically if an event occurs the microprocessor will be program to jump to the interrupt vector and the
compiler does not know why, it will simple execute the Interrupt subroutine. This code is not intended
as a meaningful solution.

#chip 16f877a, 4
Set PORTB.0 On

'Note: there is NO On Interrupt handler

InitTimer1 Osc, PS1_8
SetTimer 1, 1
StartTimer 1
'Manually set Timer1Overflow to the overflow event
'this will event will be handled by the Interrupt sub routine
TMR1IE = 1
end

Sub Interrupt
  Set PORTB.1 On
  TMR1IF = 0
End Sub

Example 2

Any events that are not dealt with by On Interrupt will result in the code in the Interrupt subroutine
executing. This example shows the operation of two interrupt handlers - is not intended as a
meaningful solution.
 #chip 16f877a, 4
On Interrupt Timer1Overflow call Overflowed
Set PORTB.0 On

InitTimer1 Osc, PS1_8

SetTimer 1, 1
StartTimer 1

InitTimer2 PS2_16, PS2_16

SetTimer 2, 255
StartTimer 2

'Manually set Timer2Overflow to create a second event

'this will event will be handled by the Interrupt sub routine
TMR2IE = 1
end

Sub Interrupt
  Set PORTB.2 On
  TMR2IF = 0
End Sub

Sub Overflowed
  Set PORTB.1 On
  TMR1IF = 0
End Sub

Keypad
Keypad Overview

Introduction

The keypad routines allow for a program to read from a 4 x 4 matrix keypad.

There are two ways that the keypad routines can be set up. One option is to connect the wires from the
keypad in a particular order, and then to set the KeypadPort constant. The other option is to connect
the keypad in whatever way is easiest, and then set the KEYPAD_ROW_x and KEYPAD_COL_x constants. The
first option (setting KeypadPort) will generate slightly more efficient code.

Configuration using KEYPAD_ROW_x and KEYPAD_COL_x:

These constants must be set:

Constant Name Controls Default Value

KEYPAD_ROW_1 The pin on the microcontroller N/A

that connects to the Row 1 pin
on the keypad

KEYPAD_ROW_2 The pin on the microcontroller N/A

that connects to the Row 2 pin
on the keypad

KEYPAD_ROW_3 The pin on the microcontroller N/A

that connects to the Row 3 pin
on the keypad

KEYPAD_ROW_4 The pin on the microcontroller N/A

that connects to the Row 4 pin
on the keypad

KEYPAD_COL_1 The pin on the microcontroller N/A

that connects to the Col 1 pin on
the keypad

KEYPAD_COL_2 The pin on the microcontroller N/A

that connects to the Col 2 pin on
the keypad

KEYPAD_COL_3 The pin on the microcontroller N/A

that connects to the Col 3 pin on
the keypad

KEYPAD_COL_4 The pin on the microcontroller N/A

that connects to the Col 4 pin on
the keypad

If using a 3 x 3 keypad, do not set the KEYPAD_ROW_4 or KEYPAD_COL_4 constants.

Configuration using KeypadPort

When setting up the keypad code using the KeypadPort constant, only KeypadPort needs to be set.

Pull-ups or pull-downs go on the columns only, and are typically 4.7k to 10k in value.

Constant Name Controls Default Value

KeypadPort The port on the microcontroller N/A

chip that the keypad is
connected to.

Configuration when using Pull down resistors

The keypad routine has a feature when using pull-down resistors, simply add the constant to your
program and the and the scan logic will be inverted appropriately.
Constant Name Controls Default Value

KEYPAD_PULLDOWN Support pull down resistors. N/A

For this to work, the keypad must be connected as follows:

Microcontroller port pin Keypad connector

0 Row 1

1 Row 2

2 Row 3

3 Row 4

4 Column 1

5 Column 2

6 Column 3

7 Column 4

Note: To use a 3 x 3 keypad in this mode, the pins on the microcontroller for any unused columns must
be pulled up.

KeypadData

Syntax:

var = KeypadData

Command Availability:

Available on all microcontrollers.

Explanation:

This function will return a value corresponding to the key that is pressed on the keypad. Note that if
two or more keys are pressed, then only one value will be returned. var can have one of the following
values:

Value Constant Name Key Pressed

0 0

1 1

2 2
 Value Constant Name Key Pressed

3 3

4 4

5 5

6 6

7 7

8 8

9 9

10 KEY_A A

11 KEY_B B

12 KEY_C C

13 KEY_D D

14 KEY_STAR Asterisk/Star (*)

15 KEY_HASH Hash (#)

255 KEY_NONE None

Example:
 'Program to show the value of the last pressed key on the LCD
#chip 18F4550, 20

'LCD connection settings

#define LCD_IO 4
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Keypad connection settings

#define KeypadPort PORTB

'Main loop
Do
    'Get key
    Temp = KeypadData

    'If a key is pressed, then display it

    If Temp <> KEY_NONE Then
        CLS
        Print Temp
        Wait 100 ms
    End If
Loop

For more help, see Keypad Overview

KeypadRaw

Syntax:

largevar = KeypadRaw

Command Availability:

Available on all microcontrollers.

Explanation:

This function will return a 16 bit value, in which each bit corresponds to a key on the keypad. If the key
is pressed its bit will hold 1, and if it is released its bit will contain a 0.
This table shows the key that each bit corresponds to:

Bit Key Position (row, col) Common Key Symbol

15 1,1 1

14 1,2 2

13 1,3 3

12 1,4 A

11 2,1 4

10 2,2 5

9 2,3 6

8 2,4 B

7 3,1 7

6 3,2 8

5 3,3 9

4 3,4 C

3 4,1 *

2 4,2 0

1 4,3 #

0 4,4 D

Example:
 'Program to show the keypad status using LEDs
#chip 16F877A, 20

'Keypad connection settings

#define KeypadPort PORTB

'LEDs
#define LED1 PORTC
#define LED2 PORTD
Dir LED1 Out
Dir LED2 Out

'Declare a 16 bit variable for the key value

Dim KeyStatus As Word

'Main loop
Do
    'Get key
    KeyStatus = KeypadRaw

    'Display
    LED1 = KeyStatus_H 'High Byte
    LED2 = KeyStatus 'Low Byte
Loop

For more help, see Keypad Overview

Graphical LCD
GLCD Overview

The GLCD commands are used to control a graphical Liquid Crystal Display based on the three GLCD
chipset. These are often 128x64 pixel displays. They can draw graphical elements by enabling or
disabling pixels.

The GLCD with back-lit pixels. These GLCD are a graphical upgrade to the popular 16x2 LCDs (see
Liquid Crystal Display Overview ) but the GLCD allows full graphical control of the display. Typical
displays are

• 128 x 64 'monochrome' pixels

• Low power white LED back-light

• Driven by on-board 5V parallel interface chipsets KS0108/KS0107 or ST7735 or ST7920 controllers

• The GLCDs are very common and well documented

 • Typically with viewing area is 71mmx39mm (2.8" x 1.5")

• Typically requires a 36-pin 0.1" header and 10K contrast pot

Great Cow Basic supports the following controller types:

KS0108 controllers, see KS0108 Controllers. ST7735 controllers, see ST7735 Controllers. ST7920
controllers, see ST7920 Controllers.

Great Cow Basic makes this type of device easier to control with the commands for the GLCD.

Setup:

You must include the glcd.h file at the top of your program. The file needs to be in brackets as shown
below.

#include <GLCD.h>

Defines:

There are several connections that must be defined to use the GLCD commands with a KS0108 display.
The I/O pin is the pin on the PIC Microcontroller that is connected to that specific pin on the graphic
LCD.

#define GLCD_RW I/O pin ‘Read/Write pin connection

#define GLCD_RESET I/O pin ‘Reset pin connection
#define GLCD_CS1 I/O pin ‘CS1 pin connection
#define GLCD_CS2 I/O pin ‘CS2 pin connection
#define GLCD_RS I/O pin ‘RS pin connection
#define GLCD_ENABLE I/O pin ‘Enable pin Connection
#define GLCD_DB0 I/O pin ‘Data pin 0 Connection
#define GLCD_DB1 I/O pin ‘Data pin 1 Connection
#define GLCD_DB2 I/O pin ‘Data pin 2 Connection
#define GLCD_DB3 I/O pin ‘Data pin 3 Connection
#define GLCD_DB4 I/O pin ‘Data pin 4 Connection
#define GLCD_DB5 I/O pin ‘Data pin 5 Connection
#define GLCD_DB6 I/O pin ‘Data pin 6 Connection
#define GLCD_DB7 I/O pin ‘Data pin 7 Connection

Common commands supported across the range of supported GLCDs are:

Command Purpose Example

InitGLCD Initialize device InitGLCD

GLCDCLS Clear screen of GLCD GLCDCLS

Command Purpose Example

GLCDPrint Print string of characters on GLCDPrint( Xposition,

GLCD using GCB font set Yposition, Stringvariable )

GLCDDrawChar Print character on GLCD using GLCDDrawChar( Xposition,

GCB font set Yposition, CharCode )

GLCDDrawString Print characters on GLCD using GLCDDrawString( Xposition,

GCB font set Yposition, Stringvariable )

Box Draw a box on the GLCD to a Box ( Xposition1, Yposition1,

specific size Xposition2, Yposition2,
[Optional In LineColour as 0 or
1] )
FilledBox Draw a box on the GLCD to a FilledBox (Xposition1,
specific size that is filled with Yposition1, Xposition2,
Yposition2, [Optional In
the foreground colour. LineColour 0 or 1] )
Line Draw a line on the GLCD to a Line ( Xposition1, Yposition1,
specific length that is filled with Xposition2, Yposition2,
[Optional In LineColour 0 or 1]
the specific attribute. )
PSet Set a pixel on the GLCD at a PSet(Xposition, Yposition,
specific position that is set with Pixel Colour 0 or 1)
the specific attribute.

For more help, see KS 0108 controllers, ST7735 Controllers and ST7920 Controllers

This example shows how to drive a KS0108 based Graphic LCD module with the built in commands of
Great Cow Basic. See Graphic LCD for details, this is an external web site.
 ;Chip Settings
#chip 16F886,16
'#config MCLRE = on 'enable reset switch on CHIPINO
#include <GLCD.h>

;Defines (Constants)
#define GLCD_RW PORTB.1 'D9 to pin 5 of LCD
#define GLCD_RESET PORTB.5 'D13 to pin 17 of LCD
#define GLCD_CS1 PORTB.3 'D12 to actually since CS1, CS2 are backward
#define GLCD_CS2 PORTB.4 'D11 to actually since CS1, CS2 are backward
#define GLCD_RS PORTB.0 'D8 to pin 4 D/I pin on LCD
#define GLCD_ENABLE PORTB.2 'D10 to Pin 6 on LCD
#define GLCD_DB0 PORTC.7 'D0 to pin 7 on LCD
#define GLCD_DB1 PORTC.6 'D1 to pin 8 on LCD
#define GLCD_DB2 PORTC.5 'D2 to pin 9 on LCD
#define GLCD_DB3 PORTC.4 'D3 to pin 10 on LCD
#define GLCD_DB4 PORTC.3 'D4 to pin 11 on LCD
#define GLCD_DB5 PORTC.2 'D5 to pin 12 on LCD
#define GLCD_DB6 PORTC.1 'D6 to pin 13 on LCD
#define GLCD_DB7 PORTC.0 'D7 to pin 14 on LCD

InitGLCD
Start:
GLCDCLS
GLCDPrint 0,10,"Hello" 'Print Hello
wait 5 s
GLCDPrint 0,10, "ASCII #:" 'Print ASCII #:
Box 18,30,28,40 'Draw Box Around ASCII Character
for char = 15 to 129 'Print 0 through 9
  GLCDPrint 17, 20 , Str(char)+" "
  GLCDdrawCHAR 20,30, char
  wait 125 ms
next
line 0,50,127,50 'Draw Line using line command
for xvar = 0 to 80 'draw line using Pset command
    pset xvar,63,on '
next '
Wait 1 s
GLCDPrint 0,10,"End " 'Print Hello
wait 1 s
Goto Start

For more help, see Graphical LCD Demonstration, InitGLCD, GLCDCLS, GLCDDrawChar, GLCDPrint,
GLCDReadByte, GLCDWriteByte, Pset
ILI9340 Controllers

See below for an example of using the ILI9340 GLCD. This section contains the relevant information for
this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option the serial mode where connection between the microcomputer and the GLCD to
control the data bus is managed the data in and data out lines.

To use the ILI9340 drivers simply include the following:

#include <glcd.h>
#DEFINE GLCD_TYPE GLCD_TYPE_ILI9340

Constants Controls Options

GLCD_TYPE GLCD_TYPE_ILI9340

GLCD_DATA_PORT Not Available for this controller. Not applicable.

GLCD_DC Specifies the output pin that is Required

connected to Data/Command IO pin on
the GLCD.

GLCD_CS Specifies the output pin that is Required

connected to Chip Select (CS) on the
GLCD.

GLCD_Reset Specifies the output pin that is Required

connected to Reset pin on the GLCD.

GLCD_DI Specifies the output pin that is Required

connected to Data In (GLCD out) pin on
the GLCD.

GLCD_D0 Specifies the output pin that is Required

connected to Data Out (GLCD in) pin on
the GLCD.

GLCD_SLK Specifies the output pin that is Required

connected to Clock (CLK) pin on the
GLCD.

The Great Cow Basic constants for control display characteristics are shown in the table below.

Constants Controls Default

GLCD_WIDTH The width parameter of the GLCD 320

GLCD_HEIGHT The height parameter of the GLCD 240

Constants Controls Default

GLCDFontWidth Specifies the font width of the Great 6

Cow Basic font set.

The Great Cow Basic commands supported for this GLCD are shown in the table below.

Command Purpose Example

GLCDCLS Clear screen of GLCD GLCDCLS

GLCDPrint Print string of characters on GLCD using GLCDPrint( Xposition, Yposition,

GCB font set Stringvariable )

GLCDDrawChar Print character on GLCD using GCB font GLCDDrawChar( Xposition, Yposition,
set CharCode )

GLCDDrawString Print characters on GLCD using GCB GLCDDrawString( Xposition, Yposition,

font set Stringvariable )

Box Draw a box on the GLCD to a specific Box ( Xposition1, Yposition1,

size Xposition2, Yposition2, [Optional In
LineColour as 0 or 1]
FilledBox Draw a box on the GLCD to a specific FilledBox (Xposition1, Yposition1,
size that is filled with the foreground Xposition2, Yposition2, [Optional In
LineColour 0 or 1] )
colour.

Line Draw a line on the GLCD to a specific Line ( Xposition1, Yposition1,

length that is filled with the specific Xposition2, Yposition2, [Optional In
LineColour 0 or 1] )
attribute.

PSet Set a pixel on the GLCD at a specific PSet(Xposition, Yposition, Pixel

position that is set with the specific Colour 0 or 1)
attribute.

GLCDWriteByte Set a byte value to the controller, see GLCDWriteByte ( LCDByte)

the datasheet for usage.

GLCDReadByte Read a byte value from the controller, bytevariable = GLCDReadByte

see the datasheet for usage.

For a ILI9340 datasheet, please refer here.

This example shows how to drive a ILI9340 based Graphic LCD module with the built in commands of
Great Cow Basic.

Example:
 ;Chip Settings
#chip 16F1937,32
#config Osc = INT, VCAPEN_OFF, MCLRE_ON, PLLEN_ON, CLKOUTEN_OFF

#include <glcd.h>

'Defines for ILI9340

#define GLCD_TYPE GLCD_TYPE_ILI9340
'Pin mappings for ILI9340
#define GLCD_DC porta.0
#define GLCD_CS porta.1
#define GLCD_RESET porta.2
#define GLCD_DI porta.3
#define GLCD_DO porta.4
#define GLCD_SCK porta.5

GLCDPrint(0, 0, "Test of the ILI9340 Device")

end

For more help, see Graphical LCD Demonstration, InitGLCD, GLCDCLS, GLCDDrawChar, GLCDPrint,
GLCDReadByte, GLCDWriteByte, Pset

Supported in <GLCD.H>

KS0108 Controllers

See below for an example of using the KS0108 GLCD. This section contains the relevant information for
this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option the 8-bit mode where 8 pins are connected between the microcomputer and the
GLCD to control the data bus.

To use the KS0108 drivers simply include the following:

#include <glcd.h>
#DEFINE GLCD_TYPE GLCD_TYPE_KS0108

Constants Controls Options

GLCD_TYPE GLCD_TYPE_KS0108 Required

GLCD_DATA_PORT Not Available for this controller. Not applicable.

Constants Controls Options

GLCD_RS Specifies the output pin that is Required

connected to Register Select on the
GLCD.

GLCD_RW Specifies the output pin that is Must be set (unless R/W is disabled)
connected to Read/Write on the GLCD. see GLCD_NO_RW
The R/W pin can be disabled.

GLCD_CS1 Specifies the output pin that is Required

connected to CS1 on the GLCD.

GLCD_CS2 Specifies the output pin that is Required

connected to CS2 on the GLCD.

GLCD_ENABLE Specifies the output pin that is Required

connected to Enable on the GLCD.

GLCD_DB0 Specifies the output pin that is Required

connected to DB0 on the GLCD.

GLCD_DB1 Specifies the output pin that is Required

connected to DB1 on the GLCD.

GLCD_DB2 Specifies the output pin that is Required

connected to DB2 on the GLCD.

GLCD_DB3 Specifies the output pin that is Required

connected to DB3 on the GLCD.

GLCD_DB4 Specifies the output pin that is Required

connected to DB4 on the GLCD.

GLCD_DB5 Specifies the output pin that is Required

connected to DB5 on the GLCD.

GLCD_DB6 Specifies the output pin that is Required

connected to DB6 on the GLCD.

GLCD_DB7 Specifies the output pin that is Required

connected to DB7 on the GLCD.

GLCD_NO_RW Disables read/write inspection of the Optional, but recommend NOT to set.
device during read/write operations The R/W pin can be disabled by setting
the GLCD_NO_RW constant. If this is done,
there is no need for the R/W to be
connected to the chip, and no need for
the LCD_RW constant to be set. Ensure
that the R/W line on the LCD is
connected to ground if not used.

The Great Cow Basic constants for control display characteristics are shown in the table below.
Constants Controls Default

GLCD_WIDTH The width parameter of the 128

GLCD

GLCD_HEIGHT The height parameter of the 64

GLCD

GLCDFontWidth Specifies the font width of the 6

Great Cow Basic font set

The Great Cow Basic commands supported for this GLCD are shown in the table below.

Command Purpose Example

InitGLCD Initialize device InitGLCD

GLCDCLS Clear screen of GLCD GLCDCLS

GLCDPrint Print string of characters on GLCDPrint( Xposition,

GLCD using GCB font set Yposition, Stringvariable )

GLCDDrawChar Print character on GLCD using GLCDDrawChar( Xposition,

GCB font set Yposition, CharCode )

GLCDDrawString Print characters on GLCD using GLCDDrawString( Xposition,

GCB font set Yposition, Stringvariable )

Box Draw a box on the GLCD to a Box ( Xposition1, Yposition1,

specific size Xposition2, Yposition2,
[Optional In LineColour as 0 or
1] )
FilledBox Draw a box on the GLCD to a FilledBox (Xposition1,
specific size that is filled with Yposition1, Xposition2,
Yposition2, [Optional In
the foreground colour. LineColour 0 or 1] )
Line Draw a line on the GLCD to a Line ( Xposition1, Yposition1,
specific length that is filled with Xposition2, Yposition2,
[Optional In LineColour 0 or 1]
the specific attribute. )
PSet Set a pixel on the GLCD at a PSet(Xposition, Yposition,
specific position that is set with Pixel Colour 0 or 1)
the specific attribute.

GLCDWriteByte Set a byte value to the controller, GLCDWriteByte ( LCDByte)

see the datasheet for usage.

GLCDReadByte Read a byte value from the bytevariable = GLCDReadByte

controller, see the datasheet for
usage.

For a KS0108 datasheet, please refer here.

This example shows how to drive a KS0108 based Graphic LCD module with the built in commands of
Great Cow Basic. See Graphic LCD for details, this is an external web site.

;Chip Settings
#chip 16F886,16
'#config MCLRE = on 'enable reset switch on CHIPINO
#include <GLCD.h>

;Defines (Constants)
#define GLCD_RW PORTB.1 'D9 to pin 5 of LCD
#define GLCD_RESET PORTB.5 'D13 to pin 17 of LCD
#define GLCD_CS1 PORTB.3 'D12 to actually since CS1, CS2 can be reversed on some devices
#define GLCD_CS2 PORTB.4 'D11 to actually since CS1, CS2 can be reversed on some devices
#define GLCD_RS PORTB.0 'D8 to pin 4 D/I pin on LCD
#define GLCD_ENABLE PORTB.2 'D10 to Pin 6 on LCD
#define GLCD_DB0 PORTC.7 'D0 to pin 7 on LCD
#define GLCD_DB1 PORTC.6 'D1 to pin 8 on LCD
#define GLCD_DB2 PORTC.5 'D2 to pin 9 on LCD
#define GLCD_DB3 PORTC.4 'D3 to pin 10 on LCD
#define GLCD_DB4 PORTC.3 'D4 to pin 11 on LCD
#define GLCD_DB5 PORTC.2 'D5 to pin 12 on LCD
#define GLCD_DB6 PORTC.1 'D6 to pin 13 on LCD
#define GLCD_DB7 PORTC.0 'D7 to pin 14 on LCD

InitGLCD
Start:
GLCDCLS
GLCDPrint 0,10,"Hello" 'Print Hello
wait 5 s
GLCDPrint 0,10, "ASCII #:" 'Print ASCII #:
Box 18,30,28,40 'Draw Box Around ASCII Character
for char = 15 to 129 'Print 0 through 9
  GLCDPrint 17, 20 , Str(char)+" "
  GLCDdrawCHAR 20,30, char
  wait 125 ms
next
line 0,50,127,50 'Draw Line using line command
for xvar = 0 to 80 'draw line using Pset command
    pset xvar,63,on '
next '
Wait 1 s
GLCDPrint 0,10,"End " 'Print Hello
wait 1 s
Goto Start

For more help, see Graphical LCD Demonstration, InitGLCD, GLCDCLS, GLCDDrawChar, GLCDPrint,
GLCDReadByte, GLCDWriteByte, Pset

Supported in <GLCD.H>

PCD8544 Controllers

See below for an example of using the PCD844 GLCD display device. This section contains the relevant
information for this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option the serial mode where connection between the microcomputer and the GLCD to
control the data bus is managed the data in and data out lines.

To use the PCD8544 drivers simply include the following:

#include <glcd.h>
#DEFINE GLCD_TYPE GLCD_TYPE_PCD8544

Constants Controls Options

GLCD_TYPE GLCD_TYPE_PCD8544
GLCD_DATA_PORT Not Available for this controller Not applicable

GLCD_DC Specifies the output pin that is Required

connected to Data/Command IO
pin on the GLCD.

GLCD_CS Specifies the output pin that is Required

connected to Chip Select (CS) on
the GLCD.

GLCD_Reset Specifies the output pin that is Required

connected to Reset pin on the
GLCD.

GLCD_D0 Specifies the output pin that is Required

connected to Data Out (GLCD in)
pin on the GLCD.

GLCD_SCK Specifies the output pin that is Required

connected to Clock (CLK) pin on
the GLCD.

GLCD_TYPE_PCD8544_CHARACTER_MOD Specifies that the display Optional

E_ONLY controller will operate in text
mode and BMP draw mode only.
For microcontrollers with less
then 1kb of RAM this will be set
be default.
Constants Controls Options

PCD8544ClockDelay Specifies the clock delay, if Optional. Set to 0 as the default

required for slower value
microcontroller,

PCD8544WriteDelay Specifies the write delay, if Optional. Set to 0 as the default

required for slower value
microcontroller,

The Great Cow Basic constants for control display characteristics are shown in the table below.

Constants Controls Default

GLCD_WIDTH The width parameter of the 160

GLCD

GLCD_HEIGHT The height parameter of the 128

GLCD

GLCDFontWidth Specifies the font width of the 6

Great Cow Basic font set.

The Great Cow Basic commands supported for this GLCD are shown in the table below.

Command Purpose Example

InitGLCD Initialize device InitGLCD

GLCDCLS Clear screen of GLCD GLCDCLS

GLCDPrint Print string of characters on GLCDPrint( Xposition,

GLCD using GCB font set Yposition, Stringvariable )

GLCDDrawChar Print character on GLCD using GLCDDrawChar( Xposition,

GCB font set Yposition, CharCode )

GLCDDrawString Print characters on GLCD using GLCDDrawString( Xposition,

GCB font set Yposition, Stringvariable )

Box Draw a box on the GLCD to a Box ( Xposition1, Yposition1,

specific size Xposition2, Yposition2,
[Optional In LineColour as 0 or
1] )
FilledBox Draw a box on the GLCD to a FilledBox (Xposition1,
specific size that is filled with Yposition1, Xposition2,
Yposition2, [Optional In
the foreground colour. LineColour 0 or 1] )
Line Draw a line on the GLCD to a Line ( Xposition1, Yposition1,
specific length that is filled with Xposition2, Yposition2,
[Optional In LineColour 0 or 1]
the specific attribute. )
Command Purpose Example

PSet Set a pixel on the GLCD at a PSet(Xposition, Yposition,

specific position that is set with Pixel Colour 0 or 1)
the specific attribute.

GLCDWriteByte Set a byte value to the controller, GLCDWriteByte ( LCDByte)

see the datasheet for usage.

GLCDReadByte Read a byte value from the bytevariable = GLCDReadByte

controller, see the datasheet for
usage.

*For a PCD8544 datasheet, please refer here

This example shows how to drive a PCD8544 based Graphic LCD module with the built in commands of
Great Cow Basic.

Example:

    #chip 16lf1939,32
    #config Osc = INT, MCLRE_ON, PLLEN_Off, CLKOUTEN_OFF

        #include <glcd.h>

        #DEFINE GLCD_TYPE GLCD_TYPE_PCD8544

          ' Pin mappings for SPI for Nokia 3310 Device

              #define GLCD_DO portc.5
              #define GLCD_SCK portc.3
              #define GLCD_DC portc.2
              #define GLCD_CS portc.1
              #define GLCD_RESET portc.0

          GLCDCLS

          DO forever
             for CCount = 31 to 127
                  GLCDPrint (0, 0, "PrintStr")
                  GLCDDrawString (0, 9, "DrawStr")
                  GLCDPrint ( 44 , 21, " ")
                  GLCDPrint ( 44 , 29, " ") ' word value
                  GLCDPrint ( 44 , 37, " ") ' Byte value

                  outstring = hex( longNumber_U)

                  GLCDPrint ( 44 , 21,outstring )
                  outstring = hex( longNumber_H)
                   GLCDPrint ( 55 , 21, outstring)
                  outstring = hex( longNumber)
                  GLCDPrint ( 67 , 21, outstring )
                  GLCDPrint ( 44 , 29, mid( str(wordNumber),1, 6))
                  GLCDPrint ( 44 , 37, byteNumber)

                  box 46,9,57,19
                  GLCDDrawChar(48, 9, CCount )
                  outString = str( CCount )
                  ' draw a box to overwrite existing strings
                  FilledBox(58,9,GLCD_WIDTH-1,17,GLCDBackground )
                  GLCDDrawString(58, 9, outString )

                   box 0,0,GLCD_WIDTH-1, GLCD_HEIGHT-1

                   box GLCD_WIDTH-5, GLCD_HEIGHT-5,GLCD_WIDTH- 1, GLCD_HEIGHT-1
                   filledbox 2,30,6,38, wordNumber
                   Circle( 25,30,8,1) ;center
                   FilledCircle( 25,30,4,longNumber xor 1) ;center

                   line 0, GLCD_HEIGHT-1 , GLCD_WIDTH/2, (GLCD_HEIGHT /2) +1

                   line GLCD_WIDTH/2, (GLCD_HEIGHT /2) +1 ,0, (GLCD_HEIGHT /2) +1

                  longNumber = longNumber + 7
                  wordNumber = wordNumber + 3
                  byteNumber++
              NEXT
          LOOP

      end

See also InitGLCD, GLCDCLS, GLCDDrawChar, GLCDPrint, GLCDReadByte, GLCDWriteByte, Pset

Supported in <GLCD.H> and <glcd_PCD8544.h>

SDD1289 Controllers

See below for an example of using the SDD1289 GLCD. This section contains the relevant information
for this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option the serial mode where connection between the microcomputer and the GLCD to
control the data bus is managed the data in and data out lines.

To use the SDD1289 drivers simply include the following:

 #include <glcd.h>
#DEFINE GLCD_TYPE GLCD_TYPE_SDD1289

Constants Controls Options

GLCD_TYPE GLCD_TYPE_SDD1289

The Great Cow Basic constants for control display characteristics are shown in the table below.

Constants Controls Default

GLCD_WIDTH The width parameter of the GLCD

GLCD_HEIGHT The height parameter of the GLCD

GLCDFontWidth Specifies the font width of the Great 6

Cow Basic font set.

The Great Cow Basic commands supported for this GLCD are shown in the table below.

Command Purpose Example

GLCDCLS Clear screen of GLCD GLCDCLS

GLCDPrint Print string of characters on GLCD using GLCDPrint( Xposition, Yposition,

GCB font set Stringvariable )

GLCDDrawChar Print character on GLCD using GCB font GLCDDrawChar( Xposition, Yposition,
set CharCode )

GLCDDrawString Print characters on GLCD using GCB GLCDDrawString( Xposition, Yposition,

font set Stringvariable )

Box Draw a box on the GLCD to a specific Box ( Xposition1, Yposition1,

size Xposition2, Yposition2, [Optional In
LineColour as 0 or 1]
FilledBox Draw a box on the GLCD to a specific FilledBox (Xposition1, Yposition1,
size that is filled with the foreground Xposition2, Yposition2, [Optional In
LineColour 0 or 1] )
colour.

Line Draw a line on the GLCD to a specific Line ( Xposition1, Yposition1,

length that is filled with the specific Xposition2, Yposition2, [Optional In
LineColour 0 or 1] )
attribute.

PSet Set a pixel on the GLCD at a specific PSet(Xposition, Yposition, Pixel

position that is set with the specific Colour 0 or 1)
attribute.

GLCDWriteByte Set a byte value to the controller, see GLCDWriteByte ( LCDByte)

the datasheet for usage.
Command Purpose Example

GLCDReadByte Read a byte value from the controller, bytevariable = GLCDReadByte

see the datasheet for usage.

For a SDD1289 datasheet, please refer here.

This example shows how to drive a SDD1289 based Graphic LCD module with the built in commands of
Great Cow Basic.

Example:

;Chip Settings
#chip 16F1937,32
#config Osc = INT, VCAPEN_OFF, MCLRE_ON, PLLEN_ON, CLKOUTEN_OFF

#include <glcd.h>

'Defines for SDD1289

#define GLCD_TYPE GLCD_TYPE_SDD1289
'Pin mappings for SDD1289
#define GLCD_DC porta.0
#define GLCD_CS porta.1
#define GLCD_RESET porta.2
#define GLCD_DI porta.3
#define GLCD_DO porta.4
#define GLCD_SCK porta.5

GLCDPrint(0, 0, "Test of the SDD1289 Device")

end

For more help, see Graphical LCD Demonstration, InitGLCD, GLCDCLS, GLCDDrawChar, GLCDPrint,
GLCDReadByte, GLCDWriteByte, Pset

Supported in <GLCD.H>

SSD1306 Controllers

See below for an example of using the SSD1306 GLCD. This section contains the relevant information
for this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option is I2C BUS. I2C is the connectivity between the microcomputer and the GLCD to
control the data bus.

To use the SSD1306 drivers simply include the following. The I2C setup/configuration commands must
be included.
 #include <glcd.h>

; ----- Define GLCD Hardware settings

#define GLCD_TYPE GLCD_TYPE_SSD1306
#define GLCD_I2C_Address 0x78

; ----- Define Hardware settings

' Define I2C settings
#define HI2C_BAUD_RATE 400
#define HI2C_DATA
HI2CMode Master

Constants Controls Options

GLCD_TYPE GLCD_TYPE_SSD1306 Required

GLCD_I2C_Address I2C address of the GLCD. Required

The Great Cow Basic constants for control display characteristics are shown in the table below.

Constants Controls Default

GLCD_WIDTH The width parameter of the 128

GLCD

GLCD_HEIGHT The height parameter of the 64

GLCD

GLCDFontWidth Specifies the font width of the 6

Great Cow Basic font set.

The Great Cow Basic specific commands for this GLCD are shown in the table below.

Command Purpose

Cursor_Position_SSD1306( in LocX as byte, in Takes raw pixel positions and translates to XY

LocY as byte ) char positions as
X coordinate of pixel,
Y coordinate of pixel

Stopscroll_SSD1306 Stops all scrolling

Startscrollright_SSD1306 ( start , stop Activate a right handed scroll for rows start
[,scrollspeed] ) through stop Hint, the display is 16 rows tall. To
scroll the whole display, execute:
startscrollright_SSD1306(0x00, 0x0F)
Parameters are Start row, End row, optionally
Scrollspeed
Command Purpose

Startscrollleft_SSD1306 ( start , stop Activate a left handed scroll for rows start
[,scrollspeed] ) through stop Hint, the display is 16 rows tall. To
scroll the whole display, execute:
startscrollleft_SSD1306(0x00, 0x0F)
Parameters are Start row, End row, optionally
Scrollspeed
Startscrolldiagright_SSD1306 ( start , stop Activate a diagright handed scroll for rows start
[,scrollspeed] ) through stop Hint, the display is 16 rows tall. To
scroll the whole display, execute:
startscrolldiagright_SSD1306(0x00, 0x0F)
Parameters are Start row, End row, optionally
Scrollspeed
Startscrolldiagleft_SSD1306 ( start , stop Activate a diagleft handed scroll for rows start
[,scrollspeed] ) through stop Hint, the display is 16 rows tall. To
scroll the whole display, execute:
startscrolldiagleft_SSD1306(0x00, 0x0F)
Parameters are Start row,End row, optionally
Scrollspeed
SetContrast_SSD1306 ( in dim_state ) Sets the constrast to select 1 out of 256 contrast
steps. Contrast increases as the value increases.
Parameter is dim value

For a SSD1306 datasheet, please refer here.

This example shows how to drive a SSD1306 based Graphic LCD module with the built in commands of
Great Cow Basic.

; ----- Configuration
#chip mega328p,16
#include <glcd.h>

; ----- Define Hardware settings

' Define I2C settings
#define HI2C_BAUD_RATE 400
#define HI2C_DATA
HI2CMode Master

; ----- Define GLCD Hardware settings

#define GLCD_TYPE GLCD_TYPE_SSD1306
#define GLCD_I2C_Address 0x78

GLCDCLS
GLCDPrint 0, 0, "Great Cow Basic"
GLCDPrint (0, 16, "Anobium 2015")
 wait 3 s
GLCDCLS

' Prepare the static components of the screen

GLCDPrint ( 0, 0, "PrintStr") ; Print some text
GLCDPrint ( 64, 0, "@")
; Print some more text
GLCDPrint ( 72, 0, ChipMhz) ; Print chip speed
GLCDPrint ( 86, 0, "Mhz") ; Print some text
GLCDDrawString( 0,8,"DrawStr") ; Draw some text
box 0,0,GLCD_WIDTH-1, GLCD_HEIGHT-1 ; Draw a box
box GLCD_WIDTH-5, GLCD_HEIGHT-5,GLCD_WIDTH-1, GLCD_HEIGHT-1 ; Draw a box
Circle( 44,41,15) ; Draw a circle
line 64,31,0,31 ; Draw a line

DO forever
   for CCount = 31 to 127
        GLCDPrint ( 64 , 36, hex(longNumber_E ) ) ; Print a HEX string
        GLCDPrint ( 76 , 36, hex(longNumber_U ) ) ; Print a HEX string
        GLCDPrint ( 88 , 36, hex(longNumber_H ) ) ; Print a HEX string
        GLCDPrint ( 100 , 36, hex(longNumber ) ) ; Print a HEX string
        GLCDPrint ( 112 , 36, "h" ) ; Print a HEX string

        GLCDPrint ( 64 , 44, pad(str(wordNumber), 5 ) ) ; Print a padded string

        GLCDPrint ( 64 , 52, pad(str(byteNumber), 3 ) ) ; Print a padded string

        box (46,9,56,19) ; Draw a Box

        GLCDDrawChar(48, 9, CCount ) ; Draw a character
        outString = str( CCount ) ; Prepare a string
        GLCDDrawString(64, 9, pad(outString,3) ) ; Draw a string

        filledbox 3,43,11,51, wordNumber ; Draw a filled box

        FilledCircle( 44,41,9, longNumber xor 1) ; Draw a filled box

        line 0,63,64,31 ; Draw a line

        ; Do some simple maths

        longNumber = longNumber + 7 : wordNumber = wordNumber + 3 : byteNumber++
    NEXT
LOOP
end

For more help, see GLCDCLS, GLCDDrawChar, GLCDPrint

Supported in <GLCD.H>
ST7735 Controllers

See below for an example of using the ST7735 GLCD. This section contains the relevant information for
this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option the serial mode where connection between the microcomputer and the GLCD to
control the data bus is managed the data in and data out lines.

To use the ST7735 drivers simply include the following:

#include <glcd.h>
#DEFINE GLCD_TYPE GLCD_TYPE_ST7735

Constants Controls Options

GLCD_TYPE GLCD_TYPE_ST7735
GLCD_DATA_PORT Not Available for this controller. Not applicable.

GLCD_DC Specifies the output pin that is Required

connected to Data/Command IO
pin on the GLCD.

GLCD_CS Specifies the output pin that is Required

connected to Chip Select (CS) on
the GLCD.

GLCD_Reset Specifies the output pin that is Required

connected to Reset pin on the
GLCD.

GLCD_DI Specifies the output pin that is Required

connected to Data In (GLCD out)
pin on the GLCD.

GLCD_D0 Specifies the output pin that is Required

connected to Data Out (GLCD in)
pin on the GLCD.

GLCD_SLK Specifies the output pin that is Required

connected to Clock (CLK) pin on
the GLCD.

The Great Cow Basic constants for control display characteristics are shown in the table below.

Constants Controls Default

GLCD_WIDTH The width parameter of the 160

GLCD
Constants Controls Default

GLCD_HEIGHT The height parameter of the 128

GLCD

GLCDFontWidth Specifies the font width of the 6

Great Cow Basic font set.

The Great Cow Basic commands supported for this GLCD are shown in the table below.

Command Purpose Example

InitGLCD Initialize device InitGLCD

GLCDCLS Clear screen of GLCD GLCDCLS

GLCDPrint Print string of characters on GLCDPrint( Xposition,

GLCD using GCB font set Yposition, Stringvariable )

GLCDDrawChar Print character on GLCD using GLCDDrawChar( Xposition,

GCB font set Yposition, CharCode )

GLCDDrawString Print characters on GLCD using GLCDDrawString( Xposition,

GCB font set Yposition, Stringvariable )

Box Draw a box on the GLCD to a Box ( Xposition1, Yposition1,

specific size Xposition2, Yposition2,
[Optional In LineColour as 0 or
1] )
FilledBox Draw a box on the GLCD to a FilledBox (Xposition1,
specific size that is filled with Yposition1, Xposition2,
Yposition2, [Optional In
the foreground colour. LineColour 0 or 1] )
Line Draw a line on the GLCD to a Line ( Xposition1, Yposition1,
specific length that is filled with Xposition2, Yposition2,
[Optional In LineColour 0 or 1]
the specific attribute. )
PSet Set a pixel on the GLCD at a PSet(Xposition, Yposition,
specific position that is set with Pixel Colour 0 or 1)
the specific attribute.

GLCDWriteByte Set a byte value to the controller, GLCDWriteByte (LCDByte)

see the datasheet for usage.

GLCDReadByte Read a byte value from the bytevariable = GLCDReadByte

controller, see the datasheet for
usage.

For a ST7735 datasheet, please refer here.

 ;Chip Settings
#chip 16F1937,32
#config Osc = INT, VCAPEN_OFF, MCLRE_ON, PLLEN_ON, CLKOUTEN_OFF

#include <lowlevel\glcd.h>

'Defines for ST7735

#define GLCD_TYPE GLCD_TYPE_ST7735
'Pin mappings for ST7735
#define GLCD_DC porta.0
#define GLCD_CS porta.1
#define GLCD_RESET porta.2
#define GLCD_DI porta.3
#define GLCD_DO porta.4
#define GLCD_SCK porta.5

GLCDPrint(0, 0, "Test of the ST7735 Device")

end

For more help, see LCD_IO 0, LCD_IO 2 LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

Supported in <GLCD.H>

ST7920 Controllers

The ST7920 GLCD is Graphic and character mixed display mode display. ST7920 LCD controller/driver
IC can display alphabets, numbers, Chinese fonts and self-defined characters. It supports 3 kinds of bus
interface, namely 8-bit, 4-bit and serial. Great Cow Basic is currently supports 8-bit only. For LCD only
operations (text characters only) you can use the Great Cow Basic LCD routines.

All functions, including display RAM, Character Generation ROM, LCD display drivers and control
circuits are all in a one-chip solution. With a minimum system configuration, a Chinese character
display system can be easily achieved.

The ST7920 includes character ROM with 8192 16x16 dots Chinese fonts and 126 16x8 dots half-width
alphanumerical fonts. It supports 64x256 dots graphic display area for graphic display (GDRAM). Mix-
mode display with both character and graphic data is possible. ST7920 has built-in CGRAM and provide
4 sets software programmable 16x16 fonts.

See below for an example of using the ST7920 GLCD. This section contains the relevant information for
this type of device.

The Great Cow Basic constants for control of the connectivity are shown in the table below. The only
connectivity option the 8-bit mode where 8 pins are connected between the microcomputer and the
GLCD to control the data bus.
To use the ST7920 drivers simply include the following:

#include <glcd.h>
#DEFINE GLCD_TYPE GLCD_TYPE_ST7920

Constants Controls Options

GLCD_TYPE GLCD_TYPE_ST7920 Required

GLCD_DATA_PORT Specifies the output port that is Required

connected between the
microcomputer and the GLCD.

GLCD_RS Specifies the output pin that is Required

connected to Register Select on
the GLCD.

GLCD_RW Specifies the output pin that is Must be set unless R/W is
connected to Read/Write on the disabled), see GLCD_NO_RW
GLCD. The R/W pin can be
disabled*.

GLCD_RESET Specifies the output pin that is Required

connected to Reset on the GLCD.

LCD_ENABLE Specifies the output pin that is Required

connected to Enable on the
GLCD.

ST7920WriteDelay Set the time delay between data Required, set to 20 us for 32Mhz
transmissions. support. Can be reduced for
slower chip speeds.

GLCD_NO_RW Disables read/write inspection of Optional, but recommend NOT

the device during read/write to set. The R/W pin can be
operations disabled by setting the
GLCD_NO_RW constant. If this is
done, there is no need for the R/W
to be connected to the chip, and
no need for the LCD_RW constant
to be set. Ensure that the R/W line
on the LCD is connected to
ground if not used.

The Great Cow Basic constants for control display characteristics are shown in the table below.

Constants Controls Default

GLCD_WIDTH The width parameter of the 128

GLCD
Constants Controls Default

GLCD_HEIGHT The height parameter of the 64

GLCD

GLCDFontWidth Specifies the font width of the 6

Great Cow Basic font set.

The Great Cow Basic commands supported for this GLCD are shown in the table below. For device
specific see the commands with the prefix of ST7920*.

Command Purpose Example

InitGLCD Initialize device InitGLCD

GLCDCLS Clear screen of GLCD GLCDCLS

GLCDPrint Print string of characters on GLCDPrint( Xposition,

GLCD using GCB font set Yposition, Stringvariable )

GLCDDrawChar Print character on GLCD using GLCDDrawChar( Xposition,

GCB font set Yposition, CharCode )

GLCDDrawString Print characters on GLCD using GLCDDrawString( Xposition,

GCB font set Yposition, Stringvariable )

Box Draw a box on the GLCD to a Box ( Xposition1, Yposition1,

specific size Xposition2, Yposition2,
[Optional In LineColour as 0 or
1] )
FilledBox Draw a box on the GLCD to a FilledBox (Xposition1,
specific size that is filled with Yposition1, Xposition2,
Yposition2, [Optional In
the foreground colour. LineColour 0 or 1] )
Line Draw a line on the GLCD to a Line ( Xposition1, Yposition1,
specific length that is filled with Xposition2, Yposition2,
[Optional In LineColour 0 or 1]
the specific attribute. )
PSet Set a pixel on the GLCD at a PSet(Xposition, Yposition,
specific position that is set with Pixel Colour 0 or 1)
the specific attribute.

GLCDWriteByte Set a byte value to the controller, GLCDWriteByte (LCDByte)

see the datasheet for usage.

GLCDReadByte Read a byte value from the bytevariable = GLCDReadByte

controller, see the datasheet for
usage.

For a TS7920 datasheet, please refer here.

This example shows how to drive a KS0108 based Graphic LCD module with the built in commands of
Great Cow Basic. See Graphic LCD for details, this is an external web site.

Example 1:

;Chip Settings
#chip 16F1937,32
#config Osc = INT, VCAPEN_OFF, MCLRE_ON, PLLEN_ON, CLKOUTEN_OFF

#include <glcd.h>

#define GLCD_TYPE GLCD_TYPE_ST7920

#define GLCD_IO 8
#define GLCD_WIDTH 128
#define GLCD_HEIGHT 160
#define GLCDFontWidth 6

' read delay of 25 is required at 32mhz, this can be reduced to 0 for slower clock speeds
#define ST7920ReadDelay 25
' write delay of 2 is required at 32mhz. this can be reduced to 1 for slower clock
speeds
#define ST7920WriteDelay 2

#define GLCD_RS PORTa.0

#define GLCD_Enable PORTA.1
#define GLCD_RW PORTA.2
#define GLCD_RESET PORTA.3
#define GLCD_DATA_PORT PORTD

ST7920GLCDEnableGraphics
ST7920GLCDClearGraphics
GLCDPrint 0, 1, "Great Cow Basic "
wait 1 s

GLCDCLS
ST7920GLCDClearGraphics

rrun = 0
dim msg1 as string * 16

dim xradius, yordinate , radiusErr, incrementalxradius, orginalxradius, orginalyordinate

as Integer

Do forever
    GLCDCLS
    ST7920GLCDClearGraphics ;clear screen
    GLCDDrawString 30,0,"ChipMhz@" ;print string
     GLCDDrawString 78,0, str(ChipMhz) ;print string
    GLCDCircle(10,10,10,0) ;upper left
    GLCDCircle(117,10,10,0) ;upper right
    GLCDCircle(63,31,10,0) ;center
    GLCDCircle(63,31,20,0) ;center
    GLCDCircle(10,53,10,0) ;lower left
    GLCDCircle(117,53,10,0) ;lower right
    GLCDDrawString 30,54,"PIC16F1937" ;print string
    wait 1 s ;wait
    FilledBox( 0,0,128,63) ;create box
    for ypos = 0 to 63 ;draw row by row
         ST7920lineh 0,ypos,128, 0 ;draw line
    next
    wait 1 s ;wait
    ST7920GLCDClearGraphics ;clear
loop

sub GLCDCircle ( in xoffset, in yoffset, in xradius, in yordinate)

'radiusErr = 1 - xradius
radiusErr = -(xradius/2)
Do While xradius >= yordinate
   Pset ((xoffset + xradius), (yoffset + yordinate), on)
   Pset ((xoffset + yordinate), (yoffset + xradius), on)
   Pset ((xoffset - xradius), (yoffset + yordinate), on)
   Pset ((xoffset - yordinate), (yoffset + xradius), on)
   Pset ((xoffset - xradius), (yoffset - yordinate), on)
   Pset ((xoffset - yordinate), (yoffset - xradius), on)
   Pset ((xoffset + xradius), (yoffset - yordinate), on)
   Pset ((xoffset + yordinate), (yoffset - xradius), on)
   yordinate ++
   If radiusErr < 0 Then
      radiusErr = radiusErr + 2 * yordinate + 1
   else
      xradius --
      radiusErr = radiusErr + 2 * (yordinate - xradius + 1)
   end if
Loop
end sub

Example 2:

;Chip Settings
#chip 16F1937,32
#config Osc = INT, VCAPEN_OFF, MCLRE_ON, PLLEN_ON, CLKOUTEN_OFF

#include <lowlevel\glcd.h>
#define GLCD_TYPE GLCD_TYPE_ST7920
#define GLCD_IO 8
#define GLCD_WIDTH 128
#define GLCD_HEIGHT 160
#define GLCDFontWidth 6

' read delay of 25 is required at 32mhz, this can be reduced to 0 for slower clock speeds
#define ST7920ReadDelay 25
' write delay of 2 is required at 32mhz. this can be reduced to 1 for slower clock
speeds
#define ST7920WriteDelay 2

#define GLCD_RS PORTa.0

#define GLCD_Enable PORTA.1
#define GLCD_RW PORTA.2
#define GLCD_RESET PORTA.3
#define GLCD_DATA_PORT PORTD

WAIT 1 S
ST7920GLCDEnableGraphics
ST7920GLCDClearGraphics
ST7920Tile "A"
GLCDPrint 0, 1, "Great Cow Basic "

GLCDCLS

rrun = 0
dim msg1 as string * 16

do forever

ST7920GLCDEnableGraphics
ST7920GLCDClearGraphics
ST7920gTile 0x55, 0x55
wait 1 s

ST7920GLCDClearGraphics
ST7920Lineh(0, 0, GLCD_WIDTH)
ST7920Lineh(0, GLCD_HEIGHT - 1, GLCD_WIDTH)
ST7920LineV(0, 0, GLCD_HEIGHT)
ST7920LineV(GLCD_WIDTH - 1, 0, GLCD_HEIGHT)

Box 18,30,28,40

WAIT 2 S

FilledBox 18,30,28,40
ST7920GLCDClearGraphics

Start:

GLCDDrawString 0,10,"Hello" 'Print Hello

wait 1 s
GLCDDrawString 0,10, "ASCII #:" 'Print ASCII #:
Box 18,30,28,40 'Draw Box Around ASCII Character
for char = 0x30 to 0x39 'Print 0 through 9
      GLCDDrawString 16, 20 , Str(char)+" "
      GLCDdrawCHAR 20, 30, char
      wait 250 ms
next
line 0,50,127,50 'Draw Line using line command
for xvar = 0 to 80 'draw line using Pset command
        pset xvar,63,on '
next
FilledBox 18,30,28,40 'Draw Box Around ASCII Character
Wait 1 s
ST7920GLCDClearGraphics
GLCDDrawString 0,10,"End "
wait 1 s
ST7920GLCDClearGraphics

workingGLCDDrawChar:
ST7920GLCDEnableGraphics
dim gtext as string
gtext = "ST7920 @QC12864B"

for xchar = 1 to gtext(0) 'Print 0 through 9

      xxpos = (1+(xchar*6)-6)
      GLCDDrawChar xxpos , 0 , gtext(xchar)
next

GLCDDrawString 1, 9, "Great Cow Basic @2014"

GLCDDrawString 1, 18,"GLCD 128*64"
GLCDDrawString 1, 27,"Using GLCD.H from GCB"
GLCDDrawString 1, 37,"Using GLCD.H GCB@2014"
GLCDDrawString 1, 45,"GLCDDrawChar method"
'GLCDDrawString 1, 54,"ST7920 @QC12864B"
GLCDDrawString 1, 54,"Test Routines"
wait 1 s

ST7920GLCDClearGraphics
ST7920GLCDDisableGraphics
GLCDCLS
msg1 = "Run = " +str(rrun)
rrun++
GLCDPrint 0, 0, "ST7920 @QC12864B"
GLCDPrint 0, 1, "Great Cow Basic "
GLCDPrint 0, 2, "GLCD 128*64"
GLCDPrint 0, 3, msg1
wait 5 s
GLCDCLS

' show all chars... takes some time!

ST7920CallBuiltinChar

ST7920Tile ( 0xa9 )
wait 1 s
GLCDCLS

' See http://www.khngai.com/chinese/charmap/tblbig.php?page=0

' and see https://sourceforge.net/projects/vietunicode/files/hannom/hannom%20v2005/ for
the FONTS!!

dim BIG5code as word

'ST7920 can display half-width HCGROM fonts, user- defined CGRAM fonts and full 16x16
CGROM fonts. The
'character codes in 0000H~0006H will use user- defined fonts in CGRAM. The character
codes in 02H~7FH will use
'half-width alpha numeric fonts. The character code larger than A1H will be treated as
16x16 fonts and will be
'combined with the next byte automatically. The 16x16 BIG5 fonts are stored in
A140H~D75FH while the 16x16 GB
'fonts are stored in A1A0H~F7FFH. In short:
'1. To display HCGROM fonts:
'Write 2 bytes of data into DDRAM to display two 8x16 fonts. Each byte represents 1
character.
'The data is among 02H~7FH.
'2. To display CGRAM fonts:
'Write 2 bytes of data into DDRAM to display one 16x16 font.
'Only 0000H, 0002H, 0004H and 0006H are acceptable.
'3. To display CGROM fonts:
'Write 2 bytes of data into DDRAM to display one 16x16 font.
'A140H~D75FH are BIG5 code, A1A0H~F7FFH are GB code.

for BIG5code = 0xA140 to 0xA1CF

    ST7920cTile ( BIG5code )
    wait 5 ms
  next
GLCDCLS
'To display HCGROM fonts
' Write 2 bytes of data into DDRAM to display two 8x16 fonts. Each byte represents 1
character.
' The data is among 02H~7FH.
' The english characters set...
for HCGROM = 0x2h to 0x7f
    ST7920Tile ( HCGROM )
    ST7920Tile ( HCGROM )
    wait 5 ms
next
GLCDCLS

linetest1:

  ST7920GLCDEnableGraphics

  ST7920gTile(0x55, 0x55)
  wait 1 s
  ST7920GLCDClearGraphics

'linehtest:
'
ST7920LineH(0, 0, GLCD_WIDTH)
ST7920LineH(0, GLCD_HEIGHT - 1, GLCD_WIDTH)
ST7920LineV(0, 0, GLCD_HEIGHT)
ST7920LineV(GLCD_WIDTH - 1, 0, GLCD_HEIGHT)

box test
ST7920LineH(10 ,0 , 118 )
ST7920LineH(0 ,8 , 128)
ST7920LineH(16 ,16 , 96 )
ST7920LineH(10 ,32 , 108 )
ST7920LineH(0, 16, GLCD_WIDTH)
ST7920LineH(0, 24, GLCD_WIDTH)
ST7920LineH(0, 32, GLCD_WIDTH)
ST7920LineH(0, 40, GLCD_WIDTH)
ST7920LineH(0, 48, GLCD_WIDTH)
ST7920LineH(0, 56, GLCD_WIDTH)
ST7920LineH(0, 63, GLCD_WIDTH)
ST7920LineV(16, 0, GLCD_HEIGHT)
ST7920LineV(17, 0, GLCD_HEIGHT)
ST7920LineV(15, 0, GLCD_HEIGHT)

ST7920LineV(46, 0, GLCD_HEIGHT)
ST7920LineV(47, 0, GLCD_HEIGHT)
ST7920LineV(48, 0, GLCD_HEIGHT)

ST7920LineV(46, 0, GLCD_HEIGHT)
ST7920LineV(47, 0, GLCD_HEIGHT)
ST7920LineV(48, 0, GLCD_HEIGHT)

ST7920LineV(96, 0, GLCD_HEIGHT)
ST7920LineV(97, 0, GLCD_HEIGHT)
ST7920LineV(98, 0, GLCD_HEIGHT

for HCGROM = 0 to GLCD_WIDTH step 8

    ST7920LineV(HCGROM, 0, GLCD_HEIGHT)
next

GraphicTestPlace:

  ST7920GLCDClearGraphics
  ST7920GraphicTest
  ST7920GLCDClearGraphics

  ' Test draw a line

  for yrowpos = 0 to 63 step 4
    ST7920LineH(0, yrowpos, GLCD_WIDTH)
  next

  ST7920GLCDClearGraphics
  ST7920GLCDDisableGraphics
  GLCDCLS

  ST7920SetIcon( 1, 0x55 )

loop

sub ST7920CallBuiltinChar
    ' 0xA140 ~ 0xA15F
      for ii = 0 to 31

          ST7920WriteData( 0xA1)
          ST7920WriteData( 0x40 + ii)

      next

      wait 1 s

      GLCDCLS

      ' 0xA140 ~ 0xA15F

      for ii = 0 to 31

          ST7920WriteData( 0xA1)
          ST7920WriteData( 0xb0 + ii)
       next
      wait 1 s
      GLCDCLS

      ' 0xA140 ~ 0xA15F

      for ii = 0 to 31

          ST7920WriteData( 0xA4)
          ST7920WriteData( 0x40 + ii)

      next
      wait 1 s
      GLCDCLS
end sub

For more help, see LCD_IO 0, LCD_IO 2 LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

Supported in <GLCD.H>

ST7920GLCDClearGraphics

Syntax:

ST7920GLCDClearGraphics

Explanation:

This command clears the GCLD display.

Example usage:

ST7920GLCDClearGraphics 'clear the screen

ST7920GLCDDisableGraphics

Syntax:

ST7920GLCDDisableGraphics

Explanation:

This command sets the GCLD display controller to text mode.

Example usage:
 ST7920GLCDDisableGraphics 'Set to text mode

ST7920GLCDEnableGraphics

Syntax:

ST7920GLCDEnableGraphics

Explanation:

This command sets the GCLD display controller to text mode.

Example usage:

ST7920GLCDEnableGraphics 'Set to text mode

ST7920GraphicTest

Syntax:

ST7920GraphicTest

Explanation:

This command tests the graphics functionality of the GLCD display.

Example usage:

ST7920GraphicTest ‘Test the display

ST7920LineHs

Syntax:

ST7920LineHs ( Xpos, Ypos, XLength, Style)

Explanation:

This command draws a line with a specific style. The style is based on the bits value of the byte passed
to the routine.

Example usage:
 ST7920LineHs ( 0, 31,128 , 0x55) ‘will draw a dashed line

ST7920Locate

Syntax:

ST7920Locate ( Xpos, Ypos)

Explanation:

This command locates the pixel at the specific X and Y location of the text screen. Subsequent printing
to the GLCD will place a character to the GLCD controller on the specified row and column. Due to the
design of the ST7920 controller (to accomodate Mandarin and Cyrillic), you must place the text on the
column according to the numbers above the diagram below. The addressing is handle by the
command.

|--0--|--1--|--2--|... ...|--7--|

+--+--+--+--+--+---------------------+

|H |e |l |l |o | ... | <- row 0 (address 0x80)

+--+--+--+--+--+---------------------+

|T |h |i |s | |i ... | <- row 1 (address 0x90)

+--+--+--+--+--+---------------------+

|' |' |' |' |' |' ... | <- row 2 (address 0x88)

+--+--+--+--+--+---------------------+

|- |- |- |- |- |- ... | <- row 3 (address 0x98)

+--+--+--+--+--+---------------------+

Writing 'a' onto the 1st column, and 1st row:

 |--0--|--1--|--2--|... ...|--7--|

+--+--+--+--+--+---------------------+

| | | | | | ... | <- row 0 (address 0x80)

+--+--+--+--+--+---------------------+

| | |a | | | ... | <- row 1 (address 0x90)

+--+--+--+--+--+---------------------+

| | | | | | ... | <- row 2 (address 0x88)

+--+--+--+--+--+---------------------+

| | | | | | ... | <- row 3 (address 0x98)

+--+--+--+--+--+---------------------+

Example usage:

ST7920Locate ( 64, 31) ‘the pixel at the mid screen point

ST7920Tile

Syntax:

ST7920Tile ( word variable )

Explanation:

This command tiles the screen with the word value provided.

Example usage:

Dim tileValue as word

 tileValue = (0x55 * 256 ) + 0x55
 ST7920Tile (tileValue) ‘tile the screen with a nice cross hatch

ST7920cTile

Syntax:
 ST7920cTile ( word variable )

Explanation:

Tiles screen with a Chinese Symbol.

This required 2 bytes of data into DDRAM to display one 16x16 font from memory location
A140H~D75FH are BIG5 code, A1A0H~F7FFH are GB code.

Example usage:

Dim CTileValue as word

cTileValue = (0xA140H * 256 ) + 0xA140H
ST7920Tile (CTileValue) ‘tile the screen with a nice cross hatch

ST7920gLocate

Syntax:

ST7920gLocate ( Xpos, Ypos)

Explanation:

This command locates the pixel at the specific X and Y location of the graphical screen.

Example usage:

ST7920gLocate ( 64, 31) ‘the pixel at the mid screen point

ST7920gTile

Syntax:

ST7920gTile ( byte variable , byte variable)

Explanation:

Tile LCD screen with two bytes in Graphic Mode.

Example usage:
 ST7920gTile (0x55, 0x85) ‘tile the screen with an odd cross hatch

ST7920lineh

Syntax:

ST7920lineh ( Xpos, Ypos, xUnitsStyle, )

Explanation:

This command draws a horizontal line with the specific style. The style can be ON or OFF. Default is
ON.

This is called by the GLCD common routines.

Example usage:

ST7920lineh ( 0, 31,128 , ON) ‘will draw a line

ST7920linev

Syntax:

ST7920lineh ( Xpos, Ypos, xUnitsStyle, )

Explanation:

This command draws a vertical line with the specific style. The style can be ON or OFF. Default is ON

This is called by the GLCD common routines.

Example usage:

ST7920lineh ( 0, 31,128 , ON) ‘will draw a line

ST7920GLCDReadByte

Syntax:

byte_variable = ST7920GLCDReadByte

Explanation:
This function return the word value (16 bits) of the GLCD display for the current XY position.

This is called by the GLCD common routines.

See the data sheet for more information.

Example usage:

SET GLCD_RS OFF

ST7920WriteByte( SysCalcPositionY )
ST7920WriteByte( SysCalcPositionX )
' read data
GLCDDataTempWord = ST7920GLCDReadByte
GLCDDataTempWord = ST7920GLCDReadByte
GLCDDataTempWord = (GLCDDataTempWord*256) + ST7920GLCDReadByte

ST7920WriteByte

Syntax:

ST7920GLCDWriteByte

Explanation:

This command write to the appropriate location as specified by the current XY position.

This is called by the GLCD common routines.

See the data sheet for more information.

Example usage:

...

SET GLCD_RS OFF

ST7920WriteByte( SysCalcPositionY )
ST7920WriteByte( SysCalcPositionX )
' read data
GLCDDataTempWord = ST7920GLCDReadByte
GLCDDataTempWord = ST7920GLCDReadByte
GLCDDataTempWord = (GLCDDataTempWord*256) + ST7920GLCDReadByte
...
ST7920WriteCommand

Syntax:

ST7920GWriteCommand ( byte_variable)

Explanation:

This command writes a command to the controller.

See the data sheet for more information.

Example usage:

...
ST7920WriteCommand(0x36) ' set the graphics mode on
GLCD_TYPE_ST7920_GRAPHICS_MODE = true
...

ST7920WriteData

Syntax:

ST7920GWriteData ( byte_variable)

Explanation:

This command writes data to the controller.

See the data sheet for more information.

Example usage:

...
for yy = 0 to ( GLCD_HEIGHT - 1 )
  ST7920gLocate(0, yy)
  for xx = 0 to ( GLCD_COLS -1 )
    ST7920WriteData( 0x55 )
    T7920WriteData( 0x55 )
  next
next
...
ST7920gReaddata

Syntax:

byte_variable = ST7920gReaddata

Explanation:

This function return the word value (16 bits) of the GLCD display for the current XY position.

See the data sheet for more information.

Example usage:

...
' Read a word from the display device.
word_variable = ST7920GLCDReadData

Box

Syntax:

Box(LineX1,LineY1, LineX2, LineY2, Optional LineColour = 1)

Explanation:

Draws a box on a graphic LCD from the upper corner of X1, Y1 location to X2,Y2 location.

See also FilledBox

Circle

Circle:

 Circle(XPixelPosition, YPixelPosition, Radius [,Optional LineColour]

[,Optional Rounding])

Explanation:

Draws a circle on a graphic LCD at X, Y with a specific radius.

The constant GLCD_PROTECTOVERRUN can be added to prevent circles from re-drawing at the screen edges.
Ensure the GLCD_Width and GLCD_HEIGHT constants are set correctly when using this additional constant.
Example:

#include <glcd.h>

circle(10,10,10) ;upper left

circle(117,10,10) ;upper right
circle(63,31,10) ;center
circle(63,31,20) ;center
circle(10,53,10) ;lower left
circle(117,53,10) ;lower right

Versions of GCB prior to May 2014 does not support circle drawing. You can install
WARNING
the latest glcd.h file to enable this functionality.

FilledBox

Syntax:

FilledBox(LineX1,LineY1, LineX2, LineY2, Optional LineColour = 1)

Explanation:

Draws a filled box on a graphic LCD from the upper corner of X1, Y1 location to X2,Y2 location.

See also Box

FilledCircle

Circle:

 FilledCircle(XPixelPosition, YPixelPosition, Radius [,Optional

LineColour] )
Explanation:

Draws a circle on a graphic LCD at X, Y with a specific radius.

Example:

#include <glcd.h>

filledcircle(10,10,10) ;upper left

filledcircle(117,10,10) ;upper right
filledcircle(63,31,10) ;center
filledcircle(63,31,20) ;center
filledcircle(10,53,10) ;lower left
filledcircle(117,53,10) ;lower right

Versions of GCB prior to May 2014 does not support filled circle drawing. You can
WARNING
install the latest glcd.h file to enable this functionality.

GLCDCLS

Syntax:

GLCDCLS

Explanation:

Clears the screen of a Graphic LCD.

This command supports both the text and graphics mode of the ST7920 GLCD devices.

GLCDDrawChar

Syntax:
 GLCDDrawChar(CharLocX, CharLocY, CharCode [, Optional Colour] )

CharLocX is the X coordinate location for the character

CharLocY is the Y coordinate location for the character
CharCode is the ASCII number of the character to display. Can be decimal hex or binary.

Colour can be ON or OFF. For the ST7735 devices this an be any word value that represents the color
palette.

Explanation:

Displays an ASCII character at a specified X and Y location. On a 128x64 Graphic LCD:

X = 1 to 128
Y = 1 to 64

GLCDDrawString

Syntax:

GLCDDrawString(CharLocX, CharLocY, String [, Optional Colour] )

CharLocX is the X corrdinate location for the character

CharLocY is the Y coordinate location for the character
String is the string of characters to display
Colour can be ON or OFF. For the ST7735 devices this an be any word value that represents the color
palette

Explanation:

Displays an ASCII character at a specified X and Y location.

On a 128x64 Graphic LCD :
X = 1 to 128
Y = 1 to 64

GLCDPrint

Syntax:

GLCDPrint(PrintLocX, PrintLocY, PrintData)

PrintLocX is the X corrdinate location for the data

PrintLocY is the Y coordinate location for the data
PrintData is a String or String variable of the data to display

Explanation:

Prints string character(s) at a specified location on the GLCD screen.

On a 128x64 GLCD display :

X is typically 0 to 128
Y is typically 0 to 64

GLCDReadByte

Syntax:

byte_variable = GLCDReadByte

Explanation:

Reads a byte of data from the Graphic LCD memory

GLCDTimeDelay

Syntax:

GLCDTime

Explanation:

This will call the delay routine that delays data transmissions. By default this is set to 20, which equate
to 20 us. GLCDTimeDelay default of 20us is for 32Mhz support. The can be reduced for slower chip speeds
by change the constant ST7920WriteDelay.

Example usage:

GLCDTime 'call the delay routine

#define ST7920WriteDelay 1 'set the delay to 1 us

GLCDWriteByte

Syntax:

GLCDWriteByte (LCDByte)
Explanation:

Writes a byte of data to the Graphic LCD memory

InitGLCD

Syntax:

InitGLCD

Explanation:

This initializes the Graphical LCD for operation. Here are the steps it takes:

Example:
 'Set pin directions

Dir GLCD_RS Out

Dir GLCD_RW Out
Dir GLCD_ENABLE Out
Dir GLCD_CS1 Out
Dir GLCD_CS2 Out
Dir GLCD_RESET Out

'Reset

Set GLCD_RESET Off

Wait 1 ms
Set GLCD_RESET On
Wait 1 ms

'Select both chips

Set GLCD_CS1 On
Set GLCD_CS2 On

'Set on

Set GLCD_RS Off

GLCDWriteByte 63

'Set Z to 0

GLCDWriteByte 192

'Deselect chips

Set GLCD_CS1 Off

Set GLCD_CS2 Off

'Clear screen

GLCDCLS

Line

Syntax:

Line(LineX1,LineY1, LineX2, LineY2, Optional LineColour = 1)

Explanation:

Draws a line on a graphic LCD from X1, Y1 location to X2,Y2 location.

Example:

#include <glcd.h>

line 0,0,127,63
line 0,63,127,0
line 40,0,87,63
line 40,63,87,0

Versions of GCB prior to May 2014 only supports lines in the vertical or horizontal
WARNING
axis.

The following addition to a Great Cow Basic program will tell the compiler to use the old line drawing
routines.

#define line oldline

Pset

Syntax:

PSet(GLCDX, GLCDY, GLCDState)

Explanation:

Sets or Clears a Pixel at the specified X, Y location. A one for GLCDState sets the pixel and a zero clears
the pixel.
Liquid Crystal Display
LCD Overview

Introduction:

This section of the Help file assumes you have a release of GCBasic Feb 2015 or later.

The LCD routines in this section allow GCBASIC programs to control an alphanumeric Liquid Crystal
Displays based on the HD44780 IC. This covers most 16 x 2, 20 x 4 and similar LCD displays.

These methods allow the displays to be connected to the microcontroller in many different ways:

Connection Mode Required Connections

0 No configuration is required directly by the

methods. The LCD routines must be provided
with other subroutines which will handle the
communication. This is useful for communicating
with LCDs connected through RS232 or I2C.
This is an advanced method of driving an LCD.

2 Data and Clock lines. This mode is used when the

LCD is connected through a 74LS174 shift register
IC, as detailed at the Internet way back engine
This method of driving an LCD requires additional
integrated circuits and other passive components.
This is not recommended for the beginner.

4 R/W, RS, Enable and the highest 4 data lines (DB4

through DB7) are connected to the microprocessor.

This a common method to connect a

microprocessor to an LCD. This requires 7 data
ports on the microprocessor.

8 R/W, RS, Enable and all 8 data lines. The data lines
must all be connected to the same I/O port, in
sequential order. For example, DB0 to PORTB.0, DB1
to PORTB.1 and so on, with`DB7` going to PORTB.7.
This a common method to connect a
microprocessor to an LCD. This requires 11 data
ports on the microprocessor.

10 The LCD is controlled via I2C. A type 10 LCD 12C

adapter. Set LCD_10 to 10 for the YwRobot LCD1602
IIC V1 or the Sainsmart LCD_PIC I2C adapter
This a common method and requires two data
ports on the microprocessor.
 Connection Mode Required Connections

12 The LCD is controlled via I2C. A type 12 LCD 12C

adapter. Set LCD_10 to `12`for the Ywmjkdz I2C
adapter with pot bent over top of chip.
This a common method and requires two data
ports on the microprocessor.

See the separate sections of the Help file for the specifics of each Connection Mode.

For more help, see LCD_IO 0, LCD_IO 2 LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

LCD_IO 0

Using 0-bit mode:

To use 0-bit connection mode, a subroutine to write a byte to the LCD must be provided.

Optionally, another subroutine to read a byte from the LCD can also be given. If there is no way to read
from the LCD, then the LCD_NO_RW constant must be set.

In 0-bit mode, the LCD_RS constant will be set automatically to a spare bit variable. The higher level LCD
commands (such as Print and Locate) will set it, and the code responsible for writing to the LCD should
read it and then set the RS pin on the LCD appropriately.

Relevant Constants:

These constants are used to control settings for the Liquid Crystal Display routines included with
GCBASIC. To set them, place a line in the main program file that uses #define to assign a value to the
particular constant.

When using 2-bit mode only three constants must be set - all others can be ignored.

Constant Name Controls Value

LCD_IO The I/O mode. Must be 0 f 0

LCD_DB The data pin used in 2-bit mode. Must be set

LCD_CB The clock pin used in 2- bit Must be set

mode.

This code is an example of how to use 0-bit mode. It sends messages to another microcontroller, which
has been programmed to read the messages and toggle the pins of an LCD appropriately:
 # #define LCD_IO 0
 #define LCD_NO_RW
 #define LCDWriteByte MySendToLCD

; ----- Define Hardware settings

  [todo]

; ----- Variables
  ' No Variables specified in this example. All byte variables are defined upon use.
  [todo]

; ----- Quick Command Reference:

  [todo]

; ----- Main body of program commences here.

cls
print "Hello World."

end

; ----- Support methods. Subroutines and Functions

Sub MySendToLCD(In MyLCDByte)

    'Uses I2C
    'Sends an address byte (128)
    'Then a control byte, where bit 4 is the state of the RS pin
    'Then a data byte, which is sent to the LCD data pins.

    ControlByte = 0
    If LCD_RS = On Then ControlByte.4 = On

    I2CStart
    I2CSend 128
    I2CSend ControlByte
    I2CSend MyLCDByte
    I2CStop

    'Need to allow time for receiver of message to update LCD

    Wait 5 ms

End Sub

See the separate sections of the Help file for the specifics of each Connection Mode.
For more help, see LCD_IO 0, LCD_IO 2, LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

LCD_IO 2

Using 2-bit mode:

To use 2-bit connection mode

Data and Clock lines. This mode is used when the LCD is connected through a 74LS174 shift register IC,
as detailed at the Internet way back engine

Relevant Constants:

These constants are used to control settings for the Liquid Crystal Display routines included with
GCBASIC. To set them, place a line in the main program file that uses #define to assign a value to the
particular constant.

When using 2-bit mode only three constants must be set - all others can be ignored.

Constant Name Controls Default Value

LCD_IO The I/O mode. Can be 2, 4 or 8. 2

LCD_DB The data pin used in 2-bit mode. Must be set

LCD_CB The clock pin used in 2- bit Must be set

mode.

Example
 'LCD connection settings
#define LCD_IO 2
#define LCD_NO_RW

#define _LCD_RS PORTA.7

#define _LCD_Enable PORTA.6
#define _LCD_DB4 PORTB.4
#define _LCD_DB5 PORTB.5
#define _LCD_DB6 PORTB.6
#define _LCD_DB7 PORTB.7

CLS

Print "Hello World."

End

See for further code examples see Two Wire LCD Examples

See the separate sections of the Help file for the specifics of each Connection Mode.

For more help, see LCD_IO 0, LCD_IO 2 LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

LCD_IO 4

Using 4-bit mode:

To use 4-bit connection mode the R/W, RS, Enable and the highest 4 data lines (DB4 through DB7) must be
connect to the microprocessor.
Relevant Constants:

These constants are used to control settings for the Liquid Crystal Display routines included with
GCBASIC. To set them, place a line in the main program file that uses #define to assign a value to the
particular constant.

Constants are required for 4 8-bit mode.

Constant Name Controls Default Value

LCD_SPEED #define LCD_SPEED SLOW MEDIUM

Speed of the data transfer to the or to speed up
LCD. Can be FAST, MEDIUM or SLOW. #define LCD_SPEED FAST
The new default character rate is
20K chars per seconds. To slow
the speed down to 10K chars per
second, add the following in the
main program:

LCD_IO Must be 4 4

LCD_RS Specifies the output pin that is Must be set

connected to Register Select on
the LCD.
Constant Name Controls Default Value

LCD_RW Specifies the output pin that is Must be set (unless R/W is
connected to Read/Write on the disabled)
LCD. The R/W pin can be
disabled*.

LCD_Enable Specifies the output pin that is Must be set

connected to Read/Write on the
LCD.

LCD_DB4 Output pin used to interface Must be set

with bit 4 of the LCD data bus

LCD_DB5 Output pin used to interface Must be set

with bit 5 of the LCD data bus

LCD_DB6 Output pin used to interface Must be set

with bit 6 of the LCD data bus

LCD_DB7 Output pin used to interface Must be set

with bit 7 of the LCD data bus

LCD_LAT Drives the port with LATx Optional

support. Resolves issues with
faster Mhz and the Microchip
read/write/modify feature. See
example below.

The R/W pin can be disabled by setting the LCD_NO_RW constant. If this is done, there is no need for the R/W
to be connected to the chip, and no need for the LCD_RW constant to be set. Ensure that the R/W line on
the LCD is connected to ground if not used!

Example :
 'LCD connection settings
#define LCD_IO 4
#define LCD_NO_RW

#define _LCD_RS PORTA.7

#define _LCD_Enable PORTA.6
#define _LCD_DB4 PORTB.4
#define _LCD_DB5 PORTB.5
#define _LCD_DB6 PORTB.6
#define _LCD_DB7 PORTB.7

CLS

Print "Hello World."

End

See for further code examples see Four Wire LCD Examples

See the separate sections of the Help file for the specifics of each Connection Mode.

For more help, see LCD_IO 0, LCD_IO 2 LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

LCD_IO 8

Using 8-bit mode:

Using 8-bit connection mode will require R/W, RS, Enable and all 8 data lines.

The data lines must all be connected to the same I/O port, in sequential order. For example, DB0 to
PORTB.0, DB1 to PORTB.1 and so on, with DB7 going to PORTB.7.

Relevant Constants:

These constants are used to control settings for the Liquid Crystal Display routines included with
GCBASIC. To set them, place a line in the main program file that uses #define to assign a value to the
particular constant.

Constants are required for 8-bit mode as follows.

Constant Name Controls Default Value

LCD_SPEED Speed of the data transfer to the MEDIUM

LCD. Can be FAST, MEDIUM or SLOW.
The default character rate is 20K
chars per seconds. To slow the
speed down to 10K chars per
second, add the following in the
main program:
#define LCD_SPEED SLOW
or to speed up
#define LCD_SPEED FAST

LCD_IO The I/O mode. Can be 2, 4 or 8. 8

LCD_RS Specifies the output pin that is Must be set

connected to Register Select on
the LCD.

LCD_RW Specifies the output pin that is Must be set (unless R/W is
connected to Read/Write on the disabled)
LCD. The R/W pin can be
disabled*.

LCD_Enable Specifies the output pin that is Must be set

connected to Read/Write on the
LCD.

LCD_DATA_PORT Output port used to interface Must be set

with LCD data bus

LCD_LAT Drives the port with LATx Optional

support. Resolves issues with
faster Mhz and the Microchip
read/write/modify feature. See
example below.

The R/W pin can be disabled by setting the LCD_NO_RW constant. If this is done, there is no need for the R/W
to be connected to the chip, and no need for the LCD_RW constant to be set. Ensure that the R/W line on
the LCD is connected to ground if not used!

Example
 'LCD connection settings
#define LCD_IO 8
#define LCD_NO_RW

#define LCD_DATA_PORT PORTB

#define LCD_RS PORTA.7
#define LCD_Enable PORTA.6

CLS

Print "Hello World"

END

For further code examples see Eight Wire LCD Examples

See the separate sections of the Help file for the specifics of each Connection Mode.

For more help, see LCD_IO 0, LCD_IO 2, LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

LCD_IO 10

Using connection mode 10

The LCD is controlled via I2C. A type 10 LCD 12C adapter. Set LCD_10 to 10 for the YwRobot LCD1602
IIC V1 or the Sainsmart LCD_PIC I2C adapter To use mode 10 you must define the I2C ports as normal
in your GCB code. Then, define the LCD type, set the I2C_address of the LCD adapter and the LCD speed,
if required. Then set the backlight control, if required. As follows:
 ; ----- Define I2C settings – Change Ports. This configuration is for Software I2C.
#define I2C_MODE Master
#define I2C_DATA PORTC.4
#define I2C_CLOCK PORTC.5
#define I2C_DISABLE_INTERRUPTS ON
‘#define I2C_BIT_DELAY 0 us ;Optional
‘#define I2C_CLOCK_DELAY 1 us ;Optional
‘#define I2C_END_DELAY 0 us ;Optional

; ----- Constants

'''Set up LCD
'''Set LCD_10 to 10 for the YwRobot LCD1602 IIC V1 or the Sainsmart LCD_PIC I2C adapter

*#define LCD_IO 10 ;This is required!*

#define LCD_I2C_Address_1 0x4e ;Default = 0x4e
#define LCD_SPEED FAST ;Defaults is FAST
#define LCD_Backlight_On_State 1 ;type 10 LCD
#define LCD_Backlight_Off_State 0 ;type 10 LCD

Then, you can use all the normal LCD commands like: CLS Print Locate Cursor etc. etc.

Also see LCD_IO 10 Example

Relevant Constants:

These constants are used to control settings for the Liquid Crystal Display routines included with
GCBASIC. To set them, place a line in the main program file that uses #define to assign a value to the
particular constant.

When using 2-bit mode only three constants must be set - all others can be ignored.

Constant Name Controls Value

LCD_IO The I/O mode. Must be 10 10

LCD_I2C_Address_1 Address of I2C adapter Default 0x4E

LCD_I2C_Address_2 Address of I2C adapter Not set

LCD_I2C_Address_3 Address of I2C adapter Not set

LCD_I2C_Address_4 Address of I2C adapter Not set

See the separate sections of the Help file for the specifics of each Connection Mode.

For more help, see LCD_IO 0, LCD_IO 2, LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12
LCD_IO 10 Port Configuration

Using mode 10

When using I2C LCD mode 10 the target I2C device address is setup as shown below. Each bit of the the
variable i2c_lcd_byte is defined to address the correct LCD display port.

i2c_lcd_e = i2c_lcd_byte.2
i2c_lcd_rw = i2c_lcd_byte.1
i2c_lcd_rs = i2c_lcd_byte.0
i2c_lcd_bl = i2c_lcd_byte.3
i2c_lcd_d4 = i2c_lcd_byte.4
i2c_lcd_d5 = i2c_lcd_byte.5
i2c_lcd_d6 = i2c_lcd_byte.6
i2c_lcd_d7 = i2c_lcd_byte.7

If you have an I2C LCD display adapter with a different set of connection of the adapter then change
this configuration to suit the specific of the adapter as follows. This should be done in the your main
program code.

#define i2c_lcd_e i2c_lcd_byte.1

#define i2c_lcd_rw i2c_lcd_byte.2
#define i2c_lcd_rs i2c_lcd_byte.0
#define i2c_lcd_bl i2c_lcd_byte.3
#define i2c_lcd_d4 i2c_lcd_byte.7
#define i2c_lcd_d5 i2c_lcd_byte.6
#define i2c_lcd_d6 i2c_lcd_byte.5
#define i2c_lcd_d7 i2c_lcd_byte.4

LCD_IO 12

Using connection mode 12

The LCD is controlled via I2C. A type 12 is the Ywmjkdz I2C adapter with pot bent over top of chip. To
use mode 12 you must define the I2C ports as normal in your GCB code. Then, define the LCD type, set
the I2C_address of the LCD adapter and the LCD speed, if required. Then set the backlight control, if
required. As follows:
 ; ----- Define I2C settings – Change Ports. This configuration is for
Software I2C.
#define I2C_MODE Master
#define I2C_DATA PORTC.4
#define I2C_CLOCK PORTC.5
#define I2C_DISABLE_INTERRUPTS ON
‘#define I2C_BIT_DELAY 0 us ;Optional
‘#define I2C_CLOCK_DELAY 1 us ;Optional
‘#define I2C_END_DELAY 0 us ;Optional

; ----- Constants

'''Set up LCD
'''Set LCD_12 to for the Ywmjkdz I2C adapter with pot bent over top of chip.

#define LCD_IO 12 ;This is required!

#define LCD_I2C_Address_1 0x4e ;Default = 0x4e,try 0x27
#define LCD_SPEED FAST ;Defaults is FAST
#define LCD_Backlight_On_State 1 ;type 10 LCD
#define LCD_Backlight_Off_State 0 ;type 10 LCD

Then, you can use all the normal LCD commands like:
CLS
Print
Locate
Cursor commands etc. etc.

Relevant Constants:

These constants are used to control settings for the Liquid Crystal Display routines included with
GCBASIC. To set them, place a line in the main program file that uses #define to assign a value to the
particular constant.

When using 2-bit mode only three constants must be set - all others can be ignored.

Constant Name Controls Value

LCD_IO The I/O mode. Must be 12 12

LCD_I2C_Address_1 Address of I2C adapter Default 0x4E, try 0x27

LCD_I2C_Address_2 Address of I2C adapter Not set

LCD_I2C_Address_2 Address of I2C adapter Not set

LCD_I2C_Address_2 Address of I2C adapter Not set

See the separate sections of the Help file for the specifics of each Connection Mode.
For more help, see LCD_IO 0, LCD_IO 2, LCD_IO 4, LCD_IO 8, LCD_IO 10 or LCD_IO 12

LCD_IO 12 Port Configuration

Using mode 12

When using I2C LCD mode 12 the target I2C device address is setup as shown below. Each bit of the the
variable i2c_lcd_byte is defined to address the correct LCD display port.

i2c_lcd_e = i2c_lcd_byte.4
i2c_lcd_rw = i2c_lcd_byte.5
i2c_lcd_rs = i2c_lcd_byte.6
i2c_lcd_bl = i2c_lcd_byte.7
i2c_lcd_d4 = i2c_lcd_byte.0
i2c_lcd_d5 = i2c_lcd_byte.1
i2c_lcd_d6 = i2c_lcd_byte.2
i2c_lcd_d7 = i2c_lcd_byte.3

If you have an I2C LCD display adapter with a different set of connection of the adapter then change
this configuration to suit the specific of the adapter as follows. This should be done in the your main
program code.

#define i2c_lcd_e i2c_lcd_byte.4

#define i2c_lcd_rw i2c_lcd_byte.5
#define i2c_lcd_rs i2c_lcd_byte.6
#define i2c_lcd_bl i2c_lcd_byte.7
#define i2c_lcd_d4 i2c_lcd_byte.3
#define i2c_lcd_d5 i2c_lcd_byte.2
#define i2c_lcd_d6 i2c_lcd_byte.1
#define i2c_lcd_d7 i2c_lcd_byte.0

LCD_SPEED

Using LCD_SPEED:

To use the IO connection mode 0, a subroutine to support the LCD write operations must be provided.
The communication performance of a LCD display can be controlled via a #DEFINE. This method allow
the displays to be connected to the microcontroller and the timing to be optimised.

Example

#DEFINE LCD_SPEED FAST

Define Required Connections

LCD_SPEED Options are:

FAST - The speed is approximately 20,000 CPS.
MEDIUM - The speed is approximately 15,000 CPS.
SLOW - The speed is approximately 10,000 CPS.
If LCD_SPEED is not defined, the speed defaults to
SLOW

CLS

Syntax:

CLS

Command Availability:

Available on all microcontrollers.

Explanation:

The CLS command clears the contents of the LCD, and returns the cursor to the top left corner of the
screen

Example :

'A Flashing Hello World program for GCBASIC

'General hardware configuration

#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Main routine
Do
    Print "Hello World"
    Wait 1 sec
    CLS
    Wait 1 sec
Loop
For more help, see LCD Overview

Supported in <LCD.H>

Get

Syntax:

var = Get(Line, Column)

Command Availability:

Available on all microcontrollers with the LCD R/W line (pin 5) connected and if the following constant
definition is used; #define LCD_RW. Not available if the LCD is connected using the 0 or 2 bit mode or if
the constant definition #define LCD_NO_RW is used.

Explanation:

The Get function reads the ASCII character code at a given location on the LCD.

For more help, see Put, LCD Overview

Supported in <LCD.H>

LCDBacklight

Syntax:

LCDBacklight ( On | Off )

Command Availability:

Available on all microcontrollers

Explanation:

Sets the LCD backlight on or off

Do not connect the LCD backlight to the microprocessor! Always refer to the datasheet for the correct
method to drive the LCD backlight.

The diagram below shows a method to connect the LCD backlight to a microcomputer.
 The
diagram above was provided by William Roth, January 2015.

Supported in <LCD.H>

LCDCreateChar

Syntax:

LCDCreateChar char, chardata()

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDCreateChar command is used to send a custom character to the LCD.

Each character on the LCD is made up from an 8 row by 5 column (5x8) matrix of pixels. The data to be
sent to the LCD is composed of an 8 element array, where each element corresponds to a row. Inside
each element, the 5 lowest bits make up the data for the corresponding row. When a bit is set a dot will
be drawn at the matching location; when it is cleared, no dot will appear.

An array of more than 8 elements may be used, but only the first 8 will be read.

char is the ASCII value of the character to create. ASCII codes 0 through 7 are usually used to store
custom characters.

chardata() is an array containing the data for the character.

Example:

'This program draws a smiling face character

'General hardware configuration

#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Create an array to store the character until it is copied

Dim CharArray(8)

'Set the array to hold the character

'Binary has been used to improve the readability of the code, but is not essential
CharArray(1) = b'00011011'
CharArray(2) = b'00011011'
CharArray(3) = b'00000000'
CharArray(4) = b'00000100'
CharArray(5) = b'00000000'
CharArray(6) = b'00010001'
CharArray(7) = b'00010001'
CharArray(8) = b'00001110'

'Copy the character from the array to the LCD

LCDCreateChar 0, CharArray()

'Draw the custom character

LCDWriteChar 0

For more help, see LCDWriteChar, LCD Overview

Supported in <LCD.H>

LCDCreateGraph

Syntax:
 LCDCreateGraph value

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDCreateGraph command will create a graph like character which can then be displayed on the
LCD

Example :

;Chip Settings
#chip 16F88,8
#config osc = intrc

;Defines (Constants)
#define LCD_IO 4
#define LCD_RS PORTA.6
#define LCD_NO_RW
#define LCD_Enable PORTA.7
#define LCD_DB4 PORTB.4
#define LCD_DB5 PORTB.5
#define LCD_DB6 PORTB.6
#define LCD_DB7 PORTB.7

Locate 0,0
Print "Reset"
wait 1 s
cls

Graph_Tests:

cls
'Draw the custom character - fill the LCD
repeat 64
      LCDWriteChar 0
end Repeat

' Update the characters at high speed without re-printing on LCD

for graphvalue = 0 to 8
    LCDCreateGraph ( 0 , graphvalue )
    wait 100 ms
next
Supported in <LCD.H>

LCDCmd

Syntax:

LCDCreateGraph value

Command Availability:

Available on all microcontrollers.

Explanation:

This command set LCD specific instructions to the LCD display. As shown in the table below.

INSTRUCTION Decimal Hexadecimal

Scroll display one character 28 1E

right (all lines)

Scroll display one character left 24 18

(all lines)

Home (move cursor to top/left 2 2

character position)

Move cursor one character left 16 10

Move cursor one character right 20 14

Turn on visible underline cursor 14 0E

Turn on visible blinking-block 15 0F

cursor

Make cursor invisible 12 0C

Blank the display (without 8 08

clearing)

Restore the display (with cursor 12 0C

hidden)

Clear Screen 1 01

Set cursor position (DDRAM 128 + addr 80+ addr

address)

Set pointer in character- 64 + addr 40+ addr

generator RAM (CG RAM
address)
Example :

;Chip Settings
#chip 16F88,8
#config osc = intrc

;Defines (Constants)
#define LCD_IO 4
#define LCD_RS PORTA.6
#define LCD_NO_RW
#define LCD_Enable PORTA.7
#define LCD_DB4 PORTB.4
#define LCD_DB5 PORTB.5
#define LCD_DB6 PORTB.6
#define LCD_DB7 PORTB.7

Locate 0,0
Print "Reset"
wait 1 s
cls

LCD_Command_Tests:

locate 0,8
print "123456"
'Scroll display one character right (all lines) 28
'
lcdcmd 28
wait 1 s
lcdcmd 28
wait 1 s
lcdcmd 28
wait 1 s
lcdcmd 28
wait 1 s

'Scroll display one character left (all lines) 24

'
lcdcmd 24
wait 1 s
lcdcmd 24
wait 1 s
lcdcmd 24
wait 1 s
lcdcmd 24
wait 1 s
 'Home (move cursor to top/left character position) 2
'
lcdcursor flash
lcdcmd 2
wait 1 s

'Move cursor one character left 16

'
lcdcursor flash
locate 0,8

lcdcmd 16
wait 1 s
lcdcmd 16
wait 1 s
lcdcmd 16
wait 1 s
lcdcmd 16
wait 1 s

'Move cursor one character right 20

'
lcdcmd 20
wait 1 s
lcdcmd 20
wait 1 s
lcdcmd 20
wait 1 s
lcdcmd 20
wait 1 s

'Turn on visible underline cursor 14

'
'Turn on visible blinking-block cursor 15
'
'Make cursor invisible 12
'
'Blank the display (without clearing) 8
'
'Restore the display (with cursor hidden) 12
'
'Clear Screen 1

Supported in <LCD.H>
LCDCursor

Syntax:

LCDCursor value

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDCursor command will accept the following:

LCDON, LCDOFF, CURSORON, CURSOROFF, FLASHON, FLASHOFF

FLASH, and ON/OFF have been retained for backward compatibility with older releases of GCB)

LCDON will turn on (restore) the LCD display.

LCDOFF will turn off (hide) the LCD display.
CURSORON will turn on the cursor.
CURSOROFF will turn off the cursor.
FLASHON will flash the cursor.
FLASHOFF will stop flashing the cursor.

Example :
#config osc = intrc

;Defines (Constants)
#define LCD_IO 4
#define LCD_RS PORTA.6
#define LCD_NO_RW
#define LCD_Enable PORTA.7
#define LCD_DB4 PORTB.4
#define LCD_DB5 PORTB.5
#define LCD_DB6 PORTB.6
#define LCD_DB7 PORTB.7

Start:
CLS
WAIT 3 s
PRINT "START DEMO"
locate 1,0
PRINT "DISPLAY ON"
wait 3 s

CLS
Locate 0,0
Print "Cursor ON"
Locate 1,0
LCDcursor CursorOn
wait 3 S

CLS
LCDcursor CursorOFF
locate 0,0
Print "Cursor OFF"
wait 3 s

CLS
Locate 0,0
Print "FLASH ON"
Locate 1,0
LCDcursor FLASHON
wait 3 s

CLS
locate 0,0
Print "FLASH OFF"
LCDCURSOR FLASHOFF
wait 3 sec

Locate 0,0
Print "CURSOR&FLASH ON" 'Both are on at the same time
locate 1,0
LCDCURSOR CURSORON
LCDCURSOR FLASHON
Wait 3 sec

Locate 0,0
Print "CURSOR FLASH OFF"
locate 1,0
LCDCURSOR CursorOFF
LCDCURSOR FLASHOFF
Wait 3 sec

CLS
Locate 0,4
PRINT "Flashing"
Locate 1,4
Print "Display"
wait 500 ms
 repeat 5
    LCDCURSOR LCDOFF
    wait 500 ms
    LCDCURSOR LCDON
    wait 500 ms
end repeat

CLS
Locate 0,0
Print "DISPLAY OFF"
Locate 1,0
Print "FOR 5 SEC"
Wait 2 SEC
LCDCURSOR LCDOFF
WAIT 5 s

CLS
Locate 0,0
LCDCURSOR LCDON
Print "END DEMO"
wait 3 s
goto start

Supported in <LCD.H>

LCDHex

Syntax:

LCDHex value

LCDHex value, LeadingZeroActive

Where value is a byte value from 0 to 255. Where LeadingZeroActive is a constant or byte value of 2.

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDHex will display the byte value as a 1 or 2 character HEX string.

Example :
;Set chip model required:
  #chip mega328p, 16
  ;Setup LCD Parameters
  #define LCD_IO 4
  #define LCD_NO_RW
  #define LCD_Speed MEDIUM 'FAST IS OK ON ARDUINO UNO R3

  'Change as necessary
  #define LCD_RS PortC.0
  #define LCD_Enable PortC.1
  #define LCD_DB4 PortC.2
  #define LCD_DB5 PortC.3
  #define LCD_DB6 PortC.4
  #define LCD_DB7 PortC.5

' #chip 16f877a, 8

' ;Setup LCD Parameters
' #define LCD_IO 4
' #define LCD_NO_RW
' #define LCD_Speed fast 'FAST IS OK ON 16f877a
'
' ;Change as necessary
' #define LCD_RS PortB.2
' #define LCD_Enable PortB.3
' #define LCD_DB4 PortB.4
' #define LCD_DB5 PortB.5
' #define LCD_DB6 PortB.6
' #define LCD_DB7 PortB.7

'Program Start
DO Forever
     CLS
     WAIT 2 s
     PRINT "Test LCDHex "
     wait 3 s
     CLS
     wait 1 s

     for bv = 0 to 255
        locate 0,0
        Print "DEC " : Print BV
        locate 1,0
        Print "HEX "
        LCDHex BV, LeadingZeroActive ; dislay leading Zero
      ' LCDHex BV ; do not display leading zero
        wait 1 s
     next
     CLS
      wait 1 s
     Print "END TEST"
LOOP

Supported in <LCD.H> after Jan 2014 release

LCDHome

Syntax:

LCDHome

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDHome command will return the cursor to home position. The current contents of the LCD screen
will be retained.

Example:
 ;Chip Settings
#chip 16F88,8
#config osc = intrc

;Defines (Constants)
#define LCD_IO 4
#define LCD_RS PORTA.6
#define LCD_NO_RW
#define LCD_Enable PORTA.7
#define LCD_DB4 PORTB.4
#define LCD_DB5 PORTB.5
#define LCD_DB6 PORTB.6
#define LCD_DB7 PORTB.7

Locate 0,0
Print "Reset"
wait 1 s
ClS

Cursor_Home_Tests:

cls
lcdcursor flash
print "Test Home Cmd"
LCDHome
wait 3 s

Supported in <LCD.H>

LCDDisplayOn

Explanationv:

Will turn on (restore) the LCD display

See also LCDCursor

Supported in <LCD.H>

LCDDisplayOff

Explanation:

Will turn off (hide) the LCD display.

See also LCDCursor

Supported in <LCD.H>

LCDSpace

Syntax:

LCDSpace value

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDSpace command will print the required number of spaces on the LCD display

Example :

;Chip Settings
#chip 16F88,8
#config osc = intrc

;Defines (Constants)
#define LCD_IO 4
#define LCD_RS PORTA.6
#define LCD_NO_RW
#define LCD_Enable PORTA.7
#define LCD_DB4 PORTB.4
#define LCD_DB5 PORTB.5
#define LCD_DB6 PORTB.6
#define LCD_DB7 PORTB.7

Locate 0,0
Print "Reset"
wait 1 s
cls

LCD_Space_Tests:

lcdcursor flash

lcdspace 12

print "*"

Supported in <LCD.H>
LCDWriteChar

Syntax:

LCDWriteChar char

Command Availability:

Available on all microcontrollers.

Explanation:

The LCDWriteChar command will show the specified character on the LCD, at the current cursor
position.

char is the ASCII value of the character to show. On most LCDs, characters 0 through 7 are user defined,
and can be set using the LCDCreateChar command.

Example :
 'This program draws a smiling face character

'General hardware configuration

#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Create an array to store the character until it is copied

Dim CharArray(8)

'Set the array to hold the character

CharArray(1) = b'00011011'
CharArray(2) = b'00011011'
CharArray(3) = b'00000000'
CharArray(4) = b'00000100'
CharArray(5) = b'00000000'
CharArray(6) = b'00010001'
CharArray(7) = b'00010001'
CharArray(8) = b'00001110'

'Copy the character from the array to the LCD

LCDCreateChar 0, CharArray()

'Draw the custom character

LCDWriteChar 0

For more help, see LCDCreateChar, LCD Overview

Supported in <LCD.H>

Locate

Syntax:

Locate line, column

Command Availability:

Available on all microcontrollers.

Explanation:

The Locate command is used to move the cursor on the LCD to the given location.

Example :

'A Hello World program for GCBASIC.

'Uses Locate to show "World" on the second line

'General hardware configuration

#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Main routine
Print "Hello"
Locate 1, 5
Print "World"

For more help, see LCD Overview

Supported in <LCD.H>

Print

Syntax:

Print string
Print byte
Print word
Print long
Print integer

Command Availability:

Available on all microcontrollers.

Explanation:

The Print command will show the contents of a variable on the LCD. It can display string, word, byte,
long or integer variables.
Example:

'A Light Meter program.

'General hardware configuration

#chip 16F877A, 20
#define LightSensor AN0

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

CLS
Print "Light Meter"
Locate 1,2
Print "A GCBASIC Demo"
Wait 2 s

Do
    CLS
    Print "Light Level: "
    Print ReadAD(LightSensor)
    Wait 250 ms
Loop

For more help, see LCD Overview

Supported in <LCD.H>

Put

Syntax:

Put Line, Column, Character

Command Availability:

Available on all microcontrollers.

Explanation:

The Put command writes the given ASCII character code to the location on the LCD.
Example :

'A scrolling star for GCBASIC

'Misc Settings
#define SCROLL_DELAY 250 ms

'General hardware configuration

#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Main routine
For StarPos = 0 To 16
    If StarPos = 0 Then
        Put 0, 16, 32
        Put 0, 0, 42
    Else
        Put 0, StarPos - 1, 32
        Put 0, StarPos, 42
    End If
    Wait SCROLL_DELAY
Next

For more help, see LCD Overview

Supported in <LCD.H>

Examples

Two Wire LCD Example

;Two-Line Serial Driver and Demonstration of LCD Features

;for the 16F877A (Great Cow Basic source).
;This Revision: 4/10/2014 - removed hard coded dependencies and fixed as needed to remove
manual intervention
;Based on works by Thomas Henry & revised Evan R. Venn
;Note: a 2 by 16 LCD is assumed.

#chip 16F877A,20
#define LCD_IO 2
#define LCD_DB portb.2
#define LCD_CB portb.0
#define LCD_NO_RW
            ;Here are various LCD commands which can be used.
            ;These are the LCD commands for the HD44780 controller

#define clrHome = 1 ;clear the display, home the cursor

#define home = 2 ;home the cursor only
#define RtoL = 4 ;print characters right to left
#define insR = 5 ;insert characters to right
#define LtoR = 6 ;print characters left to right
#define insL = 7 ;insert characters to left
#define lcdOff = 8 ;LCD screen off
#define lcdOn = 12 ;LCD screen on, no cursor
#define curOff = 12 ;an alias for the above
#define block = 13 ;LCD screen on, block cursor
#define under = 14 ;LCD screen on, underline cursor
#define undblk = 15 ;LCD screen on, blinking and underline cursor
#define CLeft = 16 ;cursor left
#define CRight = 20 ;cursor right
#define panR = 24 ;pan viewing window right
#define panL = 28 ;pan viewing window left
#define bus4 = 32 ;4-bit data bus mode
#define bus8 = 48 ;8-bit data bus mode
#define mode1 = 32 ;one-line mode (alias)
#define mode2 = 40 ;two-line mode
#define line1 = 128 ;go to start of line 1
#define line2 = 192 ;go to start of line 2
;----- Variables
dim char, msn, lsn, index, ii as byte
;----- Main Program
LoadEeprom ;load the EEprom with strings

do forever
            printMsg(0) ;print first message
            wait 3 S ;pause 3 seconds
            printMsg(2) ;print next message
            wait 3 S ;pause 3 seconds
            repeat 5 ;blink it five times
              LCDCmd(lcdOff) ;display off
              wait 500 mS ;pause
              LCDCmd(lcdOn) ;display on
              wait 500 mS ;pause
            end repeat
            wait 1 S ;pause before next demo
            ;demonstrate panning
            printMsg(4) ;print next message
            wait 3 S ;pause 3 seconds
            repeat 16
              LCDCmd(panL) ;pan left a step at a time
              wait 300 mS ;slow down to avoid blur
            end repeat
            repeat 16
              LCDCmd(panR) ;then pan right
              wait 300 mS
            end repeat
            wait 1 S ;pause before next demo
                                    ;demonstrate moving the cursor
            printMsg(6) ;print next message
            wait 3 S ;pause 3 seconds
            doHome ;home cursor
            LCDCmd(under) ;choose underline cursor
            for ii = 0 to 15 ;move cursor across first line
              LCDCmd(line1+i)
              wait 200 mS
            next i
            for ii = 0 to 15 ;move cursor across second line
              LCDCmd(line2+i)
              wait 200 mS
            next i
            for ii = 15 to 0 step -1 ;move cursor back over second line
              LCDCmd(line2+i)
              wait 200 mS
            next i
            for ii = 15 to 0 step -1 ;move cursor back over first line
              LCDCmd(line1+i)
              wait 200 mS
            next i
            wait 3 S
            ;demonstrate blinking block cursor
            printMsg(8) ;print next message
            doHome ;home the cursor
            LCDCmd(block) ;choose blinking block cursor
            wait 4 S ;pause 4 seconds
            LCDCmd(mode1) ;change to one long line mode
            doHome ;home the cursor again
            LCDCmd(curOff) ;and disable it

            ;demonstrate scrolling a lengthy one-line marquee

            for ii = 0xd0 to 0xff ;print next message - the remaining EEPROM
              EPread ii, char ;fetch directly from eeprom
              print chr(char)
            next i
            wait 1 S
            doHome ;home cursor once more
            repeat 141 ;scroll message twice
              LCDCmd(panR)
              wait 250 mS
            end repeat
            wait 2 S
            LCDCmd(mode2) ;change back to two line mode
            doClr ;clear the screen
            ;demonstrate all of the characters
            printMsg(11) ;print next message
            for ii = 33 to 127 ;print first batch of ASCII characters
              LCDCmd(line1+12) ;overwrite each character displayed
              print chr(ii) ;this is the ASCII code
              wait 500 mS
            next i
            for ii = 161 to 255 ;print next batch of ASCII characters
              LCDCmd(line1+12)
              print chr(ii)
              wait 500 mS
            next i
            ;say good-bye
            LCDCmd(line2)
            printMsg(11) ;print next message
            doHome ;home the cursor
loop

            end

            ;----- Clear the screen

            sub doClr
              LCDCmd(clrHome)
              wait 5 mS ;this command takes extra time
            end sub
            ;----- Home the cursor
            sub doHome
              LCDCmd(home)
              wait 5 mS ;and so does this one
            end sub
            ;----- Print a message to the LCD
            ;The parameter 'row' points to the start of the string.
            sub printMsg(in row as byte, in Optional StringLength As Byte = 15)
              LCDCmd(line1) ;get set for first line

              for ii = 0 to StringLength
                index = row*16+ii
                EPread index, char ;fetch next character and
                print chr(char) ;transmit to the LCD
              next
               LCDCmd(line2) ;get set for second line
              for ii = 0 to StringLength
                index = (row+1)*16+ii
                EPread index, char ;fetch next character and
                print chr(char) ;transmit to the LCD
              next
            end sub

            sub loadEeprom

            ' Strings for EEPROM, Strings should be limited to 16 characters for the
first 13 sstrings, then a long string to fill eeprom
            location = 0
            WriteEeprom "First we'll show"
            WriteEeprom "this message. "
            WriteEeprom "Then we'll blink"
            WriteEeprom "five times. "
            WriteEeprom "Now lets pan "
            WriteEeprom "left and right. "
            WriteEeprom "Watch the line "
            WriteEeprom "cursor move. "
            WriteEeprom "A block cursor "
            WriteEeprom "is available. "
            WriteEeprom "Characters: "
            WriteEeprom "Bye! "
            WriteEeprom "in one line mode"
            WriteEeprom "Next well scroll this long message as a marquee"

            end sub

            ; Write to the device eeprom

            sub WriteEeprom ( in Estring() ) as string * 64

                for ee = 1 to len ( Estring )

                    HSersend Estring(ee)
                    epwrite location, Estring(ee)
                    location++
                next

            end sub

Four Wire LCD Example

;Two-Line Serial Driver and Demonstration of LCD Features

;for the 16F877A (Great Cow Basic source).
;This Revision: 4/10/2014 - removed hard coded dependencies and fixed as needed to remove
manual intervention
;Based on works by Thomas Henry & revised Evan R. Venn
;Note: a 2 by 16 LCD is assumed.

#chip 16F877A,20

'Use LCD in 4 pin mode and define LCD pins

#define LCD_IO 4
#define LCD_RW PORTE.1
#define LCD_RS PORTE.0
#define LCD_Enable PORTE.2
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7

            ;Here are various LCD commands which can be used.

            ;These are the LCD commands for the HD44780 controller
            #define clrHome = 1 ;clear the display, home the cursor
            #define home = 2 ;home the cursor only
            #define RtoL = 4 ;print characters right to left
            #define insR = 5 ;insert characters to right
            #define LtoR = 6 ;print characters left to right
            #define insL = 7 ;insert characters to left
            #define lcdOff = 8 ;LCD screen off
            #define lcdOn = 12 ;LCD screen on, no cursor
            #define curOff = 12 ;an alias for the above
            #define block = 13 ;LCD screen on, block cursor
            #define under = 14 ;LCD screen on, underline cursor
            #define undblk = 15 ;LCD screen on, blinking and underline cursor
            #define CLeft = 16 ;cursor left
            #define CRight = 20 ;cursor right
            #define panR = 24 ;pan viewing window right
            #define panL = 28 ;pan viewing window left
            #define bus4 = 32 ;4-bit data bus mode
            #define bus8 = 48 ;8-bit data bus mode
            #define mode1 = 32 ;one-line mode (alias)
            #define mode2 = 40 ;two-line mode
            #define line1 = 128 ;go to start of line 1
            #define line2 = 192 ;go to start of line 2
            ;----- Variables
            dim char, msn, lsn, index, ii as byte
            ;----- Main Program
            LoadEeprom ;load the EEprom with strings

do forever
            printMsg(0) ;print first message
            wait 3 S ;pause 3 seconds
            printMsg(2) ;print next message
            wait 3 S ;pause 3 seconds
            repeat 5 ;blink it five times
              LCDCmd(lcdOff) ;display off
              wait 500 mS ;pause
              LCDCmd(lcdOn) ;display on
              wait 500 mS ;pause
            end repeat
            wait 1 S ;pause before next demo
            ;demonstrate panning
            printMsg(4) ;print next message
            wait 3 S ;pause 3 seconds
            repeat 16
              LCDCmd(panL) ;pan left a step at a time
              wait 300 mS ;slow down to avoid blur
            end repeat
            repeat 16
              LCDCmd(panR) ;then pan right
              wait 300 mS
            end repeat
            wait 1 S ;pause before next demo
                                    ;demonstrate moving the cursor
            printMsg(6) ;print next message
            wait 3 S ;pause 3 seconds
            doHome ;home cursor
            LCDCmd(under) ;choose underline cursor
            for ii = 0 to 15 ;move cursor across first line
              LCDCmd(line1+i)
              wait 200 mS
            next i
            for ii = 0 to 15 ;move cursor across second line
              LCDCmd(line2+i)
              wait 200 mS
            next i
            for ii = 15 to 0 step -1 ;move cursor back over second line
              LCDCmd(line2+i)
              wait 200 mS
            next i
            for ii = 15 to 0 step -1 ;move cursor back over first line
              LCDCmd(line1+i)
              wait 200 mS
            next i
            wait 3 S
            ;demonstrate blinking block cursor
            printMsg(8) ;print next message
            doHome ;home the cursor
            LCDCmd(block) ;choose blinking block cursor
            wait 4 S ;pause 4 seconds
            LCDCmd(mode1) ;change to one long line mode
            doHome ;home the cursor again
            LCDCmd(curOff) ;and disable it

            ;demonstrate scrolling a lengthy one-line marquee

            for ii = 0xd0 to 0xff ;print next message - the remaining EEPROM
              EPread ii, char ;fetch directly from eeprom
              print chr(char)
            next i
            wait 1 S
            doHome ;home cursor once more
            repeat 141 ;scroll message twice
              LCDCmd(panR)
              wait 250 mS
            end repeat
            wait 2 S
            LCDCmd(mode2) ;change back to two line mode
            doClr ;clear the screen
            ;demonstrate all of the characters
            printMsg(11) ;print next message
            for ii = 33 to 127 ;print first batch of ASCII characters
              LCDCmd(line1+12) ;overwrite each character displayed
              print chr(ii) ;this is the ASCII code
              wait 500 mS
            next i
            for ii = 161 to 255 ;print next batch of ASCII characters
              LCDCmd(line1+12)
              print chr(ii)
              wait 500 mS
            next i
            ;say good-bye
            LCDCmd(line2)
            printMsg(11) ;print next message
            doHome ;home the cursor
loop

            end

            ;----- Clear the screen

            sub doClr
              LCDCmd(clrHome)
              wait 5 mS ;this command takes extra time
            end sub
            ;----- Home the cursor
            sub doHome
              LCDCmd(home)
              wait 5 mS ;and so does this one
            end sub
            ;----- Print a message to the LCD
            ;The parameter 'row' points to the start of the string.
            sub printMsg(in row as byte, in Optional StringLength As Byte = 15)
              LCDCmd(line1) ;get set for first line

              for ii = 0 to StringLength
                index = row*16+ii
                EPread index, char ;fetch next character and
                print chr(char) ;transmit to the LCD
              next
              LCDCmd(line2) ;get set for second line
              for ii = 0 to StringLength
                index = (row+1)*16+ii
                EPread index, char ;fetch next character and
                print chr(char) ;transmit to the LCD
              next
            end sub

            sub loadEeprom

            ' Strings for EEPROM, Strings should be limited to 16 characters for the
first 13 sstrings, then a long string to fill eeprom
            location = 0
            WriteEeprom "First we'll show"
            WriteEeprom "this message. "
            WriteEeprom "Then we'll blink"
            WriteEeprom "five times. "
            WriteEeprom "Now lets pan "
            WriteEeprom "left and right. "
            WriteEeprom "Watch the line "
            WriteEeprom "cursor move. "
            WriteEeprom "A block cursor "
            WriteEeprom "is available. "
            WriteEeprom "Characters: "
            WriteEeprom "Bye! "
            WriteEeprom "in one line mode"
            WriteEeprom "Next well scroll this long message as a marquee"

            end sub

            ; Write to the device eeprom

            sub WriteEeprom ( in Estring() ) as string * 64
                 for ee = 1 to len ( Estring )
                    HSersend Estring(ee)
                    epwrite location, Estring(ee)
                    location++
                next

            end sub

Eight Wire LCD Example

;Two-Line Serial Driver and Demonstration of LCD Features

;for the 16F877A (Great Cow Basic source).
;This Revision: 4/10/2014 - removed hard coded dependencies and fixed as needed to remove
manual intervention
;Based on works by Thomas Henry & revised Evan R. Venn
;Note: a 2 by 16 LCD is assumed.

#chip 16F877A,20

'Use LCD in 8 pin mode and define LCD pins

#define LCD_IO 8
#define LCD_RW PORTE.1
#define LCD_RS PORTE.0
#define LCD_Enable PORTE.2
#define LCD_Data_Port PORTD

            ;Here are various LCD commands which can be used.

            ;These are the LCD commands for the HD44780 controller
            #define clrHome = 1 ;clear the display, home the cursor
            #define home = 2 ;home the cursor only
            #define RtoL = 4 ;print characters right to left
            #define insR = 5 ;insert characters to right
            #define LtoR = 6 ;print characters left to right
            #define insL = 7 ;insert characters to left
            #define lcdOff = 8 ;LCD screen off
            #define lcdOn = 12 ;LCD screen on, no cursor
            #define curOff = 12 ;an alias for the above
            #define block = 13 ;LCD screen on, block cursor
            #define under = 14 ;LCD screen on, underline cursor
            #define undblk = 15 ;LCD screen on, blinking and underline cursor
            #define CLeft = 16 ;cursor left
            #define CRight = 20 ;cursor right
            #define panR = 24 ;pan viewing window right
            #define panL = 28 ;pan viewing window left
            #define bus4 = 32 ;4-bit data bus mode
            #define bus8 = 48 ;8-bit data bus mode
            #define mode1 = 32 ;one-line mode (alias)
            #define mode2 = 40 ;two-line mode
            #define line1 = 128 ;go to start of line 1
            #define line2 = 192 ;go to start of line 2
            ;----- Variables
            dim char, msn, lsn, index, ii as byte
            ;----- Main Program
            LoadEeprom ;load the EEprom with strings

do forever
            printMsg(0) ;print first message
            wait 3 S ;pause 3 seconds
            printMsg(2) ;print next message
            wait 3 S ;pause 3 seconds
            repeat 5 ;blink it five times
              LCDCmd(lcdOff) ;display off
              wait 500 mS ;pause
              LCDCmd(lcdOn) ;display on
              wait 500 mS ;pause
            end repeat
            wait 1 S ;pause before next demo
            ;demonstrate panning
            printMsg(4) ;print next message
            wait 3 S ;pause 3 seconds
            repeat 16
              LCDCmd(panL) ;pan left a step at a time
              wait 300 mS ;slow down to avoid blur
            end repeat
            repeat 16
              LCDCmd(panR) ;then pan right
              wait 300 mS
            end repeat
            wait 1 S ;pause before next demo
                                    ;demonstrate moving the cursor
            printMsg(6) ;print next message
            wait 3 S ;pause 3 seconds
            doHome ;home cursor
            LCDCmd(under) ;choose underline cursor
            for ii = 0 to 15 ;move cursor across first line
              LCDCmd(line1+i)
              wait 200 mS
            next i
            for ii = 0 to 15 ;move cursor across second line
              LCDCmd(line2+i)
              wait 200 mS
            next i
            for ii = 15 to 0 step -1 ;move cursor back over second line
              LCDCmd(line2+i)
              wait 200 mS
            next i
            for ii = 15 to 0 step -1 ;move cursor back over first line
              LCDCmd(line1+i)
              wait 200 mS
            next i
            wait 3 S
            ;demonstrate blinking block cursor
            printMsg(8) ;print next message
            doHome ;home the cursor
            LCDCmd(block) ;choose blinking block cursor
            wait 4 S ;pause 4 seconds
            LCDCmd(mode1) ;change to one long line mode
            doHome ;home the cursor again
            LCDCmd(curOff) ;and disable it

            ;demonstrate scrolling a lengthy one-line marquee

            for ii = 0xd0 to 0xff ;print next message - the remaining EEPROM
              EPread ii, char ;fetch directly from eeprom
              print chr(char)
            next i
            wait 1 S
            doHome ;home cursor once more
            repeat 141 ;scroll message twice
              LCDCmd(panR)
              wait 250 mS
            end repeat
            wait 2 S
            LCDCmd(mode2) ;change back to two line mode
            doClr ;clear the screen
            ;demonstrate all of the characters
            printMsg(11) ;print next message
            for ii = 33 to 127 ;print first batch of ASCII characters
              LCDCmd(line1+12) ;overwrite each character displayed
              print chr(ii) ;this is the ASCII code
              wait 500 mS
            next i
            for ii = 161 to 255 ;print next batch of ASCII characters
              LCDCmd(line1+12)
              print chr(ii)
              wait 500 mS
            next i
            ;say good-bye
            LCDCmd(line2)
            printMsg(11) ;print next message
            doHome ;home the cursor
loop

            end

            ;----- Clear the screen

            sub doClr
              LCDCmd(clrHome)
              wait 5 mS ;this command takes extra time
            end sub
            ;----- Home the cursor
            sub doHome
              LCDCmd(home)
              wait 5 mS ;and so does this one
            end sub
            ;----- Print a message to the LCD
            ;The parameter 'row' points to the start of the string.
            sub printMsg(in row as byte, in Optional StringLength As Byte = 15)
              LCDCmd(line1) ;get set for first line

              for ii = 0 to StringLength
                index = row*16+ii
                EPread index, char ;fetch next character and
                print chr(char) ;transmit to the LCD
              next
              LCDCmd(line2) ;get set for second line
              for ii = 0 to StringLength
                index = (row+1)*16+ii
                EPread index, char ;fetch next character and
                print chr(char) ;transmit to the LCD
              next
            end sub

            sub loadEeprom

            ' Strings for EEPROM, Strings should be limited to 16 characters for the
first 13 sstrings, then a long string to fill eeprom
            location = 0
            WriteEeprom "First we'll show"
            WriteEeprom "this message. "
            WriteEeprom "Then we'll blink"
            WriteEeprom "five times. "
            WriteEeprom "Now lets pan "
            WriteEeprom "left and right. "
             WriteEeprom "Watch the line "
            WriteEeprom "cursor move. "
            WriteEeprom "A block cursor "
            WriteEeprom "is available. "
            WriteEeprom "Characters: "
            WriteEeprom "Bye! "
            WriteEeprom "in one line mode"
            WriteEeprom "Next well scroll this long message as a marquee"

            end sub

            ; Write to the device eeprom

            sub WriteEeprom ( in Estring() ) as string * 64

                for ee = 1 to len ( Estring )

                    HSersend Estring(ee)
                    epwrite location, Estring(ee)
                    location++
                next

            end sub

LCD_IO 10 Example

; FILE: Temperature Sensor to Software I2C Multiple LCDs - mega328p.gcb

; DATE: 20.02.15
; VERSION: 1.0a
; AUTHOR: Anobium
;
; Description.
' This demonstration shows an LCD being driven using an LCD I2C adapter.
' Two types are supported as shown below:
' Set LCD_I0 to 10 for the YwRobot LCD1602 IIC V1 or the Sainsmart LCD_PIC I2C adapter
' Set LCD_I0 to 12 for the Ywmjkdz I2C adapter with pot bent over top of chip

; This file is part of the Great Cow Basic compiler.

;
; This demonstration code is distributed in the hope that it will be useful,
; but WITHOUT ANY WARRANTY; without even the implied warranty of
; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
; GNU General Public License for more details.
;
; ----- Configuration
  #chip mega328p, 16
  #include <DS18B20.h>

  ; ----- Define Hardware settings

  ' Define I2C settings - CHANGE PORTS
   #define I2C_MODE Master
   #define I2C_DATA PORTC.4
   #define I2C_CLOCK PORTC.5
   #define I2C_DISABLE_INTERRUPTS ON

  '''Set up LCD
   #define LCD_IO 10
   #define LCD_I2C_Address_1 0x4E ; LCD 1
   #define LCD_I2C_Address_2 0x4C ; LCD 2

; ----- Constants
  ' DS18B20 port settings - this is required
     #define DQ PortC.3

; ----- Quick Command Reference:

'''Set LCD_10 to 10 for the YwRobot LCD1602 IIC V1 or the Sainsmart LCD_PIC I2C adapter
'''Set LCD_10 to 12 for the Ywmjkdz I2C adapter with pot bent over top of chip

; ----- Variables
  dim TempC_100 as word ' a variabler to handle the temperature calculations
  dim DSdataRaw as Integer

; ----- Main body of program commences here.

    'Change to the correct LCD by setting LCD_I2C_Address_Current to the correct

address then write to LCD.
    LCD_I2C_Address_Current = LCD_I2C_Address_1: DisplayInformation ( 1 )
    LCD_I2C_Address_Current = LCD_I2C_Address_2: DisplayInformation ( 1 )
    wait 4 s
    LCD_I2C_Address_Current = LCD_I2C_Address_1: CLS
    LCD_I2C_Address_Current = LCD_I2C_Address_2: CLS

    ccount = 0
    Do forever

        ' The function readtemp12 returns the raw value of the sensor.
        ' The sensor is read as a 12 bit value therefore each unit equates to 0.0625 of a
degree
        DSdataRaw = readtemp12 ; save to this variable to prevent the delay bewtween
screen up dates
        ' The function readtemp returns the integer value of the sensor
        DSdata = readtemp

        LCD_I2C_Address_Current = LCD_I2C_Address_1: DisplayInformation ( 2 ) ; update

LCD1
        LCD_I2C_Address_Current = LCD_I2C_Address_2: DisplayInformation ( 2 ) ; update
LCD2
        DSdata = DSdataRaw ; Set the data
        LCD_I2C_Address_Current = LCD_I2C_Address_1: DisplayInformation ( 3 ) ; update
LCD1
        DSdata= DSdataRaw ; Set the data
        LCD_I2C_Address_Current = LCD_I2C_Address_2: DisplayInformation ( 3 ) ; update
LCD2

        ccount++

        wait 1 s

    loop
    End

Sub DisplayInformation ( LCDCommand )

    Select case LCDCommand

    Case 1
      CLS
      print "GCBasic 2015"
      locate 1,0
      print "DS18B20 Demo"

    Case 2
       ' Display the integer value of the sensor on the LCD
       locate 0,0
       print hex(ccount)
       print " Ceil"
       locate 0,8
       print DSdata
       print chr(223)+"C"+" "

     Case 3

       ' Display the integer and decimal value of the sensor on the LCD

       SignBit = DSdata / 256 / 128

       If SignBit = 0 Then goto Positive
       ' its negative!
       DSdata = ( DSdata # 0xffff ) + 1 ' take twos comp
     Positive:

       ' Convert value * 0.0625. Mulitple value by 6 then add result to multiplication of
the value with 25 then divide result by 100.
       TempC_100 = DSdata * 6
       DSdata = ( DSdata * 25 ) / 100
       TempC_100 = TempC_100 + DSdata

       Whole = TempC_100 / 100

       Fract = TempC_100 % 100
       If SignBit = 0 Then goto DisplayTemp
       Print "-"

    DisplayTemp:
       locate 1,0
       print hex(ccount)
       print " Real"
       locate 1,8
       print str(Whole)
       print "."
      ' To ensure the decimal part is two digits
       Dig = Fract / 10
       print Dig
       Dig = Fract % 10
       print Dig
       print chr(223)
       print "C"+" "

    End Select

end sub

Pulse with modulation

PWM Overview

Introduction:

The routines described in this chapter allow the generation of Pulse Width Modulation signals. These
allow for the microcontroller to control the speed of a motor, or the brightness of a light. The routines
can also be used to generate the appropriate frequency signal to drive an infrared LED for remote
control applications.

The PWMOn, PWMOff and HPWM routines use the PWM generation module on the microcontroller. They will
only work on some microcontrollers - see the article on each command for details. PWMOn and HPWM will
cause the PWM module on the microcontroller to start generating the PWM signal, which will then
continue to be generated until the PWMOff instruction is run.

PWMOut does not make use of any special hardware. However, a signal is only generated while the
PWMOut command is running - when the program moves on to the next command, the signal will stop.

Relevant Constants:

These constants are used to control settings for the Pulse Width Modulation module of the PIC chip. To
set them, place a line in the main program file that uses #define to assign a value to the particular
constant.

Note that there are two sets of constants: one for Hardware PWM, and one for Software PWM.
Hardware PWM requires a CCP module on the PIC chip - Software PWM has no requirements
regarding the PIC.

Hardware PWM

These constants are only required for PWMOn. HPWM and PWMOff do not require any constants to
operate.

Constant Name Controls Default Value

PWM_Freq Specifies the output frequency of 38

the PWM module in KHz.

PWM_Duty Sets the duty cycle of the PWM 50

module output. Given as
percentage.

Hardware PWM is only available through the "CCP1" or "CCP" pin. This is a hardware limitation of PIC
microcontrollers.

Software PWM

Constant Name Controls Default Value

PWM_Delay The PWM Period. The length of Not defined - no delay

any delay used will be
multiplied by 255. If no value is
specified, no delays will be
inserted into the PWM routine.

PWM_Out n The port physical port on the PIC Not Defined

that corresponds to channel n.
n can represent 1, 2, 3 or 4.

More than 4 channels are possible, but for this the PWMOut routine in include\lowlevel\stdbasic.h must
be altered.
PWMOut

Syntax:

PWMOut channel, duty cycle, cycles

Command Availability:

Available on all microcontrollers.

Explanation :

This command uses a software PWM routine included in GCBASIC to produce a PWM signal on the
selected port of the chip. This routine does NOT require a PWM module on the chip.

channel sets the channel that the PWM is to be generated on. This must have been defined previously
by setting the constants PWM_Out1, PWM_Out2, PWM_Out3 or PWM_Out4. The maximum number of channels
available is 4.

duty cycle specifies the PWM duty cycle, and ranges from 0 to 255. 255 corresponds to 100%, 127 to
50%, 63 to 25%, and so on.

cycles is used to set the amount of PWM pulses to supply. This is useful for situations in which a pulse
of a specific length is required. The formula for calculating the time taken for one cycle is:

TCYCLE = (28 + 10C)TOSC+ 255PWM_Delay,

where C is the number of channels used and TOSC is the length of time taken to execute 1 instruction on
the chip (0.2 us on a 20 MHz chip, 1 us on a 4 Mhz chip). PWM_Delay is a length of time specified using
the PWM_Delay constant.

Example 1 :
 'This program controls the brightness of an LED on PORTB.0
'using the software PWM routine and a potentiometer.
#chip 16f877a, 4

; ----- Constants
  'PWM constant. This is a required constant.
  #define PWM_Out1 portb.0

; ----- Define Hardware settings

  'PWM port out. This is not required but good practice.
  dir PWM_Out1 out

  'A potentiometer is attached to ANO

; ----- Variables
  ' No Variables specified in this example.

; ----- Main body of program commences here.

    do
        '100 cycles is a purely arbitrary value
        PWMOut 1, ReadAD(AN0), 100
    loop

end

Example 2 :
 'This program controls the brightness of an LED on gpio.1
'using the software PWM routine and a potentiometer.
#chip 12f675, 4

; ----- Constants
  'PWM constant. This is a required constant.
  #define PWM_Out1 gpio.1

; ----- Define Hardware settings

  'PWM port out. This is not required but good practice.
  dir PWM_Out1 out

  'A potentiometer is attached to ANO

; ----- Variables
  ' No Variables specified in this example.

; ----- Main body of program commences here.

    do
      '100 cycles is a purely arbitrary value
        PWMOut 1, ReadAD(AN0), 100
    loop
end

PWMOff

Syntax:

PWMOff

Command Availability:

Only available on PIC microcontrollers with Capture/Compare/PWM (CCP) module.

Explanation:

This command will disable the output of the PWM module on the PIC chip.

Example:
 'This program will enable a 76 Khz PWM signal, with a duty cycle
'of 80%. It will emit the signal for 10 seconds, then stop.
#define PWM_Freq 76 'Set frequency in KHz
#define PWM_Duty 80 'Set duty cycle to 80 %
PWMOn 'Turn on the PWM
WAIT 10 s 'Wait 10 seconds
PWMOff 'Turn off the PWM

For more help, see PWMOn

PWMOn

Syntax:

PWMOn

Command Availability:

Only available on PIC microcontrollers with Capture/Compare/PWM (CCP) module.

Explanation:

This command will enable the output of the PWM module on the PIC chip.

Example:

'This program will enable a 76 Khz PWM signal, with a duty cycle
'of 80%. It will emit the signal for 10 seconds, then stop.
#define PWM_Freq 76 'Set frequency in KHz
#define PWM_Duty 80 'Set duty cycle to 80 %
PWMOn 'Turn on the PWM
WAIT 10 s 'Wait 10 seconds
PWMOff 'Turn off the PWM

For more help, see PWMOff

HPWM

Syntax:

HPWM channel, frequency, duty cycle

Command Availability:
Only available on PIC microcontrollers with Capture/Compare/PWM (CCP) module.

Explanation:

This command sets up the hardware PWM module of the PIC chip to generate a PWM waveform of the
given frequency and duty cycle. Once this command is called, the PWM will be emitted until PWMOff is
called. If you only need one particular frequency and duty cycle, you should use PWMOn and the
constants PWM_Freq and PWM_Duty instead.

channel is 1 or 2, and corresponds to the pins CCP1 and CCP2 respectively. On chips with only one CCP
port, pin CCP or CCP1 is always used, and channel is ignored. (It should be set to 1 anyway to allow for
future upgrades to more powerful PIC chips.)

frequency sets the frequency of the PWM output. It is measured in KHz. The maximum value allowed is
255 KHz. The minimum value varies depending on the clock speed. 1 KHz is the minimum on chips 16
MHz or under and 2 Khz is the lowest possible on 20 MHz chips. In situations that do not require a
specific PWM frequency, the PWM frequency should equal approximately 1 five-hundredth the clock
speed of the PIC (ie 40 Khz on a 20 MHz chip, 16 KHz on an 8 MHz chip). This gives the best duty cycle
resolution possible.

duty cycle specifies the desired duty cycle of the PWM signal, and ranges from 0 to 255 where 255 is
100% duty cycle.

The optional constant HPWM_FAST can be defined to enable the recalculation of the timer prescaler when
needed. This will provide faster operation, but uses extra byte of RAM and may cause problems if HPWM
and PWMOn are used together in a program. This will not cause any issue when using HPWM and PWMOff in
the same program with HPWM_FAST.

Example:
 'This program will alter the brightness of an LED using
'hardware PWM.

'Select chip model and speed

#chip 16F877A, 20

'Set the CCP1 pin to output mode

DIR PORTC.2 out

'Main code
do
    'Turn up brightness over 2.5 seconds
    For Bright = 1 to 255
        HPWM 1, 40, Bright
        wait 10 ms
    next
    'Turn down brightness over 2.5 seconds
    For Bright = 255 to 1
        HPWM 1, 40, Bright
        wait 10 ms
    next
loop

For more help, see PWMOff

Random Numbers
Overview

Introduction:

These routines allow GCBASIC to generate pseudo-random numbers.

The generator uses a 16 bit linear feedback shift register to produce pseudo-random numbers. The
most significant 8 bits of the LFSR are used to provide an 8 bit random number.

When compiling a program, GCBASIC will generate an initial seed for the generator. However, this
seed will be the same every time the program runs, so the sequence of numbers produced by a given
program will always be the same. To work around this, there is a Randomize subroutine. It can be
provided with a new seed for the generator (which will cause the generator to move to a different
point in the sequence). Alternatively, Randomize can be set to obtain a seed from some other source
such as a timer every time it is run.

Relevant Constants:

These constants are used to control settings for the tone generation routines. To set them, place a line
in the main program file that uses #define to assign a value to the particular constant.

Constant Name Controls Default Value

RANDOMIZE_SEED Source of the random seed if Timer0

Randomize is called without a
parameter

Random

Syntax:

var = Random

Command Availability:

Available on all microcontrollers

Explanation:

The Random function will generate a pseudo-random number between 0 and 255 inclusive.

The numbers generated by Random will follow the same sequence every time, until Randomize is used.

Example:

'Set chip model

#chip tiny2313, 1

'Use randomize, with the value on PORTD as the seed

Randomize PORTD

'Generate random numbers, and output on PORTB

Do
    PORTB = Random
    Wait 1 s
Loop

Randomize

Syntax:

Randomize
Randomize seed
Command Availability:

Available on all microcontrollers

Explanation:

Randomize is used to seed the pseudo random number generator, so that it will produce a different
sequence of numbers each time it is used.

If no seed is specified, then the RANDOMIZE_SEED constant will be used as the seed. If seed is specified,
then it will be used to seed the generator.

It is important that the seed is different every time that Randomize is used. If the seed is always the
same, then the sequence of numbers will always be the same. It is best to use a running timer, an input
port, or the analog to digital converter as the source of the seed, since these will normally provide a
different value each time the program runs.

Example:

'Set chip model

#chip tiny2313, 1

'Use randomize, with the value on PORTD as the seed

Randomize PORTD

'Generate random numbers, and output on PORTB

Do
    PORTB = Random
    Wait 1 s
Loop

7-Segment Displays
7 Segment Displays Overview

Introduction

The 7 segment display routines make it easier for GCBASIC programs to display numbers and letters on
7 segment LED displays.

There are two ways that the 7 segment display routines can be set up. One option is to connect the
wires from the display/s in a particular order, and then to set the DisplayPort_n_ and DispSelect_n_
constants. The other option is to connect the display/s in whatever way is easiest, and then set the
DISP_SEG_x and DISP_SEL_x constants. The first option (setting DisplayPortx and DispSelectn) will
generate slightly more efficient code.
The default for 7 segment displays is to be connected to a common parallel bus with a Common
Cathode, see the section Common Cathode for an example of the GCB code to control this configuration,
and, see the section Common Anode for an example of the GCB code to control this configuration.

Configuration for DISP_SEG_x and DISP_SEL_x:

The following constants must be set:

Constant Name Controls Default Value

DISP_SEG_x Controls the output ping used to None - needs to be set

control segment x of the
displays. There are 7 of these
constants, named DISP_SEG_A
through DISP_SEG_G. One must be
set for each segment.

DISP_SEG_DOT Specifies the output pin used to None - needs to be set

control the decimal point on the
displays.

DISP_SEL_x The command used to select None - needs to be set, see note
display n. Used to control below.
addressing pins when several
displays are multiplexed.

Note: Instead of setting DISP_SEL_x, it is possible to set DispSelectn and use these in conjunction with
DISP_SEG_x.

Configuration using DisplayPortn and DispSelectn

To set the 7-Segment display routines supplied with GCBASIC using DisplayPortn, it is necessary to set
these constants:

Constant Name Controls Default Value

DisplayPortn Controls the output port used to N/A

control display n. _n_is A, B, C or
D, corresponding to displays 1, 2,
3 and 4, respectively.

DispSelectn The command used to select nop

display n. Used to control
addressing pins when several
displays are multiplexed.

To set up the routines in this way, the displays must be connected as follows:
 Microcontroller port pin Display Segment

0 A

1 B

2 C

3 D

4 E

5 F

6 G

Also, see DisplayChar, DisplayValue

Common Cathode

Example:

'A Common Cathode 7 Segment display example

'Chip model
#chip 16f1783,8

#define DISP_SEG_A PORTC.0

#define DISP_SEG_B PORTC.1
#define DISP_SEG_C PORTC.2
#define DISP_SEG_D PORTC.3
#define DISP_SEG_E PORTC.4
#define DISP_SEG_F PORTC.5
#define DISP_SEG_G PORTC.6
' see below for a typical usage pf the SEG_DOT
'#define DISP_SEG_DOT PortC.7

#define Disp_Sel_1 PortA.1

#define Disp_Sel_2 PortA.2
#define Disp_Sel_3 PortA.3

dim count as word

dim number as word

Main:
For count = 0 to 999
    number = count
    Num2 = 0
    Num3 = 0
     If number >= 100 Then
      Num3 = number / 100
      number = SysCalcTempX
    End if
    If number >= 10 Then
      Num2 = number / 10
      number = SysCalcTempX
    end if
    Num1 = number
    Repeat 10
      DisplayValue 1, Num1
      wait 5 ms
      DisplayValue 2, Num2
      wait 5 ms
      DisplayValue 3, Num3
      Set PortC.7 On 'A manually inserted dp (SEG_DOT), like in a voltage reading
    wait 5 ms
    Set PortC.7 Off
    end Repeat
Next
Goto Main

Also, see 7 Degment Display Overview, DisplayChar, DisplayValue

Common Anode

Additional configuration when using Common Anode

When setting up the 7 segment Common Anode display you MUST use the 7Seg_CommonAnode constant.
You can optionally use the 7Seg_HighSide constant to support PFET or PNP high side driving of the
Common Anode display

Constant Name Controls Comment

7Seg_CommonAnode Inverts controls for Common Required for Common Cathode

Anode displays displays

7Seg_HighSide Support PFET or PNP high side Inverts Common Cathode

driving of the display addressing pin logic for
multiplexed displays

Example:

'A Common Anode 7 Segment display example using bs250p pfets

'Chip model
#chip 16f1783,8
'support for Common Cathode
#define 7Seg_CommonAnode

'support for pfet or pnp high side drivers

#define 7Seg_HighSide

'#define DisplayPortA = PortC

'#define DisplayPortB = PortC
'#define DisplayPortC = PortC

#define DISP_SEG_A PORTC.0

#define DISP_SEG_B PORTC.1
#define DISP_SEG_C PORTC.2
#define DISP_SEG_D PORTC.3
#define DISP_SEG_E PORTC.4
#define DISP_SEG_F PORTC.5
#define DISP_SEG_G PORTC.6
'#define DISP_SEG_DOT PortC.7

#define Disp_Sel_1 PortA.1

#define Disp_Sel_2 PortA.2
#define Disp_Sel_3 PortA.3

dim count as word

dim number as word

Main:
For count = 0 to 999
    number = count
    Num2 = 0
    Num3 = 0
    If number >= 100 Then
      Num3 = number / 100
      number = SysCalcTempX
    End if
    If number >= 10 Then
      Num2 = number / 10
      number = SysCalcTempX
    end if
    Num1 = number
    Repeat 10
      DisplayValue 1, Num1
      wait 5 ms
      DisplayValue 2, Num2
      wait 5 ms
      DisplayValue 3, Num3
      Set PortC.7 Off 'CA manually inserted dp, like in a voltage reading
      wait 5 ms
       Set PortC.7 On
    end Repeat
Next
Goto Main

Also, see 7 Degment Display Overview, DisplayChar, DisplayValue

DisplayValue

Syntax:

DisplayValue display, data

Command Availability:

Available on all microcontrollers.

Explanation:

This command will display the given value on a seven segment LED display. display is the number of
the display to use, and data is the value between 0 and 9 to show.

The command also support HEX characters in the range between 0x00 and 0x0F (0 to 15). See example
two below for usage.

Example 1:
 'This program will count from 0 to 99 on two LED displays
#chip 16F819, 8
#config osc = int

#define DISP_SEG_A PORTB.0

#define DISP_SEG_B PORTB.1
#define DISP_SEG_C PORTB.2
#define DISP_SEG_D PORTB.3
#define DISP_SEG_E PORTB.4
#define DISP_SEG_F PORTB.5
#define DISP_SEG_G PORTB.6

#define DISP_SEL_1 PORTA.0

#define DISP_SEL_2 PORTA.1

Do
    For Counter = 0 To 99

        'Get the 2 digits

        Number = Counter
        Num1 = 0
        If Number >= 10 Then
            Num1 = Number / 10
            'SysCalcTempX stores remainder after division
            Number = SysCalcTempX
        End If
        Num2 = Number

        'Show the digits

        'Each DisplayValue will erase the other (multiplexing)
        'So they must be called often enough that the flickering
        'cannot be seen.
        Repeat 500
            DisplayValue 1, Num1
            Wait 1 ms
            DisplayValue 2, Num2
            Wait 1 ms
        End Repeat
    Next
Loop

Example 2:
 'This program will count from 0 to 0xff on two LED displays
#chip 16F819, 8
#config osc = int

#define DISP_SEG_A PORTB.0

#define DISP_SEG_B PORTB.1
#define DISP_SEG_C PORTB.2
#define DISP_SEG_D PORTB.3
#define DISP_SEG_E PORTB.4
#define DISP_SEG_F PORTB.5
#define DISP_SEG_G PORTB.6

#define DISP_SEL_1 PORTA.0

#define DISP_SEL_2 PORTA.1
#define DISP_SEL_4 PORTA.2
#define DISP_SEL_3 PORTA.3

Do
    For Counter = 0 To 0xff

        'Get the 2 digits

        Number = Counter
        Num1 = 0
        If Number >= 0x10 Then
            Num1 = Number / 0x10
            'SysCalcTempX stores remainder after division
            Number = SysCalcTempX
        End If
        Num2 = Number

        'Show the digits

        'Each DisplayValue will erase the other (multiplexing)
        'So they must be called often enough that the flickering
        'cannot be seen.
        Repeat 500
            DisplayValue 1, Num1
            Wait 1 ms
            DisplayValue 2, Num2
            Wait 1 ms
        End Repeat
    Next
Loop

Also, see 7 Degment Display Overview, DisplayChar

DisplayChar

Syntax:

DisplayChar (display, character)

Command Availability:

Available on all microcontrollers.

Explanation:

This command will display the given ASCII character on a seven segment LED display. display is the
number of the display to use, and character is the ASCII character to show.

This example is a Common Cathode configuration.

Example:

'This program will show "Hello" on a LED display

'The display should be connected to PORTB

#chip 16F877A, 20
#define DisplayPortA PORTB

Dim Message As String

Message = "Hello "
For Counter = 1 to 6
    DisplayChar 1, Message(Counter)
    Wait 250 ms
Next

Also, see Also, see 7 Degment Display Overview, DisplayValue

One Wire Devices

DS18B20

The DS18B20 is a 1-Wire digital temperature sensor from Maxim IC. The sensor reports degrees C with
9 to 12-bit precision from -55C to 125C (+/- 0.5C).

Each sensor has a unique 64-Bit Serial number etched into it. This allows for a number of sensors to be
used on one data bus. This sensor is used in many data-logging and temperature control projects.

Reading the temperature from a DS18B20 takes up to 750ms.

To use the DS18B20 driver the following is required to added to the GCBASIC source file.

#include <DS18B20.h>

Note the GCBASIC commands do not work with the older DS1820 or DS18S20 as they have a different
internal resolution. These commands are not designed to be used with parasitically powered DS18B20
sensors, the 5V pin of the sensor must

ReadDigitalTemp

Syntax:

ReadDigitalTemp

Command Availability:

Available on all microcontrollers.

Explanation:

Return the value of the sensor. The following two lines must be included in the GCBASIC source file.

#include <DS18B20.h>
#define DQ PortC.3 ; change port configuration as required

The method returns whole part of the sensor value in the byte variable DSint, the method also returns
decimal part of the sensor value in the byte variable DSdec.

Example:
 'Chip Settings. Assumes the development board with with a 16F877A
#chip 16F877A,1

*#include <DS18B20.h>*

'Use LCD in 4 pin mode and define LCD pins

#define LCD_IO 4
#define LCD_RW PORTE.1
#define LCD_RS PORTE.0
#define LCD_Enable PORTE.2
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7

' DS18B20 port settings

#define DQ PortC.3

ReadDigitalTemp

' Display the integer value of the sensor on the LCD

locate 0,0
print "Temp"
locate 0,8
print DSInt
print "."
print DSdec
print chr(223)+"C"

ReadTemp

Syntax:

byte_var = ReadTemp

Command Availability:

Available on all microcontrollers.

Explanation:

A function that returns the value of the sensor. The following two lines must be included in the
GCBASIC source file.
 #include <DS18B20.h>
#define DQ PortC.3 ; change port configuration as required

Reads sensor and stores in output variable. The conversion takes up to 750ms. Readtemp carries out a
full 12 bit conversion and then rounds the result to the nearest full degree Celsius (byte_value). For the
full 12 bit value use the readtemp12 command.

The temperature is read back in whole degree steps, and the sensor operates from -55 to + 125 degrees
Celsius. Note that bit 7 is 0 for positive temperature values and 1 for negative values (ie negative values
will appear as 128 + numeric value).

Note the Readtemp command does not work with the older DS1820 or DS18S20 as they have a different
internal resolution. This command is not designed to be used with parasitically powered DS18B20
sensors, the 5V pin of the sensor must be connected.

Example:
 'Chip Settings. Assumes the development board with with a 16F877A
#chip 16F877A,1

#include <DS18B20.h>

'Use LCD in 4 pin mode and define LCD pins

#define LCD_IO 4
#define LCD_RW PORTE.1
#define LCD_RS PORTE.0
#define LCD_Enable PORTE.2
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7

' DS18B20 port settings

#define DQ PortC.3

  ccount = 0
  CLS

do forever
   ' The function readtemp returns the integer value of the sensor
   DSdata = readtemp

   ' Display the integer value of the sensor on the LCD

   locate 0,0
   print hex(ccount)
   print " Ceil"
   locate 0,8
   print DSdata
   print chr(223)+"C"

   wait 2 s
   ccount++

loop

ReadTemp12

Syntax:

byte_var = ReadTemp12

Command Availability:
Available on all microcontrollers.

Explanation:

A function that returns the raw value of the sensor. The following two lines must be included in the
GCBASIC source file.

#include <DS18B20.h>
#define DQ PortC.3 ; change port configuration as required

Reads sensor and stores in output variable. The conversion takes up to 750ms. Readtemp12 carries out
a full 12 bit conversion.

This command is for advanced users only. For standard ‘whole degree’ data use the readtemp
command.

The temperature is read back as the raw 12 bit data into a word variable (0.0625 degree resolution).
The user must interpret the data through mathematical manipulation. See the DS18B20 datasheet for
more information on the 12 bit temperature/data information construct.

Note the readtemp12 command does not work with the older DS1820 or DS18S20 as they have a
different internal resolution. This command is not designed to be used with parasitically powered
DS18B20 sensors, the 5V pin of the sensor must be connected.

Example:

'Chip Settings. Assumes the development board with with a 16F877A

#chip 16F877A,1

#include <DS18B20.h>

'Use LCD in 4 pin mode and define LCD pins

#define LCD_IO 4
#define LCD_RW PORTE.1
#define LCD_RS PORTE.0
#define LCD_Enable PORTE.2
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7

' DS18B20 port settings

#define DQ PortC.3
dim TempC_100 as word ' a variable to handle the temperature calculations
ccount = 0
CLS

do forever

   'Display the integer and decimal value of the sensor on the LCD

   ' The function readtemp12 returns the raw value of the sensor.
   ' The sensor is read as a 12 bit value. Each unit equates to 0.0625 of a degree
   DSdata = readtemp12
   SignBit = DSdata / 256 / 128
   If SignBit = 0 Then goto Positive
   ' its negative!
   DSdata = ( DSdata # 0xffff ) + 1 ' take twos comp

Positive:

   ' Convert value * 0.0625. Mulitple value by 6 then add result to multiplication of the
value with 25 then divide result by 100.
   TempC_100 = DSdata * 6
   DSdata = ( DSdata * 25 ) / 100
   TempC_100 = TempC_100 + DSdata

   Whole = TempC_100 / 100

   Fract = TempC_100 % 100
   If SignBit = 0 Then goto DisplayTemp
   Print "-"

DisplayTemp:
   locate 1,0
   print hex(ccount)
   print " Real"
   locate 1,8
   print str(Whole)
   print "."
  ' To ensure the decimal part is two digits
   Dig = Fract / 10
   print Dig
   Dig = Fract % 10
   print Dig
   print chr(223)
   print "C"
   wait 2 s
   ccount++

loop
Serial Communications
RS232 (software)

RS232 Software Overview

Introduction:

These routines allow the microcontroller to send and receive RS232 data.

All functions are implemented using software, so no special hardware is required on the
microcontroller. However, if the microcontroller has a hardware serial module (usually referred to as
UART or USART), and the serial data lines are connected to the appropriate pins, the hardware routines
should be used for smaller code, improved reliability and higher baud rates.

Relevant Constants:

These constants are used to control settings for the RS232 serial communication routines. To set them,
place a line in the main program file that uses #define to assign a value to the particular constant.

Constant Name/s Controls Default Value

SendALow, SendBLow, SendCLow These are used to define the nop

commands used to send a low (must be set)
(0) bit on serial channels A, B
and C respectively.

SendAHigh, SendBHigh, SendCHigh These are used to define the nop

commands used to send a high (must be set)
(1) bit on serial channels A, B
and C respectively.

RecALow, RecBLow, RecCLow The condition that is true when Sys232Temp.0 OFF
a low bit is being received (must be set)

RecAHigh, RecBHigh, RecCHigh The condition that is true when Sys232Temp.0 ON

a high bit is being received (must be set)

InitSer

Syntax:

InitSer channel, rate, start, data, stop, parity, invert

Command Availability:

Available on all microcontrollers.

Explanation:

This command will set up the serial communications. The parameters are as follows:

• channel is 1, 2 or 3, and refers to the I/O ports that are used for communication.

• rate is the bit rate, which is given by the letter r and then the desiredrate in bps. Acceptable units
are r300, r600, r1200, r2400, r4800, r9600 and r19200.

• start gives the number of start bits, which is usually 1. To make the PIC wait for the start bit before
proceeding with the receive, add 128 to start. (Note: it may be desirable to use the WaitForStart
constant here.)

• data tells the program how many data bits are to be sent or received. In most situations t his is 8,
but it can range between 1 and 8, inclusive.

• stop is the number of stop bits. If start bit 7 is on, then this number will be ignored.

• parity refers to a system of error checking used by many devices. It can be odd (in which there
must always be an odd number of high bits), even (where the number of high bits must always be
even), or none (for systems that do not use parity).

• invert can be either "normal" or "invert". If it in "invert", then high bits will be changed to low, and
low to high.

Example:

Please refer to SerSend for an example of InitSer

For more help, see RS232 Software Overview

SerSend

Syntax:

SerSend channel, data

Command Availability:

Available on all microcontrollers.

Explanation:

This command will send a byte given by data using the RS232 channel referred to as channel according
to the rules set using InitSer.

Example:
 'This program will send a byte using PORTB.2, the value of which
'depends on whether a button is pressed. This can be used with the example for
SerReceive.

#chip 16F819, 8
#config Osc = Int

#define SendAHigh Set PORTB.2 ON

#define SendALow Set PORTB.2 OFF
#define Button PORTA.0

Dir Button In
Dir PORTB.2 Out

InitSer 1, r9600, 1+WaitForStart, 8, 1, none, normal

Do
    If Button = On Then Temp = 100
    If Button = Off Then Temp = 0
    SerSend 1, Temp
    Wait 100 ms
Loop

For more help, see RS232 Software Overview, InitSer

SerReceive

Syntax:

SerReceive channel, output

Command Availability:

Available on all microcontrollers.

Explanation:

This command will read a byte from the RS232 channel given by channel according to the rules set
using InitSer, and store the received byte in the variable output.

Example:
 'This program will read a byte from PORTB.2, and set the LED on if
'the byte is more than 50. This can be used with the SerSend
'example program.

#chip 16F88, 8
#config Osc = Int

#define RecAHigh PORTB.2 ON

#define RecALow PORTB.2 OFF
#define LED PORTB.0

Dir PORTB.0 Out

Dir PORTB.2 In

InitSer 1, r9600, 1 + WaitForStart, 8, 1, none, normal

Do
    SerReceive 1, Temp
    If Temp <= 50 Then Set LED Off
    If Temp > 50 Then Set LED On
Loop

For more help, see RS232 Software Overview, InitSer

SerPrint

Syntax:

SerPrint channel, value

Command Availability:

Available on all microcontrollers.

Explanation:

SerPrint is used to send a value over the serial connection. value can be a string, integer, word or byte -
SerPrint is very similar to Print. channel is the serial connection to send data through. SerPrint will not
send any new line characters. If the chip is sending to a terminal, these commands should follow every
SerPrint:

SerSend channel, 13
SerSend channel, 10

Example:
'This program will display any values received over the serial
'connection. If "pot" is received, the value of the analog sensor
'will be sent.

'Chip settings
#chip 18F2525, 8
#config Osc = Int

'LCD settings
#define LCD_IO 4
#define LCD_RS PORTC.7
#define LCD_RW PORTC.6
#define LCD_Enable PORTC.5
#define LCD_DB4 PORTC.4
#define LCD_DB5 PORTC.3
#define LCD_DB6 PORTC.2
#define LCD_DB7 PORTC.1

'Serial settings
#define SerInPort PORTB.6
#define SerOutPort PORTB.7

#define SendAHigh Set SerOutPort Off

#define SendALow Set SerOutPort On
#define RecAHigh SerInPort Off
#define RecALow SerInPort On

'Potentiometer
#define POT_PORT PORTA.0
#define POT_AN AN0

'Set pin directions

Dir SerOutPort Out
Dir SerInPort In
Dir POT_PORT In

'Create buffer variables to store received messages

Dim Buffer As String
Dim OldBuffer As String
BufferSize = 0

'Set up serial connection

InitSer 1, r9600, 1 + WaitForStart, 8, 1, none, invert

'Show test messages

Print "Serial Tester"
Wait 1 s
SerPrint 1, "GCBASIC RS232 Test"
SerSend 1, 13
SerSend 1, 10
Wait 1 s

'Main loop
Do
    'Get a byte from the terminal
    SerReceive 1, Temp

    'If Enter key was pressed, deal with buffer contents

    If Temp = 13 Then
        Buffer(0) = BufferSize

        'Try to execute commands in buffer

        If Not ExecCommand (Buffer) Then
            'Show message on bottom line, last message on top.
            CLS
            Print OldBuffer
            Locate 1, 0
            Print Buffer
            'Store the message for next time
            OldBuffer = Buffer
        End If

        BufferSize = 0
    End If
    'Backspace code, delete last character in buffer
    If Temp = 8 Then
        If BufferSize > 0 Then BufferSize -= 1
    End If
    'Received ASCII code between 32 and 127, add to buffer
    If Temp >= 32 And Temp <= 127 Then
        BufferSize += 1
        Buffer(BufferSize) = Temp
    End If
Loop

'Takes a sensor reading and sends it to terminal

Sub SendSensorReading
    SerPrint 1, "Sensor Reading: "
    SerPrint 1, ReadAD10(POT_AN)
    SerSend 1, 13
    SerSend 1, 10
End Sub

'Will check the buffer for a command

'If command found, run it and return true
 'If not, return false
Function ExecCommand (CmdIn As String)
    ExecCommand = False
    'If received command is "pot", show potentiometer value
    If CmdIn = "pot" Then
        SendSensorReading
        ExecCommand = True
    End If
End Function

For more help, see RS232 Software Overview

RS232 (hardware)

RS232 Hardware Overview

Introduction

These subroutines allow GCBASIC programs to communicate more easily using RS232.

These hardware-based routines are intended for use on microcontrollers with built in RS232 modules -
normally referred to in datasheets as USART or UART modules. To use these, the RS232 data lines must
be connected to the pins on the microcontroller used by the serial module. If the RS232 lines are
connected elsewhere, or the microcontroller has no RS232 module, then the software based routines
must be used.

Relevant Constants

These constants affect the operation of the hardware RS232 routines:

Constant Name Controls Default Value

USART_BAUD_RATE Baud rate (in bps) for the N/A

routines to operate at.

USART_BLOCKING If set, this constant will cause the Not set

USART routines to delay until
data can be sent or received. If
not set, then the data will be
buffered and send by the
hardware when possible.

USART_TX_BLOCKING If set, this constant will cause the

USART routines to delay until
data has been sent. If not set,
then the data will be buffered
and sent by the hardware
whenever possible.
Constant Name Controls Default Value

USART_DELAY This is the delay between 1 ms

characters.

An additional delay may be required in programs to ensure the usart buffer is empty
NOTE before the end of the program. If you do not include a delay, typcally 100 ms, you may
lose a few characters as the microcomputer goes to sleep at the end of the program.

HSerPrint

Syntax:

HSerPrint value

Command Availability:

Available on all microcontrollers with a USART or UART module.

Explanation:

HSerPrint is used to send a value over the serial connection. value can be a string, integers, long, word
or byte. HSerPrint is very similar to Print. The channel used will be the hardware serial connection.

HSerPrint will not send any new line characters. If the chip is sending to a terminal, these commands
should follow every HSerPrint :

HSerPrint 13
HSerPrint 10

Example:

'This program will display any values received over the serial
'connection. If "pot" is received, the value of the analog sensor
'will be sent.
'Note: This has been adapted from the SerPrint example.

'Chip settings
#chip 18F2525, 8
#config Osc = Int

'LCD settings
#define LCD_IO 4
#define LCD_RS PORTC.7
#define LCD_RW PORTC.6
#define LCD_Enable PORTC.5
#define LCD_DB4 PORTC.4
#define LCD_DB5 PORTC.3
#define LCD_DB6 PORTC.2
#define LCD_DB7 PORTC.1

'USART settings
#define USART_BAUD_RATE 9600

'Potentiometer
#define POT_PORT PORTA.0
#define POT_AN AN0

'Set pin directions

Dir SerOutPort Out
Dir SerInPort In
Dir POT_PORT In

'Create buffer variables to store received messages

Dim Buffer As String
Dim OldBuffer As String
BufferSize = 0

'Show test messages

Print "Serial Tester"
Wait 1 s
HSerPrint "GCBASIC RS232 Test"
HSerSend 13
HSerSend 10
Wait 1 s

'Main loop
Do
    'Get a byte from the terminal
    HSerReceive Temp

    'If Enter key was pressed, deal with buffer contents

    If Temp = 13 Then
        Buffer(0) = BufferSize

        'Try to execute commands in buffer

        If Not ExecCommand (Buffer) Then
            'Show message on bottom line, last message on top.
            CLS
            Print OldBuffer
            Locate 1, 0
            Print Buffer
             'Store the message for next time
            OldBuffer = Buffer
        End If

        BufferSize = 0
    End If
    'Backspace code, delete last character in buffer
    If Temp = 8 Then
        If BufferSize > 0 Then BufferSize -= 1
    End If
    'Received ASCII code between 32 and 127, add to buffer
    If Temp >= 32 And Temp <= 127 Then
        BufferSize += 1
        Buffer(BufferSize) = Temp
    End If
Loop

'Takes a sensor reading and sends it to terminal

Sub SendSensorReading
    HSerPrint "Sensor Reading: "
    HSerPrint ReadAD10(POT_AN)
    HSerSend 13
    HSerSend 10
End Sub

'Will check the buffer for a command

'If command found, run it and return true
'If not, return false
Function ExecCommand (CmdIn As String)
    ExecCommand = False
    'If received command is "pot", show potentiometer value
    If CmdIn = "pot" Then
        SendSensorReading
        ExecCommand = True
    End If
End Function

HserPrintByteCRLF
HserPrintCRLF

For more help, see also HserPrintByteCRLF and HserPrintCRLF

HSerReceive

Syntax:

Used as subroutine:
 HSerReceive output

Used as function:

output = HSerReceive

Command Availability:

Available on all microcontrollers with a USART or UART module.

Explanation:

This command will read a byte from the hardware RS232 module. It can be used either as a subroutine
or as a function. If used as a subroutine, a variable must be supplied to store the received value in. If
used as a function, it will return the received value.

Example:

'This program will read a value from the USART, and display it on PORTB.

#chip 16F877A, 20

'USART settings
#define USART_BAUD_RATE 9600

'Set PORTB to input

Dir PORTB Out
'Set USART receive pin to input
Dir PORTC.7 In

'Main loop
Do
    'Get and display value
    'If there is no new data, HSerReceive will return old value.
    HSerReceive PORTB
    'Could also write:
    'PORTB = HSerReceive
Loop

HSerSend

Syntax:
 HSerSend data

Command Availability:

Available on all microcontrollers with a USART or UART module.

Explanation:

This command will send a byte given by data using the hardware RS232 module.

Example:

'This program will send the status of PORTB through the hardware
'serial module.

#chip 16F877A, 20

'USART settings
#define USART_BAUD_RATE 9600

'Set PORTB to input

Dir PORTB In
'Set USART transmit pin to output
Dir PORTC.6 Out

'Main loop
Do
    'Send PORTB value through USART
    HSerSend PORTB
    'Short delay for receiver to process message
    Wait 10 ms
Loop

HserPrintByteCRLF

Syntax:

HserPrintByteCRLF data

Command Availability:

Available on all microcontrollers with a USART or UART module.

Explanation:
This command will send a byte given by _data_using the hardware RS232 module and then send the
ASCII codes 13 and 10. ASCII codes 13 and 10 equate to a carriage return and line feed.

Example:

'This program will send the status of PORTB through the hardware serial module.

HserPrintByteCRLF 65 ' Will print a single A on the terminal

HserPrintByteCRLF "A" ' Will print a single A on the terminal

See also HserPrintCRLF

HserPrintCRLF

Syntax:

HserPrintCRLF [optional BYTE]

Command Availability:

Available on all microcontrollers with a USART or UART module.

Explanation:

This command will send ASCII codes 13 and 10 only using the hardware RS232 module. ASCII codes 13
and 10 equate to a carriage return and line feed.

Optionally, you can add a parameter. The number will determine the number of ASCII codes 13 and 10
set to the hardware RS232 module.

Example:

'This program will send the status of PORTB through the hardware serial module.

HserPrintCRLF ' Will send a CR & LF to the terminal

See also HserPrintByteCRLF

PS/2

PS/2 Overview

Introduction

These routines make it easier to communicate with a PS/2 device, particularly a keyboard.
Relevant Constants

These constants affect the operation of the PS/2 routines:

Constant Name Controls Default Value

PS2Data Pin connected to PS/2 data line N/A

PS2Clock Pin connected to PS/2 clock line. N/A

PS2_DELAY This constant can be set to a Not set

delay, such as 10 ms. If set, a
delay will be added at the end of
every byte sent or received.

InKey

Syntax:

output = InKey

Command Availability:

Available on all microcontrollers.

Explanation:

The InKey function will read the last pressed key from a PS/2 keyboard, and return an ASCII value
corresponding to the key. If no key is pressed, then InKey will return 0.

It will also monitor Caps Lock, Num Lock and Scroll Lock keys, and update the status LEDs as
appropriate.

Example:

'A program to accept messages from a standard PS/2 keyboard

'Any keys pressed will be shown on an LCD screen.

'Hardware settings
#chip 18F4620, 20

'LCD connection settings

#define LCD_IO 4
#define LCD_DB4 PORTD.4
#define LCD_DB5 PORTD.5
#define LCD_DB6 PORTD.6
#define LCD_DB7 PORTD.7
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'PS/2 connection settings

#define PS2Clock PORTC.1
#define PS2Data PORTC.0
#define PS2_DELAY 10 ms

'Set up key log

Dim KeyLog(32)
DataCount = 0
KeyLog(1) = 32

Main:
    'Read the last pressed key
    KeyIn = INKEY
    'If no key pressed, try reading again
    If KeyIn = 0 Then Goto Main

    'Escape pressed - clear message

    If KeyIn = 27 Then
        DataCount = 0
        For DataPos = 1 to 32
            KeyLog(DataPos) = 32
        Next
        Goto DisplayData
    End If

    'Backspace pressed - delete last character

    If KeyIn = 8 Then
        If DataCount = 0 Then Goto Main
        KeyLog(DataCount) = 32
        DataCount = DataCount - 1
        Goto DisplayData
    End If

    'Otherwise, add the character to the buffer

    If KeyIn >= 31 And KeyIn <= 127 Then
        DataCount = DataCount + 1
        KeyLog(DataCount) = KeyIn
    End If

DisplayData:
    'Display key buffer
    'LCDWriteChar is used instead of Print for greater control
    CLS
    For DataPos = 1 to DataCount
         If DataPos = 17 then Locate 1, 0
        LCDWriteChar KeyLog(DataPos)
    Next

Goto Main

PS2SetKBLeds

Syntax:

PS2SetKBLeds (LedStatus)

Command Availability:

Available on all microcontrollers.

Explanation:

This routine will turn the status LEDs on a keyboard on or off. LedStatus is a variable, of which the
lower 3 bits correspond to the 3 LEDs. Bit 0 is for Scroll Lock, bit 1 controls Num Lock and bit 2 controls
Caps Lock.

Note that this routine does not alter the status variables within the INKEY routine - so even if the Caps
Lock LED is turned on, Caps Lock will stay off.

Example:
 'A spinning LED program for a keyboard
'Will flash Num Lock, then Caps Lock, then Scroll Lock.

'Hardware settings
#chip 16F88, 8

#define PS2Clock PORTB.2

#define PS2Data PORTB.3
#define PS2_DELAY 10 ms

'Main Loop
Do

    'Turn on only Num Lock (bit 1)

    PS2SetKBLeds b'00000010'
    Wait 250 ms

    'Turn on only Caps Lock (bit 2)

    PS2SetKBLeds b'00000100'
    Wait 250 ms

    'Turn on only Scroll Lock (bit 0)

    PS2SetKBLeds b'00000001'
    Wait 250 ms

Loop

PS2ReadByte

Syntax:

output = PS2ReadByte

Command Availability:

Available on all microcontrollers.

Explanation:

PS2ReadByte will read a byte from the PS/2 bus. It will return the byte, or 0 if no data was returned by
the PS/2 device.

The PS/2 bus will normally be held in the inhibit state. PS2ReadByte will uninhibit the bus for 25 ms. If a
response is received, it will be read. Then, the bus will be placed back in the inhibit state.

Example:
For an example, please refer to the InKey function in the ps2.h file.

PS2WriteByte

Syntax:

PS2WriteByte data

Command Availability:

Available on all microcontrollers.

Explanation:

PS2WriteByte will send a byte to a PS/2 device. Once the byte has been written, the PS/2 bus will be
placed in the inhibit state.

Example:

For an example, please refer to the PS2SetKBLeds function in the ps2.h file.

SPI

SPIMode

Syntax:

SPIMode Mode

Command Availability:

Available on PIC microcontrollers with Synchronous Serial Port (SSP) module.

Explanation:

SPIMode sets the mode of the SPI module within the PIC chip. These are the possible SPI Modes:

Mode Name Description

MasterSlow Master mode, SPI clock is 1/64 of the frequency of

the PIC.

Master Master mode, SPI clock is 1/16 of the frequency of

the PIC.

MasterFast Master mode, SPI clock is 1/4 of the frequency of

the PIC.
Mode Name Description

Slave Slave mode

SlaveSS Slave mode, with the Slave Select pin enabled.

See also SPITransfer

SPITransfer

Syntax:

SPITransfer tx, rx

Command Availability:

Available on PIC microcontrollers with Synchronous Serial Port (SSP) module.

Explanation:

This command simultaneously sends and receives a byte of data using the SPI protocol. It behaves
differently depending on whether the PIC has been set to act as a master or a slave. When operating as
a master, SPITransfer will initiate a transfer. The data in tx will be sent to the slave, whilst the byte that
is buffered in the slave will be read into rx. In slave mode, the SPITransfer command will pause the
program until a transfer is initiated by the master. At this point, it will send the data in tx whilst
reading the transmission from the master into the rx variable.

Example:

There are two example programs for this command - one to run on the slave PIC, and one on the
master. A reading is taken from a sensor on the slave, and sent across to the master which shows the
data on its LCD screen.

Slave Program:
 'Select chip model and configuration
#chip 16F88, 20
#config MCLR_OFF

'Set directions of SPI pins

dir PORTB.2 out
dir PORTB.1 in
dir PORTB.4 in
'Set direction of analogue pin
dir PORTA.0 in

'Set SPI mode to slave

SPIMode Slave

'Allow other PIC to initialise LCD

Wait 1 sec

'Main loop - takes a reading, and then waits to send it across.

do
'Note that rx is 0 - this is because no data is to be received.
SPITransfer ReadAD(AN0), 0
loop

Master Program:
 'General hardware configuration
#chip 16F877A, 20

'LCD connection settings

#define LCD_IO 8
#define LCD_DATA_PORT PORTC
#define LCD_RS PORTD.0
#define LCD_RW PORTD.1
#define LCD_Enable PORTD.2

'Set SPI pin directions

dir PORTC.5 out
dir PORTC.4 in
dir PORTC.3 out

'Set SPI Mode to master, with fast clock

SPIMode MasterFast

'Main Loop
do
'Read a byte from the slave
'No data to send, so tx is 0
SPITransfer 0, Temp

'Display data
if Temp > 0 then
  CLS
  Print "Light: "
  LCDInt Temp
  Temp = 0
end if

'Wait to allow time for the LCD to show the given value
wait 100 ms
loop

I2C Software

I2C Overview

Introduction:

These software routines allow GCBASIC programs to send and receive I2C messages. They can be
configured to act as master or slave, and the speed can also be altered.

No hardware I2C module is required for these routines - all communication is handled in software.
However, these routines will not work on 12-bit instruction PICs (10F, 12F5xx and 16F5xx chips).

Relevant Constants:

These constants control the setup of the software I2C routines:

Constant Controls Default Value

I2C_MODE Mode of I2C routines (Master or Master

Slave)

I2C_DATA Pin on microcontroller N/A

connected to I2C data

I2C_CLOCK Pin on microcontroller N/A

connected to I2C clock

I2C_BIT_DELAY Time for a bit (used for 2 us

acknowledge detection)

I2C_CLOCK_DELAY Time for clock pulse to remain 1 us

high

I2C_END_DELAY Time between clock pulses 1 us

I2C_USE_TIMEOUT Set to true if slave mode I2C Not Set

routines should stop waiting for
the master and exit after a
timeout occurs.

I2C_DISABLE_INTERRUPTS Disable interrupts during I2C Only available in GCB compiler

routines. Important when an i2C post 1/2014
clock is part of your solution

Example: This example examines the IC2 devices and displays on a terminal. This code will require
adaption but the code shows an approach to discover the IC2 devices.
' I2C Overview - using the ChipIno board, see here for information
#chip 16F886, 8
#config MCLRE_ON

' Define I2C settings

#define I2C_MODE Master
#define I2C_DATA PORTC.4
#define I2C_CLOCK PORTC.3
#define I2C_DISABLE_INTERRUPTS ON

'USART/SERIAL PORT via a MAX232 TO PC Terminal

#define USART_BAUD_RATE 9600
Dir PORTc.6 Out
#define USART_DELAY 5 ms

HSerPrintCRLF 2
HSerPrint "I2C Discover using the ChipIno"
HSerPrintCRLF 2

HSerPrint "Started: "

HSerPrint "Searching I2C address space: v0.85"
HSerPrintCRLF

wait 100 ms
dim DeviceID as byte
for DeviceID = 0 to 255
    I2CStart
    I2CSend ( deviceID )
    I2CSend ( 0 )
    I2CSend ( 0 )
    i2cstop

    if I2CSendState = True then

      HSerPrint "__"
      HSerPrint "ID: 0x"
      HSerPrint hex(deviceID)
      HSerPrint " (d"
      HSerPrint Str(deviceID)
      HSerPrint ")"
      HSerPrintCRLF
    end if
next
HSerPrint "End of Device Search": HSerPrintCRLF 2
End
Supported in <I2C.H>

I2CAckPollState

Syntax:

<test condition> I2CAckPollState

Command Availability:

Only available in GCB I2C.h with release after 1/2014 Available on all microcontrollers except 12 bit
instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:

Should only be used when I2C routines are operating in Master mode, this command will return the
last state of the acknowledge response from a specific I2C device on the I2C bus.

I2CACKPOLL sets the state of variable I2CAckPollState. I2CAckPollState can only read - it cannot be set.

Example:

 ...
' ACK polling removes the need to for the 24xxxxx device to have a 5ms
write time
I2CACKPOLL( eeprom_device )
' You check the exit state,
' Use I2CAckPollState to check the state of a target device
 ...

Supported in <I2C.H>

I2CAckpoll

Syntax:

I2CAckpoll ( I2C_device_address )

Command Availability:

Only available in GCB I2C.h with release after 1/2014 Available on all microcontrollers except 12 bit
instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:
Should only be used when I2C routines are operating in Master mode, this command will look for a
specific I2C device on the I2C bus.

This sets a global variable I2CAckPollState that can be inspected in your calling routine.

Example:

 ...
' ACK polling removes the need to for the 24xxxxx device to have a 5ms write time
I2CACKPOLL( eeprom_device )
' You check the exit state, use I2CAckPollState to check the state of
' the acknowledge from the target device
 ...

Supported in <I2C.H>

I2CReceive

Syntax:

I2CReceive data
I2CReceive data, ack

Command Availability:

Available on all microcontrollers except 12 bit instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:

The I2CReceive command will send data through the I2C connection. If ack is TRUE, or no value is given
for ack, then I2CReceive will send an ack.

If in master mode, I2CReceive will read the data immediately.

If in slave mode, I2CReceive will wait for the master to send the data before reading. When the method
I2CReceive is used in Slave mode the global variable I2CMatch will be set to true when the received
value is equal to the constant I2C_ADDRESS.

Example 1 - Master Mode:

 ' I2C Receive - using the ChipIno board, see here for information. ' This program reads
an I2C register and LED is set to on if the value is over 100.
' This program will read from address 83, register 1.

#chip 16F886, 8
#config MCLRE_ON

'I2C settings
#define I2C_MODE Master
#define I2C_DATA PORTC.4
#define I2C_CLOCK PORTC.3

'Misc settings
#define LED PORTB.5
dir LED Out

'Main loop
Do
    'Send start
    I2CStart

    'Request value
    I2CSend 83
    I2CSend 1

    'Read value
    I2CReceive ValueIn

    'Send stop
    I2CStop

    'Turn on LED if received value > 100

    Set LED Off
    If ValueIn > 100 Then Set LED On

    'Delay
    Wait 20 ms

Loop

Example 2 - Slave Mode:

See the I2C Overview for the Master mode device to control this Slave mode device.

' I2CReceive_Slave.gcb - using a 16F88.

' This program receives commands from a GCB Master. This Slave has three LEDs attached.
;----- Configuration

#chip 16F88, 8
#config INTRC_IO,MCLR_OFF

#define I2C_MODE Slave ;this is a slave device now

#define I2C_CLOCK portb.4 ;SCL on pin 10
#define I2C_DATA portb.1 ;SDA on pin 7
#define I2C_ADDRESS 0x60 ;address of the slave device

;----- Variables

dim addr, reg, value as byte

;----- Program
#define LED0 porta.2 ;pin 1
#define LED1 porta.3 ;pin 2
#define LED2 porta.4 ;pin 3

dir LED0 out ;0, 1 and 2 are outputs (LEDs)

dir LED1 out ;0, 1 and 2 are outputs (LEDs)
dir LED2 out ;0, 1 and 2 are outputs (LEDs)

do
  I2CStart ;wait for Start signal
  I2CReceive( addr ) ;then wait for an address

  if I2CMatch = true then ;if it matches, proceed

    I2CReceive(regval, ACK) ;get the register number

    I2CReceive(value, ACK) ;and its value
    I2CStop ;release the bus from this end

    select case regval ;now turn proper LED on or off

      case 0:
        if value then
          set LED0 on
        else
          set LED0 off
        end if

      case 1:
        if value then
          set LED1 on
        else
          set LED1 off
         end if

      case 2:
        if value then
          set LED2 on
        else
          set LED2 off
        end if
      case else
                 ;other register numbers are ignored
    end select
  else
     I2CStop ;release bus in any event
  end if

loop

Supported in <I2C.H>

I2CReset

Syntax:

I2CReset

Command Availability:

Only available in GCB I2C.h with release after 1/2014

Available on all microcontrollers except 12 bit instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:

This will attempt a reset of the I2C by changing the state of the I2C bus.

Example:

 ...
I2CReset
 ...

Supported in <I2C.H>

I2CRestart

Syntax:
 I2CRestart

Command Availability:

Only available in GCB I2C.h with release after 1/2014

Available on all microcontrollers except 12 bit instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:

If the I2C routines are operating in Master mode, this command will send a start and restart condition
in a single command.

Example:

 ...
I2CRESTART
 ....

Supported in <I2C.H>

I2CSend

Syntax:

I2CSend data
I2CSend data, ack

Command Availability:

Available on all microcontrollers except 12 bit instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:

The I2CSend command will send data through the I2C connection. If ack is TRUE, or no value is given
for ack, then I2CSend will wait for an Ack from the receiver before continuing. If in master mode,
I2CSend will send the data immediately. If in slave mode, I2CSend will wait for the master to request the
data before sending.

Example 1:

' I2CSend - using the ChipIno board, see here for information.
' This program send commands to a GCB Slave with three LEDs attached.
 #chip 16F886, 8
#config MCLRE_ON

'I2C settings
#define I2C_MODE Master
#define I2C_DATA PORTC.4
#define I2C_CLOCK PORTC.3
#define I2C_BIT_DELAY 20 us
#define I2C_CLOCK_DELAY 30 us

#define I2C_ADDRESS 0x60 ;address of the slave device

;----- Variables

dim reg as byte

;----- Program

do

  for reg = 0 to 2 ;three LEDs to control

    I2CStart ;take control of the bus
    I2CSend I2C_ADDRESS ;address the device
    if I2CSendState = ACK then
      I2CSend reg ;address the particular register
      I2CSend ON ;command to turn on LED
    end if
    I2CStop ;relinquish the bus
    wait 100 ms
  next reg
  wait 1 S ;pause to show results

  for reg = 0 to 2 ;similarly, turn them off

    I2CStart ;take control of the bus
    I2CSend I2C_ADDRESS ;address the device
    if I2CSendState = ACK then
      I2CSend reg ;address the particular register
      I2CSend OFF ;command to turn off LED
    end if
    I2CStop ;relinquish the bus
    wait 100 ms
  next reg
  wait 1 S ;pause to show results

loop

Example 2:
 'This program will act as an I2C analog to digital converter
'When data is requested from address 83, registers 0 through
'3, it will return the value of AN0 through AN3.

'Chip model
#chip 16F88, 8

'I2C settings
#define I2C_MODE Slave
#define I2C_CLOCK PORTB.0
#define I2C_DATA PORTB.1

#define I2C_DISABLE_INTERRUPTS ON

'Main loop
Do
    'Wait for start condition
    I2CStart

    'Get address
    I2CReceive Address
    If Address = 83 Then
        'If address was this device's address, respond
        I2CReceive Register

        OutValue = ReadAD(Register)
        I2CSend OutValue
    End If

    I2CStop

    Wait 5 ms
Loop

Supported in <I2C.H>

I2CStart

Syntax:

I2CStart

Command Availability:

Available on all microcontrollers except 12 bit instruction PICs (10F, 12F5xx, 16F5xx chips)
Explanation:

If the I2C routines are operating in Master mode, this command will send a start condition. If routines
are in Slave mode, it will pause the program until a start condition is sent by the master. It should be
placed at the start of every I2C transmission.

If interrupt handling is enabled, this command will disable it.

Example:

Please see I2CSend and I2CReceive for an example.

Supported in <I2C.H>

I2CStop

Syntax: I2CStop

Command Availability:

Available on all microcontrollers except 12 bit instruction PICs (10F, 12F5xx, 16F5xx chips)

Explanation:

When in Master mode, this command will send an I2C stop condition, and re-enable interrupts if
I2CStart disabled them. In Slave mode, it will re- enable interrupts.

I2CStop should be called at the end of every I2C transmission.

Example:

Please see I2CSend and I2CReceive for an example.

Supported in <I2C.H>

I2C/TWI Hardware Module

HI2C Overview

Introduction:

These methods allow GCBASIC programs to send and receive Inter- Integrated Circuit (I2C™) messages
via:

1. The Master Synchronous Serial Port (MSSP) module of the microcomputer for the Microchip
architecture

2. Or, ATMEL 2-wire Serial Interface (TWI) for the AVR microcontroller architecture.

These methods are serial interfaces that are useful for communicating with other peripheral or
microcontroller devices. These peripheral devices may be serial EEPROMs, shift registers, display
drivers, A/D converters, etc.

The method can operate in one of two operational modes:

1. Master Mode, or

2. Slave mode (with general address call)

The method in I2C mode fully implements all master and slave functions (including general call
support) and provides interrupts on start and stop bits in hardware to determine a free bus (multi-
master function).

The method implements the standard mode specifications as well as 7-bit and 10-bit addressing. A
“glitch” filter is built into the SCL and SDA pins when the pin is an input. This filter operates in both
the 100 KHz and 400 KHz modes. In the 100 KHz mode, when these pins are an output, there is a slew
rate control of the pin that is independent of device frequency.

The method supports the following frequencies:

1. I2C fast mode: Defined as transfer rates up to 400 kbit/s.

2. I2C/TWO standard mode: Defined as transfer rates up to 100 kbit/s.

3. I2C fast-mode plus is not supported. Allowing up to 1 Mbit/s.

4. I2C high speed mode is not supported: Allowing up to 3.4 Mbit/s.

A hardware I2C module within the microcontroller is required for these methods.

The driver supports two hardware I2C ports. The second port is addressed by the suffix HI2C2. All
HI2C commands are applicable to the second HI2C2 port.

Relevant Constants:

These constants control the setup of the hardware I2C methods:

Constant Controls Usage

Master Operational mode of the HI2CMode ( Master )

microcomputer

Slave Operational mode of the HI2CMode ( Slave)

microcomputer

HI2C_BAUD_RATE Operational speed of the #define HI2C_BAUD_RATE 400

microcomputer. Defaults to
100mhz

Port Settings:

The settings of the pin direction is critical to the operation of these methods. Both pins must be set as
inputs and be pulled up with an appropriate resistor (typically 4.k @ 5.0v for 100Mkz transmissions).

Constant Controls Default Value

HI2C_DATA Pin on microcontroller None

connected to I2C data

HI2C_CLOCK Pin on microcontroller None

connected to I2C clock)

Example:

This example examines the IC2 devices and displays on a serial terminal. This code will require
adaption but the code shows an approach to discover the IC2 devices.

' Hardware I2C Overview - using the ChipIno board, see

' http://www.elproducts.com/chipino.html[here] for information

#chip mega328p, 16
#config MCLRE_ON

' Define I2C settings

#define HI2C_BAUD_RATE 400
#define HI2C_DATA PORTC.5
#define HI2C_CLOCK PORTC.4
'I2C pins need to be input for SSP module when used on Microchip device
Dir HI2C_DATA in
Dir HI2C_CLOCK in

'MASTER MODE
HI2CMode Master

'USART/SERIAL PORT WORKS WITH max232 THEN TO PC Terminal

#define USART_BAUD_RATE 9600
Dir PORTc.6 Out
#define USART_DELAY 10 ms

HSerPrintCRLF 2
HSerPrint "Hardware I2C Discover using the "
HSerPrint CHipNameStr
HSerPrintCRLF 2

for deviceID = 0 to 255

    HI2CStart
    HI2CSend ( deviceID )

    if HI2CAckPollState = false then

        if (( deviceID & 1 ) = 0 ) then
         HSerPrint "W"
      else
         HSerPrint "R"
      end if
      HSerSend 9
      HSerPrint "ID: 0x"
      HSerPrint hex(deviceID)
      HSerSend 9
      HSerPrint "(d)"+str(deviceID)
      HSerPrintCRLF

      HI2CSend ( 0 )
      HI2CSend ( 0 )
    end if

    HI2CStop
next
HSerPrintCRLF
HSerPrint "End of Device Search"
HSerPrintCRLF 2

Supported in <HI2C.H>

HI2CAckPollState

Syntax:

<test condition[s]> HI2CAckPollState

Command Availability:

Only available in GCB HI2C.h with release after 6/2014 and microcontrollers with the hardware I2C or
TWI module.

Explanation:

Should only be used when I2C routines are operating in Master mode, this command will return the
last state of the acknowledge response from a specific I2C device on the I2C bus.

HI2CSend sets the state of variable HI2CAckPollState.

HI2CAckPollStatecan can only read - it cannot be set.

Example:

This example code would display only the devices on the I2C bus.
  ...
for deviceID = 0 to 255
  HI2CStart
  HI2CSend ( deviceID )

  if HI2CAckPollState = false then

    HSerPrint "ID: 0x"
    HSerPrint hex(deviceID)
    HSerSend 9
  end if
next
 ...

Supported in <HI2C.H>

HI2CReceive

Syntax:

HI2CReceive data

HI2CReceive data, ACK

HI2CReceive data, NACK

Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.

Explanation:

The HI2CReceive command will send data through the I2C connection. If ack is TRUE, or no value is
given for ack, then I2CReceive will send an ack to the I2C bus.

If in master mode, I2CReceive will read the data immediately. If in slave mode, I2CReceive will wait for
the master to send the data before reading.

NOTE This command is also available on microcomputers with a second hardware I2C port.

Example 1:

'This program reads an I2C register and sets an LED if it is over 100.

'It will read from I2C device with an address of 83, register 1.
' Change the processor
#chip 16F1937, 32
 #config Osc = intOSC, MCLRE_ON, PLLEN_ON, VCAPEN_OFF

' Define I2C settings

#define HI2C_BAUD_RATE 400

#define HI2C_DATA PORTC.4

  #define HI2C_CLOCK PORTC.3

'I2C pins need to be input for SSP module

Dir HI2C_DATA in
Dir HI2C_CLOCK in

'MASTER I2C Device

HI2CMode Master

'Misc settings
#define LED PORTB.0

'Main loop
Do
    'Send start
    HI2CStart

    'Request value
    HI2CSend 83
    HI2CSend 1

    'Read value
    HI2CReceive ValueIn

    'Send stop
    HI2CStop

    'Turn on LED if received value > 100

    Set LED Off
    If ValueIn > 100 Then Set LED On

    'Delay
    Wait 20 ms

Loop

Example 2:

See the I2C Overview for the Master mode device to control this Slave mode device.
' I2CHardwareReceive_Slave.gcb - using a 16F88.
' This program receives commands from a GCB Master. This Slave has three LEDs attached.

; This Slave device responds to address 0x60 and may only be written to.
; Within it, there are three registers, 0,1 and 2 corresponding to the three LEDs.
Writing a zero
; turns the respective LED off. Writing anything else turns it on.

#chip 16F88, 4
#config INTRC_IO,MCLR_Off

#define I2C_MODE Slave ;this is a slave device now

#define I2C_CLOCK portb.4 ;SCL on pin 10
#define I2C_DATA portb.1 ;SDA on pin 7
#define I2C_ADDRESS 0x60 ;address of the slave device

#define I2C_BIT_DELAY 20 us
#define I2C_CLOCK_DELAY 10 us
#define I2C_END_DELAY 10 us

'Serial settings
#define SerInPort PORTB.6
#define SerOutPort PORTB.7

#define SendAHigh Set SerOutPort OFF

#define SendALow Set SerOutPort On
'Set pin directions
Dir SerOutPort Out
Dir SerInPort In

'Set up serial connection

InitSer 1, r2400, 1 + WaitForStart, 8, 1, none, INVERT
wait 1 s

#define LED0 porta.2 ;pin 1

#define LED1 porta.3 ;pin 2
#define LED2 porta.4 ;pin 3

;----- Variables

dim addr, reg, value,location as byte

addr = 255
reg = 255
value = 255
location = 0
mempointer = 255
;----- Program

dir LED0 out ;0, 1 and 2 are outputs (LEDs)

dir LED1 out ;0, 1 and 2 are outputs (LEDs)
dir LED2 out ;0, 1 and 2 are outputs (LEDs)

set LED0 off

set LED1 off
set LED2 off

#define SerialControlPort portb.3

dir SerialControlPort in

'Set up interrupt to process I2C

   dir I2C_CLOCK in ; required to input for MSSP module

   dir I2C_DATA in ; required to input for MSSP module
   SSPADD=I2C_ADDRESS ; Slave address
   SSPSTAT=b'00000000' ; configuration
   SSPCON=b'00110110' ; configuration
   PIE1.SSPIE=1 ; enable interrupt

repeat 3 ;flash LEDs

  set LED0 on
  set LED1 on
  set LED2 on
  wait 50 ms
  set LED0 off
  set LED1 off
  set LED2 off
  wait 100 ms
end Repeat

oldvalue = 255 ; old value, set up value only

oldreg = 255 ; old value, set up value only

UpdateLEDS ; call method to set LEDs

                              ; set up interrupt
On Interrupt SSP1Ready call I2C_Interrupt

do forever
   if reg <> oldreg then ; only process when the reg is a new value
      oldreg = reg ; retain old value
      show = 1 ; its time to show the LEDS!
      if value <> oldvalue then ; logic for tracking old values. You only want to
update terminal once per change
          oldvalue = value
          show = 1
      end if
   end if

   UpdateLEDS ; Update date LEDs

                               ; update serial terminal

   if show = 1 and SerialControlPort = 1 then

        SerPrint 1, "0x"+hex(addr)
        SerSend 1,9

        SerPrint 1, STR(reg)
        SerSend 1,9

        SerPrint 1, STR(value)
        SerSend 1,10
        SerSend 1,13

        show = 0
   end if
loop

Sub I2C_Interrupt
    ' handle interrupt
    IF SSPIF=1 THEN ; its a valid interrupt

       IF SSPSTAT.D_A=0 THEN ; its an address coming in!

          addr=SSPBUF
          IF addr=I2C_ADDRESS THEN ; its our address

             mempointer = 0 ; set the memory pointer. This code emulates an

EEPROM!

          end if
          IF addr = ( I2C_ADDRESS | 1 ) THEN ; its our write address
             CKP = 0 ; acknowledge command
                                                ; If the SDA line was low (ACK), the
transmit data must be loaded into
                                                ; the SSPBUF register which also loads
the SSPSR
                                                ; register. Then, pin RB4/SCK/SCL should
be enabled
                                                ; by setting bit CKP.

             mempointer = 10 ; set a pointer to track incoming write

reqests
             if I2C_DATA = 0 then
                SSPBUF = 0x22
                CKP = 1
                readpointer = 0x55
             end if
          end if

       else

         if SSPSTAT.P = 1 then ' Stop bit has been detected - out of
sequence
             ' handle event
         end if

         IF SSPSTAT.S = 1 THEN ' Start bit has been detected - out of
sequence
             ' handle event
         END IF

         IF SSPSTAT.R_W = 0 THEN ' Write operations requested

            SELECT CASE mempointer

                   CASE 0
                        reg = SSPBUF ' incoming value
                        mempointer++ ' increment our counter
                   CASE 1
                        value = SSPBUF ' incoming value
                        mempointer++ ' increment our counter
                   CASE ELSE
                        dummy = SSPBUF ' incoming value
            END SELECT

         ELSE ' Read operations

            SSPBUF = readpointer ' incoming value
            readpointer++ ' increment our counter

         END IF
       END IF
       CKP = 1 ' acknowledge command
       SSPOV = 0 ' acknowledge command
    END IF
    SSPIF=0
END SUB

sub UpdateLEDS
     select case reg ;now turn proper LED on or off
      case 0
        if value = 1 then
          set LED0 on
        else
          set LED0 off
        end if

      case 1
        if value = 1 then
          set LED1 on
        else
          set LED1 off
        end if

      case 2
        if value = 1 then
          set LED2 on
        else
          set LED2 off
        end if

    end select

End Sub

Supported in <HI2C.H>

HI2CRestart

Syntax:

HI2CRestart

Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.

Explanation:

If the HI2C routines are operating in Master mode, this command will send a start and restart
condition in a single command.

NOTE This command is also available on microcomputers with a second hardware I2C port.
Example:

do
        HI2CReStart ;generate a start signal
        HI2CSend(eepDev) ;inidcate a write
        loop While HI2CAckPollState

        HI2CSend(eepAddr_H) ;as two bytes

        HI2CSend(eepAddr)
        HI2CReStart
        HI2CSend(eepDev + 1) ;indicate a read

        eep_i = 0 ;loop consecutively

        do while (eep_i < eepLen) ;these many bytes
          eep_j = eep_i + 1 ;arrays begin at 1 not 0
          if (eep_i < (eepLen - 1)) then
            HI2CReceive(eepArray(eep_j), ACK) ;more data to get
          else
            HI2CReceive(eepArray(eep_j), NACK ) ;send NACK on last byte
          end if
          eep_i++ ;get set for next
        loop
        HI2CStop

Supported in <HI2C.H>

HI2CSend

Syntax:

HI2CSend data

Command Availability:

Only available for microcontrollers with the MSSP module.

Explanation:

The HI2CSend command will send data through the I2C connection. If in master mode, HI2CSend will
send the data immediately. If in slave mode, HI2CSend will wait for the master to request the data
before sending.

Example:

This example code retrieves multiple bytes from an EEPROM memory device.
         do
          HI2CReStart ;generate a start signal
          HI2CSend(eepDev) ;indicate a write
        loop While HI2CAckPollState

        HI2CSend(eepAddr_H) ;as two bytes

        HI2CSend(eepAddr)
        HI2CReStart
        HI2CSend(eepDev + 1) ;indicate a read

        eep_i = 0 ;loop consecutively

        do while (eep_i < eepLen) ;these many bytes
          eep_j = eep_i + 1 ;arrays begin at 1 not 0
          if (eep_i < (eepLen - 1)) then
            HI2CReceive(eepArray(eep_j), ACK) ;more data to get
          else
            HI2CReceive(eepArray(eep_j), NACK ) ;send NACK on last byte
          end if
          eep_i++ ;get set for next
        loop
        HI2CStop

Supported in <HI2C.H>

HI2CStart

Syntax:

HI2CStart

Command Availability:

Only available for microcontrollers with the MSSP module..

Explanation:

If the HI2C routines are operating in Master mode, this command will send a start condition. If
routines are in Slave mode, it will pause the program until a start condition is sent by the master. It
should be placed at the start of every I2C transmission.

Example:

Please see HI2CSend and HI2CReceive for examples.

Supported in <HI2C.H>
HI2CStartOccurred

Syntax:

HI2CStartOccurred

Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.

Explanation:

Check if a start condition has occurred since the last run of this function

Only used in slave mode.

NOTE This command is also available on microcomputers with a second hardware I2C port.

Supported in <HI2C.H>

HI2CMode

Syntax:

HI2CMode Master | Slave

Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.

Explanation:

Sets the microcontroller to either a Master device or a Slave device.

Only used in slave mode

NOTE This command is also available on microcomputers with a second hardware I2C port.

Supported in <HI2C.H>

HI2CSetAddress

Syntax:

HI2CSetAddress <number>
Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.

Explanation:

Sets the microcontroller address in Slave mode.

Only used in slave mode.

NOTE This command is also available on microcomputers with a second hardware I2C port.

Supported in <HI2C.H>

HI2CStop

Syntax:

HI2CStop

Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.

Explanation:

HI2CStop should be called at the end of every I2C transmission.

Example:

Please see HI2CSend and HI2CReceive for an example.

NOTE This command is also available on microcomputers with a second hardware I2C port.

Supported in <HI2C.H>

HI2CStopped

Syntax:

HI2CStopped

Command Availability:

Only available for microcontrollers with the hardware I2C or TWI module.
Explanation:

In Slave mode only. Check if start condition received since last used of HI2CStopped.

NOTE This command is also available on microcomputers with a second hardware I2C port.

Supported in <HI2C.H>

Sound
Sound Overview

Introduction:

These routines generate tones of a given frequency and duration.

Note: If an exact frequency is required, or a smaller program is needed, these routines should not be
used. Instead, you should use code like this:

Repeat count
PulseOut SoundOut, period us
Wait period us
End Repeat

Set count and period to the appropriate values:

• period to 1000000 / desired frequency / 2

• count to desired duration / period.

Relevant Constants:

These constants are used to control settings for the tone generation routines. To set them, place a line
in the main program file that uses #define to assign a value to the particular constant.

Constant Name Controls Default Value

SoundOut The output pin to produce sound N/A - Must be set

on

Tone

Syntax:

Tone Frequency, Duration

Command Availability:

Available on all microcontrollers.

Explanation:

This command will produce the specified tone for the specified duration. Frequency is measured in Hz,
and Duration is in 10 ms units.

Please note that this command may not produce the exact frequency specified. While it is accurate
enough for error beeps and small pieces of monophonic music, it should not be used for anything that
requires a highly precise frequency.

Example:

'Sample program to produce a constant A note (440 Hz)

'on PORTB bit 1.
#chip 16F877A, 20
#define SoundOut PORTB.1

Do
    Tone 440, 1000
Loop

For more help, see Sound Overview

ShortTone

Syntax:

ShortTone Frequency, Duration

Command Availability:

Available on all microcontrollers.

Explanation:

This command will produce the specified tone for the specified duration. Frequency is measured in
units of 10 Hz, and Duration is in 1 ms units. Please note that this command may not produce the exact
frequency specified. While it is accurate enough for error beeps and small pieces of monophonic
music, it should not be used for anything that requires a highly precise frequency.

Example:
 'Sample program to produce a tone on PORTB bit 1, based on the
'reading of an LDR on AN0 (usually PORTA bit 0).

#chip 16F88, 20
#define SoundOut PORTB.1

Dir PORTA.0 In

Do
    ShortTone ReadAD(AN0), 100
Loop

For more help, see Sound Overview

Timers
Timer Overview

Several functions are provided to read the current timer value. They are:

• Timer0
• Timer1

• Timer2

• Timer3

• Timer4

• Timer5

• Timer6

Not all of these functions are available on all chips. For example, if a chip only has 3 timers, then only
Timer0, Timer1 and Timer2 will be available. Timer0 and Timer2 return byte values, while Timer1, Timer3,
Timer4, Timer5 and Timer6 will return words.

Please refer to the datasheet for your microcontroller to determine the number and size of the timers
available.

ClearTimer

Syntax:

ClearTimer TimerNo

Command Availability:
Available on all PIC and AVR microcontrollers with built in timer modules.

Explanation:

ClearTimer is used to clear the specified timer.

Example:

Please refer to the InitTimer1 article for an example.

InitTimer0

Syntax:

InitTimer0 source, prescaler

Command Availability:

Available on all microcontrollers with a Timer 0 module.

Explanation:

InitTimer0 will set up timer 0, according to the settings given. `source can be Osc or Ext.

On a PIC microcontroller, prescaler can be one of the following constants:

Prescaler Value Primary Constant Secondary Constant Constant Equates

to value

1/2 PS0_2 PS0_1/2 0

1/4 PS0_4 PS0_1/4 1

1/8 PS0_8 PS0_1/8 2

1/16 PS0_16 PS0_1/16 3

1/32 PS0_32 PS0_1/32 4

1/64 PS0_64 PS0_1/64 5

1/128 PS0_128 PS0_1/128 6

1/256 PS0_256 PS0_1/256 7

These correspond to a prescaler of between 1/2 and 1/256 the oscillator speed. The prescaler will apply
to either the oscillator or the external clock input.

On an AVR microcontroller, prescaler can be one of these constants:

 Prescaler Value Primary Constant Secondary Constant Constant Equates
to value

1 PS_1 PS0_1/2 1

8 PS_8 PS0_1/4 2

64 PS_16 PS0_1/8 3

128 PS_32 PS0_1/16 4

1024 PS_1024 PS0_1/32 5

These correspond to a prescaler of between 1/1 and 1/1024 times the original input frequency. On the
AVR, the prescaler will only apply when the timer is driven from the internal oscillator - the prescaler
has no effect on the external clock pulse.

When the timer overflows from 255 to 0, a Timer0Overflow interrupt will be generated. This can be
used in conjunction with On Interrupt to run a section of code periodically.

Example:

'This code will use Timer 0 and On Interrupt to generate a Pulse

'Width Modulation signal, that will allow the speed of a motor to
'be easily controlled.

#chip 16F88, 8
#config osc = int

#define MOTOR PORTB.0

'Call the initialisation routine

InitMotorControl

'Main routine
Do
    'Increase speed to full over 2.5 seconds
    For Speed = 0 to 100
        MotorSpeed = Speed
        Wait 25 ms
    Next
    'Hold speed
    Wait 1 s
    'Decrease speed to zero over 2.5 seconds
    For Speed = 100 to 0
        MotorSpeed = Speed
        Wait 25 ms
    Next
    'Hold speed
     Wait 1 s
Loop

'Setup routine
Sub InitMotorControl
    'Clear variables
    MotorSpeed = 0
    PWMCounter = 0

    'Add a handler for the interrupt

    On Interrupt Timer0Overflow Call PWMHandler

    'Set up the timer

    InitTimer0 Osc, PS0_2
    'Timer 0 starts automatically on a PIC
End Sub

'PWM sub
'This will be called when Timer 0 overflows
Sub PWMHandler
    If MotorSpeed > PWMCounter Then
        Set MOTOR On
    Else
        Set MOTOR Off
    End If
    PWMCounter += 1
    If PWMCounter = 100 Then PWMCounter = 0
End Sub

Supported in <TIMER.H>

InitTimer1

Syntax:

InitTimer1 source, prescaler

Command Availability:

Available on all microcontrollers with a Timer 1 module.

Explanation:

InitTimer1 will set up timer 1, according to the settings given. source can be Osc , Ext or ExtOsc (ExtOsc is
only available on PIC microcontrollers). On a PIC, prescaler can be one of the following settings:
 • PS1_1

• PS1_2

• PS1_4

• PS1_8

On an AVR chip, the following options are available for prescaler:

• PS_1

• PS_8

• PS_64

• PS_256

• PS_1024

Example:

'This example will measure that time that a switch stays on for
#chip 16F819, 20
#define Switch PORTA.0

Dir Switch In
DataCount = 0
InitTimer1 Osc, PS1_8

Dim TimerValue As Word

Do
    ClearTimer 1
    Wait Until Switch = On
    StartTimer 1
    Wait Until Switch = Off
    StopTimer 1

    'Read the timer

    TimerValue = Timer1

    'Log the timer value

    EPWrite(DataCount, TimerValue_H)
    EPWrite(DataCount + 1, TimerValue)
    DataCount += 2
Loop
InitTimer2

Syntax:

 InitTimer2 prescaler, postscaler

Command Availability:

Available on all microcontrollers with a Timer 2 module.

Explanation:

InitTimer2 will set up timer 2, according to the settings given. . On a PIC. prescaler can be one of the
following settings:

- PS2_1/1 0
- PS2_1/4 1
- PS2_1/16 2
- PS2_1 0
- PS2_4 1
- PS2_16 2

postscaler slows the rate of the interrupt generation (or WDT reset) from a counter/timer by dividing it
down. Postscaler values from 1:1 to 1:16

InitTimer3

Syntax:

InitTimer3 source, prescaler

Command Availability:

Available on all microcontrollers with a Timer 3 module.

Explanation:

InitTimer3 will set up timer 3, according to the settings given. source can be Osc , Ext or ExtOsc (ExtOsc is
only available on PIC microcontrollers). On a PIC, prescaler can be one of the following settings:
 · PS3_1/1 0
· PS3_1/2 16
· PS3_1/4 32
· PS3_1/8 48
· PS3_1 0
· PS3_2 16
· PS3_4 32
· PS3_8 48

On an AVR chip, the following options are available for prescaler:

· PS_1
· PS_8
· PS_64
· PS_256
· PS_1024

InitTimer4

Syntax:

InitTimer4 source, prescaler

Command Availability:

Available on all microcontrollers with a Timer 4 module.

Explanation:

InitTimer4 will set up timer 4, according to the settings given. source can be Osc , Ext or ExtOsc (ExtOsc is
only available on PIC microcontrollers). On a PIC, prescaler can be one of the following settings:

· PS4_1/1 0
· PS4_1/4 1
· PS4_1/16 2
· PS4_1/64 3
· PS4_1 0
· PS4_4 1
· PS4_16 2
· PS4_64 3

On an AVR chip, the following options are available for prescaler:

 · PS_1
· PS_8
· PS_64
· PS_256
· PS_1024

InitTimer6

Syntax:

InitTimer6 source, prescaler

Command Availability:

Available on all microcontrollers with a Timer 6 module.

Explanation:

InitTimer6 will set up timer 6, according to the settings given. source can be Osc , Ext or ExtOsc (ExtOsc is
only available on PIC microcontrollers). On a PIC, prescaler can be one of the following settings:

· PS6_1/1 0
· PS6_1/4 1
· PS6_1/16 2
· PS6_1/64 3
· PS6_1 0
· PS6_4 1
· PS6_16 2
· PS6_64 3

On an AVR chip, the following options are available for prescaler:

· PS_1
· PS_8
· PS_64
· PS_256
· PS_1024

Settimer

Syntax:
 Settimer timernumber, value

Command Availability:

Available on all microcontrollers with a Timer modules.

Explanation:

This will correctly set 8 bit and 16 bit timers.

StartTimer

Syntax:

StartTimer TimerNo

Command Availability:

Available on all PIC and AVR microcontrollers with built in timer modules.

Explanation:

StartTimer is used to start the specified timer. Note that it cannot be used to start Timer 0 on a PIC - this
timer always runs.

Example:

Please refer to the InitTimer1 article for an example.

StopTimer

Syntax:

StopTimer TimerNo

Command Availability:

Available on all PIC and AVR microcontrollers with built in timer modules.

Explanation:

StopTimer is used to stop the specified timer. Note that it cannot be used to stop Timer 0 on a PIC - this
timer always runs.

Example:
Please refer to the InitTimer1 article for an example.

Reading Timers

Several functions are provided to read the current timer value. They are:

· Timer0
· Timer1
· Timer2
· Timer3
· Timer4
· Timer5
· Timer6

Not all of these functions are available on all chips. For example, if a chip only has 3 timers, then only
Timer0, Timer1 and Timer2 will be available. Timer0 and Timer2 return byte values, while Timer1, Timer3,
Timer4, Timer5 and Timer6 will return words.

Please refer to the datasheet for your microcontroller to determine the number and size of the timers
available.

Variables Operations
Using Variables

Variables

Using and accessing bytes within word and long numbers etc may be required when you are creating
your solution. This can be done with some ease.

You can access the bytes within word and longs variables using the following as a guide using the
Suffixes _H, _U and _E

Dim workvariable as word

workvariable = 21845
Dim lowb as byte
Dim highb as byte
Dim upperb as byte
Dim lastb as byte

lowb = workvariable
highb = workvariable_H
upperb = workvariable_U
lastb = workvariable_E
To further explain, where

Dim rB as Byte
Dim sW as Word
Dim sW as Word

To extract the bytes from a WORD of 16 bits use the Suffix _H

'To use the bits 7-0 [lower byte] in the Word variable sW
rB = sW

'For bits 15-8 [upper byte] in the Word variable sW, use sw_H
rB = sW_H

To extract the bytes from a LONG of 32 bits use the Suffixes _H, _U and _E, where

Dim rB as Byte
Dim sW as Word
Dim tL as Long

‘ For bits 7-0 [lowest byte #0] in Long variable tL

rB = tL

‘ For bits 15-8 [lower middle byte #1] in Long variable tL

rB = tL_H

‘ For bits 23-16 [upper middle byte #2] in Long variable tL

rB = tL_U

‘ For bits 31-24 [highest byte #3] in Long variable tL

rB = tL_E

To extract nibbles from the variable rB

lower_nibble = rB & 0x0F

upper_nibble = (rB & 0xF0) / 16

More on setting Variables and Constants

Variables

Within Great Cow Basic you can use regular variable assignments. But, you can also use C like maths
assignments.
The following methods are also supported.

GLCDPrintLoc += 6
CharCode -= 15
CharCode++
CharCode---

Within Great Cow Basic you can define constants, see Constants. Please note what is and what is not
support with respect to assigning numbers to constants. An example program examines what is
supported.

#chip 16F88, 4
#config Osc = INT, MCLRE_OFF

' All these work

#define Test0 b'11111111'
#define Test1 0b11111111
#define Test2 0B11111111
#define Test3 255
#define Test4 0xFF
#define Test5 0xff
#define Test6 0Xff

# Proof
dir porta Out

porta = test0
porta = test1
porta = test2
porta = test3
porta = test4
porta = test5
porta = test6

You can assigned values/numbers with all the methods shown above (for constants and variables) but
please be aware that you must Use '0' not '00'. One zero equates to zero and two zeros will give you an
unassigned variable.

Constants

A few critical constants are defined within Great Cow Basic , you can re- use this constants. They
include:
 #define ON 1 ' These are defined in System.h
#define OFF 0
#define TRUE 255
#define FALSE 0
 +
#define OSC = 1 ' These are defined in TIMER.H
#define EXT = 2 ' and, are used by InitTimer0 command
#define EXTOSC = 3

Setting Variables

Syntax:

Variable = data

Explanation:

Variable will be set to data. data can be either a fixed value (such as 157), another variable, or a sum.

All unknown byte variables are assigned Zero. A variable with the name of Forever is not defined by
GCBasic and therefore defaults to the value of zero.

If data is a fixed value, it must be an integer between 0 and 255 inclusive.

If data is a calculation, then it may have any of the following operands:

· + (add)
· - (subtract, or negate if there is no value before it)
· * (multiply)
· / (divide)
· % (modulo)
· & (and)
· | (or)
· # (xor)
· ! (not)
· = (equal)
· <> (not equal)
· < (less than)
· > (greater than)
· <= (less than or equal)
· >= (more than or equal)

The final 6 operands are for checking conditions. They will return FALSE (0) if the condition is false, or
TRUE (255) if the condition is true.
The And, Or, Xor and Not operators function both as bitwise and logical operators.

Three of the relational operators supported language have alternatives.

~ can be used in place of <>
NOTE
{ can be used in place of ⇐
} can be used in place of >=

+ Please do not use, this information is provided for information only.

GCBASIC understands order of operations. If multiple operands are present, they will be processed in
this order:

1. Brackets

2. Unary operations (not and negate)

3. Multiply/Divide/Modulo

4. Add/Subtract

5. Conditional operators

6. And/Or/Xor

There are several modes in which variables can be set. GCBASIC will automatically use a different
mode for each calculation, depending on the type of variable being set. If a byte variable is being set,
byte mode will be used; if a word variable is being set, word mode will be used. If a byte is being set
but the calculation involves numbers larger than 255, word mode can be used by adding [WORD] to
the start of one of the values in the calculation. This is known as casting - refer to the Variables article
for more information.

If you prefer, you can add Let to the start of the line. It will not alter the execution of the program, but
is included for those who are used to including it in other BASIC dialects.

Example:

'This program is to illustrate the setting of variables.

Chipmunk = 46 'Sets the variable Chipmunk to 46
Animal = Chipmunk 'Sets the variable Animal to the value of the variable Chipmunk
Bear = 2 + 3 * 5 'Sets the variable Bear to the result of 2 + 3 * 5, 17.
Sheep = (2 + 3) * 5 'Sets the variable Sheep to the result of (2 + 3) * 5, 25.
Animal = 2 * Bear 'Sets the variable Animal to twice the value of Bear.

LargeVar = 321 'LargeVar must be set as a word - see DIM.

Temp = LargeVar / [WORD]5 'Note the use of [WORD] to ensure that the calculation is
performed correctly
Dim

Dim has two uses, both of which involve large variables. It can be used to define arrays, and to declare
variables larger than 1 byte.

Syntax:

For Variables > 1 byte:

Dim variable[, variable2 [, variable3 ]] [As type ] [Alias othervar [, othervar2 ]] [At
location ]

For Arrays:
Dim array(size) [At location]

Command Availability:

Available on all microcontrollers.

Explanation:

The Dim variable command is used to inform GCBASIC of variables that are larger than 1 byte, or to
create alternate names for other variables.

The Dim array command also sets up array variables. The maximum array size is determined by the
parameter size is dynamically allocated by the compiler and depends on the specific chip used, as well
as the complexity of the program.

The limit on array size varies dependent on the chip type. The 12F/16F series of chips the array limit is
80 elements. For the AVR or an 18F there is not limit other than free RAM however Great Cow Basic
limits the array size to 10,000 elements. If a memory limit is reached, the compiler will give an error
message.

type specifies the type of variable that is to be created. Different variable types can hold values over
different ranges, and use different amounts of RAM. See the Variables article for more information.

When multiple variables are included on the one line, GCBASIC will set them all to the type that is
specified at the end of the line. If there is no type specified, then GCBASIC will make the variable a byte.

Alias creates a variable using the same memory location as one or more other variables. It is mainly
used internally in GCBASIC to treat system variables as a word. For example, this command is used to
create a word variable, made up from the two memory locations used to store the result of an A/D
conversion:

A variable can be placed at a specific location in the data memory of the chip using the At option.
location will be used whether it is a valid location or not, but a warning will be generated if GCBASIC
has already allocated the memory, or if the memory does not appear to be valid. This can be used for
peripherals that have multi byte buffers in RAM.

Dim ADResult As Word Alias ADRESH, ADRESL

Example:

'This program will set up an array, and a word variable

dim DataList(10)
dim Reading as word

Reading = 21978
DataList(1) = 15

dim stringvariable as string

For more help, see: the SerPrint article uses Dim to create string variables and Variables for more
details in creating and managing strings lengths.

BcdToDec_GCB

Syntax:

BcdToDec_GCB ( ByteVariable )

Command Availability:

Only available in GCB compiler post 1/2014

Available on all microcontrollers.

Support Bytes only.

Explanation:

Converts numbers from Binary Coded Decimal format to decimal.

GCB from Feb 2014 has this function built.

But, you can easily add it with this function below. Just add this to your GCB program and then call it
when you need it.

Example:
 Function BcdToDec(va) as byte
    BcdToDec=(va/16)*10+va%16
End Function

Also see DecToBcd_GCB

DecToBcd_GCB

Syntax:

DectoBcd( ByteVariable )

Command Availability:

Only available in GCB compiler post 1/2014

Available on all microcontrollers.

Support Bytes only.

Explanation:

Converts numbers from Decimal to Binary Coded Decimal format.

GCB from Feb 2014 has this function built.

But, you can easily add it with this function below. Just add this to your GCB program and then call it
when you need it.

Example:

Function DecToBcd(va) as Byte

   DecToBcd=(va/10)*16+va%10
End Function

Also see BcdToDec_GCB

Rotate

Syntax:

Rotate variable {Left | Right} [Simple]

Command Availability:

Available on all microcontrollers.

Explanation:

The Rotate command will rotate variable one bit in a specified direction. The bit shifted will be placed
in the Carry bit of the Status register (STATUS.C). STATUS.C acts as a ninth bit of the variable that is being
rotated.

variable supports Bytes, Word and Long variables.

When a variable is rotated right, the bit in the STATUS.C location is placed into the MSB of the variable
being rotated, and the LSB of the variable is placed into STATUS.C location.

When rotated left the opposite occurs. The MSB of the variable is shifted to the STATUS.C bit and the
LSB of the variable will contain what was previously in the STATUS.C bit location. This table shows the
operation of the Rotate Left command

Command variable STATUS.C

Values at start: b'01110011' 0

Rotate Left b'11100110' 0

Rotate Left again b'11001100' 1

Rotate Left third time b'10011001' 1

As you may notice the STATUS.C bit added a 0 to the rotation. So this will take 9 shifts left to get back to
the original value.

Simple option

Many times you want to rotate the variable around like the STATUS.C bit wasn’t there so the MSB of the
variable fills the LSB of the variable on Rotate Left or the LSB fills the MSB on Rotate Right. That is
where the SIMPLE option comes in. It adds a hidden step that shifts the STATUS.C bit twice so the bit
moves from one end of the variable to the other.

Command variable STATUS.C

Values at start: b'01110011' 0

Rotate Left b'11100110' 0

Rotate Left again b'11001101' 1

Rotate Left third time b'10011011' 1

Known as SREG bit C, or simply C flag on AVR.

Example:

'This program will use Rotate to show a chasing LED.

'8 LEDs should be connected to PORTB, one on each pin.

#chip 16F819, 8
#config osc = int

'Set port direction

Dir PORTB Out

'Set initial state of port (bits 0 and 4 on)

PORTB = b'00010001'

'Chase
Do
    Rotate PORTB Right Simple
    Wait 250 ms
Loop

Set

Syntax:

Set variable.bit {On | Off}

Command Availability:

Available on all microcontrollers.

Explanation:

The purpose of the Set command is to turn individuals bits on and off. The Set command is most useful
for controlling output ports, but can also be used to set variables.

Often when controlling output ports, Set is used in conjunction with constants. This makes it easier to
adapt the program for a new circuit later.

Example:
 'Blink LED sample program for GCBASIC
'Controls an LED on PORTB bit 0.

'Set chip model and config options

#chip 16F84A, 20

'Set a constant to represent the output port

#define LED PORTB.0

'Set pin direction

Dir LED Out

'Main routine
Do
    Set LED On
    Wait 1 sec
    Set LED OFF
    Wait 1 sec
Loop

SWAP4

Syntax:

SWAP4( VariableA)

Command Availability:

Available on all microcontrollers.

Support Bytes only.

Explanation:

A function that swaps (or exchanges) nibbles (or the 8 bits of a byte in nibbles).

Example:
 dim ByteVariable as Byte

' Set variable to 0x12

ByteVariable = 0x12

ByteVariable = Swap4( ByteVariable )

HSerPrint hex(ByteVariable)

' Would return 0x21

SWAP

Syntax:

SWAP( VariableA, VariableB)

Command Availability:

Available on all microcontrollers.

Support Bytes and Words only.

Explanation:

A function that swaps (or exchanges) one byte or word for another. SWAP support the use of byte and
word variables.

String Manipulation
Asc

Syntax:

bytevar= ASC(string, [position] )

Command Availability:

Available on all microcontrollers

NOTE Only available in GCB I2C.h with release after 1/2014

Explanation:
 NOTE Only available in GCB compiler post 1/2014

Returns the character code of the character at the specified position in a string.

ASC returns the character code of a particular character in the string. If the string is an ANSI string, the
returned value will be in the range of 0 to 255. This function DOES NOT support UNICODE.

The optional position parameter determines which character is to be checked. The first character is
one, the second two, etc. If the position parameter is missing, the first character is presumed.

CHR is the natural complement of ASC. CHR produces a one-character string corresponding to its ASCII.

Restrictions:

If the string passed is null (zero-length) or the position is zero or greater than the length of the string
the returned value will be 0.

Example:

charpos = ASC( "ABCD" ) ' Returns 65

charpos = ASC( "ABCD", 2 ) ' Returns 66

For more help, see Chr

ByteToBin

Syntax:

stringvar = ByteToBin(bytevar)

Command Availability:

NOTE Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The ByteToBin function creates a string of a ANSI (8-byte) characters. The function converts a number
to a string consisting of ones and zeros that represents the binary value.

WARNING Supports BYTE variables only. For WORD variables use WordToBin
Example:

string = ByteToBin( 1 ) ' Returns "00000001"

string = ByteToBin( 254 ) ' Returns "11111110"

For more help, see WordToBin

Chr

Syntax:

stringvar = CHR(bytevar)

Command Availability:

NOTE Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The CHR function creates a string of a ANSI (1-byte) character.

ASC is the natural complement of CHR.

Example:

string = CHR( 65 ) ' Returns "A"

string = CHR( 66 ) ' Returns "B"

For more help, see Asc

Hex

Syntax:

stringvar = Hex(number)

Command Availability:
Available on all microcontrollers

Explanation:

The Hex function will convert a number into hexadecimal format. The input number should be a byte
variable, or a fixed number between 0 and 255 inclusive. After running the function, the string
variable stringvar will contain a 2 digit hexadecimal number.

Example:

'Set chip model

#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Send EEPROM data over serial connection

'Uses Hex to display as hexadecimal
For CurrentLocation = 0 to 255
    'Send location
    HSerPrint Hex(CurrentLocation)
    HSerPrint ":"
    'Read byte and send
    EPRead CurrentLocation, CurrByte
    HSerPrint Hex(CurrByte)
    'Send carriage return/line feed
    HSerPrintCRLF
Next

When using the functions Hex() do not leave space between the function call and the left brace. You
will get a compiler error that is meaningless.

' use this, note this is no space between the Hex and the left brace!
Hex(number_variable)
' do not use, note the space!
Hex (number_variable)

See Also Str, Val

Instr

Syntax:
 location = Instr(source, find)

Command Availability:

Available on all microcontrollers

Explanation:

The Instr function will search one string to find the location of another string within it. source is the
string to search inside, and find is the string to find. The function will return the location of find within
source, or 0 if source does not contain find.

Example:

'Set chip model

#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Fill a string with a message

Dim TestData As String
TestData = "Hello, world!"

'Display the location of "world" within the string

'Will return 8, because "w" in world is the 8th character
'of "Hello, world!"
HSerPrint Instr(TestData, "world")
HSerPrintCRLF

'Display the location of "planet" within the string

'Will display 0, because "planet" does not occur inside
'the string "Hello, world!"
HSerPrint Instr(TestData, "planet")
HSerPrintCRLF

LCase

Syntax:

output = LCase(source)

Command Availability:
Available on all microcontrollers

Explanation:

The LCase function will convert all of the letters in the string source to lower case, and return the result.

Example:

'Set chip model

#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Fill a string with a message

Dim TestData As String
TestData = "Hello, world!"

'Display the string in lower case

'Will display "hello, world!"
HSerPrint LCase(TestData)
HSerPrintCRLF

See Also UCase

Left

Syntax:

output = Left(source, count)

Command Availability:

Available on all microcontrollers

Explanation:

The Left function will extract the leftmost count characters from the input string source, and return
them in a new string.

Example:
 'Set chip model
#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Fill a string with a message

Dim TestData As String
TestData = "Hello, world!"

'Display the leftmost 5 characters

'Will display "Hello"
HSerPrint Left(TestData, 5)
HSerPrintCRLF

See Also Mid, Right

Len

Syntax:

output= Len( string )

Command Availability:

NOTE Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The Len function returns an byte value which is the length of a phrase or a sentence, including the
empty spaces. The format is:

target_byte_variable = Len("Phrase")

or another example. This code will loop through the for-next loop 12 times as determined by the length
of the string:
 ' create a test string of 12 characters

dim teststring as string * 12

teststring = "0123456789AB"
for loopthrustring = 1 to len(teststring)
   hserprint mid(teststring, loopthrustring , 1)
next

Ltrim

Syntax:

stringvar = LTRIM(stringvar)

Command Availability:

NOTE Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The Ltrim function will trim the 7-bit ASCII space character (value 32) from the LEFT hand side of a
string.

Use Ltrim on text that you have received from another source that may have irregular spacing at the
left hand end of the string.

See Also Trim, Rtrim

Mid

Syntax:

output = Mid(source, start, count)

Command Availability:

Available on all microcontrollers

Explanation:

The Mid function is used to extract characters from the middle of a string variable. source is the
variable to extract from, start is the position of the first character to extract, and count is the number
of characters to extract. If count is not specified, all characters from start to the end of the source
string will be returned.

Example:

'Set chip model

#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Fill a string with a message

Dim TestData As String
TestData = "The cat sat on the mat"

'Extract "cat". The c is at position 5, and 3 letters are needed

HSerPrint "The animal is a "
HSerPrint Mid(TestData, 5, 3)

'Extract the action. "sat" starts at position 9.

HSerPrint "The animal "
HSerPrint Mid(TestData, 9)
HSerPrintCRLF

See Also Left, Right

Pad

Syntax:

Pad( string_variable, byte_value_of_the_new_length, pad_character)

Command Availability:

Available on all microcontrollers

Explanation:

The Pad function is used to create string to a specific length that is extended with a specific character.

The length of the string is specified by the second parameter. The character used to pad the string is
specified by the third parameter.

A typical use is to pad a string to be displayed on a LCD display.

Example:

'Set chip model

#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Defibe a string
Dim TestData As String * 16
TestData = "Location"

HSerPrint TestData ;will print a string of 8 characters

HSerPrintCRLF
Pad ( TestData, 16, "*" )
HSerPrint TestData ;will print a string of 'Location********'
HSerPrintCRLF

Right

Syntax:

output = Right(source, count)

Command Availability:

Available on all microcontrollers

Explanation:

The Right function will extract the rightmost count characters from the input string source, and return
them in a new string.

Example:
 'Set chip model
#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Fill a string with a message

Dim TestData As String
TestData = "Hello, world!"

'Display the rightmost 6 characters

'Will display "world!"
HSerPrint Right(TestData, 6)
HSerPrintCRLF

Rtrim

Syntax:

stringvar = Rtrim(stringvar)

Command Availability: |NOTE] Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The Rtrim function will trim the 7-bit ASCII space character (value 32) from the RIGHT hand side of a
string.

Use Rtrim on text that you have received from another source that may have irregular spacing at the
right hand end of the string.

See Also Trim, Ltrim

Str

Syntax:

stringvar = Str(number)

Command Availability:
Available on all microcontrollers

Explanation:

The Str function will convert a number into a string. number can be any byte or word variable, or a
fixed number between 0 and 65535 inclusive. The string variable stringvar will contain the same
number, represented as a string.

This function is especially useful if a number needs to added to the end of a string, or if a custom data
sending routine has been created but only supports the output of string variables.

Example:

'Set chip model

#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Take an A/D reading

SensorReading = ReadAD(AN0)

'Create a string variable

Dim OutVar As String

'Fill string with sensor reading

OutVar = Str(SensorReading)

'Send
HSerPrint OutVar
HSerPrintCRLF

When using the functions STR() do not leave space between the function
call and the left brace. You will get a compiler error that is
meaningless.

' use this, note this is no space between the STR and the left brace!
STR(number_variable)
' do not use, note the space!
STR (number_variable)

See Also Hex, Val

Trim

Syntax:
 stringvar = Trim(stringvar)

Command Availability:

NOTE Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The Trim function will trim the 7-bit ASCII space character (value 32) from text.

Trim removes all spaces from text except for single spaces between words. Use Trim on text that you
have received from another source that may have irregular spacing at the left or right hand ends of the
string.

See Also Ltrim, Rtrim

UCase

Syntax:

output = UCase(source)

Command Availability:

Available on all microcontrollers

Explanation:

The UCase function will convert all of the letters in the string source to upper case, and return the
result.

Example:
 'Set chip model
#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Fill a string with a message

Dim TestData As String
TestData = "Hello, world!"

'Display the string in upper case

'Will display "HELLO, WORLD!"
HSerPrint UCase(TestData)
HSerPrintCRLF

See Also LCase

Val

Syntax:

var = Val(string)

Command Availability:

Available on all microcontrollers

Explanation:

The Val function will extract a number from a string variable, and store it in a word variable. One
potential use is reading numbers that are sent in ASCII format over a serial connection.

Example:
'Program for an RS232 controlled dimmer
'Set chip model
#chip 16F1936

'Set up hardware serial connection

#define USART_BAUD_RATE 9600
#define USART_BLOCKING

'Set pin directions for USART and PWM

'Variable for output level

Dim OutputLevel As Word

'Variables for received bytes

Dim DataIn As String
DataInCount = 0

'Main Loop
Do
    'Get serial byte
    Wait Until USARTHasData
    HSerReceive InByte

    'Process latest byte

    'Enter key?
    If InByte = 13 Then
        'Convert output level to numeric variable
        OutputLevel = Val(DataIn)

        'Output
        HPWM 1, 32, OutputLevel

        'Clear output buffer for next command

        DataIn = ""
        DataInCount = 0
    End If

    'Number?
    If InByte >= 48 and InByte <= 57 Then
        'Add to end of DataIn string
        DataInCount += 1
        DataIn(DataInCount) = InByte
        DataIn(0) = DataInCount
    End If
Loop
See Also Hex, Str

WordToBin

Syntax:

stringvar = WordToBin(bytevar)

Command Availability:

NOTE Only available in GCB compiler post 1/2014

Available on all microcontrollers

Explanation:

The WordToBin function creates a string of a ANSI (8-byte) characters. The function converts a number
to a string consisting of ones and zeros that represents the binary value.

Example:

string = WordToBin(1) ' Returns "0000000000000001"

string = WordToBin(37654) ' Returns "1001001100010110"

For more help, see ByteToBin

Concatenation

Syntax:

stringvar = variable1 + variable2

Command Availability:

Available on all microcontrollers

Explanation:

The method join two variables into another variable.

This method does not change the existing strings, but returns a new string containing the text of the
joined variables.
Concatenation joins the elements of a specified values using the specified separator between each
variable.

Example:

timevariable = 999
stringvar = "Time = " + timevariable ' Returns Time = 999

Miscellaneous Commands
Dir

Syntax:

Dir port.bit {In | Out} (Individual Form)

Dir port {In | Out | DirectionByte} (Entire Port Form)

Command Availability:

Available on all microcontrollers. However, some low end PIC microcontrollers (10F, 12F5x and 16F5x
chips) will only accept the entire port form.

Explanation:

The Dir command is used to set the direction of the ports of the microcontroller chip. The individual
form sets the direction of one pin at a time, whereas the entire port form will set all bits in a port.

In the individual form, specify the port and bit (ie. PORTB.4), then the direction, which is either In or
Out.

The entire port form is similiar to the TRIS instruction offered by some PIC chips. To use it, give the
name of the port (i.e. PORTA), and then a byte is to be written into the TRIS variable. This form of the
command is for those who are familiar with the PIC chip’s internal architecture.

Entire port form will work differently on AVR when a value other than IN or OUT
WARNING is used! AVR chips use 0 to indicate in and 1 to indicate out, whereas PICs use 0 for
out and 1 for in. When IN and OUT are used there are no compatibility issues.

Example:
 'This program sets PORTA bits 0 and 1 to in, and the rest to out.
'It also sets all of PORTB to output, except for B1.
'Individual form is used for PORTA:
DIR PORTA.0 IN
DIR PORTA.1 IN
DIR PORTA.2 OUT
DIR PORTA.3 OUT
DIR PORTA.4 OUT
DIR PORTA.5 OUT
DIR PORTA.6 OUT
DIR PORTA.7 OUT
'Entire port form used for B:
DIR PORTB b'00000010'

'Entire port form used for C:

DIR PORTC IN

Pot

Syntax:

Pot pin, output

Command Availability:

Available on all microcontrollers.

Explanation:

Pot makes it possible to measure an analog resistance with a digital port, with the addition of a small
capacitor. This is the required circuit:
The command works by using the microcontroller pin to discharge the capacitor, then measuring the
time taken for the capacitor to charge again through the resistor.

The value for the capacitor must be adjusted depending on the size of the variable resistor. The
charging time needs to be approximately 2.5 ms when the resistor is at its maximum value. For a
typical 50 k potentiometer or LDR, a 50 nf capacitor is required.

This command should be used carefully. Each time it is inserted, 20 words of program memory are
used on the chip, which as a rough guide is more than 15 times the size of the Set command.

pin is the port connected to the circuit. The direction of the pin will be dealt with by the Pot command.

output is the name of the variable that will receive the value.

Example:
 'This program will beep whenever a shadow is detected
'A potentiometer is used to adjust the threshold

#chip 16F628A, 4
#config INTOSC_OSC_NOCLKOUT

#define ADJUST PORTB.0

#define LDR PORTB.1
#define SoundOut PORTB.2

Dir SoundOut Out

Do
    Pot ADJUST, Threshold
    Pot LDR, LightLevel
    If LightLevel > Threshold Then
        Tone 1000, 100
    End If
Loop

See also ladyada.net/library/rccalc.html or cvs1.uklinux.net/cgi-bin/calculators/time_const.cgi for

calculating capacitor value. These sites are not associated with GCBASIC.

PulseOutInv

Syntax:

PulseOutInv pin, time units

Command Availability:

Available on all microcontrollers.

Explanation:

The PulseOutInv command will set the specified pin low, wait for the specified amount of time, and
then set the pin high. The pin is specified in the same way as it is for the Set` command, and the time is
the same as for the Wait command.

Example:
 'This program flashes an LED on GPIO.0 using PulseOutInv
#chip 12F629, 4
#config INTRC_OSC_NOCLKOUT

Dir GPIO.0 Out

Do
    PulseOutInv GPIO.0, 1 sec 'Turn LED off for 1 sec
    Wait 1 sec 'Wait 1 sec with LED on
Loop

PulseIn

Syntax:

PulseIn pin, variable, time units

Command Availability:

Available on all microcontrollers.

Explanation:

The PulseIn command will monitor the specified pin when the pin is high, and then measure the high
time. It will store the time in the variable.

Example:

#chip 12F629, 4
#config INTRC_OSC_NOCLKOUT

Dir GPIO.0 In

Pulsein GPIO.0, TimeResult, 1 sec

PulseOut

Syntax:

PulseOut pin, time units

Command Availability:

Available on all microcontrollers.

Explanation:

The PulseOut command will set the specified pin high, wait for the specified amount of time, and then
set the pin low again. The pin is specified in the same way as it is for the Set command, and the time is
the same as for the Wait command.

Example:

'This program flashes an LED on GPIO.0 using PulseOut

#chip 12F629, 4
#config INTRC_OSC_NOCLKOUT

Dir GPIO.0 Out

Do
    PulseOut GPIO.0, 1 sec 'Turn LED on for 1 sec
    Wait 1 sec 'Wait 1 sec with LED off
Loop

Peek

Syntax:

OutputVariable = Peek (location)

Command Availability:

Available on all microcontrollers.

Explanation:

The Peek function is used to read information from the on-chip RAM of the microcontroller.

location is a word variable that gives the address to read. The exact range of valid values varies from
chip to chip.

This command should not normally be used, as it will make the porting of code to another chip very
difficult.

Example #1 :
 'This program will read and check a value from PORTA
'Will only work on some PICs
Temp = Peek(5)
IF Temp.2 ON THEN SET green ON
IF Temp.2 OFF THEN SET red ON

Example #2

' This subroutine will toggle the pin state.

' You must change the parameters for your specific chip.
' Usage as show in examples below.
'
' Toggle @PORTE, 2 ' equates to RE1.
' Wait 100 ms
' Toggle @PORTE, 2
' Wait 100 ms

' Port , Pin address in Binary

' Pin0 = 1
' Pin1 = 2
' Pin2 = 4
' Pin3 = 8
'
' You can toggle any number of pins.
' Toggle @PORTE, 0x55
Sub Toggle ( In DestPort As word, In DestBit )
      Poke DestPort, Peek(DestPort) xor DestBit
End sub

See Also Poke

Poke

Syntax:

Poke(location, value)

Command Availability:

Available on all microcontrollers.

Explanation:
The Poke command is used to write information to the on-chip RAM of the microcontroller.

• location is a word variable that gives the address to write. The exact range of valid values varies
from chip to chip.

• value is the data to write to the location.

This command should not normally be used, as it will make the porting of code to another chip very
difficult.

Example 1:

'This program will set all of the PORTB pins high

POKE (6, 255)

Example 2:

;Chip Settings
#chip 16F88

Do Forever
    FlashPin @PORTB, 8
    Wait 1 s
Loop

Sub FlashPin (In DestVar As word, In DestBit)

    Poke DestVar, Peek(DestVar) Or DestBit
    Wait 1 s
    Poke DestVar, Peek(DestVar) And Not DestBit
End Sub

Using @ before the name of a variable (including a special function register) will give you the address
of that variable, which can then be stored in a word variable and used by Peek and Poke to indirectly
access the location.

See Also Peek

Weak Pullups

Weak pullups provide a method to within many microcontrollers such as the Atmel AVR and
Microchip PIC parts to support internal/selectable pull-ups for convenience and reduced parts count.

If you require weak pull-ups these internal pull-ups can provide a simple solution. If you need your
weak pull-ups to exactly control current (rare for most PIC applications), then you should consider 10k
resistors (5V/10K = 500uA) Why? If you review in the microprocessor data sheet, there is no resistance
given for the weak pull-ups. That is because they are not weak pull-resistors they are weak pull-up
consisting of what appear to be high- resistance channel pFETs. Their channel resistance will vary with
temperature and between parts; not easy to characterize. The data sheet gives a current range for the
internals as 50-400uA (at 5V).

PORTs can have an individually controlled weak internal pull-up. When set, each bit of the appropriate
microchip register enables the corresponding pin pull-up. There is a master bit within a specific
register bit that enables pull- ups on all pins which also have their corresponding weak pull bit set.
Also when set, there is a weak pull register bit to disable all weak pull-ups.

The weak pull-up is automatically turned off when the port pin is configured as an output. The pull-ups
are disabled on a Power-on Reset.

Each specific microprocessor has different registers/bits for this functionality. You should review the
datasheet for the method for a specific microprocessor. The following code demonstrates how to set
the weak pull-ups available on port B of an 18F25K20.

'A program to show the use of weak pulled-ups on portb.

'Set chip model
#chip 18F25k20,16 'at 16 MHz
'Switch Low-Volt-Programming:
#config LVP = Off
#config MCLR = Off

Set RBPU = 0 'enabling Port B pullups in general.

SET WPUB1 = 1 'portb.1 pulled up
Set WPUB2 = 1 'portb.2
Set WPUB3 = 1 'portb.3
Set WPUB4 = 1 'portb.4

Dir Portb in
Dir Portc out

do
    portc.1 = portb.1 'in pin 22, out pin 12
    portc.2 = portb.2 'in pin 23, out pin 13
    portc.3 = portb.3 'in pin 24, out pin 14
    portc.4 = portb.4 'in pin 25, out pin 15

loop 'jump back to the start of the program

'main line ends here

end

Also, see I2C Slave Hardware for an example using a 16F microcomputer.
Maths
Abs

Syntax:

integer_variable = Abs( integer_variable )

Command Availability:

Available on all microcontrollers

Explanation:

The Abs function will computes the absolute value of a integer number therefore in the range of -32678
to 32768.

Example:

absolute_value = Abs( -127 ) ' Will return 127

absolute_value = Abs( 127 ) ' Will return 127 also. :-)

Average

Syntax:

integer_variable = Average(byte_variable1 , byte_variable2)

Command Availability:

Available on all microcontrollers

Explanation:

A function that returns the average of two numbers. This only supports byte variables.

Provides a very fast way to calculate the average of two 8 bit numbers.

Example:

average_value = Average(8,4) ' Will return 6

Logarithms

Explanation:

Great Cow Basic support logarithmic functions through the include file <maths.h>.

These functions compute base 2, base e and base 10 logarithms accurate to 2 decimal places, +/- 0.01.

The values returned are fixed-point numbers, with two decimal places assumed on the right. Or if you
prefer, think of the values as being scaled up by 100.

The input arguments are word-sized integers, 1 to 65535. Remember, logarithms are not defined for
non-positive numbers. It is the calling program’s responsibility to avoid these. Output values are also
word- sized.

Local variables consume 9 bytes, while the function parameters consume another 4 bytes, for a grand
total of 13 bytes of RAM used. The lookup table takes 35 words of program memory.

For more help, see Log10, Log2, Loge

Supported in <MATHS.H>

Log2

Syntax:

returned_word_variable = Log2 ( word_value )

Command Availability:

Available on all microcontrollers.

Explanation:

The Log2 command will return the base-2 logarithm, to 2 decimal places.

The values returned are fixed-point numbers, with two decimal places assumed on the right. or if you
prefer, think of the values as being scaled up by 100.

Example:

dim log_value as word

log_value = log2 ( 10 ) 'return 3321 equate to 3.321

Supported in <MATHS.H>
Loge

Syntax:

returned_word_variable = Loge ( word_value )

Command Availability:

Available on all microcontrollers.

Explanation:

The Loge command will return the base-e logarithm, to 2 decimal places.

The values returned are fixed-point numbers, with two decimal places assumed on the right. or if you
prefer, think of the values as being scaled up by 100.

Example:

dim log_value as word

log_value = log10 ( 10 ) 'return 100 equate to 1

Supported in <MATHS.H>

Log10

Syntax:

returned_word_variable = Log10 (word_value)

Command Availability:

Available on all microcontrollers.

Explanation:

The Loge command will return the base-10 logarithm, to 2 decimal places.

The values returned are fixed-point numbers, with two decimal places assumed on the right. or if you
prefer, think of the values as being scaled up by 100.

Example:
 dim log_value as word
log_value = loge ( 10 ) 'return 230 equate to 2.30

Supported in <MATHS.H>

Power

Syntax:

power( base, exponent )

Explanation:

This function raises a base to an exponent, i.e, power(base,exponent). Remember, powers can easily
become huge, so it is up to the calling program to make certain your numbers remain within range.
The base and exponent are Byte sized numbers in any event. The returned result is a Long.

Non-negative numbers are assumed throughout.

Keep in mind that 0 raised to 0 is meaningless and should be avoided, but, any other non-zero base
raised to 0 is handled correctly.

Example:
 ;Thomas Henry -- 5/2/2014

;----- Configuration

#chip 16F88, 8 ;PIC16F88 running at 8 MHz

#config mclr=off ;reset handled internally
#config osc=int ;use internal clock
#include <maths.h>

;----- Constants

#define LCD_IO 4 ;4-bit mode

#define LCD_RS PortB.2 ;pin 8 is LCD Register Select
#define LCD_Enable PortB.3 ;pin 9 is LCD Enable
#define LCD_DB4 PortB.4 ;DB4 on pin 10
#define LCD_DB5 PortB.5 ;DB5 on pin 11
#define LCD_DB6 PortB.6 ;DB6 on pin 12
#define LCD_DB7 PortB.7 ;DB7 on pin 13
#define LCD_NO_RW 1 ;Ground the RW line on LCD

;----- Variables

dim i, j as byte

;----- Program

dir PortB out ;all outputs to the LCD

for i = 1 to 10 ;do all the way from
  for j = 0 to 9 ;1^0 on up to 10^9
    cls
    print i
    print "^"
    print j
    print "="
    locate 1,0
    print power(i,j) ;here's the invocation
    wait 1 S
  next j
next i

Supported in <MATHS.H>

Sqrt

Syntax:
 word_variable = sqrt ( word )

Explanation:

A square root routine for Great Cow Basic. The function only involves bit shifting, addition and
subtraction, which makes it fast and efficient.

It expects a word in and a word out, and will handle arguments of up to 4294.

Command Availability:

Available on all microcontrollers, required MATHS.H include file.

Example:

;Demo: Show the first 100 square roots to 2 decimal places.

;This uses the maths.h include file.

;----- Configuration

#chip 16F88, 8 ;PIC16F88 running at 8 MHz

#config mclr=off ;reset handled internally
#config osc=int ;use internal clock
#include <maths.h>

;----- Constants

#define LCD_IO 4 ;4-bit mode

#define LCD_RS PortB.2 ;pin 8 is LCD Register Select
#define LCD_Enable PortB.3 ;pin 9 is LCD Enable
#define LCD_DB4 PortB.4 ;DB4 on pin 10
#define LCD_DB5 PortB.5 ;DB5 on pin 11
#define LCD_DB6 PortB.6 ;DB6 on pin 12
#define LCD_DB7 PortB.7 ;DB7 on pin 13
#define LCD_NO_RW 1 ;ground the RW line on LCD

;----- Variables

dim length as byte

dim i as word
dim valStr, outStr as string

;----- Program

dir PortB out ;all outputs to the LCD

 for i = 0 to 100 ;print first 100 square roots
  cls
  print "sqrt("
  print i
  print ")="

  valStr = str(sqrt(i)) ;format decimal nicely

  length = len(valStr)

  select case length

   case 1:
      outStr = "0.00" ;zero case
   case 3:
      outStr = left(valStr,1)+ "."+right(valStr,2)
    case 4:
      outStr = left(valStr,2)+ "."+right(valStr,2)
    case 5:
      outStr = left(valStr,3)+ "."+right(valStr,2)
  end select

  print outStr ;display results

  wait 2 S
next i

Supported in <MATHS.H>

Trigonometry

Explanation:

Great Cow Basic supports Three Primary Trigonometric Functions

Syntax:

Great Cow Basic supports the following functions, sin(x), cos(x), tan(x), where x is a signed integer
representing an angle measured in a whole number of degrees. The output values are also integers,
represented as fixed point decimal fractions.

Details:

The sine, cosine and tangent functions are available for your programs simply by including the header
file offering the precision you need. In particular,

#INCLUDE <TRIG2PLACES.H> gives two decimal places

#INCLUDE <TRIG3PLACES.H> gives three decimal places
#INCLUDE <TRIG4PLACES.H> gives four decimal places
In fixed point representation, the decimal point is assumed. For example, with two places of accuracy,
sin(60) returns 87, which you would interpret as 0.87. With three places, 866 is returned, to be
interpreted as 0.866, and so on. Another way of thinking of this is to consider the two-place values as
scaled up by 100, the three-place values scaled up by 1000 and the four-place values scaled up by
10,000.

Sine and cosine are always defined, but remember that tangent fails to exist at 90 degrees, 270 degrees
and all their coterminal angles. It is the responsibility of the calling program to avoid these special
values.

Note that the tangent function is not available to four decimal places, since its value grows so rapidly,
exceeding what the Integer data type can represent.

These routines are completely general. The input argument may be positive, negative or zero, with no
restriction on the size. Further observe that lookup tables are used, so the routines are very fast,
efficient and accurate.

Example:

;Demo: Show the trigonometric values to three decimal places.

;----- Configuration

#chip 16F88, 8 ;PIC16F88 running at 8 MHz

#config mclr=off ;reset handled internally
#config osc=int ;use internal clock
#include <Trig3Places.h>

;----- Constants

#define LCD_IO 4 ;4-bit mode

#define LCD_RS PortB.2 ;pin 8 is LCD Register Select
#define LCD_Enable PortB.3 ;pin 9 is LCD Enable
#define LCD_DB4 PortB.4 ;DB4 on pin 10
#define LCD_DB5 PortB.5 ;DB5 on pin 11
#define LCD_DB6 PortB.6 ;DB6 on pin 12
#define LCD_DB7 PortB.7 ;DB7 on pin 13
#define LCD_NO_RW 1 ;ground the RW line on LCD

;----- Variables

dim i as integer
dim outStr, valStr as string

;----- Program

dir PortB out ;all outputs to the LCD

for i = -720 to 720 ;arguments from -720 to 720
  cls
  print "sin(" ;print the label
  print i ;and the argument
  print ")=" ;and closing parenthesis
  locate 1,0
  printTrig(sin(i)) ;print value of the sine
  wait 500 mS ;pause to view

  cls ;do likewise for cosine

  print "cos("
  print i
  print ")="
  locate 1,0
  printTrig(cos(i))
  wait 500 mS ;pause to view
  cls ;do likewise for tangent
  print "tan("
  print i
  print ")="
  locate 1,0
  printTrig(tan(i))
  wait 500 mS ;pause to view
next i

sub printTrig(in value as integer)

  ;print decently formatted trig results

  outStr = "" ;assume positive (no sign)

  if value < 0 then ;handle negatives

    outStr = "-" ;prefix a minus sign
    value = -1 * value ;but work with positives
  end if

  valStr = str(value)
  length = len(valStr)
  select case length
    case 1:
      outStr = outStr + "0.00" + valStr
    case 2:
      outStr = outStr + "0.0" + valStr
    case 3:
      outStr = outStr + "0." + valStr
    case 4:
      outStr = outStr + left(valStr,1) + "." + right(valStr,3)
    case 5:
       outStr = outStr + left(valStr,2) + "." + right(valStr,3)
  end select
print outStr
end sub

Compiler Directives
#chip
Syntax:

#chip model, speed

Explanation:

The #chip directive is used to specify the chip model and speed that GCBASIC must compile for. model is
the model of the microcontroller chip - something along the lines of "16F819". speed is the speed of the
chip in MHz, and is required for the delay and PWM routines.

If no chip frequency is present, the compiler will select a frequency that should work. If the chip has
an internal oscillator, the compiler will use that and pick the highest speed it supports. If you are using
an external crystal then you must specify a chip frequency.

If speed is omitted, GCBASIC will use the highest clock speed that the internal oscillator can support. If
the chip does not have an internal oscillator, then GCBASIC will assume that the chip is being run at its
maximum possible clock speed using an external crystal.

When using an AVR, there is not need to specify "AT" before the name.

Examples:

#chip 12F509, 4
#chip 18F4550, 48
#chip 16F88, 0.125
#chip tiny2313, 1
#chip mega8, 16

Setting Other Clock frequencies

Some alternative compilers allow value of the clock speed to be set with the numerical value (i.e.
24576000). This can be useful when using the clock frequencies other than standard frequencies.

You can do this, you must write the speed in MHz with decimal points. For example, if you wanted to
run a 16F1827 at 24576000 Hz, you would write the following:

#chip 16F1827, 24.576

#config
Syntax:

#config option1, option2, ... , optionn

Explanation:

The #config directive is used to specify configuration options for the chip. There is a detailed
explanation of #config in the Configuration section of help.

See Also Configuration

#define
Syntax:

#define Find Replace

Explanation:

#define will search through the program for Find, and replace it with the value given for Replace.

See Also Defines

#if
Syntax:

#if Condition
  ...
#endif

Explanation:

The #if directive is used to prevent a section of code from compiling unless Condition is true.
Condition has the same syntax as the condition in a normal GCBASIC if command. The only difference
is that it uses constants instead of variables.

Example:

'This program will pulse an adjustable number of pins on PORTB

'The number of pins is controlled by the FlashPins constant
#chip 16F88, 8

'The number of pins to flash

#define FlashPins 2

'Initialise
Dir PORTB Out

'Main loop
Do
    #if FlashPins >= 1
        PulseOut PORTB.0, 250 ms
    #endif
    #if FlashPins >= 2
        PulseOut PORTB.1, 250 ms
    #endif
    #if FlashPins >= 3
        PulseOut PORTB.2, 250 ms
    #endif
    #if FlashPins >= 4
        PulseOut PORTB.3, 250 ms
    #endif
Loop

#ifdef
Syntax:

#ifdef Constant | Constant Value | Var(VariableName)

  ...
#endif

Explanation:

The #ifdef directive is used to selectively enable sections of code. There are several ways in which it
can be used:

• Checking if a constant is defined

 • Checking if a constant is defined and has a particular value

• Checking if a system variable exists

• Checking if a system bit has been defined

The advantage of using #ifdef rather than an equivalent series of IF statements is the amount of code
that is downloaded to the chip. #ifdef controls what code is compiled and downloaded, IF controls
what is run once on the chip. #ifdef should be used whenever the value of a constant is to be checked.

GCBASIC also supports the #ifndef directive - this is the opposite of the #ifdef directive - it will remove
code that #ifdef leaves, and vice versa.

The code in the following sections will not compile, as it is missing #chip directives and
NOTE
Dir commands. It is intended to act as an example only.

Example 1: enabling code if a constant is defined

    #define Blink1

    #ifdef Blink1
        PulseOut PORTB.0, 1 sec
        Wait 1 sec
    #endif
    #ifdef Blink2
        PulseOut PORTB.1, 1 sec
        Wait 1 sec
    #endif

This code will pulse PORTB.0, but not PORTB.1. This is because Blink1 has been defined, but Blink2 has
not. If the line

#define Blink2

was added at the start of the program, then both pins would be pulsed. The value of the constant
defined is not important and can be left off of the #define.

Example 2: enabling code if a constant is defined and has a given value

 #define PinsToFlash 2

#ifdef PinsToFlash 1,2,3

PulseOut PORTB.0, 1 sec
#endif
#ifdef PinsToFlash 2,3
PulseOut PORTB.1, 1 sec
#endif
#ifdef PinsToFlash 3
PulseOut PORTB.2, 1 sec
#endif

This program uses a constant called PinsToFlash that controls how many lights are pulsed. PORTB.0 is
pulsed when PinsToFlash is equal to 1, 2 or 3, PORTB.1 is pulsed when PinsToFlash equals 2 or 3, and
PORTB.2 is flashed when PinsToFlash is 3.

Example 3: enabling code if a system variable is defined

#ifdef NoVar(ANSEL)
SET ADCON1.PCFG3 OFF
SET ADCON1.PCFG2 ON
SET ADCON1.PCFG1 ON
SET ADCON1.PCFG0 OFF
#endif
#ifdef Var(ANSEL)
ANSEL = 0
#endif

The above section of code has been copied directly from a-d.h. It is used to disable the A/D function of
pins, so that they can be used as standard digital I/O ports. If ANSEL is not declared as a system variable
for a particular chip, then the program uses ADCON1 to control the port modes. If ANSEL is defined, then
the chip is newer and its ports can be set to digital by clearing ANSEL.

Example 4: enabling code if a system bit is defined

Similar to above, except with Bit and NoBit in the place of Var and NoVar respectively.

See Also Defines, #define

#ifndef
Syntax:
 #ifndef Constant | Constant Value | Var(VariableName)
  ...
#endif

Explanation:

The #ifndef directive is used to selectively enable sections of code. It is the opposite of the #ifdef
directive - it will delete code in cases where #ifdef would leave it, and will leave code where #ifdef
would delete it.

See the #ifdef article for more information.

#include
Syntax:

#include filename

Explanation:

#include tells GCBSIC to open up another file, read all of the subroutines and constants from it, and
then copy them into the current program.

There are two forms of include; absolute and relative.

Absolute is used to refer to files in the C:\Program Files\GCBASIC\include directory. The name of the file
is specified in between < and > symbols. For instance, to include the file srf04.h, the directive is:

#include <srf04.h>

Relative is used to read files in the same folder as the currently selected program. Filenames are given
enclosed in quotation marks, such as:

#include "mycode.h"

where mycode.h is the name of the file that is to be read.

It is not essential that the include file name ends in .h - the important thing is that the
NOTE
name given to GCBASIC is the exact name of the file to be included.
 Those who are familiar with #include in assembly or C should bear in mind that
#include in GCBASIC works differently to #include in most other languages - code is
WARNING
not inserted at the location of the #include, but rather at the end of the current
program.

#script
Syntax:

#script
[scriptcommand1]
[scriptcommand2]
 ...
[scriptcommandn]
#endscript

Explanation:

The #script block is used to create small sections of code which GCBASIC runs during compilation. A
detail explanation and example are included in the Scripts article.

See Also Scripts

#startup
Syntax:

#startup SubName

*Explanation:

#startup is used in include files to automatically insert initialization routines. If a define or subroutine
from the file is used in the program, then the specified subroutine will be called.

There are some limitations on this directive. It may only occur once within a file, and no parameters
can be specified for the subroutine that is to be called.

#mem
This directive is obsolete. GCBASIC can now determine the amount of memory on a chip
automatically, and will ignore the #mem directive.

It is recommended that this directive is removed from all programs.

Other directives
The built-in #defines used to support #IFDEF etc are as follows:

• ChipMHz - this returns a string of the microprocessor clock speed

• ChipName - this returns a number of the microprocessor type

• ChipNameStr - this returns a string of the microprocessor name

• ChipRAM - this returns the RAM size

• ChipFamily - this returns 12, 14 or 16, depending on instruction width OSC

The directives Var(), NoVar(), Bit() and NoBit() are functions that are built in to #IFDEF. They will
return true if a variable or bit is declared/not declared in the currently selected PIC chip.

Var()
NoVar()
Bit()
NoBit()

The directive AllOf and OneOf will return true if all of or one of the listed defines is declared:

AllOf(define1, define2, …)
OneOf(define1, define2, …)

Compiler Options
#option bootloader
Syntax:

#option bootloader address

Explanation:

#option bootloader prevents the overwriting of any pre-loaded bootloader code, vectors, etc. below the
address and have all GCBASIC code start at address.

A bootloader is a program that stays in the microcontroller and communicates with the PC, typically
through the serial interface. The bootloader receives a user program from the PC and writes it in the
flash memory, then launches this program in execution. Bootloaders can only be used with those
microcontrollers that can write their flash memory through software.
The bootloader itself must be written into the flash memory with an external programmer.

In order for the bootloader to be launched after each reset, a goto bootloader instruction must exist
somewhere in the first 4 instructions; There are two types of bootloaders, some that require that the
user reallocate the code and others that by themselves reallocate the first 4 instructions of the user
program to another location and execute them when the bootloader exits.

The diagram below shows the architecture of a bootloader. The left hand is the operation of the
instructions without a bootloader. The right hand shows the initial instruction of goto the bootoader,
then, when the bootloader has initialised the execution of the start code.

See example bootload software.

Example:

#option bootloader 0x800

#option NoContextSave
Syntax:

#option NoContextSave

Explanation:

Interrupts can occur at almost any time, and may interrupt another command as it runs. To ensure
that the interrupted command can continue properly after the interrupt, some temporary variables
(the context) must be saved. Normally GCBASIC will do this automatically, but in some cases it may be
necessary to prevent this. If porting some existing assembly code to GCBASIC, or creating a bootloader
using GCBASIC that will call another program, NoContextSave can be used to prevent the context
saving code from being added automatically.

Be very careful using this option - it is very easy to cause random corruption of variables. If creating
your own context saving code, you may need to save several variables. These are:

For PIC 12F/16F: W, STATUS, PCLATH For PIC 12F1/16F1/18F: W, STATUS, PCLATH, PCLATU, BSR For
AVR: All 32 registers

Other variables may also need to be saved, depending on what commands are used inside the
interrupt handler. Everything that is saved will also need to be restored manually when the interrupt
handler finishes.

Example:

' This shows an example that could be used by a bootloader to call some application code.

' The application code must deal with context save and restore
' Suppose that application code starts at location 0x100, with interrupt vector at 0x108

'Chip model
#chip 18F2620

'Do not save context automatically

#option NoContextSave

'Main bootloader routine

Set PORTB.0 On
'Do other stuff to make this an actual bootloader and not a trivial example
'Transfer control to application code
goto 0x100

'Interrupt routine - this will be placed at the interrupt vector

Sub Interrupt
    'If any interrupt occurs, jump straight to application interrupt vector
    goto 0x108
End Sub

Note:

From version 0.941 GCbasic supports the #option NoContextSave.

#option nolatch
Syntax
 #option nolatch

This option disable PORTx to LATx redirection.

Introduction

The GCBasic compiler will redirect all I/O pin writes from PORTx to LATx registers on PIC 16F1/18F
Microchip microcomputers. The Microchip mid-range PIC microcontrollers use a sequence known as
Read-Modify-Write (RMW) when changing an output state (1 or 0) on a pin. This can cause
unexpected behavior under certain circumstances.

When your program changes the state on a specific pin, for example RB0 in PORTB, the PIC
microcontroller first READs all 8 bits of the PORTB register which represents the states of all 8 pins in
PORTB (RB7-RB0). The PIC microcontroller then stores this data in the MCU. The bit associated with RB
that you’ve commanded to MODIFY is changed, and then the PIC microcontroller WRITEs all 8 bits
(RB7- RB0) back to the PORTB register.

During the first reading of the PORT register, you will be reading the actual state of the physical pin.
The problem arises when an output pin is loaded in such a way that its logic state is affected by the
load. Instances of such loads are LEDs without current-limiting resistors or loads with high capacitance
or inductance.

For example, if a capacitor is attached between pin and ground, it will take a short while to charge
when the pin is set to 1. On the other hand, if the capacitor is discharged, it acts like a short circuit,
forcing the pin to '0' state, and, therefore, a read of the PORT register will return 0, even though we
wrote a 1 to it.

GCBasic resolves this issue using the LATx register when writing to ports, rather than using PORTx
registers. Writing to a LATx register is equivalent to writing to a PORTx register, but readings from
LATx registers return the data value held in the port latch, regardless of the state of the actual pin. So,
for reading use PORTx.

This redirection capability from PORTx to LATx is available from version 0.94 of GCBasic compiler.

Note

Use you can use the #option nolatch if problems occur with compiler redirection.

Using Assembler
Assembler Overview
Explanation:
You can use assembler code within your Great Cow Basic code.

You can put the assembler code inline in with your source code. The assembler code will be passed
through to the assembly file associated with your project.

GCBASIC should recognise all of the commands in the microcomputer datasheet.

The commands should be in lower case and have a space or tab in front of the command.

Even if the mnemonics are not being formatted properly, gputils/MPASM should still be capable of
assemble the source code.

Example:

Format commands as follows:

btfsc STATUS,Z
bsf PORTB,1

Macros
Macros Overview
Explanation:

You can use macros within your Great Cow Basic code.

Macros are similar to subroutines. But during compilation, everything is inserted inline. This may
increase the code size slightly, but it also reduces stack usage.

Parameters are handled in a similar way to how constants are handled, so there is a lot more freedom
when passing things in to a macro. (Unlike subs or functions, where everything must be stored in a
variable.)

For example, for PulseOut, one parameter is a pin, and the other is a time length like "500 ms". Neither
of those could be stored in a variable, but passing them in as macro parameters is possible.

Example:
 'PulseOut Macro
macro Pulseout (Pin, Time)
Set Pin On
Wait Time
Set Pin Off
end macro

Example Macros
Measuring a Pulse Width

Introduction

When the measurement of a pulse width to sub-microsecond resolution is required for instance
measuring the high or low pulse width of an incoming analog signal a comparator can be combined
with a timer to provide the pulse width.

Microchip has published a "Compiled Tips 'N Tricks Guide" that explains how to do certain tasks with
PIC 8-Bit Microcontrollers. This guide provides the steps that need to be taken to perform the task of
measuring a pulse width.

The guide provides guidance on measuring a pulse width using Timer 1 and the CCP module. This
guidance was used as the basis for the GCBasic port the shown below. The guidance was generic and
in this example polling the CCP flag bit was more convenient than using an interrupt. In this example,
a PIC 16F1829 microprocessor operating at 32 Mhz using the internal oscillator. The GCBasic example
code is based on a macro that uses Timer1 and CCP4. However, any of the four CCP modules could be
used, the 16F1829 microprocessor has four CCP module.

Resolution of this approach using a timer Prescaler of 1:8 and a microprocessor frequency of 32 MHz
the pulse width resolution is 1ms. With the timer Prescaler of 1:2 and the microprocessor frequency of
32MHz the resolution is 250 ns.

The accuracy is dependent upon the accuracy of the system clock, but oscilliscope measurements have
show an accuracy of +- 1us from 3us to 1000us.

In this example the following was implemented

• Using GCBasic a macro to ensure the generated assembler is inline to ensure the timing is
consistent and no sub routines are called.

• Another microprocessor was used to generate the pulses to be measured

• A TEK THS730A oscilliscope was used to measure/verify pulse widths

• A 4x20 LDC module with an I2C Backpack was used to display the results. However, as an
alternative, a serial output
to a terminal program to view the data could be used
This example can be improved by adding code to poll the TIMER1 overflow flag. IF the timer overflows,
then either no pulse was detected or the pulse was longer than allowed by the prescaler/OSC settings.
In this case, return a value of zero for pulse width.

Usage:

To get positive pulse width use:

PULSE_IN

PULSE_IN returns a global word variable Pulse_Width

Example Program:

#Chip 16F1829, 32
#CONFIG MCLRE = OFF

'Setup Software I2C

#define I2C_MODE Master
#define I2C_DATA PORTA.2
#define I2C_CLOCK PORTC.0
#define I2C_DISABLE_INTERRUPTS ON

'Set up LCD
#define LCD_IO 10
#define LCD_SPEED FAST
#define LCD_Backlight_On_State 1
#define LCD_Backlight_Off_State 0

'Note: This example can be improved by adding code to poll the 'TIMER1 overflow flag. IF
the timer overflows, then either no 'pulse was detected or the pulse was longer than
allowed by the 'prescaler/OSC settings. In this case, return a value of zero 'for pulse
width.

CLS
PRINT "Pulse Width Test"
DIM PULSE_WIDTH AS WORD
DIR PORTC.6 IN

'Setup timer
'Set timer1 using PS1_2 gives 250ns resolution
InitTimer1 OSC, PS1_8
wait 1 s
CLS

'MAIN PROGRAM LOOP

 DO
  PULSE_IN 'Get positive pulse width.
  Locate 0,0: PRINT Pulse_Width: PRINT " "
  wait 1 s
Loop

MACRO PULSE_IN 'Measure Pulse Width

  'Configure CCP4 to Capture rising edge
   CCP4CON = 5 'Set to 00000101
   StartTimer 1
   CCP4IF = 0

   do while CCP4IF = 0 'Wait for rising edge

   loop

   TMR1H = 0: TMR1L = 0 'Clear timer to zero

   CCP4IF = 0 'Clear flag

   'Configure CCP4 to Capture Falling Edge

   CCP4CON = 4 '00000100'

   do while CCP4IF = 0 'Wait for falling edge

   loop

   StopTimer 1 'Stop the time

   Pulse_Width = TIMER1 'Save the timer value
   CCP4IF = 0 'Clear the CCP4 flag
End MACRO

Also see Macros Overview

Implementing a method with a Pin name as a parameter

A constant such as a Pin name cannot be passed to a sub routine or a function. This is a constraint of
GCBasic. A macro can be used to implement a method of passing a constant.

The example shown below implements a button press routine and takes an input port constant and
prints the result on an LCD display.

A macro will use more program memory as the macro will be compiled as inline code.
NOTE Therefore, for every use of the macro will use additional program memory - the same
amount of program memory for each call to the macro.
 #chip 16F877a, 16
#define Button PORTC.1 ' Switch on PIN 14 via 10K pullup resistor
DIR Button In
wait 1 sec

'USART settings
#define USART_BAUD_RATE 9600
#define USART_BLOCKING
#define USART_TX_BLOCKING

;======== MAIN PROGRAM LOOP ================

HSerPrint "Button Test"
HSerPrintCRLF 2
Do
   Test_button ( button )
Loop
;==========================================

Macro Test_button (Button)

       if Button = ON then
          wait 10 ms 'debounce
          ButtonCount = 0

           Do While Button = On

               Wait 10 ms
               ButtonCount += 1
           Loop

           if ButtonCount > 5 then

               if ButtonCount > 50 then 'Long push
                   hserprint "Long push"
               else 'Short push
                   hserprint "Short push"
               end if
               HSerPrintCRLF
           end if
           wait 1 s
       end if
End Macro

Also see Macros Overview

Example Programs
Flashing LEDs and an Interrupt
Explanation:

This code implements four flashing LEDs. This is based on the Microchip Low Pin Count Demo Board..

The example program will blink the four red lights in succession. Press the Push Button Switch, labeled
SW1, and the sequence of the lights will reverse. Rotate the potentiometer, labeled RP1, and the light
sequence will blink at a different rate.

This implements an interrupt for the switch press, reads the analog port and set the LEDs.

#chip 18F14K22, 32
#config OSC = IRC, MCLRE_OFF

' Works with the low count demo board

'Set the input pin direction

    #define SwitchIn1 PORTa.3
    Dir SwitchIn1 In

#define LedPort PORTc

    DIR PORTC OUT

'Setup the ADC pin direction

    Dir PORTA.0 In
    dim ADCreading as word

'Setup the input pin direction

    #define IntPortA PORTA.1
    Dir IntPortA In

' variable and constants

    #define intstate as byte
    intstate = 0
    #define minwait 1

    dim ccount as byte

    dim leddir as byte

    ccount = 8
    leddir = 0
    SET PORTC = 15
    WAIT 1 S
          SET PORTC = 0

          Set IOCA.3 on
          Dir porta.3 in
          On Interrupt PORTABCHANGE Call Setir

          setLedDirection

main:
DO
    INTON
    ADCreading = ReadAD10(AN0)
    if ADCreading < minwait then ADCreading = minwait

    ' Set LEDs

    Set PortC = ccount
    wait ADCreading ms

    if leddir = 0 then

      rotate ccount left simple
      ' Restart LED position
      if ccount = 16 then
          ccount = 128
      end if

    end if

    if leddir = 1 then

      rotate ccount Right simple
      ' restart LED position
      if ccount = 128 then
        ccount = 8
      end if

    end if
    ' reset interrupt - this may be been reset so set to zero so interrupt can operate.
    intstate = 0

Loop

sub Setir

    if IntPortA = 0 and intstate = 0 then

       intstate = 1
      wait while SwitchIn1 = 0
      setLedDirection
    end if

end sub

sub setLedDirection

  ' set LED values

  select case leddir

    case 0
      leddir = 1
      ccount = 8

    case 1
      leddir = 0
      ccount = 1

    end select

End Sub

See Also Interrupts, ReadAD10

Flashing LED with timing parameters

This is a useful example of a subroutine.

When called, this subroutine will blink an LED for the number of times and duration as determined by
the input parameters.

This is intended to demonstrate how to create and use a SUB with a useful example.

The syntax of the subroutine is:

Flash_LED (numtimes, OnTime, (optional) OffTime)
' Where numtimes is from 1 - 255 and OnTime/OffTime is
' from 0 - 65535 ms. If OffTime is not entered, then
' OffTime = OnTime.

Sub Flash_LED (in numtimes, in OnTime as WORD, Optional OffTime as WORD = OnTime)
repeat numtimes
    set LED on
    wait OnTime ms
    set LED OFF
    wait OffTime ms
end repeat
End Sub
Shown below is a working example program using a PIC 18F25K22.

Change Settings/PORTS as needed for other Chips.

Connect an LED to the LED pin through a 1K series resistor:

#chip 18F25K22, 16
#config OSC = INTIO67, MCLRE = OFF, XINST = OFF
#define LED PORTC.1 'Led on PIN 14 via 1K resistor
DIR LED OUT
wait 1 sec

;======== MAIN PROGRAM LOOP ================

Do
   Flash_LED 3,250 '3 Flashes 250 ms equal on/off time
   Wait 2 Sec
   Flash_LED 5,250,500 '5 flashes On 250 ms / off 500 ms
   Wait 2 Sec
   Flash_LED 10,100 '10 rapid flashes
   Wait 2 Sec
Loop
;==========================================

Sub Flash_LED (in numtimes, in OnTime as WORD, optional OffTime as word = OnTime)
    repeat numtimes
        set LED on
        wait OnTime ms
        set LED OFF
        wait OffTime ms
    end repeat
End Sub
Generate Accurate Pulses
Introduction:

The PulseOut Command is a reliable method for generating pulses if accuracy is not critical, the
PulseOut command uses a calculation of the clock to speed for the timing .

If you need better accuracy and resolution then an alternative approach is required.

To generate pulses in the 100 us to 2500 us range with an accuracy of +- 1us over this range is practical
using the approach shown in this example.

This example code works on a midrange PIC16F690 operating at 8Mhz. However, it should work on
any Microchip microprocessor, but may need some minor modifications.

Usage:

Pulse_Out_us ( word_value )

How It Works:

Timer1 is loaded with a preset value based upon the variable passed to the sub routine. The timer
(Timer1v) is started and the pulse pin (the output pin) is set high. When `Timer1 overflows the
Timer1 interrupt flag bit (TMR1IF) is set. This causes the program to exit a polling loop and set the pulse
Pin off. Then, Timer1 is stopped and TMRIF flag is cleared and the sub routine exits.

This method supports delays between 5 us and 65535 us and uses Timer1.

Test Results:

These tests were completed using a Saleae Logic Analyzer.

Pulse setting Time Results

Pulse_Out_us (2500) 2501.375 us

Pulse_Out_us (1000) 1000.750 us
Pulse_Out_us (100) 100. 125 us
Pulse_Out_us (10) 10.125 us

Pulse_Out_us with less then 4 Unreliable results

;**************************************
; Code: Output an accurate pulse
; Author: William Roth 03/13/2015
;**************************************
#chip 16F690,8

; ---- Define Hardware settings

; ---- Define I2C settings - CHANGE PORTS AS REQUIRED
#define I2C_MODE Master
#define I2C_DATA PORTB.4
#define I2C_CLOCK PORTB.6
#define I2C_DISABLE_INTERRUPTS ON

; ---- Set up LCD - Using I2C LCD Backpack

#define LCD_IO 10
#define LCD_I2C_Address_1 0x4e ; default to 0x4E
; ---- May need to use SLOW or MEDIUM if your LCD is a slower device.
#define LCD_SPEED Medium
#define LCD_Backlight_On_State 1
#define LCD_Backlight_Off_State 0

CLS
; ---- USART settings
#define USART_BAUD_RATE 38400
DIR PORTB.7 OUT

; ---- Setup Pulse parameters

#define PulsePin PORTC.4
Dim Time_us As WORD
Dir PulsePin Out 'Pulsout pin
Set PulsePin off

; ---- Setup Timer

InitTimer1 Osc, PS1_2 'For 8Mhz Chip
'InitTimer1 Osc, PS1_4, 'For 16 Mhz Chip
TMR1H = 0: TMR1L = 0 'Clear timer1
TMR1IF = 0 'Clear timer1 int flag
TMR1IE = on 'Enable timer1 Interrupt (Flag only)

' **** This is the MAIN loop *****

Do
    PULSE_OUT_US (2500) 'Measured as 2501.375 us
    wait 19 ms
    Pulse_Out_US (1000) 'Measured as 1000.750 us
    wait 19 ms
    Pulse_Out_US (100) 'Measured as 100.125 us
    wait 19 ms
    Pulse_Out_US (10) 'Measured as 10.125 us
    Wait 19 ms
loop
 SUB PULSE_OUT_US (IN Variable as WORD)
TMR1H = 65535 - Variable_H 'Timer 1 Preset High
TMR1L = (65535 - Variable) + 4 'Timer 1 Preset Low
Set TMR1ON ON 'Start timer1
Set PulsePin ON 'Set Pin high
Do While TMR1IF = 0 'Wait for Timer1 overflow
    Loop
Set PulsePin off ' Pin Low
Set TMR1ON OFF ' Stop timer 1
TMR1IF = 0 'Clear the Int flag
END SUB

Also see PulseOut

Graphical LCD Demonstration

Explanation:

This demonstration code shows the full set of command supported by Great Cow Basic.

;Chip Settings
#chip 16F877a,16

#include <glcd.h>

#Define glcd_rw PORTD.3 'RW pin on LCD

#Define glcd_reset PORTD.4 'Reset pin on LCD
#Define glcd_cs1 PORTD.1 'CS1, CS2 are backward
#Define glcd_cs2 PORTD.2 'CS1, CS2 are backward
#Define glcd_rs PORTD.5 'D/I pin on LCD
#Define glcd_enable PORTD.4 'E pin on LCD
#Define glcd_db0 PORTB.0 'D0
#Define glcd_db1 PORTB.1 'D1
#Define glcd_db2 PORTB.2 'D2
#Define glcd_db3 PORTB.3 'D3
#Define glcd_db4 PORTB.4 'D4
#Define glcd_db5 PORTB.5 'D5
#Define glcd_db6 PORTB.6 'D6
#Define glcd_db7 PORTB.7 'D7 on LCD

#define GLCD_TYPE GLCD_TYPE_KS0108

#define GLCD_WIDTH 128
#define GLCD_HEIGHT 64
#define GLCD_PROTECTOVERRUN

wait 1 s
GLCDCLS
GLCDPrint 0, 1, "Great Cow Basic "
wait 1 s
GLCDCLS

'USART settings
#define USART_BAUD_RATE 9600
Dir PORTc.6 Out
#define USART_DELAY 5 ms
#define SerSendDelayms 10
wait 1 s
HSerPrint "KS0108 Test GLCD Driver":crlf(1)
USART = true

rrun = 0
dim msg1 as string * 16

do forever

  GLCDCLS
  Box 18,30,28,40
  Line 0,0,127,63
  Line 0,63,127,0
  wait 1 s

  FilledBox 18,30,28,40
  wait 1 s

  GLCDCLS

    GLCDDrawString 30,0,"ChipMhz@"
    GLCDDrawString 78,0, str(ChipMhz)
    Circle(10,10,10,1) ;upper left
    Circle(117,10,10,1) ;upper right
    Circle(63,31,10,1) ;center
    Circle(63,31,20,1) ;center
    Circle(10,53,10,1) ;lower left
    Circle(117,53,10,1) ;lower right
    wait 1 s

    GLCDDrawString 30,0,"ChipMhz@"
    GLCDDrawString 78,0, str(ChipMhz)
    FilledCircle(10,10,10,1) ;upper left
    FilledCircle(117,10,10,1) ;upper right
    FilledCircle(63,31,10,1) ;center
    FilledCircle(63,31,20,1) ;center
    FilledCircle(10,53,10,1) ;lower left
    FilledCircle(117,53,10,1) ;lower right
    wait 1 s

    GLCDCLS
        GLCDDrawString 30,0,"ChipMhz@"
    GLCDDrawString 78,0, str(ChipMhz)
    Circle(10,0,10,1) ;upper left
    Circle(117,0,10,1) ;upper right
    Circle(63,31,10,1) ;center
    Circle(63,31,20,1) ;center
    Circle(10,63,10,1) ;lower left
    Circle(117,63,10,1) ;lower right
    wait 1 s

    GLCDCLS
    GLCDDrawString 0,10,"Hello" 'Print Hello
    wait 1 s
    GLCDDrawString 0,10, "ASCII #:" 'Print ASCII #:
    Box 18,30,28,40 'Draw Box Around ASCII Character
    for char = 0x30 to 0x39 'Print 0 through 9
      GLCDDrawString 16, 20 , Str(char)+" "
      GLCDdrawCHAR 20, 30, char
      wait 250 ms
    next
    line 0,50,127,50 'Draw Line using line command
    for xvar = 0 to 80 'draw line using Pset command
        pset xvar,63,on '
    next
    FilledBox 18,30,28,40 'Draw Box Around ASCII Character '
    wait 1 s
    GLCDCLS
    GLCDDrawString 0,10,"End "
    wait 1 s
    GLCDCLS

    workingGLCDDrawChar:
    dim gtext as string
    gtext = "KS0108"

        for xchar = 1 to gtext(0) 'Print 0 through 9

          xxpos = (1+(xchar*6)-6)
          GLCDDrawChar xxpos , 0 , gtext(xchar)
       next

    GLCDDrawString 1, 9, "Great Cow Basic @2014"

    GLCDDrawString 1, 18,"GLCD 128*64"
    GLCDDrawString 1, 27,"Using GLCD.H from GCB"
    GLCDDrawString 1, 37,"Using GLCD.H GCB@2014"
    GLCDDrawString 1, 45,"GLCDDrawChar method"
     GLCDDrawString 1, 54,"Test Routines"

    wait 1 s
    GLCDCLS

    msg1 = "Run = " +str(rrun)

    rrun++
    GLCDPrint 0, 3, msg1
    wait 1 s
    GLCDCLS

loop

For more help, see Graphical LCD Demonstration, InitGLCD, GLCDCLS, GLCDDrawChar, GLCDPrint,
GLCDReadByte, GLCDWriteByte, Pset

Versions of GCB prior to May 2014 does not support circle drawing. You can install
WARNING
the latest <glcd.h> file to enable this functionality.

InfraRed Remote
Explanation:

Great Cow Basic support interfacing with IR remote controls. The header file contains explanations, for
both hardware and software, see SonyRemote.h.

This has been tested on many different IR sensors, and different remote controls.

The example is expected to work with most any IR sensor running at a 38 kHz carrier frequency.
;This demo prints the device number and key number sent by
;a Sony compatible IR remote control unit.

;Thomas Henry --- 4/23/2014

#chip 16F88, 8 ;PIC16F88 running at 8 MHz

#config mclr=off ;reset handled internally
#config osc=int ;use internal clock
#include <SonyRemote.h> ;include the header file

;----- Constants

#define LCD_IO 4 ;4-bit mode

#define LCD_RS PortB.2 ;pin 8 is Register Select
#define LCD_Enable PortB.3 ;pin 9 is Enable
#define LCD_DB4 PortB.4 ;DB4 on pin 10
#define LCD_DB5 PortB.5 ;DB5 on pin 11
#define LCD_DB6 PortB.6 ;DB6 on pin 12
#define LCD_DB7 PortB.7 ;DB7 on pin 13
#define LCD_NO_RW 1 ;ground RW line on LCD

#define IR_DATA_PIN PortA.0 ;sensor on pin 17

;----- Variables

dim device, button as byte

;----- Program

dir PortA in ;A.0 is IR input

dir PortB out ;B.2 - B.6 for LCD

do
  readIR_Remote(device, button) ;wait for button press

  cls ;show device code

  print "Device: "
  print device

  locate 1,0
  print "Button: " ;show button code
  print button

  wait 10 mS ;ignore any repeats

loop ;repeat forever
SonyRemote.h

;Sony IR Remote Control Library for Great Cow Basic

;Thomas Henry
;Version 2.0 -- 4/23/2014

;This include file will let you easily read and use the
;infrared signals from a Sony compatible television remote
;control. In particular, the remote control transmits a
;pulse modulated signal, the sensor detects this, and the
;subroutine in this header file decodes the signal,
;returning two numbers: one representing the device
;(television, VCR, DVD, tuner, etc.), while the the other
;returns the key which has been depressed (VOL+, MUTE,
;channel numbers 0 through 9, etc.).

;This has been tested and confirmed with a fixed

;remote control purchased surplus for $2.00 from All
;Electronics, as well as an universal remote control, set
;to Sony mode.

;Moreover it has also been tested with a Panasonic IR

;sensor and a Vishay sensor, both purchased surplus for
;about fifty cents.

;Every combination performed well, and it is probably the;

;case that most any garden variety 38 kHz IR sensor will
;work. The only tricky bit is making sure you get the pinout
;for your sensor correct; search out the datasheet for
;whichever device you use. There are only three pins:

;Ground
;Vcc
;Data

;It is essential to filter the power applied to the Vcc pin.

;Do this by connecting a 100 ohm resistor from the +5V power
;supply to the Vcc pin, and bridge the pin to ground with a
;4.7uF electrolytic capacitor.

;The Data pin requires a 4.7k pullup resistor.

;There is only one constant required of the calling program.

;It indicates which port line the IR sensor is connected to.
;For example,
;#DEFINE IR_DATA_PIN PORTA.0

;There is one subroutine:

;readIR_Remote(IR_rem_dev, IR_rem_key)

;The values returned are, respectively, the device number

;mentioned earlier and the key that is currently pressed. Both
;are byte values.

;Seventeen local bytes are consumed, and two bytes are used for
;the output parameters. That's a grand total of nineteen bytes
;required when invoking this subroutine.

sub readIR_Remote(out IR_rem_dev as byte, out IR_rem_key as byte)

  dim IR_rem_count, IR_rem_i as byte
  dim IR_rem_width(12) as byte ;pulse width array

  do
    IR_rem_count = 0 ;wait for start bit
    do while IR_DATA_PIN = 0 ;measure width (active low)
      wait 100 uS ;24 X 100 uS = 2.4 mS
      IR_rem_count++
    loop
  loop while IR_rem_count < 20 ;less than this so wait

  for IR_rem_i = 1 to 12 ;read/store the 12 pulses

    do
      IR_rem_count = 0
      do while IR_DATA_PIN = 0 ;zero = 6 units = 0.6 mS
        wait 100 uS ;one = 12 units = 1.2 mS
        IR_rem_count++
      loop
    loop while IR_rem_count < 4 ;too small to be legit

    IR_rem_width(IR_rem_i) = IR_rem_count ;else store pulse width

  next IR_rem_i

  IR_rem_key = 0 ;command built up here

  for IR_rem_i = 1 to 7 ;1st 7 bits are the key
    IR_rem_key = IR_rem_key / 2 ;shift into place
    if IR_rem_width(IR_rem_i) > 10 then ;longer than 10 mS
       IR_rem_key = IR_rem_key + 64 ;so call it a one
    end if
  next

  IR_rem_dev = 0 ;device number built up here

  for IR_rem_i = 8 to 12 ;next 5 bits are device number
     IR_rem_dev = IR_rem_dev / 2
    if IR_rem_width( IR_rem_i ) > 10 then
       IR_rem_dev = IR_rem_dev + 16
    end if
  next
end sub

Midpoint Circle Algorithm

Explanation:

Great Cow Basic can draw circle using the midpoint circle algorithm. This is an algorithm used to
determine the points needed for drawing a circle. The algorithm is a variant of Bresenham’s line
algorithm, and is thus sometimes known as Bresenham’s circle algorithm, although not actually
invented by Jack E. Bresenham.

The program below show the midpoint circle algorithm within Great Cow Basic.

An example is show below:

Example:

'Midpoint Circle algorithm

'Chip model
#chip 16F886, 8 ;PIC16F88 running at 8 MHz
#config mclr=off ;reset handled internally
#config osc=int ;use internal clock

#include <glcd.h>

;----- Constants
;Pinout is shown for the LCM12864H-FSB-FBW
;graphical LCD available from Amazon.

; +5V ;LCD pin 1

; ground ;LCD pin 2
; Vo = wiper of pot ;LCD pin 3
#define GLCD_DB0 PORTB.0 ;LCD pin 4
#define GLCD_DB1 PORTB.1 ;LCD pin 5
#define GLCD_DB2 PORTB.2 ;LCD pin 6
#define GLCD_DB3 PORTB.3 ;LCD pin 7
#define GLCD_DB4 PORTB.4 ;LCD pin 8
#define GLCD_DB5 PORTB.5 ;LCD pin 9
#define GLCD_DB6 PORTB.6 ;LCD pin 10
#define GLCD_DB7 PORTB.7 ;LCD pin 11
#define GLCD_CS2 PORTA.0 ;LCD pin 12
#define GLCD_CS1 PORTA.1 ;LCD pin 13
#define GLCD_RESET PORTA.2 ;LCD pin 14
#define GLCD_RW PORTA.3 ;LCD pin 15
#define GLCD_RS PORTA.4 ;LCD pin 16
#define GLCD_ENABLE PORTA.6 ;LCD pin 17
; Vee = pot low side ;LCD pin 18
; backlight anode ;LCD pin 19
; backlight cathode ;LCD pin 20

#define GLCD_TYPE GLCD_TYPE_KS0108

#define GLCD_WIDTH 128
#define GLCD_HEIGHT 64

;----- Variables

dim cx, cy, edge, j as byte

dim i as word

;----- Program

dim xradius, yordinate , radiusErr, incrementalxradius, orginalxradius, orginalyordinate

as Integer

Start:

    GLCDDrawString 30,0,"ChipMhz@"
    GLCDDrawString 78,0, str(ChipMhz)
    GLCDCircle(10,10,10,0) ;upper left
    GLCDCircle(117,10,10,0) ;upper right
    GLCDCircle(63,31,10,0) ;center
    GLCDCircle(63,31,20,0) ;center
     GLCDCircle(10,53,10,0) ;lower left
    GLCDCircle(117,53,10,0) ;lower right
    GLCDDrawString 30,54,"PIC16F886"

goto start

sub GLCDCircle ( in xoffset, in yoffset, in xradius, in yordinate)

'radiusErr = 1 - xradius
radiusErr = -(xradius/2)
Do While xradius >= yordinate
   Pset ((xoffset + xradius), (yoffset + yordinate), on)
   Pset ((xoffset + yordinate), (yoffset + xradius), on)
   Pset ((xoffset - xradius), (yoffset + yordinate), on)
   Pset ((xoffset - yordinate), (yoffset + xradius), on)
   Pset ((xoffset - xradius), (yoffset - yordinate), on)
   Pset ((xoffset - yordinate), (yoffset - xradius), on)
   Pset ((xoffset + xradius), (yoffset - yordinate), on)
   Pset ((xoffset + yordinate), (yoffset - xradius), on)
   yordinate ++
   If radiusErr < 0 Then
      radiusErr = radiusErr + 2 * yordinate + 1
   else
      xradius --
      radiusErr = radiusErr + 2 * (yordinate - xradius + 1)
   end if
Loop
end sub

IC2 Master Hardware

Explanation:

This program demonstrates how to read and write data from an EEPROM device.

This program has three sections. Read a single byte from the EEPROM, write and read a page of 64
bytes to and from the EEPROM and finally display the contents of the EEPROM.

This program also has an interrupt driven serial handler to capture and manage input from a serial
terminal.

Demonstration program:

' change the processor

  #chip 16F1937, 32
  #config Osc = intOSC, MCLRE_ON, PLLEN_ON, VCAPEN_OFF
  #include <I2CEEPROM.h>

  ' Define I2C settings - CHANGE PORTS

  #define HI2C_BAUD_RATE 400

  #define HI2C_DATA PORTC.4

  #define HI2C_CLOCK PORTC.3
  'Initialise I2C Slave
  'I2C pins need to be input for SSP module
  Dir HI2C_DATA in
  Dir HI2C_CLOCK in
'MASTER
  HI2CMode Master

' THIS CONFIG OF THE SERIAL PORT WORKS WITH max232 THEN TO PC
' USART settings
         #define USART_BAUD_RATE 9600
         Dir PORTc.6 Out
         Dir PORTc.7 In
         #define USART_DELAY 5 ms
         #define SerSendDelayms 10
         #define USART_BLOCKING
         wait 500 ms
         'Serial Interrupt Handler
         On Interrupt UsartRX1Ready Call readUSART

         ' Constants etc required for the serial Buffer Ring

         #define BUFFER_SIZE 32
         #define bkbhit (next_in <> next_out)
        ' Required Variables for the serial Buffer Ring
         Dim buffer(BUFFER_SIZE)
         Dim next_in as byte: next_in = 1
         Dim next_out as byte: next_out = 1
         Dim syncbyte as Byte

         wait 125 ms

         ' Read ONE byte from the EEPROM

          dim DeviceID as byte
          dim EepromAddress, syscounter as word
          #define EEpromDevice 0xA0

        'Master Main Loop

        location = 0
        dim outarray(64), inarray(64)

        do
          HSerPrintCRLF 2
          HSerPrint "Commence Array Write and Read"
          for tt = 1 to 64
              outarray(tt) = tt
          next
          'eeprom_wr_array(device_number, page_size, address, array_name,
number_of_bytes)
          eeprom_wr_array(EEpromDevice, 64, location, outarray, 64)

          ;eeprom_rd_array(device_number, address, array_name, number_of_bytes)

          eeprom_rd_array(EEpromDevice, location, inarray, 64)

          HSerPrintCRLF 2
          for tt = 1 to 64

              if outarray(tt) <> inarray(tt) then

                 Hserprint "!"
                 HSerPrint inarray(tt)

              else
                 HSerPrint inarray(tt)

              end if
              HSerPrint ","
          next

          HSerPrintCRLF 2

          HSerPrint "Commence Write and Read a single byte":HSerPrintCRLF

          HSerPrint "Read value should be "
          HSerPrint str(location):HSerPrintCRLF
          HSerPrint "Read = "
          eeprom_wr_byte (EEpromDevice, location, location)
          eeprom_rd_byte (EEpromDevice, location, bbyte )

          HSerPrint bbyte
          location++
          HSerPrintCRLF 2

          HI2CDeviceSearch

          HSerPrint "Commence Dump of eeprom"

          validateEEPROM
        Loop
        end

        'Slave Main Loop

' Do
' ' Do stuff
'
' 'Check for I2C messages
' ProcessHI2CSlave
'
' Loop
' end

sub HI2CDeviceSearch
         ' assumes serial is operational
         HSerPrintCRLF
         HSerPrint "I2C Device Search"
         HSerPrintCRLF 2
              for deviceID = 0 to 255
                HI2CStart
                HI2CSend ( deviceID )
                if HI2CAckPollState = false then
                  HSerPrint "ID: 0x"
                  HSerPrint hex(deviceID)
                  HSerSend 9
                  testid = deviceID | 1
                  select case testid
                         case 49
                              Hserprint "DS2482_1Channel_1Wire Master"
                         case 65
                              Hserprint "Serial_Expander_Device"
                         Case 73
                               Hserprint "Serial_Expander_Device"
                         case 161
                              Hserprint "EEProm_Device_Device"
                         case 163
                              Hserprint "EEProm_Device_Device"
                         case 165
                              Hserprint "EEProm_Device_Device"
                         case 167
                              Hserprint "EEProm_Device_Device"
                         case 169
                              Hserprint "EEProm_Device_Device"
                         case 171
                              Hserprint "EEProm_Device_Device"
                         case 173
                              Hserprint "EEProm_Device_Device"
                         case 175
                              Hserprint "EEProm_Device_Device"
                         case 209
                              Hserprint "DS1307_RTC_Device"
                         case 249
                              Hserprint "FRAM_Device"
                         case else
                              Hserprint "Unknown_Device"
                  end select
                   HI2CSend ( 0 )
                   HI2CSend ( 0 )
                   HSerPrintCRLF
                end if

               HI2CStop
              next

              HSerPrint "End of Device Search"

         HSerPrintCRLF 2
end sub

sub validateEEPROM
    ' validation EEPROOM code
              EepromAddress = 0
              HSerPrintCRLF 2
              HSerPrint "Hx"
              HSerPrint hex(EepromAddress_h)
              HSerPrint hex(EepromAddress)
              HSerPrint " "

              for EepromAddress = 0 to 0xffff

                  eeprom_rd_byte EEPromDevice, EepromAddress, objType

                  HSerPrint hex(objType)+" "

                  if ((EepromAddress+1) % 8 ) = 0 then
                     HSerPrintCRLF
                      HSerPrint "Hx"
                      syscounter = EepromAddress + 1
                      HSerPrint hex(syscounter_h)
                      HSerPrint hex(syscounter)
                      HSerPrint " "

                  end if
                  if bkbhit then
                     syschar = bgetc
                     select case syschar
                            case 32
                              do while bgetc = 32
                              loop
                            case else
                                 HSerPrintCRLF
                                 HSerPrint "Done"
                                 exit sub
                     end select
                   end if
              next
HSerPrintCRLF
HSerPrint "Done"
end Sub

' Start of Serial Support functions

' Required to read the serial port
' Assumes serial port has been initialised
Sub readUSART
    buffer(next_in) = HSerReceive
    temppnt = next_in
    next_in = ( next_in + 1 ) % BUFFER_SIZE
    if ( next_in = next_out ) then ' buffer is full!!
       next_in = temppnt
    end if
End Sub

' Serial Support functions

' Get characters from the serial port
function bgetc
   wait while !(bkbhit)
   bgetc = buffer(next_out)
   next_out=(next_out+1) % BUFFER_SIZE
end Function

I2C Slave Hardware

Explanation:

This program demonstrates how to control and display on an LCD Code for the keypad and LCD PIC on
the Microlab board v2

This program also has an interrupt driven I2C handler to manage the I2C from the Start event..

Demonstration program:

'Code for the keypad and LCD PIC on the Microlab board v2
'PIC is responsible for:
' - Reading keypad
' - Displaying data on LCD
' - communication with main PIC via I2C
' - providing 5 keypad lines to main PIC (for compatibility)
' - receiving remote control signals for button and keypad
'This code has support for two keypad layouts. This is one possible layout:
'0123
'4567
'89AB
'CDEF
'And this is the other possible layout:
'123A
'456E
'789D
'A0BC
'Select the keypad layout by uncommenting one of these lines:
'#define KEYPAD_KEYMAP KeypadMap0123
#define KEYPAD_KEYMAP KeypadMap123F

'Chip and config

#chip 16F882, 8
#config osc = INTOSCIO

'Ports connected to keypad

'Column ports need pullups, hence columns are on PORTB for built in weak pullups
#define KEYPAD_COL_1 PORTB.4
#define KEYPAD_COL_2 PORTB.5
#define KEYPAD_COL_3 PORTB.6
#define KEYPAD_COL_4 PORTB.7
#define KEYPAD_ROW_1 PORTA.4
#define KEYPAD_ROW_2 PORTA.3
#define KEYPAD_ROW_3 PORTA.2
#define KEYPAD_ROW_4 PORTA.1

'Ports connected to LCD

#define LCD_IO 4
#define LCD_RW PORTA.7
#define LCD_RS PORTA.6
#define LCD_Enable PORTA.5
#define LCD_DB4 PORTA.4
#define LCD_DB5 PORTA.3
#define LCD_DB6 PORTA.2
#define LCD_DB7 PORTA.1
#define BACKLIGHT PORTA.0

'Button port (for remote control)

#define BUTTON PORTB.0

'Keypad ports connected to main PIC

'These are disabled when KeyoutDisabled = true
#define KEYOUT_A PORTC.5
#define KEYOUT_B PORTC.2
#define KEYOUT_C PORTC.1
#define KEYOUT_D PORTC.0
#define KEYOUT_DA PORTB.1

'I2C ports
#define I2C_DATA PORTC.4
#define I2C_CLOCK PORTC.3

'RS232/USART settings
'To do if/when remote support needed

'Initialise
Dir KEYOUT_A Out
Dir KEYOUT_B Out
Dir KEYOUT_C Out
Dir KEYOUT_D Out
Dir KEYOUT_DA Out

Dir BACKLIGHT Out

Dir BUTTON In 'Is an output, turn off by switching pin to Hi-Z

'Initialise I2C Slave

'I2C pins need to be input for SSP module
Dir I2C_DATA In
Dir I2C_CLOCK In
HI2CMode Slave
HI2CSetAddress 128

'Buffer for incoming I2C messages

'Each message takes 4 bytes
Dim I2CBuffer(10)
BufferSize = 0
OldBufferSize = 0

'Set up interrupt to process I2C

On Interrupt SSP1Ready Call I2CHandler

'Enable weak pullups on B4-7 (keypad col pins)

NOT_RBPU = 0
WPUB = b'11110000'

'Key buffers
'255 indicates no key, other value gives currently pressed key
RemoteKey = 255
OutKey = 255
KeyoutDisabled = False 'False if KEYOUT lines used to send key

'Main loop
Do
    'Read keypad, send value
    CheckPressedKeys
    SendKeys

    'Check for I2C messages

    ProcessI2C

Loop

'This keymap table is for this arrangement:

'0123
'4567
'89AB
'CDEF
Table KeypadMap0123
    3
    7
    11
    15
    2
    6
    10
    14
    1
    5
    9
    13
    0
    4
    8
    12
End Table

'This keymap table is for this arrangement:

'123F
'456E
'789D
'A0BC
Table KeypadMap123F
    15
    14
    13
    12
    3
    6
    9
    11
    2
    5
    8
    0
    1
    4
    7
    10
End Table

Sub CheckPressedKeys
    'Subroutine to:
    ' - Read keypad
    ' - Check remote keypress
    ' - Decide which key to output

    'Read keypad
    If RemoteKey <> 255 Then
        OutKey = RemoteKey
    Else
        EnableKeypad
        OutKey = KeypadData

    End If

End Sub

Sub EnableKeypad
    'Disable LCD so that keypad can be activated
    Set LCD_RW Off 'Write mode, don't let LCD write

    'Re-init keypad
    InitKeypad

End Sub

Sub I2CHandler
    'Handle I2C interrupt
    'SSPIF doesn't trigger for stop condition, only start!

    'If buffer full flag set, read

    Do While HI2CHasData

        HI2CReceive DataIn

        'Sending code
        If BufferSize = 0 Then
            LastI2CWasRead = False
            'Detect read address
            If DataIn = 129 Then
                LastI2CWasRead = True

                HI2CSend OutKey

                KeyoutDisabled = True
                Dir KEYOUT_A In
                Dir KEYOUT_B In
                Dir KEYOUT_C In
                Dir KEYOUT_D In
                Dir KEYOUT_DA In

                Exit Sub
            End If
        End If

        If BufferSize < 10 Then I2CBuffer(BufferSize) = DataIn

        BufferSize += 1
    Loop

End Sub

Sub SendKeys

    'Don't run if not using KEYOUT lines

    If KeyoutDisabled Then Exit Sub

    'Send pressed keys

    If OutKey <> 255 Then
        'If there is a key pressed, set output lines
        If OutKey.0 Then
            KEYOUT_A = 1
        Else
            KEYOUT_A = 0
        End If
        If OutKey.1 Then
            KEYOUT_B = 1
        Else
            KEYOUT_B = 0
        End If
        If OutKey.2 Then
            KEYOUT_C = 1
        Else
            KEYOUT_C = 0
        End If
        If OutKey.3 Then
            KEYOUT_D = 1
        Else
            KEYOUT_D = 0
        End If

        KEYOUT_DA = 1
    Else
        'If no key pressed, clear data available line to main PIC
        KEYOUT_DA = 0
    End If

End Sub

Sub ProcessI2C

    If HI2CStopped Then

        IntOff

        If LastI2CWasRead Then BufferSize = 0

        If BufferSize <> 0 Then

            OldBufferSize = BufferSize
            BufferSize = 0
        End If
        IntOn
    End If

    If OldBufferSize <> 0 Then

        CmdControl = I2CBuffer(1)

        'Set backlight
        If CmdControl.6 = On Then
            Set BACKLIGHT On
        Else
            Set BACKLIGHT Off
        End If

        'Set R/S bit

        LCD_RS = CmdControl.4

        'Send bytes to LCD

        LCDDataBytes = CmdControl And 0x0F
        If LCDDataBytes > 0 Then
            For CurrSendByte = 1 To LCDDataBytes
                LCDWriteByte I2CBuffer(LCDDataBytes + 1)
            Next
        End If
        'LCDWriteByte I2CBuffer(2)
         OldBufferSize = 0
    End If

End Sub

RGB LED Control

Explanation:

This program demonstrates how to drive an RGB LED to create 4096 different colors. Each of the three
;elements (red, green and blue) responds to 16 different levels. A value of 0 means the element never
turns on, while a value of 15 means the element never shuts off. Values in between these two extremes
vary the pulse width.

This program is an interrupt driven three channel PWM implementation. The basic carrier frequency
depends upon the microcontroller clock speed. For example, with an 8 MHz clock, the LED elements
are modulated at about 260 Hz. The interrupts are generated by Timer 0. With an 8 MHz clock they
occur about every 256 uS. The interrupt routine consumes about 20 uS.

Don’t forget the current limiting resistors to the LED elements. A value of around 470 ohms is good, but
you may want to adjust the individual values, to balance the color response.

In this demonstration, three potentiometers are used to set the color levels.

Demonstration program:
;----- Configuration
#chip 16F88, 8 ;PIC16F88 running at 8 MHz
#config mclr=off ;reset handled internally
#config osc=int ;use internal clock
;----- Constants
#define LED_R PortB.0 ;pin to red element
#define LED_G PortB.1 ;pin to green element
#define LED_B PortB.2 ;pin to blue element
;----- Variables
dim redValue, greenValue, blueValue, ticks as byte
;----- Program
dir PortA in ;three pots for inputs
dir PortB out ;the LED outputs
on interrupt Timer0Overflow call update
initTimer0 Osc, PS0_1/2
do
  redValue = readAD(AN0)/16 ;red -- 0 to 15
  greenValue = readAD(AN1)/16 ;green -- 0 to 15
  blueValue = readAD(AN2)/16 ;blue -- 0 to 15
loop
sub update ;interrupt routine
  ticks++ ;increment master timekeeper
  if ticks = 15 then ;start of the count
    ticks = 0
    if redValue <> 0 then ;only turn on if nonzero
      set LED_R on
    end if
    if greenValue <> 0 then
      set LED_G on
    end if
    if blueValue <> 0 then
      set LED_B on
    end if
  end if
  if ticks = redValue then ;time to turn off red?
    set LED_R off
  end if
  if ticks = greenValue then ;time to turn off green?
    set LED_G off
  end if
  if ticks = blueValue then ;time to turn off blue?
    set LED_B off
  end if
end sub
Serial/RS232 Buffer Ring
Explanation:

;Chip Settings
#chip 16F1937,32
#config LVP=OFF, BODEN=OFF, WDT=OFF, OSC=XT

' [change to your config] This is the config for a serial terminal
' turn on the RS232 and terminal port.
' Define the USART port
#define USART_BAUD_RATE 9600
#define USART_BLOCKING true
' [[change to your config] Ensure these port addresses are correct
#define SerInPort PORTc.7
#define SerOutPort PORTc.6
'Set pin directions
Dir SerOutPort Out
Dir SerInPort In

' [[change to your config] This assumes you are using an ANSI compatible terminal. Use
PUTTY.EXE it is very easy.

HSerPrint "Started: Serial between two devices"

HSerSend 10
HSerSend 13

' Pot port

DIR PORTA.0 IN

'Interrupt Handlers
On Interrupt UsartRX1Ready Call readUSART

' Constants etc required for Buffer Ring

#define BUFFER_SIZE 8
#define bkbhit (next_in <> next_out)
;Variables
Dim buffer(BUFFER_SIZE)
Dim next_in as byte: next_in = 1
Dim next_out as byte: next_out = 1
Dim syncbyte as Byte

syncbyte = 0x55 ' you can use 255 - your choice

Do
     ' Send some info to another device
    Repeat 3
        HSerSend syncbyte
    end Repeat
    HSerprint readad(an0)

    do while bkbhit

    ' get three sync chars then display the next char in buffer
        if bgetc = syncbyte and bgetc = syncbyte and bgetc = syncbyte then
            HSerPrint "sync'ed '"
            HSerPrint chr(bgetc)
            HSerSend 10
            HSerSend 13
        end if
    Loop
Loop

Sub readUSART
    buffer(next_in) = HSerReceive
    temppnt = next_in
    next_in = ( next_in + 1 ) % BUFFER_SIZE
    if ( next_in = next_out ) then ' buffer is full!!
        next_in = temppnt
    end if
End Sub

function bgetc
    wait while !(bkbhit)
    bgetc = buffer(next_out)
    next_out=(next_out+1) % BUFFER_SIZE
end Function

Sine Tables
Explanation:

This code implements Sine tables lookup in Great Cow Basic.

The example program will output the Sine value of numbers between -720 and 720 degrees.

This is implemented to output the values to an LCD display.

;Implementing the Sine function in GC Basic

;Thomas Henry -- 3/19/2014

;This program demonstrates the Sine function by printing

;out its values for arguments from -720 degrees
;to 720 degrees, in one-degree increments. The actual
;function itself is very short. The main business of the
;demo program is tied up in formatting the results to
;appear neatly on an LCD.

;This Sine function is completely general purpose. It can

;handle positive, negative or zero arguments of any
;arbitrary size.

;The values returned are valid to four decimal places,

;equivalent to most printed tables, and more than accurate
;for most engineering purposes.

;The values are maintained as signed integers, scaled up by

;a factor of 10000. A lookup table stored in program
;memory is used.

;----- Configuration

#chip 16F88, 8 ;PIC16F88 running at 8 MHz

#config mclr=off ;reset handled internally
#config osc=int ;use internal clock

;----- Constants

#define LCD_IO 4 ;4-bit mode

#define LCD_RS PortB.2 ;pin 8 is LCD Register Select
#define LCD_Enable PortB.3 ;pin 9 is LCD Enable
#define LCD_DB4 PortB.4 ;DB4 on pin 10
#define LCD_DB5 PortB.5 ;DB5 on pin 11
#define LCD_DB6 PortB.6 ;DB6 on pin 12
#define LCD_DB7 PortB.7 ;DB7 on pin 13
#define LCD_NO_RW 1 ;ground the RW line on LCD

#define degree 223 ;ASCII code for degree mark

;----- Variables

dim index as byte

dim i, sign, value, arg as integer

;----- Program

dir PortB out ;all outputs to the LCD

for i = -720 to 720 ;values of sine from -720 to 720

  cls
  print "sin(" ;print the label
  print i ;and the argument
  LCDWriteChar degree ;print degree mark
  print ")=" ;and closing parenthesis
  locate 1,0 ;move to the next line

  value = sin(i) ;get the value of the sine

  if value = 0 or value = -1 or value = 1 then

    print value ;handle whole number cases
  else
    if value < 0 then
      print "-" ;a negative result
      value = -1 * value
    end if

    print "0." ;format fractional number

    if value < 1000 then ;left pad smaller results

      print "0"
    end if
    if value < 100 then
      print "0"
    end if
      if value < 10 then
      print "0"
    end if

    print value ;then print the fraction

  end if

  wait 1 S ;pause to view

next i

;----- Subroutines

function sin(in arg as integer) as integer

  if arg < 0 then ;sine is an odd function,
    sign = -1 ;so negate negative argument
    arg = -1 * arg ;and change sign of result
  else
    sign = 1 ;else a positive argument
  end if

  arg = arg mod 360 ;reduce to 0 to 359 degrees

  if (arg > 270) then ;Quadrant IV

    sign = -1 * sign
    arg = 360 - arg ;make reference angle
  else
    if (arg > 180) then ;Quadrant III
      sign = -1 * sign
      arg = arg - 180 ;make reference angle
    else ;Quadrant II
      if (arg > 90) then
        arg = 180 - arg ;make reference angle
      end if
    end if ;Quadrant I by default
  end if

  index = [byte]arg+1 ;make index into table

  readTable sineTab, index, sin

  sin = sign * sin ;create final result

end function

;----- Data

table sineTab as word

  ;Sine values for 0 through 90 degrees, scaled up by 10000.
  0
  175
  349
  523
  698
  872
  1045
  1219
  1392
  1564
  1736
  1908
  2079
  2250
  2419
  2588
  2756
  2924
  3090
  3256
  3420
  3584
  3746
  3907
  4067
  4226
  4384
  4540
  4695
  4848
  5000
  5150
  5299
  5446
  5592
  5736
  5878
  6018
  6157
  6293
  6428
  6561
  6691
  6820
  6947
  7071
  7193
  7314
  7431
  7547
  7660
  7771
  7880
  7986
  8090
  8192
  8290
  8387
  8480
  8572
  8660
  8746
  8829
  8910
  8988
  9063
  9135
  9205
  9272
  9336
  9397
  9455
  9511
  9563
   9613
  9659
  9703
  9744
  9781
  9816
  9848
  9877
  9903
  9925
  9945
  9962
  9976
  9986
  9994
  9998
  1
end table

Trigonometry Circle
Explanation:

Great Cow Basic can draw circles using trigonometry. An example is shown below.

Example:

;Circle and filled circle commands on a graphic LCD.

;This uses the 2-place trigonometric routines found in
the include file.

;Thomas Henry -- 4/17/2014

;----- Configuration
#chip 16F88, 8 ;PIC16F88 running at 8 MHz
#config mclr=off ;reset handled internally
#config osc=int ;use internal clock

#include <GLCD.h>
#include <Trig2Places.h>

;----- Constants

;Pinout is shown for the LCM12864H-FSB-FBW

;graphical LCD available from Amazon.

; +5V ;LCD pin 1

; ground ;LCD pin 2
; Vo = wiper of pot ;LCD pin 3
#define GLCD_DB0 PORTB.0 ;LCD pin 4
#define GLCD_DB1 PORTB.1 ;LCD pin 5
#define GLCD_DB2 PORTB.2 ;LCD pin 6
#define GLCD_DB3 PORTB.3 ;LCD pin 7
#define GLCD_DB4 PORTB.4 ;LCD pin 8
#define GLCD_DB5 PORTB.5 ;LCD pin 9
#define GLCD_DB6 PORTB.6 ;LCD pin 10
#define GLCD_DB7 PORTB.7 ;LCD pin 11
#define GLCD_CS2 PORTA.0 ;LCD pin 12
#define GLCD_CS1 PORTA.1 ;LCD pin 13
#define GLCD_RESET PORTA.2 ;LCD pin 14
#define GLCD_RW PORTA.3 ;LCD pin 15
#define GLCD_RS PORTA.4 ;LCD pin 16
#define GLCD_ENABLE PORTA.6 ;LCD pin 17
; Vee = pot low side ;LCD pin 18
; backlight anode ;LCD pin 19
; backlight cathode ;LCD pin 20

#define GLCD_TYPE GLCD_TYPE_KS0108

#define GLCD_WIDTH 128
#define GLCD_HEIGHT 64

;----- Variables

dim cx, cy, edge, j as byte

dim i as word

;----- Program

InitGLCD
GLCDCLS

circle(10,10,10) ;upper left

 circle(117,10,10) ;upper right
filled(63,31,10) ;center
circle(63,31,20) ;center
filled(10,53,10) ;lower left
filled(117,53,10) ;lower right

;----- Subroutines

sub circle(cenX, cenY, rad)

  ;Center of circle = (cenX,cenY), radius = rad

  for i = 0 to 358 step 2 ;every two degrees

    cx = cenX-((10*rad*cos(i))/100+5)/10 ;properly rounded x value
    cy = cenY-((10*rad*sin(i))/100+5)/10 ;properly rounded y value

    ;the following ignores the pixel if off the screen

    if (cx>=0 and cx<=GLCD_WIDTH and cy>=0 and cy<=GLCD_HEIGHT) then
      Pset(cx, cy, on)
    end if
  next i
end sub

sub filled(cenX, cenY, rad)

  ;Center of circle = (cenX,cenY), radius = rad

  for i = 0 to 358 step 2

    cx = cenX -((10*rad*cos(i))/100+5)/10
    cy = cenY -((10*rad*sin(i))/100+5)/10
    edge = 2 * cenX - cx ;compute right edge

    for j = cx to edge ;fill entire line

      Pset(j,cy,on)
    next j
  next i
end sub

See also Trigonometry

Troubleshooting
Problem Common Causes More Assistance

There is an error in the GCBASIC Forums

program. Is Great Cow BASIC
complaining about a particular
line of code?

Great Cow BASIC has not been GCBASIC Forums

Cannot compile a program installed correctly - reinstall it.

There is a bug in Great Cow Post on the forums, or send an

BASIC email with your program
attached to
w_cholmondeley@users.sourcef
orge.net

A program compiles and Oscillator not selected. Configuration

downloads fine, but will not run

Great Cow Graphical Basic

Code Documentation
Documenting GCGB is key for ease of use. This section is intended for developers only.

Documenting is the ability to read some extra information from comments in libraries.

Some comments that start with ''' have a special meaning, and will be displayed as tooltips or as
information to the user. This helps even inexperienced users to use extra libraries.

1. A note on comments in general. GCGB uses ; to indicate comments that it has placed automatically,
and ' to indicate ones that the user has placed. When loading a program, it will not load any that
start with ;. This shouldn’t matter too much, but just something to be aware of.

2. As for code documentation comments, GCGB will load information about subroutines/functions
and any hardware settings that need to be set.

3. For subroutines, a line before the Sub or Function line that starts with ''' will be used as a tooltip
when the user hovers over the icon. A line that starts with '''@ will be interpreted differently,
depending on what comes after the @. '''@param ParamName Parameter Description will add a
description for the parameter. For a subroutine, this will show in the Icon Settings panel under the
parameter when the user has selected that icon.

4. For a function, it will show at the appropriate time in the Parameter Editor wizard. '''@return
Returned value applies to functions only. It will be displayed in the Parameter Editor wizard when
the user is asked to choose a function. An example of all this is given in srf04.h:
'''Read the distance to the nearest object
'''@param US_Sensor Sensor to read (1 to 4)
 '''@return Distance in cm
Function USDistance(US_Sensor) As Word

5. If a subroutine or command is used internally in the library, but GCGB users shouldn’t see it, it can
be hidden by placing '''@hide before the Sub or Function line. Another example from srf04.h:
'''@hide
Sub InitUSSensor
These should hopefully be pretty easy to add. For anyone more motivated, it’s also possible to add
Hardware Settings. A particular setting can be defined anywhere in the file, using this syntax:
'''@hardware condition, display name, constant, value type condition tells GCGB when to show the
setting. Normally, this is All, but sometimes it can include a constant, a space and then a comma
separated list of values. display name is a friendly name for the setting to display. constant is the
constant that must be set, and value type is the type that will be accepted for that constant’s value.
To allow for multiple value types, enter a list of types with a | between them.
Allowed types are:
free - Allows anything
label - Allows any label
condition - Allows a condition
table - Allows a data table
bit - Allows any bit from variable, or bit variable
io_pin - Allows an IO pin
io_port - Allows an entire IO port
number - Allows any fixed number or variable
rangex:y - Allows any number between x and y
var - Allows any variable
var_byte - Allows any byte variable
var_word - Allows any word variable
var_integer - Allows any integer variable
var_string - Allows any string variable
const - Allows any fixed number
const_byte - Allows any byte sized fixed number
const_word - Allows any word sized fixed number
const_integer - Allows any integer sized fixed number
const_string - Allows any fixed string
byte - Allows any byte (fixed number or variable)
word - Allows any word
integer - Allows any integer
string - Allows any string
array - Allows any array

6. When the library is added the program, GCGB will show a new device with the name of the library
file on the Hardware Settings window. The user can then set the relevant constants without
necessarily needing to see any code.
 adding a GCBASIC library to GCGB won’t result in any changes to the library. GCGB
NOTE uses the information it reads to help edit the user’s program, but then the user’s
program is passed to the compiler along with the unchanged library.

7. Hardware Settings are a bit more involved to add, but hopefully the bit of extra documentation for
subroutines will be straight forward.

Windows .NET Support

From release GCGB version 0.941 will execute under .NET 4.5/4.6 when .NET 3.5 is not installed. From
GCGB version 0.941 supports use on newer Windows versions without having to install .NET 3.5

GCBasic for Linux

Overview
Introduction:

GCBasic can be used when using the Linux Operating System.

This instructions are not distribution specific. This has bee tested and proven for Ubuntu.

Instructions:

Completed the following steps to compile GCBASIC for Linux:

1. Install FreeBasic for Linux from the FreeBasic website.

2. Download the GreatCowBasic package with source code from SourceForge. The latest version can
be found here.

3. Unzip the GreatCowBasic distribution into a folder for example in the folder /usr/share/GCBasic

4. Select the the unpacked directory:

cd /usr/share/GCBasic

5. Compile the GreatCowBasic:

fbc -exx -v -arch 586 gcbasic.bas

6. If no error occurs, you’re now ready to run the GCBasic compiler with the command:
 gcbasic

7. Confirm the version of GCBASIC by executing:

gcbasic -version

Now you can create and compile GCB source files.