Skip to content

Commit 2f9e6f5

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-74: change request with no subject merged in GitBook
1 parent 8d85bb9 commit 2f9e6f5

File tree

5 files changed

+34
-1
lines changed

5 files changed

+34
-1
lines changed

.gitbook/assets/image (1).png

5.98 KB
Loading

.gitbook/assets/image.png

25.3 KB
Loading

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
# Introduction
88

99
{% hint style="info" %}
10-
Docs are up to date through version: `0.16.0`
10+
Docs are up to date through version: `0.17.x`
1111
{% endhint %}
1212

1313
<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt=""><figcaption></figcaption></figure>

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
* [Data Dictionary](other/data-dictionary.md)
4141
* [Embed Dashboard](other/embed-dashboard.md)
4242
* [Health Check](other/health-check.md)
43+
* [Stream Deck](other/stream-deck.md)
4344

4445
## 🖥 API
4546

other/stream-deck.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
description: Use the API to show the most recent result on your Stream Deck.
3+
---
4+
5+
# Stream Deck
6+
7+
{% hint style="info" %}
8+
Shoutout to [MartynKeigher](https://github.com/MartynKeigher) on GitHub for [providing](https://github.com/alexjustesen/speedtest-tracker/issues/1191) these instructions.
9+
{% endhint %}
10+
11+
### Required Plugin
12+
13+
Download the "API Ninja" plugin from the Elgato Marketplace.
14+
15+
<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
16+
17+
### Configure the Buttons
18+
19+
1. Under the "BarRadier" plugin select "API Ninja" and drag it to an empty slot.
20+
2. Request type should be set to `GET`.
21+
3. API URL should be set to your application's app url and append `/api/speedtest/latest`.
22+
4. Set the Content Type to `application/json`.
23+
5. Set the Response Shown to `data.download` for download and `data.upload` for upload.
24+
6. Check Parse/Format 'Response shown'.
25+
7. Set the Format to `{0:N0}`.
26+
8. Optionally you can add a Title Suffix: `\n(Mbps)`
27+
9. Set the Response Type to `Text`.
28+
10. Set Autorun every option to a refresh interval of your choice.
29+
11. Optionally you can hide green success indicator.
30+
12. Lastly duplicate the button and change the Response Shown to `data.download`.
31+
32+
<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>

0 commit comments

Comments
 (0)