Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nebhale/teslamate-discovery
Home Assistant MQTT Discovery for Teslamate Cars
https://github.com/nebhale/teslamate-discovery
discovery home-assistant mqtt teslamate
Last synced: 4 days ago
JSON representation
Home Assistant MQTT Discovery for Teslamate Cars
- Host: GitHub
- URL: https://github.com/nebhale/teslamate-discovery
- Owner: nebhale
- License: apache-2.0
- Created: 2022-07-15T12:02:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T02:12:09.000Z (12 days ago)
- Last Synced: 2024-10-25T16:27:45.284Z (12 days ago)
- Topics: discovery, home-assistant, mqtt, teslamate
- Language: Go
- Homepage:
- Size: 704 KB
- Stars: 15
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TeslaMate Discovery
If you're a fan of the very excellent [TeslaMate][tm] and use it with [Home Assistant][ha], then this project is for you!
The TeslaMate + Home Assistant [integration documentation][tmha] shows a very long, manual configuration of each of the entities that TeslaMate sends messages for. While this works quite well (I used it for years) it has some shortcomings, the biggest of which is that they aren't all collected under a single [Home Assistant Device][had]. Unfortunately, devices cannot be created using purely manual end-user configuration, they can only be added with [MQTT Discovery][hamd] or a dedicated integration.
This application replaces most, if not all, of the documented TeslaMate + Home Assistant integration. In a single command, it synthesizes and publishes the MQTT Discovery configuration for commonly used entities converted to desired units and a `device_tracker` with precise coordinates that can also determine if the car is home (any geofence with "Home" in it).
[ha]: https://www.home-assistant.io
[had]: https://developers.home-assistant.io/docs/device_registry_index/
[hamd]: https://www.home-assistant.io/docs/mqtt/discovery/
[tm]: https://github.com/adriankumpf/teslamate
[tmha]: https://docs.teslamate.org/docs/integrations/home_assistant
# Pre-requisites
The application assumes that you have a healthy TeslaMate installation sending messages to a [Mosquitto MQTT broker][mos] and that Home Assistant can see those messages. The only other requirement is to have an account that can read messages from the `/teslamate/#` topic tree and send messages to the `/homeassistant/#` topic tree. This is often done by configuring `/share/mosquitto/accesscontrollist` as in the following example:
```plain
user homeassistant
topic readwrite homeassistant/#
topic read teslamate/#
user teslamate
topic write teslamate/#
user teslamate-discovery
topic write homeassistant/#
topic read teslamate/#
```
[mos]: https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md
# Installation
To install the application, navigate to the [Releases][r] page for the project and download the appropriate Asset for the platform you'll be running on (e.g. `teslamate-discovery_2.0.2_Darwin_all.tar.gz` for macOS). Unzip the package and within it you'll find the `teslamate-discovery` binary that you'll run.
[r]: https://github.com/nebhale/teslamate-discovery/releases
# Usage
Common usage might look like:
```plain
$ teslamate-discovery \
--mqtt-host \
--mqtt-username \
--mqtt-password
```
## Usage Options
```plain
Usage:
teslamate-discovery [flags]
Flags:
--ha-discovery-prefix string home assistant discovery message prefix (default "homeassistant")
--help help for teslamate-discovery
-h, --mqtt-host string mqtt broker host (default "127.0.0.1")
-P, --mqtt-password string mqtt broker password
-p, --mqtt-port int mqtt broker port (default 8883)
-s, --mqtt-scheme string mqtt broker scheme (default "ssl")
-u, --mqtt-username string mqtt broker username
--range-type string range type ["estimated", "ideal", "rated"] (default "rated")
--tm-prefix string teslamate message prefix (default "teslamate")
--units-distance string distance units ["imperial", "metric"] (default "imperial")
--units-pressure string pressure units ["imperial", "metric"] (default "imperial")
-v, --version version for teslamate-discovery
```
## License
Apache License v2.0: see [LICENSE](./LICENSE) for details.