Skip to content

Commit 92902af

Browse files
authored
Update api.md to reflect documentation support for 5x10 displays (#70)
arduino/Arduino#5563 (comment) Found this issue in the arduino/Arduino repository where an user had trouble finding the documentation for her unique 1 line 5x10 char LCD display in the LiquidCrystal references page, since she could not display the extended 32 characters with the default dotsize value in: void begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS); She had to manually dig into the source code to define the extended 5x10 font support. This commit should help users with similar boards get started easily with the LiquidCrystal library using the overloaded begin() invocation.
1 parent db84824 commit 92902af

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/api.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Initializes the interface to the LCD screen, and specifies the dimensions (width
5151
#### Syntax
5252

5353
```
54-
lcd.begin(cols, rows)
54+
lcd.begin(cols, rows, charsize)
5555
```
5656

5757
#### Parameters
@@ -61,6 +61,8 @@ cols: the number of columns that the display has
6161

6262
rows: the number of rows that the display has
6363

64+
charsize (optional): the number of dots the display has per character: LCD_5x8DOTS for 5x8, LCD_5x10DOTS for 5x10. (default: LCD_5x8DOTS)
65+
6466
### `clear()`
6567

6668
#### Description
@@ -421,4 +423,4 @@ void setup() {
421423
}
422424
423425
void loop() {}
424-
```
426+
```

0 commit comments

Comments
 (0)