qcodespp.instrument_drivers.attocube.AMC100

Classes

Module Contents

class qcodespp.instrument_drivers.attocube.AMC100.MultiAxisPosition

Bases: collections.abc.Sequence[float]

A tuple-like representation of (a subset of) axis positions.

Use this class to set any number of positions simultaneously using AttocubeAMC100.multi_axis_position.

axis_1: float

axis_2: float

axis_3: float

__getitem__(index: int, /) → float
__getitem__(index: slice, /) → collections.abc.Sequence[float]

__len__() → int

class qcodespp.instrument_drivers.attocube.AMC100.MultiAxisPositionParameter(name: str, *args: Any, names: collections.abc.Sequence[str] = _NAMES_UNSET, shapes: collections.abc.Sequence[collections.abc.Sequence[int]] = _SHAPES_UNSET, instrument: qcodes.parameters.parameter_base.InstrumentTypeVar_co = None, labels: collections.abc.Sequence[str] | None = None, units: collections.abc.Sequence[str] | None = None, setpoints: collections.abc.Sequence[collections.abc.Sequence[Any]] | None = None, setpoint_names: collections.abc.Sequence[collections.abc.Sequence[str]] | None = None, setpoint_labels: collections.abc.Sequence[collections.abc.Sequence[str]] | None = None, setpoint_units: collections.abc.Sequence[collections.abc.Sequence[str]] | None = None, docstring: str | None = None, snapshot_get: bool = True, snapshot_value: bool = False, snapshot_exclude: bool = False, metadata: collections.abc.Mapping[Any, Any] | None = None, **kwargs: Any)

Bases: qcodes.parameters.MultiParameter

A parameter that simulatenously sets multiple axis positions.

Always returns all three axes, but accepts a variable number for setting. The following are allowed for the single value argument:

an instance of MultiAxisPosition

a mapping with possible keys axis_1, axis_2, axis_3 and float values

a sequence of floats which will be interpreted as (axis_1, axis_2, …)

get_raw() → qcodes.parameters.ParamRawDataType: get_raw is called to perform the actual data acquisition from the instrument. This method should either be overwritten to perform the desired operation or alternatively for Parameter a suitable method is automatically generated if get_cmd is supplied to the parameter constructor. The method is automatically wrapped to provide a get method on the parameter instance.

set_raw(value: qcodes.parameters.ParamRawDataType) → None: set_raw is called to perform the actual setting of a parameter on the instrument. This method should either be overwritten to perform the desired operation or alternatively for Parameter a suitable method is automatically generated if set_cmd is supplied to the parameter constructor. The method is automatically wrapped to provide a set method on the parameter instance.

class qcodespp.instrument_drivers.attocube.AMC100.AMC100Axis(parent: AttocubeAMC100, name: str, axis: int, label: str | None = None, **kwargs: Any)

Bases: qcodes.instrument.InstrumentChannel

Base class for a module in an instrument. This could be in the form of a channel (e.g. something that the instrument has multiple instances of) or another logical grouping of parameters that you wish to group together separate from the rest of the instrument.

Args:

parent: The instrument to which this module should be: attached.

name: The name of this module. **kwargs: Forwarded to the base class.

actor_type

open_loop_status

reference_position_valid

reference_position

position

frequency

amplitude

output

move_to_reference_position()

This function starts an approach to the reference position.

A running motion command is aborted; closed loop moving is switched on. Requires a valid reference position.

single_step(backward: bool)

This function triggers one step on the selected axis in desired direction.

Parameters

backwardSelects the desired direction. False triggers a: forward step, true a backward step.

class qcodespp.instrument_drivers.attocube.AMC100.AttocubeAMC100(name: str, address: str | None = None, axis_labels: collections.abc.Sequence[str] = (), **kwargs: Any)

Bases: qcodes.instrument.Instrument

Driver for the AMC100 position controller.

device

all_on() → None

all_off() → None

property exception_type: Exception

close()

Irreversibly stop this instrument and free its resources.

Subclasses should override this if they have other specific resources to close.

get_idn() → dict[str, str | None]

Parse a standard VISA *IDN? response into an ID dict.

Even though this is the VISA standard, it applies to various other types as well, such as IPInstruments, so it is included here in the Instrument base class.

Override this if your instrument does not support *IDN? or returns a nonstandard IDN string. This string is supposed to be a comma-separated list of vendor, model, serial, and firmware, but semicolon and colon are also common separators so we accept them here as well.

Returns:: A dict containing vendor, model, serial, and firmware.