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

API Reference v9.1.0

Microscopeclass

Module: zaber_motion.microscopy

Represent a microscope. Parts of the microscope may or may not be instantiated depending on the configuration. Requires at least Firmware 7.34.

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

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import Microscope

connection = Connection.open_serial_port('COM3')
microscope = Microscope.find(connection)
Related Guides:

Index

pProperties
mMethods

Constructor

Microscope(connection, config)
Creates instance of `Microscope` from the given config. Parts are instantiated depending on device addresses in the config.
Arguments
NameTypeDescription
connectionConnectionConnection of the microscope.
configMicroscopeConfigThe configuration. The parts of the microscope are instantiated depending on the specified data.

Properties

p

autofocus

readonlyoptional
microscope.autofocus
Optional[Autofocus] The autofocus feature.
p

camera_trigger

readonlyoptional
microscope.camera_trigger
Optional[CameraTrigger] The camera trigger.
p

connection

readonly
microscope.connection
Connection Connection of the microscope.
p

filter_changer

readonlyoptional
microscope.filter_changer
Optional[FilterChanger] The filter changer.
p

focus_axis

readonlyoptional
microscope.focus_axis
Optional[Axis] The focus axis.
p

illuminator

readonlyoptional
microscope.illuminator
Optional[Illuminator] The illuminator.
p

objective_changer

readonlyoptional
microscope.objective_changer
Optional[ObjectiveChanger] The objective changer.
p

plate

readonlyoptional
microscope.plate
Optional[AxisGroup] Axis group consisting of X and Y axes representing the plate of the microscope.
p

x_axis

readonlyoptional
microscope.x_axis
Optional[Axis] The X axis.
p

y_axis

readonlyoptional
microscope.y_axis
Optional[Axis] The Y axis.

Methods

s

find()

async available
Microscope.find(connection, third_party_components = None)
Finds a microscope on a connection.
Arguments
NameTypeDescription
connectionConnectionConnection on which to detect the microscope.
third_party_componentsOptional[ThirdPartyComponents]Third party components of the microscope that cannot be found on the connection.
Return Value
Microscope New instance of microscope.
m

initialize()

async available
microscope.initialize(force = False)
Initializes the microscope. Homes all axes, filter changer, and objective changer if they require it.
Arguments
NameTypeDescription
forceboolForces all devices to home even when not required.
m

is_initialized()

async available
microscope.is_initialized()
Checks whether the microscope is initialized.
Return Value
bool True, when the microscope is initialized. False, otherwise.
m

__repr__()

microscope.__repr__()
Returns a string that represents the microscope.
Return Value
str A string that represents the microscope.