Merge from main

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

Author: Michael Johansen

README.md

@@ -1,2 +1,20 @@
-# nipanel-python
-Source for the nipanel python package
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+
+# About
+
+`nipanel` is a Python package that provides support for creating and controlling measurement and visualization panels.
+
+NI created and supports this package.
+
+## Operating System Support
+
+`nipanel` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+`nipanel` supports CPython 3.9+.

examples/all_types/define_types.py

@@ -79,6 +79,8 @@ class MyMixedEnum(enum.Enum):
     "ht_datetime": ht.datetime.now(tz=dt.timezone.utc),
     "bt_datetime": bt.DateTime.now(tz=dt.timezone.utc),
     "dt_timedelta": dt.timedelta(weeks=2, days=5, minutes=12, milliseconds=75),
+    "ht_timedelta": ht.timedelta(days=5, seconds=25, picoseconds=88),
+    "bt_timedelta": bt.TimeDelta(seconds=1234.56),
     # supported enum and flag types
     "intflags": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,
     "intenum": MyIntEnum.VALUE20,

poetry.lock

@@ -1,9 +1,32 @@
 [project]
 name = "nipanel"
 version = "0.1.0-dev1"
-description = "NI Panel Python API"
+license = "MIT"
+description = "NI Panel client for Python"
 authors = [{name = "NI", email = "opensource@ni.com"}]
+maintainers = [
+  {name = "Mike Prosser", email = "mike.prosser@emerson.com"},
+  {name = "Johann Scholtz", email = "johann.scholtz@emerson.com"},
+]
 readme = "README.md"
+keywords = ["nipanel", "panels"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Manufacturing",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: Implementation :: CPython",
+]
+requires-python = ">=3.9"
 dynamic = ["dependencies"]
 
 [project.urls]
@@ -24,7 +47,7 @@ numpy = ">=1.22"
 debugpy = ">=1.8.1"
 ni-grpc-extensions = { version = ">=0.1.0.dev1", allow-prereleases = true }
 ni-measurementlink-discovery-v1-client = { version = ">=0.1.0dev0", allow-prereleases = true }
