MultiPyVu 3.1.0__tar.gz → 3.1.2__tar.gz

{multipyvu-3.1.0/src/MultiPyVu.egg-info → multipyvu-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MultiPyVu
-Version: 3.1.0
+Version: 3.1.2
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
@@ -38,7 +38,6 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: typing
 Requires-Dist: pandas
 Requires-Dist: pywin32>=300; platform_system == "Windows"
 Requires-Dist: pillow
@@ -436,17 +435,28 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
+**3.1.2**
+- October 2024
+- Fixed a bug which truncated numbers
+
+**3.1.1**
+- October 2024
+- Updated the installer to include missing files.
+
 **3.1.0**
 - October 2024
 - Log the version number when the Client connects to the Server.
 - Check that the Server and Client are running the same version.
 - Increase the number of backup logs to 5.
 - Bugfix to allow Client to run on Linux or Mac systems.
-- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
 - Limit server to hosting only one client at a time.
 - Add the ability to call -quit, -is_running, -status, -get_ip from the command line using python -m MultiPyVu
 - Miscellaneous bug fixes and refactoring.
 
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+
 **2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:

{multipyvu-3.1.0 → multipyvu-3.1.2}/README.md

@@ -390,17 +390,28 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
+**3.1.2**
+- October 2024
+- Fixed a bug which truncated numbers
+
+**3.1.1**
+- October 2024
+- Updated the installer to include missing files.
+
 **3.1.0**
 - October 2024
 - Log the version number when the Client connects to the Server.
 - Check that the Server and Client are running the same version.
 - Increase the number of backup logs to 5.
 - Bugfix to allow Client to run on Linux or Mac systems.
-- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
 - Limit server to hosting only one client at a time.
 - Add the ability to call -quit, -is_running, -status, -get_ip from the command line using python -m MultiPyVu
 - Miscellaneous bug fixes and refactoring.
 
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+
 **2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:

{multipyvu-3.1.0 → multipyvu-3.1.2}/setup.py

@@ -46,13 +46,13 @@ setup(
             "images/*.jpg",
             "images/*.png",
             "font/*.ttf",
-            "scripts/*.cmd",
-            "MultiVuDataFile/*.py"
+            "scripts/*",
+            "MultiVuDataFile/*.py",
+            "logging_config.yaml"
             ]
         },
     python_requires=">=3.8",
     install_requires=[
-        "typing",
         "pandas",
         "pywin32>=300; platform_system=='Windows'",
         "pillow",

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu/CommandMultiVu.py

@@ -110,7 +110,7 @@ class CommandMultiVuBase():
             msg += 'which could mean MultiVu is not running.'
             raise MultiPyVuError(msg)
 
-        result_string = result if isinstance(result, str) else f'{result:.4f}'
+        result_string = result if isinstance(result, str) else str(result)
         return f'{result_string},{mv_command.units},{code_in_words}'
 
     def set_state(self, command: str, arg_string: str) -> str:

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu/CommandSdo.py

@@ -157,8 +157,8 @@ class CommandSdoBase(ICommand):
 
     @abstractmethod
     def get_state_server(self,
-                         statusCode: str,
-                         stateValue: str,
+                         value_variant,
+                         state_variant,
                          params: str = ''):
         raise NotImplementedError
 
@@ -187,7 +187,10 @@ class CommandSdoImp(CommandSdoBase):
         super().__init__()
         self._mvu = multivu_win32com
 
-    def _binary_to_value(self, sdo, len, val) -> Union[str, int, float]:
+    def _binary_to_value(self,
+                         sdo: SdoObject,
+                         length: win32.VARIANT,
+                         val: win32.VARIANT) -> Union[str, int, float]:
         """
         Convert a binary value from reading an SDO into its correct
         type.
@@ -195,9 +198,9 @@ class CommandSdoImp(CommandSdoBase):
         Parameters:
         -----------
         sdo: SdoObject
-        len: win32com.client.VARIANT
+        length: win32com.client.VARIANT
             This is the parameter used in ReadSDO which
-            holds the length of the value being read.
+            holds the length of the value that was read.
         val: win32com.client.VARIANT
             This is the parameter used in ReadSDO which
             holds the value being read.
@@ -208,31 +211,34 @@ class CommandSdoImp(CommandSdoBase):
         python format of string, int, or float.
         """
         if sdo.val_type is val_type.string_t:
-            var_memory = val.value[0:len.value - 1]
+            var_memory = val.value[0:length.value - 1]
             return_val = bytes(var_memory).decode('utf-8')
-        elif sdo.val_type is val_type.short_t or \
-                sdo.val_type is val_type.int_t or \
-                sdo.val_type is val_type.long_t:
-            b = list(bytes(val.value)[0:len.value])
+        elif sdo.val_type in (val_type.short_t,
+                              val_type.int_t,
+                              val_type.long_t):
+            b = list(bytes(val.value)[0:length.value])
             return_val = int.from_bytes(b,
                                         byteorder='little',
                                         signed=True)
-        elif sdo.val_type is val_type.ushort_t or \
-                sdo.val_type is val_type.uint_t or \
-                sdo.val_type is val_type.ulong_t:
-            b = list(bytes(val.value)[0:len.value])
+        elif sdo.val_type in (val_type.ushort_t,
+                              val_type.uint_t,
+                              val_type.ulong_t):
+            b = list(bytes(val.value)[0:length.value])
             return_val = int.from_bytes(b,
                                         byteorder='little',
                                         signed=False)
-        else:
-            b = bytes(val.value)[0:len.value]
+        elif sdo.val_type in (val_type.single_t,
+                              val_type.double_t):
+            b = bytes(val.value)[0:length.value]
             # format = '<f' means little endian ('>f' is big endian)
             [return_val] = struct.unpack('<f', b)
+        else:
+            raise ValueError('unsupported variant type')
         return return_val
 
     def _value_to_binary(self,
                          sdo: SdoObject,
-                         val: Union[str, int, float]) -> Tuple[int, bytes]:
+                         val: Union[str, int, float]) -> bytes:
         """
         Convert a value being sent to WriteSDO into binary.
 
@@ -245,41 +251,24 @@ class CommandSdoImp(CommandSdoBase):
 
         Returns:
         --------
-        A tuple with the first item being the length of the SDO,
-        and the second item the value being set in binary.
+        The value being set in binary.
         """
