A lightweight Python client that bridges TCP and CAN interfaces for OBD-II simulation via obdsim.net.
This client connects to a remote OBD-II simulation server and forwards traffic between a local CAN interface (e.g., vcan0
) and the simulator backend over TCP.
- ✅ Connects to
obdsim.net
TCP simulator - 🔁 Forwards CAN frames bidirectionally (CAN ↔ TCP)
- 🔌 Supports
socketcan
interfaces (vcan0
,can0
, etc.) - 📦 Easy installation via
pip
pip install git+https://github.com/obdsim-net/python-client.git
Or clone and install locally:
git clone https://github.com/obdsim-net/python-client.git
cd client-py
pip install .
python3 -m obdsim_client \
--config <your-config-id> \
--host port.obdsim.net \
--port 1337 \
--channel vcan0
Flag | Description | Default |
---|---|---|
--config |
Your simulator config ID | (required) |
--host |
Hostname of the TCP simulator | port.obdsim.net |
--port |
TCP port to connect to | 1337 |
--channel |
CAN interface name (e.g. vcan0 ) |
vcan0 |
Assuming vcan0
is set up and your config ID is abc123
:
python3 -m obdsim_client --config abc123 --channel vcan0
- 🔌 Make sure
vcan0
is created:
sudo modprobe vcan
sudo ip link add dev vcan0 type vcan
sudo ip link set up vcan0
- ❌ If the config is not found, the client will exit with an error.
MIT © obdsim.net contributors