Skip to content

Adding and removing few methods and few more fixes in RFSG #2121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ni-jfitzger merged 5 commits into from
Jul 17, 2025
Merged

Adding and removing few methods and few more fixes in RFSG #2121

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
030e1c6
multiple changes and fixes
vnktshr21 Jul 15, 2025
08d1e0a
addressed few review comments
vnktshr21 Jul 16, 2025
7b2177d
disabled few enums and corrected units in few
vnktshr21 Jul 17, 2025
ba361ec
more enum cleanup
vnktshr21 Jul 17, 2025
f09b69d
orientation correction in test
vnktshr21 Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/nirfsg/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3572,7 +3572,7 @@ analog_modulation_fm_narrowband_integrator

This property is valid only when you set the :py:attr:`nirfsg.Session.analog_modulation_type` property to :py:data:`~nirfsg.AnalogModulationType.FM` and the :py:attr:`nirfsg.Session.analog_modulation_fm_band` property to :py:data:`~nirfsg.AnalogModulationFmBand.NARROWBAND`.

**Default Value:** :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100hzto1khz`
**Default Value:** :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100Hzto1kHz`

**Supported Devices:** PXIe-5654/5654 with PXIe-5696

Expand All @@ -3585,11 +3585,11 @@ analog_modulation_fm_narrowband_integrator
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
| Name | Value | Description |
+==========================================================================+================+=============================================+
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100hzto1khz` | 18000 (0x4650) | Specifies a range from 100Â Hz to 1Â kHz. |
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100Hzto1kHz` | 18000 (0x4650) | Specifies a range from 100Â Hz to 1Â kHz. |
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._10khzto100khz` | 18002 (0x4652) | Specifies a range from 10Â kHz to 100Â kHz. |
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._10kHzto100kHz` | 18002 (0x4652) | Specifies a range from 10Â kHz to 100Â kHz. |
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._1khzto10khz` | 18001 (0x4651) | Specifies a range from 1Â kHz to 10Â kHz. |
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._1kHzto10kHz` | 18001 (0x4651) | Specifies a range from 1Â kHz to 10Â kHz. |
+--------------------------------------------------------------------------+----------------+---------------------------------------------+

The following table lists the characteristics of this property.
Expand Down Expand Up @@ -6768,7 +6768,7 @@ exported_ref_clock_rate

Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this property, the NI-RFSG device must be in the Configuration state.

**Default Value:** :py:data:`~nirfsg.ReferenceClockExportedRate._10mhz`
**Default Value:** :py:data:`~nirfsg.ReferenceClockExportedRate._10MHz`

**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Expand All @@ -6777,11 +6777,11 @@ exported_ref_clock_rate
+-------------------------------------------------------+--------------+-------------------------------------+
| Name | Value | Description |
+=======================================================+==============+=====================================+
| :py:data:`~nirfsg.ReferenceClockExportedRate._10mhz` | 10000000.0 | Uses a 10MHz Reference Clock rate. |
| :py:data:`~nirfsg.ReferenceClockExportedRate._10MHz` | 10000000.0 | Uses a 10MHz Reference Clock rate. |
+-------------------------------------------------------+--------------+-------------------------------------+
| :py:data:`~nirfsg.ReferenceClockExportedRate._100mhz` | 100000000.0 | Uses a 100MHz Reference Clock rate. |
| :py:data:`~nirfsg.ReferenceClockExportedRate._100MHz` | 100000000.0 | Uses a 100MHz Reference Clock rate. |
+-------------------------------------------------------+--------------+-------------------------------------+
| :py:data:`~nirfsg.ReferenceClockExportedRate._1ghz` | 1000000000.0 | Uses a 1GHz Reference Clock rate. |
| :py:data:`~nirfsg.ReferenceClockExportedRate._1GHz` | 1000000000.0 | Uses a 1GHz Reference Clock rate. |
+-------------------------------------------------------+--------------+-------------------------------------+

.. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
Expand Down Expand Up @@ -10434,7 +10434,7 @@ ref_clock_rate

**Valid Values:**

PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate._10mhz` values.
PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate._10MHz` values.

PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz

Expand Down Expand Up @@ -10465,7 +10465,7 @@ ref_clock_rate
+==============================================+===================================================================================================================================+
| :py:data:`~nirfsg.ReferenceClockRate.AUTO` | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :py:data:`~nirfsg.ReferenceClockRate._10mhz` | Uses a 10 MHz Reference Clock rate. |
| :py:data:`~nirfsg.ReferenceClockRate._10MHz` | Uses a 10 MHz Reference Clock rate. |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+

.. note:: Automatic detection of the Reference Clock rate is supported on only the PXIe-5654/5654 with PXIe-5696. For all other supported devices, NI-RFSG uses the default Reference Clock rate of 10MHz.
Expand Down
124 changes: 7 additions & 117 deletions docs/nirfsg/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ AnalogModulationFmNarrowbandIntegrator

.. py:class:: AnalogModulationFmNarrowbandIntegrator

.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._100hzto1khz
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._100Hzto1kHz



Expand All @@ -96,7 +96,7 @@ AnalogModulationFmNarrowbandIntegrator



.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._1khzto10khz
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._1kHzto10kHz



Expand All @@ -106,7 +106,7 @@ AnalogModulationFmNarrowbandIntegrator



.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._10khzto100khz
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._10kHzto100kHz



