docs: add rtl_433 implementation spec + skill for humans and AI agents - #109
Merged
Conversation
New docs/rtl433-implementation-spec.md - a self-contained, decoder- agnostic spec (physical layer, frame format, byte-exact payload map, nRF905 register config, test vectors from a real capture, the device_fault capture recipe, and honestly-flagged open gaps). Meant to be implementable without first reading the reverse-engineering narrative docs - those remain the provenance, this is the reference. New .claude/skills/rtl433-uponor-clean1/SKILL.md - operationalizes the spec into the actual workflow this project uses for decoder work: where the code lives (the rtl_433 fork, not this repo), branch/build/ verify/review/PR steps, the common pitfalls already hit once (id semantics, stale tail bytes, hdr_len validation, Manchester being a PHY effect not firmware), and a definition-of-done checklist. Linked from README.md's doc index and rtl433-decoder.md. Co-Authored-By: Claude <noreply@anthropic.com>
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
docs/rtl433-implementation-spec.md— a self-contained, decoder-agnostic implementation spec: physical layer, frame format, byte-exact payload map, nRF905 register config bytes (for a TX implementation), test vectors from a real capture, thedevice_faultcapture recipe, and an honest "known gaps" section. Written so a human or an AI agent can build a correct decoder from this one document, without first reading the reverse-engineering narrative..claude/skills/rtl433-uponor-clean1/SKILL.md— a Claude Code skill that operationalizes the spec into this project's actual decoder workflow: where the code lives (theadd-uponor-clean1branch of the rtl_433 fork, not this repo), the branch/build/verify/review/PR steps, a list of pitfalls already hit once (id semantics, stale tail bytes, thehdr_lencross-check, Manchester being a PHY effect not a firmware behavior), and a definition-of-done checklist.README.md's doc index and fromrtl433-decoder.md.Test plan
add-uponor-clean1branch, PRs Add SECURITY.md #1-Update scorecard-analysis.yml #4) and the existing research docs — no new claims, just consolidationradio-capture-log.md/rtl433-decoder.md🤖 Generated with Claude Code