Skip to content

Header comments: setAlarmIRQ description, charge setter results - #430

Merged
lovyan03 merged 1 commit into
m5stack:developfrom
ainyan03:release_doc_fixes
Oct 30, 2026
Merged

lovyan03 merged 1 commit into
m5stack:developfrom
ainyan03:release_doc_fixes

Conversation

@ainyan03

Copy link
Copy Markdown
Contributor

Header comments only (no code change):

  • RTC: the description of the alarm (wildcards, PowerHub limits, asynchronous acceptance) was attached to the deleted setAlarmIRQ(int) overload, so IDEs showed it there and nothing on the overloads that can be called. It is now on setAlarmIRQ(const rtc_date_t*, const rtc_time_t*), the other overloads refer to it, and the deleted overload keeps only its migration note.
  • Power: setBatteryCharge() / setChargeCurrent() / setChargeVoltage() said that false means the setting did not take effect. On some boards a step after the write can fail (e.g. PaperMono restores its I2C gate after writing the charger), so false now means the request could not be confirmed and the setting may or may not have been applied.

Checked on the fork CI (all builds pass, no new warnings).

Attach alarm documentation to the callable overload and explain that failed charge requests may still have changed hardware settings.
@lovyan03
lovyan03 merged commit 1d59eff into m5stack:develop Oct 30, 2026
31 checks passed
@ainyan03
ainyan03 deleted the release_doc_fixes branch October 30, 2026 10:13
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.

2 participants