docs: add the three MSP commands the registry is missing by MrScothh · Pull Request #12018 · iNavFlight/inav · GitHub

What this fixes

check_msp.py fails on maintenance-10.x, so the MSP consistency workflow goes red on every pull request that touches MSP, whatever the pull request does. Three commands are defined in msp_protocol_v2_inav.h and answered in fc_msp.c but have no entry in msp_messages.json:

MSP2_INAV_ESC_SRXL2_STATUS (0x2233) and MSP2_INAV_ESC_SRXL2_CALIBRATE (0x2234), which came in with my Spektrum Smart ESC (SRXL2) motor output #11947 and which I should have added then;
MSP2_INAV_MAG_UNALIGNED (0x2232), which isn't mine, but without it the check stays red.

What I changed

An entry for each, written from the handlers in fc_msp.c and the enums in motor_srxl2.h, with README.md regenerated by gen_msp_docs.sh. The MAG_UNALIGNED entry is a commit of its own, so it can be dropped if its author would rather write it.

The registry version goes from 2.1.1 to 2.1.2: new entries inside the current schema, which the versioning rule counts as a patch.

Testing

check_msp.py passes ("281 C definitions match 282 JSON definitions"), and gen_msp_docs.sh leaves README.md unchanged after the commit, which is what the workflow compares.

#11979 also bumps the registry version, so whichever of the two goes in second will need that line rebased.

The command is defined in msp_protocol_v2_inav.h and answered in fc_msp.c, but the registry never listed it, so check_msp.py fails on maintenance-10.x and on every pull request that runs the MSP consistency workflow.

MSP2_INAV_ESC_SRXL2_STATUS and MSP2_INAV_ESC_SRXL2_CALIBRATE came in with iNavFlight#11947 without an entry in msp_messages.json, which is two of the three commands check_msp.py reports as missing.

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Tip of the day

💡 Did you know, you can keep summaries lean with Finding overflow, which tucks the rest behind 'View more'

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

PR Summary by Qodo

Register missing MAG and SRXL2 MSP commands

🐞 Bug fix 📝 Documentation 🕐 10-20 Minutes

AI Description

• Restores MSP consistency checks by registering three implemented commands missing from the
 catalog.
• Documents unaligned magnetometer readings and SRXL2 ESC status and calibration payloads.
• Bumps the registry patch version and regenerates the MSP reference.

Diagram

graph TD
  Handlers["MSP handlers"] -->|payload contract| Registry["JSON registry"] --> Generator["Docs generator"] --> Reference["MSP reference"]
  Headers["C definitions"] -->|command catalog| Checker["Consistency check"]
  Registry -->|registered commands| Checker

High-Level Assessment

The PR uses the correct existing workflow: add implemented commands to the canonical JSON registry, increment its patch version, and regenerate the Markdown reference. Editing only the generated README would be overwritten, while weakening the consistency check would conceal future registry drift.

Files changed (2) +136 / -1

Bug fix (1) +91 / -1

msp_messages.jsonRegister missing MAG and SRXL2 messages +91/-1

Register missing MAG and SRXL2 messages

• Adds canonical registry entries for 'MSP2_INAV_MAG_UNALIGNED', 'MSP2_INAV_ESC_SRXL2_STATUS', and 'MSP2_INAV_ESC_SRXL2_CALIBRATE', matching their firmware handlers. Bumps the registry patch version from 2.1.1 to 2.1.2.

docs/development/msp/msp_messages.json

Documentation (1) +45 / -0

README.mdDocument three previously missing MSPv2 commands +45/-0

Document three previously missing MSPv2 commands

• Adds generated reference sections for unaligned magnetometer readings and SRXL2 ESC status and calibration. The documentation describes command IDs, payload fields, enum values, feature requirements, and failure behavior.

docs/development/msp/README.md

Thanks — this fixes the red MSP consistency check on maintenance-10.x, and I verified all three entries against the handlers in fc_msp.c and the enums in motor_srxl2.h. Including MSP2_INAV_MAG_UNALIGNED is fine, since the check can't pass without it.

One small addition, if you don't mind: srxl2CalPhase_e and srxl2CalResult_e aren't in docs/development/msp/inav_enums.json yet, so the enum links in the new entries point to missing anchors. Could you regenerate the enum files (src/utils/get_all_inav_enums_h.py / gen_enum_md.py) as part of this PR? Then its fine to merge.

Thanks!

MrScothh added 3 commits September 23, 2026 10:21

docs: add MSP2_INAV_MAG_UNALIGNED to the message registry

3a60a1d

The command is defined in msp_protocol_v2_inav.h and answered in fc_msp.c, but the registry never listed it, so check_msp.py fails on maintenance-10.x and on every pull request that runs the MSP consistency workflow.

docs: add the SRXL2 ESC messages to the MSP registry

997affd

MSP2_INAV_ESC_SRXL2_STATUS and MSP2_INAV_ESC_SRXL2_CALIBRATE came in with iNavFlight#11947 without an entry in msp_messages.json, which is two of the three commands check_msp.py reports as missing.

docs: bump the message registry to 2.1.2

9b430ba

b14ckyy added this to the 10.0 milestone Sep 23, 2026

b14ckyy added the Documentation label Sep 23, 2026

docs: add the three MSP commands the registry is missing by MrScothh · Pull Request #12018 · iNavFlight/inav · GitHub

docs: add the three MSP commands the registry is missing - #12018

docs: add the three MSP commands the registry is missing#12018
MrScothh wants to merge 3 commits into
iNavFlight:maintenance-10.xfrom
MrScothh:docs/msp-registry-srxl2

MrScothh commented Sep 23, 2026

Uh oh!

qodo-code-review Bot commented Sep 23, 2026

Uh oh!

qodo-free-for-open-source-projects Bot commented Sep 23, 2026

Uh oh!

qodo-free-for-open-source-projects Bot commented Sep 23, 2026

Uh oh!

b14ckyy commented Sep 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

docs: add the three MSP commands the registry is missing by MrScothh · Pull Request #12018 · iNavFlight/inav · GitHub

docs: add the three MSP commands the registry is missing - #12018

docs: add the three MSP commands the registry is missing#12018MrScothh wants to merge 3 commits intoiNavFlight:maintenance-10.xiNavFlight/inav:maintenance-10.xfrom MrScothh:docs/msp-registry-srxl2MrScothh/inav:docs/msp-registry-srxl2Copy head branch name to clipboard

Conversation

MrScothh commented Sep 23, 2026

What this fixes

What I changed

Testing

Uh oh!

qodo-code-review Bot commented Sep 23, 2026

Uh oh!

qodo-free-for-open-source-projects Bot commented Sep 23, 2026

Code Review by Qodo

Great, no issues found!

Uh oh!

qodo-free-for-open-source-projects Bot commented Sep 23, 2026

PR Summary by Qodo

Uh oh!

b14ckyy commented Sep 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

docs: add the three MSP commands the registry is missing#12018
MrScothh wants to merge 3 commits into
iNavFlight:maintenance-10.xfrom
MrScothh:docs/msp-registry-srxl2