https://github.com/killerboss2019/tp-speed-test-plugin
SpeedTest Plugin using https://www.speedtest.net/ API
https://github.com/killerboss2019/tp-speed-test-plugin
Last synced: about 2 months ago
JSON representation
SpeedTest Plugin using https://www.speedtest.net/ API
- Host: GitHub
- URL: https://github.com/killerboss2019/tp-speed-test-plugin
- Owner: KillerBOSS2019
- License: gpl-3.0
- Created: 2021-03-21T04:14:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-03T21:46:57.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T05:12:21.812Z (6 months ago)
- Language: Python
- Size: 7.41 MB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SpeedTest
- [SpeedTest](#SpeedTest)
- [Description](#description)
- [Settings Overview](#Settings-Overview)
- [Features](#Features)
- [Actions](#actions)
- [States](#states)
- [Installation Guide](#installation)
- [Bugs and Support](#bugs-and-suggestion)
- [License](#license)
# Description
SpeedTest Plugin using https://www.speedtest.net/ API for [TouchPortal](https://www.touch-portal.com/)
This documentation generated for SpeedTest V2000 with [Python TouchPortal SDK](https://github.com/KillerBOSS2019/TouchPortal-API).
## Settings Overview
| Read-only | Type | Default Value | Max. Value |
| --- | --- | --- | --- |
| False | text | 0 | 360 |
In order to enable automatically test you will need to enter a number that's equal or greater than 5. Otherwise It means it's disabled.
| Read-only | Type | Default Value |
| --- | --- | --- |
| False | text | True |
If I release any new update you will receive a TouchPortal notification about it.
# Features
## Actions
Category: main (Click to expand)
Action NameDescriptionFormatData
choices/default (in bold)On
Hold
Start speedtestStarts speedtest process.Start speedtest using server [1]
- Type: choice
Default: Best server (based on ping)
No
## States
Base Id: com.KillerBOSS.TPPlugins.TPSpeedTest Category: main (Click to expand)
| Id | Description | DefaultValue | parentGroup |
| --- | --- | --- | --- |
| .st.result.download.bits | Download speed in (bits) | | Download speed result |
| .st.result.download.bytes | Download speed in (bytes) | | Download speed result |
| .st.result.download.kilobits | Download speed in (kilobits) | | Download speed result |
| .st.result.download.kilobytes | Download speed in (kilobytes) | | Download speed result |
| .st.result.download.megabits | Download speed in (megabits) | | Download speed result |
| .st.result.download.megabytes | Download speed in (megabytes) | | Download speed result |
| .st.result.upload.bits | Upload speed in (bits) | | Upload speed result |
| .st.result.upload.bytes | Upload speed in (bytes) | | Upload speed result |
| .st.result.upload.kilobits | Upload speed in (kilobits) | | Upload speed result |
| .st.result.upload.kilobytes | Upload speed in (kilobytes) | | Upload speed result |
| .st.result.upload.megabits | Upload speed in (megabits) | | Upload speed result |
| .st.result.upload.megabytes | Upload speed in (megabytes) | | Upload speed result |
| .st.result.ping | Ping | | |
| .st.result.isp | ISP | | |
| .st.result.image | Image | | |
# Installation
1. Download latest version of plugin for your system.
2. Import downloaded tpp by click the gear button next to email/notification icon.
3. If this is first plugin, you will need to restart TouchPortal for it to work.
# Bugs and Suggestion
Open an [issue](https://github.com/KillerBOSS2019/TP-Speed-Test-Plugin/issues) or join offical [TouchPortal Discord](https://discord.gg/MgxQb8r) for support.
# License
This plugin is licensed under the [GPL 3.0 License] - see the [LICENSE](LICENSE) file for more information.