Add a new sample type for holding 3-phase logical meter outputs

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/timeseries/__init__.py

@@ -8,8 +8,6 @@
 [`Sample`][frequenz.sdk.timeseries.Sample]s.
 """
 
-from ._base_types import Sample
+from ._base_types import Sample, Sample3Phase
 
-__all__ = [
-    "Sample",
-]
+__all__ = ["Sample", "Sample3Phase"]

src/frequenz/sdk/timeseries/_base_types.py

@@ -26,3 +26,25 @@ class Sample:
 
     value: Optional[float] = field(compare=False, default=None)
     """The value of this sample."""
+
+
+@dataclass(frozen=True)
+class Sample3Phase:
+    """A 3-phase measurement made at a particular point in time.
+
+    Each of the `value` fields could be `None` if a component is malfunctioning
+    or data is lacking for another reason, but a sample still needs to be sent
+    to have a coherent view on a group of component metrics for a particular
+    timestamp.
+    """
+
+    timestamp: datetime
+    """The time when this sample was generated."""
+    value_p1: Optional[float]
+    """The value of the 1st phase in this sample."""
+
+    value_p2: Optional[float]
+    """The value of the 2nd phase in this sample."""
+
+    value_p3: Optional[float]
+    """The value of the 3rd phase in this sample."""