navigate.model.devices.remote_focus.equipment_solutions.EquipmentSolutionsRemoteFocus

class navigate.model.devices.remote_focus.equipment_solutions.EquipmentSolutionsRemoteFocus(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], *args, **kwargs)

Bases: NIRemoteFocus, SerialDevice

RemoteFocusEquipmentSolutions Class

Note

The SCA814 has a single character input buffer that can be overflowed if the proper steps are not taken. To avoid overflowing the input buffer the user should send a single character at a time and wait for that same character to be echoed back by the controller. While not necessary, it is advisable to verify that the character received from the controller is the same character sent. Once the character is received the next character can be processed.

__init__(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], *args, **kwargs) → None

Initialize the RemoteFocusEquipmentSolutions Class

Parameters:

• microscope_name (str) – Name of the microscope

• device_connection (Any) – Connection to the device

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

Methods

__init__(microscope_name, device_connection, ...)	Initialize the RemoteFocusEquipmentSolutions Class
adjust(exposure_times, sweep_times[, offset])	Adjust the waveform.
connect([port, baudrate, timeout])	Connect to Serial Communication Port port : str Serial Port (default is "COM1") baudrate : int, optional Baud rate of the serial port (default is 115200) timeout : float, optional Time out (default is 1.25)
disconnect()	Disconnect from serial device.
move(exposure_times, sweep_times[, offset])	Move the remote focus.
read_bytes(num_bytes)	Read the specified number of bytes from RemoteFocusEquipmentSolutions.
send_command(message)	Send write command to the RemoteFocusEquipmentSolutions device.

Attributes

comport	Name of the RS232 communication port.
timeout	Timeout for the serial port.
read_on_init	Read on initialization.
debug	Debug mode.

adjust(exposure_times, sweep_times, offset=None)

Adjust the waveform.

This method adjusts the waveform.

Parameters:

• exposure_times (dict) – Dictionary of exposure times for each selected channel

• sweep_times (dict) – Dictionary of sweep times for each selected channel

• offset (float) – The offset of the signal in volts.

Returns:

waveform_dict – The waveform dictionary.

Return type:

dict

classmethod connect(port: str = 'COM1', baudrate: int = 115200, timeout: float = 1.25) → Serial

Connect to Serial Communication Port port : str

Serial Port (default is “COM1”)

baudrateint, optional

Baud rate of the serial port (default is 115200)

timeoutfloat, optional

Time out (default is 1.25)

Returns:

An instance of the serial connection

Return type:

serial.Serial

Raises:

UserWarning – If there is a communication error with the serial port

disconnect()

Disconnect from serial device.

move(exposure_times, sweep_times, offset=None)

Move the remote focus.

This method moves the remote focus.

Parameters:

• exposure_times (dict) – Dictionary of exposure times for each selected channel

• sweep_times (dict) – Dictionary of sweep times for each selected channel

• offset (float) – The offset of the signal in volts.

read_bytes(num_bytes: int) → bytes

Read the specified number of bytes from RemoteFocusEquipmentSolutions.

Parameters:

num_bytes (int) – Number of bytes to receive

Returns:

received_bytes – Number of bytes received from the RemoteFocusEquipmentSolutions device.

Return type:

bytes

Raises:

UserWarning – If the serial port to the RemoteFocusEquipmentSolutions is connected, but it isn’t responding as expected.

send_command(message: str)

Send write command to the RemoteFocusEquipmentSolutions device.

Parameters:

message (str) – Message to send to the RemoteFocusEquipmentSolutions device. If str == ‘close’, shutdown device.

Raises:

UserWarning – If there is an error in communicating with the RemoteFocusEquipmentSolutions device.

board_name

The board name.

Type:

str

camera_delay

Camera delay percent.

Type:

float

comport

Name of the RS232 communication port.

Type:

str

configuration

Configuration dictionary.

Type:

dict

daq

The device connection object.

Type:

object

debug

Debug mode.

Type:

bool

device_config

Remote focus device parameters.

Type:

dict

device_connection

Device connection object.

Type:

Any

microscope_name

Name of the microscope.

Type:

str

read_on_init

Read on initialization.

Type:

bool

remote_focus_max_voltage

Remote focus max voltage.

Type:

float

remote_focus_min_voltage

Remote focus min voltage.

Type:

float

sample_rate

Sample rate of the DAQ.

Type:

int

sweep_time

Sweep time of the DAQ.

Type:

float

timeout

Timeout for the serial port.

Type:

float

trigger_source

The trigger source (e.g., physical channel).

Type:

str

waveform_dict

Waveform dictionary.

Type:

dict