diff --git a/CHANGELOG.md b/CHANGELOG.md index e9d243df2..8727117d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1696,6 +1696,9 @@ - Changed the name of `get_self_calibration_last_date_and_time` to `get_self_cal_last_date_and_time` to be consistent with other MI drivers - Added default value for `module` parameter in `get_self_cal_last_date_and_time` and `get_self_calibration_temperature` methods to align with documentation and allow duck-typing - Updated `self_test` to not have any parameters, aligning with other MI drivers + - Changed `frequency_settling` property to be of type float instead of hightime.timedelta, since it can have multiple interpretation based on `frequency_settling_units` property value + - Changed `interpolation_delay` and `relative_delay` properties to be of type hightime.timedelta, so that it aligns with _delay_ attributes across all drivers + - Changed `exported_ref_clock_rate` and `ref_clock_rate` properties to be of type float instead of enum, since the enums just represented raw float values - Removed - Methods and properties applicable only to hardware which are not supported anymore - Methods diff --git a/docs/nirfsg/class.rst b/docs/nirfsg/class.rst index 8481576a1..07cc55b7b 100644 --- a/docs/nirfsg/class.rst +++ b/docs/nirfsg/class.rst @@ -5325,35 +5325,33 @@ 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.CLOCK_RATE_10_MEGAHERTZ` + **Default Value:** 10MHz **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 **Defined Values**: - +------------------------------------------------------------------------+--------------+-------------------------------------+ - | Name | Value | Description | - +========================================================================+==============+=====================================+ - | :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ` | 10000000.0 | Uses a 10MHz Reference Clock rate. | - +------------------------------------------------------------------------+--------------+-------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_100_MEGAHERTZ` | 100000000.0 | Uses a 100MHz Reference Clock rate. | - +------------------------------------------------------------------------+--------------+-------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_1_GIGAHERTZ` | 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. + +--------------+-------------------------------------+ + | Value | Description | + +==============+=====================================+ + | 10000000.0 | Uses a 10MHz Reference Clock rate. | + +--------------+-------------------------------------+ + | 100000000.0 | Uses a 100MHz Reference Clock rate. | + +--------------+-------------------------------------+ + | 1000000000.0 | Uses a 1GHz Reference Clock rate. | + +--------------+-------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+----------------------------------+ - | Characteristic | Value | - +=======================+==================================+ - | Datatype | enums.ReferenceClockExportedRate | - +-----------------------+----------------------------------+ - | Permissions | read-write | - +-----------------------+----------------------------------+ - | Repeated Capabilities | None | - +-----------------------+----------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | float | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -5972,15 +5970,15 @@ frequency_settling The following table lists the characteristics of this property. - +-----------------------+-------------------------------------------------------------+ - | Characteristic | Value | - +=======================+=============================================================+ - | Datatype | hightime.timedelta, datetime.timedelta, or float in seconds | - +-----------------------+-------------------------------------------------------------+ - | Permissions | read-write | - +-----------------------+-------------------------------------------------------------+ - | Repeated Capabilities | None | - +-----------------------+-------------------------------------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | float | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6246,15 +6244,15 @@ interpolation_delay The following table lists the characteristics of this property. - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ + +-----------------------+-------------------------------------------------------------+ + | Characteristic | Value | + +=======================+=============================================================+ + | Datatype | hightime.timedelta, datetime.timedelta, or float in seconds | + +-----------------------+-------------------------------------------------------------+ + | Permissions | read-write | + +-----------------------+-------------------------------------------------------------+ + | Repeated Capabilities | None | + +-----------------------+-------------------------------------------------------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -8665,11 +8663,11 @@ ref_clock_rate To set this property, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this property. When you read this property, it returns the frequency the device is locked to during the Committed state. - If you set this property to :py:data:`~nirfsg.ReferenceClockRate.AUTO`, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device. + If you set this property to Auto, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device. **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.CLOCK_RATE_10_MEGAHERTZ` values. + PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the Auto and 10MHz values. PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz @@ -8681,7 +8679,7 @@ ref_clock_rate **Units**: hertz (Hz) - **Default Value:** :py:data:`~nirfsg.ReferenceClockRate.AUTO` + **Default Value:** Auto **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -8695,29 +8693,27 @@ ref_clock_rate **Defined Values**: - +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Value | Description | - +===============================================================+===================================================================================================================================+ - | :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.CLOCK_RATE_10_MEGAHERTZ` | Uses a 10 MHz Reference Clock rate. | - +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Name | Value | Description | + +=======+============+===================================================================================================================================+ + | Auto | -1.0 | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. | + +-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | 10MHz | 10000000.0 | 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. - .. 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. - The following table lists the characteristics of this property. - +-----------------------+--------------------------+ - | Characteristic | Value | - +=======================+==========================+ - | Datatype | enums.ReferenceClockRate | - +-----------------------+--------------------------+ - | Permissions | read-write | - +-----------------------+--------------------------+ - | Repeated Capabilities | None | - +-----------------------+--------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | float | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -8860,15 +8856,15 @@ relative_delay The following table lists the characteristics of this property. - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ + +-----------------------+-------------------------------------------------------------+ + | Characteristic | Value | + +=======================+=============================================================+ + | Datatype | hightime.timedelta, datetime.timedelta, or float in seconds | + +-----------------------+-------------------------------------------------------------+ + | Permissions | read-write | + +-----------------------+-------------------------------------------------------------+ + | Repeated Capabilities | None | + +-----------------------+-------------------------------------------------------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: diff --git a/docs/nirfsg/enums.rst b/docs/nirfsg/enums.rst index 4ed2eaf82..9191ff67c 100644 --- a/docs/nirfsg/enums.rst +++ b/docs/nirfsg/enums.rst @@ -1036,66 +1036,6 @@ RFInLoExportEnabled -ReferenceClockExportedRate --------------------------- - -.. py:class:: ReferenceClockExportedRate - - .. py:attribute:: ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ - - - - Uses a 10MHz Reference Clock rate. - - - - - - .. py:attribute:: ReferenceClockExportedRate.CLOCK_RATE_100_MEGAHERTZ - - - - Uses a 100MHz Reference Clock rate. - - - - - - .. py:attribute:: ReferenceClockExportedRate.CLOCK_RATE_1_GIGAHERTZ - - - - Uses a 1GHz Reference Clock rate. - - - - - -ReferenceClockRate ------------------- - -.. py:class:: ReferenceClockRate - - .. py:attribute:: ReferenceClockRate.AUTO - - - - Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. - - - - - - .. py:attribute:: ReferenceClockRate.CLOCK_RATE_10_MEGAHERTZ - - - - Uses a 10MHz Reference Clock rate. - - - - - ReferencePllBandwidth --------------------- diff --git a/generated/nirfsg/nirfsg/enums.py b/generated/nirfsg/nirfsg/enums.py index 0379df2f1..b1441ebf9 100644 --- a/generated/nirfsg/nirfsg/enums.py +++ b/generated/nirfsg/nirfsg/enums.py @@ -451,32 +451,6 @@ class RFInLoExportEnabled(Enum): ''' -class ReferenceClockExportedRate(Enum): - CLOCK_RATE_10_MEGAHERTZ = 10000000 - r''' - Uses a 10MHz Reference Clock rate. - ''' - CLOCK_RATE_100_MEGAHERTZ = 100000000.0 - r''' - Uses a 100MHz Reference Clock rate. - ''' - CLOCK_RATE_1_GIGAHERTZ = 1000000000.0 - r''' - Uses a 1GHz Reference Clock rate. - ''' - - -class ReferenceClockRate(Enum): - AUTO = -1 - r''' - Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. - ''' - CLOCK_RATE_10_MEGAHERTZ = 10000000 - r''' - Uses a 10MHz Reference Clock rate. - ''' - - class ReferencePllBandwidth(Enum): NARROW = 0 r''' diff --git a/generated/nirfsg/nirfsg/session.py b/generated/nirfsg/nirfsg/session.py index 2a3223476..fd974dbad 100644 --- a/generated/nirfsg/nirfsg/session.py +++ b/generated/nirfsg/nirfsg/session.py @@ -1658,29 +1658,26 @@ class _SessionBase(object): Note: The RefOut2 output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. ''' - exported_ref_clock_rate = _attributes.AttributeEnum(_attributes.AttributeViReal64, enums.ReferenceClockExportedRate, 1150292) - '''Type: enums.ReferenceClockExportedRate + exported_ref_clock_rate = _attributes.AttributeViReal64(1150292) + '''Type: float 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:** ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ + **Default Value:** 10MHz **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 **Defined Values**: - +-----------------------------------------------------+--------------+-------------------------------------+ - | Name | Value | Description | - +=====================================================+==============+=====================================+ - | ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ | 10000000.0 | Uses a 10MHz Reference Clock rate. | - +-----------------------------------------------------+--------------+-------------------------------------+ - | ReferenceClockExportedRate.CLOCK_RATE_100_MEGAHERTZ | 100000000.0 | Uses a 100MHz Reference Clock rate. | - +-----------------------------------------------------+--------------+-------------------------------------+ - | ReferenceClockExportedRate.CLOCK_RATE_1_GIGAHERTZ | 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. + +--------------+-------------------------------------+ + | Value | Description | + +==============+=====================================+ + | 10000000.0 | Uses a 10MHz Reference Clock rate. | + +--------------+-------------------------------------+ + | 100000000.0 | Uses a 100MHz Reference Clock rate. | + +--------------+-------------------------------------+ + | 1000000000.0 | Uses a 1GHz Reference Clock rate. | + +--------------+-------------------------------------+ ''' exported_script_trigger_output_terminal = _attributes.AttributeViString(1150022) '''Type: str @@ -2022,8 +2019,8 @@ class _SessionBase(object): Note: For the PXIe-5645, this property is ignored if you are using the I/Q ports. ''' - frequency_settling = _attributes.AttributeViReal64TimeDeltaSeconds(1150083) - '''Type: hightime.timedelta, datetime.timedelta, or float in seconds + frequency_settling = _attributes.AttributeViReal64(1150083) + '''Type: float Specifies the frequency settling time. Interpretation of this value depends on the frequency_settling_units property. @@ -2147,8 +2144,8 @@ class _SessionBase(object): **Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' - interpolation_delay = _attributes.AttributeViReal64(1150153) - '''Type: float + interpolation_delay = _attributes.AttributeViReal64TimeDeltaSeconds(1150153) + '''Type: hightime.timedelta, datetime.timedelta, or float in seconds Specifies the delay, in seconds, to apply to the I/Q waveform. To set this property, the NI-RFSG device must be in the Configuration state. @@ -3510,18 +3507,18 @@ class _SessionBase(object): | "Marker3" | The trigger is received from the Marker 3. | +----------------+----------------------------------------------------------------------------------------------+ ''' - ref_clock_rate = _attributes.AttributeEnum(_attributes.AttributeViReal64, enums.ReferenceClockRate, 1250322) - '''Type: enums.ReferenceClockRate + ref_clock_rate = _attributes.AttributeViReal64(1250322) + '''Type: float Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the ref_clock_source property is set to ClkIn, RefIn, or RefIn2 To set this property, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this property. When you read this property, it returns the frequency the device is locked to during the Committed state. - If you set this property to ReferenceClockRate.AUTO, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device. + If you set this property to Auto, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device. **Valid Values:** - PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the ReferenceClockRate.AUTO and ReferenceClockRate.CLOCK_RATE_10_MEGAHERTZ values. + PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the Auto and 10MHz values. PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz @@ -3533,7 +3530,7 @@ class _SessionBase(object): **Units**: hertz (Hz) - **Default Value:** ReferenceClockRate.AUTO + **Default Value:** Auto **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -3547,18 +3544,15 @@ class _SessionBase(object): **Defined Values**: - +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Value | Description | - +============================================+===================================================================================================================================+ - | ReferenceClockRate.AUTO | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. | - +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockRate.CLOCK_RATE_10_MEGAHERTZ | Uses a 10 MHz Reference Clock rate. | - +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Name | Value | Description | + +=======+============+===================================================================================================================================+ + | Auto | -1.0 | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. | + +-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | 10MHz | 10000000.0 | 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. - - 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. ''' ref_clock_source = _attributes.AttributeViString(1150001) '''Type: str @@ -3623,8 +3617,8 @@ class _SessionBase(object): 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. ''' - relative_delay = _attributes.AttributeViReal64(1150220) - '''Type: float + relative_delay = _attributes.AttributeViReal64TimeDeltaSeconds(1150220) + '''Type: hightime.timedelta, datetime.timedelta, or float in seconds Specifies the delay, in seconds, to apply to the I/Q waveform. diff --git a/src/nirfsg/metadata/attributes.py b/src/nirfsg/metadata/attributes.py index 44403da7e..21068ed93 100644 --- a/src/nirfsg/metadata/attributes.py +++ b/src/nirfsg/metadata/attributes.py @@ -1937,15 +1937,13 @@ }, 1150083: { 'access': 'read-write', - 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { 'description': 'Specifies the frequency settling time. Interpretation of this value depends on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n**Valid Values:**\n\nThe valid values for this attribute depend on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n\n\n**Default Value**: 1.0\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Settling Times `_\n\n`Events `_' }, 'lv_property': 'RF:Frequency Settling', 'name': 'FREQUENCY_SETTLING', - 'type': 'ViReal64', - 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' + 'type': 'ViReal64' }, 1150084: { 'access': 'read only', @@ -2481,13 +2479,15 @@ }, 1150153: { 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { 'description': 'Specifies the delay, in seconds, to apply to the I/Q waveform. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units:** Seconds\n\n**Valid Values:** Plus or minus half of one I/Q sample period\n\n**Supported Devices:** PXIe-5644/5645/5646' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Interpolation Delay', 'name': 'INTERPOLATION_DELAY', - 'type': 'ViReal64' + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' }, 1150154: { 'access': 'read-write', @@ -3144,6 +3144,7 @@ }, 1150220: { 'access': 'read-write', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { 'description': 'Specifies the delay, in seconds, to apply to the I/Q waveform.\n\nRelative delay allows for delaying the generated signal from one device relative to the generated signal of another device after those devices have been synchronized. You can achieve a negative relative delay by delaying both synchronized devices by the same value (1 μs) before generation begins and then changing the relative delay to a smaller amount than the initial value on only one of the devices.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\n**Units:** Seconds\n\n**Valid Values:**\n\nPXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs\n\nPXIe-5842: 0 μs to 6.5 μs\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`NI-TClk Overview `_', @@ -3151,7 +3152,8 @@ }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Relative Delay', 'name': 'RELATIVE_DELAY', - 'type': 'ViReal64' + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' }, 1150225: { 'access': 'read-write', @@ -3651,31 +3653,26 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_10MHZ\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'description': 'Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** 10MHz\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSG_VAL_10MHZ', '10000000.0', 'Uses a 10MHz Reference Clock rate.' ], [ - 'NIRFSG_VAL_100MHZ', '100000000.0', 'Uses a 100MHz Reference Clock rate.' ], [ - 'NIRFSG_VAL_1GHZ', '1000000000.0', 'Uses a 1GHz Reference Clock rate.' ] ], 'table_header': [ - 'Name', 'Value', 'Description' ] }, - 'enum': 'ReferenceClockExportedRate', 'lv_property': 'Clock:Reference Clock Exported Rate (Hz)', 'name': 'EXPORTED_REF_CLOCK_RATE', 'type': 'ViReal64' @@ -3952,24 +3949,26 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute is set to ClkIn, RefIn, or RefIn2\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this attribute. When you read this attribute, it returns the frequency the device is locked to during the Committed state.\n\nIf you set this attribute to NIRFSG_VAL_AUTO, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device.\n\n**Valid Values:**\n\nPXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the NIRFSG_VAL_AUTO and NIRFSG_VAL_10MHZ values.\n\nPXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz \n\ny, where\n\ny is 4, 8, 16, 24, 25, or 32.\n\nPXIe-5860: 10 MHz, 100 MHz\n\n**Units**: hertz (Hz)\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRefClock\n\n**Defined Values**:', + 'description': 'Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute is set to ClkIn, RefIn, or RefIn2\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this attribute. When you read this attribute, it returns the frequency the device is locked to during the Committed state.\n\nIf you set this attribute to Auto, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device.\n\n**Valid Values:**\n\nPXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the Auto and 10MHz values.\n\nPXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz \n\ny, where\n\ny is 4, 8, 16, 24, 25, or 32.\n\nPXIe-5860: 10 MHz, 100 MHz\n\n**Units**: hertz (Hz)\n\n**Default Value:** Auto\n\n**Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRefClock\n\n**Defined Values**:', '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.', 'table_body': [ [ - 'NIRFSG_VAL_AUTO', + 'Auto', + '-1.0', 'Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.' ], [ - 'NIRFSG_VAL_10MHZ', + '10MHz', + '10000000.0', 'Uses a 10 MHz Reference Clock rate.' ] ], 'table_header': [ + 'Name', 'Value', 'Description' ] }, - 'enum': 'ReferenceClockRate', 'lv_property': 'Clock:Reference Clock Rate (Hz)', 'name': 'REF_CLOCK_RATE', 'type': 'ViReal64' diff --git a/src/nirfsg/metadata/enums.py b/src/nirfsg/metadata/enums.py index a6f0cd99d..36e40d9ba 100644 --- a/src/nirfsg/metadata/enums.py +++ b/src/nirfsg/metadata/enums.py @@ -742,53 +742,6 @@ } ] }, - 'ReferenceClockExportedRate': { - 'values': [ - { - 'documentation': { - 'description': 'Uses a 10MHz Reference Clock rate.' - }, - 'name': 'NIRFSG_VAL_10MHZ', - 'python_name': 'CLOCK_RATE_10_MEGAHERTZ', - 'value': 10000000 - }, - { - 'documentation': { - 'description': 'Uses a 100MHz Reference Clock rate.' - }, - 'name': 'NIRFSG_VAL_100MHZ', - 'python_name': 'CLOCK_RATE_100_MEGAHERTZ', - 'value': 100000000.0 - }, - { - 'documentation': { - 'description': 'Uses a 1GHz Reference Clock rate.' - }, - 'name': 'NIRFSG_VAL_1GHZ', - 'python_name': 'CLOCK_RATE_1_GIGAHERTZ', - 'value': 1000000000.0 - } - ] - }, - 'ReferenceClockRate': { - 'values': [ - { - 'documentation': { - 'description': 'Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.' - }, - 'name': 'NIRFSG_VAL_AUTO', - 'value': -1 - }, - { - 'documentation': { - 'description': 'Uses a 10MHz Reference Clock rate.' - }, - 'name': 'NIRFSG_VAL_10MHZ', - 'python_name': 'CLOCK_RATE_10_MEGAHERTZ', - 'value': 10000000 - } - ] - }, 'ReferencePllBandwidth': { 'values': [ {