docs: implement complete dual-node MFC & GD32 4WD RC Vehicle specification from project_handoff.md
This commit is contained in:
parent
bc4cc25e46
commit
163ba4bea9
3 changed files with 359 additions and 296 deletions
162
README.md
162
README.md
|
|
@ -1,120 +1,142 @@
|
|||
# Multi-Functional Controller (MFC)
|
||||
# Multi-Functional Controller (MFC) & 4WD RC Vehicle
|
||||
|
||||
[](https://github.com/espressif/esp-idf)
|
||||
[](https://www.espressif.com/en/products/socs/esp32-s3)
|
||||
[](https://www.espressif.com/en/products/socs/esp32-s3)
|
||||
[](#32-rc-vehicle-receiver-node)
|
||||
[](https://www.kicad.org/)
|
||||
[](https://en.wikipedia.org/wiki/C_(programming_language))
|
||||
[](https://www.freertos.org/)
|
||||
[](#project-status--roadmap)
|
||||
|
||||
A custom, modular remote controller and telemetry station engineered from scratch for **long-range, low-latency 2.4 GHz RC control** and **USB/Bluetooth HID gaming**.
|
||||
## 1. Project Overview & Aim
|
||||
|
||||
Built around the **ESP32-S3-N16R8 (Xtensa® 32-bit LX7 dual-core @ 240 MHz)**, this project is developed in structured hardware phases—starting from a hand-wired 6×9 cm perfboard carrier core and scaling into a full desktop/console transmitter housed in a **DT-100 (190 × 137 × 59 mm)** instrument enclosure.
|
||||
- **Primary Goal:** Engineer a high-performance, bare-metal handheld remote controller (**MFC**) from scratch using an **ESP32-S3-N16R8**, paired with a custom **4WD RC Vehicle** controlled by an **ARM Cortex-M3 (`GD32F103C8T6`)**.
|
||||
- **Secondary Objectives:** Extend the controller's capabilities to include a **cloud-connected AI voice assistant** (`MAX4466`), **local FAT32 SD card telemetry logging**, and **PC Gamepad (`USB HID / Bluetooth`)** support.
|
||||
- **Tech Stack:** C/C++, ESP-IDF v5.x (FreeRTOS), bare-metal register manipulation, SPI, I2C, Hardware Pulse Counter (`PCNT`), and One-Shot `ADC1`.
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Core Carrier Board Showcase (Current Build)
|
||||
## 2. Current Situation & Hardware Prototype
|
||||
|
||||
The current physical hardware implements the **Core MCU & RF Carrier Stage** on a 6×9 cm perfboard:
|
||||
- **ESP32-S3-N16R8 Microcontroller** (socketed on female headers)
|
||||
- **nRF24L01+ 2.4 GHz RF Transceiver Module** with external dipole SMA antenna
|
||||
- **100 µF Electrolytic Decoupling Capacitor** (`C1`) across the 3.3V/GND radio rails to suppress TX burst voltage droop
|
||||
- **Modular Male Pin Headers & Dedicated Power Rail Headers** for external display, encoder, and joystick breakout interfacing
|
||||
- **Controller Prototype:** Currently prototyped on a **6×9 cm perfboard**. The `ESP32-S3-N16R8` communicates over a shared `SPI2_HOST` bus with a Nordic `nRF24L01+` 2.4 GHz transceiver and a temporary 1.3" SH1106 OLED display, decoupled by a `100 µF` electrolytic capacitor across the radio rails.
|
||||
- **Firmware:** A deterministic FreeRTOS state machine (`firmware/main/mmcontroller.c`) handles hardware quadrature decoding (`PCNT`) for a `KY-040` rotary encoder menu UI, `300 ms` software button debouncing, `ADC1` joystick polling, and live 2.4 GHz RF channel configuration (`0–125`).
|
||||
- **Display Hardware Pivot (`1.3" OLED` $\rightarrow$ `1.8" ST7789 TFT`):** Bench testing revealed that the 7-pin 1.3" OLED module lacks a physical Chip Select (`CS`) pin, causing SPI bus collisions when sharing the bus. We are upgrading to a **1.8" ST7789 Color TFT LCD** (which exposes a dedicated hardware `CS` pin on `GPIO 10`) to share the SPI bus safely without bus contention.
|
||||
- **Manufacturing & Enclosure Status:** Paused cutting the rigid ABS plastic project box (`DT-100`, `190 × 137 × 59 mm`) until next month when a variable 3-speed rotary tool (`Dremel/E108`) and `2.35 mm` diamond cutting wheels arrive to ensure clean, professional cutouts without melting the ABS plastic.
|
||||
|
||||
<p align="center">
|
||||
<img src="images/TOP_VIEW.png" alt="Multi-Functional Controller Top View" width="700">
|
||||
<br>
|
||||
<em><b>Figure 1:</b> Phase 1 Top View — ESP32-S3-N16R8 module, nRF24L01+ RF transceiver, 100 µF bulk decoupling capacitor, peripheral male pin headers, and dedicated power rail male headers on a 6×9 cm perfboard.</em>
|
||||
<em><b>Figure 1:</b> 6×9 cm Perfboard Controller Prototype (Top View) — ESP32-S3-N16R8 module, nRF24L01+ 2.4 GHz transceiver, 100 µF burst-smoothing capacitor, peripheral male header bus, and power rail headers.</em>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="images/SIDE_VIEW_WITH_ANTENNA.png" alt="Multi-Functional Controller Profile & RF Antenna" width="700">
|
||||
<br>
|
||||
<em><b>Figure 2:</b> Phase 1 Side Profile — 2.4 GHz external dipole antenna mounted to the nRF24L01+ module and dual USB-C ports (Native USB-OTG & UART).</em>
|
||||
<em><b>Figure 2:</b> Side Profile — External 2.4 GHz SMA dipole antenna connected to the nRF24L01+ transceiver and dual USB-C ports (Native USB-OTG & UART).</em>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="images/BOTTOM_VIEW.png" alt="Multi-Functional Controller Perfboard Soldering" width="700">
|
||||
<br>
|
||||
<em><b>Figure 3:</b> Phase 1 Underbody Bus Routing — Point-to-point solder bridges, common ground/power rails, and FSPI signal routing between the ESP32-S3-N16R8 and male breakout headers.</em>
|
||||
<em><b>Figure 3:</b> Underbody Bus Routing — Point-to-point solder bridges, common ground/power rails, and shared SPI2 signal routing on the 6×9 cm perfboard.</em>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Console Expansion Bill of Materials (BOM)
|
||||
## 3. Hardware Architecture & Bill of Materials (BOM)
|
||||
|
||||
The project is transitioning from the bare perfboard carrier into a self-contained console transmitter. Below is the complete English technical specification for the Phase 2 hardware expansion:
|
||||
### 3.1 Handheld Controller (MFC — Transmitter Node)
|
||||
|
||||
| Category | Component (English Technical Name) | Original / Part Spec | Engineering Role in Controller |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **Enclosure** | **DT-100 Desktop Instrument Enclosure (Black ABS)** | `DT-100` (`190 × 137 × 59 mm`) | Main desktop/handheld transmitter chassis housing the perfboard, dual gimbals, screen, and battery pack. |
|
||||
| **Display** | **1.3" ST7789 IPS TFT Color LCD Module** | `240 × 240 px`, RGB SPI, 3.3V | High-contrast full-color IPS graphical dashboard replacing the benchtop monochrome OLED. |
|
||||
| **Primary Input** | **2× Dual-Axis Hall-Effect Analog Joysticks** | Contactless Magnetic 2-Axis | Drift-free 4-channel analog control (Throttle, Yaw, Pitch, Roll) routed to `ADC1`. |
|
||||
| **Audio Input** | **MAX4466 Electret Microphone Amplifier Module** | Adjustable Gain, `2.4V–5.5V` | Analog voice telemetry capture and real-time audio FFT spectrum visualization on `ADC1`. |
|
||||
| **Storage** | **SPI MicroSD Card Reader Module** | Standard SPI (`MOSI/MISO/SCK/CS`) | Non-volatile storage for flight/drive telemetry logs, model profiles, and UI bitmap assets. |
|
||||
| **Power Boost** | **MT3608 2A Adjustable DC-DC Step-Up Boost Converter** | `2V–24V` Input, up to `28V` / `2A` Out | Boosts the 3.7V Li-ion battery rail to `5V` / `12V` for auxiliary peripherals and switch LED illumination. |
|
||||
| **Master Switch** | **12–24V Illuminated Waterproof Push-Button Switch** | Latching ON-OFF, White LED Ring | Master system power / RF arming switch mounted on the DT-100 front panel. |
|
||||
| **Mode Switch** | **KTS-303 Mini Toggle Switch (3-Pin SPDT)** | `ON-OFF`, Panel Mount | Physical toggle switch for flight/drive mode selection or high/low rate switching. |
|
||||
| **Aux Switch** | **180° Vertical Slide Switch** | `ON-OFF` Slide, Through-Hole | Sub-circuit power rail isolation / programming mode selector. |
|
||||
| **Power Diode** | **1N5817 Schottky Barrier Diode** | `1A`, `20V`, `DO-41` THT | Low forward-voltage drop ($V_F \approx 0.45\text{V}$) power rail OR-ing and reverse-polarity protection. |
|
||||
| **Rectifier Diode** | **1N4001 General-Purpose Silicon Diode** | `1A`, `50V`, `DO-41` THT | Reverse-current blocking and inductive flyback protection across switched loads. |
|
||||
| **Switching BJT** | **2N2222 NPN Bipolar Junction Transistor** | `40V`, `600mA–800mA`, `TO-92` | Low-side transistor switch allowing 3.3V ESP32-S3 GPIOs to drive the 12V switch LED ring (via MT3608) or buzzers. |
|
||||
| Subsystem | Component | Technical Details & Role |
|
||||
| :--- | :--- | :--- |
|
||||
| **MCU** | **Espressif ESP32-S3-N16R8** | Dual-core Xtensa® LX7 @ 240 MHz, 16 MB Quad SPI Flash, 8 MB Octal PSRAM. |
|
||||
| **RF Telemetry** | **Nordic nRF24L01+ Module** | 2.4 GHz ISM band transceiver over shared `SPI2_HOST`. |
|
||||
| **Display** | **1.8" ST7789 TFT Color LCD** | 3.3V logic, full-color SPI display **with dedicated `CS` pin** (replacing 7-pin CS-less 1.3" OLED). |
|
||||
| **Joysticks** | **2× K-Silver (KS) PS5 Hall-Effect Modules** | 3.3V active magnetic contactless gimbals for zero stick drift. |
|
||||
| **UI Input** | **KY-040 Rotary Encoder** | Quadrature encoder (`CLK`, `DT`, `SW`) decoded in hardware via ESP32-S3 `PCNT`. |
|
||||
| **Voice AI** | **MAX4466 Electret Microphone Module** | Analog pre-amplifier with adjustable gain for cloud-connected AI voice assistant input. |
|
||||
| **Data Logging** | **Arduino Micro SD Card Module** | SPI interface, formatted `FAT32` for local telemetry and configuration logging. |
|
||||
| **Audio Output** | **1× Passive Buzzer + 2× Active Buzzers** | Passive buzzer for melodies + 2× active buzzers for percussive UI clicks, driven by **2N2222 NPN Transistors**. |
|
||||
| **Power System** | **Dual 18650 Li-ion + TP4056 + MT3608** | Dual 18650 cells, `TP4056` charger, `MT3608` DC-DC boost converter (5V rail), `100 µF` electrolytic capacitor (nRF24 burst smoothing), and `100 nF` ceramic decoupling caps. |
|
||||
|
||||
### 3.2 RC Vehicle (Receiver Node)
|
||||
|
||||
| Subsystem | Component | Technical Details & Role |
|
||||
| :--- | :--- | :--- |
|
||||
| **MCU** | **GD32F103C8T6 Mini Board** | 32-bit ARM® Cortex®-M3 real-time vehicle controller. |
|
||||
| **RF Telemetry** | **nRF24L01+ PA+LNA Module** | High-power 2.4 GHz transceiver with Power Amplifier, Low-Noise Amplifier, and external SMA antenna (~1 km range). |
|
||||
| **IMU / Navigation**| **MPU9250 9-DOF Sensor** | 3-axis Gyroscope, 3-axis Accelerometer, and 3-axis Magnetometer (I2C) for tilt-compensated heading. |
|
||||
| **Drivetrain** | **4× JGB37-520 12V 333 RPM Gear Motors** | High-torque 12V DC gear motors with built-in quadrature encoders for closed-loop PID velocity control. |
|
||||
| **Chassis / Box** | **DT-100 Project Box** | Rigid black ABS enclosure (`190 × 137 × 59 mm`). |
|
||||
| **Power System** | **12V Battery + Motor Drivers** | 12V traction battery pack, heavy-duty H-bridge motor drivers, and **12–24V Waterproof Main Switch**. |
|
||||
|
||||
---
|
||||
|
||||
## Verified Pin Mapping (Phase 1 Firmware & Bench Harness)
|
||||
## 4. Pinout Definitions (ESP32-S3 Controller)
|
||||
|
||||
The master firmware (`firmware/main/mmcontroller.c`) configures a collision-free shared **SPI2_HOST** (FSPI) bus, `ADC1` analog inputs, and the hardware `pulse_cnt` quadrature decoder:
|
||||
The controller firmware (`firmware/main/mmcontroller.c`) and schematic (`hardware/mfc-1.kicad_sch`) allocate pins on the `ESP32-S3-N16R8` as follows:
|
||||
|
||||
| Peripheral / Signal | GPIO | Hardware Interface | Description |
|
||||
| :--- | :---: | :--- | :--- |
|
||||
| **SPI Bus: MOSI** | `GPIO 11` | SPI Master Output (`SPI2_HOST`) | Shared data line for nRF24L01+, Display (`SDA`), and MicroSD |
|
||||
| **SPI Bus: MISO** | `GPIO 13` | SPI Master Input (`SPI2_HOST`) | Shared data input line from nRF24L01+ and MicroSD |
|
||||
| **SPI Bus: SCK (Clock)** | `GPIO 12` | SPI Master Clock (`SPI2_HOST`) | Shared clock line for nRF24L01+, Display (`CLK`), and MicroSD |
|
||||
| **nRF24L01+ Chip Select (CS)** | `GPIO 14` | SPI Device Select | Dedicated radio bus enable |
|
||||
| **nRF24L01+ Chip Enable (CE)** | `GPIO 21` | Digital Output | Radio TX/RX power state activation line |
|
||||
| **Display Chip Select (CS)** | `GPIO 10` | SPI Device Select | Display SPI bus enable |
|
||||
| **Display Data/Command (DC)** | `GPIO 9` | Digital Output | Display command vs. frame data selection |
|
||||
| **Display Reset (RES)** | `GPIO 8` | Digital Output | Hardware display reset line |
|
||||
| **Joystick 1 VRx (X-Axis)** | `GPIO 4` | `ADC1` Channel 3 (`12 dB` Atten) | Analog X-axis input (`0–3.3V` safe) |
|
||||
| **Joystick 1 VRy (Y-Axis)** | `GPIO 5` | `ADC1` Channel 4 (`12 dB` Atten) | Analog Y-axis input (`0–3.3V` safe) |
|
||||
| **Rotary Encoder CLK** | `GPIO 15` | ESP-IDF `pulse_cnt` Unit | Quadrature channel A (hardware edge counter) |
|
||||
| **Rotary Encoder DT** | `GPIO 16` | ESP-IDF `pulse_cnt` Unit | Quadrature channel B (direction sensing) |
|
||||
| **Rotary Encoder Switch (SW)**| `GPIO 17` | Digital Input (`PULLUP`) | Push-button (menu enter/select mode) |
|
||||
|
||||
### Silicon Multiplexing Notes (ESP32-S3-N16R8 vs. Classic ESP32)
|
||||
1. **Octal PSRAM & Flash Reservation (`GPIO 26 – GPIO 37`):** On the **ESP32-S3-N16R8** (8 MB Octal PSRAM), `GPIO 26` through `GPIO 37` are wired internally to the Octal SPI Flash/PSRAM bus. Accessing `GPIO 26, 27, 32, 33` triggers an immediate *Guru Meditation Error / Cache Disabled Panic* on boot.
|
||||
2. **Unbonded Silicon Pins (`GPIO 22 – GPIO 25`):** `GPIO 22, 23, 24, 25` do not exist on the ESP32-S3 pin multiplexing matrix.
|
||||
3. **FSPI (`SPI2_HOST`) Default Matrix:** Uses native ESP32-S3 FSPI pins (`GPIO 10, 11, 12, 13`) rather than legacy 2016 ESP32 VSPI defaults (`GPIO 5, 18, 23`).
|
||||
| Bus / Peripheral | Signal | ESP32-S3 Pin | Interface / Mode | Notes |
|
||||
| :--- | :--- | :---: | :--- | :--- |
|
||||
| **SPI Hub (`SPI2_HOST`)** | `MOSI` | `GPIO 11` | SPI Master Output | Shared data line (`nRF24L01+`, Display `SDA`, MicroSD) |
|
||||
| **SPI Hub (`SPI2_HOST`)** | `MISO` | `GPIO 13` | SPI Master Input | Shared data input (`nRF24L01+`, MicroSD) |
|
||||
| **SPI Hub (`SPI2_HOST`)** | `SCK` | `GPIO 12` | SPI Master Clock | Shared clock line (`nRF24L01+`, Display `CLK`, MicroSD) |
|
||||
| **nRF24L01+ Radio** | `CSN` | `GPIO 14` | SPI Chip Select | Dedicated radio bus enable |
|
||||
| **nRF24L01+ Radio** | `CE` | `GPIO 21` | Digital Output | Radio TX/RX power state activation |
|
||||
| **TFT Display (1.8" ST7789)**| `CS` | `GPIO 10` | SPI Chip Select | Dedicated display bus enable |
|
||||
| **TFT Display (1.8" ST7789)**| `DC` | `GPIO 9` | Digital Output | Command vs. frame data selection |
|
||||
| **TFT Display (1.8" ST7789)**| `RES` | `GPIO 8` | Digital Output | Hardware display reset (`BLK` tied to `3.3V`) |
|
||||
| **KY-040 Rotary Encoder** | `CLK` | `GPIO 15` | Hardware `PCNT` | Quadrature channel A (1000 ns glitch filter) |
|
||||
| **KY-040 Rotary Encoder** | `DT` | `GPIO 16` | Hardware `PCNT` | Quadrature channel B (direction sensing) |
|
||||
| **KY-040 Rotary Encoder** | `SW` | `GPIO 17` | Input (`PULLUP`) | Push-button switch (300 ms software debounce) |
|
||||
| **K-Silver Hall Joystick 1**| `VRx` | `GPIO 4` | `ADC1_CH3` (`12 dB`) | Analog X-axis (0–3.3V active Hall sensor) |
|
||||
| **K-Silver Hall Joystick 1**| `VRy` | `GPIO 5` | `ADC1_CH4` (`12 dB`) | Analog Y-axis (0–3.3V active Hall sensor; 2nd joystick pending) |
|
||||
|
||||
---
|
||||
|
||||
## Repository Structure
|
||||
## 5. Hardware Safety & Engineering Rules
|
||||
|
||||
1. **Enclosure Machining RPM Rule:** Do **NOT** use standard fixed `16,000 RPM` rotary tools on the `DT-100` ABS plastic enclosure; high friction melts ABS instead of cutting it. Machining is paused until the variable 3-speed rotary tool with `2.35 mm` diamond cutting discs arrives.
|
||||
2. **Hall-Effect Gimbal Polarity Protection:** Do **NOT** wire the K-Silver (KS) PS5 Hall-effect joystick `VCC` backward. Unlike passive potentiometers, these are active 3.3V CMOS magnetic sensors and will burn out immediately under reverse polarity.
|
||||
3. **5V Sensor Level Shifting on GD32:** Do **NOT** wire a 5V `HC-SR04` ultrasonic `ECHO` pin directly to the 3.3V `GD32F103C8T6` without a resistor voltage divider (or use the 3.3V `VL53L0X` I2C Time-of-Flight sensor instead).
|
||||
4. **nRF24L01+ Burst Decoupling:** Always keep the `100 µF` electrolytic capacitor across the `nRF24L01+` `VCC`/`GND` pins to prevent 3.3V rail brown-outs during PTX transmission bursts.
|
||||
|
||||
---
|
||||
|
||||
## 6. Immediate Next Steps & Engineering Roadmap
|
||||
|
||||
1. **1.8" ST7789 TFT Migration:** Rewrite the display initialization and frame buffer logic using ESP-IDF's `esp_lcd` component to replace the custom 5×8 monochrome OLED driver.
|
||||
2. **MicroSD Card SPI & FATFS Setup:** Configure the Arduino MicroSD card module on the SPI bus and initialize the `FATFS` virtual filesystem (`VFS`) for reading/writing telemetry logs.
|
||||
3. **NVS Hall-Effect Joystick Calibration:** Write the calibration routine for the K-Silver PS5 Hall-effect joysticks—measuring resting center, minimum, and maximum voltages and saving them persistently to ESP32-S3 Non-Volatile Storage (`NVS`) flash.
|
||||
4. **GD32F103C8T6 Vehicle Receiver Firmware:** Structure the ARM Cortex-M3 C codebase to poll the `nRF24L01+ PA+LNA` module, read `MPU9250` 9-DOF I2C telemetry, and run closed-loop PID motor control on the 4× `JGB37-520` encoder motors.
|
||||
|
||||
---
|
||||
|
||||
## 7. Repository Structure & Build Instructions
|
||||
|
||||
```text
|
||||
multi-functional-controller/
|
||||
├── firmware/ # ESP-IDF C99 Firmware Project (ESP32-S3)
|
||||
├── docs/
|
||||
│ └── PROJECT_HANDOFF.md # Canonical engineering handoff & specification
|
||||
├── firmware/ # ESP-IDF v5.x C99 Firmware Project (ESP32-S3)
|
||||
│ ├── CMakeLists.txt # Top-level CMake project configuration
|
||||
│ ├── sdkconfig # Verified ESP32-S3 target configuration
|
||||
│ └── main/
|
||||
│ ├── CMakeLists.txt # Component registration
|
||||
│ └── mmcontroller.c # Master firmware: Shared SPI2, Display UI, nRF24L01+, PCNT, ADC1
|
||||
│ └── mmcontroller.c # Master firmware: Shared SPI2, PCNT menu UI, nRF24 tuning
|
||||
├── hardware/ # KiCad 10 Electronic Design Automation (EDA)
|
||||
│ ├── mfc-1.kicad_pro # KiCad project file
|
||||
│ ├── mfc-1.kicad_sch # Phase 1 schematic design (ESP32-S3, nRF24L01+, 100uF cap)
|
||||
│ ├── mfc-1.kicad_sch # Controller schematic design (ESP32-S3, nRF24L01+, 100uF cap)
|
||||
│ └── mfc-1.kicad_pcb # Board layout & routing rules
|
||||
├── images/ # High-resolution Phase 1 prototype photography
|
||||
│ ├── TOP_VIEW.png # Perfboard top view (MCU, RF, 100uF cap, male pin headers)
|
||||
├── images/ # High-resolution 6x9cm perfboard prototype photography
|
||||
│ ├── TOP_VIEW.png # Front carrier board overview
|
||||
│ ├── SIDE_VIEW_WITH_ANTENNA.png # RF antenna and profile perspective
|
||||
│ └── BOTTOM_VIEW.png # Perfboard underside solder bus & power rail wiring
|
||||
│ └── BOTTOM_VIEW.png # Perfboard underside solder bus wiring
|
||||
├── .gitignore # Clean repository filter (builds, caches, local configs)
|
||||
├── LICENSE # MIT License
|
||||
└── README.md # Master engineering documentation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Getting Started: Building the Firmware
|
||||
### Build & Flash (ESP32-S3 Controller)
|
||||
|
||||
```bash
|
||||
. $HOME/esp/esp-idf/export.sh
|
||||
|
|
@ -126,21 +148,7 @@ idf.py -p /dev/ttyACM0 flash monitor
|
|||
|
||||
---
|
||||
|
||||
## Project Status & Roadmap
|
||||
|
||||
- [x] **Phase 1 Hardware (Complete):** 6×9 cm perfboard carrier assembly with ESP32-S3-N16R8, nRF24L01+ RF module, 100 µF decoupling capacitor, signal male headers, and power rail male headers.
|
||||
- [x] **Phase 1 Firmware (Complete):** Shared `SPI2_HOST` bus, 5×8 UI state machine (`DRIVE VEHICLE`, `RADIO CONFIG`, `CALIBRATE`, `SYSTEM INFO`), hardware `pulse_cnt` rotary decoding, and live nRF24 channel tuning (`0–125`).
|
||||
- [ ] **Phase 2 Hardware Integration (In Progress):**
|
||||
- [ ] Mount system into **DT-100 (`190 × 137 × 59 mm`)** black desktop enclosure.
|
||||
- [ ] Integrate **2× Dual-Axis Hall-Effect Joysticks** (`ADC1` channels `GPIO 4, 5, 6, 7`).
|
||||
- [ ] Upgrade display to **1.3" ST7789 240×240 IPS TFT LCD**.
|
||||
- [ ] Wire **MT3608 DC-DC Boost Converter**, **1N5817 / 1N4001 Diodes**, and **2N2222 NPN BJT** to drive the **12–24V Illuminated Push-Button Switch**, **KTS-303 Toggle Switch**, and **180° Slide Switch**.
|
||||
- [ ] Integrate **MAX4466 Microphone Amplifier** and **SPI MicroSD Card Module**.
|
||||
- [ ] **Phase 3 Custom PCB:** Full multi-layer PCB fabrication in KiCad 10.
|
||||
|
||||
---
|
||||
|
||||
## Author & Project Notebook
|
||||
## Author & Project Links
|
||||
|
||||
- **Author:** [Ertunç Özbay](https://github.com/ertunc-ozbay)
|
||||
- **Personal Workshop & Portfolio:** [ertuncozbay.dev](https://ertuncozbay.dev)
|
||||
|
|
|
|||
173
docs/PROJECT_HANDOFF.md
Normal file
173
docs/PROJECT_HANDOFF.md
Normal file
|
|
@ -0,0 +1,173 @@
|
|||
# Project Handoff: Multi-Functional Controller (MFC) & RC Vehicle
|
||||
|
||||
## 1. Project Overview & Aim
|
||||
**Goal:** Engineer a high-performance, bare-metal remote controller (MFC) from scratch using an ESP32-S3, paired with a custom 4WD RC vehicle.
|
||||
**Secondary Objectives:** Extend the controller's capabilities to include a cloud-connected AI voice assistant, local telemetry logging, and PC gamepad (USB HID/Bluetooth) support.
|
||||
**Tech Stack:** C/C++, ESP-IDF v5.x (FreeRTOS), Bare-metal register manipulation, SPI, I2C, Hardware PCNT, ADC Oneshot.
|
||||
|
||||
## 2. Current Situation
|
||||
* **Controller Prototype:** Currently prototyped on a 6x9cm perfboard. The ESP32-S3 successfully communicates over a shared SPI bus with an NRF24L01+ transceiver and a temporary 1.3" OLED display.
|
||||
* **Firmware:** A robust FreeRTOS state machine is running. It handles analog ADC joystick polling, hardware quadrature decoding (PCNT) for a rotary encoder menu UI, software button debouncing, and blind RF transmission on 2.4GHz.
|
||||
* **Hardware Pivot:** We recently discovered the 7-pin 1.3" OLED lacks a Chip Select (CS) pin, causing SPI collisions. We have decided to upgrade to a 1.8" ST7789 color TFT (which has a CS pin) to share the SPI bus safely.
|
||||
* **Manufacturing:** Paused cutting the rigid ABS plastic project box (`DT-100`) until next month when a proper rotary tool (Dremel/E108) and 2.35mm cutting wheels arrive to ensure clean, professional cutouts.
|
||||
|
||||
## 3. Hardware Architecture & Bill of Materials (BOM)
|
||||
|
||||
### 3.1 Handheld Controller (MFC)
|
||||
* **MCU:** Espressif ESP32-S3-N16R8 (16MB Flash, 8MB PSRAM).
|
||||
* **RF Telemetry:** Nordic nRF24L01+ 2.4GHz Module.
|
||||
* **Display:** 1.8" ST7789 TFT Color LCD (3.3V logic, SPI with CS pin).
|
||||
* **Joysticks:** 2x K-Silver (KS) PS5 Magnetic Hall-Effect modules (3.3V active sensors).
|
||||
* **UI Input:** KY-040 Rotary Encoder (CLK, DT, SW).
|
||||
* **Voice AI:** MAX4466 Electret Microphone Module (Analog output).
|
||||
* **Data Logging:** Arduino Micro SD Card Module (SPI interface, formatted FAT32).
|
||||
* **Audio Output:** 1x Passive Buzzer (Melody), 2x Active Buzzers (Percussive clicks) driven by 2N2222 NPN Transistors.
|
||||
* **Power:** Dual 18650 Li-ion cells, TP4056 Charger, MT3608 DC-DC Boost Converter (5V rail), 100µF Electrolytic Capacitor (for NRF24 burst smoothing), 100nF Ceramic Caps.
|
||||
|
||||
### 3.2 RC Vehicle (Receiver Node)
|
||||
* **MCU:** GD32F103C8T6 ARM Cortex-M3 Mini Board.
|
||||
* **RF Telemetry:** nRF24L01+ PA+LNA (with external SMA antenna for 1km range).
|
||||
* **IMU / Navigation:** MPU9250 9-DOF Sensor (Gyro, Accelerometer, Magnetometer for tilt-compensated heading).
|
||||
* **Drivetrain:** 4x JGB37-520 12V 333RPM Gear Motors (with built-in encoders for PID velocity control).
|
||||
* **Chassis/Enclosure:** DT-100 Project Box (190x137x59mm).
|
||||
* **Power:** 12V Battery, Heavy-duty Motor Drivers, 12-24V Waterproof Main Switch.
|
||||
|
||||
## 4. Pinout Definitions (ESP32-S3 Controller)
|
||||
* **SPI Hub:** MOSI (`GPIO11`), MISO (`GPIO13`), SCK (`GPIO12`)
|
||||
* **NRF24:** CSN (`GPIO14`), CE (`GPIO21`)
|
||||
* **TFT Display (Planned):** CS (`GPIO10`), DC (`GPIO9`), RES (`GPIO8`), BLK (`3.3V`)
|
||||
* **Rotary Encoder:** CLK (`GPIO15`), DT (`GPIO16`), SW (`GPIO17` - Pull-up)
|
||||
* **Joysticks:** VRx (`GPIO4`), VRy (`GPIO5`) via ADC1. (Second joystick pins pending).
|
||||
|
||||
## 5. Master Codebase (Latest Working Version)
|
||||
This code currently uses the monochrome OLED logic, but handles PCNT menu decoding and NRF transmission perfectly.
|
||||
|
||||
```c
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <stdbool.h>
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
#include "driver/spi_master.h"
|
||||
#include "driver/gpio.h"
|
||||
#include "driver/pulse_cnt.h"
|
||||
#include "esp_system.h"
|
||||
#include "esp_log.h"
|
||||
|
||||
// Hardware Pins
|
||||
#define PIN_NUM_MOSI 11
|
||||
#define PIN_NUM_MISO 13
|
||||
#define PIN_NUM_CLK 12
|
||||
#define NRF_PIN_CS 14
|
||||
#define NRF_PIN_CE 21
|
||||
#define OLED_PIN_CS 10
|
||||
#define OLED_PIN_DC 9
|
||||
#define OLED_PIN_RES 8
|
||||
#define PIN_ENCODER_CLK 15
|
||||
#define PIN_ENCODER_DT 16
|
||||
#define PIN_ENCODER_SW 17
|
||||
|
||||
#define NUM_MENU_ITEMS 4
|
||||
|
||||
static const char *TAG = "MFC_CORE";
|
||||
spi_device_handle_t oled_spi;
|
||||
spi_device_handle_t nrf_spi;
|
||||
int current_radio_channel = 76;
|
||||
|
||||
typedef enum { SCREEN_MAIN_MENU = 0, SCREEN_DRIVE, SCREEN_RADIO_CONFIG, SCREEN_CALIBRATE, SCREEN_SYSTEM_INFO } screen_state_t;
|
||||
|
||||
// [Font arrays omitted in handoff for brevity, but exist in master file: font_AZ, font_nums, etc.]
|
||||
const uint8_t* get_font_data(char c) { /* ... */ return NULL; }
|
||||
|
||||
void oled_cmd(uint8_t cmd) {
|
||||
gpio_set_level(OLED_PIN_DC, 0);
|
||||
spi_transaction_t t = { .length = 8, .tx_buffer = &cmd };
|
||||
spi_device_polling_transmit(oled_spi, &t);
|
||||
}
|
||||
void oled_data(uint8_t data) {
|
||||
gpio_set_level(OLED_PIN_DC, 1);
|
||||
spi_transaction_t t = { .length = 8, .tx_buffer = &data };
|
||||
spi_device_polling_transmit(oled_spi, &t);
|
||||
}
|
||||
void oled_draw_string(uint8_t page, uint8_t col, const char* str) {
|
||||
oled_cmd(0xB0 + page);
|
||||
uint8_t phys_col = col + 2;
|
||||
oled_cmd(0x00 | (phys_col & 0x0F));
|
||||
oled_cmd(0x10 | ((phys_col >> 4) & 0x0F));
|
||||
while (*str) {
|
||||
const uint8_t* pixels = get_font_data(*str++);
|
||||
for (int i = 0; i < 5; i++) { oled_data(pixels[i]); }
|
||||
oled_data(0x00);
|
||||
}
|
||||
}
|
||||
void oled_clear() {
|
||||
for (uint8_t p = 0; p < 8; p++) {
|
||||
oled_cmd(0xB0 + p); oled_cmd(0x02); oled_cmd(0x10);
|
||||
for (uint8_t c = 0; c < 128; c++) { oled_data(0x00); }
|
||||
}
|
||||
}
|
||||
void oled_init() {
|
||||
gpio_set_level(OLED_PIN_RES, 0); vTaskDelay(pdMS_TO_TICKS(50));
|
||||
gpio_set_level(OLED_PIN_RES, 1); vTaskDelay(pdMS_TO_TICKS(50));
|
||||
uint8_t init_cmds[] = {0xAE,0xD5,0x80,0xA8,0x3F,0xD3,0x00,0x40,0x8D,0x14,0xA1,0xC8,0xDA,0x12,0x81,0xCF,0xD9,0xF1,0xDB,0x40,0xA4,0xA6,0xAF};
|
||||
for(int i = 0; i < sizeof(init_cmds); i++) { oled_cmd(init_cmds[i]); }
|
||||
}
|
||||
|
||||
bool nrf_check_connection() {
|
||||
uint8_t tx[2] = { 0x03, 0xFF };
|
||||
uint8_t rx[2] = { 0 };
|
||||
spi_transaction_t t = { .length = 16, .tx_buffer = tx, .rx_buffer = rx };
|
||||
spi_device_polling_transmit(nrf_spi, &t);
|
||||
return (rx[1] == 0x03);
|
||||
}
|
||||
void set_nrf_channel(uint8_t channel) {
|
||||
uint8_t tx[2] = { 0x25, channel };
|
||||
spi_transaction_t t = { .length = 16, .tx_buffer = tx };
|
||||
spi_device_polling_transmit(nrf_spi, &t);
|
||||
}
|
||||
|
||||
void draw_menu(int selected_index) { /* Renders Main Menu items */ }
|
||||
void draw_system_info() { /* Renders ESP32 Free Heap */ }
|
||||
void draw_radio_config_screen(int channel) { /* Interactive channel tuning UI */ }
|
||||
void draw_placeholder_screen(const char* title) { /* Basic placeholder */ }
|
||||
|
||||
void app_main(void) {
|
||||
// 1. SPI Init
|
||||
spi_bus_config_t buscfg = { .miso_io_num = PIN_NUM_MISO, .mosi_io_num = PIN_NUM_MOSI, .sclk_io_num = PIN_NUM_CLK, .max_transfer_sz = 4096 };
|
||||
spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO);
|
||||
|
||||
// 2. Devices (OLED & NRF)
|
||||
spi_device_interface_config_t oled_cfg = { .clock_speed_hz = 10000000, .mode = 0, .spics_io_num = OLED_PIN_CS, .queue_size = 1 };
|
||||
spi_bus_add_device(SPI2_HOST, &oled_cfg, &oled_spi);
|
||||
|
||||
spi_device_interface_config_t nrf_cfg = { .clock_speed_hz = 1000000, .mode = 0, .spics_io_num = NRF_PIN_CS, .queue_size = 1 };
|
||||
spi_bus_add_device(SPI2_HOST, &nrf_cfg, &nrf_spi);
|
||||
|
||||
// 3. PCNT Setup for Rotary Encoder
|
||||
// [PCNT Init logic omitted for brevity in handoff, but fully functional in master]
|
||||
|
||||
// 4. FreeRTOS State Machine Loop
|
||||
int count = 0, last_menu_index = -1, last_sw_state = 1;
|
||||
TickType_t last_button_press = 0;
|
||||
screen_state_t current_screen = SCREEN_MAIN_MENU;
|
||||
bool screen_needs_redraw = true;
|
||||
int radio_start_count = 0, last_tuned_channel = current_radio_channel;
|
||||
|
||||
while (1) {
|
||||
// Core polling loop handling screen state, PCNT steps, debouncing, and NRF register updating.
|
||||
vTaskDelay(pdMS_TO_TICKS(30));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 6. Immediate Next Steps (For the Assisting Agent)
|
||||
1. **ST7789 TFT Migration:** Rewrite the display initialization and frame buffer logic using ESP-IDF's `esp_lcd` component to replace the custom 5x8 monochrome OLED code.
|
||||
2. **SD Card SPI Setup:** Configure the SD card module on the shared SPI bus (or a new SPI bus) and initialize the `FATFS` VFS so we can read/write data logs.
|
||||
3. **NVS Calibration:** Write the calibration routine for the upcoming K-Silver Hall-effect joysticks. We need to measure resting, min, and max voltages and save them permanently to the ESP32's flash memory.
|
||||
4. **GD32 Vehicle Receiver Code:** Begin structuring the C code for the ARM Cortex-M3 GD32 to poll the NRF24 PA+LNA module and read the MPU9250 I2C data.
|
||||
|
||||
## 7. Known Context & Hardware Rules
|
||||
* Do NOT use standard `16000 RPM` tools on the plastic case; we are waiting for a 3-speed drill with 2.35mm diamond cutting discs.
|
||||
* Do NOT wire the Hall-effect joystick `VCC` backward; it is an active component and will burn out.
|
||||
* Do NOT wire the HC-SR04 `ECHO` pin directly to the GD32; it requires a resistor voltage divider. (Though we are considering the VL53L0X I2C ToF instead).
|
||||
* Must use a 100µF capacitor on the NRF24 power lines to prevent brown-outs during PTX bursts.
|
||||
|
|
@ -1,18 +1,16 @@
|
|||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
#include "driver/spi_master.h"
|
||||
#include "driver/gpio.h"
|
||||
#include "driver/pulse_cnt.h"
|
||||
#include "esp_adc/adc_oneshot.h"
|
||||
#include "esp_system.h"
|
||||
#include "esp_log.h"
|
||||
|
||||
// ==========================================
|
||||
// VERIFIED HARDWARE PIN MAPPINGS (ESP32-S3)
|
||||
// VERIFIED HARDWARE PIN MAPPINGS
|
||||
// ==========================================
|
||||
#define PIN_NUM_MOSI 11
|
||||
#define PIN_NUM_MISO 13
|
||||
|
|
@ -25,11 +23,6 @@
|
|||
#define OLED_PIN_DC 9
|
||||
#define OLED_PIN_RES 8
|
||||
|
||||
#define PIN_JOY_VRX 4 // ADC1 Channel 3 (GPIO 4)
|
||||
#define PIN_JOY_VRY 5 // ADC1 Channel 4 (GPIO 5)
|
||||
#define JOY_ADC_CH_X ADC_CHANNEL_3
|
||||
#define JOY_ADC_CH_Y ADC_CHANNEL_4
|
||||
|
||||
#define PIN_ENCODER_CLK 15
|
||||
#define PIN_ENCODER_DT 16
|
||||
#define PIN_ENCODER_SW 17
|
||||
|
|
@ -39,19 +32,9 @@
|
|||
static const char *TAG = "MFC_CORE";
|
||||
spi_device_handle_t oled_spi;
|
||||
spi_device_handle_t nrf_spi;
|
||||
adc_oneshot_unit_handle_t adc1_handle;
|
||||
|
||||
// Global Radio & Calibration State
|
||||
// Global Radio State
|
||||
int current_radio_channel = 76;
|
||||
int joy_center_x = 2048;
|
||||
int joy_center_y = 2048;
|
||||
|
||||
typedef struct __attribute__((packed)) {
|
||||
uint16_t joy_x;
|
||||
uint16_t joy_y;
|
||||
uint8_t flags;
|
||||
uint8_t channel;
|
||||
} rc_packet_t;
|
||||
|
||||
typedef enum {
|
||||
SCREEN_MAIN_MENU = 0,
|
||||
|
|
@ -84,8 +67,8 @@ const uint8_t font_nums[10][5] = {
|
|||
};
|
||||
|
||||
const uint8_t* get_font_data(char c) {
|
||||
static const uint8_t f_spc[5] = {0x00, 0x00, 0x00, 0x00, 0x00};
|
||||
static const uint8_t f_gt[5] = {0x08, 0x04, 0x7E, 0x04, 0x08}; // '>'
|
||||
static const uint8_t f_spc[5] = {0,0,0,0,0};
|
||||
static const uint8_t f_ptr[5] = {0x08, 0x04, 0x7E, 0x04, 0x08}; // '>'
|
||||
static const uint8_t f_lt[5] = {0x08, 0x14, 0x22, 0x41, 0x00}; // '<'
|
||||
static const uint8_t f_lbr[5] = {0x00, 0x7F, 0x41, 0x41, 0x00}; // '['
|
||||
static const uint8_t f_rbr[5] = {0x00, 0x41, 0x41, 0x7F, 0x00}; // ']'
|
||||
|
|
@ -97,9 +80,8 @@ const uint8_t* get_font_data(char c) {
|
|||
static const uint8_t f_dot[5] = {0x00, 0x60, 0x60, 0x00, 0x00}; // '.'
|
||||
|
||||
if (c >= 'A' && c <= 'Z') { return font_AZ[c - 'A']; }
|
||||
if (c >= 'a' && c <= 'z') { return font_AZ[c - 'a']; }
|
||||
if (c >= '0' && c <= '9') { return font_nums[c - '0']; }
|
||||
if (c == '>') { return f_gt; }
|
||||
if (c == '>') { return f_ptr; }
|
||||
if (c == '<') { return f_lt; }
|
||||
if (c == '[') { return f_lbr; }
|
||||
if (c == ']') { return f_rbr; }
|
||||
|
|
@ -129,7 +111,7 @@ void oled_data(uint8_t data) {
|
|||
|
||||
void oled_draw_string(uint8_t page, uint8_t col, const char* str) {
|
||||
oled_cmd(0xB0 + page);
|
||||
uint8_t phys_col = col + 2; // SH1106 132x64 internal RAM 2-px offset
|
||||
uint8_t phys_col = col + 2; // SH1106 center offset
|
||||
oled_cmd(0x00 | (phys_col & 0x0F));
|
||||
oled_cmd(0x10 | ((phys_col >> 4) & 0x0F));
|
||||
while (*str) {
|
||||
|
|
@ -139,128 +121,61 @@ void oled_draw_string(uint8_t page, uint8_t col, const char* str) {
|
|||
}
|
||||
}
|
||||
|
||||
void oled_clear(void) {
|
||||
void oled_clear() {
|
||||
for (uint8_t p = 0; p < 8; p++) {
|
||||
oled_cmd(0xB0 + p); oled_cmd(0x02); oled_cmd(0x10);
|
||||
for (uint8_t c = 0; c < 128; c++) { oled_data(0x00); }
|
||||
}
|
||||
}
|
||||
|
||||
void oled_init(void) {
|
||||
void oled_init() {
|
||||
gpio_set_level(OLED_PIN_RES, 0); vTaskDelay(pdMS_TO_TICKS(50));
|
||||
gpio_set_level(OLED_PIN_RES, 1); vTaskDelay(pdMS_TO_TICKS(50));
|
||||
uint8_t init_cmds[] = {
|
||||
0xAE, 0xD5, 0x80, 0xA8, 0x3F, 0xD3, 0x00, 0x40,
|
||||
0x8D, 0x14, 0xA1, 0xC8, 0xDA, 0x12, 0x81, 0xCF,
|
||||
0xD9, 0xF1, 0xDB, 0x40, 0xA4, 0xA6, 0xAF
|
||||
};
|
||||
for (size_t i = 0; i < sizeof(init_cmds); i++) { oled_cmd(init_cmds[i]); }
|
||||
uint8_t init_cmds[] = {0xAE,0xD5,0x80,0xA8,0x3F,0xD3,0x00,0x40,0x8D,0x14,0xA1,0xC8,0xDA,0x12,0x81,0xCF,0xD9,0xF1,0xDB,0x40,0xA4,0xA6,0xAF};
|
||||
for(int i = 0; i < sizeof(init_cmds); i++) { oled_cmd(init_cmds[i]); }
|
||||
}
|
||||
|
||||
static void nrf_write_reg(uint8_t reg, uint8_t val) {
|
||||
uint8_t tx[2] = { (uint8_t)(0x20 | (reg & 0x1F)), val };
|
||||
spi_transaction_t t = { .length = 16, .tx_buffer = tx };
|
||||
spi_device_polling_transmit(nrf_spi, &t);
|
||||
}
|
||||
|
||||
bool nrf_check_connection(void) {
|
||||
uint8_t tx[2] = { 0x03, 0xFF }; // Read SETUP_AW register (0x03)
|
||||
bool nrf_check_connection() {
|
||||
uint8_t tx[2] = { 0x03, 0xFF };
|
||||
uint8_t rx[2] = { 0 };
|
||||
spi_transaction_t t = { .length = 16, .tx_buffer = tx, .rx_buffer = rx };
|
||||
spi_device_polling_transmit(nrf_spi, &t);
|
||||
return (rx[1] >= 0x01 && rx[1] <= 0x03);
|
||||
return (rx[1] == 0x03);
|
||||
}
|
||||
|
||||
void set_nrf_channel(uint8_t channel) {
|
||||
nrf_write_reg(0x05, channel); // Write RF_CH register (0x05)
|
||||
}
|
||||
|
||||
void nrf_init_tx(uint8_t channel) {
|
||||
gpio_set_level(NRF_PIN_CE, 0);
|
||||
nrf_write_reg(0x00, 0x0E); // CONFIG: PWR_UP, EN_CRC (2-byte), PTX mode
|
||||
nrf_write_reg(0x01, 0x00); // EN_AA: Disable auto-ack for low-latency broadcast
|
||||
nrf_write_reg(0x02, 0x01); // EN_RXADDR: Pipe 0
|
||||
nrf_write_reg(0x03, 0x03); // SETUP_AW: 5-byte address width
|
||||
nrf_write_reg(0x04, 0x00); // SETUP_RETR: Retransmit disabled
|
||||
nrf_write_reg(0x05, channel); // RF_CH: Set active 2.4 GHz channel
|
||||
nrf_write_reg(0x06, 0x06); // RF_SETUP: 1 Mbps, 0 dBm
|
||||
nrf_write_reg(0x07, 0x70); // STATUS: Clear IRQ flags
|
||||
}
|
||||
|
||||
void nrf_send_packet(const rc_packet_t *pkt) {
|
||||
uint8_t flush_cmd = 0xE1; // FLUSH_TX
|
||||
spi_transaction_t tf = { .length = 8, .tx_buffer = &flush_cmd };
|
||||
spi_device_polling_transmit(nrf_spi, &tf);
|
||||
|
||||
uint8_t tx_buf[1 + sizeof(rc_packet_t)];
|
||||
tx_buf[0] = 0xA0; // W_TX_PAYLOAD
|
||||
memcpy(&tx_buf[1], pkt, sizeof(rc_packet_t));
|
||||
spi_transaction_t tp = { .length = (1 + sizeof(rc_packet_t)) * 8, .tx_buffer = tx_buf };
|
||||
spi_device_polling_transmit(nrf_spi, &tp);
|
||||
|
||||
gpio_set_level(NRF_PIN_CE, 1);
|
||||
esp_rom_delay_us(15);
|
||||
gpio_set_level(NRF_PIN_CE, 0);
|
||||
}
|
||||
|
||||
static void read_joystick(int *raw_x, int *raw_y) {
|
||||
if (adc_oneshot_read(adc1_handle, JOY_ADC_CH_X, raw_x) != ESP_OK) { *raw_x = 0; }
|
||||
if (adc_oneshot_read(adc1_handle, JOY_ADC_CH_Y, raw_y) != ESP_OK) { *raw_y = 0; }
|
||||
uint8_t tx[2] = { 0x25, channel }; // Write to RF_CH register (0x05)
|
||||
spi_transaction_t t = { .length = 16, .tx_buffer = tx };
|
||||
spi_device_polling_transmit(nrf_spi, &t);
|
||||
}
|
||||
|
||||
// ==========================================
|
||||
// UI SCREEN RENDERING
|
||||
// ==========================================
|
||||
void draw_menu(int selected_index) {
|
||||
const char* items[] = {"DRIVE VEHICLE", "RADIO CONFIG", "CALIBRATE", "SYSTEM INFO"};
|
||||
char* items[] = {"DRIVE VEHICLE", "RADIO CONFIG", "CALIBRATE", "SYSTEM INFO"};
|
||||
char buffer[32];
|
||||
|
||||
oled_draw_string(0, 20, "- MAIN MENU -");
|
||||
|
||||
for (int i = 0; i < NUM_MENU_ITEMS; i++) {
|
||||
if (i == selected_index) {
|
||||
snprintf(buffer, sizeof(buffer), "> %-14s", items[i]);
|
||||
sprintf(buffer, "> %-14s", items[i]);
|
||||
} else {
|
||||
snprintf(buffer, sizeof(buffer), " %-14s", items[i]);
|
||||
sprintf(buffer, " %-14s", items[i]);
|
||||
}
|
||||
oled_draw_string(2 + (i * 2), 5, buffer);
|
||||
}
|
||||
}
|
||||
|
||||
void draw_drive_screen(int raw_x, int raw_y, int channel) {
|
||||
char buffer[32];
|
||||
oled_draw_string(0, 10, "- DRIVE VEHICLE -");
|
||||
|
||||
snprintf(buffer, sizeof(buffer), "VRX: %-4d VRY: %-4d", raw_x, raw_y);
|
||||
oled_draw_string(2, 2, buffer);
|
||||
|
||||
snprintf(buffer, sizeof(buffer), "TX CH: %03d [ACTIVE]", channel);
|
||||
oled_draw_string(4, 2, buffer);
|
||||
|
||||
oled_draw_string(6, 10, "[CLICK TO BACK]");
|
||||
}
|
||||
|
||||
void draw_calibrate_screen(int raw_x, int raw_y) {
|
||||
char buffer[32];
|
||||
oled_draw_string(0, 10, "- CALIBRATION -");
|
||||
|
||||
snprintf(buffer, sizeof(buffer), "CUR: %04d / %04d", raw_x, raw_y);
|
||||
oled_draw_string(2, 2, buffer);
|
||||
|
||||
snprintf(buffer, sizeof(buffer), "CTR: %04d / %04d", joy_center_x, joy_center_y);
|
||||
oled_draw_string(4, 2, buffer);
|
||||
|
||||
oled_draw_string(6, 5, "[CLICK SET CTR]");
|
||||
}
|
||||
|
||||
void draw_system_info(void) {
|
||||
void draw_system_info() {
|
||||
char buffer[32];
|
||||
oled_draw_string(0, 15, "- SYSTEM INFO -");
|
||||
|
||||
snprintf(buffer, sizeof(buffer), "CHIP: ESP32-S3");
|
||||
sprintf(buffer, "CHIP: ESP32-S3");
|
||||
oled_draw_string(2, 5, buffer);
|
||||
|
||||
snprintf(buffer, sizeof(buffer), "HEAP: %lu KB", (unsigned long)(esp_get_free_heap_size() / 1024));
|
||||
sprintf(buffer, "HEAP: %lu KB", (unsigned long)(esp_get_free_heap_size() / 1024));
|
||||
oled_draw_string(4, 5, buffer);
|
||||
|
||||
oled_draw_string(6, 10, "[CLICK TO BACK]");
|
||||
|
|
@ -271,7 +186,7 @@ void draw_radio_config_screen(int channel) {
|
|||
oled_draw_string(0, 5, "- RADIO CONFIG -");
|
||||
|
||||
if (nrf_check_connection()) {
|
||||
snprintf(buffer, sizeof(buffer), "CH: <%03d> (2.4G)", channel);
|
||||
sprintf(buffer, "CH: <%03d> (2.4G)", channel);
|
||||
oled_draw_string(2, 2, buffer);
|
||||
oled_draw_string(4, 2, "TURN DIAL TO TUNE");
|
||||
} else {
|
||||
|
|
@ -282,11 +197,17 @@ void draw_radio_config_screen(int channel) {
|
|||
oled_draw_string(6, 5, "[CLICK TO SAVE]");
|
||||
}
|
||||
|
||||
void draw_placeholder_screen(const char* title) {
|
||||
oled_draw_string(0, 15, title);
|
||||
oled_draw_string(3, 20, "NOT CONNECTED");
|
||||
oled_draw_string(6, 10, "[CLICK TO BACK]");
|
||||
}
|
||||
|
||||
// ==========================================
|
||||
// MAIN APPLICATION ENTRY
|
||||
// ==========================================
|
||||
void app_main(void) {
|
||||
// 1. Initialize Shared SPI2_HOST Bus (FSPI)
|
||||
// 1. Initialize Shared SPI Bus
|
||||
spi_bus_config_t buscfg = {
|
||||
.miso_io_num = PIN_NUM_MISO,
|
||||
.mosi_io_num = PIN_NUM_MOSI,
|
||||
|
|
@ -295,50 +216,32 @@ void app_main(void) {
|
|||
.quadhd_io_num = -1,
|
||||
.max_transfer_sz = 4096
|
||||
};
|
||||
ESP_ERROR_CHECK(spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO));
|
||||
spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO);
|
||||
|
||||
// 2. Attach 1.3" SH1106 OLED Display (10 MHz SPI)
|
||||
// 2. Add OLED Device
|
||||
spi_device_interface_config_t oled_cfg = {
|
||||
.clock_speed_hz = 10 * 1000 * 1000,
|
||||
.mode = 0,
|
||||
.spics_io_num = OLED_PIN_CS,
|
||||
.queue_size = 1
|
||||
};
|
||||
ESP_ERROR_CHECK(spi_bus_add_device(SPI2_HOST, &oled_cfg, &oled_spi));
|
||||
gpio_reset_pin(OLED_PIN_DC); gpio_set_direction(OLED_PIN_DC, GPIO_MODE_OUTPUT);
|
||||
spi_bus_add_device(SPI2_HOST, &oled_cfg, &oled_spi);
|
||||
gpio_reset_pin(OLED_PIN_DC); gpio_set_direction(OLED_PIN_DC, GPIO_MODE_OUTPUT);
|
||||
gpio_reset_pin(OLED_PIN_RES); gpio_set_direction(OLED_PIN_RES, GPIO_MODE_OUTPUT);
|
||||
|
||||
oled_init();
|
||||
oled_clear();
|
||||
|
||||
// 3. Attach nRF24L01+ Radio Module (1 MHz SPI)
|
||||
gpio_reset_pin(NRF_PIN_CE);
|
||||
gpio_set_direction(NRF_PIN_CE, GPIO_MODE_OUTPUT);
|
||||
gpio_set_level(NRF_PIN_CE, 0);
|
||||
|
||||
// 3. Add NRF24 Device
|
||||
spi_device_interface_config_t nrf_cfg = {
|
||||
.clock_speed_hz = 1 * 1000 * 1000,
|
||||
.mode = 0,
|
||||
.spics_io_num = NRF_PIN_CS,
|
||||
.queue_size = 1
|
||||
};
|
||||
ESP_ERROR_CHECK(spi_bus_add_device(SPI2_HOST, &nrf_cfg, &nrf_spi));
|
||||
nrf_init_tx((uint8_t)current_radio_channel);
|
||||
spi_bus_add_device(SPI2_HOST, &nrf_cfg, &nrf_spi);
|
||||
|
||||
// 4. Initialize One-Shot ADC1 for Hall-Effect / Analog Joystick (GPIO 4 & GPIO 5)
|
||||
adc_oneshot_unit_init_cfg_t init_config1 = {
|
||||
.unit_id = ADC_UNIT_1,
|
||||
};
|
||||
ESP_ERROR_CHECK(adc_oneshot_new_unit(&init_config1, &adc1_handle));
|
||||
|
||||
adc_oneshot_chan_cfg_t adc_cfg = {
|
||||
.bitwidth = ADC_BITWIDTH_DEFAULT,
|
||||
.atten = ADC_ATTEN_DB_12,
|
||||
};
|
||||
ESP_ERROR_CHECK(adc_oneshot_config_channel(adc1_handle, JOY_ADC_CH_X, &adc_cfg));
|
||||
ESP_ERROR_CHECK(adc_oneshot_config_channel(adc1_handle, JOY_ADC_CH_Y, &adc_cfg));
|
||||
|
||||
// 5. Initialize Rotary Encoder Push Switch (GPIO 17)
|
||||
// 4. Init Rotary Encoder Switch
|
||||
gpio_config_t sw_cfg = {
|
||||
.pin_bit_mask = (1ULL << PIN_ENCODER_SW),
|
||||
.mode = GPIO_MODE_INPUT,
|
||||
|
|
@ -348,32 +251,32 @@ void app_main(void) {
|
|||
};
|
||||
gpio_config(&sw_cfg);
|
||||
|
||||
// 6. Initialize PCNT Hardware Quadrature Decoder (GPIO 15 & GPIO 16)
|
||||
// 5. Init PCNT Hardware Decoder for Quadrature Encoder
|
||||
pcnt_unit_handle_t pcnt_unit = NULL;
|
||||
pcnt_unit_config_t unit_config = { .high_limit = 10000, .low_limit = -10000 };
|
||||
ESP_ERROR_CHECK(pcnt_new_unit(&unit_config, &pcnt_unit));
|
||||
pcnt_new_unit(&unit_config, &pcnt_unit);
|
||||
|
||||
pcnt_glitch_filter_config_t filter_config = { .max_glitch_ns = 1000 };
|
||||
ESP_ERROR_CHECK(pcnt_unit_set_glitch_filter(pcnt_unit, &filter_config));
|
||||
pcnt_unit_set_glitch_filter(pcnt_unit, &filter_config);
|
||||
|
||||
pcnt_channel_handle_t pcnt_chan_a = NULL, pcnt_chan_b = NULL;
|
||||
pcnt_chan_config_t chan_a_config = { .edge_gpio_num = PIN_ENCODER_CLK, .level_gpio_num = PIN_ENCODER_DT };
|
||||
ESP_ERROR_CHECK(pcnt_new_channel(pcnt_unit, &chan_a_config, &pcnt_chan_a));
|
||||
pcnt_new_channel(pcnt_unit, &chan_a_config, &pcnt_chan_a);
|
||||
pcnt_chan_config_t chan_b_config = { .edge_gpio_num = PIN_ENCODER_DT, .level_gpio_num = PIN_ENCODER_CLK };
|
||||
ESP_ERROR_CHECK(pcnt_new_channel(pcnt_unit, &chan_b_config, &pcnt_chan_b));
|
||||
pcnt_new_channel(pcnt_unit, &chan_b_config, &pcnt_chan_b);
|
||||
|
||||
ESP_ERROR_CHECK(pcnt_channel_set_edge_action(pcnt_chan_a, PCNT_CHANNEL_EDGE_ACTION_DECREASE, PCNT_CHANNEL_EDGE_ACTION_INCREASE));
|
||||
ESP_ERROR_CHECK(pcnt_channel_set_level_action(pcnt_chan_a, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_INVERSE));
|
||||
ESP_ERROR_CHECK(pcnt_channel_set_edge_action(pcnt_chan_b, PCNT_CHANNEL_EDGE_ACTION_INCREASE, PCNT_CHANNEL_EDGE_ACTION_DECREASE));
|
||||
ESP_ERROR_CHECK(pcnt_channel_set_level_action(pcnt_chan_b, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_INVERSE));
|
||||
pcnt_channel_set_edge_action(pcnt_chan_a, PCNT_CHANNEL_EDGE_ACTION_DECREASE, PCNT_CHANNEL_EDGE_ACTION_INCREASE);
|
||||
pcnt_channel_set_level_action(pcnt_chan_a, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_INVERSE);
|
||||
pcnt_channel_set_edge_action(pcnt_chan_b, PCNT_CHANNEL_EDGE_ACTION_INCREASE, PCNT_CHANNEL_EDGE_ACTION_DECREASE);
|
||||
pcnt_channel_set_level_action(pcnt_chan_b, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_INVERSE);
|
||||
|
||||
ESP_ERROR_CHECK(pcnt_unit_enable(pcnt_unit));
|
||||
ESP_ERROR_CHECK(pcnt_unit_clear_count(pcnt_unit));
|
||||
ESP_ERROR_CHECK(pcnt_unit_start(pcnt_unit));
|
||||
pcnt_unit_enable(pcnt_unit);
|
||||
pcnt_unit_clear_count(pcnt_unit);
|
||||
pcnt_unit_start(pcnt_unit);
|
||||
|
||||
ESP_LOGI(TAG, "MFC Multi-Tasking OS State Machine Online (ESP32-S3).");
|
||||
ESP_LOGI(TAG, "MFC Multi-Tasking OS State Machine Online.");
|
||||
|
||||
// 7. Master UI & Telemetry Loop
|
||||
// 6. Master UI State Machine Loop
|
||||
int count = 0;
|
||||
int last_menu_index = -1;
|
||||
int last_sw_state = 1;
|
||||
|
|
@ -414,7 +317,8 @@ void app_main(void) {
|
|||
last_button_press = xTaskGetTickCount();
|
||||
}
|
||||
}
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
// Sub-screen handling
|
||||
if (current_screen == SCREEN_RADIO_CONFIG) {
|
||||
int encoder_delta = (count - radio_start_count) / 4;
|
||||
|
|
@ -425,53 +329,31 @@ void app_main(void) {
|
|||
|
||||
if (target_channel != last_tuned_channel || screen_needs_redraw) {
|
||||
current_radio_channel = target_channel;
|
||||
set_nrf_channel((uint8_t)current_radio_channel);
|
||||
set_nrf_channel(current_radio_channel);
|
||||
|
||||
oled_clear();
|
||||
draw_radio_config_screen(current_radio_channel);
|
||||
last_tuned_channel = target_channel;
|
||||
screen_needs_redraw = false;
|
||||
}
|
||||
} else if (current_screen == SCREEN_DRIVE) {
|
||||
int raw_x = 0, raw_y = 0;
|
||||
read_joystick(&raw_x, &raw_y);
|
||||
|
||||
rc_packet_t pkt = {
|
||||
.joy_x = (uint16_t)raw_x,
|
||||
.joy_y = (uint16_t)raw_y,
|
||||
.flags = 0x01,
|
||||
.channel = (uint8_t)current_radio_channel
|
||||
};
|
||||
nrf_send_packet(&pkt);
|
||||
|
||||
}
|
||||
else {
|
||||
if (screen_needs_redraw) {
|
||||
oled_clear();
|
||||
screen_needs_redraw = false;
|
||||
}
|
||||
draw_drive_screen(raw_x, raw_y, current_radio_channel);
|
||||
} else if (current_screen == SCREEN_CALIBRATE) {
|
||||
int raw_x = 0, raw_y = 0;
|
||||
read_joystick(&raw_x, &raw_y);
|
||||
|
||||
if (screen_needs_redraw) {
|
||||
oled_clear();
|
||||
screen_needs_redraw = false;
|
||||
}
|
||||
draw_calibrate_screen(raw_x, raw_y);
|
||||
} else if (current_screen == SCREEN_SYSTEM_INFO) {
|
||||
if (screen_needs_redraw) {
|
||||
oled_clear();
|
||||
draw_system_info();
|
||||
if (current_screen == SCREEN_SYSTEM_INFO) {
|
||||
draw_system_info();
|
||||
} else if (current_screen == SCREEN_DRIVE) {
|
||||
draw_placeholder_screen("- DRIVE VEHICLE -");
|
||||
} else if (current_screen == SCREEN_CALIBRATE) {
|
||||
draw_placeholder_screen("- CALIBRATION -");
|
||||
}
|
||||
screen_needs_redraw = false;
|
||||
}
|
||||
}
|
||||
|
||||
// Click to return to Main Menu (and save calibration if in CALIBRATE) with 300ms Debounce
|
||||
// Click to return to Main Menu with 300ms Debounce
|
||||
if (sw_state == 0 && last_sw_state == 1) {
|
||||
if ((xTaskGetTickCount() - last_button_press) > pdMS_TO_TICKS(300)) {
|
||||
if (current_screen == SCREEN_CALIBRATE) {
|
||||
read_joystick(&joy_center_x, &joy_center_y);
|
||||
}
|
||||
current_screen = SCREEN_MAIN_MENU;
|
||||
screen_needs_redraw = true;
|
||||
last_button_press = xTaskGetTickCount();
|
||||
|
|
|
|||
Loading…
Reference in a new issue