get_waveform
Retrieve and analyze a channel's waveform as text, reporting frequency, amplitude, offset, and data-quality warnings. Optionally return raw time/voltage arrays for custom analysis.
Instructions
Download and analyse the current waveform for a channel (NORM screen buffer, up to ~1000–1200 points depending on scope). Preferred over screenshot for inspecting the trace — the text analysis is cheaper and easier to reason over than an image. Stop or single-trigger the scope first for consistent data. By default returns a plain-text analysis: signal shape, frequency/period, amplitude, DC offset, cycle count, and data-quality warnings (e.g. mid-cycle edges, invalid frequency). Amplitude is judged against the channel's V/div: a trace filling under ~10% of the vertical screen is flagged as noise floor and its shape/frequency are not reported, and one filling under ~20% gets a low-amplitude warning (reduce V/div and re-capture for a clean signal). Set raw_data=true to get the full time/voltage JSON arrays instead. If the channel's display is OFF it is auto-enabled first (flagged in the warnings). After reading, act on any warnings — if FREQUENCY would be 9.9E37 widen the timebase; if edges are not near the DC mean, adjust offset so right edge = N×(period/2) − 6×scale. Do not call concurrently with any other rigol tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | ||
| raw_data | No | Return raw time/voltage JSON arrays instead of text analysis (default false) |