-        len = 1
+        sdo_length = sdo.object_length()
         sdo_val = b''
-        if sdo.val_type is val_type.short_t or \
-                sdo.val_type is val_type.ushort_t:
-            len = 1
-            sdo_val = int.to_bytes(int(val), len,
-                                   byteorder='little',
-                                   signed=False)
-        elif sdo.val_type is val_type.int_t or \
-                sdo.val_type is val_type.uint_t:
-            len = 2
-            sdo_val = int.to_bytes(int(val), len,
-                                   byteorder='little',
-                                   signed=False)
-        elif sdo.val_type is val_type.long_t or \
-                sdo.val_type is val_type.ulong_t:
-            len = 4
-            sdo_val = int.to_bytes(int(val), len,
-                                   byteorder='little',
-                                   signed=False)
-        elif sdo.val_type is val_type.single_t:
-            len = 2
-            sdo_val = struct.pack('<f', float(val))
-        elif sdo.val_type is val_type.double_t:
-            len = 4
+        if sdo.val_type in (val_type.short_t, val_type.ushort_t):
+            sdo_val = int(val).to_bytes(sdo_length, 'little', signed=False)
+        elif sdo.val_type in (val_type.int_t, val_type.uint_t):
+            sdo_val = int(val).to_bytes(sdo_length, 'little', signed=False)
+        elif sdo.val_type in (val_type.long_t, val_type.ulong_t):
+            sdo_val = int(val).to_bytes(sdo_length, 'little', signed=False)
+        elif sdo.val_type in (val_type.single_t, val_type.double_t):
             sdo_val = struct.pack('<f', float(val))
         elif sdo.val_type is val_type.string_t:
             sdo_val = val.encode()
         else:
             msg = 'Unsupported val_type: ' + str(sdo)
             raise ValueError(msg)
-        return len, sdo_val
+        return sdo_val
 
     def read_sdo(self, sdo: SdoObject,) -> Tuple:
         """
@@ -296,7 +285,7 @@ class CommandSdoImp(CommandSdoBase):
         a tuple whose first term is the CAN error and the second
         term is the abort error.
         """
-        sdo_len = win32.VARIANT(
+        length_variant = win32.VARIANT(
                             pythoncom.VT_BYREF | pythoncom.VT_I4,
                             0)
         value_variant = win32.VARIANT(
@@ -311,7 +300,7 @@ class CommandSdoImp(CommandSdoBase):
             can_error = self._mvu.ReadSDO(sdo.node,
                                           sdo.index,
                                           sdo.sub,
-                                          sdo_len,
+                                          length_variant,
                                           value_variant,
                                           error_variant)
             self.return_state = self._errors_to_str(can_error,
@@ -327,7 +316,9 @@ class CommandSdoImp(CommandSdoBase):
             msg += f'while reading ({str(sdo)})'
             raise MultiPyVuError(msg)
         else:
-            return_val = self._binary_to_value(sdo, sdo_len, value_variant)
+            return_val = self._binary_to_value(sdo,
+                                               length_variant,
+                                               value_variant)
 
         return return_val, self.return_state
 
@@ -348,13 +339,11 @@ class CommandSdoImp(CommandSdoBase):
         --------
         string with the error from MultiVu
         """
-        len, sdo_val = self._value_to_binary(sdo, val)
-        sdo_len = win32.VARIANT(
-                            pythoncom.VT_BYREF | pythoncom.VT_I4,
-                            len)
+        binary_val = self._value_to_binary(sdo, val)
+        data_length = sdo.object_length()
         value_variant = win32.VARIANT(
                             pythoncom.VT_BYREF | pythoncom.VT_VARIANT,
-                            sdo_val)
+                            binary_val)
         error_variant = win32.VARIANT(
                             pythoncom.VT_BYREF | pythoncom.VT_I4,
                             0)
@@ -363,7 +352,7 @@ class CommandSdoImp(CommandSdoBase):
             can_error = self._mvu.WriteSDO(sdo.node,
                                            sdo.index,
                                            sdo.sub,
-                                           sdo_len,
+                                           data_length,
                                            value_variant,
                                            error_variant)
             self.return_state = self._errors_to_str(can_error,
@@ -379,14 +368,20 @@ class CommandSdoImp(CommandSdoBase):
             self.logger_client.debug(msg)
         return self.return_state
 
-    def get_state_server(self, value_variant, state_variant, params) -> Tuple:
+    def get_state_server(self,
+                         value_variant,
+                         state_variant,
+                         params: str) -> Tuple:
         """
         Returns a tuple of the SDO query result and the can_error number.
 
+        Note that the first two input parameters are unused, but included
+        because the other CommandXXX classes use them.
+
         Parameters:
         -----------
-        value_variant: win32com.client (not used)
-        state_variant: win32com.client (not used)
+        value_variant: (not used)
+        state_variant: (not used)
         params: str
             The string representation of an sdo_object
 
@@ -434,10 +429,13 @@ class CommandSdoSim(CommandSdoBase):
         """
         Returns a tuple of the SDO query result and the can_error number.
 
+        Note that the first two input parameters are unused, but included
+        because the other CommandXXX classes use them.
+
         Parameters:
         -----------
-        value_variant: win32com.client (not used)
-        state_variant: win32com.client (not used)
+        value_variant: (not used)
+        state_variant: (not used)
         params: str
             The string representation of an SdoObject
 

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu/__version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = "3.1.0"
+__version__ = "3.1.2"

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu/exceptions.py

@@ -364,5 +364,5 @@ class CanError(Exception):
         if can_err == can_err_enum.R_ABORT:
             err_msg, _ = abort_error_msg(sdo_err)
         if can_err != can_err_enum.R_OK:
-            err_msg = 'Error: ' + err_msg
+            err_msg = 'CAN Error: ' + err_msg
         super().__init__(err_msg)

multipyvu-3.1.2/src/MultiPyVu/logging_config.yaml

@@ -0,0 +1,42 @@
+version: 1
+disable_existing_loggers: True
+formatters:
+  show_name:
+    format: '%(name)s - %(message)s'
+  no_name:
+    format: '%(message)s'
+  debug:
+    format: '%(asctime)-27s %(name)-20s %(levelname)-8s %(message)s'
+  gui:
+    format: '%(asctime)s - %(message)s'
+    datefmt: '%m-%d %H:%M'
+handlers:
+  console:
+    class: logging.StreamHandler
+    level: INFO
+    formatter: show_name
+    stream: ext://sys.stdout
+  file:
+    class: logging.handlers.RotatingFileHandler
+    level: DEBUG
+    formatter: debug
+    filename: debug
+    maxBytes: 4194304  # 2^22
+    backupCount: 5
+loggers:
+  MultiVuServer:
+    level: DEBUG
+    handlers: [console, file]
+    text_widget: text_widget
+    propagate: False
+  MultiVuClient:
+    level: DEBUG
+    handlers: [console, file]
+    propagate: False
+  UnitTest:
+    level: DEBUG
+    handlers: [console, file]
+    propagate: False
+root:
+  level: WARNING
+  handlers: [console]

multipyvu-3.1.2/src/MultiPyVu/scripts/helper_scripts.py

@@ -0,0 +1,118 @@
+"""
+A few helpful scripts used in the MultiPyVu module
+"""
+
+from os import path
+from sys import platform
+import subprocess
+import re
+
+from MultiPyVu.MultiVuClient import Client
+
+
+def absolute_path(filename: str) -> str:
+    """
+    Finds the absolute path of a file based on its location
+    relative to the gui module
+
+    Parameters:
+    -----------
+    filename: str
+        The file location based on its relative path from the gui module
+    """
+    abs_path = path.abspath(
+        path.join(path.dirname(
+            __file__), './'))
+    return path.join(abs_path, filename)
+
+
+def get_ip():
+    """
+    The IP address for the computer
+
+    Returns:
+    --------
+    String with the IP address
+    """
+    ip_output_str = ''
+    search_str = r'([0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3})'
+    if platform == 'win32':
+        ip_addr_script = 'whats_my_ip_address.cmd'
+        ip_addr_script = absolute_path(ip_addr_script)
+        proc = subprocess.run([ip_addr_script],
+                              capture_output=True,
+                              text=True)
+        if proc.returncode != 0:
+            print(proc.stderr)
+            raise Exception(proc.stderr)
+        ip_result = re.findall(search_str, proc.stdout)
+        if len(ip_result) == 1:
+            ip_address = ip_result[0]
+    else:
+        # using this suggestion:
+        # https://apple.stackexchange.com/questions/20547/how-do-i-find-my-ip-address-from-the-command-line
+        ifconfig_proc = subprocess.Popen(["ifconfig"],
+                                         stdout=subprocess.PIPE,
+                                         text=True)
+        grep_proc = subprocess.Popen(["grep", "inet"],
+                                     stdin=ifconfig_proc.stdout,
+                                     stdout=subprocess.PIPE,
+                                     text=True)
+        ip_output_str, err = grep_proc.communicate()
+        if err is not None:
+            print(err)
+            raise Exception(grep_proc.stderr)
+        ip_result = re.findall(search_str, ip_output_str)
+        if '127.0.0.1' in ip_result:
+            ip_result.remove('127.0.0.1')
+        if len(ip_result) >= 1:
+            ip_address = ip_result[0]
+    return ip_address
+
+
+def run_status(ip: str, port: int):
+    """
+    Queries the server for its status.
+    """
+    ip_address = ip
+    if ip_address == '0.0.0.0':
+        ip_address = 'localhost'
+
+    client = Client(host=ip_address,
+                    port=port)
+    response = client.get_server_status()
+    print(f'Server status: {response}')
+
+
+def is_running(ip: str, port: int):
+    """
+    Queries the server to see if it is running
+    """
+    ip_address = ip
+    if ip_address == '0.0.0.0':
+        ip_address = 'localhost'
+
+    client = Client(host=ip_address,
+                    port=port)
+    response = client.is_server_running()
+    if response:
+        print(f'Server is running at {client.address}')
+    else:
+        print(f'Server not running at {client.address}')
+
+
+def force_quit(ip: str, port: int) -> str:
+    """
+    Quits the server.
+    """
+    ip_address = ip
+    if ip_address == '0.0.0.0':
+        ip_address = 'localhost'
+
+    client = Client(host=ip_address,
+                    port=port)
+    response = client.force_quit_server()
+    if response:
+        return response
+    else:
+        return f'Sent quit command to {client.address}'

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu/sdo_object.py

@@ -37,6 +37,17 @@ class SdoObject():
     The string can be converted into an sdo_object by calling
     .str_to_obj(string), which is a static method and returns
     an sdo_object.
+
+    Parameters:
+    -----------
+    nodID: int
+        The node number
+    sdo_index: int
+        This should be represented in hex.  For example, 0x1008.
+    sub_index: int
+        This should be represented in hex.  For example, 0x0.
+    val_t: val_type
+        Specify the type.
     """
     def __init__(self,
                  nodeID: int,
@@ -44,7 +55,7 @@ class SdoObject():
                  sub_index: int,
                  val_t: val_type):
         if (nodeID > 63) or (nodeID < 0):
-            msg = f'Invalid nodeNum: {nodeID}'
+            msg = f'Invalid nodeID: {nodeID}'
             raise ValueError(msg)
         if (sdo_index > 0xFFFF) or (sdo_index < 0):
             msg = f'Invalid SDO index: {sdo_index}'
@@ -99,3 +110,28 @@ class SdoObject():
         s = int(sub_index, 16)
         v_t = val_type[t]
         return SdoObject(n, i, s, v_t)
+
+    def object_length(self) -> int:
+        """
+        Get the byte size
+        """
+        if self.val_type is val_type.short_t:
+            return 1
+        elif self.val_type is val_type.int_t:
+            return 2
+        elif self.val_type is val_type.single_t:
+            return 2
+        elif self.val_type is val_type.string_t:
+            return 1
+        elif self.val_type is val_type.ushort_t:
+            return 1
+        elif self.val_type is val_type.uint_t:
+            return 2
+        elif self.val_type is val_type.double_t:
+            return 4
+        elif self.val_type is val_type.long_t:
+            return 4
+        elif self.val_type is val_type.ulong_t:
+            return 4
+        else:
+            raise ValueError('Unimplemented SDO type')

{multipyvu-3.1.0 → multipyvu-3.1.2/src/MultiPyVu.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MultiPyVu
-Version: 3.1.0
+Version: 3.1.2
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
@@ -38,7 +38,6 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: typing
 Requires-Dist: pandas
 Requires-Dist: pywin32>=300; platform_system == "Windows"
 Requires-Dist: pillow
@@ -436,17 +435,28 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
+**3.1.2**
+- October 2024
+- Fixed a bug which truncated numbers
+
+**3.1.1**
+- October 2024
+- Updated the installer to include missing files.
+
 **3.1.0**
 - October 2024
 - Log the version number when the Client connects to the Server.
 - Check that the Server and Client are running the same version.
 - Increase the number of backup logs to 5.
 - Bugfix to allow Client to run on Linux or Mac systems.
-- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
 - Limit server to hosting only one client at a time.
 - Add the ability to call -quit, -is_running, -status, -get_ip from the command line using python -m MultiPyVu
 - Miscellaneous bug fixes and refactoring.
 
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+
 **2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ src/MultiPyVu/exceptions.py
 src/MultiPyVu/generate_sdo_objects.py
 src/MultiPyVu/instrument.py
 src/MultiPyVu/logging_config.py
+src/MultiPyVu/logging_config.yaml
 src/MultiPyVu/project_vars.py
 src/MultiPyVu/sdo_object.py
 src/MultiPyVu.egg-info/PKG-INFO
@@ -49,4 +50,5 @@ src/MultiPyVu/gui/ViewTk.py
 src/MultiPyVu/gui/__init__.py
 src/MultiPyVu/images/Q.png
 src/MultiPyVu/images/QD_logo.jpg
+src/MultiPyVu/scripts/helper_scripts.py
 src/MultiPyVu/scripts/whats_my_ip_address.cmd

{multipyvu-3.1.0 → multipyvu-3.1.2}/src/MultiPyVu.egg-info/requires.txt

@@ -1,4 +1,3 @@
-typing
 pandas
 pillow
 pyyaml