nirfmxvna 26.3.0__py3-none-any.whl

nirfmxvna/errors.py

@@ -0,0 +1,96 @@
+"""errors.py - Contains error classes and method(s) to handle error."""
+
+import platform
+from typing import Any
+
+
+def _is_success(code: int) -> bool:
+    return code == 0
+
+
+def _is_error(code: int) -> bool:
+    return code < 0
+
+
+def _is_warning(code: int) -> bool:
+    return code > 0
+
+
+class Error(Exception):
+    """Base error class for RFmx VNA."""
+
+    def __init__(self, message):
+        """Base error class for RFmx VNA."""
+        super(Error, self).__init__(message)
+
+
+class DriverNotInstalledError(Error):
+    """An error due to using this module without the driver runtime installed."""
+
+    def __init__(self):
+        """An error due to using this module without the driver runtime installed."""
+        super(DriverNotInstalledError, self).__init__("The RFmx VNA runtime could not be loaded. Make sure it is installed and its bitness matches that of your Python interpreter. Please visit http://www.ni.com/downloads/drivers/ to download and install it.")  # type: ignore
+
+
+class DriverTooOldError(Error):
+    """An error due to using this module with an older version of the RFmx VNA driver runtime."""
+
+    def __init__(self):
+        """An error due to using this module with an older version of the RFmx VNA driver runtime."""
+        super(DriverTooOldError, self).__init__("A function was not found in the RFmx VNA runtime. Please visit http://www.ni.com/downloads/drivers/ to download a newer version and install it.")  # type: ignore
+
+
+class DriverTooNewError(Error):
+    """An error due to the RFmx VNA driver runtime being too new for this module."""
+
+    def __init__(self):
+        """An error due to the RFmx VNA driver runtime being too new for this module."""
+        super(DriverTooNewError, self).__init__("The RFmx VNA runtime returned an unexpected value. This can occur if it is too new for the nirfmxvna Python module. Upgrade the nirfmxvna Python module.")  # type: ignore
+
+
+class UnsupportedConfigurationError(Error):
+    """An error due to using this module in an usupported platform."""
+
+    def __init__(self):
+        """An error due to using this module in an usupported platform."""
+        super(UnsupportedConfigurationError, self).__init__("System configuration is unsupported: " + platform.architecture()[0] + " " + platform.system())  # type: ignore
+
+
+class RpcError(Error):
+    """An error specific to sessions to the NI gRPC Device Server."""
+
+    def __init__(self, rpc_code, description):
+        """An error specific to sessions to the NI gRPC Device Server."""
+        self.rpc_code = rpc_code
+        self.description = description
+        try:
+            import grpc
+
+            rpc_error = str(grpc.StatusCode(self.rpc_code))
+        except Exception:
+            rpc_error = str(self.rpc_code)
+        super(RpcError, self).__init__(rpc_error + ": " + self.description)  # type: ignore
+
+
+def handle_error(
+    library_interpreter: Any, code: int, ignore_warnings: bool, is_error_handling: bool
+) -> None:
+    r"""Helper function for handling errors returned by RFmx VNA Library.
+
+    It calls back into the LibraryInterpreter to get the corresponding error
+    description and raises if necessary.
+    """
+    if _is_success(code) or (_is_warning(code) and ignore_warnings):
+        return
+
+    if is_error_handling:
+        # The caller is in the midst of error handling and an error occurred.
+        # Don't try to get the description or we'll start recursing until the stack overflows.
+        description = ""
+    else:
+        description = library_interpreter.get_error_description(code)
+
+    if _is_error(code):
+        import nirfmxinstr
+
+        raise nirfmxinstr.RFmxError(code, description)  # type: ignore

nirfmxvna/examples/nirfmxvna_calibration_with_calset_save_two_port.py

