Basic oscilloscope usage

scope_basic.py

"""Example: Basic oscilloscope usage.

Demonstrates connecting to an oscilloscope, configuring channel and trigger
settings, capturing a waveform, and taking built-in measurements.

"""

from instro.lib.publishers import NominalCorePublisher
from instro.lib.transports import VisaConfig
from instro.scope import (
    AcquisitionMode,
    Coupling,
    InstroScope,
    ScopeMeasurementType,
    TriggerMode,
    TriggerSlope,
    TriggerType,
)
from instro.scope.drivers import Keysight1200X

VISA_RESOURCE = "<visa_resource>"  # Replace with your instrument's VISA resource string.
DATASET_RID = "<dataset_rid>"  # Replace with your dataset RID.

scope = InstroScope(
    name="scope",
    driver=Keysight1200X(VisaConfig(visa_resource=VISA_RESOURCE, visa_backend="@py")),
    num_channels=4,
    publishers=[NominalCorePublisher(dataset_rid=DATASET_RID)],
)

with scope:
    # --- Configure channel 1 ---
    scope.set_coupling(Coupling.DC, channel=1)
    scope.set_probe_attenuation(1.0, channel=1)
    scope.set_vertical_scale(1, channel=1)  # 1 V/div
    scope.set_vertical_offset(0, channel=1)

    # --- Configure timebase ---
    scope.set_horizontal_scale(0.01)  # 10 ms/div

    # --- Configure acquisition ---
    scope.set_acquisition_mode(AcquisitionMode.NORMAL)

    # --- Configure trigger ---
    scope.set_trigger_source(channel=1)
    scope.set_trigger_type(TriggerType.EDGE)
    scope.set_trigger_slope(TriggerSlope.RISING)
    scope.set_trigger_level(0)  # 0 V
    scope.set_trigger_mode(TriggerMode.NORMAL)

    # --- Acquire and fetch ---
    # single() arms the acquisition; fetch_waveform() then blocks until the
    # trigger fires and the capture completes (up to its timeout).
    scope.single()
    waveform = scope.fetch_waveform(channel=1)
    print(f"Waveform captured: {len(waveform.channel_data)} channel(s)")

    # --- Built-in measurements ---
    vpp = scope.measure(ScopeMeasurementType.VPP, channel=1)
    vrms = scope.measure(ScopeMeasurementType.VRMS, channel=1, timeout=10)
    vmax = scope.measure(ScopeMeasurementType.VMAX, channel=1)
    freq = scope.measure(ScopeMeasurementType.FREQUENCY, 1)
    per = scope.measure(ScopeMeasurementType.PERIOD, 1)
    vmin = scope.measure(ScopeMeasurementType.VMIN, 1)
    print(f"Vpp:  {vpp}")
    print(f"Vrms: {vrms}")
    print(f"Vmax: {vmax}")
    print(f"Vmin: {vmin}")
    print(f"Frequency: {freq}")
    print(f"Period: {per}")

    # --- Read back settings ---
    sample_rate = scope.get_sample_rate()
    print(f"Sample rate: {sample_rate}")

    # --- Save a screenshot ---
    scope.save_screenshot("capture.png")