NI RFmx LTE General Attributes - ni/grpc-device GitHub Wiki
- RFMXLTE_ATTR_SELECTED_PORTS
- RFMXLTE_ATTR_CENTER_FREQUENCY
- RFMXLTE_ATTR_REFERENCE_LEVEL
- RFMXLTE_ATTR_EXTERNAL_ATTENUATION
- RFMXLTE_ATTR_REFERENCE_LEVEL_HEADROOM
- RFMXLTE_ATTR_LINK_DIRECTION
- RFMXLTE_ATTR_DUPLEX_SCHEME
- RFMXLTE_ATTR_UPLINK_DOWNLINK_CONFIGURATION
- RFMXLTE_ATTR_ENODEB_CATEGORY
- RFMXLTE_ATTR_SPECIAL_SUBFRAME_CONFIGURATION
- RFMXLTE_ATTR_NUMBER_OF_DUT_ANTENNAS
- RFMXLTE_ATTR_TRANSMIT_ANTENNA_TO_ANALYZE
- RFMXLTE_ATTR_NUMBER_OF_SUBBLOCKS
- RFMXLTE_ATTR_SUBBLOCK_FREQUENCY_DEFINITION
- RFMXLTE_ATTR_BAND
- RFMXLTE_ATTR_COMPONENT_CARRIER_SPACING_TYPE
- RFMXLTE_ATTR_COMPONENT_CARRIER_AT_CENTER_FREQUENCY
- RFMXLTE_ATTR_RESULT_FETCH_TIMEOUT
| Data Type: | char [] |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeString RFmxLTE_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 Other devices: (empty string) PXIe-5831/5832: if0, if1, rf<0-1>/port, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel Default values: PXIe-5830: if1 Other devices: (empty string) Get Function: RFmxLTE_GetSelectedPorts Set Function: RFmxLTE_SetSelectedPorts |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeF64 RFmxLTE_GetAttributeF64 |
| Description: | For a single carrier, this attribute specifies the center frequency of the acquired RF signal. For intra-band carrier aggregation, this attribute specifies the reference frequency of the subblock. Depending on the RFMXLTE_ATTR_SUBBLOCK_FREQUENCY_DEFINITION attribute, the center frequency can either be an absolute frequency or relative to the absolute frequency of the center frequency of the first subblock. All component carrier frequencies within the subblock are defined with respect to this frequency. This value is expressed in Hz. Use 'subblock(n)' as the selector string to configure or read this attribute. Refer to the Center Frequency topic for more information. The default value of this attribute is hardware dependent. Get Function: RFmxLTE_GetCenterFrequency Set Function: RFmxLTE_SetCenterFrequency |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeF64 RFmxLTE_GetAttributeF64 |
| Description: | Specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as 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 value of this attribute is hardware dependent. Get Function: RFmxLTE_GetReferenceLevel Set Function: RFmxLTE_SetReferenceLevel |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeF64 RFmxLTE_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. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation. 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: RFmxLTE_GetExternalAttenuation Set Function: RFmxLTE_SetExternalAttenuation |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeF64 RFmxLTE_GetAttributeF64 |
| Description: | Specifies the margin RFmx adds to the RFMXLTE_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 RFMXLTE_ATTR_REFERENCE_LEVEL plus the RFMXLTE_ATTR_REFERENCE_LEVEL_HEADROOM. If you know the input power of the signal precisely or previously included the margin in the RFMXLTE_ATTR_REFERENCE_LEVEL, you could improve the signal-to-noise ratio by reducing the RFMXLTE_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-5668, 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: RFmxLTE_GetReferenceLevelHeadroom Set Function: RFmxLTE_SetReferenceLevelHeadroom |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_LINK_DIRECTION_UPLINK. Get Function: RFmxLTE_GetLinkDirection Set Function: RFmxLTE_SetLinkDirection |
| Values: |
| RFMXLTE_VAL_LINK_DIRECTION_DOWNLINK (0) | The measurement uses 3GPP LTE downlink specification to measure the received signal. |
|---|---|
| RFMXLTE_VAL_LINK_DIRECTION_UPLINK (1) | The measurement uses 3GPP LTE uplink specification to measure the received signal. |
| RFMXLTE_VAL_LINK_DIRECTION_SIDELINK (2) | The measurement uses 3GPP LTE sidelink specifications to measure the received signal. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the duplexing technique of the signal being measured. 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 RFMXLTE_VAL_DUPLEX_SCHEME_FDD. Get Function: RFmxLTE_GetDuplexScheme Set Function: RFmxLTE_SetDuplexScheme |
| Values: |
| RFMXLTE_VAL_DUPLEX_SCHEME_FDD (0) | Specifies that the duplexing technique is frequency-division duplexing. |
|---|---|
| RFMXLTE_VAL_DUPLEX_SCHEME_TDD (1) | Specifies that the duplexing technique is time-division duplexing. |
| RFMXLTE_VAL_DUPLEX_SCHEME_LAA (2) | Specifies that the duplexing technique is license assisted access. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame. 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 RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_0. Get Function: RFmxLTE_GetUplinkDownlinkConfiguration Set Function: RFmxLTE_SetUplinkDownlinkConfiguration |
| Values: |
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_0 (0) | The configuration of the LTE frame structure in the TDD duplex mode is 0. |
|---|---|
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_1 (1) | The configuration of the LTE frame structure in the TDD duplex mode is 1. |
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_2 (2) | The configuration of the LTE frame structure in the TDD duplex mode is 2. |
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_3 (3) | The configuration of the LTE frame structure in the TDD duplex mode is 3. |
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_4 (4) | The configuration of the LTE frame structure in the TDD duplex mode is 4. |
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_5 (5) | The configuration of the LTE frame structure in the TDD duplex mode is 5. |
| RFMXLTE_VAL_UPLINK_DOWNLINK_CONFIGURATION_6 (6) | The configuration of the LTE frame structure in the TDD duplex mode is 6. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details. 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: RFmxLTE_GeteNodeBCategory Set Function: RFmxLTE_SeteNodeBCategory |
| Values: |
| RFMXLTE_VAL_ENODEB_WIDE_AREA_BASE_STATION_CATEGORY_A (0) | Specifies eNodeB is Wide Area Base Station - Category A. |
|---|---|
| RFMXLTE_VAL_ENODEB_WIDE_AREA_BASE_STATION_CATEGORY_B_OPTION1 (1) | Specifies eNodeB is Wide Area Base Station - Category B Option1. |
| RFMXLTE_VAL_ENODEB_WIDE_AREA_BASE_STATION_CATEGORY_B_OPTION2 (2) | Specifies eNodeB is Wide Area Base Station - Category B Option2. |
| RFMXLTE_VAL_ENODEB_LOCAL_AREA_BASE_STATION (3) | Specifies eNodeB is Local Area Base Station. |
| RFMXLTE_VAL_ENODEB_HOME_BASE_STATION (4) | Specifies eNodeB is Home Base Station. |
| RFMXLTE_VAL_ENODEB_MEDIUM_RANGE_BASE_STATION (5) | Specifies eNodeB is Medium Range Base Station. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification. 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. Valid values are 0 to 9, inclusive. Get Function: RFmxLTE_GetSpecialSubframeConfiguration Set Function: RFmxLTE_SetSpecialSubframeConfiguration |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the number of physical antennas available at the DUT for transmission in a MIMO setup. 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. Valid values are 1, 2, and 4. Get Function: RFmxLTE_GetNumberOfDUTAntennas Set Function: RFmxLTE_SetNumberOfDUTAntennas |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the physical antenna 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. Valid values are from 0 to N-1, where N is the number of DUT antennas. Get Function: RFmxLTE_GetTransmitAntennaToAnalyze Set Function: RFmxLTE_SetTransmitAntennaToAnalyze |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the number of subblocks that are configured in intra-band noncontiguous carrier aggregation. 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: RFmxLTE_GetNumberOfSubblocks Set Function: RFmxLTE_SetNumberOfSubblocks |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_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. Refer to the Center Frequency topic for more information. Use 'subblock(n)' as the selector string to configure or read this attribute. The default value is RFMXLTE_VAL_SUBBLOCK_FREQUENCY_DEFINITION_RELATIVE. Get Function: RFmxLTE_GetSubblockFrequencyDefinition Set Function: RFmxLTE_SetSubblockFrequencyDefinition |
| Values: |
| RFMXLTE_VAL_SUBBLOCK_FREQUENCY_DEFINITION_RELATIVE (0) | Subblock center frequency is relative to the center frequency of the first subblock. |
|---|---|
| RFMXLTE_VAL_SUBBLOCK_FREQUENCY_DEFINITION_ABSOLUTE (1) | Subblock center frequency is an absolute frequency. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification. Use 'subblock(n)' as the selector string to configure or read this attribute. The default value is 1. Valid values are from 1 to 255, inclusive. Get Function: RFmxLTE_GetBand Set Function: RFmxLTE_SetBand |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the spacing between two adjacent component carriers within a subblock. Refer to the Channel Spacing and Carrier Frequency Offset Definition and Reference Frequency topics for more information about component carrier spacing. Use 'subblock(n)' as the selector string to configure or read this attribute. The default value is RFMXLTE_VAL_COMPONENT_CARRIER_SPACING_TYPE_NOMINAL. Get Function: RFmxLTE_GetComponentCarrierSpacingType Set Function: RFmxLTE_SetComponentCarrierSpacingType |
| Values: |
| RFMXLTE_VAL_COMPONENT_CARRIER_SPACING_TYPE_NOMINAL (0) | Calculates the frequency spacing between component carriers, as defined in section 5.4.1A in the 3GPP TS 36.521 specification, and sets the RFMXLTE_ATTR_COMPONENT_CARRIER_FREQUENCY attribute. |
|---|---|
| RFMXLTE_VAL_COMPONENT_CARRIER_SPACING_TYPE_MINIMUM (1) | Calculates the frequency spacing between component carriers, as defined in section 5.4.1A of the 3GPP TS 36.521 specification, and sets the RFMXLTE_ATTR_COMPONENT_CARRIER_FREQUENCY attribute. |
| RFMXLTE_VAL_COMPONENT_CARRIER_SPACING_TYPE_USER (2) | The CC frequency that you configure in the RFMXLTE_ATTR_COMPONENT_CARRIER_FREQUENCY attribute is used. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32 |
| Description: | Specifies the index of the component carrier having its center at the user-configured center frequency. RFmxLTE uses this attribute along with RFMXLTE_ATTR_COMPONENT_CARRIER_SPACING_TYPE attribute to calculate the value of the RFMXLTE_ATTR_COMPONENT_CARRIER_FREQUENCY. Refer to the Carrier Frequency Offset Definition and Reference Frequency topic for more information about component carrier frequency. Use 'subblock(n)' as the selector string 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 aggregated carriers (subblock) lies at the Center Frequency. This attribute is ignored if you set the RFMXLTE_ATTR_COMPONENT_CARRIER_SPACING_TYPE attribute to User. Get Function: RFmxLTE_GetComponentCarrierAtCenterFrequency Set Function: RFmxLTE_SetComponentCarrierAtCenterFrequency |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxLTE_SetAttributeF64 RFmxLTE_GetAttributeF64 |
| Description: | Specifies the time to wait before results are available. 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 waits until the measurement is complete. 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 10. Get Function: RFmxLTE_GetResultFetchTimeout Set Function: RFmxLTE_SetResultFetchTimeout |