Skip to content

Commit ae1b457

Browse files
committed
Update readme file
1 parent 0175795 commit ae1b457

1 file changed

Lines changed: 57 additions & 32 deletions

File tree

README.md

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
11
# TeslaMate - Custom dashboards for Grafana
22

3-
[![](https://img.shields.io/badge/Donate-PayPal-ff69b4.svg)](https://www.paypal.com/donate?hosted_button_id=QF2MBMQZP4V2J)
3+
Here you will find a series of original dashboards to expand those included by default in Teslamate to fully squeeze the data of your Tesla.
44

5-
## How to import boards
5+
These **Custom Dashboards** have been tested with versions of Teslamate v1.27.1 and Grafana v8.5.6 or higher
66

7-
Tested with Teslamate v1.27.1+ and Grafana v8.5.6+
7+
---
88

9-
1. Sign in to Grafana
10-
2. Create an API key (More information below)
11-
3. Import dashboards [one by one manually](#import-dashboards-manually) or [run the *dashboards.sh* file](#import-dashboards-automatically-with-dashboardssh) to import them automatically
9+
## Import dashboards automatically with `dashboards.sh`
10+
11+
With this script (*dashboards.sh*), you can create or update automatically all dashboards. But, first of all, you need to generate a API KEY in your Grafana ([HOW-TO](#create-an-api-key)).
12+
13+
You have to execute the command `./dashboards.sh restore` modifying the URL and TOKEN variables as indicated in the example.
14+
15+
**URL** specifies the URL of the Grafana instance
16+
17+
**TOKEN** specifies the security key of the API, it's generated in Grafana.
1218

13-
## Create an API key
19+
```shell
20+
URL=http://localhost:3000 TOKEN=XXXXXXXXXXXX ./dashboards.sh restore
21+
```
22+
23+
Also, you can specify the source directory of the dashboards.
24+
25+
```shell
26+
URL=http://localhost:3000 TOKEN=XXXXXXXXXXXX DESTINATION_DIRECTORY=/tmp/dashboards ./dashboards.sh restore
27+
```
28+
29+
### HOW-TO: Create a Grafana API key
1430

1531
1. Sign in to Grafana, hover your cursor over Configuration (the gear icon), and click API Keys
1632
2. Click "Add API key"
@@ -21,51 +37,60 @@ Tested with Teslamate v1.27.1+ and Grafana v8.5.6+
2137

2238
More info in [Grafana documentation](https://grafana.com/docs/grafana/v8.5/administration/api-keys/create-api-key/) page.
2339

24-
## Import dashboards manually
25-
26-
1. Click in "Dashboards" option and select "Browse"
27-
2. Create a personal folder, e.g. "Teslamate-Extra"
28-
3. Go to new folder
29-
4. Press the "Import" button
30-
5. Press the "Upload JSON file" button
31-
6. Select JSON file from your computer
32-
7. And finally, press the "Import" button
33-
34-
## Import dashboards automatically with *dashboards.sh*
35-
36-
With this script, you can create or update automatically all dashboards.
40+
---
3741

38-
You have to execute the command "./dashboards.sh restore" modifying the URL and TOKEN variables as indicated in the example.
39-
40-
**URL** specifies the URL of the Grafana instance
42+
## Import dashboards manually
4143

42-
**TOKEN** specifies the security key of the API, it's generated in Grafana.
44+
1. Sign in to Grafana
45+
2. Click in "Dashboards" option and select "Browse"
46+
3. Create a personal folder, e.g. "Teslamate-Extra"
47+
4. Go to new folder
48+
5. Press the "Import" button
49+
6. Press the "Upload JSON file" button
50+
8. Select JSON file from your computer
51+
8. And finally, press the "Import" button
4352

44-
``URL=http://localhost:3000 TOKEN=XXXXXXXXXXXX ./dashboards.sh restore``
53+
---
4554

4655
## Screenshots
4756

48-
**Current Charge View**
57+
### Current Charge View
4958

5059
![Charging Curves](./screenshots/current_charge_view.png)
5160

52-
**Battery Health**
61+
### Battery Health
5362

5463
![Battery Health](./screenshots/battery_health.png)
5564

56-
**Charging Tops**
65+
### Charging Tops
5766

5867
![Charging Tops](./screenshots/charging_tops.png)
5968

60-
**Charging Costs Stats**
69+
### Charging Costs Stats
6170

6271
![Charging Costs Stats](./screenshots/charging_costs_stats.png)
6372

64-
**Charging Curves**
73+
### Charging Curves
6574

6675
![Charging Curves](./screenshots/charging_curves.png)
6776

77+
## Donations
78+
79+
Hello!
80+
81+
If you like my work and want to support me, you can buy me a coffee, I would appreciate it a lot!
82+
83+
Your support helps me to keep improving these contents.
84+
85+
Thanks!
86+
87+
[![](https://img.shields.io/badge/Donate-PayPal-ff69b4.svg)](https://www.paypal.com/donate?hosted_button_id=QF2MBMQZP4V2J)
88+
6889
## Credits
6990

70-
- Author: Carlos Cuezva – see [list of contributors](https://github.com/CarlosCuezva/dashboards-Grafana-Teslamate/graphs/contributors)
71-
- Distributed under [MIT license](./LICENSE)
91+
- Author: Carlos Cuezva
92+
- List of [contributors](https://github.com/CarlosCuezva/dashboards-Grafana-Teslamate/graphs/contributors)
93+
94+
## License
95+
96+
Distributed under [MIT license](./LICENSE)

0 commit comments

Comments
 (0)