Basic For PIC Microcontrollers PDF
Basic For PIC Microcontrollers PDF
CHAPTER I CHAPTER II CHAPTER III CHAPTER IV CHAPTER V MICROS CHAPTER VI CHAPTER VII APPENDIX A APPENDIX B
THE FUNDAMENTS OF PIC BASIC BASIC ELEMENTS OF PIC BASIC LANGUAGE OPERATORS INSTRUCTIONS SAMPLE PROGRAMS FOR SUBSYSTEMS WITHIN THE SAMPLES WITH PIC16F84 MICROCONTROLLER SAMPLES WITH PIC16F877 MICROCONTROLLER MPLAB MicroCode studio
Contents
To readers knowledge: The contents published in the book "Programming in BASIC for PIC microcontrollers" is subject to copyright and it must not be reproduced in any form without an explicit written permission released from the editorial of mikroElektronika. The contact address for the authorization regarding contents of this book: [email protected] . The book was prepared with due care and attention, however the publisher doesn't accept any responsibility neither for the exactness of the information published therein, nor for any consequences of its application. All the remarks bearing references to the product described in this book should be primarily sent to the manufacturer.
PIC is a registered and protected trademark of the Microchip Technology Inc. USA. Microchip logo and name are the registered tokens of the Microchip Technology. Copyright 1994, Microchip Technology Inc. All other tokens mentioned in the book are the property of the companies to which they belong.
Preface: Dear readers, In order to simplify things and crash some prejudices, I will allow myself to give you some advice before reading this book. You should start reading it from the chapter that interests you the most, in order you find suitable. As the time goes by, read the parts you may need at that exact moment. If something starts functioning without you knowing exactly how, it shouldn't bother you too much. Anyway, it is better that your program works than that it doesn't. Always stick to the practical side of life. It is much better for the program to be finished on time, to be reliable and, of course, to be paid for it as well as possible. In other words, it doesn't matter if the exact manner in which the electrons move within the PN junctions your microcontroller is composed of escapes your knowledge. You are not supposed to know the whole history of electronics in order to assure the income for you or your family. Do not expect that you will find everything you need in one single book. The information are dispersed literally everywhere around you, so it is necessary to collect them diligently and sort them out carefully. If you do so, success is inevitable. At the very end I would like to express my gratitude to my colleagues Dragan Andric and Predrag Micakovic for their great contribution in writing this book. With all my hopes of having done something worthy investing your time in. Yours Nebojsa Matic
Chapter 1
THE FUNDAMENTS OF PIC BASIC
Introduction 1.1 BASIC for PIC microcontrollers 1.2 P IC microcontrollers 1.3 First program written in PIC BASIC 1.4 Writing and compilation of a BASIC program 1.5 Loading a program into the microcontroller memory 1.6 Running your program 1.7 Problem with starting your program (what if it doesn't work)
Introduction
Simplicity and ease, which the higher programming languages bring for program writing as well as broader application of the microcontrollers, was enough to incite some companies as Microengeneering to embark on the development of BASIC programming language. What did we thereby get? Before all, the time of writing was shortened by employment of prepared functions that BASIC brings in (whose programming in assembler would have taken the biggest portion of time). In this way, the programmer can concentrate on solving the essential task without losing his time on writing the code for LCD display. To avoid any confusion in the further text, it is necessary to clarify three terms one encounters very often. Programming language is understood as a set of commands and rules according to which we write the program and therefore we distinguish various programming languages such as BASIC, C, PASCAL etc. On the BASIC programming language the existing literature is pretty extensive so that most of the attention in this book will be dedicated to the part concretely dealing with the programming of microcontrollers. Program consists of sequence of commands of language that our microcontroller executes one after another. The structure of BASIC program is explained with more detailed in the second chapter. BASIC compiler is the program run on PC and it's task is to translate the original BASIC code into the language of 0 and 1 understandable to the microcontroller. The process of translation of a BASIC program into an executive HEX code is shown on the image below. The program written in PIC BASIC and registered as a file Program.bas is converted into an assembler code (Program.asm). So obtained assembler code is further translated into executive HEX code which is written to the microcontroller memory by a programmer. (programmer is a device used for transferring HEX files from PC to the microcontroller memory)
can either be programmed only once (OTP version with ROM memory) or have glass window (JW version with EPROM memory), which allows erasing by few minutes exposure to UV light. OTP versions are usually cheaper and are used for manufacturing large series of products. Besides FLASH memory, microcontrollers of PIC16F87x and PIC16F84 series also contain 64-256 bytes of internal EEPROM memory, which can be used for storing program data and other parameters when power is off. PIC BASIC has built -in READ and WRITE instructions that can be used for loading and saving data to EEPROM. In order to have complete information about specific microcontroller in the application, you should get the appropriate Data Sheet or Microchip CD-ROM.
The program examples worked out throughout this book are mostly to be run on the microcontrollers PIC16F84 or PIC6F877, but could be, with small or almost no corrections, run on any other PIC microcontroller.
When the original BASIC program is finished and saved as a single file with .BAS ending it is necessary to start PIC BASIC compiler. The compiling procedure takes place in two consecutive steps. Step 1. In the first step compiler will convert BAS file in assembler s code and save it as BLINK.ASM file. Step 2. In the second step compiler automatically calls assembler, which converts ASM - type file into an executable HEX code ready for reading into the programming memory of a microcontroller. The transition between first and second step is for a user - programmer an invisible one, as everything happens completely automatically and is thereby wrapped up as an indivisible process. In case of a syntax error of a program code, the compilation will not be successful and HEX file will not be created at all. Errors must be then corrected in original BAS file and repeat the whole compilation process. The best tactics is to write and test small parts of the program, than write one gigantic of 1000 lines or more and only then embark on error finding.
Besides reading of a program code into the programming memory, the programming device serves to set the configuration of a microcontroller. Here belongs the type of the oscillator, protection of the memory against reading, switching on of a watchdog timer etc. The connection between PC, programming device and the microcontroller is shown.
The programming software is used exclusively for the communication with the programming device and is not suitable for any code writing. The one comprising text editor, software for programming microcontroller and possibly the simulator as an entity bears the name IDE i.e. Integrated Development Environment. One such environment is a Microchip's software package MPLAB.
The oscillator of the microcontroller can be a 4MHz crystal and either two 22pF capacitors or the ceramic resonator of the same frequency (ceramic resonator already contains the mentioned capacitors, but contrary to the oscillator has three termination instead of only two). The speed at which the microcontroller operates i.e. the speed at which the program runs depends heavily on this frequency of an oscillator. In the course of an application development the easiest to do is to use the internal reset circuit in a manner that MCLR pin is connected to +5V through a 10K resistor. In the sequence of text the scheme of a rectifier with circuit of LM7805 which gives the output of stable +5V, as well as the minimal configuration re levant for the operation of a PIC microcontroller.
Minimal hardware configuration necessary for the operation of PIC microcontroller After the supply is brought to the circuit structured according to the previous pictures, PIC microcontroller should look animated, and its LED diode should be twinkling once each second. If the signal is completely missing (LED diode doesn't twinkle), the check is to be done to ascertain if the +5V is present at all the corresponding tentacles on PIC microcontroller.
disconnected, it's level will be "floating" and it may work sometimes, but usually it won't. Chip has power-on-reset circuit, so that appropriate external "pull-up" resistor on MCLR pin should be sufficient. Step 2. Check whether the connection with the resonator is stable. For most PIC microcontrollers to begin with 4MHz resonator is well enough. Step 3. Check the supply. PIC microcontroller spends very little energy but the supply must be pretty well filtrated. At the rectifier exit, the current is direct but pulsing and as such is by no means suitable for the supply of microcontroller. To avoid this pulsing, the electrolytic capacitor of high order of capacitance (say 470 F) is placed at the exit of a rectifier. If PIC microcontroller supervises the devices that pull lot of energy from the energy source they can in their own rights provoke enough malfunctioning on the supply lines so that the microcontroller can stop working normally and start revealing somewhat strange behavior. Even seven-segmented LED display may well induce tension drops (the worst scenario is when all the digits are 8, for then LED display needs most power), if the source itself is not capable to procure enough current (for the case of 9V battery just for an example). Some PIC microcontrollers have multi-functional entrance\exit pins, as it is the case with PIC16C62x family (PIC16C620, 621 and 622). The microcontrollers belonging to this family are provided with analogue comparators at port A. After putting those chips to work, port A is set onto an analogue mode, which brings about the unexpected behavior of the pin functions on this port. Any PIC microcontroller with analogue entrances will after reset show itself in an analogue mode (if the same pins are used as digital lines they must then be set into a digital mode). One of the possible sources of troubles is that the fourth pin of the port A shows singular behavior when it is used as exit (because this pin has open collectors exit instead of usual bipolar state). That implies that the inscription of the logical zero on this pin will nevertheless set it on the low level, but the inscription of logical unit will let it float somewhere in between instead of setting it at high level. To coerce this pin react in a proper way the pull-up resistor is placed between RA4 and 5V. The magnitude of this resistor may be between 4.7K and 10K, depending on the intensity of the current necessary for the convected ent rance. This pin functions as any other pin used as an entrance (all the pins are after reset procedure set as exits). During the work with PIC microcontrollers more problems are to be expected. Sometimes what is being tried seems like going to work, but it doesn't happen to be the case regardless of how hard had we put an effort. Normally there is more than one way to solve something. A different angle approach may bring a solution with the same effort.
10
Chapter 2
BASIC ELEMENTS OF PIC BASIC LANGUAGE
Introduction 2.1 Identifiers 2.2 Labels 2.3 Constants 2.4 Variables 2.5 Sequences 2.6 Modifiers 2.7 Symbols 2.8 Direction INCLUDE 2.9 Comments 2.10 Programming line with more instructions 2.11 Transfer of a instruction into another line 2.12 Define 2.13 DISABLE 2.14 ENABLE 2.15 ON INTERRUPT 2.16 RESUME
Introduction
Next chapter describes the basic elements of a PIC BASIC language and the mode to use them in the efficient program writing. It is somewhat of an artistry to write a code that is both readable and easy to handle. Program is supposed to be understandable, before all, to the programmer himself and then later to his colleagues in charge of doing some corrections and adding as well. In the further text is given one example of the program written in a clear and manifest way. Donja slika nema prevod
11
Extensive use of comments, symbols, labels and other elements supported by PIC BASIC, program can be rendered considerably clearer and more understandable what is in later corrections and enlargement of the program offering programmer a great deal of help. In order to make it even more understandable it is advisable to separate the program into logical entities as those parts to which a jump with the goto instruction can be performed or subprograms to be called with the gosub instruction. Labels indicating the beginning of the segments of programs should have meaning making some obvious sense. If it, say, exists such segment of a program that switches on and off LED diodes on some of the ports, the label indicating the beginning of that part of the program could well be for example "Blink" (LED diodes shine or go dark - therefore they blink) or the like. Elements determining one BASIC program are the following: - Identifiers - Labels - Constants - Variables - Sequences - Modifiers - Symbols - Comments
12
Although they are many at first glance only but a few of them is fair enough for writing approximately 90% of all programs. Nevertheless for the sake of completeness on all the elements will be treated on the following pages.
2.1 Identifiers
Identifier represents the name of some PIC BASIC element. Identifiers are used in PIC BASIC in order to sign program lines and the names of various symbols. Identifier itself could be any string of letters, numbers or even dashes with the limit that it is not allowed to begin with a number. Identifiers don't distinguish small and capital letters, so that the strings TASTER and Taster are treated the same way. The maximum length for such strings is 32 characters.
2.2 Labels
Label represents textual sign for some programming line or respectively some of its fragments on which the program can jump through some of the instructions used to change the program flow. It is obligatory to end the label with. Contrary to many old BASIC versions, PIC BASIC doesn't allow numerical values as labels.
13
2.3 Constants
Name_constants con value_constants With this declaration is to some chosen name assigned the value that is constant. For example the constant minute has the value of 60 seconds, bearing the recollection to the number of seconds in a minute. Written at whatever program position, minute will be interpreted by complier as if it had been written 60. There are two very important reasons for such habit in program writing. The first one is the programmers wish to be more manifest. Good visibility is achieved by giving to the variables and constants those names that could be associated with the very function they assume within the program. On the other hand, the big ger flexibility of the program is obtained as well. It is for an example so that if it becomes necessary in some future work to use the same code but with a change value of the constant, it is enough make a change in the part for declaration instead performing search and replace throughout the program.
Constants can be equally written in decimal, hexadecimal and binary form. Decimal constants are written without any prefix. Hexadecimal constants start all with a sign $ and binary with %. To make the programming easier, single letters are converted into their ASCII counterparts. The sign constants must be placed into the inverted comas and they contain only one letter as a rule (in adverse case they are string constants).
2.4 Variables
Name_variable var Type_variable Variables serve for temporary storing of data and results of various arithmetic and logical operations. Variables are stored on the microcontrollers RAM locations, which means that the total number of the variables that can be used depend on the size of RAM. Accordingly for the 36-byte microcontroller, 22 bytes are reserved for variables. Variable defining is achieved with the formal word var at the beginning of the program. PIC BASIC supports variables like bit, byte and word . Variable type is selected with reference to the expected value that this same variable can assume in the course of the program run. Therefore the variable of the bit type can take value of 0 or 1, the variable of the byte values from 0 to 256 and finally, word from 0 to 65535.
14
2.5 Sequences
Name_sequence var type_element [number of the elements] Sequences of the variables are defined in a similar way as we have done with the variables. "Type_element" represents the value of every element of the sequence, and can be bit, byte or word . The number of the elements of the sequence is given through value between "[]".Each element of the sequence is accessible by an index. Index starts with zero. When we come to define the number of the elements of the sequence one must always have in mind that the number of locations in RAM memory on which we intend to store variables finite. The next table shows the maximal number of the elements of various types. The size of the sequence Element of the sequence BIT BYTE WORD * Depends on microcontroller Sequence1 var byte[10] ' the sequence of 10 elements of the type byte Sequence1 [0] represents the first element of the sequence and sequence1 [9] the last element of the sequence "sequence1". Sequence2 var byte[8] ' the sequence of 8 elements of the type byte Sequence2 [0] represents the first element of the sequence and sequence2 [7] the last element of the sequence "sequence2". Maximal number of elements 256 96* 48*
2.6 Modifiers
new_name var old_name By means of modifier it is possible to introduce a new name for the variable already defined. This direction is used relatively rarely but it ought to be mentioned for the sake of completeness. It is used in an identical way as a direction for the definition of the variables. Introduction of a new name is effectuated through the official word var.
15
2.7 Symbols
symbol old_name = new_name Symbols are granted the function exactly the same as direction for modifying variables, i.e. they serve for assigning the new names to the variables and constants. Symbols are introduced for the compatibility of the programs written for Basic Stamp and cannot be used for introducing variables.
2.9 Comments
' .... Comment.... ' In the course of program writing there's a space for lot of comments even if it may be self-evident what is the main purpose of the program. Although it may well seem as a shear waste of time, it may play later a crucial role (comments don't occupy an additional memory space in the memory of a microcontroller). Comments should give useful instructions about all that the program is doing. Comment as Set Pin0 to 1 simply explains the syntax of the language but fails to pinpoint the purpose of the act. Something of a sort Turn the Relay on may prove itself to be much more useful. At the beginning of the program it should be described what is the program used for, who were the authors and when was it written. Stipulating the information concerning revision and the exact date may be useful too. Even every concrete statement about connection to each pin can be crucial in an effort to memorize the very hardware for which this program was designed to operate.
16
2.12 Define
DEFINE the value parameter Instructions of the PIC BASIC language can have some parameters from which depends the exact way the instructions are executed. Those parameters assume some predefined values that appear in the most of the cases. A frequency of an oscillator is a good example for that. If not otherwise stated the tact of the oscillator is taken by default as 4MHz. In case that the used oscillator is of a different frequency from 4MHz it is necessary using the DEFINE direction to specify that frequency and communicate it to all the programs that contain within instructions depending on the tact of the microcontroller. One such instruction is for the serial transfer. In case that the instruction DEFINE is omitted and in gear is 8Mhz instead of 4Mhz oscillator, all the instructions that depend on the tact of microcontroller will be executed 2 times quicker. For instance, if the parameter of the speed of transfer amounts to 9600 bauds by using SERIN instruction, the data transfer would be effectuated at the speed 19200. In the same way the instruction pause 1000 the
17
delay realized would be 0.5s instead 1.0s. It is also possible similarly to upgrade the resolution of the instructions. What is next is the review of the usage for DEFINE direction in case of adjusting of parameters explained within each particular instruction. The use of a direction DEFINE parameter I2C_HOLD 1 1 description pause 12C transfer while the tact is on a low level instruction on which it acts I2COUT, I2COUT
I2C_INTERNAL
internal EEPROM in series 16Cexxx and 12Cxxx of the I2COUT, I2COUT PIC microcontroller serial tact is a bipolar at the place of an open collector for the tact > BMHz OSC with the devices of a standard velocity LCD data port Initial bit of a data 0 or 4 RS (Register select) port RS (Register select) pin enable port enable bit read/write port read/write bit No of LCD lines the time of delay of instruction in microseconds (us) the time of delay of data in microseconds tact of the oscillator in MHz: 3(3.58) 4 8 10 12 16 20 25 32 33 40 setting of OSCCAL for PIC12C671/CE673 microcontrollers the number of data bits the slowing of the tact of transfer SHIFTOUT, SHIFTIN I2CWRITE, I2CREAD
I2C_SCLOUT
1 PORTD 0
I2CWRITE, I2CREAD LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN LCDOUT, LCDIN
LCDOUT, LCDIN all instructions of the serial transfer and next pause
18
50 10 1000
LFSR BUTTON SEROUT, SERIN HSEROUT, HSERIN HSEROUT, HSERIN HSEROUT, HSERIN HSEROUT, HSERIN HSEROUT, HSERIN HSEROUT, HSERIN
HSER_BAUD 2400 HSER_SPBRG HSER_RCSTA HSRE_TXSTA HSER_EVEN 1 HSER_ODD Example: 1 25 90h 20h
Slike i primeri
2.13 DISABLE
DISABLE Before ent ering the interrupt routine, it is necessary to switch off the interrupts in order to avoid any new interruption in the course of data processing. The interruptions are forbidden in a manner that the instruction "DISABLE" reset the bit GIE in the register INTCON.
2.14 ENABLE
ENABLE In the course of execution of the interruption routine, the interrupts must be forbidden by resetting the bit GIE in the INTCON register. When the interruption processing is finished, the interruptions must be allowed once again with the instruction "ENABLE".
19
2.15 ON INTERRUPT
On interrupt LABEL With instruction "On interrupt" is indicated the label on which the program will "jump" when the interruption happened, i.e. from which label the interruption routine starts.
20
Chapter 3
OPERATORS
Introduction 3.1 Expressions 3.2 Instructions 3.3 Arithmetical operators 3.3.1 Multiplication 3.3.2 Division 3.3.3 Shift 3.3.4 ABS 3.3.5 COS 3.3.7 DIG 3.3.8 MAX and MIN 3.3.9 NCD 3.3.10 REV 3.3.11 SIN 3.3.12 SQR 3.4 Bit operators 3.5 The operators of comparison 3.6 Logical operators
Introduction
The PIC BASIC language possesses the operator set used to assign the values, compare objects and perform multitude of other operations. The objects manipulated for that purposes are called operands (which themselves can be variables or constants). The operators of PIC BASIC language must have at least two operands. They serve to create instructions and expressions that together with variables, constants and comments in effect compose the program.
3.1 Expressions
Combinations of operators and operands are called expressions. The expression does the computation and furnishes the result or starts some other activity. A=B+C ' The expression that sums up the values of the variables B and C and ' stores the result into the variable A
In application of any expression the attention must be paid that the result of the computation must be within the range of variable A in order to avoid the overflow and therefore the evident computational error. If the result of expression amounts to 428, and the variable A is of BYTE type having range between 0 and 255, the result accordingly obtained will be 172 - obviously the wrong one.
21
3.2 Instructions
Each instruction determines an action to be performed. As a rule, the instructions are being executed in an exact order in which they are written in the program. However, the order of their execution can be changed as well emp loying the instructions for the change of the flow of a program to another segment of the program such as the instructions of the ramification, jump or interrupt. IF Time = 60 THEN GOTO Minute ' if A = 23 jump to label Minute
Instruction IF...THEN contains the conducting expression Time=60 composed in its own rights of two operands, the variable Time, constant 60 and the operator of comparison (=). The instructions of PIC BASIC language can be distinguished as the instructions of choice (decision making) repeating (loops), jump and specific instruction for an access to the peripheries of the microcontrollers. Each of these instructions is explained in detail in Chapter 4.
Operators are numerous, but for almost 90% of all the programs it is necessary to know only few of them. It suffices to look how many operators are used in the examples in Chapter 5, 6 and 7.
After the activities they perform, the operators can be classified into the following categories: - Arithmetic operators - Bit operators? - The operators of comparison - Logical operators
22
3.3.1 Multiplication
Syntax: L0 = W1 * 100 L1 = W1 ** W2 L2 = W1 */ W2
Description: PIC BASIC pro does not support directly the work with the 32-bit numbers. It is usual to present a 32-bit variable as a two 16-bit variables. Operator '*' reverts lower 16 bits of a 32-bit result. Operator '**' reverts higher 16 bits of a 32-bit result. These two operators can be used in a combined way for computing 16x16 multiplications in order to produce 32-bit results. Example:
3.3.2 Division
Syntax: W0 = W1 / 100 W2 = W1 // 100
Description: As it is the case with multiplication, the operation of division is done over the 16 bit operands. Operator '/' reverts 16-bit integer result while the operator '//' reverts the remainder.
23
3.3.3 Shift
Syntax: W0 = W0 << 3 W0 = W0 >> 1
Description: Operators of the shift perform the shift towards left or right from 0 to 15 times. All the new bits that enter from the side have value 0. These two operators belong to the operators over the bits. Example:
Description: ABS gives the absolute value of a number. If ABS gets applied to the variable of the BYTE type greater then 127 (set MSB) the result is 256. If the ABS gets applied to the variable of WORD type greater then 32767 (the bit set is of the biggest weight - MSB) result is 65536.
24
Description: COS reverts the 8-bit value of the cosine. The result is in the second complement (i.e. within the range -127 to 127). For that reason it is necessary to use the lookup table in order to determine the result (cosine of an angle goes in the binary range between 0 and 255 in contrast with usual 0 to 359 degrees). Example:
Description: DCD gives the decoded bit value of the operand whose value is in the range within 0-15. If the operand is 0 then the zeroth bit of the result 1, and if the operand reads as 7, the seventh bit of the result is 1.
25
Descript ion: DIG furnishes the value of the digit of a decimal number. The number whose digits are looked for is 0-3 where 0 is a last right digit i.e. digit of the smallest weight (it is most often used for the work with seven-segment digits for extraction of the digits to be displayed). Example:
Description: The operator's maximum and m inimum are used whenever it is necessary to revert one out of two values that are being compared. If those numbers are for example 100 and 200 operator Max will revert the value 200 and operator Min, value 100. To the difference from the operators "bigger then" and "less then" they revert the entire value and not only the quantification whether some value is smaller or bigger then the other.
26
Description: NCD furnishes the value that is coded with the priority code. That gives the position of the first unit, which it encounters from the left side. If the operand is 0 the result is 0 as well. Example:
Description: REV reverts the order of the lowest bits of the operand. The number of the bits that can be reverted goes from 1 to 16. Example:
27
Description: SIN reverts the 8 -bit value of the sine. The result is in the second Complement (i.e. within the range -127 to 127). For that reason it is necessary to use the lookup table in order to determine the result (sine of an angle goes in the binary range between 0 and 255 in contrast with usual 0 to 359 degrees). Example:
Description: SQR reverts a value of a square root. Result is stored into the variable of BYTE type. Example:
28
One of the more important properties of higher programming languages is their capacity to go down to the lower level i.e. the level of the assembler. Bit operators furnish the access to the registers and memory of a microcontrollers at the level of a single bit. Operators supported by the language PIC BASIC are given in the table below: Bit operators Operator & | ^ ~ &/ |/ ^/ Description Logical AND over the bits Logical OR over the bits Logical XOR over the bits Logical NOT over the bits Logical NAND over the bits Logical NOR over the bits Logical NXOR over the bits
The value result of the expression depends on the fact which of the listed logical operations is executed over the bits of the operand. In that way, it is possible to extract, delete, set or invert the certain bit of the operand. Example1: B0 = B0 & %00000001 The upper instruction extracts the value of the lowest bit of the variable B0. When the logical "AND" is performed with the zero, there will be 0 at the position of a corresponding bit (so that all the bits 1-7 will be zeroes). The value will depend on bit 0 in the variable B0 and if it is "0", the value of variable B0 will be "0" and if it is "1" the value of B0 will accordingly be "1". Example2: B0 = B0 & %00000100 The upper instruction sets bit2 in the variable B0. When the logical "or" is performed with the unity the result is always equal to "1" regardless of the state of the corresponding bit from B0. Example 3: B0 = B0 & %00000010 The upper instruction inverts the bit 1 in variable B0. If the bit was "1" then it turns into "0" and vice versa. The other logical operators are used only rarely so there's no need for their detailed explanation.
29
These operators are most often used in examination of the conditions by the instructions such as IF...THEN. Example: If Seconds = 60 then minutes = minutes + 1 Seconds = Seconds + 1 If the variable " Seconds" equals 60 the condition of the comparison is true and the instruction "Minutes=Minutes+1" will be executed then. Unless the expression is not true the instruction "Seconds=Seconds+1" will be executed instead.
30
If the condition is fulfilled, i.e. if at least one of the operands A or B equal to one, then the program jumps to the label Lab. Example2: IF (Seconds>59) And (Minutes>59) THEN Hours=Hours+1 The conditions may be complex as well. Separating into the brackets is obligatory otherwise the result can be very unpredictable.
31
Chapter 4
INSTRUCTIONS (1/4)
Introduction 4.1 @ 4.2 ASM..ENDASM 4.3 ADCIN 4.4 BRANCH 4.5 BRANCHL 4.6 BUTTON 4.7 CALL 4.8 CLEAR 4.9 CLEARWDT 4.10 COUNT 4.11 DATA 4.12 DTMFOUT 4.13 EEPROM 4.14 END 4.15 FREQOUT 4.16 FOR-NEXT 4.17 GOSUB 4.18 GOTO 4.19 HIGH 4.20 HSERIN 4.21 HPWM 4.22 HSEROUT 4.23 I2CREAD 4.24 I2CWRITE 4.25 INPUT 4.26 IF-THEN-ELSE 4.27 LCDOUT 4.28 LCDIN 4.29 {LET} 4.30 LOOKDOWN 4.31 LOOKDOWN2 4.32 LOOKUP 4.33 LOOKUP2 4.34 LOW 4.35 NAP 4.36 OUTPUT 4.37 OWIN 4.38 OWOUT 4.39 PAUSE 4.40 PAUSEUS 4.41 POT 4.42 PULSIN 4.43 PULSOUT 4.44 PWM 4.45 RANDOM 4.46 RCTIME 4.47 READ 4.48 READCODE 4.49 RETURN 4.50 REVERSE 4.51 SELECT-CASE 4.52 SERIN 4.53 SERIN2 4.54 SEROUT 4.55 SEROUT2 4.56 SHIFTIN 4.57 SHIFTOUT 4.58 SLEEP 4.59 SOUND 4.60 STOP 4.61 SWAP 4.62 TOGGLE 4.63 WRITE 4.64 WRITECODE 4.65 WHILE-WEND
Introduction
All the programs regardless of the fact how complicated or simple they may be are nothing else but a strict flow of the executions of instructions. Instructions of branching are used in program for the decision-making (in which one of two or more program paths is being chosen). The basic instruction of branching in PIC BASIC language is instruction if. This instruction has several variations that furnish necessary flexibility required for the realization of the logic of the decision-making (these variations comprise the use of term else and insertion of the instructions). Instructions of repeating give the possibility of repeating one or more single instructions. The conducting expression determines how many times the repetition will be performed. The set of those instructions is composed of WHILE ... WEND and FOR ... NEXT. Instructions of jump serve to change the flow of the program execution. The basic instruction of jump, GOTO, transfers the execution of the program to a signed instruction in a main program or inside subroutines. Other instructions of jump are BRANCH, BRANCHL, CALL, GOSUB, RETURN (these instructions are unavoidable in programs but their use is subject to certain restrictions). Instructions of access to the peripheral devices facilitate the programmer's job. Now programmer can concentrate on the essence of the program he set out to solve, avoiding unnecessary waste of time in writing routine for LCD display or some other peripheral device he uses in his set. The set of instructions is such to satisfy the large part of needs in the design of even the most complicated microcontrollers systems.
32
Description :
Example:
33
Main : asm bsf PORTA, 0 bcf PORTB, 3 endasm Loop : goto Loop end ' Beginning of asm part of the program ' set RA0 to "1" ' set RB3 to "0" ' End of asm part of the program
4.3 ADCIN Write the values from the input of the internal AD converter
Syntax: Description : ADCIN channel, variable ADCIN performs A/D conversion of an input analogue signal in microcontrollers that have A/D converter built in chip (i.e. PIC16F877). The value read in is stored into a designated variable. Before use of ADCIN instruction the appropriate TRIS register must be initiated so that the given is designated input one. Beside that in ADCON1 register one has to set the input pins for analogue working regime, format of the results and tact of A/D converter.
Example: DEFINE ADC_BITS 8 DEFINE ADC_CLOCK 3 DEFINE ADC_SAMPLEUS 10 ' Converted result will have 8, 10 or 12 bits ' Clock for A/D converter ' Sampling time expressed in us
B0 var byte Main : TRISA = $FF ADCON1 = 0 ' All pins of port A are input ' PORTA is analog
34
' Read the channel 0 and store the result into variable B0
35
BRANCHL (BRANCH long) is a instruction quite similar to BRANCH. The only difference is that BRANCHL can realize jump onto the location situated on the second code segment. BRANCHL instruction creates the code approximately two times greater than one created by BRANCH, so that in case that the whole code of a program is in one single code segment or occupies less then 2K of memory - use of BRANCH is recommended.
Example: W0 var word Main : branchl W0, [lab1, lab2, lab3] Loop : goto Loop lab1 : lab2 : lab3 : end ' Labels where the program execution resumes after ' the jump initiated by instruction BRANCHL
36
Variable - Auxiliary variable of byte type (which must be defined at the very beginning of program is used for delay and to repeat the countdown. Before any start of the button instruction it should be initiated on 0. Action - State at which the jump onto the indicated label is to be effectuated (0 if the button is not pressed, 1 if it is). Simply put, if it is "0" it will jump if the button is not pressed, and if it is 1 it will jump if it is not pressed. Label - The execution goes on from this label if the Action is correct. button PORTB.1,0,100,10,B0,1,lab If the button on pin is pressed, RB1 jumps on the label lab. Button is considered as a pressed on if there is a logical "0" on the RB1 pin. button PORTB.1,0,100,10,B0,0,lab1 If the button on pin is not pressed, RB1 jumps on label lab1. Button is considered as a pressed on if there is a logical "0" on the RB1 pin. button PORTB.1,1,100,10,B0,1,lab1 If the button on pin is pressed, RB1 jumps on label lab1. Button is pressed if there is a logical "1" on pin RB1. Example: The example below will at each pressing of the button, which is connected to RA0, change the state of pin. If the diode is tied to the same pin the effect of the twinkling of the diode will be manifested.
37
It executes the subprogram under the name Label in the language of assembler.
38
Counts the impulses that appear on a specified pin during the time interval defined with the Period variable. The number of the impulses is stored into the No_Inpulse variable. Pin is automatically designated as input. Period is specified in milliseconds. If the oscillator is a 4Mhz one, check of a pin state (status) is effectuated every 20 microseconds. In this way, we can easily measure the frequency of a signal simply by determining number of it's impulses in one second (1000ms). Highest frequency measurable with 4MHz oscillator is 25kHz, while 20MHz oscillator measures up to 125kHz.
Example:
4.11 DATA Effectuates writing into the EEPROM at the first programming
Syntax: Description : {label} DATA {@pocadr}, constant, constant.. DATA stores constants into the internal EEPROM at the first writing of any microcontroller code. If the initial address from which the storing begins, constants will be stored from the EEPROM'S zeroth one. Constant may be numerical or character. If it is necessary to save the constant occupying two bytes an official word "word" must be put before that constant (in the adverse case, only the lower byte would be saved.) Instruction DATA is applicable only in those PIC microcontrollers such as PIC16F84 or 16F87X series, which possess the built-in EEPROM memory inside the chip. Apart from the internal EEPROM in PIC microcontrollers exists the option of connecting an additional external EEPROM through the 12C highway. Such mode of connecting in practice in the PIC microcontrollers that don't possess internal EEPROM memory of their own or when its size is inadequate. EEPROM memory has that good property that it doesn't change its value in case of a power shortage. Besides, the possibility of unwanted storing is reduced so that the EEPROM memory is often used to conserve some values of prime importance. For inwriting and reading of EEPROM memories during the operations of microcontroller, instructions WRITE and READ are used.
39
In order to obtain the desired sinusoidal signal at the output, the installation of a sort of filter is required. Example:
40
of the location is omitted, the first EEPROM instruction starts to store the constants beginning with an address 0, and the next instructions place the values on the following locations. If the value of location is stipulated, the values are written starting from that very location. Parameter "Constant" may be number or the sequence of constants. If "word" is not quoted before constant that is being written in, only the bytes of lowest weights are saved. The sequences of are stored as consecutive bytes of ASCII values. The instruction "EEPROM" is operative on only those PIC Microcontrollers, which possess EEPROM or FLASH programming memory built in the chip. The date are saved in the EEPROM space when the programming of microcontroller is definitely finished. For inwriting and reading of EEPROM memory in the course of the operation of the microcontroller, the instructions WRITE and READ are being used.
Example:
41
FREQOUT works best with a 20 MHz oscillator (while it is more difficult to filter the signal for the lower frequencies). "Onms" represents the duration of the signal in milliseconds.
In order to obtain the desired sinusoidal signal at output, the installation of a sort of filter is required. Example:
Description :
Example:
auxiliary variable
42
auxiliary variable the program turns on and off the diodes at port B with 1s pause 900 times
43
INSTRUCTIONS (2/4)
Introduction 4.1 @ 4.2 ASM..ENDASM 4.3 ADCIN 4.4 BRANCH 4.5 BRANCHL 4.6 BUTTON 4.7 CALL 4.8 CLEAR 4.9 CLEARWDT 4.10 COUNT 4.11 DATA 4.12 DTMFOUT 4.13 EEPROM 4.14 END 4.15 FREQOUT 4.16 FOR-NEXT 4.17 GOSUB 4.18 GOTO 4.19 HIGH 4.20 HSERIN 4.21 HPWM 4.22 HSEROUT 4.23 I2CREAD 4.24 I2CWRITE 4.25 INPUT 4.26 IF-THEN-ELSE 4.27 LCDOUT 4.28 LCDIN 4.29 {LET} 4.30 LOOKDOWN 4.31 LOOKDOWN2 4.32 LOOKUP 4.33 LOO KUP2 4.34 LOW 4.35 NAP 4.36 OUTPUT 4.37 OWIN 4.38 OWOUT 4.39 PAUSE 4.40 PAUSEUS 4.41 POT 4.42 PULSIN 4.43 PULSOUT 4.44 PWM 4.45 RANDOM 4.46 RCTIME 4.47 READ 4.48 READCODE 4.49 RETURN 4.50 REVERSE 4.51 SELECT-CASE 4.52 SERIN 4.53 SERIN2 4.54 SEROUT 4.55 SEROUT2 4.56 SHIFTIN 4.57 SHIFTOUT 4.58 SLEEP 4.59 SOUND 4.60 STOP 4.61 SWAP 4.62 TOGGLE 4.63 WRITE 4.64 WRITECODE 4.65 WHILE-WEND
Description: Executes the PBP instructions of the program which are situated between label "label" and instruction RETURN. When program encounters the RETURN, the execution of the program goes on with the instruction line that follows GOSUB instruction. Part of the program code between the label and the RETURN instruction is commonly called subroutine. Subroutine can be "nested". In other words, it is possible that the subroutine calls some other program. Such programming should nt go beyond four levels depth because of the finite size of the PIC microcontroller stack.
44
Description: The execution of the program continues with the instruction line following the label "label". It is not recommended to use this command too often, because over-labeled programs are generally less intelligible. Example:
The program above does exactly the same thing as the previous one, but without GOSUB instruction.
45
Description: Sets the appropriate pin on the high level. Pin is thereby automatically designated output. Example:
Description: HSERIN receives one or more serial data. It can be used with PIC microcontrollers which have hardware supported serial communication, i.e. in those which have hardware USART (e.g. m icrocontroller 16F877). The parameters of serial transfer are determined at the beginning of the program with the following DEFINE directives :
HSERIN operates with 4 MHz oscillators by default. If the microcontroller is connected with an oscillator of a different frequency it has to be specified : DEFINE OSC tact Specific oscillator frequency
Putting the parameters "Timeout" and "Label" enables the continuation of the program even with receiving no character in the course of a "Timeout" interval (specified in milliseconds). Format of the serial data 8N1 (8 bits of the data, without a parity bit and with only one stop bit). Some other formats, such as 7E1 (7 bits of data, parity bit and 1 stop bit) can be used with the previous changes through DEFINE at the beginning of program. DEFINE HSER_EVEN 1 DEFINE HSER_ODD 1 Only when we want to check the parity. Only when we want to check the non-parity.
The program may also contain the optional label "Error" at which the program jumps in case of error in transfer or the violation of parity. Label "Error" is used only if the check of parity/non-parity is in advance enabled with the corresponding DEFINE directions. The serial transfer is done by hardware so that for an adapting on RS-232 an additional inverting driver is necessary. Modifiers in HSERIN are the same as by the command SERIN2. Modifier BIN{1..16} DEC{1..5} How it works Takes binary digits Takes decimal digits
46
Takes hexadecimal digits Doesnt take next n characters Takes the sequence of n characters that ends with the character c (optional) waits for character sequence waits for a string
Example:
Description: Command uses the hardware PWM on the microcontrollers who possess it for the generation of the PWM signal. The parameter "channel" defines the exact PWM channel that is to be used. In the two channel microcontrollers, the parameter "frequency" must be identical on both of them. The parameter "Relation_on_off" defines the relation between on and off signals on the pin. Value 0 sets the pin to always off, while 255 sets it to always on. All other values in the interval 0~255 define the appropriate ODNOS of on and off signals on the pin (for example, value 127 sets 50% on and 50% off signal). Parameter "Frequency" defines the frequency of the PWM signal (highest possible frequency for any oscillator is 32767 Hz) which depends on oscillator used. Lowest frequency depends on oscillator used. If not specified otherwise, PWM generates 0 timer by default.
Example:
47
Description: HSEROUT sends one or more serial data and is used in the PIC microcontrollers that have hardware supported serial communication (hardware USART). Parameters of serial transfer are determined by with the following DEFINE directives: DEFINE HSER_RCSTA 90h DEFINE HSER_TXSTA 20h DEFINE HSER_BAUD 2400 DEFINE HSER_SPBRG 25 Setting the receiving register Setting the emitting register Baud rate Direct setting of SPBRG
When calculating transfer rate, HSERIN assumes that microcontroller works with the 4MHz oscillator. If different oscillator is used, new frequency must be specified with the following directive: DEFINE OSC Specific oscillator frequency
Format of serial data is 8N1 - 8 data bits, with no parity bit and with 1 stop bit. Some other formats, such as 7E1 (7 data bits, parity bit, 1 stop bit) or 7O1 (7 data bits, nonparity bit, 1 stop bit) may be used with the following DEFINE directives at the beginning of the program: DEFINE HSER_EVEN 1 DEFINE HSER_ODD 1 Only when we want to verify the parity Only when we want to verify the non -parity
Serial transfer is hardware based, so you might need an additional driver for adjusting to RS-232 (MAX232). Modifier {I}{S} BIN{1..16} {I}{S} DEC{1..5} {I}{S} HEX{1..4} REP c/n STR ArrayVar {\n} Sends binary number decimal number hexadecimal number character c repeated n times n character string
Example:
B0 var byte B0 = 4 Main : hserout [dec B0, 10] send decimal number from variable B0 and constant
48
Description: Sends control and address data via I2C lines and receieved bytes are stored into "Variable". I2CREAD and I2CWRITE can be used for reading and writing data to peripheral units. These instructions work with I2C master byte in read and write modes and can be also used for communication with other devices with I2C interface, such as temperature sensors, A/D converters, etc. Higher 7 bits of control byte contain control code for chip selection or extra information on addresses, depending on device. The lowest bit is flag indicating the current mode read or write. For example, for communicating with 24LC01B, requested address is 8-bit, control code is %1010 and chip select is unused, so that control byte would be %10100000 or $A0. Formats of control bytes for several other serial EEPROMs are given in the table below: EEPROM 24LC01B 24LC02B 24LC04B 24LC08B 24LC16B 24LC32B 24LC65 bbb = block selection ddd = device selection bits xxx = has no effect If 2-byte data (WORD) is received, higher byte is received first, and lower thereafter. For Capacity 128 bytes 256 bytes 512 bytes 1K bytes 2K bytes 4K bytes 8K bytes Control word %1010xxx0 %1010xxx0 %1010xxb0 %1010xbb0 %1010bbb0 %1010ddd0 %1010ddd0 Address size 1 byte 1 byte 1 byte 1 byte 1 byte 2 bytes 2 bytes
49
string transfer, STR goes before the name of the string, and number of clocks after \ . a var byte[8] I2CREAD PORTC.4, PORTC.3, $a0, 0, [STR a\8] If optional label is used, program will jump to the label if there is no response signal over the I2C interface. Standard transfer rate (100kHz) is achieved with 8MHz oscillator. For higher transfer rate (400kHz) 20MHz oscillator is used. If slower oscillator is used for the transfer, following directive should be used : DEFINE I2C_SLOW 1 In order to have bipolar I2C clock interface and not an open collector, following DEFINE directive should be used: DEFINE I2C_SCLOUT Operating any peripheral units with I2C communication demands that you read supplier manuals and specifications.
Example:
cont con %10100000 Control address of EEPROM addr = 17 Main: I2CREAD PORTA.0, PORTA.1, cont, addr, [B0] Get data to variable B0 Loop: goto Loop end Data address is 17
Description: I2WRITE sends control and address data via I2C interface. We define 8-bit or 16-bit address while defining variable put to address parameter (in order to correctly define address size, we must have accurate information on device we are communicating with).
50
If peripheral device is serial EEPROM, it is necessary to wait for 10ms (depending on device) until writing has ended. New communication with device is possible after 10ms have elapsed. If new data write occurs before the last one has ended, request will be ignored. Address size is either 1 or 2 bytes, depending on device connected. A problem may occur when trying to write multiple bytes in one instruction, depending on specific EEPROM. Such instances can be avoided if, instead of EEPROM, we use devices without the need for pause between writing. If 2-byte data (WORD) is sent, higher byte goes first, then the lower. For string transfer, STR goes before the name of the string, and number of clocks after \ . a var byte[8] I2CWRITE PORTC.4, PORTC.3, $a0, 0, [STR a\8] If optional label is used, program will jump onto the label if there is no response signal over the I2C interface. Standard transfer rate (100kHz) is achieved by 8MHz oscillator. For higher transfer rate (400kHz) 20MHz oscillator is used. If slower oscillator is used for the transfer program should contain the following directive: DEFINE I2C_SLOW 1 In order to have bipolar I2C clock interface and not an open collector, following DEFINE directive should be used: DEFINE I2C_SCLOUT Operating any peripheral units with I2C communication requires that you study the supplier manual and specifications.
Example:
cont con %10100000 Control address of EEPROM Main: addr = 17 EEPROM address where data will be written is 17 Write number 6 to address 17
51
Write value of variable B0 to
Description: INPUT designates the specific pin as input. Example: Main: input PORTA.0 TRISB.0=1 TRISB.0=1 Loop: goto Loop end Pin PORTA.0 is input. Instruction can be substituted with
Description: Instruction selects one of two possible program paths. Instruction IF is the fundamental instruction of program branching in PIC BASIC and it can be used in several ways to allow
52
The simplest form of instruction is shown on the picture above. Sample program below tests the button connected to RB0 - when the button is pressed program jumps onto the label Add where value of variable w is increased. If the button is not pressed, program jumps back onto the label Main.
Example:
w var byte
More complex form of instruction is program branching with the ELSE part of instruction.
53
w var byte Main : IF PORTB.0=0 THEN Add ELSE Subtract ENDIF goto Main Add : W=W+1 Subtract : W=W-1 End
w var byte
Basic for PIC Microcontrollers Main : IF PORTB.0=0 THEN W=W+1 ELSE W=W-1 ENDIF goto Main End
54
Description: LCDOUT sends the data to the LCD (Liquid Crystal Display). PIC BASIC supports various LCD models which have Hitachi 44780 controller or compatible one. LCD usually has either 14 or 16 pins for connection to a microcontroller. If there is character # before data, ASCII value of every data is sent to LCD. LCDOUT has the same modifiers as the instruction SEROUT2.
Modifier {I}{S} BIN{1..16} {I}{S} DEC{1..5} {I}{S} HEX{1..4} REP c/n STR ArrayVar {\n}
Sends binary number decimal number hexadecimal number character c repeated n times n character string
Before the first instruction is sent to LCD, program should wait for at least half a second for LCD to initialize. LCD display can be connected to PIC microcontrollers by either 4-bit or 8-bit bus. If 8-bit bus is used, all of 8 bits mus t be connected to the same port, while in the case of 4-bit bus all 4 bits must be either in the upper or the lower part of byte. R/W line should be connected to ground if LCD is used only for data display. PIC BASIC assumes that LCD is connected to specific pins if DEFINE directives do not say otherwise. Default is 4-bit bus with lines DB4-DB7 connected to RA0-RA3, RS pin connected to RA4 and E pin connected to RB 3. Also, it is assumed that LCD is 2x16. For changing any of the default settings, appropriate DEFINE directives can be used.
55
If LCD is connected to some other microcontroller lines it has to be defined with DEFINE directives, as shown in the following example.
DEFINE LCD_RSREG PORTB DEFINE LCD_RSBIT DEFINE LCD_EREG DEFINE LCD_EBIT DEFINE LCD_BITS DEFINE LCD_LINES 1 PORTB 0 4 2
port Register select Register Select bit Enable port Enable bit bus size 4 or 8 bits number of LCD lines
DEFINE LCD_COMMANDS 2000 command delay in microseconds DEFINE LCD_DATAUS 50 data delay in microseconds
Definitions above define 2-line LCD on 4 -bit bus on the upper 4 bits of microcont roller port D. Register Select (RS pin) is on PORTD.2 and Enable is on PORTD.3. Every LCD controller is in charge of certain commands. Commands are sent by instruction: LCDOUT $FE, $Kod. List of commands is shown in table below.
Command $FE, 1 $FE, 2 $FE, $0C $FE, $0E $FE, $0F $FE, $10 $FE, $14
Operation clear display Return home (beginning of the first line) Turn off cursor Underline cursor on Blinking cursor on Shifting cursor left Shifting cursor right
56
set cursor to the beginning of the second line set cursor to the beginning of the third line set cursor to the beginning of the fourth line
B0 var byte B1 var byte Main: lcdout $FE, 1, Hello lcdout $FE, $C0 lcdout B0 lcdout #B1 Loop: goto Loop end Clear display and print Hello
switch to second line Display the value of B0 Display the value of B1 in ASCII code
Description: LCDIN reads the given address of LCD RAM and stores data into a variable. When using this instruction, LCD Read/Write line must be connected to microcontroller. In case when LCD is used for data printing exclusively, this line can be connected to a logical zero. DEFINE directives inform the program about port and pin which Read/Write line is connected to:
Main: Lcdin $40, B0 Read data from LCD location $40 and store it into B0
57
Description: LET instruction stores value of the expression into a variable. Expression can be a constant, variable or value of some other expression. Commonly, the optional command word LET is excluded. Example:
let B0 = B1 * B2 + B3 B0 = B1 * B2 + B3 The two expressions are identical. The latter expression is missing command word let.
Description: Instruction LOOKDOWN searches the list of constants and determines the presence of given value. If a given value matches some of the constants, index of the appropriate constant is stored into variable. If the first constant matches our given value, variable is set to zero. If the second constant from the list matches our given value, variable is set to one, etc. If our value isnt present in the list, variable remains unchanged. Constants list can consist of both numerical and character (string) values. Each character of a string is treated as a separate ASCII value of a constant. Example: B0 var byte
58
lookdown B0, (01234567890ABCDEF), B1 convert hexadecimal character from B0 to a decimal value and store it into variable B1
PORTB=B1
Description: LOOKDOWN2 searches the list of values and determines the presence of given value. If Search value matches some of the Value values, index of the appropriate constant is stored into Var.
If Search matches the first value of the list, Var set to zero. If it matches the second value of the list, Var is set to one, etc. If Search va lue isnt present in the list, Var remains unchanged. Optional parameter Test is used for testing if Search value is greater or lesser than a certain value. If > is used, index of the first matching constant is stored to Var. List of values can consist of 16-bit numbers, characters or variables. Every character of a string is treated as a separate ASCII value of that character (arrays of variables cannot be used with LOOKDOWN2 instruction). LOOKDOWN2 generates the code about 3 times greater than LOOKDOWN instruction does. Thus, when searching the list consisting of 8-bit constants and strings, use of LOOKDOWN is prefferrable.
Example:
If value of W0 is 512 B0 will have value of 0. If value of W0 is 768 then B0 will have value of 1, etc.
59
If value of W0 is 4 B0 will have value of 0. If value of W0 is 200 then B0 will have value of 2, etc.
Description: LOOKUP is used for reading values from the table of constants, according to the value of variable Index. If Index equals zero, Var is set to the value of the first constant. If Index equals one, Var is set to the value of the second constant, etc. If Index is equal or greater than number of elements in the Look-up table Var remains unchanged. List of constants can consist of numerical and string constants. Each character of a string is treated as a separate ASCII value of a character. Example:
Program below illustrates the use of LOOKUP instruction. for displaying digits on sevensegment displays. Depending on value of parameter Digit, we get mask for appropriate value of parameter mask. Digit var byte value of digit to be displayed
Mask var byte mask of digit to be displayed Main: for i=0 to 9 Digit=i Lookup Digit, [$3F, $06, $5B, $4F, $66, $6D, $7D, $07, $7F, $6F], Mask
Basic for PIC Microcontrollers next i goto Main end Increase i by one Repeat the whole program
60
61
INSTRUCTIONS (3/4)
Introduction 4.1 @ 4.2 ASM..ENDASM 4.3 ADCIN 4.4 BRANCH 4.5 BRANCHL 4.6 BUTTON 4.7 CALL 4.8 CLEAR 4.9 CLEARWDT 4.10 COUNT 4.11 DATA 4.12 DTMFOUT 4.13 EEPROM 4.14 END 4.15 FREQOUT 4.16 FOR-NEXT 4.17 GOSUB 4.18 GOTO 4.19 HIGH 4.20 HSERIN 4.21 HPWM 4.22 HSEROUT 4.23 I2CREAD 4.24 I2CWRITE 4.25 INPUT 4.26 IF-THEN-ELSE 4.27 LCDOUT 4.28 LCDIN 4.29 {LET} 4.30 LOOKDOWN 4.31 LOOKDOWN2 4.32 LOOKUP 4.33 LOOKUP2 4.34 LOW 4.35 NAP 4.36 OUTPUT 4.37 OWIN 4.38 OWOUT 4.39 PAUSE 4.40 PAUSEUS 4.41 POT 4.42 PULSIN 4.43 PULSOUT 4.44 PWM 4.45 RANDOM 4.46 RCTIME 4.47 READ 4.48 READCODE 4.49 RETURN 4.50 REVERSE 4.51 SELECT-CASE 4.52 SERIN 4.53 SERIN2 4.54 SEROUT 4.55 SEROUT2 4.56 SHIFTIN 4.57 SHIFTOUT 4.58 SLEEP 4.59 SOUND 4.60 STOP 4.61 SWAP 4.62 TOGGLE 4.63 WRITE 4.64 WRITECODE 4.65 WHILE-WEND
Instruction LOOKUP2 can be used for reading values from the table of values by index. If Index equals zero, Var attains the value of the first element in the list. If Index equals one, Var attains value of the second element in the list, etc. If Index is equal or greater than number of elements in the Look-up table Var remains unchanged. List of values can consist of 16-bit numbers, characters or variables. Every character of a string is treated as a separate ASCII value of that character. Arrays of variables cannot be used with LOOKUP2 instruction. LOOKUP2 generates the code about 3 times greater than LOOKUP instruction does. Thus, when searching the list consisting of 8-bit constants and strings, use of LOOKUP is prefferrable.
Example:
For B0=0, W0 will have value of 256 For B0=1, W0 will have value of 1024
For B0=2,3,... W0 will remain unchanged
62
Description: Sets specific pin to zero. Pins is automatically designated output. Same effect can be achieved with PORTB=0. Example:
4.35 NAP Turns off the processor for a short period of time
Syntax: NAP period
Description: Instruction sets PIC microcontroller to low power mode (state of low energy consumption) for a short period of time. During this "nap", energy consumption is minimized. Stated periods are just approximations because these values were taken from watch dog timer and depend on chip and temperature: Period Delay [ms] 0 1 2 3 4 5 6 7 Example: 18 36 72 144 288 576 1152 2304
Main:
Basic for PIC Microcontrollers nap 7 take a nap for 2.304 seconds Loop: goto Loop End
63
Main: output PORTB.7 TRISB.0 = 0 Loop : goto Loop End Pin RB7 is output Same effect as above
Parameter Pin is a variable containing the microcontroller pin connected to the element which has one-wire communication.
Parameter Mode is value defined by parameters of communication.
"Mode" bit 0 1 2
How it works 1 = sending the reset signal ahead of data 1 = sending the reset signal after data 0 = 8-bit data 1= 1 -bit data
64
Parameters Var1 and Var2 are variables for containing the read data. Example:
Temperature var byte Main: OWIN PORTC.0, 0, [Temperature] read the temp. PORTB=Temperature display temperature on port B diodes
Parameter Pin is variable containing the microcontroller pin connected to the element which has one-wire communication. Parameter Mode is value defined by parameters of communication.
"Mode" bit 0 1 2 1= 1 -bit data How it works 1 = sending the reset signal ahead of data 1 = sending the reset signal after data 0 = 8-bit data
Parameters Var1 and Var2 are variables for containing the read data. Example: Main :
OWOUT PORTC.0, 1, [$CC, $BE] sends reset signal and 2 values afterwards goto Main End
65
Description: Instruction pauses the program for Period miliseconds. Period is 16-bit, allowing delay to be as long as 65 535ms (a bit over a minute). Unlike other delay instruc tions (NAP and SLEEP), PAUSE does not put the microcontroller to low power mode. Thus, PAUSE consumes more energy, but gets more accurate timing (it has precision of a system clock). Example:
TRISB = 0 Main: PORTB = 255 pause 1000 PORTB = 0 pause 2000 Delay execution of next instruction line for 2 sec. Delay execution of next instruction line for 1 sec.
Description: PAUSEUS stops the program for Period miliseconds. Period is 16-bit (WORD), allowing delay to be as long as 65 535ms (a bit over a minute). Unlike other delay instructions (NAP and SLEEP), PAUSE does not put the microcontroller to low power mode. PAUSEUS consumes more energy than PAUSE, but gets much more accurate timing. Minimal delay of PAUSEUS depends on the crystal frequency.
OSC
Minimal delay
66
3 (3.58) 4 8 10 12 16 20
20 us 24 us 12 us 8 us 7 us 5 us 3 us
PAUSEUS works with default 4MHz crystal frequency. If frequency differs from default it is necessary to modify it with directive: DEFINE Osc. Example: TRISB = 0
Main: PORTB = 255 pauseus 100 Delay execution of next instruction line for 100 microsec PORTB = 0 pauseus 3450 Delay execution of next instruction line for 3.450 ms goto Main End
Description: Instruction POT measures value of potentiometer on a given pin. Resistance can be calculated using the time of condenser discharge through resistor (usually 5K to 50K). Scale is used for setting various RC constants. For higher RC constants, scale should be set to the lowest value (minimally 1). For lower RC constants, scale should be set to the highest value (maximally 255). If the scale is set properly, "Var" should have near zero value, close to the minimum of resistance (unfortunately, scale value has to be determined experimentally). In order to set the "Scale" parameter, potentiometer should be set to maximum resistance and measured with scale set to 127. Next, "Scale" parameter should be adjusted until value of "Var" reaches 255. Program below does it automatically. Example: B0 var byte
67
skala var byte Main : FOR skala=1 TO 255 pot PORTA.0, scale, B0 IF B0>253 Then Over NEXT skala Over : PORTB=scale goto Main End display value of the scale on port B diodes read value of potentiometer on RA0
Description: Instruction measures impulse duration with 10us resolution (when 4MHz oscillator is used) on a given pin. If level is zero it measures duration of low impulse and if level is one it measures duration of high impulse. Measured value of duration is put to variable "Var". Measuring can last from 10 to 65 535 microseconds for 16-bit variables. If impulse doesnt appear at all or its duration is too long to be measured variable is set to zero. In case of 8 -bit variable only lower 8 bits of a 16-bit word are used. Resolution depends on oscillator frequency. 4MHz oscillator has 10us resolution, while 20MHz oscillator has 2us resolution. Example: W0 var word Main : pulsin PORTB.0, 1, W0 Measures high impulse on RB0 pin with 10us resolution and puts it to variable W0 goto Main End
68
Description: Instruction generates impulse of specific duration in tens of microseconds (when 4MHz oscillator is used) on a pin. Impulse is generated by double change of level on a pin, so that former state of pin defines polarity of an impulse. Chosen pin is automatically designated output. Resolution depends on oscillator frequency. 4MHz oscillator has 10us resolution, while 20MHz oscillator has 2us resolution. Example: Main : pulsout PORTB.7, 100 goto Main End Generate 1ms impulse to RB7 pin
Description: Instruction sends PWM (Pulse-Width Modulation) impulses Ratio to pin defined with parameter "Pin" (for each PWM signal, cycle goes from 0 (0%) to 255 (100%)). This PWM cycle repeats itself for number of times defined with "Cycle" parameter. Pin direction is set to output just before generating PWM impulse and is set back to input afterwards. Cycle duration depends on the oscillator used. In case of 4MHz oscillator cycle duration is 5ms, while in case of 8MHz oscillator cycle duration is 1ms. Instruction PWM allows simple R/C circuit to be used for generating DC voltage like a simple D/A converter.
Example:
Main :
69
pwm PORTB.7, 127, 100 Send pwm cycle with 50% of signal (ON) to RB7 goto Main End
Description: Instruction RANDOM stores pseudo-random number to variable. Variable should be 16bit. Example: W0 var word Main : random W0 lcdoout #W0 goto Main End Put random number to variable W0 Display random number on LCD
Description: RCTIME measures time period during which "pin" remains in a certain state. If ihe state remains unchanged variable is set to zero. RCTIME can be used for reading potentiometer or some other resistive element based on the time necessary for filling RC constant. Typical resistance measured is within 5K~50K range. Resolution depends n oscillator frequency. 4MHz oscillator has 10us resolution, while 20MHz oscillator has 2us resolution. Example: W0 var word Main : low PORTA.0 Discharge the condenser
70
Description: Instruction READ reads data from internal EEPROM memory from the specified address and stores the result to "Variable". This instruction can only be used with PIC microcontrollers which have EEPRO M built in the chip. If microcontroller is supplied with external EEPROM, instruction I2CREAD should be used instead. Example: B0 var byte W var word Main : READ 5, B0 READ 6, W.BYTE0 READ 7, W.BYTE1 Loop: goto Loop End read data from EEPROM, address 5 and put it to variable B0 load 16-bit data from addresses 6 and 7 to variable W
4.48 READCODE Reads 2 bytes (word) of program code from the address
Syntax: READCODE Address, Variable
Description: READCODE reads program code from a given address and puts the result to 16-bit variable. PIC16F87X microcontroller family allows reading and writing program code while microcontroller is in operation. Example: Wo var word
71
Main : readcode 100, W0 var. W0 Loop : goto Loop End load data from program FLASH memory, address 100 to
72
INSTRUCTIONS (4/4)
Introduction 4.1 @ 4.2 ASM..ENDASM 4.3 ADCIN 4.4 BRANCH 4.5 BRANCHL 4.6 BUTTON 4.7 CALL 4.8 CLEAR 4.9 CLEARWDT 4.10 COUNT 4.11 DATA 4.12 DTMFOUT 4.13 EEPROM 4.14 END 4.15 FREQOUT 4.16 FOR-NEXT 4.17 GOSUB 4.18 GOTO 4.19 HIGH 4.20 HSERIN 4.21 HPWM 4.22 HSEROUT 4.23 I2CREAD 4.24 I2CWRITE 4.25 INPUT 4.26 IF-THEN-ELSE 4.27 LCDOUT 4.28 LCDIN 4.29 {LET} 4.30 LOOKDOWN 4.31 LOOKDOWN2 4.32 LOOKUP 4.33 LOOKUP2 4.34 LOW 4.35 NAP 4.36 OUTPUT 4.37 OWIN 4.38 OWOUT 4.39 PAUSE 4.40 PAUSEUS 4.41 POT 4.42 PULSIN 4.43 PULSOUT 4.44 PWM 4.45 RANDOM 4.46 RCTIME 4.47 READ 4.48 READCODE 4.49 RETURN 4.50 REVERSE 4.51 SELECT-CASE 4.52 SERIN 4.53 SERIN2 4.54 SEROUT 4.55 SEROUT2 4.56 SHIFTIN 4.57 SHIFTOUT 4.58 SLEEP 4.59 SOUND 4.60 STOP 4.61 SWAP 4.62 TOGGLE 4.63 WRITE 4.64 WRITECODE 4.65 WHILE-WEND
Description: Instruction RETURN executes return from the program routine which program jumped onto via GOSUB instruction. Example: Main : gosub portb_on Loop : goto Loop call a subroutine init_ram
portb_on: PORTB=$FF return End Light all port B diodes return from subroutine
73
Description: Instruction REVERSE inverts orientation of a specified pin. If pin is input, REVERSE changes it to output and vice versa. Example: Main : reverse PORTA.0 Loop : goto Loop End Change orientation of RA0 pin
74
B var byte Main : FOR W=1 TO 9 SELECT CASE CASE 0 B=1 PORTB=B Pause 3000 CASE 1,2,3 B=2 PORTB=B Pause 3000 CASE IS > 5 B=3 PORTB=B Pause 3000 CASE ELSE B=FF PORTB=B Pause 3000 END SELECT NEXT W END W
75
The example above cycles numbers from 0 to 9 in the SELECT CASE branching. If W equals zero port B diodes will take value of 1. If W equals 1, 2 or 3 port B diodes will take value of 2. If W equals 4 or 5 port B diodes will take value of 255 because 4 and 5 havent been defined - therefore, value from CASE ELSE part of the instruction is taken. If W is greater than 5, port B diodes will take value of 3.
Description: SERIN receives one or more values on a specified pin "Pin" using the standard asynchronous format 8N1 (8 data bits, no parity check and one stop bit).
Instead of numerical value ranging from 0 to 15, Mode can be a name if "modedefs.inc" library is included ahead.
Mode number 0 1 2 3 4 5 6 7
Baud rate 2400 1200 9600 300 2400 1200 9600 300
State
True
Inverted
SERIN instruction can include label (parameter "Label") which the program will jump onto if there is no data received during the specified time period (parameter "Timeout" - default value is 1ms). There can be qualifier within brackets [] ahead of every data. SERIN must receive these bytes in correct order before receiving data words. If any received byte doesnt match next bytes qualifier, marking process begins anew - next received byte is compared to the first on the qualifying list. Qualifying content can be a constant, variable or character string. Every character in a string is treated as a separate qualifier.
76
When qualifiers are set, SERIN tries to save data to variables. If there is character # ahead of variable SERIN converts decimal value to ASCII and stores the result in that variable. SERIN works with 4MHz oscillator by default. In order to achieve certain transfer rate with other oscillators, it is neccessary to use appropriate "DEFINE Osc" directive.
Example:
B0 var byte Main : Wait for character "A" to be received on serial line on pin RB0 and store next received character to variable serin PORTB.0, N2400, ["A"], B0 variable B0 lcdout B0 Display content of B0 on LCD
SERIN2 receives one or more values on a specified pin "Pin" using the standard asynchronous format 8N1 (8 data bits, no parity check and one stop bit). Instead of numerical value from 0 to 15, Mode can be a name if "modedefs.inc" library is included ahead.
Mode T2400
Mode number 0
State True
77
2 3 4 5 6 7
Optional "FlowPin" can be used to prevent eventual data loss in high speed transfers. If used, "FlowPin" is automatically set to regular state (depends on polarity from Mode parameter table above) in order to allow transfer of every character. Mode can be used for defining baud rate and serial transfer parameters. Lower 13 bits determine baud rate. Bit 13 selects (non)parity check. Bit 14 selects inverted or true level, while bit 15 is unused. Transfer rate determines bit duration in microseconds. To determine bit duration for a given transfer rate, following equation is used : (1000000 / baud rate) - 20 Table below shows several standard transfer rates:
Baud Rate 300 600 1200 2400 4800 9600 19200 bit 0 -12 3313 1646 813 396 188 84 32
Bit 13 enables parity check if bit 13 equals 1 and disables it for 0. For bit13 = 0 transfer format is 8N1. In case that parity check is needed, following directive should be used :
DEFINE SER2_ODD
Bit 14 selects data level of flow control pins. If bit 14 equals 0 data is received true, while bit14 = 1 receives inverted data.
78
(9600 baud, no parity check, true) (2400 baud, no parity check, inverted) (300 baud, parity check, inverted)
Optional label "ParityLabel" specifies label which program jumps onto if transfer error occurs (this label makes sense only if parity bit is on). "Timeout" and "Label" allow program to proceed from designated label if there is no data in specified time period. Waiting time is expressed in miliseconds. DEFINE directive allows transfer of data with size greater than 8, that is 7 with parity check. SER2_BITS allows transfe r of data ranging from 4 to 8 bits. SERIN2 supports many different data modifiers that can be combined to allow various input data formats.
Modifier BIN{1..16} DEC{1..5} HEX{1..4} SKIP n STR ArrayVar\n{\c} WAIT ( ) WAITSTR ArrayVar{ \n} Takes binary digits Takes decimal digits
How it works
Takes hexadecimal digits Skips next n characters Takes the sequence of n characters that ends with the character c (optional) waits for character sequence waits for a string
If prefix BIN is used ahead of variable, ASCII character in binary value of variable will be received. For example, if we write BIN B0 and received value is "1000" B0 will take value of 8. If prefix DEC is used ahead of variable, ASCII character in decimal value of variable will be received. For example, if we write DEC B0 and received value is "123" B0 will take value of
79
If prefix HEX is used ahead of variable, ASCII character in hexadecimal value of variable will be received. For example, if we write HEX B0 and received value is "FE" B0 will take value of 254.
Key word SKIP followed by a number enables that many characters from input row to be skipped. For example, SKIP 4 would skip 4 characters. If key word STR is followed by variable of string type, number "n" and optional ending char, character string will be received. String length is defined with "n" or with appearing of final element of a string. Data bytes received usually go after one or more identification bytes. Identification bytes come within small brackets after WAIT. It means that the sequence of received bytes must match the sequence of identification bytes. Otherwise, if one of received bytes doesnt match following byte in identifier sequence, identification process starts anew - next received byte is compared to the first identification byte. Identification byte can be a constant, variable or array of constants. In the last case, every constant is treated as a separate identifier. WAITSTR is used in a similar way as WAIT, except for the fact that the key is character string instead of byte sequence. Instruction SERIN2 assumes that microcontroller clock works at 4MHz. In case of different oscillator it is necessary to make adjustment with following directive : DEFINE OSC.
Example:
wait for character "A" to be received to RB0 pin and store next received character to variable B0.
Basic for PIC Microcontrollers serin2 PORTB.0, 84, [skip 2, dec 4, B0]
80
SERIN sends one or more values to a specified pin "Pin" using the standard asynchronous format 8N1 (8 data bits, no parity check and one stop bit). Transfer modes ("Mode") include :
Mode T2400 T1200 T9600 T300 N2400 N1200 N9600 N300 OT2400 OT1200 OT9600 OT300 ON2400 ON1200 ON9600 ON300
Mode number 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Baud Rate 2400 1200 9600 300 2400 1200 9600 300 2400 1200 9600 300 2400 1200 9600 300
State
Driven True
Driven Inverted
Open True
Open Inverted
Instead of numerical value from 0 to 15, Mode can be a name if "modedefs.inc" library is included ahead. If there is character # ahe ad of variable SEROUT converts decimal value to ASCII and sends
Basic for PIC Microcontrollers it. For example, if B equals 34 then #B sends 3 and 4.
81
SEROUT works with 4MHz oscillator by default. In case of different oscillator it is necessary to make adjustment with following directive : DEFINE OSC. In cases of slower receiving device, it is necessary to wait for a certain amount of time when sending next data. DEFINE directive enables delay ranging from 1 to 65 535 microseconds (0.001 to 65.535 miliseconds) between sending 2 characters. DEFINE CHAR_PACING 1000 1ms delay between 2 chars
Example:
B0 var byte Main: B0 = 25 serout PORTA.3, N2400, [#B0, 13] Send ASCII value of B0 and constant 13 to RA3 via serial line Loop : goto Loop End
SEROUT2 sends one or more values to pin determined with parameter "Pin". "Pin" is automatically designated output, while optional "FlowPin" is designated input. Optional "FlowPin" is used for indicating data loss at receiver. Level of permission depends on data transfer mode determined by "Mode". Optional parameters "Timeout" and "Label" allow program to proceed and in case that "FlowPin" doesnt change to state of transfer allowed in a given time period. Wait time "Timeout" is entered in miliseconds. In some cases transfer rate of SEROUT2 can be too high for receiving device. Then, it is more
82
efficient to set delay between 2 characters using the "pace" parameter instead of using extra pin as "FlowPin". In this way, it is possible to provide sufficient delay when sending data. Mode is used to determine baud rate and important parameters of serial transfer. Lower 13 bits determine baud rate. Bit 13 selects (non)parity check. Bit 14 selects inverted or true level, while bit 15 is used to determine if connection is currently in transfer or not. Transfer rate determines bit duration in microseconds. To determine bit duration for a given transfer rate, following equation is used : (1000000 / baud rate) - 20 Table below shows several standard transfer rates:
Baud Rate 300 600 1200 2400 4800 9600 19200 bits 0-12 3313 1646 813 396 188 84 32
If set, bit 13 enables parity check. Transfer format is standard 8N1 (8 data bits, no parity check, one stop bit) and for bit13 = 1 format is 7E1 (7 data bits, parity bit and one stop bit). Bit 14 selects data level of "flow control" pins. If bit 14 equals 0 data is received true, while bit14 = 1 receives inverted data (this can used to avoid installation of RS232 communication driver - MAX232). Bit 15 determines if data pin is still connected (bit15 = 0) or disconnected from data transfer line. This option is useful in case of connecting multiple devices to common serial line.
Some of standard settings include : Mode = 84 Mode = 16780 Mode = 27889 (9600 baud, no parity check, true) (2400 baud, no parity check, inverted) (300 baud, parity check, inverted)
83
DEFINE directive SER2_BITS allows transfer of data with size different than 8 (7 with parity check). SER2_BITS allows transfer of data ranging from 4 to 8 bits. Default value is 8 bits. SEROUT2 supports many different data modifiers that can be combined in order to allow various input data formats.
Modifier {I}{S} BIN{1..16} {I}{S} DEC{1.16} {I}{S} HEX{1..16} REP c\n STR ArrayVar\n{\c} How it works Sends binary digits
If prefix BIN is used ahead of variable, ASCII character in binary value of variable will be sent. For example, if we write BIN B0 and B0 = 8, bits 1000 will be sent serial. If prefix DEC is used ahead of variable, ASCII character in decimal value of variable will be sent. For example, if we write DEC B0 and B0 = 123, data "123" will be sent. If prefix HEX is used ahead of variable, ASCII character in hexadecimal value of variable will be sent. For example, if we write HEX B0 and B0 = 254, SEROUT2 will send "FE". REP followed by a character and a number of repeating provides more compact form of writing long strings of same characters. For example, REP "0"\4 stands for "0000" STR followed by variable of string type and an optional numerical parameter "count" executes sending of character string. String length is determined by "count" or by appearance of character "0" in a string. Optional parameters can be used ahead or behind BIN, DEC and HEX. In case that "I" is used ahead of any of these, output data will begin with %@, #@ or $@ in order to mark current value as binary, decimal or hexadecimal. In case that "S" (signed) is used ahead of BIN, DEC or HEX , output data will begin with " " if highest data bit is set to 1. This allows transfer of negative values. You should bear in mind, though, that all mathematical and comparison operations work with unsigned numbers. Still, unsigned numbers arithmetic allows signed values as results. For example, in case of B0 = 9 10, DEC B0 gets value of "255", whereas SDEC B0 sends "1" after the trans fer of the highest bit. BIN, DEC and HEX can be followed by a number. It is common practice to write numerical data in exact number of digits needed, so that leading zeros are erased and not sent. In case that BIN, DEC and HEX are followed by a number, SEROUT2 will always send that exact number of data, adding leading zeros if needed. For example, BIN6 8 sends BIN "001000",
84
while BIN2 8 sends "00". All these modifies can be used simultaneously (i.e. ISDEC4 B0). Instruction SEROUT2 assumes that microcontroller clock works at 4MHz. In case of different oscillator it is necessary to make adjustment with following directive : DEFINE OSC
Example:
B0 = 25 SEROUT2 PORTA.3, 16780, [DEC B0, 10] Send decimal value of variable B0 and "LineFeed" via serial line (2400 bauds) to pin RA3. B0 = 25 SEROUT2 PORTA.1, 84, ["B0=", IHEX4 B0] Send string "B=" and 4-character hexadecimal value of variable B0 to RA1 at 9600 bauds.
Description: Instruction SHIFTIN shifts receiving bits on a given pin in synchrony with "ClockPin" frequency signal and stores them to variable. "Var \Bits" optionally specifies the number of bits to be shifted. If nothing is specified, default number of bits is 8. Depending on shifting direction (from MSB to LSB or vice versa) various transfer modes can be defined. Transfer modes Mode are defined within MODEDEFS.BAS library. To use them, it is necessary to include mentioned library at the beginning of the program with : Include "modedefs.bas" "Mode" MSBPRE LSBPRE MSBPOST Mode number 0 1 2 Operation First, the highest bit is shifted. Data is read ahead of sending clock. Clock is inactive on a logical zero. First, the lowest bit is shifted. Data is read ahead of sending clock. Clock is inactive on a logical zero. First, the highest bit is shifted. Data is read after sending clock. Clock is
85
LSBPOST
3 4 5 6 7
First, the lowest bit is shifted. Data is read after sending clock. Clock is inactive on a logical zero. First, the highest bit is shifted. Data is read ahead of sending clock. Clock is inactive on a logical one. First, the lowest bit is shifted. Data is read ahead of sending clock. Clock is inactive on a logical one. First, the highest bit is shifted. Data is read after sending clock. Clock is inactive on a logical one. First, the lowest bit is shifted. Data is read after sending clock. Clock is inactive on a logical one.
Shifting frequency is about 50KHz, depending on oscillator used. Active state lasts for at least 2 microseconds. Using the directive DEFINE enables additional delay (up to 65.535 miliseconds) for slowing down the clock. DEFINE SHIFT_PAUSEUS 100 Slowing down the cloc k for additional 100ms
Example:
shiftin Data, Clock, MSBPRE, [RxData] Sends the contents of input SHIFT register to variable RxData so that the first bit is MSB.
Description: Instruction SHIFTOUT shifts bits of variable "Var" on a given pin in synchrony with "ClockPin" frequency signal. "Var\Bits" optionally specifies the number of bits to be shifted. If nothing is specified, default number of bits is 8. Transfer modes Mode are defined within MODEDEFS.BAS library. To use them, it is necessary to include mentioned library at the beginning of the program with : include modedefs.bas Shifting frequency is about 50KHz, depending on oscillator used. Active state lasts for at least 2 microseconds. Using the directive DEFINE enables additional delay (up to 65.535 miliseconds) for slowing down the clock. DEFINE SHIFT_PAUSEUS 100 "Mode" LSBFIRST MSBFIRST Mode number 0 1 4 5 Slowing the clock for additional 100ms Operation First, the lowest bit is shifted.. Clock is inactive on a logical zero. First, the highest bit is shifted.. Clock is inactive on a logical zero. First, the lowest bit is shifted.. Clock is inactive on a logical one. First, the highest bit is shifted.. Clock is inactive on a logical one.
86
Example:
B0 var byte B1 var byte W0 var byte Main : shiftout PORTA.0, PORTA.1, MSBFIRST, [B0, B1] Sends the contents of variables B0 and B1 to output SHIFT register so that the transferred bit is MSB shiftout PORTA.0, PORTA.1, MSBFIRST, [W0\4] Sends 4 bits of variable W0 so that the first transferred bit is MSB Loop : goto Loop End
first
4.58 SLEEP Turns off the processor for a given time period
Syntax: SLEEP Period
Description: Instruction puts the microcontroller to a state of low energy consumption for "Period" of seconds. "Period" is a 16-bit value allowing maximal delay of 65 535 seconds (about 18h). SLEEP uses the watchdog timer (WDT) with granularity about 2.3 seconds. RC oscillator is less temperature stable than system clock, making WDT somewhat less accurate. Example: Main : sleep 60 Loop : goto Loop End Go to low power mode for next 60 sec
87
Description: Instruction generates tone and/or noise on a given pin. For Note=0 there is no sound generated. If Note falls within range of 1-127 tones are generated, while range of 128255 generates noise. Tones and noises are sorted in an ascending fashion (1 and 128 are the lowest frequencies, 127 and 255 are the highest). Duration ranges from 0 to 255 and defines sound duration in 12ms increments ("Note" and "Duration" dont have to be constants). Sound is being sent to output in form of sequence of TTL rectangle impulses. Thanks to the outstanding I/O features of PIC microcontrollers, a speaker can be driven directly trough electrolitical capacitor. Piezo speakers can be driven directly. Example: Main : sound PORTB.7, (100, 10, 50, 10) Loop : goto Loop End Sends 2 sounds in sequence to pin RB7
Description: Instruction stops the program execution by commencing the infinite loop. This instruction does not put the microcontroller to low power mode. Example: Main : STOP Stop the program execution in this line Loop : goto Loop End
Description: Instruction SWAP exchanges values of two variables. It can be used with variables of bit, byte and word types. SWAP can be used with strings, but only with those that have constant indexes.
88
Description: Instruction inverts state of a specified pin. "Pin" is automatically designated output. Example: Main : low PORTB.0 toggle PORTB.0 Loop : goto Loop End Set the state of pin RB0 to low level as starting condition Change state of pin RB0 to high level
Description: Instruction writes "Value" to a specified address of EEPROM. WRITE can only be used with PIC microcontrollers that have EEPROM built in chip.
89
If 2-byte variable is being stored, two bytes are written in sequence : WRITE Address, Variable.BYTE0 WRITE Address, Variable.BYTE1 Example: B0 var byte Main : B0 = $EA write 5, B0 Loop : goto Loop End Writes value $EA to location 5 of EEPROM
Description: WRITECODE writes "Value" to a given address of program memory. This instruction can only be used with PIC microcontrollers that have FLASH memory in chip. Interrupts during the writing must be on. Example: W0 var byte Main : W0 = $12FE writecode 100, W0 Write value $12FE to location 100 of program FLASH memory Loop : goto Loop End
90
Instructions... WEND Description: Purpose of this instruction is to keep executing set of instructions between WHILE and WHEN as long as "Condition" is fulfilled.
Example:
i Var byte Main : i=1 WHILE i< 10 i=i+1 PORTB = i Pause 1000 WEND goto Main End when i reaches 10 program stops and port B has value of 9
91
Chapter 5
SAMPLE PROGRAMS FOR SUBSYSTEMS WITHIN THE MICROCONTROLLER
Introduction 5.1 Using the interrupt mechanism 5.2 Using the internal AD converter 5.3 Using the TMR0 timer 5.4 Using the TMR1 timer 5.5 Using the PWM subsystem 5.6 Using the hardware UART subsystem (RS-232 communication)
Introduction
Every microcontroller is supplied with at least a few integrated subsystems - commonly, these include timers, interrupt mechanisms and AD converters. More powerful microcontrollers can command greater number of built-in subsystems. Some of frequently encountered systems are detailed in this chapter.
92
Button T is connected to the external interrupt input INT (pin RB0/INT) so that pressing the button is considered an interrupt occurrence. In order to see the change caused by interrupt LED diodes are connected to the pins RB6 and RB7. LED_run diode signalizes that the main program is being executed, while LED_ini diode signalizes the interrupt caused by pressing the button T. Following instructions are used in PIC BASIC programs which contain interrupt routine : On Interrupt goto Address Defines the interrupt vector (address of interrupt routine) Disable Enable Resume Disables the interrupts Enables the interrupts Return to the main program after handling the event
Following example demonstrates usage of external interrupt INT located on pin RB0. At the same time, program gives an example how to handle multiple interrupt sources.
93
94
Program which handles interrupt must have the main loop (program) and an interrupt routine. Program in the main loop keeps LED_run diode on and LED_int diode off. Pressing the button T causes the interrupt and the microcontroller will stop executing the main program and start executing the interrupt routine ISR marked by On interrupt instruction. At the beginning of the interrupt routine there is instruction Disable. This instruction disables all interrupts until handling the current interrupt is over. ISR routine then analyses the interrupt by checking bits (flags) set on "1" with couple of if...then instructions, because there are several possible interrupt causes. In our case, an external interrupt took place (pin RB0/INT state changes) and therefore bit INTF in INTCON register is set and the microcontroller continues program execution from the label INTF. Part of the program code following the label INTF handles the interrupt and resets INTF bit in order to enable interrupts again. In this case, handling the external INT interrupt changes state of diodes LED_int and LED_run : it turns off LED_run and turns on LED_int for half second period. After INTF is being reset, microcontroller continues executing the program from Exit_ISR label where interrupts are enabled (instruction Enable) and microcontroller returns to executing the main program (instruction Resume). Why use interrupts at all ? In situations where the microcontroller must respond to events unrelated to the main program it is very useful to have an interrupt. Perhaps, one of the best examples is multiplexing the seven-segment display. If multiplexing code is part of the interrupt routine tied to timer interrupt the main program will be much less burdened because display refreshing will work in the background of the main program.
95
The simplest AD conversion program would use 8-bit resolution and 5V of microcontroller power as referent voltage (value which the value "read" from the microcontroller pin is compared to). In the following example we measure voltage on RA0 pin which is connected to the potentiometer (picture below).
Potentiometer gives 0V in one terminal position and 5V in the other, so that digitalized voltage can take values ranging from 0 to 256 due to the fact that 8-bit conversion is used. The following program reads voltage on RA0 pin and displays it on port B diodes. If not one diode is on, result is zero and if all of diodes are on, result is 255.
96
At t he very beginning, it is necessary to properly initialize 2 bit registers ADCON1 and ADCON0. Afterwards, only thing required is to set ADCON0.2 bit which initializes the conversion and checks ADCON0.2 to determine if conversion is over. After the conversion is over, result is stored into ADRESH and ADRESL where from it can be copied. Former example can also be carried out via ADCIN instruction. Following example uses 10-bit resolution and ADCIN instruction.
97
As one port is insufficient, LCD can be used for displaying all of the 10 bits of result. Connection scheme is on the picture below and appropriate program follows.
98
99
100
prolonged, because prescaler divides the clock in a certain ratio (prescaler settings are made in OPTION_REG register). Following program illustrates use of TMR0 timer for generating 1 second time period. Prescaler is set to 32, so that internal clock is divided by 32 and TMR0 increments every 31 microseconds. If TMR0 is initialized on 96, overflow occurs in (256-96)*31 us = 5 ms. If variable "Brojac" is increased every time interrupt takes place, we can measure time according to the value of variable "Brojac". If "Brojac" is set to 200, time will total 200*5 ms = 1 second. Before the main program, TMR0 should have interrupt enabled (bit 2) and GIE bit (bit 7) in INTCON register should be set.
101
measure falls into 0-65536 microseconds range (with 4MHz frequency TMR01 increments by one microsecond). If prescaler is used that period can be prolonged, because prescaler divides the clock in a certain ratio (prescaler settings are made in T1CON register). Before the main program, TMR1 should be enabled by setting the zero bit in T1CON register. Besides that, first bit of the register should be set to zero, thus defining the internal clock for TMR1. Besides T1CON, other important registers for working with TMR1 include PIR1 and PIE1. The first contains overflow flag (zero bit) and the other is used to enable TMR1 interrupt (zero bit). When TMR1 interrupt is enabled and its flag reset only thing left to do is to enable global interrupts (bit 7) and peripheral interrupts (bit 6) in the INTCON register. The following program illustrates use of TMR1 register for generating 10 seconds time period. Prescaler is set to 00 so there is no dividing the internal clock and overflow occurs every 65.536 ms. If variable "Brojac" is increased every time interrupt takes place, we can measure one minute period according to the variable "Brojac". If "Brojac" is set to 152, time will total 152*65.536 ms = 9.960 second.
102
103
defines channel on RC2 pin. Ratio_S_P : defines the ratio of on and off signals on pin. "0" defines continual off state, whereas "255" defines continual on state. All values within these limits define appropriate ratio of on and off signals on pin. (i.e. "127" gives 50% of 0V on output and 50% of 5V on output). Frequency : defines PWM signal frequency. Top frequency for any oscillator is 32767Hz.
The following example demonstrates use of PWM for getting various light intensities on LED diode connected to RC1 pin (PWM channel 0). Parameter defining ratio of on and off signals is continually increased in the for-next loop and takes value from 0 to 255, resulting in continual intensifying of light on LED diode. After value of 255 has been reached, process begins anew.
104
105
UART contains special registers for receiving and transmitting data as well as BAUD RATE generator for determining data transfer rate. The program below illustrates use of hardware serial communication subsystem (serial communication can also be software based on any of 2 microcontroller pins). Data received from PC is stored into variable B0 and sent back to PC as confirmation of successful transfer. Thus, it is easy to check if communications works properly. Transfer format is 8N1 and transfer rate is 2400 baud. In order to achieve communication, PC must have the communication software. One such program is part of the MicroCode studio. It can be accessed by clicking View and then Serial Communication Window. New window will appear on screen and can be used for adjusting transfer settings. First it is necessary to set transfer rate by clicking Baudrate on the left of the window (set it to 2400, because microcontroller is set to that rate). Communication port is selected by clicking one of the 4 available depending on port connected to a serial cable. After making adjustments, clicking Connect starts the communication. Type your message and clickSend Message - message is sent to the microcontroller and back, where it is displayed on the screen.
106
107
Chapter 6
SAMPLES WITH PIC16F84 MICROCONTROLLER
Introduction 6.1 LED diode 6.2 Button 6.3 Generating sound 6.4 Potentiometer 6.5 Seven-segment displays 6.6 Step motor 6.7 Input shift register 6.8 Output shift register 6.9 Software serial communication 6.10 Building light control
Introduction
This chapter gives detailed examples of connecting PIC16F84 microcontroller to peripheral components and appropriate programs written in BASIC. All of the examples contain electrical connection scheme and program with comments and clarifications. You have the permission to directly copy these examples from the book or download them from the web site http://www.mikroelektronika.co.yu/ .
108
The positive pole is connected to anode, while ground is connected to cathode. For matter of differentiating the two, cathode is marked by mark on casing and shorter pin. Diode will emit light only if current flows from anode to cathode; in the other case there will be no current. Resistor is added serial to LED diode, limiting the maximal current through diode and protecting it from damage. Resistor value can be calculated from the equation on the picture above, where Ur represents voltage on resistor. For +5V power supply and 10 mA current resistor used should have value of 330. LED diode can be connected to microcontroller in two ways. One way is to have microcontroller "turning on" LED diode with logical one and the other way is with logical zero. The first way is not so frequent (which doesn't mean it doesn't have applications) because it requires the microcontroller to be diode current source. The second way works with higher current LED diodes.
109
The following example uses instructions High, Low and Pause to turn on and off LED diode connected to seventh bit of port B every half second.
110
111
6.2 Button
Button is a mechanical component which connects or disconnects two points A and B over its contacts. By function, button contacts can be normally open or normally closed.
Pressing the button with normally open contact connects t he points A and B, while pressing the button with normally closed contact disconnects A and B. Buttons can be connected to the microcontroller in one of two ways: In the first case, button is connected in a way that logical one (+5V) remains on microcontroller input pin while button is not pressed. Resistor between a button and power voltage has role of holding the input pin in defined state when the button is not pressed (in this case a logical one). This is necessary as a protection from glitch on input pin that might cause misinterpretation of program, i.e. as if button is pressed when it is not.
When the button is pressed, input pin is short circuited to the ground (0V) which indicates change on input pin. Voltage has dropped
112
from 5V to 0V. This change is interpreted by program as if button was pressed and part of program code tied to a button (for example turn on LED diode) is then executed. This way of defining pin states is called defining with "pull-up" resistors, associating that the line is held up on the logical one level. In the other case, button is connected in a way that logical zero remains on input pin. Now, resistor is between input pin and a logical zero, meaning that pressing the button brings logical one to input pin. Voltage goes up from 0V to +5V. Microcontroller program should recognize change on input pin and execute the specific part of program code. This way of defining pin states is called defin ing with "pull -down" resistors, associating that the line is held down on the logical zero level.
Common way to connect the button is with pull-up resistors, meaning that pressing the button changes pin state from logical one to logical zero. Following picture displays four button connected to the microcontroller using the pull -up resistors.
113
Problem that occurs when working with buttons is contact debounce in the moment when button is pressed. Debounce is consequence of the contact and heavily depends on the very button. One of the ways to solve the contact debounce problem is given in the following part of program code :
Pressing the Button0 causes the program to jump to address Wait0 where it remains in the loop until the button is released (this achieves that single button push is just once handled in program). When Button0 is released program continues executing instructions (in this case variable W is increased by one). Pressing Button1 causes the same effect, except that variable W is decreased by one. Problem might arise if an interrupt or some other source slows down the program execution, so that program finds itself on Wait0 or
114
In the following program for reading the button states, BASIC instruction Button is used which eliminates the contact debounce. The program reads buttons T0 and T1 which are connected to the pins RA0 and RA1, respectively. Pressing the button 0 executes part of program code which turns on LED diode on pin RB0. Pressing the button 1 executes part of program code which turns off LED diode on the same pin. The mentioned instruction is among the most complex instructions of BASIC program language. Besides few arguments that should be defined, instruction has an argument for setting the delay time between recognition of two different button pressures (the third argument). Its setting depends on the purpose of the button as well as mechanical properties of the button. Still, it came clear over time that maximal value of last argument represents the best solution for most applications, because of great disproportion in human reaction and microcontroller speed.
115
116
Sometimes it is necessary to provide sound signalization on device, besides the visual one (LED diodes). The following example shows one way to generate sound signal using the mini speaker and BASIC instruction Sound.
Buttons are connected to pins RA0, RA1 and RA2. Pressing any of these executes part of the code for generating impulse sequence on RA3 pin, which can be heard as one monotonous sound or a melody on mini speaker. Consecutive execution of instruction Sound with different parameters allows composing various melodies. In the following program, pressing the button T0 generates one monotonous sound on a mini speaker, while pressing the buttons T1 and T2 executes sequences of Sound instructions which can be heard as two different melodies on a mini speaker.
117
6.4 Potentiometer
118
In order to measure and display analog values, besides the microcontroller, it is necessary to have an AD converter. This can be an expensive solution if some less precise measuring is required, for example potentiometer voltage. For this reason PIC BASIC features the POT instruction for using the microcontroller without AD converter.
RC pair which consists of potentiometer (typical resistance in 5-50k range) and a 100nF capacitor is connected to RA0 pin. Reading the potentiometer is based upon measuring the time period between capacitor discharging and charging. Measuring scale ranges from 0 to 255 as if 8-bit AD converter was used. The following program reads potentiometer value in 0-255 range and displays it on LED diodes connected to the port B.
119
120
As seven-segment digits have better temperature features as well as visibility than LCD displays, they are very common in industrial applications. Their use satisfies all criteria including the financial one. Simple application would be displaying value read from a certain sensor.
One of the ways to connect seven-segment display to the microcontroller is given on a picture above. System is connected to use seven-segment digits with common cathode. This means that segments emit light when logical one is brought to them, and that output of all segments must be a transistor connected to common cathode, as shown on the picture. If transistor is in conducting mode any segment with logical one will emit light, and if not no segment will emit light, regardless of its pin state. If we use the scheme from the picture above, one of the ways to realize the display in BASIC could be the following program code :
121
Variables LEDDisp1 and LEDDisp2 are actually pins 1 and 0 of port A, which bases of transistors T1 and T2 are connected to. Setting logical one on those pins turns on the transistor, allowing every segment from "a" to "h", with logical one on it, to emit light. If there is logical zero on transistor base, none of the segments will emit light, regardless of the pin state. Tens digit is disabled at the very beginning of program, ahead of label Main (LEDDisp2=0). Purpose of the program is to display figures from 0 to 9 on the ones digit, with 0.5 seconds pause in between. In order to display any number, it's mask must be sent to port B. For example, if we need to display "1", segments "b" and "c" must be set to 1 and the rest must be zero. If (according to the scheme above) segments b and c are connected to the first and the second pin of port B, values 0000 and 0110 should be set to port B. These values which are set to port are commonly called "masks". Mask for number "1" is value 0000 0110 or $06 (hexadecimal). The following table contains corresponding mask values for numbers 0-9 : Digit 0 1 2 3 4 5 6 7 8 Seg. h 0 0 0 0 0 0 0 0 0 Seg. g 0 0 1 1 1 1 1 0 1 Seg. f 1 0 0 0 1 1 1 0 1 Seg. e 1 0 1 0 0 0 1 0 1 Seg. d 1 0 1 1 0 1 1 0 1 Seg. c 1 1 0 1 1 1 1 1 1 Seg. b 1 1 1 1 1 0 0 1 1 Seg. a 1 0 1 1 0 1 1 1 1 HEX $3F $06 $5B $4F $66 $6D $7D $07 $7F
122
$6F
Program uses the instruction Lookup to apply an appropriate mask to numerical value. Instruction Lookup works very simply - it puts a character from a sequence, its position defined by numerical value Digit, to variable Mask. For example, Mask will take value $5B if Digit has value 2. In that manner, we can easily get mask for any decimal digit. Continual display of Mask (PORTB=Mask) for appropriate value of variable Digit, with 0.5sec pause, will produce an effect of digits rotating from 0 to 9. Problem with multiplexing occurs when displaying more than one digit is needed on two or more displays. It is necessary to put one mask on one digit quickly enough and activate it's transistor, then put the second mask and activate the second transistor (of course, if one of the transistors is in conducting mode, the other should not work because both digits will display the same value). New program differs from the one above in converting 2-digits value to 2 masks, which are displayed in a way that human eye gets impression of simultaneous existence of both figures (this is the reason for calling it "multiplexing" - only one display actually emits in any given moment). Let's say we need to display number 35. First, the number should be separated into tens and ones (in this case, digits 3 and 5) and their masks sent to port B. This separation can be done with instruction Dig. For example, Digit1= W dig 0 will extract ones digit from variable W and store it into variable Digit1. If 0 is substituted with 1, tens digit will be extracted. Following the same logic, 2 extracts number of hundreds, 3 number of thousands, etc.
123
This part of program code prints value 35 on two seven-segment displays. The rest of the program is very similar to the last example, except for having one transition caused by displaying one digit after another. This transition can be spotted when LEDDisp1 is being turned off and LEDDisp2 turned on with a new mask. Lookup table is still the same and may be called as a subroutine when needed. The multiplexing problem is solved for now, but the program doesn't have a sole purpose to print values on displays. It is commonly just a subroutine for displaying certain information. However, this kind of solution for printing data on display will make essence of the program much more complicated. This newly encountered problem may be solved by moving part of the program for refreshing the digits (part of the program code for handling the masks and controlling the transistors) to interrupt routine. The following program shows how to use interrupt for refreshing the display. Main program increases the value of variable W from 0 to 99 and that value is printed on displays. After reaching the value of 99, counter begins anew.
124
125
Interrupt initialized in this way will generate interrupt every time TMR0 timer changes state from 255 to 0. Every time interrupt takes place, interrupt routine will be executed so that human eye gets impression that both displays print values simultaneously. As can be seen from the program code, everything tied to displaying digits is moved to interrupt routine. However, part of the code for forming the masks to be displayed is in the special subroutine (Gosub Prepare) in order to make interrupt routine code as short as possible. Another reason for this kind of organization is also the need to create masks only when variable W is changed and not every time interrupt takes place. In the course of main program, programmer doesn't have to take care of refreshing the display nor anything about displays whatsoever. It is only necessary to call subroutine "Preparation" every time value that will be displayed changes. As 2-digit values don't satisfy most needs, the following step is adding two additional digits. Program for realization of 4 sevensegment displays is just an expansion of the program above. The main difference is in the part for separating values to ones, tens, hundreds and thousands.
126
127
128
129
Chapter 7
SAMPLES WITH PIC16F877 MICROCONTROLLER
Introduction 7.1 Keyboard 7.2 Driver for seven-segment displays - MAX7912 7.3 LCD display 7.4 Serial EEPROM 7.5 RS-485 7.6 12-bit A/D converter LTC1290 7.7 12-bit D/A converter LTC1257 7.8 16-bit electrical current D/A converter AD421 7.9 Real time clock PCF8583 7.10 Digital thermometer DS1820
Introduction
This chapter gives detailed examples of connecting PIC16F877 microcontroller to peripheral components and appropriate programs written in BASIC. All of the examples contain electrical connection scheme and program with comments and clarifications. You have the permission to directly copy these examples from the book or download them from the web site http://www.mikroelektronika.co.yu/ .
7.1 Keyboard
In more demanding applications that require greater number of buttons, it is possible to use buttons connected in matrix to keep microcontroller I/O lines free. The following sample includes scheme of connecting the keyboard and accompanying program which reads keyboard keys and prints the read value on LED diodes of port D.
130
The keys are connected into shared rows and columns. 10K resistors between input pins and the ground determine the state of input pins when the key is not pressed. It means that the logical zero is on input pins when the keys are not pressed. In order to avoid shortcircuits between two pressed keys, 1K resistor is added to each row. Reading the keyboard is done by subroutine "ScanKeys". The keyboard is connected to port B, it's pins being designated as input for rows (RB7, RB6, RB5 and RB4) and output for columns (RB3, RB2 and RB1).
131
The program sets value of the last read key on port D. If none of the keys is pressed all diodes of port D are on. "*" and "#" are represented with values 10 and 11. The greatest task is on the subroutine ScanKey. It sets logical one on keyboard columns and then calls the subroutine Row which checks if any of the 4 keys in that columns is pressed (which is signalized by variable Flag). In case that one of the keys from the column is pressed, variable KeyPress takes value from 0 to 3 (zero for the first row of that column, one for the second row of that column, etc. ). By calling the appropriate Lookup table, real value of the key is stored into variable Result and then to variable OldResult where from it is displayed on port D. In case that no key is pressed value of variable is 12.
132
133
134
135
136
137
138
Appendix A
PIC BASIC AND MPLAB
Introduction A.1 Installation of the program / MPLAB A.2 Connection of PIC BASIC and MPLAB A.3 Toolbar
Introduction
MPLAB is a Windows programming package that facilitates writing and the development of the program. The easiest way to describe it would be to characterize it as a development environment for some standard programming language intended for PC programming. Using MPLAB technically facilitates some of the operations which all the way up to the appearance of the IDE environment, were operating out of the command line with very big number of parameters. Nevertheless, out of different tastes, some programmers even today prefer standard editors and compilers operating out of the command line. In any case the written code is very manifest and provided with a relatively well-provided HELP menu (the abbreviation IDE was born out of the initials Integrated Development Environment).
Basic for PIC Microcontrollers MPLAB is composed out of several different entities
139
The grouping of the files belonging to the same project (Project Manager) The creation of the program and its elaboration (Text Editor) Simulator of the code whereby its work on the microcontroller is simulated.
Besides there exist support for Microchips products such as PICStart Plus i ICD (In Circuit Debugger). As this book doesnt rely upon them, they'll be mentioned as options only.
Compatible PC of 486 class or higher Microsoft Windows 3.1x or Windows 95 and more recent Windo ws OS versions VGA graphic card 8MB of memory space (32 MB recommended) 20MB space on hard disk The mouse
To start MPLAB it is necessary to install it first, which is understood as a process of copying of MPLAB files from CD onto the hard disk of the PC. On each newly opened window there is button for going back to the previous window so mistakes should not represent any problem. The installation itself flows similarly as those of almost all Windows programs. The welcome screen pops up first and then you have the option choice and the installation menu in order to finally get the message that your installed program is ready to be started.
Basic for PIC Microcontrollers 1. 2. 3. 4. 5. 6. 7. The starting of the Microsoft Windows Put the Microchip CD disk into the CD ROM
140
Click onto the START in the lower left corner of the screen and choose the RUN option Click onto the BROWSE and select CD ROM drive for your PC On the CD ROM find the directory under the name of MPLAB Click onto the SETUP.EXE and then on the OK button Click once again on OK button in the RUN window
After these seven consecutive steps the installation will start. The following pictures explain the meaning of single steps in the installation process.
At the very beginning it is necessary to choose those components of MPLAB with which we are going to work. As it is supposed that there are no original Microchips hardware additions such as programming devices or emulators, only the MPLAB environment, Assembler, Simulator and the instructions for use will be installed.
141
The second supposition is that the OS will be Windows 95 (or some more recent version), so that in the selection of the assembler language is taken out everything that is connected to DOS operating system. However if you nevertheless wish to work in DOS, it is necessary to perform the deselecting of all the options connected with Windows, and choose the corresponding DOS components.
142
As it is normal for any program, MPLAB should be installed into a defined directory. This option can be changed into any directory on any hard disk of your PC. Unless you have some specific reason, it should be left on the selected location.
143
The next option is necessary for the users who already had some previous MPLAB version (different from one that is being installed). It's purpose is to save all the file copies that are subject to change upon the transition to an updated version. In our case the selection of NO assumes that the installation in course is the first one.
144
The option necessary to the users who install the new version of MPLAB over some already existing installation
The start menu is the set of the pointers onto the programs opened by the click onto the START button in the lower left corner of the screen. It is necessary to leave this option exactly as it is offered, since MPLAB is going to be started from here.
145
Location mentioned next is related to the part of MPLAB which will not be explained here as it is insignificant for users. By selecting an apposite directory, MPLAB will keep all the files in connection with the linker in that directory.
146
Every Windows program has the system files, usually stored in the same directory as the Windows itself. After numerous installations, the Windows directory has a tendency of becoming too big and encumbered. Therefore, some of the programs permit their system files to be kept in the same directory as the program itself. MPLAB is one such program so tha t the option below should be selected.
147
Following all steps up to now after pressing the button Next the installation is under way
Basic for PIC Microcontrollers The screen exactly before the installation
148
The installation itself is brief and the course of the copying can be monitored on the small screen in the right corner.
When the installation is terminated, two dialog boxes are present on the screen one for the last information concerning corrections and the version of the program, the other greeting one. If the text files (Readme.txt) are opened they should be closed.
149
The last information concerning version and the corrections on the program
By clicking on the Finish button the installation of the program is thereby terminated.
You just start the MPLAB and choose Install Language Tool from the Project menu. The dialog box where the corresponding options is to be set, the manufacturer first, (whereby directly in the next option comes the list of compilers by the same manufacturer) and accordingly the compiler itself in our case Pic Basic Pro Compilerand exactly as the one on the pict ure bellow will appear then. At the end on should click at the option browse and find PBP.EXE file on the disk (in this case C: PBP \). By clicking on OK the basic settings are completed.
150
Start MPLAB and choose the Install Language Tool from the Project menu.
Next step is the creation of the project that is done in a standard way by selecting New Project from the Project menu and by assigning the project name e.g. probe.pjt. A special care is to be given to the project storage location. The new project and all its components must be located in the same directory as PicBasic Pro! For this case, the project must be stored in C:/PBP.
Creating project by selecting New Project from Project menu and assigning the project name as, e.g. probe.pjt.
By clicking OK the new window Edit Project appears. In Language Tool microEngeneering Labs is to be selected (answer the incoming question with OK). It is, hence, necessary to click on probe [.hex] in the lower part of the window whereby the option Node Properties is activated.
151
The New window Edit Project for the definition of the manufacturer. Choose microEngeneering Labs
The purpose oh this window is to set the microcontroller for which the program is written. By clicking Change button, the new window for choosing the available microcontrollers appears. As an option, Editor only is to be left in the absence of any available Microchips tools (this option states the use of MPLAB as a shell for PIC Basic compiler). Bu clicking Node Properties the window shown on the picture below appears. Choose "PM" version in the assembler selection. Clicking the OK returns us to the previous window.
152
The Add Node button is active now, and through it the name to the file with basic program is assigned. It is in our case, probe.bas. it is to take notice that the present action is only assigning name of the file into the project. Its actual creation is done in next step.
Window for naming the program in writing. Opening of the file is done in next step.
153
So far we defined microcontroller and the programming language. It still remains to open the file, write the code and register it under the name given in previous step. (proba.bas). By clicking File-> New the window in which the basic program will be written appears. Before we start the program writing, file must be registered with the command File-> Save as, file name being obviously proba.bas. The code writing can start now. The program here serving as an example is a very simple one and its only function is to make the diode on a port B twinkle.
Upon finishing the code writing, the click on PROJECT-> Build All is performing the compilation of the program. Unless there have been some errors, the obtained file is C:/PBP/probe.hex readable into the microcontroller.
154
A.3 Toolbar
Since MPLAB is composed of several separate parts, each of them possesses its own toolbar. However, there exists a toolbar being a sort of a combination of all the others, which may be considered as a common one. This toolbar is sufficient for our needs so it will be the explained in details. On the picture bellow this toolbar is given with the brief explanations of the icons. Out of the limited format of this book, the basic toolbar is displayed as the free one and in a standard position is always bellow the menu, displaced horizontally along the entire screen.
If, for whatever reason, currently used toolbar does not respond, upon clicking this icon the next toolbar becomes available. The change goes into circle so that upon the 4th click, the same toolbar is obtained again.
If the current toolbar for some reason does not respond to a click on this icon, the next one appears. Changeover is repeated so that on the fourth click we will get the same toolbar again.
Icon for opening a project. Project opened in this way contains all screen adjustments and adjustment of a
155
Icon for saving a project. Saved project will keep all window adjustments and all parameter adjustments. When we read in a program again, everything will return to the screen as when the project was closed.
Searching for a part of the program, or words is operation we need when searching through bigger assemb or other programs. By using it, we can find quickly a part of the program, label, macro, etc.
Cutting a part of the text out. This one and the following three icons are standard in all programs that deal with processing textual files. Since each program is actually a common text file, those operations are usefu
Copying a part of the text. There is a difference between this one and the previous icon. With cut operation when you cut a part of the text out, it disappears from the screen (and from a program) and is copied afterwards. But with copy operation, text is copied but not cut out, and it remains on the screen.
When a part of the text is copied, it is moved into a part of the memory which serves for transferring data Windows operational system. Later, by clicking on this icon it can be 'pasted' in the text where the cursor i Saving a program (assembler file).
Start program execution in full speed. It is recognized by appearance of a yellow status line. With this kind program execution, simulator executes a program in full speed until it is interrupted by clicking on the red traffic light icon.
Stop program execution in full speed. After clicking on this icon, status line becomes gray again, and progra execution can continue step by step. Step by step program execution. By clicking on this icon, we begin executing an instruction from the next program line in relation to the current one.
Skip requirements. Since simulator is still a software simulation of real work, it is possible to simply skip ov some program requirements. This is especially handy with instructions which are waiting for some requirement following which program can proceed further. That part of the program which follows a requirement is the part that 's interesting to a programmer. Resetting a microcontroller. By clicking on this icon, program counter is positioned at the beginning of a program and simulation can start. By clicking on this icon we get a window with a program, but this time as program memory where we can which instruction is found at which address. With the help of this icon we get a window with the contents of RAM memory of a microcontroller.
By clicking on this icon, window with SFR register appears. Since SFR registers are used in every program, is recommended that in simulator this window is always active.
If a program contains variables whose values we need to keep track of (ex. counter), a window needs to b added for each of them, which is done by using this icon.
When certain errors in a program are noticed during simulation process, program has to be corrected. Sinc simulator uses HEX file as its input, so we need to translate a program again so that all changes would be transferred to a simulator. By clicking on this icon, entire project is translated again, and we get the newes version of HEX file for the simulator.
156
Appendix B
MicroCODE STUDIO
Introduction B.1 B.2 B.3 B.4 B.5 Installation of the PIC Basic Pro compiler Installation of a MicroCODE studio Connecting MicroCODE Studio and PBP compiler Connecting MicroCODE Studio and the programmer Code writing and compilation in MicroCODE studio
Introduction
Although the code writing can be done with the simplest editor and compiled in command line (those who had programmed in DOS probably remember well those acrobatics) using special editors appropriate for programming language is far better. Such specialized editors are called Integrated Development Environments - IDE. Using them makes code writing easier as the programmer is able to supervise which variables, labels or similar program elements have already been used. At the same time, they make command words bold and even write them in another color rendering thereby program more intelligible. The option for automatic call up of the programmer is also available together with many other facilities. Simply put, h aving those facilities without using them is like climbing on foot to the 13th floor of a building with elevator.
157
The first window after the installation starts. It is necessary to click on button Next
Next question is whether you accept the license and copyright rules or not. By accepting these rules by clicking on the Yes button, the installation goes forward. The next image corresponds to that phase of the installation.
158
The directory for editor location is the next question. In case of failed statement of the directory, the installation is to be effectuated in C:\ProgramFiles\Mecaniqe.
The choice of an installation directory. The best choice is to leave the option by default. It is necessary to click on OK button in order to proceed
159
The name and address of directory is without any special meaning for further programming. The real issue is the available memory space on the hard disk or on the need for keeping all items associated with a single program in the same directory. The next question refers to the name of programming group. The name already offered corresponds to the program name so it should be left as such.
The program group is to be named MicroCodeStudio. Clicking on Next, the installation goes on
160
161
To connect MicroCode Studio and PBP compiler a new window is to be opened. Its done by clicking on the Options from the View menu. If the compiler is already copied into a hard disk directory clicking on the Find Automatically button whereupon will the program itself search for the directory with compiler through the hard disk. When the program finds the compiler, above the button the path C:\PBP will appear above the button Find Automatically.
162
Connecting MicroCode studio and PBP compiler. If the PBP compiler is already copied into a directory on a hard disk, it is enough to click on the Find Automatically button and the program will find it on its own
Beside the path to the compiler, it is still necessary to define the path to the include data file. By clicking on Add the paths C:/PBP and C:/PBP/inc are added within Includes.
163
Include data files are necessary for successful compilation of the program. Clicking the Add, the new window appears with the inc directory into which the PBP compiler is copied
164
Options window after setting the path to the compiler and include data files. Notice that there areinclude data files in the very C: \PBP directory so that their path should be specified as well
This step finishes the setting part referring to the compiler. MicroCode studio is now ready for program reading and compiling.
The setting of the programmer starts by clicking on Programmers whereupon two distinct options appear, one for adding of programmer into the list and another for their removal. The programmer that is to be used here
165
ranks as the simplest economic programmers of PIC microcontrollers that are available at the moment. The name of this programmer is ICprog and it uses the serial pin of the computers port in order to communicate with the microcontroller (more details can be found in the special appendix contained in this book).
Before installing the programmer, it has to be copied in a directory on the hard disc, e.g. C: Programmer. \ Clicking the Add new Programmer, the brief procedure of selecting the path to programmer begins. The first step is writing the name of the programmer or any abbreviation that could bear resemblance to it. As Icprog programmer is used it is logical to name it ICprog.
166
In this option the name of the programmer is to be written. It can well be any of the names bearing resemblance to the programmer we wish to install
The next step is the writing of the exact name of the programmer. It is very important not to make any mistake; otherwise the program will not be able to locate it on a hard disk.
In this option, the exact name of the executive data file of the programmer is to be indicated. In this case its icprog.exe
Finally, by clicking on Find Automatically, the program then finds on its own the path towards the programmer.
167
By clicking on Find Automatically the program finds the path to the programmer on its own
Option to define additional parameters is next. Nevertheless, it is to be omitted due to the fact that it will be used in a later phase of the operation when the longer programs are written and the program name is not changed very often. Clicking on Finished overrides this option.
The option to define the additional parameters of the programmer is not to be used here; therefore it is to be omitted by clicking on Finished
The window Option out of the View menu with the set parameters for the compiler and the programmer now looks like exactly as on the image bellow. Thereby all relevant settings of the MicroCode Studio are finished.
168
Window Option with all the parameters for the compiler and the programmer set
Besides the setting of the compiler and the programmer, there are somewhat less important settings as that of an editor. Since those parameters are already well set we will not take them into consideration now.
169
The menu line contains all standard submenus as File, Edit, Search, View and Help. The toolbar contains but a few basic icons and their purpose we will not explain in details. What separates the MicroCode studio from the other development environments is its simplicity and legibility. Its most important part is located in the left part by the name Code Explorer. When necessary, that part of the window can be shut down by clicking on View Code Explorer although it is recommended to leave it as it is for it contributes to the better legibility and organization of the program. The code writing is done in the right part of the window. The process of code writing itself is largely facilitated by thickening of the commands, and by the excellent solution for the complicated commands with the greater number of parameters as button
170
command is. Namely, after writing of this command and the first empty (blank) character, the yellow frame with all parameters of the respective command appear.
Upon having written the code, by clicking on icon Compile Only (in triangular shape on the right side) the compilation of program starts. If an error occurs, its reported in a special part at the bottom of the window. By clocking on Error, the cursor is positioned exactly at the row in which the error occurred. After correction, the program is compiled as long as the compilation process becomes successful. If the programmer is already configured, then the icon right next to the Compile Only can be used instead, which will, upon a successfully accomplished compilation, call the programmer.
171
Clicking on the icon in the port form, the special window for examining the serial connection with the microcontroller opens. The Serial communication window serves for the serial communication between PC and the microcontroller. An additional option exists which enables the change of all the transfer parameters such as the port on which the microcontroller is attached, the transfer rate or the transfer format.
172