RsMxo

https://rsmxo.readthedocs.io/en/latest/
Admin
RsMxo is a Python API and documentation for controlling Rohde & Schwarz MXO series oscilloscopes and...
Tokens:780,784
Snippets:1,419
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### CALCulate:SPECtrum:GATE:STARt SCPI Command and Python API

Source: https://rsmxo.readthedocs.io/en/latest/Calculate_Spectrum_Gate_Start

This entry documents the SCPI command for setting the starting value of a spectrum gate and its corresponding Python API implementation within the RsMxo library. It covers the command syntax, parameter descriptions, return values, and usage examples for both getting and setting the start value.

```SCPI
CALCulate:SPECtrum<*>:GATE:STARt
```

```Python
class StartCls:
    """Start commands group definition."""

    def get(self, spectrum: Spectrum = Spectrum.Default) -> float:
        """
        Sets the starting value for the gate.

        > param spectrum:
        > :   optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Spectrum’)
        > 
        > return:
        > :   start: No help available
        
        # SCPI: CALCulate:SPECtrum<*>:GATE:STARt
        value: float = driver.calculate.spectrum.gate.start.get(spectrum = repcap.Spectrum.Default)
        """
        pass

    def set(self, start: float, spectrum: Spectrum = Spectrum.Default) -> None:
        """
        Sets the starting value for the gate.

        > param start:
        > :   No help available
        > 
        > param spectrum:
        > :   optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Spectrum’)
        
        # SCPI: CALCulate:SPECtrum<*>:GATE:STARt
        driver.calculate.spectrum.gate.start.set(start = 1.0, spectrum = repcap.Spectrum.Default)
        """
        pass
```

--------------------------------

### UseAutoZero SCPI Command and Python Implementation

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Offset_UseAutoZero

This entry covers the SCPI command for enabling/disabling auto-zero correction on a probe and its corresponding Python class methods for getting and setting this configuration. It includes the SCPI syntax, Python usage examples, parameter descriptions, and return values.

```SCPI
PROBe<*>:SETup:OFFSet:USEautozero
```

```Python
class UseAutoZeroCls:
    """UseAutoZero commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

    def get(self, probe=Probe.Default) -> bool:
        """
        # SCPI: PROBe<*>:SETup:OFFSet:USEautozero
        value: bool = driver.probe.setup.offset.useAutoZero.get(probe = repcap.Probe.Default)
        Corrects the zero error of the probe. The zero error is detected with method RsMxo.Probe.Setup.Offset.Azero.set.

        :param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
        :return: use_auto_zero_offset: No help available
        """
        pass

    def set(self, use_auto_zero_offset: bool, probe=Probe.Default) -> None:
        """
        # SCPI: PROBe<*>:SETup:OFFSet:USEautozero
        driver.probe.setup.offset.useAutoZero.set(use_auto_zero_offset = False, probe = repcap.Probe.Default)
        Corrects the zero error of the probe. The zero error is detected with method RsMxo.Probe.Setup.Offset.Azero.set.

        :param use_auto_zero_offset: No help available
        :param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
        """
        pass
```

--------------------------------

### RsMxo Probe Setup Laser State Get Method

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Laser_State

Python method to retrieve the laser state using the RsMxo driver. It maps to the SCPI command PROBe<*>:SETup:LASer:STATe and returns the state as an integer. The method supports specifying a probe capability selector.

```python
class StateCls:
    def get(self, probe=Probe.Default) -> int:
        """
        Returns the current status of the laser.

        :param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
        :return: laser_state:
            - 1: The laser is working.
            - 2: The laser needs service, but is still working.
            - 3: Defective laser, send to your Rohde & Schwarz service center.
        """
        pass
```

--------------------------------

### RsMxo: Set Spectrum Gate Used Start SCPI Command and Python Driver

Source: https://rsmxo.readthedocs.io/en/latest/Calculate_Spectrum_Gate_Used_Start

This snippet documents the SCPI command for setting the start point of a used gate in spectrum analysis and its equivalent method in the RsMxo Python driver. It details the command syntax, parameter types, and provides a Python usage example.

