RsMxo Documentation

https://rsmxo.readthedocs.io
Admin
RsMxo provides comprehensive documentation for its API, utilities, and logger, covering a wide range...
Tokens:2,191,896
Snippets:4,142
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### RsMxo TrProbe Setup Commands

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

Provides SCPI commands and Python methods for managing the setup of the RsMxo TrProbe module. Includes functions to get the probe's name, state, and type, along with an example of cloning the setup group.

```SCPI
TRPRobe:SETup:NAME
TRPRobe:SETup:STATe
TRPRobe:SETup:TYPE
```

```Python
# SCPI: TRPRobe:SETup:NAME
value: str = driver.trProbe.setup.get_name()

# Returns the name of the probe that is connected to the external trigger input.
# Parameters:
#   name: String parameter
```

```Python
# SCPI: TRPRobe:SETup:STATe
value: enums.Detection = driver.trProbe.setup.get_state()

# Returns the state of the probe that is connected to the external trigger input.
# Parameters:
#   state: No help available
```

```Python
# SCPI: TRPRobe:SETup:TYPE
value: str = driver.trProbe.setup.get_type_py()

# Returns the type of the probe that is connected to the external trigger input.
# Parameters:
#   type_py: String parameter
```

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

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

### SBUS I3C Frame ACKStart SCPI Command and Python Get Method

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

This documentation covers the SCPI command for retrieving the acknowledge bit start time on an I3C frame within an SBUS. It includes the command syntax and a Python method example demonstrating its usage with parameter descriptions and return values.

```APIDOC
SBUS<*>:I3C:FRAMe<*>:ACKStart

Class: AckStartCls

Method: get(*serialBus=SerialBus.Default*, *frame=Frame.Default*) → float
  Description: Returns the start time of the acknowledge bit for the selected frame.
  Parameters:
    - serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
    - frame: optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Frame’)
  Returns:
    - ack_bit_start: No help available (float)
  Example Usage:
    value: float = driver.sbus.i3C.frame.ackStart.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)
```

```python
from RsMxo.Implementations.Sbus.I3C.Frame.AckStart import AckStartCls
from RsMxo.Enums import SerialBus, Frame

# Assuming 'driver' is an instance of the RsMxo driver

# Get the acknowledge bit start time for the default serial bus and frame
value: float = driver.sbus.i3C.frame.ackStart.get(serialBus = SerialBus.Default, frame = Frame.Default)

print(f"Acknowledge bit start time: {value}")
```

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

### RsMxo Power Harmonics Display Frequency Start Commands

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

Documentation for the Start commands group within the RsMxo Power Harmonics Display Frequency API. This section defines commands related to starting operations and provides an example of cloning a group.

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

  Cloning the Group

  Example:
  # Create a clone of the original group, that exists independently
  group2 = driver.power.harmonics.display.frequency.start.clone()

  Subgroups:
  * Value
```

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

### Query Probe Setup Name

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

This snippet demonstrates how to query the name of the probe's setup using the RsMxo driver. It includes the SCPI command and a Python example with parameter details and return types.

```scpi
PROBe<*>:SETup:NAME
```

```APIDOC
SCPI Command : PROBe<*>:SETup:NAME

Description: Queries the name of the probe.

Parameters:
  probe: The repeated capability selector for the probe. Defaults to Probe.Default.

Returns:
  str: The name of the probe.
```

```python
# SCPI: PROBe<*>:SETup:NAME
# value: str = driver.probe.setup.name.get(probe = repcap.Probe.Default)

# Queries the name of the probe.
# :param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
# :return: name: Name string

# Example usage:
# probe_name = driver.probe.setup.name.get(probe = repcap.Probe.Default)
# print(f"Probe name: {probe_name}")
```

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

### Get SBUS HBTO FRAMe STARt SCPI Command and Python Usage

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

This snippet covers the SCPI command for retrieving the start time of a selected frame and demonstrates its usage with a Python driver. It includes the command syntax, parameter descriptions, return values, and a practical code example.

```APIDOC
SCPI Command:
SBUS<*>:HBTO:FRAMe<*>:STARt

