diff --git a/docs/add-ons/analog.mdx b/docs/add-ons/analog.mdx index 3415196..145269f 100644 --- a/docs/add-ons/analog.mdx +++ b/docs/add-ons/analog.mdx @@ -9,7 +9,7 @@ description: "Add-on to use hardware analog joysticks with GP2040-CE" # Analog -Purpose: This add-on is intended for the use of an hardware analog joystick with GP2040-CE for the left and right analog sticks of the gamepad. +Purpose: This add-on is intended for the use of a hardware analog joystick with GP2040-CE for the left and right analog sticks of the gamepad. ![GP2040-CE Configurator - Add-Ons Analog](../assets/images/gpc-add-ons-analog.png) diff --git a/docs/add-ons/drv8833-rumble.mdx b/docs/add-ons/drv8833-rumble.mdx index 93dcceb..3be7463 100644 --- a/docs/add-ons/drv8833-rumble.mdx +++ b/docs/add-ons/drv8833-rumble.mdx @@ -15,13 +15,13 @@ Purpose: This add-on is allows you to use DRV8833 Rumble in Xinput mode. ## Web Configurator Options --`Left Motor GPIO Pin` - The GPIO pin that the left motor `AIN1` is connected to on the DRV8833. --`Right Motor GPIO Pin` - The GPIO pin that the left motor `AIN2` is connected to on the DRV8833. --`Motor Sleep GPIO Pin` - The GPIO pin that `SLP` is connected to on the DRV8833. --`PWM Freaquency` - The freaquency for the motors (best to start at 10,000 and adjust from there). +- `Left Motor GPIO Pin` - The GPIO pin that the left motor `AIN1` is connected to on the DRV8833. +- `Right Motor GPIO Pin` - The GPIO pin that the left motor `AIN2` is connected to on the DRV8833. +- `Motor Sleep GPIO Pin` - The GPIO pin that `SLP` is connected to on the DRV8833. +- `PWM Frequency` - The frequency for the motors (best to start at 10,000 and adjust from there). - `Minimum Duty Cycle` - The bottom range as a percentage for the 0-255 rumble value. - `Maximum Duty Cycle` - The top range as a percentage for the 0-255 rumble value. ### Requirements -This add-on requires an DRV8833 motor driver or breakout and either one or two rumble motors. \ No newline at end of file +This add-on requires an DRV8833 motor driver or breakout and either one or two rumble motors. diff --git a/docs/faq/faq-console-compatibility.mdx b/docs/faq/faq-console-compatibility.mdx index 2ea9ef1..9571e85 100644 --- a/docs/faq/faq-console-compatibility.mdx +++ b/docs/faq/faq-console-compatibility.mdx @@ -201,7 +201,7 @@ Playstation consoles repeatedly send authorization requests every 30 seconds or ### How do I get my GP2040-CE unit to work on an Xbox 360? -For Xbox 360 compatibility, you will need to use the [XInput](../web-configurator/menu-pages/01-settings.mdx). XInput mode will change to Xbox 360 automatically when a appropiate Xbox 360 dongle is connected. +For Xbox 360 compatibility, you will need to use the [XInput](../web-configurator/menu-pages/01-settings.mdx). XInput mode will change to Xbox 360 automatically when an appropriate Xbox 360 dongle is connected. ### What is the Xbox 360 Input Mode? @@ -219,6 +219,7 @@ For more information, refer to [Xbox 360 Input Mode](../web-configurator/menu-pa ### What dongle do I use for Xbox 360 Input Mode? Currently there is only one dongle that will work for Xbox 360 input mode: + - [MagicBoots FPS Adapter Joystick Converter for Xbox 360](https://www.mayflash.com/product/MAG360.html) Because your experience and purchased products may vary, GP2040-CE will not provide additional specific recommendations beyond these known working devices. @@ -287,7 +288,7 @@ Xbox One, Xbox Series S, and Xbox Series X consoles only perform the authenticat ## Experimental USB Hub Support -As of v0.7.10 GP2040-CE now includes experimental support for USB hubs which will allow you to connect multiple dongles along with a keyboard at the same time. Please note the following cautions. +As of v0.7.10 GP2040-CE now includes experimental support for USB hubs which will allow you to connect multiple dongles along with a keyboard at the same time. Please note the following cautions. :::caution Not all USB hubs are supported @@ -303,6 +304,6 @@ A USB hub and multiple connected USB dongles may add considerable load to your s :::caution USB Hub Support and the RP2040 Advanced Breakout Board -Through testing we have found that on the RP2040 Advanced Breakout Board it is recommended to disable RGB LEDs via web-config if you are planning to use a USB hub. RGB LEDs can be disabled by changing the GPIO pin to `-1` and saving. +Through testing we have found that on the RP2040 Advanced Breakout Board it is recommended to disable RGB LEDs via web-config if you are planning to use a USB hub. RGB LEDs can be disabled by changing the GPIO pin to `-1` and saving. -::: \ No newline at end of file +::: diff --git a/docs/faq/faq-troubleshooting.mdx b/docs/faq/faq-troubleshooting.mdx index 2e956ed..6c9a541 100644 --- a/docs/faq/faq-troubleshooting.mdx +++ b/docs/faq/faq-troubleshooting.mdx @@ -65,7 +65,7 @@ You've likely activated one of the following SOCD cleaning mode hotkeys on your - [SOCD Up Priority](../hotkeys.mdx#socd-up-priority) - [SOCD Neutral](../hotkeys.mdx#socd-neutral) - [SOCD Last Win](../hotkeys.mdx#socd-last-win) -- [SOCD First Wins](../hotkeys.mdx#socd-first-wins) +- [SOCD First Win](../hotkeys.mdx#socd-first-win) - [SOCD Cleaning Off](../hotkeys.mdx#socd-cleaning-off) diff --git a/docs/hotkeys.mdx b/docs/hotkeys.mdx index 81148f4..6022f3c 100644 --- a/docs/hotkeys.mdx +++ b/docs/hotkeys.mdx @@ -30,19 +30,19 @@ This hotkey does nothing. Use this hotkey to disable a specific hotkey combinati ## DPad Digital -This hotkey changes the DPad mode such the directions to be read as digital inputs on the DPad. +This hotkey changes the DPad mode so the directions are read as digital inputs on the DPad. **Default**: ## DPad Left Analog -This hotkey changes the DPad mode to such the directions to be read as inputs on the Left analog joystick. The directional input is always the minimum, maximum, or zero value on that axis. +This hotkey changes the DPad mode so the directions are read as inputs on the Left analog joystick. The directional input is always the minimum, maximum, or zero value on that axis. **Default**: ## DPad Right Analog -This hotkey changes the DPad mode to such the directions to be read as inputs on the Right analog joystick. The directional input is always the minimum, maximum, or zero value on that axis. +This hotkey changes the DPad mode so the directions are read as inputs on the Right analog joystick. The directional input is always the minimum, maximum, or zero value on that axis. **Default**: @@ -95,7 +95,7 @@ This hotkey changes the SOCD cleaning method to prioritize the second directiona | Up + Down | Down | | Down + Up | Up | -## SOCD First Wins +## SOCD First Win This hotkey changes the SOCD cleaning method to prioritize the first directional input on both the X-axis and Y-axis when both directions are pressed simultaneously. @@ -155,10 +155,10 @@ This hotkey cycles through GPIO pin mapping profiles set in [Profile Settings](. For example, if `Profile 1` is active, pressing the hotkey will cycle to the next enabled profile, e.g. `Profile 2`. After reaching the last profile, it will cycle back to the first profile. ## Previous Profile + This hotkey cycles through GPIO pin mapping profiles set in [Profile Settings](./web-configurator/menu-pages/02-gpio-pin-mapping.mdx#profiles) in the Web Configurator. For example, if `Profile 2` is active, pressing the hotkey will cycle to the previous enabled profile, e.g. `Profile 1`. After reaching the first profile, it will cycle back to the last profile. - ## L3 Button This hotkey emulates a press of the button as not all controllers may have this button natively on the controller. diff --git a/docs/installation.mdx b/docs/installation.mdx index 8d7de61..4f7423c 100644 --- a/docs/installation.mdx +++ b/docs/installation.mdx @@ -23,11 +23,11 @@ Select the button labels to be displayed in the usage guide: 1. Download the compiled firmware (.uf2 file) for your device 2. Unplug your device. -3. Put your device into Bootsel/USB mode. If successful, a new removable drive named `RPI-RP2` should appear in your file explorer. +3. Put your device into BOOTSEL/USB mode. If successful, a new removable drive named `RPI-RP2` should appear in your file explorer. -:::info How to get into Bootsel Mode +:::info How to get into BOOTSEL Mode -- Holding the BootSel button while plugging in +- Holding the BOOTSEL button while plugging in - Holding while plugging in - Holding for 5 seconds. @@ -46,11 +46,11 @@ If you would like to customize your device, check out the built-in [Web Configur 1. Download the latest `GP2040-CE_X.X.X_Pico.uf2` file for the Raspberry Pi Pico from the [Download](/downloads) page. 2. Unplug your Pico. -3. Put your device into Bootsel/USB mode. If successful, a new removable drive named `RPI-RP2` should appear in your file explorer. +3. Put your device into BOOTSEL/USB mode. If successful, a new removable drive named `RPI-RP2` should appear in your file explorer. -:::info How to get into Bootsel Mode +:::info How to get into BOOTSEL Mode -- Holding the BootSel button while plugging in +- Holding the BOOTSEL button while plugging in - Holding while plugging in - Holding for 5 seconds. @@ -68,11 +68,11 @@ _Warning_ - Flash nuking your board wipes all your custom configuration for GPIO ::: 1. Download the [flash_nuke.uf2 file](/assets/flash_nuke.uf2) -2. Put your device into Bootsel/USB mode. If successful, a new removable drive named `RPI-RP2` should appear in your file explorer. +2. Put your device into BOOTSEL/USB mode. If successful, a new removable drive named `RPI-RP2` should appear in your file explorer. -:::info How to get into Bootsel Mode +:::info How to get into BOOTSEL Mode -- Holding the BootSel button while plugging in +- Holding the BOOTSEL button while plugging in - Holding while plugging in - Holding for 5 seconds. diff --git a/docs/usage.mdx b/docs/usage.mdx index 8c0d951..a27740c 100644 --- a/docs/usage.mdx +++ b/docs/usage.mdx @@ -63,17 +63,17 @@ Unlike other controllers, Keyboard gets different keys for directional buttons. | Left | Left Arrow | | Right | Right Arrow | -## Bootsel Mode +## BOOTSEL Mode -Bootsel Mode is the state of the board where firmware can be flashed onto the board. You will need to use this whenever there is an update or as part of the troubleshooting process. +BOOTSEL Mode is the state of the board where firmware can be flashed onto the board. You will need to use this whenever there is an update or as part of the troubleshooting process. -You can boot into Bootsel Mode by either holding buttons while plugging in the controller, by booting into the Web Configurator and then restarting in Bootsel Mode, or by holding together for five seconds while the controller is plugged in. There is no way to leave Bootsel mode once activated other than by flashing new firmware or by unplugging the device. +You can boot into BOOTSEL Mode by either holding buttons while plugging in the controller, by booting into the Web Configurator and then restarting in BOOTSEL Mode, or by holding together for five seconds while the controller is plugged in. There is no way to leave BOOTSEL mode once activated other than by flashing new firmware or by unplugging the device. -Generally, there is a Bootsel button somewhere on the board. This is often an exposed button on the PCB or a button inside the controller that requires either a pin to press or disassembly of the controller. +Generally, there is a BOOTSEL button somewhere on the board. This is often an exposed button on the PCB or a button inside the controller that requires either a pin to press or disassembly of the controller. :::note -There are a number of controllers that elect not to include the Bootsel button. In these instances, you will need to locate the placement of the button and use conductor to connect the 2 sides of the contacts or pads together while plugging in or booting the controller. +There are a number of controllers that elect not to include the BOOTSEL button. In these instances, you will need to locate the placement of the button and use conductor to connect the 2 sides of the contacts or pads together while plugging in or booting the controller. ::: diff --git a/docs/web-configurator/web-configurator.mdx b/docs/web-configurator/web-configurator.mdx index 8b410b4..44cb327 100644 --- a/docs/web-configurator/web-configurator.mdx +++ b/docs/web-configurator/web-configurator.mdx @@ -21,6 +21,7 @@ Select the button labels to be displayed in the usage guide: GP2040-CE contains a built-in web-based configuration application which can be started by holding when plugging your controller into a PC or by holding for five seconds while the controller is plugged in. Then access [http://192.168.7.1](http://192.168.7.1) in a web browser to begin configuration. ### Supported + - Windows - Mac - Linux @@ -28,12 +29,13 @@ GP2040-CE contains a built-in web-based configuration application which can be s - iPadOS ### Not fully supported - - Android - - iOS + +- Android +- iOS :::note -Not all Android and iOS devices are suppored for web-config. In our testing some Android devices will work and others will not. Most USB-C based iOS devices will work. We do not keep a list of which devices do and do not work. +Not all Android and iOS devices are supported for web-config. In our testing some Android devices will work and others will not. Most USB-C based iOS devices will work. We do not keep a list of which devices do and do not work. ::: @@ -42,28 +44,34 @@ Not all Android and iOS devices are suppored for web-config. In our testing som If your Windows PC cannot access the built-in web-config of your GP2040-CE controller, try the following steps: 1 - **Ensure you are in web-config mode** + - Ensure your controller is in Web-Config mode. - Verify the USB cable is securely connected and supports data transfer (some cables are power-only). 2 - **Try a Different Browser** + - Some browsers may block local device access. Try Chrome, Firefox, or Edge. - Disable browser extensions (like ad-blockers) temporarily. 3 - **Check the URL** + - The web-config URL is http://192.168.7.1. 4 - **Disable Firewall/Antivirus Temporarily** + - Security software may block communication. Test with protections temporarily disabled. 5 - **Try Another USB Port/PC** + - Test on a different port or on a different computer. 6 - **Try restarting your computer** + - Try restarting your computer. :::warning -In addition to the above there may be issues with drivers installed on your PC. Due to the risk of causing system issues the GP2040-CE team will no assist in drvier based issues or recommend drivers be installed / uninstalled. +In addition to the above there may be issues with drivers installed on your PC. Due to the risk of causing system issues the GP2040-CE team will not assist in driver based issues or recommend drivers be installed / uninstalled. :::