14 |
15 | ## Setup
16 |
17 | ### Setup for beginners
18 |
19 | You have never set up something similar? Don't worry, the [beginners guide](docs/beginnerguide.md) guides you through every step you need to take.
20 | Common problems and answers to frequently asked questions can be found [here](https://github.com/robske110/IDDataLogger/wiki/FAQ-and-frequent-problems).
21 | Should you have any remaining questions or issues please see [getting help](https://github.com/robske110/IDDataLogger/wiki/Getting-help).
22 |
23 | ### Setup for advanced users
24 |
25 | You can install this software using docker with the instructions [here](docs/docker.md).
26 | Alternatively continue with the instructions below for installing on a system directly:
27 |
28 | #### Prerequisites
29 |
30 | - PHP 8 cli with pdo-pgsql (or pdo-mysql), curl, gd, pcntl and dom
31 | - A webserver serving .php files (PHP 8 with pdo-pgsql (or pdo-mysql))
32 | - (strongly recommended) HTTPS enabled server with certificate
33 | - A PostgreSQL server (Any version from 9 and up should work, although testing has only been done on 11 and up)
34 | - alternatively MySQL / MariaDB is supported, but PostgreSQL is recommended.
35 |
36 | #### Overview of the setup process
37 |
38 | Looking at the automated install script for debian [install.sh](docs/install.sh) alongside the following instructions
39 | might be helpful. (Instructions for using it can be found [here](docs/beginnerguide.md#installing-using-the-install-script))
40 |
41 | Clone this repository.
42 |
43 | `git clone https://github.com/robske110/IDDataLogger.git --recursive`
44 |
45 | Create a database (and a user) in your PostgreSQL (or other) server for this project and fill in the details into
46 | `config/config.example.json` and `.env.example.` We'll need these files later.
47 | You can do this using the config setup wizard by running the `config-wizard.sh` script, or manually.
48 | Note: for a detailed description of the possible config values visit [config.md](docs/config.md).
49 |
50 | After creating the config.json from config.example.json run `./start.sh`.
51 | The necessary tables in the database will be automatically created.
52 | After a successful connection to the db, the setup wizard will help you create an API key for the widget and a user for
53 | the website. You can create additional API keys or add additional users at any time using `./start.sh --wizard`.
54 |
55 | All files in the `public` directory of this repository must now be placed somewhere in the webroot.
56 | It is recommended to place them in the second level (not directly in webroot).
57 |
58 | Then copy the `.env` file (created from `.env.example`) outside the webroot with the db credentials set in it.
59 |
60 | Note:
61 | `env.php` looks for a `.env` file two folders up from its location.
62 | (If you put the contents of the public folder in `/path/to/webroot/vwid/` it will look in `/path/to/.env`)
63 | If you place the files deeper inside the webroot, please consider editing env.php and configuring the correct path in
64 | the first line. It is strongly recommended keeping the .env file out of the webroot.
65 |
66 | You can alternatively set the environment variables through your webserver. (Or anything else that populates php's `$_ENV`)
67 |
68 | You now need to set up your system to automatically start `start.sh` on system start. Using systemd is recommended.
69 |
70 | You can now visit idView.php or use the iOS widget after [setting it up](docs/ioswidget.md)!
71 |
72 | #### Updating
73 |
74 | To update the software at a later data execute `git pull && git submodule update` in the repository directory and
75 | replace the files in the webroot with the new contents of the `public` folder. Make sure to restart the php process.
76 | (The one started by `start.sh`)
77 |
78 | ## Contributing
79 |
80 | Contributions are always welcome! You can help to improve the documentation, fix bugs in the code or add new features.
81 |
82 | Improving the beginners guide and documentation are currently something I would love to have help with.
83 | Feel free to open a PR!
84 |
85 | ### A big 'Thank you!' to the following contributors
86 |
87 | - @drego83 - Invaluable help with general testing and MySQL support
88 |
89 | ## Disclaimer
90 |
91 | This project is not endorsed by Volkswagen in any way, shape or form. This project is to be used entirely at your own risk.
92 | All brands and trademarks belong to their respective owners.
93 |
94 | Copyright (C) 2021 robske_110
95 |
96 | This program is free software: you can redistribute it and/or modify
97 | it under the terms of the GNU General Public License as published by
98 | the Free Software Foundation, either version 3 of the License, or
99 | (at your option) any later version.
100 |
101 | This program is distributed in the hope that it will be useful,
102 | but WITHOUT ANY WARRANTY; without even the implied warranty of
103 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
104 | GNU General Public License for more details.
--------------------------------------------------------------------------------
/config-wizard.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | DIR="$(cd -P "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
4 | cd "$DIR" || exit 1
5 |
6 | exec "php" "./src/vwid/Server.php" "--configwizard" "$@"
--------------------------------------------------------------------------------
/config/config.example.json:
--------------------------------------------------------------------------------
1 | {
2 | "username": "",
3 | "password": "",
4 | "vin": null,
5 | "base-updaterate": 600,
6 | "increased-updaterate": 60,
7 | "db": {
8 | "host": "",
9 | "dbname": "",
10 | "user": "",
11 | "password": null,
12 | "driver": "pgsql"
13 | },
14 | "carpic": {
15 | "viewDirection": "front",
16 | "angle": "right",
17 | "flip": true
18 | },
19 | "integrations": {
20 | "abrp": {
21 | "user-token": "",
22 | "api-key": null
23 | }
24 | },
25 | "timezone": null,
26 | "logging": {
27 | "debug-enable": false,
28 | "curl-verbose": false,
29 | "file-enable": false,
30 | "log-dir": null
31 | }
32 | }
--------------------------------------------------------------------------------
/db.sql:
--------------------------------------------------------------------------------
1 | CREATE TABLE IF NOT EXISTS carStatus (
2 | time TIMESTAMP NOT NULL PRIMARY KEY,
3 | batterySOC decimal(3, 0),
4 | remainingRange smallint,
5 | remainingChargingTime smallint,
6 | chargeState text,
7 | chargePower decimal(4, 1),
8 | chargeRateKMPH smallint,
9 | maxChargeCurrentAC text,
10 | autoUnlockPlugWhenCharged text,
11 | targetSOC decimal(3, 0),
12 | plugConnectionState text,
13 | plugLockState text,
14 | remainClimatisationTime smallint,
15 | hvacState text,
16 | hvacTargetTemp decimal(3, 1),
17 | hvacWithoutExternalPower boolean,
18 | hvacAtUnlock boolean,
19 | windowHeatingEnabled boolean,
20 | zoneFrontLeftEnabled boolean,
21 | zoneFrontRightEnabled boolean,
22 | zoneRearLeftEnabled boolean,
23 | zoneRearRightEnabled boolean,
24 | frontWindowHeatingState text,
25 | rearWindowHeatingState text,
26 | odometer integer
27 | );
28 |
29 | CREATE TABLE IF NOT EXISTS users (
30 | userid serial NOT NULL PRIMARY KEY,
31 | username text UNIQUE NOT NULL,
32 | hash text NOT NULL
33 | );
34 |
35 | CREATE TABLE IF NOT EXISTS authKeys (
36 | authKey text UNIQUE NOT NULL
37 | );
38 |
39 | CREATE TABLE IF NOT EXISTS carPictures (
40 | pictureID varchar(128) NOT NULL PRIMARY KEY,
41 | carPicture text NOT NULL
42 | );
43 |
44 | CREATE TABLE IF NOT EXISTS chargingSessions (
45 | sessionid serial UNIQUE NOT NULL,
46 | startTime TIMESTAMP NOT NULL PRIMARY KEY,
47 | endTime TIMESTAMP,
48 | chargeStartTime TIMESTAMP,
49 | chargeEndTime TIMESTAMP,
50 | duration integer,
51 | avgChargePower decimal(4, 1),
52 | maxChargePower decimal(4, 1),
53 | minChargePower decimal(4, 1),
54 | chargeEnergy float4,
55 | rangeStart smallint,
56 | rangeEnd smallint,
57 | targetSOC smallint,
58 | socStart decimal(3, 0),
59 | socEnd decimal(3, 0)
60 | );
61 |
62 | CREATE TABLE IF NOT EXISTS settings (
63 | settingKey varchar(128) NOT NULL PRIMARY KEY,
64 | settingValue text
65 | )
--------------------------------------------------------------------------------
/db_mysql.sql:
--------------------------------------------------------------------------------
1 | CREATE TABLE IF NOT EXISTS carStatus (
2 | time TIMESTAMP NOT NULL PRIMARY KEY,
3 | batterySOC decimal(3, 0),
4 | remainingRange smallint,
5 | remainingChargingTime smallint,
6 | chargeState text,
7 | chargePower decimal(4, 1),
8 | chargeRateKMPH smallint,
9 | maxChargeCurrentAC text,
10 | autoUnlockPlugWhenCharged text,
11 | targetSOC decimal(3, 0),
12 | plugConnectionState text,
13 | plugLockState text,
14 | remainClimatisationTime smallint,
15 | hvacState text,
16 | hvacTargetTemp decimal(3, 1),
17 | hvacWithoutExternalPower boolean,
18 | hvacAtUnlock boolean,
19 | windowHeatingEnabled boolean,
20 | zoneFrontLeftEnabled boolean,
21 | zoneFrontRightEnabled boolean,
22 | zoneRearLeftEnabled boolean,
23 | zoneRearRightEnabled boolean,
24 | frontWindowHeatingState text,
25 | rearWindowHeatingState text,
26 | odometer integer
27 | );
28 |
29 | CREATE TABLE IF NOT EXISTS users (
30 | userid serial NOT NULL PRIMARY KEY,
31 | username varchar(64) UNIQUE NOT NULL,
32 | hash text NOT NULL
33 | );
34 |
35 | CREATE TABLE IF NOT EXISTS authKeys (
36 | authKey text UNIQUE NOT NULL
37 | );
38 |
39 | CREATE TABLE IF NOT EXISTS carPictures (
40 | pictureID varchar(128) NOT NULL PRIMARY KEY,
41 | carPicture mediumtext NOT NULL
42 | );
43 |
44 | CREATE TABLE IF NOT EXISTS chargingSessions (
45 | sessionid serial UNIQUE NOT NULL,
46 | startTime TIMESTAMP NOT NULL PRIMARY KEY,
47 | endTime TIMESTAMP NULL,
48 | chargeStartTime TIMESTAMP NULL,
49 | chargeEndTime TIMESTAMP NULL,
50 | duration integer,
51 | avgChargePower decimal(4, 1),
52 | maxChargePower decimal(4, 1),
53 | minChargePower decimal(4, 1),
54 | chargeEnergy float4,
55 | rangeStart smallint,
56 | rangeEnd smallint,
57 | targetSOC smallint,
58 | socStart decimal(3, 0),
59 | socEnd decimal(3, 0)
60 | );
61 |
62 | CREATE TABLE IF NOT EXISTS settings (
63 | settingKey varchar(128) NOT NULL PRIMARY KEY,
64 | settingValue mediumtext
65 | )
--------------------------------------------------------------------------------
/docker/.env.example:
--------------------------------------------------------------------------------
1 | IDDATALOGGER_USERNAME=
2 | IDDATALOGGER_PASSWORD=
3 | IDDATALOGGER_IDVIEW_USERNAME=
4 | IDDATALOGGER_IDVIEW_PASSWORD=
5 | IDDATALOGGER_WEB_PORT=80
--------------------------------------------------------------------------------
/docker/Dockerfile-app:
--------------------------------------------------------------------------------
1 | FROM php:8.0-cli AS base
2 |
3 | # install needed php extensions
4 | RUN apt-get update && apt-get install -y \
5 | libpng-dev \
6 | zlib1g-dev \
7 | libpq-dev \
8 | && docker-php-ext-install gd \
9 | && docker-php-ext-install pdo_pgsql \
10 | && docker-php-ext-install pcntl
11 |
12 | # copy all source files and scripts
13 | COPY . /usr/src/IDDataLogger
14 |
15 | # setup entrypoint with automatic config generation from environment variables
16 | ENTRYPOINT /usr/src/IDDataLogger/docker/docker-start.sh
--------------------------------------------------------------------------------
/docker/Dockerfile-web:
--------------------------------------------------------------------------------
1 | FROM php:8.0-apache AS base
2 |
3 | # install needed php extensions
4 | RUN apt-get update && apt-get install -y \
5 | libpq-dev \
6 | && docker-php-ext-install pdo_pgsql
7 |
8 | # copy puplic http content
9 | COPY ./public/. /var/www/html/
10 |
11 | # use production php config (no warnings)
12 | RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
--------------------------------------------------------------------------------
/docker/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: '3.7'
2 | services:
3 | db:
4 | image: postgres:latest
5 | container_name: iddatalogger_db
6 | restart: always
7 | environment:
8 | POSTGRES_USER: iddatalogger
9 | POSTGRES_DB: vwid
10 | POSTGRES_HOST_AUTH_METHOD: trust
11 | PGDATA: /var/lib/postgresql/data/pgdata
12 | volumes:
13 | - persistent_data_db:/var/lib/postgresql/data:rw
14 |
15 | app:
16 | build:
17 | context: ../
18 | dockerfile: ./docker/Dockerfile-app
19 | container_name: iddatalogger_app
20 | environment:
21 | IDDATALOGGER_USERNAME: ${IDDATALOGGER_USERNAME}
22 | IDDATALOGGER_PASSWORD: ${IDDATALOGGER_PASSWORD}
23 | IDDATALOGGER_VIN: ${IDDATALOGGER_VIN}
24 | IDDATALOGGER_BASE_UPDATERATE: ${IDDATALOGGER_BASE_UPDATERATE}
25 | IDDATALOGGER_INCREASED_UPDATERATE: ${IDDATALOGGER_INCREASED_UPDATERATE}
26 | IDDATALOGGER_CARPIC_VIEWDIRECTION: ${IDDATALOGGER_CARPIC_VIEWDIRECTION}
27 | IDDATALOGGER_CARPIC_ANGLE: ${IDDATALOGGER_CARPIC_ANGLE}
28 | IDDATALOGGER_CARPIC_FLIP: ${IDDATALOGGER_CARPIC_FLIP}
29 | IDDATALOGGER_TIMEZONE: ${IDDATALOGGER_TIMEZONE}
30 | IDDATALOGGER_LOGGING_CURL_VERBOSE: ${IDDATALOGGER_LOGGING_CURL_VERBOSE}
31 | IDDATALOGGER_LOGGING_DEBUG_ENABLE: ${IDDATALOGGER_LOGGING_DEBUG_ENABLE}
32 | IDDATALOGGER_LOGGING_FILE_ENABLE: ${IDDATALOGGER_LOGGING_FILE_ENABLE}
33 | IDDATALOGGER_INTEGRATIONS_ABRP_USER_TOKEN: ${IDDATALOGGER_INTEGRATIONS_ABRP_USER_TOKEN}
34 | IDDATALOGGER_INTEGRATIONS_ABRP_API_KEY: ${IDDATALOGGER_INTEGRATIONS_ABRP_API_KEY}
35 | IDDATALOGGER_DB_HOST: iddatalogger_db
36 | IDDATALOGGER_DB_DBNAME: vwid
37 | IDDATALOGGER_DB_USER: iddatalogger
38 | IDDATALOGGER_IDVIEW_USERNAME: ${IDDATALOGGER_IDVIEW_USERNAME}
39 | IDDATALOGGER_IDVIEW_PASSWORD: ${IDDATALOGGER_IDVIEW_PASSWORD}
40 | IDDATALOGGER_API_KEY: ${IDDATALOGGER_API_KEY}
41 | depends_on:
42 | - db
43 | restart: always
44 | volumes:
45 | - persistent_data_app:/usr/src/IDDataLogger/data:rw
46 |
47 | web:
48 | build:
49 | context: ../
50 | dockerfile: ./docker/Dockerfile-web
51 | container_name: iddatalogger_web
52 | environment:
53 | DB_HOST: iddatalogger_db
54 | DB_NAME: vwid
55 | DB_USER: iddatalogger
56 | FORCE_ALLOW_HTTP: "true"
57 | restart: always
58 | ports:
59 | - "${IDDATALOGGER_WEB_PORT}:80"
60 |
61 | volumes:
62 | persistent_data_db:
63 | persistent_data_app:
--------------------------------------------------------------------------------
/docker/docker-start.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | /usr/src/IDDataLogger/config-wizard.sh --use-env --fill-defaults --quiet
4 | /usr/src/IDDataLogger/start.sh --wizard --frontend-username ${IDDATALOGGER_IDVIEW_USERNAME} --frontend-password ${IDDATALOGGER_IDVIEW_PASSWORD} --frontend-apikey ${IDDATALOGGER_API_KEY}
5 |
--------------------------------------------------------------------------------
/docs/beginnerguide.md:
--------------------------------------------------------------------------------
1 | # Setup Guide for beginners
2 | Hi! You want to use this project, but have little to no experience setting up servers? This guide is for you!
3 | Please free up about an hour for setting this project up.
4 |
5 | Setting this project up on a Raspberry Pi is recommended for beginners. This guide assumes you are running raspbian.
6 | If you do not have a Raspberry Pi handy, any Debian installation will also work with the easy install scripts and this guide.
7 |
8 | Before we begin, let's go through what this project needs and does from a technical overview standpoint:
9 |
10 | This project contains a long-running program which will fetch data about your car from VW APIs and store it in a database.
11 | It also provides a website where you can view this data. Furthermore, it provides an API itself, providing the data in machine-readable format.
12 | This API is for example used for the iOS widget.
13 |
14 | To summarize we have three components: The long-running programm, the database and a webserver to serve you the statistics website or the data for the iOS widget.
15 | All of this can run on a Raspberry Pi.
16 |
17 | Let's get to work then.
18 |
19 | ## Prerequisites
20 | You'll need
21 | - a Raspberry Pi (see [supported models](https://github.com/robske110/IDDataLogger/wiki/Supported-Raspberry-PI-models)) with an internet connection and raspbian installed (alternatively any machine with a debian installation works)
22 | - a publicly routable IPv4 address if you want to use the widget and website from outside your home network (Some fibre plans for example do not include this)
23 |
24 | We assume you have your Raspberry Pi freshly setup and have the command prompt in front of you.
25 | There are plenty of guides on the internet on how to archive this.
26 |
27 | You should see the following line: `pi@Raspberry Pi:~ $`
28 |
29 | We strongly recommend changing your password on the Raspberry Pi to a strong one using the command `passwd`.
30 |
31 | If any problems or questions pop up during set up:
32 | 1. See the list of common problems and FAQs [here](https://github.com/robske110/IDDataLogger/wiki/FAQ-and-frequent-problems).
33 | 2. If there are remaining problems or questions see [getting help](https://github.com/robske110/IDDataLogger/wiki/Getting-help).
34 |
35 | Now you'll need to decide how you want to set this project up.
36 | There is a one-line command which installs this project automagically, but if you prefer to do some things manually and
37 | learn some things in the process jump to this [section](#installing-manually).
38 |
39 | ## Installing using the install script
40 |
41 | The install script works and is tested on raspbian and debian.
42 | It assumes you have a fresh OS, especially without any existing PostgreSQL or webserver installations.
43 |
44 | *Note for debian:* Run the install script as a normal user, **do not run it under root**! Make sure to have sudo installed and be in sudoers!
45 |
46 | Enter (or copy) the following command to download and run the install script:
47 |
48 | `wget https://raw.githubusercontent.com/robske110/IDDataLogger/master/docs/install.sh; bash install.sh; rm install.sh`
49 |
50 | The install script will produce a lot of output.
51 | After a few minutes you will be prompted for your VW account login information.
52 | It will ask for the username and password of your account. Note that the username is the E-Mail you use to log in.
53 | After you entered the information you should see `Installation complete, ...`.
54 |
55 | You'll now need to jump to [finishing setting up](#finishing-set-up).
56 |
57 | ## Installing manually
58 |
59 | We are going to execute a series of commands to set up this project on the pi.
60 | It is recommended to install this application in the home directory, although it is possible to use a different location.
61 | To get to the home directory execute `cd ~`
62 |
63 | #### 1. Installing software dependencies
64 |
65 | We need to install some software on the raspberry needed for this project.
66 |
67 | We need to install php, the language in which this project is written.
68 |
69 | ```
70 | wget -q -O - https://packages.sury.org/php/README.txt | bash -s -
71 | sudo apt install php8.0 php8.0-pgsql php8.0-curl php8.0-gd php8.0-dom
72 | ```
73 | The first command will install a repository which contains the latest version of PHP.
74 | The second command will install PHP 8, along with certain extensions we need.
75 | The same command will also install and set up the webserver apache2.
76 | The last command we'll need to execute is
77 |
78 | `sudo apt install postgresql`
79 |
80 | This will install the PostgreSQL database. It will store our information about the car.
81 |
82 | #### 2. Setting up the database
83 |
84 | We need to create a user and database in PostgreSQL for the ID DataLogger to be able to write and read from it.
85 |
86 | The user will have a username and password. Since this password will never have to be entered by you, we can generate a
87 | secure one automatically using the following command
88 |
89 | To be able to create new users and databases in PostgreSQL we will log in as the user that can administer the PostgreSQL
90 | database, which is called `postgres`:
91 |
92 | `sudo su postgres`
93 |
94 | We will first create a user in the database with the following two commands:
95 | ```
96 | pg_pw=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
97 | psql -c "CREATE USER iddatalogger WITH PASSWORD '$pg_pw';"
98 | ```
99 | The first cpmmand will create a secure password for our database. The second one will connect to the database and use
100 | the generated password to create the user iddatalogger. We must now echo this password using `echo "$pg_pw"`.
101 | You'll need the password in the one of the next steps, please copy it to a temporary location.
102 | Before we leave the postgres user we must create a database for the ID DataLogger: `createdb vwid`.
103 | We are now finished with setting up the PostgreSQL database and can leave the postgres user using `exit`.
104 |
105 | #### 3. Downloading and configuring the ID DataLogger
106 |
107 | We can now install git and clone this repository. This will download the ID DataLogger software.
108 | ```
109 | sudo apt install git
110 | git clone https://github.com/robske110/IDDataLogger.git --recursive
111 | ```
112 | Once we have done this we need to configure the ID DataLogger. We'll need to tell it the database details and our VW
113 | account login information. We'll change into the directory of the program by executing `cd IDDataLogger` and then run
114 | the config wizard with `./config-wizard.sh --allow-insecure-http`. The `allow-insecure-http` option allows us to test
115 | and run the application in our home network.
116 |
117 | The wizard will first ask for the username of the VW ID account. This is the E-Mail address you used to register at VW.
118 | After that you'll need to enter the password for your VW account.
119 |
120 | Now we need to configure the database parameters. It will ask us for the hostname of the database server. Since we run
121 | the database on the same machine the default value of `localhost` is correct and we can just press enter. Now it will
122 | ask us for the name of the database. We used createdb vwid earlier, so we'll need to enter `vwid` here. The username of
123 | the user we created earlier was `iddatalogger` so enter that for the next question. Now it will ask us for the password
124 | of the database. Here we'll need to enter the password that was generated earlier. It will now ask us which database
125 | driver it should use. The default of `pgsql` is fine, since it is an abbreviation for PostgreSQL.
126 |
127 | For additional configuration options after completing the config wizard see [config.md](config.md)
128 |
129 | #### 4. Copying files to the webserver
130 |
131 | We successfully configured the application. Now we will have to do what the config wizard told us: Copy the contents of
132 | the public folder to our webroot. This will copy the parts of the program that will be accessed from the internet (or
133 | home network) to the webserver, which needs to "serve" them. We can do that using the following commands:
134 | ```
135 | sudo rm /var/www/html/index.html # removes the default "It works!" page, this is optional!
136 | sudo mkdir /var/www/html/vwid/ # creates a new directory for the ID DataLogger
137 | sudo cp -r ./public/. /var/www/html/vwid # copies the files from the public folder
138 | sudo ln -s "$PWD/.env" /var/www/ # links the .env file (created by the Config Wizard) to the appropiate location
139 | ```
140 |
141 | #### 5. Creating a service for ID DataLogger
142 |
143 | After these command we need to create a service for the ID DataLogger fetch program. This will ensure that it will be
144 | started on every boot of the Raspberry PI and be able to fetch data continuously.
145 |
146 | ```
147 | echo "[Unit]
148 | Description=ID DataLogger php backend
149 | After=network.target
150 | Requires=postgresql.service
151 |
152 | [Service]
153 | ExecStart=/home/$(whoami)/IDDataLogger/start.sh
154 | WorkingDirectory=/home/$(whoami)/IDDataLogger
155 | StandardOutput=syslog
156 | StandardError=syslog
157 | SyslogIdentifier=iddatalogger
158 | User=$(whoami)
159 | RestartSec=5
160 | Restart=always
161 |
162 | [Install]
163 | WantedBy=multi-user.target" | sudo tee /etc/systemd/system/iddatalogger.service > /dev/null
164 | ```
165 | We need to enable the service using the command `sudo systemctl enable iddatalogger.service`.
166 |
167 | You can now continue in the next section.
168 |
169 | ## Finishing set up
170 |
171 | Make sure to be in the IDDataLogger directory. If you installed using the install script you will need to enter
172 | `cd ./IDDataLogger`. If you come from the manual installation you should already be at the correct location.
173 |
174 | You can now enter `./start.sh`, which will start the ID DataLogger.
175 | It will now ask you if you want to generate an API key. If you want to use the iOS widget you will need to answer with `Y`.
176 | For more information on setting up the iOS widget using the API key see [Setting up the iOS Widget](ioswidget.md).
177 | After that it will ask you if you want to create an user. This user is used to log into the website. Make sure to choose
178 | a strong and long password. It is recommended to store this in a password manager.
179 | Note that you can create additional API keys or add additional users at any time using `./start.sh --wizard`.
180 |
181 | After creating the API key and the user you should see `Done. Ready! Fetching car status...` and `Writing new data for timestamp`.
182 | This means you have successfully set up the ID DataLogger!
183 | Please shutdown the ID DataLogger using the key combination CTRL+C and reboot the Raspberry Pi using `systemctl reboot`.
184 |
185 | You can now access the ID DataLogger using the iOS widget or by entering `http://IP/vwid` into your browser where `IP` is the ip address or hostname of your raspberry.
186 |
187 | To find the ip address of your Raspberry Pi simply enter the command `hostname -I`.
188 |
189 | A command you might find useful from time to time is `sudo journalctl -u iddatalogger`. This will show the output of the fetch
190 | program and can help you debug issues if you ever have any trouble.
191 |
192 | If you want to view the website and have the iOS widget update outside your home network,
193 | please refer to [making the ID DataLogger available from the internet](https://github.com/robske110/IDDataLogger/wiki/Making-the-ID-DataLogger-available-from-the-internet).
194 |
195 | ## Updating the installation in the future
196 |
197 | Make sure to periodically keep your installation up-to-date to receive security and bug fixes along with new features.
198 | Execute the following commands to ensure raspbian and other software is secure and up-to-date:
199 | ```
200 | sudo apt update
201 | sudo apt -y upgrade
202 | sudo apt -y dist-upgrade
203 | systemctl reboot
204 | ```
205 | To update the ID DataLogger you can either execute the following command to do this automatically:
206 |
207 | `cd ~/IDDataLogger && ./docs/update.sh`
208 |
209 | Or if you want to do it manually go into the directory of the ID DataLogger installation with `cd ~/IDDataLogger`, update
210 | the ID DataLogger software files using `git pull && git submodule update`, remove the old files in the webserver directory
211 | using `sudo rm -r /var/www/html/vwid`, copy the new files into the directory using `sudo cp -r ./public/. /var/www/html/vwid`
212 | and finally restart the ID DataLogger fetch program by running `sudo systemctl restart iddatalogger.service`.
--------------------------------------------------------------------------------
/docs/certbot.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | DIR="$(cd -P "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
4 | cd "$DIR" || exit 1
5 |
6 | echo "What's your domain name?"
7 | read -r domain
8 | echo "Enter an E-Mail where you want to receive important certificate alerts (this will not be often)"
9 | read -r email
10 | sudo apt -y install certbot python3-certbot-apache
11 | sudo certbot --apache --agree-tos -n -m $email -d $domain
12 |
13 | cd ..
14 |
15 | sudo rm /var/www/.env
16 | ./config-wizard.sh --secure --quiet
17 | sudo cp ./.env /var/www/
--------------------------------------------------------------------------------
/docs/config.md:
--------------------------------------------------------------------------------
1 | # Config
2 |
3 | ## config.json
4 |
5 | `username` The E-Mail Address used for your VW ID account
6 |
7 | `password` The password used for your VW ID account
8 |
9 | `vin` The vin of the vehicle for which data should be logged.
10 | Can be `null`, which causes the first vehicle to be used. (Recommended when you only have one vehicle in your account)
11 |
12 | `base-updaterate` Updaterate for the car values. (Note: Data will only be written to db when data changed.)
13 |
14 | `increased-updaterate` This updaterate will be used while the car is charging or hvac is active, or if the last
15 | update was during the last 6 minutes (which will mainly be while driving).
16 |
17 | `db.host` The host of the postgres db server
18 |
19 | `db.dbname` The name of the database that this application can use
20 |
21 | `db.user` The username for the database
22 |
23 | `db.password` The password for the database
24 |
25 | `db.driver` The driver for the database. See https://www.php.net/manual/en/pdo.drivers.php for possible values.
26 |
27 | `carpic.flip` Whether to flip the carpic (default: true)
28 |
29 | The keys
30 | `carpic.viewDirection` and
31 | `carpic.angle`
32 | can have the following values:
33 |
34 | | viewDirection | angle |
35 | | ----- | ------ |
36 | | side | right |
37 | | side | left |
38 | | back | left |
39 | | back | right |
40 | | front | center |
41 | | front | left |
42 | | front | right |
43 |
44 | Note: For changes to the carpic settings to apply, delete data/carPic.png
45 |
46 | `integrations.abrp.user-token` The user token to use for the [ABRP integration](https://github.com/robske110/IDDataLogger/wiki/ABRP-integration), which can be generated in the ABRP app.
47 |
48 | `integrations.abrp.api-key` Strictly optional. Overrides the default (hardcoded) api token for the ABRP live data API.
49 |
50 | `timezone` Server timezone. This is used for correct timestamps in logs. (Overrides settings in php.ini)
51 |
52 | `logging.debug-enable` Enables debug output
53 |
54 | `logging.curl-verbose` Enables verbose curl output
55 | (Highly detailed, produces a lot of output and used for debugging login / api issues)
56 |
57 | `logging.file-enable` Enables debug output
58 |
59 | `logging.log-dir` The directory in which to store log files. Can be `null` for default directory (`program_directory/log`).
60 |
61 | Note: If you run config-wizard.sh with the `--use-env` option (default in docker) the ENV variable names will be the
62 | config names in uppercase with dots and hyphens are replaced by underscores and the prefix IDDATALOGGER.
63 | (For example `logging.log-dir` becomes `IDDATALOGGER_LOGGING_LOG_DIR`.)
64 |
65 | ## .env file
66 |
67 | `DB_HOST` The host of the postgres db server
68 |
69 | `DB_NAME` The name of the database that this application can use
70 |
71 | `DB_USER` The username for the database
72 |
73 | `DB_PASSWORD` The password for the database
74 |
75 | `DB_DRIVER` The driver for the database. See https://www.php.net/manual/en/pdo.drivers.php for possible values.
76 |
77 | `FORCE_ALLOW_HTTP` Set this option to true to force the login system to allow http access.
78 | It is strongly recommended to omit this option whenever possible, especially on installations accessible over the internet.
--------------------------------------------------------------------------------
/docs/docker.md:
--------------------------------------------------------------------------------
1 | # Setup with docker
2 |
3 | A docker-compose setup with associated Dockerfiles is provided for running this application using docker.
4 |
5 | There are three docker containers:
6 | - db - based on postgres, hosts the database and persists its data
7 | - web - based on php-apache, hosts the frontend and persists nothing
8 | - app - based on php, hosts the background fetcher and persists the data directory (currently used for caching carPic)
9 |
10 | All configuration is done using environment variables.
11 |
12 | ### Installing
13 |
14 | Clone this repository and change into the docker subdirectory.
15 |
16 | `git clone https://github.com/robske110/IDDataLogger.git --recursive && cd ./IDDataLogger/docker`
17 |
18 | Create a .env file in the docker directory (using .env.example of the docker directory as a basis).
19 | Make sure to be in the docker subdirectory! The .env file in the root directory IS NOT USED in the docker installation!
20 |
21 | You need to set at least
22 | `IDDATALOGGER_USERNAME`,
23 | `IDDATALOGGER_PASSWORD`,
24 | `IDDATALOGGER_IDVIEW_USERNAME` and
25 | `IDDATALOGGER_IDVIEW_PASSWORD`
26 | for the application to work.
27 | `IDDATALOGGER_USERNAME` and `IDDATALOGGER_PASSWORD` have to be set to the credentials of your
28 | VW account. The IDVIEW variants are for the account created for the web frontend of this application.
29 |
30 | Note: If you plan to use the iOS widget and want to create a custom authentication key for it, set `IDDATALOGGER_API_KEY`
31 | to your desired key. Otherwise, an API key will be automatically generated, and you'll need to copy it from the log
32 | output on first startup.
33 | ```
34 | iddatalogger_app | [Y]: Successfully generated the API key ad65c068e1a7cf6bee6f65a6f04157545ba22d870a0a1fe019b20989e26c6749
35 | iddatalogger_app | Please enter this API key in the apiKey setting at the top of the iOS widget!
36 | ```
37 |
38 | Further environment variables available are the same as defined in [config.md](docs/config.md). The environment variable
39 | names for the configuration options will be all UPPERCASE with hyphens and dots replaced by underscores and prefixed
40 | with `IDDATALOGGER`.
41 | (For example `logging.debug-enable` becomes `IDDATALOGGER_LOGGING_DEBUG_ENABLE`)
42 |
43 | After creating the .env file the last command to execute is `docker compose up`.
44 |
45 | You can now visit `localhost:IDDATALOGGER_WEB_PORT` or [set up](docs/ioswidget.md) the iOS widget using the API key
46 | you copied from the first startup log or specified using `IDDATALOGGER_API_KEY`!
47 |
48 | If you want to access the ID DataLogger from the internet, please place it behind a reverse-proxy providing SSL
49 | certificates and HTTPS support.
50 |
51 | ### Updating
52 |
53 | To update the software at a later data execute `git pull && git submodule update` in the repository directory and
54 | rebuild the docker containers web and app. (`docker-compose build web && docker-compose build app`)
--------------------------------------------------------------------------------
/docs/img/idView.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/robske110/IDDataLogger/3c6cd0d92e40ec9defd06dc7efc0056a26c1e576/docs/img/idView.png
--------------------------------------------------------------------------------
/docs/img/widget.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/robske110/IDDataLogger/3c6cd0d92e40ec9defd06dc7efc0056a26c1e576/docs/img/widget.png
--------------------------------------------------------------------------------
/docs/img/widget_and_chargingOverview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/robske110/IDDataLogger/3c6cd0d92e40ec9defd06dc7efc0056a26c1e576/docs/img/widget_and_chargingOverview.png
--------------------------------------------------------------------------------
/docs/img/widgetcharging.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/robske110/IDDataLogger/3c6cd0d92e40ec9defd06dc7efc0056a26c1e576/docs/img/widgetcharging.png
--------------------------------------------------------------------------------
/docs/img/widgets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/robske110/IDDataLogger/3c6cd0d92e40ec9defd06dc7efc0056a26c1e576/docs/img/widgets.png
--------------------------------------------------------------------------------
/docs/install.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | #Install script for clean debian-based systems.
3 |
4 | if [ "${EUID:-$(id -u)}" -eq 0 ]; then
5 | echo "This install script is not to be run as root or with sudo."
6 | echo "Please run it with sudo installed and from a normal user who is in sudoers!"
7 | exit
8 | fi
9 | cd ~ || exit
10 | wget -q -O - https://packages.sury.org/php/README.txt | bash -s -
11 | sudo apt -y install php8.0 php8.0-pgsql php8.0-curl php8.0-gd php8.0-dom
12 | sudo apt -y install postgresql
13 | pg_pw=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
14 | sudo su postgres -c "psql -c \"DO \\$\\$
15 | BEGIN
16 | IF EXISTS (SELECT FROM pg_roles WHERE rolname='iddatalogger') THEN
17 | ALTER ROLE iddatalogger WITH PASSWORD '$pg_pw';
18 | ELSE
19 | CREATE USER iddatalogger WITH PASSWORD '$pg_pw';
20 | END IF;
21 | END \\$\\$;\"; createdb vwid"
22 | sudo apt -y install git
23 | git clone https://github.com/robske110/IDDataLogger.git --recursive
24 | cd IDDataLogger || exit
25 | ./config-wizard.sh --host localhost --user iddatalogger --dbname vwid --password "$pg_pw" --driver pgsql --allow-insecure-http --quiet
26 | sudo rm /var/www/html/index.html #remove default "It works!" page
27 | sudo mkdir /var/www/html/vwid/
28 | sudo cp -r ./public/. /var/www/html/vwid
29 | sudo ln -s "$PWD/.env" /var/www/
30 | echo "[Unit]
31 | Description=ID DataLogger php backend
32 | After=network.target
33 | Requires=postgresql.service
34 |
35 | [Service]
36 | ExecStart=/home/$(whoami)/IDDataLogger/start.sh
37 | WorkingDirectory=/home/$(whoami)/IDDataLogger
38 | StandardOutput=syslog
39 | StandardError=syslog
40 | SyslogIdentifier=iddatalogger
41 | User=$(whoami)
42 | RestartSec=5
43 | Restart=always
44 |
45 | [Install]
46 | WantedBy=multi-user.target" | sudo tee /etc/systemd/system/iddatalogger.service > /dev/null
47 | sudo systemctl enable iddatalogger.service
48 | echo "Installation complete! You can now enter cd IDDataLogger && ./start.sh to finish setting up."
--------------------------------------------------------------------------------
/docs/ioswidget.md:
--------------------------------------------------------------------------------
1 | # Setting up the iOS Widget
2 |
3 | The iOS widget is created using Scriptable App.
4 |
5 | ### Steps to get the script into the Scriptable App
6 |
7 | 1. Download Scriptable from the iOS App Store.
8 | 2. Download the file `Car.scriptable` from the latest [release](https://github.com/robske110/IDDatalogger/releases)
9 | 4. If you own a mac airdrop this file to your iOS device and open it in Scriptable.
10 |
11 | On other operating system you'll need to send the file to your iOS device in another way, for example by e-mail.
12 | 3. Edit the file *in scriptable* according to the instructions in [Changing settings in the script](#changing-settings-in-the-script)
13 |
14 | If you prefer to edit the settings on your PC you will need to edit [Car.js](../Car.js) and copy the contents of it in
15 | scriptable.
16 |
17 | ### Changing settings in the script
18 |
19 | #### Initial setup
20 |
21 | To put the necessary API key and base URL into the script you'll need to open it in Scriptable.
22 | To do this click the three dots on the Script entry in the Scriptable app.
23 |
24 | You'll now need to find the line `const apiKey = ""` and place the API key you got during the setup phase of the IDDataLogger between the "".
25 |
26 | After that you need to place the baseURL between the "" in the line which says `const baseURL = ""`.
27 |
28 | If you have used the install script on a raspberry pi the baseURL will be
29 | `http://xxx.xxx.xxx.xxx/vwid/`
30 | where xxx.xxx.xxx.xxx is the IP of your raspberry pi.
31 | If you've already made the ID DataLogger availible from the internet use `https://your-hostname.tld/vwid/` instead.
32 |
33 | #### More settings
34 |
35 | Further settings available are described in the following table:
36 |
37 | | setting | explanation |
38 | | ------- | ----------- |
39 | | rangeInMiles | set this to true if you want to have the range displayed in miles |
40 | | showFinishTime | set this to false if you want to hide the charge finish time and only display charge time remaining |
41 | | forceImageRefresh | set this to true after you've changed the carPicture (data/carPic.png) to force the widget to update it |
42 | | exampleData | set this to true to force the widget to display example data and not to fetch from baseURL |
43 | | timetravel | set this to an unix timestamp (in seconds) if you want to display values as if the widget was last updated at that time. Mostly useful for debugging. |
44 | | socThreshold | not implemented |
--------------------------------------------------------------------------------
/docs/update.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | #Update script for debian-based systems.
3 |
4 | cd ~ || exit
5 | cd IDDataLogger || exit
6 | git pull --rebase
7 | git submodule update
8 | sudo rm -r /var/www/html/vwid/
9 | sudo cp -r ./public/. /var/www/html/vwid
10 | sudo systemctl restart iddatalogger.service
11 | echo "Update complete!"
--------------------------------------------------------------------------------
/public/DatabaseConnection.php:
--------------------------------------------------------------------------------
1 | host = $host;
27 | $this->db = $db;
28 | $this->username = $username;
29 | $this->password = $password;
30 | $this->driver = $driver;
31 | $this->connect();
32 | }
33 |
34 | public function connect(){
35 | $this->connection = new PDO(
36 | $this->driver.":host=".$this->host.";dbname=".$this->db, $this->username, $this->password
37 | );
38 | }
39 |
40 | public function getConnection(): PDO{
41 | return $this->connection;
42 | }
43 |
44 | public function query(string $sql): array{
45 | $res = $this->connection->query($sql);
46 | return $res->fetchAll(PDO::FETCH_ASSOC);
47 | }
48 |
49 | public function queryStatement(string $sql): PDOStatement{
50 | return $this->connection->query($sql);
51 | }
52 |
53 | public function prepare(string $sql): PDOStatement{
54 | return $this->connection->prepare($sql);
55 | }
56 | }
--------------------------------------------------------------------------------
/public/carPicture.php:
--------------------------------------------------------------------------------
1 | format(DateTime::RFC1123));
6 | define("ALLOW_KEY_AUTHENTICATION", true);
7 | require "login/loginCheck.php";
8 | require_once "DatabaseConnection.php";
9 |
10 | $carPics = DatabaseConnection::getInstance()->query("SELECT carpicture FROM carPictures WHERE pictureID = 'default'");
11 |
12 | $pic = base64_decode($carPics[0]["carpicture"]);
13 | header("Content-Type: image/png");
14 | header("Content-Length: ".strlen($pic));
15 | echo($pic);
--------------------------------------------------------------------------------
/public/carStatus.php:
--------------------------------------------------------------------------------
1 | format("Y-m-d\TH:i:s")."'";
11 | }
12 |
13 | if($attemptRefresh){
14 | if($statusAt !== null){
15 | error("unsupported argument combination!");
16 | }
17 | echo("not implemented");
18 | }
19 |
20 | $columns = "time, batterySOC, remainingRange, remainingChargingTime, chargeState, chargePower, chargeRateKMPH, targetSOC, plugConnectionState, plugLockState, remainClimatisationTime, hvacState, hvacTargetTemp";
21 | $sqlCmd = "SELECT ".$columns." FROM carStatus".($statusAt ?? "")." ORDER BY time DESC LIMIT 1";
22 |
23 | $sqlChargeStart = "WITH chargeState_wprev AS (
24 | SELECT time, chargeState, lag(chargeState) over(ORDER BY time ASC) AS prev_chargeState
25 | FROM carStatus".($statusAt ?? "")."
26 | ORDER BY time DESC
27 | )
28 | SELECT time, chargeState, prev_chargeState
29 | FROM chargeState_wprev
30 | WHERE prev_chargeState IN ('readyForCharging', 'notReadyForCharging') AND chargeState = 'charging' LIMIT 1";
31 |
32 | if(($_ENV["DB_DRIVER"] ?? "pgsql") != "pgsql"){
33 | if($statusAt !== null){
34 | $statusAt = "WHERE startTime ".substr($statusAt, 11);
35 | }
36 | $sqlChargeStart = "SELECT startTime AS time FROM chargingSessions ".($statusAt ?? "")." ORDER BY startTime DESC LIMIT 1;";
37 | }
38 |
39 |
40 | $chargeStartRes = DatabaseConnection::getInstance()->queryStatement($sqlChargeStart)->fetch(PDO::FETCH_ASSOC);
41 |
42 | $carStatus = DatabaseConnection::getInstance()->queryStatement($sqlCmd)->fetch(PDO::FETCH_ASSOC);
43 | if(empty($carStatus)){
44 | error("no data");
45 | }
46 | $columns = explode(", ", $columns);
47 | foreach($carStatus as $key => $value){
48 | foreach($columns as $columnName){
49 | if($key === strtolower($columnName) && $key !== $columnName){
50 | $carStatus[$columnName] = $value;
51 | unset($carStatus[$key]);
52 | break;
53 | }
54 | }
55 | }
56 | $carStatus["lastChargeStartTime"] = (new DateTime($chargeStartRes["time"] ?? $carStatus["time"], new DateTimeZone("UTC")))->format(DateTimeInterface::ATOM);
57 | $carStatus["time"] = (new DateTime($carStatus["time"], new DateTimeZone("UTC")))->format(DateTimeInterface::ATOM);
58 | #var_dump($carStatus);
59 |
60 | echo(json_encode($carStatus));
61 |
62 | function error(string $msg){
63 | echo(json_encode(["error" => $msg]));
64 | exit;
65 | }
--------------------------------------------------------------------------------
/public/chargingSessionDataProvider.php:
--------------------------------------------------------------------------------
1 | $this->id,
27 | "startTime" => $this->startTime,
28 | "endTime" => $this->endTime,
29 | "chargeStartTime" => $this->chargeStartTime,
30 | "chargeEndTime" => $this->chargeEndTime,
31 | "duration" => $this->chargeDuration,
32 | "avgChargePower" => $this->avgChargePower,
33 | "maxChargePower" => $this->maxChargePower,
34 | "minChargePower" => $this->minChargePower,
35 | "chargeEnergy" => $this->integralChargeEnergy,
36 | "rangeStart" => $this->rangeStart,
37 | "rangeEnd" => $this->rangeEnd,
38 | "targetSOC" => $this->targetSOC,
39 | "socStart" => $this->socStart,
40 | "socEnd" => $this->socEnd
41 | ];
42 | }
43 | }
44 |
45 | class chargingSessionDataProvider{
46 | private int $beginTime;
47 | private int $endTime;
48 |
49 | private float $took;
50 |
51 | public function __construct(int $beginTime, int $endTime){
52 | $this->beginTime = $beginTime;
53 | $this->endTime = $endTime;
54 | }
55 |
56 | private static function formatDate(string $dbDate): string{
57 | return ((new DateTime($dbDate, new DateTimeZone("UTC")))->format(DateTimeInterface::ATOM));
58 | }
59 |
60 | private static function nullableFormatDate(?string $dbDate): ?string{
61 | return $dbDate === null ? null : self::formatDate($dbDate);
62 | }
63 |
64 | public function getChargingSessions(): array{
65 | $beginTime = microtime(true);
66 | $data = $this->fetchFromDB($this->beginTime, $this->endTime);
67 |
68 | $chargingSessions = [];
69 | foreach($data as $chargeSessionData){
70 | $chargingSession = new ChargingSession();
71 | $chargingSession->id = (int) $chargeSessionData["sessionid"];
72 | $chargingSession->startTime = self::formatDate($chargeSessionData["starttime"]);
73 | $chargingSession->endTime = self::nullableFormatDate($chargeSessionData["endtime"]);
74 | $chargingSession->chargeStartTime = self::nullableFormatDate($chargeSessionData["chargestarttime"]);
75 | $chargingSession->chargeEndTime = self::nullableFormatDate($chargeSessionData["chargeendtime"]);
76 | $chargingSession->chargeDuration = (int) $chargeSessionData["duration"];
77 | $chargingSession->avgChargePower = (float) $chargeSessionData["avgchargepower"];
78 | $chargingSession->maxChargePower = (float) $chargeSessionData["maxchargepower"];
79 | $chargingSession->minChargePower = (float) $chargeSessionData["minchargepower"];
80 | $chargingSession->integralChargeEnergy = (float) $chargeSessionData["chargeenergy"];
81 | $chargingSession->rangeStart = (int) $chargeSessionData["rangestart"];
82 | $chargingSession->rangeEnd = (int) $chargeSessionData["rangeend"];
83 | $chargingSession->targetSOC = (int) $chargeSessionData["targetsoc"];
84 | $chargingSession->socStart = (int) $chargeSessionData["socstart"];
85 | $chargingSession->socEnd = (int) $chargeSessionData["socend"];
86 |
87 | $chargingSessions[] = $chargingSession;
88 | }
89 |
90 | $endTime = microtime(true);
91 | $this->took = $endTime - $beginTime;
92 |
93 | return $chargingSessions;
94 | }
95 |
96 | public function getTook(): float{
97 | return $this->took;
98 | }
99 |
100 | private function fetchFromDB(int $beginTime, int $endTime): array{
101 | $beginTime = new DateTime("@".$beginTime, new DateTimeZone("UTC"));
102 | $endTime = new DateTime("@".$endTime, new DateTimeZone("UTC"));
103 | $data = DatabaseConnection::getInstance()->query(
104 | "SELECT sessionid,
105 | starttime,
106 | endtime,
107 | chargestarttime,
108 | chargeendtime,
109 | duration,
110 | avgchargepower,
111 | maxchargepower,
112 | minchargepower,
113 | chargeenergy,
114 | rangestart,
115 | rangeend,
116 | targetsoc,
117 | socstart,
118 | socend FROM chargingSessions WHERE starttime >= TIMESTAMP '".
119 | $beginTime->format("Y-m-d\TH:i:s").
120 | "' AND starttime <= TIMESTAMP '".$endTime->format("Y-m-d\TH:i:s")."' ORDER BY startTime DESC"
121 | );
122 | #var_dump($data);
123 | return $data;
124 | }
125 | }
--------------------------------------------------------------------------------
/public/chargingSessions.php:
--------------------------------------------------------------------------------
1 | getChargingSessions();
15 |
16 | $chgSessions = [];
17 | foreach($chargingSessions as $chargingSession){
18 | $chgSessions[] = $chargingSession->toArray();
19 | }
20 |
21 | echo(json_encode($chgSessions));
--------------------------------------------------------------------------------
/public/env.php:
--------------------------------------------------------------------------------
1 | $var){
8 | $_ENV[$key] = $var;
9 | }
10 | }
11 |
12 | $required_envvars = ["DB_HOST", "DB_NAME", "DB_USER"];
13 | foreach($required_envvars as $required_envvar){
14 | if(!isset($_ENV[$required_envvar])){
15 | echo("Error: required envvar ".$required_envvar." not set!\n");
16 | exit;
17 | }
18 | }
19 |
20 | if($_ENV["FORCE_ALLOW_HTTP"] === "true"){
21 | $_ENV["FORCE_ALLOW_HTTP"] = true;
22 | }
23 |
24 | if(isset($_ENV["TIMEZONE_OVERRIDE"])){
25 | date_default_timezone_set($_ENV["TIMEZONE_OVERRIDE"]);
26 | }
--------------------------------------------------------------------------------
/public/idView/carGraphData.php:
--------------------------------------------------------------------------------
1 | getGraphData()->toArray()));
--------------------------------------------------------------------------------
/public/idView/carGraphDataProvider.php:
--------------------------------------------------------------------------------
1 | $this->time,
17 | "batterySOC" => $this->batterySOC,
18 | "targetSOC" => $this->targetSOC,
19 | "remainingRange" => $this->remainingRange,
20 | "remainingChargingTime" => $this->remainingChargingTime,
21 | "chargePower" => $this->chargePower,
22 | "chargeRateKMPH" => $this->chargeRateKMPH
23 | ];
24 | }
25 | }
26 |
27 | class carGraphDataProvider{
28 | private int $beginTime;
29 | private int $endTime;
30 | private bool $dataBracketing;
31 |
32 | private float $took;
33 |
34 | public function __construct(int $beginTime, int $endTime, bool $dataBracketing){
35 | $this->beginTime = $beginTime;
36 | $this->endTime = $endTime;
37 | $this->dataBracketing = $dataBracketing;
38 | }
39 |
40 | public function getGraphData(): ?carGraphData{
41 | $beginTime = microtime(true);
42 | $data = $this->fetchFromDB($this->beginTime, $this->endTime);
43 |
44 | $carGraphData = new carGraphData;
45 | if(empty($data)){
46 | return $carGraphData;
47 | }
48 |
49 | $carGraphData->batterySOC = array_column($data, "batterysoc");
50 | $carGraphData->targetSOC = array_column($data, "targetsoc");
51 | $carGraphData->remainingRange = array_column($data, "remainingrange");
52 | $carGraphData->remainingChargingTime = array_column($data, "remainingchargingtime");
53 | $carGraphData->chargePower = array_column($data, "chargepower");
54 | $carGraphData->chargeRateKMPH = array_column($data, "chargeratekmph");
55 |
56 | $carGraphData->time = array_column($data, "time");
57 | $timeCnt = count($carGraphData->time);
58 | for($i = 0; $i < $timeCnt; $i++){
59 | $carGraphData->time[$i] = ((new DateTime($carGraphData->time[$i], new DateTimeZone("UTC")))->format(DateTimeInterface::ATOM));
60 | }
61 |
62 | if($this->dataBracketing){
63 | $this->performDataBracketing($carGraphData);
64 | }
65 | $endTime = microtime(true);
66 | $this->took = $endTime - $beginTime;
67 |
68 | return $carGraphData;
69 | }
70 |
71 | public function getTook(): float{
72 | return $this->took;
73 | }
74 |
75 | const MAX_DATA_POINT_DISTANCE = 2*60;
76 | const MAX_GROUP_TIME_LEN = 5*60;
77 |
78 | private function performDataBracketing(carGraphData $data){
79 | //step 1: build groups
80 | $groups = [];
81 | $dataCnt = count($data->time);
82 | for($i = 0; $i < $dataCnt; $i++){
83 | #out("Begining group at $i");
84 | $groupStartTime = (new DateTime($data->time[$i]))->getTimestamp();
85 | $groups[$groupStartTime] = [$i];
86 | $groupStart = $i;
87 | $lastTime = PHP_INT_MAX;
88 | for($groupPos = $i+1; $groupPos < $dataCnt; ++$groupPos){
89 | $currTime = (new DateTime($data->time[$groupPos]))->getTimestamp();
90 | if($currTime - $groupStartTime >= self::MAX_GROUP_TIME_LEN || $currTime - $lastTime >= self::MAX_DATA_POINT_DISTANCE){
91 | #out("Exiting group at $groupPos: ".($currTime - $groupStartTime)."s from groupStart and ".($currTime - $lastTime)."s from last point in group. (start: $time[$i] end: $time[$groupPos])");
92 | break;
93 | }
94 | $groups[$groupStartTime][] = $groupPos;
95 | $lastTime = $currTime;
96 | }
97 | $i = $groupPos-1;
98 | }
99 | //step 2: only use last value of each group
100 | foreach($groups as $group){
101 | for($i = 0; $i < count($group)-1; ++$i){
102 | #var_dump($group);
103 | #echo("rem at $group[$i] ::".count($group));
104 | unset($data->time[$group[$i]]);
105 | unset($data->batterySOC[$group[$i]]);
106 | unset($data->targetSOC[$group[$i]]);
107 | unset($data->remainingRange[$group[$i]]);
108 | unset($data->remainingChargingTime[$group[$i]]);
109 | unset($data->chargePower[$group[$i]]);
110 | unset($data->chargeRateKMPH[$group[$i]]);
111 | }
112 | }
113 | $data->time = array_values($data->time);
114 | $data->batterySOC = array_values($data->batterySOC);
115 | $data->targetSOC = array_values($data->targetSOC);
116 | $data->remainingRange = array_values($data->remainingRange);
117 | $data->remainingChargingTime = array_values($data->remainingChargingTime);
118 | $data->chargePower = array_values($data->chargePower);
119 | $data->chargeRateKMPH = array_values($data->chargeRateKMPH);
120 | }
121 |
122 | private function fetchFromDB(int $beginTime, int $endTime): array{
123 | $beginTime = new DateTime("@".$beginTime, new DateTimeZone("UTC"));
124 | $endTime = new DateTime("@".$endTime, new DateTimeZone("UTC"));
125 | $data = DatabaseConnection::getInstance()->query(
126 | "SELECT time, batterysoc, targetsoc, remainingrange, remainingchargingtime, chargepower, chargeratekmph FROM carStatus WHERE time >= TIMESTAMP '".
127 | $beginTime->format("Y-m-d\TH:i:s").
128 | "' AND time <= TIMESTAMP '".$endTime->format("Y-m-d\TH:i:s")."' ORDER BY time ASC"
129 | );
130 | #var_dump($data);
131 | return $data;
132 | }
133 | }
--------------------------------------------------------------------------------
/public/idView/chargingOverview.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | chargingOverview
11 |
12 |
13 |
12 | 
13 |