{"id":25317485,"url":"https://github.com/rakshitbharat/elm327-emulator-web-api","last_synced_at":"2025-07-27T00:37:01.116Z","repository":{"id":276146636,"uuid":"928367580","full_name":"rakshitbharat/ELM327-emulator-web-API","owner":"rakshitbharat","description":"A modern web API interface for automotive diagnostics, wrapping the ELM327-emulator project with RESTful capabilities.","archived":false,"fork":false,"pushed_at":"2025-03-02T14:14:46.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T14:31:59.684Z","etag":null,"topics":["emulator","obd2","simulator","web"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rakshitbharat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-06T14:20:03.000Z","updated_at":"2025-02-06T14:24:07.000Z","dependencies_parsed_at":"2025-02-06T15:33:54.435Z","dependency_job_id":"73959cb9-7fe8-450c-adcb-0cd27900966f","html_url":"https://github.com/rakshitbharat/ELM327-emulator-web-API","commit_stats":null,"previous_names":["rakshitbharat/elm327-emulator-web-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakshitbharat%2FELM327-emulator-web-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakshitbharat%2FELM327-emulator-web-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakshitbharat%2FELM327-emulator-web-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakshitbharat%2FELM327-emulator-web-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rakshitbharat","download_url":"https://codeload.github.com/rakshitbharat/ELM327-emulator-web-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247698682,"owners_count":20981391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emulator","obd2","simulator","web"],"created_at":"2025-02-13T19:38:31.331Z","updated_at":"2025-04-07T17:36:00.621Z","avatar_url":"https://github.com/rakshitbharat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ELM327 Emulator Web API 🚗 \n\n\u003cdiv align=\"center\"\u003e\n\n[![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge\u0026logo=fastapi)](https://fastapi.tiangolo.com/)\n[![Python](https://img.shields.io/badge/Python-3.10+-3776AB?style=for-the-badge\u0026logo=python\u0026logoColor=white)](https://www.python.org/)\n[![Next.js](https://img.shields.io/badge/Next.js-black?style=for-the-badge\u0026logo=next.js\u0026logoColor=white)](https://nextjs.org/)\n[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)](https://www.typescriptlang.org/)\n[![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge\u0026logo=bun\u0026logoColor=white)](https://bun.sh/)\n\nA modern web-based ELM327 emulator with an intuitive GUI control panel. Monitor and control your virtual OBD-II parameters in real-time! 🚀\n\n[Features](#features) • [Quick Start](#quick-start) • [Documentation](#api-documentation) • [Contributing](#contributing)\n\n![ELM327 Emulator GUI](docs/image.png)\n\n\u003c/div\u003e\n\n## ✨ Features\n\n- 🎯 **Interactive GUI Dashboard** - Real-time monitoring of all ECU parameters\n- 🚀 **FastAPI Backend** - High-performance ELM327 emulation\n- 💻 **Modern Next.js Frontend** - Sleek, responsive control panel with shadcn/ui components\n- 🐳 **Docker Ready** - Easy deployment with Docker Compose\n- 📊 **Real-time Updates** - Live parameter visualization\n- 🛠️ **Customizable Parameters** - Modify ECU values on the fly\n- 🌓 **Dark/Light Mode** - Built-in theme support\n\n## 🏁 Quick Start\n\n### Using Docker (Recommended)\n\n```bash\n# Clone the repository\ngit clone https://github.com/rakshitbharat/ELM327-emulator-web-API.git\ncd ELM327-emulator-web-API\n\n# Start the application\ndocker compose up --build\n```\n\nVisit:\n- 🌐 GUI Dashboard: http://localhost:3000\n- 📚 API Docs: http://localhost:8000/docs\n\n### Manual Setup\n\n**Backend:**\n```bash\npip install -r requirements.txt\nuvicorn app.main:app --reload\n```\n\n**Frontend:**\n```bash\ncd control-panel\nbun install\nbun run dev\n```\n\n## 🎮 GUI Features\n\n- **Real-time Dashboard**: Monitor all ECU parameters at a glance\n- **Parameter Controls**: Adjust values using intuitive sliders and inputs\n- **Command Console**: Send raw OBD-II commands\n- **Response History**: Track command history and responses\n- **Protocol Selection**: Switch between different OBD protocols\n- **Dark/Light Theme**: Choose your preferred visual style with system theme support\n\n## 🔧 Available ECU Parameters\n\n| Parameter | Range | Unit |\n|-----------|-------|------|\n| Engine RPM | 0-8000 | RPM |\n| Vehicle Speed | 0-255 | km/h |\n| Throttle Position | 0-100 | % |\n| Engine Coolant Temp | -40 to 215 | °C |\n| Engine Load | 0-100 | % |\n| Fuel Level | 0-100 | % |\n| Manifold Pressure | 0-255 | kPa |\n| Timing Advance | -64 to 63.5 | ° |\n| O2 Sensor Voltage | 0-1.275 | V |\n| Mass Air Flow | 0-655.35 | g/s |\n\n## 🌐 API Endpoints\n\n\u003cdetails\u003e\n\u003csummary\u003eView Available Endpoints\u003c/summary\u003e\n\n### Command Execution\n```http\nPOST /api/v1/command\n```\n\n### Parameter Control\n```http\nPOST /api/v1/ecu/set-value\nGET /api/v1/ecu/values\nGET /api/v1/ecu/value/{parameter}\n```\n\u003c/details\u003e\n\n## 📦 Tech Stack\n\n- **Backend**: FastAPI, Python 3.10+\n- **Frontend**: Next.js 14, TypeScript, shadcn/ui\n- **Package Manager**: Bun\n- **Containerization**: Docker\n- **Documentation**: Swagger/OpenAPI\n- **Testing**: pytest\n\n## 🛠️ Development\n\n```bash\n# Install development dependencies\npip install -r requirements-dev.txt\n\n# Run tests\npytest\n\n# Run linting\nflake8\n```\n\n## 📝 Environment Variables\n\nCreate `.env`:\n```env\nAPI_HOST=0.0.0.0\nAPI_PORT=8000\nAPI_RELOAD=True\nNEXT_PUBLIC_API_URL=http://localhost:8000\n```\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit changes (`git commit -m 'Add AmazingFeature'`)\n4. Push to branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## 📜 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- Built on top of the excellent [ELM327-emulator](https://github.com/Ircama/ELM327-emulator) library\n- Inspired by professional automotive diagnostic tools\n- UI components from [shadcn/ui](https://ui.shadcn.com/)\n\n---\n\n\u003cdiv align=\"center\"\u003e\nMade with ❤️ by \u003ca href=\"https://github.com/rakshitbharat\"\u003erakshitbharat\u003c/a\u003e\n\n⭐️ Star us on GitHub if you find this useful!\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frakshitbharat%2Felm327-emulator-web-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frakshitbharat%2Felm327-emulator-web-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frakshitbharat%2Felm327-emulator-web-api/lists"}