Added voltage ranges to the SinkConfig object

Also, the related HV_Preferred flag.  Test cases too.

pdbuddy/__init__.py

@@ -217,13 +217,13 @@ class Sink:
             cls.pid))
 
 
-class SinkConfig(namedtuple("SinkConfig", "status flags v i")):
+class SinkConfig(namedtuple("SinkConfig", "status flags v vmin vmax i")):
     """Python representation of a PD Buddy Sink configuration object
 
     ``status`` should be a `SinkStatus` object.  ``flags`` should be zero or
-    more `SinkFlags` values.  ``v`` is the voltage in millivolts, and ``i``
-    is the current in milliamperes.  `None` is also an acceptible value for
-    any of the fields.
+    more `SinkFlags` values.  ``v``, ``vmin``, and ``vmax`` are voltages in
+    millivolts, and ``i`` is the current in milliamperes.  `None` is also an
+    acceptible value for any of the fields.
     """
     __slots__ = ()
 
@@ -248,10 +248,18 @@ class SinkConfig(namedtuple("SinkConfig", "status flags v i")):
             else:
                 if self.flags & SinkFlags.GIVEBACK:
                     s += "GiveBack"
+                if self.flags & SinkFlags.HV_PREFERRED:
+                    s += "HV_Preferred"
             s += "\n"
 
         if self.v is not None:
-            s += "v: {:.2f} V\n".format(self.v / 1000.0)
+            s += "v: {:.3f} V\n".format(self.v / 1000.0)
+
+        if self.vmin is not None:
+            s += "vmin: {:.3f} V\n".format(self.vmin / 1000.0)
+
+        if self.vmax is not None:
+            s += "vmax: {:.3f} V\n".format(self.vmax / 1000.0)
 
         if self.i is not None:
             s += "i: {:.2f} A\n".format(self.i / 1000.0)
@@ -276,6 +284,8 @@ class SinkConfig(namedtuple("SinkConfig", "status flags v i")):
         status = None
         flags = None
         v = None
+        vmin = None
+        vmax = None
         i = None
 
         # Iterate over all lines of text
@@ -285,7 +295,7 @@ class SinkConfig(namedtuple("SinkConfig", "status flags v i")):
                 raise IndexError("configuration index out of range")
             # If there is no configuration, return an empty SinkConfig
             elif line.startswith(b"No configuration"):
-                return cls(None, None, None, None)
+                return cls(None, None, None, None, None, None)
             # If this line is the status field
             elif line.startswith(b"status: "):
                 line = line.split()[1:]
@@ -305,17 +315,27 @@ class SinkConfig(namedtuple("SinkConfig", "status flags v i")):
                         break
                     elif word == b"GiveBack":
                         flags |= SinkFlags.GIVEBACK
+                    elif word == b"HV_Preferred":
+                        flags |= SinkFlags.HV_PREFERRED
             # If this line is the v field
             elif line.startswith(b"v: "):
                 word = line.split()[1]
                 v = round(1000*float(word))
+            # If this line is the vmin field
+            elif line.startswith(b"vmin: "):
+                word = line.split()[1]
+                vmin = round(1000*float(word))
+            # If this line is the vmax field
+            elif line.startswith(b"vmax: "):
+                word = line.split()[1]
+                vmax = round(1000*float(word))
             # If this line is the i field
             elif line.startswith(b"i: "):
                 word = line.split()[1]
                 i = round(1000*float(word))
 
         # Create a new SinkConfig object with the values we just read
-        return cls(status=status, flags=flags, v=v, i=i)
+        return cls(status=status, flags=flags, v=v, vmin=vmin, vmax=vmax, i=i)
 
 
 class SinkStatus(enum.Enum):
@@ -329,6 +349,7 @@ class SinkFlags(enum.Flag):
     """Flags field of a PD Buddy Sink configuration object"""
     NONE = 0
     GIVEBACK = enum.auto()
+    HV_PREFERRED = enum.auto()
 
 
 class UnknownPDO(namedtuple("UnknownPDO", "value")):

test_pdbuddy/__init__.py

@@ -17,23 +17,31 @@ class SinkTestCase(unittest.TestCase):
         self.pdbs = pdbuddy.Sink(pdbs_devices[0])
 
         self.obj_valid = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=15000, i=3000)
+                flags=pdbuddy.SinkFlags.NONE, v=15000, vmin=None, vmax=None,
+                i=3000)
         self.obj_valid_gb = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.GIVEBACK, v=15000, i=3000)
