Repository navigation
Document the board detection settings, rename getBoardCandidate to getCandidateBoard, translate recent comments - #361
Merged
Conversation
…tCandidateBoard detect_config_t and its accessors had no description of when the settings apply (before the first init) or how fallback_board, fixed_board and the candidate interact. The getter is renamed to pair with getFixedBoard; the API has not been released yet, so no alias is kept.
Comments added for SCT, external RAM DMA, the LP I2C pads and board detection were written in Japanese. mode_mismatch is also returned for a nested beginTransaction and for a call from a task that does not own the I2C transaction, which its old description did not mention. Comments only; no code change.
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
2 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
M5GFX.h: whensetDetectConfig()takes effect (before the firstinit()), whatfallback_boardandfixed_boarddo, and whatgetCandidateBoard()/getFixedBoard()report.getBoardCandidate()togetCandidateBoard()so it pairs withgetFixedBoard(). These APIs are not in a release yet, so no alias is kept.error_tdescriptions (mode_mismatchis also returned for a nestedbeginTransactionand for a call from a task that does not own the I2C transaction).M5Unified calls the renamed getter and needs the matching change (m5stack/M5Unified #409); please merge both together.
Test
extras/board_spec:npm testandnpm run checkpass