Skip to content

Commit 75fb0e9

Browse files
committed
Rename SSD1306 to OLEDDisplay
1 parent 6804bc1 commit 75fb0e9

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
Build Status: [![Build Status](https://travis-ci.org/squix78/esp8266-oled-ssd1306.svg?branch=dev-branch-3.0.0)](https://travis-ci.org/squix78/esp8266-oled-ssd1306)
2-
3-
# esp8266-oled-ssd1306
1+
esp8266-oled-ssd1306 [![Build Status](https://travis-ci.org/squix78/esp8266-oled-ssd1306.svg?branch=dev-branch-3.0.0)](https://travis-ci.org/squix78/esp8266-oled-ssd1306)
2+
============
43

54
This is a driver for the SSD1306 based 128x64 pixel OLED display running on the Arduino/ESP8266 platform.
65

@@ -182,15 +181,15 @@ uint16_t getStringWidth(String text);
182181
// Specifies relative to which anchor point
183182
// the text is rendered. Available constants:
184183
// TEXT_ALIGN_LEFT, TEXT_ALIGN_CENTER, TEXT_ALIGN_RIGHT, TEXT_ALIGN_CENTER_BOTH
185-
void setTextAlignment(SSD1306_TEXT_ALIGNMENT textAlignment);
184+
void setTextAlignment(OLEDDISPLAY_TEXT_ALIGNMENT textAlignment);
186185
187186
// Sets the current font. Available default fonts
188187
// ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24
189188
// Or create one with the font tool at http://oleddisplay.squix.ch
190189
void setFont(const char* fontData);
191190
```
192191

193-
## Ui Library (SSD1306Ui)
192+
## Ui Library (OLEDDisplayUi)
194193

195194
The Ui Library is used to provide a basic set of Ui elements called, `Frames` and `Overlays`. A `Frame` is used to provide
196195
information the default behaviour is to display a `Frame` for a defined time and than move to the next. The library also provides an `Indicator` that will be updated accordingly. An `Overlay` on the other hand is a pieces of information (e.g. a clock) that is displayed always at the same position.
@@ -300,10 +299,10 @@ void nextFrame();
300299
void previousFrame();
301300

302301
// State Info
303-
SSD1306UiState* getUiState();
302+
OLEDDisplayUiState* getUiState();
304303

305304
// This needs to be called in the main loop
306-
// the returned value it the remaining time (in ms)
305+
// the returned value is the remaining time (in ms)
307306
// you have to draw after drawing to keep the frame budget.
308307
int8_t update();
309308
```

0 commit comments

Comments
 (0)