[DOCS] Adding latest results to StreamDeck

[MartynKeigher]

Is your feature request related to a problem? Please describe.
Documentation for adding 'latest result' to StreamDeck.

1. Download the 'APINinja' extension from the Elgato Marketplace.

2. Select 'BarRadier > APINinja' from the action selector on the right-hand side and drag\drop it into a vacant spot on your StreamDeck Panel.

3. To add the latest download result to the button, set the following APINinja fields as follows:

• Request Type: GET
• API URL: http://Your-Speedtest-Tracker-IP/api/speedtest/latest
• Content type: application/json
• Response Shown: data.download
• Parse/Format 'Response shown': checked
• Format: {0:N0}
• (Optional) Title Suffix: Mbps
• Response Type: Text
• Autorun every: Your preference!
• (Optional) Hide green success indicator: checked.

4. To add the latest upload result to the button, copy\paste the download button you just created to a vacant spot on your StreamDeck panel, and adjust the following field:

• Response Shown: data.upload

5. If you did this correctly, you should now have 2 buttons that look something like this...

The icons I used for down\up are part of the 'Font Awesome: Solid Icons' icon pack.

[alexjustesen]

This is awesome, I'm doing it tonight!

[OddSquirrel]

Another grave reminder that I really, really should have bought a StreamDeck XL instead of the regular one. 🙈

Dear [insert applicable deity here], please give me more buttons! 🙏

[alexjustesen]

Another grave reminder that I really, really should have bought a StreamDeck XL instead of the regular one. 🙈

Dear [insert applicable deity here], please give me more buttons! 🙏

Same, half of my first page is buttons to other pages.

[OddSquirrel]

@MartynKeigher is that the formatting you currently get using v.0.16.4? I am wondering because it shows up in bytes for me.

I also just learned that I'll probably need to make a blank icon in order to see everything properly, since API Ninja doesn't let me simply hide it. How odd. 🤔

[MartynKeigher]

@OddSquirrel - "is that the formatting you currently get using v.0.16.4?"... No, that formatting is for 'previous' versions of SpeedTracker. There is an open issue regarding the different responses between versions which is going to get addressed, so once the current version gets "fixed" (and I do use that term loosely!), then you're display will be fine.

However, if you wanting to see a 'clean ###Mbps' on your button for now, then you could play around with the Format and\or maybe regex fields to massage the response. I'll have a play with it now and see if I can get it right. If I can... I'll update the guide above.

[MartynKeigher]

@OddSquirrel - Given the latest update, v0.16.5, this extra formatting is no longer required and the instructions in the orig post here will work just fine! 👍🏼

[OddSquirrel]

I gave it a shot with v0.16.5 and v0.16.6, and this is what I end up with when using the settings above, including {0:N0}:

When I remove {0:N0}, I get this instead:

These values are supposed to represent "download":933.16 from the API.

[MartynKeigher]

Interesting. For me, adding {0:N0} effectively leaves me with a 'whole number' that is rounded up\down to the nearest number, from the value returned in the API.

With that said, its only massaging the data that I get back in the API response from data.download which for me is (at this moment) "download":828.85, so my button shows 829.

[MartynKeigher]

@OddSquirrel ... So thinking about this a little more...

{0:N0} first takes the value 933.16 and 'stores' it in 0.
It then uses the formatter : and then rounds the decimal value to the nearest whole number and formats it with zero decimal places N0, and not divide it by 10, which it looks like yours is doing. - weird. 🤔

The only thing I can think of is that your APINinja plugin is out of date and you're falling foul to a bug in an older version ??? ... but that said... the latest (v1.3) was released over 2 years ago, so I doubt you have an old version, but definitely check that to rule it out.

[OddSquirrel]

IKR? Makes zero sense. And the most hilarious part is, that it does work now. I fumbled around for an hour, trying everything in the book, all kinds of formattings, nothing would stick. And here we are after trying it just once more and everything is fine.

Whatever caused this, I thank you very much for taking your time to help me figure this out. Crawling all over GitHub certainly has a way of making me aware of my lack of knowledge, and without kind folks like you my therapist would certainly rack up quite some overtime. 😊

EDIT: Looks like I was wrong when I saw 634 Mbps on my button because it made sense (I have a 1 Gbps line). It was really 63.4 Mbps, so that decimal is being shifted around for some reason. 🙈 Since your explanation makes perfect sense, I have no idea why it would move the point to the right and then cut it off along with the rest of the digits.

[MartynKeigher]

That really is very bizarre! 🤔🤔🤔🤔

Try this...

• Delete your down\up buttons.
• Uninstall APINinja
• Restart Streamdeck app
• Download APINinja 1.3 from the BarRaider discord server (it's in the '#plugin-releases' channel) and re-install it.
• Try again?

[OddSquirrel]

It sure is. Maybe this is due to cultural parameters, with the dot being used as a decimal separator in your culture and a comma in mine? I also see that the linked syntax info provides some details about cultural settings, but I have no idea how to use that within API Ninja.

This is what I did instead:

That way, the dot and whatever follows it simply gets truncated. Yes, it won't round 849.63 to 850, but I can live with that. I'm not running an atomic clock for NASA, after all. 😋