```APIDOC
SCPI Command:
CALCulate:SPECtrum<*>:GATE:USED:STARt

Python Driver Method:
class StartCls:
    get(*spectrum=Spectrum.Default*) -> float

    Description:
    Retrieves the start value of the used gate in spectrum analysis.

    Parameters:
    * spectrum: Optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Spectrum’)

    Returns:
    float: The start value of the used gate.

    Usage Example:
    value: float = driver.calculate.spectrum.gate.used.start.get(spectrum = repcap.Spectrum.Default)

    Related Commands:
    CALCulate:SPECtrum<*>:GATE:USED:STOP
    CALCulate:SPECtrum<*>:GATE:USED:STARt:VALue
```

--------------------------------

### HysteresisCls API Documentation

Source: https://rsmxo.readthedocs.io/en/latest/Pbus_Hysteresis

Comprehensive API documentation for the HysteresisCls, covering methods for getting and setting hysteresis values, including parameter details, return types, and usage examples.

```APIDOC
class HysteresisCls:
    """Hysteresis commands group definition."""

    def get(pwrBus=PwrBus.Default, hyst=Hyst.Default) -> Hysteresis:
        """
        SCPI: PBUS<*>:HYSTeresis<*>
        Retrieves the size of the hysteresis for the respective channels.

        Parameters:
          pwrBus: optional repeated capability selector. Default value: Nr1.
          hyst: optional repeated capability selector. Default value: Nr1.

        Returns:
          Hysteresis: The hysteresis setting.
            - MAXIMUM = MAXimum: Maximum possible and useful value.
            - ROBUST = ROBust: Different hysteresis for falling/rising edges.
            - NORMAL = NORMal: Suitable value for the signal and settings.
        """

    def set(hysteresis: Hysteresis, pwrBus=PwrBus.Default, hyst=Hyst.Default) -> None:
        """
        SCPI: PBUS<*>:HYSTeresis<*>
        Defines the size of the hysteresis for the respective channels.

        Parameters:
          hysteresis: The hysteresis setting to apply.
            - MAXIMUM = MAXimum: Maximum value that is possible and useful for the signal and its settings
            - ROBUST = ROBust: Different hysteresis values for falling and rising edges to avoid an undefined state of the trigger system.
            - NORMAL = NORMal: The instrument sets a value suitable for the signal and its settings.
          pwrBus: optional repeated capability selector. Default value: Nr1.
          hyst: optional repeated capability selector. Default value: Nr1.
        """

    def clone() -> HysteresisCls:
        """
        Creates an independent clone of the original hysteresis group.
        """

```

--------------------------------

### Python Usage Example for Power RepCap

Source: https://rsmxo.readthedocs.io/en/latest/Export_Result_Select_Power

Demonstrates how to get and set the repeated capability for the Power export setting using the RsMxo Python driver. It shows retrieving the current setting and applying a new one.

```Python
# Range: Nr1 .. Nr6
rc = driver.export.result.select.power.repcap_power_get()
driver.export.result.select.power.repcap_power_set(repcap.Power.Nr1)
```

--------------------------------

### RsMxo Power Harmonics Display Frequency Start Commands

Source: https://rsmxo.readthedocs.io/en/latest/Power_Harmonics_Display_Frequency_Start

API documentation for the 'Start' commands group within the RsMxo Power Harmonics Display Frequency module. This group manages settings related to the start of frequency-related measurements or displays.

```apidoc
RsMxo.Power.Harmonics.Display.Frequency.Start
  Description: Start commands group definition. Manages settings related to the start of frequency measurements.
  Total Commands: 1
  Subgroups: 1
  Group Commands: 0

  Class: StartCls
    Purpose: Represents the 'Start' commands group.
    Source: _modules/RsMxo/Implementations/Power/Harmonics/Display/Frequency/Start.html#StartCls

  Functionality:
    - clone(): Creates an independent clone of the original group.
      Example:
        group2 = driver.power.harmonics.display.frequency.start.clone()

  Subgroups:
    - Value: Navigates to the 'Value' subgroup for specific start value configurations.
      Link: Power_Harmonics_Display_Frequency_Start_Value.html

  Navigation:
    - Previous: Power_Harmonics_Display_Frequency.html
    - Next: Power_Harmonics_Display_Frequency_Start_Value.html
```

--------------------------------

### Get Measurement Start Time

Source: https://rsmxo.readthedocs.io/en/latest/Measurement_Result_Start

Retrieves the start and stop times of a specified measurement using SCPI commands and the RsMxo Python driver. The `get` method takes an optional measurement parameter and returns the start time as a float.

```APIDOC
MEASUREMENT<*>:RESult:STARt

*class* StartCls
    get(*measurement=Measurement.Default*) → float
        param measurement: optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Measurement’)
        return: start: No help available
```

