pyccapt.control.nkt_photonics package

Submodules

pyccapt.control.nkt_photonics.nktpbus_activate module

Standalone helper: switch an Origami OXPS from CLI mode to NKTPBus.

Vendor / origin

The ly_oxp2_nktpbus CLI command sent below is part of the NKT Photonics A/S Origami XPS CLI protocol. This file is adapted from an example shipped with the NKT SDK (originally authored by Ian Baker, NKT Photonics).

For the reverse direction (NKTPBus -> CLI from Python) see nktpbus_switch.py in this folder, which uses NKT’s NKTPDLL.

pyccapt.control.nkt_photonics.origamiClassCLI module

Origami XPS laser control over the vendor CLI protocol.

Vendor / origin

The CLI command set used in this module (ly_oxp2_*, e_freq, e_div, e_mode, e_power, e_mlp, ls_wavelength, etc.) is defined and owned by NKT Photonics A/S for their Origami XP / XPS series femtosecond lasers. This file is a thin Python wrapper around that ASCII serial protocol; the protocol itself is documented in NKT’s CLI reference and the Origami QSG (see T:/Monajem/Oxcart_laser_manual/ on the lab network and 800-621-0X.pdf series).

The original wrapper (origClass) was authored by Ian Baker (NKT Photonics), version 1.1 and shipped as an example with the NKT SDK. Subsequent edits in this repository are local extensions for pyccapt integration; the underlying CLI commands remain NKT’s.

Use of the Origami / OXPS hardware and its CLI protocol is subject to NKT Photonics’ licence terms; consult NKT’s documentation before distributing this file outside this project.

class pyccapt.control.nkt_photonics.origamiClassCLI.origClass(comPort)[source]

Bases: object

AOM(power)[source]
AOMDisable()[source]
AOMEnable()[source]
AOMRead()[source]
AOMState()[source]
DigitalGateLogic(choice)[source]
DigitalGateLogicRead()[source]
Div(division)[source]
DivRead()[source]
Enable()[source]
Freq(freq)[source]
FreqRead()[source]
InterbusEnable()[source]
Listen()[source]
Mode(mode)[source]
ModeRead()[source]
Power(power)[source]

Set the IR seed/pump power setpoint of the OXPS.

Units: power is in Watts (the same convention as the max_laser_power config entry and the test report, e.g. “IR power set to 4.65 W”). Range is 0 .. max_laser_power.

The corresponding CLI command is ly_oxp2_power=<value>; the firmware echoes back ly_oxp2_power <value> on success.

PowerRead()[source]
ServiceMode()[source]
Standby()[source]
StatusMode()[source]
StatusRead()[source]
Temp(comPort)[source]
close_port()[source]
freq_avaliable()[source]
open_port()[source]
power_read_dv_green()[source]
read_average_power()[source]
status_led()[source]
wavelength_change(wavelength)[source]
wavelength_read()[source]

Module contents