Skip to main content

python-can-hub

Native python-can backend for can-hub: consume remote CAN interfaces exported by can-hub agents, directly over the binary protocol — unix socket, plain TCP, TLS or QUIC, with mTLS identity and TOFU pinning on the encrypted transports. No bridge process in between.

import can

bus = can.Bus(
    interface="canhub",
    channel="truck42/can0",
    url="quic://hub.example.com:7227",
)
bus.send(can.Message(arbitration_id=0x123, data=b"\xDE\xAD\xBE\xEF"))
for message in bus:
    print(message)
  • channel: namespaced interface agent/iface (or the numeric id from can-hub-client list).
  • url: omit to connect to the local hub unix socket.
  • state_dir: client TLS identity + pin store location (tls/quic).
  • receive_own_messages: standard python-can echo semantics.
  • reliable: carry the channel on a dedicated reliable QUIC stream (lossless, ordered) instead of the lossy datagram plane. Needs a quic:// url and a hub that advertises the capability; otherwise the open fails.
  • ignore_rx_error_frames: drop the controller error frames (is_error_frame), received by default as on python-can's socketcan interface.

Received messages are canhub.CanHubMessage, a can.Message with one more attribute: bridged is true when the hub injected the frame into this bus along a bridge route or group.

Write access follows the hub client ACLs: if the ACL grants read-only, the bus opens read-only and send() raises.

The bus is thread-safe: a can.Notifier receiving in its thread while other threads call send() is supported. Calls into the native session are serialised first come, first served, and a blocking receive gives way to a waiting send within about 10 ms.

Drop counters

Two drops happen inside the library and never reach the hub, so the hub's own counters cannot show them: send() raises when the pace relayed by the hub leaves no budget for the frame, and the receive ring overwrites its oldest entry when you read slower than the bus produces. drop_counters() returns both as monotonic totals, so a quiet bus is distinguishable from a lossy one:

bus.drop_counters()     # {"rate_limited": 0, "ring_dropped": 12}

Configuring the interface

configure() reconfigures the bus's interface on its agent, everything in one step, with the keywords of ip link set ... type can; interface_settings() reads it back. The bus must be opened by its agent/iface name, and the hub allows it only with an rwa ACL grant (unix and plain tcp clients are trusted).

bus.configure(bitrate=500000, sample_point=0.875, fd=True, data_bitrate=2000000)
bus.configure(restart_ms=100, txqueuelen=1000, termination=120, listen_only=False, up=True)
from canhub import BitTiming
bus.configure(bit_timing=BitTiming(tq=125, prop_seg=6, phase_seg1=7, phase_seg2=2, sjw=1))
bus.interface_settings()
# InterfaceSettings(up=True, state='error-active', bitrate=500000, sample_point=0.875, ...)

Both return an InterfaceSettings with None where the device reports nothing (a vcan has no bit timing). A refusal raises CanOperationError with the reason.

Listing interfaces

CanHubBus.list_interfaces() asks a hub for the interfaces it exports. Each entry is a python-can config dict you can splat straight into can.Bus:

from canhub import CanHubBus
import can

for config in CanHubBus.list_interfaces(url="quic://hub.example.com:7227"):
    print(config["channel"])          # e.g. "can-agent/can0"
bus = can.Bus(**CanHubBus.list_interfaces()[0])   # first interface, local hub

It accepts the same connection arguments as the bus (url, identity_cert, identity_key, hub_fingerprint, state_dir); omit url to query the local hub unix socket.

This also wires python-can's discovery: can.detect_available_configs("canhub") returns the same dicts. With no explicit target it reads the connection from the environment — CANHUB_URL, CANHUB_STATE_DIR, CANHUB_IDENTITY_CERT, CANHUB_IDENTITY_KEY, CANHUB_HUB_FINGERPRINT — falling back to the local hub unix socket. So CANHUB_URL=quic://hub.example.com:7227 points discovery at a remote host without any code.

The wheel bundles libcanhub.so with the TLS/QUIC stack linked in statically; the only runtime dependency is glibc.

Testing

The unit tests stub the native library, so they run without a build:

pip install -e python/.[test]
pytest python/tests

