Add help menu to CommonCLI.cpp #635
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I keep wanting a help menu in the CLI but it isn't there. Had a look and realised a small refactor would help make this maintainable. I have: - made a single source of truth for the output strings - added a number of formatter functions to enable small help responses (essentially grouped things) - added the calling routines for the above into the main logic CLI message responses for use over the mesh need to be <= 160 chars which I *think* I have achieved here. Needed to group things so that it didn't just try to dump everything in one hit and go way over that 160 limit. Was also conscious of future expansion so I hope these messages are still small enough for additional options in the future. I believe this is a direct drop-in with no other files / code affected. This is first commit after development though and has not yet been tested on a device.
yg-ht
changed the title
4np
reviewed
Aug 24, 2025
| if (memcmp(command, CMD_HELP, 4) == 0) { | ||
| if (memcmp(command, "help device cmds", 16) == 0) { format_help_device_cmds(reply); return; } | ||
| if (memcmp(command, "help device keys", 16) == 0) { format_help_device_keys(reply); return; } | ||
| if (memcmp(command, "help radio cmds", 15) == 0) { format_help_radio_cmds(reply); return; } |
There was a problem hiding this comment.
It would probably make sense to use the constants here as well, something like:
Suggested change
| if (memcmp(command, "help radio cmds", 15) == 0) { format_help_radio_cmds(reply); return; } | |
| if (memcmp(command, CMD_HELP + SPACE + KEY_RADIO + "cmds", 15) == 0) { format_help_radio_cmds(reply); return; } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I keep wanting a help menu in the CLI but it isn't there. Had a look and realised a small refactor would help make this maintainable. I have:
CLI message responses for use over the mesh need to be <= 160 chars which I think I have achieved here. Needed to group things so that it didn't just try to dump everything in one hit and go way over that 160 limit. Was also conscious of future expansion so I hope these messages are still small enough for additional options in the future.
I believe this is a direct drop-in with no other files / code affected. This is first commit after development though and has not yet been tested on a device. Please can I ask for help on this as it might take me a bit to actually test it (I am away from devices right now).