NI RFmx NR General Attributes - ni/grpc-device GitHub Wiki
- RFMXNR_ATTR_SELECTED_PORTS
- RFMXNR_ATTR_CENTER_FREQUENCY
- RFMXNR_ATTR_REFERENCE_LEVEL
- RFMXNR_ATTR_EXTERNAL_ATTENUATION
- RFMXNR_ATTR_REFERENCE_LEVEL_HEADROOM
- RFMXNR_ATTR_LINK_DIRECTION
- RFMXNR_ATTR_GNODEB_CATEGORY
- RFMXNR_ATTR_GNODEB_TYPE
- RFMXNR_ATTR_TRANSMIT_ANTENNA_TO_ANALYZE
- RFMXNR_ATTR_POWER_CLASS
- RFMXNR_ATTR_PIBY2BPSK_POWER_BOOST_ENABLED
- RFMXNR_ATTR_DOWNLINK_CHANNEL_CONFIGURATION_MODE
- RFMXNR_ATTR_AUTO_INCREMENT_CELL_ID_ENABLED
- RFMXNR_ATTR_NUMBER_OF_SUBBLOCKS
- RFMXNR_ATTR_SUBBLOCK_FREQUENCY_DEFINITION
- RFMXNR_ATTR_SUBBLOCK_TRANSMIT_LO_FREQUENCY
- RFMXNR_ATTR_PHASE_COMPENSATION_FREQUENCY
- RFMXNR_ATTR_FREQUENCY_RANGE
- RFMXNR_ATTR_BAND
- RFMXNR_ATTR_SUBBLOCK_ENDC_NOMINAL_SPACING_ADJUSTMENT
- RFMXNR_ATTR_CHANNEL_RASTER
- RFMXNR_ATTR_COMPONENT_CARRIER_SPACING_TYPE
- RFMXNR_ATTR_COMPONENT_CARRIER_AT_CENTER_FREQUENCY
- RFMXNR_ATTR_RESULT_FETCH_TIMEOUT
Data Type: | char [] |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeString RFmxNR_GetAttributeString |
Description: | Specifies the instrument port to be configured to acquire a signal. Use RFmxInstr_GetAvailablePorts function to get the valid port names. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. Valid values PXIe-5830 if0, if1 PXIe-5831/5832 if0, if1, rf(0-1)/port(x), where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel Other devices '' (empty string) Default values PXIe-5830/5831/5832 if1 Other devices '' (empty string) Get Function: RFmxNR_GetSelectedPorts Set Function: RFmxNR_SetSelectedPorts |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the center frequency of the acquired RF signal for a single carrier. This value is expressed in Hz. For intraband carrier aggregation, this attribute specifies the reference frequency of a subblock. Depending on the Subblock Frequency Definition attribute, the center frequency can either be absolute or relative to first subblock's center frequency. All component carrier frequencies within the subblock are defined with respect to this frequency. Use 'subblock(n)' as the Selector Strings to configure or read this attribute. The default of this attribute is hardware dependent. Get Function: RFmxNR_GetCenterFrequency Set Function: RFmxNR_SetCenterFrequency |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the reference level which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default of this attribute is hardware dependent. Get Function: RFmxNR_GetReferenceLevel Set Function: RFmxNR_SetReferenceLevel |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 0. Get Function: RFmxNR_GetExternalAttenuation Set Function: RFmxNR_SetExternalAttenuation |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the margin RFmx adds to the RFMXNR_ATTR_REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the RFMXNR_ATTR_REFERENCE_LEVEL plus the RFMXNR_ATTR_REFERENCE_LEVEL_HEADROOM. If you know the input power of the signal precisely or previously included the margin in the RFMXNR_ATTR_REFERENCE_LEVEL, you could improve the signal-to-noise ratio by reducing the RFMXNR_ATTR_REFERENCE_LEVEL_HEADROOM. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. Supported devices: PXIe-5668R, PXIe-5830/5831/5832/5840/5841. Default values PXIe-5668 6 dB PXIe-5830/5831/5832/5841 1 dB PXIe-5840 0 dB Get Function: RFmxNR_GetReferenceLevelHeadroom Set Function: RFmxNR_SetReferenceLevelHeadroom |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the link direction of the received signal. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_LINK_DIRECTION_UPLINK. Get Function: RFmxNR_GetLinkDirection Set Function: RFmxNR_SetLinkDirection |
Values: |
RFMXNR_VAL_LINK_DIRECTION_DOWNLINK (0) | NR measurement uses 3GPP NR downlink specification to measure the received signal. |
---|---|
RFMXNR_VAL_LINK_DIRECTION_UPLINK (1) | NR measurement uses 3GPP NR uplink specification to measure the received signal. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the downlink gNodeB (Base Station) category. Refer to the 3GPP 38.104 specification for more information about gNodeB category. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is Wide Area Base Station - Category A. Get Function: RFmxNR_GetgNodeBCategory Set Function: RFmxNR_SetgNodeBCategory |
Values: |
RFMXNR_VAL_GNODEB_CATEGORY_WIDE_AREA_BASE_STATION_CATEGORY_A (0) | The gNodeB type is Wide Area Base Station - Category A. |
---|---|
RFMXNR_VAL_GNODEB_CATEGORY_WIDE_AREA_BASE_STATION_CATEGORY_B_OPTION1 (1) | The gNodeB type is Wide Area Base Station - Category B Option1. |
RFMXNR_VAL_GNODEB_CATEGORY_WIDE_AREA_BASE_STATION_CATEGORY_B_OPTION2 (2) | The gNodeB type is Wide Area Base Station - Category B Option2. |
RFMXNR_VAL_GNODEB_CATEGORY_LOCAL_AREA_BASE_STATION (3) | The gNodeB type is Local Area Base Station. |
RFMXNR_VAL_GNODEB_CATEGORY_MEDIUM_RANGE_BASE_STATION (5) | The gNodeB type is Medium Range Base Station. |
RFMXNR_VAL_GNODEB_CATEGORY_FR2_CATEGORY_A (6) | The gNodeB type is FR2 Category A. |
RFMXNR_VAL_GNODEB_CATEGORY_FR2_CATEGORY_B (7) | The gNodeB type is FR2 Category B. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the downlink gNodeB (Base Station) type. Refer to the 3GPP 38.104 specification for more information about RFMXNR_ATTR_GNODEB_TYPE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is Type 1-C. Get Function: RFmxNR_GetgNodeBType Set Function: RFmxNR_SetgNodeBType |
Values: |
RFMXNR_VAL_GNODEB_TYPE_1C (0) | Type 1-C NR base station operating at FR1 and conducted requirements apply. |
---|---|
RFMXNR_VAL_GNODEB_TYPE_1H (1) | Type 1-H base station operating at FR1 and conducted and OTA requirements apply. |
RFMXNR_VAL_GNODEB_TYPE_1O (2) | Type 1-O base station operating at FR1 and OTA requirements apply. |
RFMXNR_VAL_GNODEB_TYPE_2O (3) |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the physical antenna that is currently connected to the analyzer. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 0. Get Function: RFmxNR_GetTransmitAntennaToAnalyze Set Function: RFmxNR_SetTransmitAntennaToAnalyze |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the power class for the UE as specified in section 6.2 of 3GPP 38.101-1/2/3 specification. This attribute impacts the spectral flatness mask for uplink. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 3. Get Function: RFmxNR_GetPowerClass Set Function: RFmxNR_SetPowerClass |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the power boost for PI/2 BPSK signal when you set the RFMXNR_ATTR_FREQUENCY_RANGE attribute to RFMXNR_VAL_FREQUENCY_RANGE_RANGE1. This attribute is valid only for uplink direction. For PI/2 BPSK modulation, if this attribute is set to True, Power Class attribute to 3,RFMXNR_ATTR_BAND attribute to 40, 41, 77, 78, or 79, and the RFMXNR_ATTR_PUSCH_SLOT_ALLOCATION attribute is set such that, at most 40% of the radio frame is active, then the EVM Equalizer spectral flatness mask specified in section 6.4.2.4.1 of 3GPP 38.101-1 is used. Otherwise the EVM Equalizer spectral flatness mask specified in section 6.4.2.4 of 3GPP 38.101-1 is used. When you set the RFMXNR_ATTR_FREQUENCY_RANGE attribute to Range 2, the measurement ignores the RFMXNR_ATTR_PIBY2BPSK_POWER_BOOST_ENABLED attribute. In this case, when you set the RFMXNR_ATTR_MODACC_SPECTRAL_FLATNESS_CONDITION attribute to RFMXNR_VAL_MODACC_SPECTRAL_FLATNESS_CONDITION_NORMAL, the equalizer spectral flatness mask as specified in section 6.4.2.5 of 3GPP TS 38.101-2 is used for the PI/2 BPSK signal. Otherwise, the equalizer spectral flatness mask as specified in section 6.4.2.4 of 3GPP 38.101-2 is used. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_PIBY2BPSK_POWER_BOOST_ENABLED_FALSE. Get Function: RFmxNR_GetPiBy2BPSKPowerBoostEnabled Set Function: RFmxNR_SetPiBy2BPSKPowerBoostEnabled |
Values: |
RFMXNR_VAL_PIBY2BPSK_POWER_BOOST_ENABLED_FALSE (0) | Power boost for PI/2 BPSK modulation is not enabled. |
---|---|
RFMXNR_VAL_PIBY2BPSK_POWER_BOOST_ENABLED_TRUE (1) | Power boost for PI/2 BPSK modulation is enabled. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the downlink channel configuration mode. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_TEST_MODEL. Get Function: RFmxNR_GetDownlinkChannelConfigurationMode Set Function: RFmxNR_SetDownlinkChannelConfigurationMode |
Values: |
RFMXNR_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_USER_DEFINED (1) | The user sets all signals and channels manually. |
---|---|
RFMXNR_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_TEST_MODEL (2) | A Test Model needs to be selected in theDownlink Test Model attribute to configure all the signals and channels automatically, according to the section 4.9.2 of 3GPP 38.141-1/2 specification. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether the cell ID of component carrier is auto calculated and configured by the measurement or configured by the user. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_AUTO_INCREMENT_CELL_ID_ENABLED_FALSE. Get Function: RFmxNR_GetAutoIncrementCellIDEnabled Set Function: RFmxNR_SetAutoIncrementCellIDEnabled |
Values: |
RFMXNR_VAL_AUTO_INCREMENT_CELL_ID_ENABLED_FALSE (0) | The measurement uses the user-configured cell IDs. |
---|---|
RFMXNR_VAL_AUTO_INCREMENT_CELL_ID_ENABLED_TRUE (1) | The Cell ID of each CC is auto calculated as specified in section 4.9.2.3 of 3GPP 38.141 specification. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the number of subblocks configured in intraband non-contiguous carrier aggregation scenarios. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1. Set this attribute to 1 for single carrier and intra-band contiguous carrier aggregation. Get Function: RFmxNR_GetNumberOfSubblocks Set Function: RFmxNR_SetNumberOfSubblocks |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies if the subblock center frequency definition is an absolute frequency or relative to the absolute frequency of the first subblock. This attribute is ignored for the first subblock and is considered to be absolute by the measurement. Use 'subblock(n)' as the Selector Strings to configure or read this attribute. The default value is RFMXNR_VAL_SUBBLOCK_FREQUENCY_DEFINITION_RELATIVE. Get Function: RFmxNR_GetSubblockFrequencyDefinition Set Function: RFmxNR_SetSubblockFrequencyDefinition |
Values: |
RFMXNR_VAL_SUBBLOCK_FREQUENCY_DEFINITION_RELATIVE (0) | Subblock center frequency is relative to the center frequency of the first subblock. |
---|---|
RFMXNR_VAL_SUBBLOCK_FREQUENCY_DEFINITION_ABSOLUTE (1) | Subblock center frequency is an absolute frequency. |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the frequency of the transmitters local oscillator. This value is expressed in Hz. The frequency is defined per subblock and relative to the respective subblock center frequency. Use 'subblock(n)' as the Selector String to configure or read this attribute. The default value is 0. Get Function: RFmxNR_GetSubblockTransmitLOFrequency Set Function: RFmxNR_SetSubblockTransmitLOFrequency |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the frequency used for phase compensation of the signal when you set the RFMXNR_ATTR_PHASE_COMPENSATION attribute to RFMXNR_VAL_PHASE_COMPENSATION_USER_DEFINED. This value is expressed in Hz. Use 'subblock(n)' as the Selector String to configure or read this attribute. The default value is 0. Get Function: RFmxNR_GetPhaseCompensationFrequency Set Function: RFmxNR_SetPhaseCompensationFrequency |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies whether to use channel bandwidth and subcarrier spacing configuration supported in the frequency range 1 (sub 6 GHz) or the frequency range 2 (above 24 GHz). Use 'subblock(n)' as the Selector Strings to configure or read this attribute. The default value is RFMXNR_VAL_FREQUENCY_RANGE_RANGE1. Get Function: RFmxNR_GetFrequencyRange Set Function: RFmxNR_SetFrequencyRange |
Values: |
RFMXNR_VAL_FREQUENCY_RANGE_RANGE1 (0) | Measurement uses the channel bandwidth and the subcarrier spacing configuration supported in frequency range 1 (sub 6 GHz). |
---|---|
RFMXNR_VAL_FREQUENCY_RANGE_RANGE2 (1) | Measurement uses the channel bandwidth and the subcarrier spacing configuration supported in frequency range 2 (above 24 GHz). |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the evolved universal terrestrial radio access (E-UTRA) or NR operating frequency band of a subblock as specified in section 5.2 of the 3GPP 38.101-1/2/3 specification. RFMXNR_ATTR_BAND determines the spectral flatness mask and spectral emission mask. Use 'subblock(n)' as the Selector Strings to configure or read this attribute. The default value is 78. Valid values for frequency range 1 are 1, 2, 3, 5, 7, 8, 12, 13, 14, 18, 20, 24, 25, 26, 28, 29, 30, 34, 38, 39, 40, 41, 47, 48, 50, 51, 53, 65, 66, 67, 70, 71, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 89, 90, 91, 92, 93, 94, 95, 97, and 98. Valid values for frequency range 2 are 257, 258, 259, 260, 261, and 262. Get Function: RFmxNR_GetBand Set Function: RFmxNR_SetBand |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the adjustment of the center frequency for adjacent E-UTRA and NR Channels in case of nominal spacing. The value is expressed in Hz. Use 'subblock(n)' as the Selector String to configure or read this attribute. The default value is 0. Get Function: RFmxNR_GetSubblockENDCNominalSpacingAdjustment Set Function: RFmxNR_SetSubblockENDCNominalSpacingAdjustment |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the subblock channel raster which is used for computing nominal spacing between aggregated carriers as specified in section 5.4A.1 of 3GPP 38.101-1/2 specification and section 5.4.1.2 of 3GPP TS 38.104 specification. The value is expressed in Hz. Use 'subblock(n)' as the Selector String to configure or read this attribute. The default value is 15 kHz. Valid values for frequency range 1 are 15 kHz and 100kHz. Valid values for frequency range 2 is 60 kHz. Get Function: RFmxNR_GetChannelRaster Set Function: RFmxNR_SetChannelRaster |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the spacing between adjacent component carriers (CCs) within a subblock. Use 'subblock(n)' as the Selector Strings to configure or read this attribute. The default value is RFMXNR_VAL_COMPONENT_CARRIER_SPACING_TYPE_NOMINAL. Get Function: RFmxNR_GetComponentCarrierSpacingType Set Function: RFmxNR_SetComponentCarrierSpacingType |
Values: |
RFMXNR_VAL_COMPONENT_CARRIER_SPACING_TYPE_NOMINAL (0) | Calculates the frequency spacing between component carriers as defined in section 5.4A.1 in the 3GPP 38.101-1/2 specification and section 5.4.1.2 in the 3GPP TS 38.104 specification and sets the RFMXNR_ATTR_COMPONENT_CARRIER_FREQUENCY attribute. |
---|---|
RFMXNR_VAL_COMPONENT_CARRIER_SPACING_TYPE_USER (2) | The component carrier frequency that you configure in the RFMXNR_ATTR_COMPONENT_CARRIER_FREQUENCY attribute is used. |
Data Type: | int32 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32 |
Description: | Specifies the index of the component carrier having its center at the user-configured center frequency. The measurement uses this attribute along with RFMXNR_ATTR_COMPONENT_CARRIER_SPACING_TYPE attribute to calculate the value of the RFMXNR_ATTR_COMPONENT_CARRIER_FREQUENCY. This attribute is ignored if you set the RFMXNR_ATTR_COMPONENT_CARRIER_SPACING_TYPE attribute to RFMXNR_VAL_COMPONENT_CARRIER_SPACING_TYPE_USER. Use 'subblock(n)' as the Selector Strings to configure or read this attribute. Valid values are -1, 0, 1 ... n - 1, inclusive, where n is the number of component carriers in the subblock. The default value is -1. If the value is -1, the component carrier frequency values are calculated such that the center of the subcarrier(with maximum subcarrier spacing for a frequency range), which is closest to the center of the aggregated channel bandwidth, lies at the center frequency. Get Function: RFmxNR_GetComponentCarrierAtCenterFrequency Set Function: RFmxNR_SetComponentCarrierAtCenterFrequency |
Data Type: | float64 |
---|---|
Access: | read/write |
Functions: | RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64 |
Description: | Specifies the time to wait before results are available in the RFmxNR Attribute Node. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmx Attribute Node waits until the measurement is complete. The default value is 10. Get Function: RFmxNR_GetResultFetchTimeout Set Function: RFmxNR_SetResultFetchTimeout |