plin-linux 0.0.2__tar.gz → 0.0.4__tar.gz

{plin-linux-0.0.2 → plin_linux-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: plin-linux
-Version: 0.0.2
+Version: 0.0.4
 Summary: The python-plin package is a Python wrapper for the chardev API provided by the PEAK LIN Linux Beta.
 Author-email: William Zhang <williamzhang@rivian.com>
 Project-URL: Homepage, https://github.com/rivian/python-plin
@@ -11,9 +11,11 @@ Classifier: Operating System :: POSIX :: Linux
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: ioctl_opt
+Dynamic: license-file
 
 # Python PLIN library
-This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Beta. The PEAK Linux beta driver is required to use this library and is available [here](https://forum.peak-system.com/viewtopic.php?t=5875).
+This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Driver. The PEAK LIN Linux driver is required to use this library and is available [here](https://www.peak-system.com/fileadmin/media/linux/lin.php).
 
 ## Installation
 The `plin-linux` package is available on [PyPI](https://pypi.org/project/plin-linux/) and can be directly installed with `pip install plin-linux`.
@@ -23,7 +25,7 @@ Runnable examples are located in the `examples/` directory.
 
 ### Master Example
 ```python
-from plin.plin import PLIN
+from plin.device import PLIN
 from plin.enums import (PLINFrameChecksumType, PLINFrameDirection,
                         PLINFrameFlag, PLINMode)
 
@@ -74,7 +76,7 @@ while True:
 
 ### Slave Example
 ```python
-from plin.plin import PLIN
+from plin.device import PLIN
 from plin.enums import PLINMode
 
 # Initializes /dev/plin0 as a LIN slave
@@ -93,11 +95,13 @@ while True:
 ```
 
 ## Unit Tests
-Unit tests are located in the `unit_tests/` directory and require a PEAK LIN device connected to run.
+* Unit tests are located in the `unit_tests/` directory.
+* Tests in `unit_tests/integration/` require a PEAK LIN device connected to run.
+* Can be run with `pytest`.
 
 ## License
 
-    Copyright 2023 Rivian Automotive, Inc.
+    Copyright 2024 Rivian Automotive, Inc.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

{plin-linux-0.0.2 → plin_linux-0.0.4}/README.md

@@ -1,5 +1,5 @@
 # Python PLIN library
-This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Beta. The PEAK Linux beta driver is required to use this library and is available [here](https://forum.peak-system.com/viewtopic.php?t=5875).
+This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Driver. The PEAK LIN Linux driver is required to use this library and is available [here](https://www.peak-system.com/fileadmin/media/linux/lin.php).
 
 ## Installation
 The `plin-linux` package is available on [PyPI](https://pypi.org/project/plin-linux/) and can be directly installed with `pip install plin-linux`.
@@ -9,7 +9,7 @@ Runnable examples are located in the `examples/` directory.
 
 ### Master Example
 ```python
-from plin.plin import PLIN
+from plin.device import PLIN
 from plin.enums import (PLINFrameChecksumType, PLINFrameDirection,
                         PLINFrameFlag, PLINMode)
 
@@ -60,7 +60,7 @@ while True:
 
 ### Slave Example
 ```python
-from plin.plin import PLIN
+from plin.device import PLIN
 from plin.enums import PLINMode
 
 # Initializes /dev/plin0 as a LIN slave
@@ -79,11 +79,13 @@ while True:
 ```
 
 ## Unit Tests
-Unit tests are located in the `unit_tests/` directory and require a PEAK LIN device connected to run.
+* Unit tests are located in the `unit_tests/` directory.
+* Tests in `unit_tests/integration/` require a PEAK LIN device connected to run.
+* Can be run with `pytest`.
 
 ## License
 
-    Copyright 2023 Rivian Automotive, Inc.
+    Copyright 2024 Rivian Automotive, Inc.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

{plin-linux-0.0.2 → plin_linux-0.0.4}/plin/device.py

@@ -41,6 +41,10 @@ PLIOSETGETRSPMAP = IOWR(ord('u'), 39, PLINUSBResponseRemap)
 PLIOSETLEDSTATE = IOW(ord('u'), 40, PLINUSBLEDState)
 
 
+class PLINException(Exception):
+    pass
+
+
 class PLIN:
     def __init__(self, interface: str):
         self.interface = interface
@@ -72,12 +76,13 @@ class PLIN:
         self.mode = mode
         self.baudrate = baudrate
 
-        if not self.fd:
+        if self.fd:
+            raise PLINException("Already connected to PLIN device!")
+        else:
             self.fd = os.open(self.interface, os.O_RDWR)
-
-        self.reset()
-        buffer = PLINUSBInitHardware(self.baudrate, self.mode, 0)
-        self._ioctl(PLIOHWINIT, buffer)
+            self.reset()
+            buffer = PLINUSBInitHardware(self.baudrate, self.mode, 0)
+            self._ioctl(PLIOHWINIT, buffer)
 
     def stop(self):
         '''
@@ -85,6 +90,9 @@ class PLIN:
         '''
         if self.fd:
             os.close(self.fd)
+            self.fd = None
+        else:
+            raise PLINException("Not connected to PLIN device!")
 
     def set_frame_entry(self,
                         id: int,
@@ -99,10 +107,11 @@ class PLIN:
         IMPORTANT NOTE: For a publisher frame, the flag PLINFrameFlag.RSP_ENABLE must be set in order to allow a slave response.
         This flag is set by default if the frame direction is publisher for convenience.
         '''
-        buffer = PLINUSBFrameEntry(
-            id=id, direction=direction, checksum=checksum_type)
         if direction == PLINFrameDirection.PUBLISHER:
-            buffer.flags = flags & PLINFrameFlag.RSP_ENABLE
+            flags |= PLINFrameFlag.RSP_ENABLE
+
+        buffer = PLINUSBFrameEntry(
+            id=id, direction=direction, checksum=checksum_type, flags=flags)
         if data:
             buffer.d = data
         if len > 0:
@@ -505,23 +514,29 @@ class PLIN:
 
     def read(self, block=True) -> Union[PLINMessage, None]:
         '''
-        Reads a PLINMessage from the LIN bus with an optional timeout in milliseconds.
+        Reads the next PLINMessage the driver has queued.
 
-        A timeout value of 0 blocks until data is read. If the timeout is reached before data is read, None is returned.
+        Every record is returned as the device reported it, including frames whose data is all 0xFF:
+        that is what an unanswered header looks like (flags carry SLV_NOT_RSP / TIMEOUT), and it is
+        indistinguishable from a slave that answered with recessive bytes, so the caller must decide
+        from the flags, not the data. Non-FRAME records (SLEEP, WAKEUP, OVERRUN, ...) are returned
+        too; check message.type.
+
+        Returns None when a non-blocking read finds nothing queued.
         '''
         if self.fd:
             blocking = os.get_blocking(self.fd)
             os.set_blocking(self.fd, block)
             try:
                 result = os.read(self.fd, PLINMessage.buffer_length)
-                message = PLINMessage.from_buffer_copy(result)
-                # If bytes read was invalid.
-                if bytes(message.data) == PLIN_EMPTY_DATA:
-                    message = None
-            except:
-                message = None
-            os.set_blocking(self.fd, blocking)
-            return message
+            except BlockingIOError:
+                return None
+            finally:
+                os.set_blocking(self.fd, blocking)
+
+            if len(result) < PLINMessage.buffer_length:
+                return None
+            return PLINMessage.from_buffer_copy(result)
         else:
             raise Exception("PLIN not connected!")
 

{plin-linux-0.0.2 → plin_linux-0.0.4}/plin_linux.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: plin-linux
-Version: 0.0.2
+Version: 0.0.4
 Summary: The python-plin package is a Python wrapper for the chardev API provided by the PEAK LIN Linux Beta.
 Author-email: William Zhang <williamzhang@rivian.com>
 Project-URL: Homepage, https://github.com/rivian/python-plin
@@ -11,9 +11,11 @@ Classifier: Operating System :: POSIX :: Linux
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: ioctl_opt
+Dynamic: license-file
 
 # Python PLIN library
-This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Beta. The PEAK Linux beta driver is required to use this library and is available [here](https://forum.peak-system.com/viewtopic.php?t=5875).
+This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Driver. The PEAK LIN Linux driver is required to use this library and is available [here](https://www.peak-system.com/fileadmin/media/linux/lin.php).
 
 ## Installation
 The `plin-linux` package is available on [PyPI](https://pypi.org/project/plin-linux/) and can be directly installed with `pip install plin-linux`.
@@ -23,7 +25,7 @@ Runnable examples are located in the `examples/` directory.
 
 ### Master Example
 ```python
-from plin.plin import PLIN
+from plin.device import PLIN
 from plin.enums import (PLINFrameChecksumType, PLINFrameDirection,
                         PLINFrameFlag, PLINMode)
 
@@ -74,7 +76,7 @@ while True:
 
 ### Slave Example
 ```python
-from plin.plin import PLIN
+from plin.device import PLIN
 from plin.enums import PLINMode
 
 # Initializes /dev/plin0 as a LIN slave
@@ -93,11 +95,13 @@ while True:
 ```
 
 ## Unit Tests
-Unit tests are located in the `unit_tests/` directory and require a PEAK LIN device connected to run.
+* Unit tests are located in the `unit_tests/` directory.
+* Tests in `unit_tests/integration/` require a PEAK LIN device connected to run.
+* Can be run with `pytest`.
 
 ## License
 
-    Copyright 2023 Rivian Automotive, Inc.
+    Copyright 2024 Rivian Automotive, Inc.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

{plin-linux-0.0.2 → plin_linux-0.0.4}/plin_linux.egg-info/SOURCES.txt

@@ -9,6 +9,4 @@ plin_linux.egg-info/PKG-INFO
 plin_linux.egg-info/SOURCES.txt
 plin_linux.egg-info/dependency_links.txt
 plin_linux.egg-info/requires.txt
-plin_linux.egg-info/top_level.txt
-tests/test_message.py
-tests/test_plin.py
+plin_linux.egg-info/top_level.txt

{plin-linux-0.0.2 → plin_linux-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "plin-linux"
-version = "0.0.2"
+version = "0.0.4"
 authors = [
   { name="William Zhang", email="williamzhang@rivian.com" },
 ]

plin-linux-0.0.2/tests/test_message.py

@@ -1,10 +0,0 @@
-import pytest
-from plin.structs import PLINMessage
-
-@pytest.fixture
-def test_message():
-    return PLINMessage()
-
-def test_set_message_data(test_message):
-    test_message.data = bytearray([0xff])
-    assert bytearray(test_message.data) == bytearray([0xff] + [0] * 7)

plin-linux-0.0.2/tests/test_plin.py

@@ -1,146 +0,0 @@
-import pytest
-from plin.device import PLIN
-from plin.enums import PLINMode, PLINMessageType, PLINFrameDirection, PLINFrameChecksumType
-from plin.structs import *
-
-@pytest.fixture
-def plin_interface():
-    return "/dev/plin0"
-
-
-@pytest.fixture
-def plin(plin_interface):
-    return PLIN(plin_interface)
-
-
-@pytest.fixture
-def plin_slave_1000(plin):
-    plin.start(mode=PLINMode.SLAVE, baudrate=1000)
-    yield plin
-    plin.stop()
-
-
-@pytest.fixture
-def plin_master_19200(plin):
-    plin.start(mode=PLINMode.MASTER, baudrate=19200)
-    yield plin
-    plin.stop()
-
-
-@pytest.fixture
-def master_request_frame():
-    return PLINMessage(type=PLINMessageType.FRAME,
-                       id=0x3c,
-                       len=8,
-                       dir=PLINFrameDirection.PUBLISHER,
-                       cs_type=PLINFrameChecksumType.CLASSIC,
-                       data=bytearray([0x7f, 0x6, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff]))
-
-
-def test_start(plin_interface, plin):
-    expected_baudrate = 1000
-    expected_mode = PLINMode.SLAVE
-
-    plin.start(mode=expected_mode, baudrate=expected_baudrate)
-    assert plin.get_baudrate() == expected_baudrate
-    assert plin.get_mode() == expected_mode
-    plin.stop()
-
-
-def test_read_nonblocking(plin_master_19200):
-    assert None == plin_master_19200.read(block=False)
-
-
-def test_write_master_request_frame(plin_master_19200, master_request_frame):
-    plin_master_19200.write(master_request_frame)
-
-
-def test_reset(plin_slave_1000):
-    expected_baudrate = 0
-    expected_mode = PLINMode.NONE
-
-    plin_slave_1000.reset()
-    assert plin_slave_1000.get_baudrate() == expected_baudrate
-    assert plin_slave_1000.get_mode() == expected_mode
-
-
-def test_set_id_filter(plin_slave_1000):
-    expected_id_filter = bytearray([0xff] * 8)
-
-    plin_slave_1000.set_id_filter(expected_id_filter)
-    assert plin_slave_1000.get_id_filter() == expected_id_filter
-
-
-def test_block_id(plin_slave_1000):
-    expected_id_filter = bytearray([0xf0] + [0xff] * 7)
-
-    plin_slave_1000.set_id_filter(bytearray([0xff] * 8))
-    plin_slave_1000.block_id(0)
-    plin_slave_1000.block_id(1)
-    plin_slave_1000.block_id(2)
-    plin_slave_1000.block_id(3)
-    assert plin_slave_1000.get_id_filter() == expected_id_filter
-
-
-def test_register_id(plin_slave_1000):
-    expected_id_filter = bytearray([0x0f] + [0x0] * 7)
-
-    plin_slave_1000.set_id_filter(bytearray([0x0] * 8))
-    plin_slave_1000.register_id(0)
-    plin_slave_1000.register_id(1)
-    plin_slave_1000.register_id(2)
-    plin_slave_1000.register_id(3)
-    print(plin_slave_1000.get_id_filter())
-    assert plin_slave_1000.get_id_filter() == expected_id_filter
-
-
-def test_clear_id_filter_allow_all(plin_slave_1000):
-    expected_id_filter = bytearray([0xff] * 8)
-
-    plin_slave_1000.clear_id_filter(allow_all=True)
-    assert plin_slave_1000.get_id_filter() == expected_id_filter
-
-
-def test_clear_id_filter_block_all(plin_slave_1000):
-    expected_id_filter = bytearray([0x0] * 8)
-
-    plin_slave_1000.clear_id_filter(allow_all=False)
-    assert plin_slave_1000.get_id_filter() == expected_id_filter
-
-
-def test_set_id_string(plin_slave_1000):
-    expected_id_string = "test ID"
-
-    plin_slave_1000.set_id_string(expected_id_string)
-    assert plin_slave_1000.get_id_string() == expected_id_string
-
-
-def test_identify(plin_slave_1000):
-    plin_slave_1000.identify()
-
-
-def test_get_firmware_version(plin_slave_1000):
-    expected_num_subversions = 3
-
-    version = plin_slave_1000.get_firmware_version()
-    assert len(version.split('.')) == expected_num_subversions
-
-
-def test_get_status(plin_slave_1000):
-    expected_baudrate = 1000
-    expected_mode = PLINMode.SLAVE
-
-    status = plin_slave_1000.get_status()
-    assert status["mode"] == expected_mode
-    assert status["baudrate"] == expected_baudrate
-
-
-def test_set_response_remap(plin_slave_1000):
-    expected_remap = {1: 2}
-    plin_slave_1000.set_response_remap(expected_remap)
-    assert plin_slave_1000.response_remap[1] == 2
-    assert plin_slave_1000.get_response_remap() == expected_remap
-
-
-def test_set_led_state(plin_slave_1000):
-    plin_slave_1000.set_led_state(enable=True)