Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rakshitbharat/elm327-emulator-web-api

A modern web API interface for automotive diagnostics, wrapping the ELM327-emulator project with RESTful capabilities.
https://github.com/rakshitbharat/elm327-emulator-web-api

emulator obd2 simulator web

Last synced: 1 day ago
JSON representation

A modern web API interface for automotive diagnostics, wrapping the ELM327-emulator project with RESTful capabilities.

Host: GitHub
URL: https://github.com/rakshitbharat/elm327-emulator-web-api
Owner: rakshitbharat
Created: 2025-02-06T14:20:03.000Z (8 days ago)
Default Branch: main
Last Pushed: 2025-02-06T14:24:01.000Z (8 days ago)
Last Synced: 2025-02-06T15:32:27.065Z (8 days ago)
Topics: emulator, obd2, simulator, web
Language: Python
Homepage:
Size: 2.93 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # ELM327 Emulator Web API 🔧🌐

[![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)](https://fastapi.tiangolo.com/)

[![Python](https://img.shields.io/badge/Python-3.9+-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)

A modern web API interface for automotive diagnostics, wrapping the [ELM327-emulator](https://github.com/Ircama/ELM327-emulator) project with RESTful capabilities.

```mermaid

graph LR

    A[Client] -->|HTTP Request| B(FastAPI Server)

    B -->|Process Command| C{ELM327 Emulator}

    C -->|Response| B

    B -->|JSON Response| A

```

## Features 🚀

- 💻 RESTful API endpoints for OBD-II command emulation

- 📚 Interactive Swagger/OpenAPI documentation

- ⚡ Real-time command processing with FastAPI

- 🔒 Type-safe Python implementation

- 📦 Docker container support

- 📈 Built-in request validation

## Quick Start 🛠️

```bash

# Clone repository

git clone https://github.com/rakshitbharat/ELM327-emulator-web-API.git

cd ELM327-emulator-web-API

# Install dependencies

pip install -r requirements.txt

# Start development server

uvicorn app.main:app --reload

```

Visit the interactive API docs: http://localhost:8000/docs

## API Endpoints ��

### Send Command

`POST /api/v1/command`

**Request:**

```json

{

  "command": "ATZ",

  "protocol": "auto"

}

```

**Success Response:**

```json

{

  "status": "success",

  "response": "ELM327 v1.5",

  "execution_time": 0.12

}

```

**Error Response:**

```json

{

  "status": "error",

  "error": "Invalid command format",

  "code": 400

}

```

## Development 🧪

```bash

# Run tests

pytest tests/

# Format code

black .

# Check code quality

flake8

```

## Deployment 🚢

```bash

# Build Docker image

docker build -t elm327-emulator .

# Run container

docker run -d -p 8000:8000 elm327-emulator

```

## Contributing 🤝

Contributions welcome! This is an open source project free to use and modify.

---

Made with ❤️ by [rakshitbharat] | [Documentation](https://github.com/rakshitbharat/ELM327-emulator-web-API/wiki) | [Report Bug](https://github.com/rakshitbharat/ELM327-emulator-web-API/issues)