STM32091C_EVAL BSP User Manual: Exported Functions

STM32091C EVAL BSP Drivers

STM32091C_EVAL BSP User Manual
Exported Functions

Functions

uint8_t BSP_LCD_Init (void)
 Initializes the LCD.
uint32_t BSP_LCD_GetXSize (void)
 Gets the LCD X size.
uint32_t BSP_LCD_GetYSize (void)
 Gets the LCD Y size.
uint16_t BSP_LCD_GetTextColor (void)
 Gets the LCD text color.
uint16_t BSP_LCD_GetBackColor (void)
 Gets the LCD background color.
void BSP_LCD_SetTextColor (uint16_t Color)
 Sets the LCD text color.
void BSP_LCD_SetBackColor (uint16_t Color)
 Sets the LCD background color.
void BSP_LCD_SetFont (sFONT *pFonts)
 Sets the LCD text font.
sFONT * BSP_LCD_GetFont (void)
 Gets the LCD text font.
void BSP_LCD_Clear (uint16_t Color)
 Clears the hole LCD.
void BSP_LCD_ClearStringLine (uint16_t Line)
 Clears the selected line.
void BSP_LCD_DisplayChar (uint16_t Xpos, uint16_t Ypos, uint8_t Ascii)
 Displays one character.
void BSP_LCD_DisplayStringAt (uint16_t Xpos, uint16_t Ypos, uint8_t *pText, Line_ModeTypdef Mode)
 Displays characters on the LCD.
void BSP_LCD_DisplayStringAtLine (uint16_t Line, uint8_t *pText)
 Displays a character on the LCD.
uint16_t BSP_LCD_ReadPixel (uint16_t Xpos, uint16_t Ypos)
 Reads an LCD pixel.
void BSP_LCD_DrawHLine (uint16_t Xpos, uint16_t Ypos, uint16_t Length)
 Draws an horizontal line.
void BSP_LCD_DrawVLine (uint16_t Xpos, uint16_t Ypos, uint16_t Length)
 Draws a vertical line.
void BSP_LCD_DrawLine (uint16_t X1, uint16_t Y1, uint16_t X2, uint16_t Y2)
 Draws an uni-line (between two points).
void BSP_LCD_DrawRect (uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height)
 Draws a rectangle.
void BSP_LCD_DrawCircle (uint16_t Xpos, uint16_t Ypos, uint16_t Radius)
 Draws a circle.
void BSP_LCD_DrawPolygon (pPoint pPoints, uint16_t PointCount)
 Draws an poly-line (between many points).
void BSP_LCD_DrawEllipse (int Xpos, int Ypos, int XRadius, int YRadius)
 Draws an ellipse on LCD.
void BSP_LCD_DrawBitmap (uint16_t Xpos, uint16_t Ypos, uint8_t *pBmp)
 Draws a bitmap picture loaded in the internal Flash (32 bpp).
void BSP_LCD_FillRect (uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height)
 Draws a full rectangle.
void BSP_LCD_FillCircle (uint16_t Xpos, uint16_t Ypos, uint16_t Radius)
 Draws a full circle.
void BSP_LCD_FillEllipse (int Xpos, int Ypos, int XRadius, int YRadius)
 Draws a full ellipse.
void BSP_LCD_DisplayOn (void)
 Enables the display.
void BSP_LCD_DisplayOff (void)
 Disables the display.
void BSP_LCD_DrawPixel (uint16_t Xpos, uint16_t Ypos, uint16_t RGBCode)
 Draws a pixel on LCD.
void BSP_LCD_SetTextColor (__IO uint16_t Color)
void BSP_LCD_SetBackColor (__IO uint16_t Color)

Function Documentation

void BSP_LCD_Clear ( uint16_t  Color)

Clears the hole LCD.

Parameters:
ColorColor of the background
Return values:
None

Definition at line 248 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawHLine(), BSP_LCD_GetXSize(), BSP_LCD_GetYSize(), BSP_LCD_SetTextColor(), and LCD_DrawPropTypeDef::TextColor.

void BSP_LCD_ClearStringLine ( uint16_t  Line)

Clears the selected line.

Parameters:
LineLine to be cleared This parameter can be one of the following values:
  • 0..9: if the Current fonts is Font16x24
  • 0..19: if the Current fonts is Font12x12 or Font8x12
  • 0..29: if the Current fonts is Font8x8
Return values:
None

Definition at line 273 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::BackColor, BSP_LCD_FillRect(), BSP_LCD_GetXSize(), BSP_LCD_SetTextColor(), LCD_DrawPropTypeDef::pFont, and LCD_DrawPropTypeDef::TextColor.

void BSP_LCD_DisplayChar ( uint16_t  Xpos,
uint16_t  Ypos,
uint8_t  Ascii 
)

Displays one character.

Parameters:
XposStart column address
YposLine where to display the character shape.
AsciiCharacter ascii code This parameter must be a number between Min_Data = 0x20 and Max_Data = 0x7E
Return values:
None