```Python
# SCPI: MEASUREMENT<*>:RESult:STARt
value: float = driver.measurement.result.start.get(measurement = repcap.Measurement.Default)
```

--------------------------------

### Python Hysteresis Setup

Source: https://rsmxo.readthedocs.io/en/latest/Pbus_Hysteresis

Initial setup or retrieval of hysteresis configuration using the RsMxo Python library. Demonstrates basic interaction with the hysteresis module.

```Python
rc = driver.pbus.hysteresis.repcap_hyst_get()
driver.pbus.hysteresis.repcap_hyst_set(repcap.Hyst.Nr1)
```

--------------------------------

### RsMxo Probe Setup Offset Commands (APIDOC)

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Offset

Provides an overview of the RsMxo Probe Setup Offset commands. This group contains 6 total commands and 6 subgroups, facilitating detailed control over probe offset settings.

```APIDOC
OffsetCls:
  Description: Offset commands group definition.
  Total Commands: 6
  Subgroups: 6
  Group Commands: 0

  clone():
    Description: Creates an independent clone of the original group.
    Usage Example:
      group2 = driver.probe.setup.offset.clone()

  Subgroups:
    Azero: Commands related to zeroing the probe offset.
    StProbe: Commands for probe offset settings specific to probe type.
    ToMean: Commands for setting the probe offset to a mean value.
    TopMeter: Commands for probe offset settings related to the top meter.
    UseAutoZero: Commands to enable or disable automatic zeroing of probe offset.
    Zadjust: Commands for adjusting the probe offset.

  Related Commands:
    Previous: Probe_Setup_Noffset
    Next: Probe_Setup_Offset_Azero
```

--------------------------------

### RsMxo Power Switching Npeak Python Example

Source: https://rsmxo.readthedocs.io/en/latest/Power_Switching_Result_Ton_Energy_Npeak

Example of how to use the RsMxo Python driver to get the negative peak value from power switching measurements. It demonstrates calling the 'get' method on the Npeak class.

```python
# SCPI: POWer<*>:SWITching:RESult:TON:ENERgy:NPEak
value: float = driver.power.switching.result.ton.energy.npeak.get(power = repcap.Power.Default)

# Return the negative peak value (minimum) of the selected measurement type if statistics are enabled.
```

--------------------------------

### Probe Setup Azero Command

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Offset_Azero

This entry covers the Azero command for probe setup, detailing its SCPI command and Python implementation for measuring probe zero error. It requires shorting the signal and ground pins before execution.

```APIDOC
SCPI Command:
  PROBe<*>:SETup:OFFSet:AZERo

Python Method:
  class AzeroCls:
    def set(self, probe=Probe.Default) -> None
      Measures the zero error of the probe. Short the signal pin and the ground pin together, then send the command.
      Parameters:
        probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)

    def set_and_wait(self, probe=Probe.Default, opc_timeout_ms: int = -1) -> None
      Waits for the operation to complete.
      Parameters:
        probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
        opc_timeout_ms: Timeout in milliseconds for OPC (Operation Complete) signal.
```

--------------------------------

### RsMxo Probe Setup Laser Class

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Laser

API documentation for the Laser commands group within the RsMxo Probe Setup module. It outlines the class structure, total commands, subgroups, and group commands.

```APIDOC
LaserCls:
  Description: Laser commands group definition.
  Total Commands: 1
  Subgroups: 1
  Group Commands: 0

  Methods:
    clone():
      Description: Creates an independent clone of the original group.
      Returns: A new instance of the Laser group.

  Subgroups:
    State: Commands related to the state of the laser.
```

--------------------------------

### RsMxo Gate Relative Start Commands

Source: https://rsmxo.readthedocs.io/en/latest/Gate_Relative_Start

Defines the relative start and end values for a gate. This functionality is available when RsMxo.Gate.Gcoupling.set is MANUAL and RsMxo.Gate.Mode.set is REL. It includes SCPI commands and Python method wrappers for setting and getting the relative start value.

```scpi
GATE<*>:RELative:STARt
```

