Add Analog Input Example (#85)

* Analog Input - Voltage and Thermocouple Single Task

* Analog input graph

* Analog input graph

* merge main

* Update nidaqmx_continuous_analog_input.py

* Analog Input - Voltage and Thermocouple

Signed-off-by: Dilmi Wickramanayake <[email protected]>

* Fixing formatting issues

Signed-off-by: Dilmi Wickramanayake <[email protected]>

* add daqmx and streamlit_echarts to mypy override

Signed-off-by: Valerie Gleason 👌 <[email protected]>

* add daqmx and streamlit_echarts to mypy override

Signed-off-by: Valerie Gleason 👌 <[email protected]>

---------

Signed-off-by: Dilmi Wickramanayake <[email protected]>
Signed-off-by: Valerie Gleason 👌 <[email protected]>
Co-authored-by: Dilmi Wickramanayake <[email protected]>
Co-authored-by: Valerie Gleason 👌 <[email protected]>

Author: 3 people

.github/workflows/check_nipanel.yml

@@ -24,7 +24,7 @@ jobs:
           path: .venv
           key: nipanel-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
       - name: Install nipanel
-        run: poetry install -v
+        run: poetry install -v --with examples,docs
       - name: Lint
         run: poetry run ni-python-styleguide lint
       - name: Mypy static analysis (Linux)

examples/nidaqmx/README.md

@@ -0,0 +1,20 @@
+Prerequisites 
+===============
+Requires a Physical or Simulated Device : https://github.com/ni/nidaqmx-python/blob/master/README.rst (Getting Started Section)
+
+## Sample
+
+This is a nipanel example that displays an interactive Streamlit app and updates continuous analog input examples.
+
+### Feature
+
+- Supports various data types
+
+### Required Software
+
+- Python 3.9 or later
+
+### Usage
+
+Run `poetry run examples/nidaqmx_continuous_analog_input/nidaqmx_continuous_analog_input.py`
+

examples/nidaqmx/nidaqmx_continuous_analog_input.py

@@ -0,0 +1,30 @@
+"""Data acquisition script that continuously acquires analog input data."""
+
+from pathlib import Path
+
+import nidaqmx
+from nidaqmx.constants import AcquisitionType
+
+import nipanel
+
+panel_script_path = Path(__file__).with_name("nidaqmx_continuous_analog_input_panel.py")
+panel = nipanel.create_panel(panel_script_path)
+
+with nidaqmx.Task() as task:
+    task.ai_channels.add_ai_voltage_chan("Dev1/ai0")
+    task.ai_channels.add_ai_thrmcpl_chan("Dev1/ai1")
+    task.timing.cfg_samp_clk_timing(
+        rate=1000.0, sample_mode=AcquisitionType.CONTINUOUS, samps_per_chan=3000
+    )
+    panel.set_value("sample_rate", task._timing.samp_clk_rate)
+    task.start()
+    try:
+        print(f"\nPress Ctrl + C to stop")
+        while True:
+            data = task.read(number_of_samples_per_channel=1000)
+            panel.set_value("voltage_data", data[0])
+            panel.set_value("thermocouple_data", data[1])
+    except KeyboardInterrupt:
+        pass
+    finally:
+        task.stop()

examples/nidaqmx/nidaqmx_continuous_analog_input_panel.py

@@ -0,0 +1,101 @@
+"""Streamlit visualization script to display data acquired by nidaqmx_continuous_analog_input.py."""
+
+import streamlit as st
+from streamlit_echarts import st_echarts
+
+import nipanel
+
+panel = nipanel.get_panel_accessor()
+
+st.title("Analog Input - Voltage and Thermocouple in a Single Task")
+voltage_tab, thermocouple_tab = st.tabs(["Voltage", "Thermocouple"])
+
+st.markdown(
+    """
+    <style>
+    div[data-baseweb="select"] {
+        width: 190px !important; /* Adjust the width as needed */
+    }
+    </style>
+    """,
+    unsafe_allow_html=True,
+)
+
+thermocouple_data = panel.get_value("thermocouple_data", [0.0])
+voltage_data = panel.get_value("voltage_data", [0.0])
+
+sample_rate = panel.get_value("sample_rate", 0)
+
+st.header("Voltage & Thermocouple")
+voltage_therm_graph = {
+    "tooltip": {"trigger": "axis"},
+    "legend": {"data": ["Voltage (V)", "Temperature (C)"]},
+    "xAxis": {
+        "type": "category",
+        "data": [x / sample_rate for x in range(len(voltage_data))],
+        "name": "Time",
+        "nameLocation": "center",
+        "nameGap": 40,
+    },
+    "yAxis": {
+        "type": "value",
+        "name": "Measurement",
+        "nameRotate": 90,
+        "nameLocation": "center",
+        "nameGap": 40,
+    },
+    "series": [
+        {
+            "name": "voltage_amplitude",
+            "type": "line",
+            "data": voltage_data,
+            "emphasis": {"focus": "series"},
+            "smooth": True,
+            "seriesLayoutBy": "row",
+        },
+        {
+            "name": "thermocouple_amplitude",
+            "type": "line",
+            "data": thermocouple_data,
+            "color": "red",
+            "emphasis": {"focus": "series"},
+            "smooth": True,
+            "seriesLayoutBy": "row",
+        },
+    ],
+}
+st_echarts(options=voltage_therm_graph, height="400px")
+
+voltage_tab.header("Voltage")
+with voltage_tab:
+    left_volt_tab, center_volt_tab, right_volt_tab = st.columns(3)
+    with left_volt_tab:
+        st.selectbox(options=["Dev1/ai0"], label="Physical Channels", disabled=True)
+        st.selectbox(options=["Off"], label="Logging Modes", disabled=False)
+    with center_volt_tab:
+        st.selectbox(options=["-5"], label="Min Value")
+        st.selectbox(options=["5"], label="Max Value")
+        st.selectbox(options=["1000"], label="Samples per Loops", disabled=False)
+    with right_volt_tab:
+        st.selectbox(options=["default"], label="Terminal Configurations")
+        st.selectbox(options=["OnboardClock"], label="Sample Clock Sources", disabled=False)
+
+
+thermocouple_tab.header("Thermocouple")
+with thermocouple_tab:
+    left, middle, right = st.columns(3)
+    with left:
+        st.selectbox(options=["Dev1/ai1"], label="Physical Channel", disabled=True)
+        st.selectbox(options=["0"], label="Min", disabled=False)
+        st.selectbox(options=["100"], label="Max", disabled=False)
+        st.selectbox(options=["Off"], label="Logging Mode", disabled=False)
+
+    with middle:
+        st.selectbox(options=["Deg C"], label="Units", disabled=False)
+        st.selectbox(options=["J"], label="Thermocouple Type", disabled=False)
+        st.selectbox(options=["Constant Value"], label="CJC Source", disabled=False)
+        st.selectbox(options=["1000"], label="Samples per Loop", disabled=False)
+    with right:
+        st.selectbox(options=["25"], label="CJC Value", disabled=False)
+        st.selectbox(options=["OnboardClock"], label="Sample Clock Source", disabled=False)
+        st.selectbox(options=[" "], label="Actual Sample Rate", disabled=True)

examples/simple_graph/simple_graph_panel.py

@@ -1,11 +1,10 @@
 """A Streamlit visualization panel for the simple_graph.py example script."""
 
 import streamlit as st
-from streamlit_echarts import st_echarts  # type: ignore
+from streamlit_echarts import st_echarts
 
 import nipanel
 
-
 panel = nipanel.get_panel_accessor()
 
 st.set_page_config(page_title="Simple Graph Example", page_icon="📈", layout="wide")

poetry.lock

@@ -13,6 +13,7 @@ protobuf = {version=">=4.21"}
 ni-measurement-plugin-sdk = {version=">=2.3"}
 typing-extensions = ">=4.13.2"
 streamlit = ">=1.24"
+streamlit-echarts = ">=0.4.0"
 nitypes = {version=">=0.1.0dev2", allow-prereleases=true}
 debugpy = ">=1.8.1"
 
@@ -57,6 +58,7 @@ optional = true
 
 [tool.poetry.group.examples.dependencies]
 streamlit-echarts = ">=0.4.0"
+nidaqmx = ">=0.8.0"
 
 [build-system]
 requires = ["poetry-core>=1.8.0"]
@@ -76,9 +78,11 @@ strict = true
 
 [[tool.mypy.overrides]]
 module = [
-  # https://github.com/ni/hightime/issues/4 - Add type annotations
   "hightime.*",
   "grpc.framework.foundation.*",
+  "streamlit_echarts.*",
+  # https://github.com/ni/nidaqmx-python/issues/209 - Support type annotations
+  "nidaqmx.*",
 ]
 ignore_missing_imports = true
 
@@ -93,4 +97,4 @@ testpaths = ["src/nipanel", "tests"]
 
 [tool.pyright]
 include = ["examples/", "src/", "tests/"]
-exclude = ["src/ni/protobuf/types/", "src/ni/pythonpanel/v1/"]
+exclude = ["src/ni/protobuf/types/", "src/ni/pythonpanel/v1/","examples/nidaqmx/nidaqmx_continuous_analog_input.py"]