Description:
Retrieves the start time of the selected frame.

Parameters:
- *: Represents a repeated capability selector.

Python Driver Usage:
class StartCls:
    # SCPI: SBUS<*>:HBTO:FRAMe<*>:STARt
    get(*serialBus=SerialBus.Default*, *frame=Frame.Default*) → float
        Retrieves the start time of the selected frame.

        Parameters:
          serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
          frame: optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Frame’)

        Returns:
          frame_start: No help available (type: float)
```

```Python
value: float = driver.sbus.hbto.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)
```

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

### SCPI PROBe:SETup:ATTenuation:MANual Command

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

This entry documents the SCPI command used to set or get the manual attenuation for a probe. It includes the command syntax, parameter descriptions, return values, and usage examples in Python.

```APIDOC
SCPI Command:
PROBe<*>:SETup:ATTenuation:MANual

Class: ManualCls
Description: Manual commands group definition. 1 total commands, 0 Subgroups, 1 group commands.

Method: get(*probe=Probe.Default*) → float
Description: Retrieves the manual attenuation setting for a probe.
Parameters:
  probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
Return Value:
  prb_att_md_manual: The manual attenuation value (float). No specific help available for the return value description.

Method: set(*prb_att_md_manual: float*, *probe=Probe.Default*) → None
Description: Sets the manual attenuation for a probe.
Parameters:
  prb_att_md_manual: The manual attenuation value to set (float). No specific help available for this parameter description.
  probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)

Example Usage (Python):
# Get attenuation
value: float = driver.probe.setup.attenuation.manual.get(probe = repcap.Probe.Default)

# Set attenuation
driver.probe.setup.attenuation.manual.set(prb_att_md_manual = 1.0, probe = repcap.Probe.Default)
```

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

### Python Implementation for Probe Setup TipModel Info

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

Python code snippet demonstrating how to use the RsMxo driver to get the probe's tip model information.

```Python
# SCPI: PROBe<*>:SETup:TIPModel:INFO
# value: str = driver.probe.setup.tipModel.info.get(probe = repcap.Probe.Default)

# Example usage:
# Assuming 'driver' is an initialized RsMxo driver instance
# tip_info = driver.probe.setup.tipModel.info.get(probe = repcap.Probe.Default)
# print(tip_info)
```

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

### RsMxo Calculate Spectrum Gate Used Start SCPI Command

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

This entry documents the SCPI command for setting or getting the start point of a used gate within the spectrum analysis module of the RsMxo instrument. It includes the SCPI command syntax and a Python driver example for interacting with this functionality.

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

```Python
class StartCls:
    """Start commands group definition.
    1 total commands, 0 Subgroups, 1 group commands
    """
    def get(self, spectrum: Spectrum = Spectrum.Default) -> float:
        """
        SCPI: CALCulate:SPECtrum<*>:GATE:USED:STARt
        value: float = driver.calculate.spectrum.gate.used.start.get(spectrum = repcap.Spectrum.Default)

        No command help available

        param spectrum:
            optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Spectrum’)

        return:
            start: No help available
        """
        pass
```

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

### RwbStart SCPI Command and Python Method

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

Details the SCPI command for RWBStart and its Python method to retrieve the R/W bit start time. Includes parameter descriptions, return values, and usage examples.

```APIDOC
SBUS<*>:I3C:FRAMe<*>:RWBStart

Class: RwbStartCls

Method: get
  Signature: get(*serialBus=SerialBus.Default*, *frame=Frame.Default*) → float
  Description: Retrieves the start time of the R/W bit.
  Parameters:
    - serialBus: Optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’).
    - frame: Optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Frame’).
  Returns:
    - rwb_it_start: float - The start time of the R/W bit. No further help available.
  Example:
    value: float = driver.sbus.i3C.frame.rwbStart.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)
