Skip to content

Commit 72bda88

Browse files
zhindesZach Hindes
andauthored
cleanup daqmx example documentation (#211)
* cleanup daqmx readmes * more aggressive cleanup * copy pasta * prereqs * mas cleanup * cleanup --------- Co-authored-by: Zach Hindes <zach.hindes@emerson.com>
1 parent 81b1bee commit 72bda88

6 files changed

Lines changed: 52 additions & 29 deletions

File tree

examples/nidaqmx/nidaqmx_analog_input_filtering/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
Prerequisites
2-
===============
3-
Requires a Physical or Simulated Device. Refer to the [Getting Started Section](https://github.com/ni/nidaqmx-python/blob/master/README.rst) to learn how to create a simulated device.
4-
## Sample
1+
# NI-DAQmx Analog Input Filtering Example
52

6-
This is an nipanel example that displays an interactive Streamlit app and updates and fetches data from device.
3+
### Overview
74

8-
### Feature
5+
This is a nipanel example that acquires a continuous amount of data with filters enabled using the DAQ device's internal clock and displays it in an interactive Streamlit panel.
96

10-
Script demonstrates analog input data getting continuously acquired, and being filtered.
11-
- Supports various data types
7+
### Features
128

13-
### Required Software
9+
- NI-DAQmx Python configuration and acquisition
10+
- Displays data in an interactive chart using ECharts
11+
- Updates automatically as new data is acquired
12+
13+
### Prerequisites
1414

1515
- Python 3.10 or later
16+
- InstrumentStudio 2026 Q1 or later
17+
- A physical or simulated device, refer to the [NI-DAQmx Python README (Getting Started section)](https://github.com/ni/nidaqmx-python/blob/master/README.rst#getting-started)
1618

1719
### Usage
1820

1921
```pwsh
2022
poetry install --with examples
2123
poetry run python examples\nidaqmx\nidaqmx_analog_input_filtering\nidaqmx_analog_input_filtering.py
2224
```
23-

examples/nidaqmx/nidaqmx_analog_input_filtering/nidaqmx_analog_input_filtering.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
"""Data acquisition script that continuously acquires analog input data."""
1+
"""Example of analog input voltage, current, or strain gage acquisition.
2+
3+
This example demonstrates how to acquire a continuous amount of data using the
4+
DAQ device's internal clock. There is sensor-specific configuration and
5+
hardware filtering can be enabled. The settings are configured from the
6+
Streamlit panel, and the acquired data is displayed on a graph. Refer to the
7+
panel script for details: nidaqmx_analog_input_filtering_panel.py
8+
"""
29

310
import time
411
from pathlib import Path

examples/nidaqmx/nidaqmx_analog_output_voltage/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
Prerequisites
2-
===============
3-
Requires a Physical or Simulated Device : https://github.com/ni/nidaqmx-python/blob/master/README.rst (Getting Started Section)
1+
# NI-DAQmx Analog Output Voltage Example
42

5-
## Sample
3+
### Overview
64

7-
This is a nipanel example that displays an interactive Streamlit app and updates continuous analog output examples.
5+
This is a nipanel example that outputs a continuous periodic waveform using an internal sample clock and displays it in an interactive Streamlit panel.
86

9-
### Feature
7+
### Features
108

11-
- Supports various data types
9+
- NI-DAQmx Python configuration and generation
10+
- Displays data in interactive charts using ECharts
1211

13-
### Required Software
12+
### Prerequisites
1413

1514
- Python 3.10 or later
15+
- InstrumentStudio 2026 Q1 or later
16+
- A physical or simulated device, refer to the [NI-DAQmx Python README (Getting Started section)](https://github.com/ni/nidaqmx-python/blob/master/README.rst#getting-started)
1617

1718
### Usage
1819

examples/nidaqmx/nidaqmx_analog_output_voltage/nidaqmx_analog_output_voltage.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
"""Data acquisition script that continuously generates analog output data."""
1+
"""Example of analog output voltage generation.
2+
3+
This example demonstrates how to output a continuous periodic waveform using an
4+
internal sample clock. The settings are configured from the Streamlit panel,
5+
and the acquired data is displayed on a graph. Refer to the panel script for
6+
details: nidaqmx_analog_output_voltage_panel.py
7+
"""
28

39
import time
410
from pathlib import Path

examples/nidaqmx/nidaqmx_continuous_analog_input/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
Prerequisites
2-
===============
3-
Requires a Physical or Simulated Device : https://github.com/ni/nidaqmx-python/blob/master/README.rst (Getting Started Section)
1+
# NI-DAQmx Continuous Analog Input Example
42

5-
## Sample
3+
### Overview
64

7-
This is a nipanel example that displays an interactive Streamlit app and updates continuous analog input examples.
5+
This is a nipanel example that acquires a continuous amount of data using the DAQ device's internal clock and displays it in an interactive Streamlit panel.
86

9-
### Feature
7+
### Features
108

11-
- Supports various data types
9+
- NI-DAQmx Python configuration and acquisition
10+
- Displays data in an interactive chart using ECharts
11+
- Updates automatically as new data is acquired
1212

13-
### Required Software
13+
### Prerequisites
1414

1515
- Python 3.10 or later
16+
- InstrumentStudio 2026 Q1 or later
17+
- A physical or simulated device, refer to the [NI-DAQmx Python README (Getting Started section)](https://github.com/ni/nidaqmx-python/blob/master/README.rst#getting-started)
1618

1719
### Usage
1820

examples/nidaqmx/nidaqmx_continuous_analog_input/nidaqmx_continuous_analog_input.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
"""Data acquisition script that continuously acquires analog input data."""
1+
"""Example of analog input voltage acquisition.
2+
3+
This example demonstrates how to acquire a continuous amount of data using the
4+
DAQ device's internal clock. The settings are configured from the Streamlit
5+
panel, and the acquired data is displayed on a graph. Refer to the panel script
6+
for details: nidaqmx_continuous_analog_input_panel.py
7+
"""
28

39
import time
410
from pathlib import Path

0 commit comments

Comments
 (0)