Skip to content

Commit 948c6c5

Browse files
committed
Document the layout parameter to Keyboard.begin()
1 parent afdbba3 commit 948c6c5

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

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

+16-2
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,26 @@ 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
41+
42+
Custom layouts can be created by copying and modifying an existing layout. See the instructions in the file KeyboardLayout.h.
2943

3044

3145
[float]

0 commit comments

Comments
 (0)