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.

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
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Add documentation for atest -e (set a Bit Error Rate)
  • Loading branch information
doismellburning committed Jun 10, 2025
commit 722081ae5e916fc0bb718e6cefb9105762428c50
4 changes: 4 additions & 0 deletions man/atest.1
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,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
1 change: 1 addition & 0 deletions src/atest.c
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,7 @@ static void usage (void) {
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