Skip to content

Commit 3220093

Browse files
authored
Merge pull request #854 from edgar-bonet/kbd-layouts
Document the layout parameter of Keyboard.begin()
2 parents bdd979a + 3a87ec4 commit 3220093

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

Diff for: Language/Functions/USB/Keyboard/keyboardBegin.adoc

+19-2
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,24 @@ When used with a Leonardo or Due board, `Keyboard.begin()` starts emulating a ke
2020

2121
[float]
2222
=== Syntax
23-
`Keyboard.begin()`
23+
`Keyboard.begin()` +
24+
`Keyboard.begin(layout)`
2425

2526

2627
[float]
2728
=== Parameters
28-
None
29+
`layout`: the keyboard layout to use. This parameter is optional and defaults to `KeyboardLayout_en_US`.
30+
31+
32+
[float]
33+
=== Keyboard layouts
34+
Currently, the library supports the following national keyboard layouts:
35+
36+
* `KeyboardLayout_de_DE`: Germany
37+
* `KeyboardLayout_en_US`: USA
38+
* `KeyboardLayout_es_ES`: Spain
39+
* `KeyboardLayout_fr_FR`: France
40+
* `KeyboardLayout_it_IT`: Italy
2941

3042

3143
[float]
@@ -68,5 +80,10 @@ void loop() {
6880
}
6981
----
7082

83+
84+
[float]
85+
=== Notes and Warnings
86+
Custom layouts can be created by copying and modifying an existing layout. See the instructions in the Keyboard library's KeyboardLayout.h file.
87+
7188
--
7289
// HOW TO USE SECTION ENDS

0 commit comments

Comments
 (0)