BKPT LabsDOCS/TRACE DOMAINS/INSTRUMENT SIDECAR EXAMPLE BKPT DEBUG & VIEWALYZER RS
TRACE DOMAINS · PRACTICAL GUIDES

Instrument sidecar example

External current samples and a high-current threshold.

Download example JSON · GitHub source · Authoring examples

Authoring example · Descriptor com.example.bench-sensor · version 1.0.0 · domain API 1.

Purpose and prerequisites

An authoring sample for adapting to your own firmware or instrument. Supply sensor-recorder executable and synchronization channel; no sidecar included. It is not a tested board-support domain.

Engineering interpretation

The fields and thresholds below are the exact example contract. Replace placeholder sources and document the actual producer, units, safe-access conditions and acceptable states before enabling this on a target. Parsing success establishes format validity, not hardware compatibility.

Cards and tables

This descriptor declares no dedicated cards or tables. Its channel rules below control existing trace presentation.

Channel presentation rules

Rules apply in order: the first match supplies metadata. No new measurements are created.

MATCH MEANING UNIT DISPLAY HINT GROUP
external / currentExternal channel supplied by sensor-recorder in mA. This example assumes the sidecar produces values in that unit; it cannot calibrate or convert a different source.mAgraphBench

Findings

High current

warning · high-current. current ≥ 200 for 500 ms of observations.

Evaluate this condition with the evidence and expected application behavior; it does not uniquely identify a root cause.

Evidence: current.

Instrument contract

No sensor-recorder executable is included. Supply an implementation of the external trace stream contract on the host PATH. Its rate parameter defaults to 1000 with allowed range 1–10000; this is a command parameter, not proof of achieved rate. The host allows a two-second warm-up and uses a sync channel named sync for alignment. Verify calibration and synchronization in the actual instrument implementation.

{
  "cmd": "sensor-recorder --stream --rate {param.rate}",
  "warmup_s": 2,
  "sync_name": "sync",
  "params": [
    {
      "key": "rate",
      "label": "Sample rate",
      "type": "number",
      "default": "1000",
      "min": 1,
      "max": 10000
    }
  ]
}

Definition and contribution

Verified against the complete authoring descriptor and the native validation, structured-source, derived-field, finding and action contracts. No real producer is supplied for this sample.

View or propose changes to the canonical JSON. Contribution guide.

Download SHA-256: b8b69fb4ab9b7bf237c6ddaa96deb7ab614bc060c24f7dd065e767ec47cf2412.