-ni-protobuf-types = { version = ">=0.1.0dev3", allow-prereleases = true }
+ni-protobuf-types = { version = ">=0.1.0dev4", allow-prereleases = true }
 ni-panels-v1-proto = { version = ">=0.1.0dev1", allow-prereleases = true }
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -22,8 +22,9 @@
     StrConverter,
 )
 from nipanel.converters.protobuf_types import (
-    BoolCollectionConverter,
     BTDateTimeConverter,
+    BTTimeDeltaConverter,
+    BoolCollectionConverter,
     BytesCollectionConverter,
     DigitalWaveformConverter,
     Double2DArrayConverter,
@@ -32,6 +33,7 @@
     DoubleSpectrumConverter,
     FloatCollectionConverter,
     HTDateTimeConverter,
+    HTTimeDeltaConverter,
     Int16AnalogWaveformConverter,
     Int16ComplexWaveformConverter,
     IntCollectionConverter,
@@ -54,6 +56,7 @@
     DTTimeDeltaConverter(),
     # Protobuf Types
     BTDateTimeConverter(),
+    BTTimeDeltaConverter(),
     BoolCollectionConverter(),
     BytesCollectionConverter(),
     DigitalWaveformConverter(),
@@ -63,6 +66,7 @@
     DoubleSpectrumConverter(),
     FloatCollectionConverter(),
     HTDateTimeConverter(),
+    HTTimeDeltaConverter(),
     Int16AnalogWaveformConverter(),
     Int16ComplexWaveformConverter(),
     IntCollectionConverter(),

src/nipanel/_convert.py

@@ -10,7 +10,7 @@
 import nitypes.bintime as bt
 from ni.measurementlink.discovery.v1.client import DiscoveryClient
 from ni_grpc_extensions.channelpool import GrpcChannelPool
-from nitypes.time import convert_datetime
+from nitypes.time import convert_datetime, convert_timedelta
 
 from nipanel._panel_client import _PanelClient
 
@@ -85,11 +85,17 @@ def get_value(self, value_id: str, default_value: _T | None = None) -> _T | obje
                 enum_type = type(default_value)
                 return enum_type(value)
 
-            # The grpc converter always converts PrecisionTimestamp into bt.DateTime, so
-            # we need to handle the case where they provide an ht.datetime default by
-            # converting to hightime.
-            if isinstance(default_value, ht.datetime) and isinstance(value, bt.DateTime):
-                return convert_datetime(ht.datetime, value)
+            # The grpc converter always converts PrecisionTimestamp into ht.datetime, so
+            # we need to handle the case where they provide a bt.DateTime default by
+            # converting to bintime.
+            if isinstance(default_value, bt.DateTime) and isinstance(value, ht.datetime):
+                return convert_datetime(bt.DateTime, value)
+
+            # The grpc converter always converts PrecisionDuration into ht.timedelta, so
+            # we need to handle the case where they provide a bt.TimeDelta default by
+            # converting to bintime.
+            if isinstance(default_value, bt.TimeDelta) and isinstance(value, ht.timedelta):
+                return convert_timedelta(bt.TimeDelta, value)
 
             # lists are allowed to not match, since sets and tuples are converted to lists
             if not isinstance(value, list):

src/nipanel/_panel_value_accessor.py

@@ -10,6 +10,8 @@
 import numpy as np
 from ni.protobuf.types import (
     array_pb2,
+    precision_duration_pb2,
+    precision_duration_conversion,
     precision_timestamp_pb2,
     precision_timestamp_conversion,
     scalar_conversion,
@@ -379,7 +381,13 @@ def to_python_value(
 
 
 class BTDateTimeConverter(Converter[bt.DateTime, precision_timestamp_pb2.PrecisionTimestamp]):
-    """A converter for bintime.DateTime types."""
+    """A converter for bintime.DateTime types.
+
+    .. note:: The nipanel package will always convert PrecisionTimestamp messages to
+        hightime.datetime objects using HTDateTimeConverter. To use bintime.DateTime
+        values in a panel, you must pass a bintime.DateTime value for the default_value
+        parameter of the get_value() method on the panel.
+    """
 
     @property
     def python_type(self) -> type:
@@ -391,6 +399,16 @@ def protobuf_message(self) -> Type[precision_timestamp_pb2.PrecisionTimestamp]:
         """The type-specific protobuf message for the Python type."""
         return precision_timestamp_pb2.PrecisionTimestamp
 
+    @property
+    def protobuf_typename(self) -> str:
+        """The protobuf name for the type."""
+        # Override the base class here because there can only be one converter that
+        # converts PrecisionTimestamp objects. Since there are two converters that convert
+        # to PrecisionTimestamp, we have to choose one to handle conversion from protobuf.
+        # For the purposes of nipanel, we'll convert PrecisionTimestamp messages to
+        # hightime.datetime. See HTDateTimeConverter.
+        return "PrecisionTimestamp_Placeholder"
+
     def to_protobuf_message(
         self, python_value: bt.DateTime
     ) -> precision_timestamp_pb2.PrecisionTimestamp:
@@ -404,34 +422,60 @@ def to_python_value(
         return precision_timestamp_conversion.bintime_datetime_from_protobuf(protobuf_message)
 
 
-class HTDateTimeConverter(Converter[ht.datetime, precision_timestamp_pb2.PrecisionTimestamp]):
-    """A converter for hightime.datetime objects.
+class BTTimeDeltaConverter(Converter[bt.TimeDelta, precision_duration_pb2.PrecisionDuration]):
+    """A converter for bintime.TimeDelta types.
 
-    .. note:: The nipanel package will always convert PrecisionTimestamp messages to
-        bintime.DateTime objects using BTDateTimeConverter. To use hightime.datetime
-        values in a panel, you must pass a hightime.datetime value for the default_value
+    .. note:: The nipanel package will always convert PrecisionDuration messages to
+        hightime.timedelta objects using HTTimeDeltaConverter. To use bintime.TimeDelta
+        values in a panel, you must pass a bintime.TimeDelta value for the default_value
         parameter of the get_value() method on the panel.
     """
 
     @property
     def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return ht.datetime
+        return bt.TimeDelta
 
     @property
-    def protobuf_message(self) -> Type[precision_timestamp_pb2.PrecisionTimestamp]:
+    def protobuf_message(self) -> Type[precision_duration_pb2.PrecisionDuration]:
         """The type-specific protobuf message for the Python type."""
-        return precision_timestamp_pb2.PrecisionTimestamp
+        return precision_duration_pb2.PrecisionDuration
 
     @property
     def protobuf_typename(self) -> str:
         """The protobuf name for the type."""
         # Override the base class here because there can only be one converter that
-        # converts PrecisionTimestamp objects. Since there are two converters that convert
-        # to PrecisionTimestamp, we have to choose one to handle conversion from protobuf.
-        # For the purposes of nipanel, we'll convert PrecisionTimestamp messages to
-        # bintime.DateTime. See BTDateTimeConverter.
-        return "PrecisionTimestamp_Placeholder"
+        # converts PrecisionDuration objects. Since there are two converters that convert
+        # to PrecisionDuration, we have to choose one to handle conversion from protobuf.
+        # For the purposes of nipanel, we'll convert PrecisionDuration messages to
+        # hightime.timedelta. See HTTimeDeltaConverter.
+        return "PrecisionDuration_Placeholder"
+
+    def to_protobuf_message(
+        self, python_value: bt.TimeDelta
+    ) -> precision_duration_pb2.PrecisionDuration:
+        """Convert the Python TimeDelta to a protobuf PrecisionDuration."""
+        return precision_duration_conversion.bintime_timedelta_to_protobuf(python_value)
+
+    def to_python_value(
+        self, protobuf_message: precision_duration_pb2.PrecisionDuration
+    ) -> bt.TimeDelta:
+        """Convert the protobuf PrecisionDuration to a Python TimeDelta."""
+        return precision_duration_conversion.bintime_timedelta_from_protobuf(protobuf_message)
+
+
+class HTDateTimeConverter(Converter[ht.datetime, precision_timestamp_pb2.PrecisionTimestamp]):
+    """A converter for hightime.datetime objects."""
+
+    @property
+    def python_type(self) -> type:
+        """The Python type that this converter handles."""
+        return ht.datetime
+
+    @property
+    def protobuf_message(self) -> Type[precision_timestamp_pb2.PrecisionTimestamp]:
+        """The type-specific protobuf message for the Python type."""
+        return precision_timestamp_pb2.PrecisionTimestamp
 
     def to_protobuf_message(
         self, python_value: ht.datetime
@@ -446,6 +490,32 @@ def to_python_value(
         return precision_timestamp_conversion.hightime_datetime_from_protobuf(protobuf_message)
 
 
+class HTTimeDeltaConverter(Converter[ht.timedelta, precision_duration_pb2.PrecisionDuration]):
+    """A converter for hightime.timedelta objects."""
+
+    @property
+    def python_type(self) -> type:
+        """The Python type that this converter handles."""
+        return ht.timedelta
+
+    @property
+    def protobuf_message(self) -> Type[precision_duration_pb2.PrecisionDuration]:
+        """The type-specific protobuf message for the Python type."""
+        return precision_duration_pb2.PrecisionDuration
+
+    def to_protobuf_message(
+        self, python_value: ht.timedelta
+    ) -> precision_duration_pb2.PrecisionDuration:
+        """Convert the Python timedelta to a protobuf PrecisionDuration."""
+        return precision_duration_conversion.hightime_timedelta_to_protobuf(python_value)
+
+    def to_python_value(
+        self, protobuf_message: precision_duration_pb2.PrecisionDuration
+    ) -> ht.timedelta:
+        """Convert the protobuf PrecisionDuration to a Python timedelta."""
+        return precision_duration_conversion.hightime_timedelta_from_protobuf(protobuf_message)
+
+
 class ScalarConverter(Converter[Scalar[_AnyScalarType], scalar_pb2.Scalar]):
     """A converter for Scalar objects."""