-
Notifications
You must be signed in to change notification settings - Fork 638
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add return values to drawString & drawStringMaxWidth (#365)
* get rid of utf8ascii() Make the drawString*() functions and getStringWidth() directly convert UTF-8 on the fly if needed. This saves an extra malloc for the converted string in most cases which then needs to be free()d and allows to count drawn chars even for UTF-8 strings later. Keep the utf8ascii() function to not break the API for derived classes. * drawStringInternal: return number of chars drawn Return the nuber of characters that was drawn. If this is less then the string length, then the text was too long for the display. This allows e.g. for custom word wrapping. * drawString: return number of characters drawn * drawStringMaxWidth: return chars written in first line This allows do scroll easily through longer texts, by noting the number of chars drawn in first line and then starting the text with this offset in the next display cycle * drawStringMaxWidth: fix UTF-8 width calculation * add SSD1306ScrollVerticalDemo example this shows how the return value of drawStringMaxWidth() can be used
- Loading branch information
Showing
4 changed files
with
158 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
examples/SSD1306ScrollVerticalDemo/SSD1306ScrollVerticalDemo.ino
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
/** | ||
The MIT License (MIT) | ||
Copyright (c) 2022 by Stefan Seyfried | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
*/ | ||
|
||
// Include the correct display library | ||
// For a connection via I2C using Wire include | ||
#include <Wire.h> // Only needed for Arduino 1.6.5 and earlier | ||
#include "SSD1306Wire.h" // legacy include: `#include "SSD1306.h"` | ||
// or #include "SH1106Wire.h", legacy include: `#include "SH1106.h"` | ||
// For a connection via I2C using brzo_i2c (must be installed) include | ||
// #include <brzo_i2c.h> // Only needed for Arduino 1.6.5 and earlier | ||
// #include "SSD1306Brzo.h" | ||
// #include "SH1106Brzo.h" | ||
// For a connection via SPI include | ||
// #include <SPI.h> // Only needed for Arduino 1.6.5 and earlier | ||
// #include "SSD1306Spi.h" | ||
// #include "SH1106Spi.h" | ||
|
||
// Use the corresponding display class: | ||
|
||
// Initialize the OLED display using SPI | ||
// D5 -> CLK | ||
// D7 -> MOSI (DOUT) | ||
// D0 -> RES | ||
// D2 -> DC | ||
// D8 -> CS | ||
// SSD1306Spi display(D0, D2, D8); | ||
// or | ||
// SH1106Spi display(D0, D2); | ||
|
||
// Initialize the OLED display using brzo_i2c | ||
// D3 -> SDA | ||
// D5 -> SCL | ||
// SSD1306Brzo display(0x3c, D3, D5); | ||
// or | ||
// SH1106Brzo display(0x3c, D3, D5); | ||
|
||
// Initialize the OLED display using Wire library | ||
SSD1306Wire display(0x3c, SDA, SCL); // ADDRESS, SDA, SCL - SDA and SCL usually populate automatically based on your board's pins_arduino.h e.g. https://github.com/esp8266/Arduino/blob/master/variants/nodemcu/pins_arduino.h | ||
// SH1106Wire display(0x3c, SDA, SCL); | ||
|
||
// UTF-8 sprinkled within, because it tests special conditions in the char-counting code | ||
const String loremipsum = "Lorem ipsum dolor sit ämet, " | ||
"consetetur sadipscing elitr, sed diam nonümy eirmöd " | ||
"tempor invidunt ut labore et dolore mägnä aliquyam erat, " | ||
"sed diam voluptua. At vero eos et accusam et justo duo " | ||
"dolores et ea rebum. Stet clita kasd gubergren, no sea " | ||
"takimata sanctus est Lorem ipsum dolor sit amet. " | ||
"äöü-ÄÖÜ/߀é/çØ."; | ||
|
||
void setup() { | ||
display.init(); | ||
display.setContrast(255); | ||
display.setTextAlignment(TEXT_ALIGN_LEFT); | ||
display.setFont(ArialMT_Plain_16); | ||
display.display(); | ||
} | ||
|
||
void loop() { | ||
static uint16_t start_at = 0; | ||
display.clear(); | ||
uint16_t firstline = display.drawStringMaxWidth(0, 0, 128, loremipsum.substring(start_at)); | ||
display.display(); | ||
if (firstline != 0) { | ||
start_at += firstline; | ||
} else { | ||
start_at = 0; | ||
delay(1000); // additional pause before going back to start | ||
} | ||
delay(1000); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters