py-obdii 0.8.0b0

A Python library for interacting with OBDII.

A modern, easy to use, Python ≥3.8 library for interacting with OBDII devices.

Installing

Python 3.8 or higher is required.

A Virtual Environment is recommended.

Create a virtual environment

Linux/macOS

python3 -m venv .venv
source .venv/bin/activate

Windows

py -3 -m venv .venv
.venv\Scripts\activate

Install from PyPI

pip install py-obdii

Install the development version

From Github:

pip install git+https://github.com/PaulMarisOUMary/OBDII@main[dev]

From local source:

git clone https://github.com/PaulMarisOUMary/OBDII
cd OBDII
pip install .[dev]

From TestPyPI:

pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple py-obdii[dev]

Usage Example

Important

This library is still in the design phase and may change in the future.

from obdii import at_commands, commands, Connection

conn = Connection("COM5")

version = conn.query(at_commands.VERSION_ID)
print(f"Version: {version.value}")

response = conn.query(commands.VEHICLE_SPEED)
print(f"Vehicle Speed: {response.value} {response.units}")

conn.close()

You can find more detailed examples and usage scenarios in the examples folder of this repository.

Emulator Support

To streamline the development process, you can use the ELM327-Emulator library. This allows you to simulate an OBDII connection on your machine without needing a physical OBDII device.

Setting Up the ELM327-Emulator

1. Install the library with “sim” extra options:

   pip install py-obdii[sim]

2. Start the ELM327-Emulator:

   python -m elm -p "REPLACE_WITH_PORT" -s car --baudrate 38400

   Note

   Replace REPLACE_WITH_PORT with the serial port of your choice

Use Virtual Ports on Windows

Windows users, can use com0com to create virtual serial ports and connect the ELM327-Emulator to your Python code.

1. Install com0com and create two virtual serial ports, (e.g. COM5 and COM6).

2. In the ELM327-Emulator, set the port to COM6.

3. In your Python code, set the connection port to COM5.

Support & Contact

For questions start a discussion on Github, for support open an issue. Your feedback and questions are greatly appreciated and will help improve this project !

• Open an Issue

• Join the Discussion

---

Thank you for using or contributing to this project. Follow our updates by leaving a star to this repository !