microscope.controllers.zaber._ZaberLEDController Class Reference

Inheritance diagram for microscope.controllers.zaber._ZaberLEDController:

Public Member Functions
None	__init__ (self, _ZaberConnection conn, int device_address, **kwargs)
typing.Dict[str, _ZaberLED]	devices (self)
typing.Mapping[str, Device]	devices (self)
Public Member Functions inherited from microscope.abc.Device
None	__init__ (self)
None	__del__ (self)
bool	get_is_enabled (self)
None	disable (self)
None	enable (self)
None	initialize (self)
None	shutdown (self)
None	add_setting (self, name, dtype, get_func, set_func, values, typing.Optional[typing.Callable[[], bool]] readonly=None)
def	get_setting (self, str name)
def	get_all_settings (self)
None	set_setting (self, str name, value)
def	describe_setting (self, str name)
def	describe_settings (self)
def	update_settings (self, incoming, bool init=False)

Additional Inherited Members
Public Attributes inherited from microscope.abc.Device
	enabled

Detailed Description

This effectively means a Zaber X-LCA4 LED controller.

The X-LCA4 series is so far the only LED controller Zaber has.
Its documentation is not included on the ASCII protocol manual,
see the `controller specific manual online
<https://www.zaber.com/protocol-manual?device=X-LCA4>`_

Definition at line 479 of file zaber.py.

Constructor & Destructor Documentation

__init__()

None microscope.controllers.zaber._ZaberLEDController.__init__	(		self,
		_ZaberConnection	conn,
		int	device_address,
		**	kwargs
	)

Reimplemented from microscope.abc.Device.

Definition at line 489 of file zaber.py.

    ) -> None:
        super().__init__(**kwargs)
        self._dev_conn = _ZaberDeviceConnection(conn, device_address)
        self._leds: typing.Dict[str, _ZaberLED] = {}
 
        all_lamps = self._dev_conn.command(b"get lamp.status").response.split()
        # We get one status per peripheral connection.  Documentation
        # states that a value of "0" means unplugged but with X-LCA4,
        # firmware version 7.13 and build 8074, we get NA for
        # unplugged.  Also not sure how 0 (unplugged) would differ
        # from 5 (peripheral not connected).  So we count as valid
        # those with status 1 (turned off), 2 (turned on), and 3
        # (fault).
        for i, lamp_state in enumerate(all_lamps, start=1):
            if lamp_state in [b"1", b"2", b"3"]:
                # The labels on the controller are LED1, LED2, etc, so
                # use the same for key.
                self._leds["LED%d" % i] = _ZaberLED(self._dev_conn, i)
            else:
                _logger.info("no LED %d, status is %s", i, lamp_state.decode())
 

Member Function Documentation

devices()

typing.Dict[str, _ZaberLED] microscope.controllers.zaber._ZaberLEDController.devices

(

self

)

Map of names to the controlled devices.

Reimplemented from microscope.abc.Controller.

Definition at line 513 of file zaber.py.

    def devices(self) -> typing.Dict[str, _ZaberLED]:
        return self._leds
 
 

Referenced by microscope.abc.Controller.devices().

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/controllers/zaber.py