Skip to content

Commit 741b9d4

Browse files
authored
smal update of doc
fix doc for #181
1 parent 0df36e4 commit 741b9d4

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ESP8266 OLED SSD1306
44

5-
> We just released version 3.0.0. Please have a look at our [upgrade guide](UPGRADE-3.0.md)
5+
> We just released version 4.0.0. Please have a look at our [upgrade guide](UPGRADE-4.0.md)
66
77
This is a driver for the SSD1306 based 128x64 pixel OLED display running on the Arduino/ESP8266 platform.
88
Can be used with either the I2C or SPI version of the display
@@ -15,6 +15,7 @@ platformio lib install 562
1515
```
1616

1717
## Credits
18+
1819
This library has initially been written by Daniel Eichhorn (@squix78). Many thanks go to Fabrice Weinberg (@FWeinb) for optimizing and refactoring many aspects of the library. Also many thanks to the many committers who helped to add new features and who fixed many bugs.
1920
The init sequence for the SSD1306 was inspired by Adafruit's library for the same display.
2021

@@ -26,7 +27,7 @@ Check out the examples folder for a few comprehensive demonstrations how to use
2627

2728
The API changed a lot with the 3.0 release. If you were using this library with older versions please have a look at the [Upgrade Guide](UPGRADE-3.0.md).
2829

29-
Going from 3.x version to 4.0 a lot of internals changed and compatibility for more displays was added. Please read the [Upgrade Guide](UPGRADE-4.0.md)
30+
Going from 3.x version to 4.0 a lot of internals changed and compatibility for more displays was added. Please read the [Upgrade Guide](UPGRADE-4.0.md).
3031

3132
## Features
3233

@@ -60,16 +61,16 @@ The library supports different protocols to access the OLED display. Currently t
6061

6162
```C++
6263
#include <Wire.h>
63-
#include "SSD1306.h"
64+
#include "SSD1306Wire.h"
6465

65-
SSD1306 display(ADDRESS, SDA, SDC);
66+
SSD1306Wire display(ADDRESS, SDA, SDC);
6667
```
6768
or for a SH1106:
6869
```C++
6970
#include <Wire.h>
70-
#include "SH1106.h"
71+
#include "SH1106Wire.h"
7172
72-
SH1106 display(ADDRESS, SDA, SDC);
73+
SH1106Wire display(ADDRESS, SDA, SDC);
7374
```
7475

7576
### I2C with brzo_i2c
@@ -140,7 +141,7 @@ void invertDisplay(void);
140141
void normalDisplay(void);
141142

142143
// Set display contrast
143-
void setContrast(char contrast);
144+
void setContrast(uint8_t contrast);
144145

145146
// Turn the display upside down
146147
void flipScreenVertically();
@@ -186,7 +187,7 @@ void drawVerticalLine(int16_t x, int16_t y, int16_t length);
186187
void drawProgressBar(uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t progress);
187188
188189
// Draw a bitmap in the internal image format
189-
void drawFastImage(int16_t x, int16_t y, int16_t width, int16_t height, const char *image);
190+
void drawFastImage(int16_t x, int16_t y, int16_t width, int16_t height, const uint8_t *image);
190191
191192
// Draw a XBM
192193
void drawXbm(int16_t x, int16_t y, int16_t width, int16_t height, const char* xbm);
@@ -217,7 +218,7 @@ void setTextAlignment(OLEDDISPLAY_TEXT_ALIGNMENT textAlignment);
217218
// Sets the current font. Available default fonts
218219
// ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24
219220
// Or create one with the font tool at http://oleddisplay.squix.ch
220-
void setFont(const char* fontData);
221+
void setFont(const uint8_t* fontData);
221222
```
222223
223224
## Ui Library (OLEDDisplayUi)

0 commit comments

Comments
 (0)