Update bme280.rst with CSB pin hint

[kotylo]

Add warning to check connection diagram, since leaving CSB non-pulled will result in dropping out of I2C mode after some time after start.

Description:

Related issue (if applicable): fixes

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

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 /index.rst when creating new documents for new components or cookbook.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	a01f09d
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/67355429c0560e00080bc243
😎 Deploy Preview	https://deploy-preview-4439--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai]

Walkthrough

The pull request updates the documentation for the BME280 sensor platform, specifically adding a note about the I²C mode configuration. It recommends pulling the CSB pin to 3V to prevent communication errors with the BME280 sensor. The rest of the documentation remains unchanged, including configuration examples and variable descriptions.

Changes

File	Change Summary
components/sensor/bme280.rst	Added note regarding I²C mode: "In I²C mode pulling CSB to 3V is recommended to avoid communication errors."

Possibly related PRs

• [bme280] Update configuration variables list #4226: This PR updates the configuration variables list for the BME280 sensor, which is directly related to the documentation changes made in the main PR regarding the BME280 sensor platform.
• Update bme280 description humidity #4257: This PR corrects the description of the humidity configuration variable in the BME280 documentation, which aligns with the focus of the main PR on enhancing the clarity of the BME280 sensor documentation.

Suggested reviewers

• jesserockz

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

components/sensor/bme280.rst (1)

16-17: LGTM! Consider adding a direct link to the connection diagram section.

The added note effectively warns users about the CSB pin configuration issue and provides the exact error message they might encounter. The placement and formatting are appropriate.

Consider adding the specific section number from the datasheet for quicker reference:

-**Note:** In :ref:`I²C <i2c>` mode pulling CSB to 3V is recommended, in order to avoid ``[E][sensor.bme280:155]: Communication with BME280 failed!`` error. See the *Connection diagram* chapter in datasheet above.
+**Note:** In :ref:`I²C <i2c>` mode pulling CSB to 3V is recommended, in order to avoid ``[E][sensor.bme280:155]: Communication with BME280 failed!`` error. See the *Connection diagram* in Section 6.2 of the datasheet above.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 885f8b6 and a01f09d.

📒 Files selected for processing (1)

• components/sensor/bme280.rst (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

components/sensor/bme280.rst (1)

Pattern **: - Do not generate or add any sequence diagrams

[frenck]

Thanks, @kotylo 👍

../Frenck