MAXLCD.C2 - Hilfe

Beschreibung

Einfügen als Gemeinsames Modul

Funktionen:

define()
define()
init()
cmd()
defineChar()
defineCharString()
clear()
home()
delline()
line()
goto()
cursorleft()
cursorright()
setcursor()
put()
print2()
print()
printlength()
fill()
printlines()
zahlf()
time()
date()
def_bargraph()
bargraph()
def_sanduhr()
def_arr_up()
def_arr_down()
portGet()
portGetn()
portSetDDR()
portSetDDRn()

Beschreibung   Nach oben

Das Modul maxlcd.c2 ist ein Treiber für Standard-LC-Display (HD44780) am I²C-Bus-Portexpander MAX7311.



Einfügen als Gemeinsames-Modul   Nach oben

Die Datei maxlcd.c2 in das Verzeichnis .\CControl2\UserLib kopieren und
in der Datei modules.txt die Zeile maxlcd.c2 einfügen.
Ein zusätzliches Ausrufezeichen unmittelbar nach einem Modulnamen in modules.txt bestimmt,
daß das Modul in jedem neuen Projekt von Anfang an aktiviert wird.

Funktionen:

define()   Nach oben

    function define(byte device, byte Addr, byte Size)

Mit der Funktion define() wird ein Display definiert und einer Displaynummer zugeordnet
Die maximale Anzahl an LCDs wird durch die Konstante maxDevices festgelegt.
Dem angegebenem Display (0 bis maxDevices-1) wird eine Subadresse (0-63) des MAX7311,
sowie eine Displaygröße zugeordnet.
Durch die Angabe der Displaygröße kann zwischen LCDs mit 16 und 20 Zeichen pro Zeile unterschieden werden.
Diese Angabe wird für die Funktionen line(), goto(), delline(), und printlines() benötigt.

setlight()   Nach oben

    function setlight(byte device, int light) returns int

Mit dieser Funktion wird die Displaybeleuchtung geschaltet.

init()   Nach oben

    function init(byte device) returns int

Die Funktion init() initialisiert das LCD.
Der Cursor wird wird dabei abgestellt.(Dieser kann mit setcursor() auf Unterstrich oder blinkender Block gesetzt werden.)
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

cmd()   Nach oben

    function cmd(byte device, byte cmd) returns int

Mit der Funktion cmd() wird ein Kommando-Byte an das LCD gesendet.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

defineChar()   Nach oben

    function defineChar(byte device, byte CharAddr, byte char[]) returns int

Mit der Funktion defineChar() können bis zu 8 benutzerdefinierte Zeichen
erstellt werden. Die Bit-Daten werden als Bytearray mit 8 Byte Größe übergeben.
Jedes Byte repräsentiert eine Pixelzeile. Die Bits 0 bis 4 entsprechen den 5 Bildpunkten pro Zeile.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

defineCharString()   Nach oben

    function defineCharString(byte device, byte CharAddr, byte chardef) returns int

Mit der Funktion defineCharString() werdend wie mit defineChar() Zeichen definiert.
Die Zeichendaten werden hier als String übergeben. So können z.B. Stringkonstanten
für die Zeichendefinition übergeben werden.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

clear()   Nach oben

    function clear(byte device) returns int

Mit clear() wird der Inhald des Displays gelöscht.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

home()   Nach oben

    function home(byte device) returns int

Mit home() wird der Cursor auf die Anfangsposition gesetzt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

delline()   Nach oben

    function delline(byte device, byte line) returns int

Mit delline() wird die angegebene Zeile gelöscht.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

line()   Nach oben

    function line(byte device, byte line) returns int

Mit line() wird der Cursor an den Anfang der angegebenen Zeile gesetzt
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

goto()   Nach oben

    function goto(byte device, byte line, byte col) returns int

Mit goto() wird der Cursor an die Angegebene Zeile und Spalte gesetzt
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

cursorleft()   Nach oben

    function cursorleft(byte device) returns int

Mit der Funktion cursorleft() wird der Cursor um eine Stelle nach links geschoben.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

cursorright()   Nach oben

    function cursorright(byte device) returns int

Mit der Funktion cursorright() wird der Cursor um eine Stelle nach rechts geschoben.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

setcursor()   Nach oben

    function setcursor(byte device, byte cursor) returns int

Mit der Funktion setcursor() wird die Art des Cursors bestimmt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

put()   Nach oben

    function put(byte device, byte char) returns int

Mit put() wird ein Zeichen auf das Display ausgegeben
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

print2()   Nach oben

    function print2(byte device, byte s[]) returns int

Mit dieser Funktion wird eine Stringvariable ausgegeben.
Wird anstelle einer Stringvariable ein Bytearray übergeben, so muß
an Byte 31 die Anzahl der Zeichen stehen.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

