Skip to content

Commit a488e07

Browse files
Vaishnavigupta1312vnktshr21
Vaishnavigupta1312
and
vnktshr21
authored
Updated NI-RFSG documentation and metadata changes (#2107)
* Updated documentation and metadata changes * Updated the helper script to not split names when number is followed by uppercase * Updated CHANGELOG.md * Latest metadata * minor modification in metadata * removed changelog change since its internal and adding the built files --------- Co-authored-by: vnktshr21 <[email protected]>
1 parent e697de8 commit a488e07

File tree

7 files changed

+4522
-4577
lines changed

7 files changed

+4522
-4577
lines changed

‎docs/nirfsg/class.rst‎

Lines changed: 1824 additions & 1854 deletions
Large diffs are not rendered by default.

‎docs/nirfsg/enums.rst‎

Lines changed: 76 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -848,6 +848,51 @@ LoPlLfractionalModeEnabled
848848
849849
850850
851+
LoadConfigurationResetOptions
852+
-----------------------------
853+
854+
.. py:class:: LoadConfigurationResetOptions
855+
856+
.. py:attribute:: LoadConfigurationResetOptions.WAVEFORMS
857+
858+
859+
860+
NI-RFSG skips resetting the waveform configurations.
861+
862+
863+
864+
865+
866+
.. py:attribute:: LoadConfigurationResetOptions.DEEMBEDDING_TABLES
867+
868+
869+
870+
NI-RFSG skips resetting the de-embedding tables.
871+
872+
873+
874+
875+
876+
.. py:attribute:: LoadConfigurationResetOptions.SCRIPTS
877+
878+
879+
880+
NI-RFSG skips resetting the scripts.
881+
882+
883+
884+
885+
886+
.. py:attribute:: LoadConfigurationResetOptions.NONE
887+
888+
889+
890+
NI-RFSG resets all configurations.
891+
892+
893+
894+
895+
851896
LoadOptions
852897
-----------
853898

@@ -1363,10 +1408,6 @@ RFInLoExportEnabled
13631408

13641409

13651410

1366-
.. py:attribute:: RFInLoExportEnabled.MANUAL
1367-
1368-
1369-
13701411
.. py:attribute:: RFInLoExportEnabled.ENABLE
13711412
13721413
@@ -1377,61 +1418,47 @@ RFInLoExportEnabled
13771418

13781419

13791420

1380-
.. py:attribute:: RFInLoExportEnabled.SCRIPT_TRIGGER
1381-
1382-
1421+
RefPllBandwidth
1422+
---------------
13831423

1384-
ReferenceClockExportedRate
1385-
--------------------------
1424+
.. py:class:: RefPllBandwidth
13861425
1387-
.. py:class:: ReferenceClockExportedRate
1388-
1389-
.. py:attribute:: ReferenceClockExportedRate._10mhz
1426+
.. py:attribute:: RefPllBandwidth.NARROW
13901427
13911428
13921429
1393-
Uses a 10MHz Reference Clock rate.
1430+
Uses the narrowest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_NARROW` allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.
13941431

13951432

13961433

13971434

13981435

1399-
.. py:attribute:: ReferenceClockExportedRate._100mhz
1436+
.. py:attribute:: RefPllBandwidth.MEDIUM
14001437
14011438
14021439
1403-
Uses a 100MHz Reference Clock rate.
1440+
Uses the medium loop bandwidth setting for the PLL.
14041441

14051442

14061443

14071444

14081445

1409-
.. py:attribute:: ReferenceClockExportedRate._1ghz
1446+
.. py:attribute:: RefPllBandwidth.WIDE
14101447
14111448
14121449
1413-
Uses a 1GHz Reference Clock rate.
1450+
Uses the widest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_WIDE` on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.
14141451

14151452

14161453

14171454

14181455

1419-
ReferenceClockRate
1420-
------------------
1421-
1422-
.. py:class:: ReferenceClockRate
1423-
1424-
.. py:attribute:: ReferenceClockRate.AUTO
1425-
1426-
1427-
1428-
Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.
1429-
1430-
1431-
1456+
ReferenceClockExportedRate
1457+
--------------------------
14321458

1459+
.. py:class:: ReferenceClockExportedRate
14331460
1434-
.. py:attribute:: ReferenceClockRate._10mhz
1461+
.. py:attribute:: ReferenceClockExportedRate._10mhz
14351462
14361463
14371464
@@ -1441,92 +1468,76 @@ ReferenceClockRate
14411468

14421469

14431470

1444-
RelativeTo
1445-
----------
1446-
1447-
.. py:class:: RelativeTo
1448-
1449-
.. py:attribute:: RelativeTo.CURRENT_POSITION
1471+
.. py:attribute:: ReferenceClockExportedRate._100mhz
14501472
14511473
14521474
1453-
The reference position is relative to the current position.
1475+
Uses a 100MHz Reference Clock rate.
14541476

14551477

14561478

14571479

14581480

1459-
.. py:attribute:: RelativeTo.START_OF_WAVEFORM
1481+
.. py:attribute:: ReferenceClockExportedRate._1ghz
14601482
14611483
14621484
1463-
The reference position is relative to the start of the waveform.
1485+
Uses a 1GHz Reference Clock rate.
14641486

14651487

14661488

14671489

14681490

1469-
ResetOptions
1470-
------------
1491+
ReferenceClockRate
1492+
------------------
14711493

1472-
.. py:class:: ResetOptions
1494+
.. py:class:: ReferenceClockRate
14731495
1474-
.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS
1496+
.. py:attribute:: ReferenceClockRate.AUTO
14751497
14761498
14771499
1478-
NI-RFSG skips resetting the waveform configurations.
1500+
Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.
14791501

14801502

14811503

14821504

14831505

1484-
.. py:attribute:: ResetOptions.MANUAL
1485-
1486-
1487-
1488-
.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES
1506+
.. py:attribute:: ReferenceClockRate._10mhz
14891507
14901508
14911509
1492-
NI-RFSG skips resetting the de-embedding tables.
1510+
Uses a 10MHz Reference Clock rate.
14931511

14941512

14951513

14961514

14971515

1498-
.. py:attribute:: ResetOptions.SCRIPT_TRIGGER
1499-
1516+
RelativeTo
1517+
----------
15001518

1519+
.. py:class:: RelativeTo
15011520
1502-
.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS
1521+
.. py:attribute:: RelativeTo.CURRENT_POSITION
15031522
15041523
15051524
1506-
NI-RFSG skips resetting the scripts.
1525+
The reference position is relative to the current position.
15071526

15081527

15091528

15101529

15111530

1512-
.. py:attribute:: ResetOptions.MARKER_EVENT
1513-
1514-
1515-
1516-
.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE
1531+
.. py:attribute:: RelativeTo.START_OF_WAVEFORM
15171532
15181533
15191534
1520-
NI-RFSG resets all configurations.
1535+
The reference position is relative to the start of the waveform.
15211536

15221537

15231538

15241539

15251540

1526-
.. py:attribute:: ResetOptions.SELF_CAL_IMAGE_SUPPRESSION
1527-
1528-
1529-
15301541
ResetWithOptionsStepsToOmit
15311542
---------------------------
15321543

‎generated/nirfsg/nirfsg/enums.py‎

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,25 @@ class LoPlLfractionalModeEnabled(Enum):
364364
SCRIPT_TRIGGER = 1
365365

366366

367+
class LoadConfigurationResetOptions(Enum):
368+
WAVEFORMS = 1
369+
r'''
370+
NI-RFSG skips resetting the waveform configurations.
371+
'''
372+
DEEMBEDDING_TABLES = 8
373+
r'''
374+
NI-RFSG skips resetting the de-embedding tables.
375+
'''
376+
SCRIPTS = 2
377+
r'''
378+
NI-RFSG skips resetting the scripts.
379+
'''
380+
NONE = 0
381+
r'''
382+
NI-RFSG resets all configurations.
383+
'''
384+
385+
367386
class LoadOptions(Enum):
368387
NONE = 0
369388
r'''
@@ -585,12 +604,25 @@ class RFInLoExportEnabled(Enum):
585604
r'''
586605
The RF In local oscillator signal is not present at the front panel LO OUT connector.
587606
'''
588-
MANUAL = 0
589607
ENABLE = 1
590608
r'''
591609
The RF In local oscillator signal is present at the front panel LO OUT connector.
592610
'''
593-
SCRIPT_TRIGGER = 1
611+
612+
613+
class RefPllBandwidth(Enum):
614+
NARROW = 0
615+
r'''
616+
Uses the narrowest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_NARROW allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.
617+
'''
618+
MEDIUM = 1
619+
r'''
620+
Uses the medium loop bandwidth setting for the PLL.
621+
'''
622+
WIDE = 2
623+
r'''
624+
Uses the widest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.
625+
'''
594626

595627

596628
class ReferenceClockExportedRate(Enum):
@@ -630,29 +662,6 @@ class RelativeTo(Enum):
630662
'''
631663

632664

633-
class ResetOptions(Enum):
634-
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS = 1
635-
r'''
636-
NI-RFSG skips resetting the waveform configurations.
637-
'''
638-
MANUAL = 0
639-
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES = 8
640-
r'''
641-
NI-RFSG skips resetting the de-embedding tables.
642-
'''
643-
SCRIPT_TRIGGER = 1
644-
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS = 2
645-
r'''
646-
NI-RFSG skips resetting the scripts.
647-
'''
648-
MARKER_EVENT = 2
649-
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE = 0
650-
r'''
651-
NI-RFSG resets all configurations.
652-
'''
653-
SELF_CAL_IMAGE_SUPPRESSION = 8
654-
655-
656665
class ResetWithOptionsStepsToOmit(Enum):
657666
DEEMBEDDING_TABLES = 8
658667
r'''

0 commit comments

Comments
 (0)