```APIDOC
StartCls:
  # SCPI: GATE<*>:RELative:STARt
  # Description: Start commands group definition. 1 total commands, 0 Subgroups, 1 group commands

  get(*gate=Gate.Default*) → float
    # Description: Retrieves the relative start value for the gate.
    # Parameters:
    #   gate: Optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Gate’)
    # Returns: float: The relative start value.
    # Example:
    #   value: float = driver.gate.relative.start.get(gate = repcap.Gate.Default)

  set(*relative_start: float*, *gate=Gate.Default*) → None
    # Description: Defines the relative start value for the gate.
    # Parameters:
    #   relative_start: The relative start value to set.
    #   gate: Optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Gate’)
    # Example:
    #   driver.gate.relative.start.set(relative_start = 1.0, gate = repcap.Gate.Default)
    # Dependencies: Available if method RsMxo.Gate.Gcoupling.set = MANUal and method RsMxo.Gate.Mode.set =REL.
```

--------------------------------

### Python Driver for LAYout ZOOM HORizontal ABSolute STARt

Source: https://rsmxo.readthedocs.io/en/latest/Layout_Zoom_Horizontal_Absolute_Start

Provides Python methods to get and set the absolute start value for the horizontal zoom area. It handles SCPI command execution and parameter management for the specified layout and zoom capabilities.

```Python
class StartCls:
    """Start commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

    def get(self, layout=repcap.Layout.Default, zoom=repcap.Zoom.Default) -> float:
        """
        # SCPI: LAYout<*>:ZOOM<*>:HORizontal:ABSolute:STARt
        value: float = driver.layout.zoom.horizontal.absolute.start.get(layout = repcap.Layout.Default, zoom = repcap.Zoom.Default)

        Defines the lower limit of the zoom area on the x-axis in absolute values.

        :param layout: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Layout’)
        :param zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Zoom’)
        :return: start: No help available
        """
        pass

    def set(self, start: float, layout=repcap.Layout.Default, zoom=repcap.Zoom.Default) -> None:
        """
        # SCPI: LAYout<*>:ZOOM<*>:HORizontal:ABSolute:STARt
        driver.layout.zoom.horizontal.absolute.start.set(start = 1.0, layout = repcap.Layout.Default, zoom = repcap.Zoom.Default)

        Defines the lower limit of the zoom area on the x-axis in absolute values.

        :param start: No help available
        :param layout: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Layout’)
        :param zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Zoom’)
        """
        pass
```

--------------------------------

### Get Probe DC Range Max Value

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_DcRange_Max

Retrieves the maximum value of the dynamic DC range for a specified probe. This command is part of the probe setup configuration. It requires the RsMxo driver and may take an optional probe identifier.

```APIDOC
SCPI Command:
PROBe<*>:SETup:DCRange:MAX

Python Method:
MaxCls.get(probe=Probe.Default) -> float

Description:
Returns the maximum value of the dynamic DC range.

Parameters:
- probe: The repeated capability selector for the probe. Defaults to Probe.Default (Nr1).

Returns:
A float representing the maximum dynamic DC range value.

Example:
# SCPI: PROBe<*>:SETup:DCRange:MAX
value: float = driver.probe.setup.dcRange.max.get(probe = repcap.Probe.Default)
```

--------------------------------

### RsMxo Toolbar API

Source: https://rsmxo.readthedocs.io/en/latest/Display_Toolbar

Comprehensive documentation for the RsMxo Toolbar class, covering SCPI commands, Python method signatures, parameter details, return values, and usage examples. Includes information on retrieving toolbar counts and cloning toolbar groups.

```SCPI
DISPlay:TOOLbar:COUNt
```

```Python
class ToolbarCls:
    """Toolbar commands group definition. 3 total commands, 2 Subgroups, 1 group commands"""
    def get_count() -> int:
        """
        # SCPI: DISPlay:TOOLbar:COUNt
        value: int = driver.display.toolbar.get_count()
        """
        # Returns the number of tools that are currently assigned to the toolbar.
        # > return:
        # > :   tool_count: No help available
```

```Python
# Create a clone of the original group, that exists independently
group2 = driver.display.toolbar.clone()
```

--------------------------------

### Python Driver: Get SBUS ARINC Word Start Time

Source: https://rsmxo.readthedocs.io/en/latest/Sbus_Arinc_Word_Start

This Python code snippet demonstrates how to use the RsMxo driver to retrieve the start time of a specific ARINC word. It requires the RsMxo library and the repcap module for specifying optional parameters like serialBus and word. The method returns a float value.

```Python
value: float = driver.sbus.arinc.word.start.get(serialBus = repcap.SerialBus.Default, word = repcap.Word.Default)
```

