RigolDSA

From: Rigol Technologies

Class: herosdevices.hardware.rigol.RigolDSA

Driver Quality Index: beta

A class to interface Rigol digital spectrum analyzers.

Arguments

Bold arguments are mandatory. For more information on the listed arguments refer to the class documentation: 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.

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

Example JSON for BOSS

The following JSON strings can be used to start a HERO device representation of RigolDSA using BOSS.

{
    "_id": "rigol_dsa815",
    "classname": "herosdevices.hardware.rigol.RigolDSA",
    "arguments": {
        "address": "dns_name_or_ip.of.your.device"
    },
    "datasource": {
        "async": false,
        "interval": 5
    }
}

^{from examples/rigol/dsa.json}

{
    "_id": "my_RigolDSA",
    "classname": "herosdevices.hardware.rigol.RigolDSA",
    "arguments": {
        "address": "<class 'str'>",
        "default_config": null,
        "keep_device_open": true,
        "payload_metadata": null
    }
}

^{generated from signature}

Inheritance

digraph inheritance220e27b7fe { bgcolor=transparent; rankdir=TB; size=""; "herosdevices.core.templates.acq_device.AcquisitionDeviceTemplate" [URL="../../../autoapi/herosdevices/core/templates/acq_device/index.html#herosdevices.core.templates.acq_device.AcquisitionDeviceTemplate",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="Template (base class) for acquisition-like devices."]; "herosdevices.interfaces.heros.ConfiguredDevice" -> "herosdevices.core.templates.acq_device.AcquisitionDeviceTemplate" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.core.templates.oscilloscope.OscilloscopeTemplate" [URL="../../../autoapi/herosdevices/core/templates/oscilloscope/index.html#herosdevices.core.templates.oscilloscope.OscilloscopeTemplate",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="Template (base class) for oscilloscope."]; "herosdevices.core.templates.acq_device.AcquisitionDeviceTemplate" -> "herosdevices.core.templates.oscilloscope.OscilloscopeTemplate" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.hardware.rigol.RigolDSA" [URL="../../../autoapi/herosdevices/hardware/rigol/index.html#herosdevices.hardware.rigol.RigolDSA",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="A class to interface Rigol digital spectrum analyzers."]; "herosdevices.core.templates.oscilloscope.OscilloscopeTemplate" -> "herosdevices.hardware.rigol.RigolDSA" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.Interface" [URL="../../../autoapi/herosdevices/interfaces/index.html#herosdevices.interfaces.Interface",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="Generic Interface to describe and check capabilities of a device driver."]; "herosdevices.interfaces.heros.ConfiguredDevice" [URL="../../../autoapi/herosdevices/interfaces/heros/index.html#herosdevices.interfaces.heros.ConfiguredDevice",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="Base interface for heros devices."]; "herosdevices.interfaces.Interface" -> "herosdevices.interfaces.heros.ConfiguredDevice" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; }