+                flags=pdbuddy.SinkFlags.GIVEBACK, v=15000, vmin=None,
+                vmax=None, i=3000)
 
         self.obj_huge_v = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=65536, i=1000)
+                flags=pdbuddy.SinkFlags.NONE, v=65536, vmin=None, vmax=None,
+                i=1000)
         self.obj_big_v = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=21001, i=1000)
+                flags=pdbuddy.SinkFlags.NONE, v=21001, vmin=None, vmax=None,
+                i=1000)
         self.obj_neg_v = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=-1, i=1000)
+                flags=pdbuddy.SinkFlags.NONE, v=-1, vmin=None, vmax=None,
+                i=1000)
 
         self.obj_huge_i = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=5000, i=65536)
+                flags=pdbuddy.SinkFlags.NONE, v=5000, vmin=None, vmax=None,
+                i=65536)
         self.obj_big_i = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=5000, i=5001)
+                flags=pdbuddy.SinkFlags.NONE, v=5000, vmin=None, vmax=None,
+                i=5001)
         self.obj_neg_i = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=5000, i=-1)
+                flags=pdbuddy.SinkFlags.NONE, v=5000, vmin=None, vmax=None,
+                i=-1)
 
     def tearDown(self):
         # Close the connection to the PD Buddy Sink
@@ -145,19 +153,30 @@ class SinkConfigTestCase(unittest.TestCase):
 
     def setUp(self):
         self.obj_none = pdbuddy.SinkConfig(status=None, flags=None, v=None,
-                i=None)
+                vmin=None, vmax=None, i=None)
         self.obj_empty = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.EMPTY,
-                flags=None, v=None, i=None)
+                flags=None, v=None, vmin=None, vmax=None, i=None)
         self.obj_valid = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=15000, i=3000)
+                flags=pdbuddy.SinkFlags.NONE, v=15000, vmin=None, vmax=None,
+                i=3000)
         self.obj_invalid = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.INVALID,
-                flags=pdbuddy.SinkFlags.NONE, v=15000, i=3000)
+                flags=pdbuddy.SinkFlags.NONE, v=15000, vmin=None, vmax=None,
+                i=3000)
         self.obj_valid_gb = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.GIVEBACK, v=15000, i=3000)
+                flags=pdbuddy.SinkFlags.GIVEBACK, v=15000, vmin=None,
+                vmax=None, i=3000)
         self.obj_valid_5v = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=5000, i=3000)
+                flags=pdbuddy.SinkFlags.NONE, v=5000, vmin=None, vmax=None,
+                i=3000)
         self.obj_valid_1a = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
-                flags=pdbuddy.SinkFlags.NONE, v=15000, i=1000)
+                flags=pdbuddy.SinkFlags.NONE, v=15000, vmin=None, vmax=None,
+                i=1000)
+        self.obj_valid_range = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
+                flags=pdbuddy.SinkFlags.NONE, v=15000, vmin=12000, vmax=16000,
+                i=1000)
+        self.obj_valid_hv = pdbuddy.SinkConfig(status=pdbuddy.SinkStatus.VALID,
+                flags=pdbuddy.SinkFlags.HV_PREFERRED, v=15000, vmin=12000,
+                vmax=16000, i=1000)
 
     def test_str_none(self):
         self.assertEqual(str(self.obj_none), "No configuration")
