microscope.controllers.coolled._CoolLEDConnection Class Reference

Public Member Functions
None	__init__ (self, microscope._utils.SharedSerial serial)
bytes	get_css (self)
None	set_css (self, bytes css)
typing.List[str]	get_channels (self)

Protected Attributes
	_serial = serial

Detailed Description

Connection to the CoolLED controller, wraps base commands.

Definition at line 36 of file coolled.py.

Constructor & Destructor Documentation

__init__()

None microscope.controllers.coolled._CoolLEDConnection.__init__	(		self,
		microscope._utils.SharedSerial	serial )

Definition at line 39 of file coolled.py.

    def __init__(self, serial: microscope._utils.SharedSerial) -> None:
        self._serial = serial
 
        # When we connect for the first time, we will get back a
        # greeting message like 'CoolLED precisExcite, Hello, pleased
        # to meet you'.  Discard it by reading until timeout.
        self._serial.readlines()
 
        # Check that this behaves like a CoolLED device.
        try:
            self.get_css()
        except Exception:
            raise microscope.InitialiseError(
                "Not a CoolLED device, unable to get CSS"
            )
 

Member Function Documentation

get_channels()

typing.List[str] microscope.controllers.coolled._CoolLEDConnection.get_channels

(

self

)

Return list of channel names (names are one character string).

Definition at line 79 of file coolled.py.

    def get_channels(self) -> typing.List[str]:
        """Return list of channel names (names are one character string)."""
        # answer has the form: [xsnNNN] per channel.  The letter 'x'
        # defines the channel (A to H), 's' refers to S (Selected) or
        # X (Not selected), 'n' refers to N (On) or F (Off) and 'NNN'
        # is the intensity in integer percent.
        return list(self.get_css()[::6].decode())
 
 

get_css()

bytes microscope.controllers.coolled._CoolLEDConnection.get_css

(

self

)

Get the global channel status map.

Definition at line 55 of file coolled.py.

    def get_css(self) -> bytes:
        """Get the global channel status map."""
        with self._serial.lock:
            self._serial.write(b"CSS?\n")
            answer = self._serial.readline()
        if not answer.startswith(b"CSS"):
            raise microscope.DeviceError(
                "answer to 'CSS?' should start with 'CSS'"
                " but got '%s' instead" % answer.decode
            )
        return answer[3:-2]  # remove initial b'CSS' and final b'\r\n'
 

set_css()

None microscope.controllers.coolled._CoolLEDConnection.set_css	(		self,
		bytes	css )

Set status for any number of channels.

Definition at line 67 of file coolled.py.

    def set_css(self, css: bytes) -> None:
        """Set status for any number of channels."""
        assert len(css) % 6 == 0, "css must be multiple of 6 (6 per channel)"
        with self._serial.lock:
            self._serial.write(b"CSS" + css + b"\n")
            answer = self._serial.readline()
        if not answer.startswith(b"CSS"):
            raise microscope.DeviceError(
                "answer to 'CSS?' should start with 'CSS'"
                " but got '%s' instead" % answer.decode
            )
 

Member Data Documentation

_serial

microscope.controllers.coolled._CoolLEDConnection._serial = serial

protected

Definition at line 40 of file coolled.py.

---

The documentation for this class was generated from the following file:

• BioImager/PythonMicroscope/microscope/controllers/coolled.py