Skip to content

Commit eba85e4

Browse files
edgar-bonetper1234
andcommitted
keyboardModifiers: Implement review suggestions
Apply changes suggested by @per1234 on pull-request review: - fix typo - use common conventions for key names and key combinations - reduce unnecessary verbosity. Co-authored-by: per1234 <accounts@perglass.com>
1 parent a7b4ff9 commit eba85e4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Language/Functions/USB/Keyboard/keyboardModifiers.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,37 +20,37 @@ When given a printable ASCII character as an argument, the functions `Keyboard.w
2020
Keyboard.write('a'); // press and release the 'A' key
2121
Keyboard.write('A'); // press Shift and 'A', then release both
2222
----
23-
A typical keyboard, however, has many keys that do not match a printable ASCII character. In order to simulate those keys, the library provides a set of macros that can be passed as arguments to `Keyboard.write()`, `Keyboard.press()` and `Keyboard.release()`. For example, the key combination Shift-F2 can be generated by:
23+
A typical keyboard, however, has many keys that do not match a printable ASCII character. In order to simulate those keys, the library provides a set of macros that can be passed as arguments to `Keyboard.write()`, `Keyboard.press()` and `Keyboard.release()`. For example, the key combination Shift+F2 can be generated by:
2424
[source,arduino]
2525
----
2626
Keyboard.press(KEY_LEFT_SHIFT); // press and hold Shift
2727
Keyboard.press(KEY_F2); // press and hold F2
2828
Keyboard.releaseAll(); // release both
2929
----
30-
Note that, in order to press multiple keys simultaneously, one has to use link:../keyboardpress[`Keyboard.press()`] rather than link:../keyboardwrite[`Keyboard.write()`], as the latter just “hits” the keys (it presses and immediate releases them).
30+
Note that, in order to press multiple keys simultaneously, one has to use link:../keyboardpress[`Keyboard.press()`] rather than link:../keyboardwrite[`Keyboard.write()`], as the latter just “hits” the keys (it presses and immediately releases them).
3131
[%hardbreaks]
3232
The available macros are listed below:
3333

3434
[float]
3535
=== Keyboard modifiers
36-
These are eight keys within the alphanumeric cluster of the keyboard that are meant to modify the normal action of another key when the two are pressed in combination. Whereas Shift and AltGr are used to access extra characters, the others are mostly used for keyboard shortcuts.
36+
These keys are meant to modify the normal action of another key when the two are pressed in combination.
3737

3838
|===
3939
|Key |Hexadecimal value |Decimal value |Notes
4040

4141
|KEY_LEFT_CTRL |0x80 |128 |
4242
|KEY_LEFT_SHIFT |0x81 |129 |
43-
|KEY_LEFT_ALT |0x82 |130 |option (⌥) on Mac
44-
|KEY_LEFT_GUI |0x83 |131 |OS logo, command (⌘) on Mac
43+
|KEY_LEFT_ALT |0x82 |130 |Option (⌥) on Mac
44+
|KEY_LEFT_GUI |0x83 |131 |OS logo, Command (⌘) on Mac
4545
|KEY_RIGHT_CTRL |0x84 |132 |
4646
|KEY_RIGHT_SHIFT |0x85 |133 |
47-
|KEY_RIGHT_ALT |0x86 |134 |also AltGr, option (⌥) on Mac
48-
|KEY_RIGHT_GUI |0x87 |135 |OS logo, command (⌘) on Mac
47+
|KEY_RIGHT_ALT |0x86 |134 |also AltGr, Option (⌥) on Mac
48+
|KEY_RIGHT_GUI |0x87 |135 |OS logo, Command (⌘) on Mac
4949
|===
5050

5151
[float]
5252
=== Special keys
53-
These are all the keys that do not match a printable ASCII character and are not modifiers, including all keys outside the alphanumeric cluster.
53+
These are all the keys that do not match a printable ASCII character and are not modifiers.
5454

5555
[float]
5656
==== Within the alphanumeric cluster
@@ -84,7 +84,7 @@ These are all the keys that do not match a printable ASCII character and are not
8484

8585
[float]
8686
==== Escape and function keys
87-
The library can simulate function keys up to F24, even though few keyboards have the F13… F24 keys.
87+
The library can simulate function keys up to F24.
8888

8989
|===
9090
|Key |Hexadecimal value |Decimal value

0 commit comments

Comments
 (0)