Definition at line 293 of file stm32091c_eval_lcd.c.

References LCD_DrawChar(), and LCD_DrawPropTypeDef::pFont.

Referenced by BSP_LCD_DisplayStringAt().

void BSP_LCD_DisplayOff ( void  )

Disables the display.

Return values:
None

Definition at line 798 of file stm32091c_eval_lcd.c.

References lcd_drv.

void BSP_LCD_DisplayOn ( void  )

Enables the display.

Return values:
None

Definition at line 789 of file stm32091c_eval_lcd.c.

References lcd_drv.

void BSP_LCD_DisplayStringAt ( uint16_t  Xpos,
uint16_t  Ypos,
uint8_t *  pText,
Line_ModeTypdef  Mode 
)

Displays characters on the LCD.

Parameters:
XposX position (in pixel)
YposY position (in pixel)
pTextPointer to string to display on LCD
ModeDisplay mode This parameter can be one of the following values:
  • CENTER_MODE
  • RIGHT_MODE
  • LEFT_MODE
Return values:
None

Definition at line 311 of file stm32091c_eval_lcd.c.

References BSP_LCD_DisplayChar(), BSP_LCD_GetXSize(), CENTER_MODE, LEFT_MODE, LCD_DrawPropTypeDef::pFont, and RIGHT_MODE.

Referenced by BSP_LCD_DisplayStringAtLine().

void BSP_LCD_DisplayStringAtLine ( uint16_t  Line,
uint8_t *  pText 
)

Displays a character on the LCD.

Parameters:
LineLine where to display the character shape This parameter can be one of the following values:
  • 0..9: if the Current fonts is Font16x24
  • 0..19: if the Current fonts is Font12x12 or Font8x12
  • 0..29: if the Current fonts is Font8x8
pTextPointer to string to display on LCD
Return values:
None

Definition at line 370 of file stm32091c_eval_lcd.c.

References BSP_LCD_DisplayStringAt(), and LEFT_MODE.

void BSP_LCD_DrawBitmap ( uint16_t  Xpos,
uint16_t  Ypos,
uint8_t *  pBmp 
)

Draws a bitmap picture loaded in the internal Flash (32 bpp).

Parameters:
XposBmp X position in the LCD
YposBmp Y position in the LCD
pBmpPointer to Bmp picture address in the internal Flash
Return values:
None

Definition at line 656 of file stm32091c_eval_lcd.c.

References BSP_LCD_GetXSize(), BSP_LCD_GetYSize(), lcd_drv, and LCD_SetDisplayWindow().

Referenced by LCD_DrawChar().

void BSP_LCD_DrawCircle ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  Radius 
)

Draws a circle.

Parameters:
XposX position
YposY position
RadiusCircle radius
Return values:
None

Definition at line 544 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawPixel(), BSP_LCD_SetFont(), LCD_DEFAULT_FONT, and LCD_DrawPropTypeDef::TextColor.

Referenced by BSP_LCD_FillCircle().

void BSP_LCD_DrawEllipse ( int  Xpos,
int  Ypos,
int  XRadius,
int  YRadius 
)

Draws an ellipse on LCD.

Parameters:
XposX position
YposY position
XRadiusEllipse X radius
YRadiusEllipse Y radius
Return values:
None

Definition at line 623 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawPixel(), and LCD_DrawPropTypeDef::TextColor.

void BSP_LCD_DrawHLine ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  Length 
)

Draws an horizontal line.

Parameters:
XposX position
YposY position
LengthLine length
Return values:
None

Definition at line 400 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawPixel(), lcd_drv, and LCD_DrawPropTypeDef::TextColor.

Referenced by BSP_LCD_Clear(), BSP_LCD_DrawRect(), and BSP_LCD_FillRect().

void BSP_LCD_DrawLine ( uint16_t  X1,
uint16_t  Y1,
uint16_t  X2,
uint16_t  Y2 
)

Draws an uni-line (between two points).

Parameters:
X1Point 1 X position
Y1Point 1 Y position
X2Point 2 X position
Y2Point 2 Y position
Return values:
None

Definition at line 451 of file stm32091c_eval_lcd.c.

References ABS, BSP_LCD_DrawPixel(), and LCD_DrawPropTypeDef::TextColor.

Referenced by BSP_LCD_DrawPolygon().

void BSP_LCD_DrawPixel ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  RGBCode 
)

Draws a pixel on LCD.

Parameters:
XposX position
YposY position
RGBCodePixel color in RGB mode (5-6-5)
Return values:
None

Definition at line 810 of file stm32091c_eval_lcd.c.

References lcd_drv.

Referenced by BSP_LCD_DrawCircle(), BSP_LCD_DrawEllipse(), BSP_LCD_DrawHLine(), BSP_LCD_DrawLine(), and BSP_LCD_DrawVLine().

void BSP_LCD_DrawPolygon ( pPoint  pPoints,
uint16_t  PointCount 
)

Draws an poly-line (between many points).

