mirror of
https://github.com/lildude/ha-addon-teslamate.git
synced 2026-10-13 21:19:16 -04:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
453252d864 | ||
|
|
800d3ee3ab | ||
|
|
562fd279b0 | ||
|
|
9d0729c9bf | ||
|
|
e3a352b44d | ||
|
|
fc5f6d6c2d | ||
|
|
db77437898 | ||
|
|
111527b4b6 | ||
|
|
df2f87600b | ||
|
|
4bc610e9a7 | ||
|
|
48cc287c98 |
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "HA Addon: TeslaMate",
|
||||
"image": "ghcr.io/home-assistant/devcontainer:addons",
|
||||
"image": "ghcr.io/home-assistant/devcontainer:2-addons",
|
||||
"appPort": ["7123:8123", "7357:4357"],
|
||||
"postStartCommand": "sudo sed -i 's/export SUPERVISOR_VERSION=.*/export SUPERVISOR_VERSION=2024.03.1.dev1803/' /etc/supervisor_scripts/common && bash devcontainer_bootstrap", // Workaround until https://github.com/home-assistant/supervisor/issues/5021 is fixed"
|
||||
"postStartCommand": "bash devcontainer_bootstrap",
|
||||
"runArgs": ["-e", "GIT_EDITOR=code --wait", "--privileged"],
|
||||
"containerEnv": {
|
||||
"WORKSPACE_DIRECTORY": "${containerWorkspaceFolder}"
|
||||
@@ -27,5 +27,8 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"mounts": ["type=volume,target=/var/lib/docker"]
|
||||
"mounts": [
|
||||
"type=volume,target=/var/lib/docker",
|
||||
"type=volume,target=/mnt/supervisor"
|
||||
]
|
||||
}
|
||||
@@ -42,7 +42,7 @@ jobs:
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build and publish
|
||||
uses: home-assistant/builder@2025.02.0
|
||||
uses: home-assistant/builder@2025.03.0
|
||||
with:
|
||||
args: |
|
||||
--${{ matrix.arch }} \
|
||||
|
||||
@@ -52,7 +52,7 @@ jobs:
|
||||
git push --tags
|
||||
working-directory: ${{ github.workspace }}/teslamate
|
||||
- name: Create release
|
||||
uses: softprops/action-gh-release@v2.2.1
|
||||
uses: softprops/action-gh-release@v2.3.2
|
||||
with:
|
||||
tag_name: v${{ steps.semver.outputs.semver }}
|
||||
body_path: CHANGELOG.txt
|
||||
|
||||
@@ -35,7 +35,7 @@ jobs:
|
||||
uses: actions/checkout@v4.2.2
|
||||
|
||||
- name: Build add-on
|
||||
uses: home-assistant/builder@2025.02.0
|
||||
uses: home-assistant/builder@2025.03.0
|
||||
with:
|
||||
args: |
|
||||
--test \
|
||||
|
||||
@@ -7,7 +7,7 @@ A self-hosted data logger for your Tesla 🚘
|
||||
[TeslaMate][teslamate] is a powerful, self-hosted data logger for your Tesla.
|
||||
|
||||
- Written in **[Elixir][elixir]**
|
||||
- Data is stored in a **Postgres** database
|
||||
- Data is stored in a **PostgreSQL** database
|
||||
- Visualization and data analysis with **Grafana**
|
||||
- Vehicle data is published to a local **MQTT** Broker
|
||||
|
||||
@@ -108,7 +108,7 @@ Once you have Grafana up and running, you'll need to configure a data source to
|
||||
|
||||
‼️ **Note**: The name must be `TeslaMate` as all the dashboards expect the datasource to use this name.
|
||||
|
||||
![Grafana Postgres data source][grafana-datasource]
|
||||
![Grafana PostgreSQL data source][grafana-datasource]
|
||||
|
||||
#### Other Options
|
||||
|
||||
@@ -130,7 +130,7 @@ Once you have Grafana up and running, you'll need to configure a data source to
|
||||
## TeslaMate Configuration
|
||||
|
||||
In order for the links in the Grafana dashboards and the TeslaMate UI to link to the correct locations, you will also need to configure TeslaMate.
|
||||
Once you have started the addon, look at the log output for the section which looks like this and take note of the two lines with `=>`:
|
||||
Once you have started the add-on, look at the log output for the section which looks like this and take note of the two lines with `=>`:
|
||||
|
||||
```
|
||||
[09:26:32] INFO: Configure TeslaMate settings by adding these values
|
||||
@@ -141,7 +141,7 @@ Once you have started the addon, look at the log output for the section which lo
|
||||
|
||||
```
|
||||
|
||||
From the addon Info tab, click "Open Web UI", enter the Tesla API access and refresh tokens if you haven't already, and then go to TeslaMate's Settings.
|
||||
From the add-on Info tab, click "Open Web UI", enter the Tesla API access and refresh tokens if you haven't already, and then go to TeslaMate's Settings.
|
||||
Scroll to the very bottom and set each of the URLs to the URL you use to access your Home Assistant instance with each of the above appended.
|
||||
|
||||
For example, if you access your Home Assistant instance at `https://ha.example.com`, set each as follows:
|
||||
@@ -151,6 +151,70 @@ For example, if you access your Home Assistant instance at `https://ha.example.c
|
||||
|
||||
Do _not_ use these values. Use the values from your log output.
|
||||
|
||||
## Migrate TeslaMate to a Different PostgreSQL Server
|
||||
|
||||
In order to migrate TeslaMate to a different PostgreSQL server, you will need to make a backup of the original data and then restore it to the destination server.
|
||||
This isn't much of a challenge for the seasoned sysadmin familiar with Docker, PostgreSQL and the command line, however most Home Assistant users aren't expert sysadmins so this guide if for you.
|
||||
|
||||
1. Ensure you have both the current and new PostgreSQL servers installed and running and ensure you have the same users and roles configured on both.
|
||||
|
||||
2. Stop the TeslaMate add-on.
|
||||
|
||||
3. Install the [pgAdmin4](https://github.com/expaso/hassos-addons) add-on.
|
||||
|
||||
4. Start the pgAdmin4 add-on and open the web UI
|
||||
|
||||
5. Make a new connection to the current PostgreSQL server by clicking "Add New Server".
|
||||
|
||||
1. Give it a recognisable name in the General tab.
|
||||
|
||||
2. Switch to the Connection tab and enter the hostname, port, username and password currently used.
|
||||
You can find these in your TeslaMate add-on configuration.
|
||||
|
||||
3. Click Save
|
||||
|
||||
6. Click the dropdown next to the new server -> Databases and then select the database you use for TeslaMate.
|
||||
This will be the same name you configured in the TeslaMate add-on configuration.
|
||||
|
||||
7. Go to Tools -> Backup, enter a filename, if you know what you're doing feel free to make other customisations but it's not essential, and then click Backup. [^1]
|
||||
|
||||
8. Once the backup has finished, repeats step 5 for your new PostgreSQL server to establish a connection to your new PostgreSQL server.
|
||||
|
||||
9. Select the new server, if not already selected, and go to Object -> Create -> Database and enter the same name and owner as used on your old server and click Save.
|
||||
|
||||
10. If the database is not already selected, select it and then go to Tools -> Restore, enter the filename you entered in step 7 and click Restore.
|
||||
You may need to use the file browser to locate the file. If you didn't change the path in step 7, the backup should be in `/root/`.
|
||||
|
||||
11. Once the restore has completed, go to the TeslaMate add-on settings and update the database settings to point to your new database server.
|
||||
The easiest approach is to use the steps in [Migrating to this version of the add-on][migrate-addon] further down in this file and change the `database_host` to the name of your new PostgreSQL server.
|
||||
|
||||
12. Update the Grafana configuration by going to the Grafana add-on -> Open web UI -> Grafana logo in top left -> Connections -> Datasources, select the TeslaMate source and change the Host URL to your new PostgreSQL server and click "Save & test".
|
||||
|
||||
13. Start the TeslaMate add-on and verifying everything is working as it was before. [^2]
|
||||
|
||||
You can now uninstall the pgAdmin4 add-on if you want and stop and uninstall your old PostgreSQL server if you're not using it for anything else.
|
||||
|
||||
## Import TeslaMate Backup
|
||||
|
||||
If you have made a backup of a TeslaMate installation as per the [TeslaMate backup documentation][teslamate-backup] and now have a `teslamate.bak` file you want to use with this add-on, you can do so as follows:
|
||||
|
||||
1. Install this TeslaMate add-on if you haven't already, but don't start it.
|
||||
|
||||
2. Install a PostgreSQL server and start it if you haven't already.
|
||||
We recommend the [PostgreSQL 17 add-on][alexbelgium-postgres] from @alexbelgium's repository, or [TimescaleDB][timescaledb] (for advanced users).
|
||||
|
||||
3. Perform steps 3, 4 and 5 from [Migrate TeslaMate to a Different PostreSQL Server][migrate-psql] above.
|
||||
|
||||
4. Transfer the `teslamate.bck` file to the `/share/teslamate` folder on your Home Assistant instance.
|
||||
You can do this using the [Samba][samba-addon] or [SSH][ssh-addon] add-ons.
|
||||
|
||||
5. Perform steps 9 and 10 from [Migrate TeslaMate to a Different PostreSQL Server][migrate-psql] above.
|
||||
Note: the file location will be `/share/teslamate/teslamate.bck`.
|
||||
|
||||
6. Configure TeslaMate and Grafana as per the details at the top of this file.
|
||||
|
||||
7. Start TeslaMate.
|
||||
|
||||
## Data Import from TeslaFi
|
||||
|
||||
It is now possible to import CSV data from TeslaFi, refer to the [official docs][teslafi-import].
|
||||
@@ -168,12 +232,27 @@ Follow this process:
|
||||
|
||||
5. Once imported sucessfully, delete the CSV files to avoid the import screen being presented.
|
||||
|
||||
[alexbelgium-postgres]: https://github.com/alexbelgium/hassio-addons/tree/master/postgres_17
|
||||
[docker]: https://hub.docker.com/r/teslamate/teslamate
|
||||
[elixir]: https://elixir-lang.org/
|
||||
[grafana-addon]: https://github.com/hassio-addons/addon-grafana
|
||||
[grafana-datasource]: https://raw.githubusercontent.com/lildude/ha-addon-teslamate/main/imgs/grafana-postgres.png
|
||||
[migrate-psql]: #migrate-teslamate-to-a-different-postresql-server
|
||||
[migrate-addon]: https://github.com/lildude/ha-addon-teslamate/blob/main/README.md#migrating-to-this-version-of-the-add-on
|
||||
[mosquitto-docs]: https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md
|
||||
[pgadmin4]: https://github.com/expaso/hassos-addons
|
||||
[samba-addon]: https://github.com/home-assistant/addons/blob/master/samba/DOCS.md
|
||||
[ssh-addon]: https://github.com/home-assistant/addons/blob/master/ssh/DOCS.md
|
||||
[teslafi-import]: https://docs.teslamate.org/docs/import/teslafi
|
||||
[teslamate]: https://github.com/teslamate-org/teslamate/
|
||||
[teslamate-backup]: https://docs.teslamate.org/docs/maintenance/backup_restore/#backup
|
||||
[timescaledb]: https://github.com/expaso/hassos-addon-timescaledb
|
||||
|
||||
[^1]:
|
||||
If the backup or restore fails due to a `server version mismatch` error, you will need to select the latest version of PostgreSQL in pgAdmin4 by going to File -> Paths -> Binary paths and add the correct path for each version.
|
||||
For example, for PostgreSQL 14, enter `/usr/local/pgsql-14`, for PostgreSQL 15, enter `/usr/local/pgsql-15` etc.
|
||||
|
||||
[^2]:
|
||||
If you see the `ERROR: type "earth" does not exist at character` error in the TeslaMate log, you can fix this by going back into pgAdmin4 and right click on the TeslaMate database -> "CREATE script".
|
||||
Delete everything auto generated and paste in the [codeblock here](https://github.com/diogob/activerecord-postgres-earthdistance/issues/30#issuecomment-2122829036).
|
||||
Click "Execute script" (It's the ▶️ symbol at the top).
|
||||
|
||||
@@ -7,7 +7,7 @@ A self-hosted data logger for your Tesla 🚘
|
||||
[TeslaMate][teslamate] is a powerful, self-hosted data logger for your Tesla.
|
||||
|
||||
- Written in **[Elixir][elixir]**
|
||||
- Data is stored in a **Postgres** database
|
||||
- Data is stored in a **PostgreSQL** database
|
||||
- Visualization and data analysis with **Grafana**
|
||||
- Vehicle data is published to a local **MQTT** Broker
|
||||
|
||||
@@ -24,8 +24,8 @@ Thanks to @matt-FFFFFF for maintaining this add-on in the past.
|
||||
|
||||
## Requirements
|
||||
|
||||
TeslaMate needs a PostgreSQL database.
|
||||
I recommend using the [PostgreSQL add-on][alexbelgium-postgres] from @alexbelgium's repository if you aren't already using Postgres.
|
||||
**TeslaMate v2 needs a PostgreSQL 16.7 or 17.3 or later database.**
|
||||
I recommend using the [PostgreSQL 17 add-on][alexbelgium-postgres] from @alexbelgium's repository, or [TimescaleDB][timescaledb] (for advanced users), if you aren't already using PostgreSQL.
|
||||
|
||||
To get the full experience, it is recommended that you also install the community [Grafana add-on][grafana-addon] and [MQTT integration][mqtt].
|
||||
|
||||
@@ -46,6 +46,13 @@ To get the full experience, it is recommended that you also install the communit
|
||||
1. Check the logs of the add-on to see if everything went well.
|
||||
1. Click the `OPEN WEB UI` button to open TeslaMate.
|
||||
|
||||
## Upgrading this add-on from v1 to v2
|
||||
|
||||
TeslaMate v2 introduced a hard requirement on the version of PostgreSQL database.
|
||||
**You will need to use PostgreSQL 16.7 or 17.3 or later.**
|
||||
If you are currently using an earlier version of PostgreSQL, you will need to backup your TeslaMate data, upgrade the database, and then restore the data.
|
||||
You can find details on how to do this in the "_Migrate TeslaMate to a Different Postres Server_" section of this add-on's documentation tab or in the [DOCS.md][docs-md] file in the add-on repository.
|
||||
|
||||
## Migrating to this version of the add-on
|
||||
|
||||
Migrating to this version of the add-on should not result in any loss of data, but you can never be too careful, so I recommend you take a full backup of your Home Assistant instance and also a direct backup of the TeslaMate database as detailed in the [TeslaMate documentation][teslamate-backup] before proceeding.
|
||||
@@ -67,9 +74,10 @@ Everything should pick up where it was before.
|
||||
|
||||
[addon]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Flildude%2Fha-addons
|
||||
[addons-repo]: https://github.com/lildude/ha-addons
|
||||
[alexbelgium-postgres]: https://github.com/alexbelgium/hassio-addons/tree/master/postgres
|
||||
[alexbelgium-postgres]: https://github.com/alexbelgium/hassio-addons/tree/master/postgres_17
|
||||
[archs]: https://img.shields.io/badge/dynamic/json?color=green&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-teslamate%2Fmain%2Fconfig.json
|
||||
[docker]: https://hub.docker.com/r/teslamate/teslamate
|
||||
[docs-md]: https://github.com/lildude/ha-addon-teslamate/blob/main/DOCS.md#migrate-teslamate-to-a-different-postgresql-server
|
||||
[elixir]: https://elixir-lang.org/
|
||||
[grafana-addon]: https://github.com/hassio-addons/addon-grafana
|
||||
[ingres-badge]: https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-teslamate%2Fmain%2Fconfig.json
|
||||
@@ -79,3 +87,4 @@ Everything should pick up where it was before.
|
||||
[teslamate-backup]: https://docs.teslamate.org/docs/maintenance/backup_restore
|
||||
[teslamate-version]: https://img.shields.io/badge/dynamic/json?label=TeslaMate%20Version&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-teslamate%2Fmain%2Fbuild.json&query=%24.args.teslamate_version
|
||||
[teslamate]: https://github.com/teslamate-org/teslamate/
|
||||
[timescaledb]: https://github.com/expaso/hassos-addon-timescaledb
|
||||
|
||||
+4
-4
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"build_from": {
|
||||
"aarch64": "teslamate/teslamate:1.32.0",
|
||||
"amd64": "teslamate/teslamate:1.32.0",
|
||||
"armv7": "teslamate/teslamate:1.32.0"
|
||||
"aarch64": "teslamate/teslamate:2.0.0",
|
||||
"amd64": "teslamate/teslamate:2.0.0",
|
||||
"armv7": "teslamate/teslamate:2.0.0"
|
||||
},
|
||||
"args": {
|
||||
"teslamate_version": "1.32.0"
|
||||
"teslamate_version": "2.0.0"
|
||||
},
|
||||
"codenotary": {
|
||||
"signer": "colin@symr.io"
|
||||
|
||||
+5
-2
@@ -9,6 +9,7 @@
|
||||
"aarch64",
|
||||
"amd64"
|
||||
],
|
||||
"hassio_api": true,
|
||||
"ingress": true,
|
||||
"init": false,
|
||||
"panel_icon": "mdi:car-connected",
|
||||
@@ -63,10 +64,12 @@
|
||||
"import_dir": "str",
|
||||
"default_geofence": "str?",
|
||||
"encryption_key": "password?",
|
||||
"env_vars": [{
|
||||
"env_vars": [
|
||||
{
|
||||
"name": "str?",
|
||||
"value": "str?"
|
||||
}]
|
||||
}
|
||||
]
|
||||
},
|
||||
"map": [
|
||||
"share:rw"
|
||||
|
||||
@@ -52,14 +52,30 @@ for env_var in $(bashio::config 'env_vars|keys'); do
|
||||
export "${name}=${value}"
|
||||
done
|
||||
|
||||
# Import dashboards
|
||||
if bashio::config.true 'grafana_import_dashboards'; then
|
||||
/dashboards.sh restore || bashio::log.error "Failed to import dashboards"
|
||||
fi
|
||||
|
||||
# Create the PostgreSQL database if it doesn't exist
|
||||
if pg_isready -h "$DATABASE_HOST" -p "$DATABASE_PORT" > /dev/null 2>&1; then
|
||||
bashio::log.info "Checking for database '$DATABASE_NAME' on $DATABASE_HOST"
|
||||
if pg_isready -h "$DATABASE_HOST" -p "$DATABASE_PORT" > /dev/null 2>&1; then
|
||||
# Check the version of PostgreSQL database is v16.7 or later or v17.3 or later
|
||||
pg_version=$(PGPASSWORD="$DATABASE_PASS" psql -h "$DATABASE_HOST" -p "$DATABASE_PORT" -U "$DATABASE_USER" postgres -Atqc "SELECT regexp_replace(version(), 'PostgreSQL ([^ ]+) .*', '\\1') AS version")
|
||||
major_version=$(echo "$pg_version" | cut -d '.' -f 1)
|
||||
minor_version=$(echo "$pg_version" | cut -d '.' -f 2)
|
||||
compat=true
|
||||
case "$major_version" in
|
||||
16)
|
||||
[[ "$minor_version" -lt 7 ]] && compat=false
|
||||
;;
|
||||
17)
|
||||
[[ "$minor_version" -lt 3 ]] && compat=false
|
||||
;;
|
||||
*)
|
||||
[[ "$major_version" -lt 16 ]] && compat=false
|
||||
;;
|
||||
esac
|
||||
|
||||
if [ $compat = false ]; then
|
||||
bashio::log.error "PostgreSQL version $pg_version is not supported. Please upgrade to v16.7 or later or v17.3 or later."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ -n $(PGPASSWORD="$DATABASE_PASS" psql -h "$DATABASE_HOST" -p "$DATABASE_PORT" -U "$DATABASE_USER" postgres -Atqc "SELECT datname FROM pg_database WHERE datname = '$DATABASE_NAME'") ]]; then
|
||||
bashio::log.info "Database $DATABASE_NAME already exists"
|
||||
@@ -76,18 +92,32 @@ else
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ -z $(PGPASSWORD="$DATABASE_PASS" psql -h "$DATABASE_HOST" -p "$DATABASE_PORT" -U "$DATABASE_USER" "$DATABASE_NAME" -Atqc "SELECT 1 FROM settings WHERE base_url LIKE '%api/hassio_ingress%'" 2&> /dev/null ) ]]; then
|
||||
# Import dashboards
|
||||
if bashio::config.true 'grafana_import_dashboards'; then
|
||||
bashio::log.info "Importing Grafana dashboards..."
|
||||
/dashboards.sh restore || bashio::log.error "Failed to import dashboards"
|
||||
fi
|
||||
|
||||
if [[ -z $(PGPASSWORD="$DATABASE_PASS" psql -h "$DATABASE_HOST" -p "$DATABASE_PORT" -U "$DATABASE_USER" "$DATABASE_NAME" -Atqc "SELECT 1 FROM settings WHERE base_url LIKE '%api/hassio_ingress%'" 2> /dev/null ) ]]; then
|
||||
teslamate_ingress=$(bashio::addon.ingress_entry)
|
||||
grafana_ingress=$(bashio::addon.ingress_entry $(bashio::supervisor.addons | grep grafana))
|
||||
grafana_ingress=$(bashio::addon.ingress_entry "$(bashio::supervisor.addons | grep grafana)")
|
||||
if [[ "$teslamate_ingress" == "$grafana_ingress" ]]; then
|
||||
grafana_ingress="** Grafana addon not found. Ensure the addon is installed and running. **"
|
||||
fi
|
||||
|
||||
bashio::log.info "Configure TeslaMate settings by adding these values
|
||||
to the URL you use to access your Home Assistant instance:
|
||||
bashio::log.notice ""
|
||||
bashio::log.notice "Configure TeslaMate settings by adding these values"
|
||||
bashio::log.notice "to the URL you use to access your Home Assistant instance:"
|
||||
bashio::log.notice ""
|
||||
bashio::log.notice "=> Web App: $teslamate_ingress"
|
||||
bashio::log.notice "=> Dashboards: $grafana_ingress"
|
||||
bashio::log.notice ""
|
||||
fi
|
||||
|
||||
=> Web App: $teslamate_ingress
|
||||
=> Dashboards: $grafana_ingress
|
||||
"
|
||||
# Set max open file limit to avoid memory allocation issues
|
||||
if [ "$(ulimit -Hn)" -gt 524288 ]; then
|
||||
ulimit -n 524288
|
||||
fi
|
||||
ulimit -n 1048576
|
||||
|
||||
bashio::log.info "Starting TeslaMate..."
|
||||
|
||||
|
||||
Reference in New Issue
Block a user