controller_device

plantimager.commons.controller_device

ControllerDevice

ControllerDevice()

Bases: ABC

Abstract class for controller device.

Source code in plantimager/commons/controller_device.py

def __init__(self):
    pass

camera_names abstractmethod

camera_names()

Return the list of camera names.

Source code in plantimager/commons/controller_device.py

@RPCProperty(notify=cameraNamesChanged)
@abstractmethod
def camera_names(self) -> list[str]:
    """Return the list of camera names."""
    pass

max_progress abstractmethod

max_progress()

Return the maximum progress of the scan.

Source code in plantimager/commons/controller_device.py

@RPCProperty(notify=maxProgressChanged)
@abstractmethod
def max_progress(self) -> int:
    """Return the maximum progress of the scan."""
    pass

progress abstractmethod

progress()

Return the current progress of the scan.

Source code in plantimager/commons/controller_device.py

@RPCProperty(notify=progressChanged)
@abstractmethod
def progress(self) -> int:
    """Return the current progress of the scan."""
    pass

ready_to_scan abstractmethod

ready_to_scan()

Return whether the controller is ready to start a scan.

Source code in plantimager/commons/controller_device.py

@RPCProperty(notify=readyToScanChanged)
@abstractmethod
def ready_to_scan(self) -> bool:
    """Return whether the controller is ready to start a scan."""
    pass

run_scan abstractmethod

run_scan()

Start the scan.

Source code in plantimager/commons/controller_device.py

@abstractmethod
def run_scan(self):
    """Start the scan."""
    pass

set_api_token abstractmethod

set_api_token(token)

Set the session token to use for authenticated requests.

Source code in plantimager/commons/controller_device.py

@abstractmethod
def set_api_token(self, token: str):
    """Set the session token to use for authenticated requests."""
    pass

set_config abstractmethod

set_config(config)

Send a configuration dictionary to the controller.

Source code in plantimager/commons/controller_device.py

@abstractmethod
def set_config(self, config: dict):
    """Send a configuration dictionary to the controller."""
    pass

set_dataset_name abstractmethod

set_dataset_name(name)

Set the name of the dataset to be created.

Source code in plantimager/commons/controller_device.py

@abstractmethod
def set_dataset_name(self, name: str):
    """Set the name of the dataset to be created."""
    pass

set_db_url abstractmethod

set_db_url(url)

Set the database URL for the controller.

Source code in plantimager/commons/controller_device.py

@abstractmethod
def set_db_url(self, url: str):
    """Set the database URL for the controller."""
    pass