-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
44 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,63 @@ | ||
# Tesla Status Plugin for Elgato Streamdeck | ||
|
||
View your Tesla Data using TeslaFi API | ||
View your Tesla Data using the TeslaFi API | ||
|
||
This an extension for the [ElGato-StreamDeck](https://www.elgato.com/en/gaming/stream-deck). | ||
Tesla Fi is on the Elgato Marketplace! [View on Marketplace](https://marketplace.elgato.com/product/teslafi-653b2ad6-741a-4dd9-8788-0a264dcbe65a). | ||
|
||
## Screenshot | ||
|
||
 | ||
|
||
Please report any issues you see on the project's Github page. I welcome any feedback. | ||
|
||
## Features | ||
|
||
- **Customizable Display:** Choose which 5 fields to display on the Stream Deck from options including Car Name, Inside Temp, Battery Range, Charging State, Outside Temp, and Odometer. | ||
- **Real-Time Updates:** Automatically refresh data every 20 minutes to keep your display current. | ||
- **Unit Conversions:** Select temperature unit (Fahrenheit/Celsius) and distance unit (Miles/Kilometers) based on your preference. | ||
- **Error Handling:** Displays an API limit error message when the majority of values return as `N/A`, indicating the need to wait for 5 minutes to clear the limit. | ||
- **Translations:** User interface is available in English, German, and Spanish. | ||
|
||
## Installation | ||
|
||
Download from Release folder [Release Folder](Release/com.f00d4tehg0dz.teslafi.streamDeckPlugin) | ||
Download from the [Release Folder](Release/com.f00d4tehg0dz.teslafi.streamDeckPlugin). | ||
|
||
Double-click to install to StreamDeck. | ||
|
||
Make sure you have an active subscription with [TeslaFi](https://teslafi.com) and enable your API key. | ||
|
||
### Configuration | ||
|
||
1. **TeslaFI API Key:** Enter your TeslaFi API key to start fetching data. | ||
2. **Automatic Refresh:** Enable or disable automatic data refresh every 20 minutes. | ||
3. **Temperature Unit:** Select between Fahrenheit (F) and Celsius (C). | ||
4. **Distance Unit:** Select between Miles (Mi) and Kilometers (Km). | ||
5. **Custom Fields:** Choose which 5 fields to display on your Stream Deck. Full List Below. | ||
1. **Car Name:** Display the name of your Tesla vehicle. | ||
2. **Inside Temp:** Display the current inside temperature. | ||
3. **Battery Range:** Display the current battery range. | ||
4. **Charging State:** Display the current charging state. | ||
5. **Outside Temp:** Display the current outside temperature. | ||
6. **Odometer:** Display the current odometer. | ||
|
||
## Localization | ||
|
||
The plugin supports the following languages: | ||
- English | ||
- German | ||
- Spanish | ||
|
||
To switch the language, adjust the language settings in the configuration file. | ||
|
||
Double click to install to StreamDeck. | ||
## Contributing | ||
|
||
Make sure you have an active subscription with [TeslaFi](https://teslafi.com) and enable your API key | ||
Feel free to contribute to this project by submitting issues or pull requests on the [Github page](https://github.com/f00d4tehg0dz/Teslafi-Status-Plugin-for-Eglato-Streamdeck). | ||
|
||
## Ongoing work | ||
## License | ||
|
||
clean up the heck out of the codebase | ||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. | ||
|
||
--- | ||
|
||
Thank you for using the Tesla Status Plugin for Elgato Streamdeck! We appreciate your feedback and support. | ||
|