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

Create guides/intrinsic_sensors.rst

Open shvmm opened this issue 1 year ago • 1 comments

Description:

An exhaustive list of all current sensors intrinsic or internal to ESPHome. This page 'guides/intrinsic_sensors.rst' intends to list all sensors intrinsic to the ESPHome platform requiring nothing more than a compatible device.

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

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

  • [x] 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.

shvmm avatar Sep 04 '24 08:09 shvmm

Deploy Preview for esphome ready!

Name Link
Latest commit 7cc52de5cad3bb3777aca5bf925f680c5ef35156
Latest deploy log https://app.netlify.com/sites/esphome/deploys/681315aa2be6da00087223e9
Deploy Preview https://deploy-preview-4222--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 site configuration.

netlify[bot] avatar Sep 04 '24 08:09 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 Dec 21 '24 01:12 github-actions[bot]

Walkthrough

The pull request introduces a new documentation page guides/intrinsic_sensors.rst, which provides an organized overview of various sensors integral to the ESPHome platform. The page categorizes sensors into groups such as Bluetooth, WiFi, Debug, and Miscellaneous, and includes a meta description for SEO purposes. Each category lists specific sensors with links to their respective documentation pages, enhancing information accessibility. Additionally, a "See Also" section references related configuration documentation and an edit option.

Changes

File Change Summary
guides/intrinsic_sensors.rst New documentation page added to catalog intrinsic sensors in ESPHome, organized by categories with links to detailed documentation

Suggested labels

next

Suggested reviewers

  • nagyrobi
  • jesserockz

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d6bb477c9e782465409f440571a0829311c4d165 and 95a65bbda18737089db0b9aee25a3d35a21d677e.

📒 Files selected for processing (1)
  • guides/intrinsic_sensors.rst (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • guides/intrinsic_sensors.rst

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 Dec 23 '24 07:12 coderabbitai[bot]