Skip to content

RFSG examples default value fix and clean up #2130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

RFSG examples default value fix and clean up #2130

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
756f282
example changes
Sep 11, 2025
7db9c46
changelog update
Sep 11, 2025
3f53d5c
Merge branch 'master' into fix-rfsg-examples-default-value
vnktshr21 Sep 29, 2025
844ac08
made rsrc name not required and removed changelog mention
Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions src/nirfsg/examples/nirfsg_arb_waveform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)


Expand Down
10 changes: 5 additions & 5 deletions src/nirfsg/examples/nirfsg_cw.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)


Expand Down
10 changes: 5 additions & 5 deletions src/nirfsg/examples/nirfsg_script.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)


Expand Down