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

WdiAutofocusProviderclass

Module: zaber_motion.microscopy

Class representing access to WDI Autofocus connection.

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

from zaber_motion.microscopy import WdiAutofocusProvider

wdi_autofocus_provider = WdiAutofocusProvider.open_tcp('169.254.64.162')
Related Guides:

Index

cConstants
pProperties
mMethods

Constants

c

DEFAULT_TCP_PORT

WdiAutofocusProvider.DEFAULT_TCP_PORT
int Default port number for TCP connections to WDI autofocus.
Value
27

Properties

p

firmware_version

readonly
wdi_autofocus_provider.firmware_version
FirmwareVersion The firmware version of the connected autofocus.
p

provider_id

readonly
wdi_autofocus_provider.provider_id
int The ID identifies the autofocus with the underlying library.

Methods

m

close()

async available
wdi_autofocus_provider.close()
Close the connection.
m

disable_laser()

async available
wdi_autofocus_provider.disable_laser()
Disables the laser.
m

enable_laser()

async available
wdi_autofocus_provider.enable_laser()
Enables the laser.
m

generic_read()

async available
wdi_autofocus_provider.generic_read(register_id, size, count = 1, offset = 0, register_bank = "U")
Generic read operation.
Arguments
NameTypeDescription
register_idintRegister address to read from.
sizeintData size to read. Valid values are (1,2,4). Determines the data type (Byte, Word, DWord).
countintNumber of values to read (defaults to 1).
offsetintOffset within the register (defaults to 0).
register_bankstrRegister bank letter (defaults to U for user bank).
Return Value
List[int] Array of integers read from the device.
m

generic_read_float()

async available
wdi_autofocus_provider.generic_read_float(register_id, count = 1, offset = 0, register_bank = "U")
Generic read operation.
Arguments
NameTypeDescription
register_idintRegister address to read from.
countintNumber of values to read (defaults to 1).
offsetintOffset within the register (defaults to 0).
register_bankstrRegister bank letter (defaults to U for user bank).
Return Value
List[float] Array of floats read from the device.
m

generic_write()

async available
wdi_autofocus_provider.generic_write(register_id, size = 0, data = [], offset = 0, register_bank = "U")
Generic write operation.
Arguments
NameTypeDescription
register_idintRegister address to write to.
sizeintData size to write. Valid values are (0,1,2,4). Determines the data type (Nil, Byte, Word, DWord).
dataList[int]Array of values to write to the register. Empty array is allowed.
offsetintOffset within the register (defaults to 0).
register_bankstrRegister bank letter (defaults to U for user bank).
m

generic_write_float()

async available
wdi_autofocus_provider.generic_write_float(register_id, data = [], offset = 0, register_bank = "U")
Generic write operation.
Arguments
NameTypeDescription
register_idintRegister address to write to.
dataList[float]Array of values to write to the register. Empty array is allowed.
offsetintOffset within the register (defaults to 0).
register_bankstrRegister bank letter (defaults to U for user bank).
m

get_status()

async available
wdi_autofocus_provider.get_status()
Gets the status of the autofocus.
Return Value
WdiAutofocusProviderStatus The status of the autofocus.
s

open_tcp()

async available
WdiAutofocusProvider.open_tcp(host_name, port = DEFAULT_TCP_PORT)
Opens a TCP connection to WDI autofocus.
Arguments
NameTypeDescription
host_namestrHostname or IP address.
portintOptional port number (defaults to 27).
Return Value
WdiAutofocusProvider An object representing the autofocus connection.
m

__repr__()

wdi_autofocus_provider.__repr__()
Returns a string that represents the autofocus connection.
Return Value
str A string that represents the connection.