Files
kaptan/docs/src/reference.md
T

1.5 KiB

Reference

This page collects stable limits and points to the detailed contracts.

Surface Current contract
Flight profile One 4 KiB-or-smaller raw CBOR blob, profile_format = 1, schema ID KAPTANPROFILE-01.
SITL file Private [generation, raw-profile-blob] envelope; not a MAVLink upload blob.
Config transaction One owner-bound RAM transaction; typed writes or 192-byte idempotent CBOR chunks; commit is restart-required.
Config discovery Correlated KAPTAN_CONFIG_INFO_REQUEST / KAPTAN_CONFIG_INFO, then descriptor/value requests.
Diagnostics KAPTAN_LOG (51020) for ordinary severity/text; KAPTAN_ERROR (51021) for a bounded { path[96], additional_information[64] } error; and KAPTAN_SHUTDOWN (51022) for completed orderly output-inhibited shutdowns.
F722 configuration Immutable compiled board policy only; inbound MAVLink configuration remains disabled.

Read Configuration for the field/consumer matrix and GCS upload sequence, Logs for receiver decoding and filtering, and Errors for error propagation and panic scope.

Verification

Before review, run:

cd firmware
cargo fmt --all --check
cargo test --workspace --locked --offline
cargo clippy --workspace --all-targets --locked -- -D warnings

The embedded no-std binaries require their target-specific build setup; the host workspace test suite continues to assert that the telemetry F722 image has no inbound authority or actuator path.