Description détaillée

Ce module permet de gérer un afficheur LCD alphanumérique.
Le développement de ce module a été fait de façon modulaire en séparant l'interface vers l'afficheur et le contrôleur graphique utilisé par l'afficheur (les 2 objets, interface et contrôleur sont complétement indépendants).
Les contrôleurs graphiques pris en charge sont :

HD44780
PCF2119
ST7032

Les interfaces prises en charge sont :

Port parallèle AVR, données sur 4 bits
Port parallèle AVR, données sur 8 bits
Interface I2C avec PCF8574 relie à un afficheur parallèle (4 bits)
Interface I2C standard (Octet de contrôle RS, CO)

Le module peut être configuré facilement grâce au fichier avrio-board-lcd.h et peut evoluer aussi facilement grâce à sa stucture clairement découpée.

Graphe de collaboration de LCD alphanumérique:

Modules
	Contrôleur graphique

	Interface matérielle

	Rétroéclairage

Structures de données
struct	xLcdPos
	Coordonnées d'un point ou d'un caractère. Plus de détails...

Fonctions
int8_t	iLcdInit (void)
	Initialise le module LCD. Plus de détails...

uint8_t	ucLcdBacklightSet (uint8_t ucLevel)
	Réglage de la luminosité du rétro-éclairage. Plus de détails...

uint8_t	ucLcdContrastSet (uint8_t ucContrast)
	Réglage du constraste de l'afficheur. Plus de détails...

void	vLcdBargraph (uint16_t uValue, uint16_t uMax, xLcdCoord uWidth)
	Affiche ou mets à jour un bargraph. Plus de détails...

void	vLcdBargraphInit (const uint8_t *pucBarPatterns)
	Initialise un bargraph à la position courante. Plus de détails...

void	vLcdClear (void)
	Effacement de l'afficheur et retour du curseur à l'origine.

void	vLcdClearChars (xLcdCoord xX, xLcdCoord xY, uint8_t uLen)
	Efface les caractères. Plus de détails...

void	vLcdClearCurrentLine (void)
	Efface seulement la ligne du curseur.

void	vLcdClearLine (xLcdCoord xY)
	Efface une ligne.

void	vLcdEnableCursor (eLcdCursor eCursor)
	Modifie l'affichage du curseur. Plus de détails...

void	vLcdGotoXY (xLcdCoord xX, xLcdCoord xY)
	Changement de la position courante. Plus de détails...

void	vLcdPutChar (char cChar)
	Affiche un caractère sur le LCD. Plus de détails...

void	vLcdPutString (const char *pcString)
	Affiche une chaîne caractères sur le LCD. Plus de détails...

void	vLcdSetIcon (uint8_t ucCode, const uint8_t *pucIconPattern)
	Chargement d'un caractère personnalisé en CGRAM. Plus de détails...

xLcdCoord	xLcdGetX (void)
	Lecture de la colonne du curseur.

xLcdCoord	xLcdGetY (void)

xLcdCoord	xLcdHeight (void)
	Nombre de lignes.

xLcdCoord	xLcdWidth (void)
	Nombre de colonnes du LCD.

Définitions de type
typedef uint8_t	xLcdCoord
	Coordonnée d'un point ou d'un caractère.

typedef struct xLcdPos	xLcdPos

Énumérations
enum	eLcdCursor { LCD_CURSOR_NONE = 0, LCD_CURSOR_UNDERSCORE = 0x02, LCD_CURSOR_BLINK = 0x03 }
	Constantes utilisées pour spécifier le type de curseur à vLcdEnableCursor() Plus de détails...

Variables
FILE	xLcd
	Descripteur de fichier du LCD permettant son utilisation avec les fonctions de la libc. Plus de détails...

Documentation du type de l'énumération

enum eLcdCursor

Constantes utilisées pour spécifier le type de curseur à vLcdEnableCursor()

Valeurs énumérées
LCD_CURSOR_NONE	Pas de curseur affiché (défaut)
LCD_CURSOR_UNDERSCORE	Curseur souligné
LCD_CURSOR_BLINK	Curseur clignotant

Définition à la ligne 41 du fichier lcd_defs.h.

               {
 
   LCD_CURSOR_NONE = 0,          
   LCD_CURSOR_UNDERSCORE = 0x02, 
   LCD_CURSOR_BLINK = 0x03       
 } eLcdCursor;

Documentation des fonctions

int8_t iLcdInit ( void )

Initialise le module LCD.

