feat: add function to check library version

Author: sophec

absscpi/client.py

@@ -20,6 +20,9 @@
 LOCAL_MODEL_INPUT_COUNT = 8
 MODEL_OUTPUT_COUNT = 36
 
+def libver_to_str(libver: int) -> str:
+    return f"{libver // 10000}.{(libver % 10000) // 100}.{libver % 100}"
+
 class AbsCellFault(IntEnum):
     """ABS cell faulting mode."""
     NONE = 0
@@ -219,6 +222,29 @@ def __check_err(self, err: int):
         if err < 0:
             raise ScpiClientError(self.__err_msg(err))
 
+    def __ensure_ver(self, req_maj: int, req_min: int, req_patch: int):
+        """Ensure that the low-level library's version is high enough to support
+        a command.
+
+        Args:
+            req_maj: The required major library version. For example, if v1.2.3
+                is required, this value should be 1.
+            req_min: The required minimum library version. For example, if
+                v1.2.3 is required, this value should be 2.
+            req_patch: The required patch library version. For example, if
+                v1.2.3 is required, this value should be 3.
+
+        Raises:
+            ScpiClientError: The required version is not met.
+        """
+        required_ver = req_maj * 10000 + req_min * 100 + req_patch
+        if self.__lib_version < required_ver:
+            req_str = libver_to_str(required_ver)
+            found_str = libver_to_str(self.__lib_version)
+            raise ScpiClientError("SCPI library is too old! " +
+                                  f"Required version {req_str}, " +
+                                  f"found version {found_str}.")
+
     def init(self):
         """Initialize the client handle.
 
@@ -1059,6 +1085,7 @@ def measure_average_cell_voltage(self, cell: int) -> float:
         Raises:
             ScpiClientError: An error occurred while executing the query.
         """
+        self.__ensure_ver(1,1,0)
         voltage = c_float()
         res = self.__dll.AbsScpiClient_MeasureAverageCellVoltage(
                 self.__handle, c_uint(cell), byref(voltage))
@@ -1078,6 +1105,7 @@ def measure_all_average_cell_voltages(self) -> list[float]:
         Raises:
             ScpiClientError: An error occurred while executing the query.
         """
+        self.__ensure_ver(1,1,0)
         voltages = (c_float * CELL_COUNT)()
         res = self.__dll.AbsScpiClient_MeasureAllAverageCellVoltages(
                 self.__handle, byref(voltages), c_uint(CELL_COUNT))
@@ -1100,6 +1128,7 @@ def measure_average_cell_current(self, cell: int) -> float:
         Raises:
             ScpiClientError: An error occurred while executing the query.
         """
+        self.__ensure_ver(1,1,0)
         current = c_float()
         res = self.__dll.AbsScpiClient_MeasureAverageCellCurrent(
                 self.__handle, c_uint(cell), byref(current))
@@ -1119,6 +1148,7 @@ def measure_all_average_cell_currents(self) -> list[float]:
         Raises:
             ScpiClientError: An error occurred while executing the query.
         """
+        self.__ensure_ver(1,1,0)
         currents = (c_float * CELL_COUNT)()
         res = self.__dll.AbsScpiClient_MeasureAllAverageCellCurrents(
                 self.__handle, byref(currents), c_uint(CELL_COUNT))