navigate.model.devices.APIs.coherent.ObisLaser.ObisLaser

class navigate.model.devices.APIs.coherent.ObisLaser.ObisLaser(port='COM4')

Bases: LaserBase

__init__(port='COM4')

Initialize Laser Base Class

Parameters:

• microscope_name (str) – Name of the microscope

• device_connection (Any) – Communication instance with the device.

• configuration (Dict[str, Any]) – Configuration dictionary

• laser_id (int) – Laser ID

Methods

__init__([port])	Initialize Laser Base Class
ask(command)
close()	# Close the port before exit.
get_ext_control()	# Get the external control status.
get_laser_model()	# Get the laser model.
get_laser_operating_mode()	# Get the laser operating mode.
get_laser_power()	# Get the current laser power in mW.
get_laser_status()	# Get the current laser status.
get_laser_wavelength()	# Get the current laser wavelength in nm.
get_maximum_laser_power()	# Get the maximum laser power in mW.
get_minimum_laser_power()	# Get the maximum laser power in mW.
initialize_laser()	# Initialize the laser.
set_laser_operating_mode(mode)	# Set the laser operating mode.
set_power(laser_intensity)	Set laser power
turn_off()	Turn off the laser
turn_on()	Turn on the laser

Attributes

timeout	The timeout for the laser in seconds.
end_of_line	The end of line character for the laser
laser	The serial port for the laser.

close()

# Close the port before exit.

get_ext_control()

# Get the external control status.

get_laser_model()

# Get the laser model.

get_laser_operating_mode()

# Get the laser operating mode.

get_laser_power()

# Get the current laser power in mW.

get_laser_status()

# Get the current laser status.

get_laser_wavelength()

# Get the current laser wavelength in nm.

get_maximum_laser_power()

# Get the maximum laser power in mW.

get_minimum_laser_power()

# Get the maximum laser power in mW.

initialize_laser()

# Initialize the laser.

set_laser_operating_mode(mode)

# Set the laser operating mode. # Seven mutually exclusive operating modes are available # CWP (continuous wave, constant power) # CWC (continuous wave, constant current) # DIGITAL (CW with external digital modulation) # ANALOG (CW with external analog modulation) # MIXED (CW with external digital + analog modulation) # DIGSO (External digital modulation with power feedback) Note: This # operating mode is not supported in some device models. # MIXSO (External mixed modulation with power feedback) Note: This # operating mode is not supported in some device models.

set_power(laser_intensity: int) → None

Set laser power

Parameters:

laser_intensity (int) – Laser intensity

turn_off() → None

Turn off the laser

turn_on() → None

Turn on the laser

configuration

Configuration dictionary

Type:

dict

device_config

Laser ID

Type:

int

device_connection

Communication instance with the device

Type:

Any

end_of_line

The end of line character for the laser

Type:

str

laser

The serial port for the laser.

Type:

serial.Serial

microscope_name

Name of the microscope

Type:

str

timeout

The timeout for the laser in seconds.

Type:

float