diff --git a/docs/add-ons/i2c-analog-ads1256-spi.mdx b/docs/add-ons/i2c-analog-ads1256-spi.mdx new file mode 100644 index 0000000..ba7dfd9 --- /dev/null +++ b/docs/add-ons/i2c-analog-ads1256-spi.mdx @@ -0,0 +1,33 @@ +--- +title: Analog ADS1256-SPI +# tags: +# - +pagination_next: null +pagination_prev: null +description: "Add-on to use ADS1256 SPI for compatible accessories (currently in early beta)" +--- + +# Analog ADS1256 (SPI) + +Purpose: This add-on is intended to allow you to use ADS1256 SPI compatible accessories (currently in early beta). + +![GP2040-CE Configurator - Add-Ons ADS1219](../assets/images/gpc-add-ons-ads1256-spi.png) + +## Web Configurator Options + +:::info GPIO Pin Assignment + +The `SPI Block`, `Chip Select Pin` and `Data Ready Pin` are now configured in [`Configuration > Peripheral Mapping - SPI`](../web-configurator/menu-pages/03-peripheral-mapping.mdx#spi). + +::: + +- `SPI Block` - The block of SPI to use (spi0 or spi1). +- `Chip Select (CS) Pin` - The GPIO pin to use for Chip Select. +- `Data Ready (DRDY) Pin` - The GPIO pin to use for Data Ready. +- `Analog Max` - The maximum voltage that will be used, `3.3V` and `5V` are selectable here. + +## Hardware + +### Requirements + +Please note that this add-on is currently in early beta and no examples of use are offered. diff --git a/docs/add-ons/rotary-encoders.mdx b/docs/add-ons/rotary-encoders.mdx new file mode 100644 index 0000000..bbeb0b3 --- /dev/null +++ b/docs/add-ons/rotary-encoders.mdx @@ -0,0 +1,36 @@ +--- +title: Rotary Encoders +# tags: +# - +pagination_next: null +pagination_prev: null +description: "Add-on to allow for the use of rotary encoders." +--- + +# Rotary Encoders + +:::Note + +Please note that rotary encoders are currently in beta. +::: + +Purpose: Rotary encoders allow for continuous or limited min-max pulses on specified pins. + +![GP2040-CE Configuration - Add-Ons Rotary Encoders](../assets/images/gpc-add-ons-rotary-encoders.png) + +## Web Configurator Options + +- `Enabled` - Enables or disables `Encoder 1` or `Encoder 2`. +- `Pin A/CLK` - The `Clock` pin for the encoder. +- `Pin B/DT` - The `Data` pin for the encoder`. +- `Pulses/Revolutions (PPR)` - The number of puleses/revolutions on your encoder. +- `Multiplier` - Use this multiplier to fine tune your encoder performance in GP2040-CE. +- `Reset After (ms)` - The number of miliseconds to wait before resetting the value to `0` / `center`. +- `Control Mode` - Choose how this encoder will function. +- `Allow Wrap-Around` - Allows the encoder to reach an axis max and wrap-around to the axis minimum. + +- + +## Hardware + +At this time we do not have recommended modules. This is a newly introduced feature. \ No newline at end of file diff --git a/docs/assets/images/gpc-add-ons-ads1256-spi.png b/docs/assets/images/gpc-add-ons-ads1256-spi.png new file mode 100644 index 0000000..c3a826a Binary files /dev/null and b/docs/assets/images/gpc-add-ons-ads1256-spi.png differ diff --git a/docs/assets/images/gpc-add-ons-rotary-encoders.png b/docs/assets/images/gpc-add-ons-rotary-encoders.png new file mode 100644 index 0000000..a3c5031 Binary files /dev/null and b/docs/assets/images/gpc-add-ons-rotary-encoders.png differ diff --git a/docs/assets/images/gpc-macro-options.png b/docs/assets/images/gpc-macro-options.png new file mode 100644 index 0000000..878fbb3 Binary files /dev/null and b/docs/assets/images/gpc-macro-options.png differ diff --git a/docs/assets/images/gpc-macros.png b/docs/assets/images/gpc-macros.png index 56a5fec..c9d9bab 100644 Binary files a/docs/assets/images/gpc-macros.png and b/docs/assets/images/gpc-macros.png differ diff --git a/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx b/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx index df12483..afe6e7c 100644 --- a/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx +++ b/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx @@ -25,20 +25,26 @@ Some of these add-ons are experimental and not all add-ons are interoperable wit - [Dual Directional Input](../../add-ons/dual-direction-input.mdx) - [Focus Mode Configuration](../../add-ons/focus-mode.mdx) - [I2C Analog ADS1219](../../add-ons/i2c-analog-ads1219.mdx) +- [I2C Analog ADS1256 (SPI)](../../add-ons/i2c-analog-ads1256-spi.mdx) - [Input History](../../add-ons/input-history.mdx) - [Input Reverse](../../add-ons/input-reverse.mdx) - [Joystick Selection Slider](../../add-ons/joystick-selection-slider.mdx) - [Keyboard Host Configuration](../../add-ons/keyboard-host.mdx) - [On-board LED Configuration](../../add-ons/on-board-led.mdx) - [Player Number (X-INPUT ONLY)](../../add-ons/player-number.mdx) -- [SNES Input](../../add-ons/snes-input.mdx) -- [SOCD Selection Slider](../../add-ons/socd-selection-slider.mdx) +- [Rotary Encoders](../../add-ons/rotary-encoders.mdx) +- [SNES Extension Configuration](../../add-ons/snes-input.mdx) +- [SOCD Cleaning Mode Selection Slider](../../add-ons/socd-selection-slider.mdx) - [Tilt Input](../../add-ons/tilt-input.mdx) - [Turbo](../../add-ons/turbo.mdx) - [Wii Extensions](../../add-ons/wii-extensions.mdx) ## Deprecated Add-ons -- PS4 Mode -- PS Passthrough -- Xbox One Passthrough +- PS4 Mode * +- PS Passthrough ** +- Xbox One Passthrough *** + +* PS4 Mode has been moved to the main settings section under `Current Input Mode` / `PS4` when you select `Upload Key Files` for the `Authentication Settings`. +** PS Passthrough mode has been moved to the main settings section under both `PS4` and `PS5` modes. +*** Xbox One Passthrough mode has been moved to the main settins section under `Xbox One` mode and is turned on by default. diff --git a/docs/web-configurator/menu-pages/09-macros.mdx b/docs/web-configurator/menu-pages/09-macros.mdx index 02470c6..4301e52 100644 --- a/docs/web-configurator/menu-pages/09-macros.mdx +++ b/docs/web-configurator/menu-pages/09-macros.mdx @@ -11,21 +11,49 @@ description: "Macro settings and how to create input macros" Macros are a series or combination of gamepad inputs triggered with a single button or a combination of buttons. +:::note + +Setting an overall `Macro` button as well as dedicated individual `Macro` buttons for any of the six available macro slots is now set via the `Configuration` / `Pin Mapping` page. + +::: + +## Macros Overview + +The Macros Overview screen will show you key information about your macro setup like which macros are currently activated, which pins (if any) they are assigned to and the label which has been assigned for each. + ![GP2040-CE Configurator - Macros](../../assets/images/gpc-macros.png) -## Macro Options +You can also have the onbload LED (on the Pico and other devices that have a connected onboard LED) turn on while a macro is active. -`Macro Button Pin` - The GPIO Pin used to activate macros in combination with other inputs when `Uses Button` is enabled and set. +Use Board LED to Display Macro Status: +- `Off` - The Board LED will not turn on while a macro is active +- `On` - The Board LED will turn on while a macro is active -### Label +![GP2040-CE Configurator - Macro Options](../../assets/images/gpc-macro-options.png) -This is the name of the macro and is optional. +## Macro Options + +On the left hand column you will see the `Macros Overview` link as well as links to each of the six configurable macros. + +### Macro Enabled -### Activate +The `Enabled` slider will allow you to enable and disable a macro. - `Off` - The macro is not available for use. - `On` - The macro is available for use when triggered by either the GPIO pin or the combination set in [`Uses Button`](#uses-button). +### Macro Name + +This is the name of the macro and is optional. + +### Macro Activation Type + +This describes is how the GPIO pin or the combination set in [`Uses Button`](#uses-button) triggers and repeats the macro. + +- Press - Full press of button triggers the macro once +- Hold Repeat - Holding button to repeatedly triggers macro +- Toggle - Full press of button causes the macro to repeatedly trigger, another full press of the button will stop the macro from repeatedly triggering. + ### Interruptible - `Off` - The macro cannot be stopped and will execute all lines until the macro is completed. @@ -48,23 +76,17 @@ This option is **only** available when `Interruptible` is disabled. ::: -### Show Frames +### Use Macro Button + Gamepad Button to Trigger -- `Off` - The duration in the macro input line editor will appear in milliseconds (ms). -- `On` - The duration in the macro input line editor will appear as a number of frames, assuming 60 frames per second. - -### Uses Button +If you have set an overall `Macro Button` in the `Pin Mapping` configuration page this will allow you to set a `Button Assignment` + the set Macro button to activate the Macro. - `Off` - This macro is assigned to a GPIO pin on the board and when pressed, the macro will be triggered. - `On` - This macro is assigned to a button combination of `Macro Button Pin + Input` where the input can be any of the standard gamepad inputs. -### Trigger Mode - -This describes is how the GPIO pin or the combination set in [`Uses Button`](#uses-button) triggers and repeats the macro. +### Show Frames -- Press - Full press of button triggers the macro once -- Hold Repeat - Holding button to repeatedly triggers macro -- Toggle - Full press of button causes the macro to repeatedly trigger, another full press of the button will stop the macro from repeatedly triggering. +- `Off` - The duration in the macro input line editor will appear in milliseconds (ms). +- `On` - The duration in the macro input line editor will appear as a number of frames, assuming 60 frames per second. ## Macro Input Line Editor @@ -82,6 +104,6 @@ Each input line is composed of the following elements from left to right. :::note Deleting Input Lines -To delete an input line, double-click the "x" button. +To delete an input line, double-click the "firework" image. -::: +::: \ No newline at end of file