Skip to content

v1.13.5 - Naming Consistency Refactoring (2025-12-09)

What Changed?

This release improves code organization and readability by renaming the event_t type to stream_data_t. The new name better reflects the struct's exclusive use in stream output formatting (SSV, TSV, CSV, JSONL), aligning with the stream_* naming convention used throughout the output module. All functionality remains unchanged; this is a pure refactoring.

What's New

Type Rename: stream_data_t (formerly event_t)

What it does: The detection event data structure has been renamed from event_t to stream_data_t to better represent its purpose: collecting sensor readings for stream output formatting.

Why the change:

  • Aligns with the stream_* naming convention used in stream_formatter.h/cpp
  • More descriptive of the struct's role (stream output data, not generic events)
  • Improves code maintainability by reducing ambiguity

What changed:

  • Type definition in include/stream_data.h
  • All function signatures in stream_formatter.h/cpp
  • Detection buffer interface in detection_buffer.h/cpp
  • Main loop variable declarations in main.cpp
  • Documentation references updated

Backward compatibility: This is a pure type rename with no functional changes. All serialization formats (SSV, TSV, CSV, JSONL) and detection logic remain identical.

Installation

Quick Start

# Get the release
git checkout v1.13.5

# Build
task build

# Upload
task upload

# Check it works
task monitor

What's Different from the Last Version?

✅ Added

  • None (pure refactoring release)

🔧 Changed

  • Renamed event_t type to stream_data_t throughout codebase
  • Updated function signatures in stream formatting module
  • Updated documentation references in configuration and API docs

🐛 Fixed

  • None

Is It Safe to Upgrade?

Backward Compatible: Yes

  • No behavioral changes - all detection, serialization, and command handling remain identical
  • Type rename is internal only; no impact on serial protocol or command interface
  • Safe to upgrade from v1.13.4 without any configuration changes

Tests Passed

  • ✅ Builds without errors (RAM: 8.5%, Flash: 24.5%)
  • ✅ No compiler warnings
  • ✅ Type system verification (all type references updated)

Release Details

  • Date: 2025-12-09
  • Version: v1.13.5
  • Files Changed: 10 (header files, implementation files, configuration docs)

Next Steps

  • Phase 2 of Device Response Protocol: Integration with command handlers and event serialization
  • CommandParser class (v1.14.0 planned): Consolidate argument parsing and validation logic
  • Additional code quality improvements based on static analysis