Skip to content

v1.15.6 - Cleanup: Remove Deprecated build_event_payload() (2025-12-12)

What Changed?

This release removes the deprecated build_event_payload() wrapper function from EventQueue. The function was marked for removal and has been superseded by the clearer get_event_payload() API. All documentation and code references have been updated for consistency.

What's New

API Cleanup: Deprecated Function Removal

What changed: The build_event_payload() function has been removed from include/event_queue.h. This was a deprecated wrapper that simply called get_event_payload() internally.

Why:

  • Reduces code duplication and improves clarity
  • The newer get_event_payload() function is now the single source of truth
  • All detection code already uses the new API

Migration: If you were using build_event_payload(), replace with get_event_payload():

// Old (deprecated - removed in v1.15.6)
const JsonDocument* payload = build_event_payload(&event);

// New (current standard)
const JsonDocument* payload = get_event_payload(&event);

Installation

Quick Start

# Get the release
git checkout v1.15.6

# Build
task build

# Upload
task upload

# Check it works
task monitor

What's Different from the Last Version?

✅ Added

  • None

🔧 Changed

  • Removed build_event_payload() deprecated wrapper function from EventQueue
  • Updated all documentation references to use get_event_payload() consistently

🐛 Fixed

  • None

Is It Safe to Upgrade?

Backward Compatible: Yes (for most users)

  • This is a cleanup release with no breaking changes to public APIs
  • The removed function was already deprecated and rarely used in production
  • All codebase references were already using get_event_payload()
  • Custom code using build_event_payload() should be updated to use get_event_payload() instead

Tests Passed

  • ✅ Code compiles without errors
  • ✅ No remaining references to build_event_payload() in codebase
  • ✅ Documentation consistent with new API

Release Details

  • Date: 2025-12-12
  • Version: v1.15.6
  • Files Changed: 2 (include/event_queue.h, docs/releases/v1.15.6.md)

Next Steps

  • Continue with CommandParser class implementation (v1.14.0 planned)
  • Evaluate Phase 7+ improvements for unified device response protocol