Skip to content

Commit d9e91a8

Browse files
author
Kirk
committed
added docs for reset and displayPower() methods. Fixed reset method sig.
1 parent a5a3f8e commit d9e91a8

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/api_device.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Methods to setup the device, get device information and change display options.
44

5+
## Initialization
6+
57
### begin()
68
This method is called to initialize the OLED library and connection to the OLED device. This method must be called before calling any graphics methods.
79

@@ -15,6 +17,18 @@ bool begin(TwoWire &wirePort, uint8_t address)
1517
| `address` | `uint8_t` | **optional**. I2C Address. If not provided, the default address is used.|
1618
| return value | `bool` | ```true``` on success, ```false``` on startup failure |
1719
20+
### reset()
21+
When called, this method reset the library state and OLED device to their intial state. Helpful to reset the OLED after waking up a system from a sleep state.
22+
23+
```C++
24+
void reset()
25+
```
26+
27+
| Parameter | Type | Description |
28+
| :------------ | :---------- | :---------------------------------------------- |
29+
| return value | `bool` | ```true``` on success, ```false``` on startup failure |
30+
31+
1832
## Geometry
1933

2034
### getWidth()
@@ -73,3 +87,15 @@ void flipHorizontal(bool bFlip)
7387
| Parameter | Type | Description |
7488
| :--- | :--- | :--- |
7589
| ```bFlip``` | `bool` | ```true``` - the screen is flipped horizontally. ```false``` - the screen is set to normal |
90+
91+
### displayPower()
92+
Used to turn the OLED display on or off.
93+
94+
```c++
95+
void displayPower(bool bEnable)
96+
```
97+
98+
| Parameter | Type | Description |
99+
| :--- | :--- | :--- |
100+
| ```bEnable``` | `bool` | ```true``` - the OLED display is powered on (default). ```false``` - the OLED dsiplay is powered off. |
101+

0 commit comments

Comments
 (0)