```

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

### Dmin SCPI Command and Python Interface

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

Documents the SBUS<*>:SWIRe:FILTer:DMIN SCPI command and its Python interface for setting data patterns or range start values. Includes GET and SET operations with parameter descriptions and usage examples.

```SCPI
SBUS<*>:SWIRe:FILTer:DMIN
```

```Python
# SCPI: SBUS<*>:SWIRe:FILTer:DMIN
# Class: DminCls
# Method: get
# Description: Specifies the data pattern, or sets the start value of a data pattern range.
# Parameters:
#   serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
# Returns:
#   data: No help available
value: str = driver.sbus.swire.filterPy.dmin.get(serialBus = repcap.SerialBus.Default)
```

```Python
# SCPI: SBUS<*>:SWIRe:FILTer:DMIN
# Class: DminCls
# Method: set
# Description: Specifies the data pattern, or sets the start value of a data pattern range.
# Parameters:
#   frame: No help available
#   field: No help available
#   data: No help available
#   serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
# Returns:
#   None
driver.sbus.swire.filterPy.dmin.set(frame = 'abc', field = 'abc', data = 'abc', serialBus = repcap.SerialBus.Default)
```

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

### Source Class Methods

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

Provides documentation for the Source class, detailing its methods for setting the input channel of the IO 2 line. It includes SCPI command structure, Python method signatures, parameter descriptions, return values, and usage examples.

```APIDOC
SCPI Command : 
SBUS<*>:QSPI:IOTWo:SOURce

class SourceCls
  Source commands group definition. 1 total commands, 0 Subgroups, 1 group commands

  get(*serialBus=SerialBus.Default*) → Source
    Description: Sets the input channel of the IO 2 line.
    Parameters:
      serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
    Returns:
      io_2_source: No help available
    Example:
      # SCPI: SBUS<*>:QSPI:IOTWo:SOURce
      value: enums.Source = driver.sbus.qspi.ioTwo.source.get(serialBus = repcap.SerialBus.Default)

  set(*io_2_source: Source*, *serialBus=SerialBus.Default*) → None
    Description: Sets the input channel of the IO 2 line.
    Parameters:
      io_2_source: No help available
      serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
    Example:
      # SCPI: SBUS<*>:QSPI:IOTWo:SOURce
      driver.sbus.qspi.ioTwo.source.set(io_2_source = enums.Source.C1, serialBus = repcap.SerialBus.Default)
```

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

### Get SBUS LIN Frame Start Time (Python)

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

Python method to get the start time of a LIN frame using the SCPI command. It requires specifying the serial bus and frame selectors, with default values provided.

```Python
value: float = driver.sbus.lin.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)

# SCPI: SBUS<*>:LIN:FRAMe<*>:STARt
# Returns the start time of the selected frame.
# param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
# param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Frame’)
# return: frame_start: No help available
```

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

### RsMxo Probe Setup Alignment API

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

API documentation for RsMxo's probe setup alignment commands. This section details the AlignmentCls, its subgroups (Gain, Write, Zero), and associated execute commands.

```APIDOC
RsMxo Probe Setup Alignment API:
  AlignmentCls
    Description: Alignment commands group definition.
    Total Commands: 3
    Subgroups: 3
    Group Commands: 0

    Subgroups:
      Gain:
        Description: Probe setup alignment gain subgroup.
        Methods:
          Execute: Executes the alignment gain procedure.

      Write:
        Description: Probe setup alignment write subgroup.
        Methods:
          (No specific methods listed, implies a general write operation or configuration)

      Zero:
        Description: Probe setup alignment zero subgroup.
        Methods:
          Execute: Executes the alignment zero procedure.

  Navigation:
    Previous: Probe_Setup_Advanced_Unit.html
    Next: Probe_Setup_Alignment_Gain.html

