Skip to content

docs: list which saves play the ACTION_SUCCESS beeps - #12104

Open
Raffi1202 wants to merge 1 commit into
iNavFlight:maintenance-10.xfrom
Raffi1202:docs/beeper-save-confirmation
Open

Raffi1202 wants to merge 1 commit into
iNavFlight:maintenance-10.xfrom
Raffi1202:docs/beeper-save-confirmation

Conversation

@Raffi1202

Copy link
Copy Markdown
Contributor

Follow-up to #11923.

#11923 made the stick save (Save setting) end with the ACTION_SUCCESS sequence. This adds a paragraph to docs/Controls.md under the stick command table that says:

  • After Save setting the FC plays ACTION_SUCCESS (two short beeps); a DShot beacon plays only the first, because the second beep falls inside the beacon guard delay (getDShotBeaconGuardDelayUs()).
  • Other saves that go through saveConfigAndNotify() sound the same: waypoint mission save (sticks, Configurator MSP_WP_MISSION_SAVE, CLI wp save, MAVLink upload), OSD menu save, end of compass or accelerometer calibration, and flight statistics / servo autotrim saves about 0.5 s after disarm.
  • Configurator save (MSP_EEPROM_WRITE) and CLI save do not beep.
  • beeper -ACTION_SUCCESS mutes the confirmation; beeper -MULTI_BEEPS no longer does.

docs/Buzzer.md (after #11940) already lists "settings saved" under ACTION_SUCCESS and no longer under MULTI_BEEPS, so it needs no change.

Docs only, no code change.

Follow-up to iNavFlight#11923: the stick save now ends with the ACTION_SUCCESS
sequence. Document which saves sound it, which do not, the DShot beacon
caveat and that beeper -ACTION_SUCCESS mutes it.
@qodo-code-review

Copy link
Copy Markdown
Contributor

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

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

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

Grey Divider

Great, no issues found!

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

Grey Divider

Tip of the day
💡 Did you know, you can describe a rule in plain language on the Rules page and Qodo drafts it for you

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document save-confirmation beeps and silent save paths

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Clarifies which stick, mission, menu, calibration, and post-disarm saves play ACTION_SUCCESS.
• Notes the DShot beacon's single beep and the Configurator and CLI saves that remain silent.
• Identifies beeper -ACTION_SUCCESS as the mute setting instead of beeper -MULTI_BEEPS.
Diagram

graph TD
  A["Save setting"] --> B["Save notification"] --> C["ACTION_SUCCESS"] --> D["FC buzzer"]
  E["Other notified saves"] --> B
  C --> F["DShot beacon"]
  G["Configurator and CLI save"] --> H["No beep"]
Loading
High-Level Assessment

Keep the explanation beside the Save setting stick command, where readers encounter the behavior. The existing buzzer reference already identifies ACTION_SUCCESS with saved settings, so duplicating this list there is unnecessary.

Files changed (1) +2 / -0

Documentation (1) +2 / -0
Controls.mdExplain save-confirmation sounds below the stick command table +2/-0

Explain save-confirmation sounds below the stick command table

• Adds a paragraph listing saves that play 'ACTION_SUCCESS' and settings saves that do not. It also documents the DShot beacon caveat and the correct beeper mute setting.

docs/Controls.md

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant