RFmx WCDMA Python API Documentation =================================== About ===== The **nirfmx-python** repository generates Python bindings (Application Programming Interface) for interacting with the RFmx Products. **nirfmx-python** follows `Python Software Foundation `_ support policy for different versions. Operating System Support ======================== **nirfmxwcdma** supports Windows systems where the supported drivers are installed. Refer to `NI Hardware and Operating System Compatibility `_ for which versions of the driver support your hardware on a given operating system. Installation ============ You can use `pip `_ to download `nirfmxwcdma `_ and install it. .. code-block:: shell $ python -m pip install nirfmxwcdma To also install gRPC support for remote NI gRPC Device Server communication: .. code-block:: shell $ python -m pip install "nirfmxwcdma[grpc]" Upgrade ======= You can use `pip `_ to upgrade `nirfmxwcdma `_ package using following command: .. code-block:: shell $ python -m pip install nirfmxwcdma --upgrade Support and Feedback ==================== For support with Python API, hardware, the driver runtime or any other questions, please visit `NI Community Forums `_. Documentation: ============== .. toctree:: :maxdepth: 1 acp acp_configuration acp_results attributes cda cda_configuration cda_results chp chp_configuration chp_results enums errors grpc_session_options modacc modacc_configuration modacc_results obw obw_configuration obw_results qevm qevm_configuration qevm_results sem sem_configuration sem_results slotphase slotphase_configuration slotphase_results slotpower slotpower_configuration slotpower_results wcdma Example: ======== .. code-block:: python import nirfmxinstr import nirfmxwcdma import numpy instr_session = None wcdma = None try: # Create a new RFmx Session instr_session = nirfmxinstr.Session(resource_name="RFSA", option_string="") # Get WCDMA signal wcdma = instr_session.get_wcdma_signal_configuration() # Configure RFmx Session instr_session.configure_frequency_reference(selector_string="", frequency_reference_source="OnboardClock", frequency_reference_frequency=10.0e6) # Configure WCDMA signal wcdma.configure_rf(selector_string="", center_frequency=1.95e9, reference_level=0.0, external_attenuation=0.0) wcdma.configure_digital_edge_trigger( selector_string="", digital_edge_source="PFI0", digital_edge=nirfmxwcdma.DigitalEdgeTriggerEdge.RISING_EDGE, trigger_delay=0.0, enable_trigger=False, ) wcdma.configure_contiguous_carriers(selector_string="", num_carriers=2, carrier_at_center_frequency=-1) # Select ACP Measurement wcdma.select_measurements(selector_string="", measurements=nirfmxwcdma.MeasurementTypes.ACP, enable_all_traces=True) # Configure ACP Measurement wcdma.acp.configuration.configure_averaging( selector_string="", averaging_enabled=nirfmxwcdma.AcpAveragingEnabled.FALSE, averaging_count=10, averaging_type=nirfmxwcdma.AcpAveragingType.RMS, ) wcdma.acp.configuration.configure_sweep_time(selector_string="", sweep_time_auto=nirfmxwcdma.AcpSweepTimeAuto.TRUE, sweep_time_interval=6.67e-4) wcdma.initiate(selector_string="", result_name="") # Retrieve Results absolute_power, relative_power, error_code = wcdma.acp.results.fetch_carrier_measurement_array( selector_string="", timeout=10.0 ) ( lower_relative_power, upper_relative_power, lower_absolute_power, upper_absolute_power, error_code, ) = wcdma.acp.results.fetch_offset_measurement_array(selector_string="", timeout=10.0) # The numpy arrays are passed in pre-allocated. If the pre allocated array size does not match the # actual array size returned by the measurement, the array is automatically resized to fit the data, # which may invalidate the previously created view. Passing an empty array (size 0) is fine; # it will be resized as needed. spectrum = numpy.empty(0, dtype=numpy.float32) x0, dx, error_code = wcdma.acp.results.fetch_spectrum(selector_string="", timeout=10.0, spectrum=spectrum) # Print Results print("------------------Carrier Measurements------------------") for i in range(len(absolute_power)): print(f"Carrier {i}") print(f"Absolute Power (dBm) : {absolute_power[i]}") print(f"Relative Power (dB) : {relative_power[i]}") print("\n------------------Offset Measurements------------------") for i in range(len(lower_relative_power)): print(f"Offset {i}") print(f"Lower Relative Power (dB) : {lower_relative_power[i]}") print(f"Upper Relative Power (dB) : {upper_relative_power[i]}") print(f"Lower Absolute Power (dBm) : {lower_absolute_power[i]}") print(f"Upper Absolute Power (dBm) : {upper_absolute_power[i]}") except Exception as e: print("ERROR: " + str(e)) finally: # Close Session if wcdma is not None: wcdma.dispose() wcdma = None if instr_session is not None: instr_session.close() instr_session = None Numpy array size handling in RFmx APIs ======================================= The numpy arrays are passed in pre-allocated. If the pre allocated array size does not match the actual array size returned by the measurement, the array is automatically resized to fit the data, which may invalidate the previously created view. Passing an empty array (size 0) is fine; it will be resized as needed. Additional Documentation ======================== Refer to the `NI-RFmx User Manual `_ for an overview of NI-RFmx, system requirements, troubleshooting, key concepts, etc. License ======= This project is licensed under the MIT License. While the source code is not publicly released, the license permits binary distribution with attribution. **Note:** This Python driver depends on several third-party components that are subject to separate commercial licenses. Users are responsible for ensuring they have the appropriate rights and licenses to use those dependencies in their environments. gRPC Features ============= For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to :py:meth:`nirfmxinstr.Session.__init__()` is subject to the NI General Purpose EULA. SSL/TLS Support =============== The server supports both server-side TLS and mutual TLS. Security configuration is accomplished by setting the `server_cert`, `server_key` and `root_cert` values in the server's configuration file. The server expects the certificate files specified in the configuration file to exist in a `certs` folder that is located in the same directory as the configuration file being used by the server. For more detailed information on SSL/TLS support refer to the `Server Security Support wiki page `_ Indices and Tables ================== * :ref:`genindex` * :ref:`modindex`