feat: add packet capture mode for field discovery#18
Open
Conversation
- Phase 1: Standardize YAML config (binary_sensor: True -> type: binary_sensor) - Phase 2: Add protocol abstraction (Protocol, PlaintextProtocol, JacuzziEncryptedProtocol) - Phase 3: Refactor base classes (MessageFactory rename, protocol injection in Spa) - Phase 4: Add tests and docs (17 tests, ARCHITECTURE.md) The protocol layer now cleanly separates decoding logic from packet parsing, making it easy to add new spa types without duplicating infrastructure.
- Add capture_mode flag (env var CAPTURE_MODE=true or config option) - Capture mode writes CSV with: timestamp, raw_hex, packet_type, channel, decoded_fields - Useful for debugging new spa models and discovering unknown fields
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a capture mode to spa2mqtt that logs packets with decoded fields for field discovery.
Usage
Option 1: Environment variable
Option 2: YAML config
Output
Creates a CSV file with columns:
Use Case
Run with the spa in different states (heater on/off, pumps on different settings, different temperatures) to capture packets. Then use
dev/field_discovery.pyto analyze the CSV and identify unknown fields.