navigate.model.devices.shutter.base.ShutterBase

class navigate.model.devices.shutter.base.ShutterBase(microscope_name: str, device_connection: Any, configuration: Dict[str, Any])

Bases: object

ShutterBase Class - Parent class for the laser shutters.

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

Initialize the Shutter.

Parameters:

• microscope_name (str) – Name of microscope in configuration

• device_connection (Any) – Hardware device to connect to

• configuration (Dict[str, Any]) – Global configuration of the microscope

Methods

__init__(microscope_name, device_connection, ...)	Initialize the Shutter.
close_shutter()	Close the Shutter.
open_shutter()	Open the Shutter.

Attributes

state	Get the Shutter state.
shutter_state	Shutter state
microscope_name	Name of the microscope
device_connection	Hardware device to connect to
configuration	Global configuration of the microscope

close_shutter() → None

Close the Shutter.

open_shutter() → None

Open the Shutter.

configuration

Global configuration of the microscope

Type:

Dict[str, Any]

device_connection

Hardware device to connect to

Type:

Any

microscope_name

Name of the microscope

Type:

str

shutter_state

Shutter state

Type:

bool

property state: bool

Get the Shutter state.

Returns:

Shutter state. True if open, False if closed.

Return type:

bool