python-can-cansub 2026.5.22__tar.gz → 2026.5.28__tar.gz

{python_can_cansub-2026.5.22 → python_can_cansub-2026.5.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-can-cansub
-Version: 2026.5.22
+Version: 2026.5.28
 Summary: CANsub python-can interface
 Project-URL: Homepage, https://csselectronics.com/
 Project-URL: Source, https://github.com/CSS-Electronics/python-can-cansub
@@ -72,8 +72,8 @@ Example of using `detect_available_configs` to automatically discover (uses mDNS
 ```python
 configs = can.detect_available_configs(interfaces=["cansub"])
 # e.g. [{"interface": "cansub", "channel": "aabbccdd-usb.local@1"},
-#       {"interface": "cansub", "channel": "aabbccdd-usb.local@2"}
-#       {"interface": "cansub", "channel": "11223344-eth.local@1"}
+#       {"interface": "cansub", "channel": "aabbccdd-usb.local@2"},
+#       {"interface": "cansub", "channel": "11223344-eth.local@1"},
 #       {"interface": "cansub", "channel": "11223344-eth.local@2"}]
 ```
 
@@ -145,16 +145,13 @@ with can.Bus(**configs[0], bitrate=250_000, data_bitrate=1_000_000, can_filters=
 
 `bus.recv()` blocks until a frame arrives. A `can.Notifier` runs a background thread that dispatches received frames to one or more *listeners*, allowing the main program to continue other work.
 
-python-can provides built-in listeners including `can.Printer` (print to stdout) and `can.Logger` (log to file). The example below logs to a CSV file while the main program continues. Custom listeners can be implemented by subclassing `can.Listener`.
+python-can provides built-in listeners including `can.Printer` (print to stdout) and `can.Logger` (log to file). The example below prints to stdout and logs to a CSV file while the main program continues. Custom listeners can be implemented by subclassing `can.Listener`.
 
 ```python
 from time import sleep
 
-print_listener = can.Printer()
-csv_listener = can.Logger("log.csv")
-
 with can.Bus(**configs[0], bitrate=250_000, data_bitrate=1_000_000) as bus:
-    with can.Notifier([bus], listeners=[print_listener, csv_listener]):
+    with can.Notifier([bus], listeners=[can.Printer(), can.Logger("log.csv")]):
 
         # Perform other tasks here while frames are received in the background
         sleep(10)
@@ -205,12 +202,14 @@ The common argument pattern for the CANsub:
 --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000
 ```
 
+Note that the *filter* argument supported by some command-line tools is limited to standard (11-bit) CAN IDs. Filtering on extended (29-bit) IDs requires the python-can API.
+
 ### can_logger
 
-Log received frames to a file (CSV by default; format inferred from file extension):
+Log received frames to a file (format inferred from file extension):
 
 ```bash
-can_logger --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000 --output-file log.csv
+can_logger --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000 --file_name log.csv
 ```
 
 ### can_player
@@ -229,13 +228,15 @@ Live terminal viewer showing received frames, updated counts, timestamps, and by
 can_viewer --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000
 ```
 
+On Windows, the can_viewer requires `windows-curses` (`pip install windows-curses`).
+
 ### can_bridge
 
 Forward all frames received on one bus to another (e.g. bridge two CANsub channels):
 
 ```bash
-can_bridge --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000 \
-           --interface2 cansub --channel2 aabbccdd-usb.local@2 --bitrate2 250000 --data-bitrate2 1000000
+can_bridge --bus1-interface cansub --bus1-channel aabbccdd-usb.local@1 --bus1-bitrate 250000 --bus1-data-bitrate 1000000 \
+           --bus2-interface cansub --bus2-channel aabbccdd-usb.local@2 --bus2-bitrate 250000 --bus2-data-bitrate 1000000
 ```
 
 ### can_logconvert

{python_can_cansub-2026.5.22 → python_can_cansub-2026.5.28}/README.md

@@ -53,8 +53,8 @@ Example of using `detect_available_configs` to automatically discover (uses mDNS
 ```python
 configs = can.detect_available_configs(interfaces=["cansub"])
 # e.g. [{"interface": "cansub", "channel": "aabbccdd-usb.local@1"},
-#       {"interface": "cansub", "channel": "aabbccdd-usb.local@2"}
-#       {"interface": "cansub", "channel": "11223344-eth.local@1"}
+#       {"interface": "cansub", "channel": "aabbccdd-usb.local@2"},
+#       {"interface": "cansub", "channel": "11223344-eth.local@1"},
 #       {"interface": "cansub", "channel": "11223344-eth.local@2"}]
 ```
 
@@ -126,16 +126,13 @@ with can.Bus(**configs[0], bitrate=250_000, data_bitrate=1_000_000, can_filters=
 
 `bus.recv()` blocks until a frame arrives. A `can.Notifier` runs a background thread that dispatches received frames to one or more *listeners*, allowing the main program to continue other work.
 
-python-can provides built-in listeners including `can.Printer` (print to stdout) and `can.Logger` (log to file). The example below logs to a CSV file while the main program continues. Custom listeners can be implemented by subclassing `can.Listener`.
+python-can provides built-in listeners including `can.Printer` (print to stdout) and `can.Logger` (log to file). The example below prints to stdout and logs to a CSV file while the main program continues. Custom listeners can be implemented by subclassing `can.Listener`.
 
 ```python
 from time import sleep
 
-print_listener = can.Printer()
-csv_listener = can.Logger("log.csv")
-
 with can.Bus(**configs[0], bitrate=250_000, data_bitrate=1_000_000) as bus:
-    with can.Notifier([bus], listeners=[print_listener, csv_listener]):
+    with can.Notifier([bus], listeners=[can.Printer(), can.Logger("log.csv")]):
 
         # Perform other tasks here while frames are received in the background
         sleep(10)
@@ -186,12 +183,14 @@ The common argument pattern for the CANsub:
 --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000
 ```
 
+Note that the *filter* argument supported by some command-line tools is limited to standard (11-bit) CAN IDs. Filtering on extended (29-bit) IDs requires the python-can API.
+
 ### can_logger
 
-Log received frames to a file (CSV by default; format inferred from file extension):
+Log received frames to a file (format inferred from file extension):
 
 ```bash
-can_logger --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000 --output-file log.csv
+can_logger --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000 --file_name log.csv
 ```
 
 ### can_player
@@ -210,13 +209,15 @@ Live terminal viewer showing received frames, updated counts, timestamps, and by
 can_viewer --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000
 ```
 
+On Windows, the can_viewer requires `windows-curses` (`pip install windows-curses`).
+
 ### can_bridge
 
 Forward all frames received on one bus to another (e.g. bridge two CANsub channels):
 
 ```bash
-can_bridge --interface cansub --channel aabbccdd-usb.local@1 --bitrate 250000 --data-bitrate 1000000 \
-           --interface2 cansub --channel2 aabbccdd-usb.local@2 --bitrate2 250000 --data-bitrate2 1000000
+can_bridge --bus1-interface cansub --bus1-channel aabbccdd-usb.local@1 --bus1-bitrate 250000 --bus1-data-bitrate 1000000 \
+           --bus2-interface cansub --bus2-channel aabbccdd-usb.local@2 --bus2-bitrate 250000 --bus2-data-bitrate 1000000
 ```
 
 ### can_logconvert

{python_can_cansub-2026.5.22 → python_can_cansub-2026.5.28}/private_repo/README_REPO.md

@@ -2,6 +2,8 @@
 
 This project uses a **private repository for development** and a **public repository for cleaned releases**.
 
+The private repository is hosted on Bitbucket while the public repository is hosted on GitHub (https://github.com/CSS-Electronics/python-can-cansub).
+
 ## Branches
 
 ### `master`
@@ -50,7 +52,7 @@ The public repository remote is not kept configured permanently.
 Push only when intentionally publishing:
 
 ```bash
-git push git@github.com:YOUR_USER/YOUR_PUBLIC_REPO.git public-master:master
+git push git@github.com:CSS-Electronics/python-can-cansub.git public-master:master
 ```
 
 This pushes:

{python_can_cansub-2026.5.22 → python_can_cansub-2026.5.28}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-can-cansub"
-version = "2026.05.22"
+version = "2026.05.28"
 authors = [
     { name="CSS Electronics" },
     { email="contact@csselectronics.com" },

{python_can_cansub-2026.5.22 → python_can_cansub-2026.5.28}/src/python_can_cansub/cansub.py

@@ -132,7 +132,7 @@ class CanSub(can.BusABC):
         del error_frames
 
         # Set channel info (required by python-can)
-        self.channel_info = f"CANSUB{self.channel}"
+        self.channel_info = f"{address}@{self.channel}"
 
         # Path to device root certificate
         self.cansub_cert = str(Path(__file__).with_name("cansub_root_cert.crt"))
@@ -453,9 +453,6 @@ class CanSub(can.BusABC):
         if timeout is not None and timeout < 0:
             raise can.exceptions.CanOperationError("Invalid timeout value")
 
-        if not (msg.channel is None or msg.channel == self.channel):
-            raise can.exceptions.CanOperationError("Invalid channel")
-
         try:
             if timeout is None:
                 # Wait indefinitely for queue space
@@ -474,7 +471,7 @@ class CanSub(can.BusABC):
         """
         See "recv" and "_recv_internal" in can.BusABC
 
-        Always return that message has already been filtered.
+        Always return that the message has already been filtered.
         """
         if timeout is not None and timeout < 0:
             raise can.exceptions.CanOperationError("Invalid timeout value")
@@ -531,9 +528,6 @@ class CanSub(can.BusABC):
         self.can_send_queue.queue.clear()
 
     def _apply_filters(self, filters: Optional[can.typechecking.CanFilters]) -> None:
-        """
-        NOTE: This python-can function does not take channel information (applies provided filters to all channels)
-        """
 
         # Python-can specify that all messages should be accepted if filters are None or empty list
         if filters is None or len(filters) == 0:
@@ -542,13 +536,13 @@ class CanSub(can.BusABC):
                 can.typechecking.CanFilter(extended=True,  can_id=0, can_mask=0)   # Accept all ext messages
             ]
 
-        # Change to CanSubHwFilter type
-        can_hw_filters = [CanSubHwFilter(is_extended=x["extended"],
+        # Change to CanSubHwFilter type. When "extended" field not provided, default to False (required by cmd-tools)
+        can_hw_filters = [CanSubHwFilter(is_extended=x.get("extended", False),
                                          is_range=False,
                                          f1=x["can_id"],
                                          f2=x["can_mask"]) for x in filters]
 
-        # Apply filters to all channels
+        # Apply hardware filter
         self.set_hw_filters(can_hw_filters)
 
     def set_hw_filters(self, can_hw_filters: Optional[CanSubHwFilters]) -> None: