pylablib.devices.Toptica package

Submodules

pylablib.devices.Toptica.base module

exception pylablib.devices.Toptica.base.TopticaError[source]

Bases: pylablib.core.devio.base.DeviceError

Generic Toptica device error

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception pylablib.devices.Toptica.base.TopticaBackendError(exc)[source]

Bases: pylablib.devices.Toptica.base.TopticaError, pylablib.core.devio.comm_backend.DeviceBackendError

Toptica backend communication error

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pylablib.devices.Toptica.ibeam module

pylablib.devices.Toptica.ibeam.muxchan(*args, **kwargs)[source]

Multiplex the function over its addr argument

class pylablib.devices.Toptica.ibeam.TDeviceInfo(serial, version)

Bases: tuple

count()

Return number of occurrences of value.

index()

Return first index of value.

Raises ValueError if the value is not present.

serial
version
class pylablib.devices.Toptica.ibeam.TWorkHours(power_up, laser_on)

Bases: tuple

count()

Return number of occurrences of value.

index()

Return first index of value.

Raises ValueError if the value is not present.

laser_on
power_up
class pylablib.devices.Toptica.ibeam.TTemperatures(diode, baseplate)

Bases: tuple

baseplate
count()

Return number of occurrences of value.

diode
index()

Return first index of value.

Raises ValueError if the value is not present.

class pylablib.devices.Toptica.ibeam.TopticaIBeam(conn='COM1')[source]

Bases: pylablib.core.devio.comm_backend.ICommBackendWrapper

Toptica iBeam smart laser controller.

Parameters:
  • conn – connection parameters - index of the Attocube ANC350 in the system (for a single controller leave 0)
  • timeout (float) – default operation timeout
Error

alias of pylablib.devices.Toptica.base.TopticaError

open()[source]

Open the backend

query(comm, multiline=False, keep_whitespace=False, check_error='FEW', reply=True)[source]
reboot()[source]

Reboot the laser system

get_device_info()[source]

Get the device info of the laser system: (serial, version)

get_full_data(formatted=False)[source]

Return the comprehensive device data

get_work_hours()[source]

Get the work hours (power on time and laser on time)

get_channels_number()[source]

Get number of supported laser channels

is_enabled()[source]

Check if the output is enabled

enable(enabled=True)[source]

Turn the output on or off

is_channel_enabled(channel='all')[source]

Check if the specific channel is enabled

enable_channel(channel, enabled=True)[source]

Turn the specific channel on or off

get_channel_power(channel='all')[source]

Get specified channel power (in W)

set_channel_power(channel, power)[source]

Set channel power (in W)

get_output_power()[source]

Get current output power (in W)

get_drive_current()[source]

Get current diode drive current (in A)

get_current_limits()[source]

Get settings of all current limits (in A) as a dictionary

get_temperatures()[source]

Get settings of all current limits (in A) as a dictionary

class NoParameterCaller(device, kind)

Bases: object

Class to simplify calling functions without a parameter

apply_settings(settings)

Apply the settings.

settings is the dict {name: value} of the device available settings. Non-applicable settings are ignored.

close()

Close the backend

get_device_variable(key)

Get the value of a settings, status, or full info parameter

get_full_info(include=0)

Get dict {name: value} containing full device information (including status and settings).

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

get_full_status(include=0)

Get dict {name: value} containing the device status (including settings).

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

get_settings(include=0)

Get dict {name: value} containing all the device settings.

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

is_opened()

Check if the device is connected

lock(timeout=None)

Lock the access to the device from other threads/processes (isn’t necessarily implemented)

locking(timeout=None)

Context manager for lock & unlock

set_device_variable(key, value)

Set the value of a settings parameter

unlock()

Unlock the access to the device from other threads/processes (isn’t necessarily implemented)

Module contents