README.md · DFRobot/DFRobot_Display

# Display

This is a base class library of the device display to store drawing methods of basic figures; 
many display device of DFRobot depend on it.

## DFRobot_Display Library for Arduino
---------------------------------------------------------
Provide a library faciltates drawing in majority screens.

## Table of Contents

* [Summary](#summary)
* [Feature](#feature)
* [Installation](#installation)
* [Result](#result)
* [Methods](#methods)

* [History](#history)
* [Compatibility](#compatibility)
* [Credits](#credits)
<snippet>
<content>

## Summary

Enable figures-drawing in the screen and many configurable functions are available.

## Feature

--Support different drawings in the screen, including point, line, circle, fill circle, 
 rectangle, fill rectangle, triangle, fill triangle, rounded rectangle, fill rounded rectangle. 
--English fonts or character library chips are configurable. 
--Read and display BMP file in SD card. 
--The library can be drived by basic hardware programs of drawPixel, fillScreen and begin.

## Installation

Download the library ZIP file and unzip it to the Arduino folder of the library. 
SPI_SD interface is available, compatible SD card libraries of ESP32 and ESP8266(https://github.com/DFRobot/SD_SPI) are added.

## Result

Functions supports. <0 means error; >0 means warning, 0 means OK .

function type

Value              | Result                                     
------------------ | ---------------------------------------
-4                 |          mem overflow
-3                 |          not support
-2                 |          param
-1                 |          error
1                  |          out range

## Methods

```C++

#include "DFRobot_ILI9488_SPI.h"

Except special instructions, all axis as below are relative to the source node , 
color represents 16 bits 565 color data

//color define 
#define DISPLAY_BLACK       0x0000      /*   0,   0,   0 */
#define DISPLAY_NAVY        0x000F      /*   0,   0, 128 */
#define DISPLAY_DARKGREEN   0x03E0      /*   0, 128,   0 */
#define DISPLAY_DARKCYAN    0x03EF      /*   0, 128, 128 */
#define DISPLAY_MAROON      0x7800      /* 128,   0,   0 */
#define DISPLAY_PURPLE      0x780F      /* 128,   0, 128 */
#define DISPLAY_OLIVE       0x7BE0      /* 128, 128,   0 */
#define DISPLAY_LIGHTGREY   0xC618      /* 192, 192, 192 */
#define DISPLAY_DARKGREY    0x7BEF      /* 128, 128, 128 */
#define DISPLAY_BLUE        0x001F      /*   0,   0, 255 */
#define DISPLAY_GREEN       0x07E0      /*   0, 255,   0 */
#define DISPLAY_CYAN        0x07FF      /*   0, 255, 255 */
#define DISPLAY_RED         0xF800      /* 255,   0,   0 */
#define DISPLAY_MAGENTA     0xF81F      /* 255,   0, 255 */
#define DISPLAY_YELLOW      0xFFE0      /* 255, 255,   0 */
#define DISPLAY_WHITE       0xFFFF      /* 255, 255, 255 */
#define DISPLAY_ORANGE      0xFD20      /* 255, 165,   0 */
#define DISPLAY_GREENYELLOW 0xAFE5      /* 173, 255,  47 */
#define DISPLAY_PINK        0xF81F

/*
 * @brief fill screen
 */
void fillScreen(uint16_t color);

/*
 * @brief draw a pixel
 *
 * @param x       x-axis coordinates
 *        y       y-axis coordinates
 */
void drawPixel(int16_t x, int16_t y, uint16_t color);

/*
 * @brief draw a line
 *
 * @param x0        The x-axis of the starting point
 *        y0        The y-axis of the starting point
 *        x1        The x-axis of the terminal point
 *        y1        The y-axis of the terminal point
 */
void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, 
              uint16_t color);

/*
 * @brief draw a horizontal line
 *
 * @param x         The x-axis of the starting point
 *        y         The y-axis of the starting point
 *        width     The line lenth
 */
void drawHLine(int16_t x, int16_t y, int16_t width, uint16_t color);

/*
 * @brief draw a vertical line
 *
 * @param x         The x-axis of the starting point
 *        y         The y-axis of the starting point
 *        height    The line lenth
 */
void drawVLine(int16_t x, int16_t y, int16_t height, uint16_t color);

/*
 * @brief draw a rectangle
 *
 * @param x         The x-axis of the starting point
 *        y         The y-axis of the starting point
 *        width     The rectangle width
 *        height    The rectangle height
 */
void drawRect(int16_t x, int16_t y, int16_t width, int16_t height, 
              uint16_t color);

/*
 * @brief draw a fill rectangle
 *
 * @param x         The x-axis of the starting point
 *        y         The y-axis of the starting point
 *        width     The rectangle width
 *        height    The rectangle height
 */
void fillRect(int16_t x, int16_t y, int16_t width, int16_t height, 
              uint16_t color);

/*
 * @brief draw a circle
 *
 * @param x         The x-axis of the center
 *        y         The y-axis of the center
 *        r         The circle radius 
 */
void drawCircle(int16_t x, int16_t y, int16_t r, uint16_t color);

/*
 * @brief draw a fill circle
 *
 * @param x         The x-axis of the center
 *        y         The y-axis of the center
 *        r         The circle radius
 */
void fillCircle(int16_t x, int16_t y, int16_t r, uint16_t color);

/*
 * @brief draw a triangle
 *
 * @param x0        The x-axis of the first point
 *        y0        The y-axis of the first point
 *        x0        The x-axis of the second point
 *        y0        The y-axis of the second point
 *        x0        The x-axis of the third point
 *        y0        The y-axis of the third point
 */
void drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, 
                  int16_t x2, int16_t y2, uint16_t color);
                  
/*
 * @brief draw a fill triangle
 *
 * @param x0        The x-axis of the first point
 *        y0        The y-axis of the first point
 *        x0        The x-axis of the second point
 *        y0        The y-axis of the second point
 *        x0        The x-axis of the third point
 *        y0        The y-axis of the third point
 */
void fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, 
                  int16_t x2, int16_t y2, uint16_t color);

/*
 * @brief draw a rounded rectangle
 *
 * @param x         The x-axis of the starting point
 *        y         The y-axis of the starting point
 *        width     The rectangle width
 *        height    The rectangle height
 *        r         The rounded corner radius
 */
void drawRoundRect(int16_t x, int16_t y, int16_t, width, int16_t height, 
                   int16_t r, uint16_t color);
                   
/*
 * @brief draw a fill rounded rectangle
 *
 * @param x         The x-axis of the starting point
 *        y         The y-axis of the starting point
 *        width     The rectangle width
 *        height    The rectangle height
 *        r         The rounded corner radius
 */
void fillRoundRect(int16_t x, int16_t y, int16_t, width, int16_t height, 
                   int16_t r, uint16_t color);
                   
/*
 * @brief Set axis of the source node(relative to the top left corner)
 *
 * @param x         The x-axis of the source node
 *        y         The y-axis of the source node
 */
void setOrign(int16_t x, int16_t y);

/*
 * @brief Get axis of the source node(relative to the top left corner)
 *
 * @param x         Address to store varialbles of the source node x-axis
 *        y         Address to store varialbles of the source node y-axis
 */
void getOrign(int16_t* pX, int16_t* pY);

/*
 * @brief Set printing point axis (relative to the top left corner)
 *
 * @param x         x-axis of the printed point
 *        y         y-axis of the printed point
 */
void setCursor(int16_t x, int16_t y);

/*
 * @brief Get axis of the printed point(relative to the top left corner)
 *
 * @param x         Address to store varialbles of the printed point x-axis
 *        y         Address to store varialbles of the printed point y-axis
 */
void getCursor(int16_t* pX, int16_t* pY);

/*
 * @brief Set text color
 */
void setTextColor(uint16_t color);

/*
 * @brief Get text color
 *
 * @return 16 bits color data
 */
uint16_t getTextColor(void);

/*
 * @brief Set text size
 *
 * @param size        text size
 */
void setTextSize(uint8_t size);

/*
 * @brief Get text size
 *
 * @return text size
 */
uint8_t getTextSize(void);

/*
 * @brief Print text in the print point, the usage method is as same as the serial port
 */
size_t print(...);
size_t println(...);

size_t printf(...);  //Only ESP series cpntrollers are supportive

enum eROTATION {
  eROTATION_0,
  eROTATION_90,
  eROTATION_180,
  eROTATION_270
};

/*
 * @brief Set the screen to rotate
 *
 * @param eRotation       The rotation angle
 */
void setRotation(eROTATION eRotation);  //Need the hardware support

/*
 * @brief Get the screen rotation
 *
 * @return The rotation angle
 */
eROTATION getRotation(void);

/*
 * @brief Get screen width
 *
 * @return The screen width
 */
int16_t getWidth(void);

/*
 * @brief Get screen hight
 *
 * @return The  screen hight
 */
int16_t getHeight(void);

/*
 * @brief Display bmp file (24bits SD card bmp file)
 *
 * @param s       file objectiv
 *        x       The x-axis of the starting point
 *        y       The y-axis of the starting point
 *
 * @return Error message
 */
int16_t drawBmp(Stream *s, int16_t x, int16_t y);

/*
 * @brief Display bmp file
 *
 * @param pData   bmp array list (single bit color)
 *        x       The x-axis of the starting point
 *        y       The y-axis of the starting point
 *        w       bmp width
 *        h       bmp height
 *        size    magnification multiple
 */
int16_t drawBmp(uint8_t* pData, int16_t x, int16_t y, uint16_t w, uint16_t h, uint8_t size, uint16_t color);

/*
 * @brief Display bmp file
 *
 * @param pData   bmp array list (24bits color)
 *        x       The x-axis of the starting point
 *        y       The y-axis of the starting point
 *        w       bmp width
 *        h       bmp height
 */
int16_t drawBmp(uint8_t* pData, int16_t x, int16_t y, uint16_t w, uint16_t h);

/*
 * @brief get screen width
 *
 * @return screen width     
 */
int16_t getWidth(void);

/*
 * @brief Get screen hight
 *
 * @return The screen hight
 */
int16_t getHeight(void);

/*
 * @brief support chinese font IC
 */
void supportChineseFont(void);

/*
 * @brief set line width (only for function drawLine now)
 *
 * @param w       line width
 */
void setLineWidth(uint16_t w);

/*
 * @brief Get line width
 *
 * @return line width
 */
uint16_t getLineWidth(void);

```

```C++

/*
 * @brief create a clock object
 */
#include "DFRobot_Display_Clock.h"

DFRobot_Display_Clock(DFRobot_Display* pDisplay);

/*
 * @brief set pointer length
 *
 * @param hl        hour pointer length
 *        ml        minute pointer length
 *        sl        second pointer length
 */
void setPointerLength(uint16_t hl, uint16_t ml, uint16_t sl);

/*
 * @brief set pointer color
 *
 * @param hc        hour pointer color
 *        mc        minute pointer color
 *        sc        second pointer color
 */
void setPointerColor(uint16_t hc, uint16_t mc, uint16_t sc);

/*
 * @brief set pointer width
 *
 * @param hw        hour pointer width
 *        mw        minute pointer width
 *        sw        second pointer width
 */
void setPointerWidth(uint16_t hw, uint16_t mw, uint16_t sw);

/*
 * @brief set clock dial
 *
 * @param x        clock dial position x
 *        y        clock dial position y
 *        r        clock dial radius r
 */
void setClockDial(int16_t x, int16_t y, uint16_t r);

/*
 * @brief set clock dial color
 *
 * @param border        border color
 *        background    dial background color
 */
void setDialColor(uint16_t border, uint16_t background);

/*
 * @brief make clock dial
 */
void showDial();

/*
 * @brief update clock
 *
 * @param h        time hour
 *        m        time minute
 *        s        time second
 */
void updateClock(uint8_t h, uint8_t m, uint8_t s);

```

## Compatibility

MCU                | Work Well    | Work Wrong   | Untested    | Remarks
------------------ | :----------: | :----------: | :---------: | -----
FireBeetle-ESP32   |      √       |              |             | 
FireBeetle-ESP8266 |      √       |              |             | 
FireBeetle-BLE4.1  |      √       |              |             | 
Arduino uno        |      √       |              |             | 
Arduino leonardo   |      √       |              |             |

## History

## Credits

Written by DFRobot_xiaowo, 2017. (Welcome to our [website](https://www.dfrobot.com/))

DFRobot/DFRobot_Display

简介

发行版

贡献者

语言

近期动态

DFRobot/DFRobot_Display .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

语言

近期动态

搜索帮助

DFRobot/DFRobot_Display