NIBObee Library  1.4
nibobee/bgx1.h-Dateireferenz

Routinen zur Kommunikation mit der Display-Erweiterung BGX1 über I²C. Mehr ...

#include <stdint.h>
#include <avr/pgmspace.h>

gehe zum Quellcode dieser Datei

Funktionen

uint8_t bgx1_init ()
void bgx1_reset ()
uint16_t bgx1_getVersion ()
uint8_t bgx1_getStatus ()
void bgx1_setStatus (uint8_t)
void bgx1_move (uint8_t x, uint8_t y)
void bgx1_mode (uint8_t mode)
void bgx1_fillAll (uint8_t pattern)
void bgx1_print (const char *text)
void bgx1_print_P (const char *text)
uint8_t bgx1_textWidth (const char *text)
uint8_t bgx1_textWidth_P (const char *text)
void bgx1_selectFont (uint8_t font)
void bgx1_hLine (uint8_t length)
void bgx1_vLine (uint8_t length)
void bgx1_box (uint8_t width, uint8_t height)
void bgx1_drawBitmap (uint8_t width, uint8_t height, const uint8_t bitmap[])
void bgx1_drawBitmap_P (uint8_t width, uint8_t height, PGM_P bitmap)
void bgx1_lineTo (uint8_t x, uint8_t y)
void bgx1_termClear ()
void bgx1_termGoto (uint8_t col, uint8_t row)
void bgx1_termScroll (int8_t lines)
void bgx1_termPrint (const char *text)
void bgx1_termPrint_P (PGM_P text)
void bgx1_syncPort ()
uint16_t bgx1_getAnalog (uint8_t index)
void bgx1_syncInterface ()
void bgx1_setIllumination (uint16_t illu)

Variablen

uint8_t bgx1_DDR
uint8_t bgx1_PORT
uint8_t bgx1_PIN
uint8_t bgx1_Leds
uint8_t bgx1_Keys

Ausführliche Beschreibung

Routinen zur Kommunikation mit der Display-Erweiterung BGX1 über I²C.

Autor:
Nils Springob (nils@nicai-systems.de)
Datum:
2010-03-28

Dokumentation der Funktionen

void bgx1_box ( uint8_t  width,
uint8_t  height 
)

Zeichnet ein Rechteck.

Parameter:
widthBreite
heightHöhe
void bgx1_drawBitmap ( uint8_t  width,
uint8_t  height,
const uint8_t  bitmap[] 
)

Gibt angegebene Bitmap an der aktuellen Grafikposition aus. Die bitmap befindet sich dabei im RAM

void bgx1_drawBitmap_P ( uint8_t  width,
uint8_t  height,
PGM_P  bitmap 
)

Gibt angegebene Bitmap an der aktuellen Grafikposition aus. Die bitmap befindet sich dabei im Flash

void bgx1_fillAll ( uint8_t  pattern)

Fulle gesamten Bildschirm mit angegebener Bitfolge

Parameter:
valBitmaske
uint16_t bgx1_getAnalog ( uint8_t  index)

Der analoge Eingang wird gemessen und der Wert zurückgeliefert.

uint8_t bgx1_getStatus ( )

Liefert die Statusvariable zurück.

Rückgabe:
0xff nach dem Einschalten, 0x00 nach dem Reset, ansonsten der Wert, der mit bgx1_setStatus gesetzt wurde.
uint16_t bgx1_getVersion ( )

Liefert die aktuelle Software-Version zurück.

void bgx1_hLine ( uint8_t  length)

Zeichnet eine horizontale Linie von der aktuellen Position nach rechts

Parameter:
lengthLänge der Linie
uint8_t bgx1_init ( )

Initialisierung des BGX1 Ruft bei Bedarf i2c_init() auf.

Rückgabe:
0 im Fehlerfall
void bgx1_lineTo ( uint8_t  x,
uint8_t  y 
)

Zeichnet eine Linie zur angegebenen Position.

