MikroBasic PRO For PIC User Manual V100 V101

User Manual:

Open the PDF directly: View PDF .
Page Count: 578 [warning: Documents this large are best viewed by clicking the View PDF Link!]

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

DISCLAIMER:

mikroBASIC PRO for PIC and this manual are owned by mikroElektronika and are pro-

tected by copyright law and international copyright treaty. Therefore, you should treat this

manual like any other copyrighted material (e.g., a book). The manual and the compiler

may not be copied, partially or as a whole without the written consent from the mikroEelk-

tronika. The PDF-edition of the manual can be printed for private or local use, but not for

distribution. Modifying the manual or the compiler is strictly prohibited.

HIGH RISK ACTIVITIES:

The mikroBASIC PRO for PICcompiler is not fault-tolerant and is not designed, manufac-

tured or intended for use or resale as on-line control equipment in hazardous environments

requiring fail-safe performance, such as in the operation of nuclear facilities, aircraft navigation

or communication systems, air traffic control, direct life support machines, or weapons sys-

tems, in which the failure of the Software could lead directly to death, personal injury, or severe

physical or environmental damage ("High Risk Activities"). mikroElektronika and its suppliers

specifically disclaim any express or implied warranty of fitness for High Risk Activities.

LICENSE AGREEMENT:

By using the mikroBASIC PRO for PIC compiler, you agree to the terms of this agreement.

Only one person may use licensed version of mikroBASIC PRO for PIC compiler at a time.

This manual covers mikroBASIC PRO for PIC version 1.0 and the related topics. Newer

versions may contain changes without prior notice.

COMPILER BUG REPORTS:

The compiler has been carefully tested and debugged. It is, however, not possible to

guarantee a 100 % error free product. If you would like to report a bug, please contact us at

the address office@mikroe.com. Please include next information in your bug report:

- Your operating system

- Version of mikroBASIC PRO for PIC

- Code sample

- Description of a bug

mikroElektronika

Voice: + 381 (11) 36 28 830

Fax: + 381 (11) 36 28 831

Web: www.mikroe.com

E-mail: office@mikroe.com

Reader’s note

Windows is a Registered trademark of Microsoft Corp. All other trade and/or services marks

are the property of the respective owners.

April 2009.

iii

Table of Contents

CHAPTER 1 Introduction

CHAPTER 2 mikroBASIC PRO for PIC Environment

CHAPTER 3 mikroICD (In-Circuit Debugger)

CHAPTER 4 mikroBASIC PRO for PIC Specifics

CHAPTER 5 PIC Specifics

CHAPTER 6 mikroBASIC PRO for PIC Language Reference

CHAPTER 7 mikroBASIC PRO for PIC Libraries

CHAPTER 1

Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Where to Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

mikroElektronika Associates License Statement and Limited Warranty . . . . . 4

IMPORTANT - READ CAREFULLY . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

LIMITED WARRANTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

HIGH RISK ACTIVITIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

GENERAL PROVISIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

How to Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Who Gets the License Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

How to Get License Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

After Receving the License Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

CHAPTER 2

IDE Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Main Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

File Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Edit Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Find Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Replace Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Find In Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Go To Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Regular expressions option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

View Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

File Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Edit Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Advanced Edit Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Find/Replace Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Project Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Build Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Build Toolbar come . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

iv MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Styles Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Tools Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Project Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Run Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Tools Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Help Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

IDE Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Customizing IDE Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Docking Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Saving Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Auto Hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Advanced Code Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Advanced Editor Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Code Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Code Folding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Parameter Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Code Templates (Auto Complete) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Auto Correct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Spell Checker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Bookmarks m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Goto Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Also, the Code Edito . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Code Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Routine List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Project Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Project Settings Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Library Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Error Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

STatisticS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Memory Usage Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

RAM Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Used RAM Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

SFR Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

ROM Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ROM Memory Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Functions Sorted By Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Functions Sorted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Sorts and displays functi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Functions Sorted By Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Functions Sorted By Name Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Sorts and displays functions by their names in a ch . . . . . . . . . . . . . . . 55

Functions Sorted By Size Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Functions Sorted By Addresses Chart . . . . . . . . . . . . . . . . . . . . . . . . . 56

Function Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Memory Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Displays summary of RAM and ROM m . . . . . . . . . . . . . . . . . . . . . . . . 57

Integrated Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

USART Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

EEPROM Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

ASCII Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Seven Segment Decoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Lcd Custom Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

mikroBasic PRO for PIC includes the L . . . . . . . . . . . . . . . . . . . . . . . . 61

Graphic LCD Bitmap Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

HID Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

The mikroBasic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Udp Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

The mikroBasic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

mikroBootloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

What is a Bootloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Macro Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Code editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Output settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Simple matches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

vi MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Escape sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Character classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Metacharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Metacharacters - Line separators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Metacharacters - Predefined classes . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Metacharacters - Word boundaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Metacharacters - Iterators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Metacharacters - Alternatives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Metacharacters - Subexpressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Metacharacters - Backreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

mikroBasic PRO for PIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

New Project Wizard Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Customizing Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Managing Project Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Add/Remove Files from Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Project Level Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Source Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Managing Source Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Creating new source file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Opening an existing file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Printing an open file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Saving file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Saving file under a different name . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Closing file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Clean Project Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Output Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Assembly View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Compiler Error Messages: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Warning Messages: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Hint Messages: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Software Simulator Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

vii

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Breakpoints Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

View RAM Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Stopwatch Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Software Simulator Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Creating New Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Multiple Library Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

mikroICD (In-Circuit Debugger) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

CHAPTER 3

mikroICD Debugger Optional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

mikroICD Debugger Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

mikroICD (In-Circuit Debugger) Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Breakpoints Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Watch Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Debugger Watch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

EEPROM Watch Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Code Watch Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

View RAM Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Common Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

mikro ICD Advanced Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Program Memory Break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

File Register Break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Emulator Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Event Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Stopwatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

CHAPTER 4

BASIC Standard Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Divergence from the Basic Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Basic Language Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Predefined Globals and Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

SFRs and related constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

All PIC SFRs are implicitly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

These defines are based on a valu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

viii MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Accessing Individual Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Accessing Individual Bits Of Variables . . . . . . . . . . . . . . . . . . . . . . . . . 114

sbit type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

bit type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Interrupts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Linker Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Directive absolute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Directive org . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Built-in Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Lo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Hi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Higher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Highest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Inc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Dec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Delay_us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Delay_ms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Clock_KHz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Clock_MHz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

ClrWdt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

DisableContextSaving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

SetFuncCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

GetDateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

GetVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Code Optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Optimizer has been . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

CHAPTER 5

Types Efficiency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Nested call represents a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

PIC18FxxJxx Specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Shared Address SFRs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

PIC16 Specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Breaking Through Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Limits of Indirect Approach Through FSR . . . . . . . . . . . . . . . . . . . . . . . 131

Memory Type Specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

rx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

sfr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

CHAPTER 6

Lexical Elements Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Whitespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Newline Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Whitespace in Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Integer Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Floating Point Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Character Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Case Sensitivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Uniqueness and Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Identifier Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Punctuators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Brackets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Parentheses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Comma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Colon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Program Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Organization of Main Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Organization of Other Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Scope and Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

xMIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

mikroBasic PRO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Main Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Every project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Modules other . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Implementation Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

External Modifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Variables and PIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Functions and Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Calling a function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Calling a procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Function Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Forward declaration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Functions reentrancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Type Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Simple Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Array Declaration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Constant Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

POINTERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Structure Member Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Types Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Implicit Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Promotion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Clipping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Explicit Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Operators Precedence and Associativity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Arithmetic Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Division by Zero . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Unary Arithmetic Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Relational Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Relational Operators in Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Bitwise Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Bitwise Operators Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Unsigned and Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Signed and Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Bitwise Shift Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

BoOlean Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Assignment Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Conditional Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

If Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Nested if statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

SELECT Case statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Iteration Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

For Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Endless Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

While Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Do Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

The do stateme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Jump Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Break and Continue Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Break Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Continue Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Exit Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Goto Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Gosub Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

asm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

xii MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Compiler Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Directives #DEFINE and #UNDEFINE . . . . . . . . . . . . . . . . . . . . . . . . . 193

Directives #IFDEF, $IFNDEF, #ELSEIF and #ELSE . . . . . . . . . . . . . . 194

Predefined Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Linker Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Directive absolute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Directive org . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

CHAPTER 7

Hardware PIC-specific Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Miscellaneous Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Library Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Hardware Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

ADC Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

ADC_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

CAN Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

CANSetOperationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

CANGetOperationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

CANInitialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

CANSetBaudRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

CANSetMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

CANSetFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

CANRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

CANWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

CAN Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

CAN_OP_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

CAN_CONFIG_FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

CAN_TX_MSG_FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

CAN_RX_MSG_FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

xiii

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

CAN_MASK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

CAN_FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

CANSPI Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

External dependecies of CANSPI Library . . . . . . . . . . . . . . . . . . . . . . . 220

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPISetOperationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPIGetOperationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPIInitialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPISetBaudRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPISetMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPISetFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPIread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPIWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

CANSPISetOperationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

CANSPIGetOperationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

CANSPIInitialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

CANSPISetBaudRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

CANSPISetMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

CANSPISetFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

CANSPIRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

CANSPIWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

CANSPI Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

CANSPI_OP_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

CANSPI_CONFIG_FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

CANSPI_TX_MSG_FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

CANSPI_RX_MSG_FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

CANSPI_MASK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

CANSPI_FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Compact Flash Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

External dependencies of Compact Flash Library . . . . . . . . . . . . . . . . 236

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Cf_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

xiv MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Cf_Detect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Cf_Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Cf_Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Cf_Read_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Cf_Read_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Cf_Write_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Cf_Write_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Cf_Read_Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Cf_Write_Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Cf_Fat_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Cf_Fat_QuickFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Cf_Fat_Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Cf_Fat_Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Cf_Fat_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Cf_Fat_Rewrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Cf_Fat_Append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Cf_Fat_Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Cf_Fat_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Cf_Fat_Set_File_Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Cf_Fat_Get_File_Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Cf_Fat_Get_File_Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Cf_Fat_Get_Swap_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

EEPROM Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

EEPROM_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

EEPROM_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Ethernet_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Ethernet_Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Ethernet_Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Ethernet_doPacket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Ethernet_putByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Ethernet_putBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Ethernet_putConstBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Ethernet_putString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Ethernet_putConstString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Ethernet_getByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Ethernet_getBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

Ethernet_UserTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Ethernet_UserUDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Ethernet_getIpAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Ethernet_getGwIpAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Ethernet_getDnsIpAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Ethernet_getIpMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Ethernet_confNetwork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Ethernet_arpResolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Ethernet_sendUDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Ethernet_dnsResolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Ethernet_initDHCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Ethernet_doDHCPLeaseTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Ethernet_renewDHCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

Flash Memory Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

FLASH_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

FLASH_Read_N_Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

FLASH_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

FLASH_Erase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

FLASH_Erase_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Graphic LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

External dependencies of Graphic LCD Library . . . . . . . . . . . . . . . . . . 296

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Glcd_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Glcd_Set_Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Glcd_Set_X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Glcd_Set_Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

Glcd_Read_Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

Glcd_Write_Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

xvi MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Glcd_Fill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

Glcd_Dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Glcd_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Glcd_V_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Glcd_H_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Glcd_Rectangl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Glcd_Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Glcd_Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

Glcd_Set_Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

Glcd_Write_Char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Glcd_Write_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Glcd_Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Glcd HW connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

I˛C Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

2C1_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

I2C1_Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

I2C1_Repeated_Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

I2C1_Is_Idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

I2C1_Rd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

I2C1_Wr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

I2C1_Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

Keypad Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

External dependencies of Keypad Library . . . . . . . . . . . . . . . . . . . . . . . 316

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Keypad_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Keypad_Key_Press . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Keypad_Key_Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Keypad_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Keypad_Key_Press . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Keypad_Key_Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

xvii

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

External dependencies of LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . 321

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Lcd_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Lcd_Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Lcd_Out_Cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Lcd_Chr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

Lcd_Chr_Cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

Lcd_Cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Available LCD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

LCD HW connecti . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Manchester Code Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

External dependencies of Manchester Code Library . . . . . . . . . . . . . . 329

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Man_Receive_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Man_Receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Man_Send_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Man_Send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

Man_Synchro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

Man_Break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

Connection Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Multi Media Card Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

External dependencies of MMC Library . . . . . . . . . . . . . . . . . . . . . . . . 339

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Read_Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Write_Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Read_Cid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Read_Csd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Routines for file handling: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_QuickFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

xviii MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Mmc_Fat_Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Rewrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Set_File_Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Get_File_Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Get_File_Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Fat_Get_Swap_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Mmc_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

Mmc_Read_Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

Mmc_Write_Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Mmc_Read_Cid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

Mmc_Read_Csd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

Mmc_Fat_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

Mmc_Fat_QuickFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

Mmc_Fat_Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

Mmc_Fat_Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Mmc_Fat_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Mmc_Fat_Rewrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Mmc_Fat_Append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Mmc_Fat_Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Mmc_Fat_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Mmc_Fat_Set_File_Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

Mmc_Fat_Get_File_Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Mmc_Fat_Get_File_Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Mmc_Fat_Get_Swap_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

OneWire Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Ow_Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Ow_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Ow_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

xix

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Ow_Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

Ow_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

Ow_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Port Expander Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

External dependencies of Port Expander Library . . . . . . . . . . . . . . . . . 363

Library Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Read_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Write_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Read_PortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Read_PortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Read_PortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Write_PortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Write_PortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Write_PortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Set_DirectionPortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Set_DirectionPortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Set_DirectionPortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Set_PullUpsPortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Set_PullUpsPortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Set_PullUpsPortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Expander_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Expander_Read_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Expander_Write_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Expander_Read_PortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

Expander_Read_PortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

Expander_Read_PortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Expander_Write_PortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Expander_Write_PortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

Expander_Write_PortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

Expander_Set_DirectionPortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

Expander_Set_DirectionPortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

Expander_Set_DirectionPortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

Expander_Set_PullUpsPortA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

xx MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Expander_Set_PullUpsPortB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

Expander_Set_PullUpsPortAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

PS/2 Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

External dependencies of PS/2 Library . . . . . . . . . . . . . . . . . . . . . . . . . 374

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Ps2_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Ps2_Key_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Ps2_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Ps2_Key_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Special Function Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

PWM Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

PWM1_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

PWM1_Set_Duty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

PWM1_Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

PWM1_Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

RS-485 Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

External dependencies of RS-485 Library . . . . . . . . . . . . . . . . . . . . . . . 384

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

RS485master_Receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

RS485master_Send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

RS485slave_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

RS485slave_Receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

RS485slave_Send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Software I˛C Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

External dependecies of Soft_I2C Library . . . . . . . . . . . . . . . . . . . . . . . 394

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

Soft_I2C_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

xxi

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Soft_I2C_Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

Soft_I2C_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Soft_I2C_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Soft_I2C_Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

Soft_I2C_Break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

LLibrary Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Software SPI Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

External dependencies of Software SPI Library . . . . . . . . . . . . . . . . . . 401

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

Soft_Spi_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

Soft_Spi_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

Soft_Spi_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

Software UART Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Soft_Uart_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Soft_UART_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Soft_Uart_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Soft_UART_Break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

Sound Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Sound_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Sound_Play . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Sound_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Sound_Play . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

The example is a simple dem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Example of Sound Library sonnection . . . . . . . . . . . . . . . . . . . . . . . . . . 413

SPI Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

SPI1_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

_LOW_2_HIGH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_CLK_IDLE_LOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_CLK_IDLE_HIGH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

xxii MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

_DATA_SAMPLE_END . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_DATA_SAMPLE_MIDDLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_SLAVE_SS_ENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_MASTER_TMR2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_MASTER_OSC_DIV64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_MASTER_OSC_DIV16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

_MASTER_OSC_DIV4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

Spi1_Init_Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

Spi1_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Spi1_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

SPI_Set_Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

The code demonstrates how to u . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

SPI HW connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

SPI Ethernet Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

SPI_Ethernet_RST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

SPI_Ethernet_CS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

External dependencies of SPI Ethernet Library . . . . . . . . . . . . . . . . . . 420

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

SPI_Ethernet_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

SPI_Ethernet_Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

SPI_Ethernet_Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

SPI_Ethernet_doPacket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

SPI_Ethernet_putByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

SPI_Ethernet_putBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

SPI_Ethernet_putConstBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

SPI_Ethernet_putString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

SPI_Ethernet_putConstString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

SPI_Ethernet_getByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

SPI_Ethernet_getBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

SPI_Ethernet_UserTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

SPI_Ethernet_UserUDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

SPI Graphic LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

xxiii

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

External dependencies of SPI Graphic LCD Library . . . . . . . . . . . . . . . 440

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

SPI_Glcd_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

SPI_Glcd_Set_Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

SPI_Glcd_Set_Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

SPI_Glcd_Set_X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

SPI_Glcd_Read_Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

SPI_Glcd_Write_Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

SPI_Glcd_Fill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

SPI_Glcd_Dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

SPI_Glcd_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

SPI_Glcd_V_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

SPI_Glcd_H_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

SPI_Glcd_Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

SPI_Glcd_Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

SPI_Glcd_Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

SPI_Glcd_Set_Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

SPI_Glcd_Write_Char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

SPI_Glcd_Write_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

SPI_Glcd_Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

SPI LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

External dependencies of SPI LCD Library . . . . . . . . . . . . . . . . . . . . . . 455

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

SPI_Lcd_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

SPI_Lcd_Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

SPI_Lcd_Out_Cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

SPI_Lcd_Chr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

SPI_Lcd_Chr_Cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

SPI_Lcd_Cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

Available LCD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

SPI LCD8 (8-bit interface) Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

External dependencies of SPI LCD Library . . . . . . . . . . . . . . . . . . . . . . 462

xxiv MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

SPI_Lcd8_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

SPI_Lcd8_Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

SPI_Lcd8_Out_Cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

SPI_Lcd8_Chr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

SPI_Lcd8_Chr_Cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

SPI_Lcd8_Cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

Available LCD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

SPI T6963C Graphic LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

External dependencies of SPI T6963C Graphic Lcd Library . . . . . . . . 469

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

SPI_T6963C_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

SPI_T6963C_WriteData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

SPI_T6963C_WriteCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

SPI_T6963C_SetPtr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

SPI_T6963C_WaitReady . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

SPI_T6963C_Fill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

SPI_T6963C_Dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

SPI_T6963C_Write_Char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

SPI_T6963C_Write_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476

SPI_T6963C_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

SPI_T6963C_Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

SPI_T6963C_Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

SPI_T6963C_Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

SPI_T6963C_Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

SPI_T6963C_Sprite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

SPI_T6963C_Set_Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

SPI_T6963C_ClearBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

SPI_T6963C_SetBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

SPI_T6963C_NegBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

SPI_T6963C_DisplayGrPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

SPI_T6963C_DisplayTxtPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

SPI_T6963C_SetGrPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

SPI_T6963C_SetTxtPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

xxv

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

SPI_T6963C_PanelFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

SPI_T6963C_GrFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

SPI_T6963C_TxtFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

SPI_T6963C_Cursor_Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

SPI_T6963C_Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

SPI_T6963C_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

SPI_T6963C_Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485

SPI_T6963C_Cursor_Blink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

T6963C Graphic LCD Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

External dependencies of T6963C Graphic LCD Library . . . . . . . . . . . 491

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

T6963C_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

T6963C_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

T6963C_WriteData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

T6963C_WriteCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

T6963C_SetPtr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

T6963C_WaitReady . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

T6963C_Fill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

T6963C_Dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

T6963C_Write_Char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497

T6963C_Write_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498

T6963C_Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

T6963C_Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

T6963C_Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

T6963C_Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

T6963C_Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

T6963C_Sprite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

T6963C_Set_Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

T6963C_DisplayGrPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

T6963C_DisplayTxtPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

T6963C_SetGrPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

T6963C_SetTxtPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

T6963C_PanelFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

xxvi MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

T6963C_GrFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

T6963C_TxtFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

T6963C_Cursor_Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

T6963C_Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

T6963C_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

T6963C_Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

T6963C_Cursor_Blink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

UART Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

UART1_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

UART1_Data_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

UART1_Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

UART1_Data_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

UART1_Tx_Idle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

UART1_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

UART1_Read_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

UART1_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

UART1_Write_Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

UART_Set_Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

UART HW connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

USB HID Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Descriptor File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Hid_Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Hid_Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Hid_Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Hid_Disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

HW Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

Miscellaneous Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

Button Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

The Button libra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

xxvii

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

Conversions Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525

ByteToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

ShortToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

WordToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

IntToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

LongintToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

LongWordToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

FloatToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

StrToInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

StrToWord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

Dec2Bcd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

Bcd2Dec16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

Dec2Bcd16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

Math Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

Library Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

acos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

asin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

atan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

atan2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

ceil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

cos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

cosh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

eval_poly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

exp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

fabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

floor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

frexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

ldexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

log10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

modf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

pow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

sin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

sinh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

sqrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

xxviii MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

tan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

tanh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

String Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

Library Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

memchr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537

memcmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537

memcpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

memmove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

memset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

strcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

strchr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539

strcmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539

strcpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539

strcspn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539

strlen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

strncat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

strncmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

strncpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

strpbrk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

strrchr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

strspn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

strstr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

Time Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542

Time_dateToE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542

Time_epochToDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

Time_dateDiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

Library Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544

TimeStruct type definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545

Trigonometry Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

Library Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

sinE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

cosE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547

xxix

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Table of Contents

xxx MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC

Table of Contents

Introduction to

mikroBasic PRO for PIC

The mikroBasic PRO for PIC is a powerful, feature-rich development tool for PIC

microcontrollers. It is designed to provide the programmer with the easiest possi-

ble solution to developing applications for embedded systems, without compromis-

ing performance or control.

CHAPTER

2MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Introduction mikroBasic PRO for PIC

CHAPTER 1

mikroBasic PRO for PIC IDE

Features

mikroBasic PRO for PIC allows you to quickly develop and deploy complex applications:

Write your Basic source code using the built-in Code Editor (Code and Parame

ter Assistants, Code Folding, Syntax Highlighting, Spell Checker, Auto Correct,

Code Templates, and more.)

Use included mikroBasic PRO libraries to dramatically speed up the develop

ment: data acquisition, memory, displays, conversions, communication etc.

Monitor your program structure, variables, and functions in the Code Explorer.

Generate commented, human-readable assembly, and standard HEX compati

ble with all programmers.

Use the integrated mikroICD (In-Circuit Debugger) Real-Time debugging tool to

monitor program execution on the hardware level.

Inspect program flow and debug executable logic with the integrated Software

Simulator.

Get detailed reports and graphs: RAM and ROM map, code statistics, assembly

isting, calling tree, and more.

mikroBasic PRO for PIC provides plenty of examples to expand, develop, and

use as building bricks in your projects. Copy them entirely if you deem fit – that’s

why we included them with the compiler.

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Introduction

CHAPTER 1

Where to Start

In case that you’re a beginner in programming PIC microcontrollers, read

carefully th PIC Specifics chapter. It might give you some useful pointers on

PIC constraints, code portability, and good programming practices.

If you are experienced in Basic programming, you will probably want to con

sult mikroBasic PRO for PIC Specifics first. For language issues, you can

always refer to the comprehensive Language Reference. A complete list of

included libraries is available at mikroBasic PRO for PIC Libraries.

If you are not very experienced in Basic programming, don’t panic! mikroBa

sic PRO for PIC provides plenty of examples making it easy for you to go

quickly. We suggest that you first consult Projects and Source Files, and

then start browsing the examples that you're the most interested in.

4MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Introduction mikroBasic PRO for PIC

CHAPTER 1

MIKROELEKTRONIKA ASSOCIATES LICENSE STATEMENT AND

LIMITED WARRANTY

IMPORTANT - READ CAREFULLY

This license statement and limited warranty constitute a legal agreement (“License

Agreement”) between you (either as an individual or a single entity) and mikroElek-

tronika (“mikroElektronika Associates”) for software product (“Software”) identified

above, including any software, media, and accompanying on-line or printed docu-

mentation.

BY INSTALLING, COPYING, OR OTHERWISE USING SOFTWARE, YOU AGREE

TO BE BOUND BY ALL TERMS AND CONDITIONS OF THE LICENSE

AGREEMENT.

Upon your acceptance of the terms and conditions of the License Agreement,

mikroElektronika Associates grants you the right to use Software in a way provided

below.

This Software is owned by mikroElektronika Associates and is protected by copy-

right law and international copyright treaty. Therefore, you must treat this Software

like any other copyright material (e.g., a book).

You may transfer Software and documentation on a permanent basis provided. You

retain no copies and the recipient agrees to the terms of the License Agreement.

Except as provided in the License Agreement, you may not transfer, rent, lease,

lend, copy, modify, translate, sublicense, time-share or electronically transmit or

receive Software, media or documentation. You acknowledge that Software in the

source code form remains a confidential trade secret of mikroElektronika Associates

and therefore you agree not to modify Software or attempt to reverse engineer,

decompile, or disassemble it, except and only to the extent that such activity is

expressly permitted by applicable law notwithstanding this limitation.

If you have purchased an upgrade version of Software, it constitutes a single prod-

uct with the mikroElektronika Associates software that you upgraded. You may use

the upgrade version of Software only in accordance with the License Agreement.

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Introduction

CHAPTER 1

LIMITED WARRANTY

Respectfully excepting the Redistributables, which are provided “as is”, without war-

ranty of any kind, mikroElektronika Associates warrants that Software, once updat-

ed and properly used, will perform substantially in accordance with the accompany-

ing documentation, and Software media will be free from defects in materials and

workmanship, for a period of ninety (90) days from the date of receipt. Any implied

warranties on Software are limited to ninety (90) days.

mikroElektronika Associates’ and its suppliers’ entire liability and your exclusive

remedy shall be, at mikroElektronika Associates’ option, either (a) return of the price

paid, or (b) repair or replacement of Software that does not meet mikroElektronika

Associates’ Limited Warranty and which is returned to mikroElektronika Associates

with a copy of your receipt. DO NOT RETURN ANY PRODUCT UNTIL YOU HAVE

CALLED MIKROELEKTRONIKA ASSOCIATES FIRST AND OBTAINED A RETURN

AUTHORIZATION NUMBER. This Limited Warranty is void if failure of Software has

resulted from an accident, abuse, or misapplication. Any replacement of Software

will be warranted for the rest of the original warranty period or thirty (30) days,

whichever is longer.

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,

MIKROELEKTRONIKA ASSOCIATES AND ITS SUPPLIERS DISCLAIM ALL

OTHER WARRANTIES AND CONDITIONS, EITHER EXPRESSED OR IMPLIED,

INCLUDED, BUT NOT LIMITED TO IMPLIED WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND

NON-INFRINGEMENT, WITH REGARD TO SOFTWARE, AND THE PROVISION

OF OR FAILURE TO PROVIDE SUPPORT SERVICES.

IN NO EVENT SHALL MIKROELEKTRONIKA ASSOCIATES OR ITS SUPPLIERS

BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL

DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES

FOR LOSS OF BUSINESS PROFITS AND BUSINESS INFORMATION, BUSINESS

INTERRUPTION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE

USE OF OR INABILITY TO USE SOFTWARE PRODUCT OR THE PROVISION OF

OR FAILURE TO PROVIDE SUPPORT SERVICES, EVEN IF

MIKROELEKTRONIKA ASSOCIATES HAS BEEN ADVISED OF THE POSSIBILITY

OF SUCH DAMAGES. IN ANY CASE, MIKROELEKTRONIKA ASSOCIATES’

ENTIRE LIABILITY UNDER ANY PROVISION OF THIS LICENSE AGREEMENT

SHALL BE LIMITED TO THE AMOUNT ACTUALLY PAID BY YOU FOR

SOFTWARE PRODUCT PROVIDED, HOWEVER, IF YOU HAVE ENTERED INTO

A MIKROELEKTRONIKA ASSOCIATES SUPPORT SERVICES AGREEMENT,

MIKROELEKTRONIKA ASSOCIATES’ ENTIRE LIABILITY REGARDING

SUPPORT SERVICES SHALL BE GOVERNED BY THE TERMS OF THAT

AGREEMENT.

6MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Introduction mikroBasic PRO for PIC

CHAPTER 1

HIGH RISK ACTIVITIES

Software is not fault-tolerant and is not designed, manufactured or intended for use

or resale as on-line control equipment in hazardous environments requiring fail-safe

performance, such as in the operation of nuclear facilities, aircraft navigation or

communication systems, air traffic control, direct life support machines, or weapons

systems, in which the failure of Software could lead directly to death, personal injury,

or severe physical or environmental damage (“High Risk Activities”). mikroElektron-

ika Associates and its suppliers specifically disclaim any expressed or implied war-

ranty of fitness for High Risk Activities.

GENERAL PROVISIONS

This statement may only be modified in writing signed by you and an authorised offi-

cer of mikroElektronika Associates. If any provision of this statement is found void

or unenforceable, the remainder will remain valid and enforceable according to its

terms. If any remedy provided is determined to have failed for its essential purpose,

all limitations of liability and exclusions of damages set forth in the Limited Warran-

ty shall remain in effect.

This statement gives you specific legal rights; you may have others, which vary, from

country to country. mikroElektronika Associates reserves all rights not specifically

granted in this statement.

mikroElektronika

Visegradska 1A,

11000 Belgrade,

Europe.

Phone: + 381 11 36 28 830

Fax: +381 11 36 28 831

Web: www.mikroe.com

E-mail: office@mikroe.com

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Introduction

CHAPTER 1

TECHNICAL SUPPORT

In case you encounter any problem, you are welcome to our support forums at

www.mikroe.com/forum/. Here, you may also find helpful information, hardware tips,

and practical code snippets. Your comments and suggestions on future develop-

ment of the mikroBasic PRO for PIC are always appreciated — feel free to drop a

note or two on our Wishlist.

In our Knowledge Base www.mikroe.com/en/kb/ you can find the answers to Fre-

quently Asked Questions and solutions to known problems. If you can not find the

solution to your problem in Knowledge Base then report it to Support Desk

www.mikroe.com/en/support/. In this way, we can record and track down bugs more

efficiently, which is in our mutual interest. We respond to every bug report and ques-

tion in a suitable manner, ever improving our technical support

8MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Introduction mikroBasic PRO for PIC

CHAPTER 1

How to Register

The latest version of the mikroBasic PRO for PIC is always available for download-

ing from our website. It is a fully functional software libraries, examples, and com-

prehensive help included.

The only limitation of the free version is that it cannot generate hex output over 2

KB. Although it might sound restrictive, this margin allows you to develop practical,

working applications with no thinking of demo limit. If you intend to develop really

complex projects in the mikroBasic PRO for PIC, then you should consider the pos-

sibility of purchasing the license key.

Who Gets the License Key

Buyers of the mikroBasic PRO for PIC are entitled to the license key. After you have

completed the payment procedure, you have an option of registering your mikroBa-

sic PRO. In this way you can generate hex output without any limitations.

How to Get License Key

After you have completed the payment procedure, start the program. Select Help ›

How to Register from the drop-down menu or click the How To Register Icon Fill

out the registration form (figure below), select your distributor, and click the Send button.

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

mikroBasic PRO for PIC Introduction

CHAPTER 1

This will start your e-mail client with message ready for sending. Review the infor-

mation you have entered, and add the comment if you deem it necessary. Please,

do not modify the subject line.

Upon receiving and verifying your request, we will send the license key to the e-mail

address you specified in the form.

10 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Introduction mikroBasic PRO for PIC

CHAPTER 1

After Receving the License Key

The license key comes as a small autoextracting file – just start it anywhere on your

computer in order to activate your copy of compiler and remove the demo limit. You

do not need to restart your computer or install any additional components. Also,

there is no need to run the mikroBasic PRO for PIC at the time of activation.

Notes:

The license key is valid until you format your hard disk. In case you need to

for mat the hard disk, you should request a new activation key.

Please keep the activation program in a safe place. Every time you upgrade

the compiler you should start this program again in order to reactivate the

license.

mikroBasic PRO for PIC

Environment

The mikroBasic PRO for PIC is an user-friendly and intuitive environment:

CHAPTER

12 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Environment mikroBasic PRO for PIC

CHAPTER 2

IDE OVERVIEW

The Code Editor features adjustable Syntax Highlighting, Code Folding,

Code Assistant, Parameters Assistant, Spell Checker, Auto Correct for com

mon typos and Code Templates (Auto Complete).

The Code Explorer is at your disposal for easier project management.

The Project Manager alows multiple project management

General project settings can be made in the Project Settings window

Library manager enables simple handling libraries being used in a project

The Error Window displays all errors detected during compiling and linking.

The source-level Software Simulator lets you debug executable logic step-

by-step by watching the program flow.

The New Project Wizard is a fast, reliable, and easy way to create a project

Help files are syntax and context sensitive.

Like in any modern Windows application, you may customize the layout of

mikroBasic PRO for PIC to suit your needs best.

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Environment

mikroBasic PRO for PIC

CHAPTER 2

Spell checker underlines identifiers which are unknown to the project. In this

way it helps the programmer to spot potential problems early, much before

the project is compiled.

Spell checker can be disabled by choosing the option in the Preferences

dialog (F12).

14 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Environment mikroBasic PRO for PIC

CHAPTER 2

MAIN MENU OPTIONS

Available Main Menu options are:



See also Built-in Routines.

198 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

LIBRARY DEPENDENCIES

Certain libraries use (depend on) function and/or variables, constants defined in

other libraries.

Image below shows clear representation about these dependencies.

For example, SPI_Glcd uses Glcd_Fonts and Port_Expander library which uses SPI

library.

This means that if you check SPI_Glcd library in Library manager, all libraries on

which it depends will be checked too.

199

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Related topics: Library manager, 8051 Libraries

200 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Hardware Libraries

 ADC Library

 CAN Library

 CANSPI Library

 Compact Flash Library

 EEPROM Library

 Ethernet PIC18FxxJ60 Library

 Flash Memory Library

 Graphic Lcd Library

 I2C Library

 Keypad Library

 Lcd Library

 Manchester Code Library

 Multi Media Card library

 OneWire Library

 Port Expander Library

 PS/2 Library

 PWM Library

 RS-485 Library

 Software I2C Library

 Software SPI Library

 Software UART Library

 Sound Library

 SPI Library

 SPI Ethernet Library

 SPI Graphic Lcd Library

 SPI Lcd Library

 SPI Lcd8 Library

 SPI T6963C Graphic Lcd Library

 T6963C Graphic Lcd Library

 UART Library

 USB HID Library

201

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

ADC LIBRARY

ADC (Analog to Digital Converter) module is available with a number of PIC MCUs. Library func-

tion Adc_Read is included to provide you comfortable work with the module.

Library Routines

 ADC_Read

ADC_Read

202 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function ADC_Read(dim channel as byte) as word

Returns 10-bit unsigned value read from the specified channel

Description

Initializes PIC’s internal ADC module to work with RC clock. Clock determines

the time period necessary for performing AD conversion (min 12TAD).

Parameter channel represents the channel from which the analog value is to be

acquired. Refer to the appropriate datasheet for channel-to-pin mapping

Requires Nothing.

Example

dim tmp as word

...

tmp = ADC_Read(2) ' Read analog value from channel 2

Library Example

This example code reads analog value from channel 2 and displays it on PORTB

and PORTC.

program ADC_on_LEDs

dim adc_rd as word

main:

EBDIS_bit = 1 ' set External Bus Disable bit

CMCON = CMCON or 0x07 ' turn off comparators

ADCON1 = ADCON1 or 0x0C ' Set AN2 channel pin as analog

TRISA2_bit = 1 ' input

TRISB = 0x00 ' Set PORTB as output

TRISC = 0x00 ' Set PORTC as output

while (TRUE)

adc_rd = ADC_Read(2) ' get ADC value from 2nd channel

PORTB = adc_rd ' display adc_rd[7..0]

PORTC = Hi(adc_rd) ' display adc_rd[9..8]

wend

end.

HW Connection

ADC HW connection

203

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CAN LIBRARY

mikroBasic provides a library (driver) for working with the CAN module.

CAN is a very robust protocol that has error detection and signalling, self–checking

and fault confinement. Faulty CAN data and remote frames are re-transmitted auto-

matically, similar to the Ethernet.

Data transfer rates vary from up to 1 Mbit/s at network lengths below 40m to 250

Kbit/s at 250m cables, and can go even lower at greater network distances, down

to 200Kbit/s, which is the minimum bitrate defined by the standard. Cables used are

shielded twisted pairs, and maximum cable length is 1000m.

CAN supports two message formats:

 Standard format, with 11 identifier bits, and

 Extended format, with 29 identifier bits

Note: Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Library Routines

 CANSetOperationMode

 CANGetOperationMode

 CANInitialize

 CANSetBaudRate

 CANSetMask

 CANSetFilter

 CANRead

 CANWrite

Following routines are for the internal use by compiler only:

 RegsToCANID

 CANIDToRegs

Be sure to check CAN constants necessary for using some of the functions

204 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

205

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CANSetOperationMode

CANGetOperationMode

Prototype sub procedure CANSetOperationMode(dim mode, wait_flag as byte)

Returns Nothing.

Description

Sets CAN to requested mode, i.e. copies mode to CANSTAT. Parameter mode

needs to be one of CAN_OP_MODE constants (see CAN constants).

Parameter wait_flag needs to be either 0 or $FF:

 If set to $FF, this is a blocking call – the function won’t “return” until the

requested mode is set.

 If 0, this is a non-blocking call. It does not verify if CAN module is switched

to requested mode or not.

Caller must use CANGetOperationMode to verify correct operation mode before

performing mode specific operation.

Requires Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example CANSetOperationMode(_CAN_MODE_CONFIG, $FF)

Prototype sub function CANGetOperationMode as byte

Returns Current opmode.

Description Function returns current operational mode of CAN module.

Requires Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example if CANGetOperationMode = _CAN_MODE_NORMAL then

...

CANInitialize

206 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure CANInitialize(dim SJW, BRP, PHSEG1, PHSEG2,

PROPSEG, CAN_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Initializes CAN. All pending transmissions are aborted. Sets all mask registers

to 0 to allow all messages.

Filter registers are set according to flag value:

if (CAN_CONFIG_FLAGS and _CAN_CONFIG_VALID_XTD_ MSG)<> 0

' Set all filters to XTD_MSG

else if (config and _CAN_CONFIG_VALID_STD_MSG) <> 0

' Set all filters to STD_MSG

else

' Set half of the filters to STD, and the rest to XTD_MSG.

Parameters:

 SJW as defined in 18XXX8 datasheet (1–4)

 BRP as defined in 18XXX8 datasheet (1–64)

 PHSEG1 as defined in 18XXX8 datasheet (1–8)

 PHSEG2 as defined in 18XXX8 datasheet (1–8)

 PROPSEG as defined in 18XXX8 datasheet (1–8)

 CAN_CONFIG_FLAGS is formed from predefined constants (see CAN constants)

Requires

CAN must be in Config mode; otherwise the function will be ignored.

Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example

init = _CAN_CONFIG_SAMPLE_THRICE and

_CAN_CONFIG_PHSEG2_PRG_ON and

_CAN_CONFIG_STD_MSG and

_CAN_CONFIG_DBL_BUFFER_ON and

_CAN_CONFIG_VALID_XTD_MSG and

_CAN_CONFIG_LINE_FILTER_OFF

...

CANInitialize(1,1,3,3,1,init) ‘Initialize CAN

CANSetBaudRate

207

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure CANSetBaudRate(dim SJW, BRP, PHSEG1, PHSEG2,

PROPSEG, CAN_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Sets CAN baud rate. Due to complexity of CAN protocol, you cannot simply

force a bps value. Instead, use this function when CAN is in Config mode. Refer

to datasheet for details.

Parameters:

SJW as defined in 18XXX8 datasheet (1–4)

 BRP as defined in 18XXX8 datasheet (1–64)

 PHSEG1 as defined in 18XXX8 datasheet (1–8)

 PHSEG2 as defined in 18XXX8 datasheet (1–8)

 PROPSEG as defined in 18XXX8 datasheet (1–8)

 CAN_CONFIG_FLAGS is formed from predefined constants (see CAN constants)

Requires

CAN must be in Config mode; otherwise the function will be ignored.

Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example

init = _CAN_CONFIG_SAMPLE_THRICE and

_CAN_CONFIG_PHSEG2_PRG_ON and

_CAN_CONFIG_STD_MSG and

_CAN_CONFIG_DBL_BUFFER_ON and

_CAN_CONFIG_VALID_XTD_MSG and

_CAN_CONFIG_LINE_FILTER_OFF

...

CANSetBaudRate (1, 1, 3, 3, 1, init)

CANSetMask

208 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure CANSetMask(dim CAN_MASK as byte, dim value

as longint, dim CAN_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Function sets mask for advanced filtering of messages. Given value is bit

adjusted to appropriate buffer mask registers.

Parameters:

 CAN_MASK is one of predefined constant values (see CAN constants)

 value is the mask register value

 CAN_CONFIG_FLAGS selects type of message to filter, either

_CAN_CONFIG_XTD_MSG or _CAN_CONFIG_STD_MSG

Requires

CAN must be in Config mode; otherwise the function will be ignored.

Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example

'Set all mask bits to 1, i.e. all filtered bits are relevant:

CANSetMask(_CAN_MASK_B1, -1,_CAN_CONFIG_XTD_MSG)

' Note that -1 is just a cheaper way to write $FFFFFFFF.

' Complement will do the trick and fill it up with ones.

CANSetFilter

209

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure CANSetFilter(dim CAN_FILTER as byte, dim value as

longint, dim CAN_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Function sets message filter. Given value is bit adjusted to appropriate buffer

mask registers.

Parameters:

 CAN_FILTER is one of predefined constant values (see CAN constants)

 value is the filter register value

 CAN_CONFIG_FLAGS selects type of message to filter, either

_CAN_CONFIG_XTD_MSG or _CAN_CONFIG_STD_MSG

Requires

CAN must be in Config mode; otherwise the function will be ignored.

Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example ' Set id of filter B1_F1 to 3:

CANSetFilter(_CAN_FILTER_B1_F1, 3, _CAN_CONFIG_XTD_MSG)

CANRead

210 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function CANRead(dim byref id as longint, dim byref data as

byte[8], dim byref datalen, CAN_RX_MSG_FLAGS as byte)as byte

Returns Message from receive buffer or zero if no message found.

Description

Function reads message from receive buffer. If at least one full receive buffer is

found, it is extracted and returned. If none found, function returns zero.

Parameters:

 id is message identifier

 data is an array of bytes up to 8 bytes in length

 datalen is data length, from 1–8.

 CAN_RX_MSG_FLAGS is value formed from constants (see CAN constants)

Requires

CAN must be in mode in which receiving is possible.

Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example

dim len, rcv, rx as byte

dim id as longint

dim data as byte[8]

' ...

rx = 0

' ...

rcv = CANRead(id, data, len, rx)

CANWrite

211

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function CANWrite(dim id as longint, dim byref data as

byte[8], dim datalen, CAN_TX_MSG_FLAGS as byte) as byte

Returns Returns zero if message cannot be queued (buffer full).

Description

If at least one empty transmit buffer is found, function sends message on queue

for transmission. If buffer is full, function returns 0.

Parameters:

 id CAN message identifier. Only 11 or 29 bits may be used depending on

message type (standard or extended)

 data is an array of bytes up to 8 bytes in length

 datalen is data length, from 1–8.

 CAN_RX_MSG_FLAGS is value formed from constants (see CAN constants)

Requires

CAN must be in Normal mode.

Microcontroller must be connected to CAN transceiver (MCP2551 or similar)

which is connected to CAN bus.

Example

dim id as longint

dim tx, data as byte

' ...

tx = _CAN_TX_PRIORITY_0 and

_CAN_TX_XTD_FRAME

' ...

CANWrite(id, data, 2, tx)

CAN Constants

There is a number of constants predefined in CAN library. To be able to use the

library effectively, you need to be familiar with these. You might want to check the

example at the end of the chapter.

CAN_OP_MODE

CAN_OP_MODE constants define CAN operation mode. Function

CANSetOperationMode expects one of these as its argument:

const _CAN_MODE_BITS = $E0 ' Use it to access mode bits

const _CAN_MODE_NORMAL = 0

const _CAN_MODE_SLEEP = $20

const _CAN_MODE_LOOP = $40

const _CAN_MODE_LISTEN = $60

const _CAN_MODE_CONFIG = $80

CAN_CONFIG_FLAGS

CAN_CONFIG_FLAGS constants define flags related to CAN module configuration.

Functions CANInitialize and CANSetBaudRate expect one of these (or a bitwise

combination) as their argument:

const _CAN_CONFIG_DEFAULT = $FF ' 11111111

const _CAN_CONFIG_PHSEG2_PRG_BIT = $01

const _CAN_CONFIG_PHSEG2_PRG_ON = $FF ' XXXXXXX1

const _CAN_CONFIG_PHSEG2_PRG_OFF = $FE ' XXXXXXX0

const _CAN_CONFIG_LINE_FILTER_BIT = $02

const _CAN_CONFIG_LINE_FILTER_ON = $FF ' XXXXXX1X

const _CAN_CONFIG_LINE_FILTER_OFF = $FD ' XXXXXX0X

const _CAN_CONFIG_SAMPLE_BIT = $04

const _CAN_CONFIG_SAMPLE_ONCE = $FF ' XXXXX1XX

const _CAN_CONFIG_SAMPLE_THRICE = $FB ' XXXXX0XX

const _CAN_CONFIG_MSG_TYPE_BIT = $08

const _CAN_CONFIG_STD_MSG = $FF ' XXXX1XXX

const _CAN_CONFIG_XTD_MSG = $F7 ' XXXX0XXX

const _CAN_CONFIG_DBL_BUFFER_BIT = $10

const _CAN_CONFIG_DBL_BUFFER_ON = $FF ' XXX1XXXX

const _CAN_CONFIG_DBL_BUFFER_OFF = $EF ' XXX0XXXX

const _CAN_CONFIG_MSG_BITS = $60

const _CAN_CONFIG_ALL_MSG = $FF ' X11XXXXX

const _CAN_CONFIG_VALID_XTD_MSG = $DF ' X10XXXXX

const _CAN_CONFIG_VALID_STD_MSG = $BF ' X01XXXXX

const _CAN_CONFIG_ALL_VALID_MSG = $9F ' X00XXXXX

212 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

You may use bitwise and to form config byte out of these values. For example:

init = _CAN_CONFIG_SAMPLE_THRICE and

_CAN_CONFIG_PHSEG2_PRG_ON and

_CAN_CONFIG_STD_MSG and

_CAN_CONFIG_DBL_BUFFER_ON and

_CAN_CONFIG_VALID_XTD_MSG and

_CAN_CONFIG_LINE_FILTER_OFF

...

CANInitialize(1, 1, 3, 3, 1, init) ' Initialize CAN

CAN_TX_MSG_FLAGS

CAN_TX_MSG_FLAGS are flags related to transmission of a CAN message:

const _CAN_TX_PRIORITY_BITS = $03

const _CAN_TX_PRIORITY_0 = $FC ' XXXXXX00

const _CAN_TX_PRIORITY_1 = $FD ' XXXXXX01

const _CAN_TX_PRIORITY_2 = $FE ' XXXXXX10

const _CAN_TX_PRIORITY_3 = $FF ' XXXXXX11

const _CAN_TX_FRAME_BIT = $08

const _CAN_TX_STD_FRAME = $FF ' XXXXX1XX

const _CAN_TX_XTD_FRAME = $F7 ' XXXXX0XX

const _CAN_TX_RTR_BIT = $40

const _CAN_TX_NO_RTR_FRAME = $FF ' X1XXXXXX

const _CAN_TX_RTR_FRAME = $BF ' X0XXXXXX

You may use bitwise and to adjust the appropriate flags. For example:

' form value to be used with CANSendMessage:

send_config = _CAN_TX_PRIORITY_0 and

_CAN_TX_XTD_FRAME and

_CAN_TX_NO_RTR_FRAME;

...

CANSendMessage(id, data, 1, send_config)

213

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CAN_RX_MSG_FLAGS

CAN_RX_MSG_FLAGS are flags related to reception of CAN message. If a particular bit

is set; corresponding meaning is TRUE or else it will be FALSE.

const _CAN_RX_FILTER_BITS = $07 'Use it to access filter bits

const _CAN_RX_FILTER_1 = $00

const _CAN_RX_FILTER_2 = $01

const _CAN_RX_FILTER_3 = $02

const _CAN_RX_FILTER_4 = $03

const _CAN_RX_FILTER_5 = $04

const _CAN_RX_FILTER_6 = $05

const _CAN_RX_OVERFLOW = $08 ' Set if Overflowed; else clear

const _CAN_RX_INVALID_MSG = $10 ' Set if invalid; else clear

const _CAN_RX_XTD_FRAME = $20 ' Set if XTD message; else clear

const _CAN_RX_RTR_FRAME = $40 ' Set if RTR message; else clear

const _CAN_RX_DBL_BUFFERED = $80 ' Set if message was

' hardware double-buffered

You may use bitwise and to adjust the appropriate flags. For example:

if (MsgFlag and CAN_RX_OVERFLOW) = 0 then

...

' Receiver overflow has occurred.

' We have lost our previous message.

CAN_MASK

CAN_MASK constants define mask codes. Function CANSetMask expects one of

these as its argument:

const CAN_MASK_B1 = 0

const CAN_MASK_B2 = 1

CAN_FILTER

CAN_FILTER constants define filter codes. Function CANSetFilter expects one of

these as its argument:

const _CAN_FILTER_B1_F1 = 0

const _CAN_FILTER_B1_F2 = 1

const _CAN_FILTER_B2_F1 = 2

const _CAN_FILTER_B2_F2 = 3

const _CAN_FILTER_B2_F3 = 4

const _CAN_FILTER_B2_F4 = 5

214 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Library Example

This is a simple demonstration of CAN Library routines usage. First node initiates

the communication with the second node by sending some data to its address. The

second node responds by sending back the data incremented by 1. First node then

does the same and sends incremented data back to second node, etc.

Code for the first CANSPI node:

program CAN_1st

dim Can_Init_Flags, Can_Send_Flags, Can_Rcv_Flags as byte ' can flags

Rx_Data_Len as byte ' received data length in bytes

RxTx_Data as byte[8] ' can rx/tx data buffer

Msg_Rcvd as byte ' reception flag

ID_1st, ID_2nd as longint ' node IDs

Rx_ID as longint

main:

PORTC = 0 ' clear PORTC

TRISC = 0 ' set PORTC as output

Can_Init_Flags = 0 '

Can_Send_Flags = 0 ' clear flags

Can_Rcv_Flags = 0 '

Can_Send_Flags = _CAN_TX_PRIORITY_0 and ' form value to be used

_CAN_TX_XTD_FRAME and ' with CANWrite

_CAN_TX_NO_RTR_FRAME

Can_Init_Flags = _CAN_CONFIG_SAMPLE_THRICE and 'form value to be

used

_CAN_CONFIG_PHSEG2_PRG_ON and 'with CANInit

_CAN_CONFIG_XTD_MSG and

_CAN_CONFIG_DBL_BUFFER_ON and

_CAN_CONFIG_VALID_XTD_MSG

ID_1st = 12111

ID_2nd = 3

RxTx_Data[0] = 9 ' set initial data to be sent

CANInitialize(1,3,3,3,1,Can_Init_Flags) ' Initialize CAN module

CANSetOperationMode(_CAN_MODE_CONFIG,0xFF) ' set CONFIGURATION mode

CANSetMask(_CAN_MASK_B1,-1,_CAN_CONFIG_XTD_MSG) ' set all mask1 bits

to ones

CANSetMask(_CAN_MASK_B2,-1,_CAN_CONFIG_XTD_MSG) ' set all mask2 bits

to ones

CANSetFilter(_CAN_FILTER_B2_F4,ID_2nd,_CAN_CONFIG_XTD_MSG) 'set id

of filter B2_F4 to 2nd node ID

CANSetOperationMode(_CAN_MODE_NORMAL,0xFF) 'set NORMAL mode

215

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CANWrite(ID_1st, RxTx_Data, 1, Can_Send_Flags 'send initial message

while TRUE

Msg_Rcvd = CANRead(Rx_ID , RxTx_Data , Rx_Data_Len, Can_Rcv_Flags)

if ((Rx_ID = ID_2nd) and (Msg_Rcvd <> 0)) <> 0 then

PORTC = RxTx_Data[0] ' output data at PORTC

RxTx_Data[0] = RxTx_Data[0] + 1

Delay_ms(10)

CANWrite(ID_1st, RxTx_Data, 1, Can_Send_Flags) ' send incre-

mented data back

end if

wend

end.

Code for the second CANSPI node:

program CAN_2nd

dim Can_Init_Flags, Can_Send_Flags, Can_Rcv_Flags as byte 'CAN flags

Rx_Data_Len as byte ' received data length in bytes

RxTx_Data as byte[8] ' can rx/tx data buffer

Msg_Rcvd as byte ' reception flag

ID_1st, ID_2nd as longin ' node IDs

Rx_ID as longint

main:

PORTC = 0 ' clear PORTC

TRISC = 0 ' set PORTC as output

Can_Init_Flags = 0 '

Can_Send_Flags = 0 ' clear flags

Can_Rcv_Flags = 0 '

Can_Send_Flags = _CAN_TX_PRIORITY_0 and ' form value to be used

_CAN_TX_XTD_FRAME and ' with CANWrite

_CAN_TX_NO_RTR_FRAME

Can_Init_Flags = _CAN_CONFIG_SAMPLE_THRICE and ' form value to be

used

_CAN_CONFIG_PHSEG2_PRG_ON and 'with CANInit

_CAN_CONFIG_XTD_MSG and

_CAN_CONFIG_DBL_BUFFER_ON and

_CAN_CONFIG_VALID_XTD_MSG and

_CAN_CONFIG_LINE_FILTER_OFF

ID_1st = 12111

ID_2nd = 3

RxTx_Data[0] = 9 ' set initial data to be sent

216 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANInitialize(1,3,3,3,1,Can_Init_Flags ' initialize external CAN

module

CANSetOperationMode(_CAN_MODE_CONFIG,0xFF) ' set CONFIGURATION

mode

CANSetMask(_CAN_MASK_B1,-1,_CAN_CONFIG_XTD_MSG) ' set all mask1

bits to ones

CANSetMask(_CAN_MASK_B2,-1,_CAN_CONFIG_XTD_MSG) ' set all mask2

bits to ones

CANSetFilter(_CAN_FILTER_B2_F3,ID_1st,_CAN_CONFIG_XTD_MSG) ' set

id of filter B2_F3 to 1st node ID

CANSetOperationMode(_CAN_MODE_NORMAL,0xFF) ' set NORMAL mode

while true ' endless loop

Msg_Rcvd = CANRead(Rx_ID , RxTx_Data , Rx_Data_Len, Can_Rcv_

Flags) ' receive message

if ((Rx_ID = ID_1st) and (Msg_Rcvd <> 0)) <> 0 then ' if message

received check id

PORTC = RxTx_Data[0] ' id correct, output data at PORTC

Inc(RxTx_Data[0]) ' increment received data

CANWrite(ID_2nd, RxTx_Data, 1, Can_Send_Flags)' send increment-

ed data back

end if

wend

end.

217

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

HW Connection

Example of interfacing CAN transceiver with MCU and bus.

218 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPI LIBRARY

The SPI module is available with a number of the PIC compliant MCUs. The

mikroBasic PRO for PIC provides a library (driver) for working with mikroElektroni-

ka's CANSPI Add-on boards (with MCP2515 or MCP2510) via SPI interface.

The CAN is a very robust protocol that has error detection and signalization,

self–checking and fault confinement. Faulty CAN data and remote frames are re-

transmitted automatically, similar to the Ethernet.

Data transfer rates depend on distance. For example, 1 Mbit/s can be achieved at

network lengths below 40m while 250 Kbit/s can be achieved at network lengths

below 250m. The greater distance the lower maximum bitrate that can be achieved.

The lowest bitrate defined by the standard is 200Kbit/s. Cables used are shielded

twisted pairs.

CAN supports two message formats:

Standard format, with 11 identifier bits and

 Extended format, with 29 identifier bits

Note:

 Consult the CAN standard about CAN bus termination resistance.

 An effective CANSPI communication speed depends on SPI and certainly is

slower than “real” CAN.

 The library uses the SPI module for communication. User must initialize SPI

module before using the SPI Graphic Lcd Library.

For MCUs with two SPI modules it is possible to initialize both of them and

then switch by using the SPI_Set_Active routine.

 CANSPI module refers to mikroElektronika's CANSPI Add-on board connect

ed to SPI module of MCU.

219

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

External dependecies of CANSPI Library

Library Routines

 CANSPISetOperationMode

 CANSPIGetOperationMode

 CANSPIInitialize

 CANSPISetBaudRate

 CANSPISetMask

 CANSPISetFilter

 CANSPIread

 CANSPIWrite

The following routines are for an internal use by the library only:

 RegsToCANSPIID

 CANSPIIDToRegs

Be sure to check CANSPI constants necessary for using some of the sub functions.

220 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using CANSPI

Library:

Description: Example :

dim CanSpi_CS as sbit

sfr external Chip Select line. dim CanSpi_CS as sbit

at RC0_bit

dim CanSpi_Rst as

sbit sfr external Reset line. dim CanSpi_Rst as

sbit at RC2_bit

dim

CanSpi_CS_Direction

as sbit sfr exter-

nal

Direction of the

Chip Select pin.

dim

CanSpi_CS_Direction

as sbit at

TRISC0_bit

dim

CanSpi_Rst_Bit_Dire

ction as sbit sfr

external

Direction of the Reset pin.

dim

CanSpi_Rst_Bit_Direc

tion as sbit at

TRISC2_bit

221

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CANSPISetOperationMode

CANSPIGetOperationMode

Prototype sub procedure CANSPISetOperationMode(dim mode as byte, dim WAIT

as byte)

Returns Nothing.

Description

Sets the CANSPI module to requested mode.

Parameters :

mode: CANSPI module operation mode. Valid values: CANSPI_OP_MODE

constants (see CANSPI constants).

 WAIT: CANSPI mode switching verification request. If WAIT = 0, the call is

non-blocking. The sub function does not verify if the CANSPI module is

switched to requested mode or not. Caller must use CANSPIGetOperationMode

to verify correct operation mode before performing mode specific operation. If WAIT

!= 0, the call is blocking – the sub function won’t “return” until the requested mode

is set.

Requires

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' set the CANSPI module into configuration mode (wait inside

CANSPISetOperationMode until this mode is set)

CANSPISetOperationMode(_CANSPI_MODE_CONFIG, 0xFF)

Prototype sub function CANSPIGetOperationMode() as byte

Returns Current operation mode.

Description

The sub function returns current operation mode of the CANSPI module. Check

CANSPI_OP_MODE constants (see CANSPI constants) or device datasheet for

operation mode codes.

Requires

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' check whether the CANSPI module is in Normal mode and if it is

do something.

if (CANSPIGetOperationMode() = _CANSPI_MODE_NORMAL) then

...

end if

222 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPIInitialize

Prototype

sub procedure CANSPIInitialize(dim SJW as byte, dim BRP as byte,

dim PHSEG1 as byte, dim PHSEG2 as byte, dim PROPSEG as byte, dim

CANSPI_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Initializes the CANSPI module.

Stand-Alone CAN controller in the CANSPI module is set to:

 Disable CAN capture

 Continue CAN operation in Idle mode

 Do not abort pending transmissions

 Fcan clock: 4*Tcy (Fosc)

 Baud rate is set according to given parameters

 CAN mode: Normal

 Filter and mask registers IDs are set to zero

 Filter and mask message frame type is set according to CAN_CONFIG_FLAGS

value

SAM,SEG2PHTS,WAKFIL and DBEN bits are set according to CAN_CONFIG_FLAGS value.

Parameters:

SJW as defined in CAN controller's datasheet

 BRP as defined in CAN controller's datasheet

 PHSEG1 as defined in CAN controller's datasheet

 PHSEG2 as defined in CAN controller's datasheet

 PROPSEG as defined in CAN controller's datasheet

 CAN_CONFIG_FLAGS is formed from predefined constants (see CANSPI con

stants)

Requires

Global variables :

 CanSpi_CS: Chip Select line

 CanSpi_Rst: Reset line

 CanSpi_CS_Bit_Direction: Direction of the Chip Select pin

 CanSpi_Rst_Bit_Direction: Direction of the Reset pin

must be defined before using this function.

The CANSPI routines are supported only by MCUs with the SPI module.

The SPI module needs to be initialized. See the SPI1_Init and SPI1_Init_Advanced

routines.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board or

similar hardware. See connection example at the bottom of this page.

223

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Example

' CANSPI module connections

dim CanSpi_CS as sbit at RC0_bit

CanSpi_CS_Direction as sbit at TRISC0_bit

CanSpi_Rst as sbit at RC2_bit

CanSpi_Rst_Direction as sbit at TRISC2_bit

' End CANSPI module connections

...

dim Can_Init_Flags as byte

...

Can_Init_Flags = _CANSPI_CONFIG_SAMPLE_THRICE and ' form value

to be used

_CANSPI_CONFIG_PHSEG2_PRG_ON and ' with

CANSPIInitialize

_CANSPI_CONFIG_XTD_MSG and

_CANSPI_CONFIG_DBL_BUFFER_ON and

_CANSPI_CONFIG_VALID_XTD_MSG

...

SPI1_Init() ' initialize SPI module

CANSPIInitialize(1,3,3,3,1,Can_Init_Flags) ' initialize exter-

nal CANSPI module

224 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPISetBaudRate

Prototype

sub procedure CANSPISetBaudRate(dim SJW as byte, dim BRP as byte,

dim PHSEG1 as byte, dim PHSEG2 as byte, dim PROPSEG as byte, dim

CANSPI_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Sets the CANSPI module baud rate. Due to complexity of the CAN protocol,

you can not simply force a bps value. Instead, use this sub function when the

CANSPI module is in Config mode.

SAM, SEG2PHTS and WAKFIL bits are set according to CANSPI_CONFIG_FLAGS

value. Refer to datasheet for details.

Parameters:

SJW as defined in CAN controller's datasheet

BRP as defined in CAN controller's datasheet

PHSEG1 as defined in CAN controller's datasheet

 PHSEG2 as defined in CAN controller's datasheet

 PROPSEG as defined in CAN controller's datasheet

 CAN_CONFIG_FLAGS is formed from predefined constants (see CANSPI con

stants)

Requires

The CANSPI module must be in Config mode, otherwise the sub function will be

ignored. See CANSPISetOperationMode.

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' set required baud rate and sampling rules

dim can_config_flags as byte

...

CANSPISetOperationMode(_CANSPI_MODE_CONFIG, 0xFF) ' set CONFIG-

URATION mode (CANSPI module mast be in config mode for baud rate

settings)

can_config_flags = _CANSPI_CONFIG_SAMPLE_THRICE and

_CANSPI_CONFIG_PHSEG2_PRG_ON and

_CANSPI_CONFIG_STD_MSG and

_CANSPI_CONFIG_DBL_BUFFER_ON and

_CANSPI_CONFIG_VALID_XTD_MSG and

_CANSPI_CONFIG_LINE_FILTER_OFF

CANSPISetBaudRate(1, 1, 3, 3, 1, can_config_flags)

225

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CANSPISetMask

Prototype sub procedure CANSPISetMask(dim CANSPI_MASK as byte, dim val as

longint, dim CANSPI_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Configures mask for advanced filtering of messages. The parameter value is

bit-adjusted to the appropriate mask registers.

Parameters:

 CAN_MASK: CANSPI module mask number. Valid values: CANSPI_MASK

costants (see CANSPI constants)

 val: mask register value

 CAN_CONFIG_FLAGS: selects type of message to filter. Valid values:

_CANSPI_CONFIG_ALL_VALID_MSG,

_CANSPI_CONFIG_MATCH_MSG_TYPE and CANSPI_CONFIG_STD_MSG,

_CANSPI_CONFIG_MATCH_MSG_TYPE and CANSPI_CONFIG_XTD_MSG.

(see CANSPI constants)

Requires

The CANSPI module must be in Config mode, otherwise the sub function will be

ignored. See CANSPISetOperationMode.

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' set the appropriate filter mask and message type value

CANSPISetOperationMode(_CANSPI_MODE_CONFIG,0xFF) ' set CONFIGURA-

TION mode (CANSPI module must be in config mode for mask set-

tings)

' Set all B1 mask bits to 1 (all filtered bits are relevant):

' Note that -1 is just a cheaper way to write 0xFFFFFFFF.

' Complement will do the trick and fill it up with ones.

CANSPISetMask(_CANSPI_MASK_B1, -1, _CANSPI_CONFIG_MATCH_MSG_TYPE

and _CANSPI_CONFIG_XTD_MSG)

226 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPISetFilter

Prototype sub procedure CANSPISetFilter(dim CANSPI_FILTER as byte, dim val

as longint, dim CANSPI_CONFIG_FLAGS as byte)

Returns Nothing.

Description

Configures message filter. The parameter value is bit-adjusted to the appropri-

ate filter registers.

Parameters:

CAN_FILTER: CANSPI module filter number. Valid values: CANSPI_FILTER

constants (see CANSPI constants)

 val: filter register value

 CAN_CONFIG_FLAGS: selects type of message to filter. Valid values:

_CANSPI_CONFIG_ALL_VALID_MSG,

_CANSPI_CONFIG_MATCH_MSG_TYPE and CANSPI_CONFIG_STD_MSG,

_CANSPI_CONFIG_MATCH_MSG_TYPE and CANSPI_CONFIG_XTD_MSG.

(see CANSPI constants)

Requires

The CANSPI module must be in Config mode, otherwise the function will be

ignored. See CANSPISetOperationMode.

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' set the appropriate filter value and message type

CANSPISetOperationMode(_CANSPI_MODE_CONFIG,0xFF)

' set CONFIGURATION mode (CANSPI module must be in config mode

for filter settings)

' Set id of filter B1_F1 to 3:

CANSPISetFilter(_CANSPI_FILTER_B1_F1, 3, _CANSPI_CONFIG_XTD_MSG)

227

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CANSPIRead

Prototype

sub function CANSPIRead(dim byref id as longint, dim byref

rd_data as byte[8],dim data_len as byte, dim CANSPI_RX_MSG_FLAGS

as byte) as byte

Returns 0if nothing is received

 0xFF if one of the Receive Buffers is full (message received)

Description

If at least one full Receive Buffer is found, it will be processed in the following

way:

 Message ID is retrieved and stored to location provided by the id parameter

 Message data is retrieved and stored to a buffer provided by the rd_data param-

eter

 Message length is retrieved and stored to location provided by the

data_len parameter

 Message flags are retrieved and stored to location provided by the

CAN_RX_MSG_FLAGS parameter

Parameters:

 id: message identifier storage address

 rd_data: data buffer (an array of bytes up to 8 bytes in length)

 data_len: data length storage address.

 CAN_RX_MSG_FLAGS: message flags storage address

Requires

The CANSPI module must be in a mode in which receiving is possible. See

CANSPISetOperationMode.

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' check the CANSPI module for received messages. If any was

received do something.

dim msg_rcvd, rx_flags, data_len as byte

rd_data as byte[8]

msg_id as longint

...

CANSPISetOperationMode(_CANSPI_MODE_NORMAL,0xFF) ' set NORMAL

mode (CANSPI module must be in mode in which receive is possible)

...

rx_flags = 0 ' clear message flags

if (msg_rcvd = CANSPIRead(msg_id, rd_data, data_len, rx_flags)

...

end if

228 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPIWrite

Prototype

sub function CANSPIWrite(dim id as longint, dim byref wr_data as

byte[8], dim data_len as byte, dim CANSPI_TX_MSG_FLAGS as byte)

as byte

Returns 0if all Transmit Buffers are busy

 0xFF if at least one Transmit Buffer is available

Description

If at least one empty Transmit Buffer is found, the function sends message in

the queue for transmission.

Parameters:

 id:CAN message identifier. Valid values: 11 or 29 bit values, depending

on message type (standard or extended)

 wr_data: data to be sent (an array of bytes up to 8 bytes in length)

 data_len: data length. Valid values: 1 to 8

 CAN_RX_MSG_FLAGS: message flags

Requires

The CANSPI module must be in mode in which transmission is possible. See

CANSPISetOperationMode.

The CANSPI routines are supported only by MCUs with the SPI module.

MCU has to be properly connected to mikroElektronika's CANSPI Extra Board

or similar hardware. See connection example at the bottom of this page.

Example

' send message extended CAN message with the appropriate ID and

data

dim tx_flags as byte

rd_data as byte[8]

msg_id as longint

...

CANSPISetOperationMode(_CANSPI_MODE_NORMAL, 0xFF)

' set NORMAL mode (CANSPI must be in mode in which transmission

is possible)

tx_flags = _CANSPI_TX_PRIORITY_0 ands _CANSPI_TX_XTD_FRAME

' set message flags

CANSPIWrite(msg_id, rd_data, 2, tx_flags)

CANSPI Constants

There is a number of constants predefined in the CANSPI library. You need to be

familiar with them in order to be able to use the library effectively. Check the exam-

ple at the end of the chapter.

CANSPI_OP_MODE

The CANSPI_OP_MODE constants define CANSPI operation mode. Function

CANSPISetOperationMode expects one of these as it's argument:

const

_CANSPI_MODE_BITS as byte = 0xE0 Use this to access opmode bits

_CANSPI_MODE_NORMAL as byte = 0x00

_CANSPI_MODE_SLEEP as byte = 0x20

_CANSPI_MODE_LOOP as byte = 0x40

_CANSPI_MODE_LISTEN as byte = 0x60

_CANSPI_MODE_CONFIG as byte = 0x80

CANSPI_CONFIG_FLAGS

The CANSPI_CONFIG_FLAGS constants define flags related to the CANSPI mod-

ule configuration. The functions CANSPIInitialize, CANSPISetBaudRate,

CANSPISetMask and CANSPISetFilter expect one of these (or a bitwise combina-

tion) as their argument:

const

_CANSPI_CONFIG_DEFAULT as byte = $FF ' 11111111

_CANSPI_CONFIG_PHSEG2_PRG_BIT as byte = $01

_CANSPI_CONFIG_PHSEG2_PRG_ON as byte = $FF ' XXXXXXX1

_CANSPI_CONFIG_PHSEG2_PRG_OFF as byte = $FE ' XXXXXXX0

_CANSPI_CONFIG_LINE_FILTER_BIT as byte = $02

_CANSPI_CONFIG_LINE_FILTER_ON as byte = $FF ' XXXXXX1X

_CANSPI_CONFIG_LINE_FILTER_OFF as byte = $FD ' XXXXXX0X

_CANSPI_CONFIG_SAMPLE_BIT as byte = $04

_CANSPI_CONFIG_SAMPLE_ONCE as byte = $FF ' XXXXX1XX

_CANSPI_CONFIG_SAMPLE_THRICE as byte = $FB ' XXXXX0XX

_CANSPI_CONFIG_MSG_TYPE_BIT as byte = $08

_CANSPI_CONFIG_STD_MSG as byte = $FF ' XXXX1XXX

_CANSPI_CONFIG_XTD_MSG as byte = $F7 ' XXXX0XXX

_CANSPI_CONFIG_DBL_BUFFER_BIT as byte = $10

_CANSPI_CONFIG_DBL_BUFFER_ON as byte = $FF ' XXX1XXXX

229

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

_CANSPI_CONFIG_DBL_BUFFER_OFF as byte = $EF ' XXX0XXXX

_CANSPI_CONFIG_MSG_BITS as byte = $60

_CANSPI_CONFIG_ALL_MSG as byte = $FF ' X11XXXXX

_CANSPI_CONFIG_VALID_XTD_MSG as byte = $DF ' X10XXXXX

_CANSPI_CONFIG_VALID_STD_MSG as byte = $BF ' X01XXXXX

_CANSPI_CONFIG_ALL_VALID_MSG as byte = $9F ' X00XXXXX

You may use bitwise and to form config byte out of these values. For example:

init = _CANSPI_CONFIG_SAMPLE_THRICE and

_CANSPI_CONFIG_PHSEG2_PRG_ON and

_CANSPI_CONFIG_STD_MSG and

_CANSPI_CONFIG_DBL_BUFFER_ON and

_CANSPI_CONFIG_VALID_XTD_MSG and

_CANSPI_CONFIG_LINE_FILTER_OFF

...

CANSPIInit(1, 1, 3, 3, 1, init) ' initialize CANSPI

CANSPI_TX_MSG_FLAGS

CANSPI_TX_MSG_FLAGS are flags related to transmission of a CAN message:

const

_CANSPI_TX_PRIORITY_BITS as byte = $03

_CANSPI_TX_PRIORITY_0 as byte = $FC ' XXXXXX00

_CANSPI_TX_PRIORITY_1 as byte = $FD ' XXXXXX01

_CANSPI_TX_PRIORITY_2 as byte = $FE ' XXXXXX10

_CANSPI_TX_PRIORITY_3 as byte = $FF ' XXXXXX11

_CANSPI_TX_FRAME_BIT as byte = $08

_CANSPI_TX_STD_FRAME as byte = $FF ' XXXXX1XX

_CANSPI_TX_XTD_FRAME as byte = $F7 ' XXXXX0XX

_CANSPI_TX_RTR_BIT as byte = $40

_CANSPI_TX_NO_RTR_FRAME as byte = $FF ' X1XXXXXX

_CANSPI_TX_RTR_FRAME as byte = $BF ' X0XXXXXX

You may use bitwise and to adjust the appropriate flags. For example:

' form value to be used with CANSendMessage:

send_config = _CANSPI_TX_PRIORITY_0 and

_CANSPI_TX_XTD_FRAME and

_CANSPI_TX_NO_RTR_FRAME

...

CANSPI1Write(id, data, 1, send_config)

230 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPI_RX_MSG_FLAGS

CANSPI_RX_MSG_FLAGS are flags related to reception of CAN message. If a par-

ticular bit is set then corresponding meaning is TRUE or else it will be FALSE.

const

_CANSPI_RX_FILTER_BITS as byte = $07 ' Use this to access fil-

ter bits

_CANSPI_RX_FILTER_1 as byte = $00

_CANSPI_RX_FILTER_2 as byte = $01

_CANSPI_RX_FILTER_3 as byte = $02

_CANSPI_RX_FILTER_4 as byte = $03

_CANSPI_RX_FILTER_5 as byte = $04

_CANSPI_RX_FILTER_6 as byte = $05

_CANSPI_RX_OVERFLOW as byte = $08 ' Set if Overflowed else

cleared

_CANSPI_RX_INVALID_MSG as byte = $10 ' Set if invalid else

cleared

_CANSPI_RX_XTD_FRAME as byte = $20 ' Set if XTD message else

cleared

_CANSPI_RX_RTR_FRAME as byte = $40 ' Set if RTR message else

cleare

_CANSPI_RX_DBL_BUFFERED as byte = $80 ' Set if this message was

hardware double-buffered

You may use bitwise and to adjust the appropriate flags. For example:

if (MsgFlag and _CANSPI_RX_OVERFLOW) <> 0 then

...

' Receiver overflow has occurred.

' We have lost our previous message.

end if

CANSPI_MASK

The CANSPI_MASK constants define mask codes. Function CANSPISetMask

expects one of these as it's argument:

const

_CANSPI_MASK_B1 as byte = 0

_CANSPI_MASK_B2 as byte = 1

CANSPI_FILTER

The CANSPI_FILTER constants define filter codes. Functions CANSPISetFilter

expects one of these as it's argument:

const

_CANSPI_FILTER_B1_F1 as byte = 0

_CANSPI_FILTER_B1_F2 as byte = 1

_CANSPI_FILTER_B2_F1 as byte = 2

_CANSPI_FILTER_B2_F2 as byte = 3

_CANSPI_FILTER_B2_F3 as byte = 4

_CANSPI_FILTER_B2_F4 as byte = 5

231

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Library Example

This is a simple demonstration of CANSPI Library routines usage. First node initi-

ates the communication with the second node by sending some data to its address.

The second node responds by sending back the data incremented by 1. First node

then does the same and sends incremented data back to second node, etc.

Code for the first CANSPI node:

program Can_Spi_1st

dim Can_Init_Flags, Can_Send_Flags, Can_Rcv_Flags as byte ' can

flags

Rx_Data_Len as byte ' received data length in bytes

RxTx_Data as byte[8] ' can rx/tx data buffer

Msg_Rcvd as byte ' reception flag

Tx_ID, Rx_ID as longint ' can rx and tx ID

' CANSPI module connections

dim CanSpi_CS as sbit at RC0_bit

CanSpi_CS_Direction as sbit at TRISC0_bit

CanSpi_Rst as sbit at RC2_bit

CanSpi_Rst_Direction as sbit at TRISC2_bit

' End CANSPI module connections

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

PORTB = 0

TRISB = 0

Can_Init_Flags = 0 '

Can_Send_Flags = 0 ' clear flags

Can_Rcv_Flags = 0 '

Can_Send_Flags = _CANSPI_TX_PRIORITY_0 and ' form value to be used

_CANSPI_TX_XTD_FRAME and ' with CANSPIWrite

_CANSPI_TX_NO_RTR_FRAME

Can_Init_Flags = _CANSPI_CONFIG_SAMPLE_THRICE and ' form value to

be used

_CANSPI_CONFIG_PHSEG2_PRG_ON and ' with CANSPIInit

_CANSPI_CONFIG_XTD_MSG and

_CANSPI_CONFIG_DBL_BUFFER_ON and

_CANSPI_CONFIG_VALID_XTD_MSG

232 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI1_Init() ' initialize SPI1 module

CANSPIInitialize(1,3,3,3,1,Can_Init_Flags) 'Initialize external CAN-

SPI module

CANSPISetOperationMode(_CANSPI_MODE_CONFIG,0xFF) 'set CONFIGURATION

mode

CANSPISetMask(_CANSPI_MASK_B1,-1,_CANSPI_CONFIG_XTD_MSG) 'set all

mask1 bits to ones

CANSPISetMask(_CANSPI_MASK_B2,-1,_CANSPI_CONFIG_XTD_MSG) 'set all

mask2 bits to ones

CANSPISetFilter(_CANSPI_FILTER_B2_F4,3,_CANSPI_CONFIG_XTD_MSG) 'set

id of filter B1_F1 to 3

CANSPISetOperationMode(_CANSPI_MODE_NORMAL,0xFF) 'set NORMAL mode

RxTx_Data[0] = 9 ' set initial data to be sent

Tx_ID = 12111 '

set transmit ID

CANSPIWrite(Tx_ID, RxTx_Data, 1, Can_Send_Flags) ' send initial

message

while TRUE ' endless loop

Msg_Rcvd = CANSPIRead(Rx_ID , RxTx_Data , Rx_Data_Len,

Can_Rcv_Flags) ' receive message

if ((Rx_ID = 3) and Msg_Rcvd) then ' if message received

check id

PORTB = RxTx_Data[0] ' id correct, output data at PORTC

Inc(RxTx_Data[0]) ' increment received data

Delay_ms(10)

CANSPIWrite(Tx_ID, RxTx_Data, 1, Can_Send_Flags) ' send

incremented data back

end if

wend

end.

Code for the second CANSPI node:

program Can_Spi_2nd

dim Can_Init_Flags, Can_Send_Flags, Can_Rcv_Flags as byte ' can

flags

Rx_Data_Len as byte ' received data length in bytes

RxTx_Data as byte[8] ' CAN rx/tx data buffer

Msg_Rcvd as byte ' reception flag

Tx_ID, Rx_ID as longint ' can rx and tx ID

' CANSPI module connections

dim CanSpi_CS as sbit at RC0_bit

CanSpi_CS_Direction as sbit at TRISC0_bit

233

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

CanSpi_Rst as sbit at PORTC.B2

CanSpi_Rst_Direction as sbit at TRISC2_bit

' End CANSPI module connections

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

PORTB = 0 ' clear PORTB

TRISB = 0 ' set PORTB as output

Can_Init_Flags = 0 '

Can_Send_Flags = 0 ' clear flags

Can_Rcv_Flags = 0 '

Can_Send_Flags = _CANSPI_TX_PRIORITY_0 and ' form value to be used

_CANSPI_TX_XTD_FRAME and ' with CANSPIWrite

_CANSPI_TX_NO_RTR_FRAME

Can_Init_Flags = _CANSPI_CONFIG_SAMPLE_THRICE and ' Form value to

be used

_CANSPI_CONFIG_PHSEG2_PRG_ON and ' with

CANSPIInit

_CANSPI_CONFIG_XTD_MSG and

_CANSPI_CONFIG_DBL_BUFFER_ON and

_CANSPI_CONFIG_VALID_XTD_MSG and

_CANSPI_CONFIG_LINE_FILTER_OFF

SPI1_Init() '

initialize SPI1 module

CANSPIInitialize(1,3,3,3,1,Can_Init_Flags)

' initialize external CANSPI module

CANSPISetOperationMode(_CANSPI_MODE_CONFIG,0xFF)

' set CONFIGURATION mode

CANSPISetMask(_CANSPI_MASK_B1,-1,_CANSPI_CONFIG_XTD_MSG)

' set all mask1 bits to ones

CANSPISetMask(_CANSPI_MASK_B2,-1,_CANSPI_CONFIG_XTD_MSG)

' set all mask2 bits to ones

CANSPISetFilter(_CANSPI_FILTER_B2_F3,12111,_CANSPI_CONFIG_XTD_MSG)

' set id of filter B1_F1 to 3

CANSPISetOperationMode(_CANSPI_MODE_NORMAL,0xFF)

' set NORMAL mode

Tx_ID = 3 ' set tx ID

while TRUE ' endless loop

Msg_Rcvd = CANSPIRead(Rx_ID, RxTx_Data, Rx_Data_Len, Can_Rcv_Flags)

'receive message

if ((Rx_ID = 12111) and Msg_Rcvd) then

PORTB =

RxTx_Data[0] ' id correct, output data at PORTC

Inc(RxTx_Data[0]) ' increment received data

234 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

CANSPIWrite(Tx_ID, RxTx_Data,1, Can_Send_Flags ' send incremented

data back

end if

wend

end.

HW Connection

Example of interfacing CAN transceiver MCP2510 with MCU via SPI interface

235

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

236 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

COMPACT FLASH LIBRARY

The Compact Flash Library provides routines for accessing data on Compact Flash

card (abbr. CF further in text). CF cards are widely used memory elements, com-

monly used with digital cameras. Great capacity and excellent access time of only

a few microseconds make them very attractive for the microcontroller applications.

In CF card, data is divided into sectors. One sector usually comprises 512 bytes.

Routines for file handling, the Cf_Fat routines, are not performed directly but suc-

cessively through 512B buffer.

Note: Routines for file handling can be used only with FAT16 file system.

Note: Library functions create and read files from the root directory only.

Note: Library functions populate both FAT1 and FAT2 tables when writing to files,

but the file data is being read from the FAT1 table only; i.e. there is no recovery if

the FAT1 table gets corrupted.

Note: If MMC/SD card has Master Boot Record (MBR), the library will work with the

first available primary (logical) partition that has non-zero size. If MMC/SD card has

Volume Boot Record (i.e. there is only one logical partition and no MBRs), the library

works with entire card as a single partition. For more information on MBR, physical

and logical drives, primary/secondary partitions and partition tables, please consult

other resources, e.g. Wikipedia and similar.

Note: Before writing operation, make sure not to overwrite boot or FAT sector as it

could make your card on PC or digital camera unreadable. Drive mapping tools,

such as Winhex, can be of great assistance.

External dependencies of Compact Flash Library

The following variables

must be defined in all

projects using Compact

Flash Library:

Description :

Example :

dim CF_Data_Port as

byte sfr external

Compact Flash

Data Port. dim CF_Data_Port as byte

at PORTD

dim CF_RDY as sbit sfr

external Ready signal line. dim CF_RDY as sbit at

RB7_bit

dim CF_WE as sbit sfr

external

Write Enable signal

line. dim CF_WE as sbit at

RB6_bit

237

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

dim CF_OE as sbit sfr

external

Output Enable signal

line. dim CF_OE as sbit at

RB5_bit

dim CF_CD1 as sbit r

external Chip Detect signal line. dim CF_CD1 as sbit at

RB4_bit

dim CF_CE1 as sbit sfr

external

Chip Enable signal

line. dim CF_CE1 as sbit at

RB3_bit

dim CF_A2 as sbit sfr

external

Address pin 2. dim CF_A2 as sbit at

RB2_bit

dim CF_A1 as sbit sfr

external Address pin 1. dim CF_A1 as sbit at

RB1_bit

dim CF_A0 as sbit sfr

external Address pin 0. dim CF_A0 as sbit at

RB0_bit

dim CF_RDY_direction as

sbit sfr external Direction of the Ready

pin.

dim CF_RDY_direction as

sbit at TRISB7_bit

dim CF_WE_direction as

sbit sfr external Direction of the Write

Enable pin.

dim CF_WE_direction as

sbit at TRISB6_bit

dim CF_OE_direction as

sbit sfr external Direction of the Output

Enable pin

dim CF_OE_direction as

sbit at TRISB5_bit

dim CF_CD1_direction as

sbit sfr external Direction of the Chip

Detect pin.

dim CF_CD1_direction as

sbit at TRISB4_bit

dim CF_CE1_direction as

sbit sfr external Direction of the Chip

Enable pin.

dim CF_CE1_direction as

sbit at TRISB3_bit

dim CF_A2_direction as

sbit sfr external Direction of the Address

2 pin.

dim CF_A2_direction as

sbit at TRISB2_bit

dim CF_A1_direction as

sbit sfr external Direction of the Address

1 pin.

dim CF_A1_direction as

sbit at TRISB1_bit

dim CF_A0_direction as

sbit sfr external Direction of the Address

0 pin.

dim CF_A0_direction as

sbit at TRISB0_bit

Library Routines

Cf_Init

 Cf_Detect

 Cf_Enable

 Cf_Disable

 Cf_Read_Init

 Cf_Read_Byte

 Cf_Write_Init

 Cf_Write_Byte

 Cf_Read_Sector

 Cf_Write_Sector

Routines for file handling:

 Cf_Fat_Init

 Cf_Fat_QuickFormat

 Cf_Fat_Assign

 Cf_Fat_Reset

 Cf_Fat_Read

 Cf_Fat_Rewrite

 Cf_Fat_Append

 Cf_Fat_Delete

 Cf_Fat_Write

 Cf_Fat_Set_File_Date

 Cf_Fat_Get_File_Date

 Cf_Fat_Get_File_Size

 Cf_Fat_Get_Swap_File

238 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Cf_Init

239

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Init()

Returns Nothing.

Description Initializes ports appropriately for communication with CF card.

Requires

Global variables :

 CF_Data_Port : Compact Flash data port

 CF_RDY : Ready signal line

 CF_WE : Write enable signal line

 CF_OE : Output enable signal line

 CF_CD1 : Chip detect signal line

 CF_CE1 : Enable signal line

 CF_A2 : Address pin 2

 CF_A1 : Address pin 1

 CF_A0 : Address pin 0

 CF_Data_Port_direction : Direction of the Compact Flash data direction port

 CF_RDY_direction : Direction of the Ready pin

 CF_WE_direction : Direction of the Write enable pin

 CF_OE_direction : Direction of the Output enable pin

 CF_CD1_direction : Direction of the Chip detect pin

 CF_CE1_direction : Direction of the Chip enable pin

 CF_A2_direction : Direction of the Address 2 pin

 CF_A1_direction : Direction of the Address 1 pin

 CF_A0_direction : Direction of the Address 0 pin

must be defined before using this function.

Example

set compact flash pinout

dim CF_Data_Port as byte at PORTD

dim CF_RDY as sbit at RB7_bit

dim CF_WE as sbit at RB6_bit

dim CF_OE as sbit at RB5_bit

dim CF_CD1 as sbit at RB4_bit

dim CF_CE1 as sbit at RB3_bit

dim CF_A2 as sbit at RB2_bit

dim CF_A1 as sbit at RB1_bit

dim CF_A0 as sbit at RB0_bit

dim CF_RDY_direction as sbit at TRISB7_bit

dim CF_WE_direction as sbit at TRISB6_bit

dim CF_OE_direction as sbit at TRISB5_bit

dim CF_CD1_direction as sbit at TRISB4_bit

dim CF_CE1_direction as sbit at TRISB3_bit

dim CF_A2_direction as sbit at TRISB2_bit

dim CF_A1_direction as sbit at TRISB1_bit

dim CF_A0_direction as sbit at TRISB0_bit

' end of cf pinout

'Init CF

Cf_Init()

Cf_Detect

Cf_Enable

Cf_Disable

240 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function CF_Detect() as byte

Returns  1 - if CF card was detected

 0 - otherwise

Description Checks for presence of CF card by reading the chip detect pin.

Requires The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

Example

' Wait until CF card is inserted:

while (Cf_Detect() = 0)

nop

wend

Prototype sub procedure Cf_Enable()

Returns Nothing.

Description

Enables the device. Routine needs to be called only if you have disabled the

device by means of the Cf_Disable routine. These two routines in conjunction

allow you to free/occupy data line when working with multiple devices.

Requires The corresponding MCU ports must be appropriately initialized for CF card. See

Cf_Init.

Example ' enable compact flash

Cf_Enable()

Prototype sub procedure Cf_Disable()

Returns Nothing.

Description

Routine disables the device and frees the data lines for other devices. To

enable the device again, call Cf_Enable. These two routines in conjunction

allow you to free/occupy data line when working with multiple devices.

Requires The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

Example ' disable compact flash

Cf_Disable()

Cf_Read_Init

Cf_Read_Byte

241

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Read_Init(dim address as longword, dim

sector_count as byte)

Returns Nothing.

Description

Initializes CF card for reading.

Parameters :

 address: the first sector to be prepared for reading opera tion.

 sector_count: number of sectors to be prepared for reading operation.

Requires The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

Example ' initialize compact flash for reading from sector 590

Cf_Read_Init(590, 1)

Prototype sub function CF_Read_Byte() as byte

Returns

Returns a byte read from Compact Flash sector buffer.

Note: Higher byte of the unsigned return value is cleared.

Description Reads one byte from Compact Flash sector buffer location currently pointed to

by internal read pointers. These pointers will be autoicremented upon reading.

Requires

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

CF card must be initialized for reading operation. See Cf_Read_Init.

Example

' Read a byte from compact flash:

dim data as byte

...

data = Cf_Read_Byte()

Cf_Write_Init

Cf_Write_Byte

242 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Write_Init(dim address as longword, dim

sectcnt as byte)

Returns Nothing.

Description

Initializes CF card for writing.

Parameters :

 address: the first sector to be prepared for writing operation

 sectcnt: number of sectors to be prepared for writing operation.

Requires The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

Example ' initialize compact flash for writing to sector 590

Cf_Write_Init(590, 1)

Prototype sub procedure Cf_Write_Byte(dim data_ as byte)

Returns Nothing.

Description

Writes a byte to Compact Flash sector buffer location currently pointed to by

writing pointers. These pointers will be autoicremented upon reading. When

sector buffer is full, its content will be transfered to appropriate flash memory

sector.

Parameters :

 data_: byte to be written.

Requires The corresponding MCU ports must be appropriately initialized for CF card. CF card

must be initialized for writing operation. See Cf_Write_Init.

Example

dim data_ as byte

...

data = 0xAA

Cf_Write_Byte(data)

Cf_Read_Sector

Cf_Write_Sector

243

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Read_Sector(dim sector_number as longword, dim

byref buffer as byte[512])

Returns Nothing.

Description

Reads one sector (512 bytes). Read data is stored into buffer provided by the

buffer parameter.

Parameters :

 sector_number: sector to be read.

 buffer: data buffer of at least 512 bytes in length.

Requires The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

Example

' read sector 22

dim data as array[512] of byte

...

Cf_Read_Sector(22, data)

Prototype sub procedure Cf_Write_Sector(dim sector_number as longword, dim

byref buffer as byte[512])

Returns Nothing.

Description

Writes 512 bytes of data provided by the buffer parameter to one CF sector.

Parameters :

 sector_number: sector to be written to.

 buffer: data buffer of 512 bytes in length

Requires The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

Example

' write to sector 22

dim data as array[512] of byte

...

Cf_Write_Sector(22, data)

Cf_Fat_Init

Cf_Fat_QuickFormat

244 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Cf_Fat_Init() as byte

Returns

 0 - if CF card was detected and successfully initialized

 1- if FAT16 boot sector was not found

 255 - if card was not detected

Description Initializes CF card, reads CF FAT16 boot sector and extracts data needed by

the library.

Requires Nothing.

Example

init the FAT library

if (Cf_Fat_Init() = 0) then

...

end if

Prototype sub function Cf_Fat_QuickFormat(dim byref cf_fat_label as

string[11]) as byte

Returns

 0- if CF card was detected and formated and initialized

 1- if FAT16 format was unseccessful

 255 - if card was not detected

Description

Formats to FAT16 and initializes CF card.

Parameters :

 cf_fat_label: volume label (11 characters in length). If less than 11

characters are provided, the label will be padded with spaces. If an empty string

is passed, the volume will not be labeled.

Note: This routine can be used instead or in conjunction with the Cf_Fat_Init

routine.

Note: If CF card already contains a valid boot sector, it will remain unchanged

(except volume label field) and only FAT and ROOT tables will be erased. Also,

the new volume label will be set.

Requires Nothing.

Example

'--- format and initialize the FAT library

if ( Cf_Fat_QuickFormat('mikroE') = 0) then

...

end if

Cf_Fat_Assign

245

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Cf_Fat_Assign(dim byref filename as char[12], dim

file_cre_attr as byte)as byte

Returns  0 if file does not exist and no new file is created.

 1 if file already exists or file does not exist but a new file is created.

Description

Assigns file for file operations (read, write, delete...). All subsequent file opera-

tions will be applied to the assigned file.

Parameters :

 filename: name of the file that should be assigned for file operations.

The file name should be in DOS 8.3 (file_name.extension) format. The file name

and extension will be automatically padded with spaces by the library if they

have less than length required (i.e. "mikro.tx" -> "mikro .tx "), so the user does

not have to take care of that. The file name and extension are case insensitive.

The library will convert them to the proper case automatically, so the user does

not have to take care of that.

Also, in order to keep backward compatibility with the first version of this library,

file names can be entered as UPPERCASE string of 11 bytes in length with no

dot character between the file name and extension (i.e. "MIKROELETXT" ->

MIKROELE.TXT). In this case the last 3 characters of the string are considered

to be file extension.

 file_cre_attr: file creation and attributs flags. Each bit corresponds to

the appropriate file attribut:

Note: Long File Names (LFN) are not supported.

Requires CF card and CF library must be initialized for file operations. See Cf_Fat_Init

Example ' create file with archive attribut if it does not already exist

Cf_Fat_Assign('MIKRO007.TXT',0xA0)

Bit Mask Description

0 0x01 Read Only

1 0x02 Hidden

2 0x04 System

3 0x08 Volume Label

4 0x10 Subdirectory

5 0x20 Archive

6 0x40 Device (internal use only, never found on disk)

7 0x80 File creation flag. If the file does not exist and this flag is set, a

new file with specified name will be created.

Cf_Fat_Reset

Cf_Fat_Read

246 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Fat_Reset(dim byref size as longword)

Returns Nothing.

Description

Opens currently assigned file for reading.

Parameters :

size: buffer to store file size to. After file has been open for reading its size

is returned through this parameter.

Requires CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign

Example

dim size as longword

...

Cf_Fat_Reset(size)

Prototype sub procedure Cf_Fat_Read(dim byref bdata as byte)

Returns Nothing.

Description

Reads a byte from currently assigned file opened for reading. Upon function

execution file pointers will be set to the next character in the file.

Parameters :

bdata: buffer to store read byte to. Upon this function execution read byte

is returned through this parameter

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

File must be open for reading. See Cf_Fat_Reset.

Example

dim character as byte

...

Cf_Fat_Read(character)

Cf_Fat_Rewrite

Cf_Fat_Append

247

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Fat_Read()

Returns Nothing.

Description Opens currently assigned file for writing. If the file is not empty its content will

be erased.

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

The file must be previously assigned. See Cf_Fat_Assign.

Example ' open file for writing

Cf_Fat_Rewrite()

Prototype sub procedure Cf_Fat_Append()

Returns Nothing.

Description

Opens currently assigned file for appending. Upon this function execution file

pointers will be positioned after the last byte in the file, so any subsequent file

writing operation will start from there.

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

Example 'open file for appending

Cf_Fat_Append()

Cf_Fat_Delete

Cf_Fat_Write

248 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Cf_Fat_Delete()

Returns Nothing.

Description Deletes currently assigned file from CF card.

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

Example 'delete current file

Cf_Fat_Delete()

Prototype sub procedure Cf_Fat_Write(dim byref fdata as byte[512],

dim data_len as word)

Returns Nothing.

Description

Writes requested number of bytes to currently assigned file opened for writing.

Parameters :

 fdata: data to be written.

 data_len: number of bytes to be written.

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

File must be open for writing. See Cf_Fat_Rewrite or Cf_Fat_Append

Example

dim file_contents as array[42] of byte

...

Cf_Fat_Write(file_contents, 42) ' write data to the assigned file

Cf_Fat_Set_File_Date

249

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype

sub procedure Cf_Fat_Set_File_Date(dim year as word, dim

month as byte, dim day as byte, dim hours as byte, dim

mins as byte, dim seconds as byte)

Returns Nothing.

Description

Sets the date/time stamp. Any subsequent file writing operation will write this

stamp to currently assigned file's time/date attributs.

Parameters :

 year: year attribute. Valid values: 1980-2107

 month: month attribute. Valid values: 1-12

 day: day attribute. Valid values: 1-31

 hours: hours attribute. Valid values: 0-23

 mins: minutes attribute. Valid values: 0-59

 seconds: seconds attribute. Valid values: 0-59

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

File must be open for writing. See Cf_Fat_Rewrite or Cf_Fat_Append.

Example Cf_Fat_Set_File_Date(2005,9,30,17,41,0)

Cf_Fat_Get_File_Date

Cf_Fat_Get_File_Size

250 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype

sub procedure Cf_Fat_Get_File_Date(dim byref year as word,

dim byref month as byte, dim byref day as byte, dim byref

hours as byte, dim byref mins as byte)

Returns Nothing.

Description

Reads time/date attributes of currently assigned file.

Parameters :

 year:buffer to store year attribute to. Upon function execution year

attribute is returned through this parameter.

 month: buffer to store month attribute to. Upon function execution month

attribute is returned through this parameter.

 day: buffer to store day attribute to. Upon function execution day attribute

is returned through this parameter.

 hours: buffer to store hours attribute to. Upon function execution hours

attribute is returned through this parameter.

 mins: buffer to store minutes attribute to. Upon function execution

minutes attribute is returned through this parameter.

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

Example

dim year as word

month, day, hours, mins as byte

...

Cf_Fat_Get_File_Date(year, month, day, hours, mins)

Prototype sub function Cf_Fat_Get_File_Size() as longword

Returns Size of the currently assigned file in bytes.

Description This function reads size of currently assigned file in bytes.

Requires

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

Example

dim my_file_size as longword

...

my_file_size = Cf_Fat_Get_File_Size()

Cf_Fat_Get_Swap_File

251

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype

sub function Cf_Fat_Get_Swap_File(dim sectors_cnt as

longint, dim byref filename as string[11], dim file_attr

as byte)as longword

Returns

 Number of the start sector for the newly created swap file, if there was

enough free space on CF card to create file of required size.

 0 - otherwise.

Description

This function is used to create a swap file of predefined name and size on the

CF media. If a file with specified name already exists on the media, search for

consecutive sectors will ignore sectors occupied by this file. Therefore, it is rec-

ommended to erase such file if it exists before calling this function. If it is not

erased and there is still enough space for a new swap file, this function will

delete it after allocating new memory space for a new swap file.

The purpose of the swap file is to make reading and writing to CF media as fast

as possible, by using the Cf_Read_Sector() and Cf_Write_Sector() functions

directly, without potentially damaging the FAT system.

The swap file can be considered as a "window" on the media where the user

can freely write/read data. Its main purpose in the mikroBasic's library is to be

used for fast data acquisition; when the time-critical acquisition has finished, the

data can be re-written into a "normal" file, and formatted in the most suitable

way.

Parameters:

 sectors_cnt: number of consecutive sectors that user wants the swap file

to have.

 filename: name of the file that should be assigned for file operations. The

file name should be in DOS 8.3 (file_name.extension) format. The file name and

extension will be automatically padded with spaces by the library if they have

less than length required (i.e. "mikro.tx" -> "mikro .tx "), so the user does not

have to take care of that. The file name and extension are case insensitive. The

library will convert them to the proper case automatically, so the user does not

have to take care of that.

Also, in order to keep backward compatibility with the first version of this library,

file names can be entered as UPPERCASE string of 11 bytes in length with no

dot character between the file name and extension (i.e. "MIKROELETXT" ->

MIKROELE.TXT). In this case the last 3 characters of the string are considered

to be file extension.

 file_attr: file creation and attributs flags. Each bit corresponds to the

appropriate file attribut:

252 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Description

Note: Long File Names (LFN) are not supported.

Requires CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

Example

program

'-------------- Try to create a swap file with archive atribute,

whose size will be at least 1000 sectors.

' If it succeeds, it sends the No. of start sec-

tor over USART

dim size as longword

...

main:

...

size = Cf_Fat_Get_Swap_File(1000, "mikroE.txt", 0x20)

if size then

UART1_Write(0xAA)

UART1_Write(Lo(size))

UART1_Write(Hi(size))

UART1_Write(Higher(size))

UART1_Write(Highest(size))

UART1_Write(0xAA)

end if

end.

Bit Mask Description

0 0x01 Read Only

1 0x02 Hidden

2 0x04 System

3 0x08 Volume Label

4 0x10 Subdirectory

5 0x20 Archive

6 0x40 Device (internal use only, never found on disk)

7 0x80 Not used

253

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Library Example

The following example demonstrates various aspects of the Cf_Fat16 library:

Creation of new file and writing down to it; Opening existing file and re-writing it (writ-

ing from start-of-file); Opening existing file and appending data to it (writing from

end-of-file); Opening a file and reading data from it (sending it to USART terminal);

Creating and modifying several files at once;

program CF_Fat16_Test

' set compact flash pinout

dim

Cf_Data_Port as byte at PORTD

CF_RDY as sbit at RB7_bit

CF_WE as sbit at RB6_bit

CF_OE as sbit at RB5_bit

CF_CD1 as sbit at RB4_bit

CF_CE1 as sbit at RB3_bit

CF_A2 as sbit at RB2_bit

CF_A1 as sbit at RB1_bit

CF_A0 as sbit at RB0_bit

CF_RDY_direction as sbit at TRISB7_bit

CF_WE_direction as sbit at TRISB6_bit

CF_OE_direction as sbit at TRISB5_bit

CF_CD1_direction as sbit at TRISB4_bit

CF_CE1_direction as sbit at TRISB3_bit

CF_A2_direction as sbit at TRISB2_bit

CF_A1_direction as sbit at TRISB1_bit

CF_A0_direction as sbit at TRISB0_bit

' end of cf pinout

FAT_TXT as string[20]

file_contents as string[50]

filename as string[14] ' File names

character as byte

loop_, loop2 as byte

size as longint

Buffer as byte[512]

'-------------- Writes string to USART

sub procedure Write_Str(dim byref ostr as byte[2] )

dim

i as byte

i = 0

while ostr[i] <> 0

UART1_Write(ostr[i])

Inc(i)

wend

UART1_Write($0A)

end sub

'-------------- Creates new file and writes some data to it

sub procedure Create_New_File

filename[7] = "A"

Cf_Fat_Assign(filename, 0xA0) ' Will not find file and then

create file

Cf_Fat_Rewrite() ' To clear file and start with

new data

for loop_=1 to 90 ' We want 5 files on the MMC

card

PORTC = loop_

file_contents[0] = loop_ div 10 + 48

file_contents[1] = loop_ mod 10 + 48

Cf_Fat_Write(file_contents, 38) ' write data to the assigned file

UART1_Write(".")

next loop_

end sub

'-------------- Creates many new files and writes data to them

sub procedure Create_Multiple_Files

for loop2 = "B" to "Z"

UART1_Write(loop2) ' this line can slow down the performance

filename[7] = loop2 ' set filename

Cf_Fat_Assign(filename, 0xA0) ' find existing file or cre-

ate a new one

Cf_Fat_Rewrite ' To clear file and start

with new data

for loop_ = 1 to 44

file_contents[0] = loop_ div 10 + 48

file_contents[1] = loop_ mod 10 + 48

Cf_Fat_Write(file_contents, 38) ' write data to the assigned

file

next loop_

next loop2

end sub

'-------------- Opens an existing file and rewrites it

254 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

255

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

sub procedure Open_File_Rewrite

filename[7] = "C" ' Set filename for single-file

tests

Cf_Fat_Assign(filename, 0)

Cf_Fat_Rewrite

for loop_ = 1 to 55

file_contents[0] = byte(loop_ div 10 + 48)

file_contents[1] = byte(loop_ mod 10 + 48)

Cf_Fat_Write(file_contents, 38) ' write data to the assigned file

next loop_

end sub

'-------------- Opens an existing file and appends data to it

' (and alters the date/time stamp)

sub procedure Open_File_Append

filename[7] = "B"

Cf_Fat_Assign(filename, 0)

Cf_Fat_Set_File_Date(2005,6,21,10,35,0)

Cf_Fat_Append

file_contents = " for mikroElektronika 2005" ' Prepare file

for append

file_contents[26] = 10 ' LF

Cf_Fat_Write(file_contents, 27) ' Write data to assigned

file

end sub

'-------------- Opens an existing file, reads data from it and puts

it to USART

sub procedure Open_File_Read

filename[7] = "B"

Cf_Fat_Assign(filename, 0)

Cf_Fat_Reset(size) ' To read file, sub procedure

returns size of file

while size > 0

Cf_Fat_Read(character)

UART1_Write(character) ' Write data to USART

Dec(size)

wend

end sub

'-------------- Deletes a file. If file doesn"t exist, it will first

be created

' and then deleted.

sub procedure Delete_File

filename[7] = "F"

Cf_Fat_Assign(filename, 0)

Cf_Fat_Delete

end sub

'-------------- Tests whether file exists, and if so sends its cre-

ation date

' and file size via USART

sub procedure Test_File_Exist(dim fname as byte)

dim

fsize as longint

year as word

month_, day, hour_, minute_ as byte

outstr as byte[12]

filename[7] = "B" ' uncomment this line to search for file

that DOES exists

' filename[7] = "F" ' uncomment this line to search for file

that DOES NOT exist

if Cf_Fat_Assign(filename, 0) <> 0 then

'--- file has been found - get its date

Cf_Fat_Get_File_Date(year,month_,day,hour_,minute_)

WordToStr(year, outstr)

Write_Str(outstr)

ByteToStr(month_, outstr)

Write_Str(outstr)

WordToStr(day, outstr)

Write_Str(outstr)

WordToStr(hour_, outstr)

Write_Str(outstr)

WordToStr(minute_, outstr)

Write_Str(outstr)

'--- get file size

fsize = Cf_Fat_Get_File_Size

LongIntToStr(fsize, outstr)

Write_Str(outstr)

else

'--- file was not found - signal it

UART1_Write(0x55)

Delay_ms(1000)

UART1_Write(0x55)

end if

end sub

'-------------- Tries to create a swap file, whose size will be at

least 100

' sectors (see Help for details)

sub procedure M_Create_Swap_File

dim i as word

for i=0 to 511

Buffer[i] = i

next i

size = Cf_Fat_Get_Swap_File(5000, "mikroE.txt", 0x20) ' see

help on this sub function for details

256 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

257

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

if (size <> 0) then

LongIntToStr(size, fat_txt)

Write_Str(fat_txt)

for i=0 to 4999

Cf_Write_Sector(size, Buffer)

size = size+1

UART1_Write(".")

next i

end if

end sub

'-------------- Main. Uncomment the sub function(s) to test the

desired operation(s)

main:

FAT_TXT = "FAT16 not found"

file_contents = "XX CF FAT16 library by Anton Rieckert"

file_contents[37] = 10 ' newline

filename = "MIKRO00xTXT"

ADCON1 = ADCON1 or 0x0F ' Configure pins as digital I/O

TRISC = 0 ' we will use PORTC to signal test end

PORTC = 0

UART1_Init(19200) ' Set up USART for file reading

delay_ms(100)

UART1_Write_Text(":Start:")

' --- Init the FAT library

' --- use Cf_Fat_QuickFormat instead of init routine if a for-

mat is needed

if Cf_Fat_Init() = 0 then

'--- test sub functions

'----- test group #1

Create_New_File()

Create_Multiple_Files()

'----- test group #2

Open_File_Rewrite()

Open_File_Append()

Delete_File

'----- test group #3

Open_File_Read()

Test_File_Exist("F")

M_Create_Swap_File()

'--- Test termination

UART1_Write(0xAA)

else

UART1_Write_Text(FAT_TXT)

end if

'--- signal end-of-test

UART1_Write_Text(":End:")

end.

HW Connection

Pin diagram of CF memory card

258 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

259

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

EEPROM LIBRARY

EEPROM data memory is available with a number of PIC MCUs. mikroBasic

PRO for PIC includes library for comfortable work with EEPROM.

Library Routines

EEPROM_Read

 EEPROM_Write

EEPROM_Read

Prototype sub function EEPROM_Read(dim Address as word) as byte

Returns Returns byte from specified address.

Description

Reads data from specified address. Parameter address is of byte type, which

means it can address only 256 locations. For PIC18 micros with more EEPROM

data locations, it is programmer’s responsibility to set SFR EEADRH register

appropriately.

Requires

Requires EEPROM module.

Ensure minimum 20ms delay between successive use of routines

EEPROM_Write and EEPROM_Read. Although PIC will write the correct value,

EEPROM_Read might return an undefined result.

Example tmp = EEPROM_Read($3F)

260 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

EEPROM_Write

Library Example

The example writes values at 20 successive locations of EEPROM. Then, it reads

the written data and prints on PORTB for a visual check.

program Eeprom

dim counter as byte ' loop variable

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

PORTB = 0

PORTC = 0

PORTD = 0

TRISB = 0

TRISC = 0

TRISD = 0

for counter = 0 to 31 ' Fill data buffer

EEPROM_Write(0x80+counter, counter) 'Write data to address 0x80+ii

next counter

EEPROM_Write(0x02,0xAA) ' Write some data at address 2

EEPROM_Write(0x50,0x55) ' Write some data at address 0150

Prototype sub procedure EEPROM_Write(dim Address as word, dim Data as byte)

Returns Nothing.

Description

Writes data to specified address. Parameter address is of byte type, which

means it can address only 256 locations. For PIC18 micros with more EEPROM

data locations, it is programmer’s responsibility to set SFR EEADRH register

appropriately.

Be aware that all interrupts will be disabled during execution of EEPROM_Write rou-

tine (GIE bit of INTCON register will be cleared). Routine will set this bit on exit.

Requires

Requires EEPROM module.

Ensure minimum 20ms delay between successive use of routines

EEPROM_Write and EEPROM_Read. Although PIC will write the correct value,

EEPROM_Read might return an undefined result.

Example EEPROM_Write($32)

261

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Delay_ms(1000) ' Blink PORTB and PORTC diodes

PORTB = 0xFF ' to indicate reading start

PORTC = 0xFF

Delay_ms(1000)

PORTB = 0x00

PORTC = 0x00

Delay_ms(1000)

PORTB = EEPROM_Read(0x02) ' Read data from address 2 and dis

play

it on PORTB

PORTC = EEPROM_Read(0x50) ' Read data from address 0x50 and dis

play it on PORTC

Delay_ms(1000)

for counter = 0 to 31 ' Read 32 bytes block from address

0x100

PORTD = EEPROM_Read(0x80+counter) ' and display data on PORTC

Delay_ms(100)

next counter

end.

Ethernet PIC18FxxJ60 Library

PIC18FxxJ60 family of microcontrollers feature an embedded Ethernet controller

module. This is a complete connectivity solution, including full implementations of

both Media Access Control (MAC) and Physical Layer transceiver (PHY) modules.

Two pulse transformers and a few passive components are all that are required to

connect the microcontroller directly to an Ethernet network.

The Ethernet module meets all of the IEEE 802.3 specifications for 10-BaseT con-

nectivity to a twisted-pair network. It incorporates a number of packet filtering

schemes to limit incoming packets. It also provides an internal DMA module for fast

data throughput and hardware assisted IP checksum calculations. Provisions are

also made for two LED outputs to indicate link and network activity

This library provides the posibility to easily utilize ethernet feature of the above men-

tioned MCUs.

Ethernet PIC18FxxJ60 library supports:

 IPv4 protocol.

 ARP requests.

 ICMP echo requests.

 UDP requests.

 TCP requests (no stack, no packet reconstruction).

 ARP client with cache.

 DNS client.

 UDP client.

 DHCP client.

 packet fragmentation is NOT supported.

Note: Global library variable Ethernet_userTimerSec is used to keep track of time

for all client implementations (ARP, DNS, UDP and DHCP). It is user responsibility

to increment this variable each second in it's code if any of the clients is used.

Note: For advanced users there are header files ("eth_j60LibDef.h" and

"eth_j60LibPrivate.h") in Uses\P18 folder of the compiler with description of all

routines and global variables, relevant to the user, implemented in the Ethernet

PIC18FxxJ60 Library.

262 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Library Routines

 Ethernet_Init

 Ethernet_Enable

 Ethernet_Disable

 Ethernet_doPacket

 Ethernet_putByte

 Ethernet_putBytes

 Ethernet_putString

 Ethernet_putConstString

 Ethernet_putConstBytes

 Ethernet_getByte

 Ethernet_getBytes

 Ethernet_UserTCP

 Ethernet_UserUDP

 Ethernet_getIpAddress

 Ethernet_getGwIpAddress

 Ethernet_getDnsIpAddress

 Ethernet_getIpMask

 Ethernet_confNetwork

 Ethernet_arpResolve

 Ethernet_sendUDP

 Ethernet_dnsResolve

 Ethernet_initDHCP

 Ethernet_doDHCPLeaseTime

 Ethernet_renewDHCP

263

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Ethernet_Init

264 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_Init(dim byref mac as byte, dim byref ip

as byte, dim fullDuplex as byte)

Returns Nothing.

Description

This is MAC module routine. It initializes Ethernet controller. This function is

internaly splited into 2 parts to help linker when coming short of memory.

Ethernet controller settings (parameters not mentioned here are set to default):

 receive buffer start address : 0x0000.

 receive buffer end address : 0x19AD.

 transmit buffer start address: 0x19AE.

 transmit buffer end address : 0x1FFF.

 RAM buffer read/write pointers in auto-increment mode.

 receive filters set to default: CRC + MAC Unicast + MAC Broad cast in OR mode.

 flow control with TX and RX pause frames in full duplex mode.

 frames are padded to 60 bytes + CRC.

 maximum packet size is set to 1518.



Back-to-Back Inter-Packet Gap: 0x15 in full duplex mode;0x12 in half duplex mode.

 Non-Back-to-Back Inter-Packet Gap: 0x0012 in full duplex mode; 0x0C12 in

half duplex mode.

 half duplex loopback disabled.

 LED configuration: default (LEDA-link status, LEDB-link activity).

Parameters:

mac: RAM buffer containing valid MAC address.

ip: RAM buffer containing valid IP address.

 fullDuplex: ethernet duplex mode switch. Valid values: 0(half duplex mode,

predefined library const Ethernet_HALFDUPLEX) and 1(full duplex mode, prede-

fined library const Ethernet_FULLDUPLEX).

Note: If a DHCP server is to be used, IP address should be set to 0.0.0.0.

Requires Nothing.

Example

dim

myMacAddr as byte[6] ' my MAC address

myIpAddr as byte[4] ' my IP addr

...

myMacAddr[0] = 0x00

myMacAddr[1] = 0x14

myMacAddr[2] = 0xA5

myMacAddr[3] = 0x76

myMacAddr[4] = 0x19

myMacAddr[5] = 0x3F

myIpAddr[0] = 192

myIpAddr[1] = 168

myIpAddr[2] = 20

myIpAddr[3] = 60

Ethernet_Init(myMacAddr, myIpAddr, Ethernet_FULLDUPLEX)

Ethernet_Enable

265

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_Enable(dim enFlt as byte)

Returns Nothing.

Description

This is MAC module routine. This routine enables appropriate network traffic on

the MCU's internal Ethernet module by the means of it's receive filters (unicast,

multicast, broadcast, crc). Specific type of network traffic will be enabled if a

corresponding bit of this routine's input parameter is set. Therefore, more than

one type of network traffic can be enabled at the same time. For this purpose,

predefined library constants (see the table below) can be ORed to form appro-

priate input value.

Parameters:

 enFlt: network traffic/receive filter flags. Each bit corresponds to the

appropriate network traffic/receive filter:

Note: Advance filtering available in the MCU's internal Ethernet module such as

Pattern Match, Magic Packet and Hash Table can not be enabled by this

routine. Additionaly, all filters, except CRC, enabled with this routine will work in

OR mode, which means that packet will be received if any of the enabled filters

accepts it.

Note: This routine will change receive filter configuration on-the-fly. It will not, in

any way, mess with enabling/disabling receive/transmit logic or any other part of

the MCU's internal Ethernet module. The MCU's internal Ethernet module

should be properly cofigured by the means of Ethernet_Init routine.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example Ethernet_Enable(_Ethernet_CRC or _Ethernet_UNICAST) ' enable CRC

checking and Unicast traffic

Bit Mask Description Predefined library const

0 0x01 MAC Broadcast traffic/receive filter flag. When

set, MAC broadcast traffic will be enabled. _Ethernet_BROADCAST

1 0x02 MAC Multicast traffic/receive filter flag. When

set, MAC multicast traffic will be enabled. _Ethernet_MULTICAST

2 0x04 not used none

3 0x08 not used none

4 0x10 not used none

5 0x20 CRC check flag. When set, packets with

invalid CRC field will be discarded. _Ethernet_CRC

6 0x40 not used none

7 0x80 MAC Unicast traffic/receive filter flag. When

set, MAC unicast traffic will be enabled. _Ethernet_UNICAST

Ethernet_Disable

266 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_Disable(dim disFlt as byte)

Returns Nothing.

Description

This is MAC module routine. This routine disables appropriate network traffic on

the MCU's internal Ethernet module by the means of it's receive filters (unicast,

multicast, broadcast, crc). Specific type of network traffic will be disabled if a

corresponding bit of this routine's input parameter is set. Therefore, more than

one type of network traffic can be disabled at the same time. For this purpose,

predefined library constants (see the table below) can be ORed to form appro-

priate input value.

Parameters:

disFlt: network traffic/receive filter flags. Each bit corresponds to the

appropriate network traffic/receive filter:

Note: Advance filtering available in the MCU's internal Ethernet module such as

Pattern Match, Magic Packet and Hash Table can not be disabled by this

routine.

Note: This routine will change receive filter configuration on-the-fly. It will not, in

any way, mess with enabling/disabling receive/transmit logic or any other part of

the MCU's internal Ethernet module. The MCU's internal Ethernet module

should be properly cofigured by the means of Ethernet_Init routine.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example Ethernet_Enable(_Ethernet_CRC or _Ethernet_UNICAST) ' enable CRC

checking and Unicast traffic

Bit Mask Description Predefined library const

0 0x01 MAC Broadcast traffic/receive filter flag. When

set, MAC broadcast traffic will be disabled. _Ethernet_BROADCAST

1 0x02 MAC Multicast traffic/receive filter flag. When

set, MAC multicast traffic will be disabled. _Ethernet_MULTICAST

2 0x04 not used none

3 0x08 not used none

4 0x10 not used none

5 0x20

CRC check flag. When set, CRC check will

be disabled and packets with invalid CRC

field will be accepted.

_Ethernet_CRC

6 0x40 not used none

7 0x80 MAC Unicast traffic/receive filter flag. When

set, MAC unicast traffic will be disabled. _Ethernet_UNICAST

Ethernet_doPacket

267

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure EEPROM_Write(dim Address as word, dim Data as byte)

Returns

0 - upon successful packet processing (zero packets received or received

packet processed successfully).

 1 - upon reception error or receive buffer corruption. Ethernet controller

needs to be restarted.

 2 - received packet was not sent to us (not our IP, nor IP broadcast address).

 3 - received IP packet was not IPv4.

 4 - received packet was of type unknown to the library.

Description

This is MAC module routine. It processes next received packet if such exists.

Packets are processed in the following manner:

 ARP & ICMP requests are replied automatically.

 upon TCP request the Ethernet_UserTCP function is called for further processing.

 upon UDP request the Ethernet_UserUDP function is called for further processing.

Note: Ethernet_doPacket must be called as often as possible in user's code.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

while true

...

Ethernet_doPacket() ' process received packets

...

wend

Ethernet_putByte

Ethernet_putBytes

268 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_putByte(dim vas byte)

Returns Nothing.

Description

This is MAC module routine. It stores one byte to address pointed by the cur-

rent Ethernet controller's write pointer (EWRPT).

Parameters:

 v: value to store

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

data as byte

...

Ethernet_putByte(data) ' put an byte into ethernet buffer

Prototype sub procedure Ethernet_putBytes(dim ptr as ^byte, dim n as byte)

Returns Nothing.

Description

This is MAC module routine. It stores requested number of bytes into Ethernet

controller's RAM starting from current Ethernet controller's write pointer

(EWRPT) location.

Parameters:

 ptr: RAM buffer containing bytes to be written into Ethernet controller's RAM.

 n: number of bytes to be written

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

buffer as byte[17]

...

buffer = "mikroElektronika"

...

Ethernet_putBytes(buffer, 16) ' put an RAM array into ethernet

buffer

Ethernet_putConstBytes

Ethernet_putString

269

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_putConstBytes(const ptr as ^byte, dim nas

byte)

Returns Nothing.

Description

This is MAC module routine. It stores requested number of const bytes into Eth-

ernet controller's RAM starting from current Ethernet controller's write pointer

(EWRPT) location.

Parameters:

 ptr: const buffer containing bytes to be written into Ethernet controller's RAM.

 n: number of bytes to be written.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

const

buffer as byte[17]

...

buffer = "mikroElektronika"

...

Ethernet_putConstBytes(buffer, 16) ' put a const array into

ethernet buffer

Prototype sub function Ethernet_putString(dim ptr as ^byte)as word

Returns Number of bytes written into Ethernet controller's RAM.

Description

This is MAC module routine. It stores whole string (excluding null termination)

into Ethernet controller's RAM starting from current Ethernet controller's write

pointer (EWRPT) location.

Parameters:

 ptr: string to be written into Ethernet controller's RAM.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

buffer as string[16]

...

buffer = "mikroElektronika"

...

Ethernet_putString(buffer) ' put a RAM string into ethernet

buffer

Ethernet_putConstString

Ethernet_getByte

270 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_putConstString(const ptr as ^byte)as word

Returns Number of bytes written into Ethernet controller's RAM.

Description

This is MAC module routine. It stores whole const string (excluding null termina-

tion) into Ethernet controller's RAM starting from current Ethernet controller's

write pointer (EWRPT) location.

Parameters:

 ptr: const string to be written into Ethernet controller's RAM.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

const

buffer as string[16]

...

buffer = "mikroElektronika"

...

Ethernet_putConstString(buffer) ' put a const string into eth-

ernet buffer

Prototype sub function Ethernet_getByte() as byte

Returns Byte read from Ethernet controller's RAM.

Description This is MAC module routine. It fetches a byte from address pointed to by cur-

rent Ethernet controller's read pointer (ERDPT).

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

buffer as byte

...

buffer = Ethernet_getByte() ' read a byte from ethernet

buffer

Ethernet_getBytes

271

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_getBytes(dim ptr as ^byte, dim addr as

word, dim nas byte)

Returns Nothing.

Description

This is MAC module routine. It fetches equested number of bytes from Ethernet

controller's RAM starting from given address. If value of 0xFFFF is passed as

the address parameter, the reading will start from current Ethernet controller's

read pointer (ERDPT) location.

Parameters:

 ptr: buffer for storing bytes read from Ethernet controller's RAM.

 addr: Ethernet controller's RAM start address. Valid values: 0..8192.

 n: number of bytes to be read.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

buffer as byte[16]

...

Ethernet_getBytes(buffer, 0x100, 16) ' read 16 bytes, starting

from address 0x100

Ethernet_UserTCP

272 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_UserTCP(dim byref remoteHost as byte[4],

dim remotePort, localPort, reqLength as word) as word

Returns  0 - there should not be a reply to the request.

 Length of TCP/HTTP reply data field - otherwise.

Description

This is TCP module routine. It is internally called by the library. The user

accesses to the TCP/HTTP request by using some of the Ethernet_get routines.

The user puts data in the transmit buffer by using some of the Ethernet_put rou-

tines. The function must return the length in bytes of the TCP/HTTP reply, or 0 if

there is nothing to transmit. If there is no need to reply to the TCP/HTTP

requests, just define this function with return(0) as a single statement.

Parameters:

 remoteHost: client's IP address.

 remotePort: client's TCP port.

 localPort: port to which the request is sent.

 reqLength: TCP/HTTP request data field length.

Note: The function source code is provided with appropriate example projects.

The code should be adjusted by the user to achieve desired reply.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example This function is internally called by the library and should not be called by the

user's code.

Ethernet_UserUDP

273

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_UserUDP(dim byref remoteHost as byte[4],

dim remotePort, destPort, reqLength as word) as word

Returns  0 - there should not be a reply to the request.

 Length of UDP reply data field - otherwise.

Description

This is UDP module routine. It is internally called by the library. The user

accesses to the UDP request by using some of the Ethernet_get routines. The

user puts data in the transmit buffer by using some of the Ethernet_put routines.

The function must return the length in bytes of the UDP reply, or 0 if nothing to

transmit. If you don't need to reply to the UDP requests, just define this function

with a return(0) as single statement.

Parameters:

 remoteHost: client's IP address.

 remotePort: client's port.

 destPort: port to which the request is sent.

 reqLength: UDP request data field length.

Note: The function source code is provided with appropriate example projects.

The code should be adjusted by the user to achieve desired reply.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example This function is internally called by the library and should not be called by the

user's code.

Ethernet_getIpAddress

Ethernet_getGwIpAddress

274 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_getIpAddress() as word

Returns Ponter to the global variable holding IP address.

Description

This routine should be used when DHCP server is present on the network to

fetch assigned IP address.

Note: User should always copy the IP address from the RAM location returned

by this routine into it's own IP address buffer. These locations should not be

altered by the user in any case!

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

ipAddr as byte[4] ' user IP address buffer

...

memcpy(ipAddr, Ethernet_getIpAddress(), 4) ' fetch IP address

Prototype sub function Ethernet_getGwIpAddress() as word

Returns Ponter to the global variable holding gateway IP address.

Description

This routine should be used when DHCP server is present on the network to

fetch assigned gateway IP address.

Note: User should always copy the IP address from the RAM location returned

by this routine into it's own gateway IP address buffer. These locations should

not be altered by the user in any case!

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

gwIpAddr as byte[4] ' user gateway IP address buffer

...

memcpy(gwIpAddr, Ethernet_getGwIpAddress(), 4) ' fetch gateway

IP address

Ethernet_getDnsIpAddress

Ethernet_getIpMask

275

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_getDnsIpAddress() as word

Returns Ponter to the global variable holding DNS IP address.

Description

This routine should be used when DHCP server is present on the network to

fetch assigned DNS IP address.

Note: User should always copy the IP address from the RAM location returned

by this routine into it's own DNS IP address buffer. These locations should not

be altered by the user in any case!

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

dnsIpAddr as byte[4] ' user DNS IP address buffer

...

memcpy(dnsIpAddr, Ethernet_getDnsIpAddress(), 4) ' fetch DNS

server address

Prototype sub function Ethernet_getIpMask() as word

Returns Ponter to the global variable holding IP subnet mask.

Description

This routine should be used when DHCP server is present on the network to

fetch assigned IP subnet mask.

Note: User should always copy the IP address from the RAM location returned

by this routine into it's own IP subnet mask buffer. These locations should not

be altered by the user in any case!

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

IpMask as byte[4] ' user IP subnet mask buffer

...

memcpy(IpMask, Ethernet_getIpMask(), 4) ' fetch IP subnet mask

Ethernet_confNetwork

276 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Ethernet_confNetwork(dim byref ipMask, gwIpAddr,

dnsIpAddr as byte[4])

Returns Nothing.

Description

Configures network parameters (IP subnet mask, gateway IP address, DNS IP

address) when DHCP is not used.

Parameters:

 ipMask: IP subnet mask.

 gwIpAddr gateway IP address.

 dnsIpAddr: DNS IP address.

Note: The above mentioned network parameters should be set by this routine

only if DHCP module is not used. Otherwise DHCP will override these settings.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

ipMask as byte[4] ' network mask (for example :

255.255.255.0)

gwIpAddr as byte[4] ' gateway (router) IP address

dnsIpAddr as byte[4] ' DNS server IP address

...

gwIpAddr[0] = 192

gwIpAddr[1] = 168

gwIpAddr[2] = 20

gwIpAddr[3] = 6

dnsIpAddr[0] = 192

dnsIpAddr[1] = 168

dnsIpAddr[2] = 20

dnsIpAddr[3] = 100

ipMask[0] = 255

ipMask[1] = 255

ipMask[2] = 255

ipMask[3] = 0

...

Ethernet_confNetwork(ipMask, gwIpAddr, dnsIpAddr) ' set network

configuration parameters

Ethernet_arpResolve

277

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_arpResolve(dim byref ip as byte[4], dim

tmax as byte)as word

Returns  MAC address behind the IP address - the requested IP address was resolved.

 0 - otherwise.

Description

This is ARP module routine. It sends an ARP request for given IP address and

waits for ARP reply. If the requested IP address was resolved, an ARP cash

entry is used for storing the configuration. ARP cash can store up to 3 entries.

For ARP cash structure refer to "eth_j60LibDef.h" header file in the compil-

er's Uses/P18 folder.

Parameters:

 ip: IP address to be resolved.

 tmax: time in seconds to wait for an reply.

Note: The Ethernet services are not stopped while this routine waits for ARP

reply. The incoming packets will be processed normaly during this time.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

IpAddr as byte[4] ' IP address

...

IpAddr[0] = 192

IpAddr[0] = 168

IpAddr[0] = 1

...

Ethernet_arpResolve(IpAddr, 5) ' get MAC address behind the

above IP address, wait 5 secs for the response

Ethernet_sendUDP

278 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype

sub function Ethernet_sendUDP(dim byref destIP as byte[4], dim

sourcePort, destPort as word, dim pkt as ^byte, dim pktLen as

word)as byte

Returns  1 - UDP packet was sent successfully.

 0 - otherwise.

Description

This is UDP module routine. It sends an UDP packet on the network.

Parameters:

 destIP: remote host IP address.

 sourcePort: local UDP source port number.

 destPort: destination UDP port number.

 pkt: packet to transmit.

 pktLen: length in bytes of packet to transmit.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

IpAddr as byte[4] ' remote IP address

...

IpAddr[0] = 192

IpAddr[0] = 168

IpAddr[0] = 1

...

Ethernet_sendUDP(IpAddr, 10001, 10001, "Hello", 5) ' send Hello

message to the above IP address, from UDP port 10001 to UDP port

10001

Ethernet_dnsResolve

279

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_dnsResolve(dim byref host as byte[4], dim

tmax as byte) as word

Returns

 pointer to the location holding the IP address - the requested host name

was resolved.

 0 - otherwise.

Description

This is DNS module routine. It sends an DNS request for given host name and

waits for DNS reply. If the requested host name was resolved, it's IP address is

stored in library global variable and a pointer containing this address is returned

by the routine. UDP port 53 is used as DNS port.

Parameters:

 host: host name to be resolved.

 tmax: time in seconds to wait for an reply.

Note: The Ethernet services are not stopped while this routine waits for DNS

reply. The incoming packets will be processed normaly during this time.

Note: User should always copy the IP address from the RAM location returned

by this routine into it's own resolved host IP address buffer. These locations

should not be altered by the user in any case!

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

dim

remoteHostIpAddr as byte[4] ' user host IP address buffer

...

' SNTP server:

' Zurich, Switzerland: Integrated Systems Lab, Swiss Fed. Inst.

of Technology

' 129.132.2.21: swisstime.ethz.ch

' Service Area: Switzerland and Europe

memcpy(remoteHostIpAddr,

Ethernet_dnsResolve("swisstime.ethz.ch", 5), 4)

Ethernet_initDHCP

280 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_initDHCP(dim tmax as byte) as byte

Returns  1 - network parameters were obtained successfully.

 0 - otherwise.

Description

This is DHCP module routine. It sends an DHCP request for network parame-

ters (IP, gateway, DNS addresses and IP subnet mask) and waits for DHCP

reply. If the requested parameters were obtained successfully, their values are

stored into the library global variables.

These parameters can be fetched by using appropriate library IP get routines:

 Ethernet_getIpAddress - fetch IP address.

 Ethernet_getGwIpAddress - fetch gateway IP address.

 Ethernet_getDnsIpAddress - fetch DNS IP address.

 Ethernet_getIpMask - fetch IP subnet mask.

UDP port 68 is used as DHCP client port and UDP port 67 is used as DHCP

server port.

Parameters:

 tmax: time in seconds to wait for an reply.

Note: The Ethernet services are not stopped while this routine waits for DNS

reply. The incoming packets will be processed normaly during this time.

Note: When DHCP module is used, global library variable

Ethernet_userTimerSec is used to keep track of time. It is user responsibility

to increment this variable each second in it's code.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

...

Ethernet_initDHCP(5) ' get network configuration from DHCP

server, wait 5 sec for the response

...

Ethernet_doDHCPLeaseTime

Ethernet_renewDHCP

281

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Ethernet_doDHCPLeaseTime() as byte

Returns  0 - lease time has not expired yet.

 1 - lease time has expired, it's time to renew it.

Description

This is DHCP module routine. It takes care of IP address lease time by decre-

menting the global lease time library counter. When this time expires, it's time to

contact DHCP server and renew the lease.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

while true

...

if(Ethernet_doDHCPLeaseTime() <> 0) then

... ' it's time to renew the IP address lease

end if

wend

Prototype sub function Ethernet_renewDHCP(dim tmax as byte)as byte

Returns  1 - upon success (lease time was renewed).

 0 - otherwise (renewal request timed out).

Description

This is DHCP module routine. It sends IP address lease time renewal request to

DHCP server.

Parameters:

 tmax: time in seconds to wait for an reply.

Requires Ethernet module has to be initialized. See Ethernet_Init.

Example

while true

...

if(Ethernet_doDHCPLeaseTime() <> 0) then

Ethernet_renewDHCP(5) ' it's time to renew the IP address

lease, with 5 secs for a reply

end if

...

wend

Library Example

This code shows how to use the PIC18FxxJ60 Ethernet library :

 the board will reply to ARP & ICMP echo requests

 the board will reply to UDP requests on any port :

returns the request in upper char with a header made of remote

host IP & port number

 the board will reply to HTTP requests on port 80, GET method with path

names :

/ will return the HTML main page

/s will return board status as text string

/t0 ... /t7 will toggle RD0 to RD7 bit and return HTML main

page

all other requests return also HTML main page.

program enc_ethernet

' ***********************************

' * RAM variables

' *

dim myMacAddr as byte[6] ' my MAC address

myIpAddr as byte[4] ' my IP address

gwIpAddr as byte[4] ' gateway (router) IP address

ipMask as byte[4] ' network mask (for example:

255.255.255.0)

dnsIpAddr as byte[4] ' DNS server IP address

const httpHeader as string[31] = "HTTP/1.1 200 OK"+chr(10)+"Content-

type: " ' HTTP header

const httpMimeTypeHTML as string[13] = "text/html"+chr(10)+chr(10)

' HTML MIME type

const httpMimeTypeScript as string[14] =

"text/plain"+chr(10)+chr(10) ' TEXT MIME type

const httpMethod as string[5] = "GET /"

' *

' * web page, splited into 2 parts :

' * when coming short of ROM, fragmented data is handled more effi-

ciently by linker

' *

' * this HTML page calls the boards to get its status, and builds

itself with javascript

' *

const indexPage as string[763] =

282 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

"<meta http-equiv=" + Chr(34) + "refresh" + Chr(34) + " con

tent=" + Chr(34) + "3;url=http://192.168.20.60" + Chr(34) +

">" +

"<HTML><HEAD></HEAD><BODY>"+

"<h1>PIC18FxxJ60 Mini Web Server</h1>"+

"<a href=/>Reload</a>"+

"<script src=/s></script>"+

"<table><tr><td valign=top><table border=1

style="+chr(34)+"font-size:20px ;font-family: terminal

;"+chr(34)+"> "+

"<tr><th colspan=2>ADC</th></tr>"+

"<tr><td>AN2</td><td><script>document.write(AN2)</script>

</td></tr>"+

"<tr><td>AN3</td><td><script>document.write(AN3)

</script></td></tr>"+

"</table></td><td><table border=1 style="+chr(34)+"font-

size:20px ;font-family: terminal ;"+chr(34)+"> "+

"<tr><th colspan=2>PORTB</th></tr>"+

"<script>"+

"var str,i;"+

"str="+chr(34)+chr(34)+"; "+

"for(i=0;i<8;i++)"+

"{str+="+chr(34)+"<tr><tb gcolor=pink>BUTTON #"+chr(34)+"+i+"

+chr(34)+"</td>"+chr(34)+"; "+

"if(PORTB&(1<<i)){str+="+chr(34)+"<td bgcolor=red>ON"

+chr(34)+";}"+

"else {str+="+chr(34)+"<td bgcolor=#cccccc>OFF"+chr(34)+";}"+

"str+="+chr(34)+"</td></tr>"+chr(34)+";}"+

"document.write(str) ;"+

"</script>"

const indexPage2 as string[470] =

"</table></td><td>"+

"<table border=1 style="+chr(34)+"font-size:20px ;font-fami

ly: terminal ;"+chr(34)+"> "+

"<tr><th colspan=3>PORTD</th></tr>"+

"<script>"+

"var str,i;"+

"str="+chr(34)+chr(34)+"; "+

"for(i=0;i<3;i++)"+

"{str+="+chr(34)+"<tr><td bgcolor=yellow>LED

#"+chr(34)+"+i+"+chr(34)+"</td>"+chr(34)+"; "+

"if(PORTD&(1<<i)){str+="+chr(34)+"<td bgcolor=red>ON"+chr

(34)+";}"+

"else {str+="+chr(34)+"<td bgcolor=#cccccc>OFF"+chr(34)+";}"+

"str+="+chr(34)+"</td><td><a href=/t"+chr(34)+"+i+"+chr(34)+

">Toggle</a></td></tr>"+chr(34)+";}"+

"document.write(str) ;"+

"</script>"

283

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

"</table></td></tr></table>"+

"This is HTTP request #<script>document.write(REQ)</script>

</BODY></HTML>"

dim getRequest as byte[15] ' HTTP request buffer

dyna as byte[30] ' buffer for dynamic response

httpCounter as word ' counter of HTTP requests

txt as string[11]

' *******************************************

' * user defined functions

' *

* this function is called by the library

' * the user accesses to the HTTP request by successive calls to

Ethernet_getByte()

' * the user puts data in the transmit buffer by successive calls to

Ethernet_putByte()

' * the function must return the length in bytes of the HTTP reply,

or 0 if nothing to transmit

' *

' * if you don't need to reply to HTTP requests,

' * just define this function with a return(0) as single statement

' *

sub function Ethernet_UserTCP(dim byref remoteHost as byte[4],

dim remotePort, localPort, reqLength as word) as word

dim i as word ' my reply length

bitMask as byte ' for bit mask

txt as string[11]

result = 0

if(localPort <> 80) then ' I listen only to web request on port

result = 0

exit

end if

'get 10 first bytes only of the request, the rest does not mat

ter here

for i = 0 to 10

getRequest[i] = Ethernet_getByte()

next i

getRequest[i] = 0

' copy httpMethod to ram for use in memcmp routine

for i = 0 to 4

txt[i] = httpMethod[i]

next i

284 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

if(memcmp(@getRequest, @txt, 5) <> 0) then ' only GET method

is supported here

result = 0

exit

end if

Inc(httpCounter) ' one more request done

if(getRequest[5] = "s") then ' if request path name

starts with s, store dynamic data in transmit buffer

' the text string replied by this request can be interpreted

as javascript statements

' by browsers

result = Ethernet_putConstString(@httpHeader) ' HTTP header

result = result + Ethernet_putConstString(@httpMimeTypeScript)

' with text MIME type

' add AN2 value to reply

WordToStr(ADC_Read(2), dyna)

txt = "var AN2="

result = result + Ethernet_putString(@txt)

result = result + Ethernet_putString(@dyna)

txt = ";"

result = result + Ethernet_putString(@txt)

' add AN3 value to reply

WordToStr(ADC_Read(3), dyna)

txt = "var AN3="

result = result + Ethernet_putString(@txt)

result = result + Ethernet_putString(@dyna)

txt = ";"

result = result + Ethernet_putString(@txt)

' add PORTB value (buttons) to reply

txt = "var PORTB="

result = result + Ethernet_putString(@txt)

WordToStr(PORTB, dyna)

result = result + Ethernet_putString(@dyna)

txt = ";"

result = result + Ethernet_putString(@txt)

' add PORTD value (LEDs) to reply

txt = "var PORTD="

result = result + Ethernet_putString(@txt)

WordToStr(PORTD, dyna)

result = result + Ethernet_putString(@dyna)

txt = ";"

result = result + Ethernet_putString(@txt)

285

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

' add HTTP requests counter to reply

WordToStr(httpCounter, dyna)

txt = "var REQ="

result = result + Ethernet_putString(@txt)

result = result + Ethernet_putString(@dyna)

txt = ";"

result = result + Ethernet_putString(@txt)

else

if(getRequest[5] = "t") then ' if request path name starts

with t, toggle PORTD (LED) bit number that comes after

bitMask = 0

if(isdigit(getRequest[6]) <> 0) then ' if 0 <= bit number

<= 9, bits 8 & 9 does not exist but does not matter

bitMask = getRequest[6] - "0" ' convert ASCII to integer

bitMask = 1 << bitMask ' create bit mask

PORTD = PORTD xor bitMask ' toggle PORTD with xor oper

ator

end if

if(result = 0) then ' what do to by default

result = Ethernet_putConstString(@httpHeader) ' HTTP header

result = result + Ethernet_putConstString(@httpMimeTypeHTML)

' with HTML MIME type

result = result + Ethernet_putConstString(@indexPage)

' HTML page first part

result = result + Ethernet_putConstString(@indexPage2)

' HTML page second part

end if

' return to the library with the number of bytes to transmit

end sub

' * this function is called by the library

' * the user accesses to the UDP request by successive calls to

Ethernet_getByte()

' * the user puts data in the transmit buffer by successive calls to

Ethernet_putByte()

' * the function must return the length in bytes of the UDP reply,

or 0 if nothing to transmit

' *

' * if you don't need to reply to UDP requests,

' * just define this function with a return(0) as single statement

' *

sub function Ethernet_UserUDP(dim byref remoteHost as byte[4],

dim remotePort, destPort, reqLength

as word) as word

286 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

dim txt as string[5]

result = 0

' reply is made of the remote host IP address in human readable

format

byteToStr(remoteHost[0], dyna) ' first IP address byte

dyna[3] = "."

byteToStr(remoteHost[1], txt) ' second

dyna[4] = txt[0]

dyna[5] = txt[1]

dyna[6] = txt[2]

dyna[7] = "."

byteToStr(remoteHost[2], txt) ' second

dyna[8] = txt[0]

dyna[9] = txt[1]

dyna[10] = txt[2]

dyna[11] = "."

byteToStr(remoteHost[3], txt) ' second

dyna[12] = txt[0]

dyna[13] = txt[1]

dyna[14] = txt[2]

dyna[15] = ":" ' add separator

' then remote host port number

WordToStr(remotePort, txt)

dyna[16] = txt[0]

dyna[17] = txt[1]

dyna[18] = txt[2]

dyna[19] = txt[3]

dyna[20] = txt[4]

dyna[21] = "["

WordToStr(destPort, txt)

dyna[22] = txt[0]

dyna[23] = txt[1]

dyna[24] = txt[2]

dyna[25] = txt[3]

dyna[26] = txt[4]

dyna[27] = "]"

dyna[28] = 0

' the total length of the request is the length of the dynam

ic string plus the text of the request

result = 28 + reqLength

' puts the dynamic string into the transmit buffer

Ethernet_putBytes(@dyna, 28)

'then puts the request string converted into upper char into

the transmit buffer

287

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

while(reqLength <> 0)

Ethernet_putByte(Ethernet_getByte())

reqLength = reqLength - 1

wend

' back to the library with the length of the UDP reply

end sub

main:

ADCON1 = 0x0B ' ADC convertors will be used with AN2 and AN3

CMCON = 0x07 ' turn off comparators

PORTA = 0

TRISA = 0x0C ' RA2:RA3 - analog inputs

' RA1:RA0 - ethernet LEDA:LEDB

PORTB = 0

TRISB = 0xFF ' set PORTB as input for buttons

PORTD = 0

TRISD = 0 ' set PORTD as output

httpCounter = 0

' set mac address

myMacAddr[0] = 0x00

myMacAddr[1] = 0x14

myMacAddr[2] = 0xA5

myMacAddr[3] = 0x76

myMacAddr[4] = 0x19

myMacAddr[5] = 0x3F

' set IP address

myIpAddr[0] = 192

myIpAddr[1] = 168

myIpAddr[2] = 20

myIpAddr[3] = 60

' set gateway address

gwIpAddr[0] = 192

gwIpAddr[1] = 168

gwIpAddr[2] = 20

gwIpAddr[3] = 6

' set dns address

dnsIpAddr[0] = 192

dnsIpAddr[1] = 168

dnsIpAddr[2] = 20

dnsIpAddr[3] = 1

288 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

'‘set subnet mask

ipMask[0] = 255

ipMask[1] = 255

ipMask[2] = 255

ipMask[3] = 0

' *

' * starts ENC28J60 with :

' * reset bit on PORTC.B0

' * CS bit on PORTC.B1

' * my MAC & IP address

' * full duplex

' *

Ethernet_Init(myMacAddr, myIpAddr, _Ethernet_FULLDUPLEX) ' init

ethernet module

Ethernet_setUserHandlers(@Ethernet_UserTCP, @Ethernet_UserUDP) '

set user handlers

' dhcp will not be used here, so use preconfigured addresses

Ethernet_confNetwork(ipMask, gwIpAddr, dnsIpAddr)

while TRUE ' do forever

Ethernet_doPacket() ' process incoming Ethernet packets

' *

' * add your stuff here if needed

' * Ethernet_doPacket() must be called as often as possible

' * otherwise packets could be lost

' *

wend

end.

289

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

FLASH MEMORY LIBRARY

This library provides routines for accessing microcontroller Flash memory. Note that

prototypes differ for PIC16 and PIC18 families.

Note: Due to the P16/P18 family flash specifics, flash library is MCU dependent.

Since the P18 family differ significantlly in number of bytes that can be erased

and/or written to specific MCUs, the appropirate suffix is added to the names of

functions in order to make it easier to use them. Flash memory operations are MCU

dependent :

1. Read operation supported. For this group of MCU's only read function is imple-

mented.

2. Read and Write operations supported (write is executed as erase-and-write). For

this group of MCU's read and write functions are implemented. Note that write oper-

ation which is executed as erase-and-write, may write less bytes than it erases.

3. Read, Write and Erase operations supported. For this group of MCU's read, write

and erase functions are implemented. Further more, flash memory block has to be

erased prior to writting (write operation is not executed as erase-and-write).

Please refer to MCU datasheet before using flash library.

Library Routines

FLASH_Read

 FLASH_Read_N_Bytes

 FLASH_Write

 FLASH_Write_8

 FLASH_Write_16

 FLASH_Write_32

 FLASH_Write_64

 FLASH_Erase

 FLASH_Erase_64

 FLASH_Erase_1024

 FLASH_Erase_Write

 FLASH_Erase_Write_64

 FLASH_Erase_Write_1024

290 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

FLASH_Read

FLASH_Read_N_Bytes

291

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype

' for PIC16

sub function FLASH_Read(dim Address as word) as word

' forPIC18

sub function FLASH_Read(dim address as dword)as byte

Returns Returns data byte from Flash memory.

Description Reads data from the specified address in Flash memory.

Requires Nothing.

Example

' for PIC18

dim tmp as byte

...

main:

...

tmp = FLASH_Read(0x0D00)

...

end.

Prototype

' for PIC18

sub procedure FLASH_Read_N_Bytes(dim address as longint, dim

byref data as byte, dim N as word)

Returns Nothing.

Description Reads N data from the specified address in Flash memory to varibale pointed

by data

Requires Nothing.

Example FLASH_Read_N(0x0D00,data_buffer,sizeof(data_buffer))

FLASH_Write

292 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype

' for PIC16

sub procedure FLASH_Write(dim Address as word, dim byref Data as

word[4])

' forPIC18

sub procedure FLASH_Write_8(dim address as dword,dim byref data

as byte[8])

sub procedure FLASH_Write_16(dim address as dword,dim byref data

as byte[16])

sub procedure FLASH_Write_32(dim address as dword, dim byref data

as byte[32])

sub procedure FLASH_Write_64(dim address as dword, dim byref data

as byte[64])

Returns Nothing.

Description

Writes block of data to Flash memory. Block size is MCU dependent.

P16: This function may erase memory segment before writing block of data to it

(MCU dependent). Furthermore, memory segment which will be erased may be

greater than the size of the data block that will be written (MCU dependent).

Therefore it is recommended to write as many bytes as you erase.

FLASH_Write writes 4 flash memory locations in a row, so it needs to be called

as many times as it is necessary to meet the size of the data block that will be

written.

P18: This function does not perform erase prior to write.

Requires Flash memory that will be written may have to be erased before this function is

called (MCU dependent). Refer to MCU datasheet for details.

Example

Write consecutive values in 64 consecutive locations, starting from 0x0D00:

dim toWrite as byte[64]

...

main:

...

'initialize array:

for i = 0 to 63

toWrite[i] = i

next i

...

' write contents of the array to the address 0x0D00:

FLASH_Write_64(0x0D00, toWrite)

...

end.

FLASH_Erase

FLASH_Erase_Write

293

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype

' for PIC16

sub procedure FLASH_Erase(dim address as word)

'forPIC18

sub procedure FLASH_Erase_64(dim address as dword)

sub procedure FLASH_Erase_1024(dim address as dword)

Returns Nothing.

Description

Erases memory block starting from a given address. For P16 familly is imple-

mented only for those MCU's whose flash memory does not support erase-and-

write operations (refer to datasheet for details).

Requires Nothing.

Example

Erase 64 byte memory memory block, starting from address $0D00:

FLASH_Erase_64($0D00)

Prototype

' for PIC18

sub procedure FLASH_Erase_Write_64(dim address as dword, dim

byref data as byte[64])

sub procedure FLASH_Erase_Write_1024(dim address as dword, dim

byref data as byte[1024])

Returns None.

Description Erase then write memory block starting from a given address.

Requires Nothing.

Example

dim toWrite as byte[64]

...

main:

...

' initialize array:

for i = 0 to 63

toWrite[i] = i

next i ...

' erase block of memory at address 0x0D00 then write contents of

the array to the address 0x0D00:

FLASH_Erase_Write_64(0x0D00, toWrite)

...

end.

Library Example

This is a simple demonstration how to use to PIC16 internal flash memory to store

data. The data is being written starting from the given location; then, the same loca-

tions are read and the data is displayed on PORTB and PORTC.

program Flash_Write

dim counter as byte

addr, data_ as word

dataAR as word[4][4]

ANSEL = 0 ' Configure AN pins as digital

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

PORTB = 0 ' Initial PORTB value

TRISB = 0 ' Set PORTB as output

PORTC = 0 ' Initial PORTC value

TRISC = 0 ' Set PORTC as output

Delay_ms(500)

' All block writes

' to program memory are done as 16-word erase by

' eight-word write operations. The write operation is

' edge-aligned and cannot occur across boundaries.

' Therefore it is recommended to perform flash writes in 16-word

chunks.

' That is why lower 4 bits of start address [3:0] must be zero.

' Since FLASH_Write routine performs writes in 4-word chunks,

' we need to call it 4 times in a row.

dataAR[0][0]= 0x3FAA+0

dataAR[0][1]= 0x3FAA+1

dataAR[0][2]= 0x3FAA+2

dataAR[0][3]= 0x3FAA+3

dataAR[1][0]= 0x3FAA+4

dataAR[1][1]= 0x3FAA+5

dataAR[1][2]= 0x3FAA+6

dataAR[1][3]= 0x3FAA+7

dataAR[2][0]= 0x3FAA+8

dataAR[2][1]= 0x3FAA+9

dataAR[2][2]= 0x3FAA+10

dataAR[2][3]= 0x3FAA+11

dataAR[3][0]= 0x3FAA+12

dataAR[3][1]= 0x3FAA+13

dataAR[3][2]= 0x3FAA+14

dataAR[3][3]= 0x3FAA+15

294 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

addr = 0x0430 ' starting Flash address, valid for P16F88

for counter = 0 to 3 ' write some data to Flash

Delay_ms(100)

FLASH_Write(addr+counter*4, dataAR[counter])

next counter

Delay_ms(500)

addr = 0x0430

for counter = 0 to 15

data_ = FLASH_Read(addr) ' P16's FLASH is 14-bit wide, so

Inc(addr)

Delay_us(10) ' two MSB's will always be '00'

PORTB = data_ ' display data on PORTB LS Byte

PORTC = word(data_ >> 8) ' and PORTC MS Byte

Delay_ms(500)

next counter

end.

295

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

GRAPHIC LCD LIBRARY

The mikroBasic PRO for PIC provides a library for operating Graphic LCD 128x64

(with commonly used Samsung KS108/KS107 controller).

For creating a custom set of Glcd images use Glcd Bitmap Editor Tool.

External dependencies of Graphic LCD Library

296 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using Graphic

LCD Library:

Description: Example :

dim GLCD_DataPort as

byte sfr external Glcd Data Port dim GLCD_DataPort as

byte at PORTD_bit

dim GLCD_CS1 as sbit

sfr external Chip Select 1 line. dim GLCD_CS1 as sbit

at RB0_bit

dim GLCD_CS2 as sbit

sfr external Chip Select 2 line. dim GLCD_CS2 as sbit

at RB1_bit

dim GLCD_RS as sbit

sfr external Register select line. dim GLCD_RS as sbit

at RB2_bit

dim GLCD_RW as sbit

sfr external Read/Write line. dim GLCD_RW as sbit

at RB3_bit

dim GLCD_RST as sbit

sfr external Reset line. dim GLCD_RST as sbit

at RB4_bit

dim GLCD_EN as sbit

sfr external Enable line. dim GLCD_EN as sbit

at RB5_bit

dim

GLCD_CS1_Direction as

sbit sfr external

Direction of the Chip Select

1 pin. dim GLCD_CS1_Direction

as sbit at TRISB0_bit

dim

GLCD_CS2_Direction as

sbit sfr external

Direction of the Chip Select

2 pin. dim GLCD_CS2_Direction

as sbit at TRISB1_bit

dim GLCD_RS_Direction

as sbit sfr external

Direction of the Register

select pin.

dim GLCD_RS_Direction

as sbit at TRISB2_bit

dim GLCD_RW_Direction

as sbit sfr external

Direction of the Read/Write

pin.

dim GLCD_RW_Direction

as sbit at TRISB3_bit

dim GLCD_EN_Direction

as sbit sfr external

Direction of the Enable pin. dim GLCD_EN_Direction

as sbit at TRISB4_bit

dim

GLCD_RST_Direction as

sbit sfr external

Direction of the Reset pin. dim GLCD_RST_Direction

as sbit at TRISB5_bit

Library Routines

Basic routines:

 Glcd_Init

 Glcd_Set_Side

 Glcd_Set_X

 Glcd_Set_Page

 Glcd_Read_Data

 Glcd_Write_Data

Advanced routines:

 Glcd_Fill

 Glcd_Dot

 Glcd_Line

 Glcd_V_Line

 Glcd_H_Line

 Glcd_Rectangle

 Glcd_Box

 Glcd_Circle

 Glcd_Set_Font

 Glcd_Write_Char

 Glcd_Write_Text

 Glcd_Image

297

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

298 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Glcd_Init

Prototype sub procedure Glcd_Init()

Returns Nothing.

Description Initializes the Glcd module. Each of the control lines is both port and pin config-

urable, while data lines must be on a single port (pins <0:7>).

Requires

Global variables :

GLCD_CS1 : Chip select 1 signal pin

 GLCD_CS2 : Chip select 2 signal pin

 GLCD_RS : Register select signal pin

 GLCD_RW : Read/Write Signal pin

 GLCD_EN : Enable signal pin

 GLCD_RST : Reset signal pin

 GLCD_DataPort : Data port

 GLCD_CS1_Direction : Direction of the Chip select 1 pin

 GLCD_CS2_Direction : Direction of the Chip select 2 pin

 GLCD_RS_Direction : Direction of the Register select signal pin

 GLCD_RW_Direction : Direction of the Read/Write signal pin

 GLCD_EN_Direction : Direction of the Enable signal pin

 GLCD_RST_Direction : Direction of the Reset signal pin

must be defined before using this function.

Example

' Glcd module connections

dim GLCD_DataPort as byte at PORTD

dim GLCD_CS1 as sbit at RB0_bit

GLCD_CS2 as sbit at RB1_bit

GLCD_RS as sbit at RB2_bit

GLCD_RW as sbit at RB3_bit

GLCD_EN as sbit at RB4_bit

GLCD_RST as sbit at RB5_bit

dim GLCD_CS1_Direction as sbit at TRISB0_bit

GLCD_CS2_Direction as sbit at TRISB1_bit

GLCD_RS_Direction as sbit at TRISB2_bit

GLCD_RW_Direction as sbit at TRISB3_bit

GLCD_EN_Direction as sbit at TRISB4_bit

GLCD_RST_Direction as sbit at TRISB5_bit

' End Glcd module connections

...

Glcd_Init()

299

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Glcd_Set_Side

Glcd_Set_X

Prototype sub procedure Glcd_Set_Side(dim x_pos as byte)

Returns Nothing.

Description

Selects Glcd side. Refer to the Glcd datasheet for detailed explaination.

Parameters :

x_pos: position on x-axis. Valid values: 0..127

The parameter x_pos specifies the Glcd side: values from 0 to 63 specify the

left side, values from 64 to 127 specify the right side.

Note: For side, x axis and page layout explanation see schematic at the bottom

of this page.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example

The following two lines are equivalent, and both of them select the left side of

Glcd:

Glcd_Select_Side(0)

Glcd_Select_Side(10)

Prototype sub procedure Glcd_Set_X(dim x_pos as byte)

Returns Nothing.

Description

Sets x-axis position to x_pos dots from the left border of Glcd within the select-

ed side.

Parameters :

x_pos: position on x-axis. Valid values: 0..63

Note: For side, x axis and page layout explanation see schematic at the bottom

of this page.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example Glcd_Set_X(25)

300 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Glcd_Set_Page

Glcd_Read_Data

Prototype sub procedure Glcd_Set_Page(dim page as byte)

Returns Nothing.

Description

Selects page of the Glcd.

Parameters :

 page: page number. Valid values: 0..7

Note: For side, x axis and page layout explanation see schematic at the bottom

of this page.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example Glcd_Set_Page(5)

Prototype sub function Glcd_Read_Data() as byte

Returns One byte from Glcd memory.

Description Reads data from from the current location of Glcd memory and moves to the

next location.

Requires

Glcd needs to be initialized, see Glcd_Init routine.

Glcd side, x-axis position and page should be set first. See functions

Glcd_Set_Side, Glcd_Set_X, and Glcd_Set_Page.

Example

dim data as byte

...

data = Glcd_Read_Data()

301

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Glcd_Write_Data

Glcd_Fill

Prototype sub procedure Glcd_Write_Data(dim ddata as byte)

Returns Nothing.

Description

Writes one byte to the current location in Glcd memory and moves to the next

location.

Parameters :

ddata: data to be written

Requires

Glcd needs to be initialized, see Glcd_Init routine.

Glcd side, x-axis position and page should be set first. See functions

Glcd_Set_Side, Glcd_Set_X, and Glcd_Set_Page.

Example

dim data as byte

...

Glcd_Write_Data(data)

Prototype sub procedure Glcd_Fill(dim pattern as byte)

Returns Nothing.

Description

Fills Glcd memory with the byte pattern.

Parameters :

pattern: byte to fill Glcd memory with

To clear the Glcd screen, use Glcd_Fill(0).

To fill the screen completely, use Glcd_Fill(0xFF).

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Clear screen

Glcd_Fill(0)

302 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Glcd_Dot

Glcd_Line

Prototype sub procedure Glcd_Dot(dim x_pos as byte, dim y_pos as byte, dim

color as byte)

Returns Nothing.

Description

Draws a dot on Glcd at coordinates (x_pos, y_pos).

Parameters :

 x_pos: x position. Valid values: 0..127

 y_pos: y position. Valid values: 0..63

 color: color parameter. Valid values: 0..2

The parameter color determines a dot state: 0 clears dot, 1 puts a dot, and 2

inverts dot state.

Note: For x and y axis layout explanation see schematic at the bottom of this page.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Invert the dot in the upper left corner

Glcd_Dot(0, 0, 2)

Prototype

sub procedure Glcd_Line(dim x_start as integer, dim y_start as

integer, dim x_end as integer, dim y_end as integer, dim color as

byte)

Returns Nothing.

Description

Draws a line on Glcd.

Parameters :

 x_start: x coordinate of the line start. Valid values: 0..127

 y_start: y coordinate of the line start. Valid values: 0..63

 x_end: x coordinate of the line end. Valid values: 0..127

 y_end: y coordinate of the line end. Valid values: 0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the line color: 0 white, 1 black, and 2 inverts

each dot.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw a line between dots (0,0) and (20,30)

Glcd_Line(0, 0, 20, 30, 1)

303

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Glcd_V_Line

Glcd_H_Line

Prototype sub procedure Glcd_V_Line(dim y_start as byte, dim y_end as byte,

dim x_pos as byte, dim color as byte)

Returns Nothing.

Description

Draws a vertical line on lcd.

Parameters :

 y_start: y coordinate of the line start. Valid values: 0..63

 y_end: y coordinate of the line end. Valid values: 0..63

 x_pos: x coordinate of vertical line. Valid values: 0..127

 color: color parameter. Valid values: 0..2

The parameter color determines the line color: 0 white, 1 black, and 2 inverts

each dot.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw a vertical line between dots (10,5) and (10,25)

Glcd_V_Line(5, 25, 10, 1)

Prototype sub procedure Glcd_V_Line(dim x_start as byte, dim x_end as byte,

dim y_pos as byte, dim color as byte)

Returns Nothing.

Description

Draws a horizontal line on Glcd.

Parameters :

 x_start: x coordinate of the line start. Valid values: 0..127

 x_end: x coordinate of the line end. Valid values: 0..127

 y_pos: y coordinate of horizontal line. Valid values: 0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the line color: 0 white, 1 black, and 2 inverts

each dot.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw a horizontal line between dots (10,20) and (50,20)

Glcd_H_Line(10, 50, 20, 1)

304 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Glcd_Rectangl

Glcd_Box

Prototype

sub procedure Glcd_Rectangle(dim x_upper_left as byte, dim

y_upper_left as byte, dim x_bottom_right as byte, dim

y_bottom_right as byte, dim color as byte)

Returns Nothing.

Description

Draws a rectangle on Glcd.

Parameters :

x_upper_left: x coordinate of the upper left rectangle corner. Valid values:

0..127

 y_upper_left: y coordinate of the upper left rectangle corner. Valid values:

0..63

 x_bottom_right: x coordinate of the lower right rectangle corner. Valid

values: 0..127

 y_bottom_right: y coordinate of the lower right rectangle corner. Valid

values: 0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the rectangle border: 0 white, 1

black, and 2 inverts each dot.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw a rectangle between dots (5,5) and (40,40)

Glcd_Rectangle(5, 5, 40, 40, 1)

Prototype

sub procedure Glcd_Box(dim x_upper_left as byte, dim y_upper_left

as byte, dim x_bottom_right as byte, dim y_bottom_right as byte,

dim color as byte)

Returns Nothing.

Description

Draws a box on Glcd.

Parameters :

 x_upper_left: x coordinate of the upper left box corner. Valid values:

0..127

 y_upper_left: y coordinate of the upper left box corner. Valid values:

0..63

 x_bottom_right: x coordinate of the lower right box corner. Valid values:

0..127

 y_bottom_right: y coordinate of the lower right box corner. Valid values:0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the box fill: 0 white, 1 black, and 2

inverts each dot.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw a box between dots (5,15) and (20,40)

Glcd_Box(5, 15, 20, 40, 1)

305

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Glcd_Circle

Glcd_Set_Font

Prototype sub procedure Glcd_Circle(dim x_center as integer, dim y_center

as integer, dim radius as integer, dim color as byte)

Returns Nothing.

Description

Draws a circle on Glcd.

Parameters :

 x_center: x coordinate of the circle center. Valid values: 0..127

 y_center: y coordinate of the circle center. Valid values: 0..63

 radius: radius size

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the circle line: 0 white, 1 black,

and 2 inverts each dot.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw a circle with center in (50,50) and radius=10

Glcd_Circle(50, 50, 10, 1)

Prototype sub procedure Glcd_Set_Font(dim byref const ActiveFont as ^byte, dim

FontWidth as byte, dim FontHeight as byte, dim FontOffs as word)

Returns Nothing.

Description

Sets font that will be used with Glcd_Write_Char and Glcd_Write_Text routines.

Parameters :

 activeFont: font to be set. Needs to be formatted as an array of char

 aFontWidth: width of the font characters in dots.

 aFontHeight: height of the font characters in dots.

 aFontOffs: number that represents difference between the mikroBasic

PRO for PIC character set and regular ASCII set (eg. if 'A' is 65 in

ASCII character, and 'A' is 45 in the mikroBasic PRO for PIC character

set, aFontOffs is 20). Demo fonts supplied with the library have an offset

of 32, which means that they start with space.

The user can use fonts given in the file “__Lib_GLCDFonts.mpas” file located in

the Uses folder or create his own fonts.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Use the custom 5x7 font "myfont" which starts with space (32):

Glcd_Set_Font(myfont, 5, 7, 32)

306 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Glcd_Write_Char

Prototype sub procedure Glcd_Write_Char(dim chr as byte, dim x_pos as byte,

dim page_num as byte, dim color as byte)

Returns Nothing.

Description

Prints character on the Glcd.

Parameters :

chr: character to be written

 x_pos: character starting position on x-axis. Valid values: 0..(127-Font

Width)

page_num: the number of the page on which character will be written.

Valid values: 0..7

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the character: 0 white, 1 black,

and 2 inverts each dot.

Note: For x axis and page layout explanation see schematic at the bottom of

this page.

Requires

Glcd needs to be initialized, see Glcd_Init routine. Use Glcd_Set_Font to speci-

fy the font for display; if no font is specified, then default 5x8 font supplied with

the library will be used.

Example ' Write character 'C' on the position 10 inside the page 2:

Glcd_Write_Char('C', 10, 2, 1)

307

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Glcd_Write_Text

Glcd_Image

Prototype sub procedure Glcd_Write_Text(dim byref text as string[20], dim

x_pos as byte, dim page_num as byte, dim color as byte)

Returns Nothing.

Description

Prints text on Glcd.

Parameters :

text: text to be written

 x_pos: text starting position on x-axis.

 page_num: the number of the page on which text will be written. Valid values:

0..7

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the text: 0 white, 1 black, and 2

inverts each dot.

Note: For x axis and page layout explanation see schematic at the bottom of

this page.

Requires

Glcd needs to be initialized, see Glcd_Init routine. Use Glcd_Set_Font to speci-

fy the font for display; if no font is specified, then default 5x8 font supplied with

the library will be used.

Example ' Write text "Hello world!" on the position 10 inside the page 2:

Glcd_Write_Text("Hello world!", 10, 2, 1);

Prototype sub procedure Glcd_Image(dim byref const image as ^byte)

Returns Nothing.

Description

Displays bitmap on Glcd.

Parameters :

image: image to be displayed. Bitmap array must be located in code

memory.

Use the mikroBasic PRO for PIC integrated Glcd Bitmap Editor to convert

image to a constant array suitable for displaying on Glcd.

Requires Glcd needs to be initialized, see Glcd_Init routine.

Example ' Draw image my_image on Glcd

Glcd_Image(my_image)

Library Example

The following example demonstrates routines of the Glcd library: initialization,

clear(pattern fill), image displaying, drawing lines, circles, boxes and rectangles, text

displaying and handling.

program Glcd_Test;

include bitmap

' Glcd module connections

dim GLCD_DataPort as byte at PORTD

dim GLCD_CS1 as sbit at RB0_bit

GLCD_CS2 as sbit at RB1_bit

GLCD_RS as sbit at RB2_bit

GLCD_RW as sbit at RB3_bit

GLCD_EN as sbit at RB4_bit

GLCD_RST as sbit at RB5_bit

dim GLCD_CS1_Direction as sbit at TRISB0_bit

GLCD_CS2_Direction as sbit at TRISB1_bit

GLCD_RS_Direction as sbit at TRISB2_bit

GLCD_RW_Direction as sbit at TRISB3_bit

GLCD_EN_Direction as sbit at TRISB4_bit

GLCD_RST_Direction as sbit at TRISB5_bit

' End Glcd module connections

dim counter as byte

someText as char[18]

sub procedure Delay2S() ' 2 seconds delay sub function

Delay_ms(2000)

end sub

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

Glcd_Init() ' Initialize Glcd

Glcd_Fill(0x00) ' Clear Glcd

while TRUE

Glcd_Image(@truck_bmp) ' Draw image

Delay2S() delay2S()

Glcd_Fill(0x00) ' Clear Glcd

Glcd_Box(62,40,124,63,1) ' Draw box

308 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Glcd_Rectangle(5,5,84,35,1) ' Draw rectangle

Glcd_Line(0, 0, 127, 63, 1) ' Draw line

Delay2S()

counter = 5

while (counter <= 59) ' Draw horizontal and vertical lines

Delay_ms(250)

Glcd_V_Line(2, 54, counter, 1)

Glcd_H_Line(2, 120, counter, 1)

Counter = counter + 5

wend

Delay2S()

Glcd_Fill(0x00) ' Clear Glcd

Glcd_Set_Font(@Character8x7, 8, 7, 32) ' Choose font

"Character8x7"

Glcd_Write_Text("mikroE", 1, 7, 2) ' Write string

for counter = 1 to 10 ' Draw circles

Glcd_Circle(63,32, 3*counter, 1)

next counter

Delay2S()

Glcd_Box(10,20, 70,63, 2) ' Draw box}

Delay2S()

Glcd_Fill(0xFF) ' Fill Glcd

Glcd_Set_Font(@Character8x7, 8, 7, 32) ' Change font

someText = "8x7 Font"

Glcd_Write_Text(someText, 5, 0, 2) ' Write string

delay2S()

Glcd_Set_Font(@System3x6, 3, 5, 32) ' Change font

someText = "3X5 CAPITALS ONLY"

Glcd_Write_Text(someText, 60, 2, 2) ' Write string

delay2S()

Glcd_Set_Font(@font5x7, 5, 7, 32) ' Change font

someText = "5x7 Font"

Glcd_Write_Text(someText, 5, 4, 2) ' Write string

delay2S()

Glcd_Set_Font(@FontSystem5x7_v2, 5, 7, 32) ' Change font

someText = "5x7 Font (v2)"

Glcd_Write_Text(someText, 5, 6, 2) ' Write string

delay2S()

309

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Glcd_Set_Font(@FontSystem5x7_v2, 5, 7, 32) ' Change font

someText = "5x7 Font (v2)"

Glcd_Write_Text(someText, 5, 6, 2) ' Write string

delay2S()

wend

end.

HW Connection

Glcd HW connection

310 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

I²C LIBRARY

I2C full master MSSP module is available with a number of PIC MCU models. mikroBasic PRO

for PIC provides library which supports the master I2C mode.

Note: Some MCUs have multiple I2C modules. In order to use the desired I2C library routine, sim-

ply change the number 1in the prototype with the appropriate module number, i.e.

I2C1_Init(100000)

Library Routines

I2C1_Init

I2C1_Start

 I2C1_Repeated_Start

 I2C1_Is_Idle

 I2C1_Rd

 I2C1_Wr

 I2C1_Stop

I2C1_Init

311

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure I2C1_Init(const clock as longint)

Returns Nothing.

Description

Initializes I2C with desired clock (refer to device data sheet for correct values in

respect with Fosc). Needs to be called before using other functions of I2C

Library.

You don’t need to configure ports manually for using the module; library will take

care of the initialization.

Requires

Library requires MSSP module on PORTB or PORTC.

Note: Calculation of the I2C clock value is carried out by the compiler, as it

would produce a relatively large code if performed on the libary level.

Therefore, compiler needs to know the value of the parameter in the compile

time. That is why this parameter needs to be a constant, and not a variable.

Example I2C1_Init(100000)

I2C1_Start

I2C1_Repeated_Start

I2C1_Is_Idle

312 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function I2C1_Start as byte

Returns I2 there is no error, function returns 0.

Description Determines if I2C bus is free and issues START signal.

Requires I2C must be configured before using this function. See I2C1_Init.

Example if I2C1_Start = 0 then

...

Prototype sub procedure I2C1_Repeated_Start

Returns Nothing.

Description Issues repeated START signal.

Requires I2C must be configured before using this function. See I2C1_Init.

Example I2C1_Repeated_Start

Prototype sub function I2C1_Is_Idle as byte

Returns Returns TRUE if I2C bus is free, otherwise returns FALSE.

Description Tests if I2C bus is free.

Requires I2C must be configured before using this function. See I2C1_Init.

Example if I2C1_Is_Idle then

...

I2C1_Rd

I2C1_Wr

I2C1_Stop

313

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function I2C1_Rd(dim ack as byte)as byte

Returns Returns one byte from the slave.

Description Reads one byte from the slave, and sends not acknowledge signal if parameter

ack is 0, otherwise it sends acknowledge.

Requires

I2C must be configured before using this function. See I2C1_Init.

Also, START signal needs to be issued in order to use this function. See

I2C1_Start.

Example Read data and send not acknowledge signal:

tmp = I2C1_Rd(0)

Prototype sub function I2C1_Wr(dim data as byte)as byte

Returns Returns 0 if there were no errors.

Description Sends data byte (parameter data) via I2C bus.

Requires

I2C must be configured before using this function. See I2C1_Init.

Also, START signal needs to be issued in order to use this function. See

I2C1_Start.

Example I2C1_Write($A3)

Prototype sub procedure I2C1_Stop

Returns Nothing.

Description Issues STOP signal.

Requires I2C must be configured before using this function. See I2C1_Init.

Example I2C1_Stop

Library Example

This code demonstrates use of I2C Library procedures and functions. PIC MCU is

connected (pins SCL and SDA) to 24c02 EEPROM. Program sends data to

EEPROM (data is written at address 2). Then, we read data via I2C from EEPROM

and send its value to PORTD, to check if the cycle was successful. The figure below

shows how to interface 24c02 to PIC.

program I2C_Simple

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

PORTB = 0

TRISB = 0 ' Configure PORTB as output

I2C1_Init(100000) ' initialize I2C communication

I2C1_Start() ' issue I2C start signal

I2C1_Wr(0xA2) ' send byte via I2C (device address + W)

I2C1_Wr(2) ' send byte (address of EEPROM location)

I2C1_Wr(0xAA) ' send data (data to be written)

I2C1_Stop() ' issue I2C stop signal

Delay_100ms()

I2C1_Start() ' issue I2C start signal

I2C1_Wr(0xA2) ' send byte via I2C (device address + W)

I2C1_Wr(2) ' send byte (data address)

I2C1_Repeated_Start() ' issue I2C signal repeated start

I2C1_Wr(0xA3) ' send byte (device address + R)

PORTB = I2C1_Rd(0) ' Read the data (NO acknowledge)

I2C1_Stop() ' issue I2C stop signal

end.

314 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

Interfacing 24c02 to PIC via I2C

315

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

KEYPAD LIBRARY

The mikroBasic PRO for PIC provides a library for working with 4x4 keypad. The library routines

can also be used with 4x1, 4x2, or 4x3 keypad. For connections explanation see schematic at the

bottom of this page.

External dependencies of Keypad Library

Library Routines

Keypad_Init

 Keypad_Key_Press

 Keypad_Key_Click

Keypad_Init

316 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all proj-

ects using Keypad Library:

Description: Example :

dim keypadPort as byte

sfr external Keypad Port dim keypadPort as byte

at PORTD

Prototype sub procedure Keypad_Init()

Returns Nothing.

Description Initializes port for working with keypad.

Requires

Global variables :

keypadPort - Keypad port must be defined before using this function.

Example

' Keypad module connections

dim keypadPort as byte at PORTD

' End of keypad module connections

...

Keypad_Init()

Keypad_Key_Press

Keypad_Key_Click

317

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Keypad_Key_Press() as byte

Returns

The code of a pressed key (1..16).

If no key is pressed, returns 0.

Description Reads the key from keypad when key gets pressed.

Requires Port needs to be initialized for working with the Keypad library, see Keypad_Init.

Example

dim kp as byte

...

kp = Keypad_Key_Press()

Prototype sub function Keypad_Key_Click() as byte

Returns

The code of a clicked key (1..16).

If no key is clicked, returns 0.

Description

Call to Keypad_Key_Click is a blocking call: the function waits until some key

is pressed and released. When released, the function returns 1 to 16, depend-

ing on the key. If more than one key is pressed simultaneously the function will

wait until all pressed keys are released. After that the function will return the

code of the first pressed key.

Requires Port needs to be initialized for working with the Keypad library, see Keypad_Init.

Example

dim kp as byte

...

kp = Keypad_Key_Click()

Library Example

This is a simple example of using the Keypad Library. It supports keypads with 1..4

rows and 1..4 columns. The code being returned by Keypad_Key_Click() function is

in range from 1..16. In this example, the code returned is transformed into ASCII

codes [0..9,A..F] and displayed on Lcd. In addition, a small single-byte counter dis-

plays in the second Lcd row number of key presses.

program Keypad_Test

dim kp, cnt, oldstate as byte

txt as byte[7]

' Keypad module connections

dim keypadPort as byte at PORTC

'End Keypad module connections

' Lcd module connections

dim LCD_RS as sbit at RB4_bit

LCD_EN as sbit at RB5_bit

LCD_D4 as sbit at RB0_bit

LCD_D5 as sbit at RB1_bit

LCD_D6 as sbit at RB2_bit

LCD_D7 as sbit at RB3_bit

LCD_RS_Direction as sbit at TRISB4_bit

LCD_EN_Direction as sbit at TRISB5_bit

LCD_D4_Direction as sbit at TRISB0_bit

LCD_D5_Direction as sbit at TRISB1_bit

LCD_D6_Direction as sbit at TRISB2_bit

LCD_D7_Direction as sbit at TRISB3_bit

' End Lcd module connections

main:

oldstate = 0

cnt = 0 ' Reset counter

Keypad_Init() ' Initialize Keypad

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH =

Lcd_Init() ' Initialize Lcd

Lcd_Cmd(_LCD_CLEAR) ' Clear display

Lcd_Cmd(_LCD_CURSOR_OFF) ' Cursor off

Lcd_Out(1, 1, "Key :") ' Write message text on Lcd

Lcd_Out(2, 1, "Times:")

while TRUE

kp = 0 ' Reset key code variable

' Wait for key to be pressed and released

while ( kp = 0 )

318 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

kp = Keypad_Key_Click() ' Store key code in kp vari-

able

wend

' Prepare value for output, transform key to it"s ASCII value

select case kp

'case 10: kp = 42 ' "*" ' Uncomment this block for

keypad4x3

'case 11: kp = 48 ' "0"

'case 12: kp = 35 ' "#"

'default: kp += 48

case 1

kp = 49 ' 1 ' Uncomment this block for

keypad4x4

case 2

kp = 50 ' 2

case 3

kp = 51 ' 3

case 4

kp = 65 ' A

case 5

kp = 52 ' 4

case 6

kp = 53 ' 5

case 7

kp = 54 ' 6

case 8

kp = 66 ' B

case 9

kp = 55 ' 7

case 10

kp = 56 ' 8

case 11

kp = 57 ' 9

case 12

kp = 67 ' C

case 13

kp = 42 ' *

case 14

kp = 48 ' 0

case 15

kp = 35 ' #

case 16

kp = 68 ' D

end select

if (kp <> oldstate) then ‘Pressed key differs from previous

cnt = 1

319

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

oldstate = kp

else ' Pressed key is same as previous

Inc(cnt)

end if

Lcd_Chr(1, 10, kp) ' Print key ASCII value on Lcd

if (cnt = 255) then ' If counter varialble overflow

cnt = 0

Lcd_Out(2, 10, " ")

end if

WordToStr(cnt, txt) ' Transform counter value to string

Lcd_Out(2, 10, txt) ' Display counter value on Lcd

wend

end.

HW Connection

4x4 Keypad connection scheme

320 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

LCD LIBRARY

The mikroBasic PRO for PIC provides a library for communication with Lcds (with

HD44780 compliant controllers) through the 4-bit interface. An example of Lcd con-

nections is given on the schematic at the bottom of this page.

For creating a set of custom Lcd characters use Lcd Custom Character Tool.

External dependencies of LCD Library

321

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using LCD

Library:

Description: Example :

dim LCD_RS as sbit

sfr external Register Select line. dim LCD_RS as sbit at

RB4_bit

dim LCD_EN as sbit

sfr external Enable line. dim LCD_EN as sbit at

RB5_bit

dim LCD_D7 as sbit

sfr external Data 7 line. dim LCD_D7 as sbit at

RB3_bit

dim LCD_D6 as sbit

sfr external Data 6 line. dim LCD_D6 as sbit at

RB2_bit

dim LCD_D5 as sbit

sfr external Data 5 line. dim LCD_D5 as sbit at

RB1_bit

dim LCD_D4 as sbit

sfr external Data 4 line. dim LCD_D4 as sbit at

RB0_bit

dim LCD_RS_Direction

as sbit sfr external

pin.

dim LCD_RS_Direction

as sbit at TRISB4_bit

dim LCD_EN_Direction

as sbit sfr external

Enable direction pin. dim LCD_EN_Direction

as sbit at TRISB5_bit

dim LCD_D7_Direction

as sbit sfr external

Data 7 direction pin. dim LCD_D7_Direction

as sbit at TRISB3_bit

dim LCD_D6_Direction

as sbit sfr external

Data 6 direction pin. dim LCD_D6_Direction

as sbit at TRISB2_bit

dim LCD_D5_Direction

as sbit sfr externald

Data 5 direction pin. dim LCD_D5_Direction

as sbit at TRISB1_bit

dim LCD_D4_Direction

as sbit sfr external

Data 4 direction pin. dim LCD_D4_Direction

as sbit at TRISB0_bit

322 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Library Routines

Lcd_Init

Lcd_Out

Lcd_Out_Cp

Lcd_Chr

Lcd_Chr_Cp

 Lcd_Cmd

Lcd_Init

Prototype sub procedure Lcd_Init()

Returns Nothing.

Description Initializes Lcd module.

Requires

 LCD_D7: Data bit 7

 LCD_D6:Data bit 6

 LCD_D5: Data bit 5

 LCD_D4: Data bit 4

 LCD_RS: Register Select (data/instruction) signal pin

 LCD_EN: Enable signal pin

 LCD_D7_Direction: Direction of the Data 7 pin

 LCD_D6_Direction: Direction of the Data 6 pin

 LCD_D5_Direction: Direction of the Data 5 pin

 LCD_D4_Direction: Direction of the Data 4 pin

 LCD_RS_Direction: Direction of the Register Select pin

 LCD_EN_Direction: Direction of the Enable signal pin

must be defined before using this function.

Example

‘Lcd module connections

dim

LCD_RS as sbit at RB4_bit

LCD_EN as sbit at RB5_bit

LCD_D7 as sbit at RB3_bit

LCD_D6 as sbit at RB2_bit

LCD_D5 as sbit at RB1_bit

LCD_D4 as sbit at RB0_bit

dim

LCD_RS as sbit at TRISB4_bit

LCD_EN as sbit at TRISB5_bit

LCD_D7 as sbit at TRISB3_bit

LCD_D6 as sbit at TRISB2_bit

LCD_D5 as sbit at TRISB1_bit

LCD_D4 as sbit at TRISB0_bit

'End Lcd module connections

...

Lcd_Init()

323

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Lcd_Out

Lcd_Out_Cp

Prototype sub procedure Lcd_Out(dim row as byte, dim column as byte, dim

byref text as string[20])

Returns Nothing.

Description

Prints text on LCD starting from specified position. Both string variables and lit-

erals can be passed as a text.

Parameters :

row: starting position row number

column: starting position column number

text: text to be written

Requires The LCD module needs to be initialized. See Lcd_Init routine.

Example ' Write text "Hello!" on Lcd starting from row 1, column 3:

Lcd_Out(1, 3, "Hello!")

Prototype sub procedure Lcd_Out_Cp(dim byref text as string[19])

Returns Nothing.

Description

Prints text on LCD at current cursor position. Both string variables and literals

can be passed as a text.

Parameters :

text: text to be written

Requires The LCD module needs to be initialized. See Lcd_Init routine.

Example ' Write text "Here!" at current cursor position:

Lcd_Out_Cp("Here!")

324 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Lcd_Chr

Lcd_Chr_Cp

Prototype sub procedure Lcd_Chr(dim row as byte, dim column as byte, dim

out_char as byte)

Returns Nothing.

Description

Prints character on LCD at specified position. Both variables and literals can be

passed as a character.

Parameters :

row: writing position row number

 column: writing position column number

 out_char: character to be written

Requires The LCD module needs to be initialized. See Lcd_Init routine.

Example ' Write character "i" at row 2, column 3:

Lcd_Chr(2, 3, 'i')

Prototype sub procedure Lcd_Chr_Cp(dim out_char as byte)

Returns Nothing.

Description

Prints character on LCD at current cursor position. Both variables and literals

can be passed as a character.

Parameters :

out_char: character to be written

Requires The LCD module needs to be initialized. See Lcd_Init routine.

Example ' Write character "e" at current cursor position:

Lcd_Chr_Cp('e')

325

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Lcd_Cmd

Available LCD Commands

Prototype sub procedure Lcd_Cmd(dim out_char as byte)

Returns Nothing.

Description

Sends command to LCD.

Parameters :

out_char: command to be sent

Note: Predefined constants can be passed to the function, see Available LCD

Commands.

Requires The LCD module needs to be initialized. See Lcd_Init table.

Example ' Clear Lcd display:

Lcd_Cmd(_LCD_CLEAR)

Lcd Command Purpose

LCD_FIRST_ROW Move cursor to the 1st row

LCD_SECOND_ROW Move cursor to the 2nd row

LCD_THIRD_ROW Move cursor to the 3rd row

LCD_FOURTH_ROW Move cursor to the 4th row

LCD_CLEAR Clear display

LCD_RETURN_HOME Return cursor to home position, returns a shifted display to its original

position. Display data RAM is unaffected.

LCD_CURSOR_OFF Turn off cursor

LCD_UNDERLINE_ON Underline cursor on

LCD_BLINK_CURSOR_ON Blink cursor on

LCD_MOVE_CURSOR_LEFT Move cursor left without changing display data RAM

LCD_MOVE_CURSOR_RIGHT Move cursor right without changing display data RAM

LCD_TURN_ON Turn LCD display on

LCD_TURN_OFF Turn LCD display off

LCD_SHIFT_LEFT Shift display left without changing display data RAM

LCD_SHIFT_RIGHT Shift display right without changing display data RAM

Library Example

The following code demonstrates usage of the LCD Library routines:

program Lcd

' Lcd module connections

dim LCD_RS as sbit at RB4_bit

LCD_EN as sbit at RB5_bit

LCD_D4 as sbit at RB0_bit

LCD_D5 as sbit at RB1_bit

LCD_D6 as sbit at RB2_bit

LCD_D7 as sbit at RB3_bit

LCD_RS_Direction as sbit at TRISB4_bit

LCD_EN_Direction as sbit at TRISB5_bit

LCD_D4_Direction as sbit at TRISB0_bit

LCD_D5_Direction as sbit at TRISB1_bit

LCD_D6_Direction as sbit at TRISB2_bit

LCD_D7_Direction as sbit at TRISB3_bit

' End Lcd module connections

dim txt1 as char[16]

txt2 as char[9]

txt3 as char[8]

txt4 as char[7]

i as byte ' Loop variable

sub procedure Move_Delay() ' Function used for text moving

Delay_ms(500) ' You can change the moving speed here

end sub

main:

TRISB = 0

PORTB = 0xFF

TRISB = 0xFF

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

txt1 = "mikroElektronika"

txt2 = "EasyPIC5"

txt3 = "Lcd4bit"

txt4 = "example"

Lcd_Init() ' Initialize Lcd

Lcd_Cmd(_LCD_CLEAR) ' Clear display

Lcd_Cmd(_LCD_CURSOR_OFF) ' Cursor off

Lcd_Out(1,6,txt3) ' Write text in first row

Lcd_Out(2,6,txt4) ' Write text in second row

326 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Delay_ms(2000)

Lcd_Cmd(_LCD_CLEAR) ' Clear display

Lcd_Out(1,1,txt1) ' Write text in first row

Lcd_Out(2,5,txt2) ' Write text in second row

Delay_ms(500)

' Moving text

for i=0 to 3 ' Move text to the right 4 times

Lcd_Cmd(_LCD_SHIFT_RIGHT)

Move_Delay()

next i

while TRUE ' Endless loop

for i=0 to 7 ' Move text to the left 8 times

Lcd_Cmd(_LCD_SHIFT_LEFT)

Move_Delay()

next i

for i=0 to 7 ' Move text to the right 8 times

Lcd_Cmd(_LCD_SHIFT_RIGHT)

Move_Delay()

next i

wend

end.

327

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

HW Connection

LCD HW connection

328 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

MANCHESTER CODE LIBRARY

The mikroBasic PRO for PIC provides a library for handling Manchester coded sig-

nals. The Manchester code is a code in which data and clock signals are combined

to form a single self-synchronizing data stream; each encoded bit contains a transi-

tion at the midpoint of a bit period, the direction of transition determines whether the

bit is 0 or 1; the second half is the true bit value and the first half is the complement

of the true bit value (as shown in the figure below).

Notes: The Manchester receive routines are blocking calls (Man_Receive_Init and

Man_Synchro). This means that MCU will wait until the task has been performed

(e.g. byte is received, synchronization achieved, etc).

Note: Manchester code library implements time-based activities, so interrupts need

to be disabled when using it.

External dependencies of Manchester Code Library

329

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using Man-

chester Code Library:

Description: Example :

dim MANRXPIN as sbit

sfr external Receive line. dim MANRXPIN as sbit

at RC0_bit

dim MANTXPIN as sbit

sfr external Transmit line. dim MANTXPIN as sbit

at RC1_bit

dim MANRXPIN_Direction

as sbit sfr external

Direction of the Receive

pin.

dim MANRXPIN_Direction

as sbit at TRISC0_bit

dim MANTXPIN_Direction

as sbit sfr external

Direction of the Transmit

pin.

dim MANTXPIN_Direction

as sbit at TRISC1_bit

330 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Library Routines

Man_Receive_Init

 Man_Receive

 Man_Send_Init

 Man_Send

 Man_Synchro

 Man_Out

The following routines are for the internal use by compiler only:

 Manchester_0

 Manchester_1

 Manchester_Out

Man_Receive_Init

Prototype sub function Man_Receive_Init()as word

Returns

 0- if initialization and synchronization were successful.

 1 - upon unsuccessful synchronization.

 255 - upon user abort.

Description

The function configures Receiver pin and performs synchronization procedure in

order to retrieve baud rate out of the incoming signal.

Note: In case of multiple persistent errors on reception, the user should call this

routine once again or Man_Synchro routine to enable synchronization.

Requires

Global variables :

 MANRXPIN : Receive line

 MANRXPIN_Direction : Direction of the receive pin

must be defined before using this function.

Example

' Initialize Receiver

dim MANRXPIN as sbit at RC0_bit

dim MANRXPIN_Direction as sbit at TRISC0_bit

...

Man_Receive_Init()

331

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Man_Receive

Man_Send_Init

Prototype sub function Man_Receive(dim byreferror as byte)as byte

Returns A byte read from the incoming signal.

Description

The function extracts one byte from incoming signal.

Parameters :

error: error flag. If signal format does not match the expected, the error flag

will be set to non-zero.

Requires To use this function, the user must prepare the MCU for receiving. See

Man_Receive_Init.

Example

dim data, error as byte

...

data = 0

error = 0

data = Man_Receive(&error)

if (error <> 0) then

' error handling

end if

Prototype sub procedure Man_Send_Init()

Returns Nothing.

Description The function configures Transmitter pin.

Requires

Global variables :

MANRXPIN : Receive line

MANRXPIN_Direction : Direction of the receive pin

must be defined before using this function

Example

' Initialize Transmitter:

dim MANTXPIN as sbit at PORTC1_bit

dim MANTXPIN_Direction as sbit at TRISC1_bit

...

Man_Send_Init()

332 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Man_Send

Man_Synchro

Prototype sub procedure Man_Send(tr_data as byte)

Returns Nothing.

Description

Sends one byte.

Parameters :

tr_data: data to be sent

Note: Baud rate used is 500 bps.

Requires To use this function, the user must prepare the MCU for sending. See

Man_Send_Init.

Example

dim msg as byte

...

Man_Send(msg)

Prototype sub function Man_Synchro() as word

Returns

0- if synchronization was not successful.

Half of the manchester bit length, given in multiples of 10us - upon

successful synchronization.

Description Measures half of the manchester bit length with 10us resolution.

Requires To use this function, you must first prepare the MCU for receiving. See

Man_Receive_Init.

Example

dim man__half_bit_len as word

...

man__half_bit_len = Man_Synchro()

333

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Man_Break

Prototype sub procedure Man_Break()

Returns Nothing.

Description

Man_Receive is blocking routine and it can block the program flow. Call this

routine from interrupt to unblock the program execution. This mechanism is sim-

ilar to WDT.

Note: Interrupts should be disabled before using Manchester routines again

(see note at the top of this page).

Requires Nothing.

Example

dim data1, error_, counter as byte

sub procedure interrupt()

if (INTCON.T0IF <> 0) then

if (counter >= 20) then

Man_Break()

counter = 0 ' reset counter

end if

else

Inc(counter) ' increment counter

INTCON.T0IF = 0 ' Clear Timer0 overflow interrupt flag

end if

end sub

main:

counter = 0

OPTION_REG = 0x04 ' TMR0 prescaler set to 1:32

...

Man_Receive_Init()

...

' try Man_Receive with blocking prevention mechanism

INTCON.GIE = 1 ' Global interrupt enable

INTCON.T0IE = 1 ' Enable Timer0 overflow interrupt

data1 = Man_Receive(error_)

INTCON.GIE = 0 ' Global interrupt disable

end.

Library Example

The following code is code for the Manchester receiver, it shows how to use the

Manchester Library for receiving data:

program Manchester_Receiver

' LCD module connections

dim LCD_RS as sbit at RB4_bit

LCD_EN as sbit at RB5_bit

LCD_D4 as sbit at RB0_bit

LCD_D5 as sbit at RB1_bit

LCD_D6 as sbit at RB2_bit

LCD_D7 as sbit at RB3_bit

LCD_RS_Direction as sbit at TRISB4_bit

LCD_EN_Direction as sbit at TRISB5_bit

LCD_D4_Direction as sbit at TRISB0_bit

LCD_D5_Direction as sbit at TRISB1_bit

LCD_D6_Direction as sbit at TRISB2_bit

LCD_D7_Direction as sbit at TRISB3_bit

' End LCD module connections

' Manchester module connections

dim MANRXPIN as sbit at RC0_bit

MANRXPIN_Direction as sbit at TRISC0_bit

MANTXPIN as sbit at RC1_bit

MANTXPIN_Direction as sbit at TRISC1_bit

' End Manchester module connections

dim error_flag, ErrorCount, temp as byte

main:

ErrorCount = 0

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

TRISC5_bit = 0

Lcd_Init() ' Initialize LCD

Lcd_Cmd(_LCD_CLEAR) ' Clear LCD display

Man_Receive_Init() ' Initialize Receiver

while TRUE ' Endless loop

Lcd_Cmd(_LCD_FIRST_ROW) ' Move cursor to the 1st row

while TRUE ' Wait for the "start" byte

temp = Man_Receive(error_flag) ' Attempt byte receive

334 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

if (temp = 0x0B) then ' "Start" byte, see Transmitter example

break ' We got the starting sequence

end if

if (error_flag <> 0) then ' Exit so we do not loop for-

ever

break

end if

wend

temp = Man_Receive(error_flag) ' Attempt byte receive

if (error_flag <> 0) then ' If error occured

Lcd_Chr_CP("?") ' Write question mark on LCD

Inc(ErrorCount) ' Update error counter

if (ErrorCount > 20) then ' In case of multiple

errors

temp = Man_Synchro() ' Try to synchronize again

'Man_Receive_Init() ' Alternative, try to Initialize

Receiver again

ErrorCount = 0 ' Reset error counter

end if

else ' No error occured

if (temp <> 0x0E) then ' If "End" byte was

received(see Transmitter example)

Lcd_Chr_CP(temp) ' do not write received

byte on LCD

end if

Delay_ms(25)

end if

loop until ( temp = 0x0E )

wend ' If "End" byte was received exit do loop

end.

The following code is code for the Manchester transmitter, it shows how to use the

Manchester Library for transmitting data:

program Manchester_Transmitter

' Manchester module connections

dim MANRXPIN as sbit at RC0_bit

MANRXPIN_Direction as sbit at TRISC0_bit

MANTXPIN as sbit at RC1_bit

MANTXPIN_Direction as sbit at TRISC1_bit

' End Manchester module connections

dim index, character as byte

s1 as char[17]

main:

s1 = "mikroElektronika"

335

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

Man_Send_Init() ' Initialize transmitter

while TRUE ' Endless loop

Man_Send(0x0B) ' Send "start" byte

Delay_ms(100) ' Wait for a while

character = s1[0] ' Take first char from string

index = 0 ' Initialize index variable

while (character <> 0) ' String ends with zero

Man_Send(character) ' Send character

Delay_ms(90) ' Wait for a while

Inc(index) ' Increment index variable

character = s1[index] ' Take next char from string

wend

Man_Send(0x0E) ' Send "end" byte

Delay_ms(1000)

wend

end.

336 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Connection Example

Simple Transmitter connection

Simple Receiver connection

337

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

MULTI MEDIA CARD LIBRARY

The Multi Media Card (MMC) is a flash memory card standard. MMC cards are cur-

rently available in sizes up to and including 1 GB, and are used in cell phones, mp3

players, digital cameras, and PDA’s.

mikroBasic PRO for PIC provides a library for accessing data on Multi Media Card

via SPI communication.This library also supports SD(Secure Digital) memory cards.

Secure Digital Card

Secure Digital (SD) is a flash memory card standard, based on the older Multi Media

Card (MMC) format.

SD cards are currently available in sizes of up to and including 2 GB, and are used

in cell phones, mp3 players, digital cameras, and PDAs.

Notes:

Library works with PIC18 family only;

 The library uses the SPI module for communication. User must initialize SPI

module before using the SPI Graphic Lcd Library.

For MCUs with two SPI modules it is possible to initialize both of them and

then switch by using the SPI_Set_Active() routine.

 Routines for file handling can be used only with FAT16 file system.

 Library functions create and read files from the root directory only;

 Library functions populate both FAT1 and FAT2 tables when writing to files,

but the file data is being read from the FAT1 table only; i.e. there is no recov

ery if FAT1 table is corrupted.

Note: The SPI module has to be initialized through SPI1_Init_Advanced routine

with the following parameters:

 SPI Master

 8bit mode

 primary prescaler 16

 Slave Select disabled

 data sampled in the middle of data output time

 clock idle low

 Serial output data changes on transition from idle clock state to active clock

state

SPI1_Init_Advanced(_SPI_MASTER_OSC_DIV16, _SPI_DATA_SAMPLE_MIDDLE,

_SPI_CLK_IDLE_LOW, _SPI_LOW_2_HIGH)

must be called before initializing Mmc_Init.

Note: Once the MMC/SD card is initialized, the user can reinitialize SPI at higher

speed. See the Mmc_Init and Mmc_Fat_Init routines.

338 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

External dependencies of MMC Library

Library Routines

 Mmc_Init

 Mmc_Read_Sector

 Mmc_Write_Sector

 Mmc_Read_Cid

 Mmc_Read_Csd

Routines for file handling:

 Mmc_Fat_Init

 Mmc_Fat_QuickFormat

 Mmc_Fat_Assign

 Mmc_Fat_Reset

 Mmc_Fat_Read

 Mmc_Fat_Rewrite

 Mmc_Fat_Append

 Mmc_Fat_Delete

 Mmc_Fat_Write

 Mmc_Fat_Set_File_Date

 Mmc_Fat_Get_File_Date

Mmc_Fat_Get_File_Size

 Mmc_Fat_Get_Swap_File

339

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

The following variables must

be defined in all projects

using MMC Library:

Description: Example :

dim Mmc_Chip_Select as

sbit sfr external Chip select pin. dim Mmc_Chip_Select as

sbit at RC2_bit

dim

Mmc_Chip_Select_Direction

as sbit sfr external

Direction of the

chip select pin.

dim

Mmc_Chip_Select_Directio

n as sbit at TRISC2_bit

Mmc_Init

340 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Init() as byte

Returns  0 - if MMC/SD card was detected and successfully initialized

 1 - otherwise

Description

Initializes MMC through hardware SPI interface.

Mmc_Init needs to be called before using other functions of this library.

Requires

Global variables :

 Mmc_Chip_Select: Chip Select line

 Mmc_Chip_Select_Direction: Direction of the Chip Select pin

must be defined before using this function.

The appropriate hardware SPI module must be previously initialized. See the

SPI1_Init, SPI1_Init_Advanced routines.

Example

' MMC module connections

dim Mmc_Chip_Select as sbit sfr at RC2_bit

dim Mmc_Chip_Select_Direction as sbit sfr at TRISC2_bit

' MMC module connections

dim error as byte

...

SPI1_Init()

error = Mmc_Init() ' Init with CS line at RB2

Mmc_Read_Sector

341

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Read_Sector(dim sector as longint, dim byref

data as byte[512]) as byte

Returns  0 - i if reading was successful

 1 - otherwise

Description

The function reads one sector (512 bytes) from MMC card.

Parameters:

 sector: MMC/SD card sector to be read.

 dbuff: buffer of minimum 512 bytes in length for data storage.

Requires MMC/SD card must be initialized. See Mmc_Init.

Example

' read sector 510 of the MMC/SD card

dim error as word

sectorNo as longword

dataBuffer as char[512]

...

main:

...

sectorNo = 510

error = Mmc_Read_Sector(sectorNo, dataBuffer)

...

end.

Mmc_Write_Sector

342 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Write_Sector(dim sector as longint, dim byref

data_ as byte[512]) as byte

Returns

 0- if writing was successful

 1 -if there was an error in sending write command

 2- if there was an error in writing (data rejected)

Description

The function writes 512 bytes of data to one MMC card sector.

Parameters:

 sector: MMC/SD card sector to be written to.

 dbuff: data to be written (buffer of minimum 512 bytes in length).

Requires MMC/SD card must be initialized. See Mmc_Init

Example

' write to sector 510 of the MMC/SD card

dim error as word

sectorNo as longword

dataBuffer as char[512]

...

main:

...

sectorNo = 510

error = Mmc_Write_Sector(sectorNo, dataBuffer)

...

end.

Mmc_Read_Cid

Mmc_Read_Csd

343

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Read_Cid(dim byref data_cid as byte[16]) as byte

Returns  0- if CID register was read successfully

 1 -if there was an error while reading

Description

The function reads 16-byte CID register.

Parameters:

 data_cid: buffer of minimum 16 bytes in length for storing CID register

content.

Requires MMC/SD card must be initialized. See Mmc_Init

Example

dim error as word

dataBuffer as byte[16]

...

main:

...

error = Mmc_Read_Cid(dataBuffer)

...

end.

Prototype sub function Mmc_Read_Csd(dim byref data_for_registers as

byte[16]) as byte

Returns  0- if CSD register was read successfully

 1- if there was an error while reading

Description

The function reads 16-byte CSD register.

Parameters:

 data_csd:buffer of minimum 16 bytes in length for storing CSD register

content.

Requires MMC/SD card must be initialized. See Mmc_Init

Example

dim error as word

dataBuffer as char[16]

...

main:

...

error = Mmc_Read_Csd(dataBuffer)

...

end.

Mmc_Fat_Init

344 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Fat_Init() as byte

Returns

 0- if MMC/SD card was detected and successfully initialized

 1- if FAT16 boot sector was not found

 255 - if MMC/SD card was not detected

Description

Initializes MMC/SD card, reads MMC/SD FAT16 boot sector and extracts neces-

sary data needed by the library.

Note: MMC/SD card has to be formatted to FAT16 file system.

Requires

Global variables :

 Mmc_Chip_Select: Chip Select line

 Mmc_Chip_Select_Direction: Direction of the Chip Select pin

must be defined before using this function.

The appropriate hardware SPI module must be previously initialized. See the

SPI1_Init, SPI1_Init_Advanced routines.

Example

' MMC module connections

dim Mmc_Chip_Select as sbit sfr at RC2_bit

dim Mmc_Chip_Select_Direction as sbit sfr at TRISC2_bit

' MMC module connections

' Initialize SPI1 module and set pointer(s) to SPI1 functions

SPI1_Init_Advanced(MASTER_OSC_DIV64, DATA_SAMPLE_MIDDLE,

CLK_IDLE_LOW, LOW_2_HIGH)

'use fat16 quick format instead of init routine if a formatting

is needed

if (Mmc_Fat_Init() = 0) then

...

end if

' reinitialize SPI1 at higher speed

SPI1_Init_Advanced(MASTER_OSC_DIV4, DATA_SAMPLE_MIDDLE,

CLK_IDLE_LOW, LOW_2_HIGH)

Mmc_Fat_QuickFormat

345

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Fat_QuickFormat(dim mmc_fat_label as string[11])

as byte

Returns

 0- if MMC/SD card was detected, successfully formated and initialized

 1- if FAT16 format was unseccessful

 255 - if MMC/SD card was not detected

Description

Formats to FAT16 and initializes MMC/SD card.

Parameters:

 mmc_fat_label: volume label (11 characters in length). If less than 11

characters are provided, the label will be padded with spaces. If null

string is passed volume will not be labeled

Note: This routine can be used instead or in conjunction with Mmc_Fat_Init

routine.

Note: If MMC/SD card already contains a valid boot sector, it will remain

unchanged (except volume label field) and only FAT and ROOT tables will be

erased. Also, the new volume label will be set.

Requires The appropriate hardware SPI module must be previously initialized.

Example

Initialize SPI1 module and set pointer(s) to SPI1 functions

SPI1_Init_Advanced(MASTER_OSC_DIV64, DATA_SAMPLE_MIDDLE,

CLK_IDLE_LOW, LOW_2_HIGH)

' Format and initialize MMC/SD card and MMC_FAT16 library globals

if (Mmc_Fat_QuickFormat('mikroE') = 0) then

...

end if

' Reinitialize the SPI module at higher speed (change primary

prescaler).

SPI1_Init_Advanced(MASTER_OSC_DIV4, DATA_SAMPLE_MIDDLE,

CLK_IDLE_LOW, LOW_2_HIGH)

Mmc_Fat_Assign

346 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Fat_Assign(dim byref filename as char[12], dim

file_cre_attr as byte)as byt

Returns  1 - if file already exists or file does not exist but a new file is created.

 0 - if file does not exist and no new file is created.

Description

Assigns file for file operations (read, write, delete...). All subsequent file opera-

tions will be applied on an assigned file.

Parameters:

 filename: name of the file that should be assigned for file operations.

File name should be in DOS 8.3 (file_name.extension) format. The file

name and extension will be automatically padded with spaces by the

library if they have less than length required (i.e. "mikro.tx" -> "mikro .tx

"), so the user does no have to take care of that. The file name and

extension are case insensitive. The library will convert them to proper

case automatically, so the user does not have to take care of that.

Also, in order to keep backward compatibility with the first version of

this library, file names can be entered as UPPERCASE string of 11

bytes in length with no dot character between file name and extension

(i.e. "MIKROELETXT" -> MIKROELE.TXT). In this case last 3 charac

ters of the string are considered to be file extension.

 file_cre_attr: file creation and attributs flags. Each bit corresponds to

the appropriate file attribut:

Note: Long File Names (LFN) are not supported.

Requires MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init

Example ' create file with archive attribut if it does not already exist

Mmc_Fat_Assign("MIKRO007.TXT",0xA0)

Bit Mask Description

0 0x01 Read Only

1 0x02 Hidden

2 0x04 System

3 0x08 Volume Label

4 0x10 Subdirectory

5 0x20 Archive

6 0x40 Device (internal use only, never found on disk)

7 0x80 File creation flag. If file does not exist and this flag is

set, a new file with specified name will be created.

Mmc_Fat_Reset

Mmc_Fat_Read

347

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Mmc_Fat_Reset(dim byref size as longword)

Returns Nothing.

Description

Opens currently assigned file for reading.

Parameters:

 size: buffer to store file size to. After file has been open for reading its

size is returned through this parameter.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

Example

dim size as longword

...

main:

...

Mmc_Fat_Reset(size)

...

end.

Prototype sub procedure Mmc_Fat_Read(dim byref bdata as byte)

Returns Nothing.

Description

Reads a byte from the currently assigned file opened for reading. Upon function

execution file pointers will be set to the next character in the file.

Parameters:

 bdata: buffer to store read byte to. Upon this function execution read

byte is returned through this parameter.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

The file must be opened for reading. See Mmc_Fat_Reset.

Example

dim character as byte

...

main:

...

Mmc_Fat_Read(character)

...

end.

Mmc_Fat_Rewrite

Mmc_Fat_Append

348 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Mmc_Fat_Rewrite()

Returns Nothing.

Description Opens the currently assigned file for writing. If the file is not empty its content

will be erased.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

Example 'open file for writing

Mmc_Fat_Rewrite()

Prototype sub procedure Mmc_Fat_Append()

Returns Nothing.

Description

Opens the currently assigned file for appending. Upon this function execution

file pointers will be positioned after the last byte in the file, so any subsequent

file write operation will start from there.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

Example ' open file for appending

Mmc_Fat_Append()

Mmc_Fat_Delete

Mmc_Fat_Write

349

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Mmc_Fat_Delete()

Returns Nothing.

Description Deletes currently assigned file from MMC/SD card.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign

Example ' delete current file

Mmc_Fat_Delete()

Prototype sub procedure Mmc_Fat_Write(dim byref fdata as byte[512], dim

data_len as word)

Returns Nothing.

Description

Writes requested number of bytes to the currently assigned file opened for writ-

ing.

Parameters:

fdata: data to be written.

data_len: number of bytes to be written.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

The file must be opened for writing. See Mmc_Fat_Rewrite or

Mmc_Fat_Append.

Example

'dim file_contents as char[42]

...

main:

...

Mmc_Fat_Write(file_contents, 42) 'write data to the assigned

file

...

end.

Mmc_Fat_Set_File_Date

350 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Mmc_Fat_Set_File_Date(dim year as word, dim month,

day, hours, mins, seconds as byte)

Returns Nothing.

Description

Sets the date/time stamp. Any subsequent file write operation will write this

stamp to the currently assigned file's time/date attributs.

Parameters:

year: year attribute. Valid values: 1980-2107

month: month attribute. Valid values: 1-12

 day: day attribute. Valid values: 1-31

 hours: hours attribute. Valid values: 0-23

 mins: minutes attribute. Valid values: 0-59

 seconds: seconds attribute. Valid values: 0-59

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

The file must be opened for writing. See Mmc_Fat_Rewrite or

Mmc_Fat_Append.

Example Mmc_Fat_Set_File_Date(2005,9,30,17,41,0)

Mmc_Fat_Get_File_Date

351

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Mmc_Fat_Get_File_Date(dim byref year as word, dim

byref month, day, hours, mins as byte)

Returns Nothing.

Description

Reads time/date attributes of the currently assigned file.

Parameters:

 year: buffer to store year attribute to. Upon function execution year attrib

ute is returned through this parameter.

 month: buffer to store month attribute to. Upon function execution month

attribute is returned through this parameter.

 day: buffer to store day attribute to. Upon function execution day attrib

ute is returned through this parameter.

 hours: buffer to store hours attribute to. Upon function execution hours

attribute is returned through this parameter.

 mins: buffer to store minutes attribute to. Upon function execution min

utes attribute is returned through this parameter.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

Example

dim year as word

month, day, hours, mins as byte

...

main:

...

Mmc_Fat_Get_File_Date(year, month, day, hours, mins)

...

end.

Mmc_Fat_Get_File_Size

Mmc_Fat_Get_Swap_File

352 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Mmc_Fat_Get_File_Size() as longword

Returns Size of the currently assigned file in bytes.

Description This function reads size of the currently assigned file in bytes.

Requires

MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init.

The file must be previously assigned. See Mmc_Fat_Assign.

Example

dim my_file_size as longword

...

main:

...

my_file_size = Mmc_Fat_Get_File_Size

...

end.

Prototype sub function Mmc_Fat_Get_Swap_File(dim sectors_cnt as longint,

dim byref filename as string[11], dim file_attr as byte)as dword

Returns

Number of the start sector for the newly created swap file, if there was

enough free space on the MMC/SD card to create file of required size.

 0 - otherwise.

Description

This function is used to create a swap file of predefined name and size on the

MMC/SD media. If a file with specified name already exists on the media,

search for consecutive sectors will ignore sectors occupied by this file. There-

fore, it is recommended to erase such file if it already exists before calling this

function. If it is not erased and there is still enough space for a new swap file,

this function will delete it after allocating new memory space for a new swap file.

The purpose of the swap file is to make reading and writing to MMC/SD media as

fast as possible, by using the Mmc_Read_Sector() and Mmc_Write_Sector() func-

tions directly, without potentially damaging the FAT system. The swap file can be con-

sidered as a "window" on the media where the user can freely write/read data. It's

main purpose in the mikroBasic PRO for PIC's library is to be used for fast data

acquisition; when the time-critical acquisition has finished, the data can be re-written

into a "normal" file, and formatted in the most suitable way.

Parameters:

 sectors_cnt: number of consecutive sectors that user wants the swap

file to have.

353

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Description

 filename: name of the file that should be assigned for file operations. File name

should be in DOS 8.3 (file_name.extension) format. The file name and extension will

be automatically padded with spaces by the library if they have less than length

required (i.e. "mikro.tx" -> "mikro .tx "), so the user does no have to take care of that.

The file name and extension are case insensitive. The library will convert them to prop-

er case automatically, so the user does not have to take care of that.

Also, in order to keep backward compatibility with the first version of this library, file

names can be entered as UPPERCASE string of 11 bytes in length with no dot char-

acter between file name and extension (i.e. "MIKROELETXT" -> MIKROELE.TXT). In

this case last 3 characters of the string are considered to be file extension.

 file_attr: file creation and attributs flags. Each bit corresponds to the

appropriate file attribut:

Note: Long File Names (LFN) are not supported.

Requires MMC/SD card and MMC library must be initialized for file operations. See

Mmc_Fat_Init

Example

'-------------- Try to create a swap file with archive atribute,

whose size will be at least 1000 sectors.

' If it succeeds, it sends No. of start sector

over UART

dim size as longword

...

main:

...

size = Mmc_Fat_Get_Swap_File(1000, "mikroE.txt", 0x20)

if size then

UART1_Write(0xAA)

UART1_Write(Lo(size))

UART1_Write(Hi(size))

UART1_Write(Higher(size))

UART1_Write(Highest(size))

UART1_Write(0xAA

end if

...

end.

Bit Mask Description

0 0x01 Read Only

1 0x02 Hidden

2 0x04 System

3 0x08 Volume Label

4 0x10 Subdirectory

5 0x20 Archive

6 0x40 Device (internal use only, never found on disk)

7 0x80 Not used

Library Example

The following example demonstrates MMC library test. Upon flashing, insert a

MMC/SD card into the module, when you should receive the "Init-OK" message.

Then, you can experiment with MMC read and write functions, and observe the

results through the Usart Terminal.

program MMC_Test

dim MMC_chip_select as sbit at RC2_bit

dim MMC_chip_select_direction as sbit at TRISC2_bit

const FILL_CHAR = "m"

dim i, SectorNo as word

dim mmc_error as byte

dim data_ok as bit

' Variables for MMC routines

SectorData as byte[512] ' Buffer for MMC sector reading/writing

data_for_registers as byte[16] ' buffer for CID and CSD registers

' UART write text and new line (carriage return + line feed)

sub procedure UART_Write_Line(dim byref uart_text as byte)

UART1_Write_Text(uart_text)

UART1_Write(13)

UART1_Write(10)

end sub

' Display byte in hex

sub procedure printhex(dim i as byte)

dim high, low as byte

high = i and 0xF0 ' High nibble

high = high >> 4

high = high + "0"

if ( high > "9" ) then

high = high + 7

low = (i and 0x0F) + "0" ' Low nibble

if ( low > "9" ) then

low = low + 7

end if

UART1_Write(high)

UART1_Write(low)

end if

end sub

354 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

main:

ADCON1 = ADCON1 or 0x0F ' Configure AN pins as digital

CMCON = CMCON or 7 ' Turn off comparators

' Initialize UART1 module

UART1_Init(19200)

Delay_ms(10)

UART_Write_Line("PIC-Started") ' PIC present report

' Initialize SPI1 module

SPI1_Init_Advanced(_SPI_MASTER_OSC_DIV64, _SPI_DATA_SAMPLE_MIDDLE,

_SPI_CLK_IDLE_LOW, _SPI_LOW_2_HIGH)

' initialise a MMC card

mmc_error = Mmc_Init()

if ( mmc_error = 0 ) then

UART_Write_Line("MMC Init-OK") ' If MMC present report

else

UART_Write_Line("MMC Init-error") ' If error report

end if

' Fill MMC buffer with same characters

for i = 0 to 511

SectorData[i] = FILL_CHAR

next i

Write sector

mmc_error = Mmc_Write_Sector(SectorNo, SectorData)

if ( mmc_error = 0 ) then

UART_Write_Line("Write-OK")

else ' if there are errors.....

UART_Write_Line("Write-Error")

end if

' Reading of CID register

mmc_error = Mmc_Read_Cid(data_for_registers)

if ( mmc_error = 0 ) then

UART1_Write_Text("CID : ")

for i = 0 to 15

printhex(data_for_registers[i])

next i

UART_Write_Line(" ")

else

UART_Write_Line("CID-error")

end if

355

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

' Reading of CSD register

mmc_error = Mmc_Read_Csd(data_for_registers)

if ( mmc_error = 0 ) then

UART1_Write_Text("CSD : ")

for i = 0 to 15

printhex(data_for_registers[i])

next i

UART_Write_Line(" ")

else

UART_Write_Line("CSD-error")

end if

' Read sector

mmc_error = Mmc_Read_Sector(SectorNo, SectorData)

if ( mmc_error = 0 ) then

UART_Write_Line("Read-OK")

else ' if there are errors.....

UART_Write_Line("Read-Error")

end if

' Chech data match

data_ok = 1

for i = 0 to 511

UART1_Write(SectorData[i])

if (SectorData[i] <> FILL_CHAR) then

data_ok = 0

break

end if

next i

if ( data_ok <> 0 ) then

UART_Write_Line("Content-OK")

else

UART_Write_Line("Content-Error")

end if

' Signal test end

UART_Write_Line("Test End.")

end.

356 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

Pin diagram of MMC memory card

357

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

ONEWIRE LIBRARY

The OneWire library provides routines for communication via the Dallas OneWire

protocol, for example with DS18x20 digital thermometer. OneWire is a Master/Slave

protocol, and all communication cabling required is a single wire. OneWire enabled

devices should have open collector drivers (with single pull-up resistor) on the

shared data line.

Slave devices on the OneWire bus can even get their power supply from data line.

For detailed schematic see device datasheet.

Some basic characteristics of this protocol are:

 single master system,

 low cost

low transfer rates (up to 16 kbps),

 fairly long distances (up to 300 meters),

 small data transfer packages.

Each OneWire device has also a unique 64-bit registration number (8-bit device

type, 48-bit serial number and 8-bit CRC), so multiple slaves can co-exist on the

same bus.

Note that oscillator frequency Fosc needs to be at least 4MHz in order to use the

routines with Dallas digital thermometers.

Note: This library implements time-based activities, so interrupts need to be dis-

abled when using OneWire library.

Library Routines

 Ow_Reset

 Ow_Read

 Ow_Write

358 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

359

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Ow_Reset

Ow_Read

Ow_Write

Prototype sub function Ow_Reset(dim byref port as byte, pin as byte)as

byte

Returns 0 if DS1820 is present, and 1 if not present.

Description Issues OneWire reset signal for DS1820. Parameters port and pin specify the

location of DS1820.

Requires Works with Dallas DS1820 temperature sensor only.

Example To reset the DS1820 that is connected to the RA5 pin:

Ow_Reset(PORTA, 5)

Prototype sub function Ow_Read(dim byref port as byte, dim pin as byte)as

byte

Returns Data read from an external device over the OneWire bus.

Description Reads one byte of data via the OneWire bus.

Requires Works with Dallas DS1820 temperature sensor only.

Example tmp = Ow_Read(PORTA, 5)

Prototype sub procedure Ow_Write(dim byref port as byte, dim pin, par as

byte)

Returns Nothing.

Description Writes one byte of data (argument par) via OneWire bus.

Requires Works with Dallas DS1820 temperature sensor only.

Example Ow_Write(PORTA, 5, $CC)

360 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Library Example

This example reads the temperature using DS18x20 connected to pin PORTA.B5.

After reset, MCU obtains temperature from the sensor and prints it on the Lcd. Make

sure to pull-up PORTA.B5 line and to turn off the PORTA LEDs.

program OneWire

' Lcd module connections

dim LCD_RS as sbit at RB4_bit

LCD_EN as sbit at RB5_bit

LCD_D4 as sbit at RB0_bit

LCD_D5 as sbit at RB1_bit

LCD_D6 as sbit at RB2_bit

LCD_D7 as sbit at RB3_bit

LCD_RS_Direction as sbit at TRISB4_bit

LCD_EN_Direction as sbit at TRISB5_bit

LCD_D4_Direction as sbit at TRISB0_bit

LCD_D5_Direction as sbit at TRISB1_bit

LCD_D6_Direction as sbit at TRISB2_bit

LCD_D7_Direction as sbit at TRISB3_bit

' End Lcd module connections

' Set TEMP_RESOLUTION to the corresponding resolution of used

DS18x20 sensor:

' 18S20: 9 (default setting can be 9,10,11,or 12)

' 18B20: 12

const TEMP_RESOLUTION as byte = 9

dim text as byte[9]

temp as word

sub procedure Display_Temperature( dim temp2write as word )

const RES_SHIFT = TEMP_RESOLUTION - 8

dim temp_whole as byte

temp_fraction as word

text = "000.0000"

' check if temperature is negative

if (temp2write and 0x8000) then

text[0] = "-"

temp2write = not temp2write + 1

end if

' extract temp_whole

temp_whole = word(temp2write >> RES_SHIFT)

' convert temp_whole to characters

if ( temp_whole div 100 ) then

text[0] = temp_whole div 100 + 48

else

text[0] = "0"

end if

text[1] = (temp_whole div 10)mod 10 + 48 ' Extract tens digit

text[2] = temp_whole mod 10 + 48 ' Extract ones digit

' extract temp_fraction and convert it to unsigned int

temp_fraction = word(temp2write << (4-RES_SHIFT))

temp_fraction = temp_fraction and 0x000F

temp_fraction = temp_fraction * 625

' convert temp_fraction to characters

text[4] = word(temp_fraction div 1000) + 48 ' Extract

thousands digit

text[5] = word((temp_fraction div 100)mod 10 + 48) ' Extract hun-

dreds digit

text[6] = word((temp_fraction div 10)mod 10 + 48) ' Extract tens

digit

text[7] = word(temp_fraction mod 10) + 48 ' Extract ones

digit

' print temperature on Lcd

Lcd_Out(2, 5, text)

end sub

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

text = "000.0000"

Lcd_Init() ' Initialize Lcd

Lcd_Cmd(_LCD_CLEAR) ' Clear Lcd

Lcd_Cmd(_LCD_CURSOR_OFF) ' Turn cursor off

Lcd_Out(1, 1, " Temperature: ")

Lcd_Chr(2,13,178) ' Print degree character, "C" for Centigrades

' different Lcd displays have different char

code for degree

Lcd_Chr(2,14,"C") ' if you see greek alpha letter try typing

178 instead of 223

'--- main loop

while (TRUE)

'--- perform temperature reading

Ow_Reset(PORTE, 2) ' Onewire reset signal

Ow_Write(PORTE, 2, 0xCC) ' Issue command SKIP_ROM

Ow_Write(PORTE, 2, 0x44) ' Issue command CONVERT_T

Delay_us(120)

361

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Ow_Reset(PORTE, 2)

Ow_Write(PORTE, 2, 0xCC) ' Issue command SKIP_ROM

Ow_Write(PORTE, 2, 0xBE) ' Issue command READ_SCRATCHPAD

temp = Ow_Read(PORTE, 2)

temp = (Ow_Read(PORTE, 2) << 8) + temp

'--- Format and display result on Lcd

Display_Temperature(temp)

Delay_ms(520)

wend

end.

HW Connection

Example of DS1820 connection

362 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

PORT EXPANDER LIBRARY

The mikroBasic PRO for PIC provides a library for communication with the

Microchip’s Port Expander MCP23S17 via SPI interface. Connections of the PIC

compliant MCU and MCP23S17 is given on the schematic at the bottom of this

page.

Note: Library uses the SPI module for communication. The user must initialize SPI

module before using the Port Expander Library.

Note: Library does not use Port Expander interrupts.

External dependencies of Port Expander Library

Library Routine

Expander_Init

Expander_Read_Byte

 Expander_Write_Byte

 Expander_Read_PortA

 Expander_Read_PortB

 Expander_Read_PortAB

 Expander_Write_PortA

 Expander_Write_PortB

 Expander_Write_PortAB

 Expander_Set_DirectionPortA

 Expander_Set_DirectionPortB

 Expander_Set_DirectionPortAB

 Expander_Set_PullUpsPortA

 Expander_Set_PullUpsPortB

 Expander_Set_PullUpsPortAB

363

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

The following variables must

be defined in all projects

using Port Expander Library:

Description: Example :

dim SPExpanderRST as sbit

sfr external;Reset line. dim SPExpanderRST as

sbit at RC0_bit

dim SPExpanderCS as sbit

sfr external Chip Select line. dim SPExpanderCS as

sbit at RC1_bit

dim

SPExpanderRST_Direction

as sbit sfr external

Direction of the

Reset pin.

dim

SPExpanderRST_Directio

nas sbit at

TRISC0_bit

dim

SPExpanderCS_Direction as

sbit sfr external

Direction of the

Chip Select pin.

dim

SPExpanderCS_Direction

s as sbit at

TRISC1_bit

364 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Expander_Init

Prototype sub procedure Expander_Init(dim ModuleAddress as byte)

Returns Nothing.

Description

Initializes Port Expander using SPI communication.

Port Expander module settings :

 hardware addressing enabled

 automatic address pointer incrementing disabled (byte mode)

 BANK_0 register adressing

 slew rate enabled

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at

the bottom of this page

Requires

Global variables :

 SPExpanderCS: Chip Select line

 SPExpanderRST: Reset line

 SPExpanderCS_Direction: Direction of the Chip Select pin

 SPExpanderRST_Direction: Direction of the Reset pin

must be defined before using this function.

SPI module needs to be initialized. See SPI1_Init and SPI1_Init_Advanced rou-

tines.

Example

' port expander pinout definition

dim SPExpanderCS as sbit at RC1_bit

SPExpanderRST as sbit at RC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

...

SPI1_Init() ' initialize SPI module

Expander_Init(0) ' initialize port expander

365

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Expander_Read_Byte

Expander_Write_Byte

Prototype sub function Expander_Read_Byte(dim ModuleAddress as byte, dim

RegAddress as byte)as byte

Returns Byte read.

Description

The function reads byte from Port Expander.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 RegAddress: Port Expander's internal register address

Requires Port Expander must be initialized. See Expander_Init.

Example

' Read a byte from Port Expander's register

dim read_data as byte

...

read_data = Expander_Read_Byte(0,1)

Prototype sub procedure Expander_Write_Byte(dim ModuleAddress as byte, dim

RegAddress as byte, dim Data_ as byte)

Returns Nothing.

Description

Routine writes a byte to Port Expander.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 RegAddress: Port Expander's internal register address

 Data_: data to be written

Requires Port Expander must be initialized. See Expander_Init.

Example ' Write a byte to the Port Expander's register

Expander_Write_Byte(0,1,0xFF)

366 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Expander_Read_PortA

Expander_Read_PortB

Prototype sub function Expander_Read_PortA(dim ModuleAddress as byte)as

byte

Returns Byte read.

Description

The function reads byte from Port Expander's PortA.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

Requires

Port Expander must be initialized. See Expander_Init.

Port Expander's PortA should be configured as input. See Expander_Set_Direc-

tionPortA and Expander_Set_DirectionPortAB routines.

Example

' Read a byte from Port Expander's PORTA

dim read_data as byte

...

Expander_Set_DirectionPortA(0,0xFF) 'set expander's porta to be

input

...

read_data = Expander_Read_PortA(0)

Prototype sub function Expander_Read_PortB(dim ModuleAddress as byte)as

byte

Returns Byte read.

Description

The function reads byte from Port Expander's PortB.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at

the bottom of this page

Requires

Port Expander must be initialized. See Expander_Init.

Port Expander's PortB should be configured as input. See Expander_Set_Direc-

tionPortB and Expander_Set_DirectionPortAB routines.

Example

' Read a byte from Port Expander's PORTB

dim read_data as byte

...

Expander_Set_DirectionPortB(0,0xFF) ' set expander's portb

to be input

...

read_data = Expander_Read_PortB(0)

367

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Expander_Read_PortAB

Expander_Write_PortA

Prototype sub function Expander_Read_PortAB(dim ModuleAddress as byte)as

word

Returns Word read.

Description

The function reads word from Port Expander's ports. PortA readings are in the

higher byte of the result. PortB readings are in the lower byte of the result.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

Requires

Port Expander must be initialized. See Expander_Init.

Port Expander's PortA and PortB should be configured as inputs. See

Expander_Set_DirectionPortA, Expander_Set_DirectionPortB and

Expander_Set_DirectionPortAB routines.

Example

' Read a byte from Port Expander's PORTA and PORTB

dim read_data as word

...

Expander_Set_DirectionPortAB(0,0xFFFF) ' set expander's porta

and portb to be input

...

read_data = Expander_Read_PortAB(0)

Prototype sub procedure Expander_Write_PortA(dim ModuleAddress as byte, dim

Data_ as byte)

Returns Nothing.

Description

The function writes byte to Port Expander's PortA.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 Data_: data to be written

Requires

Port Expander must be initialized. See Expander_Init.

Port Expander's PortA should be configured as output. See

Expander_Set_DirectionPortA and Expander_Set_DirectionPortAB routines.

Example

' Write a byte to Port Expander's PORTA

...

Expander_Set_DirectionPortA(0,0x00) ' set expander's porta to be

output

...

Expander_Write_PortA(0, 0xAA)

368 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Expander_Write_PortB

Expander_Write_PortAB

Prototype sub procedure Expander_Write_PortB(dim ModuleAddress as byte, dim

Data_ as byte)

Returns Nothing.

Description

The function writes byte to Port Expander's PortB.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at

the bottom of this page

 Data_: data to be written

Requires

Port Expander must be initialized. See Expander_Init.

Port Expander's PortB should be configured as output. See

Expander_Set_DirectionPortB and Expander_Set_DirectionPortAB routines.

Example

' Write a byte to Port Expander's PORT

...

Expander_Set_DirectionPortB(0,0x00) ' set expander's portb to be

output

...

Expander_Write_PortB(0, 0x55)

Prototype sub procedure Expander_Write_PortAB(dim ModuleAddress as byte,dim

Data_ as word)

Returns Nothing.

Description

The function writes word to Port Expander's ports.

Parameters :

ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

Data_: data to be written. Data to be written to PortA are passed in

Data's higher byte. Data to be written to PortB are passed in Data's

lower byte

Requires

Port Expander must be initialized. See Expander_Init.

Port Expander's PortA and PortB should be configured as outputs. See

Expander_Set_DirectionPortA, Expander_Set_DirectionPortB and

Expander_Set_DirectionPortAB routines.

Example

' Write a byte to Port Expander's PORTA and PORTB

...

Expander_Set_DirectionPortAB(0,0x0000) ' set expander's porta

and portb to be output

...

Expander_Write_PortAB(0, 0xAA55)

369

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Expander_Set_DirectionPortA

Expander_Set_DirectionPortB

Prototype sub procedure Expander_Set_DirectionPortA(dim ModuleAddress as

byte, dim Data_ as byte)

Returns Nothing.

Description

The function sets Port Expander's PortA direction.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 Data_: data to be written to the PortA direction register. Each bit corre

sponds to the appropriate pin of the PortA register. Set bit designates cor

responding pin as input. Cleared bit designates corresponding pin as out

put.

Requires Port Expander must be initialized. See Expander_Init.

Example ' Set Port Expander's PORTA to be output

Expander_Set_DirectionPortA(0,0x00)

Prototype sub procedure Expander_Set_DirectionPortB(dim ModuleAddress as

byte, dim Data_ as byte)

Returns Nothing.

Description

The function sets Port Expander's PortB direction.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 Data_: data to be written to the PortB direction register. Each bit corre

sponds to the appropriate pin of the PortB register. Set bit designates cor

responding pin as input. Cleared bit designates corresponding pin as out

put.

Requires Port Expander must be initialized. See Expander_Init.

Example ' Set Port Expander's PORTB to be input

Expander_Set_DirectionPortB(0,0xFF)

370 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Expander_Set_DirectionPortAB

Expander_Set_PullUpsPortA

Prototype sub procedure Expander_Set_DirectionPortAB(dim ModuleAddress as

byte, dim Direction as word)

Returns Nothing.

Description

The function sets Port Expander's PortA and PortB direction.

Parameters :

ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

Direction: data to be written to direction registers. Data to be written to

the PortA direction register are passed in Direction's higher byte. Data

to be written to the PortB direction register are passed in Direction's

lower byte. Each bit corresponds to the appropriate pin of the

PortA/PortB register. Set bit designates corresponding pin as input.

Cleared bit designates corresponding pin as output.

Requires Port Expander must be initialized. See Expander_Init.

Example 'Set Port Expander's PORTA to be output and PORTB to be input

Expander_Set_DirectionPortAB(0,0x00FF)

Prototype sub procedure Expander_Set_PullUpsPortA(dim ModuleAddress as

byte, dim Data_ as byte)

Returns Nothing.

Description

The function sets Port Expander's PortA pull up/down resistors.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 Data_: data for choosing pull up/down resistors configuration. Each

bit corresponds to the appropriate pin of the PortA register. Set bit

enables pull-up for corresponding pin.

Requires Port Expander must be initialized. See Expander_Init.

Example ' Set Port Expander's PORTA pull-up resistors

Expander_Set_PullUpsPortA(0, 0xFF)

371

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Expander_Set_PullUpsPortB

Expander_Set_PullUpsPortAB

Prototype sub procedure Expander_Set_PullUpsPortB(dim ModuleAddress as

byte, dim Data_ as byte)

Returns Nothing.

Description

The function sets Port Expander's PortB pull up/down resistors.

Parameters :

 ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 Data_: data for choosing pull up/down resistors configuration. Each bit

corresponds to the appropriate pin of the PortB register. Set bit enables

pull-up for corresponding pin.

Requires Port Expander must be initialized. See Expander_Init.

Example ‘Set Port Expander's PORTB pull-up resistors

Expander_Set_PullUpsPortB(0, 0xFF)

Prototype sub procedure Expander_Set_PullUpsPortAB(dim ModuleAddress as

byte, dim PullUps as word)

Returns Nothing.

Description

The function sets Port Expander's PortA and PortB pull up/down resistors.

Parameters :

ModuleAddress: Port Expander hardware address, see schematic at the

bottom of this page

 PullUps: data for choosing pull up/down resistors configuration. PortA pull

up/down resistors configuration is passed in PullUps's higher byte. PortB

pull up/down resistors configuration is passed in PullUps's lower byte.

Each bit corresponds to the appropriate pin of the PortA/PortB register.

Set bit enables pull-up for corresponding pin.

Requires Port Expander must be initialized. See Expander_Init.

Example ' Set Port Expander's PORTA and PORTB pull-up resistors

Expander_Set_PullUpsPortAB(0, 0xFFFF)

Library Example

The example demonstrates how to communicate with Port Expander MCP23S17.

Note that Port Expander pins A2 A1 A0 are connected to GND so Port Expander

Hardware Address is 0.

program PortExpander

' Port Expander module connections

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' End Port Expander module connections

dim counter as byte' = 0

main:

counter = 0

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

TRISB = 0 ' Set PORTB as output

PORTB = 0

SPI1_Init_Advanced(_SPI_MASTER_OSC_DIV4, _SPI_DATA_SAMPLE_MIDDLE,

_SPI_CLK_IDLE_LOW, _SPI_LOW_2_HIGH)

Expander_Init(0) ' Initialize Port Expander

Expander_Set_DirectionPortA(0, 0x00) ' Set Expander's PORTA to be

output

Expander_Set_DirectionPortB(0,0xFF) ' Set Expander's PORTB to be

input

Expander_Set_PullUpsPortB(0,0xFF) ' Set pull-ups to all of the

Expander's PORTB pins

while TRUE ' Endless loop

Expander_Write_PortA(0, counter) ' Write i to expander's PORTA

Inc(counter)

PORTB = Expander_Read_PortB(0) ' Read expander's PORTB and

write it to LEDs

Delay_ms(100)

wend

end.

372 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

Port Expander HW connection

373

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

PS/2 LIBRARY

The mikroBasic PRO for PIC provides a library for communication with the common

PS/2 keyboard.

Note: The library does not utilize interrupts for data retrieval, and requires the oscil-

lator clock to be at least 6MHz.

Note: The pins to which a PS/2 keyboard is attached should be connected to the

pull-up resistors.

Note: Although PS/2 is a two-way communication bus, this library does not provide

MCU-to-keyboard communication; e.g. pressing the Caps Lock key will not turn on

the Caps Lock LED.

External dependencies of PS/2 Library

Library Routines

 Ps2_Config

 Ps2_Key_Read

374 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using PS/2

Library:

Description: Example :

dim PS2_Data as sbit

sfr external PS/2 Data line. dim PS2_Data as sbit

at RC0_bit

dim PS2_Clock as sbit

sfr external PS/2 Clock line. dim PS2_Clock as

sbit at RC1_bit

dim PS2_Data_Direction

as sbit sfr external

Direction of the PS/2 Data

pin.

dim

PS2_Data_Direction as

sbit at TRISC0_bit

dim PS2_Clock_Direction

as sbit sfr external

Direction of the PS/2

Clock pin.

dim

PS2_Clock_Direction

as sbit at TRISC1_bit

375

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Ps2_Config

Prototype sub procedure Ps2_Config()

Returns Nothing.

Description Initializes the MCU for work with the PS/2 keyboard.

Requires

Global variables :

 PS2_Data: Data signal line

 PS2_Clock: Clock signal line in

 PS2_Data_Direction: Direction of the Data pin

 PS2_Clock_Direction: Direction of the Clock pin

must be defined before using this function.

Example

' PS2 pinout definition

dim PS2_Data as sbit at RC0_bit

dim PS2_Clock as sbit at RC1_bit

dim PS2_Data_Direction as sbit at TRISC0_bit

dim PS2_Clock_Direction as sbit at TRISC1_bit

' End of PS2 pinout definition

...

Ps2_Config() ' Init PS/2 Keyboard

376 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Ps2_Key_Read

Prototype sub function Ps2_Key_Read(dim byref value as byte, dim byref spe-

cial as byte, dim byref pressed as byte) as byte

Returns 1if reading of a key from the keyboard was successful

0if no key was pressed

Description

The function retrieves information on key pressed.

Parameters :

value: holds the value of the key pressed. For characters, numerals,

punctuation marks, and space value will store the appropriate ASCII

code. Routine “recognizes” the function of Shift and Caps Lock, and

behaves appropriately. For special function keys see Special Function

Keys Table.

 special: is a flag for special function keys (F1, Enter, Esc, etc). If key

pressed is one of these, special will be set to 1, otherwise 0.

 pressed: is set to 1 if the key is pressed, and 0 if it is released.

Requires PS/2 keyboard needs to be initialized. See Ps2_Config routine.

Example

dim value, special, pressed as byte

...

do {

if (Ps2_Key_Read(value, special, pressed)) then

if ((value = 13) and (special = 1)) then

break

end if

loop until (0=1)

Special Function Keys

377

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Key Value returned

F1 1

F2 2

F3 3

F4 4

F5 5

F6 6

F7 7

F8 8

F9 9

F10 10

F11 11

F12 12

Enter 13

Page Up 14

Page Down 15

Backspace 16

Insert 17

Delete 18

Windows 19

Ctrl 20

Shift 21

Alt 22

Print Screen 23

Pause 24

Caps Lock 25

End 26

Home 27

Scroll Lock 28

Num Lock 29

Left Arrow 30

Right Arrow 31

Up Arrow 32

Down Arrow 33

Escape 34

Tab 35

Library Example

This simple example reads values of the pressed keys on the PS/2 keyboard and

sends them via UART.

program PS2_Example

dim keydata, special, down as byte

dim PS2_Data as sbit at PORTC.0

PS2_Clock as sbit at PORTC.1

PS2_Data_Direction as sbit at TRISC.0

PS2_Clock_Direction as sbit at TRISC.1

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

UART1_Init(19200) ' Initialize UART module at 9600 bps

Ps2_Config() ' Init PS/2 Keyboard

Delay_ms(100) ' Wait for keyboard to finish

UART1_Write_Text("Ready") ' Ready

while TRUE ' Endless loop

if Ps2_Key_Read(keydata, special, down) then ' If data was read

from PS/2

if (down <> 0) and (keydata = 16) then ' Backspace read

UART1_Write(0x08) ' Send Backspace to

usart terminal

else

if (down <> 0) and (keydata = 13) then ' Enter read

UART1_Write(10) ' Send carriage return to

usart terminal

UART1_Write(13) ' Uncomment this line if

usart terminal also expects line feed

' for new line transition

else

if (down <> 0) and (special = 0) and (keydata <> 0) then

' Common key read

UART1_Write(keydata) ' Send key to usart terminal

end if

Delay_ms(10) ' Debounce period

wend

end.

378 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

Example of PS2 keyboard connection

379

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

PWM LIBRARY

CCP module is available with a number of PIC MCUs. mikroBasic PRO for PIC provides library

which simplifies using PWM HW Module.

Note: Some MCUs have multiple CCP modules. In order to use the desired CCP library routine,

simply change the number 1 in the prototype with the appropriate module number, i.e.

PWM2_Start()

Library Routines

 PWM1_Init

 PWM1_Set_Duty

 PWM1_Start

 PWM1_Stop

PWM1_Init

380 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure PWM1_Init(dim freq as longint)

Returns Nothing.

Description

Initializes the PWM module with duty ratio 0. Parameter freq is a desired PWM

frequency in Hz (refer to device data sheet for correct values in respect with

Fosc).

This routine needs to be called before using other functions from PWM Library.

Requires

MCU must have CCP module.

Note: Calculation of the PWM frequency value is carried out by the compiler, as

it would produce a relatively large code if performed on the libary level.

Therefore, compiler needs to know the value of the parameter in the compile

time. That is why this parameter needs to be a constant, and not a variable.

Example

Initialize PWM module at 5KHz:

PWM1_Init(5000)

PWM1_Set_Duty

PWM1_Start

PWM1_Stop

381

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure PWM1_Set_Duty(dim duty_ratio as byte)

Returns Nothing.

Description

Sets PWM duty ratio. Parameter duty takes values from 0 to 255, where 0 is

0%, 127 is 50%, and 255 is 100% duty ratio. Other specific values for duty ratio

can be calculated as (Percent*255)/100.

Requires MCU must have CCP module. PWM1_Init must be called before using this rou-

tine.

Example

Set duty ratio to 75%:

PWM1_Set_Duty(192)

Prototype sub procedure PWM1_Star

Returns Nothing.

Description Starts PWM.

Requires MCU must have CCP module. PWM1_Init must be called before using this rou-

tine.

Example PWM1_Start

Prototype sub procedure PWM1_Stop

Returns Nothing.

Description Stops PWM.

Requires

MCU must have CCP module. PWM1_Init must be called before using this rou-

tine. PWM1_Start should be called before using this routine, otherwise it will

have no effect as the PWM module is not running.

Example PWM1_Stop

Library Example

The example changes PWM duty ratio on pin PB3 continually. If LED is connected

to PB3, you can observe the gradual change of emitted light.

program PWM_Test

dim current_duty, current_duty1, old_duty, old_duty1 as byte

sub procedure InitMain()

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

PORTA = 255

TRISA = 255 ' configure PORTA pins as input

PORTB = 0 ' set PORTB to 0

TRISB = 0 ' designate PORTB pins as output

PORTC = 0 ' set PORTC to 0

TRISC = 0 ' designate PORTC pins as output

PWM1_Init(5000) ' Initialize PWM1 module at 5KHz

PWM2_Init(5000) ' Initialize PWM2 module at 5KHz

end sub

main:

InitMain()

current_duty = 16 ' initial value for current_duty

current_duty1 = 16 ' initial value for current_duty1

PWM1_Start() ' start PWM1

PWM2_Start() ' start PWM2

PWM1_Set_Duty(current_duty) ' Set current duty for PWM1

PWM2_Set_Duty(current_duty1) ' Set current duty for PWM2

while (TRUE) ' endless loop

if (RA0_bit <> 0) then ' button on RA0 pressed

Delay_ms(40)

Inc(current_duty) ' increment current_duty

PWM1_Set_Duty(current_duty)

end if

if (RA1_bit <> 0) then ' button on RA1 pressed

Delay_ms(40)

Dec(current_duty) ' decrement current_duty

PWM1_Set_Duty(current_duty)

end if

if (RA2_bit <> 0) then ' button on RA2 pressed

Delay_ms(40)

Inc(current_duty1) ' increment current_duty1

PWM2_Set_Duty(current_duty1)

382 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

end if

if (RA3_bit <> 0) then ' button on RA3 pressed

Delay_ms(40)

Dec(current_duty1) ' decrement current_duty1

PWM2_Set_Duty(current_duty1)

end if

Delay_ms(5) ' slow down change pace a little

wend

end.

HW Connection

PWM demonstration

383

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

RS-485 LIBRARY

RS-485 is a multipoint communication which allows multiple devices to be connect-

ed to a single bus. The mikroBasic PRO for PIC provides a set of library routines for

comfortable work with RS485 system using Master/Slave architecture. Master and

Slave devices interchange packets of information. Each of these packets contains

synchronization bytes, CRC byte, address byte and the data. Each Slave has

unique address and receives only packets addressed to it. The Slave can never ini-

tiate communication.

It is the user’s responsibility to ensure that only one device transmits via 485 bus at

a time.

The RS-485 routines require the UART module. Pins of UART need to be attached

to RS-485 interface transceiver, such as LTC485 or similar (see schematic at the

bottom of this page).

Note: The library uses the UART module for communication. The user must initial-

ize the appropriate UART module before using the RS-485 Library. For MCUs with

two UART modules it is possible to initialize both of them and then switch by using

the UART_Set_Active function. See the UART Library functions.

Library constants:

 START byte value = 150

 STOP byte value = 169

 Address 50 is the broadcast address for all Slaves (packets containing

address 50 will be received by all Slaves except the Slaves with addresses

150 and 169).

External dependencies of RS-485 Library

384 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variable

must be defined in all proj-

ects using RS-485 Library:

Description: Example :

dim RS485_rxtx_pin as

sbit sfr external

Control RS-485 Trans-

mit/Receive operation

mode

dim RS485_rxtx_pin as

sbit at RC2_bit

dim

RS485_rxtx_pin_direction

as sbit sfr ternal Direction of the RS-485

Transmit/Receive pin

dim

RS485_rxtx_pin_direc-

tion as sbit at

TRISC2_bit

385

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Library Routines

 RS485Master_Init

 RS485Master_Receive

 RS485Master_Send

 RS485Slave_Init

 RS485Slave_Receive

 RS485Slave_Send

RS485master_Init

Prototype sub procedure RS485Master_Init()

Returns Nothing.

Description Initializes MCU as a Master for RS-485 communication.

Requires

Global variables :

RS485_rxtx_pin - this pin is connected to RE/DE input of RS-485 trans

ceiver(see schematic at the bottom of this page). RE/DE signal controls

RS-485 transceiver operation mode.

RS485_rxtx_pin_direction - direction of the RS-485 Transmit/Receive

must be defined before using this function.

UART HW module needs to be initialized. See UARTx_Init

Example

' RS485 module pinout

dim RS485_rxtx_pin as sbit at RC2_bit

dim RS485_rxtx_pin_direction as sbit at TRISC2_bit

' End of RS485 module pinout

...

UART1_Init(9600) ' initialize UART module

RS485Master_Init() ' intialize MCU as a Master

for RS-485 communication

386 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

RS485master_Receive

RS485master_Send

Prototype sub procedure Rs485Master_Send(dim byref data_buffer as byte[20],

dim datalen as byte, dim slave_address as byte)

Returns Nothing.

Description

Sends message to Slave(s). Message format can be found at the bottom of this

page.

Parameters :

 data_buffer: data to be sent

datalen: number of bytes for transmition. Valid values: 0...3.

 slave_address: Slave(s) address

Requires

MCU must be initialized as a Master for RS-485 communication. See

RS485Master_Init.

It is the user’s responsibility to ensure (by protocol) that only one device sends

data via 485 bus at a time.

Example

dim msg as byte[20]

...

' send 3 bytes of data to slave with address 0x12

RS485Master_Send(msg, 3, 0x12)

Prototype sub procedure RS485Master_Receive(dim byref data_buffer as byte[20])

Returns Nothing.

Description

Receives messages from Slaves. Messages are multi-byte, so this routine must

be called for each byte received.

Parameters :

data_buffer: 7 byte buffer for storing received data, in the following man

ner:

data[0..2]: message content

 data[3]: number of message bytes received, 1–3

 data[4]: is set to 255 when message is received

 data[5]: is set to 255 if error has occurred

 data[6]: address of the Slave which sent the message

The function automatically adjusts data[4] and data[5] upon every received

message. These flags need to be cleared by software.

Requires MCU must be initialized as a Master for RS-485 communication. See

RS485master_Init.

Example

dim msg as byte[20]

...

RS485Master_Receive(msg)

387

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

RS485slave_Init

Prototype sub procedure RS485Slave_Init(dim slave_address as byte)

Returns Nothing.

Description

Initializes MCU as a Slave for RS-485 communication.

Parameters :

slave_address: Slave address

Requires

Global variables :

RS485_rxtx_pin - this pin is connected to RE/DE input of RS-485 trans

ceiver(see schematic at the bottom of this page). RE/DE signal controls

RS-485 transceiver operation mode. Valid values: 1(for transmitting) and

0 (for receiving)

RS485_rxtx_pin_direction - direction of the RS-485 Transmit/Receive

must be defined before using this function.

UART HW module needs to be initialized. See UARTx_Init.

Example

' RS485 module pinout

dim RS485_rxtx_pin as sbit at RC2_bit

dim RS485_rxtx_pin_direction as sbit at TRISC2_bit

' End of RS485 module pinout

...

UART1_Init(9600) ' initialize UART module

RS485Slave_Init(160) ' intialize MCU as a Slave

for RS-485 communication with address 160

388 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

RS485slave_Receive

RS485slave_Send

Prototype sub procedure RS485Slave_Receive(dim byref data_buffer as

byte[20])

Returns Nothing.

Description

Receives messages from Master. If Slave address and Message address field

don't match then the message will be discarded. Messages are multi-byte, so

this routine must be called for each byte received.

Parameters :

 data_buffer: 6 byte buffer for storing received data, in the following mann

er:

 data[0..2]: message content

 data[3]: number of message bytes received, 1–3

 data[4]: is set to 255 when message is received

 data[5]: is set to 255 if error has occurred

The function automatically adjusts data[4] and data[5] upon every received

message. These flags need to be cleared by software.

Requires MCU must be initialized as a Slave for RS-485 communication. See

RS485slave_Init.

Example

dim msg as byte[5]

...

RS485Slave_Read(msg)

Prototype sub procedure RS485Slave_Send(dim byref data_buffer as byte[20],

dim datalen as byte)

Returns Nothing.

Description

Sends message to Master. Message format can be found at the bottom of this page.

Parameters :

data_buffer: data to be sent

datalen: number of bytes for transmition. Valid values: 0...3.

Requires

MCU must be initialized as a Slave for RS-485 communication. See

RS485Slave_Init. It is the user’s responsibility to ensure (by protocol) that only

one device sends data via 485 bus at a time.

Example

dim msg as byte[8]

...

' send 2 bytes of data to the master

RS485Slave_Send(msg, 2)

Library Example

This is a simple demonstration of RS485 Library routines usage.

Master sends message to Slave with address 160 and waits for a response. The

Slave accepts data, increments it and sends it back to the Master. Master then does

the same and sends incremented data back to Slave, etc.

Master displays received data on PORTB, while error on receive (0xAA) and num-

ber of consecutive unsuccessful retries are displayed on PORTD. Slave displays

received data on PORTB, while error on receive (0xAA) is displayed on PORTD.

Hardware configurations in this example are made for the EasyPIC5 board and

16F887.

RS485 Master code:

program RS485_Master_Example

dim dat as byte[10] ' buffer for receving/sending messages

i, j as byte

cnt as longint

dim rs485_rxtx_pin as sbit at RC2_bit ' set transcieve pin

rs485_rxtx_pin_direction as sbit at TRISC2_bit ' set tran

scieve pin direction

' Interrupt routine

sub procedure interrupt()

RS485Master_Receive(dat)

end sub

main:

cnt = 0

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

PORTB = 0

PORTD = 0

TRISB = 0

TRISD = 0

UART1_Init(9600) ' initialize UART1 module

Delay_ms(100)

389

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

RS485Master_Init() ' initialize MCU as Master

dat[0] = 0xAA

dat[1] = 0xF0

dat[2] = 0x0F

dat[4] = 0 ' ensure that message received flag is 0

dat[5] = 0 ' ensure that error flag is 0

dat[6] = 0

RS485Master_Send(dat,1,160)

PIE1.RCIE = 1 ' enable interrupt on UART1 receive

PIE2.TXIE = 0 ' disable interrupt on UART1 transmit

INTCON.PEIE = 1 ' enable peripheral interrupts

INTCON.GIE = 1 ' enable all interrupts

while TRUE ' upon completed valid message receiving

' data[4] is set to 255

Inc(cnt)

if (dat[5] <> 0) then ' if an error detected, signal it

PORTD = 0xAA ' by setting portd to 0xAA

end if

if (dat[4] <> 0) then ' if message received successfully

cnt = 0

dat[4] = 0 ' clear message received flag

j = dat[3]

for i = 1 to dat[3] ' show data on PORTB

PORTB = dat[i-1]

next i

dat[0] = dat[0]+1 ' increment received dat[0]

Delay_ms(1) ' send back to slave

RS485Master_Send(dat,1,160)

end if

if (cnt > 100000) then ' if in 100000 poll-cycles the answer

Inc(PORTD) ' was not detected, signal

cnt = 0 ' failure of send-message

RS485Master_Send(dat,1,160)

if (PORTD > 10) then ' if sending failed 10 times

RS485Master_Send(dat,1,50) ' send message on broadcast address

end if

wend

end.

390 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

RS485 Slave code:

program RS485_Slave_Example

dim dat as byte[20] ' buffer for receving/sending messages

i, j as byte

dim rs485_rxtx_pin as sbit at RC2_bit ' set transcieve pin

rs485_rxtx_pin_direction as sbit at TRISC2_bit ' set transcieve

pin direction

' Interrupt routine

sub procedure interrupt()

RS485Slave_Receive(dat)

end sub

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

PORTB = 0

PORTD = 0

TRISB = 0

TRISD = 0

UART1_Init(9600) ' initialize UART1 module

Delay_ms(100)

RS485Slave_Init(160) ' Initialize MCU as slave, address 160

dat[4] = 0 ' ensure that message received flag is 0

dat[5] = 0 ' ensure that message received flag is 0

dat[6] = 0 ' ensure that error flag is 0

PIE1.RCIE = 1 ' enable interrupt on UART1 receive

PIE2.TXIE = 0 ' disable interrupt on UART1 transmit

INTCON.PEIE = 1 ' enable peripheral interrupts

INTCON.GIE = 1 ' enable all interrupts

while TRUE

if (dat[5] <> 0) then ' if an error detected, signal it by

PORTD = 0xAA ' setting PORTD to 0xAA

dat[5] = 0

end if

if (dat[4] <> 0) then ' upon completed valid message receive

dat[4] = 0 ' data[4] is set to 0xFF

j = dat[3]

for i = 1 to dat[3] ' show data on PORTB

391

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

PORTB = dat[i-1]

next i

dat[0] = dat[0]+1 ' increment received dat[0]

Delay_ms(1)

RS485Slave_Send(dat,1) ' and send it back to master

end if

wend

end.

HW Connection

Example of interfacing PC to PIC16F887 MCU via RS485

bus with LTC485 as RS-485 transceiver

392 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Message format and CRC calculations

Q: How is CRC checksum calculated on RS485 master side?

_START_BYTE = 0x96; ' 10010110

_STOP_BYTE = 0xA9; ' 10101001

PACKAGE:

--------

_START_BYTE 0x96

ADDRESS

DATALEN

[DATA1] ' if exists

[DATA2] ' if exists

[DATA3] ' if exists

CRC

_STOP_BYTE 0xA9

DATALEN bits

------------

bit7 = 1 MASTER SENDS

0 SLAVE SENDS

bit6 = 1 ADDRESS WAS XORed with 1, IT WAS EQUAL TO _START_BYTE or

_STOP_BYTE

0 ADDRESS UNCHANGED

bit5 = 0 FIXED

bit4 = 1 DATA3 (if exists) WAS XORed with 1, IT WAS EQUAL TO

_START_BYTE or _STOP_BYTE

0 DATA3 (if exists) UNCHANGED

bit3 = 1 DATA2 (if exists) WAS XORed with 1, IT WAS EQUAL TO

_START_BYTE or _STOP_BYTE

0 DATA2 (if exists) UNCHANGED

bit2 = 1 DATA1 (if exists) WAS XORed with 1, IT WAS EQUAL TO

_START_BYTE or _STOP_BYTE

0 DATA1 (if exists) UNCHANGED

bit1bit0 = 0 to 3 NUMBER OF DATA BYTES SEND

CRC generation :

----------------

crc_send = datalen ^ address;

crc_send ^= data[0]; ' if exists

crc_send ^= data[1]; ' if exists

crc_send ^= data[2]; ' if exists

crc_send = ~crc_send;

if ((crc_send == _START_BYTE) || (crc_send == _STOP_BYTE))

crc_send++;

NOTE: DATALEN<4..0> can not take the _START_BYTE<4..0> or

_STOP_BYTE<4..0> values.

393

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SOFTWARE I²C LIBRARY

The mikroBasic PRO for PIC provides routines for implementing Software I2C com-

munication. These routines are hardware independent and can be used with any

MCU. The Software I2C library enables you to use MCU as Master in I2C communi-

cation. Multi-master mode is not supported.

Note: This library implements time-based activities, so interrupts need to be dis-

abled when using Software I2C.

Note: All Software I2C Library functions are blocking-call functions (they are waiting

for I2C clock line to become logical one).

Note: The pins used for the Software I2C communication should be connected to

the pull-up resistors. Turning off the LEDs connected to these pins may also be

required.

External dependecies of Soft_I2C Library

Library Routines

 Soft_I2C_Init

Soft_I2C_Start

 Soft_I2C_Read

 Soft_I2C_Write

 Soft_I2C_Stop

 Soft_I2C_Break

394 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using Soft_I2C

Library:

Description: Example :

dim Soft_I2C_Scl as

sbit sfr external Soft I2C Clock line. dim Soft_I2C_Scl as

sbit at RC3_bit

dim Soft_I2C_Sda as

sbit sfr external Soft I2C Data line. dim Soft_I2C_Sda as

sbit at RC4_bit

dim

Soft_I2C_Scl_Direction

as sbit sfr external

Direction of the Soft I2C

Clock pin.

dim

Soft_I2C_Scl_Direction

as sbit at TRISC3_bit

dim

Soft_I2C_Sda_Direction

as sbit sfr external

Direction of the Soft I2C

Data pin.

dim

Soft_I2C_Sda_Direction

as sbit at TRISC4_bit

395

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Soft_I2C_Init

Soft_I2C_Start

Prototype sub procedure Soft_I2C_Init()

Returns Nothing.

Description Configures the software I2C module.

Requires

Global variables :

 Soft_I2C_Scl: Soft I2C clockline

 Soft_I2C_Sda: Soft I2C data line

 Soft_I2C_Scl_Direction: Direction of the Soft I2C clock pin

 Soft_I2C_Sda_Direction: Direction of the Soft I2C data pin

must be defined before using this function.

Example

'Soft_I2C pinout definition

dim Soft_I2C_Scl as sbit at RC3_bit

dim Soft_I2C_Sda as sbit at RC4_bit

dim Soft_I2C_Scl_Direction as sbit at TRISC3_bit

dim Soft_I2C_Sda_Direction as sbit at TRISC4_bit

'End of Soft_I2C pinout definition

...

Soft_I2C_Init()

Prototype sub procedure Soft_I2C_Start()

Returns Nothing.

Description Determines if the I2C bus is free and issues START signal.

Requires Software I2C must be configured before using this function. See Soft_I2C_Init

routine.

Example ' Issue START signal

Soft_I2C_Start()

396 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Soft_I2C_Read

Soft_I2C_Write

Prototype sub function Soft_I2C_Write(dim _Data as byte)as byte

Returns 0if there were no errors.

1if write collision was detected on the I2C bus.

Description

Sends data byte via the I2C bus.

Parameters :

_Data: data to be sent

Requires

Soft I2C must be configured before using this function. See Soft_I2C_Init routine.

Also, START signal needs to be issued in order to use this function. See

Soft_I2C_Start routine.

Example

dim _data, error as byte

...

error = Soft_I2C_Write(data)

error = Soft_I2C_Write(0xA3)

Prototype sub function Soft_I2C_Read(dim ack as word)as byte

Returns One byte from the Slave.

Description

Reads one byte from the slave.

Parameters :

 ack: acknowledge signal parameter. If the ack==0 not acknowledge sig

nal will be sent after reading, otherwise the acknowledge signal will be sent.

Requires

Soft I2C must be configured before using this function. See Soft_I2C_Init routine.

Also, START signal needs to be issued in order to use this function. See

Soft_I2C_Start routine.

Example

dim take as word

...

' Read data and send the not_acknowledge signal

take = Soft_I2C_Read(0)

Soft_I2C_Stop

Soft_I2C_Break

397

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Soft_I2C_Stop()

Returns Nothing.

Description Issues STOP signal.

Requires Soft I2C must be configured before using this function. See Soft_I2C_Init routine.

Example ' Issue STOP signal

Soft_I2C_Stop()

Prototype sub procedure Soft_I2C_Break()

Returns Nothing.

Description

All Software I2C Library functions can block the program flow (see note at the

top of this page). Calling this routine from interrupt will unblock the program

execution. This mechanism is similar to WDT.

Note: Interrupts should be disabled before using Software I2C routines again

(see note at the top of this page).

Requires Nothing.

Example

dim data1, error_, counter as byte

sub procedure interrupt()

if (INTCON.T0IF <> 0) then

if (counter >= 20) then

Soft_I2C_Break()

counter = 0 ' reset counter

end if

else

Inc(counter) ' increment counter

INTCON.T0IF = 0 ' Clear Timer0 overflow interrupt flag

end if

end sub

main:

counter = 0

OPTION_REG = 0x04 ' TMR0 prescaler set to 1:32

...

' try Soft_I2C_Init with blocking prevention mechanism

INTCON.GIE = 1 ' Global interrupt enable

INTCON.T0IE = 1 ' Enable Timer0 overflow interrupt

data1 = Soft_I2C_Init(error_)

INTCON.GIE = 0 ' Global interrupt disable

end.

LLibrary Example

The example demonstrates Software I˛C Library routines usage. The PIC MCU is

connected (SCL, SDA pins) to PCF8583 RTC (real-time clock). Program reads date

and time are read from the RTC and prints it on Lcd.

program RTC_Read

dim seconds, minutes, hours, _day, _month, year as byte ' Global

date/time variables

' Software I2C connections

dim Soft_I2C_Scl as sbit at RC3_bit

Soft_I2C_Sda as sbit at RC4_bit

Soft_I2C_Scl_Direction as sbit at TRISC3_bit

Soft_I2C_Sda_Direction as sbit at TRISC4_bit

' End Software I2C connections

' Lcd module connections

dim LCD_RS as sbit at RB4_bit

LCD_EN as sbit at RB5_bit

LCD_D4 as sbit at RB0_bit

LCD_D5 as sbit at RB1_bit

LCD_D6 as sbit at RB2_bit

LCD_D7 as sbit at RB3_bit

LCD_RS_Direction as sbit at TRISB4_bit

LCD_EN_Direction as sbit at TRISB5_bit

LCD_D4_Direction as sbit at TRISB0_bit

LCD_D5_Direction as sbit at TRISB1_bit

LCD_D6_Direction as sbit at TRISB2_bit

LCD_D7_Direction as sbit at TRISB3_bit

' End Lcd module connections

'--------------------- Reads time and date information from RTC

(PCF8583)

sub procedure Read_Time()

Soft_I2C_Start() ' Issue start signal

Soft_I2C_Write(0xA0) ' Address PCF8583, see PCF8583 datasheet

Soft_I2C_Write(2) ' Start from address 2

Soft_I2C_Start() ' Issue repeated start signal

Soft_I2C_Write(0xA1) ' Address PCF8583 for reading R/W=1

seconds = Soft_I2C_Read(1) ' Read seconds byte

minutes = Soft_I2C_Read(1) ' Read minutes byte

hours = Soft_I2C_Read(1) ' Read hours byte

_day = Soft_I2C_Read(1) ' Read year/day byte

_month = Soft_I2C_Read(0) ' Read weekday/month byte}

Soft_I2C_Stop() ' Issue stop signal}

end sub

398 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

'-------------------- Formats date and time

sub procedure Transform_Time()

seconds = ((seconds and 0xF0) >> 4)*10 + (seconds and 0x0F) '

Transform seconds

minutes = ((minutes and 0xF0) >> 4)*10 + (minutes and 0x0F) '

Transform months

hours = ((hours and 0xF0) >> 4)*10 + (hours and 0x0F) '

Transform hours

year = (_day and 0xC0) >> 6 ' Transform year

_day = ((_day and 0x30) >> 4)*10 + (_day and 0x0F) '

Transform day

_month = ((_month and 0x10) >> 4)*10 + (_month and 0x0F) '

Transform month

end sub

'-------------------- Output values to Lcd

sub procedure Display_Time()

Lcd_Chr(1, 7, (_day / 10) + 48) ' Print tens digit of day

variable

Lcd_Chr(1, 8, (_day mod 10) + 48) ' Print oness digit of day

variable

Lcd_Chr(1,10, (_month / 10) + 48)

Lcd_Chr(1,11, (_month mod 10) + 48)

Lcd_Chr(1,16, year + 56) ' Print year vaiable + 8

(start from year 2008)

Lcd_Chr(2, 7, (hours / 10) + 48)

Lcd_Chr(2, 8, (hours mod 10) + 48)

Lcd_Chr(2,10, (minutes / 10) + 48)

Lcd_Chr(2,11, (minutes mod 10) + 48)

Lcd_Chr(2,13, (seconds / 10) + 48)

Lcd_Chr(2,14, (seconds mod 10) + 48)

end sub

'------------------ Performs project-wide init

sub procedure Init_Main()

TRISB = 0

PORTB = 0xFF

TRISB = 0xFF

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

Soft_I2C_Init() ' Initialize Soft I2C communication

Lcd_Init() ' Initialize Lcd

Lcd_Cmd(_LCD_CLEAR) ' Clear Lcd display

Lcd_Cmd(_LCD_CURSOR_OFF) ' Turn cursor off

Lcd_Out(1,1,"Date:") ' Prepare and output static text on Lcd

Lcd_Chr(1,9,":")

Lcd_Chr(1,12,":")

Lcd_Out(2,1,"Time:")

Lcd_Chr(2,9,":")

399

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Lcd_Chr(2,12,":")

Lcd_Out(1,13,"200")

end sub

'----------------- Main sub procedure

main:

Init_Main() ' Perform initialization

while TRUE ' Endless loop

Read_Time() ' Read time from RTC(PCF8583)

Transform_Time() ' Format date and time

Display_Time() ' Prepare and display on Lcd

wend

end.

400 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SOFTWARE SPI LIBRARY

The mikroBasic PRO for PIC provides routines for implementing Software SPI com-

munication. These routines are hardware independent and can be used with any

MCU. The Software SPI Library provides easy communication with other devices via

SPI: A/D converters, D/A converters, MAX7219, LTC1290, etc.

Library configuration:

 SPI to Master mode

 Clock value = 20 kHz.

 Data sampled at the middle of interval.

 Clock idle state low.

 Data sampled at the middle of interval.

 Data transmitted at low to high edge.

Note: The Software SPI library implements time-based activities, so interrupts need

to be disabled when using it.

External dependencies of Software SPI Library

Library Routines

 Soft_Spi_Init

 Soft_Spi_Read

 Soft_Spi_Write

401

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using Software

SPI Library:

Description: Example :

dim SoftSpi_SDI as

sbit sfr external Data In line. dim SoftSpi_SDI as

sbit at RC4_bit

dim SoftSpi_SDO as

sbit sfr external Data Out line. dim SoftSpi_SDO as

sbit at RC5_bit

dim SoftSpi_CLK as

sbit sfr external Clock line. dim SoftSpi_CLK as

sbit at RC3_bit

dim

SoftSpi_SDI_Direction

as sbit sfr external Direction of the Data In pin.

dim

SoftSpi_SDI_Direction

as sbit at TRISC4_bit

dim

SoftSpi_SDO_Direction

as sbit sfr external

Direction of the Data Out

dim

SoftSpi_SDO_Direction

as sbit at TRISC5_bit

dim

SoftSpi_CLK_Direction

as sbit sfr external Direction of the Clock pin

dim

SoftSpi_CLK_Direction

as sbit at TRISC3_bit

402 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Soft_Spi_Init

Prototype sub procedure Soft_SPI_Init()

Returns Nothing.

Description Configures and initializes the software SPI module.

Requires

Global variables:

Chip_Select: Chip select line

SoftSpi_SDI: Data in line

SoftSpi_SDO: Data out line

SoftSpi_CLK: Data clock line

Chip_Select_Direction: Direction of the Chip select pin

SoftSpi_SDI_Direction: Direction of the Data in pin

SoftSpi_SDO_Direction: Direction of the Data out pin

SoftSpi_CLK_Direction: Direction of the Data clock pin

must be defined before using this function.

Example

' soft_spi pinout definition

dim Chip_Select as sbit at RC1_bit

dim SoftSpi_SDI as sbit at RC4_bit

dim SoftSpi_SDO as sbit at RC5_bit

dim SoftSpi_CLK as sbit at RC3_bit

dim Chip_Select_Direction as sbit at TRISC1_bit

dim SoftSpi_SDI_Direction as sbit at TRISC4_bit

dim SoftSpi_SDO_Direction as sbit at TRISC5_bit

dim SoftSpi_CLK_Direction as sbit at TRISC3_bit

' end of soft_spi pinout definition

...

Soft_SPI_Init() ' Init Soft_SPI

403

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Soft_Spi_Read

Soft_Spi_Write

Prototype sub procedure Soft_SPI_Write(dim sdata as byte)

Returns Nothing.

Description

This routine sends one byte via the Software SPI bus.

Parameters :

 sdata: data to be sent

Requires Soft SPI must be initialized before using this function. See Soft_SPI_Init routine.

Example ' Write a byte to the Soft SPI bus

Soft_SPI_Write(0xAA)

Prototype sub function Soft_SPI_Read(dim sdata as byte)as word

Returns Byte received via the SPI bus.

Description

This routine performs 3 operations simultaneously. It provides clock for the Soft-

ware SPI bus, reads a byte and sends a byte.

Parameters :

 sdata: data to be sent.

Requires Soft SPI must be initialized before using this function. See Soft_SPI_Init routine.

Example

dim data_read as byte

data_send as byte

...

' Read a byte and assign it to data_read variable

' (data_send byte will be sent via SPI during the Read operation)

data_read = Soft_SPI_Read(data_send)

Library Example

This code demonstrates using library routines for Soft_SPI communication. Also,

this example demonstrates working with Microchip's MCP4921 12-bit D/A con

verter.

program Soft_SPI

' DAC module connections

dim Chip_Select as sbit at RC1_bit

SoftSpi_CLK as sbit at RC3_bit

SoftSpi_SDI as sbit at RC4_bit

SoftSpi_SDO as sbit at RC5_bit

dim Chip_Select_Direction as sbit at TRISC1_bit

SoftSpi_CLK_Direction as sbit at TRISC3_bit

SoftSpi_SDI_Direction as sbit at TRISC4_bit

SoftSpi_SDO_Direction as sbit at TRISC5_bit

' End DAC module connections

dim value as word

sub procedure InitMain()

TRISA0_bit = 1 ' Set RA0 pin as input

TRISA1_bit = 1 ' Set RA1 pin as input

Chip_Select = 1 ' Deselect DAC

Chip_Select_Direction = 0 ' Set CS# pin as Output

Soft_Spi_Init() ' Initialize Soft_SPI

end sub

' DAC increments (0..4095) --> output voltage (0..Vref)

sub procedure DAC_Output(dim valueDAC as word)

dim temp as byte

Chip_Select = 0 ' Select DAC chip

' Send High Byte

temp = word(valueDAC >> 8) and 0x0F ' Store valueDAC[11..8] to

temp[3..0]

temp = temp or 0x30 ' Define DAC setting, see MCP4921 datasheet

Soft_SPI_Write(temp) ' Send high byte via Soft SPI

' Send Low Byte

temp = valueDAC ' Store valueDAC[7..0] to temp[7..0]

Soft_SPI_Write(temp) ' Send low byte via Soft SPI

Chip_Select = 1 ' Deselect DAC chip

end sub

404 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

main:

ANSEL = 0

ANSELH = 0

InitMain() ' Perform main initialization

value = 2048 ' When program starts, DAC gives

' the output in the mid-range

while (TRUE) ' Endless loop

if ((RA0_bit) and (value < 4095)) then ' If PA0 button is

pressed

Inc(value) ' increment value

else

if ((RA1_bit) and (value > 0)) then 'If PA1 button is pressed

Dec(value) ' decrement value

end if

DAC_Output(value) ' Send value to DAC chip

Delay_ms(1) ' Slow down key repeat pace

wend

end.

405

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SOFTWARE UART LIBRARY

mikroBasic provides library which implements software UART. These routines are hardware inde-

pendent and can be used with any MCU. You can easily communicate with other devices via

RS232 protocol – simply use the functions listed below.

Note: This library implements time-based activities, so interrupts need to be disabled when using

Soft UART.

Library Routines

 Soft_Uart_Init

 Soft_Uart_Read

 Soft_Uart_Write

 Soft_UART_Break

Soft_UART_Init

406 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Soft_UART_Init(dim byref port as byte, dim rx_pin,

tx_pin, baud_rate, inverted as byte)as byte

Returns

 2 - error, requested baud rate is too low

 1 - error, requested baud rate is too high

 0- successfull initialization

Description

Configures and initializes the software UART module.

Parameters :

 port: port to be used.

 rx_pin: sets rx_pin to be used.

 tx_pin: sets tx_pin to be used.

 baud_rate: baud rate to be set. Maximum baud rate depends on the

MCU’s clock and working conditions.

 inverted: inverted output flag. When set to a non-zero value, inverted

logic on output is used.

Software UART routines use Delay_Cyc routine. If requested baud rate is too

low then calculated parameter for calling Delay_Cyc exceeeds Delay_Cyc

argument range.

If requested baud rate is too high then rounding error of Delay_Cyc argument

corrupts Software UART timings.

Requires Nothing.

Example

This will initialize software UART and establish the communication at 9600 bps:

dim error as byte

...

error = Soft_UART_Init(PORTB, 1, 2, 9600, 0)

407

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Soft_UART_Read

Soft_Uart_Write

Prototype sub function Soft_UART_Read(dim byref error as byte)as byte

Returns Returns a received byte.

Description

Function receives a byte via software UART. Parameter error will be zero if the

transfer was successful. This is a non-blocking function call, so you should test

the error manually (check the example below).

Requires Soft UART must be initialized and communication established before using this

function. See Soft_UART_Init.

Example

Here’s a loop which holds until data is received:

error = 1

data = Soft_UART_Read(error)

loop until error = 0

Prototype sub procedure Soft_UART_Write(dim data as byte)

Returns Nothing.

Description Function transmits a byte (data) via UART.

Requires

Soft UART must be initialized and communication established before using this

function. See Soft_UART_Init.

Be aware that during transmission, software UART is incapable of receiving

data – data transfer protocol must be set in such a way to prevent loss of infor-

mation.

Example Soft_UART_Write($0A)

408 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Soft_UART_Break

Prototype sub procedure Soft_UART_Break()

Returns Nothing.

Description

Soft_UART_Read is blocking routine and it can block the program flow. Call this

routine from interrupt to unblock the program execution. This mechanism is sim-

ilar to WDT.

Note: Interrupts should be disabled before using Software UART routines again

(see note at the top of this page).

Requires Nothing.

Example

dim data1, error_, counter as byte

sub procedure interrupt()

if (INTCON.T0IF <> 0) then

if (counter >= 20) then

Soft_UART_Break()

counter = 0 ' reset counter

end if

else

Inc(counter) ' increment counter

INTCON.T0IF = 0 ' Clear Timer0 overflow interrupt flag

end if

end sub

main:

counter = 0

OPTION_REG = 0x04 ' TMR0 prescaler set to 1:32

...

if (Soft_UART_Init(PORTC, 7, 6, 9600, 0) = 0) then

Soft_UART_Write(0x55)

end if

...

' try Soft_UART_Read with blocking prevention mechanism

INTCON.GIE = 1 ' Global interrupt enable

INTCON.T0IE = 1 ' Enable Timer0 overflow interrupt

data1 = Soft_UART_Read(error_)

INTCON.GIE = 0 ' Global interrupt disable

end.

Library Example

The example demonstrates simple data exchange via software UART. When PIC

MCU receives data, it immediately sends the same data back. If PIC is connected

to the PC (see the figure below), you can test the example from mikroBasic PRO for

PIC terminal for RS232 communication, menu choice Tools › Terminal.

program Soft_UART

dim error_flag as byte

counter, byte_read as byte ' Auxiliary variables

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

TRISB = 0x00 ' Set PORTB as output (error sig

nalization)

PORTB = 0 ' No error

VDelay_ms(370)

error_flag = Soft_UART_Init(PORTC, 7, 6, 14400, 0) ' Initialize

Soft UART at 14400 bps

if (error_flag > 0) then

PORTB = error_flag ' Signalize Init error

while (TRUE)

nop ' Stop program

wend

end if

Delay_ms(100)

for counter = "z" to "A" step -1 ' Send bytes from 'z' downto 'A'

Soft_UART_Write(counter)

Delay_ms(100)

next counter

while TRUE ' Endless loop

byte_read = Soft_UART_Read(error_flag)' Read byte, then test

error flag

if (error_flag <> 0) then ' If error was detected

PORTB = error_flag ' signal it on PORTB

else

Soft_UART_Write(byte_read) ' If error was not detected,

return byte read

end if

wend

end.

409

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SOUND LIBRARY

The mikroBasic PRO for PIC provides a Sound Library to supply users with rou t i n e s

necessary for sound signalization in their applications. Sound generation needs additional hard-

ware, such as piezo-speaker (example of piezo-speaker interface is given on the schematic at the

bottom of this page).

Library Routines

Sound_Init

Sound_Play

Sound_Init

410 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Sound_Init(dim byref snd_port as byte, dim snd_pin

as byte)

Returns Nothing.

Description

Configures the appropriate MCU pin for sound generation.

Parameters :

 snd_port: sound output port address

 snd_pin: sound output pin

Requires Nothing.

Example Sound_Init(PORTD, 3) ' Initialize sound at RD3

Sound_Play

Library Example

The example is a simple demonstration of how to use the Sound Library for playing tones on a

piezo speaker.

program Sound

sub procedure Tone1()

Sound_Play(659, 250) ' Frequency = 659Hz, duration = 250ms

end sub

sub procedure Tone2()

Sound_Play(698, 250) ' Frequency = 698Hz, duration = 250ms

end sub

sub procedure Tone3()

Sound_Play(784, 250) ' Frequency = 784Hz, duration = 250ms

end sub

sub procedure Melody() ' Plays the melody "Yellow house"

Tone1() Tone2() Tone3() Tone3()

Tone1() Tone2() Tone3()

Tone1() Tone2() Tone3() Tone3()

Tone1() Tone2() Tone3()

Tone3() Tone3() Tone2() Tone2() Tone1()

end sub

sub procedure ToneA() ' Tones used in Melody2 function

411

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Sound_Play(dim freq_in_Hz as word, dim duration_ms as

word)

Returns Nothing.

Description

Generates the square wave signal on the appropriate pin.

Parameters :

 freq_in_Hz: signal frequency in Hertz (Hz)

 duration_ms: signal duration in miliseconds (ms)

Requires

In order to hear the sound, you need a piezo speaker (or other hardware) on

designated port. Also, you must call Sound_Init to prepare hardware for output

before using this function.

Example ' Play sound of 1KHz in duration of 100ms

Sound_Play(1000, 100)

Sound_Play( 880, 50)

end sub

sub procedure ToneC()

Sound_Play(1046, 50)

end sub

sub procedure ToneE()

Sound_Play(1318, 50)

end sub

sub procedure Melody2() ' Plays Melody2

dim counter as byte

for counter = 9 to 1 step -1

ToneA()

ToneC()

ToneE()

next counter

end sub

main:

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

TRISB = 0xF0 ' Configure RB7..RB4 as input, RB3

as output

Sound_Init(PORTD, 3)

Sound_Play(880, 5000)

while TRUE ' endless loop

if (Button(PORTB,7,1,1)) then ' If PORTB.7 is pressed play Tone1

Tone1()

while (RB7_bit <> 0)

nop ' Wait for button to be released

wend

end if

if (Button(PORTB,6,1,1)) then ' If PORTB.6 is pressed play

Tone1

Tone2()

while (RB6_bit <> 0)

nop ' Wait for button to be released

wend

end if

412 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

if (Button(PORTB,4,1,1)) then ' If PORTB.4 is pressed play

Tone1

Melody()

while (RB4_bit <> 0)

nop ' Wait for button to be released

wend

end if

wend

end.

HW Connection

Example of Sound Library sonnection

413

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI LIBRARY

SPI module is available with a number of PIC MCU models. mikroBasic PRO for PIC provides a

library for initializing Slave mode and comfortable work with Master mode. PIC can easily com-

municate with other devices via SPI: A/D converters, D/A converters, MAX7219, LTC1290, etc.

You need PIC MCU with hardware integrated SPI (for example, PIC16F877).

Note: Some PIC18 MCUs have multiple SPI modules. Switching between the SPI modules in the

SPI library is done by the SPI_Set_Active function (SPI module has to be previously initialized).

Note: In order to use the desired SPI library routine, simply change the number 1 in the prototype

with the appropriate module number, i.e. SPI2_Init()

Library Routines

Spi_Init

Spi_Init_Advanced

Spi_Read

Spi_Write

SPI_Set_Active

SPI1_Init

414 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure SPI1_Init()

Returns Nothing.

Description

This routine configures and enables SPI module with the following settings:

 master mode

 8 bit data transfer

 most significant bit sent first

 serial clock low when idle

 data sampled on leading edge

 serial clock = fosc/4

Requires MCU must have SPI module.

Example ' Initialize the SPI module with default settings

SPI1_Init()

415

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Spi1_Init_Advanced

Prototype sub procedure SPI1_Init_Advanced(dim master_slav, data_sample,

clock_idle, transmit_edge as byte)

Returns Nothing.

Description

Configures and initializes SPI. SPI1_Init_Advanced or SPI1_Init needs to be

called before using other functions of SPI Library.

Parameters mode, data_sample and clock_idle configure the SPI module, and

can have the following values:

Requires MCU must have SPI module.

Example

' Set SPI to master mode, clock = Fosc/4, data sampled at the

middle of interval, clock idle state low and data transmitted at

low to high edge:

SPI1_Init_Advanced(_MASTER_OSC_DIV4, _DATA_SAMPLE_MIDDLE,

_CLK_IDLE_LOW, _LOW_2_HIGH)

Description Predefined library const

SPI work mode:

Master clock = Fosc/4 _MASTER_OSC_DIV4

Master clock = Fosc/16 _MASTER_OSC_DIV16

Master clock = Fosc/64 _MASTER_OSC_DIV64

Master clock source TMR2 _MASTER_TMR2

Slave select enabled _SLAVE_SS_ENABLE

Slave select disabled _SLAVE_SS_DIS

Data sampling interval:

Input data sampled in middle of

interval _DATA_SAMPLE_MIDDLE

Input data sampled at the end of

interval _DATA_SAMPLE_END

SPI clock idle state:

Clock idle HIGH _CLK_IDLE_HIGH

Clock idle LOW _CLK_IDLE_LOW

Transmit edge:

Data transmit on low to high

edgefirst _LOW_2_HIGH

Data transmit on high to low

edge _HIGH_2_LOW _HIGH_2_LOW

416 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Spi1_Read

Spi1_Write

Prototype sub function SPI1_Read(dim buffer as byte)as byte

Returns Received data.

Description

Reads one byte from the SPI bus.

Parameters :

buffer: dummy data for clock generation (see device Datasheet for SPI

modules implementation details)

Requires SPI module must be initialized before using this function. See SPI1_Init and

SPI1_Init_Advanced routines.

Example

' read a byte from the SPI bus

dim take, dummy1 as byte

...

take = SPI1_Read(dummy1)

Prototype sub procedure SPI1_Write(dim wrdata as byte)

Returns Nothing.

Description

Writes byte via the SPI bus.

Parameters :

 wrdata: data to be sent

Requires SPI module must be initialized before using this function. See SPI1_Init and

SPI1_Init_Advanced routines.

Example

' write a byte to the SPI bus

dim buffer as byte

...

SPI1_Write(buffer)

SPI_Set_Active

Library Example

The code demonstrates how to use SPI library functions for communication between SPI module

of the MCU and Microchip's MCP4921 12-bit D/A converter

program SPI

' DAC module connections

dim Chip_Select as sbit at RC1_bit

Chip_Select_Direction as sbit at TRISC1_bit

' End DAC module connections

dim value as word

sub procedure InitMain()

TRISA0_bit = 1 ' Set RA0 pin as input

TRISA1_bit = 1 ' Set RA1 pin as input

Chip_Select = 1 ' Deselect DAC

Chip_Select_Direction = 0 ' Set CS# pin as Output

SPI1_Init() ' Initialize SPI1 module

end sub

' DAC increments (0..4095) --> output voltage (0..Vref)

sub procedure DAC_Output(dim valueDAC as word)

dim temp as byte

Chip_Select = 0 ' Select DAC chip

' Send High Byte

temp = word(valueDAC >> 8) and 0x0F ' Store valueDAC[11..8] to

temp[3..0]

temp = temp or 0x30 ' Define DAC setting, see MCP4921 datasheet

417

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype void SPI_Set_Active(char (*read_ptr)(char))

Returns Nothing.

Description

Sets the active SPI module which will be used by the SPI routines.

Parameters :

read_ptr: SPI1_Read handler

Requires

Routine is available only for MCUs with two SPI modules.

Used SPI module must be initialized before using this function. See the

SPI1_Init, SPI1_Init_Advanced

Example SPI_Set_Active(SPI2_Read) ' Sets the SPI2 module active

SPI1_Write(temp) ' Send high byte via SPI

' Send Low Byte

temp = valueDAC ' Store valueDAC[7..0] to temp[7..0]

SPI1_Write(temp) ' Send low byte via SPI

Chip_Select = 1 ' Deselect DAC chip

end sub

main:

ANSEL = 0

ANSELH = 0

InitMain() ' Perform main initialization

value = 2048 ' When program starts, DAC gives

' the output in the mid-range

while TRUE ' Endless loop

if ((RA0_bit) and (value < 4095)) then ' If RA0 button is pressed

Inc(value) ' increment value

else

if ((RA1_bit) and (value > 0)) then ' If RA1 button is pressed

Dec(value) ' decrement value

end if

DAC_Output(value) ' Send value to DAC chip

Delay_ms(1) ' Slow down key repeat pace

wend

end.

HW Connection

SPI HW connection

418 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI ETHERNET LIBRARY

The ENC28J60 is a stand-alone Ethernet controller with an industry standard Serial

Peripheral Interface (SPI™). It is designed to serve as an Ethernet network interface

for any controller equipped with SPI.

The ENC28J60 meets all of the IEEE 802.3 specifications. It incorporates a number

of packet filtering schemes to limit incoming packets. It also provides an internal

DMA module for fast data throughput and hardware assisted IP checksum calcula-

tions. Communication with the host controller is implemented via two interrupt pins

and the SPI, with data rates of up to 10 Mb/s. Two dedicated pins are used for LED

link and network activity indication.

This library is designed to simplify handling of the underlying hardware (ENC28J60).

It works with any PIC with integrated SPI and more than 4 Kb ROM memory. 38 to

40 MHz clock is recommended to get from 8 to 10 Mhz SPI clock, otherwise PIC

should be clocked by ENC28J60 clock output due to its silicon bug in SPI hardware.

If you try lower PIC clock speed, there might be board hang or miss some requests.

SPI Ethernet library supports:

 IPv4 protocol.

 ARP requests.

 ICMP echo requests.

 UDP requests.

 TCP requests (no stack, no packet reconstruction).

 ARP client with cache.

 DNS client.

 UDP client.

 DHCP client.

 packet fragmentation is NOT supported.

Note: Due to PIC16 RAM/Flash limitations pic16 library does NOT have ARP, DNS,

UDP and DHCP client support implemented.

Note: Global library variable SPI_Ethernet_userTimerSec is used to keep track of

time for all client implementations (ARP, DNS, UDP and DHCP). It is user responsi-

bility to increment this variable each second in it's code if any of the clients is used.

Note: For advanced users there are header files ("eth_enc28j60LibDef.h" and

"eth_enc28j60LibPrivate.h") in Uses\P16 and Uses\P18 folders of the compiler

with description of all routines and global variables, relevant to the user, implement-

ed in the SPI Ethernet Library.

419

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Note: The appropriate hardware SPI module must be initialized before using any of

the SPI Ethernet library routines. Refer to SPI Library.

For MCUs with two SPI modules it is possible to initialize both of them and then

switch by using the SPI_Set_Active() routine.

External dependencies of SPI Ethernet Library

420 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all

projects using SPI Ether-

net Library:

Description: Example :

dim SPI_Ethernet_CS as

sbit sfr external

ENC28J60 chip select

pin.

dim SPI_Ethernet_CS

as sbit at RC1_bit

dim SPI_Ethernet_RST as

sbit sfr external ENC28J60 reset pin. dim SPI_Ethernet_RST

as sbit at RC0_bit

dim

SPI_Ethernet_CS_Directi

on as sbit sfr external

Direction of the

ENC28J60 chip select

pin.

dim

SPI_Ethernet_CS_Direc

tion as sbit at

TRISC1_bit

dim

SPI_Ethernet_RST_Direct

ion as sbit sfr exter-

nal

Direction of the

ENC28J60 reset pin.

dim

SPI_Ethernet_RST_Dire

ction as sbit at

TRISC0_bit

The following routines must

be defined in all project

using SPI Ethernet Library:

Description: Example :

sub function

SPI_Ethernet_UserTCP

(dim remoteHost as ^byte,

dim remotePort as word,

dim localPort as word,

dim reqLength as word) as

word

TCP request handler.

Refer to the

library example at

the bottom of this

page for code

implementation.

sub function

SPI_Ethernet_UserUDP(dim

remoteHost as ^byte,

dim remotePort as word,

dim destPort as word,

dim reqLength as word) as

word

UDP request handler.

Refer to the

library example at

the bottom of this

page for code

implementation.

Library Routines

 SPI_Ethernet_Init

 SPI_Ethernet_Enable

 SPI_Ethernet_Disable

 SPI_Ethernet_doPacket

 SPI_Ethernet_putByte

 SPI_Ethernet_putBytes

 SPI_Ethernet_putString

 SPI_Ethernet_putConstString

 SPI_Ethernet_putConstBytes

 SPI_Ethernet_getByte

 SPI_Ethernet_getBytes

 SPI_Ethernet_UserTCP

 SPI_Ethernet_UserUDP

SPI_Ethernet_Init

421

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure SPI_Ethernet_Init(dim mac as ^byte, dim ip as

^byte, dim fullDuplex as byte)

Returns Nothing.

Description

This is MAC module routine. It initializes ENC28J60 controller. This function is

internaly splited into 2 parts to help linker when coming short of memory.

ENC28J60 controller settings (parameters not mentioned here are set to default):

 receive buffer start address : 0x0000.

 receive buffer end address : 0x19AD.

 transmit buffer start address: 0x19AE.

 transmit buffer end address : 0x1FFF.

 RAM buffer read/write pointers in auto-increment mode.

 receive filters set to default: CRC + MAC Unicast + MAC Broadcast in OR

mode.

 flow control with TX and RX pause frames in full duplex mode.

 frames are padded to 60 bytes + CRC.

 maximum packet size is set to 1518.

 Back-to-Back Inter-Packet Gap: 0x15 in full duplex mode; 0x12 in half

duplex mode.

 Non-Back-to-Back Inter-Packet Gap: 0x0012 in full duplex mode; 0x0C12

in half duplex mode.

 Collision window is set to 63 in half duplex mode to accomodate some

ENC28J60 revisions silicon bugs.

 CLKOUT output is disabled to reduce EMI generation.

422 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Description

 half duplex loopback disabled.

 LED configuration: default (LEDA-link status, LEDB-link activity).

Parameters:

 mac: RAM buffer containing valid MAC address.

ip: RAM buffer containing valid IP address.

 fullDuplex: ethernet duplex mode switch. Valid values: 0(half duplex

mode) and 1(full duplex mode).

Requires

Global variables :

 SPI_Ethernet_CS: Chip Select line

 SPI_Ethernet_CS_Direction: Direction of the Chip Select pin

 SPI_Ethernet_RST: Reset line

 SPI_Ethernet_RST_Direction: Direction of the Reset pin

must be defined before using this function.

The SPI module needs to be initialized. See the SPI1_Init and

SPI1_Init_Advanced routines.

Example

'mE ehternet NIC pinout

dim SPI_Ethernet_RST as sbit at RC0_bit

dim SPI_Ethernet_CS as sbit at RC1_bit

dim SPI_Ethernet_RST_Direction as sbit at TRISC0_bit

dim SPI_Ethernet_CS_Direction as sbit at TRISC1_bit

' end mE ehternet NIC pinout

const SPI_Ethernet_HALFDUPLEX = 0

const SPI_Ethernet_FULLDUPLEX = 1

myMacAddr as byte[6] ' my MAC address

myIpAddr as byte[4] ' my IP addr

...

myMacAddr[0] = 0x00

myMacAddr[1] = 0x14

myMacAddr[2] = 0xA5

myMacAddr[3] = 0x76

myMacAddr[4] = 0x19

myMacAddr[5] = 0x3F

myIpAddr[0] = 192

myIpAddr[1] = 168

myIpAddr[2] = 20

myIpAddr[3] = 60

SPI1_Init()

SPI_Ethernet_Init(myMacAddr, myIpAddr, SPI_Ethernet_FULLDUPLEX)

423

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_Enable

Prototype sub procedure SPI_Ethernet_Enable(dim enFlt as byte)

Returns Nothing.

Description

This is MAC module routine. This routine enables appropriate network traffic on

the ENC28J60 module by the means of it's receive filters (unicast, multicast,

broadcast, crc). Specific type of network traffic will be enabled if a correspon-

ding bit of this routine's input parameter is set. Therefore, more than one type of

network traffic can be enabled at the same time. For this purpose, predefined

library constants (see the table below) can be ORed to form appropriate input

value.

Parameters:

 enFlt: network traffic/receive filter flags. Each bit corresponds to the

appropriate network traffic/receive filter:

Note: Advance filtering available in the ENC28J60 module such as Pattern

Match, Magic Packet and Hash Table can not be enabled by this routine. Addi-

tionaly, all filters, except CRC, enabled with this routine will work in OR mode,

which means that packet will be received if any of the enabled filters accepts it.

Bit Mask Description Predefined library const

0 0x01

MAC Broadcast traffic/receive filter

flag. When set, MAC broadcast traf-

fic will be enabled.

_SPI_Ethernet_BROAD-

CAST

1 0x02

MAC Multicast traffic/receive filter

flag. When set, MAC multicast traffic

will be enabled.

_SPI_Ethernet_MULTI-

CAST

2 0x04 not used none

3 0x08 not used none

4 0x10 not used none

5 0x20 CRC check flag. When set, packets

with invalid CRC field will be discarded. _SPI_Ethernet_CRC

6 0x40 not used none

7 0x80

MAC Unicast traffic/receive filter flag.

When set, MAC unicast traffic will be

enabled.

_SPI_Ethernet_UNICAST

424 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_Disable

Description

Note: This routine will change receive filter configuration on-the-fly. It will not, in

any way, mess with enabling/disabling receive/transmit logic or any other part of

the ENC28J60 module. The ENC28J60 module should be properly cofigured by

the means of SPI_Ethernet_Init routine.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example SPI_Ethernet_Enable(_SPI_Ethernet_CRC or _SPI_Ethernet_UNICAST)

' enable CRC checking and Unicast traffic

Prototype sub procedure SPI_Ethernet_Disable(dim disFlt as byte)

Returns Nothing.

Description

This is MAC module routine. This routine disables appropriate network traffic on the

ENC28J60 module by the means of it's receive filters (unicast, multicast, broadcast,

crc). Specific type of network traffic will be disabled if a corresponding bit of this rou-

tine's input parameter is set. Therefore, more than one type of network traffic can be

disabled at the same time. For this purpose, predefined library constants (see the

table below) can be ORed to form appropriate input value.

Parameters:

 disFlt: network traffic/receive filter flags. Each bit corresponds to the

appropriate network traffic/receive filter:

Bit Mask Description Predefined library

const

0 0x01 MAC Broadcast traffic/receive filter flag. When

set, MAC broadcast traffic will be disabled.

_SPI_Ethernet_BR

OADCAST

1 0x02 MAC Multicast traffic/receive filter flag. When

set, MAC multicast traffic will be disabled.

_SPI_Ethernet_MU

LTICAST

2 0x04 not used none

3 0x08 not used none

4 0x10 not used none

5 0x20

CRC check flag. When set, CRC check will

be disabled and packets with invalid CRC

field will be accepted.

_SPI_Ethernet_CR

6 0x40 not used none

7 0x80 MAC Unicast traffic/receive filter flag. When

set, MAC unicast traffic will be disabled.

_SPI_Ethernet_UN

ICAST

425

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_doPacket

Description

Note: Advance filtering available in the ENC28J60 module such as Pattern

Match, Magic Packet and Hash Table can not be disabled by this routine.

Note: This routine will change receive filter configuration on-the-fly. It will not, in

any way, mess with enabling/disabling receive/transmit logic or any other part of

the ENC28J60 module. The ENC28J60 module should be properly cofigured by

the means of SPI_Ethernet_Init routine.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example SPI_Ethernet_Disable(_SPI_Ethernet_CRC or _SPI_Ethernet_UNICAST)

' disable CRC checking and Unicast traffic

Prototype sub function SPI_Ethernet_doPacket() as byte

Returns

 0- upon successful packet processing (zero packets received or received

packet processed successfully).

 1- upon reception error or receive buffer corruption. ENC28J60 controller

needs to be restarted.

 2- received packet was not sent to us (not our IP, nor IP broadcast

address).

 3- received IP packet was not IPv4

 4- received packet was of type unknown to the library.

Description

This is MAC module routine. It processes next received packet if such exists.

Packets are processed in the following manner:

 ARP & ICMP requests are replied automatically.

 upon TCP request the SPI_Ethernet_UserTCP function is called for further

processing.

 upon UDP request the SPI_Ethernet_UserUDP function is called for fur-

ther processing.

Note: SPI_Ethernet_doPacket must be called as often as possible in user's

code.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

while TRUE

...

SPI_Ethernet_doPacket() ' process received packets

...

wend

426 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_putByte

SPI_Ethernet_putBytes

Prototype sub procedure SPI_Ethernet_putByte(dim vas byte)

Returns Nothing.

Description

This is MAC module routine. It stores one byte to address pointed by the cur-

rent ENC28J60 write pointer (EWRPT).

Parameters:

 v: value to store

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

dim data as byte

...

SPI_Ethernet_putByte(data) ' put an byte into ENC28J60 buffer

Prototype sub procedure SPI_Ethernet_putBytes(dim ptr as ^byte, dim nas

byte)

Returns Nothing.

Description

This is MAC module routine. It stores requested number of bytes into

ENC28J60 RAM starting from current ENC28J60 write pointer (EWRPT) loca-

tion.

Parameters:

 ptr: RAM buffer containing bytes to be written into ENC28J60 RAM.

 n: number of bytes to be written.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

dim

buffer as byte[17]

...

buffer = "mikroElektronika"

...

SPI_Ethernet_putBytes(buffer, 16) ' put an RAM array into

ENC28J60 buffer

427

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_putConstBytes

SPI_Ethernet_putString

Prototype sub procedure SPI_Ethernet_putConstBytes(const ptr as ^byte, dim n

as byte)

Returns Nothing.

Description

This is MAC module routine. It stores requested number of const bytes into

ENC28J60 RAM starting from current ENC28J60 write pointer (EWRPT) location.

Parameters:

 ptr: const buffer containing bytes to be written into ENC28J60 RAM.

 n: number of bytes to be written.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

const

buffer as byte[17]

...

buffer = "mikroElektronika"

...

SPI_Ethernet_putConstBytes(buffer, 16) ' put a const array into

ENC28J60 buffer

Prototype sub function SPI_Ethernet_putString(dim ptr as ^byte)as word

Returns Number of bytes written into ENC28J60 RAM.

Description

This is MAC module routine. It stores whole string (excluding null termination) into

ENC28J60 RAM starting from current ENC28J60 write pointer (EWRPT) location.

Parameters:

 ptr: string to be written into ENC28J60 RAM.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

dim

buffer as string[16]

...

buffer = "mikroElektronika"

...

SPI_Ethernet_putString(buffer) ' put a RAM string into ENC28J60

buffer

428 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_putConstString

SPI_Ethernet_getByte

Prototype sub function SPI_Ethernet_putConstString(const ptr as ^byte) as

word

Returns Number of bytes written into ENC28J60 RAM.

Description

This is MAC module routine. It stores whole const string (excluding null termination)

into ENC28J60 RAM starting from current ENC28J60 write pointer (EWRPT) location.

Parameters:

 ptr: const string to be written into ENC28J60 RAM.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

const

buffer as string[16]

...

buffer = "mikroElektronika"

...

SPI_Ethernet_putConstString(buffer) ' put a const string into

ENC28J60 buffer

Prototype sub function SPI_Ethernet_getByte() as byte

Returns Byte read from ENC28J60 RAM.

Description This is MAC module routine. It fetches a byte from address pointed to by cur-

rent ENC28J60 read pointer (ERDPT).

Requires Ethernet module has to be initialized. See Spi_Ethernet_Init.

Example

dim buffer as byte<>

...

buffer = SPI_Ethernet_getByte() ' read a byte from ENC28J60

buffer

429

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_getBytes

Prototype sub procedure SPI_Ethernet_getBytes(dim ptr as ^byte, dim addr as

word, dim n as byte)

Returns Nothing.

Description

This is MAC module routine. It fetches equested number of bytes from

ENC28J60 RAM starting from given address. If value of 0xFFFF is passed as the

address parameter, the reading will start from current ENC28J60 read pointer

(ERDPT) location.

Parameters:

ptr: buffer for storing bytes read from ENC28J60 RAM.

 addr: ENC28J60 RAM start address. Valid values: 0..8192.

 n: number of bytes to be read.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example

dim

buffer as byte[16]

...

SPI_Ethernet_getBytes(buffer, 0x100, 16) ' read 16 bytes,

starting from address 0x100

430 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_UserTCP

Prototype

sub function SPI_Ethernet_UserTCP(dim remoteHost as ^byte, dim

remotePort as word, dim localPort as word, dim reqLength as word)

as word

Returns 0- there should not be a reply to the request.

Length of TCP/HTTP reply data field - otherwise.

Description

This is TCP module routine. It is internally called by the library. The user access-

es to the TCP/HTTP request by using some of the SPI_Ethernet_get routines.

The user puts data in the transmit buffer by using some of the SPI_Ethernet_put

routines. The function must return the length in bytes of the TCP/HTTP reply, or

0 if there is nothing to transmit. If there is no need to reply to the TCP/HTTP

requests, just define this function with return(0) as a single statement.

Parameters:

remoteHost : client's IP address.

remotePort : client's TCP port.

localPort : port to which the request is sent.

reqLength : TCP/HTTP request data field length.

Note: The function source code is provided with appropriate example projects.

The code should be adjusted by the user to achieve desired reply.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example This function is internally called by the library and should not be called by the

user's code.

431

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Ethernet_UserUDP

Library Example

This code shows how to use the PIC mini Ethernet library :

 the board will reply to ARP & ICMP echo requests

 the board will reply to UDP requests on any port : returns the request in upper char with

a header made of remote host IP & port number

 the board will reply to HTTP requests on port 80, GET method with path names

/ will return the HTML main page

/s will return board status as text string

/t0 ... /t7 will toggle P3.b0 to P3.b7 bit and return HTML main page

all other requests return also HTML main page.

Main program code:

Prototype

sub function SPI_Ethernet_UserUDP(dim remoteHost as ^byte, dim

remotePort as word, dim destPort as word, dim reqLength as word)

as word

Returns  0- there should not be a reply to the request.

 Length of UDP reply data field - otherwise.

Description

This is UDP module routine. It is internally called by the library. The user

accesses to the UDP request by using some of the SPI_Ethernet_get routines.

The user puts data in the transmit buffer by using some of the

SPI_Ethernet_put routines. The function must return the length in bytes of the

UDP reply, or 0 if nothing to transmit. If you don't need to reply to the UDP

requests, just define this function with a return(0) as single statement.

Parameters:

 remoteHost : client's IP address.

 remotePort : client's port.

 destPort : port to which the request is sent.

reqLength : UDP request data field length.

Note: The function source code is provided with appropriate example projects.

The code should be adjusted by the user to achieve desired reply.

Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.

Example This function is internally called by the library and should not be called by the

user's code.

program enc_ethernet

' ***********************************

' * RAM variables

' *

dim myMacAddr as byte[6] ' my MAC address

myIpAddr as byte[4] ' my IP address

' mE ehternet NIC pinout

SPI_Ethernet_Rst as sbit at RC0_bit

SPI_Ethernet_CS as sbit at RC1_bit

SPI_Ethernet_Rst_Direction as sbit at TRISC0_bit

SPI_Ethernet_CS_Direction as sbit at TRISC1_bit

' end ethernet NIC definitions

' ************************************************************

' * ROM constant strings

' *

const httpHeader as string[31] = "HTTP/1.1 200 OK"+chr(10)+"Content-

type: " ' HTTP header

const httpMimeTypeHTML as string[13] = "text/html"+chr(10)+chr(10)

' HTML MIME type

const httpMimeTypeScript as string[14] = "text/plain"+chr(10)+chr(10)

' TEXT MIME type

const httpMethod as string[5] = "GET /"

' *

' * web page, splited into 2 parts :

' * when coming short of ROM, fragmented data is handled more effi-

ciently by linker

' *

' * this HTML page calls the boards to get its status, and builds

itself with javascript

' *

const indexPage as string[763] =

"<meta http-equiv=" + Chr(34) + "refresh" + Chr(34)

+ " content=" + Chr(34) + "3;url=http://192.168.20.60" + Chr(34)

+ ">" +

"<HTML><HEAD></HEAD><BODY>"+

"<h1>PIC + ENC28J60 Mini Web Server</h1>"+

"<a href=/>Reload</a>"+

"<script src=/s></script>"+

"<table><tr><td valign=top><table border=1

style="+chr(34)+"font-size:20px ;font-family: terminal

;"+chr(34)+"> "+

"<tr><th colspan=2>ADC</th></tr>"+

"<script>"+

"var str,i;"+

"str="+chr(34)+chr(34)+"; "+

432 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

"for(i=0;i<8;i++)"+

"{str+="+chr(34)+"<tr><td bgcolor=pink>BUTTON#"+chr(34)

+"+i+"+chr(34)+"</td>"+chr(34)+"; "+

"if(PORTB&(1<<i)){str+="+chr(34)+"<td bgcolor=red>ON"+

chr(34)+";}"

"else {str+="+chr(34)+"<td bgcolor=#cccccc>OFF"+chr(34)

+";}"+

"str+="+chr(34)+"</td></tr>"+chr(34)+";}"+

"document.write(str) ;"+

"</script>"

const indexPage2 as string[470] =

"</table></td><td>"+

"<table border=1 style="+chr(34)+"font-size:20px ;font-

family: terminal ;"+chr(34)+"> "+

"<tr><th colspan=3>PORTD</th></tr>"+

"<script>"+

"var str,i;"+

"str="+chr(34)+chr(34)+"; "+

"for(i=0;i<8;i++)"+

"{str+="+chr(34)+"<tr><td bgcolor=yellow>LED

#"+chr(34)+"+i+"+chr(34)+"</td>"+chr(34)+"; "+

"if(PORTD&(1<<i)){str+="+chr(34)+"<td bgcolor=

red>ON"+chr(34)+";}"+

"else {str+="+chr(34)+"<td bgcolor=#cccccc> OFF"+

chr(34)+";}"+

"str+="+chr(34)+"</td><td><a href=/t"+chr(34)+"+i+

"+chr(34)+">Toggle</a></td></tr>"+chr(34)+";}"+

"document.write(str) ;"+

"</script>"+

"</table></td></tr></table>"+

"This is HTTP request #<script>document.write(REQ)

</script></BODY></HTML>"

dim getRequest as byte[15] ' HTTP request buffer

dyna as byte[30] ' buffer for dynamic response

httpCounter as word ' counter of HTTP requests

tmp as string[11]

' *******************************************

' * user defined sub functions

' *

'* this sub function is called by the library

' * the user accesses to the HTTP request by successive calls to

SPI_Ethernet_getByte()

' * the user puts data in the transmit buffer by successive calls to

SPI_Ethernet_putByte()

433

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

' * the sub function must return the length in bytes of the HTTP

reply, or 0 if nothing to transmit

' *

' * if you don"t need to reply to HTTP requests,

' * just define this sub function with a return(0) as single state-

ment

' *

sub function Spi_Ethernet_UserTCP(dim byref remoteHost as byte[4],

dim remotePort, localPort, reqLength

as word) as word

dim

i as word ' general purpose integer

bitMask as byte ' for bit mask

result = 0

if(localPort <> 80) then ' I listen only to web request on port 80

result = 0

exit

end if

' get 10 first bytes only of the request, the rest does not mat-

ter here

for i = 0 to 10

getRequest[i] = Spi_Ethernet_getByte()

next i

getRequest[i] = 0

' copy httpMethod to ram for use in memcmp routine

for i = 0 to 4

tmp[i] = httpMethod[i]

next i

if(memcmp(@getRequest, @tmp, 5) <> 0) then ' only GET method is

supported here

result = 0

exit

end if

Inc(httpCounter) ' one more request done

if(getRequest[5] = "s") then ' if request path name starts

with s, store dynamic data in transmit buffer

' the text string replied by this request can be interpreted

as javascript statements

' by browsers

434 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

result = SPI_Ethernet_putConstString(@httpHeader)

' HTTP header

result=result + SPI_Ethernet_putConstString(@httpMimeType

Script) ' with text MIME type

' add AN2 value to reply

WordToStr(ADC_Read(2), dyna)

tmp = "var AN2="

result = result + SPI_Ethernet_putString(@tmp)

result = result + SPI_Ethernet_putString(@dyna)

tmp = ";"

result = result + SPI_Ethernet_putString(@tmp)

' add AN3 value to reply

WordToStr(ADC_Read(3), dyna)

tmp = "var AN3="

result = result + SPI_Ethernet_putString(@tmp)

result = result + SPI_Ethernet_putString(@dyna)

tmp = ";"

result = result + SPI_Ethernet_putString(@tmp)

' add PORTB value (buttons) to reply

tmp = "var PORTB= "

result = result + SPI_Ethernet_putString(@tmp)

WordToStr(PORTB, dyna)

result = result + SPI_Ethernet_putString(@dyna)

tmp = ";"

result = result + SPI_Ethernet_putString(@tmp)

' add PORTD value (LEDs) to reply

tmp = "var PORTD= "

result = result + SPI_Ethernet_putString(@tmp)

WordToStr(PORTD, dyna)

result = result + SPI_Ethernet_putString(@dyna)

tmp = ";"

result = result + SPI_Ethernet_putString(@tmp)

' add HTTP requests counter to reply

WordToStr(httpCounter, dyna)

tmp = "var REQ= "

result = result + SPI_Ethernet_putString(@tmp)

result = result + SPI_Ethernet_putString(@dyna)

tmp = ";"

result = result + SPI_Ethernet_putString(@tmp)

else

if(getRequest[5] = "t") then ' if request path name starts with

t, toggle PORTD (LED) bit number that comes after

bitMask = 0

if(isdigit(getRequest[6]) <> 0) then ' if 0 <= bit number <=

435

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

9, bits 8 & 9 does not exist but does not matter

bitMask = getRequest[6] - "0" ' convert ASCII to integer

bitMask = 1 << bitMask ' create bit mask

PORTD = PORTD xor bitMask ' toggle PORTD with xor

operator

end if

if(result = 0) then ' what do to by default

result = SPI_Ethernet_putConstString(@httpHeader) ' HTTP header

result = result + SPI_Ethernet_putConstString(@httpMimeTypeHTML)

' with HTML MIME type

result = result + SPI_Ethernet_putConstString(@indexPage)

' HTML page first part

result = result + SPI_Ethernet_putConstString(@indexPage2)

' HTML page second part

end if

' return to the library with the number of bytes to transmit

end sub

' *

' * this code shows how to use the Spi_Ethernet mini library :

' * the board will reply to ARP & ICMP echo requests

' * the board will reply to UDP requests on any port :

' * returns the request in upper char with a header

made of remote host IP & port number

' * the board will reply to HTTP requests on port 80, GET

method with pathnames :

' * / will return the HTML main page

' * /s will return board status as text

string

' * /t0 ... /t7 will toggle RD0 to RD7 bit

and return HTML main page

' * all other requests return also HTML main

page

' *

sub function Spi_Ethernet_UserUDP(dim byref remoteHost as byte[4],

dim remotePort, destPort, reqLength

as word) as word

result = 0

' reply is made of the remote host IP address in human readable

format

byteToStr(remoteHost[0], dyna) ' first IP address byte

dyna[3] = "."

byteToStr(remoteHost[1], tmp) ' second

dyna[4] = tmp[0]

dyna[5] = tmp[1]

dyna[6] = tmp[2]

dyna[7] = ". "

436 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

byteToStr(remoteHost[2], tmp) ' second

dyna[8] = tmp[0]

dyna[9] = tmp[1]

dyna[10] = tmp[2]

dyna[11] = "."

byteToStr(remoteHost[3], tmp) ' second

dyna[12] = tmp[0]

dyna[13] = tmp[1]

dyna[14] = tmp[2]

dyna[15] = ":" ' add separator

' then remote host port number

WordToStr(remotePort, tmp)

dyna[16] = tmp[0]

dyna[17] = tmp[1]

dyna[18] = tmp[2]

dyna[19] = tmp[3]

dyna[20] = tmp[4]

dyna[21] = "["

WordToStr(destPort, tmp)

dyna[22] = tmp[0]

dyna[23] = tmp[1]

dyna[24] = tmp[2]

dyna[25] = tmp[3]

dyna[26] = tmp[4]

dyna[27] = "]"

dyna[28] = 0

' the total length of the request is the length of the dynamic

string plus the text of the request

result = 28 + reqLength

' puts the dynamic string into the transmit buffer

SPI_Ethernet_putBytes(@dyna, 28)

' then puts the request string converted into upper char into the

transmit buffer

while(reqLength <> 0)

SPI_Ethernet_putByte(SPI_Ethernet_getByte())

reqLength = reqLength - 1

wend

' back to the library with the length of the UDP reply

end sub

main:

ANSEL = 0x0C ' AN2 and AN3 convertors will be used

PORTA = 0

TRISA = 0xff ' set PORTA as input for ADC

ANSELH = 0 ' Configure other AN pins as digital I/O

437

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

PORTB = 0

TRISB = 0xff ' set PORTB as input for buttons

PORTD = 0

TRISD = 0 ' set PORTD as output

httpCounter = 0

' set mac address

myMacAddr[0] = 0x00

myMacAddr[1] = 0x14

myMacAddr[2] = 0xA5

myMacAddr[3] = 0x76

myMacAddr[4] = 0x19

myMacAddr[5] = 0x3F

' set IP address

myIpAddr[0] = 192

myIpAddr[1] = 168

myIpAddr[2] = 20

myIpAddr[3] = 60

' *

' * starts ENC28J60 with :

' * reset bit on PORTC.B0

' * CS bit on PORTC.B1

' * my MAC & IP address

' * full duplex

' *

SPI1_Init() ' init spi module

SPI_Ethernet_Init(myMacAddr, myIpAddr, _SPI_Ethernet_FULLDUPLEX)

' init ethernet module

SPI_Ethernet_setUserHandlers(@SPI_Ethernet_UserTCP,

@SPI_Ethernet_UserUDP) ' set user handlers

while TRUE ' endless loop

SPI_Ethernet_doPacket() ' process incoming Ethernet packets

' *

' * add your stuff here if needed

' * SPI_Ethernet_doPacket() must be called as often as possible

' * otherwise packets could be lost

' *

wend

end.

438 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

439

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI GRAPHIC LCD LIBRARY

The mikroBasic PRO for PIC provides a library for operating Graphic Lcd 128x64

(with commonly used Samsung KS108/KS107 controller) via SPI interface.

For creating a custom set of Glcd images use Glcd Bitmap Editor Tool.

Note: The library uses the SPI module for communication. User must initialize SPI

module before using the SPI Graphic Lcd Library.

For MCUs with two SPI modules it is possible to initialize both of them and then

switch by using the SPI_Set_Active() routine.

Note: This Library is designed to work with the mikroElektronika's Serial Lcd/Glcd

Adapter Board pinout, see schematic at the bottom of this page for details.

External dependencies of SPI Graphic LCD Library

The implementation of SPI Graphic LCD Library routines is based on Port Expander

Library routines.

External dependencies are the same as Port Expander Library external dependencies.

Library Routines

Basic routines:

 SPI_Glcd_Init

 SPI_Glcd_Set_Side

 SPI_Glcd_Set_Page

 SPI_Glcd_Set_X

 SPI_Glcd_Read_Data

 SPI_Glcd_Write_Data

Advanced routines:

 SPI_Glcd_Fill

 SPI_Glcd_Dot

 SPI_Glcd_Line

 SPI_Glcd_V_Line

 SPI_Glcd_H_Line

 SPI_Glcd_Rectangle

 SPI_Glcd_Box

 SPI_Glcd_Circle

 SPI_Glcd_Set_Font

 SPI_Glcd_Write_Char

 SPI_Glcd_Write_Text

 SPI_Glcd_Image

440 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

441

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Init

Prototype sub procedure SPI_Glcd_Init(dim DeviceAddress as byte)

Returns Nothing.

Description

Initializes the Glcd module via SPI interface.

Parameters :

 DeviceAddress: SPI expander hardware address, see schematic at

the bottom of this page

Requires

Global variables :

 SPExpanderCS: Chip Select line

 SPExpanderRST: Reset line

 SPExpanderCS_Direction: Direction of the Chip Select pin

 SPExpanderRST_Direction: Direction of the Reset pin

must be defined before using this function.

SPI module needs to be initialized. See SPI1_Init and SPI1_Init_Advanced rou-

tines.

Example

' port expander pinout definition

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' end of port expander pinout definition

...

' If Port Expander Library uses SPI1 module :

SPI1_Init() ' Initialize SPI module used with PortExpander

SPI_Glcd_Init(0)

442 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Set_Side

SPI_Glcd_Set_Page

Prototype sub procedure SPI_Glcd_Set_Side(dim x_pos as byte)

Returns Nothing.

Description

Selects Glcd side. Refer to the Glcd datasheet for detail explanation.

Parameters :

 x_pos: position on x-axis. Valid values: 0..127

The parameter x_pos specifies the Glcd side: values from 0 to 63 specify the

left side, values from 64 to 127 specify the right side.

Note: For side, x axis and page layout explanation see schematic at the bottom

of this page.

Requires Glcd needs to be initialized for SPI communication, see Spi_Glcd_Init routines.

Example

The following two lines are equivalent, and both of them select the left side of Glcd:

SPI_Glcd_Set_Side(0);

SPI_Glcd_Set_Side(10);

Prototype procedure Spi_Glcd_Set_Page(page : byte);

Returns Nothing.

Description

Selects page of Glcd.

Parameters :

 page: page number. Valid values: 0..7

Note: For side, x axis and page layout explanation see schematic at the bottom

of this page.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example SPI_Glcd_Set_Page(5)

443

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Set_X

SPI_Glcd_Read_Data

Prototype sub procedure SPI_Glcd_Set_X(dim x_pos as byte)

Returns Nothing.

Description

Sets x-axis position to x_pos dots from the left border of Glcd within the select-

ed side.

Parameters :

 x_pos: position on x-axis. Valid values: 0..63

Note: For side, x axis and page layout explanation see schematic at the bottom

of this page.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example SPI_Glcd_Set_X(25)

Prototype sub function SPI_Glcd_Read_Data() as byte

Returns One byte from Glcd memory.

Description Reads data from the current location of Glcd memory and moves to the next

location.

Requires

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Glcd side, x-axis position and page should be set first. See the functions

SPI_Glcd_Set_Side, SPI_Glcd_Set_X, and SPI_Glcd_Set_Page.

Example

dim data as byte

...

data = SPI_Glcd_Read_Data()

444 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Write_Data

SPI_Glcd_Fill

Prototype sub procedure SPI_Glcd_Write_Data(dim Ddata as byte)

Returns Nothing.

Description

Writes one byte to the current location in Glcd memory and moves to the next

location.

Parameters :

 Ddata: data to be written

Requires

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Glcd side, x-axis position and page should be set first. See the functions

SPI_Glcd_Set_Side, SPI_Glcd_Set_X, and SPI_Glcd_Set_Page.

Example

dim ddata as byte

...

SPI_Glcd_Write_Data(ddata)

Prototype sub procedure SPI_Glcd_Fill(dim pattern as byte)

Returns Nothing.

Description

Fills Glcd memory with byte pattern.

Parameters :

 pattern: byte to fill Glcd memory with

To clear the Glcd screen, use SPI_Glcd_Fill(0).

To fill the screen completely, use SPI_Glcd_Fill(0xFF).

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ' Clear screen

SPI_Glcd_Fill(0)

445

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Dot

SPI_Glcd_Line

Prototype sub procedure SPI_Glcd_Dot(dim x_pos as byte, dim y_pos as byte,

dim color as byte)

Returns Nothing.

Description

Draws a dot on Glcd at coordinates (x_pos, y_pos).

Parameters :

 x_pos: x position. Valid values: 0..127

 y_pos: y position. Valid values: 0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the dot state: 0 clears dot, 1 puts a dot, and 2

inverts dot state.

Note: For x and y axis layout explanation see schematic at the bottom of this page.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ‘Invert the dot in the upper left corner

SPI_Glcd_Dot(0, 0, 2)

Prototype

sub procedure SPI_Glcd_Line(dim x_start as integer, dim y_start

as integer, dim x_end as integer, dim y_end as integer, dim color

as byte)

Returns Nothing.

Description

Draws a line on Glcd.

Parameters :

 x_start: x coordinate of the line start. Valid values: 0..127

 y_start: y coordinate of the line start. Valid values: 0..63

 x_end: x coordinate of the line end. Valid values: 0..127

 y_end: y coordinate of the line end. Valid values: 0..63

 color: color parameter. Valid values: 0..2

Parameter color determines the line color: 0 white, 1 black, and 2 inverts each dot.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ' Draw a line between dots (0,0) and (20,30)

SPI_Glcd_Line(0, 0, 20, 30, 1)

446 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_V_Line

SPI_Glcd_H_Line

Prototype sub procedure SPI_Glcd_V_Line(dim y_start as byte,dim y_end as

byte, dim x_pos as byte, dim color as byte)

Returns Nothing.

Description

Draws a vertical line on Glcd.

Parameters :

 y_start: y coordinate of the line start. Valid values: 0..63

 y_end: y coordinate of the line end. Valid values: 0..63

 x_pos: x coordinate of vertical line. Valid values: 0..127

 color: color parameter. Valid values: 0..2

Parameter color determines the line color: 0 white, 1 black, and 2 inverts each

dot.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ' Draw a vertical line between dots (10,5) and (10,25)

SPI_Glcd_V_Line(5, 25, 10, 1)

Prototype sub procedure SPI_Glcd_V_Line(dim x_start as byte, dim x_end as

byte, dim y_pos as byte, dim color as byte)

Returns Nothing.

Description

Draws a horizontal line on Glcd.

Parameters :

 x_start: x coordinate of the line start. Valid values: 0..127

 x_end: x coordinate of the line end. Valid values: 0..127

 y_pos: y coordinate of horizontal line. Valid values: 0..63

color: color parameter. Valid values: 0..2

The parameter color determines the line color: 0 white, 1 black, and 2 inverts

each dot.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ‘Draw a horizontal line between dots (10,20) and (50,20)

SPI_Glcd_H_Line(10, 50, 20, 1)

447

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Rectangle

Prototype

sub procedure SPI_Glcd_Rectangle(dim x_upper_left as byte, dim

y_upper_left as byte, dim x_bottom_right as byte, dim y_bottom_right

as byte, dim color as byte)

Returns Nothing.

Description

Draws a rectangle on Glcd.

Parameters :

 x_upper_left: x coordinate of the upper left rectangle corner. Valid values:

0..127

 y_upper_left: y coordinate of the upper left rectangle corner. Valid values:

0..63

 x_bottom_right: x coordinate of the lower right rectangle corner. Valid val

ues: 0..127

 y_bottom_right: y coordinate of the lower right rectangle corner. Valid values:

0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the rectangle border: 0 white, 1 black,

and 2 inverts each dot.

Requires Glcd needs to be initialized for SPI communication, see S_Glcd_Init routines.

Example ' Draw a rectangle between dots (5,5) and (40,40)

SPI_Glcd_Rectangle(5, 5, 40, 40, 1)

448 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Box

SPI_Glcd_Circle

Prototype sub procedure SPI_Glcd_Circle(dim x_center as integer, dim y_cen-

ter as integer, dim radius as integer, dim color as byte)

Returns Nothing.

Description

Draws a circle on Glcd.

Parameters :

 x_center: x coordinate of the circle center. Valid values: 0..127

 y_center: y coordinate of the circle center. Valid values: 0..63

 radius: radius size

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the circle line: 0 white, 1 black,

and 2 inverts each dot.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

Example ' Draw a circle with center in (50,50) and radius=10

SPI_Glcd_Circle(50, 50, 10, 1)

Prototype

sub procedure SPI_Glcd_Box(dim x_upper_left as byte, dim

y_upper_left as byte, dim x_bottom_right as byte, dim

y_bottom_right as byte, dim color as byte)

Returns Nothing.

Description

Draws a box on Glcd.

Parameters :

 x_upper_left: x coordinate of the upper left box corner. Valid values:

0..127

 y_upper_left: y coordinate of the upper left box corner. Valid values:

0..63

 x_bottom_right: x coordinate of the lower right box corner. Valid values:

0..127

 y_bottom_right: y coordinate of the lower right box corner. Valid values:

0..63

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the box fill: 0 white, 1 black, and

2 inverts each dot.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ' Draw a box between dots (5,15) and (20,40)

SPI_Glcd_Box(5, 15, 20, 40, 1)

449

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Set_Font

Prototype

sub procedure SPI_Glcd_Set_Font(dim activeFont as longint, dim

aFontWidth as byte, dim aFontHeight as byte, dim aFontOffs as

word)

Returns Nothing.

Description

Sets font that will be used with SPI_Glcd_Write_Char and SPI_Glcd_Write_Text

routines.

Parameters :

 activeFont: font to be set. Needs to be formatted as an array of char

 aFontWidth: width of the font characters in dots.

 aFontHeight: height of the font characters in dots.

 aFontOffs: number that represents difference between the mikroBasic

PRO for PIC character set and regular ASCII set (eg. if 'A' is 65 in ASCII

character, and 'A' is 45 in the mikroBasic PRO for PIC character set,

aFontOffs is 20). Demo fonts supplied with the library have an offset of

32, which means that they start with space.

The user can use fonts given in the file “__Lib_Glcd_fonts.mbas” file located in

the Uses folder or create his own fonts.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ' Use the custom 5x7 font "myfont" which starts with space (32):

SPI_Glcd_Set_Font(@myfont, 5, 7, 32)

450 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Write_Char

Prototype sub procedure SPI_Glcd_Write_Char(dim chr1 as byte, dim x_pos as

byte, dim page_num as byte, dim color as byte)

Returns Nothing.

Description

Prints character on Glcd.

Parameters :

 chr1: character to be written

 x_pos: character starting position on x-axis. Valid values: 0..(127-Fon-

tWidth)

 page_num: the number of the page on which character will be written. Valid

values: 0..7

color: color parameter. Valid values: 0..2

The parameter color determines the color of the character: 0 white, 1 black, and

2 inverts each dot.

Note: For x axis and page layout explanation see schematic at the bottom of

this page.

Requires

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Use the SPI_Glcd_Set_Font to specify the font for display; if no font is specified, then

the default 5x8 font supplied with the library will be used.

Example ' Write character 'C' on the position 10 inside the page 2:

SPI_Glcd_Write_Char("C", 10, 2, 1)

451

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Glcd_Write_Text

Prototype sub procedure SPI_Glcd_Write_Text(dim byref text as string[40],

dim x_pos as byte, dim page_numb as byte, dim color as byte)

Returns Nothing.

Description

Prints text on Glcd.

Parameters :

 text: text to be written

 x_pos: text starting position on x-axis.

 page_num: the number of the page on which text will be written. Valid values:

0..7

 color: color parameter. Valid values: 0..2

The parameter color determines the color of the text: 0 white, 1 black, and 2

inverts each dot.

Note: For x axis and page layout explanation see schematic at the bottom of

this page.

Requires

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Use the SPI_Glcd_Set_Font to specify the font for display; if no font is speci-

fied, then the default 5x8 font supplied with the library will be used.

Example ' Write text "Hello world!" on the position 10 inside the page 2:

SPI_Glcd_Write_Text("Hello world!", 10, 2, 1)

SPI_Glcd_Image

Library Example

The example demonstrates how to communicate to KS0108 Glcd via the SPI module, using seri-

al to parallel convertor MCP23S17.

program SPI_Glcd

include bitmap

' Port Expander module connections

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' End Port Expander module connections

dim someText as char[20]

counter as byte

sub procedure Delay2S

delay_ms(2000)

end sub

main:

SPI1_Init_Advanced(_SPI_MASTER_OSC_DIV4,_SPI_DATA_SAMPLE_MIDDLE,

_SPI_CLK_IDLE_LOW, _SPI_LOW_2_HIGH) ' Initialize SPI module

452 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure SPI_Glcd_Image(dim const image as ^byte)

Returns Nothing.

Description

Displays bitmap on Glcd.

Parameters :

 image: image to be displayed. Bitmap array can be located in both code

and RAM memory (due to the mikroBasic PRO for PIC pointer to const

and pointer to RAM equivalency).

Use the mikroBasic PRO’s integrated Glcd Bitmap Editor (menu option Tools ›

Glcd Bitmap Editor) to convert image to a constant array suitable for display-

ing on Glcd.

Requires Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

Example ' Draw image my_image on Glcd

SPI_Glcd_Image(my_image)

used with PortExpander

SPI_Glcd_Init(0) ' Initialize Glcd via SPI

SPI_Glcd_Fill(0x00) ' Clear Glcd

while TRUE

SPI_Glcd_Image(@truck_bmp) ' Draw image

Delay2s() Delay2s()

SPI_Glcd_Fill(0x00) ' Clear Glcd

Delay2s

SPI_Glcd_Box(62,40,124,56,1) ' Draw box

SPI_Glcd_Rectangle(5,5,84,35,1) ' Draw rectangle

SPI_Glcd_Line(0, 63, 127, 0,1) ' Draw line

Delay2s()

counter = 5

while (counter < 60) ' Draw horizontal and vertical line

Delay_ms(250)

SPI_Glcd_V_Line(2, 54, counter, 1)

SPI_Glcd_H_Line(2, 120, counter, 1)

counter = counter + 5

wend

Delay2s()

SPI_Glcd_Fill(0x00) ' Clear Glcd

SPI_Glcd_Set_Font(@Character8x7, 8, 8, 32) ' Choose font

SPI_Glcd_Write_Text("mikroE", 5, 7, 2) ' Write string

for counter = 1 to 10 ' Draw circles

SPI_Glcd_Circle(63,32, 3*counter, 1)

next counter

Delay2s()

SPI_Glcd_Box(12,20, 70,63, 2) ' Draw box

Delay2s()

SPI_Glcd_Fill(0xFF) ' Fill Glcd

SPI_Glcd_Set_Font(@Character8x7, 8, 7, 32) ' Change font

someText = "8x7 Font"

SPI_Glcd_Write_Text(someText, 5, 1, 2) ' Write string

Delay2s()

SPI_Glcd_Set_Font(@System3x6, 3, 5, 32) ' Change font

someText = "3X5 CAPITALS ONLY"

SPI_Glcd_Write_Text(someText, 5, 3, 2) ' Write string

Delay2s()

SPI_Glcd_Set_Font(@font5x7, 5, 7, 32) ' Change font

someText = "5x7 Font"

SPI_Glcd_Write_Text(someText, 5, 5, 2) ' Write string

Delay2s()

wend

end.

453

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

HW Connection

SPI GLCD HW connection

454 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI LCD LIBRARY

The mikroBasic PRO for PIC provides a library for communication with Lcd (with

HD44780 compliant controllers) in 4-bit mode via SPI interface.

For creating a custom set of Lcd characters use Lcd Custom Character Tool.

Note: The library uses the SPI module for communication. The user must initialize

the SPI module before using the SPI Lcd Library.

For MCUs with two SPI modules it is possible to initialize both of them and then

switch by using the SPI_Set_Active() routine.

Note: This Library is designed to work with the mikroElektronika's Serial Lcd

Adapter Board pinout. See schematic at the bottom of this page for details.

External dependencies of SPI LCD Library

The implementation of SPI LCD Library routines is based on Port Expander Library

routines.

External dependencies are the same as Port Expander Library external dependen-

cies.

Library Routines

 Spi_Lcd_Config

 Spi_Lcd_Out

 Spi_Lcd_Out_Cp

 Spi_Lcd_Chr

 Spi_Lcd_Chr_Cp

 Spi_Lcd_Cmd

455

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

456 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Lcd_Config

SPI_Lcd_Out

Prototype sub procedure SPI_Lcd_Config(dim DeviceAddress as byte)

Returns Nothing.

Description

Initializes the Lcd module via SPI interface.

Parameters :

 DeviceAddress: SPI expander hardware address, see schematic at the

bottom of this page

Requires

Global variables :

 SPExpanderCS: Chip Select line

 SPExpanderRST: Reset line

 SPExpanderCS_Direction: Direction of the Chip Select pin

 SPExpanderRST_Direction: Direction of the Reset pin

Example

' port expander pinout definition

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' end of port expander pinout definition

...

' If Port Expander Library uses SPI1 module

SPI1_Init() ' Initialize SPI module used with POrtExpander

SPI_Lcd_Config(0) ' initialize lcd over spi interface

Prototype sub procedure SPI_Lcd_Out(dim row as byte, dim column as byte,

dim byref text as string[20])

Returns Nothing.

Description

Prints text on the Lcd starting from specified position. Both string variables and

literals can be passed as a text.

Parameters:

row: starting position row number

 column: starting position column number

 text: text to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd_Config routines.

Example ' Write text "Hello!" on Lcd starting from row 1, column 3:

SPI_Lcd_Out(1, 3, "Hello!")

457

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Lcd_Out_Cp

SPI_Lcd_Chr

Prototype sub procedure SPI_Lcd_Out_CP(dim text as string[19])

Returns Nothing.

Description

Prints text on the Lcd at current cursor position. Both string variables and liter-

als can be passed as a text.

Parameters :

 text: text to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd_Config routines.

Example ‘Write text "Here!" at current cursor position:

SPI_Lcd_Out_CP("Here!")

Prototype sub procedure SPI_Lcd_Chr(dim Row as byte, dim Column as byte, dim

Out_Char as byte)

Returns Nothing.

Description

Prints character on Lcd at specified position. Both variables and literals can be

passed as character.

Parameters :

 Row: writing position row number

 Column: writing position column number

 Out_Char: character to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd_Config routines.

Example ' Write character "i" at row 2, column 3:

SPI_Lcd_Chr(2, 3, 'i')

458 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Lcd_Chr_Cp

SPI_Lcd_Cmd

Prototype sub procedure SPI_Lcd_Chr_CP(dim Out_Char as byte)

Returns Nothing.

Description

Prints character on Lcd at current cursor position. Both variables and literals

can be passed as character.

Parameters :

 Out_Char: character to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd_Config routines.

Example ' Write character "e" at current cursor position:

SPI_Lcd_Chr_Cp('e')

Prototype sub procedure SPI_Lcd_Cmd(dim out_char as byte)

Returns Nothing.

Description

Sends command to Lcd.

Parameters :

 out_char: command to be sent

Note: Predefined constants can be passed to the function, see Available SPI

Lcd Commands.

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd_Config routines.

Example ' Clear Lcd display:

SPI_Lcd_Cmd(_LCD_CLEAR)

Available LCD Commands

459

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Lcd Command Purpose

_LCD_FIRST_ROW Move cursor to the 1st row

_LCD_SECOND_ROW Move cursor to the 2nd row

_LCD_THIRD_ROW Move cursor to the 3rd row

_LCD_FOURTH_ROW Move cursor to the 4th row

_LCD_CLEAR Clear display

_LCD_RETURN_HOME Return cursor to home position, returns a shifted display

to its original position. Display data RAM is unaffected.

_LCD_CURSOR_OFF Turn off cursor

_LCD_UNDERLINE_ON Underline cursor on

_LCD_BLINK_CURSOR_ON Blink cursor on

_LCD_MOVE_CURSOR_LEFT Move cursor left without changing display data RAM

_LCD_MOVE_CURSOR_RIGHT Move cursor right without changing display data RAM

_LCD_TURN_ON Turn Lcd display on

_LCD_TURN_OFF Turn Lcd display off

_LCD_SHIFT_LEFT Shift display left without changing display data RAM

_LCD_SHIFT_RIGHT Shift display right without changing display data RAM

Library Example

This example demonstrates how to communicate Lcd via the SPI module, using

serial to parallel convertor MCP23S17.

program SPI_Lcd

dim text as char[17]

' Port Expander module connections

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' End Port Expander module connections

main:

text = "mikroElektronika"

SPI1_Init() ' Initialize SPI module used with

PortExpander

SPI_Lcd_Config(0) ' Initialize Lcd over SPI inter-

face

SPI_Lcd_Cmd(_LCD_CLEAR) ' Clear display

SPI_Lcd_Cmd(_LCD_CURSOR_OFF) ' Turn cursor off

SPI_Lcd_Out(1,6, "mikroE") ' Print text to Lcd, 1st row,

6th column

SPI_Lcd_Chr_CP("!") ' Append "!"

SPI_Lcd_Out(2,1, text) ' Print text to Lcd, 2nd row, 1st

column

end.

460 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

SPI LCD HW connection

461

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI LCD8 (8-BIT INTERFACE) LIBRARY

The mikroBasic PRO for PIC provides a library for communication with Lcd (with

HD44780 compliant controllers) in 8-bit mode via SPI interface.

For creating a custom set of Lcd characters use Lcd Custom Character Tool.

Note: Library uses the SPI module for communication. The user must initialize the

SPI module before using the SPI Lcd Library.

For MCUs with two SPI modules it is possible to initialize both of them and then

switch by using the SPI_Set_Active() routine.

Note: This Library is designed to work with mikroElektronika's Serial Lcd/GLcd

Adapter Board pinout, see schematic at the bottom of this page for details.

External dependencies of SPI LCD Library

The implementation of SPI Lcd Library routines is based on Port Expander Library

routines.

External dependencies are the same as Port Expander Library external dependen-

cies.

Library Routines

 SPI_Lcd8_Config

 SPI_Lcd8_Out

 SPI_Lcd8_Out_Cp

 SPI_Lcd8_Chr

 SPI_Lcd8_Chr_Cp

 SPI_Lcd8_Cmd

462 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

463

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Lcd8_Config

SPI_Lcd8_Out

Prototype sub procedure SPI_Lcd8_Config(dim DeviceAddress as byte)

Returns Nothing.

Description

Initializes the Lcd module via SPI interface.

Parameters :

 DeviceAddress: spi expander hardware address, see schematic at the bot

tom of this page

Requires

Global variables :

 SPExpanderCS: Chip Select line

 SPExpanderRST: Reset line

 SPExpanderCS_Direction: Direction of the Chip Select pin

 SPExpanderRST_Direction: Direction of the Reset pin

must be defined before using this function.

SPI module needs to be initialized. See SPI1_Init and SPI1_Init_Advanced rou-

tines.

Example

' port expander pinout definition

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' end of port expander pinout definition

...

SPI1_Init() ' Initialize SPI interface

SPI_Lcd8_Config(0) ' Intialize Lcd in 8bit mode via spi

Prototype sub procedure SPI_Lcd8_Out(dim row as byte, dim column as byte,

dim byref text as string[19])

Returns Nothing.

Description

Prints text on Lcd starting from specified position. Both string variables and liter-

als can be passed as a text.

Parameters :

 row: starting position row number

 column: starting position column number

 text: text to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd8_Config routines

Example ' Write text "Hello!" on Lcd starting from row 1, column 3:

SPI_Lcd8_Out(1, 3, "Hello!")

464 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_Lcd8_Out_Cp

SPI_Lcd8_Chr

Prototype sub procedure SPI_Lcd8_Out_CP(dim text as string[19])

Returns Nothing.

Description

Prints text on Lcd at current cursor position. Both string variables and literals

can be passed as a text.

Parameters :

 text: text to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd8_Config routines.

Example ' Write text "Here!" at current cursor position:

SPI_Lcd8_Out_CP("Here!")

Prototype sub procedure SPI_Lcd8_Chr(dim Row as byte, dim Column as byte, dim

Out_Char as byte)

Returns Nothing.

Description

Prints character on LCD at specified position. Both variables and literals can be

passed as character.

Parameters :

 row: writing position row number

 column: writing position column number

 out_char: character to be written

Requires LCD needs to be initialized for SPI communication, see SPI_Lcd8_Config routines.

Example ' Write character "i" at row 2, column 3:

SPI_Lcd8_Chr(2, 3, 'i')

465

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_Lcd8_Chr_Cp

SPI_Lcd8_Cmd

Prototype sub procedure SPI_Lcd8_Chr_CP(dim Out_Char as byte)

Returns Nothing.

Description

Prints character on Lcd at current cursor position. Both variables and literals

can be passed as character.

Parameters :

 out_char: character to be written

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd8_Config routines.

Example

Print “e” at current cursor position:

' Write character "e" at current cursor position:

SPI_Lcd8_Chr_Cp('e')

Prototype sub procedure SPI_Lcd8_Cmd(dim out_char as byte)

Returns Nothing.

Description

Sends command to Lcd.

Parameters :

 out_char: command to be sent

Note: Predefined constants can be passed to the function, see Available SPI

Lcd8 Commands.

Requires Lcd needs to be initialized for SPI communication, see SPI_Lcd8_Config routines.

Example ' Clear Lcd display:

SPI_Lcd8_Cmd(_LCD_CLEAR)

Available LCD Commands

466 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Lcd Command Purpose

_LCD_FIRST_ROW Move cursor to the 1st row

_LCD_SECOND_ROW Move cursor to the 2nd row

_LCD_THIRD_ROW Move cursor to the 3rd row

_LCD_FOURTH_ROW Move cursor to the 4th row

_LCD_CLEAR Clear display

_LCD_RETURN_HOME Return cursor to home position, returns a shifted display

to its original position. Display data RAM is unaffected.

_LCD_CURSOR_OFF Turn off cursor

_LCD_UNDERLINE_ON Underline cursor on

_LCD_BLINK_CURSOR_ON Blink cursor on

_LCD_MOVE_CURSOR_LEFT Move cursor left without changing display data RAM

_LCD_MOVE_CURSOR_RIGHT Move cursor right without changing display data RAM

_LCD_TURN_ON Turn Lcd display on

_LCD_TURN_OFF Turn Lcd display off

_LCD_SHIFT_LEFT Shift display left without changing display data RAM

_LCD_SHIFT_RIGHT Shift display right without changing display data RAM

Library Example

This example demonstrates how to communicate Lcd in 8-bit mode via the SPI mod-

ule, using serial to parallel convertor MCP23S17.

program Spi_Lcd8_Test

dim text as char[16]

' Port Expander module connections

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' End Port Expander module connections

main:

text = "mikroE"

SPI1_Init() ' Initialize SPI module used

with PortExpander

SPI_Lcd8_Config(0) ' Intialize Lcd in 8bit mode

via SPI

SPI_Lcd8_Cmd(_LCD_CLEAR) ' Clear display

SPI_Lcd8_Cmd(_LCD_CURSOR_OFF) ' Turn cursor off

SPI_Lcd8_Out(1,6, text) ' Print text to Lcd, 1st row,

6th column...

SPI_Lcd8_Chr_CP("!") ' Append "!"

SPI_Lcd8_Out(2,1, "mikroElektronika") ' Print text to Lcd, 2nd row,

1st column...

SPI_Lcd8_Out(3,1, text) ' For Lcd modules with more

than two rows

SPI_Lcd8_Out(4,15, text) ' For Lcd modules with more

than two rows

end.

467

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

HW Connection

SPI LCD8 HW connection

468 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI T6963C GRAPHIC LCD LIBRARY

The mikroBasic PRO for PIC provides a library for working with Glcds based on

TOSHIBA T6963C controller via SPI interface. The Toshiba T6963C is a very popu-

lar Lcd controller for the use in small graphics modules. It is capable of controlling

displays with a resolution up to 240x128. Because of its low power and small out-

line it is most suitable for mobile applications such as PDAs, MP3 players or mobile

measurement equipment. Although this controller is small, it has a capability of dis-

playing and merging text and graphics and it manages all interfacing signals to the

displays Row and Column drivers.

For creating a custom set of Glcd images use Glcd Bitmap Editor Tool.

Note: The library uses the SPI module for communication. The user must initialize

SPI module before using the SPI T6963C Glcd Library.

For MCUs with two SPI modules it is possible to initialize both of them and then

switch by using the SPI_Set_Active() routine.

Note: This Library is designed to work with mikroElektronika's Serial Glcd 240x128

and 240x64 Adapter Boards pinout, see schematic at the bottom of this page for

details.

Note: Some mikroElektronika's adapter boards have pinout different from T6369C

datasheets. Appropriate relations between these labels are given in the table below:

External dependencies of SPI T6963C Graphic Lcd Library

The implementation of SPI T6963C Graphic Lcd Library routines is based on Port

Expander Library routines.

External dependencies are the same as Port Expander Library external dependencies.

469

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Adapter Board T6369C datasheet

RS C/D

R/W /RD

E/WR

Library Routines

 SPI_T6963C_Config

 SPI_T6963C_WriteData

 SPI_T6963C_WriteCommand

 SPI_T6963C_SetPtr

 SPI_T6963C_WaitReady

 SPI_T6963C_Fill

 SPI_T6963C_Dot

 SPI_T6963C_Write_Char

 SPI_T6963C_Write_Text

 SPI_T6963C_Line

 SPI_T6963C_Rectangle

 SPI_T6963C_Box

 SPI_T6963C_Circle

 SPI_T6963C_Image

 SPI_T6963C_Sprite

 SPI_T6963C_Set_Cursor

 SPI_T6963C_ClearBit

 SPI_T6963C_SetBit

 SPI_T6963C_NegBit

 SPI_T6963C_DisplayGrPanel

 SPI_T6963C_DisplayTxtPanel

 SPI_T6963C_SetGrPanel

 SPI_T6963C_SetTxtPanel

 SPI_T6963C_PanelFill

 SPI_T6963C_GrFill

 SPI_T6963C_TxtFill

 SPI_T6963C_Cursor_Height

 SPI_T6963C_Graphics

 SPI_T6963C_Text

 SPI_T6963C_Cursor

 SPI_T6963C_Cursor_Blink

470 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

471

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Config

Prototype

sub procedure SPI_T6963C_Config(dim width as word, dim height as

word, dim fntW as word, dim DeviceAddress as byte, dim wr as

byte, dim rd as byte, dim cd as byte, dim rst as byte)

Returns Nothing.

Description

Initalizes the Graphic Lcd controller.

Parameters :

width: width of the GLCD panel

 height: height of the GLCD panel

 fntW: font width

 DeviceAddress: SPI expander hardware address, see schematic at the

bottom of this page

 wr: write signal pin on GLCD control port

 rd: read signal pin on GLCD control port

 cd: command/data signal pin on GLCD control port

 rst: reset signal pin on GLCD control port

Display RAM organization:

The library cuts RAM into panels : a complete panel is one graphics panel fol-

lowed by a text panel (see schematic below).

schematic:

+--------------------- + /\

+ GRAPHICS PANEL #0 + |

+ + |

+--------------------- + | PANEL 0

+ TEXT PANEL #0 + |

+ + \/

+--------------------- + /\

+ GRAPHICS PANEL #1 + |

+ + |

+--------------------- + | PANEL 1

+ TEXT PANEL #2 + |

+ + |

+--------------------- + \/

Requires

Global variables :

 SPExpanderCS: Chip Select line

 SPExpanderRST: Reset line

 SPExpanderCS_Direction: Direction of the Chip Select pin

472 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_WriteData

SPI_T6963C_WriteCommand

Requires

 SPExpanderRST_Direction: Direction of the Reset pin

must be defined before using this function.

SPI module needs to be initialized. See SPI1_Init and SPI1_Init_Advanced rou-

tines.

Example

' port expander pinout definition

dim SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' end of port expander pinout definition

...

' Initialize SPI module

SPI1_Init()

SPI_T6963C_Config(240, 64, 8, 0, 0, 1, 3, 4)

Prototype sub procedure SPI_T6963C_WriteData(dim Ddata as byte)

Returns Nothing.

Description

Writes data to T6963C controller via SPI interface.

Parameters :

 Ddata: data to be written

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_WriteData(AddrL)

Prototype sub procedure SPI_T6963C_WriteCommand(dim Ddata as byte)

Returns Nothing.

Description

Writes command to T6963C controller via SPI interface.

Parameters :

 Ddata: command to be written

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_WriteCommand(SPI_T6963C_CURSOR_POINTER_SET)

473

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_SetPtr

SPI_T6963C_WaitReady

SPI_T6963C_Fill

Prototype sub procedure SPI_T6963C_SetPtr(dim p as word, dim c as byte)

Returns Nothing.

Description

Sets the memory pointer p for command c.

Parameters :

 p: address where command should be written

 c: command to be written

Requires SToshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_SetPtr(T6963C_grHomeAddr + start,T6963C_ADDRESS_POINT-

ER_SET)

Prototype sub procedure SPI_T6963C_WaitReady()

Returns Nothing.

Description Pools the status byte, and loops until Toshiba Glcd module is ready.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_WaitReady()

Prototype sub procedure SPI_T6963C_Fill(dim vas byte, dim start as word,

dim len as word)

Returns Nothing.

Description

Fills controller memory block with given byte.

Parameters :

 v: byte to be written

 start: starting address of the memory block

 len: length of the memory block in bytes

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Fill(0x33, 0x00FF, 0x000F)

474 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Dot

Prototype sub procedure SPI_T6963C_Dot(dim xas integer, dim yas integer,

dim color as byte)

Returns Nothing.

Description

Draws a dot in the current graphic panel of Glcd at coordinates (x, y).

Parameters :

 x: dot position on x-axis

 y: dot position on y-axis

 color: color parameter. Valid values: SPI_T6963C_BLACK and

SPI_T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Dot(x0, y0, pcolor)

475

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Write_Char

Prototype sub procedure SPI_T6963C_Write_Char(dim cas byte, dim x as byte,

dim y as byte, dim mode as byte)

Returns Nothing.

Description

Writes a char in the current text panel of Glcd at coordinates (x, y).

Parameters :

 c: char to be written

 x: char position on x-axis

 y: char position on y-axis

 mode: mode parameter. Valid values: SPI_T6963C_ROM_MODE_OR,

SPI_T6963C_ROM_MODE_XOR, SPI_T6963C_ROM_MODE_AND

and SPI_T6963C_ROM_MODE_TEXT

Mode parameter explanation:

 OR Mode: In the OR-Mode, text and graphics can be displayed and the data

is logically “OR-ed”. This is the most common way of combining text and

graphics for example labels on buttons.

 XOR-Mode: In this mode, the text and graphics data are combined via the

logical “exclusive OR”. This can be useful to display text in negative mode,

i.e. white text on black background.

 AND-Mode: The text and graphic data shown on display are combined via

the logical “AND function”.

 TEXT-Mode: This option is only available when displaying just a text. The

Text Attribute values are stored in the graphic area of display memory.

For more details see the T6963C datasheet.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Write_Char("A",22,23,AND)

476 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Write_Text

Prototype sub procedure SPI_T6963C_Write_Text(dim byref str as byte[10],

dim x as byte, dim y as byte, dim mode as byte)

Returns Nothing.

Description

Writes text in the current text panel of Glcd at coordinates (x, y).

Parameters :

 str: text to be written

 x: text position on x-axis

 y: text position on y-axis

 mode: mode parameter. Valid values: SPI_T6963C_ROM_MODE_OR,

SPI_T6963C_ROM_MODE_XOR, SPI_T6963C_ROM_MODE_AND

and SPI_T6963C_ROM_MODE_TEXT

Mode parameter explanation:

 OR Mode: In the OR-Mode, text and graphics can be displayed and the

data is logically “OR-ed”. This is the most common way of combining text

and graphics for example labels on buttons.

 XOR-Mode: In this mode, the text and graphics data are combined via

the logical “exclusive OR”. This can be useful to display text in negative

mode, i.e. white text on black background.

 AND-Mode: The text and graphic data shown on the display are com

bined via the logical “AND function”.

 TEXT-Mode: This option is only available when displaying just a text. The

Text Attribute values are stored in the graphic area of display memory.

For more details see the T6963C datasheet.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Write_Text("GLCD LIBRARY DEMO, WELCOME !", 0, 0,

T6963C_ROM_MODE_EXOR)

477

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Line

SPI_T6963C_Rectangle

Prototype sub procedure SPI_T6963C_Line(dim x0 as integer, dim y0 as inte-

ger, dim x1 as integer, dim y1 as integer, dim pcolor as byte)

Returns Nothing.

Description

Draws a line from (x0, y0) to (x1, y1).

Parameters :

 x0: x coordinate of the line start

 y0: y coordinate of the line end

 x1: x coordinate of the line start

 y1: y coordinate of the line end

 pcolor: color parameter. Valid values: SPI_T6963C_BLACK and

SPI_T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Line(0, 0, 239, 127, T6963C_WHITE)

Prototype

sub procedure SPI_T6963C_Rectangle(dim x0 as integer, dim y0 as

integer, dim x1 as integer, dim y1 as integer, dim pcolor as

byte)

Returns Nothing.

Description

Draws a rectangle on Glcd.

Parameters :

x0: x coordinate of the upper left rectangle corner

y0: y coordinate of the upper left rectangle corner

x1: x coordinate of the lower right rectangle corner

y1: y coordinate of the lower right rectangle corner

pcolor: color parameter. Valid values: SPI_T6963C_BLACK and

SPI_T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Rectangle(20, 20, 219, 107, T6963C_WHITE)

478 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Box

SPI_T6963C_Circle

Prototype sub procedure SPI_T6963C_Box(dim x0 as integer, dim y0 as inte-

ger, dim x1 as integer, dim y1 as integer, dim pcolor as byte)

Returns Nothing.

Description

Draws a box on the Glcd

Parameters :

 x0: x coordinate of the upper left box corner

 y0: y coordinate of the upper left box corner

 x1: x coordinate of the lower right box corner

 y1: y coordinate of the lower right box corner

 pcolor: color parameter. Valid values: SPI_T6963C_BLACK and

SPI_T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Box(0, 119, 239, 127, T6963C_WHITE)

Prototype sub procedure SPI_T6963C_Circle(dim x as integer, dim yas inte-

ger, dim ras longint, dim pcolor as byte)

Returns Nothing.

Description

Draws a circle on the Glcd.

Parameters :

 x: x coordinate of the circle center

y: y coordinate of the circle center

r: radius size

 pcolor: color parameter. Valid values: SPI_T6963C_BLACK and

SPI_T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Circle(120, 64, 110, T6963C_WHITE)

479

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Image

SPI_T6963C_Sprite

Prototype sub procedure SPI_T6963C_image(const pic as ^byte)

Returns Nothing.

Description

Displays bitmap on Glcd.

Parameters :

 pic: image to be displayed. Bitmap array can be located in both code and

RAM memory (due to the mikroBasic PRO for PIC pointer to const and

pointer to RAM equivalency).

Use the mikroBasic PRO’s integrated Glcd Bitmap Editor (menu option Tools ›

Glcd Bitmap Editor) to convert image to a constant array suitable for display-

ing on Glcd.

Note: Image dimension must match the display dimension.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Image(my_image)

Prototype sub procedure SPI_T6963C_sprite(dim px, py as byte, const pic as

^byte, dim sx, sy as byte)

Returns Nothing.

Description

Fills graphic rectangle area (px, py) to (px+sx, py+sy) with custom size picture.

Parameters :

 px: x coordinate of the upper left picture corner. Valid values: multiples of

the font width

 py: y coordinate of the upper left picture corner

 pic: picture to be displayed

 sx: picture width. Valid values: multiples of the font width

sy: picture height

Note: If px and sx parameters are not multiples of the font width they will be

scaled to the nearest lower number that is a multiple of the font width.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Sprite(76, 4, einstein, 88, 119) ' draw a sprite

480 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Set_Cursor

SPI_T6963C_ClearBit

SPI_T6963C_SetBit

Prototype sub procedure SPI_T6963C_set_cursor(dim x, y as byte)

Returns Nothing.

Description

Sets cursor to row x and column y.

Parameters :

 x: cursor position row number

 y: cursor position column number

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Set_Cursor(cposx, cposy)

Prototype sub procedure SPI_T6963C_clearBit(dim bas byte)

Returns Nothing.

Description

Clears control port bit(s).

Parameters :

 b: bit mask. The function will clear bit x on control port if bit x in bit mask

is set to 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' clear bits 0 and 1 on control port

SPI_T6963C_ClearBit(0x03)

Prototype sub procedure SPI_T6963C_setBit(dim bas byte)

Returns Nothing.

Description

Sets control port bit(s).

Parameters :

 b: bit mask. The function will set bit x on control port if bit x in bit mask is set

to 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' set bits 0 and 1 on control port

SPI_T6963C_SetBit(0x03)

481

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_NegBit

SPI_T6963C_DisplayGrPanel

SPI_T6963C_DisplayTxtPanel

Prototype sub procedure SPI_T6963C_negBit(dim bas byte)

Returns Nothing.

Description

Negates control port bit(s).

Parameters :

 b: bit mask. The function will negate bit x on control port if bit x in bit mask

is set to 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' negate bits 0 and 1 on control port

SPI_T6963C_NegBit(0x03)

Prototype sub procedure SPI_T6963C_DisplayGrPanel(dim nas byte)

Returns Nothing.

Description

Display selected graphic panel.

Parameters :

 n: graphic panel number. Valid values: 0 and 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' display graphic panel 1

SPI_T6963C_DisplayGrPanel(1)

Prototype sub procedure SPI_T6963C_DisplayTxtPanel(dim n as byte)

Returns Nothing.

Description

Display selected text panel.

Parameters :

 n: text panel number. Valid values: 0 and 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' display text panel 1

SPI_T6963C_DisplayTxtPanel(1)

482 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_SetGrPanel

SPI_T6963C_SetTxtPanel

Prototype sub procedure SPI_T6963C_SetGrPanel(dim nas byte)

Returns Nothing.

Description

Compute start address for selected graphic panel and set appropriate internal

pointers. All subsequent graphic operations will be preformed at this graphic

panel.

Parameters :

 n: graphic panel number. Valid values: 0 and 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' set graphic panel 1 as current graphic panel.

SPI_T6963C_SetGrPanel(1)

Prototype sub procedure SPI_T6963C_SetTxtPanel(dim nas byte)

Returns Nothing.

Description

Compute start address for selected text panel and set appropriate internal point-

ers. All subsequent text operations will be preformed at this text panel.

Parameters :

 n: text panel number. Valid values: 0 and 1.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' set text panel 1 as current text panel.

SPI_T6963C_SetTxtPanel(1)

483

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_PanelFill

SPI_T6963C_GrFill

SPI_T6963C_TxtFill

Prototype sub procedure SPI_T6963C_PanelFill(dim vas byte)

Returns Nothing.

Description

Fill current panel in full (graphic+text) with appropriate value (0 to clear).

Parameters :

 v: value to fill panel with.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example clear current panel

SPI_T6963C_PanelFill(0)

Prototype sub procedure SPI_T6963C_GrFill(dim vas byte)

Returns Nothing.

Description

Fill current graphic panel with appropriate value (0 to clear).

Parameters :

 v: value to fill graphic panel with.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' clear current graphic panel

SPI_T6963C_GrFill(0)

Prototype sub procedure SPI_T6963C_TxtFill(dim vas byte)

Returns Nothing.

Description

Fill current text panel with appropriate value (0 to clear).

Parameters :

 v: this value increased by 32 will be used to fill text panel.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' clear current text panel

SPI_T6963C_TxtFill(0)

484 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

SPI_T6963C_Cursor_Height

SPI_T6963C_Graphics

SPI_T6963C_Text

Prototype sub procedure SPI_T6963C_Cursor_Height(dim nas byte)

Returns Nothing.

Description

Set cursor size.

Parameters :

 n: cursor height. Valid values: 0..7.

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example SPI_T6963C_Cursor_Height(7)

Prototype sub procedure SPI_T6963C_Graphics(dim n as byte)

Returns Nothing.

Description

Enable/disable graphic displaying.

Parameters :

 n: graphic enable/disable parameter. Valid values: 0(disable graphic

dispaying) and 1(enable graphic displaying).

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example 'enable graphic displaying

SPI_T6963C_Graphics(1)

Prototype sub procedure SPI_T6963C_Text(dim n as byte)

Returns Nothing.

Description

Enable/disable text displaying.

Parameters :

 n: text enable/disable parameter. Valid values: 0(disable text dispaying)

and 1(enable text displaying).

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' enable text displaying

SPI_T6963C_Text(1)

SPI_T6963C_Cursor

SPI_T6963C_Cursor_Blink

Library Example

The following drawing demo tests advanced routines of the SPI T6963C Glcd library. Hardware

configurations in this example are made for the T6963C 240x128 display, EasyPIC5 board and

PIC16F887.

program SPI_T6963C_240x128

include __Lib_SPIT6963C_Const

include bitmap

include bitmap2

dim

' Port Expander module connections

485

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure SPI_T6963C_Cursor(dim nas byte)

Returns Nothing.

Description

Set cursor on/off.

Parameters :

 n: on/off parameter.Valid values: 0(set cursor off) and 1 (set cursor on).

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' set cursor on

SPI_T6963C_Cursor(1)

Prototype sub procedure SPI_T6963C_Cursor_Blink(dim nas byte)

Returns Nothing.

Description

Enable/disable cursor blinking.

Parameters :

 n: cursor blinking enable/disable parameter. Valid values: 0(disable

cursor blinking) and 1(enable cursor blinking).

Requires Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.

Example ' enable cursor blinking

SPI_T6963C_Cursor_Blink(1)

SPExpanderRST as sbit at RC0_bit

SPExpanderCS as sbit at RC1_bit

SPExpanderRST_Direction as sbit at TRISC0_bit

SPExpanderCS_Direction as sbit at TRISC1_bit

' End Port Expander module connections

dim panel as byte ' current panel

i as word ' general purpose register

curs as byte ' cursor visibility

cposx,

cposy as word ' cursor x-y position

txt, txt1 as string[29]

main:

txt1 = " EINSTEIN WOULD HAVE LIKED mE"

txt = " GLCD LIBRARY DEMO, WELCOME !"

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

TRISB0_bit = 1 ' Set RB0 as input

TRISB1_bit = 1 ' Set RB1 as input

TRISB2_bit = 1 ' Set RB2 as input

TRISB3_bit = 1 ' Set RB3 as input

TRISB4_bit = 1 ' Set RB4 as input

' Initialize SPI module

SPI1_Init()

' ' If Port Expander Library uses SPI2 module

' Pass pointer to SPI Read sub function of used SPI module

' Initialize SPI module used with PortExpander

' SPI2_Init_Advanced(_SPI_MASTER, _SPI_FCY_DIV32, _SPI_CLK_HI_

TRAILING)

' *

' * init display for 240 pixel width and 128 pixel height

' * 8 bits character width

' * data bus on MCP23S17 portB

' * control bus on MCP23S17 PORTA

' * bit 2 is !WR

' * bit 1 is !RD

' * bit 0 is !CD

' * bit 4 is RST

' * chip enable, reverse on, 8x8 font internaly set in library

486 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

' *

' Initialize SPI Toshiba 240x128

SPI_T6963C_Config(240, 128, 8, 0, 2, 1, 0, 4)

'Delay_ms(1000)

' *

' * Enable both graphics and text display at the same time

' *

SPI_T6963C_graphics(1)

SPI_T6963C_text(1)

panel = 0

i = 0

curs = 0

cposx = 0

cposy = 0

' *

' * Text messages

' *

SPI_T6963C_write_text(txt, 0, 0, SPI_T6963C_ROM_MODE_XOR)

SPI_T6963C_write_text(txt1, 0, 15, SPI_T6963C_ROM_MODE_XOR)

' *

' * Cursor

' *

SPI_T6963C_cursor_height(8) ' 8 pixel height

SPI_T6963C_set_cursor(0, 0) ' move cursor to top left

SPI_T6963C_cursor(0) ' cursor off

' * Draw rectangles

' *

SPI_T6963C_rectangle(0, 0, 239, 127, SPI_T6963C_WHITE)

SPI_T6963C_rectangle(20, 20, 219, 107, SPI_T6963C_WHITE)

SPI_T6963C_rectangle(40, 40, 199, 87, SPI_T6963C_WHITE)

SPI_T6963C_rectangle(60, 60, 179, 67, SPI_T6963C_WHITE)

' *

' * Draw a cross

' *

SPI_T6963C_line(0, 0, 239, 127, SPI_T6963C_WHITE)

SPI_T6963C_line(0, 127, 239, 0, SPI_T6963C_WHITE)

' *

487

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

' * Draw solid boxes

' *

SPI_T6963C_box(0, 0, 239, 8, SPI_T6963C_WHITE)

SPI_T6963C_box(0, 119, 239, 127, SPI_T6963C_WHITE)

' *

' * Draw circles

' *

SPI_T6963C_circle(120, 64, 10, SPI_T6963C_WHITE)

SPI_T6963C_circle(120, 64, 30, SPI_T6963C_WHITE)

SPI_T6963C_circle(120, 64, 50, SPI_T6963C_WHITE)

SPI_T6963C_circle(120, 64, 70, SPI_T6963C_WHITE)

SPI_T6963C_circle(120, 64, 90, SPI_T6963C_WHITE)

SPI_T6963C_circle(120, 64, 110, SPI_T6963C_WHITE)

SPI_T6963C_circle(120, 64, 130, SPI_T6963C_WHITE)

SPI_T6963C_sprite(76, 4, @einstein, 88, 119) ' Draw a sprite

SPI_T6963C_setGrPanel(1) ' Select other graphic panel

SPI_T6963C_sprite(0, 0, @mikroe, 240, 64) ' 240x128 can"t be

stored in most of PIC16 MCUs

SPI_T6963C_sprite(0, 64, @mikroe, 240, 64) ' it is replaced

with smaller picture 240x64

' Smaller picture is drawn two times

while TRUE ' Endless loop

'* If PORTB_0 is pressed, toggle the display between graphic

panel 0 and graphic 1

if (RB0_bit <> 0) then

Inc(panel)

panel = panel and 1

SPI_T6963C_displayGrPanel(panel)

Delay_ms(300)

'* If PORTB_2 is pressed, display only text panel

else

if (RB2_bit <> 0) then

SPI_T6963C_graphics(0)

SPI_T6963C_text(1)

Delay_ms(300)

'* If PORTB_3 is pressed, display text and graphic panels

488 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

else

if (RB3_bit <> 0) then

SPI_T6963C_graphics(1)

SPI_T6963C_text(1)

Delay_ms(300)

'* If PORTB_4 is pressed, change cursor

else

if(RB4_bit <> 0) then

Inc(curs)

if (curs = 3) then

curs = 0

end if

select case curs

case 0

' no cursor

SPI_T6963C_cursor(0)

case 1

' blinking cursor

SPI_T6963C_cursor(1)

SPI_T6963C_cursor_blink(1)

case 2

' non blinking cursor

SPI_T6963C_cursor(1)

SPI_T6963C_cursor_blink(0)

end select 'case

Delay_ms(300)

end if

'* Move cursor, even if not visible

Inc(cposx)

if (cposx = SPI_T6963C_txtCols) then

cposx = 0

Inc(cposy)

if (cposy = SPI_T6963C_grHeight / SPI_T6963C_CHARACTER_

HEIGHT) then

cposy = 0

end if

SPI_T6963C_set_cursor(cposx, cposy)

489

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Delay_ms(100)

wend

end.

HW Connection

SPI T6963C Glcd HW connection

490 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C GRAPHIC LCD LIBRARY

The mikroBasic PRO for PIC provides a library for working with Glcds based on

TOSHIBA T6963C controller. The Toshiba T6963C is a very popular Lcd controller

for the use in small graphics modules. It is capable of controlling displays with a res-

olution up to 240x128. Because of its low power and small outline it is most suitable

for mobile applications such as PDAs, MP3 players or mobile measurement equip-

ment. Although small, this contoller has a capability of displaying and merging text

and graphics and it manages all the interfacing signals to the displays Row and Col-

umn drivers.

For creating a custom set of Glcd images use Glcd Bitmap Editor Tool.

Note: ChipEnable(CE), FontSelect(FS) and Reverse(MD) have to be set to appro-

priate levels by the user outside of the T6963C_Init function. See the Library Exam-

ple code at the bottom of this page.

Note: Some mikroElektronika's adapter boards have pinout different from T6369C

datasheets. Appropriate relations between these labels are given in the table below:

External dependencies of T6963C Graphic LCD Library

491

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Adapter Board T6369C datasheet

RS C/D

R/W /RD

E/WR

The following variables

must be defined in all proj-

ects using T6963C Graphic

LCD library:

Description: Example :

dim T6963C_dataPort as

byte sfr external T6963C Data Port. dim T6963C_dataPort

as byte at PORTD

dim T6963C_ctrlwr as

sbit sfr external Write signal. dim T6963C_ctrlwr as

sbit at RC2_bit

dim T6963C_ctrlrd as

sbit sfr external Read signal. dim T6963C_ctrlrd as

sbit at RC1_bit

dim T6963C_ctrlcd as

sbit sfr external Command/Data signal. dim T6963C_ctrlcd as

sbit at RC0_bit

dim T6963C_ctrlrst as

sbit sfr external Reset signal. dim T6963C_ctrlrst as

sbit at RC4_bit

dim

T6963C_ctrlwr_Direction

as sbit sfr external

Direction of the Write

pin.

dim T6963C_ctrlwr_

Direction as sbit at

TRISC2_bit

Library Routines

T6963C_Init

T6963C_WriteData

T6963C_WriteCommand

T6963C_SetPtr

T6963C_WaitReady

T6963C_Fill

T6963C_Dot

T6963C_Write_Char

T6963C_Write_Text

T6963C_Line

T6963C_Rectangle

T6963C_Box

T6963C_Circle

T6963C_Image

T6963C_Sprite

T6963C_Set_Cursor

T6963C_DisplayGrPanel

T6963C_DisplayTxtPanel

T6963C_SetGrPanel

T6963C_SetTxtPanel

T6963C_PanelFill

T6963C_GrFill

T6963C_TxtFill

T6963C_Cursor_Height

T6963C_Graphics

T6963C_Text

T6963C_Cursor

T6963C_Cursor_Blink

492 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

The following variables

must be defined in all proj-

ects using T6963C Graphic

LCD library:

Description: Example :

dim

T6963C_ctrlrd_Direction

as sbit sfr external

Direction of the Read

pin.

dim

T6963C_ctrlrd_Direction

as sbit at TRISC1_bit

dim

T6963C_ctrlcd_Direction

as sbit sfr external

Direction of the Com-

mand/Data pin.

dim

T6963C_ctrlcd_Direction

as sbit at TRISC0_bit

dim

T6963C_ctrlrst_Direction

as sbit sfr external

Direction of the Reset

pin.

dim

T6963C_ctrlrst_Directi

on as sbit at

TRISC4_bit

493

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

T6963C_Init

Prototype sub procedure T6963C_init(dim width, height, fntW as byte)

Returns Nothing.

Description

Initializes T6963C Graphic Lcd controller.

Parameters :

 width: width of the Glcd panel

 height: height of the Glcd panel

 fntW: font width

Display RAM organization:

The library cuts the RAM into panels : a complete panel is one graphics panel

followed by a text panel (see schematic below).

schematic:

+--------------------- + /\

+ GRAPHICS PANEL #0 + |

+ + |

+--------------------- + | PANEL 0

+ TEXT PANEL #0 + |

+ + \/

+--------------------- + /\

+ GRAPHICS PANEL #1 + |

+ + |

+--------------------- + | PANEL 1

+ TEXT PANEL #1 + |

+ + |

+--------------------- + \/

Requires

Global variables :

 T6963C_dataPort: Data Port

 T6963C_ctrlwr: Write signal pin

 T6963C_ctrlrd: Read signal pin

 T6963C_ctrlcd: Command/Data signal pin

 T6963C_ctrlrst: Reset signal pin

T6963C_ctrlwr_Direction: Direction of Write signal pin

 T6963C_ctrlrd_Direction: Direction of Read signal pin

 T6963C_ctrlcd_Direction: Direction of Command/Data signal pin

 T6963C_ctrlrst_Direction: Direction of Reset signal pin

must be defined before using this function.

494 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_WriteData

T6963C_WriteCommand

Example

‘T6963C module connections

dim T6963C_dataPort as byte at PORTD

dim T6963C_ctrlwr as sbit at RC2_bit

dim T6963C_ctrlrd as sbit at RC1_bit

dim T6963C_ctrlcd as sbit at RC0_bit

dim T6963C_ctrlrst as sbit at RC4_bit

dim T6963C_ctrlwr_Direction as sbit at TRISC2_bit

dim T6963C_ctrlrd_Direction as sbit at TRISC1_bit

dim T6963C_ctrlcd_Direction as sbit at TRISC0_bit

dim T6963C_ctrlrst_Direction as sbit at TRISC4_bit

' End of T6963C module connections

...

' init display for 240 pixel width, 128 pixel height and 8 bits

character width

T6963C_init(240, 128, 8)

Prototype sub procedure T6963C_WriteData(dim mydata as byte)

Returns Nothing.

Description

Writes data to T6963C controller.

Parameters :

mydata: data to be written

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_WriteData(AddrL)

Prototype sub procedure T6963C_WriteCommand(dim mydata as byte)

Returns Nothing.

Description

Writes command to T6963C controller.

Parameters :

mydata: command to be written

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_WriteCommand(T6963C_CURSOR_POINTER_SET)

495

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

T6963C_SetPtr

T6963C_WaitReady

T6963C_Fill

Prototype sub procedure T6963C_SetPtr(dim pas word, dim cas byte)

Returns Nothing.

Description

Sets the memory pointer p for command c.

Parameters :

 p: address where command should be written

 c: command to be written

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_SetPtr(T6963C_grHomeAddr + start,

T6963C_ADDRESS_POINTER_SET)

Prototype sub procedure T6963C_WaitReady()

Returns Nothing.

Description Pools the status byte, and loops until Toshiba Glcd module is ready.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_WaitReady()

Prototype sub procedure T6963C_Fill(dim vas byte, dim start, len as word)

Returns Nothing.

Description

Fills controller memory block with given byte.

Parameters :

 v: byte to be written

 start: starting address of the memory block

 len: length of the memory block in bytes

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Fill(0x33,0x00FF,0x000F)

496 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_Dot

Prototype sub procedure T6963C_Dot(dim x, y as integer, dim color as byte)

Returns Nothing.

Description

Draws a dot in the current graphic panel of Glcd at coordinates (x, y).

Parameters :

 x: dot position on x-axis

 y: dot position on y-axis

 color: color parameter. Valid values: T6963C_BLACK and

T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Dot(x0, y0, pcolor)

497

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

T6963C_Write_Char

Prototype sub procedure T6963C_Write_Char(dim c, x, y, mode as byte)

Returns Nothing.

Description

Writes a char in the current text panel of Glcd at coordinates (x, y).

Parameters :

 c: char to be written

 x: char position on x-axis

 y: char position on y-axis

 mode: mode parameter. Valid values: T6963C_ROM_MODE_OR,

T6963C_ROM_MODE_XOR, T6963C_ROM_MODE_AND and

T6963C_ROM_MODE_TEXT

Mode parameter explanation:

 OR Mode: In the OR-Mode, text and graphics can be displayed and the

data is logically “OR-ed”. This is the most common way of combining text

and graphics for example labels on buttons.

 XOR-Mode: In this mode, the text and graphics data are combined via the

logical “exclusive OR”. This can be useful to display text in the negative

mode, i.e. white text on black background.

 AND-Mode: The text and graphic data shown on display are combined via

the logical “AND function”.

 TEXT-Mode:This option is only available when displaying just a text. The

Text Attribute values are stored in the graphic area of display memory.

For more details see the T6963C datasheet.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Write_Char('A',22,23,AND)

498 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_Write_Text

Prototype sub procedure T6963C_Write_Text(dim byref str as byte[10], dim x,

y, mode as byte)

Returns Nothing.

Description

Writes text in the current text panel of Glcd at coordinates (x, y).

Parameters :

 str: text to be written

 x: text position on x-axis

 y: text position on y-axis

 mode: mode parameter. Valid values: T6963C_ROM_MODE_OR,

T6963C_ROM_MODE_XOR, T6963C_ROM_MODE_AND and

T6963C_ROM_MODE_TEXT

Mode parameter explanation:

 OR Mode: In the OR-Mode, text and graphics can be displayed and the

data is logically “OR-ed”. This is the most common way of combining text

and graphics for example labels on buttons.

 XOR-Mode: In this mode, the text and graphics data are combined via

the logical “exclusive OR”. This can be useful to display text in the

negatiive mode, i.e. white text on black background.

 AND-Mode: The text and graphic data shown on display are combined

via the logical “AND function”.

 TEXT-Mode: This option is only available when displaying just a text.

The Text Attribute values are stored in the graphic area of display

memory.

For more details see the T6963C datasheet.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Write_Text(" GLCD LIBRARY DEMO, WELCOME !", 0, 0,

T6963C_ROM_MODE_XOR)

499

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

T6963C_Line

T6963C_Rectangle

Prototype sub procedure T6963C_Line(dim x0, y0, x1, y1 as integer, dim

pcolor as byte)

Returns Nothing.

Description

Draws a line from (x0, y0) to (x1, y1).

Parameters :

 x0: x coordinate of the line start

 y0: y coordinate of the line end

 x1: x coordinate of the line start

 y1: y coordinate of the line end

 pcolor: color parameter. Valid values: T6963C_BLACK and

T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Line(0, 0, 239, 127, T6963C_WHITE)

Prototype sub procedure T6963C_Rectangle(dim x0, y0, x1, y1 as integer, dim

pcolor as byte)

Returns Nothing.

Description

Draws a rectangle on Glcd.

Parameters :

 x0: x coordinate of the upper left rectangle corner

 y0: y coordinate of the upper left rectangle corner

 x1: x coordinate of the lower right rectangle corner

 y1: y coordinate of the lower right rectangle corner

 pcolor: color parameter. Valid values: T6963C_BLACK and

T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Rectangle(20, 20, 219, 107, T6963C_WHITE)

500 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_Box

T6963C_Circle

Prototype psub procedure T6963C_Box(dim x0, y0, x1, y1 as integer, dim

pcolor as byte)

Returns Nothing.

Description

Draws a box on Glcd.

Parameters :

 x0: x coordinate of the upper left box corner

 y0: y coordinate of the upper left box corner

 x1: x coordinate of the lower right box corner

 y1: y coordinate of the lower right box corner

 pcolor: color parameter. Valid values: T6963C_BLACK and

T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Box(0, 119, 239, 127, T6963C_WHITE)

Prototype sub procedure T6963C_Circle(dim x, y as integer, dim r as longint,

dim pcolor as byte)

Returns Nothing.

Description

Draws a circle on Glcd.

Parameters :

 x: x coordinate of the circle center

 y: y coordinate of the circle center

 r: radius size

 pcolor: color parameter. Valid values: T6963C_BLACK and

T6963C_WHITE

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Circle(120, 64, 110, T6963C_WHITE)

501

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

T6963C_Image

T6963C_Sprite

Prototype sub procedure T6963C_Image(const pic as ^byte)

Returns Nothing.

Description

Displays bitmap on Glcd.

Parameters :

 pic: image to be displayed. Bitmap array can be located in both code

and RAM memory (due to the mikroBasic PRO for PIC pointer to const

and pointer to RAM equivalency).

Use the mikroBasic PRO’s integrated Glcd Bitmap Editor (menu option Tools ›

Glcd Bitmap Editor) to convert image to a constant array suitable for display-

ing on Glcd.

Note: Image dimension must match the display dimension.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example TT6963C_Image(mc)

Prototype sub procedure T6963C_Sprite(dim px, py, sx, sy as byte, const pic as

^byte)

Returns Nothing.

Description

Fills graphic rectangle area (px, py) to (px+sx, py+sy) with custom size picture.

Parameters :

 px: x coordinate of the upper left picture corner. Valid values: multiples

of the font width

 py: y coordinate of the upper left picture corner

 pic: picture to be displayed

 sx: picture width. Valid values: multiples of the font width

 sy: picture height

Note: If px and sx parameters are not multiples of the font width they will be

scaled to the nearest lower number that is a multiple of the font width.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Sprite(76, 4, einstein, 88, 119) ' draw a sprite

502 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_Set_Cursor

T6963C_DisplayGrPanel

T6963C_DisplayTxtPanel

Prototype sub procedure T6963C_Set_Cursor(dim x, y as byte)

Returns Nothing.

Description

Sets cursor to row x and column y.

Parameters :

 x: cursor position row number

 y: cursor position column number

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Set_Cursor(cposx, cposy)

Prototype sub procedure T6963C_DisplayGrPanel(dim nas byte)

Returns Nothing.

Description

Display selected graphic panel.

Parameters :

 n: graphic panel number. Valid values: 0and 1.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' display text panel 1

T6963C_DisplayTxtPanel(1)

Prototype sub procedure T6963C_DisplayTxtPanel(dim n as byte)

Returns Nothing.

Description

Display selected text panel.

Parameters :

 n: text panel number. Valid values: 0and 1.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' display text panel 1

T6963C_DisplayTxtPanel(1)

503

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

T6963C_SetGrPanel

T6963C_SetTxtPanel

Prototype sub procedure T6963C_SetGrPanel(dim n as byte)

Returns Nothing.

Description

Compute start address for selected graphic panel and set appropriate internal

pointers. All subsequent graphic operations will be preformed at this graphic

panel.

Parameters :

 n: graphic panel number. Valid values: 0and 1.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' set graphic panel 1 as current graphic panel.

T6963C_SetGrPanel(1)

Prototype sub procedure T6963C_SetTxtPanel(dim nas byte)

Returns Nothing.

Description

Compute start address for selected text panel and set appropriate internal point-

ers. All subsequent text operations will be preformed at this text panel.

Parameters

 n: text panel number. Valid values: 0and 1.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' set text panel 1 as current text panel.

T6963C_SetTxtPanel(1)

504 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_PanelFill

T6963C_GrFill

T6963C_TxtFill

Prototype sub procedure T6963C_PanelFill(dim vas byte)

Returns Nothing.

Description

Fill current panel in full (graphic+text) with appropriate value (0 to clear).

Parameters :

 v: value to fill panel with.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example clear current panel

T6963C_PanelFill(0)

Prototype procedure T6963C_GrFill(v : byte);

Returns Nothing.

Description

Fill current graphic panel with appropriate value (0 to clear).

Parameters :

 v: value to fill graphic panel with.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ‘clear current graphic panel

T6963C_GrFill(0)

Prototype sub procedure T6963C_TxtFill(dim vas byte)

Returns Nothing.

Description

Fill current text panel with appropriate value (0 to clear).

Parameters :

 v: this value increased by 32 will be used to fill text panel.

Requires Toshiba GLCD module needs to be initialized. See the T6963C_Init routine.

Example ' clear current text panel

T6963C_TxtFill(0)

T6963C_Cursor_Height

T6963C_Graphics

T6963C_Text

505

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure T6963C_Cursor_Height(dim n as byte)

Returns Nothing.

Description

Set cursor size.

Parameters :

 ncursor height. Valid values: 0..7.

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example T6963C_Cursor_Height(7)

Prototype sub procedure T6963C_Graphics(dim nas byte)

Returns Nothing.

Description

Enable/disable graphic displaying.

Parameters :

 n: on/off parameter. Valid values: 0(disable graphic dispaying) and 1

(enable graphic displaying).

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' enable graphic displaying

T6963C_Graphics(1)

Prototype sub procedure T6963C_Text(dim nas byte)

Returns Nothing.

Description

Enable/disable text displaying.

Parameters :

 n: on/off parameter. Valid values: 0 (disable text dispaying) and 1

(enable text displaying).

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' enable text displaying

T6963C_Text(1)

506 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

T6963C_Cursor

T6963C_Cursor_Blink

Library Example

The following drawing demo tests advanced routines of the T6963C Glcd library. Hardware con-

figurations in this example are made for the T6963C 240x128 display, EasyPIC5 board and

PIC16F887.

Prototype sub procedure T6963C_Cursor(dim nas byte)

Returns Nothing.

Description

Set cursor on/off.

Parameters :

 n: on/off parameter. Valid values: 0(set cursor off) and 1 (set cursor

on).

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' set cursor on

T6963C_Cursor(1)

Prototype sub procedure T6963C_Cursor_Blink(dim nas byte)

Returns Nothing.

Description

Enable/disable cursor blinking.

Parameters :

 n: on/off parameter. Valid values: 0(disable cursor blinking) and 1

(enable cursor blinking).

Requires Toshiba Glcd module needs to be initialized. See the T6963C_Init routine.

Example ' enable cursor blinking

T6963C_Cursor_Blink(1)

program T6963C_240x128

include __Lib_T6963C_Consts

include einstein_bmp

include mikroe_bmp

' T6963C module connections

dim T6963C_dataPort as byte at PORTD ' DATA port

dim T6963C_ctrlwr as sbit at RC2_bit ' WR write signal

dim T6963C_ctrlrd as sbit at RC1_bit ' RD read signal

dim T6963C_ctrlcd as sbit at RC0_bit ' CD command/data signal

dim T6963C_ctrlrst as sbit at RC4_bit ' RST reset signal

dim T6963C_ctrlwr_Direction as sbit at TRISC2_bit ' WR write signal

direction

dim T6963C_ctrlrd_Direction as sbit at TRISC1_bit ' RD read signal

direction

dim T6963C_ctrlcd_Direction as sbit at TRISC0_bit ' CD command/data

signal direction

dim T6963C_ctrlrst_Direction as sbit at TRISC4_bit ' RST reset sig-

nal direction

' Signals not used by library, they are set in main sub function

dim T6963C_ctrlce as sbit at RC3_bit ' CE signal

dim T6963C_ctrlfs as sbit at RC6_bit ' FS signal

dim T6963C_ctrlmd as sbit at RC5_bit ' MD signal

dim T6963C_ctrlce_Direction as sbit at TRISC3_bit ' CE signal

direction

dim T6963C_ctrlfs_Direction as sbit at TRISC6_bit ' FS signal

direction

dim T6963C_ctrlmd_Direction as sbit at TRISC5_bit ' MD sig-

nal direction

' End T6963C module connections

dim panel as byte ' current panel

i as word ' general purpose register

curs as byte ' cursor visibility

cposx,

cposy as word ' cursor x-y position

txtcols as byte ' number of text coloms

txt, txt1 as string[29]

main:

txt1 = " EINSTEIN WOULD HAVE LIKED mE"

txt = " GLCD LIBRARY DEMO, WELCOME !"

ANSEL = 0 ' Configure AN pins as digital I/O

ANSELH = 0

C1ON_bit = 0 ' Disable comparators

C2ON_bit = 0

507

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

TRISB0_bit = 1 ' Set RB0 as input

TRISB1_bit = 1 ' Set RB1 as input

TRISB2_bit = 1 ' Set RB2 as input

TRISB3_bit = 1 ' Set RB3 as input

TRISB4_bit = 1 ' Set RB4 as input

T6963C_ctrlce_Direction = 0

T6963C_ctrlce = 0 ' Enable T6963C

T6963C_ctrlfs_Direction = 0

T6963C_ctrlfs = 0 ' Font Select 8x8

T6963C_ctrlmd_Direction = 0

T6963C_ctrlmd = 0 ' Column number select

panel = 0

i = 0

curs = 0

cposx = 0

cposy = 0

' Initialize T6369C

T6963C_init(240, 128, 8)

' *

' * Enable both graphics and text display at the same time

' *

T6963C_graphics(1)

T6963C_text(1)

' *

' * Text messages

' *

T6963C_write_text(txt, 0, 0, T6963C_ROM_MODE_XOR)

T6963C_write_text(txt1, 0, 15, T6963C_ROM_MODE_XOR)

' *

' * Cursor

' *

T6963C_cursor_height(8) ' 8 pixel height

T6963C_set_cursor(0, 0) ' Move cursor to top left

T6963C_cursor(0) ' Cursor off

' *

' * Draw rectangles

' *

T6963C_rectangle(0, 0, 239, 127, T6963C_WHITE)

T6963C_rectangle(20, 20, 219, 107, T6963C_WHITE)

T6963C_rectangle(40, 40, 199, 87, T6963C_WHITE)

T6963C_rectangle(60, 60, 179, 67, T6963C_WHITE)

508 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

' *

' * Draw a cross

' *

T6963C_line(0, 0, 239, 127, T6963C_WHITE)

T6963C_line(0, 127, 239, 0, T6963C_WHITE)

' *

' * Draw solid boxes

' *

T6963C_box(0, 0, 239, 8, T6963C_WHITE)

T6963C_box(0, 119, 239, 127, T6963C_WHITE)

' *

' * Draw circles

' *

T6963C_circle(120, 64, 10, T6963C_WHITE)

T6963C_circle(120, 64, 30, T6963C_WHITE)

T6963C_circle(120, 64, 50, T6963C_WHITE)

T6963C_circle(120, 64, 70, T6963C_WHITE)

T6963C_circle(120, 64, 90, T6963C_WHITE)

T6963C_circle(120, 64, 110, T6963C_WHITE)

T6963C_circle(120, 64, 130, T6963C_WHITE)

T6963C_sprite(76, 4, @einstein, 88, 119) ' Draw a sprite

T6963C_setGrPanel(1) ' Select other graphic panel

T6963C_sprite(0, 0, @mikroe_bmp, 240, 64) ' 240x128 can"t be

stored in most of PIC16 MCUs

T6963C_sprite(0, 64, @mikroe_bmp, 240, 64) ' it is replaced with

smaller picture 240x64

' Smaller picture

is drawn two times

while TRUE ' Endless loop

'* If PORTB_0 is pressed, toggle the display between graphic

panel 0 and graphic 1

if (RB0_bit <> 0) then

T6963C_graphics(1)

T6963C_text(0)

Delay_ms(300)

'* If PORTB_1 is pressed, display only graphic panel

509

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

else

if (RB1_bit <> 0) then

Inc(panel)

panel = panel and 1

T6963C_setPtr((T6963C_grMemSize + T6963C_txtMemSize) *

panel, T6963C_GRAPHIC_HOME_ADDRESS_SET)

Delay_ms(300)

'* If PORTB_2 is pressed, display only text panel

else

if (RB2_bit <> 0) then

T6963C_graphics(0)

T6963C_text(1)

Delay_ms(300)

'* If PORTB_3 is pressed, display text and graphic panels

else

if (RB3_bit <> 0) then

T6963C_graphics(1)

T6963C_text(1)

Delay_ms(300)

'* If PORTB_4 is pressed, change cursor

else

if(RB4_bit <> 0) then

Inc(curs)

if (curs = 3) then

curs = 0

end if

select case curs

case 0

' no cursor

T6963C_cursor(0)

case 1

' blinking cursor

T6963C_cursor(1)

T6963C_cursor_blink(1)

case 2

' non blinking cursor

T6963C_cursor(1)

T6963C_cursor_blink(0)

end select 'case

Delay_ms(300)

510 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

end if

'* Move cursor, even if not visible

Inc(cposx)

if (cposx = T6963C_txtCols) then

cposx = 0

Inc(cposy)

if (cposy = T6963C_grHeight / T6963C_CHARACTER_HEIGHT) then

cposy = 0

end if

T6963C_set_cursor(cposx, cposy)

Delay_ms(100)

wend

end.

511

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

HW Connection

T6963C Glcd HW connection

512 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

UART LIBRARY

UART hardware module is available with a number of PIC MCUs. mikroBasic PRO

for PIC UART Library provides comfortable work with the Asynchronous (full duplex)

mode.

You can easily communicate with other devices via RS-232 protocol (for example

with PC, see the figure at the end of the topic – RS-232 HW connection). You need

a PIC MCU with hardware integrated UART, for example 16F887. Then, simply use

the functions listed below.

Note: Some PIC18 MCUs have multiple UART modules. Switching between the

UART modules in the UART library is done by the UART_Set_Active function (UART

module has to be previously initialized).

Note: In order to use the desired UART library routine, simply change the number

1 in the prototype with the appropriate module number, i.e. UART2_Init(2400)

Library Routines

 UART1_Init

 UART1_Data_Ready

 UART1_Tx_Idle

 UART1_Read

 UART1_Read_Text

 UART1_Write

 UART1_Write_Text

 UART_Set_Active

513

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

514 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

UART1_Init

UART1_Data_Read

Prototype sub function UART1_Data_Ready() as byte

Returns Function returns 1 if data is ready or 0 if there is no data.

Description The function tests if data in receive buffer is ready for reading.

Requires

MCU with the UART module.

The UART module must be initialized before using this routine. See the

UART1_Init routine.

Example

dim receive as byte

...

' read data if ready

if (UART1_Data_Ready() = 1) then

receive = UART1_Read()

end if

Prototype sub procedure UART1_Init(dim baud_rate as longint)

Returns Nothing.

Description

Configures and initializes the UART module.

The internal UART module module is set to:

 receiver enabled

 transmitter enabled

 frame size 8 bits

 1 STOP bit

 parity mode disabled

 asynchronous operation

Parameters :

 baud_rate: requested baud rate

Refer to the device data sheet for baud rates allowed for specific Fosc.

Requires

You'll need PIC MCU with hardware UART.

UART1_Init needs to be called before using other functions from UART

Library.

Note: Calculation of the UART baud rate value is carried out by the compiler, as

it would produce a relatively large code if performed on the libary level.

Therefore, compiler needs to know the value of the parameter in the compile

time. That is why this parameter needs to be a constant, and not a variable.

Example

'This will initialize hardware UART1 module and establish the

communication at 2400 bps

UART1_Init(2400)

515

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

UART1_Tx_Idle

UART1_Read

Prototype sub function UART1_Read() as byte

Returns Received byte.

Description The function receives a byte via UART. Use the UART1_Data_Ready function

to test if data is ready first.

Requires

MCU with the UART module.

The UART module must be initialized before using this routine. See UART1_Init

routine.

Example

dim receive as byte

...

' read data if ready

if (UART1_Data_Ready() = 1) then

receive = UART1_Read()

Prototype char UART1_Tx_Idle()

 1if the data has been transmitted

0otherwise

Description Use the function to test if the transmit shift register is empty or not.

Requires UART HW module must be initialized and communication established before

using this function. See UART1_Init.

Example

' If the previous data has been shifted out, send next data:

if (UART1_Tx_Idle = 1) then

UART1_Write(_data)

end if

516 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

UART1_Read_Text

UART1_Write

Prototype sub procedure UART1_Write(dim TxData as byte)

Returns Nothing.

Description

The function transmits a byte via the UART module.

Parameters :

TxData: data to be sent

Requires

MCU with the UART module.

The UART module must be initialized before using this routine. See UART1_Init

routine.

Example

dim data_ as byte

...

data_ = 0x1E

UART1_Write(data_)

Prototype sub procedure UART1_Read_Text(dim byref Output as string[255],

dim byref Delimiter as string[10], dim Attempts as byte)

Returns Nothing.

Description

Reads characters received via UART until the delimiter sequence is detected.

The read sequence is stored in the parameter output; delimiter sequence is

stored in the parameter delimiter.

This is a blocking call: the delimiter sequence is expected, otherwise the proce-

dure exits( if the delimiter is not found). Attempts defines number of received

characters in which Delimiter sequence is expected. If Attempts is set to 255,

this routine will continously try to detect the Delimiter sequence.

Requires UART HW module must be initialized and communication established before

using this function. See UART1_Init.

Example

Read text until the sequence “OK” is received, and send back what’s been

received:

UART1_Init(4800) ' initialize UART module

Delay_ms(100)

while TRUE

if (UART1_Data_Ready() = 1) ' if data is received

UART1_Read_Text(output, 'delim', 10) ' reads text until

'delim' is found

UART1_Write_Text(output) ' sends back text

end if

wend.

517

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

UART1_Write_Text

UART_Set_Active

Prototype

sub procedure UART_Set_Active (dim read_ptr as ^Tread_ptr, dim

write_ptr as ^Twrite_ptr, dim ready_ptr as ^Tready_ptr, dim

tx_idle_ptr as ^Ttx_idle_ptr)

Returns Nothing.

Description

Sets active UART module which will be used by the UART library routines.

Parameters :

 read_ptr: UART1_Read handler

 write_ptr: UART1_Write handler

 ready_ptr: UART1_Data_Ready handler

 tx_idle_ptr: UART1_Tx_Idle handler

Requires

Routine is available only for MCUs with two UART modules.

Used UART module must be initialized before using this routine. See

UART1_Init routine.

Example

‘Activate UART2 module

UART_Set_Active(UART1_Read, UART1_Write, UART1_Data_Ready,

UART1_Tx_Idle)

Prototype sub procedure UART1_Write_Text(dim byref uart_text as string[255]

Returns Nothing.

Description Sends text (parameter uart_text) via UART. Text should be zero terminated.

Requires UART HW module must be initialized and communication established before

using this function. See UART1_Init.

Example

Read text until the sequence “OK” is received, and send back what’s been

received:

UART1_Init(4800) ' initialize UART module

Delay_ms(100)

while TRUE

if (UART1_Data_Ready() = 1) ' if data is received

UART1_Read_Text(output, 'delim', 10) ' reads text until

'delim' is found

UART1_Write_Text(output) ' sends back text

end if

wend.

Library Example

This example demonstrates simple data exchange via UART. If MCU is connected to the

PC, you can test the example from the mikroBasic PRO for PIC USART Terminal.

program UART

dim uart_rd as byte

main:

UART1_Init(9600) ' Initialize UART module at 9600 bps

Delay_ms(100) ' Wait for UART module to stabilize

while (TRUE) ' Endless loop

if (UART1_Data_Ready() <> 0) then ' If data is received,

uart_rd = UART1_Read() ' read the received data,

UART1_Write(uart_rd) ' and send data via UART

end if

wend

end.

HW Connection

UART HW connection

518 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

USB HID Library

Universal Serial Bus (USB) provides a serial bus standard for connecting a wide variety of

devices, including computers, cell phones, game consoles, PDA’s, etc.

mikroBasic PRO for PIC includes a library for working with human interface devices via Universal

Serial Bus. A human interface device or HID is a type of computer device that interacts directly

with and takes input from humans, such as the keyboard, mouse, graphics tablet, and the like.

Descriptor File

Each project based on the USB HID library should include a descriptor source file which contains

vendor id and name, product id and name, report length, and other relevant information. To cre-

ate a descriptor file, use the integrated USB HID terminal of mikroBasic (Tools › USB HID Termi-

nal). The default name for descriptor file is USBdsc.pbas, but you may rename it.

The provided code in the “Examples” folder works at 48MHz, and the flags should not be modi-

fied without consulting the appropriate datasheet first.

Library Routines

 Hid_Enable

 Hid_Read

 Hid_Write

 Hid_Disable

Hid_Enable

519

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Prototype sub procedure Hid_Enable(dim readbuff, writebuff as word)

Returns Nothing.

Description

Enables USB HID communication. Parameters readbuff and writebuff are the

addresses of Read Buffer and the Write Buffer, respectively, which are used for

HID communication. You can pass buffer names with the @ operator.

This function needs to be called before using other routines of USB HID Library.

Requires Nothing.

Example Hid_Enable(@rd, @wr)

Hid_Read

Hid_Write

Hid_Disable

520 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Hid_Read as byte

Returns Number of characters in the Read Buffer received from the host.

Description Receives message from host and stores it in the Read Buffer. Function returns

the number of characters received in the Read Buffer.

Requires USB HID needs to be enabled before using this function. See Hid_Enable.

Example length = Hid_Read

Prototype sub procedure Hid_Write(dim writebuff as word, dim len as byte)

Returns Nothing.

Description

Function sends data from Write Buffer writebuff to host. Write Buffer is the

address of the parameter used in initialization; see Hid_Enable. You can pass a

buffer name with the @ operator. Parameter len should specify a length of the

data to be transmitted.

Requires USB HID needs to be enabled before using this function. See Hid_Enable.

Example Hid_Write(@wr, len)

Prototype sub procedure Hid_Disable

Returns Nothing.

Description Disables USB HID communication.

Requires USB HID needs to be enabled before using this function. See Hid_Enable.

Example Hid_Disable()

Library Example

The following example continually sends sequence of numbers 0..255 to the PC via

Universal Serial Bus.

program hid_test

dim k as byte

dim userRD_buffer as byte[64]

dim userWR_buffer as byte[64]

sub procedure interrupt

asm

CALL _Hid_InterruptProc

nop

end asm

end sub

sub procedure Init_Main

' Disable all interrupts

' Disable GIE, PEIE, TMR0IE, INT0IE,RBIE

INTCON = 0

INTCON2 = $F5

INTCON3 = $C0

' Disable Priority Levels on interrupts

RCON.IPEN = 0

PIE1 = 0

PIE2 = 0

PIR1 = 0

PIR2 = 0

' Configure all ports with analog function as digital

ADCON1 = ADCON1 or $0F

' Ports Configuration

TRISA = 0

TRISB = 0

TRISC = $FF

TRISD = $FF

TRISE = $07

LATA = 0

LATB = 0

LATC = 0

LATD = 0

LATE = 0

' Clear user RAM

' Banks [00 .. 07] ( 8 x 256 = 2048 Bytes )

521

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

asm

LFSR FSR0, $000

MOVLW $08

CLRF POSTINC0, 0

CPFSEQ FSR0H, 0

BRA $ - 2

end asm

' Timer 0

T0CON = $07;

TMR0H = (65536 - 156) >> 8

TMR0L = (65536 - 156) and $FF

INTCON.T0IE = 1 ' Enable T0IE

T0CON.TMR0ON = 1

end sub

'** Main Program **

main:

Init_Main()

Hid_Enable(@userRD_buffer, @userWR_buffer)

for k = 0 to 255

' Prepare send buffer

userWR_buffer[0] = k

' Send the number via USB

Hid_Write(@userWR_buffer, 1)

next k

loop until FALSE

Hid_Disable

end.

522 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

HW Connection

USB connection scheme

523

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

MISCELLANEOUS LIBRARIES

 Button Library

 Conversions Library

 Math Library

 String Library

 Time Library

 Trigonometry Library

BUTTON LIBRARY

The Button library contains miscellaneous routines useful for a project development.

 Button

Button

524 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Button(dim byref port as byte, dim pin, time,

active_state as byte)as byte

Returns Returns 0 or 255.

Description

Function eliminates the influence of contact flickering upon pressing a button

(debouncing).

Parameter port specifies the location of the button; parameter pin is the pin

number on designated port and goes from 0..7; parameter time is a debounce

period in milliseconds; parameter active_state can be either 0 or 1, and it

determines if the button is active upon logical zero or logical one.

Requires Button pin must be configured as input.

Example

Example reads RB0, to which the button is connected; on transition from 1 to 0

(release of button), PORTD is inverted:

while true

if Button(PORTB, 0, 1, 1) then

oldstate = 255

end if

if oldstate and Button(PORTB, 0, 1, 0) then

PORTD = not(PORTD)

oldstate = 0

end if

wend

CONVERSIONS LIBRARY

mikroBasic PRO for PIC Conversions Library provides routines for numerals to

strings and BCD/decimal conversions.

Library Routines

You can get text representation of numerical value by passing it to one of the follow-

ing routines:

 ByteToStr

 ShortToStr

 WordToStr

 IntToStr

 LongintToStr

 LongWordToStr

 FloatToStr

 StrToInt

 StrToWord

The following sub functions convert decimal values to BCD and vice versa:

 Dec2Bcd

 Bcd2Dec16

 Dec2Bcd16

525

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

526 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

ByteToStr

ShortToStr

Prototype sub procedure ByteToStr(dim input as word, dim byref output as

string[2])

Returns Nothing.

Description

Converts input byte to a string. The output string is right justified and remaining

positions on the left (if any) are filled with blanks.

Parameters :

 input: byte to be converted

 output: destination string

Requires Nothing.

Example

dim t as word

txt as string[2]

...

t = 24

ByteToStr(t, txt) ' txt is " 24" (one blank here)

Prototype sub procedure ShortToStr(dim input as short, dim byref output as

string[3])

Returns Nothing.

Description

Converts input short (signed byte) number to a string. The output string is right

justified and remaining positions on the left (if any) are filled with blanks.

Parameters :

 input: short number to be converted

 output: destination string

Requires Nothing.

Example

dim tas short

txt as string[3]

...

t = -24

ByteToStr(t, txt) ' txt is " -24" (one blank here)

527

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

WordToStr

IntToStr

Prototype sub procedure WordToStr(dim input as word, dim byref output as

string[4])

Returns Nothing.

Description

Converts input word to a string. The output string is right justified and the

remaining positions on the left (if any) are filled with blanks.

Parameters :

input: word to be converted

 output: destination string

Requires Nothing.

Example

dim tas word

txt as string[4]

...

t = 437

WordToStr(t, txt) ' txt is " 437" (two blanks here)

Prototype sub procedure IntToStr(dim input as integer, dim byref output as

string[5]

Returns Nothing.

Description

Converts input integer number to a string. The output string is right justified and

the remaining positions on the left (if any) are filled with blanks.

Parameters :

 input: integer number to be converted

 output: destination string

Requires Nothing.

Example

dim input as integer

txt as string[5]

'...

input = -4220

IntToStr(input, txt) ' txt is ' -4220'

528 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

LongintToStr

LongWordToStr

Prototype sub procedure LongintToStr(dim input as longint, dim byref output

as string[10])

Returns Nothing.

Description

Converts input longint number to a string. The output string is right justified and

the remaining positions on the left (if any) are filled with blanks.

Parameters :

 input: longint number to be converted

 output: destination string

Requires Nothing.

Example

dim input as longint

txt as string[10]

'...

input = -12345678

IntToStr(input, txt) ' txt is ' -12345678'

Prototype sub procedure LongWordToStr(dim input as longword, dim byref out-

put as string[9])

Returns Nothing.

Description

Converts input double word number to a string. The output string is right justi-

fied and the remaining positions on the left (if any) are filled with blanks.

Parameters :

 input: double word number to be converted

 output: destination string

Requires Nothing.

Example

dim input as longint

txt as string[9]

'...

input = 12345678

IntToStr(input, txt) ' txt is ' 12345678'

529

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

FloatToStr

Prototype sub function FloatToStr(dim input as real, dim byref output as

string[22])

Returns

 3 if input number is NaN

 2 if input number is -INF

 1 if input number is +INF

 0 if conversion was successful

Description

Converts a floating point number to a string.

Parameters :

 input: floating point number to be converted

 output: destination string

The output string is left justified and null terminated after the last digit.

Note: Given floating point number will be truncated to 7 most significant digits

before conversion.

Requires Nothing.

Example

dim ff1, ff2, ff3 as real

txt as string[22]

...

ff1 = -374.2

ff2 = 123.456789

ff3 = 0.000001234

FloatToStr(ff1, txt) ' txt is "-374.2"

FloatToStr(ff2, txt) ' txt is "123.4567"

FloatToStr(ff3, txt) ' txt is "1.234e-6"

530 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

StrToInt

StrToWord

Dec2Bcd

Prototype function Dec2Bcd (dim decnum as byte) as byte

Returns Converted BCD value.

Description

Converts input number to its appropriate BCD representation.

Parameters :

 decnum: number to be converted

Requires Nothing.

Example

dim a, b as byte

...

a = 22

b = Dec2Bcd(a) ' b equals 34

Prototype sub function StrToInt(dim byref input as string[6]) as integer

Returns Integer variable.

Description Converts a string to integer

Requires The string is assumed to be a correct representation of a number.

Example

dim ii as integer

main:

ii = StrToInt('-1234')

end.

Prototype sub function StrToWord(dim byref input as string[5]) as word

Returns Word variable.

Description Converts a string to word.

Requires input string with length of max 5 chars.

The string is assumed to be a correct representation of a number.

Example

dim ww as word

main:

ww = StrToword('65432')

end.

531

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Bcd2Dec16

Dec2Bcd16

Prototype sub function Bcd2Dec16(dim bcdnum as word)as word

Returns Converted decimal value.

Description

Converts 16-bit BCD numeral to its decimal equivalent.

Parameters :

 bcdnum: 16-bit BCD numeral to be converted

Requires Nothing.

Example

dim a, b as word

...

a = 0x1234 ' a equals 4660

b = Bcd2Dec16(a) ' b equals 1234

Prototype sub function Dec2Bcd16(dim decnum as word)as word

Returns Converted BCD value.

Description

Converts decimal value to its BCD equivalent.

Parameters :

 decnum decimal number to be converted

Requires Nothing.

Example

dim a, b as word

...

a = 2345

b = Dec2Bcd16(a) ' b equals 9029

MATH LIBRARY

The mikroBasic PRO for PIC provides a set of library functions for floating point

math handling. See also Predefined Globals and Constants for the list of predefined

math constants.

Library Functions

 acos

 asin

 atan

 atan2

 ceil

 cos

 cosh

 eval_poly

 exp

 fabs

 floor

 frexp

 dexp

 log

 log10

 modf

 pow

 sin

 sinh

 sqrt

tan

 tanh

532 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

533

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

acos

asin

atan

atan2

ceil

cos

cosh

Prototype sub function acos(dim xas real)as real

Description

The function returns the arc cosine of parameter x; that is, the value whose

cosine is x. The input parameter x must be between -1 and 1 (inclusive). The

return value is in radians, between 0 and Π(inclusive).

Prototype sub function asin(dim xas real) as real

Description

The function returns the arc sine of parameter x; that is, the value whose sine is

x. The input parameter xmust be between -1 and 1 (inclusive). The return

value is in radians, between - Π/2 and Π/2 (inclusive).

Prototype sub function atan(dim arg as real) as real

Description

The function computes the arc tangent of parameter arg; that is, the value

whose tangent is arg. The return value is in radians, between -Π/2 and Π/2

(inclusive).

Prototype sub function atan2(dim yas real, dim xas real)as real

Description

This is the two-argument arc tangent function. It is similar to computing the arc

tangent of y/x, except that the signs of both arguments are used to determine

the quadrant of the result and xis permitted to be zero. The return value is in

radians, between -Πand Π(inclusive).

Prototype sub function ceil(dim xas real) as real

Description The function returns value of parameter xrounded up to the next whole number.

Prototype sub function cos(dim arg as real)as real

Description The function returns the cosine of arg in radians. The return value is from -1 to 1.

Prototype sub function cosh(dim xas real)as real

Description The function returns the hyperbolic cosine of x, defined mathematically as

(ex+e-x)/2. If the value of xis too large (if overflow occurs), the function fails.

534 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

eval_poly

exp

fabs

floor

frexp

ldexp

log

Prototype sub function eval_poly(dim xas real, dim byref d as array[10] of

real, dim nas integer)as real

Description Function Calculates polynom for number x, with coefficients stored in d[], for

degree n.

Prototype sub function exp(dim xas real)as real

Description The function returns the value of e — the base of natural logarithms — raised to

the power x(i.e. ex).

Prototype sub function fabs(dim das real)as real

Description The function returns the absolute (i.e. positive) value of d.

Prototype sub function floor(dim xas real)as real

Description The function returns the value of parameter xrounded down to the nearest integer.

Prototype sub function frexp(dim value as real, dim byref eptr as integer)

as real

Description

The function splits a floating-point value value into a normalized fraction and an

integral power of 2. The return value is a normalized fraction and the integer

exponent is stored in the object pointed to by eptr.

Prototype sub function ldexp(dim value as real, dim newexp as integer)as

real

Description The function returns the result of multiplying the floating-point number value by

2 raised to the power newexp (i.e. returns value * 2newexp).

Prototype sub function log(dim xas real)as real

Description The function returns the natural logarithm of x(i.e. loge(x)).

535

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

log10

modf

pow

sin

sinh

sqrt

tan

tanh

Prototype sub function log10(dim x as real)as real

Description The function returns the base-10 logarithm of x(i.e. log10(x)).

Prototype sub function modf(dim val as real, dim byref iptr as real) as

real

Description The function returns the signed fractional component of val, placing its whole

number component into the variable pointed to by iptr.

Prototype sub function pow(dim xas real, dim y as real)as real

Description The function returns the value of xraised to the power y(i.e. xy). If xis nega-

tive, the function will automatically cast y into longint.

Prototype sub function sin(dim arg as real) as real

Description The function returns the sine of arg in radians. The return value is from -1 to 1.

Prototype sub function sinh(dim xas real)as real

Description The function returns the hyperbolic sine of x, defined mathematically as (ex-e-x)/2.

If the value of x is too large (if overflow occurs), the function fails.

Prototype sub function sqrt(dim xas real)as real

Description The function returns the non negative square root of x.

Prototype sub function tan(dim xas real)as real

Description The function returns the tangent of xin radians. The return value spans the

allowed range of floating point in mikroBasic PRO for PIC.

Prototype sub function tanh(dim xas real)as real)

Description The function returns the hyperbolic tangent of x, defined mathematically as

sinh(x)/cosh(x).

STRING LIBRARY

The mikroBasic PRO for PIC includes a library which automatizes string related

tasks

Library Functions

 memchr

 memcmp

 memcpy

 memmove

 memset

 strcat

 strchr

 strcmp

 strcpy

 strlen

 strncat

 strncpy

 strspn

 strcspn

 strncmp

 strpbrk

 strrchr

 strstr

536 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

537

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

memchr

memcmp

Prototype sub function memchr(dim p as ^byte, dim ch as byte, dim nas

word)as word

Description

The function locates the first occurrence of the word ch in the initial nwords of

memory area starting at the address p. The function returns the offset of this

occurrence from the memory address por 0xFF if ch was not found.

For the parameter p you can use either a numerical value (literal/variable/con-

stant) indicating memory address or a dereferenced value of an object, for

example @mystring or @PORTB.

Prototype sub function memcmp(dim p1, p2 as ^byte, dim nas word)as inte-

ger

Description

The function returns a positive, negative, or zero value indicating the relation-

ship of first n words of memory areas starting at addresses p1 and p2.

This function compares two memory areas starting at addresses p1 and p2 for n

words and returns a value indicating their relationship as follows:

Value Meaning

< 0 p1 "less than" p2

= 0 p1 "equal to" p2

> 0 p1 "greater than" p2

The value returned by the function is determined by the difference between the

values of the first pair of words that differ in the strings being compared.

For parameters p1 and p2 you can use either a numerical value (literal/vari-

able/constant) indicating memory address or a dereferenced value of an object,

for example @mystring or @PORTB.

538 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

memcpy

memmove

memset

strcat

Prototype sub procedure memcpy(dim p1, p2 as ^byte, dim nn as word)

Description

The function copies nn words from the memory area starting at the address p2

to the memory area starting at p1. If these memory buffers overlap, the memcpy

function cannot guarantee that words are copied before being overwritten. If

these buffers do overlap, use the memmove function.

For parameters p1 and p2 you can use either a numerical value (literal/vari-

able/constant) indicating memory address or a dereferenced value of an object,

for example @mystring or @PORTB.

Prototype sub procedure memmove(dim p1, p2, as ^byte, dim nn as word)

Description

The function copies nn words from the memory area starting at the address p2 to the

memory area starting at p1. If these memory buffers overlap, the Memmove function

ensures that the words in p2 are copied to p1 before being overwritten.

For parameters p1 and p2 you can use either a numerical value (literal/vari-

able/constant) indicating memory address or a dereferenced value of an object,

for example @mystring or @PORTB.

Prototype sub procedure memset(dim pas ^byte, dim character as byte, dim n

as word)

Description

The function fills the first nwords in the memory area starting at the address p

with the value of word character.

For parameter pyou can use either a numerical value (literal/variable/constant)

indicating memory address or a dereferenced value of an object, for example

@mystring or @PORTB.

Prototype sub procedure strcat(dim byref s1, s2 as string[100])

Description The function appends the value of string s2 to string s1 and terminates s1 with

a null character.

539

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

strchr

strcmp

strcpy

strcspn

Prototype sub function strchr(dim byref s as string[100], dim ch as byte)

as word

Description

The function searches the string sfor the first occurrence of the character ch.

The null character terminating sis not included in the search.

The function returns the position (index) of the first character ch found in s; if no

matching character was found, the function returns 0xFF.

Prototype sub function strcmp(dim byref s1, s2 as string[100]) as short

Description

The function lexicographically compares the contents of the strings s1 and s2

and returns a value indicating their relationship:

Value Meaning

< 0 s1 "less than" s2

= 0 s1 "equal to" s2

> 0 s1 "greater than" s2

The value returned by the function is determined by the difference between the

values of the first pair of words that differ in the strings being compared.

Prototype sub procedure strcpy(dim byref s1, s2 as string[100])

Description The function copies the value of the string s2 to the string s1 and appends a

null character to the end of s1.

Prototype sub function strcspn(dim byref s1, s2 as string[100]) as word

Description

The function searches the string s1 for any of the characters in the string s2.

The function returns the index of the first character located in s1 that matches

any character in s2. If the first character in s1 matches a character in s2, a

value of 0 is returned. If there are no matching characters in s1, the length of

the string is returned (not including the terminating null character).

540 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

strlen

strncat

strncmp

strncpy

strpbrk

Prototype sub function strlen(dim byref s as string[100]) as word

Description The function returns the length, in words, of the string s. The length does not

include the null terminating character.

Prototype sub procedure strncat(dim byref s1, s2 as string[100], dim size

byte)

Description

The function appends at most size characters from the string s2 to the string s1

and terminates s1 with a null character. If s2 is shorter than the size charac-

ters, s2 is copied up to and including the null terminating character.

Prototype sub function strncmp(dim byref s1, s2 as string[100], dim len as

byte)as short

Description

The function lexicographically compares the first len words of the strings s1 and

s2 and returns a value indicating their relationship:

Value Meaning

< 0 s1 "less than" s2

= 0 s1 "equal to" s2

> 0 s1 "greater than" s2

The value returned by the function is determined by the difference between the

values of the first pair of words that differ in the strings being compared (within

first len words).

Prototype sub procedure strncpy(dim byref s1, s2 as string[100], dim size

as word)

Description

The function copies at most size characters from the string s2 to the string s1.

If s2 contains fewer characters than size, s1 is padded out with null characters

up to the total length of the size characters.

Prototype sub function strpbrk(dim byref s1, s2 as string[100]) as word

Description

The function searches s1 for the first occurrence of any character from the

string s2. The null terminator is not included in the search. The function returns

an index of the matching character in s1. If s1 contains no characters from s2,

the function returns 0xFF.

541

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

strrchr

strspn

strstr

Prototype sub function strrchr(dim byref sas string[100], dim ch as byte)

as word

Description

The function searches the string s for the last occurrence of the character ch.

The null character terminating sis not included in the search. The function

returns an index of the last ch found in s; if no matching character was found,

the function returns 0xFF.

Prototype sub function strspn(dim byref s1, s2 as string[100]) as byte

Description

The function searches the string s1 for characters not found in the s2 string.

The function returns the index of first character located in s1 that does not

match a character in s2. If the first character in s1 does not match a character in

s2, a value of 0 is returned. If all characters in s1 are found in s2, the length of

s1 is returned (not including the terminating null character).

Prototype sub function strstr(dim byref s1, s2 as string[100]) as word

Description

The function locates the first occurrence of the string s2 in the string s1 (exclud-

ing the terminating null character).

The function returns a number indicating the position of the first occurrence of

s2 in s1; if no string was found, the function returns 0xFF. If s2 is a null string,

the function returns 0.

TIME LIBRARY

The Time Library contains functions and type definitions for time calculations in the UNIX time for-

mat which counts the number of seconds since the "epoch". This is very convenient for programs

that work with time intervals: the difference between two UNIX time values is a real-time differ-

ence measured in seconds.

What is the epoch?

Originally it was defined as the beginning of 1970 GMT. ( January 1, 1970 Julian day ) GMT,

Greenwich Mean Time, is a traditional term for the time zone in England.

The TimeStruct type is a structure type suitable for time and date storage.

Library Routines

Time_dateToEpoch

Time_epochToDate

 Time_datediff

Time_dateToEpoch

542 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function Time_dateToEpoch(dim byref ts as TimeStruct)as

longint

Returns Number of seconds since January 1, 1970 0h00mn00s.

Description

This function returns the UNIX time : number of seconds since January 1, 1970

0h00mn00s.

Parameters :

ts: time and date value for calculating UNIX time.

Requires Nothing.

Example

dim ts1 as TimeStruct

Epoch as longint

...

' what is the epoch of the date in ts ?

epoch = Time_dateToEpoch(ts1)

543

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

Time_epochToDate

Time_dateDiff

Prototype sub procedure Time_epochToDate(dim e as longint, dim byref ts as

TimeStruct)

Returns Nothing.

Description

Converts the UNIX time to time and date.

Parameters :

e: UNIX time (seconds since UNIX epoch)

 ts: time and date structure for storing conversion output

Requires Nothing.

Example

dim ts2 as TimeStruct

epoch as longint

...

' what date is epoch 1234567890 ?

epoch = 1234567890

Time_epochToDate(epoch,ts2)

Prototype sub function Time_dateDiff(dim t1 as ^TimeStruct, dim t2 as

^TimeStruct)as longint

Returns Time difference in seconds as a signed long.

Description

This function compares two dates and returns time difference in seconds as a

signed long. The result is positive if t1 is before t2, null if t1 is the same as t2

and negative if t1 is after t2.

Parameters :

t1: time and date structure (the first comparison parameter)

 t2: time and date structure (the second comparison parameter)

Requires Nothing.

Example

dim ts1, ts2 as TimeStruct

diff as longint

...

' how many seconds between these two dates contained in ts1 and

ts2 buffers?

diff = Time_dateDiff(ts1, ts2)

Library Example

Demonstration of Time library routines usage for time calculations in UNIX time format.

program Time_Demo

dim epoch, diff as longint

'***********************************

ts1, ts2 as TimeStruct

'***********************************

main:

ts1.ss = 0

ts1.mn = 7

ts1.hh = 17

ts1.md = 23

ts1.mo = 5

ts1.yy = 2006

' *

' * What is the epoch of the date in ts ?

' *

epoch = Time_dateToEpoch(@ts1) ' 1148404020

' *

' * What date is epoch 1234567890 ?

' *

epoch = 1234567890

Time_epochToDate(epoch, @ts2) ' {0x1E, 0x1F, 0x17, 0x0D, 0x04,

0x02, 0x07D9)

' *

' * How much seconds between this two dates ?

' *

diff = Time_dateDiff(@ts1, @ts2) ' 86163870

end.

544 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

TimeStruct type definition

structure TimeStruct

dim ss as byte ' seconds

dim mn as byte ' minutes

dim hh as byte ' hours

dim md as byte 'day in month, from 1 to 31

dim wd as byte ' day in week, monday=0, tuesday=1, .... sun-

day=6

dim mo as byte ' month number, from 1 to 12 (and not from 0

to 11 as with unix C time !)

dim yy as word ' year Y2K compliant, from 1892 to 2038

end structure

545

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

TRIGONOMETRY LIBRARY

The mikroBasic PRO for PIC implements fundamental trigonometry functions. These functions

are implemented as look-up tables. Trigonometry functions are implemented in integer format in

order to save memory.

Library Routines

 sinE3

 cosE3

sinE3

546 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

Prototype sub function sinE3(dim angle_deg as word)as integer

Returns The function returns the sine of input parameter.

Description

The function calculates sine multiplied by 1000 and rounded to the nearest integer:

result = round(sin(angle_deg)*1000)

Parameters:

 angle_deg: input angle in degrees

Note: Return value range: -1000..1000.

Requires Nothing.

Example

dim res as integer

...

res = sinE3(45) ' result is 707

547

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

cosE3

Prototype sub function cosE3(dim angle_deg as word)as integer

Returns The function returns the cosine of input parameter.

Description

The function calculates cosine multiplied by 1000 and rounded to the nearest

integer:

result = round(cos(angle_deg)*1000)

Parameters:

angle_deg: input angle in degrees

Note: Return value range: -1000..1000.

Requires Nothing.

Example

dim res as integer

...

res = cosE3(196) ' result is -193

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries mikroBasic PRO for PIC

CHAPTER 7

548 MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

Libraries

mikroBasic PRO for PIC

CHAPTER 7

549

MIKROELEKTRONIKA - SOFTWARE AND HARDWARE SOLUTIONS FOR EMBEDDED WORLD

MikroBasic PRO For PIC User Manual V100 V101

Navigation menu

Versions of this User Manual:

Views

Navigation