GxEPD2_SD_Example.ino 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  1. // GxEPD2_SD_Example : Display Library example for SPI e-paper panels from Dalian Good Display and boards from Waveshare.
  2. // Requires HW SPI and Adafruit_GFX. Caution: these e-papers require 3.3V supply AND data lines!
  3. //
  4. // Display Library based on Demo Example from Good Display: http://www.good-display.com/download_list/downloadcategoryid=34&isMode=false.html
  5. //
  6. // BMP handling code extracts taken from: https://github.com/prenticedavid/MCUFRIEND_kbv/tree/master/examples/showBMP_kbv_Uno
  7. //
  8. // Author: Jean-Marc Zingg
  9. //
  10. // Version: see library.properties
  11. //
  12. // Library: https://github.com/ZinggJM/GxEPD2
  13. // Supporting Arduino Forum Topics:
  14. // Waveshare e-paper displays with SPI: http://forum.arduino.cc/index.php?topic=487007.0
  15. // Good Dispay ePaper for Arduino : https://forum.arduino.cc/index.php?topic=436411.0
  16. // mapping suggestion from Waveshare SPI e-Paper to Wemos D1 mini
  17. // BUSY -> D2, RST -> D4, DC -> D3, CS -> D8, CLK -> D5, DIN -> D7, GND -> GND, 3.3V -> 3.3V
  18. // mapping suggestion from Waveshare SPI e-Paper to generic ESP8266
  19. // BUSY -> GPIO4, RST -> GPIO2, DC -> GPIO0, CS -> GPIO15, CLK -> GPIO14, DIN -> GPIO13, GND -> GND, 3.3V -> 3.3V
  20. // mapping of Waveshare e-Paper ESP8266 Driver Board
  21. // BUSY -> GPIO16, RST -> GPIO5, DC -> GPIO4, CS -> GPIO15, CLK -> GPIO14, DIN -> GPIO13, GND -> GND, 3.3V -> 3.3V
  22. // mapping suggestion for ESP32, e.g. LOLIN32, see .../variants/.../pins_arduino.h for your board
  23. // NOTE: there are variants with different pins for SPI ! CHECK SPI PINS OF YOUR BOARD
  24. // BUSY -> 4, RST -> 16, DC -> 17, CS -> SS(5), CLK -> SCK(18), DIN -> MOSI(23), GND -> GND, 3.3V -> 3.3V
  25. // new mapping suggestion for STM32F1, e.g. STM32F103C8T6 "BluePill"
  26. // BUSY -> A1, RST -> A2, DC -> A3, CS-> A4, CLK -> A5, DIN -> A7
  27. // mapping suggestion for AVR, UNO, NANO etc.
  28. // BUSY -> 7, RST -> 9, DC -> 8, CS-> 10, CLK -> 13, DIN -> 11
  29. //
  30. // **** NOTE that the mapping suggestion may need modification depending on SD board used! ****
  31. // ********************************************************************************************
  32. //
  33. //#define SD_CS SS // e.g. for RobotDyn Wemos D1 mini SD board
  34. //#define EPD_CS D1 // alternative I use with RobotDyn Wemos D1 mini SD board
  35. #include <GxEPD2_BW.h>
  36. #include <GxEPD2_3C.h>
  37. #include <Fonts/FreeMonoBold9pt7b.h>
  38. #if defined(ESP32)
  39. // has support for FAT32 support with long filenames
  40. #include "FS.h"
  41. #include "SD.h"
  42. #include "SPI.h"
  43. #define SdFile File
  44. #define seekSet seek
  45. #else
  46. // include SdFat for FAT32 support with long filenames; available through Library Manager
  47. #include <SdFat.h>
  48. SdFat SD;
  49. #endif
  50. #if defined (ESP8266)
  51. #define SD_CS SS // e.g. for RobotDyn Wemos D1 mini SD board
  52. #define EPD_CS D1 // alternative I use with RobotDyn Wemos D1 mini SD board
  53. // select one and adapt to your mapping, can use full buffer size (full HEIGHT)
  54. //GxEPD2_BW<GxEPD2_154, GxEPD2_154::HEIGHT> display(GxEPD2_154(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  55. //GxEPD2_BW<GxEPD2_213, GxEPD2_213::HEIGHT> display(GxEPD2_213(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  56. //GxEPD2_BW<GxEPD2_290, GxEPD2_290::HEIGHT> display(GxEPD2_290(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  57. //GxEPD2_BW<GxEPD2_270, GxEPD2_270::HEIGHT> display(GxEPD2_270(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  58. //GxEPD2_BW<GxEPD2_420, GxEPD2_420::HEIGHT> display(GxEPD2_420(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  59. // can use only half buffer size
  60. //GxEPD2_BW < GxEPD2_583, GxEPD2_583::HEIGHT / 2 > display(GxEPD2_583(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  61. //GxEPD2_BW < GxEPD2_750, GxEPD2_750::HEIGHT / 2 > display(GxEPD2_750(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  62. // 3-color e-papers
  63. // !!! can't be used for this // GxEPD2_3C<GxEPD2_154c, GxEPD2_154c::HEIGHT> display(GxEPD2_154c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  64. //GxEPD2_3C<GxEPD2_213c, GxEPD2_213c::HEIGHT> display(GxEPD2_213c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  65. //GxEPD2_3C<GxEPD2_290c, GxEPD2_290c::HEIGHT> display(GxEPD2_290c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  66. //GxEPD2_3C<GxEPD2_270c, GxEPD2_270c::HEIGHT> display(GxEPD2_270c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  67. // can use only half buffer size
  68. //GxEPD2_3C<GxEPD2_420c, GxEPD2_420c::HEIGHT / 2> display(GxEPD2_420c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  69. // can use only quarter buffer size
  70. //GxEPD2_3C<GxEPD2_583c, GxEPD2_583c::HEIGHT / 4> display(GxEPD2_583c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  71. //GxEPD2_3C<GxEPD2_750c, GxEPD2_750c::HEIGHT / 4> display(GxEPD2_750c(/*CS=D8*/ EPD_CS, /*DC=D3*/ 0, /*RST=D4*/ 2, /*BUSY=D2*/ 4));
  72. // ***** for mapping of Waveshare e-Paper ESP8266 Driver Board *****
  73. // select one , can use full buffer size (full HEIGHT)
  74. //GxEPD2_BW<GxEPD2_154, GxEPD2_154::HEIGHT> display(GxEPD2_154(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  75. //GxEPD2_BW<GxEPD2_213, GxEPD2_213::HEIGHT> display(GxEPD2_213(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  76. //GxEPD2_BW<GxEPD2_290, GxEPD2_290::HEIGHT> display(GxEPD2_290(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  77. //GxEPD2_BW<GxEPD2_270, GxEPD2_270::HEIGHT> display(GxEPD2_270(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  78. //GxEPD2_BW<GxEPD2_420, GxEPD2_420::HEIGHT> display(GxEPD2_420(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  79. // can use only half buffer size
  80. //GxEPD2_BW < GxEPD2_583, GxEPD2_583::HEIGHT / 2 > display(GxEPD2_583(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  81. //GxEPD2_BW < GxEPD2_750, GxEPD2_750::HEIGHT / 2 > display(GxEPD2_750(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  82. // 3-color e-papers
  83. // !!! can't be used for this //GxEPD2_3C<GxEPD2_154c, GxEPD2_154c::HEIGHT> display(GxEPD2_154c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  84. //GxEPD2_3C<GxEPD2_213c, GxEPD2_213c::HEIGHT> display(GxEPD2_213c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  85. //GxEPD2_3C<GxEPD2_290c, GxEPD2_290c::HEIGHT> display(GxEPD2_290c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  86. //GxEPD2_3C<GxEPD2_270c, GxEPD2_270c::HEIGHT> display(GxEPD2_270c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  87. // can use only half buffer size
  88. //GxEPD2_3C<GxEPD2_420c, GxEPD2_420c::HEIGHT / 2> display(GxEPD2_420c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  89. // can use only quarter buffer size
  90. //GxEPD2_3C<GxEPD2_583c, GxEPD2_583c::HEIGHT / 4> display(GxEPD2_583c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  91. //GxEPD2_3C<GxEPD2_750c, GxEPD2_750c::HEIGHT / 4> display(GxEPD2_750c(/*CS=15*/ SS, /*DC=4*/ 4, /*RST=5*/ 5, /*BUSY=16*/ 16));
  92. #endif
  93. #if defined(ESP32)
  94. #define SD_CS 2 // adapt to your wiring
  95. #define EPD_CS SS // adapt to your wiring
  96. // select one and adapt to your mapping, can use full buffer size (full HEIGHT)
  97. //GxEPD2_BW<GxEPD2_154, GxEPD2_154::HEIGHT> display(GxEPD2_154(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  98. //GxEPD2_BW<GxEPD2_213, GxEPD2_213::HEIGHT> display(GxEPD2_213(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  99. //GxEPD2_BW<GxEPD2_290, GxEPD2_290::HEIGHT> display(GxEPD2_290(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  100. //GxEPD2_BW<GxEPD2_270, GxEPD2_270::HEIGHT> display(GxEPD2_270(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  101. //GxEPD2_BW<GxEPD2_420, GxEPD2_420::HEIGHT> display(GxEPD2_420(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  102. //GxEPD2_BW<GxEPD2_750, GxEPD2_750::HEIGHT> display(GxEPD2_750(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  103. // 3-color e-papers
  104. // !!! can't be used for this //GxEPD2_3C<GxEPD2_154c, GxEPD2_154c::HEIGHT> display(GxEPD2_154c(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  105. //GxEPD2_3C<GxEPD2_213c, GxEPD2_213c::HEIGHT> display(GxEPD2_213c(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  106. //GxEPD2_3C<GxEPD2_290c, GxEPD2_290c::HEIGHT> display(GxEPD2_290c(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  107. //GxEPD2_3C<GxEPD2_270c, GxEPD2_270c::HEIGHT> display(GxEPD2_270c(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  108. //GxEPD2_3C<GxEPD2_420c, GxEPD2_420c::HEIGHT> display(GxEPD2_420c(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  109. //GxEPD2_3C<GxEPD2_750c, GxEPD2_750c::HEIGHT> display(GxEPD2_750c(/*CS=5*/ EPD_CS, /*DC=*/ 17, /*RST=*/ 16, /*BUSY=*/ 4));
  110. #endif
  111. #if defined(_BOARD_GENERIC_STM32F103C_H_)
  112. #define SD_CS 0 // adapt to your wiring
  113. #define EPD_CS SS // adapt to your wiring
  114. #define MAX_DISPAY_BUFFER_SIZE 15000ul // ~15k is a good compromise
  115. #define MAX_HEIGHT(EPD) (EPD::HEIGHT <= MAX_DISPAY_BUFFER_SIZE / (EPD::WIDTH / 8) ? EPD::HEIGHT : MAX_DISPAY_BUFFER_SIZE / (EPD::WIDTH / 8))
  116. // select one and adapt to your mapping
  117. //GxEPD2_BW<GxEPD2_154, MAX_HEIGHT(GxEPD2_154)> display(GxEPD2_154(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  118. //GxEPD2_BW<GxEPD2_213, MAX_HEIGHT(GxEPD2_213)> display(GxEPD2_213(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  119. //GxEPD2_BW<GxEPD2_290, MAX_HEIGHT(GxEPD2_290)> display(GxEPD2_290(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  120. //GxEPD2_BW<GxEPD2_270, MAX_HEIGHT(GxEPD2_270)> display(GxEPD2_270(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  121. //GxEPD2_BW<GxEPD2_420, MAX_HEIGHT(GxEPD2_420)> display(GxEPD2_420(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  122. //GxEPD2_BW<GxEPD2_750, MAX_HEIGHT(GxEPD2_750)> display(GxEPD2_750(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  123. // 3-color e-papers
  124. #define MAX_HEIGHT_3C(EPD) (EPD::HEIGHT <= (MAX_DISPAY_BUFFER_SIZE / 2) / (EPD::WIDTH / 8) ? EPD::HEIGHT : (MAX_DISPAY_BUFFER_SIZE / 2) / (EPD::WIDTH / 8))
  125. // !!! can't be used for this //GxEPD2_3C<GxEPD2_154c, MAX_HEIGHT_3C(GxEPD2_154c)> display(GxEPD2_154c(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  126. //GxEPD2_3C<GxEPD2_213c, MAX_HEIGHT_3C(GxEPD2_213c)> display(GxEPD2_213c(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  127. //GxEPD2_3C<GxEPD2_290c, MAX_HEIGHT_3C(GxEPD2_290c)> display(GxEPD2_290c(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  128. //GxEPD2_3C<GxEPD2_270c, MAX_HEIGHT_3C(GxEPD2_270c)> display(GxEPD2_270c(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  129. //GxEPD2_3C<GxEPD2_420c, MAX_HEIGHT_3C(GxEPD2_420c)> display(GxEPD2_420c(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  130. //GxEPD2_3C<GxEPD2_750c, MAX_HEIGHT_3C(GxEPD2_750c)> display(GxEPD2_750c(/*CS=4*/ EPD_CS, /*DC=*/ 3, /*RST=*/ 2, /*BUSY=*/ 1));
  131. #endif
  132. #if defined(__AVR)
  133. #define SD_CS 6 // adapt to your wiring
  134. #define EPD_CS SS // adapt to your wiring
  135. // most AVR Arduinos have not enough RAM for use with SD and buffered graphics
  136. // !!! use GxEPD2_SD_AVR_Example.ino instead !!!
  137. //GxEPD2_154 display(/*CS=10*/ EPD_CS, /*DC=*/ 8, /*RST=*/ 9, /*BUSY=*/ 7);
  138. #endif
  139. // function declaration with default parameter
  140. void drawBitmapFromSD(const char *filename, int16_t x, int16_t y, bool with_color = true);
  141. void setup()
  142. {
  143. Serial.begin(115200);
  144. Serial.println();
  145. Serial.println("setup");
  146. display.init(115200);
  147. Serial.print("Initializing SD card...");
  148. if (!SD.begin(SD_CS))
  149. {
  150. Serial.println("SD failed!");
  151. return;
  152. }
  153. Serial.println("SD OK!");
  154. drawBitmaps_200x200();
  155. drawBitmaps_other();
  156. }
  157. void loop(void)
  158. {
  159. }
  160. void drawBitmaps_200x200()
  161. {
  162. int16_t x = (display.width() - 200) / 2;
  163. int16_t y = (display.height() - 200) / 2;
  164. drawBitmapFromSD("logo200x200.bmp", x, y);
  165. delay(2000);
  166. drawBitmapFromSD("first200x200.bmp", x, y);
  167. delay(2000);
  168. drawBitmapFromSD("second200x200.bmp", x, y);
  169. delay(2000);
  170. drawBitmapFromSD("third200x200.bmp", x, y);
  171. delay(2000);
  172. drawBitmapFromSD("fourth200x200.bmp", x, y);
  173. delay(2000);
  174. drawBitmapFromSD("fifth200x200.bmp", x, y);
  175. delay(2000);
  176. drawBitmapFromSD("sixth200x200.bmp", x, y);
  177. delay(2000);
  178. drawBitmapFromSD("seventh200x200.bmp", x, y);
  179. delay(2000);
  180. drawBitmapFromSD("eighth200x200.bmp", x, y);
  181. delay(2000);
  182. }
  183. void drawBitmaps_other()
  184. {
  185. int16_t w2 = display.width() / 2;
  186. int16_t h2 = display.height() / 2;
  187. drawBitmapFromSD("parrot.bmp", w2 - 64, h2 - 80);
  188. delay(2000);
  189. drawBitmapFromSD("betty_1.bmp", w2 - 100, h2 - 160);
  190. delay(2000);
  191. drawBitmapFromSD("betty_4.bmp", w2 - 102, h2 - 126);
  192. delay(2000);
  193. drawBitmapFromSD("marilyn_240x240x8.bmp", w2 - 120, h2 - 120);
  194. delay(2000);
  195. drawBitmapFromSD("miniwoof.bmp", w2 - 60, h2 - 80);
  196. delay(2000);
  197. drawBitmapFromSD("t200x200.bmp", w2 - 100, h2 - 100);
  198. delay(2000);
  199. drawBitmapFromSD("test.bmp", w2 - 120, h2 - 160);
  200. delay(2000);
  201. drawBitmapFromSD("tiger.bmp", w2 - 160, h2 - 120);
  202. delay(2000);
  203. drawBitmapFromSD("tiger_178x160x4.bmp", w2 - 89, h2 - 80);
  204. delay(2000);
  205. drawBitmapFromSD("tiger_240x317x4.bmp", w2 - 120, h2 - 160);
  206. delay(2000);
  207. drawBitmapFromSD("tiger_320x200x24.bmp", w2 - 160, h2 - 100);
  208. delay(2000);
  209. drawBitmapFromSD("tiger16T.bmp", w2 - 160, h2 - 120);
  210. delay(2000);
  211. drawBitmapFromSD("woof.bmp", w2 - 120, h2 - 160);
  212. delay(2000);
  213. }
  214. static const uint16_t input_buffer_pixels = 20; // may affect performance
  215. static const uint16_t max_row_width = 640; // for up to 7.5" display
  216. static const uint16_t max_palette_pixels = 256; // for depth <= 8
  217. uint8_t input_buffer[3 * input_buffer_pixels]; // up to depth 24
  218. uint8_t output_row_mono_buffer[max_row_width / 8]; // buffer for at least one row of b/w bits
  219. uint8_t output_row_color_buffer[max_row_width / 8]; // buffer for at least one row of color bits
  220. uint8_t mono_palette_buffer[max_palette_pixels / 8]; // palette buffer for depth <= 8 b/w
  221. uint8_t color_palette_buffer[max_palette_pixels / 8]; // palette buffer for depth <= 8 c/w
  222. void drawBitmapFromSD(const char *filename, int16_t x, int16_t y, bool with_color)
  223. {
  224. SdFile file;
  225. bool valid = false; // valid format to be handled
  226. bool flip = true; // bitmap is stored bottom-to-top
  227. uint32_t startTime = millis();
  228. if ((x >= display.width()) || (y >= display.height())) return;
  229. Serial.println();
  230. Serial.print("Loading image '");
  231. Serial.print(filename);
  232. Serial.println('\'');
  233. #if defined(ESP32)
  234. file = SD.open(String("/") + filename, FILE_READ);
  235. if (!file)
  236. {
  237. Serial.print("File not found");
  238. return;
  239. }
  240. #else
  241. if (!file.open(filename, FILE_READ))
  242. {
  243. Serial.print("File not found");
  244. return;
  245. }
  246. #endif
  247. // Parse BMP header
  248. if (read16(file) == 0x4D42) // BMP signature
  249. {
  250. uint32_t fileSize = read32(file);
  251. uint32_t creatorBytes = read32(file);
  252. uint32_t imageOffset = read32(file); // Start of image data
  253. uint32_t headerSize = read32(file);
  254. uint32_t width = read32(file);
  255. uint32_t height = read32(file);
  256. uint16_t planes = read16(file);
  257. uint16_t depth = read16(file); // bits per pixel
  258. uint32_t format = read32(file);
  259. if ((planes == 1) && ((format == 0) || (format == 3))) // uncompressed is handled, 565 also
  260. {
  261. Serial.print("File size: "); Serial.println(fileSize);
  262. Serial.print("Image Offset: "); Serial.println(imageOffset);
  263. Serial.print("Header size: "); Serial.println(headerSize);
  264. Serial.print("Bit Depth: "); Serial.println(depth);
  265. Serial.print("Image size: ");
  266. Serial.print(width);
  267. Serial.print('x');
  268. Serial.println(height);
  269. // BMP rows are padded (if needed) to 4-byte boundary
  270. uint32_t rowSize = (width * depth / 8 + 3) & ~3;
  271. if (height < 0)
  272. {
  273. height = -height;
  274. flip = false;
  275. }
  276. uint16_t w = width;
  277. uint16_t h = height;
  278. if ((x + w - 1) >= display.width()) w = display.width() - x;
  279. if ((y + h - 1) >= display.height()) h = display.height() - y;
  280. if (w < max_row_width) // handle with direct drawing
  281. {
  282. valid = true;
  283. uint8_t bitmask = 0xFF;
  284. uint8_t bitshift = 8 - depth;
  285. uint16_t red, green, blue;
  286. bool whitish, colored;
  287. if (depth == 1) with_color = false;
  288. if (depth <= 8)
  289. {
  290. if (depth < 8) bitmask >>= depth;
  291. file.seekSet(54); //palette is always @ 54
  292. for (uint16_t pn = 0; pn < (1 << depth); pn++)
  293. {
  294. blue = file.read();
  295. green = file.read();
  296. red = file.read();
  297. file.read();
  298. whitish = with_color ? ((red > 0x80) && (green > 0x80) && (blue > 0x80)) : ((red + green + blue) > 3 * 0x80); // whitish
  299. colored = (red > 0xF0) || ((green > 0xF0) && (blue > 0xF0)); // reddish or yellowish?
  300. if (0 == pn % 8) mono_palette_buffer[pn / 8] = 0;
  301. mono_palette_buffer[pn / 8] |= whitish << pn % 8;
  302. if (0 == pn % 8) color_palette_buffer[pn / 8] = 0;
  303. color_palette_buffer[pn / 8] |= colored << pn % 8;
  304. }
  305. }
  306. display.clearScreen();
  307. uint32_t rowPosition = flip ? imageOffset + (height - h) * rowSize : imageOffset;
  308. for (uint16_t row = 0; row < h; row++, rowPosition += rowSize) // for each line
  309. {
  310. uint32_t in_remain = rowSize;
  311. uint32_t in_idx = 0;
  312. uint32_t in_bytes = 0;
  313. uint8_t in_byte = 0; // for depth <= 8
  314. uint8_t in_bits = 0; // for depth <= 8
  315. uint8_t out_byte = 0;
  316. uint8_t out_color_byte = 0;
  317. uint32_t out_idx = 0;
  318. file.seekSet(rowPosition);
  319. for (uint16_t col = 0; col < w; col++) // for each pixel
  320. {
  321. // Time to read more pixel data?
  322. if (in_idx >= in_bytes) // ok, exact match for 24bit also (size IS multiple of 3)
  323. {
  324. in_bytes = file.read(input_buffer, in_remain > sizeof(input_buffer) ? sizeof(input_buffer) : in_remain);
  325. in_remain -= in_bytes;
  326. in_idx = 0;
  327. }
  328. switch (depth)
  329. {
  330. case 24:
  331. blue = input_buffer[in_idx++];
  332. green = input_buffer[in_idx++];
  333. red = input_buffer[in_idx++];
  334. whitish = with_color ? ((red > 0x80) && (green > 0x80) && (blue > 0x80)) : ((red + green + blue) > 3 * 0x80); // whitish
  335. colored = (red > 0xF0) || ((green > 0xF0) && (blue > 0xF0)); // reddish or yellowish?
  336. break;
  337. case 16:
  338. {
  339. uint8_t lsb = input_buffer[in_idx++];
  340. uint8_t msb = input_buffer[in_idx++];
  341. if (format == 0) // 555
  342. {
  343. blue = (lsb & 0x1F) << 3;
  344. green = ((msb & 0x03) << 6) | ((lsb & 0xE0) >> 2);
  345. red = (msb & 0x7C) << 1;
  346. }
  347. else // 565
  348. {
  349. blue = (lsb & 0x1F) << 3;
  350. green = ((msb & 0x07) << 5) | ((lsb & 0xE0) >> 3);
  351. red = (msb & 0xF8);
  352. }
  353. whitish = with_color ? ((red > 0x80) && (green > 0x80) && (blue > 0x80)) : ((red + green + blue) > 3 * 0x80); // whitish
  354. colored = (red > 0xF0) || ((green > 0xF0) && (blue > 0xF0)); // reddish or yellowish?
  355. }
  356. break;
  357. case 1:
  358. case 4:
  359. case 8:
  360. {
  361. if (0 == in_bits)
  362. {
  363. in_byte = input_buffer[in_idx++];
  364. in_bits = 8;
  365. }
  366. uint16_t pn = (in_byte >> bitshift) & bitmask;
  367. whitish = mono_palette_buffer[pn / 8] & (0x1 << pn % 8);
  368. colored = color_palette_buffer[pn / 8] & (0x1 << pn % 8);
  369. in_byte <<= depth;
  370. in_bits -= depth;
  371. }
  372. break;
  373. }
  374. if (whitish)
  375. {
  376. out_byte |= 0x80 >> col % 8; // not black
  377. out_color_byte |= 0x80 >> col % 8; // not colored
  378. }
  379. else if (colored && with_color)
  380. {
  381. out_byte |= 0x80 >> col % 8; // not black
  382. }
  383. else
  384. {
  385. out_color_byte |= 0x80 >> col % 8; // not colored
  386. }
  387. if (7 == col % 8)
  388. {
  389. output_row_color_buffer[out_idx] = out_color_byte;
  390. output_row_mono_buffer[out_idx++] = out_byte;
  391. out_byte = 0;
  392. out_color_byte = 0;
  393. }
  394. } // end pixel
  395. uint16_t yrow = y + (flip ? h - row - 1 : row);
  396. display.writeImage(output_row_mono_buffer, output_row_color_buffer, x, yrow, w, 1);
  397. } // end line
  398. Serial.print("loaded in "); Serial.print(millis() - startTime); Serial.println(" ms");
  399. display.refresh();
  400. }
  401. }
  402. }
  403. //Serial.print("end curPosition "); Serial.println(file.curPosition());
  404. file.close();
  405. if (!valid)
  406. {
  407. Serial.println("bitmap format not handled.");
  408. }
  409. }
  410. uint16_t read16(SdFile& f)
  411. {
  412. // BMP data is stored little-endian, same as Arduino.
  413. uint16_t result;
  414. ((uint8_t *)&result)[0] = f.read(); // LSB
  415. ((uint8_t *)&result)[1] = f.read(); // MSB
  416. return result;
  417. }
  418. uint32_t read32(SdFile& f)
  419. {
  420. // BMP data is stored little-endian, same as Arduino.
  421. uint32_t result;
  422. ((uint8_t *)&result)[0] = f.read(); // LSB
  423. ((uint8_t *)&result)[1] = f.read();
  424. ((uint8_t *)&result)[2] = f.read();
  425. ((uint8_t *)&result)[3] = f.read(); // MSB
  426. return result;
  427. }