herosdevices.hardware.santec.template
=====================================

.. py:module:: herosdevices.hardware.santec.template

.. autoapi-nested-parse::

   Template for Santec SLMs.





Module Contents
---------------

.. py:class:: SantecSLMTemplate

   Template for Santec SLMs.

   Has no functionality, use the derived classes instead.


   .. py:method:: firmware_serialnumber() -> str
      :abstractmethod:


      Get the serial number of the santec firmware running on the SLM.

      This not the same as the serial number used to identify the FTDI chip.

      :returns: Serial number.



   .. py:method:: video_mode(mode: int = 0) -> str
      :abstractmethod:


      Query or set the video source the SLM draws the images from.

      :param mode: Video source. Consult the manual for for possible sources.



   .. py:method:: push_image(slot: int, image: numpy.typing.NDArray[numpy.uint16]) -> str
      :abstractmethod:


      Upload an image into a specified memory slot.

      :param slot: Slot number. Slot numbers range from 1 to 128.
      :param image: The image.



   .. py:method:: contrast_level(value: int) -> str
      :abstractmethod:


      Set the contrast/gamma level of the LCOS.



   .. py:method:: display_slot(slot: int = 1) -> str
      :abstractmethod:


      Set the memory slot to display on the SLM.

      :param slot: Slot number. The lowest slot number is 1.