```

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

### SCPI Power Switching Region Conduction Start Commands

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

This section documents the SCPI commands and their corresponding Python interface methods for managing the start time of the conduction area. It includes details on setting and retrieving this parameter, along with its relationship to trigger points and turn-on areas.

```SCPI
POWer<*>:SWITching:REGion:CONDuction[:STARt]
```

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

    def get(*power=Power.Default*) -> float:
        """
        SCPI: POWer<*>:SWITching:REGion:CONDuction[:STARt]
        Gets the start time for the conduction area in relation to the trigger point. This value is also end time of the turn on area.

        Parameters:
            power (repcap.Power, optional): optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Power’)

        Returns:
            float: t_2_position: No help available
        """
        # Example usage:
        # value: float = driver.power.switching.region.conduction.start.get(power = repcap.Power.Default)
        pass

    def set(*t_2_position: float*, *power=Power.Default*) -> None:
        """
        SCPI: POWer<*>:SWITching:REGion:CONDuction[:STARt]
        Sets the start time for the conduction area in relation to the trigger point. This value is also end time of the turn on area.

        Parameters:
            t_2_position (float): No help available
            power (repcap.Power, optional): optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Power’)
        """
        # Example usage:
        # driver.power.switching.region.conduction.start.set(t_2_position = 1.0, power = repcap.Power.Default)
        pass
```

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

### RsMxo Probe Setup Capacitance get() Method

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

The get() method in the CapacitanceCls class retrieves the input capacitance of the probe. It maps to the SCPI command PROBe<*>:SETup:CAPacitance and returns the capacitance value as a float. The 'probe' parameter allows specifying a particular probe instance.

```Python
class CapacitanceCls:
    """Capacitance commands group definition."""
    def get(self, probe=Probe.Default) -> float:
        """
        Queries the input capacitance of the probe.

        SCPI: PROBe<*>:SETup:CAPacitance

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

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

### Get SBUS I3C Frame Start Python Method

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

This Python method, part of the RsMxo library, calls the SCPI command to get the start time of an I3C frame. It accepts optional serial bus and frame selectors.

```Python
value: float = driver.sbus.i3C.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)
```

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

### Manual Probe Gain Configuration (SCPI/Python)

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

This entry documents the SCPI command and corresponding Python driver methods for managing the manual gain of a probe. It includes the SCPI command syntax, class definition, and the get/set methods with their parameters and return values.

```APIDOC
SCPI Command:
PROBe<*>:SETup:GAIN:MANual

Class: ManualCls
  Manual commands group definition. 1 total commands, 0 Subgroups, 1 group commands

  get(*probe=Probe.Default*) → float
    SCPI: PROBe<*>:SETup:GAIN:MANual
    Example:
      value: float = driver.probe.setup.gain.manual.get(probe = repcap.Probe.Default)
    Description:
      Sets the gain for an unknown current probe.
    Parameters:
      probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
    Returns:
      prb_gn_md_manual: No help available

  set(*prb_gn_md_manual: float*, *probe=Probe.Default*) → None
    SCPI: PROBe<*>:SETup:GAIN:MANual
    Example:
      driver.probe.setup.gain.manual.set(prb_gn_md_manual = 1.0, probe = repcap.Probe.Default)
    Description:
      Sets the gain for an unknown current probe.
    Parameters:
      prb_gn_md_manual: No help available
      probe: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Probe’)
```

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

### Python Driver: Get SBUS NRZC Frame Start

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

This Python code snippet demonstrates how to use the driver to retrieve the start time of a frame using the SBUS NRZC protocol. It utilizes the 'get' method with optional serial bus and frame selectors.

```python
value: float = driver.sbus.nrzc.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)
```

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

### RsMxo Probe Setup Class Overview

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

Provides an overview of the Setup class within the RsMxo Probe module. This class groups commands related to probe setup, featuring a significant number of commands and subgroups.

```APIDOC
RsMxo.Probe.Setup
  *class* SetupCls
    Setup commands group definition.
    - Total commands: 49
    - Subgroups: 26
    - Group commands: 0

  This class serves as a central point for configuring and managing probe-specific settings within the RsMxo framework. It organizes a comprehensive set of commands and subgroups for detailed control over probe functionality.