@@ -0,0 +1,186 @@
+"""
+RFmx VNA Calibration with Calset Save Two Port Example
+
+Steps:
+1. Open a new RFmx session.
+2. Configure Frequency Reference.
+3. Configure sweep settings: Sweep Type, Start Frequency, Stop Frequency, Number of Frequency Points, 
+   IF Bandwidth, and Power Level and Test Rx Attenuation with different port names.
+4. Select S-Parameter measurement.
+5. Configure Calibration Ports and Calibration Method.
+6. Configure Connector type & vCal Resource Name for each VNA port.
+7. Detect vCal ports connected to the VNA ports.
+8. Initiate Calibration.
+9. Acquire Calibration data after user confirmation.
+10. Save Calibration data.
+11. Save Calset data to a file.
+12. Get Calset Error Terms.
+12a. Calculate Magnitude of Error Terms.
+13. Close RFmx Session.
+"""
+
+import argparse
+import sys
+
+import nirfmxinstr
+import nirfmxvna
+import numpy
+
+
+def example(resource_name, option_string):
+    """VNA calibration with calset save two port example."""
+    # Configuration parameters
+    frequency_start = 1e9  # Hz
+    frequency_end = 26e9  # Hz
+    num_of_frequency_points = 251
+    port1_power_level = -10.0  # dBm
+    port2_power_level = -10.0  # dBm
+    port1_test_receiver_attenuation = 0.0  # dB
+    port2_test_receiver_attenuation = 0.0  # dB
+    if_bandwidth = 100e3  # Hz
+
+    frequency_reference_source = "PXI_Clk"
+    frequency_reference_frequency = 100e6  # Hz
+
+    vcal_resource_name = "vCal"
+    connector_type = "3.5 mm female"
+    calibration_timeout = 100.0  # seconds
+    auto_detect_vcal_orientation = True
+    vcal_orientation = "PortA:Port1,PortB:Port2"
+
+    calset_file_path = ""
+    timeout = 10.0  # seconds
+
+    instr_session = None
+    vna_signal = None
+
+    try:
+        # Create a new RFmx Session
+        instr_session = nirfmxinstr.Session(resource_name, option_string)
+
+        # Get VNA signal configuration
+        vna_signal = instr_session.get_vna_signal_configuration()
+
+        instr_session.configure_frequency_reference(
+            "", frequency_reference_source, frequency_reference_frequency
+        )
+
+        vna_signal.set_sweep_type("", nirfmxvna.SweepType.LINEAR)
+        vna_signal.set_start_frequency("", frequency_start)
+        vna_signal.set_stop_frequency("", frequency_end)
+        vna_signal.set_number_of_points("", num_of_frequency_points)
+        vna_signal.set_if_bandwidth("", if_bandwidth)
+
+        port_selector_string = nirfmxvna.Vna.build_port_string("", "port1")
+        vna_signal.set_power_level(port_selector_string, port1_power_level)
+        vna_signal.set_test_receiver_attenuation(
+            port_selector_string, port1_test_receiver_attenuation
+        )
+
+        port_selector_string = nirfmxvna.Vna.build_port_string("", "port2")
+        vna_signal.set_power_level(port_selector_string, port2_power_level)
+        vna_signal.set_test_receiver_attenuation(
+            port_selector_string, port2_test_receiver_attenuation
+        )
+
+        vna_signal.select_measurements("", nirfmxvna.MeasurementTypes.SPARAMS, False)
+
+        vna_signal.set_correction_calibration_ports("", ["port1", "port2"])
+        vna_signal.set_correction_calibration_method(
+            "", nirfmxvna.CorrectionCalibrationMethod.SOLT
+        )
+
+        vna_signal.set_correction_calibration_connector_type("port::all", connector_type)
+        vna_signal.set_correction_calibration_calkit_electronic_resource_name(
+            "port::all", vcal_resource_name
+        )
+
+        if auto_detect_vcal_orientation:
+            vna_signal.auto_detect_vcal_orientation("")
+            vcal_orientation, error_code = vna_signal.get_correction_calibration_calkit_electronic_orientation(
+                ""
+            )
+            print(f"vCal Orientation         :{vcal_orientation}")
+        else:
+            vna_signal.set_correction_calibration_calkit_electronic_orientation(
+                "", vcal_orientation
+            )
+
+        vna_signal.calibration_initiate("")
+        vna_signal.calibration_acquire("", calibration_timeout)
+        vna_signal.calibration_save("", "")
+        vna_signal.calset_save_to_file("", "", calset_file_path)
+
+        # Retrieve error terms
+        error_term_identifiers = [
+            nirfmxvna.CalErrorTerm.DIRECTIVITY,
+            nirfmxvna.CalErrorTerm.SOURCE_MATCH,
+            nirfmxvna.CalErrorTerm.REFLECTION_TRACKING,
+            nirfmxvna.CalErrorTerm.TRANSMISSION_TRACKING,
+            nirfmxvna.CalErrorTerm.LOAD_MATCH,
+        ]
+
+        frequency_grid = numpy.empty(0, dtype=numpy.float64)
+        frequency_grid = vna_signal.calset_get_frequency_grid(
+            "", "", nirfmxvna.CalFrequencyGrid.DIRECTIVITY
+        )
+
+        for error_term_id in error_term_identifiers:
+            error_terms_port1 = numpy.empty(len(frequency_grid), dtype=numpy.complex64)
+            error_terms_port2 = numpy.empty(len(frequency_grid), dtype=numpy.complex64)
+
+            error_terms_port1 = vna_signal.calset_get_error_term(
+                "", "", error_term_id, "port1", "port2", error_terms_port1
+            )
+            error_terms_port2 = vna_signal.calset_get_error_term(
+                "", "", error_term_id, "port2", "port1", error_terms_port2
+            )
+
+            error_terms = numpy.concatenate((error_terms_port1, error_terms_port2))
+
+            # Calculate magnitude of error terms
+            error_terms_magnitude = 20 * numpy.log10(numpy.abs(error_terms))
+
+    except Exception as e:
+        print(f"Error code: {e}")
+        sys.exit(1)
+
+    finally:
+        if vna_signal is not None:
+            vna_signal.dispose()
+            vna_signal = None
+        if instr_session is not None:
+            instr_session.close()
+            instr_session = None
+
+
+def _parse_args():
+    parser = argparse.ArgumentParser(
+        description="VNA Calibration with Calset Save Two Port",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser.add_argument(
+        "-r",
+        "--resource",
+        type=str,
+        default="VNA",
+        help="Resource name of the VNA device",
+    )
+    parser.add_argument(
+        "-o",
+        "--option-string",
+        type=str,
+        default="",
+        help="Option string",
+    )
+    return parser.parse_args()
+
+
+def main():
+    """Main function."""
+    args = _parse_args()
+    example(args.resource, args.option_string)
+
+
+if __name__ == "__main__":
+    main()

nirfmxvna/examples/nirfmxvna_pulsed_s_params.py

@@ -0,0 +1,174 @@
+"""
+RFmx VNA Pulsed S-Parameters Example
+
+Steps:
+1. Open a new RFmx session.
+2. Configure Frequency Reference.
+3. Configure sweep settings: Sweep Type, Start Frequency, Stop Frequency, Number of Frequency Points, 
+   IF Bandwidth, and Power Level with different port names.
+4. Configure Pulse Settings.
+5. Configure Averaging.
+6. Select S-Parameter measurement.
+7. Configure number of S-Parameters.
+8. Configure each S-Parameter and format.
+9. Initiate the Measurement.
+10. Read Number of SParams.
+11. Fetch S-Parameter X data.
+12. Fetch S-Parameter Y data for each S-Parameter.
+13. Close RFmx Session.
+"""
+
+import argparse
+import sys
+
+import nirfmxinstr
+import nirfmxvna
+import numpy
+
+
+def example(resource_name, option_string):
+    """VNA pulsed S-parameters example."""
+    # Configuration parameters
+    frequency_start = 1e9  # Hz
+    frequency_end = 26e9  # Hz
+    number_of_frequency_points = 251
+    port1_power_level = -10.0  # dBm
+    port2_power_level = -10.0  # dBm
+
+    frequency_reference_source = "PXI_Clk"
+    frequency_reference_frequency = 100e6  # Hz
+
+    number_of_sparams = 4
+    sparams_parameters = ["S11", "S12", "S21", "S22"]
+    sparams_formats = [
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+    ]
+
+    pulse_mode_enabled = nirfmxvna.PulseModeEnabled.TRUE
+    pulse_period = 1.0e-3  # seconds
+    pulse_modulator_delay = 0.0  # seconds
+    pulse_modulator_width = 100.0e-6  # seconds
+    pulse_acquisition_auto = nirfmxvna.PulseAcquisitionAuto.TRUE
+    pulse_acquisition_delay = 20.0e-6  # seconds
+    pulse_acquisition_width = 46.65e-6  # seconds
+
+    averaging_enabled = nirfmxvna.AveragingEnabled.FALSE
+    averaging_count = 10
+
+    timeout = 10.0  # seconds
+
+    instr_session = None
+    vna_signal = None
+
+    try:
+        # Create a new RFmx Session
+        instr_session = nirfmxinstr.Session(resource_name, option_string)
+
+        # Get VNA signal configuration
+        vna_signal = instr_session.get_vna_signal_configuration()
+
+        instr_session.configure_frequency_reference(
+            "", frequency_reference_source, frequency_reference_frequency
+        )
+
+        vna_signal.set_sweep_type("", nirfmxvna.SweepType.LINEAR)
+        vna_signal.set_start_frequency("", frequency_start)
+        vna_signal.set_stop_frequency("", frequency_end)
+        vna_signal.set_number_of_points("", number_of_frequency_points)
+
+        port_selector_string = nirfmxvna.Vna.build_port_string("", "port1")
+        vna_signal.set_power_level(port_selector_string, port1_power_level)
+
+        port_selector_string = nirfmxvna.Vna.build_port_string("", "port2")
+        vna_signal.set_power_level(port_selector_string, port2_power_level)
+
+        vna_signal.set_pulse_mode_enabled("", pulse_mode_enabled)
+        vna_signal.set_pulse_period("", pulse_period)
+        vna_signal.set_pulse_modulator_delay("", pulse_modulator_delay)
+        vna_signal.set_pulse_modulator_width("", pulse_modulator_width)
+        vna_signal.set_pulse_acquisition_auto("", pulse_acquisition_auto)
+        vna_signal.set_pulse_acquisition_delay("", pulse_acquisition_delay)
+        vna_signal.set_pulse_acquisition_width("", pulse_acquisition_width)
+
+        vna_signal.set_averaging_enabled("", averaging_enabled)
+        vna_signal.set_averaging_count("", averaging_count)
+
+        vna_signal.select_measurements("", nirfmxvna.MeasurementTypes.SPARAMS, False)
+
+        vna_signal.s_params.configuration.set_number_of_s_parameters("", number_of_sparams)
+
+        for i in range(number_of_sparams):
+            sparam_selector_string = nirfmxvna.Vna.build_s_parameter_string("", i)
+            vna_signal.s_params.configuration.configure_s_parameter(
+                sparam_selector_string, sparams_parameters[i]
+            )
+            vna_signal.s_params.configuration.set_format(
+                sparam_selector_string, sparams_formats[i]
+            )
+
+        vna_signal.initiate("", "")
+
+        # Retrieve results
+        number_of_sparams_result, error_code = vna_signal.s_params.configuration.get_number_of_s_parameters("")
+
+        sparams_x_data_result, _ = vna_signal.s_params.results.fetch_x_data("", timeout)
+
+        sparams_y1_data_result = []
+        sparams_y2_data_result = []
+
+        for i in range(number_of_sparams_result):
+            sparam_selector_string = nirfmxvna.Vna.build_s_parameter_string("", i)
+
+            y1_data, y2_data, error_code = vna_signal.s_params.results.fetch_y_data(
+                sparam_selector_string, timeout
+            )
+
+            sparams_y1_data_result.append(y1_data)
+            sparams_y2_data_result.append(y2_data)
+
+    except Exception as e:
+        print(f"Error occurred: {e}")
+        sys.exit(1)
+
+    finally:
+        if vna_signal is not None:
+            vna_signal.dispose()
+            vna_signal = None
+        if instr_session is not None:
+            instr_session.close()
+            instr_session = None
+
+
+def _parse_args():
+    parser = argparse.ArgumentParser(
+        description="VNA Pulsed S-Parameters Example",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser.add_argument(
+        "-r",
+        "--resource",
+        type=str,
+        default="VNA",
+        help="Resource name of the VNA device",
+    )
+    parser.add_argument(
+        "-o",
+        "--option-string",
+        type=str,
+        default="",
+        help="Option string",
+    )
+    return parser.parse_args()
+
+
+def main():
+    """Main function."""
+    args = _parse_args()
+    example(args.resource, args.option_string)
+
+
+if __name__ == "__main__":
+    main()

nirfmxvna/examples/nirfmxvna_s_params_corrected_with_calset_load_two_port_grpc.py

@@ -0,0 +1,234 @@
+r"""Getting Started:
+
+To run this example, install "RFmx VNA" on the server machine:
+  https://www.ni.com/en-us/support/downloads/software-products/download.rfmx-vna.html
+
+Download and run the NI gRPC Device Server (ni_grpc_device_server.exe) on the server machine:
+  https://github.com/ni/grpc-device/releases
+
+  
+Running from command line:
+
+Server machine's IP address, port number, resource name and options can be passed as separate
+command line arguments.
+
+  > python nirfmxvna_s_params_corrected_with_calset_load_two_port_grpc.py <server_address> <port_number> <resource_name> <options>
+
+If they are not passed in as command line arguments, then by default the server address will be
+"localhost:31763", with "VNA" as the resource name and empty option string.
+"""
+
+r"""RFmx VNA S-Parameters Corrected with Calset Load Two Port gRPC Example
+
+Steps:
+1. Open a new RFmx session.
+2. Configure Frequency Reference.
+3. Configure sweep settings: Frequency List, IF Bandwidth, and Power Level and Test Rx Attenuation 
+   with different port names.
+4. Select S-Parameter measurement.
+5. Configure number of S-Parameters.
+6. Configure each S-Parameter and format.
+7. Configure Magnitude Units & Phase Trace Type.
+8. Load Calset data from a file.
+9. Enable Correction.
+10. Initiate the Measurement after user confirmation.
+11. Read Number of SParams.
+12. Fetch S-Parameter Correction State.
+13. Fetch S-Parameter X data.
+14. Fetch S-Parameter Y data for each S-Parameter.
+15. Set SnP Export attributes (can be accessed and written before or after measurement initiate) 
+    and save S-Parameter data to file.
+16. Close RFmx Session.
+"""
+
+import argparse
+import sys
+
+import grpc
+import nirfmxinstr
+import nirfmxvna
+import numpy
+
+
+def example(server_name, port, resource_name, option_string):
+    """Run VNA S-Parameters Corrected with Calset Load Two Port gRPC Example."""
+    # Configuration parameters
+    sweep_type = nirfmxvna.SweepType.LINEAR
+    frequency_list_size = 251
+    frequency_start = 1e9  # Hz
+    frequency_stop = 26e9  # Hz
+
+    port1_power_level = -10.0  # dBm
+    port2_power_level = -10.0  # dBm
+    port1_test_receiver_attenuation = 0.0  # dB
+    port2_test_receiver_attenuation = 0.0  # dB
+    if_bandwidth = 100e3  # Hz
+
+    frequency_reference_source = "PXI_Clk"
+    frequency_reference_frequency = 100e6  # Hz
+
+    number_of_sparams = 4
+    sparams_parameters = ["S11", "S12", "S21", "S22"]
+    sparams_formats = [
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+        nirfmxvna.SParamsFormat.MAGNITUDE,
+    ]
+
+    magnitude_units = nirfmxvna.SParamsMagnitudeUnits.DB
+    phase_trace_type = nirfmxvna.SParamsPhaseTraceType.WRAPPED
+
+    calset_file_path = ""
+    snp_file_path = ""
+
+    timeout = 10.0  # seconds
+
+    instr_session = None
+    vna_signal = None
+
+    try:
+        # Create a new RFmx gRPC Session
+        channel = grpc.insecure_channel(
+            f"{server_name}:{port}",
+            options=[
+                ("grpc.max_receive_message_length", -1),
+                ("grpc.max_send_message_length", -1),
+            ],
+        )
+        grpc_options = nirfmxinstr.GrpcSessionOptions(channel, "Remote_VNA_Session")
+
+        # Create a new RFmx Session
+        instr_session = nirfmxinstr.Session(
+            resource_name, option_string, grpc_options=grpc_options
+        )
+
+        # Get VNA signal configuration
+        vna_signal = instr_session.get_vna_signal_configuration()
+
+        instr_session.configure_frequency_reference(
+            "", frequency_reference_source, frequency_reference_frequency
+        )
+
+        vna_signal.set_sweep_type("", sweep_type)
+        vna_signal.set_start_frequency("", frequency_start)
+        vna_signal.set_stop_frequency("", frequency_stop)
+        vna_signal.set_number_of_points("", frequency_list_size)
+        vna_signal.set_if_bandwidth("", if_bandwidth)
+
+        port_selector_string = nirfmxvna.Vna.build_port_string("", "port1")
+        vna_signal.set_power_level(port_selector_string, port1_power_level)
+        vna_signal.set_test_receiver_attenuation(
+            port_selector_string, port1_test_receiver_attenuation
+        )
+
+        port_selector_string = nirfmxvna.Vna.build_port_string("", "port2")
+        vna_signal.set_power_level(port_selector_string, port2_power_level)
+        vna_signal.set_test_receiver_attenuation(
+            port_selector_string, port2_test_receiver_attenuation
+        )
+
+        vna_signal.select_measurements("", nirfmxvna.MeasurementTypes.SPARAMS, False)
+
+        vna_signal.s_params.configuration.set_number_of_s_parameters("", number_of_sparams)
+
+        for i in range(number_of_sparams):
+            sparam_selector_string = nirfmxvna.Vna.build_s_parameter_string("", i)
+            vna_signal.s_params.configuration.configure_s_parameter(
+                sparam_selector_string, sparams_parameters[i]
+            )
+            vna_signal.s_params.configuration.set_format(
+                sparam_selector_string, sparams_formats[i]
+            )
+
+        vna_signal.s_params.configuration.set_magnitude_units("", magnitude_units)
+        vna_signal.s_params.configuration.set_phase_trace_type("", phase_trace_type)
+
+        vna_signal.calset_load_from_file("", "", calset_file_path)
+
+        vna_signal.set_correction_enabled("", nirfmxvna.CorrectionEnabled.TRUE)
+        vna_signal.initiate("", "")
+
+        # Retrieve results
+        number_of_sparams_result, error_code = vna_signal.s_params.configuration.get_number_of_s_parameters("")
+
+        correction_state_result, error_code = vna_signal.s_params.results.get_correction_state("")
+
+        sparams_x_data_result, _ = vna_signal.s_params.results.fetch_x_data("", timeout)
+
+        sparams_y1_data_result = []
+        sparams_y2_data_result = []
+
+        for i in range(number_of_sparams_result):
+            sparam_selector_string = nirfmxvna.Vna.build_s_parameter_string("", i)
+
+            y1_data, y2_data, error_code = vna_signal.s_params.results.fetch_y_data(
+                sparam_selector_string, timeout
+            )
+
+            sparams_y1_data_result.append(y1_data)
+            sparams_y2_data_result.append(y2_data)
+
+        vna_signal.s_params.configuration.set_snp_data_format(
+            "", nirfmxvna.SParamsSnPDataFormat.AUTO
+        )
+        vna_signal.s_params.configuration.set_snp_ports("", "port1,port2")
+        vna_signal.s_params.configuration.export_to_snp_file("", snp_file_path)
+
+    except Exception as e:
+        print(f"Error occurred: {e}")
+        sys.exit(1)
+
+    finally:
+        if vna_signal is not None:
+            vna_signal.dispose()
+            vna_signal = None
+        if instr_session is not None:
+            instr_session.close()
+            instr_session = None
+
+
+def _parse_args():
+    parser = argparse.ArgumentParser(
+        description="VNA S-Parameters Corrected with Calset Load Two Port gRPC Example",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser.add_argument(
+        "-s",
+        "--server-address",
+        type=str,
+        default="localhost",
+        help="Server address",
+    )
+    parser.add_argument(
+        "-p",
+        "--port",
+        type=str,
+        default="31763",
+        help="Server port",
+    )
+    parser.add_argument(
+        "-r",
+        "--resource",
+        type=str,
+        default="VNA",
+        help="Resource name of the VNA device",
+    )
+    parser.add_argument(
+        "-o",
+        "--option-string",
+        type=str,
+        default="",
+        help="Option string",
+    )
+    return parser.parse_args()
+
+
+def main():
+    """Main function."""
+    args = _parse_args()
+    example(args.server_address, args.port, args.resource, args.option_string)
+
+
+if __name__ == "__main__":
+    main()