Expand Down Expand Up @@ -651,56 +651,6 @@ IQOutPortTermCfg



Lo1OutputFilter
---------------

.. py:class:: Lo1OutputFilter

.. py:attribute:: Lo1OutputFilter.HIGH



yet to be defined





.. py:attribute:: Lo1OutputFilter.LOW



yet to be defined





LoOutEnabled
------------

.. py:class:: LoOutEnabled

.. py:attribute:: LoOutEnabled.DISABLE



The local oscillator signal is present at the LO OUT front panel connector.





.. py:attribute:: LoOutEnabled.ENABLE



The local oscillator signal is not present at the LO OUT front panel connector..





LoOutExportConfigureFromRFSaEnable
----------------------------------

Expand Down Expand Up @@ -1096,31 +1046,6 @@ PhaseContinuityEnabled



PortTypes
---------

.. py:class:: PortTypes

.. py:attribute:: PortTypes.OUT



Specifies the PXIe-5840 RF OUT port.





.. py:attribute:: PortTypes.IN



Specifies the PXIe-5840 RF IN port. This value is not supported as the first element of an array.





PowerLevelType
--------------

Expand Down Expand Up @@ -1251,41 +1176,6 @@ RFBlanking



RFFilter
--------

.. py:class:: RFFilter

.. py:attribute:: RFFilter.HI_FREQ_MOD



yet to be defined





.. py:attribute:: RFFilter.LO_FREQ_MOD_4000



yet to be defined





.. py:attribute:: RFFilter.LO_FREQ_MOD_2500



yet to be defined





RFInLoExportEnabled
-------------------

Expand Down Expand Up @@ -1326,7 +1216,7 @@ ReferenceClockExportedRate

.. py:class:: ReferenceClockExportedRate

.. py:attribute:: ReferenceClockExportedRate._10mhz
.. py:attribute:: ReferenceClockExportedRate._10MHz



Expand All @@ -1336,7 +1226,7 @@ ReferenceClockExportedRate



.. py:attribute:: ReferenceClockExportedRate._100mhz
.. py:attribute:: ReferenceClockExportedRate._100MHz



Expand All @@ -1346,7 +1236,7 @@ ReferenceClockExportedRate



.. py:attribute:: ReferenceClockExportedRate._1ghz
.. py:attribute:: ReferenceClockExportedRate._1GHz



Expand All @@ -1371,7 +1261,7 @@ ReferenceClockRate



.. py:attribute:: ReferenceClockRate._10mhz
.. py:attribute:: ReferenceClockRate._10MHz



Expand Down
62 changes: 7 additions & 55 deletions generated/nirfsg/nirfsg/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ class AnalogModulationFmBand(Enum):


class AnalogModulationFmNarrowbandIntegrator(Enum):
_100hzto1khz = 18000
_100Hzto1kHz = 18000
r'''
Specifies a range from 100Hz to 1kHz.
'''
_1khzto10khz = 18001
_1kHzto10kHz = 18001
r'''
Specifies a range from 1kHz to 10kHz.
'''
_10khzto100khz = 18002
_10kHzto100kHz = 18002
r'''
Specifies a range from 10kHz to 100kHz.
'''
Expand Down Expand Up @@ -284,28 +284,6 @@ class IQOutPortTermCfg(Enum):
'''


class Lo1OutputFilter(Enum):
HIGH = 0
r'''
yet to be defined
'''
LOW = 1
r'''
yet to be defined
'''


class LoOutEnabled(Enum):
DISABLE = 0
r'''
The local oscillator signal is present at the LO OUT front panel connector.
'''
ENABLE = 1
r'''
The local oscillator signal is not present at the LO OUT front panel connector..
'''


class LoOutExportConfigureFromRFSaEnable(Enum):
DISABLE = 0
r'''
Expand Down Expand Up @@ -477,17 +455,6 @@ class PhaseContinuityEnabled(Enum):
'''


class PortTypes(Enum):
OUT = 14501
r'''
Specifies the PXIe-5840 RF OUT port.
'''
IN = 14500
r'''
Specifies the PXIe-5840 RF IN port. This value is not supported as the first element of an array.
'''


class PowerLevelType(Enum):
AVERAGE = 7000
r'''
Expand Down Expand Up @@ -544,21 +511,6 @@ class RFBlanking(Enum):
'''


class RFFilter(Enum):
HI_FREQ_MOD = '0'
r'''
yet to be defined
'''
LO_FREQ_MOD_4000 = '1'
r'''
yet to be defined
'''
LO_FREQ_MOD_2500 = '2'
r'''
yet to be defined
'''


class RFInLoExportEnabled(Enum):
UNSPECIFIED = -2
r'''
Expand All @@ -575,15 +527,15 @@ class RFInLoExportEnabled(Enum):


class ReferenceClockExportedRate(Enum):
_10mhz = 10000000
_10MHz = 10000000
r'''
Uses a 10MHz Reference Clock rate.
'''
_100mhz = 100000000.0
_100MHz = 100000000.0
r'''
Uses a 100MHz Reference Clock rate.
'''
_1ghz = 1000000000.0
_1GHz = 1000000000.0
r'''
Uses a 1GHz Reference Clock rate.
'''
Expand All @@ -594,7 +546,7 @@ class ReferenceClockRate(Enum):
r'''
Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.
'''
_10mhz = 10000000
_10MHz = 10000000
r'''
Uses a 10MHz Reference Clock rate.
'''
Expand Down
Loading