Compare commits
24 Commits
debug
...
e525dba0c4
| Author | SHA1 | Date | |
|---|---|---|---|
| e525dba0c4 | |||
| 1b699352ce | |||
| c32d208854 | |||
| db05bc0864 | |||
| 5f73e75f5b | |||
| 5656986768 | |||
| aa029587a4 | |||
| abbbd16b5c | |||
| e63867ba5e | |||
| 8bdae1da9b | |||
| 361cf52252 | |||
| 2d63ec6006 | |||
| 511ee05712 | |||
| 03ab8604ba | |||
| edb973bb61 | |||
|
bffcf62cae
|
|||
| 27597bceab | |||
| 016de2ccb4 | |||
| 15257ae6f2 | |||
|
795eb0ecf3
|
|||
|
558c5b18c2
|
|||
|
fa66dd70d4
|
|||
|
b14bdf7fc3
|
|||
|
427dde8c72
|
1
.gitignore
vendored
1
.gitignore
vendored
@@ -32,3 +32,4 @@
|
||||
*.out
|
||||
*.app
|
||||
|
||||
.codex
|
||||
|
||||
10
CLAUDE.md
10
CLAUDE.md
@@ -6,6 +6,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
|
||||
Main firmware lives in `Gaugecontroller/Gaugecontroller.ino`. Requires the **FastLED** library (`arduino-cli lib install FastLED`). Use the Arduino IDE or `arduino-cli`:
|
||||
|
||||
The ESP32 bridge runs ESPHome; the config is in `gaugecontroller.yaml`.
|
||||
|
||||
```bash
|
||||
# Compile (replace board/port as needed)
|
||||
arduino-cli compile --fqbn arduino:avr:mega Gaugecontroller
|
||||
@@ -58,7 +60,7 @@ The sketch controls `GAUGE_COUNT` stepper-motor gauges using a trapezoidal veloc
|
||||
|
||||
### Key data structures
|
||||
|
||||
- `GaugePins` — hardware pin mapping per gauge (dir, step, enable, active-high/low polarity flags, `ledCount`). Declared `constexpr` so `TOTAL_LEDS` can be computed from it at compile time. Configured in the `gaugePins[]` array at the top.
|
||||
- `GaugePins` — hardware pin mapping per gauge (dir, step, enable, active-high/low polarity flags, `ledOrder` string). Declared `constexpr` so `TOTAL_LEDS` can be computed from it at compile time. Configured in the `gaugePins[]` array at the top.
|
||||
- `Gauge` — per-gauge runtime state: position, target, velocity, accel, homing state machine, sweep mode.
|
||||
|
||||
### Motion control (`updateGauge`)
|
||||
@@ -76,7 +78,7 @@ When `sweepEnabled`, `updateSweepTarget` bounces `targetPos` between `minPos` an
|
||||
|
||||
### LED strip
|
||||
|
||||
One shared WS2812B strip is driven from `LED_DATA_PIN` (currently 22). Each gauge owns a contiguous segment of the strip; `gaugePins[i].ledCount` sets the segment length (0 = no LEDs). `TOTAL_LEDS` is computed at compile time via `constexpr sumLedCounts()` — no manual constant to keep in sync. Per-gauge offsets into the flat `leds[]` array are computed once in `setup()` into `gaugeLedOffset[]`. LED commands and effects mark the strip dirty, and `FastLED.show()` is called once per main-loop iteration if anything changed.
|
||||
Two LED strips are driven: main backlight/status LEDs on `LED_DATA_PIN` (currently 22) and dial indicator LEDs on `INDICATOR_LED_DATA_PIN` (currently 36). The serial protocol still exposes one logical per-gauge LED segment: `0-2` backlight, `3-4` indicators, `5-6` status. `gaugePins[i].ledOrder` is a per-LED type string (one char per LED, `'G'` = GRB-ordered, `'R'` = RGB-ordered) and its length defines the logical LED count. `TOTAL_LEDS`, `TOTAL_MAIN_LEDS`, and `TOTAL_INDICATOR_LEDS` are computed at compile time. Per-gauge logical and physical offsets are cached in `setup()`. LED writes dirty only their physical strip, and the loop flushes each FastLED controller independently with `showLeds()`.
|
||||
|
||||
### Serial command protocol
|
||||
|
||||
@@ -104,6 +106,6 @@ All commands reply `OK` or `ERR BAD_ID` / `ERR BAD_CMD` etc.
|
||||
### Adding gauges
|
||||
|
||||
1. Increment `GAUGE_COUNT`.
|
||||
2. Add a `constexpr GaugePins` entry to `gaugePins[]` (including `ledCount`).
|
||||
2. Add a `constexpr GaugePins` entry to `gaugePins[]` (including the `ledOrder` string — one char per LED, `'G'` for GRB or `'R'` for RGB).
|
||||
3. Tune `maxPos` and `homingBackoffSteps` in the corresponding `Gauge` default or at runtime.
|
||||
4. `TOTAL_LEDS` and `gaugeLedOffset[]` update automatically — no manual changes needed.
|
||||
4. `TOTAL_LEDS`, `gaugeLedOffset[]`, and `gaugeLedCount[]` update automatically — no manual changes needed.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
1270
Gaugecontroller_WithLeds/Gaugecontroller.ino
Normal file
1270
Gaugecontroller_WithLeds/Gaugecontroller.ino
Normal file
File diff suppressed because it is too large
Load Diff
1301
Gaugecontroller_no_VFD/Gaugecontroller_no_VFD.ino
Normal file
1301
Gaugecontroller_no_VFD/Gaugecontroller_no_VFD.ino
Normal file
File diff suppressed because it is too large
Load Diff
2395
Gaugecontroller_no_VFD/esp-home_no_VFD.yaml
Normal file
2395
Gaugecontroller_no_VFD/esp-home_no_VFD.yaml
Normal file
File diff suppressed because it is too large
Load Diff
52
README.md
52
README.md
@@ -7,7 +7,7 @@ A dedicated gauge controller for Arduinos.
|
||||
This repository contains:
|
||||
|
||||
- `Gaugecontroller/Gaugecontroller.ino`: the Arduino Mega firmware for the stepper gauges, LEDs, and integrated HV5812-based VFD
|
||||
- `gauge.py`: the ESP32 / MicroPython MQTT bridge that exposes the controller to Home Assistant
|
||||
- `gaugecontroller.yaml`: the ESPHome-based ESP32 firmware that exposes the gauges and VFD to Home Assistant via the native API
|
||||
|
||||
## VFD Support
|
||||
|
||||
@@ -48,16 +48,19 @@ Rules:
|
||||
- shorter values are right-aligned
|
||||
- leading zeroes are preserved if they are part of the input
|
||||
|
||||
## Home Assistant Entities
|
||||
## Home Assistant Integration
|
||||
|
||||
The MQTT bridge publishes Home Assistant discovery entities for the VFD:
|
||||
The ESPHome firmware in `gaugecontroller.yaml` exposes entities to Home Assistant via the native API:
|
||||
|
||||
- `VFD Display`
|
||||
text entity for the displayed value
|
||||
- `VFD Decimal Point`
|
||||
switch entity
|
||||
- `VFD Alarm`
|
||||
switch entity
|
||||
### Gauge Controls
|
||||
- Number entities for each gauge's target value (with unit conversion)
|
||||
- Number entities for speed and acceleration (diagnostic)
|
||||
- Rezero buttons for each gauge and all gauges
|
||||
|
||||
### VFD Display
|
||||
- `VFD Display`: text entity for the displayed value
|
||||
- `VFD Decimal Point`: switch entity
|
||||
- `VFD Alarm`: switch entity
|
||||
|
||||
The display is intentionally exposed as a text entity rather than a numeric entity so that:
|
||||
|
||||
@@ -65,27 +68,12 @@ The display is intentionally exposed as a text entity rather than a numeric enti
|
||||
- hexadecimal values like `DEAD` or `BEEF` work
|
||||
- clearing the display is possible with an empty value
|
||||
|
||||
## MQTT Topics
|
||||
### LED Controls
|
||||
- RGB light entity for each gauge's backlight with effects (Blink, Breathe, Double Flash)
|
||||
- Binary light entities for each gauge's red/green indicators and status lights
|
||||
|
||||
Using the configured `mqtt_prefix` from `config.json`, the VFD topics are:
|
||||
|
||||
- `<prefix>/vfd/set`
|
||||
- `<prefix>/vfd/state`
|
||||
- `<prefix>/vfd/decimal_point/set`
|
||||
- `<prefix>/vfd/decimal_point/state`
|
||||
- `<prefix>/vfd/alarm/set`
|
||||
- `<prefix>/vfd/alarm/state`
|
||||
|
||||
Example with the default prefix `gauges`:
|
||||
|
||||
- `gauges/vfd/set`
|
||||
- `gauges/vfd/decimal_point/set`
|
||||
- `gauges/vfd/alarm/set`
|
||||
|
||||
Example payloads:
|
||||
|
||||
- publish `0123` to `gauges/vfd/set`
|
||||
- publish `ON` to `gauges/vfd/decimal_point/set`
|
||||
- publish `OFF` to `gauges/vfd/alarm/set`
|
||||
|
||||
The MQTT bridge then converts that into the correct Arduino serial command such as `VFD 0123.`.
|
||||
### Diagnostics
|
||||
- WiFi signal sensor
|
||||
- Uptime sensor
|
||||
- IP address and SSID text sensors
|
||||
- Arduino Last Message sensor
|
||||
|
||||
@@ -183,13 +183,14 @@ Then connect the motor side of that driver to:
|
||||
|
||||
according to the driver board you are using.
|
||||
|
||||
## 14. Wire The WS2812B LEDs
|
||||
## 14. Wire The WS2812 LEDs
|
||||
|
||||
Connect:
|
||||
|
||||
- `Mega D22` -> `WS2812B DIN`
|
||||
- `5V LED supply` -> `WS2812B 5V`
|
||||
- `WS2812B GND` -> common ground rail
|
||||
- `Mega D22` -> main backlight/status strip `DIN`
|
||||
- `Mega D36` -> indicator strip `DIN`
|
||||
- `5V LED supply` -> both strip `5V` inputs
|
||||
- both strip `GND` inputs -> common ground rail
|
||||
|
||||
If the LED chain is long or bright:
|
||||
|
||||
|
||||
@@ -205,9 +205,10 @@ If `D8` and `D9` come from separate fly wires to the stripboard, keep them in th
|
||||
|
||||
Route:
|
||||
|
||||
- `D22` -> `WS2812 DIN`
|
||||
- `5V` -> `WS2812 5V`
|
||||
- `GND` -> `WS2812 GND`
|
||||
- `D22` -> main backlight/status strip `DIN`
|
||||
- `D36` -> indicator strip `DIN`
|
||||
- `5V` -> both strip `5V` inputs
|
||||
- `GND` -> both strip `GND` inputs
|
||||
|
||||
Keep the LED connector in the low-voltage area.
|
||||
|
||||
|
||||
46
changes.md
Normal file
46
changes.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Changes
|
||||
|
||||
## 2026-04-27 — Arduino firmware refactor (`Gaugecontroller/Gaugecontroller.ino`)
|
||||
|
||||
### Non-blocking VFD multiplexer
|
||||
`vfd::refresh()` previously held each digit for 2000 µs via `delayMicroseconds`,
|
||||
which capped the effective stepper pulse rate at roughly 500 Hz regardless of
|
||||
`maxSpeed`. It now tracks `phaseStartMicros`/`phaseActive` and returns
|
||||
immediately while the digit is still being held; the main loop runs at
|
||||
microsecond cadence again and the configured `maxSpeed = 4000.0f` steps/s is
|
||||
actually achievable.
|
||||
|
||||
### Fixed-buffer command parser (no more `String` heap churn)
|
||||
Replaced `String rxLine` with `char rxBuf[128]` and converted the entire
|
||||
command pipeline to take `const char*`:
|
||||
|
||||
- `processLine`, `sendReply`, `vfd::parseCommand`
|
||||
- All `parse*` functions: `parseSet`, `parseSpeed`, `parseAccel`, `parseEnable`,
|
||||
`parseZero`, `parseHome`, `parseSweep`, `parsePosQuery`, `parseCfgQuery`,
|
||||
`parseLedQuery`, `parseLed`, `parseBlink`, `parseBreathe`, `parseDflash`,
|
||||
`parseVfd`, `parsePing`.
|
||||
|
||||
`parseSpeed` / `parseAccel` / `parseSweep` use `strncmp` + `atof` because the
|
||||
default AVR-libc `sscanf` doesn't support `%f`. No allocations on the command
|
||||
path; the Mega's heap no longer fragments over time.
|
||||
|
||||
### Cached `ledNeedsSwap[TOTAL_LEDS]`
|
||||
Per-LED RGB-vs-GRB swap flag is now precomputed once in `setup()` from
|
||||
`gaugePins[].ledOrder`. `encodeForStrip` is a single array index instead of
|
||||
walking the gauge table on every LED read/write.
|
||||
|
||||
### Cached step direction per gauge
|
||||
Added `Gauge.lastDir`. `setDir()` skips the DIR-pin `digitalWrite` when the
|
||||
direction hasn't flipped (the common case during a step run) and adds a 1 µs
|
||||
DIR-to-STEP setup delay only when it actually flips.
|
||||
|
||||
### Cleanups
|
||||
- Removed the `absf` helper; use `fabsf` consistently.
|
||||
- Removed the `+ 0.0001f` epsilon in the trapezoidal braking-distance divisor.
|
||||
`parseAccel` already rejects `accel <= 0`, so the divisor is always positive.
|
||||
- Fixed the `<r> <ig> <b>` typo to `<r> <g> <b>` in the protocol comment for
|
||||
`DFLASH`.
|
||||
|
||||
### Build verification
|
||||
`arduino-cli compile --fqbn arduino:avr:mega Gaugecontroller`:
|
||||
17758 B flash (6%), 1845 B SRAM (22%).
|
||||
2394
gaugecontroller.yaml
Normal file
2394
gaugecontroller.yaml
Normal file
File diff suppressed because it is too large
Load Diff
17
wiring.md
17
wiring.md
@@ -163,19 +163,22 @@ Also connect:
|
||||
|
||||
If your driver boards need separate motor power, supply that from the proper motor supply. Do not power motors from the Mega `5V` pin.
|
||||
|
||||
## WS2812B LED Strip
|
||||
## WS2812 LED Strips
|
||||
|
||||
The current sketch expects one shared WS2812B chain.
|
||||
The current sketch expects two LED data chains. Backlight and status LEDs stay
|
||||
on the main strip; the red/green dial indicator LEDs are on their own strip.
|
||||
|
||||
| Mega Pin | WS2812B |
|
||||
| Mega Pin | LED Strip |
|
||||
|---|---|
|
||||
| `D22` | `DIN` |
|
||||
| `5V` | `5V` |
|
||||
| `GND` | `GND` |
|
||||
| `D22` | main backlight/status `DIN` |
|
||||
| `D36` | indicator `DIN` |
|
||||
| `5V` | both strips `5V` |
|
||||
| `GND` | both strips `GND` |
|
||||
|
||||
Notes:
|
||||
|
||||
- the code expects `7 LEDs per gauge`, so `21 LEDs total`
|
||||
- the command protocol still exposes `7 LEDs per gauge`
|
||||
- logical indices `0-2` are backlight, `3-4` are indicators, and `5-6` are status
|
||||
- use a proper 5V supply sized for the LED current
|
||||
- keep LED ground common with the Mega
|
||||
|
||||
|
||||
Reference in New Issue
Block a user