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@6:469fb6b0d26d, 2018-03-28 (annotated)

Committer:
GerritPathuis
Date:
Wed Mar 28 09:21:33 2018 +0000
Revision:
6:469fb6b0d26d
Parent:
3:e4399b5ceb4b
Child:
7:25cadf37fd86
Compilation succes

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 6:469fb6b0d26d 27 #ifndef MBED_H_
GerritPathuis 6:469fb6b0d26d 28 #define MBED_H_
GerritPathuis 6:469fb6b0d26d 29 #include "mbed.h"
GerritPathuis 6:469fb6b0d26d 30 #endif
GerritPathuis 0:665e04c85d8d 31 #include "epd1in54.h"
GerritPathuis 0:665e04c85d8d 32
GerritPathuis 0:665e04c85d8d 33 Epd::~Epd() {
GerritPathuis 0:665e04c85d8d 34 };
GerritPathuis 0:665e04c85d8d 35
GerritPathuis 0:665e04c85d8d 36 Epd::Epd() {
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 0:665e04c85d8d 45 int Epd::Init(const unsigned char* lut) {
GerritPathuis 0:665e04c85d8d 46 /* this calls the peripheral hardware interface, see epdif */
GerritPathuis 0:665e04c85d8d 47 if (IfInit() != 0) {
GerritPathuis 0:665e04c85d8d 48 return -1;
GerritPathuis 0:665e04c85d8d 49 }
GerritPathuis 0:665e04c85d8d 50 /* EPD hardware init start */
GerritPathuis 0:665e04c85d8d 51 this->lut = lut;
GerritPathuis 0:665e04c85d8d 52 Reset();
GerritPathuis 0:665e04c85d8d 53 SendCommand(DRIVER_OUTPUT_CONTROL);
GerritPathuis 0:665e04c85d8d 54 SendData((EPD_HEIGHT - 1) & 0xFF);
GerritPathuis 0:665e04c85d8d 55 SendData(((EPD_HEIGHT - 1) >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 56 SendData(0x00); // GD = 0; SM = 0; TB = 0;
GerritPathuis 0:665e04c85d8d 57 SendCommand(BOOSTER_SOFT_START_CONTROL);
GerritPathuis 0:665e04c85d8d 58 SendData(0xD7);
GerritPathuis 0:665e04c85d8d 59 SendData(0xD6);
GerritPathuis 0:665e04c85d8d 60 SendData(0x9D);
GerritPathuis 0:665e04c85d8d 61 SendCommand(WRITE_VCOM_REGISTER);
GerritPathuis 0:665e04c85d8d 62 SendData(0xA8); // VCOM 7C
GerritPathuis 0:665e04c85d8d 63 SendCommand(SET_DUMMY_LINE_PERIOD);
GerritPathuis 0:665e04c85d8d 64 SendData(0x1A); // 4 dummy lines per gate
GerritPathuis 0:665e04c85d8d 65 SendCommand(SET_GATE_TIME);
GerritPathuis 0:665e04c85d8d 66 SendData(0x08); // 2us per line
GerritPathuis 0:665e04c85d8d 67 SendCommand(DATA_ENTRY_MODE_SETTING);
GerritPathuis 0:665e04c85d8d 68 SendData(0x03); // X increment; Y increment
GerritPathuis 0:665e04c85d8d 69 SetLut(this->lut);
GerritPathuis 0:665e04c85d8d 70 /* EPD hardware init end */
GerritPathuis 0:665e04c85d8d 71 return 0;
GerritPathuis 0:665e04c85d8d 72 }
GerritPathuis 0:665e04c85d8d 73
GerritPathuis 0:665e04c85d8d 74 /**
GerritPathuis 0:665e04c85d8d 75 * @brief: basic function for sending commands
GerritPathuis 0:665e04c85d8d 76 */
GerritPathuis 0:665e04c85d8d 77 void Epd::SendCommand(unsigned char command) {
GerritPathuis 6:469fb6b0d26d 78 DigitalWrite(dc_pin_no, LOW);
GerritPathuis 0:665e04c85d8d 79 SpiTransfer(command);
GerritPathuis 0:665e04c85d8d 80 }
GerritPathuis 0:665e04c85d8d 81
GerritPathuis 0:665e04c85d8d 82 /**
GerritPathuis 0:665e04c85d8d 83 * @brief: basic function for sending data
GerritPathuis 0:665e04c85d8d 84 */
GerritPathuis 0:665e04c85d8d 85 void Epd::SendData(unsigned char data) {
GerritPathuis 6:469fb6b0d26d 86 DigitalWrite(dc_pin_no, HIGH);
GerritPathuis 0:665e04c85d8d 87 SpiTransfer(data);
GerritPathuis 0:665e04c85d8d 88 }
GerritPathuis 0:665e04c85d8d 89
GerritPathuis 1:d27a7e06c233 90
GerritPathuis 0:665e04c85d8d 91 /**
GerritPathuis 0:665e04c85d8d 92 * @brief: Wait until the busy_pin goes LOW
GerritPathuis 0:665e04c85d8d 93 */
GerritPathuis 0:665e04c85d8d 94 void Epd::WaitUntilIdle(void) {
GerritPathuis 6:469fb6b0d26d 95 while(DigitalRead(busy_pin_no) == HIGH) { //LOW: idle, HIGH: busy
GerritPathuis 0:665e04c85d8d 96 DelayMs(100);
GerritPathuis 0:665e04c85d8d 97 }
GerritPathuis 0:665e04c85d8d 98 }
GerritPathuis 0:665e04c85d8d 99
GerritPathuis 0:665e04c85d8d 100 /**
GerritPathuis 0:665e04c85d8d 101 * @brief: module reset.
GerritPathuis 0:665e04c85d8d 102 * often used to awaken the module in deep sleep,
GerritPathuis 0:665e04c85d8d 103 * see Epd::Sleep();
GerritPathuis 0:665e04c85d8d 104 */
GerritPathuis 0:665e04c85d8d 105 void Epd::Reset(void) {
GerritPathuis 6:469fb6b0d26d 106 DigitalWrite(reset_pin_no, LOW); //module reset
GerritPathuis 0:665e04c85d8d 107 DelayMs(200);
GerritPathuis 6:469fb6b0d26d 108 DigitalWrite(reset_pin_no, HIGH);
GerritPathuis 0:665e04c85d8d 109 DelayMs(200);
GerritPathuis 0:665e04c85d8d 110 }
GerritPathuis 0:665e04c85d8d 111
GerritPathuis 0:665e04c85d8d 112 /**
GerritPathuis 0:665e04c85d8d 113 * @brief: set the look-up table register
GerritPathuis 0:665e04c85d8d 114 */
GerritPathuis 0:665e04c85d8d 115 void Epd::SetLut(const unsigned char* lut) {
GerritPathuis 0:665e04c85d8d 116 this->lut = lut;
GerritPathuis 0:665e04c85d8d 117 SendCommand(WRITE_LUT_REGISTER);
GerritPathuis 0:665e04c85d8d 118 /* the length of look-up table is 30 bytes */
GerritPathuis 0:665e04c85d8d 119 for (int i = 0; i < 30; i++) {
GerritPathuis 0:665e04c85d8d 120 SendData(this->lut[i]);
GerritPathuis 0:665e04c85d8d 121 }
GerritPathuis 0:665e04c85d8d 122 }
GerritPathuis 0:665e04c85d8d 123
GerritPathuis 0:665e04c85d8d 124 /**
GerritPathuis 0:665e04c85d8d 125 * @brief: put an image buffer to the frame memory.
GerritPathuis 0:665e04c85d8d 126 * this won't update the display.
GerritPathuis 0:665e04c85d8d 127 */
GerritPathuis 0:665e04c85d8d 128 void Epd::SetFrameMemory(
GerritPathuis 0:665e04c85d8d 129 const unsigned char* image_buffer,
GerritPathuis 0:665e04c85d8d 130 int x,
GerritPathuis 0:665e04c85d8d 131 int y,
GerritPathuis 0:665e04c85d8d 132 int image_width,
GerritPathuis 0:665e04c85d8d 133 int image_height
GerritPathuis 0:665e04c85d8d 134 ) {
GerritPathuis 0:665e04c85d8d 135 int x_end;
GerritPathuis 0:665e04c85d8d 136 int y_end;
GerritPathuis 0:665e04c85d8d 137
GerritPathuis 0:665e04c85d8d 138 if (
GerritPathuis 0:665e04c85d8d 139 image_buffer == NULL ||
GerritPathuis 0:665e04c85d8d 140 x < 0 || image_width < 0 ||
GerritPathuis 0:665e04c85d8d 141 y < 0 || image_height < 0
GerritPathuis 0:665e04c85d8d 142 ) {
GerritPathuis 0:665e04c85d8d 143 return;
GerritPathuis 0:665e04c85d8d 144 }
GerritPathuis 0:665e04c85d8d 145 /* x point must be the multiple of 8 or the last 3 bits will be ignored */
GerritPathuis 0:665e04c85d8d 146 x &= 0xF8;
GerritPathuis 0:665e04c85d8d 147 image_width &= 0xF8;
GerritPathuis 0:665e04c85d8d 148 if (x + image_width >= this->width) {
GerritPathuis 0:665e04c85d8d 149 x_end = this->width - 1;
GerritPathuis 0:665e04c85d8d 150 } else {
GerritPathuis 0:665e04c85d8d 151 x_end = x + image_width - 1;
GerritPathuis 0:665e04c85d8d 152 }
GerritPathuis 0:665e04c85d8d 153 if (y + image_height >= this->height) {
GerritPathuis 0:665e04c85d8d 154 y_end = this->height - 1;
GerritPathuis 0:665e04c85d8d 155 } else {
GerritPathuis 0:665e04c85d8d 156 y_end = y + image_height - 1;
GerritPathuis 0:665e04c85d8d 157 }
GerritPathuis 0:665e04c85d8d 158 SetMemoryArea(x, y, x_end, y_end);
GerritPathuis 0:665e04c85d8d 159 SetMemoryPointer(x, y);
GerritPathuis 0:665e04c85d8d 160 SendCommand(WRITE_RAM);
GerritPathuis 0:665e04c85d8d 161 /* send the image data */
GerritPathuis 0:665e04c85d8d 162 for (int j = 0; j < y_end - y + 1; j++) {
GerritPathuis 0:665e04c85d8d 163 for (int i = 0; i < (x_end - x + 1) / 8; i++) {
GerritPathuis 0:665e04c85d8d 164 SendData(image_buffer[i + j * (image_width / 8)]);
GerritPathuis 0:665e04c85d8d 165 }
GerritPathuis 0:665e04c85d8d 166 }
GerritPathuis 0:665e04c85d8d 167 }
GerritPathuis 0:665e04c85d8d 168
GerritPathuis 0:665e04c85d8d 169 /**
GerritPathuis 0:665e04c85d8d 170 * @brief: put an image buffer to the frame memory.
GerritPathuis 0:665e04c85d8d 171 * this won't update the display.
GerritPathuis 0:665e04c85d8d 172 *
GerritPathuis 0:665e04c85d8d 173 * Question: When do you use this function instead of
GerritPathuis 0:665e04c85d8d 174 * void SetFrameMemory(
GerritPathuis 0:665e04c85d8d 175 * const unsigned char* image_buffer,
GerritPathuis 0:665e04c85d8d 176 * int x,
GerritPathuis 0:665e04c85d8d 177 * int y,
GerritPathuis 0:665e04c85d8d 178 * int image_width,
GerritPathuis 0:665e04c85d8d 179 * int image_height
GerritPathuis 0:665e04c85d8d 180 * );
GerritPathuis 0:665e04c85d8d 181 * Answer: SetFrameMemory with parameters only reads image data
GerritPathuis 0:665e04c85d8d 182 * from the RAM but not from the flash in AVR chips (for AVR chips,
GerritPathuis 0:665e04c85d8d 183 * you have to use the function pgm_read_byte to read buffers
GerritPathuis 0:665e04c85d8d 184 * from the flash).
GerritPathuis 0:665e04c85d8d 185 */
GerritPathuis 0:665e04c85d8d 186 void Epd::SetFrameMemory(const unsigned char* image_buffer) {
GerritPathuis 0:665e04c85d8d 187 SetMemoryArea(0, 0, this->width - 1, this->height - 1);
GerritPathuis 0:665e04c85d8d 188 SetMemoryPointer(0, 0);
GerritPathuis 0:665e04c85d8d 189 SendCommand(WRITE_RAM);
GerritPathuis 0:665e04c85d8d 190 /* send the image data */
GerritPathuis 0:665e04c85d8d 191 for (int i = 0; i < this->width / 8 * this->height; i++) {
GerritPathuis 3:e4399b5ceb4b 192 //SendData(pgm_read_byte(&image_buffer[i]));
GerritPathuis 1:d27a7e06c233 193 SendData(*(&image_buffer[i]));
GerritPathuis 0:665e04c85d8d 194 }
GerritPathuis 0:665e04c85d8d 195 }
GerritPathuis 0:665e04c85d8d 196
GerritPathuis 0:665e04c85d8d 197 /**
GerritPathuis 0:665e04c85d8d 198 * @brief: clear the frame memory with the specified color.
GerritPathuis 0:665e04c85d8d 199 * this won't update the display.
GerritPathuis 0:665e04c85d8d 200 */
GerritPathuis 0:665e04c85d8d 201 void Epd::ClearFrameMemory(unsigned char color) {
GerritPathuis 0:665e04c85d8d 202 SetMemoryArea(0, 0, this->width - 1, this->height - 1);
GerritPathuis 0:665e04c85d8d 203 SetMemoryPointer(0, 0);
GerritPathuis 0:665e04c85d8d 204 SendCommand(WRITE_RAM);
GerritPathuis 0:665e04c85d8d 205 /* send the color data */
GerritPathuis 0:665e04c85d8d 206 for (int i = 0; i < this->width / 8 * this->height; i++) {
GerritPathuis 0:665e04c85d8d 207 SendData(color);
GerritPathuis 0:665e04c85d8d 208 }
GerritPathuis 0:665e04c85d8d 209 }
GerritPathuis 0:665e04c85d8d 210
GerritPathuis 0:665e04c85d8d 211 /**
GerritPathuis 0:665e04c85d8d 212 * @brief: update the display
GerritPathuis 0:665e04c85d8d 213 * there are 2 memory areas embedded in the e-paper display
GerritPathuis 0:665e04c85d8d 214 * but once this function is called,
GerritPathuis 0:665e04c85d8d 215 * the the next action of SetFrameMemory or ClearFrame will
GerritPathuis 0:665e04c85d8d 216 * set the other memory area.
GerritPathuis 0:665e04c85d8d 217 */
GerritPathuis 0:665e04c85d8d 218 void Epd::DisplayFrame(void) {
GerritPathuis 0:665e04c85d8d 219 SendCommand(DISPLAY_UPDATE_CONTROL_2);
GerritPathuis 0:665e04c85d8d 220 SendData(0xC4);
GerritPathuis 0:665e04c85d8d 221 SendCommand(MASTER_ACTIVATION);
GerritPathuis 0:665e04c85d8d 222 SendCommand(TERMINATE_FRAME_READ_WRITE);
GerritPathuis 0:665e04c85d8d 223 WaitUntilIdle();
GerritPathuis 0:665e04c85d8d 224 }
GerritPathuis 0:665e04c85d8d 225
GerritPathuis 0:665e04c85d8d 226 /**
GerritPathuis 0:665e04c85d8d 227 * @brief: private function to specify the memory area for data R/W
GerritPathuis 0:665e04c85d8d 228 */
GerritPathuis 0:665e04c85d8d 229 void Epd::SetMemoryArea(int x_start, int y_start, int x_end, int y_end) {
GerritPathuis 0:665e04c85d8d 230 SendCommand(SET_RAM_X_ADDRESS_START_END_POSITION);
GerritPathuis 0:665e04c85d8d 231 /* x point must be the multiple of 8 or the last 3 bits will be ignored */
GerritPathuis 0:665e04c85d8d 232 SendData((x_start >> 3) & 0xFF);
GerritPathuis 0:665e04c85d8d 233 SendData((x_end >> 3) & 0xFF);
GerritPathuis 0:665e04c85d8d 234 SendCommand(SET_RAM_Y_ADDRESS_START_END_POSITION);
GerritPathuis 0:665e04c85d8d 235 SendData(y_start & 0xFF);
GerritPathuis 0:665e04c85d8d 236 SendData((y_start >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 237 SendData(y_end & 0xFF);
GerritPathuis 0:665e04c85d8d 238 SendData((y_end >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 239 }
GerritPathuis 0:665e04c85d8d 240
GerritPathuis 0:665e04c85d8d 241 /**
GerritPathuis 0:665e04c85d8d 242 * @brief: private function to specify the start point for data R/W
GerritPathuis 0:665e04c85d8d 243 */
GerritPathuis 0:665e04c85d8d 244 void Epd::SetMemoryPointer(int x, int y) {
GerritPathuis 0:665e04c85d8d 245 SendCommand(SET_RAM_X_ADDRESS_COUNTER);
GerritPathuis 0:665e04c85d8d 246 /* x point must be the multiple of 8 or the last 3 bits will be ignored */
GerritPathuis 0:665e04c85d8d 247 SendData((x >> 3) & 0xFF);
GerritPathuis 0:665e04c85d8d 248 SendCommand(SET_RAM_Y_ADDRESS_COUNTER);
GerritPathuis 0:665e04c85d8d 249 SendData(y & 0xFF);
GerritPathuis 0:665e04c85d8d 250 SendData((y >> 8) & 0xFF);
GerritPathuis 0:665e04c85d8d 251 WaitUntilIdle();
GerritPathuis 0:665e04c85d8d 252 }
GerritPathuis 0:665e04c85d8d 253
GerritPathuis 0:665e04c85d8d 254 /**
GerritPathuis 0:665e04c85d8d 255 * @brief: After this command is transmitted, the chip would enter the
GerritPathuis 0:665e04c85d8d 256 * deep-sleep mode to save power.
GerritPathuis 0:665e04c85d8d 257 * The deep sleep mode would return to standby by hardware reset.
GerritPathuis 0:665e04c85d8d 258 * You can use Epd::Init() to awaken
GerritPathuis 0:665e04c85d8d 259 */
GerritPathuis 0:665e04c85d8d 260 void Epd::Sleep() {
GerritPathuis 0:665e04c85d8d 261 SendCommand(DEEP_SLEEP_MODE);
GerritPathuis 0:665e04c85d8d 262 WaitUntilIdle();
GerritPathuis 0:665e04c85d8d 263 }
GerritPathuis 0:665e04c85d8d 264
GerritPathuis 0:665e04c85d8d 265 const unsigned char lut_full_update[] =
GerritPathuis 0:665e04c85d8d 266 {
GerritPathuis 0:665e04c85d8d 267 0x02, 0x02, 0x01, 0x11, 0x12, 0x12, 0x22, 0x22,
GerritPathuis 0:665e04c85d8d 268 0x66, 0x69, 0x69, 0x59, 0x58, 0x99, 0x99, 0x88,
GerritPathuis 0:665e04c85d8d 269 0x00, 0x00, 0x00, 0x00, 0xF8, 0xB4, 0x13, 0x51,
GerritPathuis 0:665e04c85d8d 270 0x35, 0x51, 0x51, 0x19, 0x01, 0x00
GerritPathuis 0:665e04c85d8d 271 };
GerritPathuis 0:665e04c85d8d 272
GerritPathuis 0:665e04c85d8d 273 const unsigned char lut_partial_update[] =
GerritPathuis 0:665e04c85d8d 274 {
GerritPathuis 0:665e04c85d8d 275 0x10, 0x18, 0x18, 0x08, 0x18, 0x18, 0x08, 0x00,
GerritPathuis 0:665e04c85d8d 276 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
GerritPathuis 0:665e04c85d8d 277 0x00, 0x00, 0x00, 0x00, 0x13, 0x14, 0x44, 0x12,
GerritPathuis 0:665e04c85d8d 278 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
GerritPathuis 0:665e04c85d8d 279 };
GerritPathuis 0:665e04c85d8d 280
GerritPathuis 0:665e04c85d8d 281
GerritPathuis 0:665e04c85d8d 282 /* END OF FILE */
GerritPathuis 0:665e04c85d8d 283
GerritPathuis 0:665e04c85d8d 284
GerritPathuis 0:665e04c85d8d 285