PyVLCB 0.2.6__tar.gz → 0.2.8__tar.gz

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

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

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

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

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

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

{pyvlcb-0.2.6 → pyvlcb-0.2.8}/src/PyVLCB.egg-info/SOURCES.txt

@@ -13,4 +13,5 @@ src/pyvlcb/utils.py
 src/pyvlcb/vlcbformat.py
 src/pyvlcb/tests/run_tests.py
 src/pyvlcb/tests/test_canusb4.py
+src/pyvlcb/tests/test_opcodes.py
 src/pyvlcb/tests/test_vlcb.py

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

@@ -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.8/src/pyvlcb/tests/test_opcodes.py

@@ -0,0 +1,23 @@
+import unittest
+
+import os
+
+from pyvlcb import VLCB, VLCBFormat, VLCBOpcode
+
+## Test for VLCB library
+# Test that the OpCodes are formatted correctly (particular the format field)
+class TestOpCodes(unittest.TestCase):
+    # Check each of the format entries exist in the field_formats list
+    def test_opcode_format(self):
+        for thisopcode in VLCBOpcode.opcodes.keys():
+
+            if VLCBOpcode.opcodes[thisopcode]['format'] == "":
+                continue
+            field_codes = VLCBOpcode.opcodes[thisopcode]['format'].split(',')
+            for this_code in field_codes:
+                #print (f"Checking Opcode {thisopcode} format :{this_code}:")
+                self.assertTrue(this_code in VLCBOpcode.field_formats.keys())
+
+                
+if __name__ == '__main__':
+    unittest.main()

{pyvlcb-0.2.6 → pyvlcb-0.2.8}/src/pyvlcb/tests/test_vlcb.py

@@ -92,6 +92,7 @@ class TestVLCB(unittest.TestCase):
         self.assertEqual(f_to_bytes (2, functions), ("01", "19"))
         self.assertEqual(f_to_bytes (7, functions), ("02", "06"))
         self.assertEqual(f_to_bytes (24, functions), ("05", "00"))
+        
 
 
 if __name__ == "__main__":

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

@@ -336,7 +336,7 @@ class VLCBOpcode:
         'F9':  {'opc': 'ASOF3', 'title': 'Accessory Short OFF', 'format': 'NN,DNHigh_DNLow,Byte1,Byte2,Byte3', 'minpri': 3, 'comment': 'Indicates an OFF event using the short event number of 2 LS bytes with three added data bytes.'},
         'FA':  {'opc': 'DDES', 'title': 'Device data event (short mode)', 'format': 'DNHigh_DNLow,Byte1,Byte2,Byte3,Byte4,Byte5', 'minpri': 3, 'comment': 'Function is the same as F6 but uses device addressing so can relate data to a device attached to a node. e.g. one of several RFID readers attached to a single node.'},
         'FB':  {'opc': 'DDRS', 'title': 'Device data response (short mode)', 'format': 'DNHigh_DNLow,Byte1,Byte2,Byte3,Byte4,Byte5', 'minpri': 3, 'comment': 'The response to a request for data from a device. (0x5B)'},
-        'FC':  {'opc': 'DDWS', 'title': 'Write data', 'format': 'DNHigh_DNLow,byte1,byte2,byte3,byte4,byte5', 'minpri': 0, 'comment': 'Used to write data to a device such as an RFID tag. For RC522 byte1 should be 0.'},
+        'FC':  {'opc': 'DDWS', 'title': 'Write data', 'format': 'DNHigh_DNLow,Byte1,Byte2,Byte3,Byte4,Byte5', 'minpri': 0, 'comment': 'Used to write data to a device such as an RFID tag. For RC522 byte1 should be 0.'},
         'FD':  {'opc': 'ARSON3', 'title': 'Accessory Short Response Event', 'format': 'NN,DNHigh_DNLow,Byte1,Byte2,Byte3', 'minpri': 3, 'comment': "Indicates an ON response event with with three added data bytes. A response event is a reply to a status request (ASRQ) without producing an ON or OFF event."},
         'FE':  {'opc': 'ARSOF3', 'title': 'Accessory Short Response Event', 'format': 'NN,DNHigh_DNLow,Byte1,Byte2,Byte3', 'minpri': 3, 'comment': "Indicates an OFF response event with with three added data bytes. A response event is a reply to a status request (ASRQ) without producing an ON or OFF event."},
         'FF':  {'opc': 'EXTC6', 'title': 'Extended op-code with 6 data bytes', 'format': 'ExtOpc,Byte1,Byte2,Byte3,Byte4,Byte5,Byte6', 'minpri': 3, 'comment': 'Used if the basic set of 32 OPCs is not enough. Allows an additional 256 OPCs'}
@@ -353,8 +353,9 @@ class VLCBOpcode:
             "Consist": [2, "num"],        # Consist ID
             "Index": [2, "num"],          # Index of loco in consist
             "Status": [2, "hex"],     
-            "NN": [4, "num"],    # Node number
-            "AllocCode": [2, "num"],       # Specific allocation code
+            "NN": [4, "num"],             # Node number
+            "NNIndex": [2, "num"],        # Index for the node variable value 
+            "AllocCode": [2, "num"],      # Specific allocation code
             "SpeedDir": [2, "hex"],
             "SpeedFlag": [2, "hex"],       # Speed flags DDD-DDDDD
             "Fnum": [2, "num"],            # Function number