Skip to content

stub

Plugin guide#

This page is not written yet

This page is a stub. It lists the topics that belong here and where the source material is.

Content follows the v1.0 tag.

Scope#

This page will walk through a shipped plugin, clients/mfp/, from start to finish.

Topics the example covers:

  • Discovery, and the requirement that a manual address still works.
  • Choosing between dense samples and sparse segments, and what each costs.
  • Holding a session open through a pause: the segments stop, the liveness pings continue, and the machine settles instead of tripping its deadman.
  • A divergence watchdog that warns, without switching modes, when the host app's output for the axis differs from the script's prediction.
  • Byte-for-byte wire parity with the probe (the reference verifier), checked by a test.
  • Running the same session twice back to back without rebooting the device. This pattern is mandatory for anything touching session lifecycle.

Source material#

  • clients/mfp/: the shipped plugin. The guide must separate shipped files from development-only files.
  • spec/V1-READINESS.md ยง2.5: the client work items, including the limits of the host application's extension surface.

Where to go next#

  • Quickstart: the seven-step session this guide's example builds on.
  • CLI guide: verify wire parity with the probe.
  • Local testing: the back-to-back-sessions pattern.