:orphan:

RigolDSA
========

**From:** `Rigol Technologies <https://www.rigol.com/intl/products/spectrum-analyzer.html>`_

**Class:** :py:class:`herosdevices.hardware.rigol.RigolDSA`


**Driver Quality Index:** beta


A class to interface Rigol digital spectrum analyzers.

.. 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.rigol.RigolDSA` 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'>**
           - 
           - Address or IP of the instrument.
         * - default_config
           - str | None
           - None
           - 
         * - keep_device_open
           - <class 'bool'>
           - True
           - Keep the device open after it is first opened
         * - payload_metadata
           - dict | None
           - None
           - 
      

   .. tab-item:: Example JSON for BOSS
   
      The following JSON strings can be used to start a HERO device representation of             :py:class:`RigolDSA <herosdevices.hardware.rigol.RigolDSA>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.
      
      .. code-block:: json
      
         {
             "_id": "rigol_dsa815",
             "classname": "herosdevices.hardware.rigol.RigolDSA",
             "arguments": {
                 "address": "dns_name_or_ip.of.your.device"
             },
             "datasource": {
                 "async": false,
                 "interval": 5
             }
         }
      
      :sup:`from examples/rigol/dsa.json` 
      
      
      .. code-block:: json
      
         {
             "_id": "my_RigolDSA",
             "classname": "herosdevices.hardware.rigol.RigolDSA",
             "arguments": {
                 "address": "<class 'str'>",
                 "default_config": null,
                 "keep_device_open": true,
                 "payload_metadata": null
             }
         }
      
      :sup:`generated from signature`
   .. tab-item:: Inheritance
   
   
      .. inheritance-diagram:: herosdevices.hardware.rigol.RigolDSA
      
