hel_lcd.h File Reference

Board Support LCD for microcontroller STM32. More...

Go to the source code of this file.

Data Structures
struct	_LCD_HandleTypeDef
	Struct for LCD HANDLER. More...

Macros
#define	LCD_OFF   0u
#define	LCD_ON   1u
#define	LCD_TOGGLE   2u
#define	ONE_MILISECOND   1u
#define	CLEAR_SCREEN   0
#define	ENTRY_MODE   1
#define	DISPLAY_ON   2
#define	INTERNAL_OSC_FREQUENCY   3
#define	WAKE_UP   4
#define	FUNCION_SET   5
#define	POWER_CONTROL   6
#define	FOLLOWER_CONTROL   7
#define	CONSTRAST   8

Typedefs
typedef struct _LCD_HandleTypeDef	LCD_HandleTypeDef
	Struct for LCD HANDLER.

Functions
uint8_t	HEL_LCD_Init (LCD_HandleTypeDef *hlcd)
	Function to initialize the LCD.
void	HEL_LCD_MspInit (LCD_HandleTypeDef *hlcd)
	Sub-initialization interface for the pins used by the LCD.
uint8_t	HEL_LCD_Command (LCD_HandleTypeDef *hlcd, uint8_t cmd)
	Function to send a command to the LCD.
uint8_t	HEL_LCD_Data (LCD_HandleTypeDef *hlcd, uint8_t data)
	Function to send a character to be displayed on the LCD using the SPI.
uint8_t	HEL_LCD_String (LCD_HandleTypeDef *hlcd, char *str)
	Function to send a string of characters to the LCD.
uint8_t	HEL_LCD_SetCursor (LCD_HandleTypeDef *hlcd, uint8_t row, uint8_t col)
	Function to locate the LCD cursor.
void	HEL_LCD_Backlight (LCD_HandleTypeDef *hlcd, uint8_t state)
	Function to control the LCD backlight.
uint8_t	HEL_LCD_Contrast (LCD_HandleTypeDef *hlcd, uint8_t contrast)
	Function to control the contrast level of the LCD.

Detailed Description

Board Support LCD for microcontroller STM32.

File provides the neccesary drivers, libraries, and configurations for the LCD.

Macro Definition Documentation

CLEAR_SCREEN

#define CLEAR_SCREEN   0

Brief description

CONSTRAST

#define CONSTRAST   8

Brief description

DISPLAY_ON

#define DISPLAY_ON   2

Brief description

ENTRY_MODE

#define ENTRY_MODE   1

Brief description

FOLLOWER_CONTROL

#define FOLLOWER_CONTROL   7

Brief description

FUNCION_SET

#define FUNCION_SET   5

Brief description

INTERNAL_OSC_FREQUENCY

#define INTERNAL_OSC_FREQUENCY   3

Brief description

ONE_MILISECOND

#define ONE_MILISECOND   1u

Brief description

POWER_CONTROL

#define POWER_CONTROL   6

Brief description

WAKE_UP

#define WAKE_UP   4

Brief description

Function Documentation

HEL_LCD_Backlight()

void HEL_LCD_Backlight ( LCD_HandleTypeDef * hlcd, uint8_t state )

extern

Function to control the LCD backlight.

Parameters

[out]	hlcd	LCD Handler.
[in]	state	Describe the intensity.

< Brief description

< Brief description

< Brief description

HEL_LCD_Command()

uint8_t HEL_LCD_Command ( LCD_HandleTypeDef * hlcd, uint8_t cmd )

extern

Function to send a command to the LCD.

The function must wait as long as necessary for the command to be accepted by the LCD .

Parameters

[out]	hlcd	LCD Handler.
[in]	cmd	8-bit Command.

Return values

value

Returns an indication of a successful operation or not.

< Brief description

HEL_LCD_Contrast()

uint8_t HEL_LCD_Contrast ( LCD_HandleTypeDef * hlcd, uint8_t contrast )

extern

Function to control the contrast level of the LCD.

Parameters

[out]	hlcd	LCD Handler.
[in]	contrast	Describe the contrast, 0 to 63.

Return values

value

Returns an indication of a successful operation or not.

HEL_LCD_Data()

uint8_t HEL_LCD_Data ( LCD_HandleTypeDef * hlcd, uint8_t data )

extern

Function to send a character to be displayed on the LCD using the SPI.

Parameters

[out]	hlcd	LCD Handler.
[in]	data	8-bit Command.

Return values

value

Returns an indication of a successful operation or not.

< Brief description

HEL_LCD_Init()

uint8_t HEL_LCD_Init ( LCD_HandleTypeDef * hlcd )

extern

Function to initialize the LCD.

Commands to sent for SPI communication between the LCD and the microcontroller.

Parameters

[in]

hlcd

Pointer to Lcd handler.

Return values

value

Returns an indication of a successful operation or not.

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

< Brief description

HEL_LCD_MspInit()

void HEL_LCD_MspInit ( LCD_HandleTypeDef * hlcd )

extern

Sub-initialization interface for the pins used by the LCD.

Parameters

[out]

hlcd

LCD Handler.

HEL_LCD_SetCursor()

uint8_t HEL_LCD_SetCursor ( LCD_HandleTypeDef * hlcd, uint8_t row, uint8_t col )

extern

Function to locate the LCD cursor.

Parameters

[out]	hlcd	LCD Handler.
[in]	row	Value 0 to 1.
[in]	col	Value 0 to 15.

Return values

value

Returns an indication of a successful operation or not.

HEL_LCD_String()

uint8_t HEL_LCD_String ( LCD_HandleTypeDef * hlcd, char * str )

extern

Function to send a string of characters to the LCD.

Parameters

[out]	hlcd	LCD Handler.
[out]	str	String.

Return values

value

Returns an indication of a successful operation or not.