Metadata-Version: 2.1
Name: weconnect-mqtt
Version: 0.5.0
Summary: CMQTT Client that publishes data from Volkswagen WeConnect
Home-page: https://github.com/tillsteinbach/WeConnect-mqtt
Author: Till Steinbach
License: MIT
Description: # WeConnect-MQTT
        [![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/WeConnect-mqtt/)
        [![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/WeConnect-mqtt)](https://github.com/tillsteinbach/WeConnect-mqtt/releases/latest)
        [![GitHub](https://img.shields.io/github/license/tillsteinbach/WeConnect-mqtt)](https://github.com/tillsteinbach/WeConnect-mqtt/blob/master/LICENSE)
        [![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/WeConnect-mqtt)](https://github.com/tillsteinbach/WeConnect-mqtt/issues)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/weconnect-mqtt?label=PyPI%20Downloads)](https://pypi.org/project/weconnect-mqtt/)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/weconnect-mqtt)](https://pypi.org/project/weconnect-mqtt/)
        [![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/tillsteinbach/weconnect-mqtt?sort=semver)](https://hub.docker.com/r/tillsteinbach/weconnect-mqtt)
        [![Docker Pulls](https://img.shields.io/docker/pulls/tillsteinbach/weconnect-mqtt)](https://hub.docker.com/r/tillsteinbach/weconnect-mqtt)
        [![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
        [![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)
        
        [MQTT](https://mqtt.org) Client that publishes data from Volkswagen WeConnect Services
        
        ## What is the purpose?
        If you want to integrate data from your weconnect enabled car a standard protocol such as [MQTT](https://mqtt.org) can be very helpful. 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))
        
        ## Requirements
        You need to install python 3 on your system: [How to install python](https://realpython.com/installing-python/)
        
        ## How to install
        If you want to use WeConnect-mqtt, the easiest way is to obtain it from [PyPI](https://pypi.org/project/weconnect-mqtt/). Just install instead using:
        ```bash
        pip3 install weconnect-mqtt
        ```
        ### Updates
        If you want to update WeConnect-mqtt, the easiest way is:
        ```bash
        pip3 install weconnect-mqtt --upgrade
        ```
        ### Docker
        There is also a Docker image to easily host WeConnect-MQTT: [See on Dockerhub](https://hub.docker.com/repository/docker/tillsteinbach/weconnect-mqtt)
        
        ## How to use
        Start weconnect-mqtt from the commandline:
        ```bash
        weconnect-mqtt
        ```
        You get all the usage information by using the --help command
        ```bash
        weconnect-mqtt --help
        ```
        An example to connect with an MQTT broker at 192.168.0.1 with user test and password test123 is
        ```bash
        weconnect-mqtt --username test@test.de --password test123 --mqttbroker 192.168.0.1 --mqtt-username test --mqtt-password test123 --prefix weconnect
        ```
        The client uses user test@test.de and password test123 in this example to connect to weconnect
        
        ### Credentials
        If you do not want to provide your username or password all the time you have to create a ".netrc" file at the appropriate location (usually this is your home folder):
        ```
        # For WeConnect
        machine volkswagen.de
        login test@test.de
        password testpassword123
        
        # For the MQTTBroker
        machine 192.168.0.1
        login test
        password testpassword123
        ```
        You can also provide the location of the netrc file using the --netrc option
        
        ## Tested with
        - Volkswagen ID.3 Modelyear 2021
        - Volkswagen Passat GTE Modelyear 2021
        
        ## Reporting Issues
        Please feel free to open an issue at [GitHub Issue page](https://github.com/tillsteinbach/WeConnect-mqtt/issues) to report problems you found.
        
        ### Known Issues
        - The Tool is in alpha state and may change unexpectedly at any time!
        
        ## Related Projects:
        - [WeConnect-cli](https://github.com/tillsteinbach/WeConnect-cli): Commandline Interface to interact with the Volkswagen WeConnect Services
        - [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python): Python API to connect to Volkswagen WeConnect Services
        
Keywords: weconnect,we connect,carnet,car net,volkswagen,vw,telemetry,mqtt,smarthome
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Home Automation
Requires-Python: >=3.7
Description-Content-Type: text/markdown
