diff --git a/docs/add-ons/xbox-one-passthrough.mdx b/docs/add-ons/xbox-one-passthrough.mdx index ae247b0..dc85603 100644 --- a/docs/add-ons/xbox-one-passthrough.mdx +++ b/docs/add-ons/xbox-one-passthrough.mdx @@ -43,4 +43,4 @@ See [USB Host Port Installation](../controller-build/usb-host.mdx) for more info ## 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. +None. diff --git a/docs/assets/images/gpc-add-ons-turbo-shmup.png b/docs/assets/images/gpc-add-ons-turbo-shmup.png index 2b06447..1e65bbc 100644 Binary files a/docs/assets/images/gpc-add-ons-turbo-shmup.png and b/docs/assets/images/gpc-add-ons-turbo-shmup.png differ diff --git a/docs/assets/images/gpc-add-ons-turbo.png b/docs/assets/images/gpc-add-ons-turbo.png index 324934f..61ee882 100644 Binary files a/docs/assets/images/gpc-add-ons-turbo.png and b/docs/assets/images/gpc-add-ons-turbo.png differ diff --git a/docs/assets/images/gpc-display-example.png b/docs/assets/images/gpc-display-example.png new file mode 100644 index 0000000..63addd6 Binary files /dev/null and b/docs/assets/images/gpc-display-example.png differ diff --git a/docs/assets/images/gpc-pin-mapping.png b/docs/assets/images/gpc-pin-mapping.png index df34502..0e01684 100644 Binary files a/docs/assets/images/gpc-pin-mapping.png and b/docs/assets/images/gpc-pin-mapping.png differ diff --git a/docs/assets/wiring/AdafruitKB2040_Pinout.png b/docs/assets/wiring/AdafruitKB2040_Pinout.png deleted file mode 100644 index b199225..0000000 Binary files a/docs/assets/wiring/AdafruitKB2040_Pinout.png and /dev/null differ diff --git a/docs/assets/wiring/AdafruitKB2040_Pinout.svg b/docs/assets/wiring/AdafruitKB2040_Pinout.svg new file mode 100644 index 0000000..d770f8b --- /dev/null +++ b/docs/assets/wiring/AdafruitKB2040_Pinout.svg @@ -0,0 +1,8105 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +A1GP00A2GP01B2GP02B1GP03B4GP04B3GP05GP06GP07R2GP08L2GP09R1GP10GP11R3GP12L3GP13ONBOARD LEDGP17S2GP18L1GP19S1GP20LEFTGP26UPGP27RIGHTGP28DOWNGP29VBUSGNDGNDGNDGND3V3(OUT)3V3(OUT)USB_DPUSB_DMRESETRESET + + Keeb 2040 rev B_breadboard.svg + + Fritzing breadboard generated by brd2svg + + + + + + + + D+ + + + + + + + + + + + + + T + + + + + + + + + RX + + + + + GND + + + + + + + + + 2 + + + + + + + + + + + + + 3 + + + + + + + + + + + + + 4 + + + + + + + + + + + + + 5 + + + + + + + + + + + + + 6 + + + + + + + + + + + + + 7 + + + + + + + + + 8 + + + + + 9 + + + + + MI + + + + + A0 + + + + + A1 + + + + + A2 + + + + + A3 + + + + + 3V + + + + + RST + + + + + G + + + + + RAW + + + + + D- + + + + + SCK + + + + + BOOT + + + + + + + + + RST + + + + + + + + + I2C + + + + + KB2040 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/wiring/RaspberryPiPico_Pinout.png b/docs/assets/wiring/RaspberryPiPico_Pinout.png deleted file mode 100644 index 222b103..0000000 Binary files a/docs/assets/wiring/RaspberryPiPico_Pinout.png and /dev/null differ diff --git a/docs/assets/wiring/RaspberryPiPico_Pinout.svg b/docs/assets/wiring/RaspberryPiPico_Pinout.svg new file mode 100644 index 0000000..e43f753 --- /dev/null +++ b/docs/assets/wiring/RaspberryPiPico_Pinout.svg @@ -0,0 +1,5259 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GP00GP01UPGP02DOWNGP03RIGHTGP04LEFTGP05B1GP06B2GP07R2GP08L2GP09B3GP10B4GP11R1GP12L1GP13GP14GP15S1GP16S2GP17L3GP18R3GP19A1GP20A2GP21GP22GP26GP27GP28GNDGNDGNDGNDGNDGNDGNDADC_GND3V3_3NRUNVSYS3V3(OUT)ADC_VREFVBUS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/wiring/SparkFunProMicroRP2040_Pinout.png b/docs/assets/wiring/SparkFunProMicroRP2040_Pinout.png deleted file mode 100644 index 8470158..0000000 Binary files a/docs/assets/wiring/SparkFunProMicroRP2040_Pinout.png and /dev/null differ diff --git a/docs/assets/wiring/SparkFunProMicroRP2040_Pinout.svg b/docs/assets/wiring/SparkFunProMicroRP2040_Pinout.svg new file mode 100644 index 0000000..3f2d703 --- /dev/null +++ b/docs/assets/wiring/SparkFunProMicroRP2040_Pinout.svg @@ -0,0 +1,2437 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +B3GP00B4GP01B2GP02B1GP03L1GP04GP05L2GP06A1GP07A2GP08GP09GP16GP17S2GP20R2GP21R1GP22S1GP23UPGP26DOWNGP27LEFTGP28RIGHTGP29VBUSGNDGNDGNDGND3V3(OUT)3V3(OUT)BOOTRESETRESET diff --git a/docs/assets/wiring/Template_Pinout.svg b/docs/assets/wiring/Template_Pinout.svg new file mode 100644 index 0000000..664a127 --- /dev/null +++ b/docs/assets/wiring/Template_Pinout.svg @@ -0,0 +1,3157 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GP00GP00GP00GP01GP01GP01GP02GP02GP02GP03GP03GP03GP04GP04GP04GP05GP05GP05GP06GP06GP06GP07GP07GP07GP08GP08GP08GP09GP09GP09GP10GP10GP10GP11GP11GP11GP12GP12GP12GP13GP13GP13GP14GP14GP14GP15GP15GP15GP16GP16GP16GP17GP17GP17GP18GP18GP18GP19GP19GP19GP20GP20GP20GP21GP21GP21GP22GP22GP22GP23GP23GP23GP24GP24GP24GP25GP25GP25GP26GP26GP26GP27GP27GP27GP28GP28GP28GP29GP29GP29VBUSGNDADC_GND3V3_3NRUNVSYS3V3(OUT)ADC_VREFBOOTUSB_DPUSB_DMRESETSWCLKSWDIO diff --git a/docs/assets/wiring/WaveshareRP2040Zero_Pinout.png b/docs/assets/wiring/WaveshareRP2040Zero_Pinout.png deleted file mode 100644 index 3057626..0000000 Binary files a/docs/assets/wiring/WaveshareRP2040Zero_Pinout.png and /dev/null differ diff --git a/docs/assets/wiring/WaveshareRP2040Zero_Pinout.svg b/docs/assets/wiring/WaveshareRP2040Zero_Pinout.svg new file mode 100644 index 0000000..a7c3c54 --- /dev/null +++ b/docs/assets/wiring/WaveshareRP2040Zero_Pinout.svg @@ -0,0 +1,2870 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +S1GP00S2GP01UPGP02DOWNGP03RIGHTGP04LEFTGP05B1GP06B2GP07R2GP08L2GP09B3GP10B4GP11R1GP12L1GP13A1GP14A2GP15ONBOARD LEDGP16GP17GP18GP19GP20GP21GP22GP23GP24GP25L3GP26R3GP27GP28GP29VBUSGNDGND3V3(OUT) diff --git a/docs/controller-build/wiring.mdx b/docs/controller-build/wiring.mdx index 3bd5c2c..68ceb9b 100644 --- a/docs/controller-build/wiring.mdx +++ b/docs/controller-build/wiring.mdx @@ -4,31 +4,47 @@ title: Microcontroller Board Wiring # - pagination_next: null pagination_prev: null -description: "Default pinouts for common, commercially available microcontroller boards" +description: "Default pinouts for precompiled, common, commercially available microcontroller boards" --- # Wiring -These are the default pin mappings for each GP2040-CE supported microcontroller board. +:::caution + +Custom builds using these microcontroller boards may have different pin mappings from the ones listed below, depending on the vendor. + +Resetting through the Web Configurator may result in incorrect pin mappings so it is recommended to speak with the vendor first. + +::: + +These are the pinouts of the GP2040-CE supported microcontroller board that are precompiled and available for [download](../downloads/download-page.mdx). + +They do not cover all cases and your particular RP2040 based board will likely had a different pin out, which depends entirely on how the board manufacturer decided to make the board. Exercise caution and do not assume that the pins on your board match the ones listed here. + +:::note Reconfigure GPIO Pin Out + +None of these pinouts are permanent. The pinouts can be changed to suit your needs through the [Web Configurator - Pin Mapping](../web-configurator/menu-pages/02-pin-mapping.mdx). + +::: ## Raspberry Pi Pico -:::note +:::info Alternative Pico Boards and Clones The Raspberry Pi Pico pinout can also be used on clone boards with the same form factor and pinout, such as the Pimironi Pico LiPo and the Waveshare RP2040-Plus. ::: -![Raspberry Pi Pico Pinout](../assets//wiring/RaspberryPiPico_Pinout.png) +![Raspberry Pi Pico Pinout](../assets//wiring/RaspberryPiPico_Pinout.svg) ## SparkFun Pro Micro - RP2040 -![SparkFun Pro Micro - RP2040 Pinout](../assets/wiring/SparkFunProMicroRP2040_Pinout.png) +![SparkFun Pro Micro - RP2040 Pinout](../assets/wiring/SparkFunProMicroRP2040_Pinout.svg) ## Waveshare RP2040-Zero -![Waveshare RP2040-Zero Pinout](../assets/wiring/WaveshareRP2040Zero_Pinout.png) +![Waveshare RP2040-Zero Pinout](../assets/wiring/WaveshareRP2040Zero_Pinout.svg) ## Adafruit KB2040 -![Adafruit KB2040 Pinout](../assets/wiring/AdafruitKB2040_Pinout.png) +![Adafruit KB2040 Pinout](../assets/wiring/AdafruitKB2040_Pinout.svg) diff --git a/docs/faq/faq-console-compatibility.mdx b/docs/faq/faq-console-compatibility.mdx index 245bc95..a5ae3f0 100644 --- a/docs/faq/faq-console-compatibility.mdx +++ b/docs/faq/faq-console-compatibility.mdx @@ -25,7 +25,7 @@ When using converters and adapters with PS/Xbox One Passthrough add-ons, you plu ```mermaid graph LR -Converter/Adapter/Dongle --> Controller --> Console +Converter/Adapter/Dongle -- USB Port
on controller --> Controller([Controller]) -- USB Port
on console --> Console{{Console}} ```
@@ -38,7 +38,7 @@ Do not plug the converter/adapter as shown below. ```mermaid graph LR -Controller --> Converter/Adapter/Dongle --> Console +Controller([Controller]) -- USB Port
on Converter --> Converter/Adapter/Dongle -- USB Port
on console --> Console{{Console}} ``` ::: @@ -119,8 +119,6 @@ If you're using an OLED display, the input mode will change from `PS4` to `PS4:A PS Passthrough is an add-on that grants GP2040-CE compatibility with the Playstation 4 or Playstation 5 console by using another controller or dongle to answer authentication -Depending on the controller or dongle used, you may be limited to only Playstation 4 support. - For more information, refer to [PS Passthrough](../add-ons/ps-passthrough.mdx) in the `Web Configurator - Add-ons` section of the documentation. #### What controller or dongle do I use for PS Passthrough? @@ -139,7 +137,7 @@ Some devices that do work for PS5 include, but are not limited to; - [MagicBoots FPS Adapter Joystick Converter for PS4 v1.1](https://www.mayflash.com/product/MAGPS4.html) - [N5 for PXN Game Steering Wheel](https://pxn-game.com/products/n5-for-pxn-game-steering-wheel) -- PCBs from Licensed PS4 Arcade Sticks +- Licensed PS4 Arcade Sticks Because your experience and purchased products may vary, GP2040-CE will not provide additional specific recommendations beyond these known working devices. diff --git a/docs/installation.mdx b/docs/installation.mdx index 9b382e9..c3d8062 100644 --- a/docs/installation.mdx +++ b/docs/installation.mdx @@ -7,15 +7,32 @@ pagination_prev: null description: "How to install firmware onto devices" --- +import InputLabelSelector, { + Hotkey, +} from "@site/src/components/LabelSelector.tsx"; + # Firmware Installation +Select the button labels to be displayed in the usage guide: + + + ## General Process > If the device has been previously used for something other than GP2040-CE, you will need to follow the [Flash Nuke Process](#flash-nuke-process) below first to clear the memory entirely in preparation for installing GP2040-CE. 1. Download the compiled firmware (.uf2 file) for your device 2. Unplug your device. -3. Put your device into Bootsel/USB mode. 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 + +- Holding the BootSel button while plugging in +- Holding while plugging in +- Holding for 5 seconds. + +::: + 4. Drag and drop the compiled firmware (.uf2 file) downloaded in step 1 into the removable drive 5. Wait for the device to automatically disconnect. @@ -29,7 +46,16 @@ 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/download-page.mdx) page. 2. Unplug your Pico. -3. Hold the BOOTSEL button on the Pico and plug into your computer. +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 + +- Holding the BootSel button while plugging in +- Holding while plugging in +- Holding for 5 seconds. + +::: + 4. Drag and drop the `GP2040-CE_X.X.X_Pico.uf2` file into the removable drive. 5. Wait for the Pico to automatically disconnect. @@ -42,7 +68,16 @@ _Warning_ - Flash nuking your board wipes all your custom configuration for pin ::: 1. Download the [flash_nuke.uf2 file](./downloads/flash_nuke.uf2) -2. Boot into bootsel/RPI drive (multiple methods to do so) +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 + +- Holding the BootSel button while plugging in +- Holding while plugging in +- Holding for 5 seconds. + +::: + 3. Drag [flash_nuke.uf2 file](./downloads/flash_nuke.uf2) onto the drive 4. **_Wait for the drive to disconnect and reconnect without unplugging_** 5. Drag your firmware onto the RPI drive and wait for disconnect diff --git a/docs/web-configurator/menu-pages/02-pin-mapping.mdx b/docs/web-configurator/menu-pages/02-pin-mapping.mdx index 53ac28c..7ba8e70 100644 --- a/docs/web-configurator/menu-pages/02-pin-mapping.mdx +++ b/docs/web-configurator/menu-pages/02-pin-mapping.mdx @@ -30,7 +30,11 @@ Options are not limited to a single GPIO pin assignment and can be assigned mult ::: -## Mapping Buttons With :video_game: +## Pin Viewer :video_game: + +This tool is available to see what GPIO pin is physically wired to a button. Click on the button and follow the prompt. It will ask you to press the button and then display a "Pressed pin". + +## Map Buttons With :video_game: ![GP2040-CE Configurator - Pin Mapping - "Map buttons with..." ](../../assets/images/gpc-pin-mapping-map-buttons.png) diff --git a/docs/web-configurator/menu-pages/03-peripheral-mapping.mdx b/docs/web-configurator/menu-pages/03-peripheral-mapping.mdx index c707641..166f739 100644 --- a/docs/web-configurator/menu-pages/03-peripheral-mapping.mdx +++ b/docs/web-configurator/menu-pages/03-peripheral-mapping.mdx @@ -64,8 +64,8 @@ The pins must match a set found on the table below for each SPI block. If this i - `D+` - The GPIO Pin used to carry Data Plus between the USB Host Port and RP2040 - `Enable 5V` - The GPIO Pin used to enable 5V power to the host port on the board. - `Pin Order` - This setting is based on the order that the Data pins are connected to sequential GPIO pins - - `D+/D-` - The GPIO pins is such that, sequentially, `D+` is immediately followed by `D-` - - `D-/D+` -The GPIO pins is such that, sequentially, `D-` is immediately followed by `D+` + - `D+/D-` - The GPIO pins are set such that, sequentially, `D+` is immediately followed by `D-` + - `D-/D+` -The GPIO pins are set such that, sequentially, `D-` is immediately followed by `D+` :::note Enable 5V diff --git a/docs/web-configurator/menu-pages/07-display-configuration.mdx b/docs/web-configurator/menu-pages/07-display-configuration.mdx index a65bf72..85d7493 100644 --- a/docs/web-configurator/menu-pages/07-display-configuration.mdx +++ b/docs/web-configurator/menu-pages/07-display-configuration.mdx @@ -37,6 +37,68 @@ Be sure to pick left and right layouts that match. Some layout combinations resu - `Splash Mode` - Enables or disables a splash screen displaying when the unit is turned on. - `Splash Duration` - Sets the amount of time the splash screen displays for on boot. - `Display Saver Timeout` - Will cause the display to turn off after the specified number of minutes. Pressing any input will cause the display to turn back on. -- `Choose File` - This will allow you to upload your own image to be used for the splash screen. It is recommend that you use a two color 128x64 image (or one that is sized appropriately for your display). Uploading any other type of image will result in a conversion and sizing of the image automatically. If the image is inverted upon upload, just check off the `Invert` box. +- `Choose File` - Upload your own image to be used for the splash screen. + +## Custom Splash Screen + +It is recommend that you use a two color 128x64 image (or one that is sized appropriately for your display). Uploading any other type of image will result in a conversion and sizing of the image automatically. + +Supported Formats: BMP, GIF, JPG, JPEG, PNG, WEBP + +:::caution + +Animated GIFs are not supported at this time. + +::: Check out our collection of great custom splash screens from the community [HERE](../community-splash-screens.mdx) + +## Display Elements + +![GP2040-CE Configurator - Display Example](../../assets/images/gpc-display-example.png) + +This area contains an explanation of display elements and provide an example for how it may appear on your device. + +### Top Row + +Going from left to right, the display elements are + +- [Input Mode](../../usage.mdx#input-modes) - Displays the current input mode + - `XINPUT` - XInput + - `SWITCH` - Nintendo Switch + - `DINPUT` - PS3/DirectInput + - `HID-KB` - Keyboard + - `PS4` - Controller Mode set as `Controller`, will change to `PS4:AS` on successful authentication + - `PS4:AS` - [PS4 Mode](../../add-ons/ps4-mode.mdx) add-on successfully authenticated + - `PS5` - Controller Mode Set as `Arcade Stick`, will change to `PS5:AS` on successful authentication + - `PS5:AS` - [PS Passthrough](../../add-ons/ps-passthrough.mdx) add-on successfully authenticated + - `XBONE` - Xbox One compatible with [Xbox One Passthrough](../../add-ons/xbox-one-passthrough.mdx) + - `OGXBOX` - Original XBox + - `GEN/MD` - Sega Genesis/MegaDrive Mini + - `NGMINI` - NEOGEO mini + - `PCE/TG` - PC Engine/Turbografx 16 Mini + - `EGRET` - EGRET II Mini + - `ASTRO` - ASTROCITY Mini + - `PSC` - Playstation Classic +- [Turbo](../../add-ons/turbo.mdx) - Will display `T##` when Turbo is enabled where ## is the number of presses per second +- DPad Mode - Displays the current DPad Mode + - `D` - [DPad Digital](../../hotkeys.mdx#dpad-digital) + - `L` - [DPad Left Analog](../../hotkeys.mdx#dpad-left-analog) + - `R` - [DPad Right Analog](../../hotkeys.mdx#dpad-right-analog) +- SOCD Cleaning Mode - Displays the current SOCD cleaning Mode + - `SOCD-U` - [SOCD Up Priority](../../hotkeys.mdx#socd-up-priority) + - `SOCD-N` - [SOCD Neutral](../../hotkeys.mdx#socd-neutral) + - `SOCD-L` - [SOCD Last Win](../../hotkeys.mdx#socd-last-win) + - `SOCD-F` - [SOCD First Wins](../../hotkeys.mdx#socd-first-wins) + - `SOCD-X` - [SOCD Cleaning Off](../../hotkeys.mdx#socd-cleaning-off) +- [Macros](./09-macros.mdx) - `M` will appear if Macros are enabled and this cannot be disabled. + +### Middle + +The appearance of this area will depend on the particular configuration of your [Button Layouts](#layout-options) on the Left and Right sides + +- Turbo Rings - When using the Turbo Mode is enabled on individual buttons, the buttons will have a smaller inner ring as an indicator. When disabled, this button will disappear. + +### Bottom + +- Input History - Will display input history when the [Input History](../../add-ons/input-history.mdx) add-on is enabled and configured diff --git a/docs/web-configurator/menu-pages/09-macros.mdx b/docs/web-configurator/menu-pages/09-macros.mdx index 7f165f1..02470c6 100644 --- a/docs/web-configurator/menu-pages/09-macros.mdx +++ b/docs/web-configurator/menu-pages/09-macros.mdx @@ -44,7 +44,7 @@ When a macro stops for any reason and are triggered. again, the macro starts aga :::note -This option is **only** available when `Interruptible` is enabled. +This option is **only** available when `Interruptible` is disabled. ::: @@ -74,7 +74,7 @@ Each individual macro has a maximum of 50 lines where each input line has a maxi Each input line is composed of the following elements from left to right. -`Input Line Duration` ms `Inputs` | `Post Input Wait Duration` ms +`Input Line Duration` ms/frame(s) `Inputs` | `Post Input Wait Duration` ms - Input Line Duration - The duration that the inputs are held for. (Maximum 4,294,967ms or 268,435 frames) - Inputs - The inputs to be held during the execution of the input line. diff --git a/docs/web-configurator/menu-pages/11-danger-zone.mdx b/docs/web-configurator/menu-pages/11-danger-zone.mdx index d12500e..0619cb4 100644 --- a/docs/web-configurator/menu-pages/11-danger-zone.mdx +++ b/docs/web-configurator/menu-pages/11-danger-zone.mdx @@ -2,11 +2,11 @@ title: DANGER ZONE # tags: # - -# pagination_next: null +pagination_next: null pagination_prev: null description: "Perform a firmware reset on your controller" --- -# ## DANGER ZONE +# DANGER ZONE ![GP2040-CE Configurator - Reset Settings](../../assets/images/gpc-reset-settings.png) diff --git a/docs/web-configurator/web-configurator.mdx b/docs/web-configurator/web-configurator.mdx index c7537d9..b6659ff 100644 --- a/docs/web-configurator/web-configurator.mdx +++ b/docs/web-configurator/web-configurator.mdx @@ -4,7 +4,7 @@ title: GP2040-CE Web Configurator # - pagination_next: null pagination_prev: null -description: "GP2040-CE's Web-Based Configuration Application: Just press S2 on boot and go to http://192.168.7.1" +description: "GP2040-CE's Web-Based Configuration Application: Just hold S2 on boot or hold S2+B3+B4 while already plugged in. Then go to http://192.168.7.1 to access the Web Configurator." --- import InputLabelSelector, { diff --git a/sidebars.js b/sidebars.js index 0a37acf..7f7c4ce 100644 --- a/sidebars.js +++ b/sidebars.js @@ -53,7 +53,7 @@ const sidebars = { { type: "category", label: "Controller Building", - collapsed: true, + collapsed: false, items: ["controller-build/wiring", "controller-build/usb-host"], }, ],