8000 GitHub - obdsim-net/python-client: A lightweight Python client that bridges TCP and CAN interfaces for OBD-II simulation via obdsim.net
[go: up one dir, main page]

Skip to content

A lightweight Python client that bridges TCP and CAN interfaces for OBD-II simulation via obdsim.net

License

Notifications You must be signed in to change notification settings

obdsim-net/python-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

client-py

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.


Features

  • ✅ Connects to obdsim.net TCP simulator
  • 🔁 Forwards CAN frames bidirectionally (CAN ↔ TCP)
  • 🔌 Supports socketcan interfaces (vcan0, can0, etc.)
  • 📦 Easy installation via pip

Installation

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 .

Usage

python3 -m obdsim_client \
  --config <your-config-id> \
  --host port.obdsim.net \
  --port 1337 \
  --channel vcan0

Parameters

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

Example

Assuming vcan0 is set up and your config ID is abc123:

python3 -m obdsim_client --config abc123 --channel vcan0

Troubleshooting

  • 🔌 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.

License

MIT © obdsim.net contributors

About

A lightweight Python client that bridges TCP and CAN interfaces for OBD-II simulation via obdsim.net

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

0