swaits/meshcore-spec
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(versioning): snapshot corpus per spec version
mdBook / build (push) Canceled after 0s
Details
mdBook / deploy (push) Canceled after 0s
Details

Browse Source 
A frozen spec is only meaningful if it's paired with the corpus
that was current at release time — otherwise a v0.1.0 reader
follows "see corpus/payloads/ack/" and lands on a file whose
test vectors may have changed since v0.1.0 was cut.

Three changes:

1. `cut-version` now copies BOTH src/ AND corpus/ into the
   snapshot directory. A release is the pair, not just the text.

2. The corpus URL rewriting in cut-version now retargets
   /tree/main/corpus -> /tree/main/versions/<v>/corpus (and the
   blob variant). This lets the link resolve on GitHub from main
   alone — no git tag required, since the frozen copy is a real
   path under main. Downgrades the "tag is REQUIRED" message from
   last commit back to "optionally tag the commit".

3. The frozen corpus's spec_ref fields get rewritten too: from
   `src/04-payload-ack.md` to `versions/<v>/04-payload-ack.md`,
   so a reader following a test vector lands on the spec text the
   vector was paired with at release time.

versions/v0.1.0/ regenerated from scratch via `just cut-version v0.1.0`
to pick up the corpus snapshot + the new sed patterns. The release
is now self-consistent: v0.1.0 spec links go to v0.1.0 corpus, which
links back to v0.1.0 spec.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
swaitsandClaude Opus 4.7 committed 2026-05-12 10:38:02 -06:00
1 parent f83d4088e3
commit 9232c16f7c
71 files changed
+5924 -28
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

versions/v0.1.0/corpus/kiss/sethardware.json
+185
View File
@@ -0,0 +1,185 @@
{
"$schema": "../schema/test-vector.schema.json",
"name": "KISS Protocol - SetHardware Extensions",
"spec_ref": "versions/v0.1.0/19-kiss-protocol.md",
"protocol_version": 0,
"description": "Tests MeshCore-specific SetHardware (0x06) sub-commands and responses.",
"vectors": [
{
"id": "kiss-hw-001",
"description": "GetVersion request",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 11 C0"
}
},
"binary": "3D 00 C0 06 11 C0",
"notes": "SetHardware(06) + GetVersion(11)."
},
{
"id": "kiss-hw-002",
"description": "Version response: version=1, reserved=0",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 91 01 00 C0"
}
},
"binary": "3D 00 C0 06 91 01 00 C0",
"notes": "SetHardware(06) + Version response(91) + version=1 + reserved=0."
},
{
"id": "kiss-hw-003",
"description": "SetRadio: freq=869618000Hz, bw=62500Hz, sf=12, cr=5",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 09 D0C5D733 A4F40000 0C 05 C0"
}
},
"binary": "3D 00 C0 06 09 D0C5D733 A4F40000 0C 05 C0",
"notes": "SetRadio(09). freq=869618000=0x33D7C5D0 LE=D0C5D733. bw=62500=0x0000F4A4 LE=A4F40000. sf=12, cr=5."
},
{
"id": "kiss-hw-004",
"description": "Ping request and Pong response",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 17 C0"
}
},
"binary": "3D 00 C0 06 17 C0",
"notes": "SetHardware(06) + Ping(17)."
},
{
"id": "kiss-hw-005",
"description": "Error response: UnknownCmd (0x05)",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 F1 05 C0"
}
},
"binary": "3D 00 C0 06 F1 05 C0",
"notes": "SetHardware(06) + Error(F1) + UnknownCmd(05)."
},
{
"id": "kiss-hw-006",
"description": "RxMeta unsolicited event: SNR=-2.5dB, RSSI=-100dBm",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 F9 F6 9C C0"
}
},
"binary": "3D 00 C0 06 F9 F6 9C C0",
"notes": "RxMeta(F9). SNR: -2.5dB × 4 = -10 = 0xF6 (signed byte). RSSI: -100dBm = 0x9C (signed byte)."
},
{
"id": "kiss-hw-007",
"description": "TxDone success",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 F8 01 C0"
}
},
"binary": "3D 00 C0 06 F8 01 C0",
"notes": "TxDone(F8) + success(01)."
},
{
"id": "kiss-hw-008",
"description": "Stats response: rx=100, tx=50, errors=2",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "C0 06 92 64000000 32000000 02000000 C0"
}
},
"binary": "3D 00 C0 06 92 64000000 32000000 02000000 C0",
"notes": "Stats(92). rx=100=0x64 LE=64000000, tx=50=0x32 LE=32000000, errors=2 LE=02000000."
}
]
}