Files
KAT/docs/README.md
T
KaraZajac e59d976123 docs: README and protocol docs for KeeLoq generic fallback
- README: add KeeLoq generic fallback to features, supported protocols, crypto modules, project structure
- docs/README.md: add keeloq_generic to protocol table and short note
- docs/keeloq_generic.md: new doc describing fallback flow, keeloq_common usage, display, encoding

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-15 19:01:41 -05:00

1.6 KiB

KAT Protocol Documentation

This folder describes how each keyfob protocol supported by KAT works. Each document corresponds to a decoder/encoder in src/protocols/.

Capture/encode model: Decoded signals expose optional extra (e.g. VAG: vag_type + key_idx). When present, the app stores it in Capture.data_extra so retransmit can encode from the capture without decoder instance state. See vag.md for the VAG encode-from-capture flow.

Protocol Rust module Doc
Kia V0 kia_v0.rs kia_v0.md
Kia V1 kia_v1.rs kia_v1.md
Kia V2 kia_v2.rs kia_v2.md
Kia V3/V4 kia_v3_v4.rs kia_v3_v4.md
Kia V5 kia_v5.rs kia_v5.md
Kia V6 kia_v6.rs kia_v6.md
Ford V0 ford_v0.rs ford_v0.md
Subaru subaru.rs subaru.md
VAG vag.rs vag.md
Fiat V0 fiat_v0.rs fiat_v0.md
Suzuki suzuki.rs suzuki.md
Scher-Khan scher_khan.rs scher_khan.md
Star Line star_line.rs star_line.md
PSA psa.rs psa.md
KeeLoq generic (fallback) keeloq_generic.rs keeloq_generic.md

KeeLoq generic is not a registered decoder; it runs when no protocol matches and tries KeeLoq with every keystore manufacturer key (using keeloq_common). Successful decodes appear as Keeloq (keystore name).

Implementations are aligned with the ProtoPirate reference in REFERENCES/ProtoPirate/protocols/.