PyVLCB 0.1.2__tar.gz → 0.1.3__tar.gz

{pyvlcb-0.1.2/src/PyVLCB.egg-info → pyvlcb-0.1.3}/PKG-INFO

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

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/pyproject.toml

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

{pyvlcb-0.1.2 → pyvlcb-0.1.3/src/PyVLCB.egg-info}/PKG-INFO

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

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/src/pyvlcb/__init__.py

@@ -3,7 +3,7 @@
 
 from .vlcbformat import VLCBFormat, VLCBOpcode
 from .canusb import CanUSB4
-from .utils import num_to_1hexstr, num_to_2hexstr, num_to_4hexstr, f_to_bytes
+from .utils import num_to_1hexstr, num_to_2hexstr, num_to_4hexstr, f_to_bytes, dict_to_string
 from .exceptions import (
     MyLibraryError, 
     DeviceConnectionError, 
@@ -123,7 +123,7 @@ class VLCB:
         opcode = vlcb_entry.data[0:2]
         opcode_string = f'{opcode} - {VLCBOpcode.opcode_mnemonic(opcode)}'
         #data_string = f"{VLCBOpcode.parse_data(vlcb_entry.data)}"
-        data_string = VLCB._dict_to_string(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 
     
@@ -400,12 +400,42 @@ class VLCB:
         """
         return f"{self.make_header(opcode='23')}23{num_to_1hexstr(session_id)};"
     
+    def loco_speed_dir (self, session_id: int, speed: int, direction: int) -> str:
+        """Set loco speed and direction based on separate arguments
+
+        Same as loco_speeddir but this takes 2 arguments, whereas loco_speeddir needs a combined value
+        Maximum call this once every 32 milliseconds
+
+        Uses DSPD (47)
+
+        Args:
+            session_id: Session ID
+            speed: 0 to 127 (1 is increased to 2 to avoid emergency stop)
+            direction: 1 = forward, 0 = reverse
+
+        Returns:
+            String: A string for the request
+            
+        Raises:
+            ValueError is speed is out of range, or invalid direction
+        """
+        if speed < 0 or speed > 127:
+            raise ValueError ("Invalid speed specified. Must be in range 0 to 127")
+        if direction <0 or direction > 1:
+            raise ValueError ("Direction is not valid. Use 1 for forward, 0 for reverse")
+        # special case - ignore emergency stop
+        if speed == 1:
+            speed = 2
+        speeddir = (direction * 0x80) + speed
+        return self.loco_speeddir (session_id, speeddir)
+    
     # Set loco speed and direction (always done together)
-    # Maximum once every 32 miliseconds (GUI configured based on non triggered so shouldn't be an issue)
-    # Could add time detection if required
-    # This uses the combined speed and direction value
     def loco_speeddir (self, session_id: int, speeddir: int) -> str:
-        """Create a combined set speed and direction event
+        """Set loco speed and direction
+
+        Maximum call this once every 32 milliseconds
+        Needs combined speed and direction value.
+        If speed is set to 1 then that is considered an emergency stop
 
         Uses DSPD (47)
 
@@ -437,5 +467,28 @@ class VLCB:
             String: A string for the request
         """
         return f"{self.make_header(opcode='60')}60{num_to_1hexstr(session_id)}{num_to_1hexstr(byte1)}{num_to_1hexstr(byte2)};"
-        
     
+    def loco_set_function (self, session_id: int, function_num, function_list) -> str:
+        """Create a set function request using the function list
+        Sends the entire group of functions where the function_num resides
+        This is an alternative to loco_set_dfun as this calculates the bytes
+        this method can only be used for functions 0 to 27
+
+        Uses DFUN (60)
+
+        Args:
+            session_id: Session ID
+            byte1: Function number
+            byte2: List of current function statuses
+
+        Returns:
+            String: A string for the request
+            
+        Raises:
+            ValueError: Typically raised from f_to_bytes
+        """
+        byte1_2 = f_to_bytes(function_num, function_list)
+        return f"{self.make_header(opcode='60')}60{num_to_1hexstr(session_id)}{byte1_2[0]}{byte1_2[1]};"
+        
+
+    

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/src/pyvlcb/canusb.py

@@ -22,7 +22,8 @@ class CanUSB4 ():
     def __init__ (self, 
                   port: str, 
                   baud: Optional[int] = 115200, 
-                  timeout: Optional[float] = 0.01) -> None:
+                  timeout: Optional[float] = 0.01,
+                  exclusive: Optional[bool] = True) -> None:
         """Inits CanUSB4 with a USB port
         
         Args:
@@ -41,6 +42,10 @@ class CanUSB4 ():
         self.timeout = timeout
         self.max_retry = 30    # How many times to attempt on get_data must be at least as long as frame
         # Timeout for a request could be max_rety x timeout
+        self.exclusive = exclusive	# Exclusive determines if check for exclusive use of the USB port
+        # If this is set to false then if another application is already using the port then the application
+        # will run, but appear to hang if there is no response because another thread has already
+        # taken the incoming data
         
         if not port:
             raise InvalidConfigurationError("Port name cannot be empty")
@@ -53,7 +58,11 @@ class CanUSB4 ():
         
         
     # Optional arguments override existing
-    def connect(self, port=None, baud=None, timeout=None):
+    def connect(self,
+                port: Optional[str] = None,
+                baud: Optional[int] = None,
+                timeout: Optional[float] = None,
+                exclusive: Optional[bool] = None) -> None:
         """Inits CanUSB4 with a USB port
         
         Args:
@@ -74,8 +83,15 @@ class CanUSB4 ():
             self.baud = baud
         if timeout != None:
             self.timeout = timeout
+        if exclusive != None:
+            self.exclusive = exclusive
         try:
-            self.ser = serial.Serial(self.port, self.baud, timeout=self.timeout)
+            self.ser = serial.Serial(
+                self.port,
+                self.baud,
+                timeout=self.timeout,
+                exclusive = exclusive
+                )
         except serial.SerialException as e:
             raise DeviceConnectionError(f"Could not open port {self.port}") from e
         if self.ser:

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/src/pyvlcb/exceptions.py

@@ -57,4 +57,12 @@ class InvalidLocoError(MyLibraryError):
     or short code specified but code needs long code
     or if the packet does not contain a loco_id (eg. certain Err codes)
     """
+    pass
+
+class InvalidFunctionError(MyLibraryError):
+    """
+    Raised for an invalid function requests
+    For example asking for function information
+    from a response which doesn't include the function information.
+    """
     pass

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/src/pyvlcb/tests/test_canusb4.py

@@ -34,7 +34,7 @@ class TestCanUSB4(unittest.TestCase):
     def test_init_valid(self):
         """Test that initialization opens the serial port with correct settings."""
         # Check if serial.Serial was called with correct args
-        self.mock_serial_class.assert_called_with(self.port, 115200, timeout=0.01)
+        self.mock_serial_class.assert_called_with(self.port, 115200, timeout=0.01, exclusive=None)
 
     def test_init_empty_port(self):
         """Test that empty port raises InvalidConfigurationError."""

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/src/pyvlcb/tests/test_vlcb.py

@@ -88,10 +88,10 @@ class TestVLCB(unittest.TestCase):
     #f_to_bytes (f_num: int, function_status: List[int]) -> Tuple[bytes, bytes]
     def test_f_to_bytes(self):
         functions = [1, 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1]
-        self.assertEqual(f_to_bytes (1, functions), (1, 25))
-        self.assertEqual(f_to_bytes (2, functions), (1, 25))
-        self.assertEqual(f_to_bytes (7, functions), (2, 6))
-        self.assertEqual(f_to_bytes (24, functions), (5, 0))
+        self.assertEqual(f_to_bytes (1, functions), ("01", "19"))
+        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.1.2 → pyvlcb-0.1.3}/src/pyvlcb/utils.py

@@ -40,7 +40,7 @@ def num_to_4hexstr (num: int) -> str:
 
 
 # dict to string without {} or ""
-def _dict_to_string (dictionary: dict) -> str:
+def dict_to_string (dictionary: dict) -> str:
     """ Convert a dict to a string without {} or quotes """
     data_string = ""
     for key, value in dictionary.items():
@@ -49,8 +49,8 @@ def _dict_to_string (dictionary: dict) -> str:
         data_string += f"{key} = {value}"
     return data_string
 
-def f_to_bytes (f_num: int, function_status: List[int]) -> Tuple[bytes, bytes]:
-    """ Convert a Fnumber (Loco function ID) to bytes
+def f_to_bytes (f_num: int, function_status: List[int]) -> Tuple[str, str]:
+    """ Convert a Fnumber (Loco function ID) to bytes as string representation
 
     Can be used to create correct format for loco_set_dfun
     Limited to range 0 to 28 - which is max for DFUN
@@ -61,7 +61,7 @@ def f_to_bytes (f_num: int, function_status: List[int]) -> Tuple[bytes, bytes]:
         function_status: List with value of all functions (must be updated before calling)
         
     Returns:
-        Tuple of two bytes
+        Tuple of two x 2-characer strings representing the bytes
         
     Raises: ValueError
 
@@ -117,7 +117,11 @@ def f_to_bytes (f_num: int, function_status: List[int]) -> Tuple[bytes, bytes]:
                  0b1000000 * function_list[27] +
                  0b10000000 * function_list[28]
                  )
-    return (byte1, byte2)
+    # convert to strings before returning
+    # and with 0xFF guarentees it doesn't overflow (although not really neccessary for this method)
+    str1 = f"{ (byte1 & 0xFF) :02x}"
+    str2 = f"{ (byte2 & 0xFF) :02x}"
+    return (str1, str2)
 
 
 # Where 2 bytes convert to addr id
@@ -148,3 +152,29 @@ def bytes_to_hexstr (byte1: bytes, byte2: bytes) -> str:
     """
     return f"{hex(byte1).upper()[2:]:0>2}{hex(byte2).upper()[2:]:0>2}"
     
+
+def bytes_to_functions (fn1: bytes, fn2: bytes, fn3: bytes) -> List[int]:
+    """ Sets the value of the functions from a PLOC message
+    Only returns values for F0 to F12 (others not included in PLOC)
+    Provides as a list for inclusion in menus etc.
+    
+    Args:
+        fn1: Function byte F0 to F4 - bit 5 = dir lighting (F0), bit 6 = direction, bit 7 = res, bit 8 = 0
+        fn2: Function byte F5 to F8 - bit 5 upwards reserved
+        fn3: Function byte F9 to F12
+        
+    Returns:
+        List of function values as 0 or 1 for each function as off and on
+    
+    """    
+    data_in = [fn1, fn2, fn3]
+    mask = [0b0001, 0b0010, 0b0100, 0b1000]
+    function_status = [0] * 29
+    # Handle 0 separately as it's in the upper nibble
+    function_status[0] = data_in[0] & 0b10000
+    # Create a list of 12 entries
+    for i in range (0, 3):
+        for j in range (0, 4):
+            function_status[(i*4)+j+1] = 1 if (data_in[i] & mask[j]) > 0 else 0
+            
+    return function_status

{pyvlcb-0.1.2 → pyvlcb-0.1.3}/src/pyvlcb/vlcbformat.py

@@ -1,6 +1,6 @@
 import logging
 import warnings
-from .utils import bytes_to_addr
+from .utils import bytes_to_addr, bytes_to_functions
 from typing import List, Optional, Union, Dict, Any
 
 # Set up a null handler so nothing prints by default unless the user enables it
@@ -108,6 +108,29 @@ class VLCBFormat :
         else:
             raise InvalidLocoError(f"Opcode {self.opcode()} does not contain a loco_id")
 
+    def get_function_list (self) -> List[int]:
+        """Where packet contains Fn1, Fn2, Fn3 (eg. PLOC)
+        returns 
+
+        Only valid with certain VLCBFormat packets associated with Locos.
+        If packet is does not contain the 3 byte values (which
+        may be formatted differently) then raises a InvalidFunctionError
+        
+        Returns:
+            List of function values as 0 or 1 for each function as off and on
+            
+        Raises:
+            InvalidFunctionError: If Function Bytes are not in the packet
+        """
+        if self.opcode() == "PLOC":
+            # Get data
+            data_dict = VLCBOpcode.parse_data(self.data)
+            return bytes_to_functions (data_dict['Fn1'], data_dict['Fn2'], data_dict['Fn3'])
+        else:
+            raise InvalidLocoError(f"Opcode {self.opcode()} does not contain a loco_id")
+
+
+
 
     def __str__ (self):
         return f'{self.priority} : {self.can_id} : {self.opcode()} ({self.data[0:2]}) : {self.data} / {self.format_data()}'