Skip to content

Document the layout parameter of Keyboard.begin() #854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
per1234 merged 2 commits into from
Nov 21, 2021
Merged

Document the layout parameter of Keyboard.begin() #854

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
948c6c5
Document the layout parameter to Keyboard.begin()
edgar-bonet Nov 6, 2021
3a87ec4
keyboardBegin.adoc: Add Notes and Warnings
edgar-bonet Nov 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions Language/Functions/USB/Keyboard/keyboardBegin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,24 @@ When used with a Leonardo or Due board, `Keyboard.begin()` starts emulating a ke

[float]
=== Syntax
`Keyboard.begin()`
`Keyboard.begin()` +
`Keyboard.begin(layout)`


[float]
=== Parameters
None
`layout`: the keyboard layout to use. This parameter is optional and defaults to `KeyboardLayout_en_US`.


[float]
=== Keyboard layouts
Currently, the library supports the following national keyboard layouts:

* `KeyboardLayout_de_DE`: Germany
* `KeyboardLayout_en_US`: USA
* `KeyboardLayout_es_ES`: Spain
* `KeyboardLayout_fr_FR`: France
* `KeyboardLayout_it_IT`: Italy


[float]
Expand Down Expand Up @@ -68,5 +80,10 @@ void loop() {
}
----


[float]
=== Notes and Warnings
Custom layouts can be created by copying and modifying an existing layout. See the instructions in the Keyboard library's KeyboardLayout.h file.

--
// HOW TO USE SECTION ENDS