:orphan:

CLS Bridge
==========

**From:** `Toptica Photonics <https://www.toptica.com/products/narrow-linewidth-lasers/cls>`_

**Class:** :py:class:`herosdevices.hardware.toptica.clock_laser.Bridge`


**Driver Quality Index:** beta


Driver for Toptica Clock Laser CLS Bridge module.

This class controls the CLS Bridge AOM (Acousto-Optic Modulator) module for Toptica Clock Lasers.
The CLS Bridge allows precise control of the laser frequency through RF signal modulation.

.. tab-set:: 


   .. tab-item:: Arguments
   
   
      Bold arguments are mandatory. For more information on the listed arguments refer to the class             documentation: :py:class:`herosdevices.hardware.toptica.clock_laser.Bridge` If parameters appear in this             list but not in the class definition, please recursively check the linked base classes for the             definition of the parameter.
      
      
      .. list-table:: 
         :widths: 50 50 50 100
         :header-rows: 1
      
         * - Argument
           - Type
           - Default Value
           - Description
         * - **address**
           - **<class 'str'>**
           - 
           - Serial port address for communication.
         * - **freq_max**
           - **<class 'float'>**
           - 
           - Maximum frequency limit of the AOM in Hz (RF signal).
         * - **freq_min**
           - **<class 'float'>**
           - 
           - Minimum frequency limit of the AOM in Hz (RF signal).
         * - timeout
           - <class 'float'>
           - 1.0
           - Communication timeout in seconds (default: 1.0).
      

   .. tab-item:: Example JSON for BOSS
   
      The following JSON strings can be used to start a HERO device representation of             :py:class:`Bridge <herosdevices.hardware.toptica.clock_laser.Bridge>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.
      
      .. code-block:: json
      
         {
             "_id": "my_Bridge",
             "classname": "herosdevices.hardware.toptica.clock_laser.Bridge",
             "arguments": {
                 "address": "/dev/ttyACM0",
                 "freq_max": 220000000.0,
                 "freq_min": 260000000.0,
                 "timeout": 1.0
             }
         }
      
      :sup:`from examples/toptica/cls_bridge.json` 
      
      
      .. code-block:: json
      
         {
             "_id": "my_Bridge",
             "classname": "herosdevices.hardware.toptica.clock_laser.Bridge",
             "arguments": {
                 "address": "<class 'str'>",
                 "freq_max": "<class 'float'>",
                 "freq_min": "<class 'float'>",
                 "timeout": 1.0
             }
         }
      
      :sup:`generated from signature`
   .. tab-item:: Inheritance
   
   
      .. inheritance-diagram:: herosdevices.hardware.toptica.clock_laser.Bridge