Zaber Motion LibraryGetting StartedHow-to GuidesSupportBinary Protocol (Legacy)
API Reference
zaber_motion.ascii
AlertEventAllAxesAxisAxisGroupAxisIdentityAxisSettingsAxisStorageAxisTypeConnectionConversionFactorDeviceDeviceIdentityDeviceIODeviceIOInfoDeviceSettingsDeviceStorageDigitalOutputActionGetAxisSettingGetAxisSettingResultGetAxisSettingTypedResultGetSettingGetSettingResultGetSettingTypedResultIoPortLabelIoPortTypeLockstepMeasurementSequenceMessageTypeOscilloscopeOscilloscopeCapturePropertiesOscilloscopeDataOscilloscopeDataSourceParamsetInfoPidTuningPvtPvtAxisDefinitionPvtAxisTypePvtBufferPvtBufferAxisUnitsPvtCallActionPvtCancelAllOutputsScheduleActionPvtCancelOutputScheduleActionPvtCsvDataPvtIoPvtModePvtPartialCsvDataPvtPartialPointPvtPartialSequenceItemPvtPointPvtSequencePvtSequenceItemPvtSetAllAnalogOutputsActionPvtSetAllDigitalOutputsActionPvtSetAnalogOutputActionPvtSetDigitalOutputActionResponseServoTunerServoTuningParamServoTuningParamsetSetStateAxisResponseSetStateDeviceResponseSettingConstantsSimpleTuningSimpleTuningParamDefinitionStreamStreamAxisDefinitionStreamAxisTypeStreamBufferStreamIoStreamModeStreamsTransportTriggerTriggerActionTriggerConditionTriggerEnabledStateTriggerOperationTriggersTriggerStateTypedSettingUnknownResponseEventWarningFlagsWarnings
zaber_motion.binary
BinarySettingsCommandCodeConnectionDeviceDeviceIdentityDeviceSettingsDeviceTypeErrorCodeMessageReplyCodeReplyOnlyEventUnknownResponseEvent
zaber_motion.exceptions
MotionLibExceptionBinaryCommandFailedExceptionDataCommandFailedExceptionDataCommandTooLongExceptionDataDeviceAddressConflictExceptionDataDeviceDbFailedExceptionDataDeviceDbInnerErrorGCodeExecutionExceptionDataGCodeSyntaxExceptionDataInvalidPacketExceptionDataInvalidPvtPointInvalidResponseExceptionDataMovementFailedExceptionDataMovementInterruptedExceptionDataOperationFailedExceptionDataPvtExecutionExceptionDataPvtMovementFailedExceptionDataPvtMovementInterruptedExceptionDataSetDeviceStateExceptionDataSetPeripheralStateExceptionDataStreamExecutionExceptionDataStreamMovementFailedExceptionDataStreamMovementInterruptedExceptionData
zaber_motion.gcode
AxisDefinitionAxisMappingAxisTransformationDeviceDefinitionOfflineTranslatorTranslateMessageTranslateResultTranslatorTranslatorConfig
zaber_motion.microscopy
AutofocusAutofocusStatusCameraTriggerFilterChangerIlluminatorIlluminatorChannelMicroscopeMicroscopeConfigObjectiveChangerThirdPartyComponentsWdiAutofocusProviderWdiAutofocusProviderStatus
zaber_motion.product
Ge1xGripperGe1xGripperDirectionGe1xGripperErrorGe1xGripperStateProcessProcessControllerProcessControllerModeProcessControllerSourceProcessControllerSourceSensor
zaber_motion
AxisAddressChannelAddressCyclicDirectionDeviceDbSourceDeviceDbSourceTypeDeviceDiscoveryResultDevicePortTypeFirmwareVersionLibraryLogOutputModeMeasurementNamedParameterRotationDirectionToolsUnitConversionDescriptorUnitsUnitTable
© 2026 Zaber Technologies Inc.

API Reference v9.2.0

OscilloscopeDataclass

Module: zaber_motion.ascii

Contains a block of contiguous recorded data for one channel of the device's oscilloscope.

The following example illustrates how you can obtain an instance of this type:

from zaber_motion.ascii import Connection

connection = Connection.open_serial_port('COM3')
device = connection.get_device(1)
oscilloscope = device.oscilloscope
oscilloscope_data = oscilloscope.read()
Related Guides:

Index

pProperties
mMethods

Properties

p

axis_number

readonly
oscilloscope_data.axis_number
int The number of the axis the data was recorded from, or 0 for the controller.
p

data_id

readonly
oscilloscope_data.data_id
int Unique ID for this block of recorded data.
p

data_source

readonly
oscilloscope_data.data_source
OscilloscopeDataSource Indicates whether the data came from a setting or an I/O pin.
p

io_channel

readonly
oscilloscope_data.io_channel
int Which I/O pin within the port was recorded.
p

io_type

readonly
oscilloscope_data.io_type
IoPortType Which kind of I/O port data was recorded from.
p

setting

readonly
oscilloscope_data.setting
str The name of the recorded setting.

Methods

m

get_data()

oscilloscope_data.get_data(unit = Units.NATIVE)
Get the recorded data as an array of doubles, with optional unit conversion. Note that not all quantities can be unit converted. For example, digital I/O channels and pure numbers such as device mode settings have no units.
Arguments
NameTypeDescription
unitUnitsAndLiteralsUnit of measure to convert the data to.
Return Value
List[float] The recorded data for one oscilloscope channel, converted to the units specified.
m

get_delay()

oscilloscope_data.get_delay(unit = Units.NATIVE)
Get the user-specified time period between receipt of the start command and the first data point. Under some circumstances, the actual delay may be different - call GetSampleTime(0) to get the effective delay.
Arguments
NameTypeDescription
unitTimeUnitsUnit of measure to represent the delay in.
Return Value
float The delay setting at the time the data was recorded.
m

get_frequency()

oscilloscope_data.get_frequency(unit = Units.NATIVE)
Get the sampling frequency that this data was recorded with.
Arguments
NameTypeDescription
unitFrequencyUnitsUnit of measure to represent the frequency in.
Return Value
float The frequency (inverse of the timebase setting) at the time the data was recorded.
m

get_sample_time()

oscilloscope_data.get_sample_time(index, unit = Units.NATIVE)
Calculate the time a sample was recorded, relative to when the recording was triggered.
Arguments
NameTypeDescription
indexint0-based index of the sample to calculate the time of.
unitTimeUnitsUnit of measure to represent the calculated time in.
Return Value
float The calculated time offset of the data sample at the given index.
m

get_sample_times()

oscilloscope_data.get_sample_times(unit = Units.NATIVE)
Calculate the time for all samples, relative to when the recording was triggered.
Arguments
NameTypeDescription
unitTimeUnitsUnit of measure to represent the calculated time in.
Return Value
List[float] The calculated time offsets of all data samples.
m

get_timebase()

oscilloscope_data.get_timebase(unit = Units.NATIVE)
Get the sample interval that this data was recorded with.
Arguments
NameTypeDescription
unitTimeUnitsUnit of measure to represent the timebase in.
Return Value
float The timebase setting at the time the data was recorded.