swaitsandClaude Opus 4.7
d785e35919
Set up the protocol spec as an mdBook and add a GitHub Actions workflow that builds it on every push/PR and deploys to GitHub Pages on main. The repo is now both a machine-readable corpus and a browsable, searchable site. Structure changes (one-time, mechanical): - Rename the spec source directory from `spec/` to `src/` to match mdBook's default convention. All 21 chapter files move; their internal relative cross-links are unchanged. - Add `src/SUMMARY.md` as the mdBook table of contents, grouping chapters under Wire Format, Payloads, Cryptography & Identity, and Routing & Higher-Layer Protocols. - Add `book.toml` at repo root: title, author, search enabled, fold enabled, edit-on-GitHub links, navy theme. - Add `.github/workflows/mdbook.yml`: build on push + PR, deploy on push to main only (configure-pages + upload-pages-artifact + deploy-pages from actions/). - Add `/book/` to .gitignore. Reference updates so the old path is fully retired: - Every `spec_ref` in `corpus/**/*.json` rewritten from `spec/` to `src/` (54 files). - Schema description text and example path in `corpus/schema/test-vector.schema.json`. - `README.md`: prominent link to the published site near the top; "What's Here" updated for the new layout. - `CONTRIBUTING.md`: spec-editing instructions point at `src/` and note the SUMMARY.md requirement. - `CLAUDE.md`: directory-layout notes updated. CHANGELOG.md historical entries intentionally keep their `spec/` paths since those record what the paths were at the time of those commits. After this lands, the user needs to enable GitHub Pages in repo settings with source = "GitHub Actions" (one-time, manual). The workflow will then publish to https://swaits.github.io/meshcore-spec/ on every push to main. Verified locally: `mdbook build` produces a clean book/ tree with all 21 chapters rendered and the SUMMARY-driven sidebar populated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
186 lines
4.9 KiB
JSON
186 lines
4.9 KiB
JSON
{
|
||
"$schema": "../schema/test-vector.schema.json",
|
||
"name": "KISS Protocol - SetHardware Extensions",
|
||
"spec_ref": "src/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."
|
||
}
|
||
]
|
||
}
|