WIFI Plugin Configuration Guide
Function introduction
Input parameters
| Parameter name | Required | Default value | Description |
|---|---|---|---|
ssid | yes | - | WiFi name (SSID) to test |
url | no | null | The target URL used for speed testing after successful connection (the target IP is the domain name resolution address) |
ctCount | no | 5 | Connection test timeout count. Wait 3 seconds each time, the total Wait Time is ctCount * 3 seconds |
connect | no | true | Whether to perform the connection operation. Skip connection when false |
disconnect | no | true | Whether to perform disconnection operation. Skip disconnection when false, otherwise perform disconnection operation first |
host | no | www.tingyun.com | Default target host for settings (if speed test URL is not available) |
ip | no | 1.1.1.1 | Used for settings default target IP (if it is not set speed test URL) |
Output indicators
| Indicator index | Indicator name | Description |
|---|---|---|
| 0 | performance | Performance (Signal Quality %) |
| 1 | Signal quality percentage | WiFi signal quality as a percentage |
| 2 | Signal strength dBm | Signal strength value in dBm |
| 3 | AP connection status | 1=Connection successful, 0=Connection failed |
| 4 | Download Speed | Download Speed through URL speed test |
| 5 | Download time | Download test time |
| 6 | Total Download Bytes | Total number of bytes downloaded for the test |
| 7 | WiFi connection takes time | The time taken from initiating the connection to successful connection |
| 8 | frequency band | 2.4G / 5G / Wifi6 / WiGig |
| 9 | WiFi downlink speed (backup) | Same as above |
| 10 | WiFi uplink speed | WiFi uplink speed |
| 11 | channel | WiFi channel number |
| 12 | DNS Time | DNS resolution time during speed test |
| 20 | Total time spent | Total time spent on the entire task |
The impact of parameters on output indicators
ssid: Core parameter, determines which WiFi Network to test. If the SSID does not exist or the signal is unreachable, the AP connection status is 0, and subsequent speed measurement indicators are meaningless.url: If configured, after the connection is successful, a Download Speed test will be initiated to this address, and the output indicator will be 4/5/6/12. If it is not configured, skip the speed measurement stage.ctCount: Number of waiting rounds for connection. When the SSID connection is slow, you need to increase this value, otherwise it may be mistakenly judged as a connection failure. But too large a value will increase the total time taken (metric 20).connect: When set to false, skip the connection step and directly test the signal and speed of the currently connected WiFi. At this time, indicator 7 (WiFi connection time) is 0.disconnect: When set to false, WiFi will not be disconnected after the task is completed, suitable for scenarios where the connection needs to be maintained.host / ip: only used for settings directory domain name and IP.Error code
| Error code | meaning |
|---|---|
| 699001 | WiFi connection failed |
| 699002 | WiFi disconnect failed |
| 699003 | Unknown error |
| 699004 | Download Speed test failed (URL related) |
Preconditions
1.
2.
3.
4.
5.