Merge branch 'main' of https://github.com/ni/nipanel-python

Author: Dilmi Wickramanayake

examples/all_types/README.md

@@ -1,15 +1,18 @@
 ## All Types Example
 
-This is an example for `nipanel` that demonstrates all supported data types
+This is an example for `nipanel` that demonstrates all supported data types.
 
 ### Feature
 
-- Demonstrates support for all data types
+- Demonstrates all supported data types
 
 ### Required Software
 
 - Python 3.9 or later
 
 ### Usage
 
-Run `poetry run python examples/all_types/all_types.py`
+```pwsh
+poetry install --with examples
+poetry run python examples/all_types/all_types.py
+```

examples/hello/README.md

@@ -1,6 +1,6 @@
 ## Hello
 
-This is a simple nipanel example that displays a Streamlit app.
+This is a simple `nipanel` example that displays a Streamlit app.
 
 ### Feature
 
@@ -12,4 +12,7 @@ This is a simple nipanel example that displays a Streamlit app.
 
 ### Usage
 
-Run `poetry run python examples/hello/hello.py`
+```pwsh
+poetry install --with examples
+poetry run python examples/hello/hello.py
+```

examples/nidaqmx/README.md

@@ -1,4 +1,4 @@
-Prerequisites 
+Prerequisites
 ===============
 Requires a Physical or Simulated Device : https://github.com/ni/nidaqmx-python/blob/master/README.rst (Getting Started Section)
 
@@ -16,5 +16,7 @@ This is a nipanel example that displays an interactive Streamlit app and updates
 
 ### Usage
 
-Run `poetry run examples/nidaqmx/nidaqmx_continuous_analog_input.py`
-
+```pwsh
+poetry install --with examples
+poetry run examples/nidaqmx/nidaqmx_continuous_analog_input.py
+```

examples/niscope/README.md

@@ -1,13 +1,14 @@
-Prerequisites 
+Prerequisites
 ===============
 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. This example uses NI oscilloscopes/digitizers, which have the module numbering pattern _51xx_. One example is NI PXIe-5114.
+
 ## Sample
 
 This is a nipanel example that displays an interactive Streamlit app and updates and fetches data from device.
 
 ### Feature
 
-Script demonstrates NIScope waveform data getting continuously acquired. 
+Script demonstrates NIScope waveform data getting continuously acquired.
 - Supports various data types
 
 ### Required Software
@@ -16,5 +17,7 @@ Script demonstrates NIScope waveform data getting continuously acquired.
 
 ### Usage
 
-Run `poetry run examples/niscope/niscope_ex_fetch_forever.py`
-
+```pwsh
+poetry install --with examples
+poetry run examples/niscope/niscope_ex_fetch_forever.py
+```

examples/performance_checker/README.md

@@ -1,6 +1,6 @@
 # Performance checker Example
 
-This example measures the performance of a stremlit panel with a graph.
+This example measures the performance of a streamlit panel with a graph.
 
 ## Features
 
@@ -15,4 +15,7 @@ This example measures the performance of a stremlit panel with a graph.
 
 ### Usage
 
-Run `poetry run python examples/performance_checker/performance_checker.py`
+```pwsh
+poetry install --with examples
+poetry run python examples/performance_checker/performance_checker.py
+```

examples/simple_graph/README.md

@@ -1,6 +1,6 @@
 # Simple Graph Example
 
-This example demonstrates using nipanel with Streamlit to display a dynamic sine wave using the `streamlit-echarts` library.
+This example demonstrates using `nipanel` with Streamlit to display a dynamic sine wave using the `streamlit-echarts` library.
 
 ## Features
 
@@ -15,4 +15,7 @@ This example demonstrates using nipanel with Streamlit to display a dynamic sine
 
 ### Usage
 
-Run `poetry run python examples/simple_graph/simple_graph.py`
+```pwsh
+poetry install --with examples
+poetry run python examples/simple_graph/simple_graph.py
+```

poetry.lock

@@ -18,13 +18,18 @@ option ruby_package = "NI::PythonPanel::V1";
 service PythonPanelService {
   // Start a panel (or connect to if it has already been started)
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-  // - NOT_FOUND: the file for the panel was not found
+  // - INVALID_ARGUMENT: 
+  //   - The panel script filename doesn't end in .py.
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - NOT_FOUND: 
+  //   - The panel script file was not found.
+  //   - The python executable file was not found.
   rpc StartPanel(StartPanelRequest) returns (StartPanelResponse);
 
   // Stop a panel
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - INVALID_ARGUMENT:
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
   rpc StopPanel(StopPanelRequest) returns (StopPanelResponse);
 
   // Enumerate the panels available in the system, including information about the state of the panels and what values they have.
@@ -33,12 +38,25 @@ service PythonPanelService {
 
   // Get a value for a control on the panel
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - INVALID_ARGUMENT: 
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  //   - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - NOT_FOUND: 
+  //   - The value with the specified identifier was not found.
   rpc GetValue(GetValueRequest) returns (GetValueResponse);
 
+  // Try to get a value for a control on the panel
+  // Status Codes for errors:
+  // - INVALID_ARGUMENT: 
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  //   - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  rpc TryGetValue(TryGetValueRequest) returns (TryGetValueResponse);
+
   // Set a value for a control on the panel
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - INVALID_ARGUMENT: 
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  //   - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
   rpc SetValue(SetValueRequest) returns (SetValueResponse);
 }
 
@@ -98,6 +116,19 @@ message GetValueRequest {
 
 message GetValueResponse {
   // The value
+  google.protobuf.Any value = 1;
+}
+
+message TryGetValueRequest {
+  // Unique ID of the panel
+  string panel_id = 1;
+
+  // Unique ID of value
+  string value_id = 2;
+}
+
+message TryGetValueResponse {
+  // The value, if  it was found
   optional google.protobuf.Any value = 1;
 }
 

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -65,6 +65,7 @@ optional = true
 [tool.poetry.group.examples.dependencies]
 streamlit-echarts = ">=0.4.0"
 nidaqmx = { version = ">=0.8.0", allow-prereleases = true }
+niscope = "^1.4.9"
 
 [build-system]
 requires = ["poetry-core>=1.8.0"]