-
The product is a TFT display screen with I2C and UART interfaces. It has built-in firmware that integrates some LVGL controls and GDL graphics display. Additionally, it features an integrated GT30L24A3W font chip on the hardware, which supports language display for multiple countries. The firmware chip also includes a large number of commonly used icons.
Product Link（https://www.dfrobot.com）
SKU: DFR0997
Provides an arduino library to drive the display screen(DFR0997)
To use this library, please download the library file first, and paste it into the \Arduino\libraries directory, then open the examples folder and run the demo in the folder.
/**
* @fn begin
* @brief initialization function
* @return Boolean type, initialized state
* @retval true succeed
* @retval false failed
*/
bool begin();
/**
* @fn setBackgroundColor
* @brief Set the Background Color object
* @param bg_color Background Color(R,G,B)
*/
void setBackgroundColor(uint32_t bg_color = 0xFF0000);
/**
* @fn setBackgroundImg
* @brief Set the background image object
* @param location Built-in or external images
* @param str Picture path
*/
void setBackgroundImg(uint8_t location, String str);
/**
* @fn cleanScreen
* @brief Clear the screen to clear all control objects on the screen
*/
void cleanScreen();
/**
* @fn drawPixel
* @brief Draw pixels on the screen
* @param x The x coordinate of the pixel
* @param y The y coordinate of the pixel
* @param color the color of the pixel, RGB888 format
*/
void drawPixel(int16_t x, int16_t y, uint32_t color);
/**
* @fn drawLine
* @brief Draw a straight line on the screen.
* @param x0 Start X-coordinate of the line.
* @param y0 Start Y-coordinate of the line.
* @param x1 End X-coordinate of the line.
* @param y1 End Y-coordinate of the line.
* @param width line width
* @param color the color of the line, RGB888 format
* @return line control handle
*/
uint8_t drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint8_t width, uint32_t color);
/**
* @fn updateLine
* @brief Update a straight line on the screen.
* @param id Line control handle
* @param x0 Start X-coordinate of the line.
* @param y0 Start Y-coordinate of the line.
* @param x1 End X-coordinate of the line.
* @param y1 End Y-coordinate of the line.
* @param width line width
* @param color the color of the line, RGB888 format
*/
void updateLine(uint8_t id, int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint8_t width, uint32_t color);
/**
*
* @fn deleteLine
* @brief Delete line
* @param id line control handle
*/
void deleteLine(uint8_t id);
/**
* @fn drawRect
* @brief Draw rectangles on the screen
* @param x Start of rectangle x coordinate
* @param y Start of rectangle y coordinate
* @param w Width of a rectangle
* @param h Height of rectangle
* @param borderWidth border width
* @param borderColor border color
* @param fill fill
* @param fillColor fill color
* @param rounded rounded
* @return rect control handle
*
*/
uint8_t drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint8_t borderWidth, uint32_t borderColor, uint8_t fill, uint32_t fillColor, uint8_t rounded);
/**
* @fn updateRect
* @brief update rectangles on the screen
* @param id rectangles control handle
* @param x Start of rectangle x coordinate
* @param y Start of rectangle y coordinate
* @param w Width of a rectangle
* @param h Height of rectangle
* @param borderWidth border width
* @param borderColor border color
* @param fill fill
* @param fillColor fill color
* @param rounded rounded
*
*/
void updateRect(uint8_t id, int16_t x, int16_t y, int16_t w, int16_t h, uint8_t borderWidth, uint32_t borderColor, uint8_t fill, uint32_t fillColor, uint8_t rounded);
/**
*
* @fn deleteRect
* @brief Delete rectangles
* @param id rectangles control handle
*/
void deleteRect(uint8_t id);
/**
* @fn drawCircle
* @brief Draw circles on the screen
* @param x Center of the circle x coordinate
* @param y Center of the circle y coordinate
* @param r Radius of the circle
* @param borderWidth border width
* @param borderColor border Color
* @param fill fill
* @param fillColor fill color
* @return circle control handle
*/
uint8_t drawCircle(int16_t x, int16_t y, int16_t r, uint8_t borderWidth, uint32_t borderColor, uint8_t fill, uint32_t fillColor);
/**
* @fn updateCircle
* @brief Update circles on the screen
* @param id Circles control handle
* @param x Center of the circle x coordinate
* @param y Center of the circle y coordinate
* @param r Radius of the circle
* @param borderWidth border width
* @param borderColor border Color
* @param fill fill
* @param fillColor fill color
*/
void updateCircle(uint8_t id, int16_t x, int16_t y, int16_t r, uint8_t borderWidth, uint32_t borderColor, uint8_t fill, uint32_t fillColor);
/**
*
* @fn deleteCircle
* @brief Delete circles
* @param id circles control handle
*/
void deleteCircle(uint8_t id);
/**
* @fn drawTriangle
* @brief Draw a triangle on the screen
* @param x0 The x-coordinate of the first point of the triangle
* @param y0 The y-coordinate of the first point of the triangle
* @param x1 The x-coordinate of the second point of the triangle
* @param y1 The y-coordinate of the second point of the triangle
* @param x2 The x-coordinate of the third point of the triangle
* @param y2 The y-coordinate of the third point of the triangle
* @param borderWidth border width
* @param borderColor border color
* @param fill fill
* @param fillColor fill color
* @return triangle control handle
*/
uint8_t drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint8_t borderWidth, uint32_t borderColor, uint8_t fill, uint32_t fillColor);
/**
* @fn updateTriangle
* @brief Draw a triangle on the screen
* @param id triangle control handle
* @param x0 The x-coordinate of the first point of the triangle
* @param y0 The y-coordinate of the first point of the triangle
* @param x1 The x-coordinate of the second point of the triangle
* @param y1 The y-coordinate of the second point of the triangle
* @param x2 The x-coordinate of the third point of the triangle
* @param y2 The y-coordinate of the third point of the triangle
* @param borderWidth border width
* @param borderColor border color
* @param fill fill
* @param fillColor fill color
*/
void updateTriangle(uint8_t id, int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint8_t borderWidth, uint32_t borderColor, uint8_t fill, uint32_t fillColor);
/**
*
* @fn deleteTriangle
* @brief Delete Triangles
* @param id Triangle control handle
*/
void deleteTriangle(uint8_t id);
/**
* @fn drawIcon
* @brief Draw an icon
* @param x The x-coordinate of the first point of the icon
* @param y The y-coordinate of the first point of the icon
* @param iconNum The icon's corresponding number
* @param size Icon scaling factor
* @return Icon control handle
*/
uint8_t drawIcon(int16_t x, int16_t y, uint16_t iconNum, uint16_t size = 255);
/**
* @fn drawIcon
* @brief Draw the icon on the USB flash drive
* @param x The x-coordinate of the first point of the icon
* @param y The y-coordinate of the first point of the icon
* @param str Picture path
* @param zoom Icon scaling factor
* @return Icon control handle
*/
uint8_t drawIcon(int16_t x, int16_t y, String str, uint16_t zoom);
/**
* @fn setAngleIcon
* @brief Set the Angle of the icon
* @param id Icon control handle
* @param angle rotation angle
*/
void setAngleIcon(uint8_t id, int16_t angle);
/**
* @fn updateIcon
* @brief Update icon
* @param x The x-coordinate of the first point of the icon
* @param y The y-coordinate of the first point of the icon
* @param iconNum The icon's corresponding number
* @param size Icon scaling factor
*/
void updateIcon(uint8_t iconId, int16_t x, int16_t y, uint16_t iconNum, uint16_t size);
/**
* @fn updateIcon
* @brief Update icon
* @param x The x-coordinate of the first point of the icon
* @param y The y-coordinate of the first point of the icon
* @param str icon path
* @param zoom Icon scaling factor
*/
void updateIcon(uint8_t iconId, int16_t x, int16_t y, String str, uint16_t zoom);
/**
* @fn deleteIcon
* @brief Delete icon
* @param id Icon control handle
*/
void deleteIcon(uint8_t id);
/**
* @fn drawGif
* @brief Draw gif
* @param x The x-coordinate of the first point of the gif
* @param y The y-coordinate of the first point of the gif
* @param gifNum The enumerated value corresponding to the GIF
* @param size GIF scaling factor
* @return GIF control handle
*/
uint8_t drawGif(int16_t x, int16_t y, uint16_t gifNum, uint16_t size = 255);
/**
* @fn drawGif
* @brief Draw the gif on the USB flash drive
* @param x The x-coordinate of the first point of the icon
* @param y The y-coordinate of the first point of the icon
* @param str Picture path
* @param zoom Icon scaling factor
* @return Gif control handle
*/
uint8_t drawGif(int16_t x, int16_t y, String str, uint16_t zoom);
/**
* @fn deleteGif
* @brief Delete the Gif control
* @param id Gif control handle
*/
void deleteGif(uint8_t id);
/**
* @fn creatSlider
* @brief Create a slider control
* @param x The x-coordinate of the slider
* @param y The y-coordinate of the slider
* @param width The width of the slider
* @param height The height of the slide bar
* @param color The color of the slider
* @return Slider control handle
*/
uint8_t creatSlider(uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint16_t color);
/**
* @fn updateSlider
* @brief Update a slider control
* @param id Slider control handle
* @param x The x-coordinate of the slider
* @param y The y-coordinate of the slider
* @param width The width of the slider
* @param height The height of the slide bar
* @param color The color of the slider
*/
void updateSlider(uint8_t id, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint16_t color);
/**
* @fn setSliderValue
* @brief Sets the slider value
* @param sliderId Slider control handle
* @param value The value of the slider
*/
void setSliderValue(uint8_t sliderId, uint16_t value);
/**
*
* @fn deleteSlider
* @brief Delete slider
* @param id slider control handle
*/
void deleteSlider(uint8_t id);
/**
* @fn creatBar
* @brief Create a progress bar control
* @param x The x coordinate of the progress bar
* @param y The y coordinate of the progress bar
* @param width Width of the progress bar
* @param height Height of the progress bar
* @param color Color of the progress bar
* @return Bar control handle
*/
uint8_t creatBar(uint16_t x, uint16_t y, uint16_t width, uint8_t height, uint32_t color);
/**
* @fn updateBar
* @brief Update a progress bar control
* @param id Bar control handle
* @param x The x coordinate of the progress bar
* @param y The y coordinate of the progress bar
* @param width Width of the progress bar
* @param height Height of the progress bar
* @param color Color of the progress bar
*/
void updateBar(uint8_t id, uint16_t x, uint16_t y, uint16_t width, uint8_t height, uint32_t color);
/**
* @fn setBarValue
* @brief Set the value of the progress bar, which can include a unit but must start with a number
* @param barId Progress bar control handle
* @param value Value of the progress bar
*/
void setBarValue(uint8_t barId, uint16_t);
/**
*
* @fn deleteBar
* @brief Delete bar
* @param id bar control handle
*/
void deleteBar(uint8_t id);
/**
* @fn creatChart
* @brief Create a chart control
* @param strX Label on the x axis of the chart
* @param strY Label on the y axis of the chart
* @param bgColor background color
* @param type Type of chart (line chart / bar chart)
* @return chart control handle
*/
uint8_t creatChart(String strX, String strY, uint32_t bgColor, uint8_t type);
/**
* @fn updateChart
* @brief Update a chart control
* @param id Chart control handle
* @param bgColor background color
* @param type Type of chart (line chart / bar chart)
*/
void updateChart(uint8_t id, uint32_t bgColor, uint8_t type);
/**
* @fn creatChartSeries
* @brief Create a line chart or bar chart sequence in the chart
* @param chartId chart control handle
* @param color Color of line chart/bar chart
* @return Return the index of the series
*/
uint8_t creatChartSeries(uint8_t chartId, uint32_t color);
/**
* @fn updateChartSeries
* @brief Update a line chart or bar chart sequence in the chart
* @param chartId chart control handle
* @param seriesId series id
* @param color Color of line chart/bar chart
*/
void updateChartSeries(uint8_t chartId, uint8_t seriesId, uint32_t color);
/**
* @fn addChart
* @brief Assign a data sequence and add it to the chart
* @param obj chart control handle
* @param id the allocated data series
* @param point A graph/bar chart requires an array of data
* @param len array length
* @return Return the index of the series
*/
uint8_t addChartSeriesData(uint8_t chartId, uint8_t SeriesId, uint16_t point[], uint8_t len);
/**
* @fn updateChartPoint
* @brief Update the value of a point in the table
* @param chartId chart control handle
* @param seriesId series id
* @param pointNum point number
* @param value new value
*/
void updateChartPoint(uint8_t chartId, uint8_t SeriesId, uint8_t pointNum, uint16_t value);
/**
*
* @fn setTopChart
* @brief Set Top chart
* @param id chart control handle
*/
void setTopChart(uint8_t id);
/**
*
* @fn deleteChart
* @brief Delete chart
* @param id chart control handle
*/
void deleteChart(uint8_t id);
/**
* @fn creatGauge
* @brief Create a dial control
* @param x The x-axis coordinate of the control
* @param y The y-axis coordinate of the control
* @param diameter Gauge diameter
* @param start start value
* @param end end value
* @param pointerColor pointer color
* @param bgColor background color
* @return dial control handle
*/
uint8_t creatGauge(uint16_t x, uint16_t y, uint16_t diameter, uint16_t start, uint16_t end, uint32_t pointerColor, uint32_t bgColor);
/**
* @fn updateGauge
* @brief update a dial control
* @param id gauge control handle
* @param x The x-axis coordinate of the control
* @param y The y-axis coordinate of the control
* @param diameter Gauge diameter
* @param start start value
* @param end end value
* @param pointerColor pointer color
* @param bgColor background color
*/
void updateGauge(uint8_t id, uint16_t x, uint16_t y, uint16_t diameter, uint16_t start, uint16_t end, uint32_t pointerColor, uint32_t bgColor);
/**
* @fn setGaugeValue
* @brief Sets the value indicated by the dial
* @param gaugeId gauge control handle
* @param value the new value
*/
void setGaugeValue(uint8_t gaugeId, uint16_t value);
/**
*
* @fn deleteGauge
* @brief Delete gauge
* @param id gauge control handle
*/
void deleteGauge(uint8_t id);
/**
* @fn creatCompass
* @brief Creating a compass control
* @param x The x-axis coordinate of the control
* @param y The y-axis coordinate of the control
* @param diameter Compass diameter
* @return compass control handle
*/
uint8_t creatCompass(uint16_t x, uint16_t y, uint16_t diameter);
/**
* @fn updateCompass
* @brief Update a compass control
* @param id compass control handle
* @param x The x-axis coordinate of the control
* @param y The y-axis coordinate of the control
* @param diameter Compass diameter
*/
void updateCompass(uint8_t id, uint16_t x, uint16_t y, uint16_t diameter);
/**
* @fn setCompassScale
* @brief Setting the angle of the compass pointer
* @param compassId compass control handle
* @param scale Pointer angle(0~360)
*/
void setCompassScale(uint8_t compassId, uint16_t scale);
/**
*
* @fn deleteCompass
* @brief Delete compass
* @param id compass control handle
*/
void deleteCompass(uint8_t id);
/**
* @fn creatLineMeter
* @brief Create a linear gauge control
* @param x The x-axis coordinate of the control
* @param y The y-axis coordinate of the control
* @param size LineMeter size
* @param start minimum value
* @param end maximum value
* @param pointerColor pointer color
* @param bgColor pointer color
* @return linear meter id
*/
uint8_t creatLineMeter(uint16_t x, uint16_t y, uint16_t size, uint16_t start, uint16_t end, uint32_t pointerColor, uint32_t bgColor);
/**
* @fn updateLineMeter
* @brief update a linear gauge control
* @param id linear gauge control handle
* @param x The x-axis coordinate of the control
* @param y The y-axis coordinate of the control
* @param size LineMeter size
* @param start minimum value
* @param end maximum value
* @param pointerColor pointer color
* @param bgColor pointer color
*/
void updateLineMeter(uint8_t id, uint16_t x, uint16_t y, uint16_t size, uint16_t start, uint16_t end, uint32_t pointerColor, uint32_t bgColor);
/**
* @fn setMeterValue
* @brief Set a new value on the line meter
* @param lineMeterId line meter control handle
* @param value new value
*/
void setMeterValue(uint8_t lineMeterId, uint16_t value);
/**
*
* @fn deleteLineMeter
* @brief Delete LineMeter
* @param id LineMeter control handle
*/
void deleteLineMeter(uint8_t id);
/**
*
* @fn setTopLineMeter
* @brief Set Top LineMeter
* @param id LineMeter control handle
*/
void setTopLineMeter(uint8_t id);
/**
* @fn drawString
* @brief Display text on the screen
* @param x The x-coordinate of the starting position
* @param y The y-coordinate of the starting position
* @param str The text to display
* @param fontSize Text size (only applicable to eChinese and eAscii): 0 (24px size), 1 (12px size)
* @param color Color of text
* @return Text control handle
*/
uint8_t drawString(uint16_t x, uint16_t y, String str, uint8_t fontSize, uint32_t color);
/**
* @fn updateString
* @brief Change text on the screen
* @param id Text control handle
* @param x The x-coordinate of the starting position
* @param y The y-coordinate of the starting position
* @param str The text to display
* @param fontSize Text size (only applicable to eChinese and eAscii): 0 (24px size), 1 (12px size)
* @param color Color of text
*/
void updateString(uint8_t id, uint16_t x, uint16_t y, String str, uint8_t fontSize, uint32_t color);
/**
* @fn deleteString
* @brief Delete text on the screen
* @param id Text control handle
*/
void deleteString(uint8_t id);
/**
* @fn drawLcdTime
* @brief Displays the set time on the screen
* @param x The x-coordinate of the starting position
* @param y The y-coordinate of the starting position
* @param hour hour
* @param Minute minute
* @param seconds second
* @param fontSize font size
* @param color Color of text
* @return time control handle
*/
uint8_t drawLcdTime(uint8_t x, uint8_t y, uint8_t hour, uint8_t Minute, uint8_t seconds, uint8_t fontSize, uint16_t color);
/**
* @fn updateLcdTime
* @brief Update the set time on the screen
* @param id
* @param x The x-coordinate of the starting position
* @param y The y-coordinate of the starting position
* @param hour hour
* @param Minute minute
* @param seconds second
* @param fontSize font size
* @param color Color of text
*/
void updateLcdTime(uint8_t id, uint8_t x, uint8_t y, uint8_t hour, uint8_t Minute, uint8_t seconds, uint8_t fontSize, uint16_t color);
/**
* @fn drawLcdDate
* @brief Displays the set date on the screen
* @param x The x-coordinate of the starting position
* @param y The y-coordinate of the starting position
* @param month month
* @param day day
* @param weeks weekday
* @param fontSize font size
* @param color Color of text
*/
void drawLcdDate(uint8_t x, uint8_t y, uint8_t month, uint8_t day, uint8_t weeks, uint8_t fontSize, uint16_t color);
| MCU | Work Well | Work Wrong | Untested | Remarks |
|---|---|---|---|---|
| Arduino Uno | √ | |||
| FireBeetle-ESP8266 | √ | |||
| FireBeetle-ESP32 | √ | |||
| Arduino MEGA2560 | √ | |||
| Arduino Leonardo | √ | |||
| Micro:bit | √ | |||
| FireBeetle-M0 | √ |
- 2023/05/29 - Version 1.0.0 released.
- 2023/08/17 - Version 1.0.1 released.
Written by fengli(li.feng@dfrobot.com), 2022.08.08 (Welcome to our website)