Python plugin: We-connect VW ID3

Python and python framework

Moderator: leecollings

Post Reply
Andreotti
Posts: 3
Joined: Sunday 07 February 2021 14:21
Target OS: Raspberry Pi / ODroid
Domoticz version:
Location: Zuid-Holland (NL)
Contact:

Python plugin: We-connect VW ID3

Post by Andreotti »

Hi, I made a Domoticz plugin to read my VW ID.3 battery percentage and distance left.

screenshot.png
screenshot.png (257.11 KiB) Viewed 599 times

It is not perfect, but it is working. There's room for expansion and improvement.

Download the code section. Name it plugin.py and place it in /home/pi/domoticz/plugins/we-connect
Make sure chmod is 644

You need weconnect-cli for Python. Install steps are in the code.
I had to make a small change in the API code to get it working. See readme.txt attachment

Code: Select all

# We-connect - Volkswagen group - Domoticz plugin
# Tested with my VW ID.3
#
# Author: Andreotti 2024
#
# Uses: Python API for the Volkswagen WeConnect Services
# Web: https://github.com/tillsteinbach/WeConnect-python
#
# Setup We-connect API on Raspberry Pi
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# apt install python3-pip
# pip3 install weconnect-cli
#
# When you get this error: "externally-managed-environment"
# pip3 install weconnect-cli --break-system-packages
#
# Test:
# weconnect-cli --username 'email' --password 'my_password'
#
# P.S. the check for the right VIN is not working for some reason!

"""
<plugin key="We-connect" name="We-connect" author="Andreotti" version="1.0.0" >
  <description>
    <p>VIN is optional. Use it if you have more then one car connected in your app.</p>
    Credentials:
  </description>
  <params>
    <param field="Username" label="Username" width="150px"/>
    <param field="Password" label="Password" width="150px" default="" password="true"/>
    <param field="VIN" label="VIN (optional)" width="150px"/>
  </params>
</plugin>
"""

import Domoticz
from weconnect import weconnect

class BasePlugin:

  runAgain = 1

  def __init__(self):
    return

  def onStart(self):

    if len(Devices) == 0:
      Domoticz.Device(Name="Battery", Unit=1, Type=243, Subtype=6, Switchtype=0).Create()
      Domoticz.Device(Name="Distance", Unit=2, TypeName="Custom", Options={"Custom": "1;km"}).Create()
      
      Domoticz.Log("Created device: ")

  def onStop(self):
    return

  def onDisconnect(self, Connection):
    return

  def onHeartbeat(self):
    self.runAgain = self.runAgain - 1
    if (self.runAgain > 0):
      return

    self.runAgain = 60  # 1x per 5 minuten checken (60 x 5 sec)

    weConnect = weconnect.WeConnect(username=Parameters["Username"], password=Parameters["Password"], updateAfterLogin=False, loginOnInit=False)
    if (weConnect):
      try:
        weConnect.login()
        weConnect.update()
      except Exception as e:
        Domoticz.Log(f"Error during weConnect update: {str(e)}")
        return

      try:
        for vin, vehicle in weConnect.vehicles.items():
          # if (Parameters["VIN"] == "" or vin == Parameters["VIN"]):
            if "charging" in vehicle.domains and "batteryStatus" in vehicle.domains["charging"]:
              Devices[1].Update(nValue=0, sValue=str(vehicle.domains["charging"]["batteryStatus"].currentSOC_pct.value))
              Devices[2].Update(nValue=0, sValue=str(vehicle.domains["charging"]["batteryStatus"].cruisingRangeElectric_km.value))

      except Exception as e:
        Domoticz.Log(f"Error reading weConnect data: {str(e)}")
        return

    weConnect = None

global _plugin
_plugin = BasePlugin()

def onStart():
  global _plugin
  _plugin.onStart()

def onStop():
  global _plugin
  _plugin.onStop()

def onDisconnect(Connection):
  global _plugin
  _plugin.onDisconnect(Connection)

def onHeartbeat():
  global _plugin
  _plugin.onHeartbeat()

This fits my needs, but change it if you want to.
Attachments
readme.txt
(1.19 KiB) Downloaded 8 times
User avatar
waltervl
Posts: 5148
Joined: Monday 28 January 2019 18:48
Target OS: Linux
Domoticz version: 2024.7
Location: NL
Contact:

Re: Python plugin: We-connect VW ID3

Post by waltervl »

Thanks for creating the plugin. It would be helpfull if you put the plugin on GitHub as every other plugin is there. It is easier to trackand download future changes in the plugin (user can do a git pull) than here on the forum.
Domoticz running on Udoo X86 (on Ubuntu)
Devices/plugins: ZigbeeforDomoticz (with Xiaomi, Ikea, Tuya devices), Nefit Easy, Midea Airco, Omnik Solar, Goodwe Solar
Andreotti
Posts: 3
Joined: Sunday 07 February 2021 14:21
Target OS: Raspberry Pi / ODroid
Domoticz version:
Location: Zuid-Holland (NL)
Contact:

Re: Python plugin: We-connect VW ID3

Post by Andreotti »

I added the project to github:

https://github.com/Andreotti100/We-connect
Post Reply

Who is online

Users browsing this forum: Google [Bot] and 1 guest