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@0:665e04c85d8d, 2018-03-25 (annotated)

Committer:
GerritPathuis
Date:
Sun Mar 25 12:14:55 2018 +0000
Revision:
0:665e04c85d8d
Child:
1:d27a7e06c233
Start point

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