Skip to content

Draft status messages for EDM & POP#9

Open
jschlyter wants to merge 2 commits into
mainfrom
mqtt_status_messages
Open

Draft status messages for EDM & POP#9
jschlyter wants to merge 2 commits into
mainfrom
mqtt_status_messages

Conversation

@jschlyter

@jschlyter jschlyter commented Jun 16, 2026

Copy link
Copy Markdown
Member

Closes #8

Status placeholders for EDM & POP. "disconnected" state messages should be configured as "last will" in MQTT.

Summary by CodeRabbit

  • New Features
    • Added new connection status message types for EDM and POP state reporting, including JSON schema definitions for connected/disconnected.
  • Documentation
    • Updated MQTT topic documentation with signed status channels and revised event link references.
  • Chores
    • Expanded the build generation list to include new status artifacts.
    • Updated ignore rules to omit generated status/event JSON files.

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1ca44fe4-8c37-4c2a-98d6-bccb94214726

📥 Commits

Reviewing files that changed from the base of the PR and between e241935 and 68e5c80.

📒 Files selected for processing (2)
  • status/status_edm.yaml
  • status/status_pop.yaml
🚧 Files skipped from review as they are similar to previous changes (2)
  • status/status_edm.yaml
  • status/status_pop.yaml

📝 Walkthrough

Walkthrough

Two new JSON Schema definitions (status/status_edm.yaml and status/status_pop.yaml) are added for EDM and POP status messages, each requiring type and version fields and constraining state to connected or disconnected. The Makefile GENERATED variable, .gitignore patterns, and README.md MQTT topic documentation are updated accordingly.

Changes

Status Schema Definitions and Integration

Layer / File(s) Summary
status_edm and status_pop schema definitions
status/status_edm.yaml, status/status_pop.yaml
Adds two JSON Schema (draft 2020-12) files. Both require type and version, constrain type to a constant (status_edm / status_pop), enforce version as an integer ≥ 0, and restrict state to connected or disconnected with additional properties allowed.
Build, gitignore, and docs integration
Makefile, .gitignore, README.md
Extends GENERATED in the Makefile with status/status_edm.json and status/status_pop.json. Replaces specific event file ignores with broad events/*.json and status/*.json glob patterns. Updates README to link new_qname and new_aggregate to their YAML files and adds signed MQTT topic entries for status/edm/up/SENDER/# and status/pop/up/SENDER/#, removing the prior status/up/SENDER/# placeholder.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 Hop hop, two schemas appear today,
status_edm and status_pop are here to stay!
connected or disconnected, state must comply,
The Makefile now builds them, the docs say hi.
With gitignore swept to a tidy wide net,
This bunny declares: the best schemas yet! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: introducing draft status message schemas for EDM and POP systems.
Linked Issues check ✅ Passed The PR addresses issue #8 by defining JSON Schema for status messages for both EDM and POP with proper state validation.
Out of Scope Changes check ✅ Passed All changes are in scope: new status schemas, .gitignore updates, Makefile configuration, and documentation updates align with the objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jschlyter jschlyter requested review from johanix and morkrost June 16, 2026 08:00
@jschlyter jschlyter marked this pull request as ready for review June 16, 2026 08:03
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.

Define schema for status message

1 participant