Gerrit Pathuis / Mbed 2 deprecated Epaper_epd1in54_Waveshare

E_paper, E_ink, Screen size 1.54", resolution 200x200, 4 wire spi, Waveshare, Black and White, Kl25Z, 8 wire print connector, supply 3.3 Volt, IL0373 Controller, font size is 8, 12, 16 and 24.

Dependencies:   mbed

epd1in54.cpp@10:08e026240a5f, 2018-03-31 (annotated)

Committer:
GerritPathuis
Date:
Sat Mar 31 08:40:16 2018 +0000
Revision:
10:08e026240a5f
Parent:
9:9503e1ff98ea 
Minor text update

Who changed what in which revision?

UserRevisionLine numberNew contents of line
GerritPathuis 0:665e04c85d8d 1 /**
GerritPathuis 0:665e04c85d8d 2 * @filename : epd1in54.cpp
GerritPathuis 0:665e04c85d8d 3 * @brief : Implements for e-paper library
GerritPathuis 0:665e04c85d8d 4 * @author : Yehui from Waveshare
GerritPathuis 0:665e04c85d8d 5 *
GerritPathuis 0:665e04c85d8d 6 * Copyright (C) Waveshare September 5 2017
GerritPathuis 0:665e04c85d8d 7 *
GerritPathuis 0:665e04c85d8d 8 * Permission is hereby granted, free of charge, to any person obtaining a copy
GerritPathuis 0:665e04c85d8d 9 * of this software and associated documnetation files (the "Software"), to deal
GerritPathuis 0:665e04c85d8d 10 * in the Software without restriction, including without limitation the rights
GerritPathuis 0:665e04c85d8d 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
GerritPathuis 0:665e04c85d8d 12 * copies of the Software, and to permit persons to whom the Software is
GerritPathuis 0:665e04c85d8d 13 * furished to do so, subject to the following conditions:
GerritPathuis 0:665e04c85d8d 14 *
GerritPathuis 0:665e04c85d8d 15 * The above copyright notice and this permission notice shall be included in
GerritPathuis 0:665e04c85d8d 16 * all copies or substantial portions of the Software.
GerritPathuis 0:665e04c85d8d 17 *
GerritPathuis 0:665e04c85d8d 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
GerritPathuis 0:665e04c85d8d 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
GerritPathuis 0:665e04c85d8d 20 * FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
GerritPathuis 0:665e04c85d8d 21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
GerritPathuis 0:665e04c85d8d 22 * LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
GerritPathuis 0:665e04c85d8d 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
GerritPathuis 0:665e04c85d8d 24 * THE SOFTWARE.
GerritPathuis 0:665e04c85d8d 25 */
GerritPathuis 0:665e04c85d8d 26
GerritPathuis 0:665e04c85d8d 27 #include "epd1in54.h"
GerritPathuis 0:665e04c85d8d 28
GerritPathuis 7:25cadf37fd86 29 extern Serial pc;
GerritPathuis 7:25cadf37fd86 30
GerritPathuis 8:01db118d1694 31 Epd::~Epd()
GerritPathuis 8:01db118d1694 32 {
GerritPathuis 0:665e04c85d8d 33 };
GerritPathuis 0:665e04c85d8d 34
GerritPathuis 8:01db118d1694 35 Epd::Epd()
GerritPathuis 8:01db118d1694 36 {
GerritPathuis 6:469fb6b0d26d 37 reset_pin_no= 0;
GerritPathuis 6:469fb6b0d26d 38 dc_pin_no = 1;
GerritPathuis 6:469fb6b0d26d 39 cs_pin_no = 2;
GerritPathuis 6:469fb6b0d26d 40 busy_pin_no = 3;
GerritPathuis 0:665e04c85d8d 41 width = EPD_WIDTH;
GerritPathuis 0:665e04c85d8d 42 height = EPD_HEIGHT;
GerritPathuis 0:665e04c85d8d 43 };
GerritPathuis 0:665e04c85d8d 44
GerritPathuis 8:01db118d1694 45 int Epd::Init(const unsigned char* lut)
GerritPathuis 8:01db118d1694 46 {
GerritPathuis 8:01db118d1694 47 pc.printf("Init... \n\r");
GerritPathuis 0:665e04c85d8d 48 /* this calls the peripheral hardware interface, see epdif */
GerritPathuis 0:665e04c85d8d 49 if (IfInit() != 0) {
GerritPathuis 0:665e04c85d8d 50 return -1;
GerritPathuis 0:665e04c85d8d 51 }
GerritPathuis 0:665e04c85d8d 52 /* EPD hardware init start */
GerritPathuis 0:665e04c85d8d 53 this->lut = lut;
GerritPathuis 0:665e04c85d8d 54 Reset();
GerritPathuis 0:665e04c85d8d 55 SendCommand(DRIVER_OUTPUT_CONTROL);
GerritPathuis 0:665e04c85d8d 56 SendData((EPD_HEIGHT - 1) & 0xFF);
GerritPathuis 0:665e04c85d8d 57 SendData(((EPD_HEIGHT - 1) >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 58 SendData(0x00); // GD = 0; SM = 0; TB = 0;
GerritPathuis 0:665e04c85d8d 59 SendCommand(BOOSTER_SOFT_START_CONTROL);
GerritPathuis 0:665e04c85d8d 60 SendData(0xD7);
GerritPathuis 0:665e04c85d8d 61 SendData(0xD6);
GerritPathuis 0:665e04c85d8d 62 SendData(0x9D);
GerritPathuis 0:665e04c85d8d 63 SendCommand(WRITE_VCOM_REGISTER);
GerritPathuis 0:665e04c85d8d 64 SendData(0xA8); // VCOM 7C
GerritPathuis 0:665e04c85d8d 65 SendCommand(SET_DUMMY_LINE_PERIOD);
GerritPathuis 0:665e04c85d8d 66 SendData(0x1A); // 4 dummy lines per gate
GerritPathuis 0:665e04c85d8d 67 SendCommand(SET_GATE_TIME);
GerritPathuis 0:665e04c85d8d 68 SendData(0x08); // 2us per line
GerritPathuis 0:665e04c85d8d 69 SendCommand(DATA_ENTRY_MODE_SETTING);
GerritPathuis 0:665e04c85d8d 70 SendData(0x03); // X increment; Y increment
GerritPathuis 0:665e04c85d8d 71 SetLut(this->lut);
GerritPathuis 0:665e04c85d8d 72 /* EPD hardware init end */
GerritPathuis 8:01db118d1694 73 pc.printf("Init done \n\r");
GerritPathuis 0:665e04c85d8d 74 return 0;
GerritPathuis 0:665e04c85d8d 75 }
GerritPathuis 0:665e04c85d8d 76
GerritPathuis 0:665e04c85d8d 77 /**
GerritPathuis 0:665e04c85d8d 78 * @brief: basic function for sending commands
GerritPathuis 0:665e04c85d8d 79 */
GerritPathuis 8:01db118d1694 80 void Epd::SendCommand(unsigned char command)
GerritPathuis 8:01db118d1694 81 {
GerritPathuis 6:469fb6b0d26d 82 DigitalWrite(dc_pin_no, LOW);
GerritPathuis 0:665e04c85d8d 83 SpiTransfer(command);
GerritPathuis 0:665e04c85d8d 84 }
GerritPathuis 0:665e04c85d8d 85
GerritPathuis 0:665e04c85d8d 86 /**
GerritPathuis 0:665e04c85d8d 87 * @brief: basic function for sending data
GerritPathuis 0:665e04c85d8d 88 */
GerritPathuis 8:01db118d1694 89 void Epd::SendData(unsigned char data)
GerritPathuis 8:01db118d1694 90 {
GerritPathuis 6:469fb6b0d26d 91 DigitalWrite(dc_pin_no, HIGH);
GerritPathuis 0:665e04c85d8d 92 SpiTransfer(data);
GerritPathuis 0:665e04c85d8d 93 }
GerritPathuis 0:665e04c85d8d 94
GerritPathuis 1:d27a7e06c233 95
GerritPathuis 0:665e04c85d8d 96 /**
GerritPathuis 0:665e04c85d8d 97 * @brief: Wait until the busy_pin goes LOW
GerritPathuis 0:665e04c85d8d 98 */
GerritPathuis 8:01db118d1694 99 void Epd::WaitUntilIdle(void)
GerritPathuis 8:01db118d1694 100 {
GerritPathuis 6:469fb6b0d26d 101 while(DigitalRead(busy_pin_no) == HIGH) { //LOW: idle, HIGH: busy
GerritPathuis 0:665e04c85d8d 102 DelayMs(100);
GerritPathuis 8:01db118d1694 103 }
GerritPathuis 0:665e04c85d8d 104 }
GerritPathuis 0:665e04c85d8d 105
GerritPathuis 0:665e04c85d8d 106 /**
GerritPathuis 0:665e04c85d8d 107 * @brief: module reset.
GerritPathuis 0:665e04c85d8d 108 * often used to awaken the module in deep sleep,
GerritPathuis 0:665e04c85d8d 109 * see Epd::Sleep();
GerritPathuis 0:665e04c85d8d 110 */
GerritPathuis 8:01db118d1694 111 void Epd::Reset(void)
GerritPathuis 8:01db118d1694 112 {
GerritPathuis 8:01db118d1694 113 DigitalWrite(reset_pin_no, LOW); //module reset
GerritPathuis 0:665e04c85d8d 114 DelayMs(200);
GerritPathuis 6:469fb6b0d26d 115 DigitalWrite(reset_pin_no, HIGH);
GerritPathuis 8:01db118d1694 116 DelayMs(200);
GerritPathuis 0:665e04c85d8d 117 }
GerritPathuis 0:665e04c85d8d 118
GerritPathuis 0:665e04c85d8d 119 /**
GerritPathuis 0:665e04c85d8d 120 * @brief: set the look-up table register
GerritPathuis 0:665e04c85d8d 121 */
GerritPathuis 8:01db118d1694 122 void Epd::SetLut(const unsigned char* lut)
GerritPathuis 8:01db118d1694 123 {
GerritPathuis 0:665e04c85d8d 124 this->lut = lut;
GerritPathuis 0:665e04c85d8d 125 SendCommand(WRITE_LUT_REGISTER);
GerritPathuis 0:665e04c85d8d 126 /* the length of look-up table is 30 bytes */
GerritPathuis 0:665e04c85d8d 127 for (int i = 0; i < 30; i++) {
GerritPathuis 0:665e04c85d8d 128 SendData(this->lut[i]);
GerritPathuis 0:665e04c85d8d 129 }
GerritPathuis 0:665e04c85d8d 130 }
GerritPathuis 0:665e04c85d8d 131
GerritPathuis 0:665e04c85d8d 132 /**
GerritPathuis 0:665e04c85d8d 133 * @brief: put an image buffer to the frame memory.
GerritPathuis 0:665e04c85d8d 134 * this won't update the display.
GerritPathuis 0:665e04c85d8d 135 */
GerritPathuis 0:665e04c85d8d 136 void Epd::SetFrameMemory(
GerritPathuis 0:665e04c85d8d 137 const unsigned char* image_buffer,
GerritPathuis 8:01db118d1694 138 int x,int y, int image_width, int image_height)
GerritPathuis 8:01db118d1694 139 {
GerritPathuis 0:665e04c85d8d 140 int x_end;
GerritPathuis 0:665e04c85d8d 141 int y_end;
GerritPathuis 0:665e04c85d8d 142
GerritPathuis 0:665e04c85d8d 143 if (
GerritPathuis 0:665e04c85d8d 144 image_buffer == NULL ||
GerritPathuis 0:665e04c85d8d 145 x < 0 || image_width < 0 ||
GerritPathuis 0:665e04c85d8d 146 y < 0 || image_height < 0
GerritPathuis 0:665e04c85d8d 147 ) {
GerritPathuis 0:665e04c85d8d 148 return;
GerritPathuis 0:665e04c85d8d 149 }
GerritPathuis 0:665e04c85d8d 150 /* x point must be the multiple of 8 or the last 3 bits will be ignored */
GerritPathuis 0:665e04c85d8d 151 x &= 0xF8;
GerritPathuis 0:665e04c85d8d 152 image_width &= 0xF8;
GerritPathuis 0:665e04c85d8d 153 if (x + image_width >= this->width) {
GerritPathuis 0:665e04c85d8d 154 x_end = this->width - 1;
GerritPathuis 0:665e04c85d8d 155 } else {
GerritPathuis 0:665e04c85d8d 156 x_end = x + image_width - 1;
GerritPathuis 0:665e04c85d8d 157 }
GerritPathuis 0:665e04c85d8d 158 if (y + image_height >= this->height) {
GerritPathuis 0:665e04c85d8d 159 y_end = this->height - 1;
GerritPathuis 0:665e04c85d8d 160 } else {
GerritPathuis 0:665e04c85d8d 161 y_end = y + image_height - 1;
GerritPathuis 0:665e04c85d8d 162 }
GerritPathuis 0:665e04c85d8d 163 SetMemoryArea(x, y, x_end, y_end);
GerritPathuis 0:665e04c85d8d 164 SetMemoryPointer(x, y);
GerritPathuis 0:665e04c85d8d 165 SendCommand(WRITE_RAM);
GerritPathuis 0:665e04c85d8d 166 /* send the image data */
GerritPathuis 0:665e04c85d8d 167 for (int j = 0; j < y_end - y + 1; j++) {
GerritPathuis 0:665e04c85d8d 168 for (int i = 0; i < (x_end - x + 1) / 8; i++) {
GerritPathuis 0:665e04c85d8d 169 SendData(image_buffer[i + j * (image_width / 8)]);
GerritPathuis 0:665e04c85d8d 170 }
GerritPathuis 0:665e04c85d8d 171 }
GerritPathuis 0:665e04c85d8d 172 }
GerritPathuis 0:665e04c85d8d 173
GerritPathuis 0:665e04c85d8d 174 /**
GerritPathuis 0:665e04c85d8d 175 * @brief: put an image buffer to the frame memory.
GerritPathuis 0:665e04c85d8d 176 * this won't update the display.
GerritPathuis 0:665e04c85d8d 177 *
GerritPathuis 8:01db118d1694 178 * Question: When do you use this function instead of
GerritPathuis 0:665e04c85d8d 179 * void SetFrameMemory(
GerritPathuis 0:665e04c85d8d 180 * const unsigned char* image_buffer,
GerritPathuis 0:665e04c85d8d 181 * int x,
GerritPathuis 0:665e04c85d8d 182 * int y,
GerritPathuis 0:665e04c85d8d 183 * int image_width,
GerritPathuis 0:665e04c85d8d 184 * int image_height
GerritPathuis 0:665e04c85d8d 185 * );
GerritPathuis 0:665e04c85d8d 186 * Answer: SetFrameMemory with parameters only reads image data
GerritPathuis 0:665e04c85d8d 187 * from the RAM but not from the flash in AVR chips (for AVR chips,
GerritPathuis 8:01db118d1694 188 * you have to use the function pgm_read_byte to read buffers
GerritPathuis 0:665e04c85d8d 189 * from the flash).
GerritPathuis 0:665e04c85d8d 190 */
GerritPathuis 8:01db118d1694 191 void Epd::SetFrameMemory(const unsigned char* image_buffer)
GerritPathuis 8:01db118d1694 192 {
GerritPathuis 0:665e04c85d8d 193 SetMemoryArea(0, 0, this->width - 1, this->height - 1);
GerritPathuis 0:665e04c85d8d 194 SetMemoryPointer(0, 0);
GerritPathuis 0:665e04c85d8d 195 SendCommand(WRITE_RAM);
GerritPathuis 0:665e04c85d8d 196 /* send the image data */
GerritPathuis 0:665e04c85d8d 197 for (int i = 0; i < this->width / 8 * this->height; i++) {
GerritPathuis 8:01db118d1694 198 SendData(*(&image_buffer[i]));
GerritPathuis 0:665e04c85d8d 199 }
GerritPathuis 0:665e04c85d8d 200 }
GerritPathuis 0:665e04c85d8d 201
GerritPathuis 0:665e04c85d8d 202 /**
GerritPathuis 0:665e04c85d8d 203 * @brief: clear the frame memory with the specified color.
GerritPathuis 0:665e04c85d8d 204 * this won't update the display.
GerritPathuis 0:665e04c85d8d 205 */
GerritPathuis 8:01db118d1694 206 void Epd::ClearFrameMemory(unsigned char color)
GerritPathuis 8:01db118d1694 207 {
GerritPathuis 0:665e04c85d8d 208 SetMemoryArea(0, 0, this->width - 1, this->height - 1);
GerritPathuis 0:665e04c85d8d 209 SetMemoryPointer(0, 0);
GerritPathuis 0:665e04c85d8d 210 SendCommand(WRITE_RAM);
GerritPathuis 8:01db118d1694 211
GerritPathuis 0:665e04c85d8d 212 /* send the color data */
GerritPathuis 0:665e04c85d8d 213 for (int i = 0; i < this->width / 8 * this->height; i++) {
GerritPathuis 0:665e04c85d8d 214 SendData(color);
GerritPathuis 0:665e04c85d8d 215 }
GerritPathuis 0:665e04c85d8d 216 }
GerritPathuis 0:665e04c85d8d 217
GerritPathuis 0:665e04c85d8d 218 /**
GerritPathuis 0:665e04c85d8d 219 * @brief: update the display
GerritPathuis 0:665e04c85d8d 220 * there are 2 memory areas embedded in the e-paper display
GerritPathuis 0:665e04c85d8d 221 * but once this function is called,
GerritPathuis 8:01db118d1694 222 * the the next action of SetFrameMemory or ClearFrame will
GerritPathuis 0:665e04c85d8d 223 * set the other memory area.
GerritPathuis 0:665e04c85d8d 224 */
GerritPathuis 8:01db118d1694 225 void Epd::DisplayFrame(void)
GerritPathuis 8:01db118d1694 226 {
GerritPathuis 0:665e04c85d8d 227 SendCommand(DISPLAY_UPDATE_CONTROL_2);
GerritPathuis 0:665e04c85d8d 228 SendData(0xC4);
GerritPathuis 0:665e04c85d8d 229 SendCommand(MASTER_ACTIVATION);
GerritPathuis 0:665e04c85d8d 230 SendCommand(TERMINATE_FRAME_READ_WRITE);
GerritPathuis 0:665e04c85d8d 231 WaitUntilIdle();
GerritPathuis 0:665e04c85d8d 232 }
GerritPathuis 0:665e04c85d8d 233
GerritPathuis 0:665e04c85d8d 234 /**
GerritPathuis 0:665e04c85d8d 235 * @brief: private function to specify the memory area for data R/W
GerritPathuis 0:665e04c85d8d 236 */
GerritPathuis 8:01db118d1694 237 void Epd::SetMemoryArea(int x_start, int y_start, int x_end, int y_end)
GerritPathuis 8:01db118d1694 238 {
GerritPathuis 0:665e04c85d8d 239 SendCommand(SET_RAM_X_ADDRESS_START_END_POSITION);
GerritPathuis 0:665e04c85d8d 240 /* x point must be the multiple of 8 or the last 3 bits will be ignored */
GerritPathuis 0:665e04c85d8d 241 SendData((x_start >> 3) & 0xFF);
GerritPathuis 0:665e04c85d8d 242 SendData((x_end >> 3) & 0xFF);
GerritPathuis 0:665e04c85d8d 243 SendCommand(SET_RAM_Y_ADDRESS_START_END_POSITION);
GerritPathuis 0:665e04c85d8d 244 SendData(y_start & 0xFF);
GerritPathuis 0:665e04c85d8d 245 SendData((y_start >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 246 SendData(y_end & 0xFF);
GerritPathuis 0:665e04c85d8d 247 SendData((y_end >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 248 }
GerritPathuis 0:665e04c85d8d 249
GerritPathuis 0:665e04c85d8d 250 /**
GerritPathuis 0:665e04c85d8d 251 * @brief: private function to specify the start point for data R/W
GerritPathuis 0:665e04c85d8d 252 */
GerritPathuis 8:01db118d1694 253 void Epd::SetMemoryPointer(int x, int y)
GerritPathuis 8:01db118d1694 254 {
GerritPathuis 0:665e04c85d8d 255 SendCommand(SET_RAM_X_ADDRESS_COUNTER);
GerritPathuis 8:01db118d1694 256
GerritPathuis 0:665e04c85d8d 257 /* x point must be the multiple of 8 or the last 3 bits will be ignored */
GerritPathuis 0:665e04c85d8d 258 SendData((x >> 3) & 0xFF);
GerritPathuis 0:665e04c85d8d 259 SendCommand(SET_RAM_Y_ADDRESS_COUNTER);
GerritPathuis 0:665e04c85d8d 260 SendData(y & 0xFF);
GerritPathuis 0:665e04c85d8d 261 SendData((y >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 262 WaitUntilIdle();
GerritPathuis 0:665e04c85d8d 263 }
GerritPathuis 0:665e04c85d8d 264
GerritPathuis 0:665e04c85d8d 265 /**
GerritPathuis 8:01db118d1694 266 * @brief: After this command is transmitted, the chip would enter the
GerritPathuis 8:01db118d1694 267 * deep-sleep mode to save power.
GerritPathuis 8:01db118d1694 268 * The deep sleep mode would return to standby by hardware reset.
GerritPathuis 0:665e04c85d8d 269 * You can use Epd::Init() to awaken
GerritPathuis 0:665e04c85d8d 270 */
GerritPathuis 8:01db118d1694 271 void Epd::Sleep()
GerritPathuis 8:01db118d1694 272 {
GerritPathuis 0:665e04c85d8d 273 SendCommand(DEEP_SLEEP_MODE);
GerritPathuis 0:665e04c85d8d 274 WaitUntilIdle();
GerritPathuis 0:665e04c85d8d 275 }
GerritPathuis 0:665e04c85d8d 276
GerritPathuis 8:01db118d1694 277 const unsigned char lut_full_update[] = {
GerritPathuis 8:01db118d1694 278 0x02, 0x02, 0x01, 0x11, 0x12, 0x12, 0x22, 0x22,
GerritPathuis 8:01db118d1694 279 0x66, 0x69, 0x69, 0x59, 0x58, 0x99, 0x99, 0x88,
GerritPathuis 8:01db118d1694 280 0x00, 0x00, 0x00, 0x00, 0xF8, 0xB4, 0x13, 0x51,
GerritPathuis 0:665e04c85d8d 281 0x35, 0x51, 0x51, 0x19, 0x01, 0x00
GerritPathuis 0:665e04c85d8d 282 };
GerritPathuis 0:665e04c85d8d 283
GerritPathuis 8:01db118d1694 284 const unsigned char lut_partial_update[] = {
GerritPathuis 8:01db118d1694 285 0x10, 0x18, 0x18, 0x08, 0x18, 0x18, 0x08, 0x00,
GerritPathuis 8:01db118d1694 286 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
GerritPathuis 8:01db118d1694 287 0x00, 0x00, 0x00, 0x00, 0x13, 0x14, 0x44, 0x12,
GerritPathuis 0:665e04c85d8d 288 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
GerritPathuis 0:665e04c85d8d 289 };
GerritPathuis 0:665e04c85d8d 290
GerritPathuis 0:665e04c85d8d 291
GerritPathuis 0:665e04c85d8d 292 /* END OF FILE */
GerritPathuis 0:665e04c85d8d 293
GerritPathuis 0:665e04c85d8d 294
GerritPathuis 0:665e04c85d8d 295