Display
EmbedUI class
Note
This the main class of the library. You need to create an instance of this class, before you go any further.
-
Use: To create an instance of the Main Class of the Library
-
Constructor:
EmbedUI(
HardwareSerial& serial
)
-
Parameters:
- HardwareSerial& serial : The Hardware Serial Port to use for communication with the host PC. ( Currently, only Hardware Serial Ports are supported )
-
Returns: EmbedUI Object
EmbedUI methods
begin
-
Use: To Initialize the UI Application functions
-
Constructor:
begin(
uint32_t baudrate
)
-
Parameters:
- uint32_t baudrate : The Baud Rate for Serial Communication
-
Returns: Nothing
clear
Note
This method only removes the Elements from the UI. The Added Fonts and Background properties stay same.
-
Use: To clear all the content in the UI
-
Constructor:
begin(
uint32_t baudrate
)
-
Parameters:
- uint32_t baudrate : The Baud Rate for Serial Communication
-
Returns: Nothing
void setDisplayBackgroundColor(uint32_t _color);
setDisplayBackgroundColor
-
Use: To the Background Color of the Display
-
Constructor:
setDisplayBackgroundColor(
uint32_t _color
)
-
Parameters:
- uint32_t _color : The background color of the Display ( you can use the color() function to apply RGB values directly )
-
Returns: Nothing
color
-
Use: To the generate a 24-bit color value using RGB 8-bit values
-
Constructor:
color(
uint8_t _r, uint8_t _g, uint8_t _b
)
-
Parameters:
- uint8_t _r : The Red Color value, among the RGB Values of a Color
- uint8_t _g : The Green Color value, among the RGB Values of a Color
- uint8_t _b : The Blue Color value, among the RGB Values of a Color
-
Returns: The Color value as an unsigned integer (uint32_t)