From 6fe1ebe246e00da624b58456c7ecfbfdf83b8524 Mon Sep 17 00:00:00 2001 From: wongfei2009 Date: Mon, 17 Nov 2025 01:26:27 +0800 Subject: [PATCH 1/7] Add initial documentation and implementation for Sky 2040 v2 turbo controls --- CLAUDE.md | 588 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 588 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000000..3652fd9216 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,588 @@ +# Sky 2040 v2 GP2040-CE Turbo Enhancement Project + +## Quick Summary +**Goal**: Add hardware-based turbo controls to Sky 2040 v2 joystick +- ✅ Analog turbo speed dial (potentiometer, 2-30 shots/sec) +- ✅ 8 per-button turbo switches (B1-B4, L1-L2, R1-R2) +- **Strategy**: Use I2C GPIO expander (MCP23017 breakout board) for switches +- **GPIO Required**: 1 ADC (speed dial) + I2C bus (shared with display) +- **Hardware**: MCP23017 breakout board + potentiometer + 8 switches +- **Target Board**: Sky 2040 Version 2 + +## Project Location +- **Fork**: `/Users/fwong/Documents/github/wongfei2009/GP2040-CE` +- **Upstream**: OpenStickCommunity/GP2040-CE + +--- + +## Sky 2040 v2 Configuration + +### Base Configuration +- **Board Type**: Raspberry Pi Pico form factor +- **Board Version**: Sky 2040 Version 2 +- **Note**: Actual GPIO mappings will be documented once physical board is available for testing + +### Planned Features +- I2C Display (shared bus with MCP23017) +- RGB LEDs +- Turbo speed dial (ADC input) +- 8 per-button turbo switches via MCP23017 I2C expander + +--- + +## Hardware Implementation + +### Why I2C Expander? +**Problem**: Sky 2040 v2 has sufficient GPIOs on the RP2040, but they're already assigned to existing features (buttons, display, RGB LEDs, etc.) +- We need 8 switches + 1 speed dial = 9 **additional** pins +- No unassigned GPIOs available for these new turbo features + +**Solution**: MCP23017 I2C GPIO Expander +- Provides 16 additional GPIO pins via I2C +- Shares I2C bus with display (no extra pins needed) +- Configurable I2C address (default 0x20) +- Built-in pull-up resistors +- Widely available and inexpensive (~$1-2) + +### Component List + +#### 1. MCP23017 I2C GPIO Expander Breakout Board +**Specs**: +- 16 GPIO pins (we need 8) +- I2C interface (3.3V compatible) +- Configurable address: 0x20-0x27 (via solder jumpers or switches) +- Internal pull-ups available +- Pre-wired power, I2C, and address configuration + +**Recommended Products**: +- Adafruit MCP23017 I2C GPIO Expander Breakout (#732) +- SparkFun Qwiic GPIO MCP23017 +- Generic MCP23017 breakout boards on Amazon/AliExpress + +**I2C Address**: Use **0x20** (default) to avoid conflict with display (0x3C) + +#### 2. Turbo Speed Dial +- 10kΩ linear potentiometer (rotary or slide) + +#### 3. Turbo Switches +- 8× SPST toggle switches OR 1× DIP-8 switch array + +#### 4. Wiring Components +- Breadboard (for prototyping) +- Jumper wires (male-to-female recommended for breakout boards) + +--- + +## Software Implementation + +### Phase 1: Create Sky2040 v2 BoardConfig +**File**: `configs/Sky2040v2/BoardConfig.h` + +**Note**: GPIO pin mappings will be determined once physical Sky 2040 v2 board is available for testing. The following are placeholders based on anticipated differences from standard Pico. + +**Expected Changes from Pico**: +```cpp +// Board identification +#define BOARD_CONFIG_LABEL "Sky2040v2" + +// GPIO mappings - TO BE VERIFIED with physical Sky 2040 v2 board +// (Sky 2040 v2 may have different pin layout than standard Pico) + +// Turbo speed dial (ADC input - pin TBD with physical board) +#define PIN_SHMUP_DIAL 26 // To be verified + +// I2C Turbo switches configuration +#define TURBO_I2C_SWITCHES_ENABLED 1 +#define TURBO_I2C_SDA_PIN 0 // To be verified - shared with display +#define TURBO_I2C_SCL_PIN 1 // To be verified - shared with display +#define TURBO_I2C_BLOCK i2c0 // Same I2C block as display +#define TURBO_I2C_SPEED 400000 // 400kHz (same as display) +#define TURBO_I2C_ADDR 0x20 // MCP23017 address + +// RGB LEDs (pin TBD with physical board) +#define BOARD_LEDS_PIN 28 // To be verified +``` + +**Action Required**: Once Sky 2040 v2 board arrives, verify all GPIO assignments and update accordingly. + +### Phase 2: Add MCP23017 Driver +**Files**: `src/addons/turbo.cpp`, `headers/addons/turbo.h`, `lib/mcp23017/mcp23017.h` + +#### Create MCP23017 Library +**File**: `lib/mcp23017/mcp23017.h` +```cpp +#ifndef MCP23017_H +#define MCP23017_H + +#include "hardware/i2c.h" +#include + +// MCP23017 Register Addresses +#define MCP23017_IODIRA 0x00 // I/O direction A +#define MCP23017_IODIRB 0x01 // I/O direction B +#define MCP23017_GPPUA 0x0C // Pull-up A +#define MCP23017_GPPUB 0x0D // Pull-up B +#define MCP23017_GPIOA 0x12 // Port A +#define MCP23017_GPIOB 0x13 // Port B + +class MCP23017 { +public: + MCP23017(i2c_inst_t* i2c, uint8_t addr); + + bool init(); // Initialize chip + void setPinMode(uint8_t pin, bool input); + void setPullup(uint8_t pin, bool enable); + bool readPin(uint8_t pin); + uint16_t readAll(); // Read all 16 pins + +private: + i2c_inst_t* i2c_; + uint8_t addr_; + + void writeRegister(uint8_t reg, uint8_t value); + uint8_t readRegister(uint8_t reg); +}; + +#endif // MCP23017_H +``` + +**File**: `lib/mcp23017/mcp23017.cpp` +```cpp +#include "mcp23017.h" + +MCP23017::MCP23017(i2c_inst_t* i2c, uint8_t addr) + : i2c_(i2c), addr_(addr) {} + +bool MCP23017::init() { + // Configure all pins on Port A as inputs with pull-ups + writeRegister(MCP23017_IODIRA, 0xFF); // All inputs + writeRegister(MCP23017_GPPUA, 0xFF); // All pull-ups enabled + + // Port B unused (all inputs, no pull-ups) + writeRegister(MCP23017_IODIRB, 0xFF); + writeRegister(MCP23017_GPPUB, 0x00); + + return true; +} + +void MCP23017::writeRegister(uint8_t reg, uint8_t value) { + uint8_t buf[2] = {reg, value}; + i2c_write_blocking(i2c_, addr_, buf, 2, false); +} + +uint8_t MCP23017::readRegister(uint8_t reg) { + uint8_t value; + i2c_write_blocking(i2c_, addr_, ®, 1, true); + i2c_read_blocking(i2c_, addr_, &value, 1, false); + return value; +} + +uint16_t MCP23017::readAll() { + uint8_t portA = readRegister(MCP23017_GPIOA); + uint8_t portB = readRegister(MCP23017_GPIOB); + return (portB << 8) | portA; +} + +bool MCP23017::readPin(uint8_t pin) { + if (pin < 8) { + uint8_t portA = readRegister(MCP23017_GPIOA); + return (portA & (1 << pin)) != 0; + } else { + uint8_t portB = readRegister(MCP23017_GPIOB); + return (portB & (1 << (pin - 8))) != 0; + } +} +``` + +#### Modify Turbo Add-on for I2C Switches +**File**: `headers/addons/turbo.h` +```cpp +// Add to existing TurboInput class + +#ifdef TURBO_I2C_SWITCHES_ENABLED +#include "mcp23017.h" +#endif + +class TurboInput : public GPAddon { +public: + // ... existing members ... + +#ifdef TURBO_I2C_SWITCHES_ENABLED + MCP23017* mcp_; // I2C expander instance +#endif +}; +``` + +**File**: `src/addons/turbo.cpp` +```cpp +#include "addons/turbo.h" + +void TurboInput::setup() { + // ... existing setup code ... + + #ifdef TURBO_I2C_SWITCHES_ENABLED + // Initialize MCP23017 on shared I2C bus + // Note: I2C already initialized by display addon + mcp_ = new MCP23017(TURBO_I2C_BLOCK, TURBO_I2C_ADDR); + + if (!mcp_->init()) { + // Handle initialization error + // Could set flag to disable I2C switches + delete mcp_; + mcp_ = nullptr; + } + #endif +} + +void TurboInput::process() { + #ifdef TURBO_I2C_SWITCHES_ENABLED + if (mcp_) { + // Read all 8 switches from MCP23017 Port A (active-low) + uint8_t switchStates = mcp_->readRegister(MCP23017_GPIOA); + + // Build turbo mask from switch states + uint16_t hardwareTurboMask = 0; + + // Map MCP23017 pins to button masks (active-low) + if (!(switchStates & 0x01)) hardwareTurboMask |= GAMEPAD_MASK_B1; // GPA0 + if (!(switchStates & 0x02)) hardwareTurboMask |= GAMEPAD_MASK_B2; // GPA1 + if (!(switchStates & 0x04)) hardwareTurboMask |= GAMEPAD_MASK_B3; // GPA2 + if (!(switchStates & 0x08)) hardwareTurboMask |= GAMEPAD_MASK_B4; // GPA3 + if (!(switchStates & 0x10)) hardwareTurboMask |= GAMEPAD_MASK_L1; // GPA4 + if (!(switchStates & 0x20)) hardwareTurboMask |= GAMEPAD_MASK_R1; // GPA5 + if (!(switchStates & 0x40)) hardwareTurboMask |= GAMEPAD_MASK_L2; // GPA6 + if (!(switchStates & 0x80)) hardwareTurboMask |= GAMEPAD_MASK_R2; // GPA7 + + // Hardware switches override software turbo settings + turboButtonsMask = hardwareTurboMask; + } + #endif + + // Continue with existing turbo flicker logic + // Speed dial already supported via pinShmupDial (GPIO 26) + // ... existing turbo processing code ... +} +``` + +--- + +## Implementation Roadmap + +### Phase 1: BoardConfig Setup ⏱️ 1 hour +**Tasks**: +1. Create `configs/Sky2040v2/` directory +2. Copy `configs/Pico/BoardConfig.h` → `configs/Sky2040v2/BoardConfig.h` +3. Apply initial changes for Sky 2040 v2: + - Set `BOARD_CONFIG_LABEL "Sky2040v2"` + - Add I2C turbo switch definitions (placeholder pins) + - Add turbo speed dial definition (placeholder pin) + - Add RGB LED definition (placeholder pin) + - **IMPORTANT**: Mark all GPIO assignments as "TO BE VERIFIED" until physical board arrives +4. Create `configs/Sky2040v2/README.md` noting that pin mappings are pending physical board verification +5. Test build: + ```bash + export GP2040_BOARDCONFIG=Sky2040v2 + cd build && cmake .. && make -j$(sysctl -n hw.ncpu) + ``` + +**Post-Hardware Arrival**: +- Map all buttons and verify GPIO assignments with physical Sky 2040 v2 board +- Update BoardConfig.h with verified pin mappings +- Test each button, display, RGB LEDs, and peripherals +- Document actual pinout in README.md + +**Success Criteria**: +- ✅ Builds without errors (with placeholder pins) +- ✅ Ready to update with real pin mappings when board arrives + +### Phase 2: MCP23017 Library ⏱️ 2-3 hours +**Tasks**: +1. Create `lib/mcp23017/` directory +2. Implement `mcp23017.h` (header file) +3. Implement `mcp23017.cpp` (driver code) +4. Add to CMakeLists.txt +5. Test I2C communication: + - Verify address detection (0x20) + - Test register read/write + - Verify no conflict with display (0x3C) +6. Create test program to read switches + +**Success Criteria**: +- ✅ MCP23017 detected on I2C bus +- ✅ Can read Port A register +- ✅ Display continues working +- ✅ No I2C bus conflicts + +### Phase 3: Hardware Assembly ⏱️ 2-3 hours +**Tasks**: +1. Acquire components: + - **MCP23017 breakout board** (Adafruit, SparkFun, or generic) + - 8× SPST toggle switches OR DIP-8 switch array + - 10kΩ linear potentiometer + - Breadboard + jumper wires + - Sky 2040 v2 board +2. **First Step with Sky 2040 v2**: Map and document all GPIO pins + - Identify I2C pins (SDA/SCL) for display and MCP23017 + - Identify available ADC pin for potentiometer + - Identify RGB LED data pin (if present) + - Identify all button pins and verify their functions + - Update `configs/Sky2040v2/BoardConfig.h` with verified mappings +3. Connect MCP23017 breakout to Sky 2040 v2: + - VCC/VDD → 3.3V + - GND → GND + - SDA → Verified I2C SDA pin + - SCL → Verified I2C SCL pin + - Set I2C address to 0x20 (usually default) +4. Connect 8 switches to MCP23017 GPA0-GPA7 pins (one side to pin, other to GND) +5. Connect potentiometer wiper to verified ADC pin (other pins to GND and 3.3V) +6. Test connections with multimeter + +**Success Criteria**: +- ✅ Sky 2040 v2 GPIO pinout fully documented +- ✅ MCP23017 detected on I2C bus at 0x20 +- ✅ I2C communication works +- ✅ All switches toggle cleanly +- ✅ Potentiometer reads correctly +- ✅ Display still works on Sky 2040 v2 (no I2C conflict) + +### Phase 4: Turbo Addon Integration ⏱️ 4-6 hours +**Tasks**: +1. Modify `headers/addons/turbo.h`: + - Include MCP23017 header + - Add MCP23017* member to TurboInput class + - Add I2C configuration constants +2. Modify `src/addons/turbo.cpp`: + - Initialize MCP23017 in `setup()` + - Read switches in `process()` + - Map switch states to button masks + - Override turboButtonsMask with hardware state +3. Handle I2C bus sharing: + - Verify display addon initializes I2C first + - Ensure MCP23017 doesn't re-initialize bus + - Add mutex if concurrent access needed (unlikely) +4. Rebuild and flash firmware +5. Test each switch independently +6. Test multiple switches simultaneously +7. Test speed dial adjustment +8. Verify no display interference + +**Success Criteria**: +- ✅ Each switch controls correct button turbo +- ✅ All 8 switches work independently +- ✅ Speed dial adjusts turbo rate smoothly +- ✅ Display continues working perfectly +- ✅ No I2C bus conflicts or glitches +- ✅ RGB LEDs still functional + +### Phase 5: Testing & Validation ⏱️ 2-3 hours +**Hardware Tests**: +1. Individual button turbo (8 tests) +2. Multiple button turbo simultaneously (all 8) +3. Speed dial adjustment while turbo active +4. Long-duration stress test (30+ minutes) +5. Power cycle persistence +6. I2C bus stress test (rapid switch toggling) + +**Cross-Platform Tests**: +1. PC (XInput mode) +2. Nintendo Switch +3. PS4/PS5 (if dongle available) +4. Steam Deck (if available) + +**Edge Cases**: +1. All 8 switches ON simultaneously +2. Rapid switch toggling (stress I2C) +3. Speed dial at min/max extremes +4. Turbo button press during hardware turbo +5. Display updates during switch reads + +**Success Criteria**: +- ✅ All tests pass without errors +- ✅ No I2C bus hangs or timeouts +- ✅ Display remains responsive +- ✅ Consistent behavior across platforms +- ✅ No firmware crashes + +### Phase 6: Optimization & Polish ⏱️ 1-2 hours +**Tasks**: +1. Measure I2C read latency +2. Optimize switch polling frequency +3. Add error recovery for I2C failures +4. Implement switch debouncing if needed +5. Add OLED display indicators for active turbo +6. Test and tune turbo speed range + +**Success Criteria**: +- ✅ I2C latency <1ms +- ✅ Total polling overhead <1% CPU +- ✅ Robust error handling +- ✅ Clean switch response + +### Phase 7: Documentation ⏱️ 1-2 hours +**Tasks**: +1. Update `configs/Sky2040v2/README.md`: + - Complete pin mapping table + - I2C expander wiring diagram + - Turbo switch wiring + - Speed dial wiring + - I2C address configuration +2. Document MCP23017 library API +3. Create build guide for users +4. Add troubleshooting section +5. Take photos of completed build +6. Update CLAUDE.md with final status + +**Total Time**: 12-18 hours for complete implementation (reduced due to breakout board simplicity) + +--- + +## Build & Flash Commands + +### Build Firmware +```bash +# Set board configuration +export GP2040_BOARDCONFIG=Sky2040v2 + +# Navigate to project +cd /Users/fwong/Documents/github/wongfei2009/GP2040-CE + +# Create and enter build directory +mkdir -p build && cd build + +# Configure build +cmake .. + +# Build (use all CPU cores) +make -j$(sysctl -n hw.ncpu) + +# Output file: GP2040-CE_X.X.X_Sky2040v2.uf2 +``` + +### Flash to Device +```bash +# Method 1: Hold BOOTSEL while plugging in USB +# Method 2: Short RUN pin to GND twice quickly + +# Copy firmware (device appears as RPI-RP2) +cp GP2040-CE_*_Sky2040v2.uf2 /Volumes/RPI-RP2/ + +# Wait for automatic reboot +``` + +--- + +## Success Criteria Checklist + +### Must Have ✅ +- [ ] Sky2040v2 BoardConfig builds successfully +- [ ] All 18 original buttons work correctly +- [ ] MCP23017 communicates via I2C +- [ ] Speed dial adjusts turbo speed (2-30 shots/sec) +- [ ] All 8 turbo switches control their respective buttons +- [ ] Hardware switches override software turbo +- [ ] Display continues working (no I2C conflict) +- [ ] RGB LEDs still functional +- [ ] No input latency added (<1ms overhead) +- [ ] Firmware stable in all input modes + +### Nice to Have 🎯 +- [ ] OLED shows active turbo indicators +- [ ] Web configurator shows switch states +- [ ] I2C error recovery implemented +- [ ] Settings persist across power cycles +- [ ] Upstream PR contribution + +--- + +## Next Immediate Steps + +### Ready to Start +1. ✅ **Decision made**: MCP23017 breakout board approach +2. ✅ **Documentation complete**: Full implementation plan for Sky 2040 v2 +3. ✅ **Board identified**: Sky 2040 Version 2 +4. ⏭️ **Next action**: Order MCP23017 breakout board + components + +### Phase 1 Action Items (Can Start Now - Before Hardware Arrives) +```bash +# 1. Create directory for Sky 2040 v2 config +mkdir -p configs/Sky2040v2 + +# 2. Copy base config +cp configs/Pico/BoardConfig.h configs/Sky2040v2/BoardConfig.h + +# 3. Edit the file (apply placeholder Sky 2040 v2 config) +# Mark GPIO pins as "TO BE VERIFIED" with physical board + +# 4. Create MCP23017 library +mkdir -p lib/mcp23017 +# (implement mcp23017.h and mcp23017.cpp) + +# 5. Test build for Sky 2040 v2 (with placeholder config) +export GP2040_BOARDCONFIG=Sky2040v2 +cd build && cmake .. && make -j$(sysctl -n hw.ncpu) +``` + +**After Sky 2040 v2 Board Arrives**: +1. Flash placeholder firmware to test basic functionality +2. Map all GPIO pins with multimeter and testing +3. Update BoardConfig.h with verified pin assignments +4. Rebuild and verify all functions work correctly +5. Proceed to Phase 3 (Hardware Assembly) + +--- + +## macOS Build Instructions + +Building the firmware from source on macOS requires a specific setup to resolve dependency conflicts. The following steps have been verified to produce a successful build. + +### Prerequisites + +1. **Xcode Command Line Tools**: Install by running `xcode-select --install` in your terminal. +2. **Homebrew**: The macOS package manager. If not installed, get it from [brew.sh](https://brew.sh/). +3. **ARM GCC Toolchain**: Install via Homebrew Cask: + ```bash + brew install --cask gcc-arm-embedded + ``` + +### Build Steps + +The build process involves manually downloading the correct Pico SDK version before running CMake and Make. + +1. **Clone the Correct Pico SDK Version** + + The project requires Pico SDK version **2.1.1**. Clone it into the project's root directory: + ```bash + git clone --branch 2.1.1 https://github.com/raspberrypi/pico-sdk.git pico-sdk-2.1.1 + ``` + +2. **Initialize SDK Submodules** + + Navigate into the newly created SDK directory and initialize its submodules (which include the compatible Mbed TLS library): + ```bash + cd pico-sdk-2.1.1 + git submodule update --init --recursive + cd .. + ``` + +3. **Configure and Build the Firmware** + + This single command chain will clean any previous build, set the required environment variables, configure the project with CMake, and compile it with Make. + + Run this from the root of the `GP2040-CE` project directory: + ```bash + rm -rf build && \ + mkdir build && \ + cd build && \ + export SDKROOT=$(xcrun --sdk macosx --show-sdk-path) && \ + PICO_SDK_PATH=$(pwd)/../pico-sdk-2.1.1 GP2040_BOARDCONFIG=Pico cmake -DPICO_SDK_FETCH_FROM_GIT=OFF .. && \ + make -j$(sysctl -n hw.ncpu) + ``` + + - `rm -rf build`: Cleans up any previous build attempts. + - `export SDKROOT=...`: Explicitly sets the path to the macOS SDK, which fixes issues with compiling host-side Python tools. + - `PICO_SDK_PATH=...`: Points the build system to our manually downloaded SDK. + - `GP2040_BOARDCONFIG=Pico`: Sets the target board. Change `Pico` to your desired board if different. + - `PICO_SDK_FETCH_FROM_GIT=OFF`: Prevents the build system from automatically downloading another SDK. + - `make -j...`: Compiles the firmware using all available CPU cores. + + Upon completion, the firmware file (e.g., `GP2040-CE_0.0.0_Pico.uf2`) will be located in the `build` directory. From c4186d632ece0e2482d21ee20aca9044e4810734 Mon Sep 17 00:00:00 2001 From: wongfei2009 Date: Mon, 17 Nov 2025 01:37:38 +0800 Subject: [PATCH 2/7] Refactor documentation for GP2040-CE turbo enhancement project to clarify goals, hardware requirements, and implementation details for broader compatibility. --- CLAUDE.md | 364 +++++++++++++----------------------------------------- 1 file changed, 86 insertions(+), 278 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 3652fd9216..415a41bbfb 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,13 +1,13 @@ -# Sky 2040 v2 GP2040-CE Turbo Enhancement Project +# GP2040-CE Turbo Enhancement Project ## Quick Summary -**Goal**: Add hardware-based turbo controls to Sky 2040 v2 joystick +**Goal**: Add hardware-based turbo controls to GP2040-CE using an I2C GPIO expander. - ✅ Analog turbo speed dial (potentiometer, 2-30 shots/sec) - ✅ 8 per-button turbo switches (B1-B4, L1-L2, R1-R2) -- **Strategy**: Use I2C GPIO expander (MCP23017 breakout board) for switches +- **Strategy**: Use I2C GPIO expander (MCP23017 breakout board) for switches. This makes the feature available to any board with an I2C bus. - **GPIO Required**: 1 ADC (speed dial) + I2C bus (shared with display) - **Hardware**: MCP23017 breakout board + potentiometer + 8 switches -- **Target Board**: Sky 2040 Version 2 +- **Target Board**: Any Pico-based board (like Sky 2040 v2) using the `Pico` BoardConfig. ## Project Location - **Fork**: `/Users/fwong/Documents/github/wongfei2009/GP2040-CE` @@ -15,98 +15,67 @@ --- -## Sky 2040 v2 Configuration - -### Base Configuration -- **Board Type**: Raspberry Pi Pico form factor -- **Board Version**: Sky 2040 Version 2 -- **Note**: Actual GPIO mappings will be documented once physical board is available for testing - -### Planned Features -- I2C Display (shared bus with MCP23017) -- RGB LEDs -- Turbo speed dial (ADC input) -- 8 per-button turbo switches via MCP23017 I2C expander - ---- - ## Hardware Implementation ### Why I2C Expander? -**Problem**: Sky 2040 v2 has sufficient GPIOs on the RP2040, but they're already assigned to existing features (buttons, display, RGB LEDs, etc.) -- We need 8 switches + 1 speed dial = 9 **additional** pins -- No unassigned GPIOs available for these new turbo features +**Problem**: Most boards have limited free GPIOs after connecting buttons, displays, and LEDs. +- We need 8 switches + 1 speed dial = 9 **additional** pins. +- An I2C expander avoids the need for a board with many spare GPIOs. **Solution**: MCP23017 I2C GPIO Expander -- Provides 16 additional GPIO pins via I2C -- Shares I2C bus with display (no extra pins needed) -- Configurable I2C address (default 0x20) -- Built-in pull-up resistors -- Widely available and inexpensive (~$1-2) +- Provides 16 additional GPIO pins via I2C. +- Shares the I2C bus with a display (SDA/SCL pins). +- Configurable I2C address (default 0x20). +- Built-in pull-up resistors. +- Widely available and inexpensive (~$1-2). ### Component List #### 1. MCP23017 I2C GPIO Expander Breakout Board **Specs**: -- 16 GPIO pins (we need 8) -- I2C interface (3.3V compatible) -- Configurable address: 0x20-0x27 (via solder jumpers or switches) -- Internal pull-ups available -- Pre-wired power, I2C, and address configuration - -**Recommended Products**: -- Adafruit MCP23017 I2C GPIO Expander Breakout (#732) -- SparkFun Qwiic GPIO MCP23017 -- Generic MCP23017 breakout boards on Amazon/AliExpress - -**I2C Address**: Use **0x20** (default) to avoid conflict with display (0x3C) +- 16 GPIO pins (we need 8 for switches). +- I2C interface (3.3V compatible). +- Configurable address: 0x20-0x27. +- **I2C Address**: Use **0x20** (default) to avoid conflict with common displays (0x3C). #### 2. Turbo Speed Dial -- 10kΩ linear potentiometer (rotary or slide) +- 10kΩ linear potentiometer. #### 3. Turbo Switches -- 8× SPST toggle switches OR 1× DIP-8 switch array +- 8× SPST toggle switches OR 1× DIP-8 switch array. #### 4. Wiring Components -- Breadboard (for prototyping) -- Jumper wires (male-to-female recommended for breakout boards) +- Breadboard and jumper wires. --- ## Software Implementation -### Phase 1: Create Sky2040 v2 BoardConfig -**File**: `configs/Sky2040v2/BoardConfig.h` +### Phase 1: Enable Turbo Hardware in BoardConfig +**File**: `configs/Pico/BoardConfig.h` (or your target board's config) -**Note**: GPIO pin mappings will be determined once physical Sky 2040 v2 board is available for testing. The following are placeholders based on anticipated differences from standard Pico. +Add the following definitions to your `BoardConfig.h` to enable the hardware turbo features. -**Expected Changes from Pico**: ```cpp -// Board identification -#define BOARD_CONFIG_LABEL "Sky2040v2" - -// GPIO mappings - TO BE VERIFIED with physical Sky 2040 v2 board -// (Sky 2040 v2 may have different pin layout than standard Pico) - -// Turbo speed dial (ADC input - pin TBD with physical board) -#define PIN_SHMUP_DIAL 26 // To be verified +// Turbo speed dial (ADC input) +// Set to -1 to disable. Valid pins are 26, 27, 28. +#define PIN_SHMUP_DIAL 26 // I2C Turbo switches configuration #define TURBO_I2C_SWITCHES_ENABLED 1 -#define TURBO_I2C_SDA_PIN 0 // To be verified - shared with display -#define TURBO_I2C_SCL_PIN 1 // To be verified - shared with display -#define TURBO_I2C_BLOCK i2c0 // Same I2C block as display -#define TURBO_I2C_SPEED 400000 // 400kHz (same as display) +#define TURBO_I2C_SDA_PIN 0 +#define TURBO_I2C_SCL_PIN 1 +#define TURBO_I2C_BLOCK i2c0 +#define TURBO_I2C_SPEED 400000 // 400kHz #define TURBO_I2C_ADDR 0x20 // MCP23017 address - -// RGB LEDs (pin TBD with physical board) -#define BOARD_LEDS_PIN 28 // To be verified ``` -**Action Required**: Once Sky 2040 v2 board arrives, verify all GPIO assignments and update accordingly. +**Action Required**: Verify that the `TURBO_I2C_SDA_PIN` and `TURBO_I2C_SCL_PIN` match the I2C pins used by your display or other I2C devices. ### Phase 2: Add MCP23017 Driver -**Files**: `src/addons/turbo.cpp`, `headers/addons/turbo.h`, `lib/mcp23017/mcp23017.h` +**Files**: `src/addons/turbo.cpp`, `headers/addons/turbo.h`, `lib/mcp23017/mcp23017.h`, `lib/mcp23017/mcp23017.cpp` + +This phase involves creating a generic driver for the MCP23017 and integrating it into the turbo addon. #### Create MCP23017 Library **File**: `lib/mcp23017/mcp23017.h` @@ -222,12 +191,11 @@ void TurboInput::setup() { #ifdef TURBO_I2C_SWITCHES_ENABLED // Initialize MCP23017 on shared I2C bus - // Note: I2C already initialized by display addon + // Note: I2C should already be initialized by display addon or another service mcp_ = new MCP23017(TURBO_I2C_BLOCK, TURBO_I2C_ADDR); if (!mcp_->init()) { // Handle initialization error - // Could set flag to disable I2C switches delete mcp_; mcp_ = nullptr; } @@ -258,8 +226,6 @@ void TurboInput::process() { } #endif - // Continue with existing turbo flicker logic - // Speed dial already supported via pinShmupDial (GPIO 26) // ... existing turbo processing code ... } ``` @@ -268,171 +234,55 @@ void TurboInput::process() { ## Implementation Roadmap -### Phase 1: BoardConfig Setup ⏱️ 1 hour +### Phase 1: MCP23017 Library ⏱️ 2-3 hours **Tasks**: -1. Create `configs/Sky2040v2/` directory -2. Copy `configs/Pico/BoardConfig.h` → `configs/Sky2040v2/BoardConfig.h` -3. Apply initial changes for Sky 2040 v2: - - Set `BOARD_CONFIG_LABEL "Sky2040v2"` - - Add I2C turbo switch definitions (placeholder pins) - - Add turbo speed dial definition (placeholder pin) - - Add RGB LED definition (placeholder pin) - - **IMPORTANT**: Mark all GPIO assignments as "TO BE VERIFIED" until physical board arrives -4. Create `configs/Sky2040v2/README.md` noting that pin mappings are pending physical board verification -5. Test build: - ```bash - export GP2040_BOARDCONFIG=Sky2040v2 - cd build && cmake .. && make -j$(sysctl -n hw.ncpu) - ``` - -**Post-Hardware Arrival**: -- Map all buttons and verify GPIO assignments with physical Sky 2040 v2 board -- Update BoardConfig.h with verified pin mappings -- Test each button, display, RGB LEDs, and peripherals -- Document actual pinout in README.md +1. Create `lib/mcp23017/` directory. +2. Implement `mcp23017.h` (header file). +3. Implement `mcp23017.cpp` (driver code). +4. Add library to `CMakeLists.txt`. +5. Test I2C communication and switch reading. **Success Criteria**: -- ✅ Builds without errors (with placeholder pins) -- ✅ Ready to update with real pin mappings when board arrives +- ✅ MCP23017 is detected on the I2C bus. +- ✅ Can read switch states from Port A. +- ✅ No conflicts with other I2C devices (like a display). -### Phase 2: MCP23017 Library ⏱️ 2-3 hours +### Phase 2: Hardware Assembly ⏱️ 2-3 hours **Tasks**: -1. Create `lib/mcp23017/` directory -2. Implement `mcp23017.h` (header file) -3. Implement `mcp23017.cpp` (driver code) -4. Add to CMakeLists.txt -5. Test I2C communication: - - Verify address detection (0x20) - - Test register read/write - - Verify no conflict with display (0x3C) -6. Create test program to read switches +1. Acquire components (MCP23017, switches, potentiometer). +2. Connect MCP23017 to the Pico's I2C bus (VCC, GND, SDA, SCL). +3. Connect 8 switches to MCP23017 GPA0-GPA7 pins. +4. Connect potentiometer to an ADC pin (e.g., GPIO 26). +5. Update `configs/Pico/BoardConfig.h` with correct pin assignments. **Success Criteria**: -- ✅ MCP23017 detected on I2C bus -- ✅ Can read Port A register -- ✅ Display continues working -- ✅ No I2C bus conflicts +- ✅ MCP23017 is detected at address 0x20. +- ✅ Potentiometer provides a variable reading on the ADC pin. +- ✅ All switches toggle correctly. -### Phase 3: Hardware Assembly ⏱️ 2-3 hours +### Phase 3: Turbo Addon Integration ⏱️ 4-6 hours **Tasks**: -1. Acquire components: - - **MCP23017 breakout board** (Adafruit, SparkFun, or generic) - - 8× SPST toggle switches OR DIP-8 switch array - - 10kΩ linear potentiometer - - Breadboard + jumper wires - - Sky 2040 v2 board -2. **First Step with Sky 2040 v2**: Map and document all GPIO pins - - Identify I2C pins (SDA/SCL) for display and MCP23017 - - Identify available ADC pin for potentiometer - - Identify RGB LED data pin (if present) - - Identify all button pins and verify their functions - - Update `configs/Sky2040v2/BoardConfig.h` with verified mappings -3. Connect MCP23017 breakout to Sky 2040 v2: - - VCC/VDD → 3.3V - - GND → GND - - SDA → Verified I2C SDA pin - - SCL → Verified I2C SCL pin - - Set I2C address to 0x20 (usually default) -4. Connect 8 switches to MCP23017 GPA0-GPA7 pins (one side to pin, other to GND) -5. Connect potentiometer wiper to verified ADC pin (other pins to GND and 3.3V) -6. Test connections with multimeter - -**Success Criteria**: -- ✅ Sky 2040 v2 GPIO pinout fully documented -- ✅ MCP23017 detected on I2C bus at 0x20 -- ✅ I2C communication works -- ✅ All switches toggle cleanly -- ✅ Potentiometer reads correctly -- ✅ Display still works on Sky 2040 v2 (no I2C conflict) - -### Phase 4: Turbo Addon Integration ⏱️ 4-6 hours -**Tasks**: -1. Modify `headers/addons/turbo.h`: - - Include MCP23017 header - - Add MCP23017* member to TurboInput class - - Add I2C configuration constants -2. Modify `src/addons/turbo.cpp`: - - Initialize MCP23017 in `setup()` - - Read switches in `process()` - - Map switch states to button masks - - Override turboButtonsMask with hardware state -3. Handle I2C bus sharing: - - Verify display addon initializes I2C first - - Ensure MCP23017 doesn't re-initialize bus - - Add mutex if concurrent access needed (unlikely) -4. Rebuild and flash firmware -5. Test each switch independently -6. Test multiple switches simultaneously -7. Test speed dial adjustment -8. Verify no display interference - -**Success Criteria**: -- ✅ Each switch controls correct button turbo -- ✅ All 8 switches work independently -- ✅ Speed dial adjusts turbo rate smoothly -- ✅ Display continues working perfectly -- ✅ No I2C bus conflicts or glitches -- ✅ RGB LEDs still functional - -### Phase 5: Testing & Validation ⏱️ 2-3 hours -**Hardware Tests**: -1. Individual button turbo (8 tests) -2. Multiple button turbo simultaneously (all 8) -3. Speed dial adjustment while turbo active -4. Long-duration stress test (30+ minutes) -5. Power cycle persistence -6. I2C bus stress test (rapid switch toggling) - -**Cross-Platform Tests**: -1. PC (XInput mode) -2. Nintendo Switch -3. PS4/PS5 (if dongle available) -4. Steam Deck (if available) - -**Edge Cases**: -1. All 8 switches ON simultaneously -2. Rapid switch toggling (stress I2C) -3. Speed dial at min/max extremes -4. Turbo button press during hardware turbo -5. Display updates during switch reads +1. Modify `headers/addons/turbo.h` and `src/addons/turbo.cpp` as shown above. +2. Ensure I2C bus is initialized before the turbo addon tries to use it. +3. Rebuild and flash firmware with `GP2040_BOARDCONFIG=Pico`. +4. Test each switch and the speed dial. **Success Criteria**: -- ✅ All tests pass without errors -- ✅ No I2C bus hangs or timeouts -- ✅ Display remains responsive -- ✅ Consistent behavior across platforms -- ✅ No firmware crashes +- ✅ Each switch correctly enables/disables turbo for the assigned button. +- ✅ Speed dial adjusts turbo rate smoothly. +- ✅ No interference with other I2C devices. -### Phase 6: Optimization & Polish ⏱️ 1-2 hours +### Phase 4: Testing & Validation ⏱️ 2-3 hours **Tasks**: -1. Measure I2C read latency -2. Optimize switch polling frequency -3. Add error recovery for I2C failures -4. Implement switch debouncing if needed -5. Add OLED display indicators for active turbo -6. Test and tune turbo speed range +1. Test individual and multiple turbo switches. +2. Test speed dial adjustment. +3. Stress test I2C bus by toggling switches rapidly. +4. Test across different platforms (PC, Switch, etc.). **Success Criteria**: -- ✅ I2C latency <1ms -- ✅ Total polling overhead <1% CPU -- ✅ Robust error handling -- ✅ Clean switch response - -### Phase 7: Documentation ⏱️ 1-2 hours -**Tasks**: -1. Update `configs/Sky2040v2/README.md`: - - Complete pin mapping table - - I2C expander wiring diagram - - Turbo switch wiring - - Speed dial wiring - - I2C address configuration -2. Document MCP23017 library API -3. Create build guide for users -4. Add troubleshooting section -5. Take photos of completed build -6. Update CLAUDE.md with final status - -**Total Time**: 12-18 hours for complete implementation (reduced due to breakout board simplicity) +- ✅ All tests pass without errors. +- ✅ No I2C bus hangs or firmware crashes. +- ✅ Display (if present) remains responsive. --- @@ -441,7 +291,7 @@ void TurboInput::process() { ### Build Firmware ```bash # Set board configuration -export GP2040_BOARDCONFIG=Sky2040v2 +export GP2040_BOARDCONFIG=Pico # Navigate to project cd /Users/fwong/Documents/github/wongfei2009/GP2040-CE @@ -455,79 +305,37 @@ cmake .. # Build (use all CPU cores) make -j$(sysctl -n hw.ncpu) -# Output file: GP2040-CE_X.X.X_Sky2040v2.uf2 -``` - -### Flash to Device -```bash -# Method 1: Hold BOOTSEL while plugging in USB -# Method 2: Short RUN pin to GND twice quickly - -# Copy firmware (device appears as RPI-RP2) -cp GP2040-CE_*_Sky2040v2.uf2 /Volumes/RPI-RP2/ - -# Wait for automatic reboot +# Output file: GP2040-CE_X.X.X_Pico.uf2 ``` --- -## Success Criteria Checklist - -### Must Have ✅ -- [ ] Sky2040v2 BoardConfig builds successfully -- [ ] All 18 original buttons work correctly -- [ ] MCP23017 communicates via I2C -- [ ] Speed dial adjusts turbo speed (2-30 shots/sec) -- [ ] All 8 turbo switches control their respective buttons -- [ ] Hardware switches override software turbo -- [ ] Display continues working (no I2C conflict) -- [ ] RGB LEDs still functional -- [ ] No input latency added (<1ms overhead) -- [ ] Firmware stable in all input modes - -### Nice to Have 🎯 -- [ ] OLED shows active turbo indicators -- [ ] Web configurator shows switch states -- [ ] I2C error recovery implemented -- [ ] Settings persist across power cycles -- [ ] Upstream PR contribution - ---- - ## Next Immediate Steps ### Ready to Start -1. ✅ **Decision made**: MCP23017 breakout board approach -2. ✅ **Documentation complete**: Full implementation plan for Sky 2040 v2 -3. ✅ **Board identified**: Sky 2040 Version 2 -4. ⏭️ **Next action**: Order MCP23017 breakout board + components +1. ✅ **Decision made**: Use MCP23017 breakout board to add hardware turbo. +2. ✅ **Plan updated**: Integrate as a generic feature for any board config. +3. ⏭️ **Next action**: Implement the MCP23017 driver. -### Phase 1 Action Items (Can Start Now - Before Hardware Arrives) +### Phase 1 Action Items (Software) ```bash -# 1. Create directory for Sky 2040 v2 config -mkdir -p configs/Sky2040v2 +# 1. Create MCP23017 library directory +mkdir -p lib/mcp23017 -# 2. Copy base config -cp configs/Pico/BoardConfig.h configs/Sky2040v2/BoardConfig.h +# 2. Create and implement mcp23017.h and mcp23017.cpp +# (Use the code provided in the "Software Implementation" section) -# 3. Edit the file (apply placeholder Sky 2040 v2 config) -# Mark GPIO pins as "TO BE VERIFIED" with physical board +# 3. Add the new library to the build system (edit CMakeLists.txt) -# 4. Create MCP23017 library -mkdir -p lib/mcp23017 -# (implement mcp23017.h and mcp23017.cpp) +# 4. Modify the Turbo addon (turbo.h, turbo.cpp) to use the new driver -# 5. Test build for Sky 2040 v2 (with placeholder config) -export GP2040_BOARDCONFIG=Sky2040v2 -cd build && cmake .. && make -j$(sysctl -n hw.ncpu) -``` +# 5. Edit configs/Pico/BoardConfig.h to enable the feature +# (Add the #defines for TURBO_I2C_SWITCHES_ENABLED, etc.) -**After Sky 2040 v2 Board Arrives**: -1. Flash placeholder firmware to test basic functionality -2. Map all GPIO pins with multimeter and testing -3. Update BoardConfig.h with verified pin assignments -4. Rebuild and verify all functions work correctly -5. Proceed to Phase 3 (Hardware Assembly) +# 6. Test build +export GP2040_BOARDCONFIG=Pico +# (run cmake and make from the build directory) +``` --- From 17f9b2560df8dd71f80ebedb67b31f1b5299c7cf Mon Sep 17 00:00:00 2001 From: wongfei2009 Date: Mon, 17 Nov 2025 14:17:35 +0800 Subject: [PATCH 3/7] Add turbo diagnostics API and integrate with Turbo component for real-time updates --- pico-sdk-2.1.1 | 1 + src/webconfig.cpp | 26 ++++++++++++++++++ www/src/Addons/Turbo.tsx | 54 +++++++++++++++++++++++++++++++++----- www/src/Services/WebApi.js | 11 ++++++++ 4 files changed, 86 insertions(+), 6 deletions(-) create mode 160000 pico-sdk-2.1.1 diff --git a/pico-sdk-2.1.1 b/pico-sdk-2.1.1 new file mode 160000 index 0000000000..bddd20f928 --- /dev/null +++ b/pico-sdk-2.1.1 @@ -0,0 +1 @@ +Subproject commit bddd20f928ce76142793bef434d4f75f4af6e433 diff --git a/src/webconfig.cpp b/src/webconfig.cpp index d59cb1ac47..6ebce0b8a4 100644 --- a/src/webconfig.cpp +++ b/src/webconfig.cpp @@ -789,6 +789,31 @@ std::string getGamepadOptions() return serialize_json(doc); } +std::string getTurboDiagnostics() +{ + const size_t capacity = JSON_OBJECT_SIZE(10); + DynamicJsonDocument doc(capacity); + + TurboOptions& options = Storage::getInstance().getAddonOptions().turboOptions; + + if (options.shmupDialPin != -1) { + // Read ADC directly - works in config mode without addon process loop + adc_select_input(options.shmupDialPin - 26); + uint16_t rawValue = adc_read(); + + writeDoc(doc, "dialConfigured", true); + writeDoc(doc, "dialPin", options.shmupDialPin); + writeDoc(doc, "dialRawValue", rawValue); + writeDoc(doc, "dialPercentage", (rawValue * 100) / 4095); + } else { + writeDoc(doc, "dialConfigured", false); + writeDoc(doc, "dialRawValue", 0); + writeDoc(doc, "dialPercentage", 0); + } + + return serialize_json(doc); +} + std::string setLedOptions() { DynamicJsonDocument doc = get_post_data(); @@ -2600,6 +2625,7 @@ static const std::pair handlerFuncs[] = { "/api/reboot", reboot }, { "/api/getDisplayOptions", getDisplayOptions }, { "/api/getGamepadOptions", getGamepadOptions }, + { "/api/getTurboDiagnostics", getTurboDiagnostics }, { "/api/getButtonLayoutDefs", getButtonLayoutDefs }, { "/api/getButtonLayouts", getButtonLayouts }, { "/api/getLedOptions", getLedOptions }, diff --git a/www/src/Addons/Turbo.tsx b/www/src/Addons/Turbo.tsx index eb033b92f5..f3662fcb9b 100644 --- a/www/src/Addons/Turbo.tsx +++ b/www/src/Addons/Turbo.tsx @@ -1,5 +1,5 @@ import { useState } from 'react'; -import { useContext } from 'react'; +import { useContext, useEffect } from 'react'; import { useTranslation } from 'react-i18next'; import { FormCheck, Row } from 'react-bootstrap'; import * as yup from 'yup'; @@ -15,6 +15,7 @@ import { DUAL_STICK_MODES } from '../Data/Addons'; import LEDColors from '../Data/LEDColors'; import { ANALOG_PINS } from '../Data/Buttons'; import { AddonPropTypes } from '../Pages/AddonsConfigPage'; +import WebApi from '../Services/WebApi'; const SHMUP_MIXED_MODES = [ { label: 'Turbo Priority', value: 0 }, @@ -148,6 +149,35 @@ const Turbo = ({ const [colorPickerTarget, setColorPickerTarget] = useState(null); const [showPicker, setShowPicker] = useState(false); + const [turboState, setTurboState] = useState({ + dialRawValue: 0, + dialPercentage: 0, + }); + + // Poll for turbo state when dial pin is configured + useEffect(() => { + if (!values.TurboInputEnabled || values.pinShmupDial === -1) { + return; + } + + const pollTurboState = async () => { + const diagnostics = await WebApi.getTurboDiagnostics(); + if (diagnostics && diagnostics.dialConfigured) { + setTurboState({ + dialRawValue: diagnostics.dialRawValue || 0, + dialPercentage: diagnostics.dialPercentage || 0, + }); + } + }; + + // Initial poll + pollTurboState(); + + // Poll every 500ms + const interval = setInterval(pollTurboState, 500); + + return () => clearInterval(interval); + }, [values.TurboInputEnabled, values.pinShmupDial]); const toggleRgbPledPicker = (e) => { e.stopPropagation(); @@ -285,6 +315,18 @@ const Turbo = ({ + {values.pinShmupDial !== -1 && ( + +
+
+ Live Turbo Dial Position: +
+ {turboState.dialPercentage}% ({turboState.dialRawValue} / 4095) +
+
+
+ + )} - Date: Mon, 17 Nov 2025 15:42:41 +0800 Subject: [PATCH 4/7] Implement MCP23017 I2C GPIO expander support for turbo controls and diagnostics --- CLAUDE.md | 76 +++++++++++++++++------- CMakeLists.txt | 1 + configs/Pico/BoardConfig.h | 13 +++++ headers/addons/turbo.h | 7 +++ lib/CMakeLists.txt | 1 + lib/mcp23017/CMakeLists.txt | 4 ++ lib/mcp23017/mcp23017.cpp | 65 +++++++++++++++++++++ lib/mcp23017/mcp23017.h | 48 +++++++++++++++ src/addons/turbo.cpp | 37 ++++++++++++ src/webconfig.cpp | 66 ++++++++++++++++++++- www/src/Addons/Turbo.tsx | 113 ++++++++++++++++++++++++++++++++++-- 11 files changed, 406 insertions(+), 25 deletions(-) create mode 100644 lib/mcp23017/CMakeLists.txt create mode 100644 lib/mcp23017/mcp23017.cpp create mode 100644 lib/mcp23017/mcp23017.h diff --git a/CLAUDE.md b/CLAUDE.md index 415a41bbfb..5d93393e01 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -234,13 +234,13 @@ void TurboInput::process() { ## Implementation Roadmap -### Phase 1: MCP23017 Library ⏱️ 2-3 hours +### Phase 1: MCP23017 Library ✅ COMPLETE **Tasks**: -1. Create `lib/mcp23017/` directory. -2. Implement `mcp23017.h` (header file). -3. Implement `mcp23017.cpp` (driver code). -4. Add library to `CMakeLists.txt`. -5. Test I2C communication and switch reading. +1. ✅ Create `lib/mcp23017/` directory. +2. ✅ Implement `mcp23017.h` (header file). +3. ✅ Implement `mcp23017.cpp` (driver code). +4. ✅ Add library to `CMakeLists.txt`. +5. ✅ Test I2C communication and switch reading. **Success Criteria**: - ✅ MCP23017 is detected on the I2C bus. @@ -256,21 +256,23 @@ void TurboInput::process() { 5. Update `configs/Pico/BoardConfig.h` with correct pin assignments. **Success Criteria**: -- ✅ MCP23017 is detected at address 0x20. -- ✅ Potentiometer provides a variable reading on the ADC pin. -- ✅ All switches toggle correctly. +- ⏳ MCP23017 is detected at address 0x20. +- ⏳ Potentiometer provides a variable reading on the ADC pin. +- ⏳ All switches toggle correctly. -### Phase 3: Turbo Addon Integration ⏱️ 4-6 hours +### Phase 3: Turbo Addon Integration ✅ COMPLETE **Tasks**: -1. Modify `headers/addons/turbo.h` and `src/addons/turbo.cpp` as shown above. -2. Ensure I2C bus is initialized before the turbo addon tries to use it. -3. Rebuild and flash firmware with `GP2040_BOARDCONFIG=Pico`. -4. Test each switch and the speed dial. +1. ✅ Modify `headers/addons/turbo.h` and `src/addons/turbo.cpp` for I2C switches. +2. ✅ Ensure I2C bus is initialized before the turbo addon tries to use it. +3. ✅ Rebuild and flash firmware with `GP2040_BOARDCONFIG=Pico`. +4. ✅ Add real-time web configurator display for I2C switches. +5. ⏳ Test each switch and the speed dial. **Success Criteria**: -- ✅ Each switch correctly enables/disables turbo for the assigned button. -- ✅ Speed dial adjusts turbo rate smoothly. -- ✅ No interference with other I2C devices. +- ⏳ Each switch correctly enables/disables turbo for the assigned button. +- ⏳ Speed dial adjusts turbo rate smoothly. +- ⏳ No interference with other I2C devices. +- ✅ Web configurator displays real-time switch states. ### Phase 4: Testing & Validation ⏱️ 2-3 hours **Tasks**: @@ -280,9 +282,43 @@ void TurboInput::process() { 4. Test across different platforms (PC, Switch, etc.). **Success Criteria**: -- ✅ All tests pass without errors. -- ✅ No I2C bus hangs or firmware crashes. -- ✅ Display (if present) remains responsive. +- ⏳ All tests pass without errors. +- ⏳ No I2C bus hangs or firmware crashes. +- ⏳ Display (if present) remains responsive. + +--- + +## Web Configurator Features ✅ IMPLEMENTED + +### Real-Time Turbo Diagnostics +The web configurator now displays real-time status for: + +1. **Turbo Speed Dial** (existing feature): + - Live percentage reading (0-100%) + - Raw ADC value (0-4095) + - Updates every 500ms + +2. **I2C Turbo Switches** (NEW): + - Live ON/OFF status for all 8 switches: + - B1, B2, B3, B4 (Face buttons) + - L1, R1, L2, R2 (Shoulder buttons) + - Visual badges: Green for ON, Gray for OFF + - Updates every 500ms + - Only shown when `TURBO_I2C_SWITCHES_ENABLED` is defined + +### Implementation Details + +**Backend Changes** (`src/webconfig.cpp`): +- Enhanced `getTurboDiagnostics()` API endpoint +- Reads MCP23017 switch states directly via I2C +- Returns JSON with individual switch states +- Conditionally compiled with `#ifdef TURBO_I2C_SWITCHES_ENABLED` + +**Frontend Changes** (`www/src/Addons/Turbo.tsx`): +- Extended state to track all 8 switch positions +- Auto-polling mechanism (500ms interval) +- Bootstrap badge UI for visual feedback +- Responsive grid layout (4 switches per row) --- diff --git a/CMakeLists.txt b/CMakeLists.txt index 6c0770c0e1..88bc4891f5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -320,6 +320,7 @@ CRC32 FlashPROM ADS1219 ADS1256 +mcp23017 NeoPico OneBitDisplay ArduinoJson diff --git a/configs/Pico/BoardConfig.h b/configs/Pico/BoardConfig.h index ca2029f64d..446f894480 100644 --- a/configs/Pico/BoardConfig.h +++ b/configs/Pico/BoardConfig.h @@ -65,6 +65,19 @@ #define GPIO_PIN_14 GpioAction::BUTTON_PRESS_TURBO #define TURBO_LED_PIN 15 +// Turbo I2C Switches Configuration +// Uncomment to enable hardware turbo switches via MCP23017 I2C GPIO expander +#define TURBO_I2C_SWITCHES_ENABLED 1 +#define TURBO_I2C_SDA_PIN 0 +#define TURBO_I2C_SCL_PIN 1 +#define TURBO_I2C_BLOCK i2c0 +#define TURBO_I2C_SPEED 400000 +#define TURBO_I2C_ADDR 0x27 + +// Turbo Speed Dial (Potentiometer) +// Uncomment and set to a valid ADC pin (26, 27, or 28) to enable +// #define PIN_SHMUP_DIAL 26 + #define BOARD_LEDS_PIN 28 #define LED_BRIGHTNESS_MAXIMUM 100 #define LED_BRIGHTNESS_STEPS 5 diff --git a/headers/addons/turbo.h b/headers/addons/turbo.h index ec3fc6270a..2fe980cf6c 100644 --- a/headers/addons/turbo.h +++ b/headers/addons/turbo.h @@ -6,6 +6,10 @@ #include "eventmanager.h" #include "enums.pb.h" +#ifdef TURBO_I2C_SWITCHES_ENABLED +#include "mcp23017.h" +#endif + #ifndef TURBO_ENABLED #define TURBO_ENABLED 0 #endif @@ -138,5 +142,8 @@ class TurboInput : public GPAddon { uint8_t encoderValue; // Rotary encoder value bool hasTurboAssigned; // Turbo enabled on a pin. uint8_t lastShotCount; // Last shot count for comparison +#ifdef TURBO_I2C_SWITCHES_ENABLED + MCP23017* mcp_; // I2C expander instance +#endif }; #endif // TURBO_H_ diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt index c4c56607e6..6b2d2be771 100644 --- a/lib/CMakeLists.txt +++ b/lib/CMakeLists.txt @@ -4,6 +4,7 @@ add_subdirectory(CRC32) add_subdirectory(FlashPROM) add_subdirectory(httpd) add_subdirectory(lwip-port) +add_subdirectory(mcp23017) add_subdirectory(nanopb) add_subdirectory(NeoPico) add_subdirectory(OneBitDisplay) diff --git a/lib/mcp23017/CMakeLists.txt b/lib/mcp23017/CMakeLists.txt new file mode 100644 index 0000000000..d093852184 --- /dev/null +++ b/lib/mcp23017/CMakeLists.txt @@ -0,0 +1,4 @@ +add_library(mcp23017 INTERFACE) +target_sources(mcp23017 INTERFACE ${CMAKE_CURRENT_LIST_DIR}/mcp23017.cpp) +target_include_directories(mcp23017 INTERFACE ${CMAKE_CURRENT_LIST_DIR}) +target_link_libraries(mcp23017 INTERFACE hardware_i2c) diff --git a/lib/mcp23017/mcp23017.cpp b/lib/mcp23017/mcp23017.cpp new file mode 100644 index 0000000000..678eb17a47 --- /dev/null +++ b/lib/mcp23017/mcp23017.cpp @@ -0,0 +1,65 @@ +#include "mcp23017.h" +#include "pico/time.h" + +MCP23017::MCP23017(i2c_inst_t* i2c, uint8_t addr) + : i2c_(i2c), addr_(addr) {} + +bool MCP23017::init() { + // Configure IOCON register first to ensure we're in the right mode + // IOCON.BANK = 0 (sequential register addresses) + // IOCON.SEQOP = 0 (sequential operation enabled) + writeRegister(MCP23017_IOCON, 0x00); + sleep_ms(10); // Small delay for chip to process + + // Configure all pins on Port A as inputs with pull-ups + writeRegister(MCP23017_IODIRA, 0xFF); // All inputs + sleep_ms(1); + + // Enable pull-ups on Port A + writeRegister(MCP23017_GPPUA, 0xFF); // All pull-ups enabled + sleep_ms(1); + + // Verify the configuration by reading back + uint8_t verifyDir = readRegister(MCP23017_IODIRA); + uint8_t verifyPullup = readRegister(MCP23017_GPPUA); + + if (verifyDir != 0xFF || verifyPullup != 0xFF) { + return false; // MCP23017 not configured correctly + } + + // Port B unused (all inputs, no pull-ups) + writeRegister(MCP23017_IODIRB, 0xFF); + writeRegister(MCP23017_GPPUB, 0x00); + + return true; +} + +void MCP23017::writeRegister(uint8_t reg, uint8_t value) { + uint8_t buf[2] = {reg, value}; + i2c_write_blocking(i2c_, addr_, buf, 2, false); +} + +uint8_t MCP23017::readRegister(uint8_t reg) { + uint8_t value = 0xFF; // Default to all high (unpulled state) + int result = i2c_write_blocking(i2c_, addr_, ®, 1, true); + if (result == 1) { + i2c_read_blocking(i2c_, addr_, &value, 1, false); + } + return value; +} + +uint16_t MCP23017::readAll() { + uint8_t portA = readRegister(MCP23017_GPIOA); + uint8_t portB = readRegister(MCP23017_GPIOB); + return (portB << 8) | portA; +} + +bool MCP23017::readPin(uint8_t pin) { + if (pin < 8) { + uint8_t portA = readRegister(MCP23017_GPIOA); + return (portA & (1 << pin)) != 0; + } else { + uint8_t portB = readRegister(MCP23017_GPIOB); + return (portB & (1 << (pin - 8))) != 0; + } +} diff --git a/lib/mcp23017/mcp23017.h b/lib/mcp23017/mcp23017.h new file mode 100644 index 0000000000..d7207f4ef1 --- /dev/null +++ b/lib/mcp23017/mcp23017.h @@ -0,0 +1,48 @@ +#ifndef MCP23017_H +#define MCP23017_H + +#include "hardware/i2c.h" +#include + +// MCP23017 Register Addresses (IOCON.BANK = 0, sequential mode) +#define MCP23017_IODIRA 0x00 // I/O direction A +#define MCP23017_IODIRB 0x01 // I/O direction B +#define MCP23017_IPOLA 0x02 // Input polarity A +#define MCP23017_IPOLB 0x03 // Input polarity B +#define MCP23017_GPINTENA 0x04 // Interrupt-on-change A +#define MCP23017_GPINTENB 0x05 // Interrupt-on-change B +#define MCP23017_DEFVALA 0x06 // Default value A +#define MCP23017_DEFVALB 0x07 // Default value B +#define MCP23017_INTCONA 0x08 // Interrupt control A +#define MCP23017_INTCONB 0x09 // Interrupt control B +#define MCP23017_IOCON 0x0A // I/O expander configuration +#define MCP23017_GPPUA 0x0C // Pull-up A +#define MCP23017_GPPUB 0x0D // Pull-up B +#define MCP23017_INTFA 0x0E // Interrupt flag A +#define MCP23017_INTFB 0x0F // Interrupt flag B +#define MCP23017_INTCAPA 0x10 // Interrupt captured value A +#define MCP23017_INTCAPB 0x11 // Interrupt captured value B +#define MCP23017_GPIOA 0x12 // Port A +#define MCP23017_GPIOB 0x13 // Port B +#define MCP23017_OLATA 0x14 // Output latch A +#define MCP23017_OLATB 0x15 // Output latch B + +class MCP23017 { +public: + MCP23017(i2c_inst_t* i2c, uint8_t addr); + + bool init(); // Initialize chip + void setPinMode(uint8_t pin, bool input); + void setPullup(uint8_t pin, bool enable); + bool readPin(uint8_t pin); + uint16_t readAll(); // Read all 16 pins + uint8_t readRegister(uint8_t reg); + +private: + i2c_inst_t* i2c_; + uint8_t addr_; + + void writeRegister(uint8_t reg, uint8_t value); +}; + +#endif // MCP23017_H diff --git a/src/addons/turbo.cpp b/src/addons/turbo.cpp index 2ae0ae6ef6..512944765c 100644 --- a/src/addons/turbo.cpp +++ b/src/addons/turbo.cpp @@ -106,6 +106,18 @@ void TurboInput::setup(){ nextTimer = getMicro(); encoderValue = shotCount; updateTurboShotCount(shotCount, false); + +#ifdef TURBO_I2C_SWITCHES_ENABLED + // Initialize MCP23017 on shared I2C bus + // Note: I2C should already be initialized by display addon or another service + mcp_ = new MCP23017(TURBO_I2C_BLOCK, TURBO_I2C_ADDR); + + if (!mcp_->init()) { + // Handle initialization error + delete mcp_; + mcp_ = nullptr; + } +#endif } /** @@ -132,6 +144,31 @@ void TurboInput::process() if (!options.enabled && (!hasTurboAssigned == true)) return; +#ifdef TURBO_I2C_SWITCHES_ENABLED + // Read hardware turbo switches from MCP23017 + if (mcp_) { + // Read all 8 switches from MCP23017 Port A (active-low) + uint8_t switchStates = mcp_->readRegister(MCP23017_GPIOA); + + // Build turbo mask from switch states + uint16_t hardwareTurboMask = 0; + + // Map MCP23017 pins to button masks (active-low) + if (!(switchStates & 0x01)) hardwareTurboMask |= GAMEPAD_MASK_B1; // GPA0 + if (!(switchStates & 0x02)) hardwareTurboMask |= GAMEPAD_MASK_B2; // GPA1 + if (!(switchStates & 0x04)) hardwareTurboMask |= GAMEPAD_MASK_B3; // GPA2 + if (!(switchStates & 0x08)) hardwareTurboMask |= GAMEPAD_MASK_B4; // GPA3 + if (!(switchStates & 0x10)) hardwareTurboMask |= GAMEPAD_MASK_L1; // GPA4 + if (!(switchStates & 0x20)) hardwareTurboMask |= GAMEPAD_MASK_R1; // GPA5 + if (!(switchStates & 0x40)) hardwareTurboMask |= GAMEPAD_MASK_L2; // GPA6 + if (!(switchStates & 0x80)) hardwareTurboMask |= GAMEPAD_MASK_R2; // GPA7 + + // Hardware switches override software turbo settings + turboButtonsMask = hardwareTurboMask; + gamepad->turboState.buttons = turboButtonsMask; + } +#endif + // Check if shotCount changed externally (e.g., via hotkey) if (options.shotCount != lastShotCount){ updateTurboShotCount(options.shotCount, false); diff --git a/src/webconfig.cpp b/src/webconfig.cpp index 6ebce0b8a4..c11ad2272c 100644 --- a/src/webconfig.cpp +++ b/src/webconfig.cpp @@ -23,6 +23,13 @@ // for hall-effect calibration #include "hardware/adc.h" +// for I2C turbo switches +#ifdef TURBO_I2C_SWITCHES_ENABLED +#include "hardware/i2c.h" +#include "hardware/gpio.h" +#include "mcp23017.h" +#endif + // HTTPD Includes #include #include "rndis.h" @@ -791,7 +798,7 @@ std::string getGamepadOptions() std::string getTurboDiagnostics() { - const size_t capacity = JSON_OBJECT_SIZE(10); + const size_t capacity = JSON_OBJECT_SIZE(20); DynamicJsonDocument doc(capacity); TurboOptions& options = Storage::getInstance().getAddonOptions().turboOptions; @@ -811,6 +818,63 @@ std::string getTurboDiagnostics() writeDoc(doc, "dialPercentage", 0); } +#ifdef TURBO_I2C_SWITCHES_ENABLED + // Ensure I2C is initialized (it should be from display, but check anyway) + // Note: i2c_init is safe to call multiple times + i2c_init(TURBO_I2C_BLOCK, TURBO_I2C_SPEED); + gpio_set_function(TURBO_I2C_SDA_PIN, GPIO_FUNC_I2C); + gpio_set_function(TURBO_I2C_SCL_PIN, GPIO_FUNC_I2C); + gpio_pull_up(TURBO_I2C_SDA_PIN); + gpio_pull_up(TURBO_I2C_SCL_PIN); + + // Scan I2C bus for MCP23017 (addresses 0x20-0x27) + int foundAddress = -1; + for (uint8_t addr = 0x20; addr <= 0x27; addr++) { + uint8_t dummy; + int result = i2c_read_blocking(TURBO_I2C_BLOCK, addr, &dummy, 1, false); + if (result >= 0) { + foundAddress = addr; + break; + } + } + + // Read I2C switch states from MCP23017 + uint8_t actualAddr = (foundAddress >= 0) ? foundAddress : TURBO_I2C_ADDR; + MCP23017 mcp(TURBO_I2C_BLOCK, actualAddr); + + // Initialize MCP23017 for reading + if (mcp.init()) { + // DEBUG: Read all configuration registers + uint8_t iocon = mcp.readRegister(MCP23017_IOCON); + uint8_t iodira = mcp.readRegister(MCP23017_IODIRA); + uint8_t gppua = mcp.readRegister(MCP23017_GPPUA); + uint8_t gpioa = mcp.readRegister(MCP23017_GPIOA); + + writeDoc(doc, "i2cSwitchesConfigured", true); + writeDoc(doc, "i2cFoundAddress", foundAddress); // -1 if not found, or actual address + writeDoc(doc, "i2cConfiguredAddress", (int)TURBO_I2C_ADDR); // What we expected + writeDoc(doc, "debugIOCON", iocon); // Should be 0x00 + writeDoc(doc, "debugIODIRA", iodira); // Should be 0xFF (all inputs) + writeDoc(doc, "debugGPPUA", gppua); // Should be 0xFF (all pull-ups) + writeDoc(doc, "rawSwitchValue", gpioa); // Current GPIO state + + // Active-low switches: Pin HIGH (1) = switch OPEN = OFF + // Pin LOW (0) = switch CLOSED = ON + writeDoc(doc, "switchB1", !(gpioa & 0x01)); // GPA0 + writeDoc(doc, "switchB2", !(gpioa & 0x02)); // GPA1 + writeDoc(doc, "switchB3", !(gpioa & 0x04)); // GPA2 + writeDoc(doc, "switchB4", !(gpioa & 0x08)); // GPA3 + writeDoc(doc, "switchL1", !(gpioa & 0x10)); // GPA4 + writeDoc(doc, "switchR1", !(gpioa & 0x20)); // GPA5 + writeDoc(doc, "switchL2", !(gpioa & 0x40)); // GPA6 + writeDoc(doc, "switchR2", !(gpioa & 0x80)); // GPA7 + } else { + writeDoc(doc, "i2cSwitchesConfigured", false); + } +#else + writeDoc(doc, "i2cSwitchesConfigured", false); +#endif + return serialize_json(doc); } diff --git a/www/src/Addons/Turbo.tsx b/www/src/Addons/Turbo.tsx index f3662fcb9b..a6d2642605 100644 --- a/www/src/Addons/Turbo.tsx +++ b/www/src/Addons/Turbo.tsx @@ -152,20 +152,50 @@ const Turbo = ({ const [turboState, setTurboState] = useState({ dialRawValue: 0, dialPercentage: 0, + i2cSwitchesConfigured: false, + i2cFoundAddress: -1, + i2cConfiguredAddress: 0, + rawSwitchValue: 0, + debugIOCON: 0, + debugIODIRA: 0, + debugGPPUA: 0, + switchB1: false, + switchB2: false, + switchB3: false, + switchB4: false, + switchL1: false, + switchR1: false, + switchL2: false, + switchR2: false, }); - // Poll for turbo state when dial pin is configured + // Poll for turbo state when dial pin is configured or I2C switches enabled useEffect(() => { - if (!values.TurboInputEnabled || values.pinShmupDial === -1) { + if (!values.TurboInputEnabled) { return; } const pollTurboState = async () => { const diagnostics = await WebApi.getTurboDiagnostics(); - if (diagnostics && diagnostics.dialConfigured) { + if (diagnostics) { setTurboState({ dialRawValue: diagnostics.dialRawValue || 0, dialPercentage: diagnostics.dialPercentage || 0, + i2cSwitchesConfigured: diagnostics.i2cSwitchesConfigured || false, + i2cFoundAddress: diagnostics.i2cFoundAddress !== undefined ? diagnostics.i2cFoundAddress : -1, + i2cConfiguredAddress: diagnostics.i2cConfiguredAddress || 0, + rawSwitchValue: diagnostics.rawSwitchValue || 0, + debugIOCON: diagnostics.debugIOCON || 0, + debugIODIRA: diagnostics.debugIODIRA || 0, + debugGPPUA: diagnostics.debugGPPUA || 0, + switchB1: diagnostics.switchB1 || false, + switchB2: diagnostics.switchB2 || false, + switchB3: diagnostics.switchB3 || false, + switchB4: diagnostics.switchB4 || false, + switchL1: diagnostics.switchL1 || false, + switchR1: diagnostics.switchR1 || false, + switchL2: diagnostics.switchL2 || false, + switchR2: diagnostics.switchR2 || false, }); } }; @@ -177,7 +207,7 @@ const Turbo = ({ const interval = setInterval(pollTurboState, 500); return () => clearInterval(interval); - }, [values.TurboInputEnabled, values.pinShmupDial]); + }, [values.TurboInputEnabled]); const toggleRgbPledPicker = (e) => { e.stopPropagation(); @@ -327,6 +357,81 @@ const Turbo = ({ )} + {turboState.i2cSwitchesConfigured && ( + +
+
+ Live I2C Turbo Switch Status: +
+
+ I2C Address Scan: + {turboState.i2cFoundAddress >= 0 ? ( + Found MCP23017 at 0x{turboState.i2cFoundAddress.toString(16).toUpperCase().padStart(2, '0')} + ) : ( + Not found (scanning 0x20-0x27) + )} + {' - '}Configured: 0x{turboState.i2cConfiguredAddress.toString(16).toUpperCase().padStart(2, '0')} +
+
+ Raw GPIOA Value: 0x{(turboState.rawSwitchValue || 0).toString(16).toUpperCase().padStart(2, '0')} ({turboState.rawSwitchValue || 0}) +
+
+ + MCP23017 Registers: + IOCON=0x{(turboState.debugIOCON || 0).toString(16).toUpperCase().padStart(2, '0')} (expect 0x00), + IODIRA=0x{(turboState.debugIODIRA || 0).toString(16).toUpperCase().padStart(2, '0')} (expect 0xFF), + GPPUA=0x{(turboState.debugGPPUA || 0).toString(16).toUpperCase().padStart(2, '0')} (expect 0xFF) + +
+
+
+ + B1: {turboState.switchB1 ? "ON" : "OFF"} + +
+
+ + B2: {turboState.switchB2 ? "ON" : "OFF"} + +
+
+ + B3: {turboState.switchB3 ? "ON" : "OFF"} + +
+
+ + B4: {turboState.switchB4 ? "ON" : "OFF"} + +
+
+
+
+ + L1: {turboState.switchL1 ? "ON" : "OFF"} + +
+
+ + R1: {turboState.switchR1 ? "ON" : "OFF"} + +
+
+ + L2: {turboState.switchL2 ? "ON" : "OFF"} + +
+
+ + R2: {turboState.switchR2 ? "ON" : "OFF"} + +
+
+
+
+
+ + )} Date: Mon, 17 Nov 2025 17:53:12 +0800 Subject: [PATCH 5/7] Add I2C device scanning functionality to WebApi and DisplayConfig --- CLAUDE.md | 2 +- src/webconfig.cpp | 27 +++++++++++++ www/src/Pages/DisplayConfig.jsx | 70 +++++++++++++++++++++++++++++++++ www/src/Services/WebApi.js | 11 ++++++ 4 files changed, 109 insertions(+), 1 deletion(-) diff --git a/CLAUDE.md b/CLAUDE.md index 5d93393e01..f1decbf35e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -418,7 +418,7 @@ The build process involves manually downloading the correct Pico SDK version bef mkdir build && \ cd build && \ export SDKROOT=$(xcrun --sdk macosx --show-sdk-path) && \ - PICO_SDK_PATH=$(pwd)/../pico-sdk-2.1.1 GP2040_BOARDCONFIG=Pico cmake -DPICO_SDK_FETCH_FROM_GIT=OFF .. && \ + PICO_SDK_PATH=$(pwd)/../pico-sdk-2.1.1 GP2040_BOARDCONFIG=Pico cmake -DPICO_SDK_FETCH_FROM_GIT=OFF -DSKIP_SUBMODULES=TRUE .. && \ make -j$(sysctl -n hw.ncpu) ``` diff --git a/src/webconfig.cpp b/src/webconfig.cpp index c11ad2272c..2f0e343ad8 100644 --- a/src/webconfig.cpp +++ b/src/webconfig.cpp @@ -2658,6 +2658,32 @@ std::string reboot() { return serialize_json(doc); } +std::string scanI2CDevices() +{ + const size_t capacity = JSON_OBJECT_SIZE(50); + DynamicJsonDocument doc(capacity); + + // Scan both I2C blocks if enabled + for (uint8_t block = 0; block < NUM_I2CS; block++) { + if (PeripheralManager::getInstance().isI2CEnabled(block)) { + PeripheralI2C* i2c = PeripheralManager::getInstance().getI2C(block); + std::map scanResults = i2c->scan(); + + char blockKey[10]; + sprintf(blockKey, "i2c%d", block); + + auto devices = doc.createNestedArray(blockKey); + for (const auto& result : scanResults) { + char addrStr[6]; + sprintf(addrStr, "0x%02X", result.first); + devices.add(addrStr); + } + } + } + + return serialize_json(doc); +} + typedef std::string (*HandlerFuncPtr)(); static const std::pair handlerFuncs[] = { @@ -2707,6 +2733,7 @@ static const std::pair handlerFuncs[] = { "/api/abortGetHeldPins", abortGetHeldPins }, { "/api/getUsedPins", getUsedPins }, { "/api/getConfig", getConfig }, + { "/api/scanI2CDevices", scanI2CDevices }, #if !defined(NDEBUG) { "/api/echo", echo }, #endif diff --git a/www/src/Pages/DisplayConfig.jsx b/www/src/Pages/DisplayConfig.jsx index de0e172106..dbb6633553 100644 --- a/www/src/Pages/DisplayConfig.jsx +++ b/www/src/Pages/DisplayConfig.jsx @@ -194,9 +194,18 @@ export default function DisplayConfigPage() { const { updateUsedPins, getAvailablePeripherals, updatePeripherals } = useContext(AppContext); const [saveMessage, setSaveMessage] = useState(''); + const [scanResults, setScanResults] = useState(null); + const [isScanning, setIsScanning] = useState(false); const { t } = useTranslation(''); + const handleScanI2C = async () => { + setIsScanning(true); + const results = await WebApi.scanI2CDevices(); + setScanResults(results); + setIsScanning(false); + }; + useEffect(() => { async function fetchData() { const data = await WebApi.getDisplayOptions(); @@ -295,6 +304,67 @@ export default function DisplayConfigPage() { ))} + + +
+
I2C Device Scanner
+

+ Scan the I2C bus to detect connected devices and their addresses. + This helps identify if your display is properly connected. +

+ + {scanResults && ( +
+ Scan Results: + {(scanResults.i2c0 && scanResults.i2c0.length > 0) || + (scanResults.i2c1 && scanResults.i2c1.length > 0) ? ( +
+ {scanResults.i2c0 && scanResults.i2c0.length > 0 && ( +
+ I2C0 + + {scanResults.i2c0.join(', ')} + + {scanResults.i2c0.includes('0x3C') && ( + (Common OLED address) + )} + {scanResults.i2c0.includes('0x3D') && ( + (Common OLED address) + )} +
+ )} + {scanResults.i2c1 && scanResults.i2c1.length > 0 && ( +
+ I2C1 + + {scanResults.i2c1.join(', ')} + + {scanResults.i2c1.includes('0x3C') && ( + (Common OLED address) + )} + {scanResults.i2c1.includes('0x3D') && ( + (Common OLED address) + )} +
+ )} +
+ ) : ( +
+ No I2C devices found. Please check your connections. +
+ )} +
+ )} +
+ + Date: Sat, 27 Dec 2025 12:01:10 +0800 Subject: [PATCH 6/7] Add comprehensive documentation for hardware turbo controls MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Enhanced documentation across multiple files to prepare for upstream PR: - configs/Pico/README.md: Added Hardware Turbo Controls section with pin assignments, required hardware list, switch mapping, and configuration - configs/Pico/BoardConfig.h: Added detailed inline comments explaining MCP23017 requirements, I2C bus sharing, active-low wiring, and all configuration parameters - lib/mcp23017/mcp23017.h: Added doxygen-style documentation for the MCP23017 driver library with hardware specs and API descriptions - src/addons/turbo.cpp: Enhanced code comments for I2C initialization and switch reading logic with detailed explanations - www/server/docs/GP2040-CE.postman_collection.json: Added API documentation for /api/getTurboDiagnostics endpoint All documentation follows GP2040-CE conventions. Build verified successful. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- configs/Pico/BoardConfig.h | 39 ++++++++--- configs/Pico/README.md | 39 ++++++++++- lib/mcp23017/mcp23017.h | 67 ++++++++++++++++++- src/addons/turbo.cpp | 47 +++++++------ .../docs/GP2040-CE.postman_collection.json | 38 +++++++++++ 5 files changed, 199 insertions(+), 31 deletions(-) diff --git a/configs/Pico/BoardConfig.h b/configs/Pico/BoardConfig.h index 446f894480..dffbb1b554 100644 --- a/configs/Pico/BoardConfig.h +++ b/configs/Pico/BoardConfig.h @@ -65,17 +65,40 @@ #define GPIO_PIN_14 GpioAction::BUTTON_PRESS_TURBO #define TURBO_LED_PIN 15 -// Turbo I2C Switches Configuration -// Uncomment to enable hardware turbo switches via MCP23017 I2C GPIO expander +// --------------------- HARDWARE TURBO CONFIGURATION --------------------- +// Hardware turbo controls via I2C GPIO expander (MCP23017) +// Provides 8 physical toggle switches for per-button turbo control +// and optional analog speed dial for adjustable turbo rate. +// +// Requirements: +// - MCP23017 I2C GPIO expander breakout board +// - 8× SPST toggle switches (or DIP-8 switch array) +// - 10kΩ linear potentiometer (optional, for speed dial) +// +// Hardware connections: +// - I2C bus is shared with display (if present) +// - MCP23017 Port A pins (GPA0-GPA7) connect to switches +// - Switches should be wired active-low (pull to GND when closed) +// - MCP23017 has built-in pull-up resistors +// +// Switch mapping (GPA0-GPA7): +// GPA0 → B1, GPA1 → B2, GPA2 → B3, GPA3 → B4 +// GPA4 → L1, GPA5 → R1, GPA6 → L2, GPA7 → R2 + +// I2C GPIO expander for per-button turbo switches +// Enables 8 physical switches (B1-B4, L1-L2, R1-R2) +// Uncomment to enable hardware turbo switches #define TURBO_I2C_SWITCHES_ENABLED 1 -#define TURBO_I2C_SDA_PIN 0 -#define TURBO_I2C_SCL_PIN 1 -#define TURBO_I2C_BLOCK i2c0 -#define TURBO_I2C_SPEED 400000 -#define TURBO_I2C_ADDR 0x27 +#define TURBO_I2C_SDA_PIN 0 // Must match display I2C pins (if display enabled) +#define TURBO_I2C_SCL_PIN 1 // Must match display I2C pins (if display enabled) +#define TURBO_I2C_BLOCK i2c0 // I2C block instance (i2c0 or i2c1) +#define TURBO_I2C_SPEED 400000 // 400kHz (safe speed for most I2C devices) +#define TURBO_I2C_ADDR 0x27 // MCP23017 I2C address (default: 0x20, avoid display at 0x3C) // Turbo Speed Dial (Potentiometer) -// Uncomment and set to a valid ADC pin (26, 27, or 28) to enable +// Analog input for adjustable turbo speed (2-30 shots/second) +// Set to a valid ADC pin (26, 27, or 28) to enable +// Set to -1 to disable // #define PIN_SHMUP_DIAL 26 #define BOARD_LEDS_PIN 28 diff --git a/configs/Pico/README.md b/configs/Pico/README.md index 55f6a75275..185c123499 100644 --- a/configs/Pico/README.md +++ b/configs/Pico/README.md @@ -25,4 +25,41 @@ Basic pin setup for a stock Raspberry Pi Pico. Combine with a simple GPIO breako | GPIO_PIN_18| GpioAction::BUTTON_PRESS_L3 | L3 | LS | LS | L3 | 11 | LS | | GPIO_PIN_19| GpioAction::BUTTON_PRESS_R3 | R3 | RS | RS | R3 | 12 | RS | | GPIO_PIN_20| GpioAction::BUTTON_PRESS_A1 | A1 | Guide | Home | PS | 13 | ~ | -| GPIO_PIN_21| GpioAction::BUTTON_PRESS_A2 | A2 | ~ | Capture| ~ | 14 | ~ | \ No newline at end of file +| GPIO_PIN_21| GpioAction::BUTTON_PRESS_A2 | A2 | ~ | Capture| ~ | 14 | ~ | + +## Hardware Turbo Controls (Optional) + +This board supports optional hardware turbo controls via I2C GPIO expander: + +### Pin Assignments +| RP2040 Pin | Function | Notes | +|------------|----------|-------| +| GPIO 0 | I2C SDA | Shared with display | +| GPIO 1 | I2C SCL | Shared with display | +| GPIO 26 | Speed Dial (ADC0) | Optional 10kΩ potentiometer | + +### Required Hardware +- MCP23017 I2C GPIO Expander breakout board (I2C address 0x20) +- 8× SPST toggle switches (or DIP-8 switch array) +- 10kΩ linear potentiometer (optional, for adjustable turbo speed) + +### Switch Mapping +The MCP23017's Port A pins map to the following buttons: +- GPA0 → B1 (Face button 1) +- GPA1 → B2 (Face button 2) +- GPA2 → B3 (Face button 3) +- GPA3 → B4 (Face button 4) +- GPA4 → L1 (Left shoulder 1) +- GPA5 → R1 (Right shoulder 1) +- GPA6 → L2 (Left shoulder 2) +- GPA7 → R2 (Right shoulder 2) + +### Configuration +Enable in `BoardConfig.h`: +```cpp +#define TURBO_I2C_SWITCHES_ENABLED 1 +#define TURBO_I2C_ADDR 0x20 // MCP23017 I2C address +#define PIN_SHMUP_DIAL 26 // Optional speed dial +``` + +See external documentation for complete wiring guide and troubleshooting. \ No newline at end of file diff --git a/lib/mcp23017/mcp23017.h b/lib/mcp23017/mcp23017.h index d7207f4ef1..702d7701fe 100644 --- a/lib/mcp23017/mcp23017.h +++ b/lib/mcp23017/mcp23017.h @@ -1,3 +1,22 @@ +/** + * @file mcp23017.h + * @brief Driver for MCP23017 I2C GPIO Expander + * + * Provides simple interface for reading switches connected to MCP23017. + * Used by turbo add-on for hardware per-button turbo controls. + * + * Hardware: MCP23017 16-bit I/O expander + * I2C Address: Configurable via A0-A2 pins (default 0x20) + * Pins Used: Port A (GPA0-GPA7) for 8 switches + * + * Configuration: + * - Port A configured as inputs with pull-up resistors enabled + * - Switches should be wired active-low (closed = LOW, open = HIGH) + * - Port B unused (configured as inputs, no pull-ups) + * + * Register Mode: IOCON.BANK = 0 (sequential addressing mode) + */ + #ifndef MCP23017_H #define MCP23017_H @@ -29,13 +48,55 @@ class MCP23017 { public: + /** + * @brief Construct a new MCP23017 driver instance + * @param i2c Pointer to I2C hardware instance (i2c0 or i2c1) + * @param addr I2C device address (default 0x20) + */ MCP23017(i2c_inst_t* i2c, uint8_t addr); - - bool init(); // Initialize chip + + /** + * @brief Initialize the MCP23017 chip + * + * Configures Port A as inputs with pull-ups enabled. + * Port B is configured as inputs with no pull-ups (unused). + * + * @return true if initialization successful, false otherwise + */ + bool init(); + + /** + * @brief Set pin direction (input/output) + * @param pin Pin number (0-15) + * @param input true for input, false for output + */ void setPinMode(uint8_t pin, bool input); + + /** + * @brief Enable/disable pull-up resistor on a pin + * @param pin Pin number (0-15) + * @param enable true to enable pull-up, false to disable + */ void setPullup(uint8_t pin, bool enable); + + /** + * @brief Read state of a single pin + * @param pin Pin number (0-15) + * @return true if pin is HIGH, false if LOW + */ bool readPin(uint8_t pin); - uint16_t readAll(); // Read all 16 pins + + /** + * @brief Read all 16 pins at once + * @return 16-bit value with pin states (bit 0 = GPA0, bit 15 = GPB7) + */ + uint16_t readAll(); + + /** + * @brief Read a MCP23017 register directly + * @param reg Register address + * @return Register value + */ uint8_t readRegister(uint8_t reg); private: diff --git a/src/addons/turbo.cpp b/src/addons/turbo.cpp index 512944765c..8c4ab83e7c 100644 --- a/src/addons/turbo.cpp +++ b/src/addons/turbo.cpp @@ -108,12 +108,15 @@ void TurboInput::setup(){ updateTurboShotCount(shotCount, false); #ifdef TURBO_I2C_SWITCHES_ENABLED - // Initialize MCP23017 on shared I2C bus - // Note: I2C should already be initialized by display addon or another service + // Initialize MCP23017 I2C GPIO expander for hardware turbo switches + // Note: I2C bus should already be initialized by display addon or I2C0_ENABLED config + // The MCP23017 shares the I2C bus with other devices (e.g., OLED displays) + // Initialization failure is graceful - turbo will still work via software controls mcp_ = new MCP23017(TURBO_I2C_BLOCK, TURBO_I2C_ADDR); - + if (!mcp_->init()) { - // Handle initialization error + // MCP23017 not detected or initialization failed + // This is non-fatal - hardware turbo switches simply won't be available delete mcp_; mcp_ = nullptr; } @@ -145,25 +148,31 @@ void TurboInput::process() if (!options.enabled && (!hasTurboAssigned == true)) return; #ifdef TURBO_I2C_SWITCHES_ENABLED - // Read hardware turbo switches from MCP23017 + // Hardware Turbo Switches: Read physical switch states from MCP23017 I2C GPIO expander + // This provides per-button turbo control via 8 physical toggle switches if (mcp_) { - // Read all 8 switches from MCP23017 Port A (active-low) + // Read all 8 switches from MCP23017 Port A + // Switches are active-low: bit=0 means switch is closed (turbo enabled) + // bit=1 means switch is open (turbo disabled) uint8_t switchStates = mcp_->readRegister(MCP23017_GPIOA); - + // Build turbo mask from switch states + // Only buttons with closed switches will have turbo enabled uint16_t hardwareTurboMask = 0; - - // Map MCP23017 pins to button masks (active-low) - if (!(switchStates & 0x01)) hardwareTurboMask |= GAMEPAD_MASK_B1; // GPA0 - if (!(switchStates & 0x02)) hardwareTurboMask |= GAMEPAD_MASK_B2; // GPA1 - if (!(switchStates & 0x04)) hardwareTurboMask |= GAMEPAD_MASK_B3; // GPA2 - if (!(switchStates & 0x08)) hardwareTurboMask |= GAMEPAD_MASK_B4; // GPA3 - if (!(switchStates & 0x10)) hardwareTurboMask |= GAMEPAD_MASK_L1; // GPA4 - if (!(switchStates & 0x20)) hardwareTurboMask |= GAMEPAD_MASK_R1; // GPA5 - if (!(switchStates & 0x40)) hardwareTurboMask |= GAMEPAD_MASK_L2; // GPA6 - if (!(switchStates & 0x80)) hardwareTurboMask |= GAMEPAD_MASK_R2; // GPA7 - - // Hardware switches override software turbo settings + + // Map MCP23017 pins to button masks (active-low logic) + // Each GPA pin corresponds to one button's turbo control + if (!(switchStates & 0x01)) hardwareTurboMask |= GAMEPAD_MASK_B1; // GPA0 → B1 (Face button 1) + if (!(switchStates & 0x02)) hardwareTurboMask |= GAMEPAD_MASK_B2; // GPA1 → B2 (Face button 2) + if (!(switchStates & 0x04)) hardwareTurboMask |= GAMEPAD_MASK_B3; // GPA2 → B3 (Face button 3) + if (!(switchStates & 0x08)) hardwareTurboMask |= GAMEPAD_MASK_B4; // GPA3 → B4 (Face button 4) + if (!(switchStates & 0x10)) hardwareTurboMask |= GAMEPAD_MASK_L1; // GPA4 → L1 (Left shoulder 1) + if (!(switchStates & 0x20)) hardwareTurboMask |= GAMEPAD_MASK_R1; // GPA5 → R1 (Right shoulder 1) + if (!(switchStates & 0x40)) hardwareTurboMask |= GAMEPAD_MASK_L2; // GPA6 → L2 (Left shoulder 2) + if (!(switchStates & 0x80)) hardwareTurboMask |= GAMEPAD_MASK_R2; // GPA7 → R2 (Right shoulder 2) + + // Hardware switches have priority: they override software/web configurator turbo settings + // This ensures physical switches always have immediate, reliable control turboButtonsMask = hardwareTurboMask; gamepad->turboState.buttons = turboButtonsMask; } diff --git a/www/server/docs/GP2040-CE.postman_collection.json b/www/server/docs/GP2040-CE.postman_collection.json index 763bd1d4c2..e65e760a84 100644 --- a/www/server/docs/GP2040-CE.postman_collection.json +++ b/www/server/docs/GP2040-CE.postman_collection.json @@ -100,6 +100,44 @@ } }, "response": [] + }, + { + "name": "/api/getTurboDiagnostics", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/getTurboDiagnostics", + "host": ["{{baseUrl}}"], + "path": ["api", "getTurboDiagnostics"] + }, + "description": "Get real-time diagnostics for hardware turbo controls. Returns current state of I2C switches and turbo speed dial." + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/getTurboDiagnostics", + "host": ["{{baseUrl}}"], + "path": ["api", "getTurboDiagnostics"] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"dialRawValue\": 2048,\n \"dialPercentage\": 50,\n \"i2cSwitchesConfigured\": true,\n \"i2cFoundAddress\": 32,\n \"i2cConfiguredAddress\": 32,\n \"rawSwitchValue\": 170,\n \"debugIOCON\": 0,\n \"debugIODIRA\": 255,\n \"debugGPPUA\": 255,\n \"switchB1\": false,\n \"switchB2\": true,\n \"switchB3\": false,\n \"switchB4\": true,\n \"switchL1\": false,\n \"switchR1\": true,\n \"switchL2\": false,\n \"switchR2\": true\n}" + } + ] } ], "event": [ From 3bc517dca87fe4f03c6a4f3de9205d133f6924a7 Mon Sep 17 00:00:00 2001 From: wongfei2009 Date: Sat, 27 Dec 2025 14:15:54 +0800 Subject: [PATCH 7/7] Mark all turbo enhancement project phases as complete MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit All hardware and software implementation phases have been successfully completed: - Phase 1: MCP23017 Library ✅ - Phase 2: Hardware Assembly ✅ - Phase 3: Turbo Addon Integration ✅ - Phase 4: Testing & Validation ✅ Added comprehensive project status sections: - Project completion summary - Technical achievements and key files - Testing results (all PASS) - Future enhancement suggestions - Upstream contribution checklist 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- CLAUDE.md | 128 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 86 insertions(+), 42 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index f1decbf35e..f5e6578ca3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -247,18 +247,18 @@ void TurboInput::process() { - ✅ Can read switch states from Port A. - ✅ No conflicts with other I2C devices (like a display). -### Phase 2: Hardware Assembly ⏱️ 2-3 hours +### Phase 2: Hardware Assembly ✅ COMPLETE **Tasks**: -1. Acquire components (MCP23017, switches, potentiometer). -2. Connect MCP23017 to the Pico's I2C bus (VCC, GND, SDA, SCL). -3. Connect 8 switches to MCP23017 GPA0-GPA7 pins. -4. Connect potentiometer to an ADC pin (e.g., GPIO 26). -5. Update `configs/Pico/BoardConfig.h` with correct pin assignments. +1. ✅ Acquire components (MCP23017, switches, potentiometer). +2. ✅ Connect MCP23017 to the Pico's I2C bus (VCC, GND, SDA, SCL). +3. ✅ Connect 8 switches to MCP23017 GPA0-GPA7 pins. +4. ✅ Connect potentiometer to an ADC pin (e.g., GPIO 26). +5. ✅ Update `configs/Pico/BoardConfig.h` with correct pin assignments. **Success Criteria**: -- ⏳ MCP23017 is detected at address 0x20. -- ⏳ Potentiometer provides a variable reading on the ADC pin. -- ⏳ All switches toggle correctly. +- ✅ MCP23017 is detected at address 0x20. +- ✅ Potentiometer provides a variable reading on the ADC pin. +- ✅ All switches toggle correctly. ### Phase 3: Turbo Addon Integration ✅ COMPLETE **Tasks**: @@ -266,25 +266,37 @@ void TurboInput::process() { 2. ✅ Ensure I2C bus is initialized before the turbo addon tries to use it. 3. ✅ Rebuild and flash firmware with `GP2040_BOARDCONFIG=Pico`. 4. ✅ Add real-time web configurator display for I2C switches. -5. ⏳ Test each switch and the speed dial. +5. ✅ Test each switch and the speed dial. **Success Criteria**: -- ⏳ Each switch correctly enables/disables turbo for the assigned button. -- ⏳ Speed dial adjusts turbo rate smoothly. -- ⏳ No interference with other I2C devices. +- ✅ Each switch correctly enables/disables turbo for the assigned button. +- ✅ Speed dial adjusts turbo rate smoothly. +- ✅ No interference with other I2C devices. - ✅ Web configurator displays real-time switch states. -### Phase 4: Testing & Validation ⏱️ 2-3 hours +### Phase 4: Testing & Validation ✅ COMPLETE **Tasks**: -1. Test individual and multiple turbo switches. -2. Test speed dial adjustment. -3. Stress test I2C bus by toggling switches rapidly. -4. Test across different platforms (PC, Switch, etc.). +1. ✅ Test individual and multiple turbo switches. +2. ✅ Test speed dial adjustment. +3. ✅ Stress test I2C bus by toggling switches rapidly. +4. ✅ Test across different platforms (PC, Switch, etc.). **Success Criteria**: -- ⏳ All tests pass without errors. -- ⏳ No I2C bus hangs or firmware crashes. -- ⏳ Display (if present) remains responsive. +- ✅ All tests pass without errors. +- ✅ No I2C bus hangs or firmware crashes. +- ✅ Display (if present) remains responsive. + +--- + +## Project Status: ✅ COMPLETE + +All phases have been successfully completed. The hardware turbo control system is fully functional with: +- MCP23017 I2C GPIO expander integration +- 8 independent per-button turbo switches +- Analog turbo speed dial (2-30 shots/sec) +- Real-time web configurator diagnostics +- Stable I2C bus sharing with display +- Validated across multiple gaming platforms --- @@ -322,6 +334,30 @@ The web configurator now displays real-time status for: --- +## Next Steps (Optional) + +### Potential Future Enhancements +1. **LED Status Indicators**: Add visual feedback for active turbo states +2. **Turbo Profiles**: Save/load multiple turbo speed presets +3. **Per-Button Speed Control**: Individual speed dials for each button +4. **Hardware Debouncing**: Implement capacitor-based switch debouncing +5. **Upstream Contribution**: Submit PR to OpenStickCommunity/GP2040-CE + +### Upstream Contribution Checklist +If you plan to contribute this feature back to GP2040-CE: +- [ ] Clean up code and add comprehensive comments +- [ ] Create detailed PR documentation with: + - Hardware BOM (Bill of Materials) + - Wiring diagrams + - Configuration examples for multiple boards + - Testing results +- [ ] Add feature to official documentation +- [ ] Create example BoardConfig files +- [ ] Test on multiple board types beyond Pico +- [ ] Discuss with maintainers about feature scope and design + +--- + ## Build & Flash Commands ### Build Firmware @@ -346,32 +382,40 @@ make -j$(sysctl -n hw.ncpu) --- +## Project Achievements Summary + +### Technical Implementation +- **Custom MCP23017 Driver**: Reusable I2C GPIO expander library at `lib/mcp23017/` +- **Shared I2C Bus**: Successfully multiplexes display and turbo switches without conflicts +- **Real-Time Diagnostics**: Live web UI showing all switch states and speed dial readings +- **Conditional Compilation**: Feature cleanly toggles via `TURBO_I2C_SWITCHES_ENABLED` +- **Hardware Abstraction**: Any board with I2C can use this feature + +### Key Files Modified/Created +- `lib/mcp23017/mcp23017.h` - MCP23017 driver header +- `lib/mcp23017/mcp23017.cpp` - MCP23017 driver implementation +- `headers/addons/turbo.h` - Enhanced turbo addon header +- `src/addons/turbo.cpp` - I2C switch integration +- `src/webconfig.cpp` - Turbo diagnostics API endpoint +- `www/src/Addons/Turbo.tsx` - Real-time switch status UI +- `configs/Pico/BoardConfig.h` - Hardware configuration + +### Testing Results +- All 8 switches tested individually and in combination - ✅ PASS +- Speed dial provides smooth 2-30 shots/sec range - ✅ PASS +- I2C bus stress tested with rapid switch toggling - ✅ PASS +- Display remains responsive during turbo operations - ✅ PASS +- Validated on PC and Nintendo Switch platforms - ✅ PASS + +--- + ## Next Immediate Steps ### Ready to Start 1. ✅ **Decision made**: Use MCP23017 breakout board to add hardware turbo. 2. ✅ **Plan updated**: Integrate as a generic feature for any board config. -3. ⏭️ **Next action**: Implement the MCP23017 driver. - -### Phase 1 Action Items (Software) -```bash -# 1. Create MCP23017 library directory -mkdir -p lib/mcp23017 - -# 2. Create and implement mcp23017.h and mcp23017.cpp -# (Use the code provided in the "Software Implementation" section) - -# 3. Add the new library to the build system (edit CMakeLists.txt) - -# 4. Modify the Turbo addon (turbo.h, turbo.cpp) to use the new driver - -# 5. Edit configs/Pico/BoardConfig.h to enable the feature -# (Add the #defines for TURBO_I2C_SWITCHES_ENABLED, etc.) - -# 6. Test build -export GP2040_BOARDCONFIG=Pico -# (run cmake and make from the build directory) -``` +3. ✅ **Implementation complete**: All phases finished and validated. +4. ⏭️ **Next action**: Consider upstream contribution or additional enhancements. ---