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

DeviceSettingsclass

Module: zaber_motion.ascii

Class providing access to various device settings and properties.

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)
device_settings = device.settings
Related Guides:

Index

mMethods

Methods

m

can_convert_native_units()

device_settings.can_convert_native_units(setting)
Indicates if given setting can be converted from and to native units.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
bool True if unit conversion can be performed.
m

convert_from_native_units()

device_settings.convert_from_native_units(setting, value, unit)
Convert arbitrary setting value from Zaber native units.
Arguments
NameTypeDescription
settingstrName of the setting.
valuefloatValue of the setting in Zaber native units.
unitUnitsAndLiteralsUnits to convert value to.
Return Value
float Setting value.
m

convert_to_native_units()

device_settings.convert_to_native_units(setting, value, unit, round = False)
Convert arbitrary setting value to Zaber native units.
Arguments
NameTypeDescription
settingstrName of the setting.
valuefloatValue of the setting in units specified by following argument.
unitUnitsAndLiteralsUnits of the value.
roundboolIf true, round the result to the device's native decimal places.
Return Value
float Setting value.
m

get()

async available
device_settings.get(setting, unit = Units.NATIVE)
Returns any device setting or property. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
unitUnitsAndLiteralsUnits of setting.
Return Value
float Setting value.
m

get_bool()

async available
device_settings.get_bool(setting)
Returns any device setting or property as a boolean. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
bool Setting value.
m

get_default()

device_settings.get_default(setting, unit = Units.NATIVE)
Returns the default value of a setting.
Arguments
NameTypeDescription
settingstrName of the setting.
unitUnitsAndLiteralsUnits of setting.
Return Value
float Default setting value.
m

get_default_bool()

device_settings.get_default_bool(setting)
Returns the default value of a setting as a boolean.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
bool Default setting value.
m

get_default_int()

device_settings.get_default_int(setting)
Returns the default value of a setting as an integer.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
int Default setting value.
m

get_default_string()

device_settings.get_default_string(setting)
Returns the default value of a setting as a string.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
str Default setting value.
m

get_from_all_axes()

async available
device_settings.get_from_all_axes(setting)
Gets the value of an axis scope setting for each axis on the device. Values may be NaN where the setting is not applicable.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
List[float] The setting values on each axis.
m

get_int()

async available
device_settings.get_int(setting)
Returns any device setting or property as an integer. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
int Setting value.
m

get_many()

async available
device_settings.get_many(*settings)
Gets many setting values in as few device requests as possible.
Arguments
NameTypeDescription
*settingsGetSettingThe settings to read.
Return Value
List[GetSettingResult] The setting values read.
m

get_many_typed()

async available
device_settings.get_many_typed(*settings)
Returns many device settings or properties in their native types in as few requests as possible. Note that specifying units will always return floating point values, even for settings that are natively integers. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
*settingsGetSettingThe settings to read.
Return Value
List[GetSettingTypedResult] The setting values read.
m

get_string()

async available
device_settings.get_string(setting)
Returns any device setting or property as a string. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
str Setting value.
m

get_synchronized()

async available
device_settings.get_synchronized(*settings)
Gets many setting values in the same tick, ensuring their values are synchronized. Requires at least Firmware 7.35.
Arguments
NameTypeDescription
*settingsGetSettingThe settings to read.
Return Value
List[GetSettingResult] The setting values read.
m

get_typed()

async available
device_settings.get_typed(setting, unit = Units.NATIVE)
Returns any device setting or property in its native type. Note that specifying units will cause settings that are otherwise integers to be returned as floats. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
unitUnitsAndLiteralsUnits of setting to convert result to.
Return Value
TypedSetting Setting value.
m

get_unit_conversion_descriptor()

device_settings.get_unit_conversion_descriptor(setting)
Retrieves unit conversion descriptor for a setting, allowing unit conversion without a device. The descriptor can be used with the ConvertTo/FromNativeUnits methods of the UnitTable class.
Arguments
NameTypeDescription
settingstrName of the setting.
Return Value
UnitConversionDescriptor The unit conversion descriptor for the setting.
m

set()

async available
device_settings.set(setting, value, unit = Units.NATIVE)
Sets any device setting. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
valuefloatValue of the setting.
unitUnitsAndLiteralsUnits of setting.
m

set_bool()

async available
device_settings.set_bool(setting, value)
Sets any device setting as a boolean. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
valueboolValue of the setting.
m

set_int()

async available
device_settings.set_int(setting, value)
Sets any device setting or property as an integer. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
valueintValue of the setting.
m

set_string()

async available
device_settings.set_string(setting, value)
Sets any device setting as a string. For more information refer to the ASCII Protocol Manual.
Arguments
NameTypeDescription
settingstrName of the setting.
valuestrValue of the setting.