docs: add TIME_STREAM_PLAN.md for PPS callback consumer work#13
Draft
ringof wants to merge 1 commit into
Draft
Conversation
Captures the locked decisions for consuming the upcoming librx888 PPS callback API (rx888-tools branch claude/detect-dropped-samples-YbnYV) in gr-rx888: rx_time stream tags, status message port, mock surface, and the system-clock UTC source. gpsd lands in a follow-up PR.
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
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
Adds
TIME_STREAM_PLAN.mdat the repo root. This is the workingplan for consuming the upcoming librx888 PPS callback API
(rx888-tools branch
claude/detect-dropped-samples-YbnYV,documented in
doc/pps_window.md) and exposing UTC-alignedrx_timestream tags + astatusmessage port on therx888.sourceblock.Locked decisions captured in the plan:
check_symbol_exists(no pkg-config version literal).
CLOCK_REALTIME) as the UTC source for thisfirst pass; gpsd lands in a follow-up PR.
statusmessage port (pps_window,host_overflow,device_gone,firmware_version,clock_locked) with the time-stream work.pps_windowmessage per PPS event (with adeficit_samplesfield), not only on anomaly.librx888 delivers events, silent otherwise.
This PR is plan-only. Implementation lands in follow-up PRs once
the plan is signed off.
Test plan
rx888-tools/doc/pps_window.mdonbranch
claude/detect-dropped-samples-YbnYVfor API shapeparity (struct fields, callback signature, thread rules).
lib/source_impl.{h,cc},tests/mock/librx888.{h,c}, andCMakeLists.txt.Generated by Claude Code