docs/applications/{morsey, txmorse}: Add documentation for Morse code features#19493
Open
linguini1 wants to merge 4 commits into
Open
docs/applications/{morsey, txmorse}: Add documentation for Morse code features#19493linguini1 wants to merge 4 commits into
linguini1 wants to merge 4 commits into
Conversation
Includes documentation about how to include and use the Morsey library for transmitting Morse code. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
Documents how to use the txmorse application and how it can be extended to support other output devices besides the console and GPIO. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
Adds a configuration for a Morse code example. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
Document configuration with txmorse example. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
github-actions
Bot
added
Area: Documentation
linguini1
changed the title
linguini1
requested review from
acassis,
cederom,
jerpelea,
michallenc,
raiden00pl,
simbit18 and
xiaoxiang781216
July 21, 2026 01:20
Contributor
Author
|
Cancelling workflow until twin PR is merged, this PR depends on it. |
|
xiaoxiang781216
approved these changes
Jul 21, 2026
acassis
reviewed
Jul 21, 2026
|
|
||
| .. code:: console | ||
|
|
||
| nsh> txmorse "sos" /dev/gpio0 |
Contributor
There was a problem hiding this comment.
Please add the " nsh> txmorse "sos" /dev/gpio0" example here.
Contributor
Author
There was a problem hiding this comment.
What do you mean? That's exactly what's written
Contributor
There was a problem hiding this comment.
I mean add "nsh> txmorse "sos sos sos" " without passing gpio as well
xiaoxiang781216
approved these changes
Jul 21, 2026
jerpelea
approved these changes
Jul 21, 2026
Contributor
Author
|
@acassis I have the documentation fix, I will push it after apache/nuttx-apps#3654 is merged to fix the CI error. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
Adds documentation for the new Morse code features added in: apache/nuttx-apps#3653
Also adds a configuration for sim so that users can play with the example.
The twin pull request must be merged before this one passes CI.
Commit summary:
docs/sim: Document txmorse configuration
Document configuration with txmorse example.
boards/sim: Add configuration for Morse code example
Adds a configuration for a Morse code example.
docs/applications/txmorse: Document the txmorse application
Documents how to use the txmorse application and how it can be extended
to support other output devices besides the console and GPIO.
docs/applications/audioutils: Document Morsey library
Includes documentation about how to include and use the Morsey library
for transmitting Morse code.
Impact
Users can understand the new Morse code features with documentation, and they
can also play with the example on sim.
Testing
Local documentation build. Output on
sim:txmorse: