:orphan:

.. _device-WSx:

WSx
===

**From:** `HighFinesse GmbH <https://www.highfinesse.com/en/wavelengthmeter/index.html#wavelengthmeter-overview>`_
**Class:** :py:class:`herosdevices.hardware.highfinesse.wsx.WSx`

**Driver Quality Index:** beta

A Highfinesse WSx series wavelength meter.

Tested with WS6,WS7 and WS8.

Hardware driver to communicate with a High Finesse WSx Wavemeter via the DLL in present in Windows systems with
the vendor software installed.

.. 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.highfinesse.wsx.WSx` 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
           * - dll_path
             - <class 'str'>
             - C:\Windows\System32\wlmData.dll
             - 
           * - wavemeter_index
             - <class 'int'>
             - 0
             - 
           * - channels
             - <class 'tuple'>
             - (1, 2, 3, 4, 5, 6, 7, 8)
             - 

    .. tab-item:: Example JSON for BOSS

        The following JSON strings can be used to start a HERO device representation of             :py:class:`WSx <herosdevices.hardware.highfinesse.wsx.WSx>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.

        .. code-block:: json

            {
                "_id": "my_WSx",
                "classname": "herosdevices.hardware.highfinesse.wsx.WSx",
                "arguments": {
                    "dll_path": "C:\\Windows\\System32\\wlmData.dll",
                    "wavemeter_index": 0,
                    "channels": [
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7,
                        8
                    ]
                }
            }

        :sup:`generated from signature`

    .. tab-item:: Inheritance

        .. inheritance-diagram:: herosdevices.hardware.highfinesse.wsx.WSx