esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

Clarify MCP23017 GPIO indexing in ESPHome docs

Open viniciusvillas opened this issue 5 months ago • 2 comments

This update fixes the MCP23017 component documentation. Changes were made to the description of the pin mapping, clarifying that the A port is reverse-mapped. Changes were made in the example to reflect the way the component actually works (A0 is actually pin 7, because it's reverse-mapped)

Description:

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

  • esphome/esphome#<esphome PR number goes here>

Checklist:

  • [ ] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • [ ] I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • [ ] Link added in /components/index.rst when creating new documents for new components or cookbook.

viniciusvillas avatar Jun 10 '25 03:06 viniciusvillas

Walkthrough

The documentation for the MCP23017 component was updated to clarify the pin numbering scheme, specifically detailing the reverse mapping for port A and forward mapping for port B. The example configuration was also corrected to illustrate the proper pin number for A0.

Changes

File(s) Change Summary
components/mcp230xx.rst Clarified pin numbering scheme for MCP23017; updated example configuration for pin A0 mapping.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 10 '25 03:06 coderabbitai[bot]

Deploy Preview for esphome ready!

Name Link
Latest commit 9339a14166753817475bb359b20a75de0250ce61
Latest deploy log https://app.netlify.com/projects/esphome/deploys/6847a2b81a8ec200087a6d6b
Deploy Preview https://deploy-preview-4988--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Jun 10 '25 03:06 netlify[bot]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

github-actions[bot] avatar Aug 10 '25 02:08 github-actions[bot]

Please provide some documentation to support the assertion that port A is reverse mapped.

clydebarrow avatar Aug 13 '25 00:08 clydebarrow

Please provide some documentation to support the assertion that port A is reverse mapped.

I couldn’t find authoritative documentation for this behavior. My findings are empirical: in practice the current ESPHome documentation for the integration with the MCP23017 diverges from what the hardware actually does (the datasheet doesn’t cover ESPHome’s integration details, so this has to be inferred from real-world tests).

If there’s a canonical reference I’ve missed, I’d appreciate a pointer. If this change isn’t a fit for main, no problem—but the current documented behavior is incorrect in practice. At minimum, this PR can serve as a breadcrumb for future readers.

viniciusvillas avatar Aug 13 '25 23:08 viniciusvillas

I've tracked down this behavior in practice.

Well, could you detail your findings here then. The datasheet and the ESPHome implementation appear on paper to be in agreement, so if the datasheet is wrong you'll need to provide some evidence of that.

If your assertion is correct then it's certainly important for others to know that, just need something to back it up.

clydebarrow avatar Aug 14 '25 00:08 clydebarrow