device

frog.gui.hardware_set.device

Helper functions for managing connections to devices.

Classes

ConnectionStatus

Bases: Enum

The connection state of a device.

OpenDeviceArgs(instance, class_name, params=frozendict()) dataclass

Arguments needed to open a device.

Functions

close()

Close the device.

Source code in frog/gui/hardware_set/device.py

def close(self) -> None:
    """Close the device."""
    close_device(self.instance)

create(instance, class_name, params=frozendict()) classmethod

Create an OpenDeviceArgs using basic types.

Source code in frog/gui/hardware_set/device.py

@classmethod
def create(
    cls, instance: str, class_name: str, params: Mapping[str, Any] = frozendict()
) -> OpenDeviceArgs:
    """Create an OpenDeviceArgs using basic types."""
    return cls(DeviceInstanceRef.from_str(instance), class_name, frozendict(params))

open()

Open the device.

Source code in frog/gui/hardware_set/device.py

def open(self) -> None:
    """Open the device."""
    open_device(self.class_name, self.instance, self.params)

Functions

close_device(instance)

Close a connection to a device.

Source code in frog/gui/hardware_set/device.py

def close_device(instance: DeviceInstanceRef) -> None:
    """Close a connection to a device."""
    pub.sendMessage("device.close", instance=instance)

open_device(class_name, instance, params)

Open a connection to a device.

Source code in frog/gui/hardware_set/device.py

def open_device(
    class_name: str, instance: DeviceInstanceRef, params: Mapping[str, Any]
) -> None:
    """Open a connection to a device."""
    pub.sendMessage(
        "device.open", class_name=class_name, instance=instance, params=params
    )