mpbc-vyfa-sf 0.3.0

Python interface for a MPB VYFA amplifier

MPBC-VYFA-SF

Python interface for a MPB Communications VYFA-SF Series amplifier

Communication is over a serial (USB-CDC / COM) port using pyserial.

Installation

pip install mpbc-vyfa-sf

or, for development with uv:

uv sync

Methods and attributes of the MPBAmplifier class

• enable_laser()
  start laser emission
• disable_laser()
  disable laser emission
• get_faults()
  get all faults of the amplifier
• get_alarms()
  get all alarms of the amplifier
• enter_test_environment()
  enter the test environment of the amplifier, required to change the SHG temperature setpoint
• save_all()
  save settings to non-volatile memory
• model
  amplifier model
• serial
  serial number
• enabled
  boolean for laser emision status
• state
• laser_state
  Current state of the laser; e.g. BOOSTER_ON, OFF etc. see enums.py for more.
• mode
• seed_current
  mA
• preamp_current
  mA
• booster_current
  mA
• booster_current_setpoint
  get and set the booster current setpoint
• shg_temperature
  C
• shg_temperature setpoint
  get and set the shg temperature setpoint in C
• seed_power
  mW
• output_power
  mW
• output_power_setpoint
  if power_stabilization is enabled (set to True) this gets and sets the output power setpoint in mW
• power_stabilization
  enable or disable (True or False) the output power stabilization. Only settable when emission is disabled.

Example

from mpbc_vyfa_sf import MPBAmplifier

# port is the serial COM port; baud_rate (default 9600) and timeout in seconds
# (default 2.0) are optional
amp = MPBAmplifier(port="COM4", baud_rate=9600, timeout=2.0)

# get the current laser state
amp.laser_state

# get the seed power
amp.seed_power

# enable the laser
amp.enable_laser()

# get the output power
amp.output_power

# disable the laser
amp.disable_laser()

MPBAmplifier can also be used as a context manager, which closes the serial port on exit:

with MPBAmplifier(port="COM4") as amp:
    print(amp.laser_state)