```

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

### RsMxo API Structure Overview

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

Provides a hierarchical view of the RsMxo API, outlining major modules and their sub-sections. This structure helps in navigating the library's functionalities, such as Probe setup, calibration, measurements, and system settings.

```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>
    - Id
    - Pmeter
    - Setup
      - AcCoupling
      - Adapter
      - Advanced
      - Alignment
        - Gain
        - Write
        - Zero
          - Execute
      - Attenuation
      - Bandwidth
      - Capacitance
      - CmOffset
      - DcRange
      - Degauss
      - DisplayDiff
      - DmOffset
      - Gain
      - Impedance
      - Laser
      - Mode
      - Name
      - Noffset
      - Offset
      - Poffset
      - PrMode
      - State
      - Term
      - TipModel
      - TypePy
      - Zaxv
    - SkeState
  - RefCurve<RefCurve>
  - RefLevel<RefLevel>
  - Run
  - Saveset
  - Sbus<SerialBus>
  - Selftests
  - Sense
  - Service
  - Sessions
  - Status
  - Synchronize
  - System
  - Timebase
  - Treference<TimingReference>
  - Trfs
  - Trigger
  - TriggerInvoke
  - TrProbe
  - UserDefined
  - Wgenerator<WaveformGen>
  - Xy<XyAxis>
  - Zone<Zone>

RsMxo Utilities
RsMxo Logger
RsMxo Events
```

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

### Python Example: Get Bit State

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

Example demonstrating how to retrieve the current bit state using the BitCls.get method.

```python
# SCPI: SBUS<*>:I3C:FILTer:BIT
value: enums.SbusBitState = driver.sbus.i3C.filterPy.bit.get(serialBus = repcap.SerialBus.Default)
```

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

### StartCls.get Method for Frame Start

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

The `get` method of the `StartCls` class retrieves the start time of the selected frame. It requires optional `serialBus` and `frame` selectors and returns a float representing the frame start time.

```APIDOC
class StartCls:
    """Start commands group definition."""
    def get(self, serialBus: SerialBus = SerialBus.Default, frame: Frame = Frame.Default) -> float:
        """
        # SCPI: SBUS<*>:TNOS:FRAMe<*>:STARt
        value: float = driver.sbus.tnos.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)

        Returns the start time of the selected frame.

        :param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
        :param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Frame’)
        :return: frame_start: No help available
        """
        pass
