You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,10 @@ The following API is available if the Joystick library in included in a sketch f
59
59
Constructor used to initialize and setup the Joystick. The following optional parameters are available:
60
60
61
61
-`uint8_t hidReportId` - Default: `0x03` - Indicates the joystick's HID report ID. This value must be unique if you are creating multiple instances of Joystick. Do not use `0x01` or `0x02` as they are used by the built-in Arduino Keyboard and Mouse libraries.
-`uint8_t joystickType` - Default: `JOYSTICK_TYPE_JOYSTICK` or `0x04` - Indicates the HID input device type. Supported values:
63
+
-`JOYSTICK_TYPE_JOYSTICK` or `0x04` - Joystick
64
+
-`JOYSTICK_TYPE_GAMEPAD` or `0x05` - Gamepad
65
+
-`JOYSTICK_TYPE_MULTI_AXIS` or `0x08` - Multi-axis Controller
63
66
-`uint8_t buttonCount` - Default: `32` - Indicates how many buttons will be available on the joystick.
64
67
-`uint8_t hatSwitchCount` - Default: `2` - Indicates how many hat switches will be available on the joystick. Range: `0` - `2`
65
68
-`bool includeXAxis` - Default: `true` - Indicates if the X Axis is available on the joystick.
@@ -79,9 +82,6 @@ The following constants define the default values for the constructor parameter'
79
82
-`JOYSTICK_DEFAULT_REPORT_ID` is set to `0x03`
80
83
-`JOYSTICK_DEFAULT_BUTTON_COUNT` is set to `32`
81
84
-`JOYSTICK_DEFAULT_HATSWITCH_COUNT` is set to `2`
82
-
-`JOYSTICK_TYPE_JOYSTICK` is set to `0x04`
83
-
-`JOYSTICK_TYPE_GAMEPAD` is set to `0x05`
84
-
-`JOYSTICK_TYPE_MULTI_AXIS` is set to `0x08`
85
85
86
86
### Joystick.begin(bool initAutoSendState)
87
87
Starts emulating a game controller connected to a computer. By default all methods update the game controller state immediately. If `initAutoSendState` is set to `false`, the `Joystick.sendState` method must be called to update the game controller state.
0 commit comments