components/epaper/EPD_5in83bc.h

   1 /*****************************************************************************
   2 * | File        :   EPD_5IN83BC.h
   3 * | Author      :   Waveshare team
   4 * | Function    :   5.83inch e-paper b&c
   5 * | Info        :
   6 * |     This version:   V3.0
   7 * | Date        :   2019-06-13
   8 * | Info        :
   9 * -----------------------------------------------------------------------------
  10 * V3.0(2019-06-13):
  11 * 1.Change:
  12 *    EPD_Reset() => EPD_5IN83BC_Reset()
  13 *    EPD_SendCommand() => EPD_5IN83BC_SendCommand()
  14 *    EPD_SendData() => EPD_5IN83BC_SendData()
  15 *    EPD_WaitUntilIdle() => EPD_5IN83BC_ReadBusy()
  16 *    EPD_Init() => EPD_5IN83BC_Init()
  17 *    EPD_Clear() => EPD_5IN83BC_Clear()
  18 *    EPD_Display() => EPD_5IN83BC_Display()
  19 *    EPD_Sleep() => EPD_5IN83BC_Sleep()
  20 * 2.Remove:
  21 *   #define PANEL_SETTING                               0x00
  22 *   #define POWER_SETTING                               0x01
  23 *   #define POWER_OFF                                   0x02
  24 *   #define POWER_OFF_SEQUENCE_SETTING                  0x03
  25 *   #define POWER_ON                                    0x04
  26 *   #define POWER_ON_MEASURE                            0x05
  27 *   #define BOOSTER_SOFT_START                          0x06
  28 *   #define DEEP_SLEEP                                  0x07
  29 *   #define DATA_START_TRANSMISSION_1                   0x10
  30 *   #define DATA_STOP                                   0x11
  31 *   #define DISPLAY_REFRESH                             0x12
  32 *   #define IMAGE_PROCESS                               0x13
  33 *   #define LUT_FOR_VCOM                                0x20
  34 *   #define LUT_BLUE                                    0x21
  35 *   #define LUT_WHITE                                   0x22
  36 *   #define LUT_GRAY_1                                  0x23
  37 *   #define LUT_GRAY_2                                  0x24
  38 *   #define LUT_RED_0                                   0x25
  39 *   #define LUT_RED_1                                   0x26
  40 *   #define LUT_RED_2                                   0x27
  41 *   #define LUT_RED_3                                   0x28
  42 *   #define LUT_XON                                     0x29
  43 *   #define PLL_CONTROL                                 0x30
  44 *   #define TEMPERATURE_SENSOR_COMMAND                  0x40
  45 *   #define TEMPERATURE_CALIBRATION                     0x41
  46 *   #define TEMPERATURE_SENSOR_WRITE                    0x42
  47 *   #define TEMPERATURE_SENSOR_READ                     0x43
  48 *   #define VCOM_AND_DATA_INTERVAL_SETTING              0x50
  49 *   #define LOW_POWER_DETECTION                         0x51
  50 *   #define TCON_SETTING                                0x60
  51 *   #define TCON_RESOLUTION                             0x61
  52 *   #define SPI_FLASH_CONTROL                           0x65
  53 *   #define REVISION                                    0x70
  54 *   #define GET_STATUS                                  0x71
  55 *   #define AUTO_MEASUREMENT_VCOM                       0x80
  56 *   #define READ_VCOM_VALUE                             0x81
  57 *   #define VCM_DC_SETTING                              0x82
  58 * 3.add:
  59 *   EPD_5IN83BC_DisplayHalfScreen()
  60 * -----------------------------------------------------------------------------
  61 * V2.0(2018-11-09):
  62 * 1.Remove:ImageBuff[EPD_HEIGHT * EPD_WIDTH / 8]
  63 * 2.Change:EPD_Display(UBYTE *Image)
  64 *   Need to pass parameters: pointer to cached data
  65 #
  66 # Permission is hereby granted, free of charge, to any person obtaining a copy
  67 # of this software and associated documnetation files (the "Software"), to deal
  68 # in the Software without restriction, including without limitation the rights
  69 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  70 # copies of the Software, and to permit persons to  whom the Software is
  71 # furished to do so, subject to the following conditions:
  72 #
  73 # The above copyright notice and this permission notice shall be included in
  74 # all copies or substantial portions of the Software.
  75 #
  76 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  77 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  78 # FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  79 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  80 # LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  81 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  82 # THE SOFTWARE.
  83 #
  84 ******************************************************************************/
  85 #ifndef __EPD_5IN83BC_H_
  86 #define __EPD_5IN83BC_H_
  87
  88 #include "DEV_Config.h"
  89
  90 // Display resolution
  91 #define EPD_5IN83BC_WIDTH       600
  92 #define EPD_5IN83BC_HEIGHT      448
  93
  94 void EPD_5IN83BC_Init(UBYTE mode);
  95 void EPD_5IN83BC_Clear(void);
  96 void EPD_5IN83BC_Display(const UBYTE *blackimage, const UBYTE *ryimage);
  97 void EPD_5IN83BC_DisplayHalfScreen(const UBYTE *blackimage, const UBYTE *ryimage);
  98 void EPD_5IN83BC_Sleep(void);
  99
 100 #endif