{"id":24382930,"url":"https://github.com/tillsteinbach/carconnectivity-plugin-mqtt","last_synced_at":"2026-02-07T00:17:25.362Z","repository":{"id":270511325,"uuid":"910467679","full_name":"tillsteinbach/CarConnectivity-plugin-mqtt","owner":"tillsteinbach","description":"Plugin for connecting CarConnectivity with MQTT brokers. Enables vehicle telemetry of various brands in MQTT","archived":false,"fork":false,"pushed_at":"2025-04-01T06:51:54.000Z","size":154,"stargazers_count":18,"open_issues_count":4,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-01T07:37:30.230Z","etag":null,"topics":["car","mqtt","mqtt-client","mqtt-protocol","mqtt-publisher","skoda","smart-home","smarthome","telemetry","telemetry-client","telemetry-data","volkswagen"],"latest_commit_sha":null,"homepage":"https://github.com/tillsteinbach/CarConnectivity","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tillsteinbach.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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},"funding":{"github":["tillsteinbach"],"custom":["https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ"]}},"created_at":"2024-12-31T10:59:19.000Z","updated_at":"2025-04-01T06:51:57.000Z","dependencies_parsed_at":"2024-12-31T20:20:49.883Z","dependency_job_id":"ba05d94d-6638-447a-90ca-02d597411ed2","html_url":"https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt","commit_stats":null,"previous_names":["tillsteinbach/carconnectivity-plugin-mqtt"],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-plugin-mqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-plugin-mqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-plugin-mqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-plugin-mqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tillsteinbach","download_url":"https://codeload.github.com/tillsteinbach/CarConnectivity-plugin-mqtt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322600,"owners_count":21084337,"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":["car","mqtt","mqtt-client","mqtt-protocol","mqtt-publisher","skoda","smart-home","smarthome","telemetry","telemetry-client","telemetry-data","volkswagen"],"created_at":"2025-01-19T10:10:57.845Z","updated_at":"2026-02-07T00:17:25.356Z","avatar_url":"https://github.com/tillsteinbach.png","language":"Python","funding_links":["https://github.com/sponsors/tillsteinbach","https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ"],"categories":[],"sub_categories":[],"readme":"\n\n# CarConnectivity Plugin for MQTT\n[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/)\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-plugin-mqtt)](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/releases/latest)\n[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-mqtt)](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/blob/master/LICENSE)\n[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-mqtt)](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/issues)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-plugin-mqtt?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-plugin-mqtt/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-plugin-mqtt)](https://pypi.org/project/carconnectivity-plugin-mqtt/)\n[![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/tillsteinbach/carconnectivity-mqtt?sort=semver)](https://hub.docker.com/r/tillsteinbach/carconnectivity-mqtt)\n[![Docker Pulls](https://img.shields.io/docker/pulls/tillsteinbach/carconnectivity-mqtt)](https://hub.docker.com/r/tillsteinbach/carconnectivity-mqtt)\n[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)\n[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)\n\n## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!\n\n[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to publish the data collected from your vehicle in a standard protocol such as [MQTT](https://mqtt.org) this plugin will help you. This Client enables you to integrate with the [MQTT Broker](https://mqtt.org/software/) of your choice (e.g. your home automation solution such as [ioBroker](https://www.iobroker.net), [FHEM](https://fhem.de) or [Home Assistant](https://www.home-assistant.io))\n\n## How to install\n\n### Install using PIP\nIf you want to use CarConnectivity-mqtt, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-mqtt/). Just install instead using:\n```bash\npip3 install carconnectivity-plugin-mqtt\n```\n\n#### Connectors \u0026 Plugins\nIn order to connect vehciles from various brands, you need to install connector, e.g. with:\n```bash\npip3 install carconnectivity-connector-volkswagen\npip3 install carconnectivity-connector-skoda\npip3 install carconnectivity-connector-seatcupra\n```\n\n### Install using pipx (alternative)\n[pipx](https://github.com/pypa/pipx) is a tool to help you install and run end-user applications written in Python. [pipx](https://github.com/pypa/pipx) creates an isolated environment for each application and its associated packages.\n```bash\npipx install carconnectivity-plugin-mqtt\n```\n#### Important\nWhen using [pipx](https://github.com/pypa/pipx), connectors and plugins need to be explicitly installed in the carconnectivity-mqtt environment. Otherwise the connectors or plugins will not be found due to the isolation. You can do that with e.g.:\n```bash\npipx inject carconnectivity-plugin-mqtt carconnectivity-connector-volkswagen\n```\n\n### Create config file\nCreate a carconnectivity.json config file like this (Example if you have a Volkswagen and a MySkoda account). A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/tree/main/doc/Config.md).\n```json\n{\n    \"carConnectivity\": {\n        \"log_level\": \"error\", // set the global log level, you can set individual log levels in the connectors and plugins\n        \"connectors\": [\n            {\n                \"type\": \"skoda\", // Definition for a MySkoda account\n                \"config\": {\n                    \"interval\": 600, // Interval in which the server is checked in seconds\n                    \"username\": \"test@test.de\", // Username of your MySkoda Account\n                    \"password\": \"testpassword123\" // Password of your MySkoda Account\n                }\n            },\n            {\n                \"type\": \"volkswagen\", // Definition for a Volkswagen account\n                \"config\": {\n                    \"interval\": 300, // Interval in which the server is checked in seconds\n                    \"username\": \"test@test.de\", // Username of your Volkswagen Account\n                    \"password\": \"testpassword123\" // Username of your Volkswagen Account\n                }\n            }\n        ],\n        \"plugins\": [\n            {\n                \"type\": \"mqtt\", // Definition for the MQTT Connection\n                \"config\": {\n                    \"broker\": \"192.168.0.123\", // Broker hostname or IP address\n                    \"username\": \"testuser\", // Broker username to login\n                    \"password\": \"testuser\" // Broker password to login\n                }\n            }\n        ]\n    }\n}\n```\n\n### Startup\nWhen using docker-compose configure CarConnectivity-MQTT like that:\n```bash\ncarconnectivity-mqtt carconnectivity.json\n```\nIf you face challenges the WebUI can help you find the problems: [CarConnectivity-plugin-webui](https://github.com/tillsteinbach/CarConnectivity-plugin-webui). Install it with:\n```bash\npip3 install carconnectivity-plugin-webui\n```\nand add a plugin of `\"type\": \"webui\"` to your configuration.\n\n### Updates\nIf you want to update, the easiest way is:\n```bash\npip3 install carconnectivity-plugin-mqtt --upgrade\npip3 install carconnectivity-connector-volkswagen --upgrade\npip3 install carconnectivity-connector-skoda --upgrade\npip3 install carconnectivity-connector-seatcupra --upgrade\n```\n\nIf you want to try pre-releases (e.g. alpha releases) you can do so by\n```bash\npip3 install --pre carconnectivity-connector-volkswagen\n```\nor with an exact version like\n```bash\npip3 install carconnectivity-connector-volkswagen==0.9.2a1\n```\n\n## With Docker\nThere is also a Docker image to easily host CarConnectivity-MQTT: [See on Dockerhub](https://hub.docker.com/r/tillsteinbach/carconnectivity-mqtt)\n\n## Other\n### Home Assistant\nThe easiest way to work with home assistant is to use the prepackaged [carconnectivity-addon](https://github.com/Pulpyyyy/carconnectivity-addon).\n\n#### Manual install with Home Assistant\nTo make Auto Discovery and further features available in Home Assistant also install [CarConnectivity-plugin-mqtt_homeassistant](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant)\n```bash\npip3 install carconnectivity-plugin-mqtt_homeassistant\n```\nand add it to your config:\n```json\n            {\n                \"type\": \"mqtt\", // Definition for the MQTT Connection\n                \"config\": {\n                    \"broker\": \"192.168.0.123\", // Broker hostname or IP address\n                    \"username\": \"testuser\", // Broker username to login\n                    \"password\": \"testuser\" // Broker password to login\n                }\n            },\n            {\n                \"type\": \"mqtt_homeassistant\", // Definition for the MQTT Home Assistant Compatibility\n                \"config\": {}\n            }\n```\n### Times\nBy default the times coming from the car are UTC isoformat. You can convert times to your local timezone by adding `convert-times` to your config. Convert times will use the timezone specified in `TZ` variable.\nYou can format times in your local format by adding `timeformat` to your config. This will use the default Date/Time format of your locale setting (`LC_ALL` variable). If you want to set a specific format add e.g. `timeformat '%a %d %b %Y %T'` to your config.\n```yml\n...\n  carconnectivity-mqtt:\n    image: \"tillsteinbach/carconnectivity-mqtt:edge\"\n    environment:\n      - TZ=Europe/Berlin\n      - LANG=de_DE\n      - LC_ALL=de_DE\n...\n```\n### Using Miles or Farenheit\nCarConnectivity will guess your desired temperature or range/speed unit based on the systems locale. If it does not match what you want, you can set a different locale in your `carconnectivity.json` json config.\n\n### Credentials\nIf you do not want to provide your username or password inside the configuration you have to create a \".netrc\" file at the appropriate location (usually this is your home folder):\n```\n# For MQTT broker\nmachine mymqttbroker\nlogin test@test.de\npassword testpassword123\n```\nIn this case the configuration needs to look like this:\n```\n{\n    \"carConnectivity\": {\n        \"connectors\": [\n            ...\n        ]\n        \"plugins\": [\n            {\n                \"type\": \"mqtt\",\n                \"config\": {\n                    \"broker\": \"mymqttbroker\"\n                }\n            }\n        ]\n    }\n}\n```\n\nYou can also provide the location of the netrc file in the configuration.\n```\n{\n    \"carConnectivity\": {\n        \"connectors\": [\n            ...\n        ]\n        \"plugins\": [\n            {\n                \"type\": \"mqtt\",\n                \"config\": {\n                    \"broker\": \"mymqttbroker\"\n                    \"netrc\": \"/some/path/on/your/filesystem\"\n                }\n            }\n        ]\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftillsteinbach%2Fcarconnectivity-plugin-mqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftillsteinbach%2Fcarconnectivity-plugin-mqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftillsteinbach%2Fcarconnectivity-plugin-mqtt/lists"}