navigate.model.devices.shutter.asi.ASIShutter
- class navigate.model.devices.shutter.asi.ASIShutter(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], address=None)
Bases:
ShutterBase
,SerialDevice
ShutterTTL Class
Triggering for shutters delivered from the TigerController. Each output keeps their last digital state for as long the device is not powered down.
- __init__(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], address=None) → None
Initialize the ASIShutter.
- 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 ASIShutter.
Closes the shutter.
connect
(port[, baudrate, timeout])Build ASILaser Serial Port connection
Disconnect from serial device.
Opens the shutter.
Attributes
Get the state of the shutter.
Address of the shutter, if applicable.
ASI Tiger Controller object.
Axis of the shutter.
Port for communicating with the shutter.
- close_shutter() → None
Closes the shutter.
- Raises:
Exception – If there is an error while trying to close the shutter.
- classmethod connect(port, baudrate=115200, timeout=0.25)
Build ASILaser Serial Port connection
- Parameters:
port (str) – Port for communicating with the shutter, e.g., COM1.
baudrate (int) – Baud rate for communicating with the shutter, default is 115200.
timeout (float) – Timeout for communicating with the shutter, default is 0.25.
- Returns:
tiger_controller – ASI Tiger Controller object.
- Return type:
TigerController
- disconnect()
Disconnect from serial device.
- open_shutter() → None
Opens the shutter.
- Raises:
Exception – If there is an error while trying to open the shutter.
- address
Address of the shutter, if applicable.
- Type:
str
- axis
Axis of the shutter.
- Type:
str
- 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
- port
Port for communicating with the shutter.
- Type:
str
- shutter
ASI Tiger Controller object.
- Type:
TigerController
- shutter_state
Shutter state
- Type:
bool
- property state: bool
Get the state of the shutter.
- Returns:
True if the shutter is open, False if it is closed.
- Return type:
bool