Adafruit Library
dispDrvThinkInkGrayscale4T5.h
Go to the documentation of this file.
1 
16 #ifndef WS_DRV_THINKINK_GRAYSCALE4_T5_H
17 #define WS_DRV_THINKINK_GRAYSCALE4_T5_H
18 
19 #include "dispDrvBase.h"
20 
26 public:
40  dispDrvThinkInkGrayscale4T5(int16_t dc, int16_t rst, int16_t cs,
41  int16_t sram_cs = -1, int16_t busy = -1)
42  : dispDrvBase(dc, rst, cs, sram_cs, busy), _display(nullptr) {}
43 
45  if (_display) {
46  // Clear the display buffer before deleting
47  _display->clearBuffer();
48  _display->display();
49  delete _display;
50  _display = nullptr;
51  }
52  }
53 
63  bool begin(thinkinkmode_t mode, bool reset = true) override {
64  _display = new ThinkInk_290_Grayscale4_T5(_pin_dc, _pin_rst, _pin_cs,
66  if (!_display)
67  return false; // Allocation failed
68 
69  // Initialize the display
70  _display->begin(mode);
71  // Configure display settings
72  _display->setTextSize(_text_sz);
73  _display->setTextColor(EPD_BLACK);
74  _display->setTextWrap(false);
75  _height = _display->height();
76  _width = _display->width();
77  // Clear the display buffer
78  _display->clearBuffer();
79  _display->display();
80 
81  return true;
82  }
83 
89  virtual void drawStatusBar(const char *io_username) override {
90  if (!_display)
91  return;
92 
93  // Clear the entire display buffer to remove splash screen
94  _display->clearBuffer();
95 
96  // Draw status bar
97  _display->fillRect(0, 0, _display->width(), STATUS_BAR_HEIGHT, EPD_BLACK);
98  _display->fillRect(STATUS_BAR_BORDER, STATUS_BAR_BORDER,
99  _display->width() - (2 * STATUS_BAR_BORDER),
100  STATUS_BAR_HEIGHT - (2 * STATUS_BAR_BORDER), EPD_WHITE);
101 
102  // Draw username on left side of the status bar
103  _display->setTextSize(1);
104  _display->setTextColor(EPD_BLACK);
105  _display->setCursor(5, 6);
106  _display->print(io_username);
107 
108  // Calculate status bar icon positions and center vertically
113  _display->width() - STATUS_BAR_ICON_SZ - STATUS_BAR_ICON_MARGIN;
118  // Draw icons on right side of the status bar
119  _display->drawBitmap(_statusbar_icon_cloud_x, _statusbar_icons_y,
121  STATUS_BAR_ICON_SZ, EPD_BLACK);
122  _display->drawBitmap(_statusbar_icon_wifi_x, _statusbar_icons_y,
124  STATUS_BAR_ICON_SZ, EPD_BLACK);
125  _display->drawBitmap(_statusbar_icon_battery_x, _statusbar_icons_y,
127  STATUS_BAR_ICON_SZ, EPD_BLACK);
128 
129  _display->display();
130  }
131 
142  void updateStatusBar(int8_t rssi, uint8_t bat, bool mqtt_status) override {
143  if (!_display)
144  return;
145 
146  // Only update wifi icon if the RSSI has changed significantly (+/- 5dB)
147  bool update_rssi = abs(rssi - _statusbar_rssi) >= 5;
148  // Only update cloud icon if MQTT status has changed
149  bool update_mqtt = mqtt_status != _statusbar_mqtt_connected;
150 
151  // No need to update if nothing has changed
152  if (!update_rssi && !update_mqtt)
153  return;
154 
155  if (update_mqtt) {
156  // updating the RSSI occurs too frequently to be practical
157  _display->fillRect(_statusbar_icon_cloud_x, _statusbar_icons_y,
159  if (mqtt_status) {
160  _display->drawBitmap(_statusbar_icon_cloud_x, _statusbar_icons_y,
162  STATUS_BAR_ICON_SZ, EPD_BLACK);
163  } else {
164  _display->drawBitmap(_statusbar_icon_cloud_x, _statusbar_icons_y,
165  epd_bmp_cloud_offline, STATUS_BAR_ICON_SZ,
166  STATUS_BAR_ICON_SZ, EPD_BLACK);
167  }
168  _statusbar_mqtt_connected = mqtt_status;
169  }
170 
171  // Update WiFi icon only if RSSI has changed significantly (+/-3dB)
172  if (update_rssi) {
173  const unsigned char *wifi_icon = epd_bmp_wifi_no_signal;
174  if (rssi >= -50) {
175  wifi_icon = epd_bmp_wifi_full;
176  } else if (rssi < -50 && rssi >= -60) {
177  wifi_icon = epd_bmp_wifi_fair;
178  } else if (rssi < -60 && rssi >= -70) {
179  wifi_icon = epd_bmp_wifi_weak;
180  } else if (rssi < -70 && rssi >= -80) {
181  wifi_icon = epd_bmp_wifi_no_signal;
182  } else {
183  wifi_icon = epd_bmp_wifi_no_signal;
184  }
185  // Clear and draw the new WiFi icon, based on RSSI
186  _display->fillRect(_statusbar_icon_wifi_x, _statusbar_icons_y,
188  _display->drawBitmap(_statusbar_icon_wifi_x, _statusbar_icons_y,
190  EPD_BLACK);
191  _statusbar_rssi = rssi;
192  }
193 
194  _display->display();
195  }
196 
204  virtual void writeMessage(const char *message) override {
205  if (_display == nullptr)
206  return;
207 
208  // Clear only the area below the status bar
209  _display->fillRect(0, STATUS_BAR_HEIGHT, _display->width(),
210  _display->height() - STATUS_BAR_HEIGHT, EPD_WHITE);
211  // Add padding between status bar and text content
212  int16_t y_idx = STATUS_BAR_HEIGHT + 4;
213  _display->setCursor(0, y_idx);
214 
215  // Calculate the line height based on the text size (NOTE: base height is
216  // 8px)
217  int16_t line_height = 8 * _text_sz;
218  uint16_t c_idx = 0;
219  size_t msg_size = strlen(message);
220 
221  // Reset the text size to the configured value before we write
222  _display->setTextSize(_text_sz);
223 
224  for (size_t i = 0; i < msg_size && c_idx < msg_size; i++) {
225  if (y_idx + line_height > _height)
226  break;
227  if (message[i] == '\\' && i + 1 < msg_size &&
228  (message[i + 1] == 'n' || message[i + 1] == 'r')) {
229  // Handle \r\n sequence as a single newline
230  if (message[i + 1] == 'r' && i + 3 < msg_size &&
231  message[i + 2] == '\\' && message[i + 3] == 'n') {
232  // Skip to the next line
233  if (y_idx + line_height > _height)
234  break;
235  y_idx += line_height;
236  _display->setCursor(0, y_idx);
237  i += 3;
238  } else if (message[i + 1] == 'n') {
239  // Skip to the next line
240  if (y_idx + line_height > _height)
241  break;
242  y_idx += line_height;
243  _display->setCursor(0, y_idx);
244  i++;
245  }
246  } else if (message[i] == 0xC2 && message[i + 1] == 0xB0) {
247  // Degree symbol
248  _display->write(char(247));
249  i++;
250  } else {
251  _display->print(message[i]);
252  }
253  }
254  _display->display();
255  }
256 
257 private:
258  ThinkInk_290_Grayscale4_T5 *_display;
259 };
260 
261 #endif // WS_DRV_THINKINK_GRAYSCALE4_T5_H
const unsigned char epd_bmp_bat_full[]
battery-full-thin-full icon from FontAwesome (16x16px)
Definition: icons.h:70
int _statusbar_icons_y
Y position of status bar icons.
Definition: dispDrvBase.h:178
void updateStatusBar(int8_t rssi, uint8_t bat, bool mqtt_status) override
Updates the status bar with current information (battery level, connectivity status, etc).
Definition: dispDrvThinkInkGrayscale4T5.h:142
#define STATUS_BAR_ICON_MARGIN
Margin from edge of display to status bar icons in pixels.
Definition: dispDrvThinkInkGrayscale4Eaamfgn.h:27
const unsigned char epd_bmp_wifi_fair[]
wifi-fair-thin-full icon from FontAwesome (16x16px)
Definition: icons.h:46
int _statusbar_icon_battery_x
X position of battery icon.
Definition: dispDrvBase.h:179
const unsigned char epd_bmp_wifi_no_signal[]
wifi-slash-thin-full icon from FontAwesome (16x16px)
Definition: icons.h:62
uint8_t _text_sz
Text size for displaying a message.
Definition: dispDrvBase.h:173
int8_t _statusbar_rssi
RSSI value for status bar.
Definition: dispDrvBase.h:182
#define STATUS_BAR_ICON_SZ
Size of status bar icons in pixels.
Definition: dispDrvThinkInkGrayscale4Eaamfgn.h:24
#define STATUS_BAR_BORDER
Border around the status bar in pixels.
Definition: dispDrvThinkInkGrayscale4Eaamfgn.h:23
virtual void writeMessage(const char *message) override
Writes a message to the display.
Definition: dispDrvThinkInkGrayscale4T5.h:204
int16_t _pin_sram_cs
Optional EPD SRAM chip select pin.
Definition: dispDrvBase.h:169
int _statusbar_icon_cloud_x
X position of cloud icon.
Definition: dispDrvBase.h:181
int16_t _pin_rst
Reset pin.
Definition: dispDrvBase.h:166
int16_t _width
Width of the display.
Definition: dispDrvBase.h:175
#define STATUS_BAR_ICON_SPACING
Spacing between status bar icons in pixels.
Definition: dispDrvThinkInkGrayscale4Eaamfgn.h:25
const unsigned char epd_bmp_wifi_full[]
wifi-thin-full icon from FontAwesome (16x16px)
Definition: icons.h:38
#define STATUS_BAR_HEIGHT
Height of the status bar in pixels, assumes 16px icons.
Definition: dispDrvThinkInkGrayscale4Eaamfgn.h:21
virtual void drawStatusBar(const char *io_username) override
Draws a status bar at the top of the display.
Definition: dispDrvThinkInkGrayscale4T5.h:89
const unsigned char epd_bmp_cloud_online[]
cloud-thin-full icon from FontAwesome (16x16px)
Definition: icons.h:22
dispDrvThinkInkGrayscale4T5(int16_t dc, int16_t rst, int16_t cs, int16_t sram_cs=-1, int16_t busy=-1)
Constructor for the ThinkInk Grayscale T5 EPD display driver.
Definition: dispDrvThinkInkGrayscale4T5.h:40
int16_t _height
Height of the display.
Definition: dispDrvBase.h:174
bool _statusbar_mqtt_connected
MQTT connection status for the status bar.
Definition: dispDrvBase.h:185
int16_t _pin_busy
Optional Busy pin.
Definition: dispDrvBase.h:168
Abstract base class for display drivers. This class provides a common interface for all display drive...
Definition: dispDrvBase.h:28
int16_t _pin_cs
Chip Select pin.
Definition: dispDrvBase.h:167
bool begin(thinkinkmode_t mode, bool reset=true) override
Attempts to initialize the ThinkInk Grayscale 4 T5 EPD display driver.
Definition: dispDrvThinkInkGrayscale4T5.h:63
Driver for a ThinkInk 2.9" Grayscale 4-level T5 display (pre-2025 version of the Adafruit MagTag)...
Definition: dispDrvThinkInkGrayscale4T5.h:25
const unsigned char epd_bmp_wifi_weak[]
wifi-weak-thin-full icon from FontAwesome (16x16px)
Definition: icons.h:54
int16_t _pin_dc
Data/Command pin.
Definition: dispDrvBase.h:165
int _statusbar_icon_wifi_x
X position of WiFi icon.
Definition: dispDrvBase.h:180