--------------------------------

### RsMxo Gate Class: RepCap Settings and Cloning

Source: https://rsmxo.readthedocs.io/en/latest/Gate

Demonstrates how to interact with the RsMxo Gate class, including setting and retrieving repeated capabilities (RepCaps) and creating independent clones of the gate group. This section provides essential examples for managing gate configurations.

```python
# Range: Nr1 .. Nr8
rc = driver.gate.repcap_gate_get()
driver.gate.repcap_gate_set(repcap.Gate.Nr1)
```

```python
# Create a clone of the original group, that exists independently
group2 = driver.gate.clone()
```

--------------------------------

### RsMxo Calculate Spectrum Frequency Start Command

Source: https://rsmxo.readthedocs.io/en/latest/Calculate_Spectrum_Frequency_Start

This entry documents the SCPI command for setting the start frequency within the spectrum analysis module of the RsMxo project. It includes the SCPI command syntax, its purpose, and the corresponding Python driver implementation for getting and setting the start frequency value. The command is used to define the beginning frequency of the displayed frequency span.

```APIDOC
SCPI Command : 
CALCulate:SPECtrum<*>:FREQuency:STARt

*class* StartCls
:   Start commands group definition. 1 total commands, 0 Subgroups, 1 group commands

    get(*spectrum=Spectrum.Default*) → float
    :   Defines the start frequency of the displayed frequency span.
        > param spectrum:
        > :   optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Spectrum’)
        > 
        > return:
        > :   start: No help available

    set(*start: float*, *spectrum=Spectrum.Default*) → None
    :   Defines the start frequency of the displayed frequency span.
        > param start:
        > :   No help available
        > 
        > param spectrum:
        > :   optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Spectrum’)
```

```Python
# SCPI: CALCulate:SPECtrum<*>:FREQuency:STARt
value: float = driver.calculate.spectrum.frequency.start.get(spectrum = repcap.Spectrum.Default)

# SCPI: CALCulate:SPECtrum<*>:FREQuency:STARt
driver.calculate.spectrum.frequency.start.set(start = 1.0, spectrum = repcap.Spectrum.Default)
```

--------------------------------

### RsMxo API - Power OnOff InputPy Class

Source: https://rsmxo.readthedocs.io/en/latest/Power_OnOff_InputPy

Documentation for the InputPy class in the RsMxo API, which groups commands related to power input configurations. It details the class structure, its subgroups, and provides a Python example for cloning the group.

```APIDOC
InputPyCls
  :   InputPy commands group definition. 4 total commands, 4 Subgroups, 0 group commands

  Cloning the Group

  Subgroups:
  * Ac
    + Absolute
      - Value
  * Dc
    + Absolute
      - Value
  * Source
  * TypePy

  Navigation:
  [Previous](Power_OnOff.html "OnOff")
  [Next](Power_OnOff_InputPy_Ac.html "Ac")
```

```Python
# Create a clone of the original group, that exists independently
group2 = driver.power.onOff.inputPy.clone()
```

--------------------------------

### Python API for Vertical Absolute Start

Source: https://rsmxo.readthedocs.io/en/latest/Layout_Zoom_Vertical_Absolute_Start

Provides Python methods to get and set the lower limit of the zoom area on the y-axis. These methods wrap the SCPI command, allowing programmatic control via a driver interface.

```APIDOC
class StartCls:
    """Start commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

    def get(self, layout=Layout.Default, zoom=Zoom.Default) -> float:
        """
        # SCPI: LAYout<*>:ZOOM<*>:VERTical:ABSolute:STARt
        # Defines the lower limit of the zoom area on the y-axis in absolute values.
        # Parameters:
        #   layout: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Layout’)
        #   zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Zoom’)
        # Returns:
        #   start: No help available
        """
        pass

    def set(self, start: float, layout=Layout.Default, zoom=Zoom.Default) -> None:
        """
        # SCPI: LAYout<*>:ZOOM<*>:VERTical:ABSolute:STARt
        # Defines the lower limit of the zoom area on the y-axis in absolute values.
        # Parameters:
        #   start: No help available
        #   layout: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Layout’)
        #   zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Zoom’)
        """
        pass
```

--------------------------------

### UserCls API Documentation

Source: https://rsmxo.readthedocs.io/en/latest/Power_Harmonics_Rpower_User

