update docs - softserial limit - #11771
Open
RomanLut wants to merge 1 commit into
Open
Conversation
Branch Targeting SuggestionYou've targeted the
If This is an automated suggestion to help route contributions to the appropriate branch. |
Contributor
PR Summary by QodoFix telemetry docs: remove outdated softserial baud-rate limits
AI Description
High-Level Assessment
Files changed (1)
|
Contributor
Code Review by Qodo
1. Softserial limit docs conflict
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
|
|
||
| It shares 1 line for both TX and RX, the rx pin cannot be used for other serial port stuff. | ||
| It runs at a fixed baud rate of 115200, so it need hardware uart (softserial is limit to 19200). | ||
| It runs at a fixed baud rate of 115200. |
Contributor
There was a problem hiding this comment.
1. Softserial limit docs conflict 🐞 Bug ⚙ Maintainability
docs/Telemetry.md removes the “softserial limited to 19200” guidance, but other docs still claim SoftSerial is capped at 19200, creating contradictory configuration guidance. The SoftSerial implementation appears to accept an arbitrary baud (no explicit 19200 clamp), so the remaining “19200 limit” statements are likely misleading or at least need qualification as a practical recommendation rather than a hard limit.
Agent Prompt
### Issue description
`docs/Telemetry.md` no longer states SoftSerial is limited to 19200 baud, but `docs/Serial.md` and `docs/Blackbox.md` still state (as a hard limit) that SoftSerial is limited to 19200. This creates contradictory documentation after this PR.
### Issue Context
The SoftSerial code path takes a `baud` parameter and configures timers from it without a clear 19200 cap, so documentation that presents 19200 as a strict limit is inconsistent with the current implementation.
### Fix Focus Areas
- docs/Telemetry.md[205-236]
- docs/Serial.md[36-49]
- docs/Blackbox.md[68-76]
- src/main/drivers/serial_softserial.c[170-189]
- src/main/drivers/serial_softserial.c[204-345]
### Suggested change
Update the other docs to match the new reality (e.g., remove the “limited to 19200” hard-limit phrasing) or rephrase consistently as a practical/recommended limit if that’s the intended guidance (e.g., “SoftSerial may be unreliable at high baud rates; prefer hardware UART for >19200 / high bandwidth”).
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
| MAVLink is a lightweight header-only message marshalling library for micro air vehicles. INAV supports MAVLink for compatibility with ground stations, OSDs and antenna trackers built for PX4, PIXHAWK, APM and Parrot AR.Drone platforms. | ||
|
|
||
| MAVLink implementation in INAV is transmit-only and usable on low baud rates and can be used over soft serial (requires 19200 baud). MAVLink V1 and V2 are supported. | ||
| MAVLink implementation in INAV is transmit-only, is usable at low baud rates. MAVLink V1 and V2 are supported. |
Contributor
There was a problem hiding this comment.
2. Mavlink sentence punctuation 🐞 Bug ⚙ Maintainability
The new sentence “transmit-only, is usable…” is a comma splice and reads ambiguously. This reduces clarity in the updated documentation.
Agent Prompt
### Issue description
The updated MAVLink line uses a comma splice (“transmit-only, is usable”), which is grammatically awkward and can be misread.
### Issue Context
This is purely a documentation clarity/readability fix.
### Fix Focus Areas
- docs/Telemetry.md[205-210]
### Suggested change
Reword to something like:
- “MAVLink implementation in INAV is transmit-only and usable at low baud rates. MAVLink V1 and V2 are supported.”
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Code Review by Qodo
1. MAVLink not transmit-only
|
![qodo-free-for-open-source-projects[bot]](https://avatars.githubusercontent.com/in/1068000?s=60&v=4){kind=small}
| MAVLink is a lightweight header-only message marshalling library for micro air vehicles. INAV supports MAVLink for compatibility with ground stations, OSDs and antenna trackers built for PX4, PIXHAWK, APM and Parrot AR.Drone platforms. | ||
|
|
||
| MAVLink implementation in INAV is transmit-only and usable on low baud rates and can be used over soft serial (requires 19200 baud). MAVLink V1 and V2 are supported. | ||
| MAVLink implementation in INAV is transmit-only, is usable at low baud rates. MAVLink V1 and V2 are supported. |
There was a problem hiding this comment.
1. Mavlink not transmit-only 🐞 Bug ≡ Correctness
docs/Telemetry.md states MAVLink in INAV is “transmit-only”, but the current MAVLink telemetry implementation reads and processes incoming MAVLink messages (missions/params/RC override/etc). This misleads users about MAVLink capabilities and is in-scope because the PR edited this sentence but kept the incorrect claim.
Agent Prompt
### Issue description
`docs/Telemetry.md` says MAVLink is transmit-only, but the implementation processes inbound MAVLink messages. This is incorrect documentation and can lead users to wrong configuration/expectations.
### Issue Context
The telemetry MAVLink code contains an explicit receive loop and dispatches received message IDs.
### Fix Focus Areas
- docs/Telemetry.md[205-210]
- src/main/telemetry/mavlink.c[1388-1433]
- src/main/telemetry/mavlink.c[1444-1456]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
| Ibus telemetry requires a single connection from the TX pin of a bidirectional serial port to the Ibus sens pin on an FlySky telemetry receiver. (tested with fs-iA6B receiver, iA10 should work) | ||
|
|
||
| It shares 1 line for both TX and RX, the rx pin cannot be used for other serial port stuff. | ||
| It runs at a fixed baud rate of 115200, so it need hardware uart (softserial is limit to 19200). |
There was a problem hiding this comment.
2. Softserial baud docs conflict 🐞 Bug ⚙ Maintainability
This PR removes the “softserial is limit to 19200” note from the iBus telemetry section, but other docs still state SoftSerial is limited to 19200 baud. This leaves contradictory guidance across the documentation set and will confuse users configuring SoftSerial-based telemetry/logging.
Agent Prompt
### Issue description
After this PR, `docs/Telemetry.md` no longer mentions a 19200 SoftSerial limit for iBus, but `docs/Serial.md` and `docs/Blackbox.md` still claim SoftSerial is limited to 19200 baud. This is conflicting documentation.
### Issue Context
The PR’s stated goal is to fix misleading SoftSerial-limit docs; this should be applied consistently across the documentation set.
### Fix Focus Areas
- docs/Telemetry.md[231-237]
- docs/Serial.md[46-48]
- docs/Blackbox.md[68-75]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
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
1 participant
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.
Software serial does not limit to 19200 since version 5 or so. Fixed misleading docs.