Skip to content

Document V1/V2 MQTT topics and their code touchpoints in README - #7

Draft
tyeth with Copilot wants to merge 1 commit into
mainfrom
copilot/update-readme-v1-v2-topics
Draft

tyeth with Copilot wants to merge 1 commit into
mainfrom
copilot/update-readme-v1-v2-topics

Conversation

Copilot AI commented Jul 15, 2026 •

Copy link
Copy Markdown
Contributor

The README didn't explain the V1/V2 protocol topic schemes or where in the codebase they're consumed, making it easy to update one location (e.g. subtopic tables) and miss the others.

Changes

  • New "V1 vs V2 Topics" section in README.md, placed before "Authentication"
    • Describes the V2 topic shape (ws-b2d/ws-d2b envelope-based) vs V1 (wprsnpr flat per-message)
    • Points to the three places that must stay in sync when topic/subtopic structure changes:
      • frontend/stores/subscriptions.js — SUBSCRIPTION_MODES topic filters
      • frontend/util.js — TOPIC_MESSAGE_MAP / resolveV1TopicName decoding
      • protobufs.js — resolveV1Topic / decodeByTopic decoding
    • Flags that the frontend and backend V1_SIGNAL_SUBTOPICS tables are intentionally duplicated (frontend can't import the backend module) and must be manually kept in sync

Copilot AI changed the title Document V1/V2 topics in README Document V1/V2 MQTT topics and their code touchpoints in README Jul 15, 2026
Copilot finished work on behalf of tyeth July 15, 2026 18:36
Copilot AI requested a review from tyeth July 15, 2026 18:36

@tyeth tyeth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expected it to also include hints to users on how to work with an alternative protobuf source and merely that the topics would need adjusting. It's also the case the V1 and V2 documentation of topics and stuff is useful so that's fine too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants