From 756f282396358c1e97a3a909cad4e567e7864d9a Mon Sep 17 00:00:00 2001 From: vnktshr21 Date: Thu, 11 Sep 2025 13:42:59 +0530 Subject: [PATCH 1/3] example changes --- src/nirfsg/examples/nirfsg_arb_waveform.py | 10 +++++----- src/nirfsg/examples/nirfsg_cw.py | 10 +++++----- src/nirfsg/examples/nirfsg_script.py | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/nirfsg/examples/nirfsg_arb_waveform.py b/src/nirfsg/examples/nirfsg_arb_waveform.py index 7bbc6fd26..fffc9e326 100644 --- a/src/nirfsg/examples/nirfsg_arb_waveform.py +++ b/src/nirfsg/examples/nirfsg_arb_waveform.py @@ -19,11 +19,11 @@ def example(resource_name, options, frequency, power_level, number_of_samples): def _main(argsv): parser = argparse.ArgumentParser(description='Continuously generates an arbitrary waveform using NI-RFSG.', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-n', '--resource-name', default='5841', help='Resource name of the NI RF signal generator.') + parser.add_argument('-n', '--resource-name', default='', required=True, help='Resource name of the NI RF signal generator.') parser.add_argument('-f', '--frequency', default=1e9, type=float, help='Frequency in Hz.') parser.add_argument('-p', '--power-level', default=-10.0, type=float, help='Power level in dBm.') parser.add_argument('-s', '--number-of-samples', default=1000, type=int, help='Number of samples.') - parser.add_argument('-op', '--option-string', default='Simulate=1, DriverSetup=Model:5841', type=str, help='Option string for the session.') + parser.add_argument('-op', '--option-string', default='', type=str, help='Option string for the session.') args = parser.parse_args(argsv) example(args.resource_name, args.option_string, args.frequency, args.power_level, args.number_of_samples) @@ -33,12 +33,12 @@ def main(): def test_example(): - options = "Simulate=1, DriverSetup=Model:5841" - example('5841', options, 1e9, -10.0, 1000) + options = {'simulate': True, 'driver_setup': {'Model': '5841', }, } + example('simulated5841', options, 1e9, -10.0, 1000) def test_main(): - cmd_line = ['--resource-name', '5841', '--frequency', '1e9', '--power-level', '-10', '--number-of-samples', '1000', '--option-string', 'Simulate=1, DriverSetup=Model:5841'] + cmd_line = ['--resource-name', 'simulated5841', '--frequency', '1e9', '--power-level', '-10', '--number-of-samples', '1000', '--option-string', 'Simulate=1, DriverSetup=Model:5841'] _main(cmd_line) diff --git a/src/nirfsg/examples/nirfsg_cw.py b/src/nirfsg/examples/nirfsg_cw.py index 4f2701f49..b577a8537 100644 --- a/src/nirfsg/examples/nirfsg_cw.py +++ b/src/nirfsg/examples/nirfsg_cw.py @@ -19,10 +19,10 @@ def example(resource_name, options, frequency, power_level): def _main(argsv): parser = argparse.ArgumentParser(description='Generates a continuous wave (CW) signal using NI-RFSG.', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-n', '--resource-name', default='5841', help='Resource name of the NI RF signal generator.') + parser.add_argument('-n', '--resource-name', default='', required=True, help='Resource name of the NI RF signal generator.') parser.add_argument('-f', '--frequency', default=1e9, type=float, help='Frequency in Hz.') parser.add_argument('-p', '--power-level', default=-10.0, type=float, help='Power level in dBm.') - parser.add_argument('-op', '--option-string', default='Simulate=1, DriverSetup=Model:5841', type=str, help='Option string for the session.') + parser.add_argument('-op', '--option-string', default='', type=str, help='Option string for the session.') args = parser.parse_args(argsv) example(args.resource_name, args.option_string, args.frequency, args.power_level) @@ -32,12 +32,12 @@ def main(): def test_example(): - options = "Simulate=1, DriverSetup=Model:5841" - example('5841', options, 1e9, -10.0) + options = {'simulate': True, 'driver_setup': {'Model': '5841', }, } + example('simulated5841', options, 1e9, -10.0) def test_main(): - cmd_line = ['--resource-name', '5841', '--frequency', '1e9', '--power-level', '-10', '--option-string', 'Simulate=1, DriverSetup=Model:5841'] + cmd_line = ['--resource-name', 'simulated5841', '--frequency', '1e9', '--power-level', '-10', '--option-string', 'Simulate=1, DriverSetup=Model:5841'] _main(cmd_line) diff --git a/src/nirfsg/examples/nirfsg_script.py b/src/nirfsg/examples/nirfsg_script.py index 627ca1845..23471e483 100644 --- a/src/nirfsg/examples/nirfsg_script.py +++ b/src/nirfsg/examples/nirfsg_script.py @@ -28,11 +28,11 @@ def example(resource_name, options, frequency, power_level, number_of_samples): def _main(argsv): parser = argparse.ArgumentParser(description='Generates a signal based on the script provided.', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-n', '--resource-name', default='5841', help='Resource name of the NI RF signal generator.') + parser.add_argument('-n', '--resource-name', default='', required=True, help='Resource name of the NI RF signal generator.') parser.add_argument('-f', '--frequency', default=1e9, type=float, help='Frequency in Hz.') parser.add_argument('-p', '--power-level', default=-10.0, type=float, help='Power level in dBm.') parser.add_argument('-s', '--number-of-samples', default=1000, type=int, help='Number of samples.') - parser.add_argument('-op', '--option-string', default='Simulate=1, DriverSetup=Model:5841', type=str, help='Option string for the session.') + parser.add_argument('-op', '--option-string', default='', type=str, help='Option string for the session.') args = parser.parse_args(argsv) example(args.resource_name, args.option_string, args.frequency, args.power_level, args.number_of_samples) @@ -42,12 +42,12 @@ def main(): def test_example(): - options = "Simulate=1, DriverSetup=Model:5841" - example('5841', options, 1e9, -10.0, 1000) + options = {'simulate': True, 'driver_setup': {'Model': '5841', }, } + example('simulated5841', options, 1e9, -10.0, 1000) def test_main(): - cmd_line = ['--resource-name', '5841', '--frequency', '1e9', '--power-level', '-10', '--number-of-samples', '1000', '--option-string', 'Simulate=1, DriverSetup=Model:5841'] + cmd_line = ['--resource-name', 'simulated5841', '--frequency', '1e9', '--power-level', '-10', '--number-of-samples', '1000', '--option-string', 'Simulate=1, DriverSetup=Model:5841'] _main(cmd_line) From 7db9c466f1e07e53e87ee77787e291a69134bbe0 Mon Sep 17 00:00:00 2001 From: vnktshr21 Date: Thu, 11 Sep 2025 13:47:53 +0530 Subject: [PATCH 2/3] changelog update --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5579fee23..d8ad62b7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1691,6 +1691,7 @@ #### [nirfsg] Unreleased - Added - Changed + - Fix default value for option string in examples to be empty and make resource name as required input - Removed #### [nirfsg] 1.0.0 - 2025-08-05 From 844ac08cdbbb25cfc34f53a2b506b7b95abf9b5d Mon Sep 17 00:00:00 2001 From: vnktshr21 Date: Mon, 6 Oct 2025 11:01:34 +0530 Subject: [PATCH 3/3] made rsrc name not required and removed changelog mention --- CHANGELOG.md | 1 - src/nirfsg/examples/nirfsg_arb_waveform.py | 2 +- src/nirfsg/examples/nirfsg_cw.py | 2 +- src/nirfsg/examples/nirfsg_script.py | 2 +- 4 files changed, 3 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ac50ad6d..fc6172790 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1691,7 +1691,6 @@ #### [nirfsg] Unreleased - Added - Changed - - Fix default value for option string in examples to be empty and make resource name as required input - Fixed the return type of `get_all_script_names` and `get_all_named_waveform_names` to remove the size parameter and return a list of strings instead of a comma-separated string - Removed diff --git a/src/nirfsg/examples/nirfsg_arb_waveform.py b/src/nirfsg/examples/nirfsg_arb_waveform.py index fffc9e326..0dcc42276 100644 --- a/src/nirfsg/examples/nirfsg_arb_waveform.py +++ b/src/nirfsg/examples/nirfsg_arb_waveform.py @@ -19,7 +19,7 @@ def example(resource_name, options, frequency, power_level, number_of_samples): def _main(argsv): parser = argparse.ArgumentParser(description='Continuously generates an arbitrary waveform using NI-RFSG.', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-n', '--resource-name', default='', required=True, help='Resource name of the NI RF signal generator.') + parser.add_argument('-n', '--resource-name', default='PXI1Slot2', help='Resource name of the NI RF signal generator.') parser.add_argument('-f', '--frequency', default=1e9, type=float, help='Frequency in Hz.') parser.add_argument('-p', '--power-level', default=-10.0, type=float, help='Power level in dBm.') parser.add_argument('-s', '--number-of-samples', default=1000, type=int, help='Number of samples.') diff --git a/src/nirfsg/examples/nirfsg_cw.py b/src/nirfsg/examples/nirfsg_cw.py index b577a8537..617f8c948 100644 --- a/src/nirfsg/examples/nirfsg_cw.py +++ b/src/nirfsg/examples/nirfsg_cw.py @@ -19,7 +19,7 @@ def example(resource_name, options, frequency, power_level): def _main(argsv): parser = argparse.ArgumentParser(description='Generates a continuous wave (CW) signal using NI-RFSG.', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-n', '--resource-name', default='', required=True, help='Resource name of the NI RF signal generator.') + parser.add_argument('-n', '--resource-name', default='PXI1Slot2', help='Resource name of the NI RF signal generator.') parser.add_argument('-f', '--frequency', default=1e9, type=float, help='Frequency in Hz.') parser.add_argument('-p', '--power-level', default=-10.0, type=float, help='Power level in dBm.') parser.add_argument('-op', '--option-string', default='', type=str, help='Option string for the session.') diff --git a/src/nirfsg/examples/nirfsg_script.py b/src/nirfsg/examples/nirfsg_script.py index 23471e483..858c418f0 100644 --- a/src/nirfsg/examples/nirfsg_script.py +++ b/src/nirfsg/examples/nirfsg_script.py @@ -28,7 +28,7 @@ def example(resource_name, options, frequency, power_level, number_of_samples): def _main(argsv): parser = argparse.ArgumentParser(description='Generates a signal based on the script provided.', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-n', '--resource-name', default='', required=True, help='Resource name of the NI RF signal generator.') + parser.add_argument('-n', '--resource-name', default='PXI1Slot2', help='Resource name of the NI RF signal generator.') parser.add_argument('-f', '--frequency', default=1e9, type=float, help='Frequency in Hz.') parser.add_argument('-p', '--power-level', default=-10.0, type=float, help='Power level in dBm.') parser.add_argument('-s', '--number-of-samples', default=1000, type=int, help='Number of samples.')