nonoo/kappanhang
1
0
Fork 0
mirror of https://github.com/nonoo/kappanhang.git synced 2026-01-20 15:40:40 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add status log info

Browse source
This commit is contained in:
Nonoo 2020-10-28 21:13:50 +01:00
parent 4b98518e0a
commit cdedfa4cc5
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -78,6 +78,25 @@ If the `-s` command line argument is specified, then kappanhang will create a
the transceiver directly. Look at the app log to find out the name of the
virtual serial port.
### Status log
kappanhang displays a "realtime" status log (when the audio/serial connection
is up) with the following info:
- `up`: how long the audio/serial connection is active
- `rtt`: roundtrip communication latency with the server
- `up/down`: currently used upload/download bandwidth (only considering UDP
payload to/from the server)
- `retx`: audio/serial retransmit request count to/from the server
- `lost`: lost audio/serial packet count from the server
`retx` and `lost` are displayed in a 1 minute window, which means they will be
reset to 0 if they don't increase for 1 minute. A `retx` value other than 0
indicates issues with the connection (probably a poor Wi-Fi connection), but
if `loss` stays 0 then the issues were fixed using packet retransmission.
`loss` indicates failed retransmit sequences, so packet loss. This can cause
audio and serial communication disruptions.
If the status log interval (can be changed with the `-i` command line
argument) is equal to or above 1 second, then the realtime status log will be
disabled and all status log lines will be written as new console lines.