Parameters:
pPointsPointer to the points array
PointCountNumber of points
Return values:
None

Definition at line 594 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawLine(), Point::X, and Point::Y.

void BSP_LCD_DrawRect ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  Width,
uint16_t  Height 
)

Draws a rectangle.

Parameters:
XposX position
YposY position
WidthRectangle width
HeightRectangle height
Return values:
None

Definition at line 526 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawHLine(), and BSP_LCD_DrawVLine().

void BSP_LCD_DrawVLine ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  Length 
)

Draws a vertical line.

Parameters:
XposX position
YposY position
LengthLine length
Return values:
None

Definition at line 424 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawPixel(), BSP_LCD_GetXSize(), BSP_LCD_GetYSize(), lcd_drv, LCD_SetDisplayWindow(), and LCD_DrawPropTypeDef::TextColor.

Referenced by BSP_LCD_DrawRect(), BSP_LCD_FillCircle(), and BSP_LCD_FillEllipse().

void BSP_LCD_FillCircle ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  Radius 
)

Draws a full circle.

Parameters:
XposX position
YposY position
RadiusCircle radius
Return values:
None

Definition at line 709 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawCircle(), BSP_LCD_DrawVLine(), BSP_LCD_SetTextColor(), and LCD_DrawPropTypeDef::TextColor.

void BSP_LCD_FillEllipse ( int  Xpos,
int  Ypos,
int  XRadius,
int  YRadius 
)

Draws a full ellipse.

Parameters:
XposX position
YposY position
XRadiusEllipse X radius
YRadiusEllipse Y radius
Return values:
None

Definition at line 759 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawVLine().

void BSP_LCD_FillRect ( uint16_t  Xpos,
uint16_t  Ypos,
uint16_t  Width,
uint16_t  Height 
)

Draws a full rectangle.

Parameters:
XposX position
YposY position
WidthRectangle width
HeightRectangle height
Return values:
None

Definition at line 692 of file stm32091c_eval_lcd.c.

References BSP_LCD_DrawHLine(), BSP_LCD_SetTextColor(), and LCD_DrawPropTypeDef::TextColor.

Referenced by BSP_LCD_ClearStringLine().

uint16_t BSP_LCD_GetBackColor ( void  )

Gets the LCD background color.

Return values:
Usedbackground color

Definition at line 199 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::BackColor.

sFONT * BSP_LCD_GetFont ( void  )

Gets the LCD text font.

Return values:
Usedfont

Definition at line 238 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::pFont.

uint16_t BSP_LCD_GetTextColor ( void  )

Gets the LCD text color.

Return values:
Usedtext color.

Definition at line 190 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::TextColor.

uint32_t BSP_LCD_GetXSize ( void  )

Gets the LCD X size.

Return values:
UsedLCD X size

Definition at line 172 of file stm32091c_eval_lcd.c.

References lcd_drv.

Referenced by BSP_LCD_Clear(), BSP_LCD_ClearStringLine(), BSP_LCD_DisplayStringAt(), BSP_LCD_DrawBitmap(), and BSP_LCD_DrawVLine().

uint32_t BSP_LCD_GetYSize ( void  )

Gets the LCD Y size.

Return values:
UsedLCD Y size

Definition at line 181 of file stm32091c_eval_lcd.c.

References lcd_drv.

Referenced by BSP_LCD_Clear(), BSP_LCD_DrawBitmap(), and BSP_LCD_DrawVLine().

uint8_t BSP_LCD_Init ( void  )
uint16_t BSP_LCD_ReadPixel ( uint16_t  Xpos,
uint16_t  Ypos 
)

Reads an LCD pixel.

Parameters:
XposX position
YposY position
Return values:
RGBpixel color

Definition at line 381 of file stm32091c_eval_lcd.c.

References lcd_drv.

void BSP_LCD_SetBackColor ( __IO uint16_t  Color)
void BSP_LCD_SetBackColor ( uint16_t  Color)

Sets the LCD background color.

Parameters:
ColorBackground color code RGB(5-6-5)
Return values:
None

Definition at line 219 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::BackColor.

void BSP_LCD_SetFont ( sFONT *  pFonts)

Sets the LCD text font.

Parameters:
pFontsFont to be used
Return values:
None

Definition at line 229 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::pFont.

Referenced by BSP_LCD_DrawCircle(), and BSP_LCD_Init().

void BSP_LCD_SetTextColor ( __IO uint16_t  Color)
void BSP_LCD_SetTextColor ( uint16_t  Color)

Sets the LCD text color.

Parameters:
ColorText color code RGB(5-6-5)
Return values:
None

Definition at line 209 of file stm32091c_eval_lcd.c.

References LCD_DrawPropTypeDef::TextColor.

Referenced by BSP_LCD_Clear(), BSP_LCD_ClearStringLine(), BSP_LCD_FillCircle(), and BSP_LCD_FillRect().

Generated on Wed Jul 5 2017 09:21:50 for STM32091C_EVAL BSP User Manual by   doxygen 1.7.6.1