Parameter:
xX-Position des Zielpunktes (0..127)
yY-Position des Zielpunktes (0..63)
void bgx1_mode ( uint8_t  mode)

Wählt den Grafikmodus

Parameter:
modeGrafikmodus
void bgx1_move ( uint8_t  x,
uint8_t  y 
)

Setzt Grafikcursor auf angegebene Position

Parameter:
xX-Position des Cursors (0..127)
yY-Position des Cursors (0..63)
void bgx1_print ( const char *  text)

Gibt angegebenen Nullterminierten String an der aktuellen Grafikposition aus.

Parameter:
txtNullterminierter String im RAM
void bgx1_print_P ( const char *  text)

Gibt angegebenen Nullterminierten String an der aktuellen Grafikposition aus.

Parameter:
txtNullterminierter String im FLASH
void bgx1_reset ( )

Setzt das Display zurück.

void bgx1_selectFont ( uint8_t  font)

Wählt die Schriftart.

Parameter:
font0=fix, 1=Proportional
void bgx1_setIllumination ( uint16_t  illu)

Wert für Displaybeleuchtung setzen

Parameter:
lightHelligkeit (0..1024)
void bgx1_setStatus ( uint8_t  )

Setzt die Statusvariable.

void bgx1_syncInterface ( )

Synchronisert Leds und Keys. Die Variablen bgx1_Leds und bgx1_Keys werden mit dem BGX1 synchronisisert.

void bgx1_syncPort ( )

Synchronisiert Port Bits. Die Variablen bgx1_DDR, bgx1_PORT und bgx1_PIN werden mit dem Registern des BGX1 synchronisisert.

void bgx1_termClear ( )

Löscht den Bildschirm und setzt den Terminal-Cursor an die Position (0/0).

void bgx1_termGoto ( uint8_t  col,
uint8_t  row 
)

Setzt den Terminal-Cursor an die angegebene Position.

Parameter:
colSpalte
colZeile
void bgx1_termPrint ( const char *  text)

Gibt den Text im Terminal-Modus aus.

Parameter:
textNullterminierter String im RAM
void bgx1_termPrint_P ( PGM_P  text)

Gibt den Text im Terminal-Modus aus.

Parameter:
textNullterminierter String im FLASH
void bgx1_termScroll ( int8_t  lines)

Scrollt den Bildschirm um die angegebene Zeilenanzahl.

Parameter:
linesAnzahl der Zeilen
uint8_t bgx1_textWidth ( const char *  text)

Liefert Breite in Pixeln für Nullterminierten String

Parameter:
txtNullterminierter String im RAM
Rückgabe:
Breite in Pixeln
uint8_t bgx1_textWidth_P ( const char *  text)

Liefert Breite in Pixeln für Nullterminierten String

Parameter:
txtNullterminierter String im FLASH
Rückgabe:
Breite in Pixeln
void bgx1_vLine ( uint8_t  length)

Zeichnet eine vertikale Linie von der aktuellen Position nach unten

Parameter:
lengthLänge der Linie

Variablen-Dokumentation

uint8_t bgx1_DDR

DDR Register des Erweiterungsports am BGX1, wird durch bgx1_syncPort() an das BGX1 weitergeleitet.

uint8_t bgx1_Keys

Keys Register des BGX1, wird durch bgx1_syncInterface() mit dem Wert des BGX1 aktualisiert.

uint8_t bgx1_Leds

Leds Register des BGX1, wird durch bgx1_syncInterface() an das BGX1 weitergeleitet.

uint8_t bgx1_PIN

PIN Register des Erweiterungsports am BGX1, wird durch bgx1_syncPort() mit dem Wert des BGX1 aktualisiert.

uint8_t bgx1_PORT

PORT Register des Erweiterungsports am BGX1, wird durch bgx1_syncPort() an das BGX1 weitergeleitet.


Erzeugt am Fre Jun 3 2011 16:39:44 für NIBObee Library von doxygen 1.7.4-20110426