Install

If you successfully installed VWsFriend on a special platform (e.g. a Raspberry or a Synology NAS) I would be happy if you share a documentation.

Install on Synology Docker (Native Synology UI, no docker-compose)

• Launch docker on your NAS, go to Registry. Search for vwsfriend and select the container
• Choose Tag latest
• Go to Image, select the container, click Launch
• Rename the container name if you want, then click Advanced Settings
• Advanced tab : Check Enable auto-restart
• Network tab : Check Use the same network as Docker Host
• Environment tab : Enter your We Connect user name in WECONNECT_USER, your password in WECONNECT_PASSWORD, and to activate HomeKit, enter --with-homekit in ADDITIONAL_PARAMETERS
• Click Apply to close the advanced settings window
• Click Next check the summary, then click Apply. The container should start.
• Go to http://your_nas_ip:4000, you should be able to see your car data

If you want to use HomeKit, click on HomeKit tab, then scan the QR code from the Home App. You can see a tutorial video (in french) of the full install here : https://youtu.be/ZYS58LdQ9mQ

Install without Docker

Tested with openSuse TW

• You need:

  • python 3.8
  • grafana (best > 8.0)
  • postgresql

• Install VWsFriend:

  • pip install vwsfriend
  • you might use pip3 or pip3.8 if you have multiple python versions

• Test VWsFriend

  • vwsfriend -vv -u user -p password
  • open browser on http://127.0.0.1:4000

• Configure postgresql

  • Start postgresql: systemctl start postgresql.service
  • Login to postgresql as admin: sudo -u postgres psql
  • create user vwsfriend with encrypted password '<password>';
  • create database vwsfriend;
  • grant all privileges on database vwsfriend to vwsfriend;
  • exit
  • Modify /var/lib/pgsql/data/pg_hba.conf (this is only quick and dirty)
  • comment out all access rules
  • add:

local   vwfriends       vwfriends                               md5
host    all             all             127.0.0.1/32            md5
host    all             all             ::1/128                 md5

• restart pregresql: systemctl restart postgresql.service
• test access: psql -h localhost -U vwsfriend vwsfriend as user
• start VWsFriend: vwsfriend --with-database --with-abrp -vv --database-url postgresql://vwsfriend:<password>@127.0.0.1/vwsfriend
• check if vwsfriend can connect to the database and create the corresponding tables

• Configure Grafana:
  • Install required plugins
  • wget zip file and unzip it in /var/lib/grafana/plugins
  • You need:
    • pr0ps-trackmap-panel
    • panodata-map-panel
    • natel-plotly-panel
  • check user rights: chgrp -R grafana *, chown -R grafana *
  • copy from this repo ./config/grafana/provisioning/ to /etc/grafana/provisioning/
  • copy from this repo ./dashboards/ to /var/lib/grafana/dashboards/
  • check user rights
  • modify /etc/grafana/provisioning/datasources/vwsfriend.yml the fields database, user, password, url
  • check paths in /etc/grafana/provisioning/dashboards/vwsfriend.yml (e.g., grafana-static -> grafana for some distributions)
  • start grafana with systemctl start grafana-server.service
  • open browser on http://127.0.0.1:3000
  • login with admin/admin

• Limitations for Grafana 7.5.x

  • state-timeline is not working (introduced with Grafana 8.X)
  • picture of the car is not working

• When you upgrade you have to:

  • pip install vwsfriend --upgrade
  • copy again ./dashboards/ to /var/lib/grafana/dashboards/
  • check if new plugins are necessary