Comprehensive documentation for the UserCls, covering its methods for interacting with user-defined power settings in harmonic measurements. This includes SCPI command syntax, Python method signatures, parameter descriptions, return values, and usage examples.

```APIDOC
SCPI Command:
  POWer<*>:HARMonics:RPOWer:USER

Class: UserCls
  User commands group definition. 1 total commands, 0 Subgroups, 1 group commands

Methods:
  get(*power=Power.Default*) → float
    Purpose: Retrieves the user-defined power value.
    SCPI Equivalent: POWer<*>:HARMonics:RPOWer:USER?
    Description: Selects the revision of the EN61000 standard, if method RsMxo.Power.Harmonics.Standard.set is set to END and method RsMxo.Power.Harmonics.Rpower.User.set is set to USER. Sets a user-defined power value.
    Parameters:
      power: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Power’)
    Returns:
      user_act_power: No help available (float)
    Example:
      # SCPI: POWer<*>:HARMonics:RPOWer:USER
      value: float = driver.power.harmonics.rpower.user.get(power = repcap.Power.Default)

  set(*user_act_power: float*, *power=Power.Default*) → None
    Purpose: Sets a user-defined power value.
    SCPI Equivalent: POWer<*>:HARMonics:RPOWer:USER <value>
    Description: Selects the revision of the EN61000 standard, if method RsMxo.Power.Harmonics.Standard.set is set to END and method RsMxo.Power.Harmonics.Rpower.User.set is set to USER. Sets a user-defined power value.
    Parameters:
      user_act_power: No help available (float)
      power: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Power’)
    Returns:
      None
    Example:
      # SCPI: POWer<*>:HARMonics:RPOWer:USER
      driver.power.harmonics.rpower.user.set(user_act_power = 1.0, power = repcap.Power.Default)

Related Commands:
  - RsMxo.Power.Harmonics.Standard.set
  - RsMxo.Power.Harmonics.Rpower.User.set
```

--------------------------------

### Probe Zadjust Commands

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Offset_Zadjust

Provides methods to get and set the zero adjustment value for the probe, correcting for voltage offset or temperature drift. The `get` method retrieves the current zero adjustment value, while the `set` method applies a new value. Both methods interact with the `PROBe<*>:SETup:OFFSet:ZADJust` SCPI command.

```SCPI
PROBe<*>:SETup:OFFSet:ZADJust
```

```Python
# SCPI: PROBe<*>:SETup:OFFSet:ZADJust
value: float = driver.probe.setup.offset.zadjust.get(probe = repcap.Probe.Default)
```

```Python
# SCPI: PROBe<*>:SETup:OFFSet:ZADJust
driver.probe.setup.offset.zadjust.set(zero_adj_val = 1.0, probe = repcap.Probe.Default)
```

--------------------------------

### Python Driver: RangeCls Methods for Probe Voltage Range

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Advanced_Range

Provides methods to interact with the SCPI PROBe<*>:SETup:ADVanced:RANGe command using the RsMxo Python driver. The 'get' method queries the current voltage range, while the 'set' method configures it. Both methods support optional probe selection.

```APIDOC
SCPI: PROBe<*>:SETup:ADVanced:RANGe

Class: RsMxo.Implementations.Probe.Setup.Advanced.Range.RangeCls

Methods:
  get(*probe=Probe.Default*) → ProbeRange
    Description: Queries the voltage range of an R&S RT-ZHD probe.
    Parameters:
      probe: Optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’).
    Returns:
      probe_range: An enum value representing the probe range (AUTO, MHIGh, MLOW).

  set(*probe_range: ProbeRange*, *probe=Probe.Default*) → None
    Description: Sets the voltage range of an R&S RT-ZHD probe.
    Parameters:
      probe_range: The desired voltage range. Accepted values:
        - AUTO: The voltage range is set with CHANnelch:SCALe.
        - MHIGh: Sets the higher voltage range of the connected probe. To query the value, use PROBech:SETup:ATTenuation[:AUTO]?.
        - MLOW: Sets the lower voltage range of the connected probe. To query the value, use PROBech:SETup:ATTenuation[:AUTO]?.
      probe: Optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’).
    Returns:
      None

Example Usage:
  # Get current range
  current_range = driver.probe.setup.advanced.range.get(probe = repcap.Probe.Default)

  # Set range to AUTO
  driver.probe.setup.advanced.range.set(probe_range = enums.ProbeRange.AUTO, probe = repcap.Probe.Default)
```

