First commit

Author: kstaniek

.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9","3.10","3.11","3.12","3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install package + dev deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+
+      - name: Lint (ruff)
+        run: |
+          ruff --version
+          ruff check can_waveshare tests --output-format=github || true
+
+      - name: Run tests
+        run: pytest -q
+
+      - name: Verify entry point is discoverable
+        run: |
+          python - <<'PY'
+          import importlib.metadata as md, can
+          eps = md.entry_points().select(group='can.interface')
+          names = {ep.name for ep in eps}
+          assert 'waveshare' in names, names
+          cls = [ep for ep in eps if ep.name == 'waveshare'][0].load()
+          assert issubclass(cls, can.BusABC), cls
+          print("Entry point present and loadable:", cls)
+          PY
+
+
+      - name: Build sdist & wheel
+        run: |
+          python -m pip install --upgrade build
+          python -m build
+
+      - name: Check install from wheel
+        run: |
+          pip install --force-reinstall --no-deps dist/*.whl
+          python - <<'PY'
+          import importlib.metadata as md, can
+          eps = md.entry_points().select(group='can.interface')
+          assert any(ep.name=='waveshare' for ep in eps), eps
+          print("Installed wheel exposes entry point OK.")
+          PY
+

.gitignore

@@ -0,0 +1,68 @@
+# --- Python bytecode / caches ---
+__pycache__/
+*.py[cod]
+*$py.class
+.python-version
+
+# --- Build / packaging artifacts ---
+build/
+dist/
+*.egg-info/
+.eggs/
+pip-wheel-metadata/
+.wheelhouse/
+
+# --- Virtual environments ---
+.venv/
+venv/
+env/
+ENV/
+
+# --- Test / coverage ---
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.tox/
+.nox/
+
+# --- Type checking / lint caches ---
+.mypy_cache/
+.pytype/
+.ruff_cache/
+.pyright/
+.dmypy.json
+.pyre/
+
+# --- Logs ---
+*.log
+
+# --- Docs / sites (we keep docs/ markdown, ignore built site) ---
+site/
+docs/_build/
+
+# --- IDE / editor ---
+.vscode/
+.idea/
+*.code-workspace
+
+# --- OS cruft ---
+.DS_Store
+Thumbs.db
+
+# --- Editor swap files ---
+*.swp
+*.swo
+
+# --- Notebooks ---
+.ipynb_checkpoints/
+
+# --- Local env files / secrets ---
+.env
+.env.*
+*.env
+
+# --- Temporary scratch ---
+tmp/
+temp/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Klaudiusz Staniek
+
+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.

README.md

@@ -0,0 +1,69 @@
+# can-waveshare
+
+**python-can** backend for the **Waveshare 2-CH-CAN-TO-ETH** bridge that uses a fixed **13‑byte** TCP wire format.
+Works with `python -m can.viewer/logger/player` and plain `can.Bus(...)`.
+
+> Transport: TCP server on the device (e.g., `:20001` for CAN1, `:20002` for CAN2).  
+> Frames: 13 bytes: `[flags/dlc][id:4][data:0..8 padded]`
+
+## Install
+
+```bash
+pip install can-waveshare
+# or from source (editable):
+pip install -e .[dev]
+```
+
+## Use with CLI
+
+```bash
+# Most portable: pass channel as host:port
+python -m can.viewer -i waveshare -c 172.31.11.67:20001
+
+# Or forward kwargs directly to the bus:
+python -m can.viewer -i waveshare --bus-kwargs host=172.31.11.67 port=20001
+```
+
+### Config via `~/.canrc`
+
+The stock CLIs read only the **[default]** section. Put this in `~/.canrc`:
+
+```ini
+[default]
+interface = waveshare
+channel   = 172.31.11.67:20001
+```
+
+Then:
+
+```bash
+python -m can.viewer
+```
+
+If you want multiple profiles, either (a) swap rc files or (b) write a tiny launcher in code and use `Bus(config_context="waveshare2")` to select other sections.
+
+## Use in code
+
+```python
+import can
+
+# explicit kwargs:
+with can.Bus(interface="waveshare", host="172.31.11.67", port=20001) as bus:
+    bus.send(can.Message(arbitration_id=0x123, data=b"\x11\x22\x33", is_extended_id=False))
+    print(bus.recv(1.0))
+
+# or via channel (parses host:port, tcp://host:port, [ipv6]:port, or aliases can1/can2):
+with can.Bus(interface="waveshare", channel="172.31.11.67:20001") as bus:
+    print(bus.recv(1.0))
+```
+
+## Features & Notes
+
+- CAN 2.0 (0..8 data bytes). **CAN‑FD not supported** by Waveshare wire format.
+- Software filters (`can_filters`) supported in the backend.
+- Best‑effort own‑echo suppression when `receive_own_messages=False` (default). Set `True` to see echoes.
+- Periodic TX via `bus.send_periodic(...)` works (python-can broadcast manager calls `send()` repeatedly).
+
+## License
+
+MIT

can_waveshare/__init__.py

@@ -0,0 +1,3 @@
+from .bus import WaveShareBus as Bus, WaveShareBus
+
+__all__ = ["WaveShareBus", "Bus"]