Skip to content

Escape sequences don't match the docs (6 vs 7, 5 vs 3) #8

Description

@ramereth

The published documentation and the firmware's own banner both give the wrong
escape sequences.

Serial -> menu. The vendor manual says seven + then seven U. The code
wants six of each:

case '+':  if ((magic_flag >= 0) && (magic_flag <= 6)) magic_flag++;
case 'U':  if (magic_flag == 6) magic_flag = -1;

Worse, a seventh + leaves magic_flag at 7, where 'U' never matches — so
following the manual literally cannot work until a non-matching character
resets it.

Pass-through -> menu. The banner printed by the firmware says:

Welcome to com, enter'+++' to quit

but the check is if (add_count > 4), i.e. five or more + immediately
followed by Enter.

Options: make the code accept what the docs say (more forgiving), or fix the
banner and update our translated manual. The former is friendlier to anyone
following upstream's page.

Our translated manual already carries [Note] markers for both, so this is
about the firmware and upstream's page, not our docs.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions