Skip to content

v1.9.7 - Build Flag Naming Refactor (2025-11-30)

What Changed?

This release renames three build flags for improved clarity and consistency. The changes are purely cosmetic—no firmware functionality is affected. Users working with custom build flags or scripts will need to update their configurations.

What's New

Build Flag Naming Improvements

What changed:

Three build flags have been renamed to improve user understanding and align with internal naming conventions:

Old Name New Name Reason
ADC_DEPEND_CHANNEL ADC_JUMPER_CHANNEL Clarifies that this reflects the hardware jumper position
ENABLE_FREERTOS_QUEUE ENABLE_QUEUE Hides FreeRTOS implementation detail; exposes only the feature
ENABLE_TEXT_PROTOCOL ENABLE_TEXT_COMMAND Aligns with module naming (text_command.h/cpp)

How to update:

If you use custom build flags in your workflow, update them to the new names:

# Old (no longer works)
PLATFORMIO_BUILD_FLAGS="-DADC_DEPEND_CHANNEL=2" pio run -t upload

# New
PLATFORMIO_BUILD_FLAGS="-DADC_JUMPER_CHANNEL=2" pio run -t upload

Code example (changes in platformio.ini):

; Before
build_flags =
    -DADC_DEPEND_CHANNEL=1
    -DENABLE_FREERTOS_QUEUE=0
    -DENABLE_TEXT_PROTOCOL=0

; After
build_flags =
    -DADC_JUMPER_CHANNEL=1
    -DENABLE_QUEUE=0
    -DENABLE_TEXT_COMMAND=0

Installation

Quick Start

# Get the release
git checkout v1.9.7

# Build
task build

# Upload
task upload

# Check it works
task monitor

What's Different from the Last Version?

✅ Added

  • Improved build flag naming for better user experience
  • Enhanced documentation for all renamed flags

🔧 Changed

  • ADC_DEPEND_CHANNEL → ADC_JUMPER_CHANNEL (all build profiles)
  • ENABLE_FREERTOS_QUEUE → ENABLE_QUEUE (all build profiles)
  • ENABLE_TEXT_PROTOCOL → ENABLE_TEXT_COMMAND (all build profiles)
  • Updated CLAUDE.md with new flag names and examples
  • Updated hardware documentation for ADC configuration

🐛 Fixed

  • None (refactoring only)

Is It Safe to Upgrade?

Backward Compatible: No

Breaking change: Custom build scripts using old flag names will fail with undefined identifier errors.

Migration path: Update any scripts or custom build commands to use new flag names. The functionality is identical; only the naming has changed.

Tests Passed

  • ✅ Builds without errors (all profiles)
  • ✅ Pre-commit hooks pass (trailing whitespace, file endings, syntax)
  • ✅ Flash/RAM usage unchanged
  • ✅ Serial protocol functionality unchanged

Release Details

  • Date: 2025-11-30
  • Version: v1.9.7
  • Files Changed: 18 files
  • Type: Refactoring (cosmetic, no functionality changes)

Next Steps

  • v1.9.8: Feature enhancement TBD
  • v2.0.0: Multi-threading and event-driven architecture overhaul