Digital Power Starter Kit 3 Firmware
dsPIC33C Buck Converter Voltage Mode Control Example

Public functions of the LC display device driver library. More...

+ Collaboration diagram for Public Functions:

Functions

void dev_Lcd_Initialize (void)
 Initializes the LCD Device. More...
 
void dev_Lcd_Clear (void)
 Clears the LC Display Screen. More...
 
void dev_Lcd_GotoXY (volatile uint8_t x, volatile uint8_t y)
 Sets the cursor position to the given x- and y-coordinates. More...
 
void dev_Lcd_WriteChar (const char ch)
 Writes a character on the LCD screen. More...
 
void dev_Lcd_WriteString (const char *str)
 Writes a complete string on the LCD screen. More...
 
void dev_Lcd_WriteStringXY (volatile uint8_t column_index, volatile uint8_t line_index, const char *str)
 Sets the cursor position to the given x- and y-coordinates and writes the given string on the lcd screen. More...
 

Detailed Description

Public functions of the LC display device driver library.

This is the detailed description of public API functions of the LC display device driver library.

Function Documentation

◆ dev_Lcd_Clear()

void dev_Lcd_Clear ( void  )

Clears the LC Display Screen.

Parameters
void
Returns
void This function clears the LCD screen and sets the cursor position at 0,0 (left upper corner). Instead of calling this function, clearing the screen can also be achieved by sending the character '\f' within a string

Definition at line 166 of file dev_lcd.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dev_Lcd_GotoXY()

void dev_Lcd_GotoXY ( volatile uint8_t  x,
volatile uint8_t  y 
)

Sets the cursor position to the given x- and y-coordinates.

Parameters
xx-coordinate for the new cursor position starting with zero
yy-coordinate for the new cursor position starting with zero
Returns
void This function sets the cursor position to the given x- and y-coordinates starting at (0, 0) in the upper left corner.

Definition at line 184 of file dev_lcd.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dev_Lcd_Initialize()

void dev_Lcd_Initialize ( void  )

Initializes the LCD Device.

Parameters
void
Returns
void This function initializes the LCD Device Driver. It needs to be called once at boot-up before that device can be used.

Definition at line 126 of file dev_lcd.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dev_Lcd_WriteChar()

void dev_Lcd_WriteChar ( const char  ch)

Writes a character on the LCD screen.

Parameters
chcharacter be written to the LCD screen
Returns
void This function writes the single character 'ch' to the currently selected position on LCD screen. The following special characters will result in a specific response of the LCD:
  • Character '\f' clears the screen and positions the cursor on the upper left corner
  • Character '\r' sets the x position of the cursor to 0
  • Character '
    ' puts the cursor on the next line (without changing the x-position)

Definition at line 209 of file dev_lcd.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dev_Lcd_WriteString()

void dev_Lcd_WriteString ( const char *  str)

Writes a complete string on the LCD screen.

Parameters
strPointer to a string variable to be written on the LCD screen
Returns
void This function writes a complete string 'str' to the currently selected position on LCD screen. If the length of the string exceeds the available number display digits, the position will overrun and start again from position (0, 0).

The following special characters within the string will result in a specific response of the LCD:

  • Character '\f' clears the screen and positions the cursor on the upper left corner
  • Character '\r' sets the x position of the cursor to 0
  • Character '
    ' puts the cursor on the next line (without changing the x-position)

Definition at line 272 of file dev_lcd.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dev_Lcd_WriteStringXY()

void dev_Lcd_WriteStringXY ( volatile uint8_t  column_index,
volatile uint8_t  line_index,
const char *  str 
)

Sets the cursor position to the given x- and y-coordinates and writes the given string on the lcd screen.

Parameters
column_indexx-coordinates for the new cursor position starting with zero
line_indexy-coordinates for the new cursor position starting with zero
strpointer to a string variable to be written on the LCD screen
Returns
void This function positions the cursor at the location defined by parameters x and y and writes a complete string 'str' to the newly selected position on LCD screen. If the length of the string exceeds the available number display digits, the position will overrun and start again from position (0, 0) in the upper left corner.

The following special characters within the string will result in a specific response of the LCD:

  • Character '\f' clears the screen and positions the cursor on the upper left corner
  • Character '\r' sets the x position of the cursor to 0
  • Character '
    ' puts the cursor on the next line (without changing the x-position)

Definition at line 305 of file dev_lcd.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function: