PyVLCB 0.2.1__tar.gz → 0.2.6__tar.gz

{pyvlcb-0.2.1/src/PyVLCB.egg-info → pyvlcb-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyVLCB
-Version: 0.2.1
+Version: 0.2.6
 Summary: A library for CBUS / VLCB communication
 Author-email: "Stewart Watkiss (penguintutor)" <5587863+penguintutor@users.noreply.github.com>
 License: MIT License

{pyvlcb-0.2.1 → pyvlcb-0.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyVLCB"
-version = "0.2.1"
+version = "0.2.6"
 description = "A library for CBUS / VLCB communication"
 readme = {file="README.md",  content-type = "text/markdown"} 
 requires-python = ">=3.6"

{pyvlcb-0.2.1 → pyvlcb-0.2.6/src/PyVLCB.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyVLCB
-Version: 0.2.1
+Version: 0.2.6
 Summary: A library for CBUS / VLCB communication
 Author-email: "Stewart Watkiss (penguintutor)" <5587863+penguintutor@users.noreply.github.com>
 License: MIT License

{pyvlcb-0.2.1 → pyvlcb-0.2.6}/src/pyvlcb/__init__.py

@@ -124,8 +124,8 @@ class VLCB:
         opcode_string = f'{opcode} - {VLCBOpcode.opcode_mnemonic(opcode)}'
         #data_string = f"{VLCBOpcode.parse_data(vlcb_entry.data)}"
         data_string = dict_to_string(VLCBOpcode.parse_data(vlcb_entry.data))
-        return [date_string, direction, message, str(vlcb_entry.can_id), opcode_string, data_string]
-        # Todo - error handling 
+        description_string = vlcb_entry.get_description()
+        return [date_string, direction, message, str(vlcb_entry.can_id), opcode_string, data_string, description_string]
     
         
     # Static Methods moved to utils

{pyvlcb-0.2.1 → pyvlcb-0.2.6}/src/pyvlcb/vlcbformat.py

@@ -62,6 +62,24 @@ class VLCBFormat :
         """
         return VLCBOpcode.parse_data(self.data)
 
+
+    def get_description (self): # -> str:
+        """Returns a human readable string based on the data string
+
+        Returns:
+            String
+
+        Raises:
+            ValueError: If opcode not found
+        """
+        str_value = self.data[0:2]
+        if str_value in VLCBOpcode.opcodes.keys():
+            #TODO: Currently returns title - in future look to parse loco ID if appropriate
+            return VLCBOpcode.opcodes[str_value]['title']
+        else:
+            raise ValueError(f"Opcode {str_value} is not defined.")
+
+
     def format_data (self) -> OpcodeData:
         """Returns the opcode associated with the data string
 
@@ -463,14 +481,15 @@ class VLCBOpcode:
 
         Returns:
             String: shortened opcode string
+            or empty string for NULL opcode
 
-        Raises:
-            ValueError: If string does not contain at least 2 characters
         """
-        if len(opcode_string) >= 2:
+        # Also ignore - in position 1 (eg. " - ")
+        if len(opcode_string) >= 2 and opcode_string[1] != "-":
             return opcode_string[0:2]
         else:
-            raise ValueError(f"String {opcode_string} is too short.")
+            # If not a opcode_string (eg. Null) return ""
+            return ""
     
     # Get min priority from opcode
     @staticmethod
@@ -484,7 +503,7 @@ class VLCBOpcode:
             ValueError: If opcode not found
         """
         opcode = VLCBOpcode.opcode_extract(opcode)
-        if opcode in VLCBOpcode.opcodes.keys():
+        if opcode in VLCBOpcode.opcodes:
             return VLCBOpcode.opcodes[opcode]['minpri']
         else:
             raise ValueError(f"Opcode {opcode} is not defined.")