```

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

### Start Frame SCPI Command and Python Method

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

This entry documents the SCPI command for starting a frame and its corresponding Python method. It details the command syntax, parameters, and return values for retrieving the frame start time.

```SCPI
SBUS<*>:SPMI:FRAMe<*>:STARt
```

```Python
class StartCls:
    """Start commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
    def get(self, serialBus=SerialBus.Default, frame=Frame.Default) -> float:
        """
        # SCPI: SBUS<*>:SPMI:FRAMe<*>:STARt
        value: float = driver.sbus.spmi.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)

        Returns the start time of the selected frame.

        :param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Sbus’)
        :param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Frame’)
        :return: frame_start: No help available
        """
        pass
```

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

### Enable SCPI Command and Class Methods

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

Documentation for the SCPI command to enable overload status warnings and the associated Python class methods for setting and getting this status. This includes command syntax, parameter descriptions, return values, and usage examples.

```APIDOC
SCPI Command:
  CHANnel<*>:WARNoverload:STATus:ENABle

Class: EnableCls
  Purpose: Enable commands group definition.

Methods:
  get(*channel=Channel.Default*) → bool
    Description: Retrieves the enablement status for overload warnings. Sets the ENABle part that allows true conditions in the EVENt part to be reported for the summary bit in the status byte. These events can be used for a service request. If a bit in the ENABle part is 1, and the corresponding EVENt bit is true, a positive transition occurs in the summary bit. This transition is reported to the next higher level.
    Parameters:
      channel: The repeated capability selector for the channel. Default value: Ch1.
    Returns:
      bool: The enablement status.
    Example:
      # SCPI: CHANnel<*>:WARNoverload:STATus:ENABle
      value: bool = driver.channel.warnOverload.status.enable.get(channel = repcap.Channel.Default)

  set(*value: bool*, *channel=Channel.Default*) → None
    Description: Sets the enablement status for overload warnings. Sets the ENABle part that allows true conditions in the EVENt part to be reported for the summary bit in the status byte. These events can be used for a service request. If a bit in the ENABle part is 1, and the corresponding EVENt bit is true, a positive transition occurs in the summary bit. This transition is reported to the next higher level.
    Parameters:
      value: The boolean value to set the enablement status to.
      channel: The repeated capability selector for the channel. Default value: Ch1.
    Example:
      # SCPI: CHANnel<*>:WARNoverload:STATus:ENABle
      driver.channel.warnOverload.status.enable.set(value = False, channel = repcap.Channel.Default)

Related Methods/Commands:
  - STATus:QUEStionable:…:[:EVENt]
  - STATus:QUEStionable:…:[:ENABLe]

Error Conditions:
  - Refer to SCPI error documentation for specific error codes related to invalid parameters or command execution.
```

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

### Get SCPI SBUS CAN Frame Start Time

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

Retrieves the start time of the selected CAN frame using SCPI commands. This command is part of the SBUS CAN Frame group.

```APIDOC
SBUS<*>:CAN:FRAMe<*>:STARt
  Description: Start commands group definition. 1 total commands, 0 Subgroups, 1 group commands.
  Parameters:
    *: Wildcard for repeated capabilities.
  Returns:
    float: The start time of the selected frame.
```

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

### Python Class for SBus I2C Frame Start Commands

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

Defines the Python class 'StartCls' which encapsulates commands related to starting an I2C frame on the SBus. It includes a method to get the frame start time.

```python
class StartCls:
    get(*serialBus=SerialBus.Default, *frame=Frame.Default) -> float
```

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

### RsMxo API Structure Overview

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

Provides a hierarchical view of the RsMxo API, listing major modules and sub-components. This serves as a navigation guide to the API's organization.

```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>
    - Id
    - Pmeter
    - Setup
      - AcCoupling
      - Adapter
      - Advanced
      - Alignment
      - Attenuation
      - Bandwidth
      - Capacitance
      - CmOffset
      - DcRange
      - Degauss
      - DisplayDiff
      - DmOffset
      - Gain
      - Impedance
      - Laser
      - Mode
      - Name
      - Noffset
      - Offset
      - Poffset
      - PrMode
      - State
      - Term
      - TipModel
      - TypePy
      - Zaxv
    - SkeState
  - RefCurve<RefCurve>
  - RefLevel<RefLevel>
  - Run
  - Saveset
  - Sbus<SerialBus>
  - Selftests
  - Sense
  - Service
  - Sessions
  - Status
  - Synchronize
  - System
  - Timebase
  - Treference<TimingReference>
  - Trfs
  - Trigger
  - TriggerInvoke
  - TrProbe
  - UserDefined
  - Wgenerator<WaveformGen>
  - Xy<XyAxis>
  - Zone<Zone>

RsMxo Utilities
RsMxo Logger
RsMxo Events
```

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

### Python Implementation for SBUS CAN Frame Start

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

Python code to get the start time of a selected CAN frame using the RsMxo driver. It specifies optional serial bus and frame selectors.

```Python
value: float = driver.sbus.can.frame.start.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)
```

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

### Get Bit State Example

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

Python example demonstrating how to retrieve the current bit state using the BitCls.get method.

```python
# SCPI: SBUS<*>:I2C:FILTer:BIT
value: enums.SbusBitState = driver.sbus.i2C.filterPy.bit.get(serialBus = repcap.SerialBus.Default)
```
Tokens:
Raw