--------------------------------

### RsMxo Laser Group Cloning

Source: https://rsmxo.readthedocs.io/en/latest/Probe_Setup_Laser

Demonstrates how to create an independent clone of the RsMxo Laser command group. This allows for separate manipulation of laser settings without affecting the original group.

```python
# Create a clone of the original group, that exists independently
group2 = driver.probe.setup.laser.clone()

```

--------------------------------

### RsMxo API Structure Overview

Source: https://rsmxo.readthedocs.io/en/latest/Sbus_Swire_Frame_Stop

Provides a high-level overview of the RsMxo API structure, listing major modules and their relationships. This serves as a navigation guide to detailed API documentation for each component.

```APIDOC
RsMxo API Structure:
  - Acquire
  - AutoScale
  - Calculate
  - Calibration
  - Channel<Channel>
  - Cursor<Cursor>
  - Digital<Digital>
  - Display
  - Export
  - FormatPy
  - Franalysis
  - Gate<Gate>
  - Generator
  - HardCopy
  - Hdefinition
  - Layout<Layout>
  - MassMemory
  - Measurement<Measurement>
  - Meter<Voltmeter>
  - Mtest<MaskTest>
  - Pbus<PwrBus>
  - Power<Power>
  - Probe<Probe>
  - RefCurve<RefCurve>
  - RefLevel<RefLevel>
  - Run
  - Saveset
  - Sbus<SerialBus>
    - Arinc
    - Can
    - ExpResult
    - FormatPy
    - Hbto
    - I2C
    - I3C
    - Lin
    - Milstd
    - Nrzc
    - Nrzu
    - Qspi
    - Result
    - Rffe
    - RmsBus
    - Sent
    - Spi
    - Spmi
    - State
    - Swire
      - Data
      - Fcount
      - FilterPy
      - Frame<Frame>
        - Bitrate
        - CodParity
        - Data
        - DatParity
        - EscParity
        - Fld<Field>
        - Start
        - State
        - Stop
        - TypePy
      - Mgap
      - MinGap
      - Position
      - Scale
      - Strbe
      - SwtIndex
      - SwtTime
    - Threshold
    - Tnos
    - TrgHardware
    - TrgSoftware
    - TypePy
    - Uart
    - Zcoupling
  - Selftests
  - Sense
  - Service
  - Sessions
  - Status
  - Synchronize
  - System
  - Timebase
  - Treference<TimingReference>
  - Trfs
  - Trigger
  - TriggerInvoke
  - TrProbe
  - UserDefined
  - Wgenerator<WaveformGen>
  - Xy<XyAxis>
  - Zone<Zone>
```

--------------------------------

### RsMxo LAYout:ZOOM:HORizontal:RELative:STARt SCPI Command and Python API

Source: https://rsmxo.readthedocs.io/en/latest/Layout_Zoom_Horizontal_Relative_Start

Defines the lower limit of the zoom area on the x-axis in relative values. This entry covers the SCPI command and its corresponding Python driver methods for setting and retrieving the value. It includes parameter details and usage examples.

```SCPI
LAYout<*>:ZOOM<*>:HORizontal:RELative:STARt
```

```Python
class StartCls:
    # SCPI: LAYout<*>:ZOOM<*>:HORizontal:RELative:STARt

    def get(self, layout=repcap.Layout.Default, zoom=repcap.Zoom.Default) -> float:
        """
        Defines the lower limit of the zoom area on the x-axis in relative values.

        :param layout: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Layout’)
        :param zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Zoom’)
        :return: relative_start: No help available
        """
        pass

    def set(self, relative_start: float, layout=repcap.Layout.Default, zoom=repcap.Zoom.Default) -> None:
        """
        Defines the lower limit of the zoom area on the x-axis in relative values.

        :param relative_start: No help available
        :param layout: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Layout’)
        :param zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Zoom’)
        """
        pass
```

```Python Example
# SCPI: LAYout<*>:ZOOM<*>:HORizontal:RELative:STARt
value: float = driver.layout.zoom.horizontal.relative.start.get(layout = repcap.Layout.Default, zoom = repcap.Zoom.Default)

# SCPI: LAYout<*>:ZOOM<*>:HORizontal:RELative:STARt
driver.layout.zoom.horizontal.relative.start.set(relative_start = 1.0, layout = repcap.Layout.Default, zoom = repcap.Zoom.Default)
```
Tokens:
Raw