{"id":13396956,"url":"https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3","last_synced_at":"2025-03-13T23:32:03.145Z","repository":{"id":21399346,"uuid":"92652571","full_name":"openvehicles/Open-Vehicle-Monitoring-System-3","owner":"openvehicles","description":"Open Vehicle Monitoring System - Version 3","archived":false,"fork":false,"pushed_at":"2024-11-19T23:56:16.000Z","size":88760,"stargazers_count":609,"open_issues_count":153,"forks_count":231,"subscribers_count":69,"default_branch":"master","last_synced_at":"2024-11-20T00:34:08.064Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http:///www.openvehicles.com/","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openvehicles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2017-05-28T09:46:35.000Z","updated_at":"2024-11-19T23:56:19.000Z","dependencies_parsed_at":"2023-02-19T12:16:07.971Z","dependency_job_id":"6091a82e-308e-48b6-84aa-906aaa23cd3c","html_url":"https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openvehicles%2FOpen-Vehicle-Monitoring-System-3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openvehicles%2FOpen-Vehicle-Monitoring-System-3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openvehicles%2FOpen-Vehicle-Monitoring-System-3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openvehicles%2FOpen-Vehicle-Monitoring-System-3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openvehicles","download_url":"https://codeload.github.com/openvehicles/Open-Vehicle-Monitoring-System-3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243500226,"owners_count":20300760,"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":[],"created_at":"2024-07-30T18:01:08.387Z","updated_at":"2025-03-13T23:32:03.136Z","avatar_url":"https://github.com/openvehicles.png","language":"C","funding_links":[],"categories":["C","Network and Middleware"],"sub_categories":["Controller Area Network"],"readme":"# Open-Vehicle-Monitoring-System-3 (OVMS3)\n\n![OVMS3 module](docs/source/userguide/ovms-intro.jpg)\n\n\n## Introduction\n\nThe OVMS is an **all open source** vehicle remote monitoring, diagnosis and control system.\n\nThe system provides **live monitoring** of vehicle metrics like state of charge, temperatures, tyre pressures \nand diagnostic fault conditions. It will **alert** you about critical conditions and events like a charge \nabort, battery cell failure or potential theft. Depending on the vehicle integration it allows you to **take \ncontrol** over the charge process, climate control, tuning parameters of the engine and more. OVMS developers \nare enthusiasts trying hard to provide as **detailed information** about the internals of a vehicle as \npossible.\n\nWhile most new vehicles now include some kind of remote control system, very few allow deep insight, some will \nnot work in all regions and none will give you **control over your personal data**. The OVMS fills that gap, \nand also enables you to add all these features to existing vehicles of any kind.\n\nThe OVMS can also be used for **fleet monitoring**. It allows a fleet manager to not only track the vehicle \nlocations but also to monitor the vehicle's vitals, remotely check for fault conditions, offer services like \nautomatic preheating for users and take active control in case of abusive use. As the system is open source \nand fully scriptable, it can easily integrate custom access and control systems.\n\nFor **developers and technicians**, the OVMS includes a range of CAN tools including multiple logging \nformats, a configurable OBD2 translator, a DBC decoder, a reverse engineering toolkit and a CANopen client. \nThe module provides SSH access and WebSocket streaming and can stream and inject CAN frames via TCP. Both the \nmodule and the web frontend can be customized by plugins. The module has three builtin CAN buses and [can be \nextended by a fourth one](https://github.com/mjuhanne/OVMS-SWCAN).\n\nThe **OVMS base component** is a small hardware module that connects to the vehicle **OBD2** \nport. The standard kit in the current version 3.3 includes a **2G/3G/4G modem** to provide cellular \nconnectivity and **GPS**. This standard kit has been **FCC certified** and **CE certified**.\n\nThe module provides a **built-in Web App** user interface and remote control via native cellphone Apps \navailable for **Android** and **iOS**. It integrates into home/process automation systems via **MQTT** and \nprovides data logging to SD card and to a server.\n\n\n## Vehicle Support\n\n- _Native Integration_\n  - Chevrolet Volt / Opel Ampera\n  - Chevrolet Bolt EV / Opel Ampera-e\n  - [BMW i3 / i3s](https://docs.openvehicles.com/en/latest/components/vehicle_bmwi3/docs/index.html)\n  - [Mini Cooper SE](https://docs.openvehicles.com/en/latest/components/vehicle_minise/docs/index.html)\n  - [Fiat 500e](https://docs.openvehicles.com/en/latest/components/vehicle_fiat500/docs/index.html)\n  - [Hyundai Ioniq vFL](https://docs.openvehicles.com/en/latest/components/vehicle_hyundai_ioniqvfl/docs/index.html)\n  - [Hyundai Ioniq 5](https://docs.openvehicles.com/en/latest/components/vehicle_hyundai_ioniq5/docs/index.html)\n  - [Jaguar Ipace](https://docs.openvehicles.com/en/latest/components/vehicle_jaguaripace/docs/index.html)\n  - [Kia e-Niro / Hyundai Kona / Hyundai Ioniq FL](https://docs.openvehicles.com/en/latest/components/vehicle_kianiroev/docs/index.html)\n  - [Kia Soul EV](https://docs.openvehicles.com/en/latest/components/vehicle_kiasoulev/docs/index.html)\n  - [Maxus eDeliver 3](https://docs.openvehicles.com/en/latest/components/vehicle_maxus_edeliver3/docs/index.html)\n  - [Mercedes-Benz B250E](https://docs.openvehicles.com/en/latest/components/vehicle_mercedesb250e/docs/index.html)\n  - [MG](https://docs.openvehicles.com/en/latest/components/vehicle_mgev/docs/index.html)\n  - [Mitsubishi Trio (i-MiEV et al)](https://docs.openvehicles.com/en/latest/components/vehicle_mitsubishi/docs/index.html)\n  - [Nissan Leaf / e-NV200](https://docs.openvehicles.com/en/latest/components/vehicle_nissanleaf/docs/index.html)\n  - [Renault Twizy](https://docs.openvehicles.com/en/latest/components/vehicle_renaulttwizy/docs/index.html)\n  - [Renault Zoe / Kangoo](https://docs.openvehicles.com/en/latest/components/vehicle_renaultzoe/docs/index.html)\n  - [Renault Zoe Phase 2](https://docs.openvehicles.com/en/latest/components/vehicle_renaultzoe_ph2_obd/docs/index.html)\n  - [Smart ED Gen.3](https://docs.openvehicles.com/en/latest/components/vehicle_smarted/docs/index.html)\n  - [Smart ED/EQ Gen.4 (453)](https://docs.openvehicles.com/en/latest/components/vehicle_smarteq/docs/index.html)\n  - [Tesla Model S](https://docs.openvehicles.com/en/latest/components/vehicle_teslamodels/docs/index.html)\n  - [Tesla Roadster](https://docs.openvehicles.com/en/latest/components/vehicle_teslaroadster/docs/index.html)\n  - Think City\n  - [Toyota RAV4 EV](https://docs.openvehicles.com/en/latest/components/vehicle_toyotarav4ev/docs/index.html)\n  - [VW e-Up](https://docs.openvehicles.com/en/latest/components/vehicle_vweup/docs/index.html)\n- _General Support_\n  - [DBC File Based](https://docs.openvehicles.com/en/latest/components/vehicle_dbc/docs/index.html)\n  - [GPS Tracking](https://docs.openvehicles.com/en/latest/components/vehicle_track/docs/index.html)\n  - [OBD-II Standard](https://docs.openvehicles.com/en/latest/components/vehicle_obdii/docs/index.html)\n  - Zeva BMS\n\n\n## Links\n\n- _User Resources_\n  - _User and Developer Guides: (hint: version selection in left menu at the bottom)_\n    - [Stable release (OTA version \"main\")](https://docs.openvehicles.com/en/stable/)\n    - [Latest nightly build (OTA version \"edge\")](https://docs.openvehicles.com/en/latest/)\n  - [User Support Forum](https://www.openvehicles.com/forum)\n  - [Android App](https://play.google.com/store/apps/details?id=com.openvehicles.OVMS\u0026hl=en_US) [APK file](https://github.com/openvehicles/Open-Vehicle-Android/tree/master/release)\n  - [iOS App](https://apps.apple.com/us/app/open-vehicles/id490098531)\n- _Distributors_\n  - [Medlock \u0026 Sons (North America)](https://medlockandsons.com/product/ovms-v3/)\n  - [OpenEnergyMonitor (UK/Europe)](https://shop.openenergymonitor.com/ovms/)\n  - [e-mobility driving solutions GmbH (Germany/Europe)](https://e-mobility-driving-solutions.com/produkt-kategorie/ovms-products/?lang=en)\n- _Servers_\n  - [Asia-Pacific](https://www.openvehicles.com/)\n  - [Germany/Europe](https://dexters-web.de/)\n- _Developers_\n  - [Developer Guide](https://docs.google.com/document/d/1q5M9Lb5jzQhJzPMnkMKwy4Es5YK12ACQejX_NWEixr0)\n  - [Developer Mailing List \u0026 Archive](http://lists.openvehicles.com/mailman/listinfo/ovmsdev)\n  - [Server Source](https://github.com/openvehicles/Open-Vehicle-Server)\n  - [Android App Source](https://github.com/openvehicles/Open-Vehicle-Android)\n  - [iOS App Source](https://github.com/openvehicles/Open-Vehicle-iOS)\n\n\n## Hardware\n\n![OVMS3 module](docs/source/userguide/slide-image-2.jpg)\n\n- [Module Schematics and PCB Layouts](https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/tree/master/vehicle/hardware)  \n\n- **Base Module (v3.0-3.3)**\n  - Black injection-moulded plastic enclosure, approximately 99x73x29 mm excl. plugs\n  - ESP32 WROVER processor (16MB flash, 4MB SPI RAM, 520KB SRAM, dual core 160/240MHz Xtensa LX6 processor)\n  - WIFI 802.11 b/g/n\n  - Bluetooth v4.2 BR/EDR and BLE\n  - 3x CAN buses\n  - 1x Micro USB connector (for flash download and serial console)\n  - 1x Micro SD card slot\n  - 1x Internal expansion slot\n  - 8x EGPIO, 2x GPIO\n  - 1x GSM antenna connector\n  - 1x GPS antenna connector\n  - 1x DB9 vehicle connector\n  - 1x DB26 expansion connector\n- **Modem Module v3.0-3.2**\n  - US edition is SIM5360A (Dual-Band UMTS/HSPA+ 850/1900MHz, Quad-Band GSM/GPRS/EDGE 850/900/1800/1900MHz)\n  - EU edition is SIM5360J(E) (Dual-Band UMTS/HSPA+ 900/2100MHz, Quad-Band GSM/GPRS/EDGE 850/900/1800/1900MHz)\n  - 3G (EV-DO/HSPA+) dual band modem\n  - Includes 2G (GSM/GPRS) and 2.5G (EDGE) quad band\n  - GPS/GNSS\n  - Nano (4FF) SIM slot\n  - HOLOGRAM.IO nano sim included (can be exchanged if necessary)\n- **Modem Module v3.3**\n  - World edition: SIM7600G (Multi-Band LTE-FDD/LTE-TDD/HSPA+ and GSM/GPRS/EDGE)\n  - 4G (LTE-FDD/LTE-TDD) multi band modem\n  - Includes 3G (EV-DO/HSPA+), 2G (GSM/GPRS) and 2.5G (EDGE) quad band\n  - GPS/GNSS\n  - Nano (4FF) SIM slot\n  - HOLOGRAM.IO nano sim included (can be exchanged if necessary)\n\n\n### Extensions\n\nThe external DB26 DIAG connector provides access to the three CAN buses and offers some free extension ports. \nThe internal PCB expansion connector allows stacked additions of further modules and serves for routing GPIO \nports to the external DIAG connector. See schematics for details.\n\nA very nice first extension module has been developed by Marko Juhanne: \n[OVMS-SWCAN](https://github.com/mjuhanne/OVMS-SWCAN)\n\nIf you plan on developing a hardware extension or just want to do some custom adaptations, have a look at our \nprototyping PCB kit. It's available in packs of 3 PCBs and includes headers and mounting material:\n\n![OVMS-tailored prototyping PCB](docs/source/userguide/prototyping-pcb.jpg)\n\nIf the kit isn't available at the distributors, please contact Mark Webb-Johnson \u003cmark@webb-johnson.net\u003e.\n\n\n## Development and Contributions\n\n**New developers are very welcome on any part of the system, and we will gladly provide any help needed to\nget started.**\n\nThe purpose of this project is to get the community of vehicle hackers and enthusiasts to be able to expand \nthe project. We can't do it all, and there is so much to do. What we are doing is providing an affordable and \nflexible base that the community can work on and extend.\n\nEverything is open, and APIs are public. Other car modules can talk to the server, and other Apps can show the \nstatus and control the car. This is a foundation that others hopefully will interface to and and build upon.\n\n**If you'd like to contribute, please accept our code of conduct:**\n\n- Introduce yourself on the developer mailing list\n- Be kind \u0026 polite\n- Understand the framework concepts\n- Ask if you need help\n- Present your plans if in doubt\n- Write decent code\n- If you extend modules, stick to their code style\n- Write brief but descriptive commit comments\n- Add user level descriptions to the change history\n- Provide documentation in the user guide\n- Use pull requests to submit your code for inclusion\n\n**A note on pull requests:**\n\nPull requests shall focus on one specific issue / feature / vehicle at a time and shall only mix \nvehicle specific changes with framework changes if they depend on each other. If changes are not \nor only loosely related, split them into multiple PRs (just as you would do with commits).\n\nUsage hint: create a branch for each pull request, include only those commits in that branch (by \ncherry-picking if necessary) that shall be included in the pull request. That way you can push \nfurther commits to that branch, Github will automatically add them to an open pull request.\n\n\n## Donations\n\nThe OVMS is a non-profit community project. Hardware production and service can normally be financed by sales, \nbut some things (e.g. prototype development and certifications) need extra money. To help the project, you can \nmake a donation on the OVMS website: https://www.openvehicles.com/forum\n\nPlease also consider supporting the vehicle developers directly. Check out their web sites and support\naddresses for their respective donation channels.\n\n**Thank you!**\n\n\n## License\n\nThe project includes some third party libraries and components to which their respective licenses\napply, see component sources for details.\n\nThe project itself is published under the MIT license:\n\nCopyright (c) 2011-2020 Open Vehicles\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nSoftware which uses other licenses will be annotated appropriately.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenvehicles%2FOpen-Vehicle-Monitoring-System-3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenvehicles%2FOpen-Vehicle-Monitoring-System-3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenvehicles%2FOpen-Vehicle-Monitoring-System-3/lists"}