pylablib.devices.LighthousePhotonics package
Submodules
pylablib.devices.LighthousePhotonics.base module
- exception pylablib.devices.LighthousePhotonics.base.LighthousePhotonicsError[source]
Bases:
DeviceError
Generic Lighthouse Photonics devices error
- add_note()
Exception.add_note(note) – add a note to the exception
- args
- with_traceback()
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception pylablib.devices.LighthousePhotonics.base.LighthousePhotonicsBackendError(exc)[source]
Bases:
LighthousePhotonicsError
,DeviceBackendError
Generic Lighthouse Photonics backend communication error
- add_note()
Exception.add_note(note) – add a note to the exception
- args
- with_traceback()
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- class pylablib.devices.LighthousePhotonics.base.TDeviceInfo(product, version, serial, configuration)
Bases:
tuple
- configuration
- product
- serial
- version
- class pylablib.devices.LighthousePhotonics.base.TWorkHours(controller, laser)
Bases:
tuple
- controller
- laser
- class pylablib.devices.LighthousePhotonics.base.SproutG(conn)[source]
Bases:
ICommBackendWrapper
Lighthouse Photonics Sprout G laser.
- Parameters:
conn – serial connection parameters (usually port)
- Error
alias of
LighthousePhotonicsError
- get_device_info()[source]
Get device information (product name, product version, serial number, configuration)
- get_output_mode()[source]
Get output mode.
Can be
"on"
,"off"
,"idle"
(power standby mode),"calibrate"
,"interlock"
(manual interlock is off),"warmup"
(warmup mode), or"calibration"
(calibration mode).
- set_output_mode(mode='on')[source]
Set output mode.
mode can be
"on"
,"off"
,"idle"
(power standby mode), or"calibrate"
(calibration mode).
- 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, settinginclude=-10
queries all available variables, which is equivalent toinclude="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, settinginclude=-10
queries all available variables, which is equivalent toinclude="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, settinginclude=-10
queries all available variables, which is equivalent toinclude="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
- open()
Open the backend
- 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)