Skip to content

Commit bc2af92

Browse files
generated README.rst with updated vesion
1 parent 7de65af commit bc2af92

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

generated/nirfsg/README.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ NI-RFSG Python API Status
5353
+-------------------------------+-----------------------+
5454
| NI-RFSG (nirfsg) | |
5555
+===============================+=======================+
56-
| Driver Version Tested Against | 2023 Q1.1 |
56+
| Driver Version Tested Against | 2025 Q1 |
5757
+-------------------------------+-----------------------+
5858
| PyPI Version | |nirfsgLatestVersion| |
5959
+-------------------------------+-----------------------+
@@ -102,7 +102,7 @@ As a prerequisite to using the **nirfsg** module, you must install the NI-RFSG r
102102

103103
The nimi-python modules (i.e. for **NI-RFSG**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
104104

105-
$ python -m pip install nirfsg
105+
$ python -m pip install nirfsg~=0.2.0
106106

107107

108108
Contributing
@@ -113,17 +113,26 @@ We welcome contributions! You can clone the project repository, build it, and in
113113
Usage
114114
------
115115

116-
The following is a basic example of using the **nirfsg** module to open a session to a Function Generator and generate a sine wave for 5 seconds.
116+
The following is a basic example of using the **nirfsg** module to open a session to an RF Signal Generator and generate a continuous wave (CW) signal.
117117

118118
.. code-block:: python
119119
120120
import nirfsg
121-
with nirfsg.Session('SwitchExecutiveExample') as session:
122-
session.connect('DIOToUUT')
123121
124-
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nirfsg/examples>`_
122+
# Configure the session
123+
with nirfsg.Session(resource_name='5841', id_query=False, reset_device=False, options='Simulate=1, DriverSetup=Model:5841') as session:
124+
# Configure RF settings
125+
session.configure_rf(
126+
frequency=1e9, # Frequency in Hz
127+
power_level=-10.0 # Power level in dBm
128+
)
129+
session.generation_mode = nirfsg.GenerationMode.CW
125130
126-
.. _support-section:
131+
# Start signal generation
132+
with session.initiate():
133+
input("Press Enter to stop generation")
134+
135+
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nirfsg/examples>`_.. _support-section:
127136

128137
Support / Feedback
129138
==================

0 commit comments

Comments
 (0)