Skip to content

Improve atest CLI documentation #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve atest CLI documentation #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
722081a
Add documentation for `atest -e` (set a Bit Error Rate)
doismellburning Jun 10, 2025
02b284c
Add documentation for `atest -U` (force upsampling rate for G3RUH)
doismellburning Jun 10, 2025
0019cda
Remove duplicate "rather" in atest usage message
doismellburning Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions man/atest.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ Force G3RUH modem regardless of data rate.
.BI "-D " "n"
Divide audio sample rate by n.

.TP
.BI "-U " "n"
Override automatic upsampling rate for G3RUH,
improving performance when sample rate to baud ratio is low.

.TP
.BI "-h "
Print frame contents as hexadecimal bytes.
Expand All @@ -72,6 +77,10 @@ Amount of effort to try fixing frames with an invalid CRC.
1 = Try to fix only a single bit.
more = Try modifying more bits to get a good CRC.

.TP
.BI "-e " "n"
Artificially introduce a desired Bit Error Rate (BER) for testing.

.TP
.BI "-L "
Error if Less than this number decoded.
Expand Down
5 changes: 4 additions & 1 deletion src/atest.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -982,18 +982,21 @@ static void usage (void) {
dw_printf (" AIS for ship Automatic Identification System.\n");
dw_printf (" EAS for Emergency Alert System (EAS) Specific Area Message Encoding (SAME).\n");
dw_printf ("\n");
dw_printf (" -g Use G3RUH modem rather rather than default for data rate.\n");
dw_printf (" -g Use G3RUH modem rather than default for data rate.\n");
dw_printf (" -j 2400 bps QPSK compatible with direwolf <= 1.5.\n");
dw_printf (" -J 2400 bps QPSK compatible with MFJ-2400.\n");
dw_printf ("\n");
dw_printf (" -D n Divide audio sample rate by n.\n");
dw_printf (" -U n Override automatic upsampling rate for G3RUH,\n");
dw_printf (" improving performance when sample rate to baud ratio is low.\n");
dw_printf ("\n");
dw_printf (" -h Print frame contents as hexadecimal bytes.\n");
dw_printf ("\n");
dw_printf (" -F n Amount of effort to try fixing frames with an invalid CRC. \n");
dw_printf (" 0 (default) = consider only correct frames. \n");
dw_printf (" 1 = Try to fix only a single bit. \n");
dw_printf (" more = Try modifying more bits to get a good CRC.\n");
dw_printf (" -e n Artificially introduce a desired Bit Error Rate (BER) for testing.\n");
dw_printf ("\n");
dw_printf (" -d x Debug information for FX.25. Repeat for more detail.\n");
dw_printf ("\n");
Expand Down