Skip to content

stub

Python client guide#

This page is not written yet

This page is a stub. It lists the planned content and the source material.

Content is written after the v1.0 tag.

Planned content#

The tooling and test client: a minimal session, and using generated constants instead of numeric literals.

Source material: tools/valence_probe.py, the reference verifier.

DEMO-CANDIDATE: the probe's own minimal session (see the Quickstart) run live, one decoded frame printed per line.

Common outline#

Every client guide covers these seven steps in this order.

  1. Open the transport and complete the handshake.
  2. Handle the catalog: fetch, cache by etag, or pin it.
  3. Pass the ready gate.
  4. Adopt retained STATE before rendering anything.
  5. Send an intent and render the echo, never the request.
  6. Keep the session alive, and honor the deadman if you own a source.
  7. Handle NACKs, including the range fallback for a code you do not know.

Where to go next#

  • Quickstart: a worked example, end to end.
  • CLI guide: the probe and Valence Trace, in depth.
  • Local testing: run the client against the simulator before running it against hardware.