Skip to content

Commit

Permalink
Update documentation to 0.7.6 (#12)
Browse files Browse the repository at this point in the history
* Correct Links and README generation

* Update Usage page

* Remove README from tracking

* Update Hotkeys page

* Fix image stretching

* Update usage page

* Remove vestigial snippets

* Update WebConfig Menu pages

* Remove TODO, correct links

* Update snippets

* Update add-on pages

* Update FAQ

* Add client redirect for console compatibility page

* Correct environment set up section

* Rearrange Community Splash Page

* Update page description

* Clarify PS4 Controller Modes

* Add Bootsel note

* Correct on PS Passthrough device

* Add converter and adapter for Passthrough info
  • Loading branch information
InfraredAces authored Jan 15, 2024
1 parent d4d7bb0 commit e29d2d5
Show file tree
Hide file tree
Showing 74 changed files with 1,729 additions and 367 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ build

.docusaurus
.cache-loader
README.md
15 changes: 11 additions & 4 deletions docs/add-ons/dual-direction-input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,21 @@ Purpose: This add-on is intended to allow additional digital buttons to be used

## Web Configurator Options

:::info GPIO Pin Mapping Moved

The pin(s) are now configured on the [Pin Mapping page](../web-configurator/menu-pages/02-pin-mapping.mdx) by choosing the correct option for the selected pin.

- DDI Up
- DDI Down
- DDI Left
- DDI Right

:::

- `Dual D-Pad Mode` - Choose if this should act as an additional instance of a D-Pad, Left analog joystick, or Right analog joystick.
- `Combination Mode` - Choose how these direction inputs should be combined with gamepad directions.
- `Dual Directional 4-Way Joystick Mode` - Prevents diagonal inputs from being sent when enabled.

The pin(s) are configured [on the core Pin Mapping page](../web-configurator/menu-pages/pin-mapping) by choosing the desired input direction for the selected pin.

![GP2040-CE Configurator - Dual Directional Input Pin Selection in the Pin Mapping Page](../assets/images/gpc-add-ons-dual-directional-pin-example.png)

### Dual D-Pad Mode Values

- `D-PAD` for D-Pad mode.
Expand Down
16 changes: 0 additions & 16 deletions docs/add-ons/extra-button.mdx

This file was deleted.

2 changes: 0 additions & 2 deletions docs/add-ons/focus-mode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Purpose: This add-on is intended to allow you to disable a number of functions o
## Web Configurator Options

- `Focus Mode Pin` - The GPIO pin used to enable Focus Mode
- `Lock OLED Screen` - When enabled, the OLED screen will not display anything during Focus Mode.
- `Lock RGB LED` - When enabled, the RGB LEDs that are controlled by the RP2040 device will not display anything during Focus Mode.
- `Lock Macro` - When enabled, macro triggers will not activate macro sequences during Focus Mode
- `Lock Buttons` - When enabled, listed inputs will not be sent during Focus Mode. As inputs are added, new dropdowns will appear for additional inputs.

Expand Down
26 changes: 11 additions & 15 deletions docs/add-ons/i2c-analog-ads1219.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ pagination_prev: null
description: "Add-on to use an ADS1219 ADC for Left and Right analog joysticks on your controller"
---

import I2CTable from "../snippets/_i2c-block-table.mdx";

# I2C Analog ADS1219

Purpose: This add-on is intended to allow you to add Left and Right analog joystick functionality using the ADS1219 24-bit, analog-to-digital
Expand All @@ -16,10 +18,13 @@ converter (ADC).

## Web Configurator Options

- `I2C Analog ADS1219 SDA Pin` - The GPIO pin used for I2C Analog ADS1219 SDA.
- `I2C Analog ADS1219 SCL Pin` - The GPIO pin used for I2C Analog ADS1219 SCL.
:::info GPIO Pin Assignment

The SDA and SCL pins for I2C and speed are now configured in [`Configuration > Peripheral Mapping - I2C`](../web-configurator/menu-pages/03-peripheral-mapping.mdx#i2c).

:::

- `I2C Analog ADS1219 Block` - The block of I2C to use (i2c0 or i2c1).
- `I2C Analog ADS1219 Speed` - Sets the speed of I2C communication. Common values are `100000` for standard, `400000` for fast and `800000` ludicrous speed.
- `I2C Analog ADS1219 Address` - Sets the address for the I2C Analog ADS1219 based on the pins used for SDA and SCL according to the table below.

| A0 | A1 | I2C Address |
Expand Down Expand Up @@ -50,18 +55,9 @@ Connect the pins on the ADS1219 according to the table below

:::info A0/A1 GPIO Assignment

These pins will need to be wired to the appropriate SDA/SCL pins on the RP2040 and set the correct `I2C Analog ADS1219 Block` in Web Configurator. See the table below.

| SDA | SCL | I2C Block | SDA | SCL | I2C Block |
| :-----: | :-----: | --------- | :-----: | :-----: | --------- |
| GPIO 0 | GPIO 1 | I2C0 | GPIO 2 | GPIO 3 | I2C1 |
| GPIO 4 | GPIO 5 | I2C0 | GPIO 6 | GPIO 7 | I2C1 |
| GPIO 8 | GPIO 9 | I2C0 | GPIO 10 | GPIO 11 | I2C1 |
| GPIO 12 | GPIO 13 | I2C0 | GPIO 14 | GPIO 15 | I2C1 |
| GPIO 16 | GPIO 17 | I2C0 | GPIO 18 | GPIO 19 | I2C1 |
| GPIO 20 | GPIO 21 | I2C0 | GPIO 22 | GPIO 23 | I2C1 |
| GPIO 24 | GPIO 25 | I2C0 | GPIO 26 | GPIO 27 | I2C1 |
| GPIO 28 | GPIO 29 | I2C0 | | | |
These pins will need to be wired to the appropriate SDA/SCL pins on the RP2040 and set the correct I2C block in Web Configurator.

See [Peripheral Mapping](../web-configurator/menu-pages/03-peripheral-mapping.mdx#i2c) for more information on setting up I2C.

:::

Expand Down
17 changes: 10 additions & 7 deletions docs/add-ons/joystick-selection-slider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,20 @@ Purpose: This add-on is intended to allow users change the input mode of the pri

## Web Configurator Options

- `Slider Pin Mode Default` - The directional input mode that is active when no `D-Pad Mode` pins are held.
:::info GPIO Pin Mapping Moved

The pin(s) are configured [on the core Pin Mapping page](../web-configurator/menu-pages/pin-mapping) by choosing the desired input mode for the selected pin.
The pin(s) are now configured on the [Pin Mapping page](../web-configurator/menu-pages/02-pin-mapping.mdx) by choosing the correct option for the selected pin.

![GP2040-CE Configurator - Joystick Mode Pin Selection in the Pin Mapping Page](../assets/images/gpc-add-ons-joystick-slider-pin-example.png)
- D-Pad Mode: D-Pad
- D-Pad Mode: Left Stick
- D-Pad Mode: Right Stick

### Slider Pin Mode Options
:::

- `Digital` - D-Pad directional inputs
- `Left Analog` - Cardinal directions on the Left Analog joystick at maximum magnitude.
- `Right Analog` - Cardinal directions on the Right Analog joystick at maximum magnitude.
- `Slider Pin Mode Default` - The directional input mode that is active when no `D-Pad Mode` pins are held.
- `Digital` - D-Pad directional inputs
- `Left Analog` - Cardinal directions on the Left Analog joystick at maximum magnitude.
- `Right Analog` - Cardinal directions on the Right Analog joystick at maximum magnitude.

## Hardware

Expand Down
13 changes: 9 additions & 4 deletions docs/add-ons/keyboard-host.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ description: "Add-on to use a USB keyboard in conjunction with GP2040-CE to send
---

import InputLabelSelector, {
Hotkey,
Hotkey,
} from "@site/src/components/LabelSelector.tsx";
import PinOption from "../snippets/_pin-options-USB-Host.mdx";
import InstallUSBHostPort from "../snippets/_add-usb-host-port.mdx";

Select the button labels to be displayed in the usage guide:
Expand All @@ -24,7 +23,11 @@ Purpose: This add-on is intended to allow you to use a keyboard with GP2040-CE t

## Web Configurator Options

<PinOption />
:::info GPIO Pin Assignment

The Data, 5V Enable, and Pin Orientation options for USB host ports are now configured in [`Configuration > Peripheral Mapping - USB Host`](../web-configurator/menu-pages/03-peripheral-mapping.mdx#usb-host).

:::

### Default Keybindings

Expand Down Expand Up @@ -54,7 +57,9 @@ Purpose: This add-on is intended to allow you to use a keyboard with GP2040-CE t

### Requirements

This add-on requires that you have something like the [USB Passthrough Board](https://github.com/OpenStickCommunity/Hardware/tree/main/USB%20Passthrough%20Board) or a board with a USB passthrough port on it already.
This add-on requires that you have a USB host port available on your device connected to GPIO pins on the RP2040 board. There are a number of methods to do so.

See [USB Host Port Installation](../controller-build/usb-host.mdx) for more information on the requirements for adding a USB host port to your controller.

### Installation

Expand Down
15 changes: 11 additions & 4 deletions docs/add-ons/ps-passthrough.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ pagination_prev: null
description: "Add-on to provide Playstation 4 and select Playstation 5 games on a GP2040 controller through the use of a passthrough authentication device attached to a USB host port"
---

import PinOption from "../snippets/_pin-options-USB-Host.mdx";
import InstallUSBHostPort from "../snippets/_add-usb-host-port.mdx";

# PS Passthrough
Expand All @@ -19,21 +18,29 @@ Purpose: This add-on is intended to allow you to use a licensed 3rd party, "cate

## Web Configurator Options

<PinOption />
:::info GPIO Pin Assignment

The Data, 5V Enable, and Pin Orientation options for USB host ports are now configured in [`Configuration > Peripheral Mapping - USB Host`](../web-configurator/menu-pages/03-peripheral-mapping.mdx#usb-host).

:::

:::caution

If you have PS Passthrough enabled, you must turn off the `PS4 Mode` add-on as the two will not work together.

Ensure that under the `Settings` section you have chosen the PS4 for the input mode in order to use the GP2040-CE device as a controller or as a fightstick.
Ensure that, under the `Settings` section, you have set the input mode as `PS4` and the `Controller Mode` as `Arcade Stick`. The PS Passthrough add-on will not work otherwise.

:::

## Hardware

### Requirements

This add-on requires that you have something like the [USB Passthrough Board](https://github.com/OpenStickCommunity/Hardware/tree/main/USB%20Passthrough%20Board) or a board with a USB passthrough port on it already.
This add-on requires that you have a USB host port available on your device connected to GPIO pins on the RP2040 board. There are a number of methods to do so.

See [USB Host Port Installation](../controller-build/usb-host.mdx) for more information on the requirements for adding a USB host port to your controller.

A passthrough authentication device is also required for authentication of the controller by the console. See [FAQ: Console Compatibility](../faq/faq-console-compatibility.mdx#what-controller-or-dongle-do-i-use-for-ps-passthrough) for more information on which passthrough authentication devices will work for this add-on.

### Installation

Expand Down
23 changes: 15 additions & 8 deletions docs/add-ons/socd-selection-slider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,25 @@ Purpose: This add-on is intended to allow users change the method of SOCD cleani

- `SOCD Slider Mode Default` - The default SOCD mode to be used when the slider pin is not activated.

The pin(s) are configured [on the core Pin Mapping page](../web-configurator/menu-pages/pin-mapping) by choosing the desired SOCD cleaning mode for the selected pin.
:::info GPIO Pin Mapping Moved

![GP2040-CE Configurator - SOCD Mode Pin Selection in the Pin Mapping Page](../assets/images/gpc-add-ons-socd-slider-pin-example.png)
The pin(s) are now configured on the [Pin Mapping page](../web-configurator/menu-pages/02-pin-mapping.mdx) by choosing the correct option for the selected pin.

### SOCD Slider Mode Options

- [Up Priority](../hotkeys.mdx#socd-up-priority)
- [Neutral](../hotkeys.mdx#socd-neutral)
- [Last Win](../hotkeys.mdx#socd-last-win)
- [First Wins](../hotkeys.mdx#socd-first-wins)
- [Up Priority SOCD Cleaning](../hotkeys.mdx#socd-up-priority)
- [Neutral SOCD Cleaning](../hotkeys.mdx#socd-neutral)
- [Last Win SOCD Cleaning](../hotkeys.mdx#socd-last-win)
- [First Wins SOCD Cleaning](../hotkeys.mdx#socd-first-wins)
- [SOCD Cleaning Off](../hotkeys.mdx#socd-cleaning-off)

:::

- `SOCD Slider Mode Default` - The SOCD cleaning mode that is active when no `SOCD Cleaning Mode` pins are held.
- [Up Priority](../hotkeys.mdx#socd-up-priority)
- [Neutral](../hotkeys.mdx#socd-neutral)
- [Last Win](../hotkeys.mdx#socd-last-win)
- [First Wins](../hotkeys.mdx#socd-first-wins)
- [SOCD Cleaning Off](../hotkeys.mdx#socd-cleaning-off)

## Hardware

### Requirements
Expand Down
6 changes: 0 additions & 6 deletions docs/add-ons/usb-host-add-on/_example-wiring-diagram.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions docs/add-ons/usb-host-add-on/_pin-options.mdx

This file was deleted.

21 changes: 18 additions & 3 deletions docs/add-ons/wii-extensions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,21 @@ The Wii Extensions add-on is not meant to work with Wii consoles.

## Web Configurator Options

- `I2C SDA Pin` - The GPIO pin used for Wii Extension SDA.
- `I2C SCL Pin` - The GPIO pin used for Wii Extension SCL.
:::info GPIO Pin Assignment

The SDA and SCL pins for I2C and speed are now configured in [`Configuration > Peripheral Mapping - I2C`](../web-configurator/menu-pages/03-peripheral-mapping.mdx#i2c).

:::

- `I2C Block` - The block of I2C to use (i2c0 or i2c1).
- `I2C Speed` - Sets the speed of I2C communication. Common values are `100000` for standard, or `400000` for fast.

### Controller Specific Options

<Tabs groupId="wii-extenstions" defaultValue="Nunchuck">
<TabItem value="Nunchuck" label="Nunchuck" default>

![GP2040-CE Configurator - Wii Nunchuck Settings](../assets/images/gpc-add-ons-wii-extensions-nunchuck.png)

![GP2040-CE Configurator - Wii Nunchuck Controller](../assets/images/wii-extension-controllers/nunchuck.svg)

</TabItem>
Expand All @@ -47,11 +52,15 @@ The Wii Extensions add-on is not meant to work with Wii consoles.

:::

![GP2040-CE Configurator - Wii Classic Controller Settings](../assets/images/gpc-add-ons-wii-extensions-classic.png)

![GP2040-CE Configurator - Wii Classic Controller](../assets/images/wii-extension-controllers/classic.svg)

</TabItem>
<TabItem value="Guitar" label="Guitar" default>

![GP2040-CE Configurator - Wii Guitar Settings](../assets/images/gpc-add-ons-wii-extensions-guitar.png)

![GP2040-CE Configurator - Wii Guitar](../assets/images/wii-extension-controllers/guitar.svg)

</TabItem>
Expand All @@ -63,16 +72,22 @@ Due to an accessory hardware issue, Drum & DJ turntable controllers may require

:::

![GP2040-CE Configurator - Wii Drums Settings](../assets/images/gpc-add-ons-wii-extensions-drums.png)

![GP2040-CE Configurator - Wii Drums](../assets/images/wii-extension-controllers/drums.svg)

</TabItem>
<TabItem value="Turntable" label="Turntable" default>

![GP2040-CE Configurator - Wii Turntable Settings](../assets/images/gpc-add-ons-wii-extensions-turntable.png)

![GP2040-CE Configurator - Wii Turntable](../assets/images/wii-extension-controllers/turntable.svg)

</TabItem>
<TabItem value="Taiko" label="Taiko" default>

![GP2040-CE Configurator - Wii Taiko Settings](../assets/images/gpc-add-ons-wii-extensions-taiko.png)

![GP2040-CE Configurator - Wii Taiko](../assets/images/wii-extension-controllers/taiko.svg)

</TabItem>
Expand Down
46 changes: 46 additions & 0 deletions docs/add-ons/xbox-one-passthrough.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Xbox One Passthrough
# tags:
# -
pagination_next: null
pagination_prev: null
description: "Add-on to provide support for Xbox One and Xbox Series consoles on a GP2040 controller through the use of a passthrough authentication device attached to a USB host port"
---

import InstallUSBHostPort from "../snippets/_add-usb-host-port.mdx";

# Xbox One Passthrough

Purpose: This add-on is intended to provide support for Xbox One and Xbox Series consoles on a GP2040 controller through the use of a passthrough authentication device attached to a USB host port.

![GP2040-CE Configurator - PS Passthrough](../assets/images/gpc-add-ons-xbox-one-passthrough.png)

## Web Configurator Options

:::info GPIO Pin Assignment

The Data, 5V Enable, and Pin Orientation options for USB host ports are now configured in [`Configuration > Peripheral Mapping - USB Host`](../web-configurator/menu-pages/03-peripheral-mapping.mdx#usb-host).

:::

:::caution

If you have Xbox One Passthrough enabled, you use the [`Xbox One`](../usage.mdx#input-modes) input mode in order to utilize this add-on.

:::

## Hardware

### Requirements

This add-on requires that you have a USB host port available on your device connected to GPIO pins on the RP2040 board. There are a number of methods to do so.

See [USB Host Port Installation](../controller-build/usb-host.mdx) for more information on the requirements for adding a USB host port to your controller.

### Installation

<InstallUSBHostPort />

## Miscellaneous Notes

This add-on is not compatible with the [PS4 Mode](./ps-passthrough.mdx) add-on. In order to use one, the other must be disabled.
Binary file modified docs/assets/images/gpc-add-ons-ads1219.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified docs/assets/images/gpc-add-ons-dual-directional.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-add-ons-focus-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-add-ons-keyboard-host-configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-add-ons-ps-passthrough.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-add-ons-socd-slider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-add-ons-wii-extensions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-backup-and-restore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-display-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/gpc-input-boot-modes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-macros-input-line.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/gpc-peripheral-mapping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-pin-mapping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-pled-pwm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-pled-rgb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/gpc-rgb-led-button-order.png
Binary file modified docs/assets/images/gpc-rgb-led-config.png
Binary file added docs/assets/images/gpc-settings-ps4.png
Binary file modified docs/assets/images/gpc-settings.png
12 changes: 12 additions & 0 deletions docs/controller-build/rgb-led-wiring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: RGB LED Wiring
# tags:
# -
pagination_next: null
pagination_prev: null
description: "Instructions on installing RGB LEDs onto your GP2040-CE controllers. May require additional wiring, connectors, solder, or circuit boards."
---

# Document Title

CONTENT
Loading

0 comments on commit e29d2d5

Please sign in to comment.