Initialise l'ensemble des éléments nécessaires au fonctionnement de l'afficheur, règle le contraste à mi-course (16) et efface l'écran.

Renvoie: 0 succès, une valeur négative si erreur.

Exemples:: lcd/demo_lcd.c, et sensor/mq135/demo/demo_sensor_mq135.c.

uint8_t ucLcdBacklightSet ( uint8_t ucLevel )

Réglage de la luminosité du rétro-éclairage.

Paramètres

ucLevel La luminosité entre 0 et 63

Renvoie: La valeur effectivement réglée

Exemples:: sensor/mq135/demo/demo_sensor_mq135.c.

uint8_t ucLcdContrastSet ( uint8_t ucContrast )

Réglage du constraste de l'afficheur.

Paramètres

ucContrast Le contraste entre 0 et 31

Renvoie: La valeur effectivement réglée

Exemples:: sensor/mq135/demo/demo_sensor_mq135.c.

void vLcdBargraph	(	uint16_t	uValue,
		uint16_t	uMax,
		xLcdCoord	uWidth
	)

Affiche ou mets à jour un bargraph.

Paramètres

uValue	Valeur à afficher entre 0 et `uMax`
uMax	Valeur max de la barre correspondant à 100 %
uWidth	Longueur de la barre en nombre de caractères

Note: La fonction vLcdCtrlSetIcon() doit être prise en charge par le contrôleur du LCD.

void vLcdBargraphInit ( const uint8_t * pucBarPatterns )

Initialise un bargraph à la position courante.

Paramètres

pucBarPatterns Pointeur sur un tableau de patterns en mémoire FLASH permettant d'afficher un bloc de largeur 0 à LCD_PATTERN_WIDTH+1

void vLcdClearChars	(	xLcdCoord	xX,
		xLcdCoord	xY,
		uint8_t	uLen
	)

Efface les caractères.

Paramètres

xX	colonne du premier caractère
xY	ligne du premier caractère
uLen	de caractères à effacer

Note: Après l'effacement le curseur est repositionner en (xX, xY)

void vLcdEnableCursor ( eLcdCursor eCursor )

Modifie l'affichage du curseur.

Paramètres

eCursor Type de curseur à afficher

Note: Cette fonction ne fait rien si l'afficheur ne dispose pas de cette fonctionnalité.

void vLcdGotoXY	(	xLcdCoord	xX,
		xLcdCoord	xY
	)

Changement de la position courante.

Paramètres

xX	valeur de la colonne (0 pour la colonne de gauche)
xY	valeur de la ligne (0 pour la ligne du haut)

Exemples:: lcd/demo_lcd.c.

void vLcdPutChar ( char cChar )

Affiche un caractère sur le LCD.

Cette fonction prend en charge les caractères CR/LF et les sauts de lignes automatiques

Paramètres

cChar caractère ASCII (code étendu non pris en charge)

Note: Pour les affichages complexes, il peut être plus interessant d'utiliser les fonctions de la libc (putc, puts, printf, fprintf ... )

void vLcdPutString ( const char * pcString )

Affiche une chaîne caractères sur le LCD.

Paramètres

pcString chaîne caractères

Note: Pour les affichages complexes, il peut être plus interessant d'utiliser les fonctions de la libc (puts, printf, fprintf ... )

void vLcdSetIcon	(	uint8_t	ucCode,
		const uint8_t *	pucIconPattern
	)

Chargement d'un caractère personnalisé en CGRAM.

Paramètres

ucCode	Code du caractère en CGRAM
pucIconPattern	Pointeur sur la matrice des points du caractère en mémoire FLASH

Note: Le contrôleur du LCD doit prendre en charge cette fonctionnalité.

xLcdCoord xLcdGetY ( void )

Lecture de la colonne du curseur

Documentation des variables

FILE xLcd

Descripteur de fichier du LCD permettant son utilisation avec les fonctions de la libc.

Pour utiliser le LCD comme sortie par défaut, on mettra au début du main() :

 int main(void) {
   iLcdInit ();
   stdout = &xLcd;
  ...

On pourra dans le cas contraire passer &xLcd à la fonction fprintf :

 int choix;
 ...
 fprintf (&xLcd, "Choix ? ");
 ...

Exemples:: lcd/demo_lcd.c, et sensor/mq135/demo/demo_sensor_mq135.c.

Description détaillée

Modules

Structures de données

Fonctions

Définitions de type

Énumérations

Variables

Documentation du type de l'énumération

Documentation des fonctions

Documentation des variables