gsusb-canfd 0.1.0__tar.gz

gsusb_canfd-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 gsusb-canfd contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gsusb_canfd-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: gsusb-canfd
+Version: 0.1.0
+Summary: Userspace gs_usb CAN FD driver and CLI (Python implementation)
+Author-email: sorrowfeng <1399600304@qq.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sorrowfeng/gsusb-canfd
+Project-URL: Repository, https://github.com/sorrowfeng/gsusb-canfd
+Project-URL: Issues, https://github.com/sorrowfeng/gsusb-canfd/issues
+Project-URL: Changelog, https://github.com/sorrowfeng/gsusb-canfd/blob/main/CHANGELOG.md
+Project-URL: Source (Python), https://github.com/sorrowfeng/gsusb-canfd/tree/main/python
+Keywords: can,can-fd,canfd,gs_usb,usb,libusb,pyusb
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyusb>=1.2.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# gsusb-canfd (Python)
+
+Part of the [gsusb-canfd](../README.md) project. Python implementation of the
+library: a userspace **gs_usb** CAN FD driver built directly on `pyusb`/`libusb`.
+It speaks the same wire protocol as the C++ library in this repository, so the two
+are interchangeable.
+
+It does **not** depend on the `gs_usb` / `python-can` packages. Those assume the
+candleLight reference endpoints (`OUT = 0x02`) and only configure classic CAN
+timing, so they cannot talk to adapters that use different bulk endpoints or
+CAN FD data-phase timing through `GS_USB_BREQ_BT_CONST_EXT` / `DATA_BITTIMING`.
+This package handles both.
+
+## Install
+
+```bash
+pip install ./python
+```
+
+Requires `libusb-1.0` at runtime (`brew install libusb`, `apt install libusb-1.0-0-dev`).
+
+## Use
+
+```python
+from gsusb_canfd import BusConfig, CanFdBus, CanFrame
+
+bus = CanFdBus()
+with bus:
+    bus.configure(BusConfig(bitrate=1_000_000, sample_point=0.80,
+                            data_bitrate=5_000_000, data_sample_point=0.75,
+                            fd=True))
+    bus.send(CanFrame(id=0x501, data=bytes([0x00, 0x02, 0x50, 0x01]),
+                      fd=True, brs=True))
+    while True:
+        frame = bus.receive(timeout=0.5)
+        if frame and not frame.echo and frame.id == 0x481:
+            print(frame)
+```
+
+Extended frames: set `id > 0x7FF` or `CanFrame(extended=True)`.
+
+Async receive (callback on a background thread):
+
+```python
+bus.start(lambda frame: print(frame))
+...
+bus.stop()
+```
+
+## Devices
+
+```python
+from gsusb_canfd import scan_adapters
+
+for i, adapter in enumerate(scan_adapters()):
+    print(i, adapter.name(), f"{adapter.vendor_id:04X}:{adapter.product_id:04X}",
+          adapter.serial)
+```
+
+Select one with a `DeviceSelector` (`vid`, `pid`, `index`, `channel`, `serial`,
+`product`). By default any gs_usb adapter is auto-discovered (known USB ids plus
+descriptor heuristics); pass explicit `vid`/`pid` to pin one. On devices with
+several CAN channels, `channel` selects which one (`bus.channel_count()` reports
+the count).
+
+## CLI
+
+```bash
+gsusb-canfd list
+
+gsusb-canfd monitor --bitrate 1000000 --sample-point 0.80 \
+                    --data-bitrate 5000000 --data-sample-point 0.75 \
+                    --trigger --trigger-id 501 --trigger-data 00025001 \
+                    --count 20
+
+gsusb-canfd send --classic 123 1122334455667788
+```
+
+## Tests
+
+The protocol logic (bit timing, DLC mapping, frame codec) is pure Python and is
+covered by unit tests that need no hardware:
+
+```bash
+pip install -e './python[dev]'
+pytest python/tests
+```
+
+## Releasing
+
+See [PUBLISHING.md](PUBLISHING.md); the version lives in
+[`src/gsusb_canfd/_version.py`](src/gsusb_canfd/_version.py).

gsusb_canfd-0.1.0/README.md