print()   Nach oben

    function print(byte device, string s) returns int

Mit dieser Funktion wird ein String ausgegeben.
Es können Strinvariablen, Stringkonstanten oder direkt Strings übergeben werden.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

printlength()   Nach oben

    function printlength(byte device, byte s[], byte len) returns int

Mit dieser Funktion wird eine Stringvariable oder der Inhalt eines Bytearrays ausgegeben.
Die Anzahl der auszugebenden Zeichen wird dabei übergeben.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

fill()   Nach oben

    function fill(byte device, byte ASCII, byte len) returns int

Mit dieser Funktion wird das Display mit einer Anzahl gleicher Zeichen gefüllt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

printlines()   Nach oben

    function printlines(byte device, string s[], byte count) returns int

Mit dieser Funktion wird ein Stringarray auf das Display ausgegeben.
Jeder String wird in einer Zeile ausgegeben. Angefangen inder ersten Zeile.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

Zahlfunktionen   Nach oben

    function ziff(byte device, int num) returns int
    function zahl2(byte device, int num) returns int
    function zahl3p(byte device, int num) returns int
    function zahl3(byte device, int num) returns int
    function zahl4p(byte device, int num) returns int
    function zahl4(byte device, int num) returns int
    function zahl5(byte device, int num) returns int
    function zahl(byte device, int num) returns int


Mit diesen Funktion können Zahlen direkt ausgegeben werden, ohne diese
erst in Strings zu konvertieren. Jede Funktion besitzt eine andere Ausgabeform von Zahlen:

zahllf()   Nach oben

    function zahlf(byte device, long num, byte cnt, byte dec) returns int

Mit dieser Funktion wird eine Zahl in dem angegebenen Format ausgegeben.
Die Zahl kann max. vom Typ long sein. Die übergebene Zahl wird als Festkommawert
ausgegeben, wenn mit dec eine Anzahl an Dezimalstellen definiert wird.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

time()   Nach oben

    function time(byte device, byte format) returns int

Mit dieser Funktion wird die aktuelle Zeit auf das Display ausgegeben.
Es sind dabei mehrere Formate möglich.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

date()   Nach oben

    function date(byte device, byte format) returns int

Mit dieser Funktion wird das aktuelle Datum auf das Display ausgegeben.
Es sind dabei mehrere Formate möglich.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

def_bargraph()   Nach oben

    function def_bargraph(byte device)

Die Funktion defbargraph() definiert Zeichen für die Bargraph-Funktion und legt diese
im Display-RAM als ASCII-Zeichen 0 bis 3 ab.

bargraph()   Nach oben

    function bargraph(byte device, byte len, byte maxlen) returns int

Mit der Funktion bargraph() können Balken ausgegeben werden.
Es muß vor dem ersten Verwenden dieser Funktion die Funktion def_bargraph()
aufgerufen werden.
Die Maximale Balkenlänge bei 2x16 und 4x16 LCDs beträgt 80 und bei
2x20 und 4x20 100.

Sonderzeichen   Nach oben

    function def_sanduhr(byte device, byte ascii)
    function def_arr_up(byte device, byte ascii)
    function def_arr_down(byte device, byte ascii)

Mit diesen Funktion können die Sonderzeichen "Sanduhr", Pfeil nach oben und
Pfeil nach unten erstellt und im RAM des Displays abgelegt werden.
Die jeweilige Funktion muß vor dem ersten Verwenden des Zeichens aufgerufen werden.

portSetDDR()   Nach oben

    function portSetDDR(byte device, byte Port, int DDR) returns int

Mit dieser Funktion wird die Datenrichtung der 4 freien I/O-Ports festgelegt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

portSetDDRn()   Nach oben

    function portSetDDRn(byte device, byte DDR) returns int

Mit dieser Funktion wird die Datenrichtung der 4 freien I/O-Ports als Datennibble festgelegt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

portGet()   Nach oben

    function portGet(byte device, byte Port) returns int

Mit portGet() wird ein als Eingang definierter Port ausgelesen.

portGetn()   Nach oben

    function portGetn(byte device) returns byte

Mit dieser Funktion werden die als Eingang definiertern Zusatzports ausgelesen,
und als Bitmuster zurückgegeben.

portSet()   Nach oben

    function portSet(byte device, byte Port, int state) returns int

Mit portSet() wird ein als Ausgnag definierter Port gesetzt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).

portSetn()   Nach oben

    function portSetn(byte device, byte state) returns byte

Mit dieser Funktion wird die Ausgänge mit dem übergebenen Bitmuster gesetzt.
Die Funktion gibt True(-1) zurück, wenn sich an der angegebenen Adresse ein
Baustein befindet, andernfalls False(0).