The backend is also exercised end-to-end against real binaries (recv, send, list_interfaces, and can.detect_available_configs discovery) by test/e2e/tests/python_can.robot; run the whole bench with make e2e.

Building from source

./scripts/build-python-wheel.sh        # host arch, glibc-tagged (local dev)
pip install python/dist/*.whl

Distributable manylinux wheels are built per architecture in a manylinux container and repaired by auditwheel (needs docker, plus QEMU binfmt for the cross arches):

./scripts/build-python-wheel.sh x86_64   # python/dist/x86_64/*.whl
./scripts/build-python-wheel.sh aarch64
./scripts/build-python-wheel.sh armv7l

The release workflow builds these three on native runners (aarch64/armv7l on the arm64 hosted runner, no QEMU) plus a cross-compiled win_amd64 wheel, and publishes all four to PyPI on a v* tag.

Metadata

Release files for python-can-hub 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for python-can-hub 0.5.0
File Actions
python_can_hub-0.5.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for python_can_hub-0.5.0-py3-none-win_amd64.whl
python_can_hub-0.5.0-py3-none-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl Python 3 none Linux glibc 2.28+ x86-64, Linux glibc 2.26+ x86-64 Details for python_can_hub-0.5.0-py3-none-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
python_can_hub-0.5.0-py3-none-manylinux_2_26_armv7l.manylinux_2_31_armv7l.whl Python 3 none Linux glibc 2.26+ ARMv7l, Linux glibc 2.31+ ARMv7l Details for python_can_hub-0.5.0-py3-none-manylinux_2_26_armv7l.manylinux_2_31_armv7l.whl
python_can_hub-0.5.0-py3-none-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl Python 3 none Linux glibc 2.28+ ARM64, Linux glibc 2.26+ ARM64 Details for python_can_hub-0.5.0-py3-none-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Total release size: 3.1 MB

Release files / python_can_hub-0.5.0-py3-none-win_amd64.whl

Download URL python_can_hub-0.5.0-py3-none-win_amd64.whl
Size 714.1 kB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
9d26e5474ccef536ec312404d4bf4c7257157e12859fc62c48545d347343b6bd
BLAKE2b-256 checksum
How to use checksums
f99c3093e0cecc58d6aa5054ab4af8dd6c23cb8dc4d72f58652cb55b864b3dd3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / python_can_hub-0.5.0-py3-none-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl

Download URL python_can_hub-0.5.0-py3-none-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
Size 921.9 kB
Tags Linux glibc 2.26+ x86-64 Linux glibc 2.28+ x86-64 Python 3
SHA-256 checksum
How to use checksums
478ea3e42bdcfc71d8d7fcc2f149b148f37117c53dea431349cc1a3ffd1b569c
BLAKE2b-256 checksum
How to use checksums
9808c04640cf99a6cc5b2403f5baa825bab3aa37ee6ebe669e06d1696b59a286
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / python_can_hub-0.5.0-py3-none-manylinux_2_26_armv7l.manylinux_2_31_armv7l.whl

Download URL python_can_hub-0.5.0-py3-none-manylinux_2_26_armv7l.manylinux_2_31_armv7l.whl
Size 748.6 kB
Tags Linux glibc 2.26+ ARMv7l Linux glibc 2.31+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
16b61f35f321e521248b7807a994fad2013a0ae7d5ae625a63bd3c0b6a87e06b
BLAKE2b-256 checksum
How to use checksums
9be3841fa02a9bcfc561115497388f5f1b9885c60973c246beef77b0fac60630
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / python_can_hub-0.5.0-py3-none-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL python_can_hub-0.5.0-py3-none-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 737.4 kB
Tags Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 Python 3
SHA-256 checksum
How to use checksums
688ee7324893611125e0463e750d1357661742c28c963e19ec5e0ecda595131b
BLAKE2b-256 checksum
How to use checksums
37d3dd9520d7755c831ddea00b01f9085d8f7b0d6fdd9ee86b5799fbd4ee44b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for python-can-hub 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 4 files in this release have been uploaded with provenance metadata.

Select from 4 files

Attestation for python_can_hub-0.5.0-py3-none-win_amd64.whl

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page