@@ -0,0 +1,92 @@
+# gsusb-canfd (Python)
+
+Part of the [gsusb-canfd](../README.md) project. Python implementation of the
+library: a userspace **gs_usb** CAN FD driver built directly on `pyusb`/`libusb`.
+It speaks the same wire protocol as the C++ library in this repository, so the two
+are interchangeable.
+
+It does **not** depend on the `gs_usb` / `python-can` packages. Those assume the
+candleLight reference endpoints (`OUT = 0x02`) and only configure classic CAN
+timing, so they cannot talk to adapters that use different bulk endpoints or
+CAN FD data-phase timing through `GS_USB_BREQ_BT_CONST_EXT` / `DATA_BITTIMING`.
+This package handles both.
+
+## Install
+
+```bash
+pip install ./python
+```
+
+Requires `libusb-1.0` at runtime (`brew install libusb`, `apt install libusb-1.0-0-dev`).
+
+## Use
+
+```python
+from gsusb_canfd import BusConfig, CanFdBus, CanFrame
+
+bus = CanFdBus()
+with bus:
+    bus.configure(BusConfig(bitrate=1_000_000, sample_point=0.80,
+                            data_bitrate=5_000_000, data_sample_point=0.75,
+                            fd=True))
+    bus.send(CanFrame(id=0x501, data=bytes([0x00, 0x02, 0x50, 0x01]),
+                      fd=True, brs=True))
+    while True:
+        frame = bus.receive(timeout=0.5)
+        if frame and not frame.echo and frame.id == 0x481:
+            print(frame)
+```
+
+Extended frames: set `id > 0x7FF` or `CanFrame(extended=True)`.
+
+Async receive (callback on a background thread):
+
+```python
+bus.start(lambda frame: print(frame))
+...
+bus.stop()
+```
+
+## Devices
+
+```python
+from gsusb_canfd import scan_adapters
+
+for i, adapter in enumerate(scan_adapters()):
+    print(i, adapter.name(), f"{adapter.vendor_id:04X}:{adapter.product_id:04X}",
+          adapter.serial)
+```
+
+Select one with a `DeviceSelector` (`vid`, `pid`, `index`, `channel`, `serial`,
+`product`). By default any gs_usb adapter is auto-discovered (known USB ids plus
+descriptor heuristics); pass explicit `vid`/`pid` to pin one. On devices with
+several CAN channels, `channel` selects which one (`bus.channel_count()` reports
+the count).
+
+## CLI
+
+```bash
+gsusb-canfd list
+
+gsusb-canfd monitor --bitrate 1000000 --sample-point 0.80 \
+                    --data-bitrate 5000000 --data-sample-point 0.75 \
+                    --trigger --trigger-id 501 --trigger-data 00025001 \
+                    --count 20
+
+gsusb-canfd send --classic 123 1122334455667788
+```
+
+## Tests
+
+The protocol logic (bit timing, DLC mapping, frame codec) is pure Python and is
+covered by unit tests that need no hardware:
+
+```bash
+pip install -e './python[dev]'
+pytest python/tests
+```
+
+## Releasing
+
+See [PUBLISHING.md](PUBLISHING.md); the version lives in
+[`src/gsusb_canfd/_version.py`](src/gsusb_canfd/_version.py).

gsusb_canfd-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gsusb-canfd"
+dynamic = ["version"]
+description = "Userspace gs_usb CAN FD driver and CLI (Python implementation)"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "sorrowfeng", email = "1399600304@qq.com" },
+]
+keywords = ["can", "can-fd", "canfd", "gs_usb", "usb", "libusb", "pyusb"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Hardware :: Hardware Drivers",
+]
+dependencies = [
+    "pyusb>=1.2.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7",
+]
+
+[project.urls]
+Homepage = "https://github.com/sorrowfeng/gsusb-canfd"
+Repository = "https://github.com/sorrowfeng/gsusb-canfd"
+Issues = "https://github.com/sorrowfeng/gsusb-canfd/issues"
+Changelog = "https://github.com/sorrowfeng/gsusb-canfd/blob/main/CHANGELOG.md"
+"Source (Python)" = "https://github.com/sorrowfeng/gsusb-canfd/tree/main/python"
+
+[project.scripts]
+gsusb-canfd = "gsusb_canfd.cli:main"
+
+[tool.setuptools.dynamic]
+version = { attr = "gsusb_canfd._version.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+gsusb_canfd = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

gsusb_canfd-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gsusb_canfd-0.1.0/src/gsusb_canfd/__init__.py

@@ -0,0 +1,50 @@
+"""Python implementation of the gsusb-canfd library.
+
+The wire protocol, bit timing and frame codec live in
+:mod:`gsusb_canfd.protocol`; :class:`~gsusb_canfd.bus.CanFdBus` speaks to the
+adapter through pyusb.
+"""
+
+from ._version import __version__
+from .bus import (
+    DEFAULT_PID,
+    DEFAULT_VID,
+    AdapterInfo,
+    BusConfig,
+    CanFdBus,
+    DeviceInfo,
+    DeviceSelector,
+    scan_adapters,
+)
+from .protocol import (
+    BitTiming,
+    BitTimingConst,
+    CanFdError,
+    CanFrame,
+    calculate_bit_timing,
+    decode_frame,
+    dlc_to_length,
+    encode_frame,
+    length_to_dlc,
+)
+
+__all__ = [
+    "AdapterInfo",
+    "BusConfig",
+    "BitTiming",
+    "BitTimingConst",
+    "CanFdBus",
+    "CanFdError",
+    "CanFrame",
+    "DEFAULT_PID",
+    "DEFAULT_VID",
+    "DeviceInfo",
+    "DeviceSelector",
+    "calculate_bit_timing",
+    "decode_frame",
+    "dlc_to_length",
+    "encode_frame",
+    "length_to_dlc",
+    "scan_adapters",
+    "__version__",
+]

gsusb_canfd-0.1.0/src/gsusb_canfd/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"