herosdevices.hardware.menlo.laser_lock
======================================

.. py:module:: herosdevices.hardware.menlo.laser_lock

.. autoapi-nested-parse::

   HERO driver for a laser-lock module (DDS + closed lock loop) of a Menlo Systems frequency comb.





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

.. py:class:: LaserLock(ofc: herosdevices.hardware.menlo.ofc.OFC, funclayer_identifier: str, frequency_distribution_node: str = 'frequencyDistribution', amp_node: str | None = None, observables: dict[str, dict[str, str]] | None = None)

   Bases: :py:obj:`herosdevices.hardware.menlo.dds.DDS`


   Driver for a laser-lock module of a Menlo Systems frequency comb.

   Extends :py:class:`~herosdevices.hardware.menlo.DDS` with the closed feedback loop (a beat-note PLL)
   that locks the DDS to a reference. Use :py:class:`~herosdevices.hardware.menlo.DDS` directly for a
   module that only exposes a bare DDS output with no lock loop.

   :param ofc: The OFC HERO this laser-lock module belongs to.
   :param funclayer_identifier: Identifier of the module's functional-layer settings object, e.g. "cw1112_1"
                                for the sub-tree at `functionalLayer.cw1112_1Settings`. Use `ofc.explore("functionalLayer")` to
                                find the identifier for a given module.
   :param frequency_distribution_node: Relative node name of this module's frequency-distribution block.
                                       Defaults to `"frequencyDistribution"`, the plain CW-channel node name. Dual-wavelength channels
                                       (see :py:class:`~herosdevices.hardware.menlo.dual_laser_lock.DualLaserLock`) use a
                                       wavelength-suffixed name instead, since they have two such blocks.
   :param amp_node: Relative node name of this module's laser-diode current-control block (`amp*`), if it has
                    one - not every CW channel does (e.g. `cw578vexlumSettings` has none). `None` (the default)
                    leaves :py:attr:`current_control` unset.
   :param observables: Additional observables to poll, merged on top of `DEFAULT_OBSERVABLES`, see
                       :py:class:`~herosdevices.hardware.menlo.functional_layer.FunctionalLayerModule`.


   .. py:attribute:: DEFAULT_OBSERVABLES
      :type:  dict[str, dict[str, str]]


   .. py:attribute:: locked


   .. py:attribute:: fast_output_setpoint


   .. py:attribute:: fast_output_locked


   .. py:attribute:: fast_output_monitor


   .. py:attribute:: unlock_here


   .. py:attribute:: frequency_control


   .. py:attribute:: frequency_distribution


   .. py:attribute:: select_monitor


   .. py:attribute:: current_control


   .. py:property:: amplifier_enabled
      :type: bool


      Whether the loop's actuator amplifier (e.g. piezo/current driver) is enabled.


   .. py:property:: slow_branch_setpoint
      :type: float


      Setpoint of the loop's slow feedback branch.


   .. py:property:: slow_branch_locked
      :type: bool


      Whether the loop's slow feedback branch is currently locked. Read-only status.


   .. py:property:: slow_branch_monitor
      :type: float


      Monitor voltage of the loop's slow feedback branch. Read-only.


   .. py:attribute:: amp_max
      :type:  float
      :value: 1.0



   .. py:attribute:: amp_min
      :type:  float
      :value: 0.0



   .. py:attribute:: freq_max
      :type:  float
      :value: 100000000.0



   .. py:attribute:: freq_min
      :type:  float
      :value: 0.0



   .. py:property:: output_enabled
      :type: bool


      Whether the DDS output is enabled.


   .. py:attribute:: ofc


   .. py:attribute:: base_path


   .. py:attribute:: observables


   .. py:method:: get(relative_path: str) -> Any

      Read the current value of a node relative to this module's settings object.

      Use this for module properties not already exposed as a named attribute. See
      :py:meth:`~herosdevices.hardware.menlo.ofc.OFC.explore` to find the available relative paths,
      e.g. `ofc.explore(module.base_path, depth=2)`.

      :param relative_path: Dotted path relative to `base_path`.

      :returns: The current value of the node.



   .. py:method:: set(relative_path: str, value: Any) -> None

      Set the value of a node relative to this module's settings object.

      :param relative_path: Dotted path relative to `base_path`, see :py:meth:`get`.
      :param value: Value to set.



   .. py:attribute:: frequency
      :type:  float
      :value: 1000000.0



   .. py:attribute:: amplitude
      :type:  float
      :value: 0.1



   .. py:attribute:: phase
      :type:  float
      :value: 0.0



   .. py:attribute:: default_ramp_steps
      :type:  int
      :value: 30



   .. py:attribute:: blind
      :type:  bool
      :value: False