@@ -167,23 +186,33 @@ class SinkConfigTestCase(unittest.TestCase):
 
     def test_str_valid(self):
         self.assertEqual(str(self.obj_valid),
-                "status: valid\nflags: (none)\nv: 15.00 V\ni: 3.00 A")
+                "status: valid\nflags: (none)\nv: 15.000 V\ni: 3.00 A")
 
     def test_str_invalid(self):
         self.assertEqual(str(self.obj_invalid),
-                "status: invalid\nflags: (none)\nv: 15.00 V\ni: 3.00 A")
+                "status: invalid\nflags: (none)\nv: 15.000 V\ni: 3.00 A")
 
     def test_str_valid_gb(self):
         self.assertEqual(str(self.obj_valid_gb),
-                "status: valid\nflags: GiveBack\nv: 15.00 V\ni: 3.00 A")
+                "status: valid\nflags: GiveBack\nv: 15.000 V\ni: 3.00 A")
 
     def test_str_valid_5v(self):
         self.assertEqual(str(self.obj_valid_5v),
-                "status: valid\nflags: (none)\nv: 5.00 V\ni: 3.00 A")
+                "status: valid\nflags: (none)\nv: 5.000 V\ni: 3.00 A")
 
     def test_str_valid_1a(self):
         self.assertEqual(str(self.obj_valid_1a),
-                "status: valid\nflags: (none)\nv: 15.00 V\ni: 1.00 A")
+                "status: valid\nflags: (none)\nv: 15.000 V\ni: 1.00 A")
+
+    def test_str_valid_range(self):
+        self.assertEqual(str(self.obj_valid_range),
+                "status: valid\nflags: (none)\nv: 15.000 V\nvmin: 12.000 V\n"
+                "vmax: 16.000 V\ni: 1.00 A")
+
+    def test_str_valid_hv(self):
+        self.assertEqual(str(self.obj_valid_hv),
+                "status: valid\nflags: HV_Preferred\nv: 15.000 V\n"
+                "vmin: 12.000 V\nvmax: 16.000 V\ni: 1.00 A")
 
     def test_from_text_none(self):
         ft_none = pdbuddy.SinkConfig.from_text([])
@@ -196,38 +225,56 @@ class SinkConfigTestCase(unittest.TestCase):
     def test_from_text_valid(self):
         ft_valid = pdbuddy.SinkConfig.from_text([b"status: valid",
                 b"flags: (none)",
-                b"v: 15.00 V",
+                b"v: 15.000 V",
                 b"i: 3.00 A"])
         self.assertEqual(ft_valid, self.obj_valid)
 
     def test_from_text_invalid(self):
         ft_invalid = pdbuddy.SinkConfig.from_text([b"status: invalid",
                 b"flags: (none)",
-                b"v: 15.00 V",
+                b"v: 15.000 V",
                 b"i: 3.00 A"])
         self.assertEqual(ft_invalid, self.obj_invalid)
 
     def test_from_text_valid_gb(self):
         ft_valid_gb = pdbuddy.SinkConfig.from_text([b"status: valid",
                 b"flags: GiveBack",
-                b"v: 15.00 V",
+                b"v: 15.000 V",
                 b"i: 3.00 A"])
         self.assertEqual(ft_valid_gb, self.obj_valid_gb)
 
     def test_from_text_valid_5v(self):
         ft_valid_5v = pdbuddy.SinkConfig.from_text([b"status: valid",
                 b"flags: (none)",
-                b"v: 5.00 V",
+                b"v: 5.000 V",
                 b"i: 3.00 A"])
         self.assertEqual(ft_valid_5v, self.obj_valid_5v)
 
     def test_from_text_valid_1a(self):
         ft_valid_1a = pdbuddy.SinkConfig.from_text([b"status: valid",
                 b"flags: (none)",
-                b"v: 15.00 V",
+                b"v: 15.000 V",
                 b"i: 1.00 A"])
         self.assertEqual(ft_valid_1a, self.obj_valid_1a)
 
+    def test_from_text_valid_range(self):
+        ft_valid_range = pdbuddy.SinkConfig.from_text([b"status: valid",
+                b"flags: (none)",
+                b"v: 15.000 V",
+                b"vmin: 12.000 V",
+                b"vmax: 16.000 V",
+                b"i: 1.00 A"])
+        self.assertEqual(ft_valid_range, self.obj_valid_range)
+
+    def test_from_text_valid_hv(self):
+        ft_valid_hv = pdbuddy.SinkConfig.from_text([b"status: valid",
+                b"flags: HV_Preferred",
+                b"v: 15.000 V",
+                b"vmin: 12.000 V",
+                b"vmax: 16.000 V",
+                b"i: 1.00 A"])
+        self.assertEqual(ft_valid_hv, self.obj_valid_hv)
+
     def test_from_text_invalid_index(self):
         with self.assertRaises(IndexError):
             pdbuddy.SinkConfig.from_text([b"Invalid index"])
@@ -240,7 +287,7 @@ class SinkConfigTestCase(unittest.TestCase):
         ft_valid = pdbuddy.SinkConfig.from_text([b"status: valid",
                 b"flags: (none)",
                 b"This is an extra line, which shouldn't hurt anything.",
-                b"v: 15.00 V",
+                b"v: 15.000 V",
                 b"i: 3.00 A"])
         self.assertEqual(ft_valid, self.obj_valid)