PyVLCB 0.2.2__tar.gz → 0.2.7__tar.gz

{pyvlcb-0.2.2/src/PyVLCB.egg-info → pyvlcb-0.2.7}/PKG-INFO

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

{pyvlcb-0.2.2 → pyvlcb-0.2.7}/pyproject.toml

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

{pyvlcb-0.2.2 → pyvlcb-0.2.7/src/PyVLCB.egg-info}/PKG-INFO

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

{pyvlcb-0.2.2 → pyvlcb-0.2.7}/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
@@ -250,9 +250,16 @@ class VLCB:
         Returns:
             String: A string for the request
         """
+
         # if ev_id is a string then convert to an int
         # Setting based to 0 will automatically handle base 10 or hex
-        ev_id = int(ev_id, 0)
+        if not isinstance(ev_id, (int, str)):
+            raise TypeError(f"Expected int or str, got {type(ev_id).__name__}")
+
+        # Convert strings (ints are ignored and remain ints)
+        if isinstance(ev_id, str):
+            ev_id = int(ev_id, 0)
+
         # determine if long or short
         if ev_id <= 0xffff:
             return self.accessory_short_command (node_id, ev_id, state)
@@ -491,4 +498,4 @@ class VLCB:
         return f"{self.make_header(opcode='60')}60{num_to_1hexstr(session_id)}{byte1_2[0]}{byte1_2[1]};"
         
 
-    
+    

{pyvlcb-0.2.2 → pyvlcb-0.2.7}/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