carconnectivity-plugin-webui 0.5.3a1

CarConnectivity plugin for a web based user interface

CarConnectivity Plugin for A Web based User Interface

CarConnectivity will become the successor of WeConnect-python in 2025 with similar functionality but support for other brands beyond Volkswagen!

CarConnectivity is a python API to connect to various car services. This plugin allows you to use a browser to interact with CarConnectivity.

How to install

Install using PIP

If you want to use CarConnectivity Web UI, the easiest way is to obtain it from PyPI. Just install instead using:

pip3 install carconnectivity-plugin-webui

after you installed CarConnectivity

Configuration

In your carconnectivity.json configuration add a section for the webui plugin like this. A documentation of all possible config options can be found here.

{
    "carConnectivity": {
        "connectors": [
            ...
        ]
        "plugins": [
            {
                "type": "webui",
                "config": {
                    "username": "admin", // Admin username for login
                    "password": "secret" // Admin password for login
                }
            }
        ]
    }
}

How to use

You will default find the webinterface on http port 4000 on the machine that is hosting carconnectivity. You can change interface with the host parameter and the port with the port parameter. Always set your personal username and password to protect your data from theft.

Updates

If you want to update, the easiest way is:

pip3 install carconnectivity-plugin-webui --upgrade